classes/pluser.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 /**
  23  * PlUserNotFound is raised when a user id cannot be linked to a real user.
  24  * The @p results give the list hruids (useful when several users are found).
  25  */
  26 class UserNotFoundException extends Exception
  27 {
  28     public function __construct($results = array())
  29     {
  30         $this->results = $results;
  31         parent::__construct();
  32     }
  33 }
  34
  35 /**
  36  * Represents an user of plat/al (without any further assumption), with a
  37  * special focus on always-used properties (identification fields, display name,
  38  * forlife/bestalias emails, ...).
  39  * NOTE: each implementation of plat/al-code MUST subclass PlUser, and name it
  40  * 'User'.
  41  */
  42 abstract class PlUser
  43 {
  44     /**
  45      * User data enumerations.
  46      */
  47     const GENDER_FEMALE = true;
  48     const GENDER_MALE = false;
  49     const FORMAT_HTML = "html";
  50     const FORMAT_TEXT = "text";
  51
  52     /**
  53      * User data storage.
  54      * By convention, null means the information hasn't been fetched yet, and
  55      * false means the information is not available.
  56      */
  57
  58     // uid is internal user ID (potentially numeric), whereas hruid is a
  59     // "human readable" unique ID
  60     protected $uid = null;
  61     protected $hruid = null;
  62
  63     // User main email aliases (forlife is the for-life email address, bestalias
  64     // is user-chosen preferred email address).
  65     protected $forlife = null;
  66     protected $bestalias = null;
  67
  68     // Display name is user-chosen name to display (eg. in "Welcome
  69     // <display name> !"), while full name is the official full name.
  70     protected $display_name = null;
  71     protected $full_name = null;
  72
  73     // Other important parameters used when sending emails.
  74     protected $gender = null;  // Acceptable values are GENDER_MALE and GENDER_FEMALE
  75     protected $email_format = null;  // Acceptable values are FORMAT_HTML and FORMAT_TEXT
  76
  77     // Permissions
  78     protected $perms = null;
  79     protected $perm_flags = null;
  80
  81     // Other properties are listed in this key-value hash map.
  82     protected $data = array();
  83
  84     /**
  85      * Constructs the PlUser object from an identifier (any identifier which is
  86      * understood by getLogin() implementation).
  87      *
  88      * @param $login An user login.
  89      * @param $values List of known user properties.
  90      */
  91     public function __construct($login, $values = array())
  92     {
  93         $this->fillFromArray($values);
  94
  95         // If the user id was not part of the known values, determines it from
  96         // the login.
  97         if (!$this->uid) {
  98             $this->uid = $this->getLogin($login);
  99         }
 100
 101         // Preloads main properties (assumes the loader will lazily get them
 102         // from variables already set in the object).
 103         $this->loadMainFields();
 104     }
 105
 106     /**
 107      * Get the canonical user id for the @p login.
 108      *
 109      * @param $login An user login.
 110      * @return The canonical user id.
 111      * @throws UserNotFoundException when login is not found.
 112      */
 113     abstract protected function getLogin($login);
 114
 115     /**
 116      * Loads the main properties (hruid, forlife, bestalias, ...) from the
 117      * database. Should return immediately when the properties are already
 118      * available.
 119      */
 120     abstract protected function loadMainFields();
 121
 122     /**
 123      * Accessors to the main properties, ie. those available as top level
 124      * object variables.
 125      */
 126     public function id()
 127     {
 128         return $this->uid;
 129     }
 130
 131     public function login()
 132     {
 133         return $this->hruid;
 134     }
 135
 136     public function bestEmail()
 137     {
 138         return $this->bestalias;
 139     }
 140     public function forlifeEmail()
 141     {
 142         return $this->forlife;
 143     }
 144
 145     public function displayName()
 146     {
 147         return $this->display_name;
 148     }
 149     public function fullName()
 150     {
 151         return $this->full_name;
 152     }
 153
 154     abstract public function password();
 155
 156     // Fallback value is GENDER_MALE.
 157     public function isFemale()
 158     {
 159         return $this->gender == self::GENDER_FEMALE;
 160     }
 161
 162     // Fallback value is FORMAT_TEXT.
 163     public function isEmailFormatHtml()
 164     {
 165         return $this->email_format == self::FORMAT_HTML;
 166     }
 167
 168     /**
 169      * Other properties are available directly through the $data array, or as
 170      * standard object variables, using a getter.
 171      */
 172     public function data()
 173     {
 174         return $this->data;
 175      }
 176
 177     public function __get($name)
 178     {
 179         if (property_exists($this, $name)) {
 180             return $this->$name;
 181         }
 182
 183         if (isset($this->data[$name])) {
 184             return $this->data[$name];
 185         }
 186
 187         return null;
 188     }
 189
 190     public function __isset($name)
 191     {
 192         return property_exists($this, $name) || isset($this->data[$name]);
 193     }
 194
 195     public function __unset($name)
 196     {
 197         if (property_exists($this, $name)) {
 198             $this->$name = null;
 199         } else {
 200             unset($this->data[$name]);
 201         }
 202     }
 203
 204     /**
 205      * Fills the object properties using the @p associative array; the intended
 206      * user case is to fill the object using SQL obtained arrays.
 207      *
 208      * @param $values Key-value array of user properties.
 209      */
 210     protected function fillFromArray(array $values)
 211     {
 212         // Merge main properties with existing ones.
 213         unset($values['data']);
 214         foreach ($values as $key => $value) {
 215             if (property_exists($this, $key) && !isset($this->$key)) {
 216                 $this->$key = $value;
 217             }
 218         }
 219
 220         // Merge all value into the $this->data placeholder.
 221         $this->data = array_merge($this->data, $values);
 222     }
 223
 224     /**
 225      * Adds properties to the object; this method does not allow the caller to
 226      * update core properties (id, ...).
 227      *
 228      * @param $values An associative array of non-core properties.
 229      */
 230     public function addProperties(array $values)
 231     {
 232         foreach ($values as $key => $value) {
 233             if (!property_exists($this, $key)) {
 234                 $this->data[$key] = $value;
 235             }
 236         }
 237     }
 238
 239
 240     /**
 241      * Build the permissions flags for the user.
 242      */
 243     abstract protected function buildPerms();
 244
 245     /**
 246      * Check wether the user got the given permission combination.
 247      */
 248     public function checkPerms($perms)
 249     {
 250         if (is_null($this->perm_flags)) {
 251             $this->buildPerms();
 252         }
 253         if (is_null($this->perm_flags)) {
 254             return false;
 255         }
 256         return $this->perm_flags->hasFlagCombination($perms);
 257     }
 258
 259
 260     /**
 261      * Returns a valid User object built from the @p id and optionnal @p values,
 262      * or returns false and calls the callback if the @p id is not valid.
 263      */
 264     public static function get($login, $callback = false)
 265     {
 266         return User::getWithValues($login, array(), $callback);
 267     }
 268
 269     public static function getWithValues($login, $values, $callback = false)
 270     {
 271         if (!$callback) {
 272             $callback = array('User', '_default_user_callback');
 273         }
 274
 275         try {
 276             return new User($login, $values);
 277         } catch (UserNotFoundException $e) {
 278             return call_user_func($callback, $login, $e->results);
 279         }
 280     }
 281
 282     public static function getWithUID($uid, $callback = false)
 283     {
 284         return User::getWithValues(null, array('uid' => $uid), $callback);
 285     }
 286
 287     // Same as above, but using the silent callback as default.
 288     public static function getSilent($login)
 289     {
 290         return User::getWithValues($login, array(), array('User', '_silent_user_callback'));
 291     }
 292
 293     public static function getSilentWithValues($login, $values)
 294     {
 295         return User::getWithValues($login, $values, array('User', '_silent_user_callback'));
 296     }
 297
 298     public static function getSilentWithUID($uid)
 299     {
 300         return User::getWithValues(null, array('uid' => $uid), array('User', '_silent_user_callback'));
 301     }
 302
 303     /**
 304      * Retrieves User objects corresponding to the @p logins, and eventually
 305      * extracts and returns the @p property. If @p strict mode is disabled, it
 306      * also includes logins for which no forlife was found (but it still calls
 307      * the callback for them).
 308      * In all cases, email addresses which are not from the local domains are
 309      * kept.
 310      *
 311      * @param $logins Array of user logins.
 312      * @param $property Property to retrieve from the User objects.
 313      * @param $strict Should unvalidated logins be returned as-is or discarded ?
 314      * @param $callback Callback to call when a login is unknown to the system.
 315      * @return Array of validated user forlife emails.
 316      */
 317     private static function getBulkUserProperties($logins, $property, $strict, $callback)
 318     {
 319         if (!is_array($logins)) {
 320             if (strlen(trim($logins)) == 0) {
 321                 return null;
 322             }
 323             $logins = split("[; ,\r\n\|]+", $logins);
 324         }
 325
 326         if ($logins) {
 327             $list = array();
 328             foreach ($logins as $i => $login) {
 329                 $login = trim($login);
 330                 if (empty($login)) {
 331                     continue;
 332                 }
 333
 334                 if (($user = User::get($login, $callback))) {
 335                     $list[$i] = $user->$property();
 336                 } else if (!$strict || (User::isForeignEmailAddress($login) && isvalid_email($login))) {
 337                     $list[$i] = $login;
 338                 }
 339             }
 340             return $list;
 341         }
 342         return null;
 343     }
 344
 345     /**
 346      * Returns hruid corresponding to the @p logins. See getBulkUserProperties()
 347      * for details.
 348      */
 349     public static function getBulkHruid($logins, $callback = false)
 350     {
 351         return self::getBulkUserProperties($logins, 'login', true, $callback);
 352     }
 353
 354     /**
 355      * Returns forlife emails corresponding to the @p logins. See
 356      * getBulkUserProperties() for details.
 357      */
 358     public static function getBulkForlifeEmails($logins, $strict = true, $callback = false)
 359     {
 360         return self::getBulkUserProperties($logins, 'forlifeEmail', $strict, $callback);
 361     }
 362
 363     /**
 364      * Predefined callbacks for the user lookup; they are called when a given
 365      * login is found not to be associated with any valid user. Silent callback
 366      * does nothing; default callback is supposed to display an error message,
 367      * using the Platal::page() hook.
 368      */
 369     public static function _silent_user_callback($login, $results)
 370     {
 371         return;
 372     }
 373
 374     abstract public static function _default_user_callback($login, $results);
 375
 376     /**
 377      * Determines if the @p login is an email address, and an email address not
 378      * served locally by plat/al.
 379      */
 380     abstract public static function isForeignEmailAddress($email);
 381
 382     private static function stripBadChars($text)
 383     {
 384         return str_replace(array(' ', "'"), array('-', ''),
 385                            strtolower(stripslashes(replace_accent(trim($text)))));
 386     }
 387
 388     /** Creates a username from a first and last name
 389      * @param $firstname User's firstname
 390      * @param $lasttname User's lastname
 391      * return STRING the corresponding username
 392      */
 393     public static function makeUserName($firstname, $lastname)
 394     {
 395         return self::stripBadChars($firstname) . '.' . self::stripBadChars($lastname);
 396     }
 397
 398     /**
 399      * Creates a user forlive identifier from:
 400      * @param $firstname User's firstname
 401      * @param $lasttname User's lastname
 402      * @param $category  User's promotion or type of account
 403      */
 404     public static function makeHrid($firstname, $lastname, $category)
 405     {
 406         $cat = self::stripBadChars($category);
 407         if (!cat) {
 408             Platal::page()->kill("$category is not a suitable category.");
 409         }
 410
 411         return self::makeUserName($firstname, $lastname) . '.' . $cat;
 412     }
 413
 414     /** Reformats the firstname so that all letters are in lower case,
 415      * except the first letter of each part of the name.
 416      */
 417     public static function fixFirstnameCase($firstname)
 418     {
 419         $firstname = strtolower($firstname);
 420         $pieces = explode('-', $firstname);
 421
 422         foreach ($pieces as $piece) {
 423             $subpieces = explode("'", $piece);
 424             $usubpieces = '';
 425
 426             foreach ($subpieces as $subpiece) {
 427                 $usubpieces[] = ucwords($subpiece);
 428             }
 429             $upieces[] = implode("'", $usubpieces);
 430         }
 431         return implode('-', $upieces);
 432     }
 433 }
 434
 435 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 436 ?>