X-Git-Url: http://git.polytechnique.org/?a=blobdiff_plain;f=classes%2Fpluser.php;h=c974b7e3ad50fa8170be9fb70fc2fba6bcfc1cf1;hb=refs%2Fheads%2Fcore%2Fmaster;hp=ba82b8d69855a8f663621b4bcaa3492332b77ad6;hpb=2ab75571bf840471fa9559292b75852bfce004d3;p=platal.git

diff --git a/classes/pluser.php b/classes/pluser.php
index ba82b8d..c974b7e 100644
--- a/classes/pluser.php
+++ b/classes/pluser.php
@@ -1,6 +1,6 @@
 <?php
 /***************************************************************************
- *  Copyright (C) 2003-2010 Polytechnique.org                              *
+ *  Copyright (C) 2003-2011 Polytechnique.org                              *
  *  http://opensource.polytechnique.org/                                   *
  *                                                                         *
  *  This program is free software; you can redistribute it and/or modify   *
@@ -32,6 +32,17 @@ class UserNotFoundException extends Exception
     }
 }
 
+interface PlUserInterface
+{
+    public static function _default_user_callback($login, $results);
+
+    /**
+     * Determines if the @p login is an email address, and an email address not
+     * served locally by plat/al.
+     */
+    public static function isForeignEmailAddress($email);
+}
+
 /**
  * Represents an user of plat/al (without any further assumption), with a
  * special focus on always-used properties (identification fields, display name,
@@ -39,7 +50,7 @@ class UserNotFoundException extends Exception
  * NOTE: each implementation of plat/al-code MUST subclass PlUser, and name it
  * 'User'.
  */
-abstract class PlUser
+abstract class PlUser implements PlUserInterface
 {
     /**
      * User data enumerations.
@@ -55,20 +66,23 @@ abstract class PlUser
      * false means the information is not available.
      */
 
-    // user_id is internal user ID (potentially numeric), whereas hruid is a
+    // uid is internal user ID (potentially numeric), whereas hruid is a
     // "human readable" unique ID
-    protected $user_id = null;
+    protected $uid = null;
     protected $hruid = null;
 
     // User main email aliases (forlife is the for-life email address, bestalias
-    // is user-chosen preferred email address).
+    // is user-chosen preferred email address, email might be any email available
+    // for the user).
     protected $forlife = null;
     protected $bestalias = null;
+    protected $email = null;
 
     // Display name is user-chosen name to display (eg. in "Welcome
     // <display name> !"), while full name is the official full name.
     protected $display_name = null;
     protected $full_name = null;
+    protected $sort_name = null;
 
     // Other important parameters used when sending emails.
     protected $gender = null;  // Acceptable values are GENDER_MALE and GENDER_FEMALE
@@ -94,8 +108,8 @@ abstract class PlUser
 
         // If the user id was not part of the known values, determines it from
         // the login.
-        if (!$this->user_id) {
-            $this->user_id = $this->getLogin($login);
+        if (!$this->uid) {
+            $this->uid = $this->getLogin($login);
         }
 
         // Preloads main properties (assumes the loader will lazily get them
@@ -125,7 +139,7 @@ abstract class PlUser
      */
     public function id()
     {
-        return $this->user_id;
+        return $this->uid;
     }
 
     public function login()
@@ -133,13 +147,30 @@ abstract class PlUser
         return $this->hruid;
     }
 
+    public function isMe($other)
+    {
+        if (!$other) {
+            return false;
+        } else if ($other instanceof PlUser) {
+            return $other->id() == $this->id();
+        } else {
+            return false;
+        }
+    }
+
     public function bestEmail()
     {
-        return $this->bestalias;
+        if (!empty($this->bestalias)) {
+            return $this->bestalias;
+        }
+        return $this->email;
     }
     public function forlifeEmail()
     {
-        return $this->forlife;
+        if (!empty($this->forlife)) {
+            return $this->forlife;
+        }
+        return $this->email;
     }
 
     public function displayName()
@@ -192,6 +223,15 @@ abstract class PlUser
         return property_exists($this, $name) || isset($this->data[$name]);
     }
 
+    public function __unset($name)
+    {
+        if (property_exists($this, $name)) {
+            $this->$name = null;
+        } else {
+            unset($this->data[$name]);
+        }
+    }
+
     /**
      * Fills the object properties using the @p associative array; the intended
      * user case is to fill the object using SQL obtained arrays.
@@ -272,7 +312,7 @@ abstract class PlUser
 
     public static function getWithUID($uid, $callback = false)
     {
-        return User::getWithValues(null, array('user_id' => $uid), $callback);
+        return User::getWithValues(null, array('uid' => $uid), $callback);
     }
 
     // Same as above, but using the silent callback as default.
@@ -288,7 +328,7 @@ abstract class PlUser
 
     public static function getSilentWithUID($uid)
     {
-        return User::getWithValues(null, array('user_id' => $uid), array('User', '_silent_user_callback'));
+        return User::getWithValues(null, array('uid' => $uid), array('User', '_silent_user_callback'));
     }
 
     /**
@@ -311,7 +351,7 @@ abstract class PlUser
             if (strlen(trim($logins)) == 0) {
                 return null;
             }
-            $logins = split("[; ,\r\n\|]+", $logins);
+            $logins = preg_split("/[; ,\r\n\|]+/", $logins);
         }
 
         if ($logins) {
@@ -328,7 +368,7 @@ abstract class PlUser
                     $list[$i] = $login;
                 }
             }
-            return $list;
+            return array_unique($list);
         }
         return null;
     }
@@ -362,14 +402,58 @@ abstract class PlUser
         return;
     }
 
-    abstract public static function _default_user_callback($login, $results);
+    private static function stripBadChars($text)
+    {
+        return str_replace(array(' ', "'", '+'), array('-', '', '_'),
+                           strtolower(stripslashes(replace_accent(trim($text)))));
+    }
+
+    /** Creates a username from a first and last name
+     * @param $firstname User's firstname
+     * @param $lasttname User's lastname
+     * return STRING the corresponding username
+     */
+    public static function makeUserName($firstname, $lastname)
+    {
+        return self::stripBadChars($firstname) . '.' . self::stripBadChars($lastname);
+    }
 
     /**
-     * Determines if the @p login is an email address, and an email address not
-     * served locally by plat/al.
+     * Creates a user forlive identifier from:
+     * @param $firstname User's firstname
+     * @param $lasttname User's lastname
+     * @param $category  User's promotion or type of account
+     */
+    public static function makeHrid($firstname, $lastname, $category)
+    {
+        $cat = self::stripBadChars($category);
+        if (!$cat) {
+            Platal::page()->kill("$category is not a suitable category.");
+        }
+
+        return self::makeUserName($firstname, $lastname) . '.' . $cat;
+    }
+
+    /** Reformats the firstname so that all letters are in lower case,
+     * except the first letter of each part of the name.
      */
-    abstract public static function isForeignEmailAddress($email);
+    public static function fixFirstnameCase($firstname)
+    {
+        $firstname = strtolower($firstname);
+        $pieces = explode('-', $firstname);
+
+        foreach ($pieces as $piece) {
+            $subpieces = explode("'", $piece);
+            $usubpieces = '';
+
+            foreach ($subpieces as $subpiece) {
+                $usubpieces[] = ucwords($subpiece);
+            }
+            $upieces[] = implode("'", $usubpieces);
+        }
+        return implode('-', $upieces);
+    }
 }
 
-// vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
+// vim:set et sw=4 sts=4 sws=4 foldmethod=marker fenc=utf-8:
 ?>