From 8b92d2b0507a98dfd380553c64765bcfdecc6fe3 Mon Sep 17 00:00:00 2001
From: thomascube <thomas@roundcube.net>
Date: Wed, 25 Jan 2012 15:18:15 -0500
Subject: [PATCH] Add lib for server side mime parsing (to be used by non-imap storage backends or as fallback if imap server doesn't provide a proper structure)
---
program/include/rcube_contacts.php | 245 ++++++++++++++++++++++++++++++++++++++----------
1 files changed, 192 insertions(+), 53 deletions(-)
diff --git a/program/include/rcube_contacts.php b/program/include/rcube_contacts.php
index 5e7165e..1cfebb5 100644
--- a/program/include/rcube_contacts.php
+++ b/program/include/rcube_contacts.php
@@ -6,7 +6,10 @@
| |
| This file is part of the Roundcube Webmail client |
| Copyright (C) 2006-2011, 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: |
| Interface to the local address book database |
@@ -31,6 +34,7 @@
protected $db_name = 'contacts';
protected $db_groups = 'contactgroups';
protected $db_groupmembers = 'contactgroupmembers';
+ protected $vcard_fieldmap = array();
/**
* Store database connection.
@@ -49,8 +53,10 @@
// public properties
public $primary_key = 'contact_id';
+ public $name;
public $readonly = false;
public $groups = true;
+ public $undelete = true;
public $list_page = 1;
public $page_size = 10;
public $group_id = 0;
@@ -59,6 +65,8 @@
'jobtitle', 'organization', 'department', 'assistant', 'manager',
'gender', 'maidenname', 'spouse', 'email', 'phone', 'address',
'birthday', 'anniversary', 'website', 'im', 'notes', 'photo');
+
+ const SEPARATOR = ',';
/**
@@ -76,9 +84,18 @@
/**
+ * Returns addressbook name
+ */
+ function get_name()
+ {
+ return $this->name;
+ }
+
+
+ /**
* Save a search string for future listings
*
- * @param string SQL params to use in listing method
+ * @param string SQL params to use in listing method
*/
function set_search_set($filter)
{
@@ -153,6 +170,29 @@
/**
+ * 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)
+ {
+ $sql_result = $this->db->query(
+ "SELECT * FROM ".get_table_name($this->db_groups).
+ " WHERE del<>1".
+ " AND contactgroup_id=?".
+ " AND user_id=?",
+ $group_id, $this->user_id);
+
+ if ($sql_result && ($sql_arr = $this->db->fetch_assoc($sql_result))) {
+ $sql_arr['ID'] = $sql_arr['contactgroup_id'];
+ return $sql_arr;
+ }
+
+ return null;
+ }
+
+ /**
* List the current set of contact records
*
* @param array List of cols to show, Null means all
@@ -198,8 +238,10 @@
if ($read_vcard)
$sql_arr = $this->convert_db_data($sql_arr);
- else
- $sql_arr['email'] = preg_split('/,\s*/', $sql_arr['email']);
+ else {
+ $sql_arr['email'] = explode(self::SEPARATOR, $sql_arr['email']);
+ $sql_arr['email'] = array_map('trim', $sql_arr['email']);
+ }
// make sure we have a name to display
if (empty($sql_arr['name'])) {
@@ -234,14 +276,17 @@
*
* @param mixed $fields The field name of array of field names to search in
* @param mixed $value Search value (or array of values when $fields is array)
- * @param boolean $strict True for strict (=), False for partial (LIKE) matching
+ * @param int $mode Matching mode:
+ * 0 - partial (*abc*),
+ * 1 - strict (=),
+ * 2 - prefix (abc*)
* @param boolean $select True if results are requested, False if count only
* @param boolean $nocount True to skip the count query (select only)
* @param array $required List of fields that cannot be empty
*
* @return object rcube_result_set Contact records and 'count' value
*/
- function search($fields, $value, $strict=false, $select=true, $nocount=false, $required=array())
+ function search($fields, $value, $mode=0, $select=true, $nocount=false, $required=array())
{
if (!is_array($fields))
$fields = array($fields);
@@ -249,11 +294,14 @@
$required = array($required);
$where = $and_where = array();
+ $mode = intval($mode);
+ $WS = ' ';
+ $AS = self::SEPARATOR;
foreach ($fields as $idx => $col) {
// direct ID search
if ($col == 'ID' || $col == $this->primary_key) {
- $ids = !is_array($value) ? explode(',', $value) : $value;
+ $ids = !is_array($value) ? explode(self::SEPARATOR, $value) : $value;
$ids = $this->db->array2list($ids, 'integer');
$where[] = 'c.' . $this->primary_key.' IN ('.$ids.')';
continue;
@@ -261,35 +309,69 @@
// fulltext search in all fields
else if ($col == '*') {
$words = array();
- foreach (explode(" ", self::normalize_string($value)) as $word)
- $words[] = $this->db->ilike('words', '%'.$word.'%');
+ foreach (explode($WS, self::normalize_string($value)) as $word) {
+ switch ($mode) {
+ case 1: // strict
+ $words[] = '(' . $this->db->ilike('words', $word . '%')
+ . ' OR ' . $this->db->ilike('words', '%' . $WS . $word . $WS . '%')
+ . ' OR ' . $this->db->ilike('words', '%' . $WS . $word) . ')';
+ break;
+ case 2: // prefix
+ $words[] = '(' . $this->db->ilike('words', $word . '%')
+ . ' OR ' . $this->db->ilike('words', '%' . $WS . $word . '%') . ')';
+ break;
+ default: // partial
+ $words[] = $this->db->ilike('words', '%' . $word . '%');
+ }
+ }
$where[] = '(' . join(' AND ', $words) . ')';
}
else {
$val = is_array($value) ? $value[$idx] : $value;
// table column
if (in_array($col, $this->table_cols)) {
- if ($strict) {
- $where[] = $this->db->quoteIdentifier($col).' = '.$this->db->quote($val);
- }
- else {
- $where[] = $this->db->ilike($col, '%'.$val.'%');
+ switch ($mode) {
+ case 1: // strict
+ $where[] = '(' . $this->db->quoteIdentifier($col) . ' = ' . $this->db->quote($val)
+ . ' OR ' . $this->db->ilike($col, $val . $AS . '%')
+ . ' OR ' . $this->db->ilike($col, '%' . $AS . $val . $AS . '%')
+ . ' OR ' . $this->db->ilike($col, '%' . $AS . $val) . ')';
+ break;
+ case 2: // prefix
+ $where[] = '(' . $this->db->ilike($col, $val . '%')
+ . ' OR ' . $this->db->ilike($col, $AS . $val . '%') . ')';
+ break;
+ default: // partial
+ $where[] = $this->db->ilike($col, '%' . $val . '%');
}
}
// vCard field
else {
if (in_array($col, $this->fulltext_cols)) {
- foreach (explode(" ", self::normalize_string($val)) as $word)
- $words[] = $this->db->ilike('words', '%'.$word.'%');
+ foreach (explode(" ", self::normalize_string($val)) as $word) {
+ switch ($mode) {
+ case 1: // strict
+ $words[] = '(' . $this->db->ilike('words', $word . $WS . '%')
+ . ' OR ' . $this->db->ilike('words', '%' . $AS . $word . $WS .'%')
+ . ' OR ' . $this->db->ilike('words', '%' . $AS . $word) . ')';
+ break;
+ case 2: // prefix
+ $words[] = '(' . $this->db->ilike('words', $word . '%')
+ . ' OR ' . $this->db->ilike('words', $AS . $word . '%') . ')';
+ break;
+ default: // partial
+ $words[] = $this->db->ilike('words', '%' . $word . '%');
+ }
+ }
$where[] = '(' . join(' AND ', $words) . ')';
}
if (is_array($value))
- $post_search[$col] = $strict ? $val : mb_strtolower($val);
+ $post_search[$col] = mb_strtolower($val);
}
}
}
- foreach ($required as $col) {
+ foreach (array_intersect($required, $this->table_cols) as $col) {
$and_where[] = $this->db->quoteIdentifier($col).' <> '.$this->db->quote('');
}
@@ -306,7 +388,7 @@
if (!empty($post_search)) {
$ids = array(0);
// build key name regexp
- $regexp = '/^(' . implode(array_keys($post_search), '|') . ')(:.*?)$/';
+ $regexp = '/^(' . implode(array_keys($post_search), '|') . ')(?:.*)$/';
// use initial WHERE clause, to limit records number if possible
if (!empty($where))
$this->set_search_set($where);
@@ -321,26 +403,36 @@
$this->list_records(null, $i, true);
while ($row = $this->result->next()) {
$id = $row[$this->primary_key];
- $found = 0;
+ $found = array();
foreach (preg_grep($regexp, array_keys($row)) as $col) {
$pos = strpos($col, ':');
$colname = $pos ? substr($col, 0, $pos) : $col;
$search = $post_search[$colname];
foreach ((array)$row[$col] as $value) {
// composite field, e.g. address
- if (is_array($value)) {
- $value = implode($value);
- }
- if (($strict && $value == $search)
- || (!$strict && strpos(mb_strtolower($value), $search) !== false)
- ) {
- $found++;
- break;
+ 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);
+ break;
+ }
+
+ if ($got) {
+ $found[$colname] = true;
+ break 2;
+ }
}
}
}
// all fields match
- if ($found == $scnt) {
+ if (count($found) >= $scnt) {
$ids[] = $id;
}
}
@@ -349,7 +441,14 @@
// build WHERE clause
$ids = $this->db->array2list($ids, 'integer');
$where = 'c.' . $this->primary_key.' IN ('.$ids.')';
+ // reset counter
unset($this->cache['count']);
+
+ // when we know we have an empty result
+ if ($ids == '0') {
+ $this->set_search_set($where);
+ return ($this->result = new rcube_result_set(0, 0));
+ }
}
if (!empty($where)) {
@@ -483,16 +582,17 @@
* If input not valid, the message to display can be fetched using get_error()
*
* @param array Assoziative array with data to save
+ * @param boolean Try to fix/complete record automatically
* @return boolean True if input is valid, False if not.
*/
- public function validate($save_data)
+ public function validate(&$save_data, $autofix = false)
{
// validate e-mail addresses
- $valid = parent::validate($save_data);
+ $valid = parent::validate($save_data, $autofix);
// require at least one e-mail address (syntax check is already done)
if ($valid && !array_filter($this->get_col_values('email', $save_data, true))) {
- $this->set_error('warning', 'noemailwarning');
+ $this->set_error(self::ERROR_VALIDATE, 'noemailwarning');
$valid = false;
}
@@ -587,23 +687,24 @@
return $updated;
}
-
-
+
+
private function convert_db_data($sql_arr)
{
$record = array();
$record['ID'] = $sql_arr[$this->primary_key];
-
+
if ($sql_arr['vcard']) {
unset($sql_arr['email']);
- $vcard = new rcube_vcard($sql_arr['vcard']);
+ $vcard = new rcube_vcard($sql_arr['vcard'], RCMAIL_CHARSET, false, $this->vcard_fieldmap);
$record += $vcard->get_assoc() + $sql_arr;
}
else {
$record += $sql_arr;
- $record['email'] = preg_split('/,\s*/', $record['email']);
+ $record['email'] = explode(self::SEPARATOR, $record['email']);
+ $record['email'] = array_map('trim', $record['email']);
}
-
+
return $record;
}
@@ -614,7 +715,7 @@
$words = '';
// copy values into vcard object
- $vcard = new rcube_vcard($record['vcard'] ? $record['vcard'] : $save_data['vcard']);
+ $vcard = new rcube_vcard($record['vcard'] ? $record['vcard'] : $save_data['vcard'], RCMAIL_CHARSET, false, $this->vcard_fieldmap);
$vcard->reset();
foreach ($save_data as $key => $values) {
list($field, $section) = explode(':', $key);
@@ -634,12 +735,16 @@
$key = $col;
if (!isset($save_data[$key]))
$key .= ':home';
- if (isset($save_data[$key]))
- $out[$col] = is_array($save_data[$key]) ? join(',', $save_data[$key]) : $save_data[$key];
+ if (isset($save_data[$key])) {
+ if (is_array($save_data[$key]))
+ $out[$col] = join(self::SEPARATOR, $save_data[$key]);
+ else
+ $out[$col] = $save_data[$key];
+ }
}
// save all e-mails in database column
- $out['email'] = join(", ", $vcard->email);
+ $out['email'] = join(self::SEPARATOR, $vcard->email);
// join words for fulltext search
$out['words'] = join(" ", array_unique(explode(" ", $words)));
@@ -651,19 +756,47 @@
/**
* Mark one or more contact records as deleted
*
- * @param array Record identifiers
+ * @param array Record identifiers
+ * @param boolean Remove record(s) irreversible (unsupported)
*/
- function delete($ids)
+ function delete($ids, $force=true)
{
if (!is_array($ids))
- $ids = explode(',', $ids);
+ $ids = explode(self::SEPARATOR, $ids);
$ids = $this->db->array2list($ids, 'integer');
- // flag record as deleted
+ // flag record as deleted (always)
$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();
+ }
+
+
+ /**
+ * Undelete one or more contact records
+ *
+ * @param array Record identifiers
+ */
+ function undelete($ids)
+ {
+ if (!is_array($ids))
+ $ids = explode(self::SEPARATOR, $ids);
+
+ $ids = $this->db->array2list($ids, 'integer');
+
+ // clear deleted flag
+ $this->db->query(
+ "UPDATE ".get_table_name($this->db_name).
+ " SET del=0, changed=".$this->db->now().
" WHERE user_id=?".
" AND contact_id IN ($ids)",
$this->user_id
@@ -680,8 +813,12 @@
*/
function delete_all()
{
- $this->db->query("DELETE FROM ".get_table_name($this->db_name)." WHERE user_id = ?", $this->user_id);
$this->cache = null;
+
+ $this->db->query("UPDATE ".get_table_name($this->db_name).
+ " SET del=1, changed=".$this->db->now().
+ " WHERE user_id = ?", $this->user_id);
+
return $this->db->affected_rows();
}
@@ -724,8 +861,9 @@
$sql_result = $this->db->query(
"UPDATE ".get_table_name($this->db_groups).
" SET del=1, changed=".$this->db->now().
- " WHERE contactgroup_id=?",
- $gid
+ " WHERE contactgroup_id=?".
+ " AND user_id=?",
+ $gid, $this->user_id
);
$this->cache = null;
@@ -749,8 +887,9 @@
$sql_result = $this->db->query(
"UPDATE ".get_table_name($this->db_groups).
" SET name=?, changed=".$this->db->now().
- " WHERE contactgroup_id=?",
- $name, $gid
+ " WHERE contactgroup_id=?".
+ " AND user_id=?",
+ $name, $gid, $this->user_id
);
return $this->db->affected_rows() ? $name : false;
@@ -767,7 +906,7 @@
function add_to_group($group_id, $ids)
{
if (!is_array($ids))
- $ids = explode(',', $ids);
+ $ids = explode(self::SEPARATOR, $ids);
$added = 0;
$exists = array();
@@ -812,7 +951,7 @@
function remove_from_group($group_id, $ids)
{
if (!is_array($ids))
- $ids = explode(',', $ids);
+ $ids = explode(self::SEPARATOR, $ids);
$ids = $this->db->array2list($ids, 'integer');
--
Gitblit v1.9.1