X-Git-Url: http://git.polytechnique.org/?a=blobdiff_plain;f=classes%2Fpluser.php;h=187f131a63df7ad38b74c38ec7c6bbe1ad26642a;hb=4d1c62e006bc896e9ddb59d15dc7a7e30f9eb48e;hp=4cd8edc6a8053ff8336b8e348e05a34fb99d121c;hpb=6c36b907ae72344efb81730e3b41a0ddc9473cec;p=platal.git

diff --git a/classes/pluser.php b/classes/pluser.php
index 4cd8edc..187f131 100644
--- a/classes/pluser.php
+++ b/classes/pluser.php
@@ -1,6 +1,6 @@
 <?php
 /***************************************************************************
- *  Copyright (C) 2003-2009 Polytechnique.org                              *
+ *  Copyright (C) 2003-2010 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,15 +66,17 @@ 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.
@@ -94,8 +107,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 +138,7 @@ abstract class PlUser
      */
     public function id()
     {
-        return $this->user_id;
+        return $this->uid;
     }
 
     public function login()
@@ -135,11 +148,17 @@ abstract class PlUser
 
     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()
@@ -151,11 +170,6 @@ abstract class PlUser
         return $this->full_name;
     }
 
-    public function promo()
-    {
-        return $this->promo;
-    }
-
     abstract public function password();
 
     // Fallback value is GENDER_MALE.
@@ -197,6 +211,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.
@@ -277,7 +300,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.
@@ -293,7 +316,7 @@ abstract class PlUser
 
     public static function getSilentWithUID($uid)
     {
-        return User::getWithValues($uid, array('User', '_silent_user_callback'));
+        return User::getWithValues(null, array('uid' => $uid), array('User', '_silent_user_callback'));
     }
 
     /**
@@ -316,7 +339,7 @@ abstract class PlUser
             if (strlen(trim($logins)) == 0) {
                 return null;
             }
-            $logins = split("[; ,\r\n\|]+", $logins);
+            $logins = preg_split("/[; ,\r\n\|]+/", $logins);
         }
 
         if ($logins) {
@@ -329,7 +352,7 @@ abstract class PlUser
 
                 if (($user = User::get($login, $callback))) {
                     $list[$i] = $user->$property();
-                } else if (!$strict || User::isForeignEmailAddress($login)) {
+                } else if (!$strict || (User::isForeignEmailAddress($login) && isvalid_email($login))) {
                     $list[$i] = $login;
                 }
             }
@@ -367,13 +390,57 @@ 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
      */
-    abstract public static function isForeignEmailAddress($email);
+    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.
+     */
+    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: