Skip to content

Commit

Permalink
- Add option to define matching method for addressbook search (#14865…
Browse files Browse the repository at this point in the history 
…64, #1487907)
  • Loading branch information
@alecpl
alecpl committed Nov 10, 2011
1 parent 81f5dd7 commit f21a04c
Show file tree
Hide file tree
Showing 12 changed files with 133 additions and 42 deletions.
1 change: 1 addition & 0 deletions CHANGELOG
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
CHANGELOG Roundcube Webmail
===========================

- Add option to define matching method for addressbook search (#1486564, #1487907)
- Make email recipients separator configurable
- Fix so folders with \Noinferiors attribute aren't listed in parent selector
- Fix handling of curly brackets in URLs (#1488168)
Expand Down
7 changes: 7 additions & 0 deletions config/main.inc.php.dist
View file
Original file line number Diff line number Diff line change
Expand Up @@ -627,6 +627,13 @@ $rcmail_config['autocomplete_max'] = 15;
// available placeholders: {street}, {locality}, {zipcode}, {country}, {region}
$rcmail_config['address_template'] = '{street}<br/>{locality} {zipcode}<br/>{country} {region}';

// Matching mode for addressbook search (including autocompletion)
// 0 - partial (*abc*), default
// 1 - strict (abc)
// 2 - prefix (abc*)
// Note: For LDAP sources fuzzy_search must be enabled to use 'partial' or 'prefix' mode
$rcmail_config['addressbook_search_mode'] = 0;

// ----------------------------------
// USER PREFERENCES
// ----------------------------------
Expand Down
6 changes: 5 additions & 1 deletion program/include/rcube_addressbook.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,12 +96,16 @@ abstract function list_records($cols=null, $subset=0);
*
* @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
Expand Down
81 changes: 63 additions & 18 deletions program/include/rcube_contacts.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -177,12 +177,12 @@ function get_group($group_id)
" 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;
}

Expand Down Expand Up @@ -268,21 +268,25 @@ function list_records($cols=null, $subset=0, $nocount=false)
*
* @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);
if (!is_array($required) && !empty($required))
$required = array($required);

$where = $and_where = array();
$mode = intval($mode);

foreach ($fields as $idx => $col) {
// direct ID search
Expand All @@ -295,26 +299,56 @@ function search($fields, $value, $strict=false, $select=true, $nocount=false, $r
// 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(" ", self::normalize_string($value)) as $word) {
switch ($mode) {
case 1: // strict
$words[] = '(' . $this->db->ilike('words', $word.' %')
. ' OR ' . $this->db->ilike('words', '% '.$word.' %')
. ' OR ' . $this->db->ilike('words', '% '.$word) . ')';
break;
case 2: // prefix
$words[] = '(' . $this->db->ilike('words', $word.'%')
. ' OR ' . $this->db->ilike('words', '% '.$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) {
switch ($mode) {
case 1: // strict
$where[] = $this->db->quoteIdentifier($col).' = '.$this->db->quote($val);
}
else {
break;
case 2: // prefix
$where[] = $this->db->ilike($col, $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.' %')
. ' OR ' . $this->db->ilike('words', '% '.$word.' %')
. ' OR ' . $this->db->ilike('words', '% '.$word) . ')';
break;
case 2: // prefix
$words[] = '(' . $this->db->ilike('words', $word.'%')
. ' OR ' . $this->db->ilike('words', ' '.$word.'%') . ')';
break;
default: // partial
$words[] = $this->db->ilike('words', '%'.$word.'%');
}
}
$where[] = '(' . join(' AND ', $words) . ')';
}
if (is_array($value))
Expand Down Expand Up @@ -362,13 +396,24 @@ function search($fields, $value, $strict=false, $select=true, $nocount=false, $r
$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;
}
}
}
}
Expand Down
52 changes: 41 additions & 11 deletions program/include/rcube_ldap.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -698,15 +698,20 @@ function _entry_sort_cmp($a, $b)
*
* @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 (fuzzy) 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 (Not used)
* @param array $required List of fields that cannot be empty
*
* @return array Indexed list of 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())
{
$mode = intval($mode);

// special treatment for ID-based search
if ($fields == 'ID' || $fields == $this->primary_key)
{
Expand Down Expand Up @@ -738,13 +743,31 @@ function search($fields, $value, $strict=false, $select=true, $nocount=false, $r
array_values($this->fieldmap), 0, (int)$this->prop['sizelimit'], (int)$this->prop['timelimit']);

// get all entries of this page and post-filter those that really match the query
$search = mb_strtolower($value);
$this->result = new rcube_result_set(0);
$entries = ldap_get_entries($this->conn, $this->ldap_result);

for ($i = 0; $i < $entries['count']; $i++) {
$rec = $this->_ldap2result($entries[$i]);
if (stripos($rec['name'] . $rec['email'], $value) !== false) {
$this->result->add($rec);
$this->result->count++;
foreach (array('email', 'name') as $f) {
$val = mb_strtolower($rec[$f]);
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) {
$this->result->add($rec);
$this->result->count++;
break;
}
}
}

Expand All @@ -753,7 +776,14 @@ function search($fields, $value, $strict=false, $select=true, $nocount=false, $r

// use AND operator for advanced searches
$filter = is_array($value) ? '(&' : '(|';
$wc = !$strict && $this->prop['fuzzy_search'] ? '*' : '';
// set wildcards
$wp = $ws = '';
if (!empty($this->prop['fuzzy_search']) && $mode != 1) {
$ws = '*';
if (!$mode) {
$wp = '*';
}
}

if ($fields == '*')
{
Expand All @@ -767,7 +797,7 @@ function search($fields, $value, $strict=false, $select=true, $nocount=false, $r
if (is_array($this->prop['search_fields']))
{
foreach ($this->prop['search_fields'] as $field) {
$filter .= "($field=$wc" . $this->_quote_string($value) . "$wc)";
$filter .= "($field=$wp" . $this->_quote_string($value) . "$ws)";
}
}
}
Expand All @@ -776,7 +806,7 @@ function search($fields, $value, $strict=false, $select=true, $nocount=false, $r
foreach ((array)$fields as $idx => $field) {
$val = is_array($value) ? $value[$idx] : $value;
if ($f = $this->_map_field($field)) {
$filter .= "($f=$wc" . $this->_quote_string($val) . "$wc)";
$filter .= "($f=$wp" . $this->_quote_string($val) . "$ws)";
}
}
}
Expand Down Expand Up @@ -1433,9 +1463,9 @@ function list_groups($search = null)

$groups = array();
if ($search) {
$search = strtolower($search);
$search = mb_strtolower($search);
foreach ($group_cache as $group) {
if (strstr(strtolower($group['name']), $search))
if (strpos(mb_strtolower($group['name']), $search) !== false)
$groups[] = $group;
}
}
Expand Down Expand Up @@ -1511,7 +1541,7 @@ private function _fetch_groups($vlv_page = 0)
$groups[$group_id]['email'][] = $ldap_data[$i][$email_attr][$j];
}

$group_sortnames[] = strtolower($ldap_data[$i][$sort_attr][0]);
$group_sortnames[] = mb_strtolower($ldap_data[$i][$sort_attr][0]);
}

// recursive call can exit here
Expand Down
4 changes: 2 additions & 2 deletions program/steps/addressbook/copy.inc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ foreach ($cids as $source => $cid)
// Check if contact exists, if so, we'll need it's ID
// Note: Some addressbooks allows empty email address field
if (!empty($a_record['email']))
$result = $TARGET->search('email', $a_record['email'], true, true, true);
$result = $TARGET->search('email', $a_record['email'], 1, true, true);
else if (!empty($a_record['name']))
$result = $TARGET->search('name', $a_record['name'], true, true, true);
$result = $TARGET->search('name', $a_record['name'], 1, true, true);
else
$result = new rcube_result_set();

Expand Down
4 changes: 2 additions & 2 deletions program/steps/addressbook/import.inc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -174,9 +174,9 @@ if ($_FILES['_file']['tmp_name'] && is_uploaded_file($_FILES['_file']['tmp_name'

if (!$replace && $email) {
// compare e-mail address
$existing = $CONTACTS->search('email', $email, false, false);
$existing = $CONTACTS->search('email', $email, 1, false);
if (!$existing->count && $vcard->displayname) { // compare display name
$existing = $CONTACTS->search('name', $vcard->displayname, false, false);
$existing = $CONTACTS->search('name', $vcard->displayname, 1, false);
}
if ($existing->count) {
$IMPORT_STATS->skipped++;
Expand Down
2 changes: 1 addition & 1 deletion program/steps/addressbook/mailto.inc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ foreach ($cids as $source => $cid)
{
$CONTACTS->set_page(1);
$CONTACTS->set_pagesize(count($cid) + 2); // +2 to skip counting query
$recipients = $CONTACTS->search($CONTACTS->primary_key, $cid, false, true, true, 'email');
$recipients = $CONTACTS->search($CONTACTS->primary_key, $cid, 0, true, true, 'email');
}
}

Expand Down
2 changes: 1 addition & 1 deletion program/steps/addressbook/save.inc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ else {
// show notice if existing contacts with same e-mail are found
$existing = false;
foreach ($CONTACTS->get_col_values('email', $a_record, true) as $email) {
if ($email && ($res = $CONTACTS->search('email', $email, false, false, true)) && $res->count) {
if ($email && ($res = $CONTACTS->search('email', $email, 1, false, true)) && $res->count) {
$OUTPUT->show_message('contactexists', 'notice', null, false);
break;
}
Expand Down
5 changes: 4 additions & 1 deletion program/steps/addressbook/search.inc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,9 @@ function rcmail_contact_search()
}
}

// Values matching mode
$mode = (int) $RCMAIL->config->get('addressbook_search_mode');

// get sources list
$sources = $RCMAIL->get_address_sources();
$search_set = array();
Expand Down Expand Up @@ -168,7 +171,7 @@ function rcmail_contact_search()
$source->set_pagesize(9999);

// get contacts count
$result = $source->search($fields, $search, false, false);
$result = $source->search($fields, $search, $mode, false);

if (!$result->count) {
continue;
Expand Down
6 changes: 3 additions & 3 deletions program/steps/mail/addcontact.inc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ if (!empty($_POST['_address']) && is_object($CONTACTS))
$OUTPUT->show_message('errorsavingcontact', 'error');
$OUTPUT->send();
}

$email = rcube_idn_to_ascii($contact['email']);
if (!check_email($email, false)) {
$OUTPUT->show_message('emailformaterror', 'error', array('email' => $contact['email']));
Expand All @@ -65,13 +65,13 @@ if (!empty($_POST['_address']) && is_object($CONTACTS))
$error = $CONTACTS->get_error();
// TODO: show dialog to complete record
// if ($error['type'] == rcube_addressbook::ERROR_VALIDATE) { }

$OUTPUT->show_message($error['message'] ? $error['message'] : 'errorsavingcontact', 'error');
$OUTPUT->send();
}

// check for existing contacts
$existing = $CONTACTS->search('email', $contact['email'], true, false);
$existing = $CONTACTS->search('email', $contact['email'], 1, false);

if ($done = $existing->count)
$OUTPUT->show_message('contactexists', 'warning');
Expand Down
Loading

0 comments on commit f21a04c

Please sign in to comment.