Copy plugins to release branch

1 files changed, 140 insertions, 0 deletions

diff --git a/plugins/kolab_addressbook/kolab_addressbook.php b/plugins/kolab_addressbook/kolab_addressbook.php
new file mode 100644
index 000000000..edf8e1f45
--- /dev/null
+++ b/plugins/kolab_addressbook/kolab_addressbook.php
@@ -0,0 +1,140 @@
+<?php
+
+require_once(dirname(__FILE__) . '/rcube_kolab_contacts.php');
+
+/**
+ * Kolab address book
+ * 
+ * Sample plugin to add a new address book source with data from Kolab storage
+ * This is work-in-progress for the Roundcube+Kolab integration.
+ *
+ * @author Thomas Bruederli <roundcube@gmail.com>
+ * 
+ */
+class kolab_addressbook extends rcube_plugin
+{
+    private $folders;
+    private $sources;
+
+    /**
+     * Required startup method of a Roundcube plugin
+     */
+    public function init()
+    {
+        // load required plugin
+        $this->require_plugin('kolab_core');
+        
+        $this->add_texts('localization');
+        
+        // register hooks
+        $this->add_hook('addressbooks_list', array($this, 'address_sources'));
+        $this->add_hook('addressbook_get', array($this, 'get_address_book'));
+        $this->add_hook('contact_form', array($this, 'contact_form'));
+        
+        // extend list of address sources to be used for autocompletion
+        $rcmail = rcmail::get_instance();
+        if ($rcmail->action == 'autocomplete' || $rcmail->action == 'group-expand') {
+            $sources = (array) $rcmail->config->get('autocomplete_addressbooks', array());
+            foreach ($this->_list_sources() as $abook_id => $abook) {
+                if (!in_array($abook_id, $sources))
+                    $sources[] = $abook_id;
+            }
+            $rcmail->config->set('autocomplete_addressbooks', $sources);
+        }
+    }
+
+    /**
+     * Handler for the addressbooks_list hook.
+     *
+     * This will add all instances of available Kolab-based address books
+     * to the list of address sources of Roundcube.
+     *
+     * @param array Hash array with hook parameters
+     * @return array Hash array with modified hook parameters
+     */
+    public function address_sources($p)
+    {
+        foreach ($this->_list_sources() as $abook_id => $abook) {
+            // register this address source
+            $p['sources'][$abook_id] = array(
+                'id' => $abook_id,
+                'name' => $abook->get_name(),
+                'readonly' => $abook->readonly,
+                'groups' => $abook->groups,
+            );
+        }
+
+        return $p;
+    }
+
+
+    /**
+     * Getter for the rcube_addressbook instance
+     */
+    public function get_address_book($p)
+    {
+        if ($this->sources[$p['id']]) {
+            $p['instance'] = $this->sources[$p['id']];
+        }
+        
+        return $p;
+    }
+    
+    
+    private function _list_sources()
+    {
+        // already read sources
+        if (isset($this->sources))
+            return $this->sources;
+
+        // get all folders that have "contact" type
+        $this->folders = rcube_kolab::get_folders('contact');
+        $this->sources = array();
+
+        if (PEAR::isError($this->folders)) {
+            raise_error(array(
+              'code' => 600, 'type' => 'php',
+              'file' => __FILE__, 'line' => __LINE__,
+              'message' => "Failed to list contact folders from Kolab server:" . $this->folders->getMessage()),
+            true, false);
+        }
+        else {
+            foreach ($this->folders as $c_folder) {
+                // create instance of rcube_contacts
+                $abook_id = strtolower(asciiwords(strtr($c_folder->name, '/.', '--')));
+                $abook = new rcube_kolab_contacts($c_folder->name);
+                $this->sources[$abook_id] = $abook;
+            }
+        }
+        
+        return $this->sources;
+    }
+    
+    
+    /**
+     * Plugin hook called before rendering the contact form or detail view
+     */
+    public function contact_form($p)
+    {
+        // extend the list of contact fields to be displayed in the 'info' section
+        if (is_array($p['form']['info'])) {
+            $p['form']['info']['content']['initials'] = array('size' => 6);
+            $p['form']['info']['content']['anniversary'] = array('size' => 12, 'render_func' => 'rcmail_format_date_col');
+            
+            // TODO: add more Kolab-specific fields
+            
+            // re-order fields according to the coltypes list
+            $block = array();
+            $contacts = reset($this->sources);
+            foreach ($contacts->coltypes as $col => $prop) {
+                if (isset($p['form']['info']['content'][$col]))
+                    $block[$col] = $p['form']['info']['content'][$col];
+            }
+            
+            $p['form']['info']['content'] = $block;
+        }
+        
+        return $p;
+    }
+
+}