| | |
| | | /* |
| | | +-----------------------------------------------------------------------+ |
| | | | 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. | |
| | |
| | | /** public properties (mandatory) */ |
| | | public $primary_key; |
| | | public $groups = false; |
| | | public $export_groups = true; |
| | | public $readonly = true; |
| | | public $searchonly = false; |
| | | public $undelete = false; |
| | |
| | | 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; |
| | | |
| | |
| | | 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 |
| | | */ |
| | | function get_error() |
| | | { |
| | | return $this->error; |
| | | return $this->error; |
| | | } |
| | | |
| | | /** |
| | |
| | | */ |
| | | protected function set_error($type, $message) |
| | | { |
| | | $this->error = array('type' => $type, 'message' => $message); |
| | | $this->error = array('type' => $type, 'message' => $message); |
| | | } |
| | | |
| | | /** |
| | |
| | | public function validate(&$save_data, $autofix = false) |
| | | { |
| | | $rcube = rcube::get_instance(); |
| | | $valid = true; |
| | | |
| | | // check validity of email addresses |
| | | foreach ($this->get_col_values('email', $save_data, true) as $email) { |
| | |
| | | if (!rcube_utils::check_email(rcube_utils::idn_to_ascii($email))) { |
| | | $error = $rcube->gettext(array('name' => 'emailformaterror', 'vars' => array('email' => $email))); |
| | | $this->set_error(self::ERROR_VALIDATE, $error); |
| | | return false; |
| | | $valid = false; |
| | | break; |
| | | } |
| | | } |
| | | } |
| | | |
| | | return true; |
| | | } |
| | | // allow plugins to do contact validation and auto-fixing |
| | | $plugin = $rcube->plugins->exec_hook('contact_validate', array( |
| | | 'record' => $save_data, |
| | | 'autofix' => $autofix, |
| | | 'valid' => $valid, |
| | | )); |
| | | |
| | | if ($valid && !$plugin['valid']) { |
| | | $this->set_error(self::ERROR_VALIDATE, $plugin['error']); |
| | | } |
| | | |
| | | if (is_array($plugin['record'])) { |
| | | $save_data = $plugin['record']; |
| | | } |
| | | |
| | | return $plugin['valid']; |
| | | } |
| | | |
| | | /** |
| | | * Create a new contact record |
| | |
| | | * @param array Assoziative array with save data |
| | | * Keys: Field name with optional section in the form FIELD:SECTION |
| | | * Values: Field value. Can be either a string or an array of strings for multiple values |
| | | * @return boolean True on success, False on error |
| | | * |
| | | * @return mixed On success if ID has been changed returns ID, otherwise True, False on error |
| | | */ |
| | | function update($id, $save_cols) |
| | | { |
| | |
| | | |
| | | /** |
| | | * Mark all records in database as deleted |
| | | * |
| | | * @param bool $with_groups Remove also groups |
| | | */ |
| | | function delete_all() |
| | | function delete_all($with_groups = false) |
| | | { |
| | | /* empty for read-only address books */ |
| | | } |
| | |
| | | * 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(); |
| | |
| | | /** |
| | | * 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) |
| | | { |
| | |
| | | /** |
| | | * 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) |
| | | { |
| | |
| | | return array(); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Utility function to return all values of a certain data column |
| | | * either as flat list or grouped by subtype |
| | |
| | | * @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) { |
| | |
| | | $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); |
| | | } |
| | | } |
| | |
| | | |
| | | return $out; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Normalize the given string for fulltext search. |
| | |
| | | $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 |
| | |
| | | |
| | | return $fn; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Compose the name to display in the contacts list for the given contact record. |
| | |
| | | $fn = join(' ', array($contact['surname'], $contact['firstname'], $contact['middlename'])); |
| | | else if ($compose_mode == 1) |
| | | $fn = join(' ', array($contact['firstname'], $contact['middlename'], $contact['surname'])); |
| | | else |
| | | else if ($compose_mode == 0) |
| | | $fn = !empty($contact['name']) ? $contact['name'] : join(' ', array($contact['prefix'], $contact['firstname'], $contact['middlename'], $contact['surname'], $contact['suffix'])); |
| | | else { |
| | | $plugin = rcube::get_instance()->plugins->exec_hook('contact_listname', array('contact' => $contact)); |
| | | $fn = $plugin['fn']; |
| | | } |
| | | |
| | | $fn = trim($fn, ', '); |
| | | |
| | |
| | | $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; |
| | | } |
| | | |
| | | } |
| | | |