From f66f5f02e30d9fc2d5c06eeefb4377b8ff36fce2 Mon Sep 17 00:00:00 2001
From: alecpl <alec@alec.pl>
Date: Fri, 08 Apr 2011 02:15:37 -0400
Subject: [PATCH] - Removed dependency on rcube_* functions, small improvements
---
program/include/rcube_contacts.php | 235 +++++++++++++++++++++++++++++++++++++++++++++-------------
1 files changed, 182 insertions(+), 53 deletions(-)
diff --git a/program/include/rcube_contacts.php b/program/include/rcube_contacts.php
index 8f93374..705551b 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-2010, Roundcube Dev. - Switzerland |
+ | Copyright (C) 2006-2011, The Roundcube Dev Team |
| Licensed under the GNU GPL |
| |
| PURPOSE: |
@@ -32,23 +32,33 @@
protected $db_groups = 'contactgroups';
protected $db_groupmembers = 'contactgroupmembers';
+ /**
+ * Store database connection.
+ *
+ * @var rcube_mdb2
+ */
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');
+ private $table_cols = array('name', 'email', 'firstname', 'surname');
+ private $fulltext_cols = array('name', 'firstname', 'surname', 'middlename', 'nickname',
+ 'jobtitle', 'organization', 'department', 'maidenname', 'email', 'phone',
+ 'address', 'street', 'locality', 'zipcode', 'region', 'country', 'website', 'im', 'notes');
// 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;
+ public $primary_key = 'contact_id';
+ public $readonly = false;
+ public $groups = true;
+ public $list_page = 1;
+ public $page_size = 10;
+ public $group_id = 0;
+ public $ready = false;
+ public $coltypes = array('name', 'firstname', 'surname', 'middlename', 'prefix', 'suffix', 'nickname',
+ 'jobtitle', 'organization', 'department', 'assistant', 'manager',
+ 'gender', 'maidenname', 'spouse', 'email', 'phone', 'address',
+ 'birthday', 'anniversary', 'website', 'im', 'notes', 'photo');
/**
@@ -106,8 +116,6 @@
{
$this->result = null;
$this->filter = null;
- $this->search_fields = null;
- $this->search_string = null;
$this->cache = null;
}
@@ -147,7 +155,7 @@
/**
* List the current set of contact records
*
- * @param array List of cols to show
+ * @param array List of cols to show, Null means all
* @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
@@ -182,11 +190,21 @@
$this->user_id,
$this->group_id);
+ // determine whether we have to parse the vcard or if only db cols are requested
+ $read_vcard = !$cols || count(array_intersect($cols, $this->table_cols)) < count($cols);
+
while ($sql_result && ($sql_arr = $this->db->fetch_assoc($sql_result))) {
$sql_arr['ID'] = $sql_arr[$this->primary_key];
+
+ 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']))
- $sql_arr['name'] = $sql_arr['email'];
+ $sql_arr['name'] = $sql_arr['email'][0];
+
$this->result->add($sql_arr);
}
@@ -217,7 +235,7 @@
* @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
+ * @return object rcube_result_set Contact records and 'count' value
*/
function search($fields, $value, $strict=false, $select=true, $nocount=false, $required=array())
{
@@ -234,8 +252,15 @@
$ids = $this->db->array2list($ids, 'integer');
$where[] = 'c.' . $this->primary_key.' IN ('.$ids.')';
}
- else if ($strict)
+ else if ($strict) {
$where[] = $this->db->quoteIdentifier($col).' = '.$this->db->quote($value);
+ }
+ else if ($col == '*') {
+ $words = array();
+ foreach(explode(" ", self::normalize_string($value)) as $word)
+ $words[] = $this->db->ilike('words', '%'.$word.'%');
+ $where[] = '(' . join(' AND ', $words) . ')';
+ }
else
$where[] = $this->db->ilike($col, '%'.$value.'%');
}
@@ -310,7 +335,7 @@
/**
* Return the last result set
*
- * @return Result array or NULL if nothing selected yet
+ * @return mixed Result array or NULL if nothing selected yet
*/
function get_result()
{
@@ -322,7 +347,7 @@
* Get a specific contact record
*
* @param mixed record identifier(s)
- * @return Result object with all record fields or False if not found
+ * @return mixed Result object with all record fields or False if not found
*/
function get_record($id, $assoc=false)
{
@@ -340,38 +365,95 @@
);
if ($sql_arr = $this->db->fetch_assoc()) {
- $sql_arr['ID'] = $sql_arr[$this->primary_key];
+ $record = $this->convert_db_data($sql_arr);
$this->result = new rcube_result_set(1);
- $this->result->add($sql_arr);
+ $this->result->add($record);
}
- return $assoc && $sql_arr ? $sql_arr : $this->result;
+ return $assoc && $record ? $record : $this->result;
+ }
+
+
+ /**
+ * Get group assignments of a specific contact record
+ *
+ * @param mixed Record identifier
+ * @return array List of assigned groups as ID=>Name pairs
+ */
+ function get_record_groups($id)
+ {
+ $results = array();
+
+ if (!$this->groups)
+ 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)" .
+ " WHERE cgm.contact_id=?",
+ $id
+ );
+ while ($sql_result && ($sql_arr = $this->db->fetch_assoc($sql_result))) {
+ $results[$sql_arr['contactgroup_id']] = $sql_arr['name'];
+ }
+
+ return $results;
+ }
+
+
+ /**
+ * Check the given data before saving.
+ * If input not valid, the message to display can be fetched using get_error()
+ *
+ * @param array Assoziative array with data to save
+ * @return boolean True if input is valid, False if not.
+ */
+ public function validate($save_data)
+ {
+ // check for name input
+ $valid = parent::validate($save_data);
+
+ // require at least one e-mail address (syntax check is done later in save.inc)
+ if ($valid && !array_filter($this->get_col_values('email', $save_data, true))) {
+ $this->set_error('warning', 'noemailwarning');
+ $valid = false;
+ }
+
+ return $valid;
}
/**
* Create a new contact record
*
- * @param array Assoziative array with save data
- * @return The created record ID on success, False on error
+ * @param array Associative array with save data
+ * @return integer|boolean 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);
+ if (!is_array($save_data))
+ return false;
$insert_id = $existing = false;
- if ($check)
- $existing = $this->search('email', $save_data['email'], true, false);
+ if ($check) {
+ foreach ($save_data as $col => $values) {
+ if (strpos($col, 'email') === 0) {
+ foreach ((array)$values as $email) {
+ if ($existing = $this->search('email', $email, false, false))
+ break 2;
+ }
+ }
+ }
+ }
+ $save_data = $this->convert_save_data($save_data);
$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]);
- }
+ foreach ($save_data as $col => $value) {
+ $a_insert_cols[] = $this->db->quoteIdentifier($col);
+ $a_insert_values[] = $this->db->quote($value);
+ }
if (!$existing->count && !empty($a_insert_cols)) {
$this->db->query(
@@ -394,35 +476,22 @@
/**
- * 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
+ * @return boolean True on success, False on error
*/
function update($id, $save_cols)
{
$updated = false;
$write_sql = array();
+ $record = $this->get_record($id, true);
+ $save_cols = $this->convert_save_data($save_cols, $record);
- 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]));
+ foreach ($save_cols as $col => $value) {
+ $write_sql[] = sprintf("%s=%s", $this->db->quoteIdentifier($col), $this->db->quote($value));
+ }
if (!empty($write_sql)) {
$this->db->query(
@@ -436,9 +505,69 @@
);
$updated = $this->db->affected_rows();
+ $this->result = null; // clear current result (from get_record())
}
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']);
+ $record += $vcard->get_assoc() + $sql_arr;
+ }
+ else {
+ $record += $sql_arr;
+ $record['email'] = preg_split('/,\s*/', $record['email']);
+ }
+
+ return $record;
+ }
+
+
+ private function convert_save_data($save_data, $record = array())
+ {
+ $out = array();
+ $words = '';
+
+ // copy values into vcard object
+ $vcard = new rcube_vcard($record['vcard'] ? $record['vcard'] : $save_data['vcard']);
+ $vcard->reset();
+ foreach ($save_data as $key => $values) {
+ list($field, $section) = explode(':', $key);
+ $fulltext = in_array($field, $this->fulltext_cols);
+ foreach ((array)$values as $value) {
+ if (isset($value))
+ $vcard->set($field, $value, $section);
+ if ($fulltext && is_array($value))
+ $words .= ' ' . self::normalize_string(join(" ", $value));
+ else if ($fulltext && strlen($value) >= 3)
+ $words .= ' ' . self::normalize_string($value);
+ }
+ }
+ $out['vcard'] = $vcard->export();
+
+ foreach ($this->table_cols as $col) {
+ $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];
+ }
+
+ // save all e-mails in database column
+ $out['email'] = join(", ", $vcard->email);
+
+ // join words for fulltext search
+ $out['words'] = join(" ", array_unique(explode(" ", $words)));
+
+ return $out;
}
@@ -484,7 +613,7 @@
* Create a contact group with the given name
*
* @param string The group name
- * @return False on error, array with record props in success
+ * @return mixed False on error, array with record props in success
*/
function create_group($name)
{
--
Gitblit v1.9.1