7db7df4be954e9cb00c4cdc28674d20912201aea
2 /***************************************************************************
3 * Copyright (C) 2003-2010 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 // Additional fields (non core)
28 protected $promo = null
;
30 // Implementation of the login to uid method.
31 protected function getLogin($login)
36 throw new UserNotFoundException();
39 if ($login instanceof User
) {
43 if ($login instanceof Profile
) {
44 $this->_profile
= $login;
45 $this->_profile_fetched
= true
;
46 $res = XDB
::query('SELECT ap.uid
47 FROM account_profiles AS ap
48 WHERE ap.pid = {?} AND FIND_IN_SET(\'owner\', perms)',
50 if ($res->numRows()) {
51 return $res->fetchOneCell();
53 throw new UserNotFoundException();
56 // If $data is an integer, fetches directly the result.
57 if (is_numeric($login)) {
58 $res = XDB
::query('SELECT a.uid
60 WHERE a.uid = {?}', $login);
61 if ($res->numRows()) {
62 return $res->fetchOneCell();
65 throw new UserNotFoundException();
68 // Checks whether $login is a valid hruid or not.
69 $res = XDB
::query('SELECT a.uid
71 WHERE a.hruid = {?}', $login);
72 if ($res->numRows()) {
73 return $res->fetchOneCell();
76 // From now, $login can only by an email alias, or an email redirection.
77 // If it doesn't look like a valid address, appends the plat/al's main domain.
78 $login = trim(strtolower($login));
79 if (strstr($login, '@') === false
) {
80 $login = $login . '@' . $globals->mail
->domain
;
83 // Checks if $login is a valid alias on the main domains.
84 list($mbox, $fqdn) = explode('@', $login);
85 if ($fqdn == $globals->mail
->domain ||
$fqdn == $globals->mail
->domain2
) {
86 $res = XDB
::query('SELECT a.uid
88 INNER JOIN aliases AS al ON (al.uid = a.uid AND al.type IN (\'alias\', \'a_vie\'))
89 WHERE al.alias = {?}', $mbox);
90 if ($res->numRows()) {
91 return $res->fetchOneCell();
94 /** TODO: implements this by inspecting the profile.
95 if (preg_match('/^(.*)\.([0-9]{4})$/u', $mbox, $matches)) {
96 $res = XDB::query('SELECT a.uid
98 INNER JOIN aliases AS al ON (al.id = a.uid AND al.type IN ('alias', 'a_vie'))
99 WHERE al.alias = {?} AND a.promo = {?}', $matches[1], $matches[2]);
100 if ($res->numRows() == 1) {
101 return $res->fetchOneCell();
105 throw new UserNotFoundException();
108 // Looks for $login as an email alias from the dedicated alias domain.
109 if ($fqdn == $globals->mail
->alias_dom ||
$fqdn == $globals->mail
->alias_dom2
) {
110 $res = XDB
::query("SELECT redirect
111 FROM virtual_redirect
112 INNER JOIN virtual USING(vid)
113 WHERE alias = {?}", $mbox . '@' . $globals->mail
->alias_dom
);
114 if ($redir = $res->fetchOneCell()) {
115 // We now have a valid alias, which has to be translated to an hruid.
116 list($alias, $alias_fqdn) = explode('@', $redir);
117 $res = XDB
::query("SELECT a.uid
119 LEFT JOIN aliases AS al ON (al.uid = a.uid AND al.type IN ('alias', 'a_vie'))
120 WHERE al.alias = {?}", $alias);
121 if ($res->numRows()) {
122 return $res->fetchOneCell();
126 throw new UserNotFoundException();
129 // Looks for an account with the given email.
130 $res = XDB
::query('SELECT a.uid
132 WHERE a.email = {?}', $login);
133 if ($res->numRows() == 1) {
134 return $res->fetchOneCell();
137 // Otherwise, we do suppose $login is an email redirection.
138 $res = XDB
::query("SELECT a.uid
140 LEFT JOIN emails AS e ON (e.uid = a.uid)
141 WHERE e.email = {?}", $login);
142 if ($res->numRows() == 1) {
143 return $res->fetchOneCell();
146 throw new UserNotFoundException($res->fetchColumn(1));
149 protected static function loadMainFieldsFromUIDs(array $uids, $respect_order = true
)
154 if ($globals->asso('id')) {
155 $joins .= XDB
::format("LEFT JOIN group_members AS gpm ON (gpm.uid = a.uid AND gpm.asso_id = {?})\n", $globals->asso('id'));
156 $fields[] = 'gpm.perms AS group_perms';
157 $fields[] = 'gpm.comm AS group_comm';
159 if (count($fields) > 0) {
160 $fields = ', ' . implode(', ', $fields);
165 if ($respect_order) {
166 $order = 'ORDER BY ' . XDB
::formatCustomOrder('a.uid', $uids);
171 $uids = array_map(array('XDB', 'escape'), $uids);
173 return XDB
::iterator('SELECT a.uid, a.hruid, a.registration_date, ah.alias AS homonym,
174 CONCAT(af.alias, \'@' . $globals->mail
->domain
. '\') AS forlife,
175 CONCAT(af.alias, \'@' . $globals->mail
->domain2
. '\') AS forlife_alternate,
176 CONCAT(ab.alias, \'@' . $globals->mail
->domain
. '\') AS bestalias,
177 CONCAT(ab.alias, \'@' . $globals->mail
->domain2
. '\') AS bestalias_alternate,
178 a.full_name, a.display_name, a.sex = \'female\' AS gender,
179 IF(a.state = \'active\', at.perms, \'\') AS perms,
180 a.email_format, a.is_admin, a.state, a.type, a.skin,
181 FIND_IN_SET(\'watch\', a.flags) AS watch, a.comment,
182 a.weak_password IS NOT NULL AS weak_access,
183 a.token IS NOT NULL AS token_access,
184 (e.email IS NULL AND NOT FIND_IN_SET(\'googleapps\', eo.storage)) AND a.state != \'pending\' AS lost
187 INNER JOIN account_types AS at ON (at.type = a.type)
188 LEFT JOIN aliases AS af ON (af.uid = a.uid AND af.type = \'a_vie\')
189 LEFT JOIN aliases AS ab ON (ab.uid = a.uid AND FIND_IN_SET(\'bestalias\', ab.flags))
190 LEFT JOIN aliases AS ah ON (ah.uid = a.uid AND ah.type = \'homonyme\')
191 LEFT JOIN emails AS e ON (e.uid = a.uid AND e.flags = \'active\')
192 LEFT JOIN email_options AS eo ON (eo.uid = a.uid)
194 WHERE a.uid IN (' . implode(', ', $uids) . ')
199 // Implementation of the data loader.
200 protected function loadMainFields()
202 if ($this->hruid
!== null
&& $this->forlife
!== null
203 && $this->bestalias
!== null
&& $this->display_name
!== null
204 && $this->full_name
!== null
&& $this->perms
!== null
205 && $this->gender
!== null
&& $this->email_format
!== null
) {
208 $this->fillFromArray(self
::loadMainFieldsFromUIDs(array($this->user_id
))->next());
211 // Specialization of the fillFromArray method, to implement hacks to enable
212 // lazy loading of user's main properties from the session.
213 // TODO(vzanotti): remove the conversion hacks once the old codebase will
214 // stop being used actively.
215 protected function fillFromArray(array $values)
217 // It might happen that the 'user_id' field is called uid in some places
218 // (eg. in sessions), so we hard link uid to user_id to prevent useless
220 if (!isset($values['user_id']) && isset($values['uid'])) {
221 $values['user_id'] = $values['uid'];
224 // Also, if display_name and full_name are not known, but the user's
225 // surname and last name are, we can construct the former two.
226 if (isset($values['prenom']) && isset($values['nom'])) {
227 if (!isset($values['display_name'])) {
228 $values['display_name'] = ($values['prenom'] ?
$values['prenom'] : $values['nom']);
230 if (!isset($values['full_name'])) {
231 $values['full_name'] = $values['prenom'] . ' ' . $values['nom'];
235 // We also need to convert the gender (usually named "femme"), and the
236 // email format parameter (valued "texte" instead of "text").
237 if (isset($values['femme'])) {
238 $values['gender'] = (bool
) $values['femme'];
240 if (isset($values['mail_fmt'])) {
241 $values['email_format'] = $values['mail_fmt'];
244 parent
::fillFromArray($values);
247 // Specialization of the buildPerms method
248 // This function build 'generic' permissions for the user. It does not take
249 // into account page specific permissions (e.g X.net group permissions)
250 protected function buildPerms()
252 if (!is_null($this->perm_flags
)) {
255 if ($this->perms
=== null
) {
256 $this->loadMainFields();
258 $this->perm_flags
= self
::makePerms($this->perms
, $this->is_admin
);
261 // We do not want to store the password in the object.
262 // So, fetch it 'on demand'
263 public function password()
265 return XDB
::fetchOneCell('SELECT a.password
267 WHERE a.uid = {?}', $this->id());
270 /** Overload PlUser::promo(): there no promo defined for a user in the current
271 * schema. The promo is a field from the profile.
273 public function promo()
275 if (!$this->hasProfile()) {
278 return $this->profile()->promo();
281 public function firstName()
283 if (!$this->hasProfile()) {
284 return $this->displayName();
286 return $this->profile()->firstName();
289 public function lastName()
291 if (!$this->hasProfile()) {
294 return $this->profile()->lastName();
297 /** Return the main profile attached with this account if any.
299 public function profile()
301 if (!$this->_profile_fetched
) {
302 $this->_profile_fetched
= true
;
303 $this->_profile
= Profile
::get($this);
305 return $this->_profile
;
308 /** Return true if the user has an associated profile.
310 public function hasProfile()
312 return !is_null($this->profile());
315 /** Check if the user can edit to given profile.
317 public function canEdit(Profile
$profile)
319 // XXX: Check permissions (e.g. secretary permission)
320 // and flags from the profile
321 return XDB
::fetchOneCell('SELECT pid
322 FROM account_profiles
323 WHERE uid = {?} AND pid = {?}',
324 $this->id(), $profile->id());
327 /** Get the email alias of the user.
329 public function emailAlias()
332 $data = $this->emailAliases($globals->mail
->alias_dom
);
333 if (count($data) > 0) {
334 return array_pop($data);
339 /** Get all the aliases the user belongs to.
341 public function emailAliases($domain = null
, $type = 'user', $sub_state = false
)
343 $join = XDB
::format('(vr.redirect = {?} OR vr.redirect = {?}) ',
344 $this->forlifeEmail(), $this->m4xForlifeEmail());
346 if (!is_null($domain)) {
347 $where = XDB
::format('WHERE v.alias LIKE CONCAT("%@", {?})', $domain);
349 if (!is_null($type)) {
351 $where = XDB
::format('WHERE v.type = {?}', $type);
353 $where .= XDB
::format(' AND v.type = {?}', $type);
357 return XDB
::fetchAllAssoc('alias', 'SELECT v.alias, vr.redirect IS NOT NULL AS sub
359 LEFT JOIN virtual_redirect AS vr ON (v.vid = vr.vid AND ' . $join . ')
362 return XDB
::fetchColumn('SELECT v.alias
364 INNER JOIN virtual_redirect AS vr ON (v.vid = vr.vid AND ' . $join . ')
369 /** Get the alternative forlife email
370 * TODO: remove this uber-ugly hack. The issue is that you need to remove
371 * all @m4x.org addresses in virtual_redirect first.
372 * XXX: This is juste to make code more readable, to be remove as soon as possible
374 public function m4xForlifeEmail()
377 trigger_error('USING M4X FORLIFE', E_USER_NOTICE
);
378 return $this->login() . '@' . $globals->mail
->domain2
;
382 /** Get marketing informations
384 private function fetchMarketingData()
386 if (isset($this->last_known_email
)) {
389 $infos = XDB
::fetchOneAssoc('SELECT IF (MAX(m.last) > p.relance, MAX(m.last), p.relance) AS last_relance,
390 p.email AS last_known_email
391 FROM register_pending AS p
392 LEFT JOIN register_marketing AS m ON (p.uid = m.uid)
394 GROUP BY p.uid', $this->id());
396 $infos = array('last_relance' => null
, 'last_known_email' => null
);
398 $this->fillFromArray($infos);
401 public function lastMarketingRelance()
403 $this->fetchMarketingData();
404 return $this->last_relance
;
407 public function lastKnownEmail()
409 $this->fetchMarketingData();
410 return $this->last_known_email
;
414 /** Get watch informations
416 private function fetchWatchData()
418 if (isset($this->watch_actions
)) {
421 $watch = XDB
::fetchOneAssoc('SELECT flags AS watch_flags, actions AS watch_actions,
422 UNIX_TIMESTAMP(last) AS watch_last
424 WHERE uid = {?}', $this->id());
425 $watch['watch_flags'] = new PlFlagSet($watch['watch_flags']);
426 $watch['watch_actions'] = new PlFlagSet($watch['watch_actions']);
427 $watch['watch_promos'] = XDB
::fetchColumn('SELECT promo
429 WHERE uid = {?}', $this->id());
430 $watch['watch_users'] = XDB
::fetchColumn('SELECT ni_id
432 WHERE uid = {?}', $this->id());
433 $this->fillFromArray($watch);
436 public function watchType($type)
438 $this->fetchWatchData();
439 return $this->watch_actions
->hasFlag($type);
442 public function watchContacts()
444 $this->fetchWatchData();
445 return $this->watch_flags
->hasFlag('contacts');
448 public function watchEmail()
450 $this->fetchWatchData();
451 return $this->watch_flags
->hasFlag('mail');
454 public function watchPromos()
456 $this->fetchWatchData();
457 return $this->watch_promos
;
460 public function watchUsers()
462 $this->fetchWatchData();
463 return $this->watch_users
;
466 public function watchLast()
468 $this->fetchWatchData();
469 return $this->watch_last
;
474 private $contacts = null
;
475 private function fetchContacts()
477 if (is_null($this->contacts
)) {
478 $this->contacts
= XDB
::fetchAllAssoc('contact', 'SELECT *
485 public function iterContacts()
487 $this->fetchContacts();
488 return self
::iterOverUIDs(array_keys($this->contacts
));
491 public function getContacts()
493 $this->fetchContacts();
494 return self
::getBulkUsersWithUIDs(array_keys($this->contacts
));
497 public function isContact(PlUser
&$user)
499 $this->fetchContacts();
500 return isset($this->contacts
[$user->id()]);
504 private $groups = null
;
505 public function groups()
507 if (is_null($this->groups
)) {
508 $this->groups
= XDB
::fetchAllAssoc('asso_id', 'SELECT asso_id, perms, comm
513 return $this->groups
;
516 // Return permission flags for a given permission level.
517 public static function makePerms($perms, $is_admin)
519 $flags = new PlFlagSet($perms);
520 $flags->addFlag(PERMS_USER
);
522 $flags->addFlag(PERMS_ADMIN
);
527 // Implementation of the default user callback.
528 public static function _default_user_callback($login, $results)
530 $result_count = count($results);
531 if ($result_count == 0 ||
!S
::admin()) {
532 Platal
::page()->trigError("Il n'y a pas d'utilisateur avec l'identifiant : $login");
534 Platal
::page()->trigError("Il y a $result_count utilisateurs avec cet identifiant : " . join(', ', $results));
538 // Implementation of the static email locality checker.
539 public static function isForeignEmailAddress($email)
542 if (strpos($email, '@') === false
) {
546 list($user, $dom) = explode('@', $email);
547 return $dom != $globals->mail
->domain
&&
548 $dom != $globals->mail
->domain2
&&
549 $dom != $globals->mail
->alias_dom
&&
550 $dom != $globals->mail
->alias_dom2
;
553 public static function isVirtualEmailAddress($email)
556 if (strpos($email, '@') === false
) {
560 list($user, $dom) = explode('@', $email);
561 return $dom == $globals->mail
->alias_dom
562 ||
$dom == $globals->mail
->alias_dom2
;
565 public static function iterOverUIDs($uids, $respect_order = true
)
567 return new UserIterator(self
::loadMainFieldsFromUIDs($uids, $respect_order));
570 /** Fetch a set of users from a list of UIDs
571 * @param $data The list of uids to fetch, or an array of arrays
572 * @param $orig If $data is an array of arrays, the subfield where uids are stored
573 * @param $dest If $data is an array of arrays, the subfield to fill with Users
574 * @param $fetchProfile Whether to fetch Profiles as well
575 * @return either an array of $uid => User, or $data with $data[$i][$dest] = User
577 public static function getBulkUsersWithUIDs(array $data, $orig = null
, $dest = null
, $fetchProfile = true
)
579 // Fetch the list of uids
580 if (is_null($orig)) {
583 if (is_null($dest)) {
587 foreach ($data as $key=>$entry) {
588 if (isset($entry[$orig])) {
589 $uids[] = $entry[$orig];
595 if (count($uids) == 0) {
598 $users = self
::iterOverUIDs($uids, true
);
602 $profiles = Profile
::iterOverUIDS($uids, true
);
603 $profile = $profiles->next();
606 /** We iterate through the users, moving in
607 * profiles when they match the user ID :
608 * there can be users without a profile, but not
609 * the other way around.
611 while (($user = $users->next())) {
613 if ($profile->owner_id
== $user->id()) {
614 $user->_profile
= $profile;
615 $profile = $profiles->next();
617 $user->_profile_fetched
= true
;
619 $table[$user->id()] = $user;
622 // Build the result with respect to input order.
623 if (is_null($orig)) {
626 foreach ($data as $key=>$entry) {
627 if (isset($entry[$orig])) {
628 $entry[$dest] = $table[$entry[$orig]];
629 $data[$key] = $entry;
636 public static function getBulkUsersFromDB($fetchProfile = true
)
638 $args = func_get_args();
639 $uids = call_user_func_array(array('XDB', 'fetchColumn'), $args);
640 return self
::getBulkUsersWithUIDs($uids, null
, null
, $fetchProfile);
644 /** Iterator over a set of Users
645 * @param an XDB::Iterator obtained from a User::loadMainFieldsFromUIDs
647 class UserIterator
implements PlIterator
651 public function __construct($dbiter)
653 $this->dbiter
= $dbiter;
656 public function next()
658 $data = $this->dbiter
->next();
662 return User
::getSilentWithValues(null
, $data);
666 public function total()
668 return $this->dbiter
->total();
671 public function first()
673 return $this->dbiter
->first();
676 public function last()
678 return $this->dbiter
->last();
682 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: