- Plugin API: added 'contact_form' hook

- Re-designed contact frame using Tabs

1 files changed, 200 insertions, 143 deletions

diff --git a/program/steps/addressbook/func.inc b/program/steps/addressbook/func.inc
index 561b4fe3d..f875ea68a 100644
--- a/program/steps/addressbook/func.inc
+++ b/program/steps/addressbook/func.inc
@@ -27,7 +27,7 @@ $source = get_input_value('_source', RCUBE_INPUT_GPC);
 
 // if source is not set use first directory
 if (empty($source))
-  $source = $js_list[key($js_list)]['id'];
+    $source = $js_list[key($js_list)]['id'];
 
 // instantiate a contacts object according to the given source
 $CONTACTS = $RCMAIL->get_address_book($source);
@@ -36,203 +36,260 @@ $CONTACTS->set_pagesize($CONFIG['pagesize']);
 
 // set list properties and session vars
 if (!empty($_GET['_page']))
-  $CONTACTS->set_page(($_SESSION['page'] = intval($_GET['_page'])));
+    $CONTACTS->set_page(($_SESSION['page'] = intval($_GET['_page'])));
 else
-  $CONTACTS->set_page(isset($_SESSION['page']) ?$_SESSION['page'] : 1);
+    $CONTACTS->set_page(isset($_SESSION['page']) ?$_SESSION['page'] : 1);
   
 if (!empty($_REQUEST['_gid']))
-  $CONTACTS->set_group(get_input_value('_gid', RCUBE_INPUT_GPC));
+    $CONTACTS->set_group(get_input_value('_gid', RCUBE_INPUT_GPC));
 
 // set message set for search result
 if (!empty($_REQUEST['_search']) && isset($_SESSION['search'][$_REQUEST['_search']]))
-  $CONTACTS->set_search_set($_SESSION['search'][$_REQUEST['_search']]);
+    $CONTACTS->set_search_set($_SESSION['search'][$_REQUEST['_search']]);
 
 // set data source env
 $OUTPUT->set_env('source', $source ? $source : '0');
 $OUTPUT->set_env('readonly', $CONTACTS->readonly, false);
