Move table photo into profile_photos, rename uid to pid.
[platal.git] / classes / profile.php
index 177a244..ef87258 100644 (file)
@@ -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   *
@@ -24,10 +24,37 @@ class Profile
     static private $v_values = array('public'  => array('public'),
                                      'ax'      => array('ax', 'public'),
                                      'private' => array('private', 'ax', 'public'));
+
     const VISIBILITY_PUBLIC  = 'public';
     const VISIBILITY_AX      = 'ax';
     const VISIBILITY_PRIVATE = 'private';
 
+    /* name tokens */
+    const LASTNAME  = 'lastname';
+    const FIRSTNAME = 'firstname';
+    const NICKNAME  = 'nickname';
+    const PSEUDONYM = 'pseudonym';
+    const NAME      = 'name';
+    /* name variants */
+    const VN_MARITAL  = 'marital';
+    const VN_ORDINARY = 'ordinary';
+    const VN_OTHER    = 'other';
+    const VN_INI      = 'ini';
+    /* display names */
+    const DN_FULL      = 'directory_name';
+    const DN_DISPLAY   = 'yourself';
+    const DN_YOURSELF  = 'yourself';
+    const DN_DIRECTORY = 'directory_name';
+    const DN_PRIVATE   = 'private_name';
+    const DN_PUBLIC    = 'public_name';
+    const DN_SHORT     = 'short_name';
+    const DN_SORT      = 'sort_name';
+
+    static public $name_variants = array(
+            self::LASTNAME => array(self::VN_MARITAL, self::VN_ORDINARY),
+            self::FIRSTNAME => array(self::VN_ORDINARY, self::VN_INI, self::VN_OTHER)
+        );
+
     const ADDRESS_MAIN       = 0x000001;
     const ADDRESS_PERSO      = 0x000002;
     const ADDRESS_PRO        = 0x000004;
@@ -119,11 +146,21 @@ class Profile
         return $this->firstname;
     }
 
+    public function firstNames()
+    {
+        return $this->nameVariants(self::FIRSTNAME);
+    }
+
     public function lastName()
     {
         return $this->lastname;
     }
 
+    public function lastNames()
+    {
+        return $this->nameVariants(self::LASTNAME);
+    }
+
     public function isFemale()
     {
         return $this->sex == PlUser::GENDER_FEMALE;
@@ -135,6 +172,19 @@ class Profile
         return $this->data;
     }
 
