2 /***************************************************************************
3 * Copyright (C) 2003-2008 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 Profile
) {
33 $this->_profile
= $login;
34 $this->_profile_fetched
= true
;
35 $res = XDB
::query('SELECT ap.uid
36 FROM account_profiles AS ap
37 WHERE ap.pid = {?} AND FIND_IN_SET(\'owner\', perms)',
39 if ($res->numRows()) {
40 return $res->fetchOneCell();
42 throw new UserNotFoundException();
45 // If $data is an integer, fetches directly the result.
46 if (is_numeric($login)) {
47 $res = XDB
::query('SELECT a.uid
49 WHERE a.uid = {?}', $login);
50 if ($res->numRows()) {
51 return $res->fetchOneCell();
54 throw new UserNotFoundException();
57 // Checks whether $login is a valid hruid or not.
58 $res = XDB
::query('SELECT a.uid
60 WHERE a.hruid = {?}', $login);
61 if ($res->numRows()) {
62 return $res->fetchOneCell();
65 // From now, $login can only by an email alias, or an email redirection.
66 // If it doesn't look like a valid address, appends the plat/al's main domain.
67 $login = trim(strtolower($login));
68 if (strstr($login, '@') === false
) {
69 $login = $login . '@' . $globals->mail
->domain
;
72 // Checks if $login is a valid alias on the main domains.
73 list($mbox, $fqdn) = explode('@', $login);
74 if ($fqdn == $globals->mail
->domain ||
$fqdn == $globals->mail
->domain2
) {
75 $res = XDB
::query('SELECT a.uid
77 INNER JOIN aliases AS al ON (al.id = a.uid AND al.type IN (\'alias\', \'a_vie\'))
78 WHERE al.alias = {?}', $mbox);
79 if ($res->numRows()) {
80 return $res->fetchOneCell();
83 /** TODO: implements this by inspecting the profile.
84 if (preg_match('/^(.*)\.([0-9]{4})$/u', $mbox, $matches)) {
85 $res = XDB::query('SELECT a.uid
87 INNER JOIN aliases AS al ON (al.id = a.uid AND al.type IN ('alias', 'a_vie'))
88 WHERE al.alias = {?} AND a.promo = {?}', $matches[1], $matches[2]);
89 if ($res->numRows() == 1) {
90 return $res->fetchOneCell();
94 throw new UserNotFoundException();
97 // Looks for $login as an email alias from the dedicated alias domain.
98 if ($fqdn == $globals->mail
->alias_dom ||
$fqdn == $globals->mail
->alias_dom2
) {
99 $res = XDB
::query("SELECT redirect
100 FROM virtual_redirect
101 INNER JOIN virtual USING(vid)
102 WHERE alias = {?}", $mbox . '@' . $globals->mail
->alias_dom
);
103 if ($redir = $res->fetchOneCell()) {
104 // We now have a valid alias, which has to be translated to an hruid.
105 list($alias, $alias_fqdn) = explode('@', $redir);
106 $res = XDB
::query("SELECT a.uid
108 LEFT JOIN aliases AS al ON (al.id = a.uid AND al.type IN ('alias', 'a_vie'))
109 WHERE al.alias = {?}", $alias);
110 if ($res->numRows()) {
111 return $res->fetchOneCell();
115 throw new UserNotFoundException();
118 // Looks for an account with the given email.
119 $res = XDB
::query('SELECT a.uid
121 WHERE a.email = {?}', $login);
122 if ($res->numRows() == 1) {
123 return $res->fetchOneCell();
126 // Otherwise, we do suppose $login is an email redirection.
127 $res = XDB
::query("SELECT a.uid
129 LEFT JOIN emails AS e ON (e.uid = a.uid)
130 WHERE e.email = {?}", $login);
131 if ($res->numRows() == 1) {
132 return $res->fetchOneCell();
135 throw new UserNotFoundException($res->fetchColumn(1));
138 protected static function loadMainFieldsFromUIDs(array $uids, $sorted = null
)
144 if (!is_null($sorted)) {
148 foreach (explode(',', $sorted) as $part) {
149 $desc = ($part[0] == '-');
151 $part = substr($desc, 1);
157 $part = 'IF (pd.promo IS NULL, \'ext\', pd.promo)';
160 $part = 'a.full_name';
163 $part = 'a.display_name';
168 if (!is_null($part)) {
175 if (count($order) > 0) {
177 $joins .= "LEFT JOIN account_profiles AS ap ON (ap.uid = a.uid AND FIND_IN_SET('owner', ap.perms))\n";
180 $joins .= "LEFT JOIN profile_display AS pd ON (pd.pid = ap.pid)\n";
182 $orderby = 'ORDER BY ' . implode(', ', $order);
185 if ($globals->asso('id')) {
186 $joins .= XDB
::format("LEFT JOIN groupex.membres AS gpm ON (gpm.uid = a.uid AND gpm.asso_id = {?})\n", $globals->asso('id'));
187 $fields[] = 'gpm.perms AS group_perms';
189 if (count($fields) > 0) {
190 $fields = ', ' . implode(', ', $fields);
194 $uids = array_map(array('XDB', 'escape'), $uids);
195 return XDB
::iterator('SELECT a.uid, a.hruid, a.registration_date,
196 CONCAT(af.alias, \'@' . $globals->mail
->domain
. '\') AS forlife,
197 CONCAT(ab.alias, \'@' . $globals->mail
->domain
. '\') AS bestalias,
198 a.full_name, a.display_name, a.sex = \'female\' AS gender,
199 IF(a.state = \'active\', at.perms, \'\') AS perms,
200 a.email_format, a.is_admin, a.state, a.type, a.skin,
201 FIND_IN_SET(\'watch\', a.flags) AS watch, a.comment,
202 a.weak_password IS NOT NULL AS weak_access,
203 a.token IS NOT NULL AS token_access ' . $fields . '
205 INNER JOIN account_types AS at ON (at.type = a.type)
206 LEFT JOIN aliases AS af ON (af.id = a.uid AND af.type = \'a_vie\')
207 LEFT JOIN aliases AS ab ON (ab.id = a.uid AND FIND_IN_SET(\'bestalias\', ab.flags))
209 WHERE a.uid IN (' . implode(', ', $uids) . ')
213 // Implementation of the data loader.
214 protected function loadMainFields()
216 if ($this->hruid
!== null
&& $this->forlife
!== null
217 && $this->bestalias
!== null
&& $this->display_name
!== null
218 && $this->full_name
!== null
&& $this->perms
!== null
219 && $this->gender
!== null
&& $this->email_format
!== null
) {
222 $this->fillFromArray(self
::loadMainFieldsFromUIDs(array($this->user_id
))->next());
225 // Specialization of the fillFromArray method, to implement hacks to enable
226 // lazy loading of user's main properties from the session.
227 // TODO(vzanotti): remove the conversion hacks once the old codebase will
228 // stop being used actively.
229 protected function fillFromArray(array $values)
231 // It might happen that the 'user_id' field is called uid in some places
232 // (eg. in sessions), so we hard link uid to user_id to prevent useless
234 if (!isset($values['user_id']) && isset($values['uid'])) {
235 $values['user_id'] = $values['uid'];
238 // Also, if display_name and full_name are not known, but the user's
239 // surname and last name are, we can construct the former two.
240 if (isset($values['prenom']) && isset($values['nom'])) {
241 if (!isset($values['display_name'])) {
242 $values['display_name'] = ($values['prenom'] ?
$values['prenom'] : $values['nom']);
244 if (!isset($values['full_name'])) {
245 $values['full_name'] = $values['prenom'] . ' ' . $values['nom'];
249 // We also need to convert the gender (usually named "femme"), and the
250 // email format parameter (valued "texte" instead of "text").
251 if (isset($values['femme'])) {
252 $values['gender'] = (bool
) $values['femme'];
254 if (isset($values['mail_fmt'])) {
255 $values['email_format'] = $values['mail_fmt'];
258 parent
::fillFromArray($values);
261 // Specialization of the buildPerms method
262 // This function build 'generic' permissions for the user. It does not take
263 // into account page specific permissions (e.g X.net group permissions)
264 protected function buildPerms()
266 if (!is_null($this->perm_flags
)) {
269 if ($this->perms
=== null
) {
270 $this->loadMainFields();
272 $this->perm_flags
= self
::makePerms($this->perms
, $this->is_admin
);
275 // We do not want to store the password in the object.
276 // So, fetch it 'on demand'
277 public function password()
279 return XDB
::fetchOneCell('SELECT a.password
281 WHERE a.uid = {?}', $this->id());
284 /** Overload PlUser::promo(): there no promo defined for a user in the current
285 * schema. The promo is a field from the profile.
287 public function promo()
289 if (!$this->hasProfile()) {
292 return $this->profile()->promo();
295 /** Return the main profile attached with this account if any.
297 public function profile()
299 if (!$this->_profile_fetched
) {
300 $this->_profile_fetched
= true
;
301 $this->_profile
= Profile
::get($this);
303 return $this->_profile
;
306 /** Return true if the user has an associated profile.
308 public function hasProfile()
310 return !is_null($this->profile());
313 /** Check if the user can edit to given profile.
315 public function canEdit(Profile
$profile)
317 // XXX: Check permissions (e.g. secretary permission)
318 // and flags from the profile
319 return XDB
::fetchOneCell('SELECT pid
320 FROM account_profiles
321 WHERE uid = {?} AND pid = {?}',
322 $this->id(), $profile->id());
325 /** Get the email alias of the user.
327 public function emailAlias()
330 $data = $this->emailAliases($globals->mail
->alias_dom
);
331 if (count($data) > 0) {
332 return array_pop($data);
337 /** Get all the aliases the user belongs to.
339 public function emailAliases($domain = null
)
342 if (!is_null($domain)) {
343 $where = XDB
::format(' AND alias LIKE CONCAT("%@", {?})', $domain);
345 return XDB
::fetchColumn('SELECT v.alias
347 INNER JOIN virtual_redirect AS vr ON (v.vid = vr.vid)
348 WHERE (vr.redirect = {?} OR vr.redirect = {?})
350 $this->forlifeEmail(), $this->m4xForlifeEmail());
353 /** Get the alternative forlife email
354 * TODO: remove this uber-ugly hack. The issue is that you need to remove
355 * all @m4x.org addresses in virtual_redirect first.
356 * XXX: This is juste to make code more readable, to be remove as soon as possible
358 public function m4xForlifeEmail()
361 trigger_error('USING M4X FORLIFE', E_USER_NOTICE
);
362 return $this->login() . '@' . $globals->mail
->domain2
;
365 // Return permission flags for a given permission level.
366 public static function makePerms($perms, $is_admin)
368 $flags = new PlFlagSet($perms);
369 $flags->addFlag(PERMS_USER
);
371 $flags->addFlag(PERMS_ADMIN
);
376 // Implementation of the default user callback.
377 public static function _default_user_callback($login, $results)
379 $result_count = count($results);
380 if ($result_count == 0 ||
!S
::has_perms()) {
381 Platal
::page()->trigError("Il n'y a pas d'utilisateur avec l'identifiant : $login");
383 Platal
::page()->trigError("Il y a $result_count utilisateurs avec cet identifiant : " . join(', ', $results));
387 // Implementation of the static email locality checker.
388 public static function isForeignEmailAddress($email)
391 if (strpos($email, '@') === false
) {
395 list($user, $dom) = explode('@', $email);
396 return $dom != $globals->mail
->domain
&&
397 $dom != $globals->mail
->domain2
&&
398 $dom != $globals->mail
->alias_dom
&&
399 $dom != $globals->mail
->alias_dom2
;
402 // Fetch a set of users from a list of UIDs
403 public static function getBuildUsersWithUIDs(array $uids, $sortby = null
)
405 $fields = self
::loadMainFieldsFromUIDs($uids, $sortby);
407 while (($list = $fields->next())) {
408 $users[] = User
::getSilentWithValues(null
, $list);
414 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: