Aleksander Machniak
2012-05-09 66510e20d36cb8da4f3012ef063de7bfce9b51aa
program/include/rcube_user.php
@@ -6,7 +6,10 @@
 |                                                                       |
 | This file is part of the Roundcube Webmail client                     |
 | Copyright (C) 2005-2010, The Roundcube Dev Team                       |
 | Licensed under the GNU GPL                                            |
 |                                                                       |
 | Licensed under the GNU General Public License version 3 or            |
 | any later version with exceptions for skins & plugins.                |
 | See the README file for a full license statement.                     |
 |                                                                       |
 | PURPOSE:                                                              |
 |   This class represents a system user linked and provides access      |
@@ -41,12 +44,14 @@
    private $db;
    /**
     * rcmail object.
     * Framework object.
     *
     * @var rcmail
     * @var rcube
     */
    private $rc;
    const SEARCH_ADDRESSBOOK = 1;
    const SEARCH_MAIL = 2;
    /**
     * Object constructor
@@ -56,12 +61,12 @@
     */
    function __construct($id = null, $sql_arr = null)
    {
        $this->rc = rcmail::get_instance();
        $this->rc = rcube::get_instance();
        $this->db = $this->rc->get_dbh();
        if ($id && !$sql_arr) {
            $sql_result = $this->db->query(
                "SELECT * FROM ".get_table_name('users')." WHERE user_id = ?", $id);
                "SELECT * FROM ".$this->db->table_name('users')." WHERE user_id = ?", $id);
            $sql_arr = $this->db->fetch_assoc($sql_result);
        }
