Bypass the default query of the User class when no uid is specified
[platal.git] / classes / user.php
index 17cbd72..f7f90fa 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,11 +24,18 @@ class User extends PlUser
     private $_profile_fetched = false;
     private $_profile = null;
 
+    // Additional fields (non core)
+    protected $promo = null;
+
     // Implementation of the login to uid method.
     protected function getLogin($login)
     {
         global $globals;
 
+        if (!$login) {
+            throw new UserNotFoundException();
+        }
+
         if ($login instanceof User) {
             $machin->id();
         }
@@ -78,7 +85,7 @@ class User extends PlUser
         if ($fqdn == $globals->mail->domain || $fqdn == $globals->mail->domain2) {
             $res = XDB::query('SELECT  a.uid
                                  FROM  accounts AS a
-                           INNER JOIN  aliases AS al ON (al.id = a.uid AND al.type IN (\'alias\', \'a_vie\'))
+                           INNER JOIN  aliases AS al ON (al.uid = a.uid AND al.type IN (\'alias\', \'a_vie\'))
                                 WHERE  al.alias = {?}', $mbox);
             if ($res->numRows()) {
                 return $res->fetchOneCell();
@@ -109,7 +116,7 @@ class User extends PlUser
                 list($alias, $alias_fqdn) = explode('@', $redir);
                 $res = XDB::query("SELECT  a.uid
                                      FROM  accounts AS a
-                                LEFT JOIN  aliases AS al ON (al.id = a.uid AND al.type IN ('alias', 'a_vie'))
+                                LEFT JOIN  aliases AS al ON (al.uid = a.uid AND al.type IN ('alias', 'a_vie'))
                                     WHERE  al.alias = {?}", $alias);
                 if ($res->numRows()) {
                     return $res->fetchOneCell();
@@ -139,13 +146,17 @@ class User extends PlUser
         throw new UserNotFoundException($res->fetchColumn(1));
     }
 
-    protected static function loadMainFieldsFromUIDs(array $uids)
+    protected static function loadMainFieldsFromUIDs(array $uids, $respect_order = true)
     {
+        if (empty($uids)) {
+            return PlIteratorUtils::emptyIterator();
+        }
+
         global $globals;
         $joins = '';
         $fields = array();
         if ($globals->asso('id')) {
-            $joins .= XDB::format("LEFT JOIN groupex.membres AS gpm ON (gpm.uid = a.uid AND gpm.asso_id = {?})\n", $globals->asso('id'));
+            $joins .= XDB::format("LEFT JOIN group_members AS gpm ON (gpm.uid = a.uid AND gpm.asso_id = {?})\n", $globals->asso('id'));
             $fields[] = 'gpm.perms AS group_perms';
             $fields[] = 'gpm.comm AS group_comm';
         }
@@ -154,23 +165,39 @@ class User extends PlUser
         } else {
             $fields = '';
         }
+
+        if ($respect_order) {
+            $order = 'ORDER BY ' . XDB::formatCustomOrder('a.uid', $uids);
+        } else {
+            $order = '';
+        }
+
         $uids = array_map(array('XDB', 'escape'), $uids);
-        return XDB::iterator('SELECT  a.uid, a.hruid, a.registration_date,
-                                      CONCAT(af.alias, \'@' . $globals->mail->domain . '\') AS forlife,
-                                      CONCAT(ab.alias, \'@' . $globals->mail->domain . '\') AS bestalias,
+
+        return XDB::iterator('SELECT  a.uid, a.hruid, a.registration_date, ah.alias AS homonym,
+                                      IF (af.alias IS NULL, a.email, CONCAT(af.alias, \'@' . $globals->mail->domain . '\')) AS forlife,
+                                      CONCAT(af.alias, \'@' . $globals->mail->domain2 . '\') AS forlife_alternate,
+                                      IF (ab.alias IS NULL, a.email, CONCAT(ab.alias, \'@' . $globals->mail->domain . '\')) AS bestalias,
+                                      CONCAT(ab.alias, \'@' . $globals->mail->domain2 . '\') AS bestalias_alternate,
                                       a.full_name, a.display_name, a.sex = \'female\' AS gender,
                                       IF(a.state = \'active\', at.perms, \'\') AS perms,
                                       a.email_format, a.is_admin, a.state, a.type, a.skin,
                                       FIND_IN_SET(\'watch\', a.flags) AS watch, a.comment,
                                       a.weak_password IS NOT NULL AS weak_access,
-                                      a.token IS NOT NULL AS token_access ' . $fields . '
+                                      a.token IS NOT NULL AS token_access,
+                                      (e.email IS NULL AND NOT FIND_IN_SET(\'googleapps\', eo.storage)) AND a.state != \'pending\' AS lost
+                                      ' . $fields . '
                                 FROM  accounts AS a
                           INNER JOIN  account_types AS at ON (at.type = a.type)
-                           LEFT JOIN  aliases AS af ON (af.id = a.uid AND af.type = \'a_vie\')
-                           LEFT JOIN  aliases AS ab ON (ab.id = a.uid AND FIND_IN_SET(\'bestalias\', ab.flags))
+                           LEFT JOIN  aliases AS af ON (af.uid = a.uid AND af.type = \'a_vie\')
+                           LEFT JOIN  aliases AS ab ON (ab.uid = a.uid AND FIND_IN_SET(\'bestalias\', ab.flags))
+                           LEFT JOIN  aliases AS ah ON (ah.uid = a.uid AND ah.type = \'homonyme\')
+                           LEFT JOIN  emails AS e ON (e.uid = a.uid AND e.flags = \'active\')
+                           LEFT JOIN  email_options AS eo ON (eo.uid = a.uid)
                                    ' . $joins . '
                                WHERE  a.uid IN (' . implode(', ', $uids) . ')
-                            GROUP BY  a.uid');
+                            GROUP BY  a.uid
+                                   ' . $order);
     }
 
     // Implementation of the data loader.
@@ -182,7 +209,7 @@ class User extends PlUser
             && $this->gender !== null && $this->email_format !== null) {
             return;
         }
-        $this->fillFromArray(self::loadMainFieldsFromUIDs(array($this->user_id))->next());
+        $this->fillFromArray(self::loadMainFieldsFromUIDs(array($this->uid))->next());
     }
 
     // Specialization of the fillFromArray method, to implement hacks to enable
@@ -191,13 +218,6 @@ class User extends PlUser
     // stop being used actively.
     protected function fillFromArray(array $values)
     {
-        // It might happen that the 'user_id' field is called uid in some places
-        // (eg. in sessions), so we hard link uid to user_id to prevent useless
-        // SQL requests.
-        if (!isset($values['user_id']) && isset($values['uid'])) {
-            $values['user_id'] = $values['uid'];
-        }
-
         // Also, if display_name and full_name are not known, but the user's
         // surname and last name are, we can construct the former two.
         if (isset($values['prenom']) && isset($values['nom'])) {
@@ -355,6 +375,337 @@ class User extends PlUser
         return $this->login() . '@' . $globals->mail->domain2;
     }
 
+
+    /** Get marketing informations
+     */
+    private function fetchMarketingData()
+    {
+        if (isset($this->last_known_email)) {
+            return;
+        }
+        // FIXME: We should fetch the last known email as well as the pending registration email (they aren't the same !)
+        $infos = XDB::fetchOneAssoc('SELECT  IF (MAX(m.last) > p.relance, MAX(m.last), p.relance) AS last_relance,
+                                             p.email AS last_known_email
+                                       FROM  register_pending AS p
+                                  LEFT JOIN  register_marketing AS m ON (p.uid = m.uid)
+                                      WHERE  p.uid = {?}
+                                   GROUP BY  p.uid', $this->id());
+        if (!$infos) {
+            $infos = array('last_relance' => null, 'last_known_email' => null);
+        }
+        $this->fillFromArray($infos);
+    }
+
+    public function lastMarketingRelance()
+    {
+        $this->fetchMarketingData();
+        return $this->last_relance;
+    }
+
+    public function lastKnownEmail()
+    {
+        $this->fetchMarketingData();
+        return $this->last_known_email;
+    }
+
+
+    /** Format of the emails sent by the site
+     */
+    public function setEmailFormat($format)
+    {
+        Platal::assert($format == self::FORMAT_HTML || $format == self::FORMAT_TEXT,
+                       "Invalid email format \"$format\"");
+        XDB::execute("UPDATE  accounts
+                         SET  email_format = {?}
+                       WHERE  uid = {?}",
+                     $format, $this->uid);
+        $this->email_format = $format;
+    }
+
+
+    /** Get watch informations
+     */
+    private function fetchWatchData()
+    {
+        if (isset($this->watch_actions)) {
+            return;
+        }
+        $watch = XDB::fetchOneAssoc('SELECT  flags AS watch_flags, actions AS watch_actions,
+                                             UNIX_TIMESTAMP(last) AS watch_last
+                                       FROM  watch
+                                      WHERE  uid = {?}', $this->id());
+        $watch['watch_flags'] = new PlFlagSet($watch['watch_flags']);
+        $watch['watch_actions'] = new PlFlagSet($watch['watch_actions']);
+        $watch['watch_promos'] = XDB::fetchColumn('SELECT  promo
+                                                     FROM  watch_promo
+                                                    WHERE  uid = {?}', $this->id());
+        $watch['watch_users'] = XDB::fetchColumn('SELECT  ni_id
+                                                    FROM  watch_nonins
+                                                   WHERE  uid = {?}', $this->id());
+        $this->fillFromArray($watch);
+    }
+
+    public function watchType($type)
+    {
+        $this->fetchWatchData();
+        return $this->watch_actions->hasFlag($type);
+    }
+
+    public function watchContacts()
+    {
+        $this->fetchWatchData();
+        return $this->watch_flags->hasFlag('contacts');
+    }
+
+    public function watchEmail()
+    {
+        $this->fetchWatchData();
+        return $this->watch_flags->hasFlag('mail');
+    }
+
+    public function watchPromos()
+    {
+        $this->fetchWatchData();
+        return $this->watch_promos;
+    }
+
+    public function watchUsers()
+    {
+        $this->fetchWatchData();
+        return $this->watch_users;
+    }
+
+    public function watchLast()
+    {
+        $this->fetchWatchData();
+        return $this->watch_last;
+    }
+
+    public function invalidWatchCache()
+    {
+        unset($this->watch_actions);
+        unset($this->watch_users);
+        unset($this->watch_last);
+        unset($this->watch_promos);
+    }
+
+
+    // Contacts
+    private $contacts = null;
+    private function fetchContacts()
+    {
+        if (is_null($this->contacts)) {
+            $this->contacts = XDB::fetchAllAssoc('contact', 'SELECT  *
+                                                               FROM  contacts
+                                                              WHERE  uid = {?}',
+                                                 $this->id());
+        }
+    }
+
+    public function iterContacts()
+    {
+        $this->fetchContacts();
+        return Profile::iterOverPIDs(array_keys($this->contacts));
+    }
+
+    public function getContacts()
+    {
+        $this->fetchContacts();
+        return Profile::getBulkProfilesWithPIDs(array_keys($this->contacts));
+    }
+
+    public function isContact(Profile &$profile)
+    {
+        $this->fetchContacts();
+        return isset($this->contacts[$profile->id()]);
+    }
+
+    public function isWatchedUser(Profile &$profile)
+    {
+        return in_array($profile->id(), $this->watchUsers());
+    }
+
+    // Groupes X
+    private $groups = null;
+    public function groups()
+    {
+        if (is_null($this->groups)) {
+            $this->groups = XDB::fetchAllAssoc('asso_id', 'SELECT  asso_id, perms, comm
+                                                             FROM  group_members
+                                                            WHERE  uid = {?}',
+                                                $this->id());
+        }
+        return $this->groups;
+    }
+
+    public function groupNames($institutions = false)
+    {
+        if ($institutions) {
+            $where = ' AND (g.cat = \'GroupesX\' OR g.cat = \'Institutions\')';
+        } else {
+            $where = '';
+        }
+        return XDB::fetchAllAssoc('SELECT  g.diminutif, g.nom, g.site
+                                     FROM  group_members AS gm
+                                LEFT JOIN  groups AS g ON (g.id = gm.asso_id)
+                                    WHERE  gm.uid = {?}' . $where,
+                                  $this->id());
+    }
+
+    /**
+     * Clears a user.
+     *  *always deletes in: account_lost_passwords, register_marketing,
+     *      register_pending, register_subs, watch_nonins, watch, watch_promo
+     *  *always keeps in: account_types, accounts, aliases, axletter_ins, carvas,
+     *      group_members, homonyms, newsletter_ins, register_mstats,
+     *  *deletes if $clearAll: account_auth_openid, announce_read, contacts,
+     *      email_options, email_send_save, emails, forum_innd, forum_profiles,
+     *      forum_subs, gapps_accounts, gapps_nicknames, group_announces_read,
+     *      group_member_sub_requests, reminder, requests, requests_hidden,
+     *      virtual, virtual_redirect, ML
+     *  *modifies if $clearAll: accounts
+     *
+     * Use cases:
+     *  *$clearAll == false: when a user dies, her family still needs to keep in
+     *      touch with the community.
+     *  *$clearAll == true: in every other case we want the account to be fully
+     *      deleted so that it can not be used anymore.
+     */
+    public function clear($clearAll = true)
+    {
+        $tables = array('account_lost_passwords', 'register_marketing',
+                        'register_pending', 'register_subs', 'watch_nonins',
+                        'watch', 'watch_promo');
+
+        foreach ($tables as $t) {
+            XDB::execute('DELETE FROM  ' . $t . '
+                                WHERE  uid = {?}',
+                                $this->id());
+        }
+
+        if ($clearAll) {
+            $groupIds = XDB::iterator('SELECT  asso_id
+                                         FROM  group_members
+                                        WHERE  uid = {?}',
+                                      $this->id());
+            while ($groupId = $groupIds->next()) {
+                $group = Group::get($groupId);
+                if ($group->notif_unsub) {
+                    $mailer = new PlMailer('xnetgrp/unsubscription-notif.mail.tpl');
+                    $admins = $group->iterAdmins();
+                    while ($admin = $admins->next()) {
+                        $mailer->addTo($admin);
+                    }
+                    $mailer->assign('group', $group->shortname);
+                    $mailer->assign('user', $this);
+                    $mailer->assign('selfdone', false);
+                    $mailer->send();
+                }
+            }
+
+            $tables = array('account_auth_openid', 'gannounce_read', 'contacts',
+                            'email_options', 'gemail_send_save', 'emails',
+                            'forum_innd', 'gforum_profiles', 'forum_subs',
+                            'gapps_accounts', 'ggapps_nicknames', 'group_announces_read',
+                            'group_members', 'ggroup_member_sub_requests', 'reminder', 'requests',
+                            'requests_hidden');
+
+            foreach ($tables as $t) {
+                XDB::execute('DELETE FROM  ' . $t . '
+                                    WHERE  uid = {?}',
+                    $this->id());
+            }
+
+            XDB::execute("UPDATE  accounts
+                             SET  registration_date = 0, state = 'pending', password = NULL,
+                                  weak_password = NULL, token = NULL, is_admin = 0
+                           WHERE  uid = {?}",
+                         $this->id());
+
+            XDB::execute('DELETE  v.*
+                            FROM  virtual          AS v
+                      INNER JOIN  virtual_redirect AS r ON (v.vid = r.vid)
+                           WHERE  redirect = {?} OR redirect = {?}',
+                         $this->forlifeEmail(), $this->m4xForlifeEmail());
+            XDB::execute('DELETE FROM  virtual_redirect
+                                WHERE  redirect = {?} OR redirect = {?}',
+                         $this->forlifeEmail(), $this->m4xForlifeEmail());
+
+            if ($globals->mailstorage->googleapps_domain) {
+                require_once 'googleapps.inc.php';
+
+                if (GoogleAppsAccount::account_status($uid)) {
+                    $account = new GoogleAppsAccount($user);
+                    $account->suspend();
+                }
+            }
+        }
+
+        $mmlist = new MMList($this);
+        $mmlist->kill($alias, $clearAll);
+    }
+
+    // Merge all infos in other user and then clean this one
+    public function mergeIn(User &$newuser) {
+        if ($this->profile() || !$newuser->id()) {
+            // don't disable user with profile in this way
+            return false;
+        }
+        // TODO check all tables to see if there is no other info to use
+
+        $newemail = $newuser->forlifeEmail();
+        if (!$newemail && $this->forlifeEmail()) {
+            XDB::execute("UPDATE  accounts
+                             SET  email = {?}
+                           WHERE  uid = {?} AND email IS NULL",
+                    $this->forlifeEmail(), $newuser->id());
+            $newemail = $this->forlifeEmail();
+        }
+
+        // change email used in aliases and mailing lists
+        if ($this->forlifeEmail() != $newemail && $this->forlifeEmail()) {
+            // virtual_redirect (email aliases)
+            XDB::execute("DELETE  v1
+                            FROM  virtual_redirect AS v1, virtual_redirect AS v2
+                           WHERE  v1.vid = v2.vid AND v1.redirect = {?} AND v2.redirect = {?}",
+                    $this->forlifeEmail(), $newemail);
+            XDB::execute("UPDATE  virtual_redirect
+                             SET  redirect = {?}
+                           WHERE  redirect = {?}",
+                    $newemail, $this->forlifeEmail());
+
+            // require_once 'mmlist.php';
+
+            // group mailing lists
+            $group_domains = XDB::fetchColumn("SELECT  g.mail_domain
+                          FROM  groups AS g
+                    INNER JOIN  group_members AS gm ON(g.id = gm.asso_id)
+                         WHERE  g.mail_domain != '' AND gm.uid = {?}",
+                    $this->id());
+            foreach ($group_domains as $mail_domain) {
+                $mmlist = new MMList($this, $mail_domain);
+                $mmlist->replace_email_in_all($this->forlifeEmail(), $newmail);
+            }
+            // main domain lists
+            $mmlist = new MMList($this);
+            $mmlist->replace_email_in_all($this->forlifeEmail(), $newmail);
+        }
+
+        // group_members (xnet group membership)
+        XDB::execute("DELETE  g1
+                        FROM  group_members AS g1, group_members AS g2
+                       WHERE  g1.uid = {?} AND g2.uid = {?} AND g1.asso_id = g2.asso_id",
+                    $this->id(), $newuser->id());
+        XDB::execute("UPDATE  group_members
+                         SET  uid = {?}
+                       WHERE  uid = {?}",
+                    $this->id(), $newuser->id());
+
+        XDB::execute("DELETE FROM accounts WHERE uid = {?}", $this->id());
+
+        return true;
+    }
+
     // Return permission flags for a given permission level.
     public static function makePerms($perms, $is_admin)
     {
@@ -370,7 +721,7 @@ class User extends PlUser
     public static function _default_user_callback($login, $results)
     {
         $result_count = count($results);
-        if ($result_count == 0 || !S::has_perms()) {
+        if ($result_count == 0 || !S::admin()) {
             Platal::page()->trigError("Il n'y a pas d'utilisateur avec l'identifiant : $login");
         } else {
             Platal::page()->trigError("Il y a $result_count utilisateurs avec cet identifiant : " . join(', ', $results));
@@ -392,19 +743,165 @@ class User extends PlUser
                $dom != $globals->mail->alias_dom2;
     }
 
-    // Fetch a set of users from a list of UIDs
-    public static function getBulkUsersWithUIDs(array $uids)
+    public static function isVirtualEmailAddress($email)
     {
-        $fields = self::loadMainFieldsFromUIDs($uids);
+        global $globals;
+        if (strpos($email, '@') === false) {
+            return false;
+        }
+
+        list($user, $dom) = explode('@', $email);
+        return $dom == $globals->mail->alias_dom
+            || $dom == $globals->mail->alias_dom2;
+    }
+
+    /* Tries to find pending accounts with an hruid close to $login. */
+    public static function getPendingAccounts($login, $iterator = false)
+    {
+        global $globals;
+
+        if (strpos($login, '@') === false) {
+            return null;
+        }
+
+        list($login, $domain) = explode('@', $login);
+
+        if ($domain && $domain != $globals->mail->domain && $domain != $globals->mail->domain2) {
+            return null;
+        }
+
+        $sql = "SELECT  uid, full_name
+                  FROM  accounts
+                 WHERE  state = 'pending' AND REPLACE(hruid, '-', '') LIKE
+                        CONCAT('%', REPLACE(REPLACE(REPLACE({?}, ' ', ''), '-', ''), '\'', ''), '%')
+              ORDER BY  full_name";
+        if ($iterator) {
+            return XDB::iterator($sql, $login);
+        } else {
+            $res = XDB::query($sql, $login);
+            return $res->fetchAllAssoc();
+        }
+    }
+
+
+    public static function iterOverUIDs($uids, $respect_order = true)
+    {
+        return new UserIterator(self::loadMainFieldsFromUIDs($uids, $respect_order));
+    }
+
+    /** Fetch a set of users from a list of UIDs
+     * @param $data The list of uids to fetch, or an array of arrays
+     * @param $orig If $data is an array of arrays, the subfield where uids are stored
+     * @param $dest If $data is an array of arrays, the subfield to fill with Users
+     * @param $fetchProfile Whether to fetch Profiles as well
+     * @return either an array of $uid => User, or $data with $data[$i][$dest] = User
+     */
+    public static function getBulkUsersWithUIDs(array $data, $orig = null, $dest = null, $fetchProfile = true)
+    {
+        // Fetch the list of uids
+        if (is_null($orig)) {
+            $uids = $data;
+        } else {
+            if (is_null($dest)) {
+                $dest = $orig;
+            }
+            $uids = array();
+            foreach ($data as $key=>$entry) {
+                if (isset($entry[$orig])) {
+                    $uids[] = $entry[$orig];
+                }
+            }
+        }
+
+        // Fetch users
+        if (count($uids) == 0) {
+            return $data;
+        }
+        $users = self::iterOverUIDs($uids, true);
+
         $table = array();
-        while (($list = $fields->next())) {
-            $table[$list['uid']] = User::getSilentWithValues(null, $list);
+        if ($fetchProfile) {
+            $profiles = Profile::iterOverUIDS($uids, true);
+            if ($profiles != null) {
+                $profile = $profiles->next();
+            } else {
+                $profile = null;
+            }
+        }
+
+        /** We iterate through the users, moving in
+         * profiles when they match the user ID :
+         * there can be users without a profile, but not
+         * the other way around.
+         */
+        while (($user = $users->next())) {
+            if ($fetchProfile) {
+                if ($profile != null && $profile->owner_id == $user->id()) {
+                    $user->_profile = $profile;
+                    $profile = $profiles->next();
+                }
+                $user->_profile_fetched = true;
+            }
+            $table[$user->id()] = $user;
+        }
+
+        // Build the result with respect to input order.
+        if (is_null($orig)) {
+            return $table;
+        } else {
+            foreach ($data as $key=>$entry) {
+                if (isset($entry[$orig])) {
+                    $entry[$dest] = $table[$entry[$orig]];
+                    $data[$key] = $entry;
+                }
+            }
+            return $data;
         }
-        $users = array();
-        foreach ($uids as $uid) {
-            $users[] = $table[$uid];
+    }
+
+    public static function getBulkUsersFromDB($fetchProfile = true)
+    {
+        $args = func_get_args();
+        $uids = call_user_func_array(array('XDB', 'fetchColumn'), $args);
+        return self::getBulkUsersWithUIDs($uids, null, null, $fetchProfile);
+    }
+}
+
+/** Iterator over a set of Users
+ * @param an XDB::Iterator obtained from a User::loadMainFieldsFromUIDs
+ */
+class UserIterator 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 User::getSilentWithValues(null, $data);
         }
-        return $users;
+    }
+
+    public function total()
+    {
+        return $this->dbiter->total();
+    }
+
+    public function first()
+    {
+        return $this->dbiter->first();
+    }
+
+    public function last()
+    {
+        return $this->dbiter->last();
     }
 }