2 /***************************************************************************
3 * Copyright (C) 2003-2009 Polytechnique.org *
4 * http://opensource.polytechnique.org/ *
6 * This program is free software; you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation; either version 2 of the License, or *
9 * (at your option) any later version. *
11 * This program is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
14 * GNU General Public License for more details. *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program; if not, write to the Free Software *
19 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *
20 ***************************************************************************/
22 class User
extends PlUser
24 private $_profile_fetched = false
;
25 private $_profile = null
;
27 // Implementation of the login to uid method.
28 protected function getLogin($login)
32 if ($login instanceof User
) {
36 if ($login instanceof Profile
) {
37 $this->_profile
= $login;
38 $this->_profile_fetched
= true
;
39 $res = XDB
::query('SELECT ap.uid
40 FROM account_profiles AS ap
41 WHERE ap.pid = {?} AND FIND_IN_SET(\'owner\', perms)',
43 if ($res->numRows()) {
44 return $res->fetchOneCell();
46 throw new UserNotFoundException();
49 // If $data is an integer, fetches directly the result.
50 if (is_numeric($login)) {
51 $res = XDB
::query('SELECT a.uid
53 WHERE a.uid = {?}', $login);
54 if ($res->numRows()) {
55 return $res->fetchOneCell();
58 throw new UserNotFoundException();
61 // Checks whether $login is a valid hruid or not.
62 $res = XDB
::query('SELECT a.uid
64 WHERE a.hruid = {?}', $login);
65 if ($res->numRows()) {
66 return $res->fetchOneCell();
69 // From now, $login can only by an email alias, or an email redirection.
70 // If it doesn't look like a valid address, appends the plat/al's main domain.
71 $login = trim(strtolower($login));
72 if (strstr($login, '@') === false
) {
73 $login = $login . '@' . $globals->mail
->domain
;
76 // Checks if $login is a valid alias on the main domains.
77 list($mbox, $fqdn) = explode('@', $login);
78 if ($fqdn == $globals->mail
->domain ||
$fqdn == $globals->mail
->domain2
) {
79 $res = XDB
::query('SELECT a.uid
81 INNER JOIN aliases AS al ON (al.id = a.uid AND al.type IN (\'alias\', \'a_vie\'))
82 WHERE al.alias = {?}', $mbox);
83 if ($res->numRows()) {
84 return $res->fetchOneCell();
87 /** TODO: implements this by inspecting the profile.
88 if (preg_match('/^(.*)\.([0-9]{4})$/u', $mbox, $matches)) {
89 $res = XDB::query('SELECT a.uid
91 INNER JOIN aliases AS al ON (al.id = a.uid AND al.type IN ('alias', 'a_vie'))
92 WHERE al.alias = {?} AND a.promo = {?}', $matches[1], $matches[2]);
93 if ($res->numRows() == 1) {
94 return $res->fetchOneCell();
98 throw new UserNotFoundException();
101 // Looks for $login as an email alias from the dedicated alias domain.
102 if ($fqdn == $globals->mail
->alias_dom ||
$fqdn == $globals->mail
->alias_dom2
) {
103 $res = XDB
::query("SELECT redirect
104 FROM virtual_redirect
105 INNER JOIN virtual USING(vid)
106 WHERE alias = {?}", $mbox . '@' . $globals->mail
->alias_dom
);
107 if ($redir = $res->fetchOneCell()) {
108 // We now have a valid alias, which has to be translated to an hruid.
109 list($alias, $alias_fqdn) = explode('@', $redir);
110 $res = XDB
::query("SELECT a.uid
112 LEFT JOIN aliases AS al ON (al.id = a.uid AND al.type IN ('alias', 'a_vie'))
113 WHERE al.alias = {?}", $alias);
114 if ($res->numRows()) {
115 return $res->fetchOneCell();
119 throw new UserNotFoundException();
122 // Looks for an account with the given email.
123 $res = XDB
::query('SELECT a.uid
125 WHERE a.email = {?}', $login);
126 if ($res->numRows() == 1) {
127 return $res->fetchOneCell();
130 // Otherwise, we do suppose $login is an email redirection.
131 $res = XDB
::query("SELECT a.uid
133 LEFT JOIN emails AS e ON (e.uid = a.uid)
134 WHERE e.email = {?}", $login);
135 if ($res->numRows() == 1) {
136 return $res->fetchOneCell();
139 throw new UserNotFoundException($res->fetchColumn(1));
142 protected static function loadMainFieldsFromUIDs(array $uids)
147 if ($globals->asso('id')) {
148 $joins .= XDB
::format("LEFT JOIN groupex.membres AS gpm ON (gpm.uid = a.uid AND gpm.asso_id = {?})\n", $globals->asso('id'));
149 $fields[] = 'gpm.perms AS group_perms';
150 $fields[] = 'gpm.comm AS group_comm';
152 if (count($fields) > 0) {
153 $fields = ', ' . implode(', ', $fields);
157 $uids = array_map(array('XDB', 'escape'), $uids);
158 return XDB
::iterator('SELECT a.uid, a.hruid, a.registration_date,
159 CONCAT(af.alias, \'@' . $globals->mail
->domain
. '\') AS forlife,
160 CONCAT(ab.alias, \'@' . $globals->mail
->domain
. '\') AS bestalias,
161 a.full_name, a.display_name, a.sex = \'female\' AS gender,
162 IF(a.state = \'active\', at.perms, \'\') AS perms,
163 a.email_format, a.is_admin, a.state, a.type, a.skin,
164 FIND_IN_SET(\'watch\', a.flags) AS watch, a.comment,
165 a.weak_password IS NOT NULL AS weak_access,
166 a.token IS NOT NULL AS token_access ' . $fields . '
168 INNER JOIN account_types AS at ON (at.type = a.type)
169 LEFT JOIN aliases AS af ON (af.id = a.uid AND af.type = \'a_vie\')
170 LEFT JOIN aliases AS ab ON (ab.id = a.uid AND FIND_IN_SET(\'bestalias\', ab.flags))
172 WHERE a.uid IN (' . implode(', ', $uids) . ')
176 // Implementation of the data loader.
177 protected function loadMainFields()
179 if ($this->hruid
!== null
&& $this->forlife
!== null
180 && $this->bestalias
!== null
&& $this->display_name
!== null
181 && $this->full_name
!== null
&& $this->perms
!== null
182 && $this->gender
!== null
&& $this->email_format
!== null
) {
185 $this->fillFromArray(self
::loadMainFieldsFromUIDs(array($this->user_id
))->next());
188 // Specialization of the fillFromArray method, to implement hacks to enable
189 // lazy loading of user's main properties from the session.
190 // TODO(vzanotti): remove the conversion hacks once the old codebase will
191 // stop being used actively.
192 protected function fillFromArray(array $values)
194 // It might happen that the 'user_id' field is called uid in some places
195 // (eg. in sessions), so we hard link uid to user_id to prevent useless
197 if (!isset($values['user_id']) && isset($values['uid'])) {
198 $values['user_id'] = $values['uid'];
201 // Also, if display_name and full_name are not known, but the user's
202 // surname and last name are, we can construct the former two.
203 if (isset($values['prenom']) && isset($values['nom'])) {
204 if (!isset($values['display_name'])) {
205 $values['display_name'] = ($values['prenom'] ?
$values['prenom'] : $values['nom']);
207 if (!isset($values['full_name'])) {
208 $values['full_name'] = $values['prenom'] . ' ' . $values['nom'];
212 // We also need to convert the gender (usually named "femme"), and the
213 // email format parameter (valued "texte" instead of "text").
214 if (isset($values['femme'])) {
215 $values['gender'] = (bool
) $values['femme'];
217 if (isset($values['mail_fmt'])) {
218 $values['email_format'] = $values['mail_fmt'];
221 parent
::fillFromArray($values);
224 // Specialization of the buildPerms method
225 // This function build 'generic' permissions for the user. It does not take
226 // into account page specific permissions (e.g X.net group permissions)
227 protected function buildPerms()
229 if (!is_null($this->perm_flags
)) {
232 if ($this->perms
=== null
) {
233 $this->loadMainFields();
235 $this->perm_flags
= self
::makePerms($this->perms
, $this->is_admin
);
238 // We do not want to store the password in the object.
239 // So, fetch it 'on demand'
240 public function password()
242 return XDB
::fetchOneCell('SELECT a.password
244 WHERE a.uid = {?}', $this->id());
247 /** Overload PlUser::promo(): there no promo defined for a user in the current
248 * schema. The promo is a field from the profile.
250 public function promo()
252 if (!$this->hasProfile()) {
255 return $this->profile()->promo();
258 public function firstName()
260 if (!$this->hasProfile()) {
261 return $this->displayName();
263 return $this->profile()->firstName();
266 public function lastName()
268 if (!$this->hasProfile()) {
271 return $this->profile()->lastName();
274 /** Return the main profile attached with this account if any.
276 public function profile()
278 if (!$this->_profile_fetched
) {
279 $this->_profile_fetched
= true
;
280 $this->_profile
= Profile
::get($this);
282 return $this->_profile
;
285 /** Return true if the user has an associated profile.
287 public function hasProfile()
289 return !is_null($this->profile());
292 /** Check if the user can edit to given profile.
294 public function canEdit(Profile
$profile)
296 // XXX: Check permissions (e.g. secretary permission)
297 // and flags from the profile
298 return XDB
::fetchOneCell('SELECT pid
299 FROM account_profiles
300 WHERE uid = {?} AND pid = {?}',
301 $this->id(), $profile->id());
304 /** Get the email alias of the user.
306 public function emailAlias()
309 $data = $this->emailAliases($globals->mail
->alias_dom
);
310 if (count($data) > 0) {
311 return array_pop($data);
316 /** Get all the aliases the user belongs to.
318 public function emailAliases($domain = null
, $type = 'user', $sub_state = false
)
320 $join = XDB
::format('(vr.redirect = {?} OR vr.redirect = {?}) ',
321 $this->forlifeEmail(), $this->m4xForlifeEmail());
323 if (!is_null($domain)) {
324 $where = XDB
::format('WHERE v.alias LIKE CONCAT("%@", {?})', $domain);
326 if (!is_null($type)) {
328 $where = XDB
::format('WHERE v.type = {?}', $type);
330 $where .= XDB
::format(' AND v.type = {?}', $type);
334 return XDB
::fetchAllAssoc('alias', 'SELECT v.alias, vr.redirect IS NOT NULL AS sub
336 LEFT JOIN virtual_redirect AS vr ON (v.vid = vr.vid AND ' . $join . ')
339 return XDB
::fetchColumn('SELECT v.alias
341 INNER JOIN virtual_redirect AS vr ON (v.vid = vr.vid AND ' . $join . ')
346 /** Get the alternative forlife email
347 * TODO: remove this uber-ugly hack. The issue is that you need to remove
348 * all @m4x.org addresses in virtual_redirect first.
349 * XXX: This is juste to make code more readable, to be remove as soon as possible
351 public function m4xForlifeEmail()
354 trigger_error('USING M4X FORLIFE', E_USER_NOTICE
);
355 return $this->login() . '@' . $globals->mail
->domain2
;
359 /** Get marketing informations
361 private function fetchMarketingData()
363 if (isset($this->last_known_email
)) {
366 $infos = XDB
::fetchOneAssoc('SELECT IF (MAX(m.last) > p.relance, MAX(m.last), p.relance) AS last_relance,
367 p.email AS last_known_email
368 FROM register_pending AS p
369 LEFT JOIN register_marketing AS m ON (p.uid = m.uid)
371 GROUP BY p.uid', $this->id());
373 $infos = array('last_relance' => null
, 'last_known_email' => null
);
375 $this->fillFromArray($infos);
378 public function lastMarketingRelance()
380 $this->fetchMarketingData();
381 return $this->last_relance
;
384 public function lastKnownEmail()
386 $this->fetchMarketingData();
387 return $this->last_known_email
;
390 // Return permission flags for a given permission level.
391 public static function makePerms($perms, $is_admin)
393 $flags = new PlFlagSet($perms);
394 $flags->addFlag(PERMS_USER
);
396 $flags->addFlag(PERMS_ADMIN
);
401 // Implementation of the default user callback.
402 public static function _default_user_callback($login, $results)
404 $result_count = count($results);
405 if ($result_count == 0 ||
!S
::has_perms()) {
406 Platal
::page()->trigError("Il n'y a pas d'utilisateur avec l'identifiant : $login");
408 Platal
::page()->trigError("Il y a $result_count utilisateurs avec cet identifiant : " . join(', ', $results));
412 // Implementation of the static email locality checker.
413 public static function isForeignEmailAddress($email)
416 if (strpos($email, '@') === false
) {
420 list($user, $dom) = explode('@', $email);
421 return $dom != $globals->mail
->domain
&&
422 $dom != $globals->mail
->domain2
&&
423 $dom != $globals->mail
->alias_dom
&&
424 $dom != $globals->mail
->alias_dom2
;
427 public static function isVirtualEmailAddress($email)
430 if (strpos($email, '@') === false
) {
434 list($user, $dom) = explode('@', $email);
435 return $dom == $globals->mail
->alias_dom
436 ||
$dom == $globals->mail
->alias_dom2
;
439 // Fetch a set of users from a list of UIDs
440 public static function getBulkUsersWithUIDs(array $uids)
442 if (count($uids) == 0) {
445 $fields = self
::loadMainFieldsFromUIDs($uids);
447 while (($list = $fields->next())) {
448 $table[$list['uid']] = User
::getSilentWithValues(null
, $list);
451 foreach ($uids as $uid) {
452 $users[] = $table[$uid];
458 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: