classes/user.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2010 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     private $_profile_fetched = false;
  25     private $_profile = null;
  26
  27     // Additional fields (non core)
  28     protected $promo = null;
  29
  30     // Implementation of the login to uid method.
  31     protected function getLogin($login)
  32     {
  33         global $globals;
  34
  35         if (!$login) {
  36             throw new UserNotFoundException();
  37         }
  38
  39         if ($login instanceof User) {
  40             $machin->id();
  41         }
  42
  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)',
  49                               $login->id());
  50             if ($res->numRows()) {
  51                 return $res->fetchOneCell();
  52             }
  53             throw new UserNotFoundException();
  54         }
  55
  56         // If $data is an integer, fetches directly the result.
  57         if (is_numeric($login)) {
  58             $res = XDB::query('SELECT  a.uid
  59                                  FROM  accounts AS a
  60                                 WHERE  a.uid = {?}', $login);
  61             if ($res->numRows()) {
  62                 return $res->fetchOneCell();
  63             }
  64
  65             throw new UserNotFoundException();
  66         }
  67
  68         // Checks whether $login is a valid hruid or not.
  69         $res = XDB::query('SELECT  a.uid
  70                              FROM  accounts AS a
  71                             WHERE  a.hruid = {?}', $login);
  72         if ($res->numRows()) {
  73             return $res->fetchOneCell();
  74         }
  75
  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;
  81         }
  82
  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
  87                                  FROM  accounts AS a
  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();
  92             }
  93
  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
  97                                      FROM  accounts AS a
  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();
 102                 }
 103             }*/
 104
 105             throw new UserNotFoundException();
 106         }
 107
 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
 118                                      FROM  accounts AS a
 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();
 123                 }
 124             }
 125
 126             throw new UserNotFoundException();
 127         }
 128
 129         // Looks for an account with the given email.
 130         $res = XDB::query('SELECT  a.uid
 131                              FROM  accounts AS a
 132                             WHERE  a.email = {?}', $login);
 133         if ($res->numRows() == 1) {
 134             return $res->fetchOneCell();
 135         }
 136
 137         // Otherwise, we do suppose $login is an email redirection.
 138         $res = XDB::query("SELECT  a.uid
 139                              FROM  accounts AS a
 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();
 144         }
 145
 146         throw new UserNotFoundException($res->fetchColumn(1));
 147     }
 148
 149     protected static function loadMainFieldsFromUIDs(array $uids, $respect_order = true)
 150     {
 151         global $globals;
 152         $joins = '';
 153         $fields = array();
 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';
 158         }
 159         if (count($fields) > 0) {
 160             $fields = ', ' . implode(', ', $fields);
 161         } else {
 162             $fields = '';
 163         }
 164
 165         if ($respect_order) {
 166             $order = 'ORDER BY ' . XDB::formatCustomOrder('a.uid', $uids);
 167         } else {
 168             $order = '';
 169         }
 170
 171         $uids = array_map(array('XDB', 'escape'), $uids);
 172
 173         return XDB::iterator('SELECT  a.uid, a.hruid, a.registration_date,
 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
 185                                       ' . $fields . '
 186                                 FROM  accounts AS a
 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  emails AS e ON (e.uid = a.uid AND e.flags = \'active\')
 191                            LEFT JOIN  email_options AS eo ON (eo.uid = a.uid)
 192                                    ' . $joins . '
 193                                WHERE  a.uid IN (' . implode(', ', $uids) . ')
 194                             GROUP BY  a.uid
 195                                    ' . $order);
 196     }
 197
 198     // Implementation of the data loader.
 199     protected function loadMainFields()
 200     {
 201         if ($this->hruid !== null && $this->forlife !== null
 202             && $this->bestalias !== null && $this->display_name !== null
 203             && $this->full_name !== null && $this->perms !== null
 204             && $this->gender !== null && $this->email_format !== null) {
 205             return;
 206         }
 207         $this->fillFromArray(self::loadMainFieldsFromUIDs(array($this->user_id))->next());
 208     }
 209
 210     // Specialization of the fillFromArray method, to implement hacks to enable
 211     // lazy loading of user's main properties from the session.
 212     // TODO(vzanotti): remove the conversion hacks once the old codebase will
 213     // stop being used actively.
 214     protected function fillFromArray(array $values)
 215     {
 216         // It might happen that the 'user_id' field is called uid in some places
 217         // (eg. in sessions), so we hard link uid to user_id to prevent useless
 218         // SQL requests.
 219         if (!isset($values['user_id']) && isset($values['uid'])) {
 220             $values['user_id'] = $values['uid'];
 221         }
 222
 223         // Also, if display_name and full_name are not known, but the user's
 224         // surname and last name are, we can construct the former two.
 225         if (isset($values['prenom']) && isset($values['nom'])) {
 226             if (!isset($values['display_name'])) {
 227                 $values['display_name'] = ($values['prenom'] ? $values['prenom'] : $values['nom']);
 228             }
 229             if (!isset($values['full_name'])) {
 230                 $values['full_name'] = $values['prenom'] . ' ' . $values['nom'];
 231             }
 232         }
 233
 234         // We also need to convert the gender (usually named "femme"), and the
 235         // email format parameter (valued "texte" instead of "text").
 236         if (isset($values['femme'])) {
 237             $values['gender'] = (bool) $values['femme'];
 238         }
 239         if (isset($values['mail_fmt'])) {
 240             $values['email_format'] = $values['mail_fmt'];
 241         }
 242
 243         parent::fillFromArray($values);
 244     }
 245
 246     // Specialization of the buildPerms method
 247     // This function build 'generic' permissions for the user. It does not take
 248     // into account page specific permissions (e.g X.net group permissions)
 249     protected function buildPerms()
 250     {
 251         if (!is_null($this->perm_flags)) {
 252             return;
 253         }
 254         if ($this->perms === null) {
 255              $this->loadMainFields();
 256         }
 257         $this->perm_flags = self::makePerms($this->perms, $this->is_admin);
 258     }
 259
 260     // We do not want to store the password in the object.
 261     // So, fetch it 'on demand'
 262     public function password()
 263     {
 264         return XDB::fetchOneCell('SELECT  a.password
 265                                     FROM  accounts AS a
 266                                    WHERE  a.uid = {?}', $this->id());
 267     }
 268
 269     /** Overload PlUser::promo(): there no promo defined for a user in the current
 270      * schema. The promo is a field from the profile.
 271      */
 272     public function promo()
 273     {
 274         if (!$this->hasProfile()) {
 275             return '';
 276         }
 277         return $this->profile()->promo();
 278     }
 279
 280     public function yearpromo()
 281     {
 282         if (!$this->hasProfile()) {
 283             return 0;
 284         }
 285         return $this->profile()->yearpromo();
 286     }
 287
 288     public function firstName()
 289     {
 290         if (!$this->hasProfile()) {
 291             return $this->displayName();
 292         }
 293         return $this->profile()->firstName();
 294     }
 295
 296     public function lastName()
 297     {
 298         if (!$this->hasProfile()) {
 299             return '';
 300         }
 301         return $this->profile()->lastName();
 302     }
 303
 304     /** Return the main profile attached with this account if any.
 305      */
 306     public function profile()
 307     {
 308         if (!$this->_profile_fetched) {
 309             $this->_profile_fetched = true;
 310             $this->_profile = Profile::get($this);
 311         }
 312         return $this->_profile;
 313     }
 314
 315     /** Return true if the user has an associated profile.
 316      */
 317     public function hasProfile()
 318     {
 319         return !is_null($this->profile());
 320     }
 321
 322     /** Check if the user can edit to given profile.
 323      */
 324     public function canEdit(Profile $profile)
 325     {
 326         // XXX: Check permissions (e.g. secretary permission)
 327         //      and flags from the profile
 328         return XDB::fetchOneCell('SELECT  pid
 329                                     FROM  account_profiles
 330                                    WHERE  uid = {?} AND pid = {?}',
 331                                  $this->id(), $profile->id());
 332     }
 333
 334     /** Get the email alias of the user.
 335      */
 336     public function emailAlias()
 337     {
 338         global $globals;
 339         $data = $this->emailAliases($globals->mail->alias_dom);
 340         if (count($data) > 0) {
 341             return array_pop($data);
 342         }
 343         return null;
 344     }
 345
 346     /** Get all the aliases the user belongs to.
 347      */
 348     public function emailAliases($domain = null, $type = 'user',  $sub_state = false)
 349     {
 350         $join = XDB::format('(vr.redirect = {?} OR vr.redirect = {?}) ',
 351                              $this->forlifeEmail(), $this->m4xForlifeEmail());
 352         $where = '';
 353         if (!is_null($domain)) {
 354             $where = XDB::format('WHERE v.alias LIKE CONCAT("%@", {?})', $domain);
 355         }
 356         if (!is_null($type)) {
 357             if (empty($where)) {
 358                 $where = XDB::format('WHERE v.type = {?}', $type);
 359             } else {
 360                 $where .= XDB::format(' AND v.type = {?}', $type);
 361             }
 362         }
 363         if ($sub_state) {
 364             return XDB::fetchAllAssoc('alias', 'SELECT  v.alias, vr.redirect IS NOT NULL AS sub
 365                                                   FROM  virtual AS v
 366                                              LEFT JOIN  virtual_redirect AS vr ON (v.vid = vr.vid AND ' . $join . ')
 367                                                  ' . $where);
 368         } else {
 369             return XDB::fetchColumn('SELECT  v.alias
 370                                        FROM  virtual AS v
 371                                  INNER JOIN  virtual_redirect AS vr ON (v.vid = vr.vid AND ' . $join . ')
 372                                      ' . $where);
 373         }
 374     }
 375
 376     /** Get the alternative forlife email
 377      * TODO: remove this uber-ugly hack. The issue is that you need to remove
 378      * all @m4x.org addresses in virtual_redirect first.
 379      * XXX: This is juste to make code more readable, to be remove as soon as possible
 380      */
 381     public function m4xForlifeEmail()
 382     {
 383         global $globals;
 384         trigger_error('USING M4X FORLIFE', E_USER_NOTICE);
 385         return $this->login() . '@' . $globals->mail->domain2;
 386     }
 387
 388
 389     /** Get marketing informations
 390      */
 391     private function fetchMarketingData()
 392     {
 393         if (isset($this->last_known_email)) {
 394             return;
 395         }
 396         $infos = XDB::fetchOneAssoc('SELECT  IF (MAX(m.last) > p.relance, MAX(m.last), p.relance) AS last_relance,
 397                                              p.email AS last_known_email
 398                                        FROM  register_pending AS p
 399                                   LEFT JOIN  register_marketing AS m ON (p.uid = m.uid)
 400                                       WHERE  p.uid = {?}
 401                                    GROUP BY  p.uid', $this->id());
 402         if (!$infos) {
 403             $infos = array('last_relance' => null, 'last_known_email' => null);
 404         }
 405         $this->fillFromArray($infos);
 406     }
 407
 408     public function lastMarketingRelance()
 409     {
 410         $this->fetchMarketingData();
 411         return $this->last_relance;
 412     }
 413
 414     public function lastKnownEmail()
 415     {
 416         $this->fetchMarketingData();
 417         return $this->last_known_email;
 418     }
 419
 420
 421     /** Get watch informations
 422      */
 423     private function fetchWatchData()
 424     {
 425         if (isset($this->watch_actions)) {
 426             return;
 427         }
 428         $watch = XDB::fetchOneAssoc('SELECT  flags AS watch_flags, actions AS watch_actions,
 429                                              UNIX_TIMESTAMP(last) AS watch_last
 430                                        FROM  watch
 431                                       WHERE  uid = {?}', $this->id());
 432         $watch['watch_flags'] = new PlFlagSet($watch['watch_flags']);
 433         $watch['watch_actions'] = new PlFlagSet($watch['watch_actions']);
 434         $watch['watch_promos'] = XDB::fetchColumn('SELECT  promo
 435                                                      FROM  watch_promo
 436                                                     WHERE  uid = {?}', $this->id());
 437         $watch['watch_users'] = XDB::fetchColumn('SELECT  ni_id
 438                                                     FROM  watch_nonins
 439                                                    WHERE  uid = {?}', $this->id());
 440         $this->fillFromArray($watch);
 441     }
 442
 443     public function watchType($type)
 444     {
 445         $this->fetchWatchData();
 446         return $this->watch_actions->hasFlag($type);
 447     }
 448
 449     public function watchContacts()
 450     {
 451         $this->fetchWatchData();
 452         return $this->watch_flags->hasFlag('contacts');
 453     }
 454
 455     public function watchEmail()
 456     {
 457         $this->fetchWatchData();
 458         return $this->watch_flags->hasFlag('mail');
 459     }
 460
 461     public function watchPromos()
 462     {
 463         $this->fetchWatchData();
 464         return $this->watch_promos;
 465     }
 466
 467     public function watchUsers()
 468     {
 469         $this->fetchWatchData();
 470         return $this->watch_users;
 471     }
 472
 473     public function watchLast()
 474     {
 475         $this->fetchWatchData();
 476         return $this->watch_last;
 477     }
 478
 479
 480     // Contacts
 481     private $contacts = null;
 482     public function isContact(PlUser &$user)
 483     {
 484         if (is_null($this->contacts)) {
 485             $this->contacts = XDB::fetchAllAssoc('contact', 'SELECT  *
 486                                                                FROM  contacts
 487                                                               WHERE  uid = {?}',
 488                                                  $this->id());
 489         }
 490         return isset($this->contacts[$user->id()]);
 491     }
 492
 493     // Groupes X
 494     private $groups = null;
 495     public function groups()
 496     {
 497         if (is_null($this->groups)) {
 498             $this->groups = XDB::fetchAllAssoc('asso_id', 'SELECT  asso_id, perms, comm
 499                                                              FROM  group_members
 500                                                             WHERE  uid = {?}',
 501                                                 $this->id());
 502         }
 503         return $this->groups;
 504     }
 505
 506     // Return permission flags for a given permission level.
 507     public static function makePerms($perms, $is_admin)
 508     {
 509         $flags = new PlFlagSet($perms);
 510         $flags->addFlag(PERMS_USER);
 511         if ($is_admin) {
 512             $flags->addFlag(PERMS_ADMIN);
 513         }
 514         return $flags;
 515     }
 516
 517     // Implementation of the default user callback.
 518     public static function _default_user_callback($login, $results)
 519     {
 520         $result_count = count($results);
 521         if ($result_count == 0 || !S::admin()) {
 522             Platal::page()->trigError("Il n'y a pas d'utilisateur avec l'identifiant : $login");
 523         } else {
 524             Platal::page()->trigError("Il y a $result_count utilisateurs avec cet identifiant : " . join(', ', $results));
 525         }
 526     }
 527
 528     // Implementation of the static email locality checker.
 529     public static function isForeignEmailAddress($email)
 530     {
 531         global $globals;
 532         if (strpos($email, '@') === false) {
 533             return false;
 534         }
 535
 536         list($user, $dom) = explode('@', $email);
 537         return $dom != $globals->mail->domain &&
 538                $dom != $globals->mail->domain2 &&
 539                $dom != $globals->mail->alias_dom &&
 540                $dom != $globals->mail->alias_dom2;
 541     }
 542
 543     public static function isVirtualEmailAddress($email)
 544     {
 545         global $globals;
 546         if (strpos($email, '@') === false) {
 547             return false;
 548         }
 549
 550         list($user, $dom) = explode('@', $email);
 551         return $dom == $globals->mail->alias_dom
 552             || $dom == $globals->mail->alias_dom2;
 553     }
 554
 555     public static function iterOverUIDs($uids, $respect_order = true)
 556     {
 557         return new UserIterator(self::loadMainFieldsFromUIDs($uids, $respect_order));
 558     }
 559
 560     /** Fetch a set of users from a list of UIDs
 561      * @param $data The list of uids to fetch, or an array of arrays
 562      * @param $orig If $data is an array of arrays, the subfield where uids are stored
 563      * @param $dest If $data is an array of arrays, the subfield to fill with Users
 564      * @param $fetchProfile Whether to fetch Profiles as well
 565      * @return either an array of $uid => User, or $data with $data[$i][$dest] = User
 566      */
 567     public static function getBulkUsersWithUIDs(array $data, $orig = null, $dest = null, $fetchProfile = true)
 568     {
 569         // Fetch the list of uids
 570         if (is_null($orig)) {
 571             $uids = $data;
 572         } else {
 573             if (is_null($dest)) {
 574                 $dest = $orig;
 575             }
 576             $uids = array();
 577             foreach ($data as $key=>$entry) {
 578                 if (isset($entry[$orig])) {
 579                     $uids[] = $entry[$orig];
 580                 }
 581             }
 582         }
 583
 584         // Fetch users
 585         if (count($uids) == 0) {
 586             return $data;
 587         }
 588         $users = self::iterOverUIDs($uids, true);
 589
 590         $table = array();
 591         if ($fetchProfile) {
 592             $profiles = Profile::iterOverUIDS($uids, true);
 593             $profile = $profiles->next();
 594         }
 595
 596         /** We iterate through the users, moving in
 597          * profiles when they match the user ID :
 598          * there can be users without a profile, but not
 599          * the other way around.
 600          */
 601         while (($user = $users->next())) {
 602             if ($fetchProfile) {
 603                 if ($profile->owner_id == $user->id()) {
 604                     $user->_profile = $profile;
 605                     $profile = $profiles->next();
 606                 }
 607                 $user->_profile_fetched = true;
 608             }
 609             $table[$user->id()] = $user;
 610         }
 611
 612         // Build the result with respect to input order.
 613         if (is_null($orig)) {
 614             return $table;
 615         } else {
 616             foreach ($data as $key=>$entry) {
 617                 if (isset($entry[$orig])) {
 618                     $entry[$dest] = $table[$entry[$orig]];
 619                     $data[$key] = $entry;
 620                 }
 621             }
 622             return $data;
 623         }
 624     }
 625
 626     public static function getBulkUsersFromDB($fetchProfile = true)
 627     {
 628         $args = func_get_args();
 629         $uids = call_user_func_array(array('XDB', 'fetchColumn'), $args);
 630         return self::getBulkUsersWithUIDs($uids, null, null, $fetchProfile);
 631     }
 632 }
 633
 634 /** Iterator over a set of Users
 635  * @param an XDB::Iterator obtained from a User::loadMainFieldsFromUIDs
 636  */
 637 class UserIterator implements PlIterator
 638 {
 639     private $dbiter;
 640
 641     public function __construct($dbiter)
 642     {
 643         $this->dbiter = $dbiter;
 644     }
 645
 646     public function next()
 647     {
 648         $data = $this->dbiter->next();
 649         if ($data == null) {
 650             return null;
 651         } else {
 652             return User::getSilentWithValues(null, $data);
 653         }
 654     }
 655
 656     public function total()
 657     {
 658         return $this->dbiter->total();
 659     }
 660
 661     public function first()
 662     {
 663         return $this->dbiter->first();
 664     }
 665
 666     public function last()
 667     {
 668         return $this->dbiter->last();
 669     }
 670 }
 671
 672 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 673 ?>