@@ -122,7 +127,10 @@
            if (!empty($_SESSION['preferences'])) {
                // Check last write attempt time, try to write again (every 5 minutes)
                if ($_SESSION['preferences_time'] < time() - 5 * 60) {
                    $this->save_prefs(unserialize($_SESSION['preferences']));
                    $saved_prefs = unserialize($_SESSION['preferences']);
                    $this->rc->session->remove('preferences');
                    $this->rc->session->remove('preferences_time');
                    $this->save_prefs($saved_prefs);
                }
                else {
                    $this->data['preferences'] = $_SESSION['preferences'];
@@ -165,7 +173,7 @@
        $save_prefs = serialize($save_prefs);
        $this->db->query(
            "UPDATE ".get_table_name('users').
            "UPDATE ".$this->db->table_name('users').
            " SET preferences = ?".
                ", language = ?".
            " WHERE user_id = ?",
@@ -224,7 +232,7 @@
        $result = array();
        $sql_result = $this->db->query(
            "SELECT * FROM ".get_table_name('identities').
            "SELECT * FROM ".$this->db->table_name('identities').
            " WHERE del <> 1 AND user_id = ?".
            ($sql_add ? " ".$sql_add : "").
            " ORDER BY ".$this->db->quoteIdentifier('standard')." DESC, name ASC, identity_id ASC",
@@ -259,7 +267,7 @@
        $query_params[] = $iid;
        $query_params[] = $this->ID;
        $sql = "UPDATE ".get_table_name('identities').
        $sql = "UPDATE ".$this->db->table_name('identities').
            " SET changed = ".$this->db->now().", ".join(', ', $query_cols).
            " WHERE identity_id = ?".
                " AND user_id = ?".
@@ -293,7 +301,7 @@
        $insert_cols[]   = 'user_id';
        $insert_values[] = $this->ID;
        $sql = "INSERT INTO ".get_table_name('identities').
        $sql = "INSERT INTO ".$this->db->table_name('identities').
            " (changed, ".join(', ', $insert_cols).")".
            " VALUES (".$this->db->now().", ".join(', ', array_pad(array(), sizeof($insert_values), '?')).")";
@@ -316,7 +324,7 @@
            return false;
        $sql_result = $this->db->query(
            "SELECT count(*) AS ident_count FROM ".get_table_name('identities').
            "SELECT count(*) AS ident_count FROM ".$this->db->table_name('identities').
            " WHERE user_id = ? AND del <> 1",
            $this->ID);
@@ -327,7 +335,7 @@
            return -1;
        $this->db->query(
            "UPDATE ".get_table_name('identities').
            "UPDATE ".$this->db->table_name('identities').
            " SET del = 1, changed = ".$this->db->now().
            " WHERE user_id = ?".
                " AND identity_id = ?",
@@ -347,7 +355,7 @@
    {
        if ($this->ID && $iid) {
            $this->db->query(
                "UPDATE ".get_table_name('identities').
                "UPDATE ".$this->db->table_name('identities').
                " SET ".$this->db->quoteIdentifier('standard')." = '0'".
                " WHERE user_id = ?".
                    " AND identity_id <> ?".
@@ -365,7 +373,7 @@
    {
        if ($this->ID) {
            $this->db->query(
                "UPDATE ".get_table_name('users').
                "UPDATE ".$this->db->table_name('users').
                " SET last_login = ".$this->db->now().
                " WHERE user_id = ?",
                $this->ID);
@@ -392,13 +400,10 @@
     */
    static function query($user, $host)
    {
        $dbh = rcmail::get_instance()->get_dbh();
        // use BINARY (case-sensitive) comparison on MySQL, other engines are case-sensitive
        $mod = preg_match('/^mysql/', $dbh->db_provider) ? 'BINARY' : '';
        $dbh = rcube::get_instance()->get_dbh();
        // query for matching user name
        $query = "SELECT * FROM ".get_table_name('users')." WHERE mail_host = ? AND %s = $mod ?";
        $query = "SELECT * FROM ".$dbh->table_name('users')." WHERE mail_host = ? AND %s = ?";
        $sql_result = $dbh->query(sprintf($query, 'username'), $host, $user);
        // query for matching alias
@@ -426,15 +431,15 @@
    {
        $user_name  = '';
        $user_email = '';
        $rcmail = rcmail::get_instance();
        $rcube = rcube::get_instance();
        // try to resolve user in virtuser table and file
        if ($email_list = self::user2email($user, false, true)) {
            $user_email = is_array($email_list[0]) ? $email_list[0]['email'] : $email_list[0];
        }
        $data = $rcmail->plugins->exec_hook('user_create',
           array('user'=>$user, 'user_name'=>$user_name, 'user_email'=>$user_email));
        $data = $rcube->plugins->exec_hook('user_create',
           array('user'=>$user, 'user_name'=>$user_name, 'user_email'=>$user_email, 'host'=>$host));
        // plugin aborted this operation
        if ($data['abort'])
@@ -443,10 +448,10 @@
        $user_name  = $data['user_name'];
        $user_email = $data['user_email'];
        $dbh = $rcmail->get_dbh();
        $dbh = $rcube->get_dbh();
        $dbh->query(
            "INSERT INTO ".get_table_name('users').
            "INSERT INTO ".$dbh->table_name('users').
            " (created, last_login, username, mail_host, alias, language)".
            " VALUES (".$dbh->now().", ".$dbh->now().", ?, ?, ?, ?)",
            strip_newlines($user),
@@ -457,9 +462,9 @@
        if ($user_id = $dbh->insert_id('users')) {
            // create rcube_user instance to make plugin hooks work
            $user_instance = new rcube_user($user_id);
            $rcmail->user  = $user_instance;
            $rcube->user   = $user_instance;
            $mail_domain = $rcmail->config->mail_domain($host);
            $mail_domain = $rcube->config->mail_domain($host);
            if ($user_email == '') {
                $user_email = strpos($user, '@') ? $user : sprintf('%s@%s', $user, $mail_domain);
@@ -471,7 +476,7 @@
            if (empty($email_list))
                $email_list[] = strip_newlines($user_email);
            // identities_level check
            else if (count($email_list) > 1 && $rcmail->config->get('identities_level', 0) > 1)
            else if (count($email_list) > 1 && $rcube->config->get('identities_level', 0) > 1)
                $email_list = array($email_list[0]);
            // create new identities records
@@ -492,17 +497,17 @@
                $record['user_id'] = $user_id;
                $record['standard'] = $standard;
                $plugin = $rcmail->plugins->exec_hook('identity_create',
                $plugin = $rcube->plugins->exec_hook('identity_create',
                   array('login' => true, 'record' => $record));
                if (!$plugin['abort'] && $plugin['record']['email']) {
                    $rcmail->user->insert_identity($plugin['record']);
                    $rcube->user->insert_identity($plugin['record']);
                }
                $standard = 0;
            }
        }
        else {
            raise_error(array(
            rcube::raise_error(array(
                'code' => 500,
                'type' => 'php',
                'line' => __LINE__,
@@ -522,8 +527,8 @@
     */
    static function email2user($email)
    {
        $rcmail = rcmail::get_instance();
        $plugin = $rcmail->plugins->exec_hook('email2user',
        $rcube = rcube::get_instance();
        $plugin = $rcube->plugins->exec_hook('email2user',
            array('email' => $email, 'user' => NULL));
        return $plugin['user'];
@@ -540,12 +545,137 @@
     */
    static function user2email($user, $first=true, $extended=false)
    {
        $rcmail = rcmail::get_instance();
        $plugin = $rcmail->plugins->exec_hook('user2email',
        $rcube = rcube::get_instance();
        $plugin = $rcube->plugins->exec_hook('user2email',
            array('email' => NULL, 'user' => $user,
                'first' => $first, 'extended' => $extended));
        return empty($plugin['email']) ? NULL : $plugin['email'];
    }
    /**
     * Return a list of saved searches linked with this user
     *
     * @param int  $type  Search type
     *
     * @return array List of saved searches indexed by search ID
     */
    function list_searches($type)
    {
        $plugin = $this->rc->plugins->exec_hook('saved_search_list', array('type' => $type));
        if ($plugin['abort']) {
            return (array) $plugin['result'];
        }
        $result = array();
        $sql_result = $this->db->query(
            "SELECT search_id AS id, ".$this->db->quoteIdentifier('name')
            ." FROM ".$this->db->table_name('searches')
            ." WHERE user_id = ?"
                ." AND ".$this->db->quoteIdentifier('type')." = ?"
            ." ORDER BY ".$this->db->quoteIdentifier('name'),
            (int) $this->ID, (int) $type);
        while ($sql_arr = $this->db->fetch_assoc($sql_result)) {
            $sql_arr['data'] = unserialize($sql_arr['data']);
            $result[$sql_arr['id']] = $sql_arr;
        }
        return $result;
    }
    /**
     * Return saved search data.
     *
     * @param int  $id  Row identifier
     *
     * @return array Data
     */
    function get_search($id)
    {
        $plugin = $this->rc->plugins->exec_hook('saved_search_get', array('id' => $id));
        if ($plugin['abort']) {
            return $plugin['result'];
        }
        $sql_result = $this->db->query(
            "SELECT ".$this->db->quoteIdentifier('name')
                .", ".$this->db->quoteIdentifier('data')
                .", ".$this->db->quoteIdentifier('type')
            ." FROM ".$this->db->table_name('searches')
            ." WHERE user_id = ?"
                ." AND search_id = ?",
            (int) $this->ID, (int) $id);
        while ($sql_arr = $this->db->fetch_assoc($sql_result)) {
            return array(
                'id'   => $id,
                'name' => $sql_arr['name'],
                'type' => $sql_arr['type'],
                'data' => unserialize($sql_arr['data']),
            );
        }
        return null;
    }
    /**
     * Deletes given saved search record
     *
     * @param  int  $sid  Search ID
     *
     * @return boolean True if deleted successfully, false if nothing changed
     */
    function delete_search($sid)
    {
        if (!$this->ID)
            return false;
        $this->db->query(
            "DELETE FROM ".$this->db->table_name('searches')
            ." WHERE user_id = ?"
                ." AND search_id = ?",
            (int) $this->ID, $sid);
        return $this->db->affected_rows();
    }
    /**
     * Create a new saved search record linked with this user
     *
     * @param array $data Hash array with col->value pairs to save
     *
     * @return int  The inserted search ID or false on error
     */
    function insert_search($data)
    {
        if (!$this->ID)
            return false;
        $insert_cols[]   = 'user_id';
        $insert_values[] = (int) $this->ID;
        $insert_cols[]   = $this->db->quoteIdentifier('type');
        $insert_values[] = (int) $data['type'];
        $insert_cols[]   = $this->db->quoteIdentifier('name');
        $insert_values[] = $data['name'];
        $insert_cols[]   = $this->db->quoteIdentifier('data');
        $insert_values[] = serialize($data['data']);
        $sql = "INSERT INTO ".$this->db->table_name('searches')
            ." (".join(', ', $insert_cols).")"
            ." VALUES (".join(', ', array_pad(array(), sizeof($insert_values), '?')).")";
        call_user_func_array(array($this->db, 'query'),
            array_merge(array($sql), $insert_values));
        return $this->db->insert_id('searches');
    }
}