-if(! $OUTPUT->ajax_call) {
-  $OUTPUT->set_env('address_sources', $js_list);
-  $OUTPUT->set_pagetitle(rcube_label('addressbook'));
+if (!$OUTPUT->ajax_call) {
+    $OUTPUT->set_env('address_sources', $js_list);
+    $OUTPUT->set_pagetitle(rcube_label('addressbook'));
 }
 
+
 function rcmail_directory_list($attrib)
 {
-  global $RCMAIL, $OUTPUT;
-  
-  if (!$attrib['id'])
-    $attrib['id'] = 'rcmdirectorylist';
-
-  $out = '';
-  $local_id = '0';
-  $jsdata = array();
-  $current = get_input_value('_source', RCUBE_INPUT_GPC);
-  $line_templ = html::tag('li', array('id' => 'rcmli%s', 'class' => 'addressbook %s'),
-    html::a(array('href' => '%s', 'onclick' => "return ".JS_OBJECT_NAME.".command('list','%s',this)"), '%s'));
-
-  if (!$current && strtolower($RCMAIL->config->get('address_book_type', 'sql')) != 'ldap') {
-    $current = '0';
-  }
-  else if (!$current) {
-    // DB address book not used, see if a source is set, if not use the
-    // first LDAP directory.
-    $current = key((array)$RCMAIL->config->get('ldap_public', array()));
-  }
-
-  foreach ((array)$OUTPUT->env['address_sources'] as $j => $source) {
-    $id = $source['id'] ? $source['id'] : $j;
-    $js_id = JQ($id);
-    $dom_id = preg_replace('/[^a-z0-9\-_]/i', '', $id);
-    $out .= sprintf($line_templ, $dom_id, ($current == $id ? 'selected' : ''),
-      Q(rcmail_url(null, array('_source' => $id))), $js_id, (!empty($source['name']) ? Q($source['name']) : Q($id)));
-    $groupdata = rcmail_contact_groups(array('out' => $out, 'jsdata' => $jsdata, 'source' => $id));
-    $jsdata = $groupdata['jsdata'];
-    $out = $groupdata['out'];
-  }
-
-  $OUTPUT->set_env('contactgroups', $jsdata); 
-  $OUTPUT->add_gui_object('folderlist', $attrib['id']);
-  
-  return html::tag('ul', $attrib, $out, html::$common_attrib);
-}
+    global $RCMAIL, $OUTPUT;
 
+    if (!$attrib['id'])
+        $attrib['id'] = 'rcmdirectorylist';
 
-function rcmail_contact_groups($args)
-{
-  global $RCMAIL;
+    $out = '';
+    $local_id = '0';
+    $jsdata = array();
+    $current = get_input_value('_source', RCUBE_INPUT_GPC);
+    $line_templ = html::tag('li', array(
+        'id' => 'rcmli%s', 'class' => 'addressbook %s'),
+        html::a(array('href' => '%s',
+            'onclick' => "return ".JS_OBJECT_NAME.".command('list','%s',this)"), '%s'));
+
+    if (!$current && strtolower($RCMAIL->config->get('address_book_type', 'sql')) != 'ldap') {
+        $current = '0';
+    }
+    else if (!$current) {
+        // DB address book not used, see if a source is set, if not use the
+        // first LDAP directory.
+        $current = key((array)$RCMAIL->config->get('ldap_public', array()));
+    }
+
+    foreach ((array)$OUTPUT->env['address_sources'] as $j => $source) {
+        $id = $source['id'] ? $source['id'] : $j;
+        $js_id = JQ($id);
+        $dom_id = preg_replace('/[^a-z0-9\-_]/i', '', $id);
+        $out .= sprintf($line_templ, $dom_id, ($current == $id ? 'selected' : ''),
+            Q(rcmail_url(null, array('_source' => $id))),
+            $js_id, (!empty($source['name']) ? Q($source['name']) : Q($id)));
+        $groupdata = rcmail_contact_groups(array('out' => $out, 'jsdata' => $jsdata, 'source' => $id));
+        $jsdata = $groupdata['jsdata'];
+        $out = $groupdata['out'];
+    }
 
-  $groups = $RCMAIL->get_address_book($args['source'])->list_groups();
+    $OUTPUT->set_env('contactgroups', $jsdata); 
+    $OUTPUT->add_gui_object('folderlist', $attrib['id']);
 
-  if (!empty($groups)) {
-    $line_templ = html::tag('li', array('id' => 'rcmliG%s%s', 'class' => 'contactgroup'),
-      html::a(array('href' => '#', 'onclick' => "return ".JS_OBJECT_NAME.".command('listgroup',{'source':'%s','id':'%s'},this)"), '%s'));
+    return html::tag('ul', $attrib, $out, html::$common_attrib);
+}
 
-    $jsdata = array();
-    foreach ($groups as $group) {
-      $args['out'] .= sprintf($line_templ, $args['source'], $group['ID'], $args['source'], $group['ID'], Q($group['name']));
-      $args['jsdata']['G'.$args['source'].$group['ID']] = array(
-        'source' => $args['source'], 'id' => $group['ID'], 'name' => $group['name'], 'type' => 'group');
+
+function rcmail_contact_groups($args)
+{
+    global $RCMAIL;
+
+    $groups = $RCMAIL->get_address_book($args['source'])->list_groups();
+
+    if (!empty($groups)) {
+        $line_templ = html::tag('li', array(
+            'id' => 'rcmliG%s%s', 'class' => 'contactgroup'),
+            html::a(array('href' => '#',
+                'onclick' => "return ".JS_OBJECT_NAME.".command('listgroup',{'source':'%s','id':'%s'},this)"), '%s'));
+
+        $jsdata = array();
+        foreach ($groups as $group) {
+            $args['out'] .= sprintf($line_templ, $args['source'], $group['ID'], $args['source'], $group['ID'], Q($group['name']));
+            $args['jsdata']['G'.$args['source'].$group['ID']] = array(
+                'source' => $args['source'], 'id' => $group['ID'],
+                'name' => $group['name'], 'type' => 'group');
+        }
     }
-  }
 
-  return $args;
+    return $args;
 }
 
 
 // return the message list as HTML table
 function rcmail_contacts_list($attrib)
-  {
-  global $CONTACTS, $OUTPUT;
-  
-  // count contacts for this user
-  $result = $CONTACTS->list_records();
-  
-  // add id to message list table if not specified
-  if (!strlen($attrib['id']))
-    $attrib['id'] = 'rcmAddressList';
-  
-  // define list of cols to be displayed
-  $a_show_cols = array('name');
+{
+    global $CONTACTS, $OUTPUT;
 
-  // create XHTML table
-  $out = rcube_table_output($attrib, $result->records, $a_show_cols, $CONTACTS->primary_key);
-  
-  // set client env
-  $OUTPUT->add_gui_object('contactslist', $attrib['id']);
-  $OUTPUT->set_env('current_page', (int)$CONTACTS->list_page);
-  $OUTPUT->set_env('pagecount', ceil($result->count/$CONTACTS->page_size));
-  $OUTPUT->include_script('list.js');
-  
-  // add some labels to client
-  $OUTPUT->add_label('deletecontactconfirm');
-  
-  return $out;
-  }
+    // count contacts for this user
+    $result = $CONTACTS->list_records();
+
+    // add id to message list table if not specified
+    if (!strlen($attrib['id']))
+        $attrib['id'] = 'rcmAddressList';
+
+    // define list of cols to be displayed
+    $a_show_cols = array('name');
+
+    // create XHTML table
+    $out = rcube_table_output($attrib, $result->records, $a_show_cols, $CONTACTS->primary_key);
+
+    // set client env
+    $OUTPUT->add_gui_object('contactslist', $attrib['id']);
+    $OUTPUT->set_env('current_page', (int)$CONTACTS->list_page);
+    $OUTPUT->set_env('pagecount', ceil($result->count/$CONTACTS->page_size));
+    $OUTPUT->include_script('list.js');
+
+    // add some labels to client
+    $OUTPUT->add_label('deletecontactconfirm');
+
+    return $out;
+}
 
 
 function rcmail_js_contacts_list($result, $prefix='')
-  {
-  global $OUTPUT;
+{
+    global $OUTPUT;
 
-  if (empty($result) || $result->count == 0)
-    return;
+    if (empty($result) || $result->count == 0)
+        return;
 
-  // define list of cols to be displayed
-  $a_show_cols = array('name');
+    // define list of cols to be displayed
+    $a_show_cols = array('name');
   
-  while ($row = $result->next())
-    {
-    $a_row_cols = array();
-    
-    // format each col
-    foreach ($a_show_cols as $col)
-      $a_row_cols[$col] = Q($row[$col]);
+    while ($row = $result->next()) {
+        $a_row_cols = array();
     
-    $OUTPUT->command($prefix.'add_contact_row', $row['ID'], $a_row_cols);
+        // format each col
+        foreach ($a_show_cols as $col)
+            $a_row_cols[$col] = Q($row[$col]);
+
+        $OUTPUT->command($prefix.'add_contact_row', $row['ID'], $a_row_cols);
     }
-  }
+}
 
 
 // similar function as /steps/settings/identities.inc::rcmail_identity_frame()
 function rcmail_contact_frame($attrib)
-  {
-  global $OUTPUT;
+{
+    global $OUTPUT;
 
-  if (!$attrib['id'])
-    $attrib['id'] = 'rcmcontactframe';
+    if (!$attrib['id'])
+        $attrib['id'] = 'rcmcontactframe';
     
-  $attrib['name'] = $attrib['id'];
+    $attrib['name'] = $attrib['id'];
 
-  $OUTPUT->set_env('contentframe', $attrib['name']);
-  $OUTPUT->set_env('blankpage', $attrib['src'] ? $OUTPUT->abs_url($attrib['src']) : 'program/blank.gif');
+    $OUTPUT->set_env('contentframe', $attrib['name']);
+    $OUTPUT->set_env('blankpage', $attrib['src'] ? $OUTPUT->abs_url($attrib['src']) : 'program/blank.gif');
 
-  return html::iframe($attrib);
-  }
+    return html::iframe($attrib);
+}
 
 
 function rcmail_rowcount_display($attrib)
-  {
-  global $OUTPUT;
-  
-  if (!$attrib['id'])
-    $attrib['id'] = 'rcmcountdisplay';
+{
+    global $OUTPUT;
 
-  $OUTPUT->add_gui_object('countdisplay', $attrib['id']);
+    if (!$attrib['id'])
+        $attrib['id'] = 'rcmcountdisplay';
 
-  return html::span($attrib, rcmail_get_rowcount_text());
-  }
+    $OUTPUT->add_gui_object('countdisplay', $attrib['id']);
 
+    return html::span($attrib, rcmail_get_rowcount_text());
+}
 
 
 function rcmail_get_rowcount_text()
-  {
-  global $CONTACTS;
-  
-  // read nr of contacts
-  $result = $CONTACTS->get_result();
-  if (!$result)
-    $result = $CONTACTS->count();
+{
+    global $CONTACTS;
   
-  if ($result->count == 0)
-    $out = rcube_label('nocontactsfound');
-  else
-    $out = rcube_label(array(
-      'name' => 'contactsfromto',
-      'vars' => array(
-        'from'  => $result->first + 1,
-        'to'    => min($result->count, $result->first + $CONTACTS->page_size),
-        'count' => $result->count)
-      ));
-
-  return $out;
-  }
+    // read nr of contacts
+    $result = $CONTACTS->get_result();
+    if (!$result) {
+        $result = $CONTACTS->count();
+    }
+
+    if ($result->count == 0)
+        $out = rcube_label('nocontactsfound');
+    else
+        $out = rcube_label(array(
+            'name'  => 'contactsfromto',
+            'vars'  => array(
+            'from'  => $result->first + 1,
+            'to'    => min($result->count, $result->first + $CONTACTS->page_size),
+            'count' => $result->count)
+        ));
+
+    return $out;
+}
+
+
+function rcmail_contact_form($form, $record)
+{
+    global $RCMAIL;
+
+    // Allow plugins to modify contact form content
+    $plugin = $RCMAIL->plugins->exec_hook('contact_form', array(
+        'form' => $form, 'record' => $record));
+
+    $form = $plugin['form'];
+    $record = $plugin['record'];
+    $out = '';
+
+    foreach ($form as $fieldset) {
+        if (empty($fieldset['content']))
+            continue;
+
+        $content = '';
+        if (is_array($fieldset['content'])) {
+            $table = new html_table(array('cols' => 2));
+
+            foreach ($fieldset['content'] as $col => $colprop) {
+                $colprop['id'] = 'rcmfd_'.$col;
+
+                $label = !empty($colprop['label']) ? $colprop['label'] : rcube_label($col);
+
+                if (!empty($colprop['value'])) {
+                    $value = $colprop['value'];
+                }
+                else if ($RCMAIL->action == 'show') {
+                    $value = $record[$col];
+                }
+                else {
+                    $value = rcmail_get_edit_field($col, $record[$col], $colprop, $colprop['type']);
+                }
+
+                $table->add('title', sprintf('<label for="%s">%s</label>', $colprop['id'], Q($label)));
+                $table->add(null, $value);
+            }
+            $content = $table->show();
+        }
+        else {
+            $content = $fieldset['content'];
+        }
+
+        $out .= html::tag('fieldset', null, html::tag('legend', null, Q($fieldset['name'])) . $content) ."\n";
+    }
   
+    return $out;
+}
+
+
 // register UI objects
 $OUTPUT->add_handlers(array(
-  'directorylist' => 'rcmail_directory_list',
+    'directorylist' => 'rcmail_directory_list',
 //  'groupslist' => 'rcmail_contact_groups',
-  'addresslist' => 'rcmail_contacts_list',
-  'addressframe' => 'rcmail_contact_frame',
-  'recordscountdisplay' => 'rcmail_rowcount_display',
-  'searchform' => array($OUTPUT, 'search_form')
+    'addresslist' => 'rcmail_contacts_list',
+    'addressframe' => 'rcmail_contact_frame',
+    'recordscountdisplay' => 'rcmail_rowcount_display',
+    'searchform' => array($OUTPUT, 'search_form')
 ));
-