folders.inc
No OneTemporary
Actions

Authored By

Unknown

Size

15 KB

Referenced Files

None

Subscribers

None

folders.inc
View Options

	<?php

	/*
	+-----------------------------------------------------------------------+
	\| program/steps/settings/folders.inc \|
	\| \|
	\| This file is part of the Roundcube Webmail client \|
	\| Copyright (C) 2005-2013, The Roundcube Dev Team \|
	\| \|
	\| Licensed under the GNU General Public License version 3 or \|
	\| any later version with exceptions for skins & plugins. \|
	\| See the README file for a full license statement. \|
	\| \|
	\| PURPOSE: \|
	\| Provide functionality of folders management \|
	\| \|
	+-----------------------------------------------------------------------+
	\| Author: Thomas Bruederli <roundcube@gmail.com> \|
	\| Author: Aleksander Machniak <alec@alec.pl> \|
	+-----------------------------------------------------------------------+
	*/

	// WARNING: folder names in UI are encoded with RCUBE_CHARSET

	// init IMAP connection
	$STORAGE = $RCMAIL->get_storage();

	// subscribe mailbox
	if ($RCMAIL->action == 'subscribe') {
	$mbox = rcube_utils::get_input_value('_mbox', rcube_utils::INPUT_POST, true, 'UTF7-IMAP');

	if (strlen($mbox)) {
	$result = $STORAGE->subscribe(array($mbox));

	// Handle virtual (non-existing) folders
	if (!$result && $STORAGE->get_error_code() == -1 &&
	$STORAGE->get_response_code() == rcube_storage::TRYCREATE
	) {
	$result = $STORAGE->create_folder($mbox, true);
	if ($result) {
	// @TODO: remove 'virtual' class of folder's row
	}
	}

	if ($result) {
	// Handle subscription of protected folder (#1487656)
	if ($RCMAIL->config->get('protect_default_folders')
	&& $STORAGE->is_special_folder($mbox)
	) {
	$OUTPUT->command('disable_subscription', $mbox);
	}

	$OUTPUT->show_message('foldersubscribed', 'confirmation');
	}
	else
	$RCMAIL->display_server_error('errorsaving');
	}
	}
	// unsubscribe mailbox
	else if ($RCMAIL->action == 'unsubscribe') {
	$mbox = rcube_utils::get_input_value('_mbox', rcube_utils::INPUT_POST, true, 'UTF7-IMAP');
	if (strlen($mbox)) {
	$result = $STORAGE->unsubscribe(array($mbox));
	if ($result)
	$OUTPUT->show_message('folderunsubscribed', 'confirmation');
	else
	$RCMAIL->display_server_error('errorsaving');
	}
	}
	// delete an existing mailbox
	else if ($RCMAIL->action == 'delete-folder') {
	$mbox_utf8 = rcube_utils::get_input_value('_mbox', rcube_utils::INPUT_POST, true);
	$mbox = rcube_charset::convert($mbox_utf8, RCUBE_CHARSET, 'UTF7-IMAP');

	if (strlen($mbox)) {
	$plugin = $RCMAIL->plugins->exec_hook('folder_delete', array('name' => $mbox));

	if (!$plugin['abort']) {
	$deleted = $STORAGE->delete_folder($plugin['name']);
	}
	else {
	$deleted = $plugin['result'];
	}

	// #1488692: update session
	if ($deleted && $_SESSION['mbox'] === $mbox) {
	$RCMAIL->session->remove('mbox');
	}
	}

	if ($OUTPUT->ajax_call && $deleted) {
	// Remove folder and subfolders rows
	$OUTPUT->command('remove_folder_row', $mbox_utf8, true);
	$OUTPUT->show_message('folderdeleted', 'confirmation');
	// Clear content frame
	$OUTPUT->command('subscription_select');
	$OUTPUT->command('set_quota', $RCMAIL->quota_content());
	}
	else if (!$deleted) {
	$RCMAIL->display_server_error('errorsaving');
	}
	}
	// rename an existing mailbox
	else if ($RCMAIL->action == 'rename-folder') {
	$name_utf8 = trim(rcube_utils::get_input_value('_folder_newname', rcube_utils::INPUT_POST, true));
	$oldname_utf8 = rcube_utils::get_input_value('_folder_oldname', rcube_utils::INPUT_POST, true);

	if (strlen($name_utf8) && strlen($oldname_utf8)) {
	$name = rcube_charset::convert($name_utf8, RCUBE_CHARSET, 'UTF7-IMAP');
	$oldname = rcube_charset::convert($oldname_utf8, RCUBE_CHARSET, 'UTF7-IMAP');

	$rename = rcmail_rename_folder($oldname, $name);
	}

	if ($rename && $OUTPUT->ajax_call) {
	rcmail_update_folder_row($name, $oldname);
	}
	else if (!$rename) {
	$RCMAIL->display_server_error('errorsaving');
	}
	}
	// clear mailbox
	else if ($RCMAIL->action == 'purge') {
	$mbox_utf8 = rcube_utils::get_input_value('_mbox', rcube_utils::INPUT_POST, true);
	$mbox = rcube_charset::convert($mbox_utf8, RCUBE_CHARSET, 'UTF7-IMAP');
	$delimiter = $STORAGE->get_hierarchy_delimiter();
	$trash_mbox = $RCMAIL->config->get('trash_mbox');
	$trash_regexp = '/^' . preg_quote($trash . $delimiter, '/') . '/';

	// we should only be purging trash (or their subfolders)
	if (!strlen($trash_mbox) \|\| $mbox === $trash_mbox
	\|\| preg_match($trash_regexp, $mbox)
	) {
	$success = $STORAGE->delete_message('*', $mbox);
	$delete = true;
	}
	// copy to Trash
	else {
	$success = $STORAGE->move_message('1:*', $trash_mbox, $mbox);
	$delete = false;
	}

	if ($success) {
	$OUTPUT->set_env('messagecount', 0);
	if ($delete) {
	$OUTPUT->show_message('folderpurged', 'confirmation');
	$OUTPUT->command('set_quota', $RCMAIL->quota_content());
	}
	else {
	$OUTPUT->show_message('messagemoved', 'confirmation');
	}
	$_SESSION['unseen_count'][$mbox] = 0;
	$OUTPUT->command('show_folder', $mbox_utf8, null, true);
	}
	else {
	$RCMAIL->display_server_error('errorsaving');
	}
	}
	// get mailbox size
	else if ($RCMAIL->action == 'folder-size') {
	$name = rcube_utils::get_input_value('_mbox', rcube_utils::INPUT_POST, true);

	$size = $STORAGE->folder_size($name);

	// @TODO: check quota and show percentage usage of specified mailbox?

	if ($size !== false) {
	$OUTPUT->command('folder_size_update', $RCMAIL->show_bytes($size));
	}
	else {
	$RCMAIL->display_server_error();
	}
	}

	if ($OUTPUT->ajax_call) {
	$OUTPUT->send();
	}

	$OUTPUT->set_pagetitle($RCMAIL->gettext('folders'));
	$OUTPUT->include_script('list.js');
	$OUTPUT->set_env('prefix_ns', $STORAGE->get_namespace('prefix'));
	if ($STORAGE->get_capability('QUOTA')) {
	$OUTPUT->set_env('quota', true);
	}

	// add some labels to client
	$OUTPUT->add_label('deletefolderconfirm', 'purgefolderconfirm', 'folderdeleting',
	'foldermoving', 'foldersubscribing', 'folderunsubscribing', 'quota');

	// register UI objects
	$OUTPUT->add_handlers(array(
	'foldersubscription' => 'rcube_subscription_form',
	'folderframe' => 'rcmail_folder_frame',
	'quotadisplay' => array($RCMAIL, 'quota_display'),
	));

	$OUTPUT->send('folders');


	// build table with all folders listed by server
	function rcube_subscription_form($attrib)
	{
	global $RCMAIL, $OUTPUT;

	list($form_start, $form_end) = get_form_tags($attrib, 'folders');
	unset($attrib['form']);

	if (!$attrib['id'])
	$attrib['id'] = 'rcmSubscriptionlist';

	$table = new html_table();

	if ($attrib['noheader'] !== true && $attrib['noheader'] != "true") {
	// add table header
	$table->add_header('name', $RCMAIL->gettext('foldername'));
	$table->add_header('subscribed', '');
	}

	$STORAGE = $RCMAIL->get_storage();

	// get folders from server
	$STORAGE->clear_cache('mailboxes', true);

	$a_unsubscribed = $STORAGE->list_folders();
	$a_subscribed = $STORAGE->list_folders_subscribed('', '*', null, null, true); // unsorted
	$delimiter = $STORAGE->get_hierarchy_delimiter();
	$namespace = $STORAGE->get_namespace();
	$special_folders = array_flip(array_merge(array('inbox' => 'INBOX'), $STORAGE->get_special_folders()));
	$protect_default = $RCMAIL->config->get('protect_default_folders');
	$a_js_folders = array();
	$seen = array();
	$list_folders = array();

	// pre-process folders list
	foreach ($a_unsubscribed as $i => $folder) {
	$folder_id = $folder;
	$folder = $STORAGE->mod_folder($folder);
	$foldersplit = explode($delimiter, $folder);
	$name = rcube_charset::convert(array_pop($foldersplit), 'UTF7-IMAP');
	$parent_folder = join($delimiter, $foldersplit);
	$level = count($foldersplit);

	// add any necessary "virtual" parent folders
	if ($parent_folder && !isset($seen[$parent_folder])) {
	for ($i=1; $i<=$level; $i++) {
	$ancestor_folder = join($delimiter, array_slice($foldersplit, 0, $i));
	if ($ancestor_folder && !$seen[$ancestor_folder]++) {
	$ancestor_name = rcube_charset::convert($foldersplit[$i-1], 'UTF7-IMAP');
	$list_folders[] = array(
	'id' => $ancestor_folder,
	'name' => $ancestor_name,
	'level' => $i-1,
	'virtual' => true,
	);
	}
	}
	}

	// Handle properly INBOX.INBOX situation
	if (isset($seen[$folder])) {
	continue;
	}

	$seen[$folder]++;

	$list_folders[] = array(
	'id' => $folder_id,
	'name' => $name,
	'level' => $level,
	);
	}

	unset($seen);

	// add drop-target representing 'root'
	$table->add_row(array('id' => 'mailboxroot', 'class' => 'virtual root'));
	$table->add('name', ' ');
	$table->add(null, ' ');

	$a_js_folders['mailboxroot'] = array('', '', true);

	$checkbox_subscribe = new html_checkbox(array(
	'name' => '_subscribed[]',
	'title' => $RCMAIL->gettext('changesubscription'),
	'onclick' => rcmail_output::JS_OBJECT_NAME.".command(this.checked?'subscribe':'unsubscribe',this.value)",
	));

	// create list of available folders
	foreach ($list_folders as $i => $folder) {
	$idx = $i + 1;
	$sub_key = array_search($folder['id'], $a_subscribed);
	$subscribed = $sub_key !== false;
	$protected = $protect_default && isset($special_folders[$folder['id']]);
	$noselect = false;
	$classes = array($i%2 ? 'even' : 'odd');

	$folder_utf8 = rcube_charset::convert($folder['id'], 'UTF7-IMAP');
	$display_folder = str_repeat('    ', $folder['level'])
	. rcube::Q($protected ? $RCMAIL->localize_foldername($folder['id']) : $folder['name']);

	if ($folder['virtual']) {
	$classes[] = 'virtual';
	}

	// Check \Noselect flag (of existing folder)
	if (!$protected && in_array($folder['id'], $a_unsubscribed)) {
	$attrs = $STORAGE->folder_attributes($folder['id']);
	$noselect = in_array('\\Noselect', $attrs);
	}

	$disabled = (($protected && $subscribed) \|\| $noselect);

	// Below we will disable subscription option for "virtual" folders
	// according to namespaces, but only if they aren't already subscribed.
	// User should be able to unsubscribe from the folder
	// even if it doesn't exists or is not accessible (OTRS:1000059)
	if (!$subscribed && !$disabled && !empty($namespace) && $folder['virtual']) {
	// check if the folder is a namespace prefix, then disable subscription option on it
	if (!$disabled && $folder['level'] == 0) {
	$fname = $folder['id'] . $delimiter;
	foreach ($namespace as $ns) {
	if (is_array($ns)) {
	foreach ($ns as $item) {
	if ($item[0] === $fname) {
	$disabled = true;
	break 2;
	}
	}
	}
	}
	}
	// check if the folder is an other users virtual-root folder, then disable subscription option on it
	if (!$disabled && $folder['level'] == 1 && !empty($namespace['other'])) {
	$parts = explode($delimiter, $folder['id']);
	$fname = $parts[0] . $delimiter;
	foreach ($namespace['other'] as $item) {
	if ($item[0] === $fname) {
	$disabled = true;
	break;
	}
	}
	}
	// check if the folder is shared, then disable subscription option on it (if not subscribed already)
	if (!$disabled) {
	$tmp_ns = array_merge((array)$namespace['other'], (array)$namespace['shared']);
	foreach ($tmp_ns as $item) {
	if (strpos($folder['id'], $item[0]) === 0) {
	$disabled = true;
	break;
	}
	}
	}
	}

	$table->add_row(array('id' => 'rcmrow'.$idx, 'class' => join(' ', $classes),
	'foldername' => $folder['id']));

	$table->add('name', $display_folder);
	$table->add('subscribed', $checkbox_subscribe->show(($subscribed ? $folder_utf8 : ''),
	array('value' => $folder_utf8, 'disabled' => $disabled ? 'disabled' : '')));

	$a_js_folders['rcmrow'.$idx] = array($folder_utf8,
	$display_folder, $protected \|\| $folder['virtual']);
	}

	$RCMAIL->plugins->exec_hook('folders_list', array('table' => $table));

	$OUTPUT->add_gui_object('subscriptionlist', $attrib['id']);
	$OUTPUT->set_env('subscriptionrows', $a_js_folders);
	$OUTPUT->set_env('defaultfolders', array_keys($special_folders));
	$OUTPUT->set_env('delimiter', $delimiter);

	return $form_start . $table->show($attrib) . $form_end;
	}

	function rcmail_folder_frame($attrib)
	{
	global $OUTPUT;

	if (!$attrib['id']) {
	$attrib['id'] = 'rcmfolderframe';
	}

	return $OUTPUT->frame($attrib, true);
	}

	function rcmail_rename_folder($oldname, $newname)
	{
	global $RCMAIL;

	$storage = $RCMAIL->get_storage();
	$delimiter = $storage->get_hierarchy_delimiter();

	$plugin = $RCMAIL->plugins->exec_hook('folder_rename', array(
	'oldname' => $oldname, 'newname' => $newname));

	if (!$plugin['abort']) {
	$renamed = $storage->rename_folder($oldname, $newname);
	}
	else {
	$renamed = $plugin['result'];
	}

	// update per-folder options for modified folder and its subfolders
	if ($renamed) {
	$a_threaded = (array) $RCMAIL->config->get('message_threading', array());
	$oldprefix = '/^' . preg_quote($oldname . $delimiter, '/') . '/';

	foreach (array_keys($a_threaded) as $key) {
	if ($key == $oldname) {
	unset($a_threaded[$key]);
	$a_threaded[$newname] = true;
	}
	else if (preg_match($oldprefix, $key)) {
	unset($a_threaded[$key]);
	$a_threaded[preg_replace($oldprefix, $newname.$delimiter, $key)] = true;
	}
	}
	$RCMAIL->user->save_prefs(array('message_threading' => $a_threaded));

	// #1488692: update session
	if ($_SESSION['mbox'] === $oldname) {
	$_SESSION['mbox'] = $newname;
	}

	return true;
	}

	return false;
	}

File Metadata

Mime Type: text/x-php
Expires: Sun, Apr 5, 11:17 PM (1 w, 6 d ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 18831544
Default Alt Text: folders.inc (15 KB)

folders.incNo OneTemporaryActions

folders.incView Options

File Metadata

Event Timeline

folders.inc
No OneTemporary
Actions

folders.inc
View Options