No OneTemporary
Actions

Size

53 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/lib/kolab/kolab_format_distributionlist.php b/lib/kolab/kolab_format_distributionlist.php
	index a747b87..fcb94c1 100644
	--- a/lib/kolab/kolab_format_distributionlist.php
	+++ b/lib/kolab/kolab_format_distributionlist.php
	@@ -1,143 +1,147 @@
	<?php

	/**
	* Kolab Distribution List model class
	*
	* @version @package_version@
	* @author Thomas Bruederli <bruederli@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_format_distributionlist extends kolab_format
	{
	public $CTYPE = 'application/vcard+xml';

	protected $read_func = 'kolabformat::readDistlist';
	protected $write_func = 'kolabformat::writeDistlist';


	function __construct($xmldata = null)
	{
	$this->obj = new DistList;
	$this->xmldata = $xmldata;
	}

	/**
	* Set properties to the kolabformat object
	*
	* @param array Object data as hash array
	*/
	public function set(&$object)
	{
	$this->init();

	// set some automatic values if missing
	if (!empty($object['uid']))
	$this->obj->setUid($object['uid']);

	$object['changed'] = new DateTime('now', self::$timezone);
	$this->obj->setLastModified(self::get_datetime($object['changed'], new DateTimeZone('UTC')));

	$this->obj->setName($object['name']);

	$seen = array();
	$members = new vectorcontactref;
	foreach ((array)$object['member'] as $member) {
	if ($member['uid'])
	$m = new ContactReference(ContactReference::UidReference, $member['uid']);
	else if ($member['email'])
	$m = new ContactReference(ContactReference::EmailReference, $member['email']);
	else
	continue;

	$m->setName($member['name']);
	$members->push($m);
	$seen[$member['email']]++;
	}

	$this->obj->setMembers($members);

	+ // set type property for proper caching
	+ $object['_type'] = 'distribution-list';
	+
	// cache this data
	$this->data = $object;
	unset($this->data['_formatobj']);
	}

	public function is_valid()
	{
	return $this->data \|\| (is_object($this->obj) && $this->obj->isValid());
	}

	/**
	* Load data from old Kolab2 format
	*/
	public function fromkolab2($record)
	{
	$object = array(
	'uid' => $record['uid'],
	'changed' => $record['last-modification-date'],
	'name' => $record['last-name'],
	'member' => array(),
	);

	foreach ((array)$record['member'] as $member) {
	$object['member'][] = array(
	'email' => $member['smtp-address'],
	'name' => $member['display-name'],
	'uid' => $member['uid'],
	);
	}

	$this->data = $object;
	}

	/**
	* Convert the Distlist object into a hash array data structure
	*
	* @return array Distribution list data as hash array
	*/
	public function to_array()
	{
	// return cached result
	if (!empty($this->data))
	return $this->data;

	$this->init();

	// read object properties
	$object = array(
	'uid' => $this->obj->uid(),
	'changed' => self::php_datetime($this->obj->lastModified()),
	'name' => $this->obj->name(),
	'member' => array(),
	+ '_type' => 'distribution-list',
	);

	$members = $this->obj->members();
	for ($i=0; $i < $members->size(); $i++) {
	$member = $members->get($i);
	# if ($member->type() == ContactReference::UidReference && ($uid = $member->uid()))
	$object['member'][] = array(
	'uid' => $member->uid(),
	'email' => $member->email(),
	'name' => $member->name(),
	);
	}

	$this->data = $object;
	return $this->data;
	}

	}
	diff --git a/lib/kolab/kolab_storage.php b/lib/kolab/kolab_storage.php
	index 546d19a..e14156d 100644
	--- a/lib/kolab/kolab_storage.php
	+++ b/lib/kolab/kolab_storage.php
	@@ -1,598 +1,624 @@
	<?php

	/**
	* Kolab storage class providing static methods to access groupware objects on a Kolab server.
	*
	* @version @package_version@
	* @author Thomas Bruederli <bruederli@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 SERVERSIDE_SUBSCRIPTION = 0;
	const CLIENTSIDE_SUBSCRIPTION = 1;

	public static $last_error;

	private static $ready = false;
	private static $config;
	private static $cache;
	private static $imap;


	/**
	* 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::$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);
	}

	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, false, $folderdata) as $foldername) {
	$folders[$foldername] = new kolab_storage_folder($foldername, $folderdata[$foldername]);
	}
	}

	return $folders;
	}


	/**
	* 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
	*
	* @return bool True on success, false on failure
	*/
	public static function folder_create($name, $type = null, $subscribed = false)
	{
	self::setup();

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

	// revert if metadata could not be set
	if (!$saved) {
	self::$imap->delete_folder($name);
	}
	}
	}

	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
	* @return mixed New folder name or False on failure
	*/
	public static function folder_update(&$prop)
	{
	self::setup();

	$folder = rcube_charset::convert($prop['name'], RCMAIL_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, $delimiter) !== 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'] === self::SERVERSIDE_SUBSCRIPTION);
	}

	// save color in METADATA
	// TODO: also save 'showalarams' and other properties here
	- // TODO: change private/shared precedence depending on private or shared folder

	if ($result && $prop['color']) {
	- if (!($meta_saved = self::$imap->set_metadata($folder, array(self::COLOR_KEY_SHARED => $prop['color'])))) // try in shared namespace
	- $meta_saved = self::$imap->set_metadata($folder, array(self::COLOR_KEY_PRIVATE => $prop['color'])); // try in private namespace
	+ $meta_saved = false;
	+ $ns = self::$imap->folder_namespace($folder);
	+ if ($ns == 'personal') // save in shared namespace for personal folders
	+ $meta_saved = self::$imap->set_metadata($folder, array(self::COLOR_KEY_SHARED => $prop['color']));
	+ if (!$meta_saved) // try in private namespace
	+ $meta_saved = self::$imap->set_metadata($folder, array(self::COLOR_KEY_PRIVATE => $prop['color']));
	if ($meta_saved)
	unset($prop['color']); // unsetting will prevent fallback to local user prefs
	}

	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();

	$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] = rcube_charset::convert($name, 'UTF7-IMAP');
	}

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

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

	$folders = array_keys($names);
	$names = array();

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

	foreach ($folders as $name) {
	$imap_name = $name;
	$name = $origname = self::object_name($name);

	// 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;
	$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 string Enable to return subscribed folders only
	* @param array Will be filled with folder-types data
	*
	* @return array List of folders
	*/
	public static function list_folders($root = '', $mbox = '*', $filter = null, $subscribed = false, &$folderdata = array())
	{
	if (!self::setup()) {
	return null;
	}

	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;

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

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

	$folderdata = array_map(array('kolab_storage', 'folder_select_metadata'), $folderdata);
	$regexp = '/^' . preg_quote($filter, '/') . '(\..+)?$/';

	// In some conditions we can skip LIST command (?)
	if ($subscribed == false && $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;
	}


	/**
	* Callback for array_map to select the correct annotation value
	*/
	static function folder_select_metadata($types)
	{
	return $types[self::CTYPE_KEY_PRIVATE] ?: $types[self::CTYPE_KEY];
	}

	+
	+ /**
	+ * Returns type of IMAP folder
	+ *
	+ * @param string $folder Folder name (UTF7-IMAP)
	+ *
	+ * @return string Folder type
	+ */
	+ static function folder_type($folder)
	+ {
	+ $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';
	+ }
	+
	}
	diff --git a/lib/kolab/kolab_storage_folder.php b/lib/kolab/kolab_storage_folder.php
	index daa988f..08bf669 100644
	--- a/lib/kolab/kolab_storage_folder.php
	+++ b/lib/kolab/kolab_storage_folder.php
	@@ -1,844 +1,838 @@
	<?php

	/**
	* The kolab_storage_folder class represents an IMAP folder on the Kolab server.
	*
	* @version @package_version@
	* @author Thomas Bruederli <bruederli@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_folder
	{
	/**
	* The folder name.
	* @var string
	*/
	public $name;

	/**
	* The type of this folder.
	* @var string
	*/
	public $type;

	/**
	* Is this folder set to be the default for its type
	* @var boolean
	*/
	public $default = false;

	/**
	* Is this folder set to be default
	* @var boolean
	*/
	public $cache;

	private $type_annotation;
	private $imap;
	private $info;
	private $owner;
	private $resource_uri;
	private $uid2msg = array();


	/**
	* Default constructor
	*/
	function __construct($name, $type = null)
	{
	$this->imap = rcube::get_instance()->get_storage();
	$this->imap->set_options(array('skip_deleted' => true));
	$this->cache = new kolab_storage_cache($this);
	$this->set_folder($name, $type);
	}


	/**
	* Set the IMAP folder this instance connects to
	*
	* @param string The folder name/path
	* @param string Optional folder type if known
	*/
	public function set_folder($name, $ftype = null)
	{
	- if (!$ftype) {
	- $metadata = $this->imap->get_metadata($name, array(kolab_storage::CTYPE_KEY, kolab_storage::CTYPE_KEY_PRIVATE));
	- $this->type_annotation = $metadata[$name][kolab_storage::CTYPE_KEY_PRIVATE] ?: $metadata[$name][kolab_storage::CTYPE_KEY];
	- }
	- else {
	- $this->type_annotation = $ftype;
	- }
	+ $this->type_annotation = $ftype ? $ftype : kolab_storage::folder_type($name);

	list($this->type, $suffix) = explode('.', $this->type_annotation);
	$this->default = $suffix == 'default';
	$this->name = $name;
	$this->resource_uri = null;

	$this->imap->set_folder($this->name);
	$this->cache->set_folder($this);
	}


	/**
	*
	*/
	private function get_folder_info()
	{
	if (!isset($this->info))
	$this->info = $this->imap->folder_info($this->name);

	return $this->info;
	}


	/**
	* Returns IMAP metadata/annotations (GETMETADATA/GETANNOTATION)
	*
	* @param array List of metadata keys to read
	* @return array Metadata entry-value hash array on success, NULL on error
	*/
	public function get_metadata($keys)
	{
	$metadata = $this->imap->get_metadata($this->name, (array)$keys);
	return $metadata[$this->name];
	}


	/**
	* Sets IMAP metadata/annotations (SETMETADATA/SETANNOTATION)
	*
	* @param array $entries Entry-value array (use NULL value as NIL)
	* @return boolean True on success, False on failure
	*/
	public function set_metadata($entries)
	{
	return $this->imap->set_metadata($this->name, $entries);
	}


	/**
	* Returns the owner of the folder.
	*
	* @return string The owner of this folder.
	*/
	public function get_owner()
	{
	// return cached value
	if (isset($this->owner))
	return $this->owner;

	$info = $this->get_folder_info();
	$rcmail = rcube::get_instance();

	switch ($info['namespace']) {
	case 'personal':
	$this->owner = $rcmail->get_user_name();
	break;

	case 'shared':
	$this->owner = 'anonymous';
	break;

	default:
	$owner = '';
	list($prefix, $user) = explode($this->imap->get_hierarchy_delimiter(), $info['name']);
	if (strpos($user, '@') === false) {
	$domain = strstr($rcmail->get_user_name(), '@');
	if (!empty($domain))
	$user .= $domain;
	}
	$this->owner = $user;
	break;
	}

	return $this->owner;
	}


	/**
	* Getter for the name of the namespace to which the IMAP folder belongs
	*
	* @return string Name of the namespace (personal, other, shared)
	*/
	public function get_namespace()
	{
	return $this->imap->folder_namespace($this->name);
	}


	/**
	* Get IMAP ACL information for this folder
	*
	* @return string Permissions as string
	*/
	public function get_myrights()
	{
	$rights = $this->info['rights'];

	if (!is_array($rights))
	$rights = $this->imap->my_rights($this->name);

	return join('', (array)$rights);
	}


	/**
	* Compose a unique resource URI for this IMAP folder
	*/
	public function get_resource_uri()
	{
	if (!empty($this->resource_uri))
	return $this->resource_uri;

	// strip namespace prefix from folder name
	$ns = $this->get_namespace();
	$nsdata = $this->imap->get_namespace($ns);
	if (is_array($nsdata[0]) && strlen($nsdata[0][0]) && strpos($this->name, $nsdata[0][0]) === 0) {
	$subpath = substr($this->name, strlen($nsdata[0][0]));
	if ($ns == 'other') {
	list($user, $suffix) = explode($nsdata[0][1], $subpath);
	$subpath = $suffix;
	}
	}
	else {
	$subpath = $this->name;
	}

	// compose fully qualified ressource uri for this instance
	$this->resource_uri = 'imap://' . urlencode($this->get_owner()) . '@' . $this->imap->options['host'] . '/' . $subpath;
	return $this->resource_uri;
	}

	/**
	* Check subscription status of this folder
	*
	* @param string Subscription type (kolab_storage::SERVERSIDE_SUBSCRIPTION or kolab_storage::CLIENTSIDE_SUBSCRIPTION)
	* @return boolean True if subscribed, false if not
	*/
	public function is_subscribed($type = 0)
	{
	static $subscribed; // local cache

	if ($type == kolab_storage::SERVERSIDE_SUBSCRIPTION) {
	if (!$subscribed)
	$subscribed = $this->imap->list_folders_subscribed();

	return in_array($this->name, $subscribed);
	}
	else if (kolab_storage::CLIENTSIDE_SUBSCRIPTION) {
	// TODO: implement this
	return true;
	}

	return false;
	}

	/**
	* Change subscription status of this folder
	*
	* @param boolean The desired subscription status: true = subscribed, false = not subscribed
	* @param string Subscription type (kolab_storage::SERVERSIDE_SUBSCRIPTION or kolab_storage::CLIENTSIDE_SUBSCRIPTION)
	* @return True on success, false on error
	*/
	public function subscribe($subscribed, $type = 0)
	{
	if ($type == kolab_storage::SERVERSIDE_SUBSCRIPTION) {
	return $subscribed ? $this->imap->subscribe($this->name) : $this->imap->unsubscribe($this->name);
	}
	else {
	// TODO: implement this
	}

	return false;
	}


	/**
	* Get number of objects stored in this folder
	*
	* @param mixed Pseudo-SQL query as list of filter parameter triplets
	* or string with object type (e.g. contact, event, todo, journal, note, configuration)
	* @return integer The number of objects of the given type
	* @see self::select()
	*/
	public function count($type_or_query = null)
	{
	if (!$type_or_query)
	$query = array(array('type','=',$this->type));
	else if (is_string($type_or_query))
	$query = array(array('type','=',$type_or_query));
	else
	$query = $this->_prepare_query((array)$type_or_query);

	// synchronize cache first
	$this->cache->synchronize();

	return $this->cache->count($query);
	}


	/**
	* List all Kolab objects of the given type
	*
	* @param string $type Object type (e.g. contact, event, todo, journal, note, configuration)
	* @return array List of Kolab data objects (each represented as hash array)
	*/
	public function get_objects($type = null)
	{
	if (!$type) $type = $this->type;

	// synchronize caches
	$this->cache->synchronize();

	// fetch objects from cache
	return $this->cache->select(array(array('type','=',$type)));
	}


	/**
	* Select some Kolab objects matching the given query
	*
	* @param array Pseudo-SQL query as list of filter parameter triplets
	* triplet: array('<colname>', '<comparator>', '<value>')
	* @return array List of Kolab data objects (each represented as hash array)
	*/
	public function select($query = array())
	{
	// check query argument
	if (empty($query))
	return $this->get_objects();

	// synchronize caches
	$this->cache->synchronize();

	// fetch objects from cache
	return $this->cache->select($this->_prepare_query($query));
	}


	/**
	* Getter for object UIDs only
	*
	* @param array Pseudo-SQL query as list of filter parameter triplets
	* @return array List of Kolab object UIDs
	*/
	public function get_uids($query = array())
	{
	// synchronize caches
	$this->cache->synchronize();

	// fetch UIDs from cache
	return $this->cache->select($this->_prepare_query($query), true);
	}


	/**
	* Helper method to sanitize query arguments
	*/
	private function _prepare_query($query)
	{
	$type = null;
	foreach ($query as $i => $param) {
	if ($param[0] == 'type') {
	$type = $param[2];
	}
	else if (($param[0] == 'dtstart' \|\| $param[0] == 'dtend' \|\| $param[0] == 'changed')) {
	if (is_object($param[2]) && is_a($param[2], 'DateTime'))
	$param[2] = $param[2]->format('U');
	if (is_numeric($param[2]))
	$query[$i][2] = date('Y-m-d H:i:s', $param[2]);
	}
	}

	// add type selector if not in $query
	if (!$type)
	$query[] = array('type','=',$this->type);

	return $query;
	}


	/**
	* Getter for a single Kolab object, identified by its UID
	*
	* @param string Object UID
	* @return array The Kolab object represented as hash array
	*/
	public function get_object($uid)
	{
	// synchronize caches
	$this->cache->synchronize();

	$msguid = $this->cache->uid2msguid($uid);
	if ($msguid && ($object = $this->cache->get($msguid)))
	return $object;

	return false;
	}


	/**
	* Fetch a Kolab object attachment which is stored in a separate part
	* of the mail MIME message that represents the Kolab record.
	*
	* @param string Object's UID
	* @param string The attachment's mime number
	* @param string IMAP folder where message is stored;
	* If set, that also implies that the given UID is an IMAP UID
	* @return mixed The attachment content as binary string
	*/
	public function get_attachment($uid, $part, $mailbox = null)
	{
	if ($msguid = ($mailbox ? $uid : $this->cache->uid2msguid($uid))) {
	$this->imap->set_folder($mailbox ? $mailbox : $this->name);
	return $this->imap->get_message_part($msguid, $part);
	}

	return null;
	}


	/**
	* Fetch the mime message from the storage server and extract
	* the Kolab groupware object from it
	*
	* @param string The IMAP message UID to fetch
	* @param string The object type expected (use wildcard '*' to accept all types)
	* @param string The folder name where the message is stored
	* @return mixed Hash array representing the Kolab object, a kolab_format instance or false if not found
	*/
	public function read_object($msguid, $type = null, $folder = null)
	{
	if (!$type) $type = $this->type;
	if (!$folder) $folder = $this->name;

	$this->imap->set_folder($folder);

	$headers = $this->imap->get_message_headers($msguid);

	// Message doesn't exist?
	if (empty($headers)) {
	return false;
	}

	$object_type = kolab_format::mime2object_type($headers->others['x-kolab-type']);
	$content_type = kolab_format::KTYPE_PREFIX . $object_type;

	// check object type header and abort on mismatch
	if ($type != '*' && $object_type != $type)
	return false;

	$message = new rcube_message($msguid);
	$attachments = array();

	// get XML part
	foreach ((array)$message->attachments as $part) {
	if (!$xml && ($part->mimetype == $content_type \|\| preg_match('!application/([a-z]+\+)?xml!', $part->mimetype))) {
	$xml = $part->body ? $part->body : $message->get_part_content($part->mime_id);
	}
	else if ($part->filename \|\| $part->content_id) {
	$key = $part->content_id ? trim($part->content_id, '<>') : $part->filename;
	$attachments[$key] = array(
	'id' => $part->mime_id,
	'name' => $part->filename,
	'mimetype' => $part->mimetype,
	'size' => $part->size,
	);
	}
	}

	if (!$xml) {
	rcube::raise_error(array(
	'code' => 600,
	'type' => 'php',
	'file' => __FILE__,
	'line' => __LINE__,
	'message' => "Could not find Kolab data part in message $msguid ($this->name).",
	), true);
	return false;
	}

	$format = kolab_format::factory($object_type);

	if (is_a($format, 'PEAR_Error'))
	return false;

	// check kolab format version
	$mime_version = $headers->others['x-kolab-mime-version'];
	if (empty($mime_version)) {
	list($xmltype, $subtype) = explode('.', $object_type);
	$xmlhead = substr($xml, 0, 512);

	// detect old Kolab 2.0 format
	if (strpos($xmlhead, '<' . $xmltype) !== false && strpos($xmlhead, 'xmlns=') === false)
	$mime_version = 2.0;
	else
	$mime_version = 3.0; // assume 3.0
	}

	if ($mime_version <= 2.0) {
	// read Kolab 2.0 format
	$handler = class_exists('Horde_Kolab_Format') ? Horde_Kolab_Format::factory('XML', $xmltype, array('subtype' => $subtype)) : null;
	if (!is_object($handler) \|\| is_a($handler, 'PEAR_Error')) {
	return false;
	}

	// XML-to-array
	$object = $handler->load($xml);
	$format->fromkolab2($object);
	}
	else {
	// load Kolab 3 format using libkolabxml
	$format->load($xml);
	}

	if ($format->is_valid()) {
	$object = $format->to_array();
	$object['_type'] = $object_type;
	$object['_msguid'] = $msguid;
	$object['_mailbox'] = $this->name;
	$object['_attachments'] = array_merge((array)$object['_attachments'], $attachments);
	$object['_formatobj'] = $format;

	return $object;
	}
	else {
	// try to extract object UID from XML block
	if (preg_match('!<uid>(.+)</uid>!Uims', $xml, $m))
	$msgadd = " UID = " . trim(strip_tags($m[1]));

	rcube::raise_error(array(
	'code' => 600,
	'type' => 'php',
	'file' => __FILE__,
	'line' => __LINE__,
	'message' => "Could not parse Kolab object data in message $msguid ($this->name)." . $msgadd,
	), true);
	}

	return false;
	}


	/**
	* Save an object in this folder.
	*
	* @param array $object The array that holds the data of the object.
	* @param string $type The type of the kolab object.
	* @param string $uid The UID of the old object if it existed before
	* @return boolean True on success, false on error
	*/
	public function save(&$object, $type = null, $uid = null)
	{
	if (!$type)
	$type = $this->type;

	// copy attachments from old message
	if (!empty($object['_msguid']) && ($old = $this->cache->get($object['_msguid'], $type, $object['_mailbox']))) {
	foreach ((array)$old['_attachments'] as $key => $att) {
	if (!isset($object['_attachments'][$key])) {
	$object['_attachments'][$key] = $old['_attachments'][$key];
	}
	// unset deleted attachment entries
	if ($object['_attachments'][$key] == false) {
	unset($object['_attachments'][$key]);
	}
	// load photo.attachment from old Kolab2 format to be directly embedded in xcard block
	else if ($key == 'photo.attachment' && !isset($object['photo']) && !$object['_attachments'][$key]['content'] && $att['id']) {
	$object['photo'] = $this->get_attachment($object['_msguid'], $att['id'], $object['_mailbox']);
	unset($object['_attachments'][$key]);
	}
	}
	}

	// generate unique keys (used as content-id) for attachments
	if (is_array($object['_attachments'])) {
	$numatt = count($object['_attachments']);
	foreach ($object['_attachments'] as $key => $attachment) {
	if (is_numeric($key) && $key < $numatt) {
	// derrive content-id from attachment file name
	$ext = preg_match('/(\.[a-z0-9]{1,6})$/i', $attachment['name'], $m) ? $m[1] : null;
	$basename = preg_replace('/[^a-z0-9_.-]/i', '', basename($attachment['name'], $ext)); // to 7bit ascii
	if (!$basename) $basename = 'noname';
	$cid = $basename . '.' . microtime(true) . $ext;

	$object['_attachments'][$cid] = $attachment;
	unset($object['_attachments'][$key]);
	}
	}
	}

	if ($raw_msg = $this->build_message($object, $type)) {
	$result = $this->imap->save_message($this->name, $raw_msg, '', false);

	// delete old message
	if ($result && !empty($object['_msguid']) && !empty($object['_mailbox'])) {
	$this->imap->delete_message($object['_msguid'], $object['_mailbox']);
	$this->cache->set($object['_msguid'], false, $object['_mailbox']);
	}
	else if ($result && $uid && ($msguid = $this->cache->uid2msguid($uid))) {
	$this->imap->delete_message($msguid, $this->name);
	$this->cache->set($object['_msguid'], false);
	}

	// update cache with new UID
	if ($result) {
	$object['_msguid'] = $result;
	$this->cache->insert($result, $object);
	}
	}

	return $result;
	}


	/**
	* Delete the specified object from this folder.
	*
	* @param mixed $object The Kolab object to delete or object UID
	* @param boolean $expunge Should the folder be expunged?
	*
	* @return boolean True if successful, false on error
	*/
	public function delete($object, $expunge = true)
	{
	$msguid = is_array($object) ? $object['_msguid'] : $this->cache->uid2msguid($object);
	$success = false;

	if ($msguid && $expunge) {
	$success = $this->imap->delete_message($msguid, $this->name);
	}
	else if ($msguid) {
	$success = $this->imap->set_flag($msguid, 'DELETED', $this->name);
	}

	if ($success) {
	$this->cache->set($msguid, false);
	}

	return $success;
	}


	/**
	*
	*/
	public function delete_all()
	{
	$this->cache->purge();
	return $this->imap->clear_folder($this->name);
	}


	/**
	* Restore a previously deleted object
	*
	* @param string Object UID
	* @return mixed Message UID on success, false on error
	*/
	public function undelete($uid)
	{
	if ($msguid = $this->cache->uid2msguid($uid, true)) {
	if ($this->imap->set_flag($msguid, 'UNDELETED', $this->name)) {
	return $msguid;
	}
	}

	return false;
	}


	/**
	* Move a Kolab object message to another IMAP folder
	*
	* @param string Object UID
	* @param string IMAP folder to move object to
	* @return boolean True on success, false on failure
	*/
	public function move($uid, $target_folder)
	{
	if ($msguid = $this->cache->uid2msguid($uid)) {
	if ($success = $this->imap->move_message($msguid, $target_folder, $this->name)) {
	$this->cache->move($msguid, $uid, $target_folder);
	return true;
	}
	else {
	rcube::raise_error(array(
	'code' => 600, 'type' => 'php',
	'file' => __FILE__, 'line' => __LINE__,
	'message' => "Failed to move message $msguid to $target_folder: " . $this->imap->get_error_str(),
	), true);
	}
	}

	return false;
	}


	/**
	* Creates source of the configuration object message
	*/
	private function build_message(&$object, $type)
	{
	// load old object to preserve data we don't understand/process
	if (is_object($object['_formatobj']))
	$format = $object['_formatobj'];
	else if ($object['_msguid'] && ($old = $this->cache->get($object['_msguid'], $type, $object['_mailbox'])))
	$format = $old['_formatobj'];

	// create new kolab_format instance
	if (!$format)
	$format = kolab_format::factory($type);

	if (PEAR::isError($format))
	return false;

	$format->set($object);
	$xml = $format->write();
	$object['uid'] = $format->uid; // read UID from format
	$object['_formatobj'] = $format;

	if (!$format->is_valid() \|\| empty($object['uid'])) {
	return false;
	}

	$mime = new Mail_mime("\r\n");
	$rcmail = rcube::get_instance();
	$headers = array();
	$part_id = 1;

	if ($ident = $rcmail->user->get_identity()) {
	$headers['From'] = $ident['email'];
	$headers['To'] = $ident['email'];
	}
	$headers['Date'] = date('r');
	$headers['X-Kolab-Type'] = kolab_format::KTYPE_PREFIX . $type;
	$headers['X-Kolab-Mime-Version'] = kolab_format::VERSION;
	$headers['Subject'] = $object['uid'];
	// $headers['Message-ID'] = $rcmail->gen_message_id();
	$headers['User-Agent'] = $rcmail->config->get('useragent');

	$mime->headers($headers);
	$mime->setTXTBody('This is a Kolab Groupware object. '
	. 'To view this object you will need an email client that understands the Kolab Groupware format. '
	. "For a list of such email clients please visit http://www.kolab.org/\n\n");

	$mime->addAttachment($xml, // file
	$format->CTYPE, // content-type
	'kolab.xml', // filename
	false, // is_file
	'8bit', // encoding
	'attachment', // disposition
	RCMAIL_CHARSET // charset
	);
	$part_id++;

	// save object attachments as separate parts
	// TODO: optimize memory consumption by using tempfiles for transfer
	foreach ((array)$object['_attachments'] as $key => $att) {
	if (empty($att['content']) && !empty($att['id'])) {
	$msguid = !empty($object['_msguid']) ? $object['_msguid'] : $object['uid'];
	$att['content'] = $this->get_attachment($msguid, $att['id'], $object['_mailbox']);
	}

	$headers = array('Content-ID' => Mail_mimePart::encodeHeader('Content-ID', '<' . $key . '>', RCMAIL_CHARSET, 'quoted-printable'));
	$name = !empty($att['name']) ? $att['name'] : $key;

	if (!empty($att['content'])) {
	$mime->addAttachment($att['content'], $att['mimetype'], $name, false, 'base64', 'attachment', '', '', '', null, null, '', RCMAIL_CHARSET, $headers);
	$part_id++;
	}
	else if (!empty($att['path'])) {
	$mime->addAttachment($att['path'], $att['mimetype'], $name, true, 'base64', 'attachment', '', '', '', null, null, '', RCMAIL_CHARSET, $headers);
	$part_id++;
	}

	$object['_attachments'][$key]['id'] = $part_id;
	}

	return $mime->getMessage();
	}


	/**
	* Triggers any required updates after changes within the
	* folder. This is currently only required for handling free/busy
	* information with Kolab.
	*
	* @return boolean\|PEAR_Error True if successfull.
	*/
	public function trigger()
	{
	$owner = $this->get_owner();
	$result = false;

	switch($this->type) {
	case 'event':
	if ($this->get_namespace() == 'personal') {
	$result = $this->trigger_url(
	sprintf('%s/trigger/%s/%s.pfb', kolab_storage::get_freebusy_server(), $owner, $this->imap->mod_folder($this->name)),
	$this->imap->options['user'],
	$this->imap->options['password']
	);
	}
	break;

	default:
	return true;
	}

	if ($result && is_object($result) && is_a($result, 'PEAR_Error')) {
	return PEAR::raiseError(sprintf("Failed triggering folder %s. Error was: %s",
	$this->name, $result->getMessage()));
	}

	return $result;
	}

	/**
	* Triggers a URL.
	*
	* @param string $url The URL to be triggered.
	* @param string $auth_user Username to authenticate with
	* @param string $auth_passwd Password for basic auth
	* @return boolean\|PEAR_Error True if successfull.
	*/
	private function trigger_url($url, $auth_user = null, $auth_passwd = null)
	{
	require_once('HTTP/Request2.php');

	try {
	$rcmail = rcube::get_instance();
	$request = new HTTP_Request2($url);
	$request->setConfig(array('ssl_verify_peer' => $rcmail->config->get('kolab_ssl_verify_peer', true)));

	// set authentication credentials
	if ($auth_user && $auth_passwd)
	$request->setAuth($auth_user, $auth_passwd);

	$result = $request->send();
	// rcube::write_log('trigger', $result->getBody());
	}
	catch (Exception $e) {
	return PEAR::raiseError($e->getMessage());
	}

	return true;
	}

	}

File Metadata

Mime Type: text/x-diff
Expires: Fri, Mar 20, 4:56 AM (1 d, 21 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 458860
Default Alt Text: (53 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions