Aleksander Machniak
2013-10-14 c1bc8f6c827a27540b5510b42dcc65b39d38f2c1
program/lib/Roundcube/rcube_addressbook.php
@@ -3,7 +3,7 @@
/*
 +-----------------------------------------------------------------------+
 | This file is part of the Roundcube Webmail client                     |
 | Copyright (C) 2006-2012, The Roundcube Dev Team                       |
 | Copyright (C) 2006-2013, The Roundcube Dev Team                       |
 |                                                                       |
 | Licensed under the GNU General Public License version 3 or            |
 | any later version with exceptions for skins & plugins.                |
@@ -35,6 +35,7 @@
    /** public properties (mandatory) */
    public $primary_key;
    public $groups = false;
    public $export_groups = true;
    public $readonly = true;
    public $searchonly = false;
    public $undelete = false;
@@ -45,6 +46,7 @@
    public $sort_col = 'name';
    public $sort_order = 'ASC';
    public $coltypes = array('name' => array('limit'=>1), 'firstname' => array('limit'=>1), 'surname' => array('limit'=>1), 'email' => array('limit'=>1));
    public $date_cols = array();
    protected $error;
@@ -132,7 +134,7 @@
    abstract function get_record($id, $assoc=false);
    /**
     * Returns the last error occured (e.g. when updating/inserting failed)
     * Returns the last error occurred (e.g. when updating/inserting failed)
     *
     * @return array Hash array with the following fields: type, message
     */
@@ -222,7 +224,6 @@
        return true;
    }
    /**
     * Create a new contact record
     *
@@ -309,9 +310,14 @@
     * List all active contact groups of this source
     *
     * @param string  Optional search string to match group name
     * @param int     Matching mode:
     *                0 - partial (*abc*),
     *                1 - strict (=),
     *                2 - prefix (abc*)
     *
     * @return array  Indexed list of contact groups, each a hash array
     */
    function list_groups($search = null)
    function list_groups($search = null, $mode = 0)
    {
        /* empty for address books don't supporting groups */
        return array();
@@ -370,9 +376,10 @@
    /**
     * Add the given contact records the a certain group
     *
     * @param string  Group identifier
     * @param array   List of contact identifiers to be added
     * @return int    Number of contacts added
     * @param string       Group identifier
     * @param array|string List of contact identifiers to be added
     *
     * @return int Number of contacts added
     */
    function add_to_group($group_id, $ids)
    {
@@ -383,9 +390,10 @@
    /**
     * Remove the given contact records from a certain group
     *
     * @param string  Group identifier
     * @param array   List of contact identifiers to be removed
     * @return int    Number of deleted group members
     * @param string       Group identifier
     * @param array|string List of contact identifiers to be removed
     *
     * @return int Number of deleted group members
     */
    function remove_from_group($group_id, $ids)
    {
@@ -407,7 +415,6 @@
        return array();
    }
    /**
     * Utility function to return all values of a certain data column
     * either as flat list or grouped by subtype
@@ -417,7 +424,7 @@
     * @param boolean True to return one array with all values, False for hash array with values grouped by type
     * @return array List of column values
     */
    function get_col_values($col, $data, $flat = false)
    public static function get_col_values($col, $data, $flat = false)
    {
        $out = array();
        foreach ((array)$data as $c => $values) {
@@ -426,7 +433,7 @@
                    $out = array_merge($out, (array)$values);
                }
                else {
                    list($f, $type) = explode(':', $c);
                    list(, $type) = explode(':', $c);
                    $out[$type] = array_merge((array)$out[$type], (array)$values);
                }
            }
@@ -439,7 +446,6 @@
        return $out;
    }
    /**
     * Normalize the given string for fulltext search.
@@ -471,7 +477,8 @@
            $fn = trim(join(' ', array_filter(array($contact['prefix'], $contact['firstname'], $contact['middlename'], $contact['surname'], $contact['suffix']))));
        // use email address part for name
        $email = is_array($contact['email']) ? $contact['email'][0] : $contact['email'];
        $email = self::get_col_values('email', $contact, true);
        $email = $email[0];
        if ($email && (empty($fn) || $fn == $email)) {
            // return full email
@@ -487,7 +494,6 @@
        return $fn;
    }
    /**
     * Compose the name to display in the contacts list for the given contact record.
@@ -519,12 +525,72 @@
            $fn = $contact['name'];
        // fallback to email address
        $email = is_array($contact['email']) ? $contact['email'][0] : $contact['email'];
        if (empty($fn) && $email)
            return $email;
        if (empty($fn) && ($email = self::get_col_values('email', $contact, true)) && !empty($email)) {
            return $email[0];
        }
        return $fn;
    }
    /**
     * Create a unique key for sorting contacts
     */
    public static function compose_contact_key($contact, $sort_col)
    {
        $key = $contact[$sort_col] . ':' . $contact['sourceid'];
        // add email to a key to not skip contacts with the same name (#1488375)
        if (($email = self::get_col_values('email', $contact, true)) && !empty($email)) {
            $key .= ':' . implode(':', (array)$email);
        }
        return $key;
    }
    /**
     * Compare search value with contact data
     *
     * @param string       $colname Data name
     * @param string|array $value   Data value
     * @param string       $search  Search value
     * @param int          $mode    Search mode
     *
     * @return bool Comparision result
     */
    protected function compare_search_value($colname, $value, $search, $mode)
    {
        // The value is a date string, for date we'll
        // use only strict comparison (mode = 1)
        // @TODO: partial search, e.g. match only day and month
        if (in_array($colname, $this->date_cols)) {
            return (($value = rcube_utils::anytodatetime($value))
                && ($search = rcube_utils::anytodatetime($search))
                && $value->format('Ymd') == $search->format('Ymd'));
        }
        // composite field, e.g. address
        foreach ((array)$value as $val) {
            $val = mb_strtolower($val);
            switch ($mode) {
            case 1:
                $got = ($val == $search);
                break;
            case 2:
                $got = ($search == substr($val, 0, strlen($search)));
                break;
            default:
                $got = (strpos($val, $search) !== false);
            }
            if ($got) {
                return true;
            }
        }
        return false;
    }
}