From 6c27c3b55e7516ae1d2b99ecd1188203d022de78 Mon Sep 17 00:00:00 2001
From: Thomas Bruederli <thomas@roundcube.net>
Date: Fri, 25 Jan 2013 08:27:25 -0500
Subject: [PATCH] Add search box to compose address book widget (#1488381)
---
CHANGELOG | 1
program/steps/mail/search_contacts.inc | 112 ++++++++++++++++++
program/steps/mail/list_contacts.inc | 147 ++++++++++++++++--------
program/js/app.js | 22 ++-
skins/larry/mail.css | 21 +++
skins/larry/templates/compose.html | 7 +
6 files changed, 251 insertions(+), 59 deletions(-)
diff --git a/CHANGELOG b/CHANGELOG
index bd0e7c8..58b395f 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -1,6 +1,7 @@
CHANGELOG Roundcube Webmail
===========================
+- Add search box to compose address book widget (#1488381)
- Fix login in case when default_host is an array with one element (#1488928)
- Use LDAP fallback hosts on connect + bind instead of ldap_connect() only.
- Add config option for LDAP bind timeout (sets LDAP_OPT_NETWORK_TIMEOUT option)
diff --git a/program/js/app.js b/program/js/app.js
index ce17245..4841be0 100644
--- a/program/js/app.js
+++ b/program/js/app.js
@@ -3,8 +3,8 @@
| Roundcube Webmail Client Script |
| |
| This file is part of the Roundcube Webmail client |
- | Copyright (C) 2005-2012, The Roundcube Dev Team |
- | Copyright (C) 2011, Kolab Systems AG |
+ | Copyright (C) 2005-2013, The Roundcube Dev Team |
+ | Copyright (C) 2011-2012, Kolab Systems AG |
| |
| Licensed under the GNU General Public License version 3 or |
| any later version with exceptions for skins & plugins. |
@@ -219,7 +219,7 @@
if (this.gui_objects.qsearchbox) {
if (this.env.search_text != null)
this.gui_objects.qsearchbox.value = this.env.search_text;
- $(this.gui_objects.qsearchbox).focusin(function() { rcmail.message_list.blur(); });
+ $(this.gui_objects.qsearchbox).focusin(function() { rcmail.message_list && rcmail.message_list.blur(); });
}
this.set_button_titles();
@@ -251,7 +251,7 @@
}
}
else if (this.env.action == 'compose') {
- this.env.compose_commands = ['send-attachment', 'remove-attachment', 'send', 'cancel', 'toggle-editor', 'list-adresses', 'extwin'];
+ this.env.compose_commands = ['send-attachment', 'remove-attachment', 'send', 'cancel', 'toggle-editor', 'list-adresses', 'search', 'reset-search', 'extwin'];
if (this.env.drafts_mailbox)
this.env.compose_commands.push('savedraft')
@@ -1050,8 +1050,13 @@
this.reset_qsearch();
this.select_all_mode = false;
- if (s && this.env.mailbox)
+ if (s && this.env.action == 'compose') {
+ if (this.contact_list)
+ this.list_contacts_clear();
+ }
+ else if (s && this.env.mailbox) {
this.list_mailbox(this.env.mailbox, 1);
+ }
else if (s && this.task == 'addressbook') {
if (this.env.source == '') {
for (n in this.env.address_sources) break;
@@ -3652,7 +3657,8 @@
// reset vars
this.env.current_page = 1;
- r = this.http_request('search', url, lock);
+ var action = this.env.action == 'compose' && this.contact_list ? 'search-contacts' : 'search';
+ r = this.http_request(action, url, lock);
this.env.qsearch = {lock: lock, request: r};
}
@@ -4147,7 +4153,7 @@
if (this.env.search_id)
folder = 'S'+this.env.search_id;
- else
+ else if (!this.env.search_request)
folder = group ? 'G'+src+group : src;
this.select_folder(folder);
@@ -4200,7 +4206,7 @@
this.env.source = src;
this.env.group = group;
- // also send search request to get the right messages
+ // also send search request to get the right records
if (this.env.search_request)
url._search = this.env.search_request;
diff --git a/program/steps/mail/list_contacts.inc b/program/steps/mail/list_contacts.inc
index 9347190..7e3b349 100644
--- a/program/steps/mail/list_contacts.inc
+++ b/program/steps/mail/list_contacts.inc
@@ -5,7 +5,7 @@
| program/steps/mail/list_contacts.inc |
| |
| This file is part of the Roundcube Webmail client |
- | Copyright (C) 2012, The Roundcube Dev Team |
+ | Copyright (C) 2012-2013, The Roundcube Dev Team |
| |
| Licensed under the GNU General Public License version 3 or |
| any later version with exceptions for skins & plugins. |
@@ -19,72 +19,117 @@
+-----------------------------------------------------------------------+
*/
-$jsenv = array();
-$source = get_input_value('_source', RCUBE_INPUT_GPC);
-$CONTACTS = $RCMAIL->get_address_book($source);
-$PAGE_SIZE = $RCMAIL->config->get('addressbook_pagesize', $RCMAIL->config->get('pagesize', 50));
+$afields = $RCMAIL->config->get('contactlist_fields');
+$sort_col = $RCMAIL->config->get('addressbook_sort_col', 'name');
+$page_size = $RCMAIL->config->get('addressbook_pagesize', $RCMAIL->config->get('pagesize', 50));
+$page = max(1, intval($_GET['_page']));
-if ($CONTACTS && $CONTACTS->ready) {
- // set list properties
- $CONTACTS->set_pagesize($PAGE_SIZE);
- $CONTACTS->set_page(max(1, intval($_GET['_page'])));
+// Use search result
+if (!empty($_REQUEST['_search']) && isset($_SESSION['search'][$_REQUEST['_search']])) {
+ $search = (array)$_SESSION['search'][$_REQUEST['_search']];
- // list groups of this source (on page one)
- if ($CONTACTS->groups && $CONTACTS->list_page == 1) {
- foreach ($CONTACTS->list_groups() as $group) {
- $CONTACTS->reset();
- $CONTACTS->set_group($group['ID']);
- $group_prop = $CONTACTS->get_group($group['ID']);
+ // get records from all sources
+ foreach ($search as $s => $set) {
+ $CONTACTS = $RCMAIL->get_address_book($s);
- // group (distribution list) with email address(es)
- if ($group_prop['email']) {
- foreach ((array)$group_prop['email'] as $email) {
- $row_id = 'G'.$group['ID'];
- $jsresult[$row_id] = format_email_recipient($email, $group['name']);
+ // reset page
+ $CONTACTS->set_page(1);
+ $CONTACTS->set_pagesize(9999);
+ $CONTACTS->set_search_set($set);
+
+ // get records
+ $result = $CONTACTS->list_records($afields);
+
+ while ($row = $result->next()) {
+ $row['sourceid'] = $s;
+ $key = rcube_addressbook::compose_contact_key($row, $sort_col);
+ $records[$key] = $row;
+ }
+ unset($result);
+ }
+
+ // sort the records
+ ksort($records, SORT_LOCALE_STRING);
+
+ // create resultset object
+ $count = count($records);
+ $first = ($page-1) * $page_size;
+ $result = new rcube_result_set($count, $first);
+
+ // we need only records for current page
+ if ($page_size < $count) {
+ $records = array_slice($records, $first, $page_size);
+ }
+
+ $result->records = array_values($records);
+}
+// list contacts from selected source
+else {
+ $source = get_input_value('_source', RCUBE_INPUT_GPC);
+ $CONTACTS = $RCMAIL->get_address_book($source);
+
+ if ($CONTACTS && $CONTACTS->ready) {
+ // set list properties
+ $CONTACTS->set_pagesize($page_size);
+ $CONTACTS->set_page($page);
+
+ // list groups of this source (on page one)
+ if ($CONTACTS->groups && $CONTACTS->list_page == 1) {
+ foreach ($CONTACTS->list_groups() as $group) {
+ $CONTACTS->reset();
+ $CONTACTS->set_group($group['ID']);
+ $group_prop = $CONTACTS->get_group($group['ID']);
+
+ // group (distribution list) with email address(es)
+ if ($group_prop['email']) {
+ foreach ((array)$group_prop['email'] as $email) {
+ $row_id = 'G'.$group['ID'];
+ $jsresult[$row_id] = format_email_recipient($email, $group['name']);
+ $OUTPUT->command('add_contact_row', $row_id, array(
+ 'contactgroup' => html::span(array('title' => $email), Q($group['name']))), 'group');
+ }
+ }
+ // show group with count
+ else if (($result = $CONTACTS->count()) && $result->count) {
+ $row_id = 'E'.$group['ID'];
+ $jsresult[$row_id] = $group['name'];
$OUTPUT->command('add_contact_row', $row_id, array(
- 'contactgroup' => html::span(array('title' => $email), Q($group['name']))), 'group');
+ 'contactgroup' => Q($group['name'] . ' (' . intval($result->count) . ')')), 'group');
}
}
- // show group with count
- else if (($result = $CONTACTS->count()) && $result->count) {
- $row_id = 'E'.$group['ID'];
- $jsresult[$row_id] = $group['name'];
- $OUTPUT->command('add_contact_row', $row_id, array(
- 'contactgroup' => Q($group['name'] . ' (' . intval($result->count) . ')')), 'group');
- }
}
+
+ // get contacts for this user
+ $CONTACTS->set_group(0);
+ $result = $CONTACTS->list_records($afields);
}
+}
- // get contacts for this user
- $CONTACTS->set_group(0);
- $afields = $RCMAIL->config->get('contactlist_fields');
- $result = $CONTACTS->list_records($afields);
+if (!empty($result) && !$result->count && $result->searchonly) {
+ $OUTPUT->show_message('contactsearchonly', 'notice');
+}
+else if (!empty($result) && $result->count > 0) {
+ // create javascript list
+ while ($row = $result->next()) {
+ $name = rcube_addressbook::compose_list_name($row);
- if (!$result->count && $result->searchonly) {
- $OUTPUT->show_message('contactsearchonly', 'notice');
- }
- else if (!empty($result) && $result->count > 0) {
- // create javascript list
- while ($row = $result->next()) {
- $name = rcube_addressbook::compose_list_name($row);
-
- // add record for every email address of the contact
- $emails = $CONTACTS->get_col_values('email', $row, true);
- foreach ($emails as $i => $email) {
- $row_id = $row['ID'].$i;
- $jsresult[$row_id] = format_email_recipient($email, $name);
- $OUTPUT->command('add_contact_row', $row_id, array(
- 'contact' => html::span(array('title' => $email), Q($name ? $name : $email) .
- ($name && count($emails) > 1 ? ' ' . html::span('email', Q($email)) : '')
- )), 'person');
- }
+ // add record for every email address of the contact
+ $emails = $CONTACTS->get_col_values('email', $row, true);
+ foreach ($emails as $i => $email) {
+ $row_id = $row['ID'].$i;
+ $jsresult[$row_id] = format_email_recipient($email, $name);
+ $OUTPUT->command('add_contact_row', $row_id, array(
+ 'contact' => html::span(array('title' => $email), Q($name ? $name : $email) .
+ ($name && count($emails) > 1 ? ' ' . html::span('email', Q($email)) : '')
+ )), 'person');
}
}
}
+
// update env
$OUTPUT->set_env('contactdata', $jsresult);
-$OUTPUT->set_env('pagecount', ceil($result->count / $PAGE_SIZE));
+$OUTPUT->set_env('pagecount', ceil($result->count / $page_size));
$OUTPUT->command('set_page_buttons');
// send response
diff --git a/program/steps/mail/search_contacts.inc b/program/steps/mail/search_contacts.inc
new file mode 100644
index 0000000..2e6bb12
--- /dev/null
+++ b/program/steps/mail/search_contacts.inc
@@ -0,0 +1,112 @@
+<?php
+
+/*
+ +-----------------------------------------------------------------------+
+ | program/steps/mail/search_contacts.inc |
+ | |
+ | This file is part of the Roundcube Webmail client |
+ | Copyright (C) 2013, 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: |
+ | Search contacts from the adress book widget |
+ | |
+ +-----------------------------------------------------------------------+
+ | Author: Thomas Bruederli <roundcube@gmail.com> |
+ +-----------------------------------------------------------------------+
+*/
+
+$search = get_input_value('_q', RCUBE_INPUT_GPC, true);
+$sources = $RCMAIL->get_address_sources();
+$search_mode = (int) $RCMAIL->config->get('addressbook_search_mode');
+$sort_col = $RCMAIL->config->get('addressbook_sort_col', 'name');
+$afields = $RCMAIL->config->get('contactlist_fields');
+
+$page = 1;
+$page_size = $RCMAIL->config->get('addressbook_pagesize', $RCMAIL->config->get('pagesize', 50));
+
+$records = $search_set = array();
+foreach ($sources as $s) {
+ $source = $RCMAIL->get_address_book($s['id']);
+ $source->set_page(1);
+ $source->set_pagesize(9999);
+
+ // get contacts count
+ $result = $source->search($afields, $search, $search_mode, true, true, 'email');
+
+ if (!$result->count) {
+ continue;
+ }
+
+ // get records
+ $result = $source->list_records($afields);
+
+ while ($row = $result->next()) {
+ $row['sourceid'] = $s['id'];
+ $key = rcube_addressbook::compose_contact_key($row, $sort_col);
+ $records[$key] = $row;
+ }
+
+ $search_set[$s['id']] = $source->get_search_set();
+ unset($result);
+}
+
+// sort the records
+ksort($records, SORT_LOCALE_STRING);
+
+// create resultset object
+$count = count($records);
+$result = new rcube_result_set($count);
+
+// select the requested page
+if ($page_size < $count) {
+ $records = array_slice($records, $result->first, $page_size);
+}
+
+$result->records = array_values($records);
+
+if (!empty($result) && $result->count > 0) {
+ // create javascript list
+ while ($row = $result->next()) {
+ $name = rcube_addressbook::compose_list_name($row);
+
+ // add record for every email address of the contact
+ // (same as in list_contacts.inc)
+ $emails = $source->get_col_values('email', $row, true);
+ foreach ($emails as $i => $email) {
+ $row_id = $row['ID'].$i;
+ $jsresult[$row_id] = format_email_recipient($email, $name);
+ $OUTPUT->command('add_contact_row', $row_id, array(
+ 'contact' => html::span(array('title' => $email), Q($name ? $name : $email) .
+ ($name && count($emails) > 1 ? ' ' . html::span('email', Q($email)) : '')
+ )), 'person');
+ }
+ }
+
+ // search request ID
+ $search_request = md5('composeaddr' . $search);
+
+ // save search settings in session
+ $_SESSION['search'][$search_request] = $search_set;
+ $_SESSION['search_params'] = array('id' => $search_request, 'data' => array($afields, $search));
+
+ $OUTPUT->show_message('contactsearchsuccessful', 'confirmation', array('nr' => $result->count));
+
+ $OUTPUT->command('set_env', 'search_request', $search_request);
+ $OUTPUT->command('set_env', 'source', '');
+ $OUTPUT->command('unselect_directory');
+}
+else {
+ $OUTPUT->show_message('nocontactsfound', 'notice');
+}
+
+// update env
+$OUTPUT->set_env('contactdata', $jsresult);
+$OUTPUT->set_env('pagecount', ceil($result->count / $page_size));
+$OUTPUT->command('set_page_buttons');
+
+// send response
+$OUTPUT->send();
diff --git a/skins/larry/mail.css b/skins/larry/mail.css
index 33e66d1..6ad1f7a 100644
--- a/skins/larry/mail.css
+++ b/skins/larry/mail.css
@@ -1156,6 +1156,27 @@
bottom: 0;
}
+#composequicksearch {
+ position: relative;
+ padding: 4px;
+ background: #c7e3ef;
+}
+
+#composequicksearch .searchbox {
+ height: 26px;
+}
+
+#composequicksearch .searchbox input {
+ width: auto;
+ position: absolute;
+ left: 0px;
+ right: 0px;
+}
+
+#composequicksearch #searchmenulink {
+ width: 15px;
+}
+
#compose-contacts #directorylist {
border-bottom: 4px solid #c7e3ef;
}
diff --git a/skins/larry/templates/compose.html b/skins/larry/templates/compose.html
index de3b5bf..9cfe7fe 100644
--- a/skins/larry/templates/compose.html
+++ b/skins/larry/templates/compose.html
@@ -39,6 +39,13 @@
<!-- inline address book -->
<div id="compose-contacts" class="uibox listbox">
<h2 class="boxtitle"><roundcube:label name="contacts" /></h2>
+ <div id="composequicksearch">
+ <div class="searchbox">
+ <roundcube:object name="searchform" id="contactsearchbox" />
+ <a id="searchmenulink" class="iconbutton searchoptions"> </a>
+ <roundcube:button command="reset-search" id="searchreset" class="iconbutton reset" title="resetsearch" content=" " />
+ </div>
+ </div>
<roundcube:object name="addressbooks" id="directorylist" class="listing" />
<div class="scroller withfooter">
<roundcube:object name="addresslist" id="contacts-table" class="listing" noheader="true" />
--
Gitblit v1.9.1