Move the hard-coded list of fields used to list contacts to a central location

program/include/rcube_config.php

@@ -49,6 +49,11 @@ class rcube_config
     public function __construct()
     {
         $this->load();
+
+        // Defaults, that we do not require you to configure,
+        // but contain information that is used in various
+        // locations in the code:
+        $this->set('contactlist_fields', array('name', 'firstname', 'surname', 'email'));
     }
 
 

program/include/rcube_ldap.php

@@ -767,7 +767,9 @@ class rcube_ldap extends rcube_addressbook
         }
 
         // use VLV pseudo-search for autocompletion
-        if ($this->prop['vlv_search'] && $this->conn && join(',', (array)$fields) == 'name,firstname,surname,email')
+        $rcmail = rcmail::get_instance();
+
+        if ($this->prop['vlv_search'] && $this->conn && join(',', (array)$fields) == join(',', $rcmail->config->get('contactlist_fields')))
         {
             // add general filter to query
             if (!empty($this->prop['filter']) && empty($this->filter))

program/steps/addressbook/delete.inc

@@ -70,6 +70,7 @@ $page = isset($_SESSION['page']) ? $_SESSION['page'] : 1;
 // update saved search after data changed
 if (($search_request = $_REQUEST['_search']) && isset($_SESSION['search'][$search_request])) {
     $sort_col = $RCMAIL->config->get('addressbook_sort_col', 'name');
+    $afields = $RCMAIL->config->get('contactlist_fields');
     $search  = (array)$_SESSION['search'][$search_request];
     $records = array();
 
@@ -83,7 +84,7 @@ if (($search_request = $_REQUEST['_search']) && isset($_SESSION['search'][$searc
         $source->set_search_set($set);
 
         // get records
-        $result = $source->list_records(array('name', 'firstname', 'surname', 'email'));
+        $result = $source->list_records($afields);
 
         if (!$result->count) {
             unset($search[$s]);

program/steps/addressbook/list.inc

@@ -19,6 +19,8 @@
  +-----------------------------------------------------------------------+
 */
 
+$afields = $RCMAIL->config->get('contactlist_fields');
+
 // Use search result
 if (!empty($_REQUEST['_search']) && isset($_SESSION['search'][$_REQUEST['_search']]))
 {
@@ -43,7 +45,7 @@ if (!empty($_REQUEST['_search']) && isset($_SESSION['search'][$_REQUEST['_search
         $source->set_search_set($set);
 
         // get records
-        $result = $source->list_records(array('name', 'firstname', 'surname', 'email'));
+        $result = $source->list_records($afields);
 
         while ($row = $result->next()) {
             $row['sourceid'] = $s;
@@ -73,7 +75,7 @@ else {
     $CONTACTS = rcmail_contact_source(null, true);
 
     // get contacts for this user
-    $result = $CONTACTS->list_records(array('name', 'firstname', 'surname', 'email'));
+    $result = $CONTACTS->list_records($afields);
 
     if (!$result->count && $result->searchonly) {
         $OUTPUT->show_message('contactsearchonly', 'notice');

program/steps/addressbook/search.inc

@@ -145,6 +145,7 @@ function rcmail_contact_search()
     $search_set = array();
     $records    = array();
     $sort_col   = $RCMAIL->config->get('addressbook_sort_col', 'name');
+    $afields = $RCMAIL->config->get('contactlist_fields');
 
     foreach ($sources as $s) {
         $source = $RCMAIL->get_address_book($s['id']);
@@ -179,7 +180,7 @@ function rcmail_contact_search()
         }
 
         // get records
-        $result = $source->list_records(array('name', 'firstname', 'surname', 'email'));
+        $result = $source->list_records($afields);
 
         while ($row = $result->next()) {
             $row['sourceid'] = $s['id'];

program/steps/mail/autocomplete.inc

@@ -26,7 +26,7 @@ if ($RCMAIL->action == 'group-expand') {
     $members = array();
     $abook->set_group($gid);
     $abook->set_pagesize(1000);  // TODO: limit number of group members by config
-    $result = $abook->list_records(array('name', 'firstname', 'surname', 'email'));
+    $result = $abook->list_records($RCMAIL->config->get('contactlist_fields'));
     while ($result && ($sql_arr = $result->iterate())) {
       foreach ((array)$sql_arr['email'] as $email) {
         $members[] = format_email_recipient($email, rcube_addressbook::compose_list_name($sql_arr));
@@ -64,7 +64,7 @@ if (!empty($book_types) && strlen($search)) {
     $abook = $RCMAIL->get_address_book($id);
     $abook->set_pagesize($MAXNUM);
 
-    if ($result = $abook->search(array('name', 'firstname', 'surname', 'email'), $search, $mode, true, true, 'email')) {
+    if ($result = $abook->search($RCMAIL->config->get('contactlist_fields'), $search, $mode, true, true, 'email')) {
       while ($sql_arr = $result->iterate()) {
         // Contact can have more than one e-mail address
         $email_arr = (array)$abook->get_col_values('email', $sql_arr, true);

program/steps/mail/list_contacts.inc

@@ -57,7 +57,8 @@ if ($CONTACTS && $CONTACTS->ready) {
 
     // get contacts for this user
     $CONTACTS->set_group(0);
-    $result = $CONTACTS->list_records(array('name', 'firstname', 'surname', 'email'));
+    $afields = $RCMAIL->config->get('contactlist_fields');
+    $result = $CONTACTS->list_records($afields);
 
     if (!$result->count && $result->searchonly) {
         $OUTPUT->show_message('contactsearchonly', 'notice');