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->uid
))->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 // Also, if display_name and full_name are not known, but the user's
218 // surname and last name are, we can construct the former two.
219 if (isset($values['prenom']) && isset($values['nom'])) {
220 if (!isset($values['display_name'])) {
221 $values['display_name'] = ($values['prenom'] ?
$values['prenom'] : $values['nom']);
223 if (!isset($values['full_name'])) {
224 $values['full_name'] = $values['prenom'] . ' ' . $values['nom'];
228 // We also need to convert the gender (usually named "femme"), and the
229 // email format parameter (valued "texte" instead of "text").
230 if (isset($values['femme'])) {
231 $values['gender'] = (bool
) $values['femme'];
233 if (isset($values['mail_fmt'])) {
234 $values['email_format'] = $values['mail_fmt'];
237 parent
::fillFromArray($values);
240 // Specialization of the buildPerms method
241 // This function build 'generic' permissions for the user. It does not take
242 // into account page specific permissions (e.g X.net group permissions)
243 protected function buildPerms()
245 if (!is_null($this->perm_flags
)) {
248 if ($this->perms
=== null
) {
249 $this->loadMainFields();
251 $this->perm_flags
= self
::makePerms($this->perms
, $this->is_admin
);
254 // We do not want to store the password in the object.
255 // So, fetch it 'on demand'
256 public function password()
258 return XDB
::fetchOneCell('SELECT a.password
260 WHERE a.uid = {?}', $this->id());
263 /** Overload PlUser::promo(): there no promo defined for a user in the current
264 * schema. The promo is a field from the profile.
266 public function promo()
268 if (!$this->hasProfile()) {
271 return $this->profile()->promo();
274 public function firstName()
276 if (!$this->hasProfile()) {
277 return $this->displayName();
279 return $this->profile()->firstName();
282 public function lastName()
284 if (!$this->hasProfile()) {
287 return $this->profile()->lastName();
290 /** Return the main profile attached with this account if any.
292 public function profile()
294 if (!$this->_profile_fetched
) {
295 $this->_profile_fetched
= true
;
296 $this->_profile
= Profile
::get($this);
298 return $this->_profile
;
301 /** Return true if the user has an associated profile.
303 public function hasProfile()
305 return !is_null($this->profile());
308 /** Check if the user can edit to given profile.
310 public function canEdit(Profile
$profile)
312 // XXX: Check permissions (e.g. secretary permission)
313 // and flags from the profile
314 return XDB
::fetchOneCell('SELECT pid
315 FROM account_profiles
316 WHERE uid = {?} AND pid = {?}',
317 $this->id(), $profile->id());
320 /** Get the email alias of the user.
322 public function emailAlias()
325 $data = $this->emailAliases($globals->mail
->alias_dom
);
326 if (count($data) > 0) {
327 return array_pop($data);
332 /** Get all the aliases the user belongs to.
334 public function emailAliases($domain = null
, $type = 'user', $sub_state = false
)
336 $join = XDB
::format('(vr.redirect = {?} OR vr.redirect = {?}) ',
337 $this->forlifeEmail(), $this->m4xForlifeEmail());
339 if (!is_null($domain)) {
340 $where = XDB
::format('WHERE v.alias LIKE CONCAT("%@", {?})', $domain);
342 if (!is_null($type)) {
344 $where = XDB
::format('WHERE v.type = {?}', $type);
346 $where .= XDB
::format(' AND v.type = {?}', $type);
350 return XDB
::fetchAllAssoc('alias', 'SELECT v.alias, vr.redirect IS NOT NULL AS sub
352 LEFT JOIN virtual_redirect AS vr ON (v.vid = vr.vid AND ' . $join . ')
355 return XDB
::fetchColumn('SELECT v.alias
357 INNER JOIN virtual_redirect AS vr ON (v.vid = vr.vid AND ' . $join . ')
362 /** Get the alternative forlife email
363 * TODO: remove this uber-ugly hack. The issue is that you need to remove
364 * all @m4x.org addresses in virtual_redirect first.
365 * XXX: This is juste to make code more readable, to be remove as soon as possible
367 public function m4xForlifeEmail()
370 trigger_error('USING M4X FORLIFE', E_USER_NOTICE
);
371 return $this->login() . '@' . $globals->mail
->domain2
;
375 /** Get marketing informations
377 private function fetchMarketingData()
379 if (isset($this->last_known_email
)) {
382 $infos = XDB
::fetchOneAssoc('SELECT IF (MAX(m.last) > p.relance, MAX(m.last), p.relance) AS last_relance,
383 p.email AS last_known_email
384 FROM register_pending AS p
385 LEFT JOIN register_marketing AS m ON (p.uid = m.uid)
387 GROUP BY p.uid', $this->id());
389 $infos = array('last_relance' => null
, 'last_known_email' => null
);
391 $this->fillFromArray($infos);
394 public function lastMarketingRelance()
396 $this->fetchMarketingData();
397 return $this->last_relance
;
400 public function lastKnownEmail()
402 $this->fetchMarketingData();
403 return $this->last_known_email
;
407 /** Get watch informations
409 private function fetchWatchData()
411 if (isset($this->watch_actions
)) {
414 $watch = XDB
::fetchOneAssoc('SELECT flags AS watch_flags, actions AS watch_actions,
415 UNIX_TIMESTAMP(last) AS watch_last
417 WHERE uid = {?}', $this->id());
418 $watch['watch_flags'] = new PlFlagSet($watch['watch_flags']);
419 $watch['watch_actions'] = new PlFlagSet($watch['watch_actions']);
420 $watch['watch_promos'] = XDB
::fetchColumn('SELECT promo
422 WHERE uid = {?}', $this->id());
423 $watch['watch_users'] = XDB
::fetchColumn('SELECT ni_id
425 WHERE uid = {?}', $this->id());
426 $this->fillFromArray($watch);
429 public function watchType($type)
431 $this->fetchWatchData();
432 return $this->watch_actions
->hasFlag($type);
435 public function watchContacts()
437 $this->fetchWatchData();
438 return $this->watch_flags
->hasFlag('contacts');
441 public function watchEmail()
443 $this->fetchWatchData();
444 return $this->watch_flags
->hasFlag('mail');
447 public function watchPromos()
449 $this->fetchWatchData();
450 return $this->watch_promos
;
453 public function watchUsers()
455 $this->fetchWatchData();
456 return $this->watch_users
;
459 public function watchLast()
461 $this->fetchWatchData();
462 return $this->watch_last
;
467 private $contacts = null
;
468 private function fetchContacts()
470 if (is_null($this->contacts
)) {
471 $this->contacts
= XDB
::fetchAllAssoc('contact', 'SELECT *
478 public function iterContacts()
480 $this->fetchContacts();
481 return Profile
::iterOverPIDs(array_keys($this->contacts
));
484 public function getContacts()
486 $this->fetchContacts();
487 return Profile
::getBulkProfilesWithPIDs(array_keys($this->contacts
));
490 public function isContact(Profile
&$profile)
492 $this->fetchContacts();
493 return isset($this->contacts
[$profile->id()]);
497 private $groups = null
;
498 public function groups()
500 if (is_null($this->groups
)) {
501 $this->groups
= XDB
::fetchAllAssoc('asso_id', 'SELECT asso_id, perms, comm
506 return $this->groups
;
511 * *always deletes in: account_lost_passwords, register_marketing,
512 * register_pending, register_subs, watch_nonins, watch, watch_promo
513 * *always keeps in: account_types, accounts, aliases, axletter_ins, carvas,
514 * group_members, homonyms, newsletter_ins, register_mstats,
515 * *deletes if $clearAll: account_auth_openid, announce_read, contacts,
516 * email_options, email_send_save, emails, forum_innd, forum_profiles,
517 * forum_subs, gapps_accounts, gapps_nicknames, group_announces_read,
518 * group_member_sub_requests, reminder, requests, requests_hidden,
519 * virtual, virtual_redirect, ML
520 * *modifies if $clearAll: accounts
523 * *$clearAll == false: when a user dies, her family still needs to keep in
524 * touch with the community.
525 * *$clearAll == true: in every other case we want the account to be fully
526 * deleted so that it can not be used anymore.
528 public function clear($clearAll = true
)
530 XDB
::execute('DELETE FROM account_lost_passwords, register_marketing,
531 register_pending, register_subs, watch_nonins,
537 $groupIds = XDB
::iterator('SELECT asso_id
541 while ($groupId = $groupIds->next()) {
542 $group = Group
::get($groupId);
543 if ($group->notif_unsub
) {
544 $mailer = new PlMailer('xnetgrp/unsubscription-notif.mail.tpl');
545 $admins = $group->iterAdmins();
546 while ($admin = $admins->next()) {
547 $mailer->addTo($admin);
549 $mailer->assign('group', $group->shortname
);
550 $mailer->assign('user', $this);
551 $mailer->assign('selfdone', false
);
556 XDB
::execute('DELETE FROM account_auth_openid, announce_read, contacts,
557 email_options, email_send_save, emails,
558 forum_innd, forum_profiles, forum_subs,
559 gapps_accounts, gapps_nicknames, group_announces_read,
560 group_members, group_member_sub_requests, reminder, requests,
564 XDB
::execute("UPDATE accounts
565 SET registration_date = 0, state = 'pending', password = NULL,
566 weak_password = NULL, token = NULL, is_admin = 0
570 XDB
::execute('DELETE v.*
572 INNER JOIN virtual_redirect AS r ON (v.vid = r.vid)
573 WHERE redirect = {?} OR redirect = {?}',
574 $this->forlifeEmail(), $this->m4xForlifeEmail());
575 XDB
::execute('DELETE FROM virtual_redirect
576 WHERE redirect = {?} OR redirect = {?}',
577 $this->forlifeEmail(), $this->m4xForlifeEmail());
579 if ($globals->mailstorage
->googleapps_domain
) {
580 require_once 'googleapps.inc.php';
582 if (GoogleAppsAccount
::account_status($uid)) {
583 $account = new GoogleAppsAccount($user);
589 $mmlist = new MMList($this);
590 $mmlist->kill($alias, $clearAll);
593 // Return permission flags for a given permission level.
594 public static function makePerms($perms, $is_admin)
596 $flags = new PlFlagSet($perms);
597 $flags->addFlag(PERMS_USER
);
599 $flags->addFlag(PERMS_ADMIN
);
604 // Implementation of the default user callback.
605 public static function _default_user_callback($login, $results)
607 $result_count = count($results);
608 if ($result_count == 0 ||
!S
::admin()) {
609 Platal
::page()->trigError("Il n'y a pas d'utilisateur avec l'identifiant : $login");
611 Platal
::page()->trigError("Il y a $result_count utilisateurs avec cet identifiant : " . join(', ', $results));
615 // Implementation of the static email locality checker.
616 public static function isForeignEmailAddress($email)
619 if (strpos($email, '@') === false
) {
623 list($user, $dom) = explode('@', $email);
624 return $dom != $globals->mail
->domain
&&
625 $dom != $globals->mail
->domain2
&&
626 $dom != $globals->mail
->alias_dom
&&
627 $dom != $globals->mail
->alias_dom2
;
630 public static function isVirtualEmailAddress($email)
633 if (strpos($email, '@') === false
) {
637 list($user, $dom) = explode('@', $email);
638 return $dom == $globals->mail
->alias_dom
639 ||
$dom == $globals->mail
->alias_dom2
;
642 public static function iterOverUIDs($uids, $respect_order = true
)
644 return new UserIterator(self
::loadMainFieldsFromUIDs($uids, $respect_order));
647 /** Fetch a set of users from a list of UIDs
648 * @param $data The list of uids to fetch, or an array of arrays
649 * @param $orig If $data is an array of arrays, the subfield where uids are stored
650 * @param $dest If $data is an array of arrays, the subfield to fill with Users
651 * @param $fetchProfile Whether to fetch Profiles as well
652 * @return either an array of $uid => User, or $data with $data[$i][$dest] = User
654 public static function getBulkUsersWithUIDs(array $data, $orig = null
, $dest = null
, $fetchProfile = true
)
656 // Fetch the list of uids
657 if (is_null($orig)) {
660 if (is_null($dest)) {
664 foreach ($data as $key=>$entry) {
665 if (isset($entry[$orig])) {
666 $uids[] = $entry[$orig];
672 if (count($uids) == 0) {
675 $users = self
::iterOverUIDs($uids, true
);
679 $profiles = Profile
::iterOverUIDS($uids, true
);
680 $profile = $profiles->next();
683 /** We iterate through the users, moving in
684 * profiles when they match the user ID :
685 * there can be users without a profile, but not
686 * the other way around.
688 while (($user = $users->next())) {
690 if ($profile->owner_id
== $user->id()) {
691 $user->_profile
= $profile;
692 $profile = $profiles->next();
694 $user->_profile_fetched
= true
;
696 $table[$user->id()] = $user;
699 // Build the result with respect to input order.
700 if (is_null($orig)) {
703 foreach ($data as $key=>$entry) {
704 if (isset($entry[$orig])) {
705 $entry[$dest] = $table[$entry[$orig]];
706 $data[$key] = $entry;
713 public static function getBulkUsersFromDB($fetchProfile = true
)
715 $args = func_get_args();
716 $uids = call_user_func_array(array('XDB', 'fetchColumn'), $args);
717 return self
::getBulkUsersWithUIDs($uids, null
, null
, $fetchProfile);
721 /** Iterator over a set of Users
722 * @param an XDB::Iterator obtained from a User::loadMainFieldsFromUIDs
724 class UserIterator
implements PlIterator
728 public function __construct($dbiter)
730 $this->dbiter
= $dbiter;
733 public function next()
735 $data = $this->dbiter
->next();
739 return User
::getSilentWithValues(null
, $data);
743 public function total()
745 return $this->dbiter
->total();
748 public function first()
750 return $this->dbiter
->first();
753 public function last()
755 return $this->dbiter
->last();
759 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: