d346eb3c4e0ec1e7ef46a738a2536c437859952a
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.id = 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.id = 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)
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);
164 $uids = array_map(array('XDB', 'escape'), $uids);
165 return XDB
::iterator('SELECT a.uid, a.hruid, a.registration_date,
166 CONCAT(af.alias, \'@' . $globals->mail
->domain
. '\') AS forlife,
167 CONCAT(af.alias, \'@' . $globals->mail
->domain2
. '\') AS forlife_alternate,
168 CONCAT(ab.alias, \'@' . $globals->mail
->domain
. '\') AS bestalias,
169 CONCAT(ab.alias, \'@' . $globals->mail
->domain2
. '\') AS bestalias_alternate,
170 a.full_name, a.display_name, a.sex = \'female\' AS gender,
171 IF(a.state = \'active\', at.perms, \'\') AS perms,
172 a.email_format, a.is_admin, a.state, a.type, a.skin,
173 FIND_IN_SET(\'watch\', a.flags) AS watch, a.comment,
174 a.weak_password IS NOT NULL AS weak_access,
175 a.token IS NOT NULL AS token_access,
176 (e.email IS NULL AND NOT FIND_IN_SET(\'googleapps\', eo.storage)) AND a.state != \'pending\' AS lost
179 INNER JOIN account_types AS at ON (at.type = a.type)
180 LEFT JOIN aliases AS af ON (af.id = a.uid AND af.type = \'a_vie\')
181 LEFT JOIN aliases AS ab ON (ab.id = a.uid AND FIND_IN_SET(\'bestalias\', ab.flags))
182 LEFT JOIN emails AS e ON (e.uid = a.uid AND e.flags = \'active\')
183 LEFT JOIN email_options AS eo ON (eo.uid = a.uid)
185 WHERE a.uid IN (' . implode(', ', $uids) . ')
189 // Implementation of the data loader.
190 protected function loadMainFields()
192 if ($this->hruid
!== null
&& $this->forlife
!== null
193 && $this->bestalias
!== null
&& $this->display_name
!== null
194 && $this->full_name
!== null
&& $this->perms
!== null
195 && $this->gender
!== null
&& $this->email_format
!== null
) {
198 $this->fillFromArray(self
::loadMainFieldsFromUIDs(array($this->user_id
))->next());
201 // Specialization of the fillFromArray method, to implement hacks to enable
202 // lazy loading of user's main properties from the session.
203 // TODO(vzanotti): remove the conversion hacks once the old codebase will
204 // stop being used actively.
205 protected function fillFromArray(array $values)
207 // It might happen that the 'user_id' field is called uid in some places
208 // (eg. in sessions), so we hard link uid to user_id to prevent useless
210 if (!isset($values['user_id']) && isset($values['uid'])) {
211 $values['user_id'] = $values['uid'];
214 // Also, if display_name and full_name are not known, but the user's
215 // surname and last name are, we can construct the former two.
216 if (isset($values['prenom']) && isset($values['nom'])) {
217 if (!isset($values['display_name'])) {
218 $values['display_name'] = ($values['prenom'] ?
$values['prenom'] : $values['nom']);
220 if (!isset($values['full_name'])) {
221 $values['full_name'] = $values['prenom'] . ' ' . $values['nom'];
225 // We also need to convert the gender (usually named "femme"), and the
226 // email format parameter (valued "texte" instead of "text").
227 if (isset($values['femme'])) {
228 $values['gender'] = (bool
) $values['femme'];
230 if (isset($values['mail_fmt'])) {
231 $values['email_format'] = $values['mail_fmt'];
234 parent
::fillFromArray($values);
237 // Specialization of the buildPerms method
238 // This function build 'generic' permissions for the user. It does not take
239 // into account page specific permissions (e.g X.net group permissions)
240 protected function buildPerms()
242 if (!is_null($this->perm_flags
)) {
245 if ($this->perms
=== null
) {
246 $this->loadMainFields();
248 $this->perm_flags
= self
::makePerms($this->perms
, $this->is_admin
);
251 // We do not want to store the password in the object.
252 // So, fetch it 'on demand'
253 public function password()
255 return XDB
::fetchOneCell('SELECT a.password
257 WHERE a.uid = {?}', $this->id());
260 /** Overload PlUser::promo(): there no promo defined for a user in the current
261 * schema. The promo is a field from the profile.
263 public function promo()
265 if (!$this->hasProfile()) {
268 return $this->profile()->promo();
271 public function firstName()
273 if (!$this->hasProfile()) {
274 return $this->displayName();
276 return $this->profile()->firstName();
279 public function lastName()
281 if (!$this->hasProfile()) {
284 return $this->profile()->lastName();
287 /** Return the main profile attached with this account if any.
289 public function profile()
291 if (!$this->_profile_fetched
) {
292 $this->_profile_fetched
= true
;
293 $this->_profile
= Profile
::get($this);
295 return $this->_profile
;
298 /** Return true if the user has an associated profile.
300 public function hasProfile()
302 return !is_null($this->profile());
305 /** Check if the user can edit to given profile.
307 public function canEdit(Profile
$profile)
309 // XXX: Check permissions (e.g. secretary permission)
310 // and flags from the profile
311 return XDB
::fetchOneCell('SELECT pid
312 FROM account_profiles
313 WHERE uid = {?} AND pid = {?}',
314 $this->id(), $profile->id());
317 /** Get the email alias of the user.
319 public function emailAlias()
322 $data = $this->emailAliases($globals->mail
->alias_dom
);
323 if (count($data) > 0) {
324 return array_pop($data);
329 /** Get all the aliases the user belongs to.
331 public function emailAliases($domain = null
, $type = 'user', $sub_state = false
)
333 $join = XDB
::format('(vr.redirect = {?} OR vr.redirect = {?}) ',
334 $this->forlifeEmail(), $this->m4xForlifeEmail());
336 if (!is_null($domain)) {
337 $where = XDB
::format('WHERE v.alias LIKE CONCAT("%@", {?})', $domain);
339 if (!is_null($type)) {
341 $where = XDB
::format('WHERE v.type = {?}', $type);
343 $where .= XDB
::format(' AND v.type = {?}', $type);
347 return XDB
::fetchAllAssoc('alias', 'SELECT v.alias, vr.redirect IS NOT NULL AS sub
349 LEFT JOIN virtual_redirect AS vr ON (v.vid = vr.vid AND ' . $join . ')
352 return XDB
::fetchColumn('SELECT v.alias
354 INNER JOIN virtual_redirect AS vr ON (v.vid = vr.vid AND ' . $join . ')
359 /** Get the alternative forlife email
360 * TODO: remove this uber-ugly hack. The issue is that you need to remove
361 * all @m4x.org addresses in virtual_redirect first.
362 * XXX: This is juste to make code more readable, to be remove as soon as possible
364 public function m4xForlifeEmail()
367 trigger_error('USING M4X FORLIFE', E_USER_NOTICE
);
368 return $this->login() . '@' . $globals->mail
->domain2
;
372 /** Get marketing informations
374 private function fetchMarketingData()
376 if (isset($this->last_known_email
)) {
379 $infos = XDB
::fetchOneAssoc('SELECT IF (MAX(m.last) > p.relance, MAX(m.last), p.relance) AS last_relance,
380 p.email AS last_known_email
381 FROM register_pending AS p
382 LEFT JOIN register_marketing AS m ON (p.uid = m.uid)
384 GROUP BY p.uid', $this->id());
386 $infos = array('last_relance' => null
, 'last_known_email' => null
);
388 $this->fillFromArray($infos);
391 public function lastMarketingRelance()
393 $this->fetchMarketingData();
394 return $this->last_relance
;
397 public function lastKnownEmail()
399 $this->fetchMarketingData();
400 return $this->last_known_email
;
404 /** Get watch informations
406 private function fetchWatchData()
408 if (isset($this->watch_actions
)) {
411 $watch = XDB
::fetchOneAssoc('SELECT flags AS watch_flags, actions AS watch_actions,
412 UNIX_TIMESTAMP(last) AS watch_last
414 WHERE uid = {?}', $this->id());
415 $watch['watch_flags'] = new PlFlagSet($watch['watch_flags']);
416 $watch['watch_actions'] = new PlFlagSet($watch['watch_actions']);
417 $watch['watch_promos'] = XDB
::fetchColumn('SELECT promo
419 WHERE uid = {?}', $this->id());
420 $watch['watch_users'] = XDB
::fetchColumn('SELECT ni_id
422 WHERE uid = {?}', $this->id());
423 $this->fillFromArray($watch);
426 public function watch($type)
428 $this->fetchWatchData();
429 return $this->watch_actions
->hasFlag($type);
432 public function watchContacts()
434 $this->fetchWatchData();
435 return $this->watch_flags
->hasFlag('contacts');
438 public function watchEmail()
440 $this->fetchWatchData();
441 return $this->watch_flags
->hasFlag('mail');
444 public function watchPromos()
446 $this->fetchWatchData();
447 return $this->watch_promos
;
450 public function watchUsers()
452 $this->fetchWatchData();
453 return $this->watch_users
;
456 public function watchLast()
458 $this->fetchWatchData();
459 return $this->watch_last
;
464 private $contacts = null
;
465 public function isContact(PlUser
&$user)
467 if (is_null($this->contacts
)) {
468 $this->contacts
= XDB
::fetchAllAssoc('contact', 'SELECT *
473 return isset($this->contacts
[$user->id()]);
477 private $groups = null
;
478 public function groups()
480 if (is_null($this->groups
)) {
481 $this->groups
= XDB
::fetchAllAssoc('asso_id', 'SELECT asso_id, perms, comm
482 FROM #groupex#.membres
486 return $this->groups
;
489 // Return permission flags for a given permission level.
490 public static function makePerms($perms, $is_admin)
492 $flags = new PlFlagSet($perms);
493 $flags->addFlag(PERMS_USER
);
495 $flags->addFlag(PERMS_ADMIN
);
500 // Implementation of the default user callback.
501 public static function _default_user_callback($login, $results)
503 $result_count = count($results);
504 if ($result_count == 0 ||
!S
::admin()) {
505 Platal
::page()->trigError("Il n'y a pas d'utilisateur avec l'identifiant : $login");
507 Platal
::page()->trigError("Il y a $result_count utilisateurs avec cet identifiant : " . join(', ', $results));
511 // Implementation of the static email locality checker.
512 public static function isForeignEmailAddress($email)
515 if (strpos($email, '@') === false
) {
519 list($user, $dom) = explode('@', $email);
520 return $dom != $globals->mail
->domain
&&
521 $dom != $globals->mail
->domain2
&&
522 $dom != $globals->mail
->alias_dom
&&
523 $dom != $globals->mail
->alias_dom2
;
526 public static function isVirtualEmailAddress($email)
529 if (strpos($email, '@') === false
) {
533 list($user, $dom) = explode('@', $email);
534 return $dom == $globals->mail
->alias_dom
535 ||
$dom == $globals->mail
->alias_dom2
;
538 // Fetch a set of users from a list of UIDs
539 public static function getBulkUsersWithUIDs(array $data, $orig = null
, $dest = null
, $fetchProfile = true
)
541 // Fetch the list of uids
542 if (is_null($orig)) {
545 if (is_null($dest)) {
549 foreach ($data as $key=>$entry) {
550 if (isset($entry[$orig])) {
551 $uids[] = $entry[$orig];
557 if (count($uids) == 0) {
560 $fields = self
::loadMainFieldsFromUIDs($uids);
563 $profiles = Profile
::getBulkProfilesWithUIDS($uids);
565 while (($list = $fields->next())) {
567 $user = User
::getSilentWithValues(null
, $list);
569 if (isset($profiles[$uid])) {
570 $user->_profile
= $profiles[$uid];
572 $user->_profile_fetched
= true
;
574 $table[$list['uid']] = $user;
577 // Build the result with respect to input order.
578 if (is_null($orig)) {
580 foreach ($uids as $key=>$uid) {
581 $users[$key] = $table[$uid];
585 foreach ($data as $key=>$entry) {
586 if (isset($entry[$orig])) {
587 $entry[$dest] = $table[$entry[$orig]];
588 $data[$key] = $entry;
595 public static function getBulkUsersFromDB($fetchProfile = true
)
597 $args = func_get_args();
598 $uids = call_user_func_array(array('XDB', 'fetchColumn'), $args);
599 return self
::getBulkUsersWithUIDs($uids, null
, null
, $fetchProfile);
603 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: