Changeset 2386 in subversion

Timestamp:

Apr 13, 2009 12:11:06 PM (4 years ago)

Author:

thomasb

Message:

Add hooks for additional address books + simple example plugin

Location:

branches/devel-api

Files:

• plugins/example_addressbook (added)
• plugins/example_addressbook/example_addressbook.php (added)
• plugins/example_addressbook/example_addressbook_backend.php (added)
• program/include/main.inc (modified) (1 diff)
• program/include/rcmail.php (modified) (1 diff)
• program/steps/addressbook/func.inc (modified) (2 diffs)
• skins/default/templates/addressbook.html (modified) (2 diffs)

branches/devel-api/program/include/main.inc

@@ -684 +684 @@
 
   // convert attributes to an associative array (name => value)
-  if ($regs)
-    foreach ($regs as $attr)
-      {
-      $attrib[strtolower($attr[1])] = $attr[3] . $attr[4];
-      }
+  if ($regs) {
+    foreach ($regs as $attr) {
+      $attrib[strtolower($attr[1])] = html_entity_decode($attr[3] . $attr[4]);
+    }
+  }
 
   return $attrib;

branches/devel-api/program/include/rcmail.php

@@ -260 +260 @@
     $ldap_config = (array)$this->config->get('ldap_public');
     $abook_type = strtolower($this->config->get('address_book_type'));
-    
-    if ($id && $ldap_config[$id]) {
+
+    $plugin = $this->plugins->exec_hook('get_address_book', array('id' => $id, 'writeable' => $writeable));
+    
+    // plugin returned instance of a rcube_addressbook
+    if ($plugin['instance'] instanceof rcube_addressbook) {
+      $contacts = $plugin['instance'];
+    }
+    else if ($id && $ldap_config[$id]) {
       $contacts = new rcube_ldap($ldap_config[$id]);
+    }
+    else if ($id === '0') {
+      $contacts = new rcube_contacts($this->db, $this->user->ID);
     }
     else if ($abook_type == 'ldap') {

branches/devel-api/program/steps/addressbook/func.inc

@@ -43 +43 @@
 if (strtolower($CONFIG['address_book_type']) != 'ldap') {
   // We are using the DB address book, add it.
-  $js_list = array("0" => array('id' => 0, 'readonly' => false));
+  $js_list['0'] = array('id' => 0, 'name' => rcube_label('personaladrbook'), 'readonly' => false);
 }
 if (is_array($CONFIG['ldap_public'])) {
   foreach ($CONFIG['ldap_public'] as $id => $prop)
-    $js_list[$id] = array('id' => $id, 'readonly' => !$prop['writable']);
+    $js_list[$id] = array('id' => $id, 'name' => $prop['name'], 'readonly' => !$prop['writable']);
 }
-$OUTPUT->set_env('address_sources', $js_list);
+
+$plugin = $RCMAIL->plugins->exec_hook('address_sources', array('sources' => $js_list));
+$OUTPUT->set_env('address_sources', $plugin['sources']);
 
 
 function rcmail_directory_list($attrib)
 {
-  global $CONFIG, $OUTPUT;
+  global $RCMAIL, $OUTPUT;
   
   if (!$attrib['id'])
@@ -64 +66 @@
   $line_templ = html::tag('li', array('id' => 'rcmli%s', 'class' => '%s'),
     html::a(array('href' => '%s', 'onclick' => "return ".JS_OBJECT_NAME.".command('list','%s',this)"), '%s'));
-    
-  if (strtolower($CONFIG['address_book_type']) != 'ldap') {
-    $out .= sprintf($line_templ, $local_id, (!$current ? 'selected' : ''),
-      Q(rcmail_url(null, array('_source' => $local_id))), $local_id, rcube_label('personaladrbook'));
-  } // end if
-  else {
+
+  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.
-    if (!$current) {
-      $current = key((array)$CONFIG['ldap_public']);
-    } // end if
-  } // end else
-  
-  foreach ((array)$CONFIG['ldap_public'] as $id => $prop) {
+    $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($prop['name']) ? Q($prop['name']) : Q($id)));
-  }
-  
+      Q(rcmail_url(null, array('_source' => $id))), $js_id, (!empty($source['name']) ? Q($source['name']) : Q($id)));
+  }
+
   $OUTPUT->add_gui_object('folderlist', $attrib['id']);
   

branches/devel-api/skins/default/templates/addressbook.html

@@ -8 +8 @@
 
 <style type="text/css">
-<roundcube:if condition="config:ldap_public == false" />
+<roundcube:if condition="count(env:address_sources) &lt;= 1" />
 #abookcountbar { left: 20px;}
 #mainscreen { left:20px; /* IE hack */ width:expression((parseInt(document.documentElement.clientWidth)-40)+'px') }
@@ -45 +45 @@
 </div>
 
-<roundcube:if condition="config:ldap_public" />
+<roundcube:if condition="count(env:address_sources) &gt; 1" />
 <div id="directorylist">
 <div id="groups-title"><roundcube:label name="groups" /></div>