+    private function nameVariants($type)
+    {
+        $vals = array($this->$type);
+        foreach (self::$name_variants[$type] as $var) {
+            $vartype = $type . '_' . $var;
+            $varname = $this->$vartype;
+            if ($varname != null && $varname != "") {
+                $vals[] = $varname;
+            }
+        }
+        return array_unique($vals);
+    }
+
     public function __get($name)
     {
         if (property_exists($this, $name)) {
@@ -155,18 +205,44 @@ class Profile
 
     public function setVisibilityLevel($visibility)
     {
-        if ($visibility != self::VISIBILITY_PRIVATE 
-         && $visibility != self::VISIBILITY_AX 
+        if ($visibility != self::VISIBILITY_PRIVATE
+         && $visibility != self::VISIBILITY_AX
          && $visibility != self::VISIBILITY_PUBLIC) {
             Platal::page()->kill("Visibility invalide: " . $visibility);
         }
         $this->visibility = self::$v_values[$visibility];
-        if ($this->mobile && !in_array($this->modbile_pub, $this->visibility)) {
+        if ($this->mobile && !in_array($this->mobile_pub, $this->visibility)) {
             unset($this->data['mobile']);
         }
     }
 
 
+    /* Photo
+     */
+    public function getPhoto($fallback = true)
+    {
+        /* TODO: migrate photo table to profile_photo, change uid to pid
+         */
+        $cond = '';
+        if ($this->visibility) {
+            $cond = ' AND pub IN ' . XDB::formatArray($this->visibility);
+        }
+        $res = XDB::query('SELECT  *
+                             FROM  profile_photos
+                            WHERE  attachmime IN (\'jpeg\', \'png\')
+                                   ' . $cond . ' AND  pid = {?}',
+                          $this->id());
+        if ($res->numRows() > 0) {
+            $photo = $res->fetchOneAssoc();
+            return PlImage::fromData($photo['attach'], 'image/' . $photo['attachmime'],
+                                     $photo['x'], $photo['y']);
+        } else if ($fallback) {
+            return PlImage::fromFile(dirname(__FILE__).'/../htdocs/images/none.png',
+                                     'image/png');
+        }
+        return null;
+    }
+
     /* Addresses
      */
     public function getAddresses($flags, $limit = null)
@@ -195,6 +271,7 @@ class Profile
         return XDB::iterator('SELECT  pa.text, pa.postalCode, pa.type, pa.latitude, pa.longitude,
                                       gl.name AS locality, gas.name AS subAdministrativeArea,
                                       ga.name AS administrativeArea, gc.countryFR AS country,
+                                      ppfix.display_tel AS fixed_tel, ppfax.display_tel AS fax_tel,
                                       FIND_IN_SET(\'current\', pa.flags) AS current,
                                       FIND_IN_SET(\'temporary\', pa.flags) AS temporary,
                                       FIND_IN_SET(\'secondary\', pa.flags) AS secondary,
@@ -204,6 +281,8 @@ class Profile
                            LEFT JOIN  geoloc_administrativeareas AS ga ON (ga.id = pa.administrativeAreaId)
                            LEFT JOIN  geoloc_administrativeareas AS gas ON (gas.id = pa.subAdministrativeAreaId)
                            LEFT JOIN  geoloc_countries AS gc ON (gc.iso_3166_1_a2 = pa.countryId)
+                           LEFT JOIN  profile_phones AS ppfix ON (ppfix.link_type = \'address\' AND ppfix.uid = pa.pid AND ppfix.link_id = pa.id AND ppfix.tel_type = \'fixed\')
+                           LEFT JOIN  profile_phones AS ppfax ON (ppfax.link_type = \'address\' AND ppfax.uid = pa.pid AND ppfax.link_id = pa.id AND ppfax.tel_type = \'fax\')
                                WHERE  ' . $where . '
                             ORDER BY  pa.id
                                       ' . $limit);
@@ -325,39 +404,59 @@ class Profile
         return $job->next();
     }
 
+    /* Binets
+     */
+    public function getBinets()
+    {
+        return XDB::fetchColumn('SELECT  binet_id
+                                   FROM  binets_ins
+                                  WHERE  user_id = {?}', $this->id());
+    }
+
 
     public function owner()
     {
         return User::getSilent($this);
     }
 
-    private static function fetchProfileData(array $pids)
+    private static function fetchProfileData(array $pids, $respect_order = true)
     {
         if (count($pids) == 0) {
             return array();
         }
-        return XDB::fetchAllAssoc('SELECT  p.*, p.sex = \'female\' AS sex, pe.entry_year, pe.grad_year,
-                                           pn_f.name AS firstname, pn_l.name AS lastname, pn_n.name AS nickname,
-                                           IF(pn_uf.name IS NULL, pn_f.name, pn_uf.name) AS firstname_usual,
-                                           IF(pn_ul.name IS NULL, pn_l.name, pn_ul.name) AS lastname_usual,
-                                           pd.promo AS promo, pd.short_name, pd.directory_name AS full_name,
-                                           pp.display_tel AS mobile, pp.pub AS mobile_pub
-                                     FROM  profiles AS p
-                               INNER JOIN  profile_display AS pd ON (pd.pid = p.pid)
-                               INNER JOIN  profile_education AS pe ON (pe.uid = p.pid AND FIND_IN_SET(\'primary\', pe.flags))
-                               INNER JOIN  profile_name AS pn_f ON (pn_f.pid = p.pid
-                                                                    AND pn_f.typeid = ' . self::getNameTypeId('lastname', true) . ')
-                               INNER JOIN  profile_name AS pn_l ON (pn_l.pid = p.pid
-                                                                    AND pn_l.typeid = ' . self::getNameTypeId('firstname', true) . ')
-                                LEFT JOIN  profile_name AS pn_uf ON (pn_uf.pid = p.pid
-                                                                     AND pn_uf.typeid = ' . self::getNameTypeId('lastname_ordinary', true) . ')
-                                LEFT JOIN  profile_name AS pn_ul ON (pn_ul.pid = p.pid
-                                                                     AND pn_ul.typeid = ' . self::getNameTypeId('firstname_ordinary', true) . ')
-                                LEFT JOIN  profile_name AS pn_n ON (pn_n.pid = p.pid 
-                                                                    AND pn_n.typeid = ' . self::getNameTypeId('nickname', true) . ')
-                                LEFT JOIN  profile_phones AS pp ON (pp.uid = p.pid AND pp.link_type = \'user\' AND tel_type = \'mobile\')
-                                    WHERE  p.pid IN ' . XDB::formatArray($pids) . '
-                                 GROUP BY  p.pid');
+
+        if ($respect_order) {
+            $order = 'ORDER BY  ' . XDB::formatCustomOrder('p.pid', $pids);
+        } else {
+            $order = '';
+        }
+
+        return XDB::Iterator('SELECT  p.*, p.sex = \'female\' AS sex, pe.entry_year, pe.grad_year,
+                                      pn_f.name AS firstname, pn_l.name AS lastname, pn_n.name AS nickname,
+                                      IF(pn_uf.name IS NULL, pn_f.name, pn_uf.name) AS firstname_ordinary,
+                                      IF(pn_ul.name IS NULL, pn_l.name, pn_ul.name) AS lastname_ordinary,
+                                      pd.promo AS promo, pd.short_name, pd.directory_name AS full_name,
+                                      pd.directory_name, pp.display_tel AS mobile, pp.pub AS mobile_pub,
+                                      ph.pub AS photo_pub, ap.uid AS owner_id
+                                FROM  profiles AS p
+                          INNER JOIN  profile_display AS pd ON (pd.pid = p.pid)
+                          INNER JOIN  profile_education AS pe ON (pe.uid = p.pid AND FIND_IN_SET(\'primary\', pe.flags))
+                          INNER JOIN  profile_name AS pn_f ON (pn_f.pid = p.pid
+                                                               AND pn_f.typeid = ' . self::getNameTypeId('firstname', true) . ')
+                          INNER JOIN  profile_name AS pn_l ON (pn_l.pid = p.pid
+                                                               AND pn_l.typeid = ' . self::getNameTypeId('lastname', true) . ')
+                           LEFT JOIN  profile_name AS pn_uf ON (pn_uf.pid = p.pid
+                                                                AND pn_uf.typeid = ' . self::getNameTypeId('firstname_ordinary', true) . ')
+                           LEFT JOIN  profile_name AS pn_ul ON (pn_ul.pid = p.pid
+                                                                AND pn_ul.typeid = ' . self::getNameTypeId('lastname_ordinary', true) . ')
+                           LEFT JOIN  profile_name AS pn_n ON (pn_n.pid = p.pid
+                                                               AND pn_n.typeid = ' . self::getNameTypeId('nickname', true) . ')
+                           LEFT JOIN  profile_phones AS pp ON (pp.uid = p.pid AND pp.link_type = \'user\' AND tel_type = \'mobile\')
+                           LEFT JOIN  profile_photos AS ph ON (ph.pid = p.pid)
+                           LEFT JOIN  account_profiles AS ap ON (ap.pid = p.pid AND FIND_IN_SET(\'owner\', ap.perms))
+                               WHERE  p.pid IN ' . XDB::formatArray($pids) . '
+                            GROUP BY  p.pid
+                                   ' . $order);
     }
 
     public static function getPID($login)
@@ -378,15 +477,31 @@ class Profile
         }
     }
 
+    public static function getPIDsFromUIDs($uids, $respect_order = true)
+    {
+        if ($respect_order) {
+            $order = 'ORDER BY ' . XDB::formatCustomOrder('uid', $uids);
+        } else {
+            $order = '';
+        }
+        return XDB::fetchAllAssoc('uid', 'SELECT  ap.uid, ap.pid
+                                            FROM  account_profiles AS ap
+                                           WHERE  FIND_IN_SET(\'owner\', ap.perms)
+                                                  AND ap.uid IN ' . XDB::formatArray($uids) .'
+                                               ' . $order);
+    }
 
     /** Return the profile associated with the given login.
      */
     public static function get($login)
     {
+        if (is_array($login)) {
+            return new Profile($login);
+        }
         $pid = self::getPID($login);
         if (!is_null($pid)) {
-            $data = self::fetchProfileData(array($pid));
-            return new Profile(array_pop($data));
+            $it = self::iterOverPIDs(array($pid), false);
+            return $it->next();
         } else {
             /* Let say we can identify a profile using the identifiers of its owner.
              */
@@ -400,6 +515,16 @@ class Profile
         }
     }
 
+    public static function iterOverUIDs($uids, $respect_order = true)
+    {
+        return self::iterOverPIDs(self::getPIDsFromUIDs($uids), $respect_order);
+    }
+
+    public static function iterOverPIDs($pids, $respect_order = true)
+    {
+        return new ProfileIterator(self::fetchProfileData($pids, $respect_order));
+    }
+
     /** Return profiles for the list of pids.
      */
     public static function getBulkProfilesWithPIDs(array $pids)
@@ -407,13 +532,10 @@ class Profile
         if (count($pids) == 0) {
             return array();
         }
-        $data = self::fetchProfileData($pids);
-        $inv = array_flip($pids);
+        $it = self::iterOverPIDs($pids);
         $profiles = array();
-        foreach ($data AS $p) {
-            $p = new Profile($p);
-            $key = $inv[$p->id()];
-            $profiles[$key] = $p;
+        while ($p = $it->next()) {
+            $profiles[$p->id()] = $p;
         }
         return $profiles;
     }
@@ -425,11 +547,15 @@ class Profile
         if (count($uids) == 0) {
             return array();
         }
-        $table = XDB::fetchAllAssoc('uid', 'SELECT  ap.uid, ap.pid
-                                              FROM  account_profiles AS ap
-                                             WHERE  FIND_IN_SET(\'owner\', ap.perms)
-                                                    AND ap.uid IN ' . XDB::formatArray($uids));
-        return self::getBulkProfilesWithPIDs($table);
+        return self::getBulkProfilesWithPIDs(self::getPIDsFromUIDs($uids));
+    }
+
+    public static function isDisplayName($name)
+    {
+        return $name == self::DN_FULL || $name == self::DN_DISPLAY
+            || $name == self::DN_YOURSELF || $name == self::DN_DIRECTORY
+            || $name == self::DN_PRIVATE || $name == self::DN_PUBLIC
+            || $name == self::DN_SHORT || $name == self::DN_SORT;
     }
 
     public static function getNameTypeId($type, $for_sql = false)
@@ -449,5 +575,43 @@ class Profile
     }
 }
 
+/** Iterator over a set of Profiles
+ * @param an XDB::Iterator obtained from a Profile::fetchProfileData
+ */
+class ProfileIterator implements PlIterator
+{
+    private $dbiter;
+
+    public function __construct($dbiter)
+    {
+        $this->dbiter = $dbiter;
+    }
+
+    public function next()
+    {
+        $data = $this->dbiter->next();
+        if ($data == null) {
+            return null;
+        } else {
+            return Profile::get($data);
+        }
+    }
+
+    public function total()
+    {
+        return $this->dbiter->total();
+    }
+
+    public function first()
+    {
+        return $this->dbiter->first();
+    }
+
+    public function last()
+    {
+        return $this->dbiter->last();
+    }
+}
+
 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 ?>