From 66510e20d36cb8da4f3012ef063de7bfce9b51aa Mon Sep 17 00:00:00 2001
From: Aleksander Machniak <alec@alec.pl>
Date: Wed, 09 May 2012 07:52:28 -0400
Subject: [PATCH] Merge pull request #1 from Brianetta/de-svn
---
program/include/rcube_addressbook.php | 213 ++++++++++++++++++++++++++++++++++++++++++++++++++---
1 files changed, 200 insertions(+), 13 deletions(-)
diff --git a/program/include/rcube_addressbook.php b/program/include/rcube_addressbook.php
index c3c8e92..2f264f9 100644
--- a/program/include/rcube_addressbook.php
+++ b/program/include/rcube_addressbook.php
@@ -5,8 +5,11 @@
| program/include/rcube_addressbook.php |
| |
| This file is part of the Roundcube Webmail client |
- | Copyright (C) 2006-2011, The Roundcube Dev Team |
- | Licensed under the GNU GPL |
+ | Copyright (C) 2006-2012, The Roundcube Dev Team |
+ | |
+ | 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: |
| Interface to the local address book database |
@@ -30,20 +33,30 @@
/** constants for error reporting **/
const ERROR_READ_ONLY = 1;
const ERROR_NO_CONNECTION = 2;
- const ERROR_INCOMPLETE = 3;
+ const ERROR_VALIDATE = 3;
const ERROR_SAVING = 4;
-
+ const ERROR_SEARCH = 5;
+
/** public properties (mandatory) */
public $primary_key;
public $groups = false;
public $readonly = true;
+ public $searchonly = false;
+ public $undelete = false;
public $ready = false;
public $group_id = null;
public $list_page = 1;
public $page_size = 10;
+ 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));
-
+
protected $error;
+
+ /**
+ * Returns addressbook name (e.g. for addressbooks listing)
+ */
+ abstract function get_name();
/**
* Save a search string for future listings
@@ -88,12 +101,16 @@
*
* @param array List of fields to search in
* @param string Search value
+ * @param int Matching mode:
+ * 0 - partial (*abc*),
+ * 1 - strict (=),
+ * 2 - prefix (abc*)
* @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 object rcube_result_set List of contact records and 'count' value
*/
- abstract function search($fields, $value, $strict=false, $select=true, $nocount=false, $required=array());
+ abstract function search($fields, $value, $mode=0, $select=true, $nocount=false, $required=array());
/**
* Count number of available contacts in database
@@ -128,7 +145,7 @@
{
return $this->error;
}
-
+
/**
* Setter for errors for internal use
*
@@ -167,6 +184,49 @@
{
$this->page_size = (int)$size;
}
+
+ /**
+ * Set internal sort settings
+ *
+ * @param string $sort_col Sort column
+ * @param string $sort_order Sort order
+ */
+ function set_sort_order($sort_col, $sort_order = null)
+ {
+ if ($sort_col != null && ($this->coltypes[$sort_col] || in_array($sort_col, $this->coltypes))) {
+ $this->sort_col = $sort_col;
+ }
+ if ($sort_order != null) {
+ $this->sort_order = strtoupper($sort_order) == 'DESC' ? 'DESC' : 'ASC';
+ }
+ }
+
+ /**
+ * Check the given data before saving.
+ * If input isn't valid, the message to display can be fetched using get_error()
+ *
+ * @param array Assoziative array with data to save
+ * @param boolean Attempt to fix/complete record automatically
+ * @return boolean True if input is valid, False if not.
+ */
+ public function validate(&$save_data, $autofix = false)
+ {
+ $rcmail = rcmail::get_instance();
+
+ // check validity of email addresses
+ foreach ($this->get_col_values('email', $save_data, true) as $email) {
+ if (strlen($email)) {
+ if (!rcube_utils::check_email(rcube_utils::idn_to_ascii($email))) {
+ $error = $rcmail->gettext(array('name' => 'emailformaterror', 'vars' => array('email' => $email)));
+ $this->set_error(self::ERROR_VALIDATE, $error);
+ return false;
+ }
+ }
+ }
+
+ return true;
+ }
+
/**
* Create a new contact record
@@ -219,14 +279,25 @@
* Mark one or more contact records as deleted
*
* @param array Record identifiers
+ * @param bool Remove records irreversible (see self::undelete)
*/
- function delete($ids)
+ function delete($ids, $force=true)
{
/* empty for read-only address books */
}
/**
- * Remove all records from the database
+ * Unmark delete flag on contact record(s)
+ *
+ * @param array Record identifiers
+ */
+ function undelete($ids)
+ {
+ /* empty for read-only address books */
+ }
+
+ /**
+ * Mark all records in database as deleted
*/
function delete_all()
{
@@ -249,6 +320,18 @@
{
/* empty for address books don't supporting groups */
return array();
+ }
+
+ /**
+ * Get group properties such as name and email address(es)
+ *
+ * @param string Group identifier
+ * @return array Group properties as hash array
+ */
+ function get_group($group_id)
+ {
+ /* empty for address books don't supporting groups */
+ return null;
}
/**
@@ -280,9 +363,10 @@
*
* @param string Group identifier
* @param string New name to set for this group
+ * @param string New group identifier (if changed, otherwise don't set)
* @return boolean New name on success, false if no data was changed
*/
- function rename_group($gid, $newname)
+ function rename_group($gid, $newname, &$newid)
{
/* empty for address books don't supporting groups */
return false;
@@ -342,7 +426,7 @@
{
$out = array();
foreach ($data as $c => $values) {
- if (strpos($c, $col) === 0) {
+ if ($c === $col || strpos($c, $col.':') === 0) {
if ($flat) {
$out = array_merge($out, (array)$values);
}
@@ -352,9 +436,112 @@
}
}
}
-
+
return $out;
}
-
+
+
+ /**
+ * Normalize the given string for fulltext search.
+ * Currently only optimized for Latin-1 characters; to be extended
+ *
+ * @param string Input string (UTF-8)
+ * @return string Normalized string
+ */
+ protected static function normalize_string($str)
+ {
+ // split by words
+ $arr = explode(" ", preg_replace(
+ array('/[\s;\+\-\/]+/i', '/(\d)[-.\s]+(\d)/', '/\s\w{1,3}\s/'),
+ array(' ', '\\1\\2', ' '),
+ $str));
+
+ foreach ($arr as $i => $part) {
+ if (utf8_encode(utf8_decode($part)) == $part) { // is latin-1 ?
+ $arr[$i] = utf8_encode(strtr(strtolower(strtr(utf8_decode($part),
+ '��������������������������������������������������',
+ 'ccaaaaeeeeiiiaeooouuuyooaiounnaaaaaeeeiiioooouuuyy')),
+ array('�' => 'ss', 'ae' => 'a', 'oe' => 'o', 'ue' => 'u')));
+ }
+ else
+ $arr[$i] = mb_strtolower($part);
+ }
+
+ return join(" ", $arr);
+ }
+
+
+ /**
+ * Compose a valid display name from the given structured contact data
+ *
+ * @param array Hash array with contact data as key-value pairs
+ * @param bool Don't attempt to extract components from the email address
+ *
+ * @return string Display name
+ */
+ public static function compose_display_name($contact, $full_email = false)
+ {
+ $contact = rcmail::get_instance()->plugins->exec_hook('contact_displayname', $contact);
+ $fn = $contact['name'];
+
+ if (!$fn) // default display name composition according to vcard standard
+ $fn = 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'];
+
+ if ($email && (empty($fn) || $fn == $email)) {
+ // return full email
+ if ($full_email)
+ return $email;
+
+ list($emailname) = explode('@', $email);
+ if (preg_match('/(.*)[\.\-\_](.*)/', $emailname, $match))
+ $fn = trim(ucfirst($match[1]).' '.ucfirst($match[2]));
+ else
+ $fn = ucfirst($emailname);
+ }
+
+ return $fn;
+ }
+
+
+ /**
+ * Compose the name to display in the contacts list for the given contact record.
+ * This respects the settings parameter how to list conacts.
+ *
+ * @param array Hash array with contact data as key-value pairs
+ * @return string List name
+ */
+ public static function compose_list_name($contact)
+ {
+ static $compose_mode;
+
+ if (!isset($compose_mode)) // cache this
+ $compose_mode = rcmail::get_instance()->config->get('addressbook_name_listing', 0);
+
+ if ($compose_mode == 3)
+ $fn = join(' ', array($contact['surname'] . ',', $contact['firstname'], $contact['middlename']));
+ else if ($compose_mode == 2)
+ $fn = join(' ', array($contact['surname'], $contact['firstname'], $contact['middlename']));
+ else if ($compose_mode == 1)
+ $fn = join(' ', array($contact['firstname'], $contact['middlename'], $contact['surname']));
+ else
+ $fn = !empty($contact['name']) ? $contact['name'] : join(' ', array($contact['prefix'], $contact['firstname'], $contact['middlename'], $contact['surname'], $contact['suffix']));
+
+ $fn = trim($fn, ', ');
+
+ // fallback to display name
+ if (empty($fn) && $contact['name'])
+ $fn = $contact['name'];
+
+ // fallback to email address
+ $email = is_array($contact['email']) ? $contact['email'][0] : $contact['email'];
+ if (empty($fn) && $email)
+ return $email;
+
+ return $fn;
+ }
+
}
--
Gitblit v1.9.1