From 1495ac7913095ae8284c3501b7d4e6dd31a484ec Mon Sep 17 00:00:00 2001
From: alecpl <alec@alec.pl>
Date: Sat, 14 Apr 2012 07:15:28 -0400
Subject: [PATCH] - More public methods, code cleanup
---
program/include/rcube_contacts.php | 251 ++++++++++++++++++++++++++++++++++---------------
1 files changed, 173 insertions(+), 78 deletions(-)
diff --git a/program/include/rcube_contacts.php b/program/include/rcube_contacts.php
index 52667fa..8834a7d 100644
--- a/program/include/rcube_contacts.php
+++ b/program/include/rcube_contacts.php
@@ -5,8 +5,11 @@
| program/include/rcube_contacts.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 |
@@ -31,6 +34,7 @@
protected $db_name = 'contacts';
protected $db_groups = 'contactgroups';
protected $db_groupmembers = 'contactgroupmembers';
+ protected $vcard_fieldmap = array();
/**
* Store database connection.
@@ -41,7 +45,6 @@
private $user_id = 0;
private $filter = null;
private $result = null;
- private $name;
private $cache;
private $table_cols = array('name', 'email', 'firstname', 'surname');
private $fulltext_cols = array('name', 'firstname', 'surname', 'middlename', 'nickname',
@@ -50,6 +53,7 @@
// public properties
public $primary_key = 'contact_id';
+ public $name;
public $readonly = false;
public $groups = true;
public $undelete = true;
@@ -61,6 +65,8 @@
'jobtitle', 'organization', 'department', 'assistant', 'manager',
'gender', 'maidenname', 'spouse', 'email', 'phone', 'address',
'birthday', 'anniversary', 'website', 'im', 'notes', 'photo');
+
+ const SEPARATOR = ',';
/**
@@ -147,7 +153,7 @@
$sql_filter = $search ? " AND " . $this->db->ilike('name', '%'.$search.'%') : '';
$sql_result = $this->db->query(
- "SELECT * FROM ".get_table_name($this->db_groups).
+ "SELECT * FROM ".$this->db->table_name($this->db_groups).
" WHERE del<>1".
" AND user_id=?".
$sql_filter.
@@ -162,6 +168,29 @@
return $results;
}
+
+ /**
+ * 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 ".$this->db->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
@@ -185,17 +214,28 @@
$length = $subset != 0 ? abs($subset) : $this->page_size;
if ($this->group_id)
- $join = " LEFT JOIN ".get_table_name($this->db_groupmembers)." AS m".
+ $join = " LEFT JOIN ".$this->db->table_name($this->db_groupmembers)." AS m".
" ON (m.contact_id = c.".$this->primary_key.")";
+ $order_col = (in_array($this->sort_col, $this->table_cols) ? $this->sort_col : 'name');
+ $order_cols = array('c.'.$order_col);
+ if ($order_col == 'firstname')
+ $order_cols[] = 'c.surname';
+ else if ($order_col == 'surname')
+ $order_cols[] = 'c.firstname';
+ if ($order_col != 'name')
+ $order_cols[] = 'c.name';
+ $order_cols[] = 'c.email';
+
$sql_result = $this->db->limitquery(
- "SELECT * FROM ".get_table_name($this->db_name)." AS c" .
+ "SELECT * FROM ".$this->db->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 ". $this->db->concat('c.name', 'c.email'),
+ " ORDER BY ". $this->db->concat($order_cols) .
+ " " . $this->sort_order,
$start_row,
$length,
$this->user_id,
@@ -209,14 +249,9 @@
if ($read_vcard)
$sql_arr = $this->convert_db_data($sql_arr);
- else
- $sql_arr['email'] = preg_split('/,\s*/', $sql_arr['email']);
-
- // make sure we have a name to display
- if (empty($sql_arr['name'])) {
- if (empty($sql_arr['email']))
- $sql_arr['email'] = $this->get_col_values('email', $sql_arr, true);
- $sql_arr['name'] = $sql_arr['email'][0];
+ else {
+ $sql_arr['email'] = explode(self::SEPARATOR, $sql_arr['email']);
+ $sql_arr['email'] = array_map('trim', $sql_arr['email']);
}
$this->result->add($sql_arr);
@@ -245,14 +280,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);
@@ -260,11 +298,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;
@@ -272,26 +313,60 @@
// 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))
@@ -300,7 +375,7 @@
}
}
- foreach ($required as $col) {
+ foreach (array_intersect($required, $this->table_cols) as $col) {
$and_where[] = $this->db->quoteIdentifier($col).' <> '.$this->db->quote('');
}
@@ -339,13 +414,24 @@
$search = $post_search[$colname];
foreach ((array)$row[$col] as $value) {
// composite field, e.g. address
- if (is_array($value)) {
- $value = implode($value);
- }
- $value = mb_strtolower($value);
- if (($strict && $value == $search) || (!$strict && strpos($value, $search) !== false)) {
- $found[$colname] = true;
- 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;
+ }
}
}
}
@@ -402,13 +488,13 @@
private function _count()
{
if ($this->group_id)
- $join = " LEFT JOIN ".get_table_name($this->db_groupmembers)." AS m".
+ $join = " LEFT JOIN ".$this->db->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".
+ " FROM ".$this->db->table_name($this->db_name)." AS c".
$join.
" WHERE c.del<>1".
" AND c.user_id=?".
@@ -450,7 +536,7 @@
return $assoc ? $first : $this->result;
$this->db->query(
- "SELECT * FROM ".get_table_name($this->db_name).
+ "SELECT * FROM ".$this->db->table_name($this->db_name).
" WHERE contact_id=?".
" AND user_id=?".
" AND del<>1",
@@ -482,8 +568,8 @@
return $results;
$sql_result = $this->db->query(
- "SELECT cgm.contactgroup_id, cg.name FROM " . get_table_name($this->db_groupmembers) . " AS cgm" .
- " LEFT JOIN " . get_table_name($this->db_groups) . " AS cg ON (cgm.contactgroup_id = cg.contactgroup_id AND cg.del<>1)" .
+ "SELECT cgm.contactgroup_id, cg.name FROM " . $this->db->table_name($this->db_groupmembers) . " AS cgm" .
+ " LEFT JOIN " . $this->db->table_name($this->db_groups) . " AS cg ON (cgm.contactgroup_id = cg.contactgroup_id AND cg.del<>1)" .
" WHERE cgm.contact_id=?",
$id
);
@@ -500,16 +586,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;
}
@@ -551,7 +638,7 @@
if (!$existing->count && !empty($a_insert_cols)) {
$this->db->query(
- "INSERT INTO ".get_table_name($this->db_name).
+ "INSERT INTO ".$this->db->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).")"
);
@@ -589,7 +676,7 @@
if (!empty($write_sql)) {
$this->db->query(
- "UPDATE ".get_table_name($this->db_name).
+ "UPDATE ".$this->db->table_name($this->db_name).
" SET changed=".$this->db->now().", ".join(', ', $write_sql).
" WHERE contact_id=?".
" AND user_id=?".
@@ -604,23 +691,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;
}
@@ -631,7 +719,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);
@@ -651,12 +739,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)));
@@ -668,18 +760,19 @@
/**
* 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).
+ "UPDATE ".$this->db->table_name($this->db_name).
" SET del=1, changed=".$this->db->now().
" WHERE user_id=?".
" AND contact_id IN ($ids)",
@@ -700,13 +793,13 @@
function undelete($ids)
{
if (!is_array($ids))
- $ids = explode(',', $ids);
+ $ids = explode(self::SEPARATOR, $ids);
$ids = $this->db->array2list($ids, 'integer');
- // flag record as deleted
+ // clear deleted flag
$this->db->query(
- "UPDATE ".get_table_name($this->db_name).
+ "UPDATE ".$this->db->table_name($this->db_name).
" SET del=0, changed=".$this->db->now().
" WHERE user_id=?".
" AND contact_id IN ($ids)",
@@ -726,7 +819,7 @@
{
$this->cache = null;
- $this->db->query("UPDATE ".get_table_name($this->db_name).
+ $this->db->query("UPDATE ".$this->db->table_name($this->db_name).
" SET del=1, changed=".$this->db->now().
" WHERE user_id = ?", $this->user_id);
@@ -748,7 +841,7 @@
$name = $this->unique_groupname($name);
$this->db->query(
- "INSERT INTO ".get_table_name($this->db_groups).
+ "INSERT INTO ".$this->db->table_name($this->db_groups).
" (user_id, changed, name)".
" VALUES (".intval($this->user_id).", ".$this->db->now().", ".$this->db->quote($name).")"
);
@@ -770,10 +863,11 @@
{
// flag group record as deleted
$sql_result = $this->db->query(
- "UPDATE ".get_table_name($this->db_groups).
+ "UPDATE ".$this->db->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;
@@ -789,16 +883,17 @@
* @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)
+ function rename_group($gid, $newname, &$new_gid)
{
// make sure we have a unique name
$name = $this->unique_groupname($newname);
$sql_result = $this->db->query(
- "UPDATE ".get_table_name($this->db_groups).
+ "UPDATE ".$this->db->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;
@@ -815,14 +910,14 @@
function add_to_group($group_id, $ids)
{
if (!is_array($ids))
- $ids = explode(',', $ids);
+ $ids = explode(self::SEPARATOR, $ids);
$added = 0;
$exists = array();
// get existing assignments ...
$sql_result = $this->db->query(
- "SELECT contact_id FROM ".get_table_name($this->db_groupmembers).
+ "SELECT contact_id FROM ".$this->db->table_name($this->db_groupmembers).
" WHERE contactgroup_id=?".
" AND contact_id IN (".$this->db->array2list($ids, 'integer').")",
$group_id
@@ -835,7 +930,7 @@
foreach ($ids as $contact_id) {
$this->db->query(
- "INSERT INTO ".get_table_name($this->db_groupmembers).
+ "INSERT INTO ".$this->db->table_name($this->db_groupmembers).
" (contactgroup_id, contact_id, created)".
" VALUES (?, ?, ".$this->db->now().")",
$group_id,
@@ -860,12 +955,12 @@
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');
$sql_result = $this->db->query(
- "DELETE FROM ".get_table_name($this->db_groupmembers).
+ "DELETE FROM ".$this->db->table_name($this->db_groupmembers).
" WHERE contactgroup_id=?".
" AND contact_id IN ($ids)",
$group_id
@@ -888,7 +983,7 @@
do {
$sql_result = $this->db->query(
- "SELECT 1 FROM ".get_table_name($this->db_groups).
+ "SELECT 1 FROM ".$this->db->table_name($this->db_groups).
" WHERE del<>1".
" AND user_id=?".
" AND name=?",
--
Gitblit v1.9.1