classes/user.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2009 Polytechnique.org                              *
   4  *  http://opensource.polytechnique.org/                                   *
   5  *                                                                         *
   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.                                    *
  10  *                                                                         *
  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.                           *
  15  *                                                                         *
  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            *
  18  *  Foundation, Inc.,                                                      *
  19  *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
  20  ***************************************************************************/
  21
  22 class User extends PlUser
  23 {
  24     // Implementation of the login to uid method.
  25     protected function getLogin($login)
  26     {
  27         global $globals;
  28
  29         // If $data is an integer, fetches directly the result.
  30         if (is_numeric($login)) {
  31             $res = XDB::query("SELECT user_id FROM auth_user_md5 WHERE user_id = {?}", $login);
  32             if ($res->numRows()) {
  33                 return $res->fetchOneCell();
  34             }
  35
  36             throw new UserNotFoundException();
  37         }
  38
  39         // Checks whether $login is a valid hruid or not.
  40         $res = XDB::query("SELECT user_id FROM auth_user_md5 WHERE hruid = {?}", $login);
  41         if ($res->numRows()) {
  42             return $res->fetchOneCell();
  43         }
  44
  45         // From now, $login can only by an email alias, or an email redirection.
  46         // If it doesn't look like a valid address, appends the plat/al's main domain.
  47         $login = trim(strtolower($login));
  48         if (strstr($login, '@') === false) {
  49             $login = $login . '@' . $globals->mail->domain;
  50         }
  51
  52         // Checks if $login is a valid alias on the main domains.
  53         list($mbox, $fqdn) = explode('@', $login);
  54         if ($fqdn == $globals->mail->domain || $fqdn == $globals->mail->domain2) {
  55             $res = XDB::query("SELECT  u.user_id
  56                                  FROM  auth_user_md5 AS u
  57                            INNER JOIN  aliases AS a ON (a.id = u.user_id AND a.type IN ('alias', 'a_vie'))
  58                                 WHERE  a.alias = {?}", $mbox);
  59             if ($res->numRows()) {
  60                 return $res->fetchOneCell();
  61             }
  62
  63             if (preg_match('/^(.*)\.([0-9]{4})$/u', $mbox, $matches)) {
  64                 $res = XDB::query("SELECT  u.user_id
  65                                      FROM  auth_user_md5 AS u
  66                                INNER JOIN  aliases AS a ON (a.id = u.user_id AND a.type IN ('alias', 'a_vie'))
  67                                     WHERE  a.alias = {?} AND u.promo = {?}", $matches[1], $matches[2]);
  68                 if ($res->numRows() == 1) {
  69                     return $res->fetchOneCell();
  70                 }
  71             }
  72
  73             throw new UserNotFoundException();
  74         }
  75
  76         // Looks for $login as an email alias from the dedicated alias domain.
  77         if ($fqdn == $globals->mail->alias_dom || $fqdn == $globals->mail->alias_dom2) {
  78             $res = XDB::query("SELECT  redirect
  79                                  FROM  virtual_redirect
  80                            INNER JOIN  virtual USING(vid)
  81                                 WHERE  alias = {?}", $mbox . '@' . $globals->mail->alias_dom);
  82             if ($redir = $res->fetchOneCell()) {
  83                 // We now have a valid alias, which has to be translated to an hruid.
  84                 list($alias, $alias_fqdn) = explode('@', $redir);
  85                 $res = XDB::query("SELECT  u.user_id
  86                                      FROM  auth_user_md5 AS u
  87                                 LEFT JOIN  aliases AS a ON (a.id = u.user_id AND a.type IN ('alias', 'a_vie'))
  88                                     WHERE  a.alias = {?}", $alias);
  89                 if ($res->numRows()) {
  90                     return $res->fetchOneCell();
  91                 }
  92             }
  93
  94             throw new UserNotFoundException();
  95         }
  96
  97         // Otherwise, we do suppose $login is an email redirection.
  98         $res = XDB::query("SELECT  u.user_id
  99                              FROM  auth_user_md5 AS u
 100                         LEFT JOIN  emails AS e ON (e.uid = u.user_id)
 101                             WHERE  e.email = {?}", $login);
 102         if ($res->numRows() == 1) {
 103             return $res->fetchOneCell();
 104         }
 105
 106         throw new UserNotFoundException($res->fetchColumn(1));
 107     }
 108
 109     // Implementation of the data loader.
 110     protected function loadMainFields()
 111     {
 112         if ($this->hruid !== null && $this->forlife !== null
 113             && $this->bestalias !== null && $this->display_name !== null
 114             && $this->full_name !== null && $this->promo !== null && $this->perms !== null
 115             && $this->gender !== null && $this->email_format !== null) {
 116             return;
 117         }
 118
 119         global $globals;
 120         $res = XDB::query("SELECT  u.hruid, d.promo,
 121                                    CONCAT(af.alias, '@{$globals->mail->domain}') AS forlife,
 122                                    CONCAT(ab.alias, '@{$globals->mail->domain}') AS bestalias,
 123                                    CONCAT(u.prenom, ' ', IF(u.nom_usage <> '', u.nom_usage, u.nom)) AS full_name,
 124                                    IF(u.prenom != '', u.prenom, u.nom) AS display_name,
 125                                    FIND_IN_SET('femme', u.flags) AS gender,
 126                                    q.core_mail_fmt AS email_format,
 127                                    u.perms
 128                              FROM  auth_user_md5 AS u
 129                        INNER JOIN  profile_display AS d ON (d.pid = u.user_id)
 130                         LEFT JOIN  auth_user_quick AS q ON (q.user_id = u.user_id)
 131                         LEFT JOIN  aliases AS af ON (af.id = u.user_id AND af.type = 'a_vie')
 132                         LEFT JOIN  aliases AS ab ON (ab.id = u.user_id AND FIND_IN_SET('bestalias', ab.flags))
 133                             WHERE  u.user_id = {?}", $this->user_id);
 134         $this->fillFromArray($res->fetchOneAssoc());
 135     }
 136
 137     // Specialization of the fillFromArray method, to implement hacks to enable
 138     // lazy loading of user's main properties from the session.
 139     // TODO(vzanotti): remove the conversion hacks once the old codebase will
 140     // stop being used actively.
 141     protected function fillFromArray(array $values)
 142     {
 143         // It might happen that the 'user_id' field is called uid in some places
 144         // (eg. in sessions), so we hard link uid to user_id to prevent useless
 145         // SQL requests.
 146         if (!isset($values['user_id']) && isset($values['uid'])) {
 147             $values['user_id'] = $values['uid'];
 148         }
 149
 150         // Also, if display_name and full_name are not known, but the user's
 151         // surname and last name are, we can construct the former two.
 152         if (isset($values['prenom']) && isset($values['nom'])) {
 153             if (!isset($values['display_name'])) {
 154                 $values['display_name'] = ($values['prenom'] ? $values['prenom'] : $values['nom']);
 155             }
 156             if (!isset($values['full_name'])) {
 157                 $values['full_name'] = $values['prenom'] . ' ' . $values['nom'];
 158             }
 159         }
 160
 161         // We also need to convert the gender (usually named "femme"), and the
 162         // email format parameter (valued "texte" instead of "text").
 163         if (isset($values['femme'])) {
 164             $values['gender'] = (bool) $values['femme'];
 165         }
 166         if (isset($values['mail_fmt'])) {
 167             $values['email_format'] = $values['mail_fmt'];
 168         }
 169         if (isset($values['email_format'])) {
 170             $values['email_format'] = ($values['email_format'] ? self::FORMAT_HTML : self::FORMAT_TEXT);
 171         }
 172
 173         parent::fillFromArray($values);
 174     }
 175
 176     // Specialization of the buildPerms method
 177     // This function build 'generic' permissions for the user. It does not take
 178     // into account page specific permissions (e.g X.net group permissions)
 179     protected function buildPerms()
 180     {
 181         if (!is_null($this->perm_flags)) {
 182             return;
 183         }
 184         if ($this->perms === null) {
 185              $this->loadMainFields();
 186         }
 187         $this->perm_flags = self::makePerms($this->perms);
 188     }
 189
 190     // Return the password of the user
 191     public function password()
 192     {
 193         return XDB::fetchOneCell('SELECT  u.password
 194                                     FROM  auth_user_md5 AS u
 195                                    WHERE  u.user_id = {?}', $this->id());
 196     }
 197
 198     // Return permission flags for a given permission level.
 199     public static function makePerms($perms)
 200     {
 201         $flags = new PlFlagSet();
 202         if (is_null($flags) || $perms == 'disabled' || $perms == 'ext') {
 203             return $flags;
 204         }
 205         $flags->addFlag(PERMS_USER);
 206         if ($perms == 'admin') {
 207             $flags->addFlag(PERMS_ADMIN);
 208         }
 209         return $flags;
 210     }
 211
 212     // Implementation of the default user callback.
 213     public static function _default_user_callback($login, $results)
 214     {
 215         $result_count = count($results);
 216         if ($result_count == 0 || !S::has_perms()) {
 217             Platal::page()->trigError("Il n'y a pas d'utilisateur avec l'identifiant : $login");
 218         } else {
 219             Platal::page()->trigError("Il y a $result_count utilisateurs avec cet identifiant : " . join(', ', $results));
 220         }
 221     }
 222
 223     // Implementation of the static email locality checker.
 224     public static function isForeignEmailAddress($email)
 225     {
 226         global $globals;
 227         if (strpos($email, '@') === false) {
 228             return false;
 229         }
 230
 231         list($user, $dom) = explode('@', $email);
 232         return $dom != $globals->mail->domain &&
 233                $dom != $globals->mail->domain2 &&
 234                $dom != $globals->mail->alias_dom &&
 235                $dom != $globals->mail->alias_dom2;
 236     }
 237 }
 238
 239 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 240 ?>