No OneTemporary
Actions

Authored By

Unknown

Size

53 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/plugins/kolab_addressbook/kolab_addressbook.php b/plugins/kolab_addressbook/kolab_addressbook.php
	index 2059deab..d6f0d6d6 100644
	--- a/plugins/kolab_addressbook/kolab_addressbook.php
	+++ b/plugins/kolab_addressbook/kolab_addressbook.php
	@@ -1,509 +1,536 @@
	<?php

	/**
	* Kolab address book
	*
	* Sample plugin to add a new address book source with data from Kolab storage
	* It provides also a possibilities to manage contact folders
	* (create/rename/delete/acl) directly in Addressbook UI.
	*
	* @version @package_version@
	* @author Thomas Bruederli <bruederli@kolabsys.com>
	* @author Aleksander Machniak <machniak@kolabsys.com>
	*
	* Copyright (C) 2011, Kolab Systems AG <contact@kolabsys.com>
	*
	* This program is free software: you can redistribute it and/or modify
	* it under the terms of the GNU Affero General Public License as
	* published by the Free Software Foundation, either version 3 of the
	* License, or (at your option) any later version.
	*
	* This program is distributed in the hope that it will be useful,
	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	* GNU Affero General Public License for more details.
	*
	* You should have received a copy of the GNU Affero General Public License
	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	*/

	class kolab_addressbook extends rcube_plugin
	{
	public $task = 'mail\|settings\|addressbook\|calendar';

	- private $folders;
	private $sources;
	private $rc;
	private $ui;

	const GLOBAL_FIRST = 0;
	const PERSONAL_FIRST = 1;
	const GLOBAL_ONLY = 2;
	const PERSONAL_ONLY = 3;

	/**
	* Startup method of a Roundcube plugin
	*/
	public function init()
	{
	require_once(dirname(__FILE__) . '/lib/rcube_kolab_contacts.php');

	$this->rc = rcube::get_instance();

	// load required plugin
	$this->require_plugin('libkolab');

	// register hooks
	$this->add_hook('addressbooks_list', array($this, 'address_sources'));
	$this->add_hook('addressbook_get', array($this, 'get_address_book'));
	$this->add_hook('config_get', array($this, 'config_get'));

	if ($this->rc->task == 'addressbook') {
	$this->add_texts('localization');
	$this->add_hook('contact_form', array($this, 'contact_form'));

	// Plugin actions
	$this->register_action('plugin.book', array($this, 'book_actions'));
	$this->register_action('plugin.book-save', array($this, 'book_save'));

	// Load UI elements
	if ($this->api->output->type == 'html') {
	require_once($this->home . '/lib/kolab_addressbook_ui.php');
	$this->ui = new kolab_addressbook_ui($this);
	}
	}
	else if ($this->rc->task == 'settings') {
	$this->add_texts('localization');
	$this->add_hook('preferences_list', array($this, 'prefs_list'));
	$this->add_hook('preferences_save', array($this, 'prefs_save'));
	}
	}


	/**
	* 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.
	* This will also hide some addressbooks according to kolab_addressbook_prio setting.
	*
	* @param array $p Hash array with hook parameters
	*
	* @return array Hash array with modified hook parameters
	*/
	public function address_sources($p)
	{
	- // Load configuration
	- $this->load_config();
	-
	- $abook_prio = (int) $this->rc->config->get('kolab_addressbook_prio');
	- $undelete = $this->rc->config->get('undo_timeout');
	+ $abook_prio = $this->addressbook_prio();
	+ $undelete = $this->rc->config->get('undo_timeout');

	// Disable all global address books
	// Assumes that all non-kolab_addressbook sources are global
	if ($abook_prio == self::PERSONAL_ONLY) {
	$p['sources'] = array();
	}

	$sources = array();
	$names = array();

	foreach ($this->_list_sources() as $abook_id => $abook) {
	$name = kolab_storage::folder_displayname($abook->get_name(), $names);

	// register this address source
	$sources[$abook_id] = array(
	'id' => $abook_id,
	'name' => $name,
	'readonly' => $abook->readonly,
	'editable' => $abook->editable,
	'groups' => $abook->groups,
	'undelete' => $abook->undelete && $undelete,
	'realname' => rcube_charset::convert($abook->get_realname(), 'UTF7-IMAP'), // IMAP folder name
	'class_name' => $abook->get_namespace(),
	'kolab' => true,
	);
	}

	// Add personal address sources to the list
	if ($abook_prio == self::PERSONAL_FIRST) {
	// $p['sources'] = array_merge($sources, $p['sources']);
	// Don't use array_merge(), because if you have folders name
	// that resolve to numeric identifier it will break output array keys
	foreach ($p['sources'] as $idx => $value)
	$sources[$idx] = $value;
	$p['sources'] = $sources;
	}
	else {
	// $p['sources'] = array_merge($p['sources'], $sources);
	foreach ($sources as $idx => $value)
	$p['sources'][$idx] = $value;
	}

	return $p;
	}


	/**
	* Sets autocomplete_addressbooks option according to
	* kolab_addressbook_prio setting extending list of address sources
	* to be used for autocompletion.
	*/
	public function config_get($args)
	{
	if ($args['name'] != 'autocomplete_addressbooks') {
	return $args;
	}

	- // Load configuration
	- $this->load_config();
	-
	- $abook_prio = (int) $this->rc->config->get('kolab_addressbook_prio');
	+ $abook_prio = $this->addressbook_prio();
	// here we cannot use rc->config->get()
	$sources = $GLOBALS['CONFIG']['autocomplete_addressbooks'];

	// Disable all global address books
	// Assumes that all non-kolab_addressbook sources are global
	if ($abook_prio == self::PERSONAL_ONLY) {
	$sources = array();
	}

	if (!is_array($sources)) {
	$sources = array();
	}

	$kolab_sources = array();
	foreach (array_keys($this->_list_sources()) as $abook_id) {
	if (!in_array($abook_id, $sources))
	$kolab_sources[] = $abook_id;
	}

	// Add personal address sources to the list
	if (!empty($kolab_sources)) {
	if ($abook_prio == self::PERSONAL_FIRST) {
	$sources = array_merge($kolab_sources, $sources);
	}
	else {
	$sources = array_merge($sources, $kolab_sources);
	}
	}

	$args['result'] = $sources;

	return $args;
	}


	/**
	* Getter for the rcube_addressbook instance
	*
	* @param array $p Hash array with hook parameters
	*
	* @return array Hash array with modified hook parameters
	*/
	public function get_address_book($p)
	{
	if ($p['id']) {
	$this->_list_sources();
	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;

	$this->sources = array();

	- // Load configuration
	- $this->load_config();
	-
	- $abook_prio = (int) $this->rc->config->get('kolab_addressbook_prio');
	+ $abook_prio = $this->addressbook_prio();

	// Personal address source(s) disabled?
	if ($abook_prio == self::GLOBAL_ONLY) {
	return $this->sources;
	}

	// get all folders that have "contact" type
	- $this->folders = kolab_storage::sort_folders(kolab_storage::get_folders('contact'));
	+ $folders = kolab_storage::sort_folders(kolab_storage::get_folders('contact'));

	- if (PEAR::isError($this->folders)) {
	+ if (PEAR::isError($folders)) {
	rcube::raise_error(array(
	'code' => 600, 'type' => 'php',
	'file' => __FILE__, 'line' => __LINE__,
	- 'message' => "Failed to list contact folders from Kolab server:" . $this->folders->getMessage()),
	+ 'message' => "Failed to list contact folders from Kolab server:" . $folders->getMessage()),
	true, false);
	}
	else {
	+ // we need at least one folder to prevent from errors in Roundcube core
	+ // when there's also no sql nor ldap addressbook (Bug #2086)
	+ if (empty($folders)) {
	+ if ($folder = kolab_storage::create_default_folder('contact')) {
	+ $folders = array(new kolab_storage_folder($folder, 'contact'));
	+ }
	+ }
	+
	// convert to UTF8 and sort
	$names = array();
	- foreach ($this->folders as $folder) {
	+ foreach ($folders as $folder) {
	// create instance of rcube_contacts
	$abook_id = kolab_storage::folder_id($folder->name);
	$abook = new rcube_kolab_contacts($folder->name);
	$this->sources[$abook_id] = $abook;
	}
	}

	return $this->sources;
	}


	/**
	* Plugin hook called before rendering the contact form or detail view
	*
	* @param array $p Hash array with hook parameters
	*
	* @return array Hash array with modified hook parameters
	*/
	public function contact_form($p)
	{
	// none of our business
	if (!is_object($GLOBALS['CONTACTS']) \|\| !is_a($GLOBALS['CONTACTS'], 'rcube_kolab_contacts'))
	return $p;

	// extend the list of contact fields to be displayed in the 'personal' section
	if (is_array($p['form']['personal'])) {
	$p['form']['personal']['content']['profession'] = array('size' => 40);
	$p['form']['personal']['content']['children'] = array('size' => 40);
	$p['form']['personal']['content']['freebusyurl'] = array('size' => 40);
	$p['form']['personal']['content']['pgppublickey'] = array('size' => 70);
	$p['form']['personal']['content']['pkcs7publickey'] = array('size' => 70);

	// re-order fields according to the coltypes list
	$p['form']['contact']['content'] = $this->_sort_form_fields($p['form']['contact']['content']);
	$p['form']['personal']['content'] = $this->_sort_form_fields($p['form']['personal']['content']);

	/* define a separate section 'settings'
	$p['form']['settings'] = array(
	'name' => $this->gettext('settings'),
	'content' => array(
	'freebusyurl' => array('size' => 40, 'visible' => true),
	'pgppublickey' => array('size' => 70, 'visible' => true),
	'pkcs7publickey' => array('size' => 70, 'visible' => false),
	)
	);
	*/
	}

	return $p;
	}


	private function _sort_form_fields($contents)
	{
	$block = array();
	$contacts = reset($this->sources);

	foreach (array_keys($contacts->coltypes) as $col) {
	if (isset($contents[$col]))
	$block[$col] = $contents[$col];
	}

	return $block;
	}


	/**
	* Handler for user preferences form (preferences_list hook)
	*
	* @param array $args Hash array with hook parameters
	*
	* @return array Hash array with modified hook parameters
	*/
	public function prefs_list($args)
	{
	if ($args['section'] != 'addressbook') {
	return $args;
	}

	- // Load configuration
	- $this->load_config();
	+ $ldap_public = $this->rc->config->get('ldap_public');
	+ $abook_type = $this->rc->config->get('address_book_type');

	- // Load localization
	- $this->add_texts('localization');
	+ // Hide option if there's no global addressbook
	+ if (empty($ldap_public) \|\| $abook_type != 'ldap') {
	+ return $args;
	+ }

	// Check that configuration is not disabled
	- $dont_override = (array) $this->rc->config->get('dont_override', array());
	+ $dont_override = (array) $this->rc->config->get('dont_override', array());
	+ $prio = $this->addressbook_prio();

	if (!in_array('kolab_addressbook_prio', $dont_override)) {
	+ // Load localization
	+ $this->add_texts('localization');
	+
	$field_id = '_kolab_addressbook_prio';
	$select = new html_select(array('name' => $field_id, 'id' => $field_id));

	$select->add($this->gettext('globalfirst'), self::GLOBAL_FIRST);
	$select->add($this->gettext('personalfirst'), self::PERSONAL_FIRST);
	$select->add($this->gettext('globalonly'), self::GLOBAL_ONLY);
	$select->add($this->gettext('personalonly'), self::PERSONAL_ONLY);

	$args['blocks']['main']['options']['kolab_addressbook_prio'] = array(
	'title' => html::label($field_id, Q($this->gettext('addressbookprio'))),
	- 'content' => $select->show((int)$this->rc->config->get('kolab_addressbook_prio')),
	+ 'content' => $select->show($prio),
	);
	}

	return $args;
	}

	/**
	* Handler for user preferences save (preferences_save hook)
	*
	* @param array $args Hash array with hook parameters
	*
	* @return array Hash array with modified hook parameters
	*/
	public function prefs_save($args)
	{
	if ($args['section'] != 'addressbook') {
	return $args;
	}

	- // Load configuration
	- $this->load_config();
	-
	// Check that configuration is not disabled
	- $dont_override = (array) $this->rc->config->get('dont_override', array());
	+ $dont_override = (array) $this->rc->config->get('dont_override', array());
	+ $key = 'kolab_addressbook_prio';

	- if (!in_array('kolab_addressbook_prio', $dont_override)) {
	- $key = 'kolab_addressbook_prio';
	+ if (!in_array('kolab_addressbook_prio', $dont_override) \|\| !isset($_POST['_'.$key])) {
	$args['prefs'][$key] = (int) get_input_value('_'.$key, RCUBE_INPUT_POST);
	}

	return $args;
	}


	/**
	* Handler for plugin actions
	*/
	public function book_actions()
	{
	$action = trim(get_input_value('_act', RCUBE_INPUT_GPC));

	if ($action == 'create') {
	$this->ui->book_edit();
	}
	else if ($action == 'edit') {
	$this->ui->book_edit();
	}
	else if ($action == 'delete') {
	$this->book_delete();
	}
	}


	/**
	* Handler for address book create/edit form submit
	*/
	public function book_save()
	{
	$prop = array(
	'name' => trim(get_input_value('_name', RCUBE_INPUT_POST)),
	'oldname' => trim(get_input_value('_oldname', RCUBE_INPUT_POST, true)), // UTF7-IMAP
	'parent' => trim(get_input_value('_parent', RCUBE_INPUT_POST, true)), // UTF7-IMAP
	'type' => 'contact',
	'subscribed' => true,
	);

	$result = $error = false;
	$type = strlen($prop['oldname']) ? 'update' : 'create';
	$prop = $this->rc->plugins->exec_hook('addressbook_'.$type, $prop);

	if (!$prop['abort']) {
	if ($newfolder = kolab_storage::folder_update($prop)) {
	$folder = $newfolder;
	$result = true;
	}
	else {
	$error = kolab_storage::$last_error;
	}
	}
	else {
	$result = $prop['result'];
	$folder = $prop['name'];
	}

	if ($result) {
	$storage = $this->rc->get_storage();
	$delimiter = $storage->get_hierarchy_delimiter();
	$kolab_folder = new rcube_kolab_contacts($folder);

	// create display name for the folder (see self::address_sources())
	if (strpos($folder, $delimiter)) {
	$names = array();
	foreach ($this->_list_sources() as $abook) {
	$realname = $abook->get_realname();
	// The list can be not updated yet, handle old folder name
	if ($type == 'update' && $realname == $prop['oldname']) {
	$abook = $kolab_folder;
	$realname = $folder;
	}

	$name = kolab_storage::folder_displayname($abook->get_name(), $names);

	if ($realname == $folder) {
	break;
	}
	}
	}
	else {
	$name = $kolab_folder->get_name();
	}

	$this->rc->output->show_message('kolab_addressbook.book'.$type.'d', 'confirmation');
	$this->rc->output->command('set_env', 'delimiter', $delimiter);
	$this->rc->output->command('book_update', array(
	'id' => kolab_storage::folder_id($folder),
	'name' => $name,
	'readonly' => false,
	'editable' => true,
	'groups' => true,
	'realname' => rcube_charset::convert($folder, 'UTF7-IMAP'), // IMAP folder name
	'class_name' => $kolab_folder->get_namespace(),
	'kolab' => true,
	), kolab_storage::folder_id($prop['oldname']));

	$this->rc->output->send('iframe');
	}

	if (!$error)
	$error = $plugin['message'] ? $plugin['message'] : 'kolab_addressbook.book'.$type.'error';

	$this->rc->output->show_message($error, 'error');
	// display the form again
	$this->ui->book_edit();
	}


	/**
	* Handler for address book delete action (AJAX)
	*/
	private function book_delete()
	{
	$folder = trim(get_input_value('_source', RCUBE_INPUT_GPC, true, 'UTF7-IMAP'));

	if (kolab_storage::folder_delete($folder)) {
	$storage = $this->rc->get_storage();
	$delimiter = $storage->get_hierarchy_delimiter();

	$this->rc->output->show_message('kolab_addressbook.bookdeleted', 'confirmation');
	$this->rc->output->set_env('pagecount', 0);
	$this->rc->output->command('set_rowcount', rcmail_get_rowcount_text(new rcube_result_set()));
	$this->rc->output->command('set_env', 'delimiter', $delimiter);
	$this->rc->output->command('list_contacts_clear');
	$this->rc->output->command('book_delete_done', kolab_storage::folder_id($folder));
	}
	else {
	$this->rc->output->show_message('kolab_addressbook.bookdeleteerror', 'error');
	}

	$this->rc->output->send();
	}
	+
	+ /**
	+ * Returns value of kolab_addressbook_prio setting
	+ */
	+ private function addressbook_prio()
	+ {
	+ // Load configuration
	+ if (!$this->config_loaded) {
	+ $this->load_config();
	+ $this->config_loaded = true;
	+ }
	+
	+ $abook_prio = (int) $this->rc->config->get('kolab_addressbook_prio');
	+
	+ // Make sure any global addressbooks are defined
	+ if ($abook_prio == 0 \|\| $abook_prio == 2) {
	+ $ldap_public = $this->rc->config->get('ldap_public');
	+ $abook_type = $this->rc->config->get('address_book_type');
	+
	+ if (empty($ldap_public) \|\| $abook_type != 'ldap') {
	+ $abook_prio = 1;
	+ }
	+ }
	+
	+ return $abook_prio;
	+ }
	}
	diff --git a/plugins/libkolab/lib/kolab_storage.php b/plugins/libkolab/lib/kolab_storage.php
	index 777702d5..ee6ede02 100644
	--- a/plugins/libkolab/lib/kolab_storage.php
	+++ b/plugins/libkolab/lib/kolab_storage.php
	@@ -1,916 +1,1019 @@
	<?php

	/**
	* Kolab storage class providing static methods to access groupware objects on a Kolab server.
	*
	* @version @package_version@
	* @author Thomas Bruederli <bruederli@kolabsys.com>
	* @author Aleksander Machniak <machniak@kolabsys.com>
	*
	* Copyright (C) 2012, Kolab Systems AG <contact@kolabsys.com>
	*
	* This program is free software: you can redistribute it and/or modify
	* it under the terms of the GNU Affero General Public License as
	* published by the Free Software Foundation, either version 3 of the
	* License, or (at your option) any later version.
	*
	* This program is distributed in the hope that it will be useful,
	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	* GNU Affero General Public License for more details.
	*
	* You should have received a copy of the GNU Affero General Public License
	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	*/

	class kolab_storage
	{
	const CTYPE_KEY = '/shared/vendor/kolab/folder-type';
	const CTYPE_KEY_PRIVATE = '/private/vendor/kolab/folder-type';
	const COLOR_KEY_SHARED = '/shared/vendor/kolab/color';
	const COLOR_KEY_PRIVATE = '/private/vendor/kolab/color';
	const NAME_KEY_SHARED = '/shared/vendor/kolab/displayname';
	const NAME_KEY_PRIVATE = '/private/vendor/kolab/displayname';

	public static $version = '3.0';
	public static $last_error;

	private static $ready = false;
	private static $subscriptions;
	private static $states;
	private static $config;
	private static $imap;

	+ // Default folder names
	+ private static $default_folders = array(
	+ 'event' => 'Calendar',
	+ 'contact' => 'Contacts',
	+ 'task' => 'Tasks',
	+ 'note' => 'Notes',
	+ 'file' => 'Files',
	+ 'configuration' => 'Configuration',
	+ 'journal' => 'Journal',
	+ 'mail.inbox' => 'INBOX',
	+ 'mail.drafts' => 'Drafts',
	+ 'mail.sentitems' => 'Sent',
	+ 'mail.wastebasket' => 'Trash',
	+ 'mail.outbox' => 'Outbox',
	+ 'mail.junkemail' => 'Junk',
	+ );
	+

	/**
	* Setup the environment needed by the libs
	*/
	public static function setup()
	{
	if (self::$ready)
	return true;

	$rcmail = rcube::get_instance();
	self::$config = $rcmail->config;
	self::$version = strval($rcmail->config->get('kolab_format_version', self::$version));
	self::$imap = $rcmail->get_storage();
	self::$ready = class_exists('kolabformat') &&
	(self::$imap->get_capability('METADATA') \|\| self::$imap->get_capability('ANNOTATEMORE') \|\| self::$imap->get_capability('ANNOTATEMORE2'));

	if (self::$ready) {
	// set imap options
	self::$imap->set_options(array(
	'skip_deleted' => true,
	'threading' => false,
	));
	self::$imap->set_pagesize(9999);
	}
	else if (!class_exists('kolabformat')) {
	rcube::raise_error(array(
	'code' => 900, 'type' => 'php',
	'message' => "required kolabformat module not found"
	), true);
	}
	else {
	rcube::raise_error(array(
	'code' => 900, 'type' => 'php',
	'message' => "IMAP server doesn't support METADATA or ANNOTATEMORE"
	), true);
	}

	return self::$ready;
	}


	/**
	* Get a list of storage folders for the given data type
	*
	* @param string Data type to list folders for (contact,distribution-list,event,task,note)
	*
	* @return array List of Kolab_Folder objects (folder names in UTF7-IMAP)
	*/
	public static function get_folders($type)
	{
	$folders = $folderdata = array();

	if (self::setup()) {
	foreach ((array)self::list_folders('', '*', $type, null, $folderdata) as $foldername) {
	$folders[$foldername] = new kolab_storage_folder($foldername, $folderdata[$foldername]);
	}
	}

	return $folders;
	}

	/**
	* Getter for the storage folder for the given type
	*
	* @param string Data type to list folders for (contact,distribution-list,event,task,note)
	* @return object kolab_storage_folder The folder object
	*/
	public static function get_default_folder($type)
	{
	if (self::setup()) {
	foreach ((array)self::list_folders('', '*', $type . '.default', false, $folderdata) as $foldername) {
	return new kolab_storage_folder($foldername, $folderdata[$foldername]);
	}
	}

	return null;
	}


	/**
	* Getter for a specific storage folder
	*
	* @param string IMAP folder to access (UTF7-IMAP)
	* @return object kolab_storage_folder The folder object
	*/
	public static function get_folder($folder)
	{
	return self::setup() ? new kolab_storage_folder($folder) : null;
	}


	/**
	* Getter for a single Kolab object, identified by its UID.
	* This will search all folders storing objects of the given type.
	*
	* @param string Object UID
	* @param string Object type (contact,distribution-list,event,task,note)
	* @return array The Kolab object represented as hash array or false if not found
	*/
	public static function get_object($uid, $type)
	{
	self::setup();
	$folder = null;
	foreach ((array)self::list_folders('', '*', $type) as $foldername) {
	if (!$folder)
	$folder = new kolab_storage_folder($foldername);
	else
	$folder->set_folder($foldername);

	if ($object = $folder->get_object($uid))
	return $object;
	}

	return false;
	}


	/**
	*
	*/
	public static function get_freebusy_server()
	{
	return unslashify(self::$config->get('kolab_freebusy_server', 'https://' . $_SESSION['imap_host'] . '/freebusy'));
	}


	/**
	* Compose an URL to query the free/busy status for the given user
	*/
	public static function get_freebusy_url($email)
	{
	return self::get_freebusy_server() . '/' . $email . '.ifb';
	}


	/**
	* Creates folder ID from folder name
	*
	* @param string $folder Folder name (UTF7-IMAP)
	*
	* @return string Folder ID string
	*/
	public static function folder_id($folder)
	{
	return asciiwords(strtr($folder, '/.-', '___'));
	}


	/**
	* Deletes IMAP folder
	*
	* @param string $name Folder name (UTF7-IMAP)
	*
	* @return bool True on success, false on failure
	*/
	public static function folder_delete($name)
	{
	// clear cached entries first
	if ($folder = self::get_folder($name))
	$folder->cache->purge();

	$success = self::$imap->delete_folder($name);
	self::$last_error = self::$imap->get_error_str();

	return $success;
	}

	/**
	* Creates IMAP folder
	*
	* @param string $name Folder name (UTF7-IMAP)
	* @param string $type Folder type
	* @param bool $subscribed Sets folder subscription
	* @param bool $active Sets folder state (client-side subscription)
	*
	* @return bool True on success, false on failure
	*/
	public static function folder_create($name, $type = null, $subscribed = false, $active = false)
	{
	self::setup();

	if ($saved = self::$imap->create_folder($name, $subscribed)) {
	// set metadata for folder type
	if ($type) {
	$saved = self::set_folder_type($name, $type);

	// revert if metadata could not be set
	if (!$saved) {
	self::$imap->delete_folder($name);
	}
	// activate folder
	else if ($active) {
	self::set_state($name, true);
	}
	}
	}

	if ($saved) {
	return true;
	}

	self::$last_error = self::$imap->get_error_str();
	return false;
	}


	/**
	* Renames IMAP folder
	*
	* @param string $oldname Old folder name (UTF7-IMAP)
	* @param string $newname New folder name (UTF7-IMAP)
	*
	* @return bool True on success, false on failure
	*/
	public static function folder_rename($oldname, $newname)
	{
	self::setup();

	$success = self::$imap->rename_folder($oldname, $newname);
	self::$last_error = self::$imap->get_error_str();

	return $success;
	}


	/**
	* Rename or Create a new IMAP folder.
	*
	* Does additional checks for permissions and folder name restrictions
	*
	* @param array Hash array with folder properties and metadata
	* - name: Folder name
	* - oldname: Old folder name when changed
	* - parent: Parent folder to create the new one in
	* - type: Folder type to create
	* - subscribed: Subscribed flag (IMAP subscription)
	* - active: Activation flag (client-side subscription)
	* @return mixed New folder name or False on failure
	*/
	public static function folder_update(&$prop)
	{
	self::setup();

	$folder = rcube_charset::convert($prop['name'], RCUBE_CHARSET, 'UTF7-IMAP');
	$oldfolder = $prop['oldname']; // UTF7
	$parent = $prop['parent']; // UTF7
	$delimiter = self::$imap->get_hierarchy_delimiter();

	if (strlen($oldfolder)) {
	$options = self::$imap->folder_info($oldfolder);
	}

	if (!empty($options) && ($options['norename'] \|\| $options['protected'])) {
	}
	// sanity checks (from steps/settings/save_folder.inc)
	else if (!strlen($folder)) {
	self::$last_error = 'cannotbeempty';
	return false;
	}
	else if (strlen($folder) > 128) {
	self::$last_error = 'nametoolong';
	return false;
	}
	else {
	// these characters are problematic e.g. when used in LIST/LSUB
	foreach (array($delimiter, '%', '*') as $char) {
	if (strpos($folder, $char) !== false) {
	self::$last_error = 'forbiddencharacter';
	return false;
	}
	}
	}

	if (!empty($options) && ($options['protected'] \|\| $options['norename'])) {
	$folder = $oldfolder;
	}
	else if (strlen($parent)) {
	$folder = $parent . $delimiter . $folder;
	}
	else {
	// add namespace prefix (when needed)
	$folder = self::$imap->mod_folder($folder, 'in');
	}

	// Check access rights to the parent folder
	if (strlen($parent) && (!strlen($oldfolder) \|\| $oldfolder != $folder)) {
	$parent_opts = self::$imap->folder_info($parent);
	if ($parent_opts['namespace'] != 'personal'
	&& (empty($parent_opts['rights']) \|\| !preg_match('/[ck]/', implode($parent_opts['rights'])))
	) {
	self::$last_error = 'No permission to create folder';
	return false;
	}
	}

	// update the folder name
	if (strlen($oldfolder)) {
	if ($oldfolder != $folder) {
	$result = self::folder_rename($oldfolder, $folder);
	}
	else
	$result = true;
	}
	// create new folder
	else {
	$result = self::folder_create($folder, $prop['type'], $prop['subscribed'], $prop['active']);
	}

	- // save displayname and color in METADATA
	- // TODO: also save 'showalarams' and other properties here
	if ($result) {
	- $ns = null;
	- foreach (array('color' => array(self::COLOR_KEY_SHARED,self::COLOR_KEY_PRIVATE),
	- 'displayname' => array(self::NAME_KEY_SHARED,self::NAME_KEY_PRIVATE)) as $key => $metakeys) {
	- if (!empty($prop[$key])) {
	- if (!isset($ns))
	- $ns = self::$imap->folder_namespace($folder);
	-
	- $meta_saved = false;
	- if ($ns == 'personal') // save in shared namespace for personal folders
	- $meta_saved = self::$imap->set_metadata($folder, array($metakeys[0] => $prop[$key]));
	- if (!$meta_saved) // try in private namespace
	- $meta_saved = self::$imap->set_metadata($folder, array($metakeys[1] => $prop[$key]));
	- if ($meta_saved)
	- unset($prop[$key]); // unsetting will prevent fallback to local user prefs
	- }
	- }
	+ self::set_folder_props($folder, $prop);
	}

	return $result ? $folder : false;
	}


	/**
	* Getter for human-readable name of Kolab object (folder)
	* See http://wiki.kolab.org/UI-Concepts/Folder-Listing for reference
	*
	* @param string $folder IMAP folder name (UTF7-IMAP)
	* @param string $folder_ns Will be set to namespace name of the folder
	*
	* @return string Name of the folder-object
	*/
	public static function object_name($folder, &$folder_ns=null)
	{
	self::setup();

	// find custom display name in folder METADATA
	if (self::$config->get('kolab_custom_display_names', true)) {
	$metadata = self::$imap->get_metadata($folder, array(self::NAME_KEY_PRIVATE, self::NAME_KEY_SHARED));
	if (($name = $metadata[$folder][self::NAME_KEY_PRIVATE]) \|\| ($name = $metadata[$folder][self::NAME_KEY_SHARED])) {
	return $name;
	}
	}

	$found = false;
	$namespace = self::$imap->get_namespace();

	if (!empty($namespace['shared'])) {
	foreach ($namespace['shared'] as $ns) {
	if (strlen($ns[0]) && strpos($folder, $ns[0]) === 0) {
	$prefix = '';
	$folder = substr($folder, strlen($ns[0]));
	$delim = $ns[1];
	$found = true;
	$folder_ns = 'shared';
	break;
	}
	}
	}
	if (!$found && !empty($namespace['other'])) {
	foreach ($namespace['other'] as $ns) {
	if (strlen($ns[0]) && strpos($folder, $ns[0]) === 0) {
	// remove namespace prefix
	$folder = substr($folder, strlen($ns[0]));
	$delim = $ns[1];
	// get username
	$pos = strpos($folder, $delim);
	if ($pos) {
	$prefix = '('.substr($folder, 0, $pos).') ';
	$folder = substr($folder, $pos+1);
	}
	else {
	$prefix = '('.$folder.')';
	$folder = '';
	}
	$found = true;
	$folder_ns = 'other';
	break;
	}
	}
	}
	if (!$found && !empty($namespace['personal'])) {
	foreach ($namespace['personal'] as $ns) {
	if (strlen($ns[0]) && strpos($folder, $ns[0]) === 0) {
	// remove namespace prefix
	$folder = substr($folder, strlen($ns[0]));
	$prefix = '';
	$delim = $ns[1];
	$found = true;
	break;
	}
	}
	}

	if (empty($delim))
	$delim = self::$imap->get_hierarchy_delimiter();

	$folder = rcube_charset::convert($folder, 'UTF7-IMAP');
	$folder = html::quote($folder);
	$folder = str_replace(html::quote($delim), ' » ', $folder);

	if ($prefix)
	$folder = html::quote($prefix) . ' ' . $folder;

	if (!$folder_ns)
	$folder_ns = 'personal';

	return $folder;
	}


	/**
	* Helper method to generate a truncated folder name to display
	*/
	public static function folder_displayname($origname, &$names)
	{
	$name = $origname;

	// find folder prefix to truncate
	for ($i = count($names)-1; $i >= 0; $i--) {
	if (strpos($name, $names[$i] . ' » ') === 0) {
	$length = strlen($names[$i] . ' » ');
	$prefix = substr($name, 0, $length);
	$count = count(explode(' » ', $prefix));
	$name = str_repeat('  ', $count-1) . '» ' . substr($name, $length);
	break;
	}
	}
	$names[] = $origname;

	return $name;
	}


	/**
	* Creates a SELECT field with folders list
	*
	* @param string $type Folder type
	* @param array $attrs SELECT field attributes (e.g. name)
	* @param string $current The name of current folder (to skip it)
	*
	* @return html_select SELECT object
	*/
	public static function folder_selector($type, $attrs, $current = '')
	{
	// get all folders of specified type
	$folders = self::get_folders($type);

	$delim = self::$imap->get_hierarchy_delimiter();
	$names = array();
	$len = strlen($current);

	if ($len && ($rpos = strrpos($current, $delim))) {
	$parent = substr($current, 0, $rpos);
	$p_len = strlen($parent);
	}

	// Filter folders list
	foreach ($folders as $c_folder) {
	$name = $c_folder->name;
	// skip current folder and it's subfolders
	if ($len && ($name == $current \|\| strpos($name, $current.$delim) === 0)) {
	continue;
	}

	// always show the parent of current folder
	if ($p_len && $name == $parent) { }
	// skip folders where user have no rights to create subfolders
	else if ($c_folder->get_owner() != $_SESSION['username']) {
	$rights = $c_folder->get_myrights();
	if (!preg_match('/[ck]/', $rights)) {
	continue;
	}
	}

	$names[$name] = self::object_name($name);
	}

	// Make sure parent folder is listed (might be skipped e.g. if it's namespace root)
	if ($p_len && !isset($names[$parent])) {
	$names[$parent] = self::object_name($parent);
	}

	// Sort folders list
	asort($names, SORT_LOCALE_STRING);

	// Build SELECT field of parent folder
	$attrs['is_escaped'] = true;
	$select = new html_select($attrs);
	$select->add('---', '');

	$listnames = array();
	foreach (array_keys($names) as $imap_name) {
	$name = $origname = $names[$imap_name];

	// find folder prefix to truncate
	for ($i = count($listnames)-1; $i >= 0; $i--) {
	if (strpos($name, $listnames[$i].' » ') === 0) {
	$length = strlen($listnames[$i].' » ');
	$prefix = substr($name, 0, $length);
	$count = count(explode(' » ', $prefix));
	$name = str_repeat('  ', $count-1) . '» ' . substr($name, $length);
	break;
	}
	}

	$listnames[] = $origname;
	$select->add($name, $imap_name);
	}

	return $select;
	}


	/**
	* Returns a list of folder names
	*
	* @param string Optional root folder
	* @param string Optional name pattern
	* @param string Data type to list folders for (contact,distribution-list,event,task,note,mail)
	* @param boolean Enable to return subscribed folders only (null to use configured subscription mode)
	* @param array Will be filled with folder-types data
	*
	* @return array List of folders
	*/
	public static function list_folders($root = '', $mbox = '*', $filter = null, $subscribed = null, &$folderdata = array())
	{
	if (!self::setup()) {
	return null;
	}

	// use IMAP subscriptions
	if ($subscribed === null && self::$config->get('kolab_use_subscriptions')) {
	$subscribed = true;
	}

	if (!$filter) {
	// Get ALL folders list, standard way
	if ($subscribed) {
	return self::$imap->list_folders_subscribed($root, $mbox);
	}
	else {
	return self::$imap->list_folders($root, $mbox);
	}
	}

	$prefix = $root . $mbox;
	$regexp = '/^' . preg_quote($filter, '/') . '(\..+)?$/';

	// get folders types
	$folderdata = self::folders_typedata($prefix);

	if (!is_array($folderdata)) {
	return array();
	}

	// In some conditions we can skip LIST command (?)
	if (!$subscribed && $filter != 'mail' && $prefix == '*') {
	foreach ($folderdata as $folder => $type) {
	if (!preg_match($regexp, $type)) {
	unset($folderdata[$folder]);
	}
	}
	return array_keys($folderdata);
	}

	// Get folders list
	if ($subscribed) {
	$folders = self::$imap->list_folders_subscribed($root, $mbox);
	}
	else {
	$folders = self::$imap->list_folders($root, $mbox);
	}

	// In case of an error, return empty list (?)
	if (!is_array($folders)) {
	return array();
	}

	// Filter folders list
	foreach ($folders as $idx => $folder) {
	$type = $folderdata[$folder];

	if ($filter == 'mail' && empty($type)) {
	continue;
	}
	if (empty($type) \|\| !preg_match($regexp, $type)) {
	unset($folders[$idx]);
	}
	}

	return $folders;
	}


	/**
	* Sort the given list of kolab folders by namespace/name
	*
	* @param array List of kolab_storage_folder objects
	* @return array Sorted list of folders
	*/
	public static function sort_folders($folders)
	{
	$nsnames = array('personal' => array(), 'shared' => array(), 'other' => array());
	foreach ($folders as $folder) {
	$folders[$folder->name] = $folder;
	$ns = $folder->get_namespace();
	$nsnames[$ns][$folder->name] = strtolower(html_entity_decode(self::object_name($folder->name, $ns), ENT_COMPAT, RCUBE_CHARSET)); // decode »
	}

	$names = array();
	foreach ($nsnames as $ns => $dummy) {
	asort($nsnames[$ns], SORT_LOCALE_STRING);
	$names += $nsnames[$ns];
	}

	$out = array();
	foreach ($names as $utf7name => $name) {
	$out[] = $folders[$utf7name];
	}

	return $out;
	}


	/**
	* Returns folder types indexed by folder name
	*
	* @param string $prefix Folder prefix (Default '*' for all folders)
	*
	* @return array\|bool List of folders, False on failure
	*/
	public static function folders_typedata($prefix = '*')
	{
	if (!self::setup()) {
	return false;
	}

	$folderdata = self::$imap->get_metadata($prefix, array(self::CTYPE_KEY, self::CTYPE_KEY_PRIVATE));

	if (!is_array($folderdata)) {
	return false;
	}

	return array_map(array('kolab_storage', 'folder_select_metadata'), $folderdata);
	}


	/**
	* Callback for array_map to select the correct annotation value
	*/
	public static function folder_select_metadata($types)
	{
	if (!empty($types[self::CTYPE_KEY_PRIVATE])) {
	return $types[self::CTYPE_KEY_PRIVATE];
	}
	else if (!empty($types[self::CTYPE_KEY])) {
	list($ctype, $suffix) = explode('.', $types[self::CTYPE_KEY]);
	return $ctype;
	}
	return null;
	}


	/**
	* Returns type of IMAP folder
	*
	* @param string $folder Folder name (UTF7-IMAP)
	*
	* @return string Folder type
	*/
	public static function folder_type($folder)
	{
	self::setup();

	$metadata = self::$imap->get_metadata($folder, array(self::CTYPE_KEY, self::CTYPE_KEY_PRIVATE));

	if (!is_array($metadata)) {
	return null;
	}

	if (!empty($metadata[$folder])) {
	return self::folder_select_metadata($metadata[$folder]);
	}

	return 'mail';
	}


	/**
	* Sets folder content-type.
	*
	* @param string $folder Folder name
	* @param string $type Content type
	*
	* @return boolean True on success
	*/
	public static function set_folder_type($folder, $type='mail')
	{
	self::setup();

	list($ctype, $subtype) = explode('.', $type);

	$success = self::$imap->set_metadata($folder, array(self::CTYPE_KEY => $ctype, self::CTYPE_KEY_PRIVATE => $subtype ? $type : null));

	if (!$success) // fallback: only set private annotation
	$success \|= self::$imap->set_metadata($folder, array(self::CTYPE_KEY_PRIVATE => $type));

	return $success;
	}


	/**
	* Check subscription status of this folder
	*
	* @param string $folder Folder name
	*
	* @return boolean True if subscribed, false if not
	*/
	public static function folder_is_subscribed($folder)
	{
	if (self::$subscriptions === null) {
	self::setup();
	self::$subscriptions = self::$imap->list_folders_subscribed();
	}

	return in_array($folder, self::$subscriptions);
	}


	/**
	* Change subscription status of this folder
	*
	* @param string $folder Folder name
	*
	* @return True on success, false on error
	*/
	public static function folder_subscribe($folder)
	{
	self::setup();

	if (self::$imap->subscribe($folder)) {
	self::$subscriptions === null;
	return true;
	}

	return false;
	}


	/**
	* Change subscription status of this folder
	*
	* @param string $folder Folder name
	*
	* @return True on success, false on error
	*/
	public static function folder_unsubscribe($folder)
	{
	self::setup();

	if (self::$imap->unsubscribe($folder)) {
	self::$subscriptions === null;
	return true;
	}

	return false;
	}


	/**
	* Check activation status of this folder
	*
	* @param string $folder Folder name
	*
	* @return boolean True if active, false if not
	*/
	public static function folder_is_active($folder)
	{
	$active_folders = self::get_states();

	return in_array($folder, $active_folders);
	}


	/**
	* Change activation status of this folder
	*
	* @param string $folder Folder name
	*
	* @return True on success, false on error
	*/
	public static function folder_activate($folder)
	{
	return self::set_state($folder, true);
	}


	/**
	* Change activation status of this folder
	*
	* @param string $folder Folder name
	*
	* @return True on success, false on error
	*/
	public static function folder_deactivate($folder)
	{
	return self::set_state($folder, false);
	}


	/**
	* Return list of active folders
	*/
	private static function get_states()
	{
	if (self::$states !== null) {
	return self::$states;
	}

	$rcube = rcube::get_instance();
	$folders = $rcube->config->get('kolab_active_folders');

	if ($folders !== null) {
	self::$states = !empty($folders) ? explode('**', $folders) : array();
	}
	// for backward-compatibility copy server-side subscriptions to activation states
	else {
	self::setup();
	if (self::$subscriptions === null) {
	self::$subscriptions = self::$imap->list_folders_subscribed();
	}
	self::$states = self::$subscriptions;
	$folders = implode(self::$states, '**');
	$rcube->user->save_prefs(array('kolab_active_folders' => $folders));
	}

	return self::$states;
	}


	/**
	* Update list of active folders
	*/
	private static function set_state($folder, $state)
	{
	self::get_states();

	// update in-memory list
	$idx = array_search($folder, self::$states);
	if ($state && $idx === false) {
	self::$states[] = $folder;
	}
	else if (!$state && $idx !== false) {
	unset(self::$states[$idx]);
	}

	// update user preferences
	$folders = implode(self::$states, '**');
	$rcube = rcube::get_instance();
	return $rcube->user->save_prefs(array('kolab_active_folders' => $folders));
	}
	+
	+ /**
	+ * Creates default folder of specified type
	+ * To be run when none of subscribed folders (of specified type) is found
	+ *
	+ * @param string $type Folder type
	+ * @param string $props Folder properties (color, etc)
	+ *
	+ * @return string Folder name
	+ */
	+ public static function create_default_folder($type, $props = array())
	+ {
	+ if (!self::setup()) {
	+ return;
	+ }
	+
	+ $folders = self::$imap->get_metadata('*', array(kolab_storage::CTYPE_KEY_PRIVATE));
	+
	+ // from kolab_folders config
	+ $folder_type = strpos($type, '.') ? str_replace('.', '_', $type) : $type . '_default';
	+ $default_name = self::$config->get('kolab_folders_' . $folder_type);
	+ $folder_type = str_replace('_', '.', $folder_type);
	+
	+ // check if we have any folder in personal namespace
	+ // folder(s) may exist but not subscribed
	+ foreach ($folders as $f => $data) {
	+ if (strpos($data[self::CTYPE_KEY_PRIVATE], $type) === 0) {
	+ $folder = $f;
	+ break;
	+ }
	+ }
	+
	+ if (!$folder) {
	+ if (!$default_name) {
	+ $default_name = self::$default_folders[$type];
	+ }
	+
	+ if (!$default_name) {
	+ return;
	+ }
	+
	+ $folder = rcube_charset::convert($default_name, RCUBE_CHARSET, 'UTF7-IMAP');
	+ $prefix = self::$imap->get_namespace('prefix');
	+
	+ // add personal namespace prefix if needed
	+ if ($prefix && strpos($folder, $prefix) !== 0 && $folder != 'INBOX') {
	+ $folder = $prefix . $folder;
	+ }
	+
	+ if (!self::$imap->folder_exists($folder)) {
	+ if (!self::$imap->folder_create($folder)) {
	+ return;
	+ }
	+ }
	+
	+ self::set_folder_type($folder, $folder_type);
	+ }
	+
	+ self::folder_subscribe($folder);
	+
	+ if ($props['active']) {
	+ self::set_state($folder, true);
	+ }
	+
	+ if (!empty($props)) {
	+ self::set_folder_props($folder, $props);
	+ }
	+
	+ return $folder;
	+ }
	+
	+ /**
	+ * Sets folder metadata properties
	+ *
	+ * @param string $folder Folder name
	+ * @param array $prop Folder properties
	+ */
	+ public static function set_folder_props($folder, &$prop)
	+ {
	+ if (!self::setup()) {
	+ return;
	+ }
	+
	+ // TODO: also save 'showalarams' and other properties here
	+ $ns = self::$imap->folder_namespace($folder);
	+ $supported = array(
	+ 'color' => array(self::COLOR_KEY_SHARED, self::COLOR_KEY_PRIVATE),
	+ 'displayname' => array(self::NAME_KEY_SHARED, self::NAME_KEY_PRIVATE),
	+ );
	+
	+ foreach ($supported as $key => $metakeys) {
	+ if (array_key_exists($key, $prop)) {
	+ $meta_saved = false;
	+ if ($ns == 'personal') // save in shared namespace for personal folders
	+ $meta_saved = self::$imap->set_metadata($folder, array($metakeys[0] => $prop[$key]));
	+ if (!$meta_saved) // try in private namespace
	+ $meta_saved = self::$imap->set_metadata($folder, array($metakeys[1] => $prop[$key]));
	+ if ($meta_saved)
	+ unset($prop[$key]); // unsetting will prevent fallback to local user prefs
	+ }
	+ }
	+ }
	+
	}

File Metadata

Mime Type: text/x-diff
Expires: Fri, Apr 24, 1:05 PM (1 w, 13 h ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 18896688
Default Alt Text: (53 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions