kolab_folders.php
No OneTemporary
Actions

Authored By

Unknown

Size

20 KB

Referenced Files

None

Subscribers

None

kolab_folders.php
View Options

	<?php

	/**
	* Type-aware folder management/listing for Kolab
	*
	* @version @package_version@
	* @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_folders extends rcube_plugin
	{
	public $task = '?(?!login).*';

	public $types = array('mail', 'event', 'journal', 'task', 'note', 'contact', 'configuration');
	public $mail_types = array('inbox', 'drafts', 'sentitems', 'outbox', 'wastebasket', 'junkemail');
	private $rc;

	const CTYPE_KEY = '/shared/vendor/kolab/folder-type';


	/**
	* Plugin initialization.
	*/
	function init()
	{
	$this->rc = rcmail::get_instance();

	// Folder listing hooks
	$this->add_hook('storage_folders', array($this, 'mailboxes_list'));

	// Folder manager hooks
	$this->add_hook('folder_form', array($this, 'folder_form'));
	$this->add_hook('folder_update', array($this, 'folder_save'));
	$this->add_hook('folder_create', array($this, 'folder_save'));
	$this->add_hook('folder_delete', array($this, 'folder_save'));
	$this->add_hook('folder_rename', array($this, 'folder_save'));
	$this->add_hook('folders_list', array($this, 'folders_list'));
	}

	/**
	* Handler for mailboxes_list hook. Enables type-aware lists filtering.
	*/
	function mailboxes_list($args)
	{
	if (!$this->metadata_support()) {
	return $args;
	}

	$filter = $args['filter'];

	// all-folders request, use core method
	if (!$filter) {
	return $args;
	}

	// get folders types
	$folderdata = $this->get_folder_type_list($args['root'].$args['name'], true);

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

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

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

	$storage = $this->rc->get_storage();

	// Get folders list
	if ($args['mode'] == 'LIST') {
	$args['folders'] = $storage->conn->listMailboxes($args['root'], $args['name']);
	}
	else {
	$args['folders'] = $this->list_subscribed($args['root'], $args['name']);
	}

	// In case of an error, return empty list
	if (!is_array($args['folders'])) {
	$args['folders'] = array();
	return $args;
	}

	// Filter folders list
	foreach ($args['folders'] as $idx => $folder) {
	$type = $folderdata[$folder];
	if ($filter == 'mail' && empty($type)) {
	continue;
	}
	if (empty($type) \|\| !preg_match($regexp, $type)) {
	unset($args['folders'][$idx]);
	}
	}

	return $args;
	}

	/**
	* Handler for folders_list hook. Add css classes to folder rows.
	*/
	function folders_list($args)
	{
	if (!$this->metadata_support()) {
	return $args;
	}

	$table = $args['table'];

	// get folders types
	$folderdata = $this->get_folder_type_list('*');

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

	// Add type-based style for table rows
	// See kolab_folders::folder_class_name()
	for ($i=1, $cnt=$table->size(); $i<=$cnt; $i++) {
	$attrib = $table->get_row_attribs($i);
	$folder = $attrib['foldername']; // UTF7-IMAP
	$type = $folderdata[$folder];

	if (!$type)
	$type = 'mail';

	$class_name = self::folder_class_name($type);

	$attrib['class'] = trim($attrib['class'] . ' ' . $class_name);
	$table->set_row_attribs($attrib, $i);
	}

	return $args;
	}

	/**
	* Handler for folder info/edit form (folder_form hook).
	* Adds folder type selector.
	*/
	function folder_form($args)
	{
	if (!$this->metadata_support()) {
	return $args;
	}
	// load translations
	$this->add_texts('localization/', false);

	// INBOX folder is of type mail.inbox and this cannot be changed
	if ($args['name'] == 'INBOX') {
	$args['form']['props']['fieldsets']['settings']['content']['foldertype'] = array(
	'label' => $this->gettext('folderctype'),
	'value' => sprintf('%s (%s)', $this->gettext('foldertypemail'), $this->gettext('inbox')),
	);

	return $args;
	}

	if ($args['options']['is_root']) {
	return $args;
	}

	$mbox = strlen($args['name']) ? $args['name'] : $args['parent_name'];

	if (isset($_POST['_ctype'])) {
	$new_ctype = trim(get_input_value('_ctype', RCUBE_INPUT_POST));
	$new_subtype = trim(get_input_value('_subtype', RCUBE_INPUT_POST));
	}

	// Get type of the folder or the parent
	if (strlen($mbox)) {
	list($ctype, $subtype) = $this->get_folder_type($mbox);
	if (strlen($args['parent_name']) && $subtype == 'default')
	$subtype = ''; // there can be only one
	}

	if (!$ctype) {
	$ctype = 'mail';
	}

	$storage = $this->rc->get_storage();

	// Don't allow changing type of shared folder, according to ACL
	if (strlen($mbox)) {
	$options = $storage->folder_info($mbox);
	if ($options['namespace'] != 'personal' && !in_array('a', $options['rights'])) {
	if (in_array($ctype, $this->types)) {
	$value = $this->gettext('foldertype'.$ctype);
	}
	else {
	$value = $ctype;
	}
	if ($subtype) {
	$value .= ' ('. ($subtype == 'default' ? $this->gettext('default') : $subtype) .')';
	}

	$args['form']['props']['fieldsets']['settings']['content']['foldertype'] = array(
	'label' => $this->gettext('folderctype'),
	'value' => $value,
	);

	return $args;
	}
	}

	// Add javascript script to the client
	$this->include_script('kolab_folders.js');

	// build type SELECT fields
	$type_select = new html_select(array('name' => '_ctype', 'id' => '_ctype'));
	$sub_select = new html_select(array('name' => '_subtype', 'id' => '_subtype'));

	foreach ($this->types as $type) {
	$type_select->add($this->gettext('foldertype'.$type), $type);
	}
	// add non-supported type
	if (!in_array($ctype, $this->types)) {
	$type_select->add($ctype, $ctype);
	}

	$sub_select->add('', '');
	$sub_select->add($this->gettext('default'), 'default');
	foreach ($this->mail_types as $type) {
	$sub_select->add($this->gettext($type), $type);
	}

	$args['form']['props']['fieldsets']['settings']['content']['foldertype'] = array(
	'label' => $this->gettext('folderctype'),
	'value' => $type_select->show(isset($new_ctype) ? $new_ctype : $ctype)
	. $sub_select->show(isset($new_subtype) ? $new_subtype : $subtype),
	);

	return $args;
	}

	/**
	* Handler for folder update/create action (folder_update/folder_create hook).
	*/
	function folder_save($args)
	{
	// Folder actions from folders list
	if (empty($args['record'])) {
	// Just clear Horde folders cache and return
	$this->clear_folders_cache();
	return $args;
	}

	// Folder create/update with form
	$ctype = trim(get_input_value('_ctype', RCUBE_INPUT_POST));
	$subtype = trim(get_input_value('_subtype', RCUBE_INPUT_POST));
	$mbox = $args['record']['name'];
	$old_mbox = $args['record']['oldname'];
	$subscribe = $args['record']['subscribe'];

	if (empty($ctype)) {
	return $args;
	}

	// load translations
	$this->add_texts('localization/', false);

	// Skip folder creation/rename in core
	// @TODO: Maybe we should provide folder_create_after and folder_update_after hooks?
	// Using create_mailbox/rename_mailbox here looks bad
	$args['abort'] = true;

	// There can be only one default folder of specified type
	if ($subtype == 'default') {
	$default = $this->get_default_folder($ctype);

	if ($default !== null && $old_mbox != $default) {
	$args['result'] = false;
	$args['message'] = $this->gettext('defaultfolderexists');
	return $args;
	}
	}
	// Subtype sanity-checks
	else if ($subtype && ($ctype != 'mail' \|\| !in_array($subtype, $this->mail_types))) {
	$subtype = '';
	}

	$ctype .= $subtype ? '.'.$subtype : '';

	$storage = $this->rc->get_storage();

	// Create folder
	if (!strlen($old_mbox)) {
	// By default don't subscribe to non-mail folders
	if ($subscribe)
	$subscribe = (bool) preg_match('/^mail/', $ctype);

	$result = $storage->create_folder($mbox, $subscribe);
	// Set folder type
	if ($result) {
	$this->set_folder_type($mbox, $ctype);
	}
	}
	// Rename folder
	else {
	if ($old_mbox != $mbox) {
	$result = $storage->rename_folder($old_mbox, $mbox);
	}
	else {
	$result = true;
	}

	if ($result) {
	list($oldtype, $oldsubtype) = $this->get_folder_type($mbox);
	$oldtype .= $oldsubtype ? '.'.$oldsubtype : '';

	if ($ctype != $oldtype) {
	$this->set_folder_type($mbox, $ctype);
	}
	}
	}

	// Clear Horde folders cache
	if ($result) {
	$this->clear_folders_cache();
	}

	$args['record']['class'] = self::folder_class_name($ctype);
	$args['record']['subscribe'] = $subscribe;
	$args['result'] = $result;

	return $args;
	}

	/**
	* Checks if IMAP server supports any of METADATA, ANNOTATEMORE, ANNOTATEMORE2
	*
	* @return boolean
	*/
	function metadata_support()
	{
	$storage = $this->rc->get_storage();

	return $storage->get_capability('METADATA') \|\|
	$storage->get_capability('ANNOTATEMORE') \|\|
	$storage->get_capability('ANNOTATEMORE2');
	}

	/**
	* Checks if IMAP server supports any of METADATA, ANNOTATEMORE, ANNOTATEMORE2
	*
	* @param string $folder Folder name
	*
	* @return array Folder content-type
	*/
	function get_folder_type($folder)
	{
	$storage = $this->rc->get_storage();
	$folderdata = $storage->get_metadata($folder, array(kolab_folders::CTYPE_KEY));

	return explode('.', $folderdata[$folder][kolab_folders::CTYPE_KEY]);
	}

	/**
	* Sets folder content-type.
	*
	* @param string $folder Folder name
	* @param string $type Content type
	*
	* @return boolean True on success
	*/
	function set_folder_type($folder, $type='mail')
	{
	$storage = $this->rc->get_storage();

	return $storage->set_metadata($folder, array(kolab_folders::CTYPE_KEY => $type));
	}

	/**
	* Returns list of subscribed folders (directly from IMAP server)
	*
	* @param string $root Optional root folder
	* @param string $name Optional name pattern
	*
	* @return array List of mailboxes/folders
	*/
	private function list_subscribed($root='', $name='*')
	{
	$storage = $this->rc->get_storage();

	// Code copied from rcube_imap::_list_mailboxes()
	// Server supports LIST-EXTENDED, we can use selection options
	// #1486225: Some dovecot versions returns wrong result using LIST-EXTENDED
	if (!$this->rc->config->get('imap_force_lsub') && $storage->get_capability('LIST-EXTENDED')) {
	// This will also set mailbox options, LSUB doesn't do that
	$a_folders = $storage->conn->listMailboxes($root, $name,
	NULL, array('SUBSCRIBED'));

	// remove non-existent folders
	if (is_array($a_folders) && $name = '*') {
	foreach ($a_folders as $idx => $folder) {
	if ($storage->conn->data['LIST'] && ($opts = $storage->conn->data['LIST'][$folder])
	&& in_array('\\NonExistent', $opts)
	) {
	$storage->conn->unsubscribe($folder);
	unset($a_folders[$idx]);
	}
	}
	}
	}
	// retrieve list of folders from IMAP server using LSUB
	else {
	$a_folders = $storage->conn->listSubscribed($root, $name);

	// unsubscribe non-existent folders, remove from the list
	if (is_array($a_folders) && $name == '*') {
	foreach ($a_folders as $idx => $folder) {
	if ($storage->conn->data['LIST'] && ($opts = $storage->conn->data['LIST'][$folder])
	&& in_array('\\Noselect', $opts)
	) {
	// Some servers returns \Noselect for existing folders
	if (!$storage->folder_exists($folder)) {
	$storage->conn->unsubscribe($folder);
	unset($a_folders[$idx]);
	}
	}
	}
	}
	}

	return $a_folders;
	}

	/**
	* Returns list of folder(s) type(s)
	*
	* @param string $mbox Folder name or pattern
	* @param bool $defaults Enables creation of configured default folders
	*
	* @return array List of folders data, indexed by folder name
	*/
	function get_folder_type_list($mbox, $create_defaults = false)
	{
	$storage = $this->rc->get_storage();

	// Use mailboxes. prefix so the cache will be cleared by core
	// together with other mailboxes-related cache data
	$cache_key = 'mailboxes.folder-type.'.$mbox;

	// get cached metadata
	$metadata = $storage->get_cache($cache_key);

	if (!is_array($metadata)) {
	$metadata = $storage->get_metadata($mbox, kolab_folders::CTYPE_KEY);
	$need_update = true;
	}

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

	// make the result more flat
	if ($need_update) {
	$metadata = array_map('implode', $metadata);
	}

	// create default folders if needed
	if ($create_defaults) {
	$this->create_default_folders($metadata, $cache_key);
	}

	// write mailboxlist to cache
	if ($need_update) {
	$storage->update_cache($cache_key, $metadata);
	}

	return $metadata;
	}

	/**
	* Returns the name of default folder
	*
	* @param string $type Folder type
	*
	* @return string Folder name
	*/
	function get_default_folder($type)
	{
	$storage = $this->rc->get_storage();
	$folderdata = $this->get_folder_type_list('*');

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

	$type .= '.default';
	$namespace = $storage->get_namespace();

	// get all folders of specified type
	$folderdata = array_intersect($folderdata, array($type));
	unset($folders[0]);

	foreach ($folderdata as $folder => $data) {
	// check if folder is in personal namespace
	foreach (array('shared', 'other') as $nskey) {
	if (!empty($namespace[$nskey])) {
	foreach ($namespace[$nskey] as $ns) {
	if ($ns[0] && substr($folder, 0, strlen($ns[0])) == $ns[0]) {
	continue 3;
	}
	}
	}
	}

	// There can be only one default folder of specified type
	return $folder;
	}

	return null;
	}

	/**
	* Returns CSS class name for specified folder type
	*
	* @param string $type Folder type
	*
	* @return string Class name
	*/
	static function folder_class_name($type)
	{
	list($ctype, $subtype) = explode('.', $type);

	$class[] = 'type-' . ($ctype ? $ctype : 'mail');

	if ($subtype)
	$class[] = 'subtype-' . $subtype;

	return implode(' ', $class);
	}

	/**
	* Clear Horde's folder cache. See Kolab_List::singleton().
	*/
	private function clear_folders_cache()
	{
	unset($_SESSION['horde_session_objects']['kolab_folderlist']);
	}

	/**
	* Creates default folders if they doesn't exist
	*/
	private function create_default_folders(&$folderdata, $cache_key = null)
	{
	$storage = $this->rc->get_storage();
	$namespace = $storage->get_namespace();
	$defaults = array();
	$need_update = false;

	// Find personal namespace prefix
	if (is_array($namespace['personal']) && count($namespace['personal']) == 1) {
	$prefix = $namespace['personal'][0][0];
	}
	else {
	$prefix = '';
	}

	$this->load_config();

	// get configured defaults
	foreach ($this->types as $type) {
	$subtypes = $type == 'mail' ? $this->mail_types : array('default');
	foreach ($subtypes as $subtype) {
	$opt_name = 'kolab_folders_' . $type . '_' . $subtype;
	if ($folder = $this->rc->config->get($opt_name)) {
	// convert configuration value to UTF7-IMAP charset
	$folder = rcube_charset::convert($folder, RCMAIL_CHARSET, 'UTF7-IMAP');
	// and namespace prefix if needed
	if ($prefix && strpos($folder, $prefix) === false && $folder != 'INBOX') {
	$folder = $prefix . $folder;
	}
	$defaults[$type . '.' . $subtype] = $folder;
	}
	}
	}

	// find default folders
	foreach ($defaults as $type => $foldername) {
	// folder exists, do nothing
	if (!empty($folderdata[$foldername])) {
	continue;
	}

	// special case, need to set type only
	if ($foldername == 'INBOX' \|\| $type == 'mail.inbox') {
	$this->set_folder_type($foldername, 'mail.inbox');
	continue;
	}

	// get all folders of specified type
	$folders = array_intersect($folderdata, array($type));
	unset($folders[0]);

	// find folders in personal namespace
	foreach ($folders as $folder) {
	if ($folder) {
	foreach (array('shared', 'other') as $nskey) {
	if (!empty($namespace[$nskey])) {
	foreach ($namespace[$nskey] as $ns) {
	if ($ns[0] && substr($folder, 0, strlen($ns[0])) == $ns[0]) {
	continue 3;
	}
	}
	}
	}
	}

	// got folder in personal namespace
	continue 2;
	}

	list($type1, $type2) = explode('.', $type);

	// create folder
	if ($type1 != 'mail' \|\| !$storage->folder_exists($foldername)) {
	$storage->create_folder($foldername, $type1 == 'mail');
	}

	// set type
	$result = $this->set_folder_type($foldername, $type);

	// add new folder to the result
	if ($result) {
	$folderdata[$foldername] = $type;
	$need_update = true;
	}
	}

	// update cache
	if ($need_update && $cache_key) {
	$storage->update_cache($cache_key, $folderdata);
	}
	}

	}

File Metadata

Mime Type: text/x-php
Expires: Sat, Apr 4, 9:12 AM (3 w, 1 d ago)
Storage Engine: local-disk
Storage Format: Raw Data
Storage Handle: ba/69/808886ec4aba9bd23c9f53c5c81f
Default Alt Text: kolab_folders.php (20 KB)

kolab_folders.phpNo OneTemporaryActions

kolab_folders.phpView Options

File Metadata

Event Timeline

kolab_folders.php
No OneTemporary
Actions

kolab_folders.php
View Options