From 494504d537c1ec61291aa2f9155cca3476f473df Mon Sep 17 00:00:00 2001 From: thomasb Date: Mon, 22 Nov 2010 10:18:46 +0000 Subject: Move core Kolab functions to a separate plugin to be used by others too git-svn-id: https://svn.roundcube.net/trunk@4247 208e9e7b-5314-0410-a742-e7e81cd9613c --- plugins/kolab_addressbook/config.inc.php.dist | 8 -- plugins/kolab_addressbook/kolab_addressbook.php | 14 +-- plugins/kolab_core/config.inc.php.dist | 8 ++ plugins/kolab_core/kolab_core.php | 30 +++++++ plugins/kolab_core/rcube_kolab.php | 109 ++++++++++++++++++++++++ 5 files changed, 151 insertions(+), 18 deletions(-) delete mode 100644 plugins/kolab_addressbook/config.inc.php.dist create mode 100644 plugins/kolab_core/config.inc.php.dist create mode 100644 plugins/kolab_core/kolab_core.php create mode 100644 plugins/kolab_core/rcube_kolab.php (limited to 'plugins') diff --git a/plugins/kolab_addressbook/config.inc.php.dist b/plugins/kolab_addressbook/config.inc.php.dist deleted file mode 100644 index b6ac25a4d..000000000 --- a/plugins/kolab_addressbook/config.inc.php.dist +++ /dev/null @@ -1,8 +0,0 @@ -'; - -?> diff --git a/plugins/kolab_addressbook/kolab_addressbook.php b/plugins/kolab_addressbook/kolab_addressbook.php index 4c5a84e5f..807dfb8ec 100644 --- a/plugins/kolab_addressbook/kolab_addressbook.php +++ b/plugins/kolab_addressbook/kolab_addressbook.php @@ -6,10 +6,7 @@ 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. - * The library part is to be moved into a separate PEAR package or plugin - * that this and other Kolab-related plugins will depend on. * * @author Thomas Bruederli * @@ -24,17 +21,14 @@ class kolab_addressbook extends rcube_plugin */ public function init() { - // load local config - $this->load_config(); + // load required plugin + $this->require_plugin('kolab_core'); + // 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 include path to load bundled Horde classes - $include_path = $this->home . '/lib' . PATH_SEPARATOR . ini_get('include_path'); - set_include_path($include_path); - + // extend list of address sources to be used for autocompletion $rcmail = rcmail::get_instance(); if ($rcmail->action == 'autocomplete' || $rcmail->action == 'group-expand') { diff --git a/plugins/kolab_core/config.inc.php.dist b/plugins/kolab_core/config.inc.php.dist new file mode 100644 index 000000000..b6ac25a4d --- /dev/null +++ b/plugins/kolab_core/config.inc.php.dist @@ -0,0 +1,8 @@ +'; + +?> diff --git a/plugins/kolab_core/kolab_core.php b/plugins/kolab_core/kolab_core.php new file mode 100644 index 000000000..e98b02dcd --- /dev/null +++ b/plugins/kolab_core/kolab_core.php @@ -0,0 +1,30 @@ + + * + */ +class kolab_core extends rcube_plugin +{ + /** + * Required startup method of a Roundcube plugin + */ + public function init() + { + // load local config + $this->load_config(); + + // extend include path to load bundled Horde classes + $include_path = $this->home . PATH_SEPARATOR . ini_get('include_path'); + set_include_path($include_path); + } + +} + diff --git a/plugins/kolab_core/rcube_kolab.php b/plugins/kolab_core/rcube_kolab.php new file mode 100644 index 000000000..94511e55d --- /dev/null +++ b/plugins/kolab_core/rcube_kolab.php @@ -0,0 +1,109 @@ +config->get('kolab'); + + $conf['kolab']['ldap']['server'] = 'ldap://' . $_SESSION['imap_host'] . ':389'; + $conf['kolab']['imap']['server'] = $_SESSION['imap_host']; + $conf['kolab']['imap']['port'] = $_SESSION['imap_port']; + + // pass the current IMAP authentication credentials to the Horde auth system + self::$horde_auth = Auth::singleton('kolab'); + if (self::$horde_auth->authenticate($_SESSION['username'], array('password' => ($pwd = $rcmail->decrypt($_SESSION['password']))), false)) { + $_SESSION['__auth'] = array( + 'authenticated' => true, + 'userId' => $_SESSION['username'], + 'timestamp' => time(), + 'remote_addr' => $_SERVER['REMOTE_ADDR'], + ); + Auth::setCredential('password', $pwd); + } + } + + + /** + * Get instance of a Kolab (XML) format object + * + * @param string Data type (contact,event,task,note) + * @return object Horde_Kolab_Format_XML The format object + */ + public static function get_format($type) + { + self::setup(); + return Horde_Kolab_Format::factory('XML', $type); + } + + /** + * Get a list of storage folders for the given data type + * + * @param string Data type to list folders for (contact,event,task,note) + * @return array List of Kolab_Folder objects + */ + public static function get_folders($type) + { + self::setup(); + $kolab = Kolab_List::singleton(); + return $kolab->getByType($type); + } + + /** + * Get storage object for read/write access to the Kolab backend + * + * @param string IMAP folder to access + * @param string Object type to deal with (leave empty for auto-detection using annotations) + * @return object Kolab_Data The data storage object + */ + public static function get_storage($folder, $data_type = null) + { + self::setup(); + $kolab = Kolab_List::singleton(); + return $kolab->getFolder($folder)->getData($data_type); + } + + /** + * Cleanup session data when done + */ + public static function shutdown() + { + if (isset($_SESSION['__auth'])) { + // unset auth data from session. no need to store it persistantly + unset($_SESSION['__auth']); + + // FIXME: remove strange numeric entries + foreach ($_SESSION as $key => $val) { + if (!$val && is_numeric($key)) + unset($_SESSION[$key]); + } + } + } +} -- cgit v1.2.3