From f07d238b1b4d75b34639be873dcc1b1627404ae7 Mon Sep 17 00:00:00 2001 From: alecpl <alec@alec.pl> Date: Fri, 28 May 2010 09:54:32 -0400 Subject: [PATCH] - Add 'imap_timeout' option (#1486760) --- program/include/rcube_contacts.php | 946 +++++++++++++++++++++++++++++++++++++--------------------- 1 files changed, 602 insertions(+), 344 deletions(-) diff --git a/program/include/rcube_contacts.php b/program/include/rcube_contacts.php index 65d89ca..5553a23 100644 --- a/program/include/rcube_contacts.php +++ b/program/include/rcube_contacts.php @@ -5,7 +5,7 @@ | program/include/rcube_contacts.php | | | | This file is part of the RoundCube Webmail client | - | Copyright (C) 2006-2009, RoundCube Dev. - Switzerland | + | Copyright (C) 2006-2010, RoundCube Dev. - Switzerland | | Licensed under the GNU GPL | | | | PURPOSE: | @@ -15,7 +15,7 @@ | Author: Thomas Bruederli <roundcube@gmail.com> | +-----------------------------------------------------------------------+ - $Id: rcube_contacts.inc 328 2006-08-30 17:41:21Z thomasb $ + $Id$ */ @@ -25,366 +25,624 @@ * * @package Addressbook */ -class rcube_contacts +class rcube_contacts extends rcube_addressbook { - var $db = null; - var $db_name = ''; - var $user_id = 0; - var $filter = null; - var $result = null; - var $search_fields; - var $search_string; - var $table_cols = array('name', 'email', 'firstname', 'surname', 'vcard'); - - /** public properties */ - var $primary_key = 'contact_id'; - var $readonly = false; - var $list_page = 1; - var $page_size = 10; - var $ready = false; + // protected for backward compat. with some plugins + protected $db_name = 'contacts'; + protected $db_groups = 'contactgroups'; + protected $db_groupmembers = 'contactgroupmembers'; - - /** - * Object constructor - * - * @param object Instance of the rcube_db class - * @param integer User-ID - */ - function __construct($dbconn, $user) - { - $this->db = $dbconn; - $this->db_name = get_table_name('contacts'); - $this->user_id = $user; - $this->ready = $this->db && !$this->db->is_error(); - } + private $db = null; + private $user_id = 0; + private $filter = null; + private $result = null; + private $search_fields; + private $search_string; + private $cache; + private $table_cols = array('name', 'email', 'firstname', 'surname', 'vcard'); + + // public properties + var $primary_key = 'contact_id'; + var $readonly = false; + var $groups = true; + var $list_page = 1; + var $page_size = 10; + var $group_id = 0; + var $ready = false; - /** - * Set internal list page - * - * @param number Page number to list - * @access public - */ - function set_page($page) - { - $this->list_page = (int)$page; - } - - - /** - * Set internal page size - * - * @param number Number of messages to display on one page - * @access public - */ - function set_pagesize($size) - { - $this->page_size = (int)$size; - } - - - /** - * Save a search string for future listings - * - * @param string SQL params to use in listing method - */ - function set_search_set($filter) - { - $this->filter = $filter; - } - - - /** - * Getter for saved search properties - * - * @return mixed Search properties used by this class - */ - function get_search_set() - { - return $this->filter; - } - - - /** - * Reset all saved results and search parameters - */ - function reset() - { - $this->result = null; - $this->filter = null; - $this->search_fields = null; - $this->search_string = null; - } - - - /** - * Close connection to source - * Called on script shutdown - */ - function close(){} - - - /** - * List the current set of contact records - * - * @param array List of cols to show - * @param int Only return this number of records, use negative values for tail - * @return array Indexed list of contact records, each a hash array - */ - function list_records($cols=null, $subset=0) - { - // count contacts for this user - $this->result = $this->count(); - $sql_result = NULL; - - // get contacts from DB - if ($this->result->count) + /** + * Object constructor + * + * @param object Instance of the rcube_db class + * @param integer User-ID + */ + function __construct($dbconn, $user) { - $start_row = $subset < 0 ? $this->result->first + $this->page_size + $subset : $this->result->first; - $length = $subset != 0 ? abs($subset) : $this->page_size; - - $sql_result = $this->db->limitquery( - "SELECT * FROM ".$this->db_name." - WHERE del<>1 - AND user_id=?" . - ($this->filter ? " AND (".$this->filter.")" : "") . - " ORDER BY name", - $start_row, - $length, - $this->user_id); - } - - while ($sql_result && ($sql_arr = $this->db->fetch_assoc($sql_result))) - { - $sql_arr['ID'] = $sql_arr[$this->primary_key]; - // make sure we have a name to display - if (empty($sql_arr['name'])) - $sql_arr['name'] = $sql_arr['email']; - $this->result->add($sql_arr); - } - - return $this->result; - } - - - /** - * Search contacts - * - * @param array List of fields to search in - * @param string Search value - * @param boolean True if results are requested, False if count only - * @return Indexed list of contact records and 'count' value - */ - function search($fields, $value, $strict=false, $select=true) - { - if (!is_array($fields)) - $fields = array($fields); - - $add_where = array(); - foreach ($fields as $col) - { - if ($col == 'ID' || $col == $this->primary_key) - { - $ids = !is_array($value) ? split(',', $value) : $value; - $add_where[] = $this->primary_key.' IN ('.join(',', $ids).')'; - } - else if ($strict) - $add_where[] = $this->db->quoteIdentifier($col).'='.$this->db->quote($value); - else - $add_where[] = $this->db->ilike($col, '%'.$value.'%'); - } - - if (!empty($add_where)) - { - $this->set_search_set(join(' OR ', $add_where)); - if ($select) - $this->list_records(); - else - $this->result = $this->count(); - } - - return $this->result; - } - - - /** - * Count number of available contacts in database - * - * @return Result array with values for 'count' and 'first' - */ - function count() - { - // count contacts for this user - $sql_result = $this->db->query( - "SELECT COUNT(contact_id) AS rows - FROM ".$this->db_name." - WHERE del<>1 - AND user_id=?". - ($this->filter ? " AND (".$this->filter.")" : ""), - $this->user_id); - - $sql_arr = $this->db->fetch_assoc($sql_result); - return new rcube_result_set($sql_arr['rows'], ($this->list_page-1) * $this->page_size);; - } - - - /** - * Return the last result set - * - * @return Result array or NULL if nothing selected yet - */ - function get_result($as_res=true) - { - return $this->result; - } - - - /** - * Get a specific contact record - * - * @param mixed record identifier(s) - * @return Result object with all record fields or False if not found - */ - function get_record($id, $assoc=false) - { - // return cached result - if ($this->result && ($first = $this->result->first()) && $first[$this->primary_key] == $id) - return $assoc ? $first : $this->result; - - $this->db->query( - "SELECT * FROM ".$this->db_name." - WHERE contact_id=? - AND user_id=? - AND del<>1", - $id, - $this->user_id); - - if ($sql_arr = $this->db->fetch_assoc()) - { - $sql_arr['ID'] = $sql_arr[$this->primary_key]; - $this->result = new rcube_result_set(1); - $this->result->add($sql_arr); + $this->db = $dbconn; + $this->user_id = $user; + $this->ready = $this->db && !$this->db->is_error(); } - return $assoc && $sql_arr ? $sql_arr : $this->result; - } - - - /** - * Create a new contact record - * - * @param array Assoziative array with save data - * @return The created record ID on success, False on error - */ - function insert($save_data, $check=false) - { - if (is_object($save_data) && is_a($save_data, rcube_result_set)) - return $this->insert_recset($save_data, $check); - $insert_id = $existing = false; - - if ($check) - $existing = $this->search('email', $save_data['email'], true, false); - - $a_insert_cols = $a_insert_values = array(); - foreach ($this->table_cols as $col) - if (isset($save_data[$col])) - { - $a_insert_cols[] = $this->db->quoteIdentifier($col); - $a_insert_values[] = $this->db->quote($save_data[$col]); - } - - if (!$existing->count && !empty($a_insert_cols)) + /** + * Save a search string for future listings + * + * @param string SQL params to use in listing method + */ + function set_search_set($filter) { - $this->db->query( - "INSERT INTO ".$this->db_name." - (user_id, changed, del, ".join(', ', $a_insert_cols).") - VALUES (?, ".$this->db->now().", 0, ".join(', ', $a_insert_values).")", - $this->user_id); - - $insert_id = $this->db->insert_id(get_sequence_name('contacts')); + $this->filter = $filter; + $this->cache = null; } - - return $insert_id; - } - /** - * Insert new contacts for each row in set - */ - function insert_recset($result, $check=false) - { - $ids = array(); - while ($row = $result->next()) + /** + * Getter for saved search properties + * + * @return mixed Search properties used by this class + */ + function get_search_set() { - if ($insert = $this->insert($row, $check)) - $ids[] = $insert; + return $this->filter; } - return $ids; - } - - - /** - * Update a specific contact record - * - * @param mixed Record identifier - * @param array Assoziative array with save data - * @return True on success, False on error - */ - function update($id, $save_cols) - { - $updated = false; - $write_sql = array(); - foreach ($this->table_cols as $col) - if (isset($save_cols[$col])) - $write_sql[] = sprintf("%s=%s", $this->db->quoteIdentifier($col), $this->db->quote($save_cols[$col])); - if (!empty($write_sql)) + + /** + * Setter for the current group + * (empty, has to be re-implemented by extending class) + */ + function set_group($gid) { - $this->db->query( - "UPDATE ".$this->db_name." - SET changed=".$this->db->now().", ".join(', ', $write_sql)." - WHERE contact_id=? - AND user_id=? - AND del<>1", - $id, - $this->user_id); - - $updated = $this->db->affected_rows(); + $this->group_id = $gid; + $this->cache = null; } - - return $updated; - } - - - /** - * Mark one or more contact records as deleted - * - * @param array Record identifiers - */ - function delete($ids) - { - if (is_array($ids)) - $ids = join(',', $ids); - $this->db->query( - "UPDATE ".$this->db_name." - SET del=1 - WHERE user_id=? - AND contact_id IN (".$ids.")", - $this->user_id); - return $this->db->affected_rows(); - } - - - /** - * Remove all records from the database - */ - function delete_all() - { - $this->db->query("DELETE FROM {$this->db_name} WHERE user_id=?", $this->user_id); - return $this->db->affected_rows(); - } + /** + * Reset all saved results and search parameters + */ + function reset() + { + $this->result = null; + $this->filter = null; + $this->search_fields = null; + $this->search_string = null; + $this->cache = null; + } + + + /** + * List all active contact groups of this source + * + * @param string Search string to match group name + * @return array Indexed list of contact groups, each a hash array + */ + function list_groups($search = null) + { + $results = array(); + + if (!$this->groups) + return $results; + + $sql_filter = $search ? " AND " . $this->db->ilike('name', '%'.$search.'%') : ''; + + $sql_result = $this->db->query( + "SELECT * FROM ".get_table_name($this->db_groups). + " WHERE del<>1". + " AND user_id=?". + $sql_filter. + " ORDER BY name", + $this->user_id); + + while ($sql_result && ($sql_arr = $this->db->fetch_assoc($sql_result))) { + $sql_arr['ID'] = $sql_arr['contactgroup_id']; + $results[] = $sql_arr; + } + + return $results; + } + + + /** + * List the current set of contact records + * + * @param array List of cols to show + * @param int Only return this number of records, use negative values for tail + * @param boolean True to skip the count query (select only) + * @return array Indexed list of contact records, each a hash array + */ + function list_records($cols=null, $subset=0, $nocount=false) + { + if ($nocount || $this->list_page <= 1) { + // create dummy result, we don't need a count now + $this->result = new rcube_result_set(); + } else { + // count all records + $this->result = $this->count(); + } + + $start_row = $subset < 0 ? $this->result->first + $this->page_size + $subset : $this->result->first; + $length = $subset != 0 ? abs($subset) : $this->page_size; + + if ($this->group_id) + $join = " LEFT JOIN ".get_table_name($this->db_groupmembers)." AS m". + " ON (m.contact_id = c.".$this->primary_key.")"; + + $sql_result = $this->db->limitquery( + "SELECT * FROM ".get_table_name($this->db_name)." AS c" . + $join . + " WHERE c.del<>1" . + " AND c.user_id=?" . + ($this->group_id ? " AND m.contactgroup_id=?" : ""). + ($this->filter ? " AND (".$this->filter.")" : "") . + " ORDER BY c.name", + $start_row, + $length, + $this->user_id, + $this->group_id); + + while ($sql_result && ($sql_arr = $this->db->fetch_assoc($sql_result))) { + $sql_arr['ID'] = $sql_arr[$this->primary_key]; + // make sure we have a name to display + if (empty($sql_arr['name'])) + $sql_arr['name'] = $sql_arr['email']; + $this->result->add($sql_arr); + } + + $cnt = count($this->result->records); + + // update counter + if ($nocount) + $this->result->count = $cnt; + else if ($this->list_page <= 1) { + if ($cnt < $this->page_size && $subset == 0) + $this->result->count = $cnt; + else if (isset($this->cache['count'])) + $this->result->count = $this->cache['count']; + else + $this->result->count = $this->_count(); + } + + return $this->result; + } + + + /** + * Search contacts + * + * @param array List of fields to search in + * @param string Search value + * @param boolean True for strict (=), False for partial (LIKE) matching + * @param boolean True if results are requested, False if count only + * @param boolean True to skip the count query (select only) + * @param array List of fields that cannot be empty + * @return Indexed list of contact records and 'count' value + */ + function search($fields, $value, $strict=false, $select=true, $nocount=false, $required=array()) + { + if (!is_array($fields)) + $fields = array($fields); + if (!is_array($required) && !empty($required)) + $required = array($required); + + $where = $and_where = array(); + + foreach ($fields as $col) { + if ($col == 'ID' || $col == $this->primary_key) { + $ids = !is_array($value) ? explode(',', $value) : $value; + $ids = $this->db->array2list($ids, 'integer'); + $where[] = 'c.' . $this->primary_key.' IN ('.$ids.')'; + } + else if ($strict) + $where[] = $this->db->quoteIdentifier($col).' = '.$this->db->quote($value); + else + $where[] = $this->db->ilike($col, '%'.$value.'%'); + } + + foreach ($required as $col) { + $and_where[] = $this->db->quoteIdentifier($col).' <> '.$this->db->quote(''); + } + + if (!empty($where)) + $where = join(' OR ', $where); + + if (!empty($and_where)) + $where = ($where ? "($where) AND " : '') . join(' AND ', $and_where); + + if (!empty($where)) { + $this->set_search_set($where); + if ($select) + $this->list_records(null, 0, $nocount); + else + $this->result = $this->count(); + } + + return $this->result; + } + + + /** + * Count number of available contacts in database + * + * @return rcube_result_set Result object + */ + function count() + { + $count = isset($this->cache['count']) ? $this->cache['count'] : $this->_count(); + + return new rcube_result_set($count, ($this->list_page-1) * $this->page_size); + } + + + /** + * Count number of available contacts in database + * + * @return int Contacts count + */ + private function _count() + { + if ($this->group_id) + $join = " LEFT JOIN ".get_table_name($this->db_groupmembers)." AS m". + " ON (m.contact_id=c.".$this->primary_key.")"; + + // count contacts for this user + $sql_result = $this->db->query( + "SELECT COUNT(c.contact_id) AS rows". + " FROM ".get_table_name($this->db_name)." AS c". + $join. + " WHERE c.del<>1". + " AND c.user_id=?". + ($this->group_id ? " AND m.contactgroup_id=?" : ""). + ($this->filter ? " AND (".$this->filter.")" : ""), + $this->user_id, + $this->group_id + ); + + $sql_arr = $this->db->fetch_assoc($sql_result); + + $this->cache['count'] = (int) $sql_arr['rows']; + + return $this->cache['count']; + } + + + /** + * Return the last result set + * + * @return Result array or NULL if nothing selected yet + */ + function get_result() + { + return $this->result; + } + + + /** + * Get a specific contact record + * + * @param mixed record identifier(s) + * @return Result object with all record fields or False if not found + */ + function get_record($id, $assoc=false) + { + // return cached result + if ($this->result && ($first = $this->result->first()) && $first[$this->primary_key] == $id) + return $assoc ? $first : $this->result; + + $this->db->query( + "SELECT * FROM ".get_table_name($this->db_name). + " WHERE contact_id=?". + " AND user_id=?". + " AND del<>1", + $id, + $this->user_id + ); + + if ($sql_arr = $this->db->fetch_assoc()) { + $sql_arr['ID'] = $sql_arr[$this->primary_key]; + $this->result = new rcube_result_set(1); + $this->result->add($sql_arr); + } + + return $assoc && $sql_arr ? $sql_arr : $this->result; + } + + + /** + * Create a new contact record + * + * @param array Assoziative array with save data + * @return The created record ID on success, False on error + */ + function insert($save_data, $check=false) + { + if (is_object($save_data) && is_a($save_data, rcube_result_set)) + return $this->insert_recset($save_data, $check); + + $insert_id = $existing = false; + + if ($check) + $existing = $this->search('email', $save_data['email'], true, false); + + $a_insert_cols = $a_insert_values = array(); + + foreach ($this->table_cols as $col) + if (isset($save_data[$col])) { + $a_insert_cols[] = $this->db->quoteIdentifier($col); + $a_insert_values[] = $this->db->quote($save_data[$col]); + } + + if (!$existing->count && !empty($a_insert_cols)) { + $this->db->query( + "INSERT INTO ".get_table_name($this->db_name). + " (user_id, changed, del, ".join(', ', $a_insert_cols).")". + " VALUES (".intval($this->user_id).", ".$this->db->now().", 0, ".join(', ', $a_insert_values).")" + ); + + $insert_id = $this->db->insert_id($this->db_name); + } + + // also add the newly created contact to the active group + if ($insert_id && $this->group_id) + $this->add_to_group($this->group_id, $insert_id); + + $this->cache = null; + + return $insert_id; + } + + + /** + * Insert new contacts for each row in set + */ + function insert_recset($result, $check=false) + { + $ids = array(); + while ($row = $result->next()) { + if ($insert = $this->insert($row, $check)) + $ids[] = $insert; + } + return $ids; + } + + + /** + * Update a specific contact record + * + * @param mixed Record identifier + * @param array Assoziative array with save data + * @return True on success, False on error + */ + function update($id, $save_cols) + { + $updated = false; + $write_sql = array(); + + foreach ($this->table_cols as $col) + if (isset($save_cols[$col])) + $write_sql[] = sprintf("%s=%s", $this->db->quoteIdentifier($col), + $this->db->quote($save_cols[$col])); + + if (!empty($write_sql)) { + $this->db->query( + "UPDATE ".get_table_name($this->db_name). + " SET changed=".$this->db->now().", ".join(', ', $write_sql). + " WHERE contact_id=?". + " AND user_id=?". + " AND del<>1", + $id, + $this->user_id + ); + + $updated = $this->db->affected_rows(); + } + + return $updated; + } + + + /** + * Mark one or more contact records as deleted + * + * @param array Record identifiers + */ + function delete($ids) + { + if (!is_array($ids)) + $ids = explode(',', $ids); + + $ids = $this->db->array2list($ids, 'integer'); + + // flag record as deleted + $this->db->query( + "UPDATE ".get_table_name($this->db_name). + " SET del=1, changed=".$this->db->now(). + " WHERE user_id=?". + " AND contact_id IN ($ids)", + $this->user_id + ); + + $this->cache = null; + + return $this->db->affected_rows(); + } + + + /** + * Remove all records from the database + */ + function delete_all() + { + $this->db->query("DELETE FROM ".get_table_name($this->db_name)." WHERE user_id = ?", $this->user_id); + $this->cache = null; + return $this->db->affected_rows(); + } + + + /** + * Create a contact group with the given name + * + * @param string The group name + * @return False on error, array with record props in success + */ + function create_group($name) + { + $result = false; + + // make sure we have a unique name + $name = $this->unique_groupname($name); + + $this->db->query( + "INSERT INTO ".get_table_name($this->db_groups). + " (user_id, changed, name)". + " VALUES (".intval($this->user_id).", ".$this->db->now().", ".$this->db->quote($name).")" + ); + + if ($insert_id = $this->db->insert_id($this->db_groups)) + $result = array('id' => $insert_id, 'name' => $name); + + return $result; + } + + + /** + * Delete the given group (and all linked group members) + * + * @param string Group identifier + * @return boolean True on success, false if no data was changed + */ + function delete_group($gid) + { + // flag group record as deleted + $sql_result = $this->db->query( + "UPDATE ".get_table_name($this->db_groups). + " SET del=1, changed=".$this->db->now(). + " WHERE contactgroup_id=?", + $gid + ); + + $this->cache = null; + + return $this->db->affected_rows(); + } + + + /** + * Rename a specific contact group + * + * @param string Group identifier + * @param string New name to set for this group + * @return boolean New name on success, false if no data was changed + */ + function rename_group($gid, $newname) + { + // make sure we have a unique name + $name = $this->unique_groupname($newname); + + $sql_result = $this->db->query( + "UPDATE ".get_table_name($this->db_groups). + " SET name=?, changed=".$this->db->now(). + " WHERE contactgroup_id=?", + $name, $gid + ); + + return $this->db->affected_rows() ? $name : false; + } + + + /** + * 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 + */ + function add_to_group($group_id, $ids) + { + if (!is_array($ids)) + $ids = explode(',', $ids); + + $added = 0; + + foreach ($ids as $contact_id) { + $sql_result = $this->db->query( + "SELECT 1 FROM ".get_table_name($this->db_groupmembers). + " WHERE contactgroup_id=?". + " AND contact_id=?", + $group_id, + $contact_id + ); + + if (!$this->db->num_rows($sql_result)) { + $this->db->query( + "INSERT INTO ".get_table_name($this->db_groupmembers). + " (contactgroup_id, contact_id, created)". + " VALUES (?, ?, ".$this->db->now().")", + $group_id, + $contact_id + ); + + if (!$this->db->db_error) + $added++; + } + } + + return $added; + } + + + /** + * 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 + */ + function remove_from_group($group_id, $ids) + { + if (!is_array($ids)) + $ids = explode(',', $ids); + + $ids = $this->db->array2list($ids, 'integer'); + + $sql_result = $this->db->query( + "DELETE FROM ".get_table_name($this->db_groupmembers). + " WHERE contactgroup_id=?". + " AND contact_id IN ($ids)", + $group_id + ); + + return $this->db->affected_rows(); + } + + + /** + * Check for existing groups with the same name + * + * @param string Name to check + * @return string A group name which is unique for the current use + */ + private function unique_groupname($name) + { + $checkname = $name; + $num = 2; $hit = false; + + do { + $sql_result = $this->db->query( + "SELECT 1 FROM ".get_table_name($this->db_groups). + " WHERE del<>1". + " AND user_id=?". + " AND name=?", + $this->user_id, + $checkname); + + // append number to make name unique + if ($hit = $this->db->num_rows($sql_result)) + $checkname = $name . ' ' . $num++; + } while ($hit > 0); + + return $checkname; + } } -- Gitblit v1.9.1