From 15cf4fa9251f01313b5eb5cf1a91ec10643d42cb Mon Sep 17 00:00:00 2001
From: Aleksander Machniak <alec@alec.pl>
Date: Wed, 21 Nov 2012 13:55:34 -0500
Subject: [PATCH] Rename rcube_bc.inc to bc.php for consistency
---
program/steps/settings/folders.inc | 264 +++++++++++++++++++++++++++++++++-------------------
1 files changed, 165 insertions(+), 99 deletions(-)
diff --git a/program/steps/settings/folders.inc b/program/steps/settings/folders.inc
index 1ceca74..0c7d906 100644
--- a/program/steps/settings/folders.inc
+++ b/program/steps/settings/folders.inc
@@ -5,8 +5,11 @@
| program/steps/settings/folders.inc |
| |
| This file is part of the Roundcube Webmail client |
- | Copyright (C) 2005-2009, Roundcube Dev. - Switzerland |
- | Licensed under the GNU GPL |
+ | Copyright (C) 2005-2009, 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 |
@@ -15,37 +18,42 @@
| Author: Thomas Bruederli <roundcube@gmail.com> |
| Author: Aleksander Machniak <alec@alec.pl> |
+-----------------------------------------------------------------------+
-
- $Id$
-
*/
// WARNING: folder names in UI are encoded with RCMAIL_CHARSET
// init IMAP connection
-$RCMAIL->imap_connect();
+$STORAGE = $RCMAIL->get_storage();
// subscribe mailbox
if ($RCMAIL->action == 'subscribe')
{
$mbox = get_input_value('_mbox', RCUBE_INPUT_POST, true, 'UTF7-IMAP');
if (strlen($mbox)) {
- $result = $IMAP->subscribe(array($mbox));
+ $result = $STORAGE->subscribe(array($mbox));
// Handle virtual (non-existing) folders
- if (!$result && $IMAP->get_error_code() == -1 &&
- strpos($IMAP->get_error_str(), '[TRYCREATE]')
+ if (!$result && $STORAGE->get_error_code() == -1 &&
+ $STORAGE->get_response_code() == rcube_storage::TRYCREATE
) {
- $result = $IMAP->create_mailbox($mbox, true);
+ $result = $STORAGE->create_folder($mbox, true);
if ($result) {
// @TODO: remove 'virtual' class of folder's row
}
}
- if ($result)
+ if ($result) {
+ // Handle subscription of protected folder (#1487656)
+ if ($RCMAIL->config->get('protect_default_folders')
+ && in_array($mbox, (array)$RCMAIL->config->get('default_folders'))
+ ) {
+ $OUTPUT->command('disable_subscription', $mbox);
+ }
+
$OUTPUT->show_message('foldersubscribed', 'confirmation');
+ }
else
- $OUTPUT->show_message('errorsaving', 'error');
+ rcmail_display_server_error('errorsaving');
}
}
@@ -54,11 +62,11 @@
{
$mbox = get_input_value('_mbox', RCUBE_INPUT_POST, true, 'UTF7-IMAP');
if (strlen($mbox)) {
- $result = $IMAP->unsubscribe(array($mbox));
+ $result = $STORAGE->unsubscribe(array($mbox));
if ($result)
$OUTPUT->show_message('folderunsubscribed', 'confirmation');
else
- $OUTPUT->show_message('errorsaving', 'error');
+ rcmail_display_server_error('errorsaving');
}
}
@@ -68,31 +76,32 @@
$mbox_utf8 = get_input_value('_mbox', RCUBE_INPUT_POST, true);
$mbox = rcube_charset_convert($mbox_utf8, RCMAIL_CHARSET, 'UTF7-IMAP');
- // get folder's children or all folders if the name contains special characters
- $delimiter = $IMAP->get_hierarchy_delimiter();
- if ((strpos($mbox, '%') === false) && (strpos($mbox, '*') === false))
- $a_mboxes = $IMAP->list_unsubscribed('', $mbox.$delimiter.'*');
- else
- $a_mboxes = $IMAP->list_unsubscribed();
+ if (strlen($mbox)) {
+ $plugin = $RCMAIL->plugins->exec_hook('folder_delete', array('name' => $mbox));
- if (strlen($mbox))
- $deleted = $IMAP->delete_mailbox($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);
- foreach ($a_mboxes as $folder) {
- if (preg_match('/^'. preg_quote($mbox.$delimiter, '/') .'/', $folder)) {
- $OUTPUT->command('remove_folder_row', rcube_charset_convert($folder, 'UTF7-IMAP'));
- }
- }
+ $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) {
- $OUTPUT->show_message('errorsaving', 'error');
+ rcmail_display_server_error('errorsaving');
}
}
@@ -110,38 +119,10 @@
}
if ($rename && $OUTPUT->ajax_call) {
- $folderlist = $IMAP->list_unsubscribed();
- $delimiter = $IMAP->get_hierarchy_delimiter();
-
- $regexp = '/^' . preg_quote($name . $delimiter, '/') . '/';
-
- // subfolders
- for ($x=sizeof($folderlist)-1; $x>=0; $x--) {
- if (preg_match($regexp, $folderlist[$x])) {
- $oldfolder = $oldname . $delimiter . preg_replace($regexp, '', $folderlist[$x]);
- $foldersplit = explode($delimiter, $folderlist[$x]);
- $level = count($foldersplit) - 1;
- $display_rename = str_repeat(' ', $level)
- . rcube_charset_convert($foldersplit[$level], 'UTF7-IMAP');
-
- $before = isset($folderlist[$x+1]) ? rcube_charset_convert($folderlist[$x+1], 'UTF7-IMAP') : false;
-
- $OUTPUT->command('replace_folder_row', rcube_charset_convert($oldfolder, 'UTF7-IMAP'),
- rcube_charset_convert($folderlist[$x], 'UTF7-IMAP'), $display_rename, $before);
- }
- }
-
- $foldersplit = explode($delimiter, $name);
- $level = count($foldersplit) - 1;
- $display_rename = str_repeat(' ', $level) . rcube_charset_convert($foldersplit[$level], 'UTF7-IMAP');
- $index = array_search($name, $folderlist);
- $before = $index !== false && isset($folderlist[$index+1]) ? rcube_charset_convert($folderlist[$index+1], 'UTF7-IMAP') : false;
-
- $OUTPUT->command('replace_folder_row', $oldname_utf8,
- rcube_charset_convert($name, 'UTF7-IMAP'), $display_rename, $before);
+ rcmail_update_folder_row($name, $oldname);
}
else if (!$rename) {
- $OUTPUT->show_message('errorsaving', 'error');
+ rcmail_display_server_error('errorsaving');
}
}
@@ -150,19 +131,19 @@
{
$mbox_utf8 = get_input_value('_mbox', RCUBE_INPUT_POST, true);
$mbox = rcube_charset_convert($mbox_utf8, RCMAIL_CHARSET, 'UTF7-IMAP');
- $delimiter = $IMAP->get_hierarchy_delimiter();
+ $delimiter = $STORAGE->get_hierarchy_delimiter();
$trash_regexp = '/^' . preg_quote($CONFIG['trash_mbox'] . $delimiter, '/') . '/';
// we should only be purging trash (or their subfolders)
if (!strlen($CONFIG['trash_mbox']) || $mbox == $CONFIG['trash_mbox']
|| preg_match($trash_regexp, $mbox)
) {
- $success = $IMAP->clear_mailbox($mbox);
+ $success = $STORAGE->delete_message('*', $mbox);
$delete = true;
}
// copy to Trash
else {
- $success = $IMAP->move_message('1:*', $CONFIG['trash_mbox'], $mbox);
+ $success = $STORAGE->move_message('1:*', $CONFIG['trash_mbox'], $mbox);
$delete = false;
}
@@ -179,7 +160,7 @@
$OUTPUT->command('show_folder', $mbox_utf8, null, true);
}
else {
- $OUTPUT->show_message('errorsaving', 'error');
+ rcmail_display_server_error('errorsaving');
}
}
@@ -188,12 +169,15 @@
{
$name = trim(get_input_value('_mbox', RCUBE_INPUT_POST, true));
- $size = $IMAP->get_mailbox_size($name);
+ $size = $STORAGE->folder_size($name);
// @TODO: check quota and show percentage usage of specified mailbox?
if ($size !== false) {
$OUTPUT->command('folder_size_update', show_bytes($size));
+ }
+ else {
+ rcmail_display_server_error();
}
}
@@ -204,11 +188,11 @@
// build table with all folders listed by server
function rcube_subscription_form($attrib)
{
- global $RCMAIL, $IMAP, $CONFIG, $OUTPUT;
+ global $RCMAIL, $OUTPUT;
list($form_start, $form_end) = get_form_tags($attrib, 'folders');
unset($attrib['form']);
-
+
if (!$attrib['id'])
$attrib['id'] = 'rcmSubscriptionlist';
@@ -220,25 +204,33 @@
$table->add_header('subscribed', '');
}
- // get folders from server
- $IMAP->clear_cache('mailboxes');
+ $STORAGE = $RCMAIL->get_storage();
- $a_unsubscribed = $IMAP->list_unsubscribed();
- $a_subscribed = $IMAP->list_mailboxes();
- $delimiter = $IMAP->get_hierarchy_delimiter();
+ // 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();
$a_js_folders = array();
$seen = array();
$list_folders = array();
+ $default_folders = (array) $RCMAIL->config->get('default_folders');
+ $protect_default = $RCMAIL->config->get('protect_default_folders');
+
// pre-process folders list
foreach ($a_unsubscribed as $i => $folder) {
- $foldersplit = explode($delimiter, $folder);
- $name = rcube_charset_convert(array_pop($foldersplit), 'UTF7-IMAP');
+ $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);
+ $level = count($foldersplit);
// add any necessary "virtual" parent folders
- if ($parent_folder && !$seen[$parent_folder]) {
+ 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]++) {
@@ -252,17 +244,29 @@
}
}
}
-
+
+ // Handle properly INBOX.INBOX situation
+ if (isset($seen[$folder])) {
+ continue;
+ }
+
$seen[$folder]++;
$list_folders[] = array(
- 'id' => $folder,
+ '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[]',
@@ -273,38 +277,86 @@
// create list of available folders
foreach ($list_folders as $i => $folder) {
$idx = $i + 1;
- $subscribed = in_array($folder['id'], $a_subscribed);
- $protected = ($CONFIG['protect_default_folders'] == true && in_array($folder['id'], $CONFIG['default_imap_folders']));
+ $sub_key = array_search($folder['id'], $a_subscribed);
+ $subscribed = $sub_key !== false;
+ $protected = $protect_default && in_array($folder['id'], $default_folders);
+ $noselect = false;
$classes = array($i%2 ? 'even' : 'odd');
$folder_js = Q($folder['id']);
$folder_utf8 = rcube_charset_convert($folder['id'], 'UTF7-IMAP');
$display_folder = str_repeat(' ', $folder['level'])
. Q($protected ? rcmail_localize_foldername($folder['id']) : $folder['name']);
-
+
if ($folder['virtual']) {
$classes[] = 'virtual';
}
if (!$protected) {
- $opts = $IMAP->mailbox_options($folder['id']);
- $noselect = in_array('\\Noselect', $opts);
+ $attrs = $STORAGE->folder_attributes($folder['id']);
+ $noselect = in_array('\\Noselect', $attrs);
}
- $table->add_row(array('id' => 'rcmrow'.$idx, 'class' => join(' ', $classes)));
-
+ $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' => ($protected || $noselect) ? 'disabled' : '')));
+ array('value' => $folder_utf8, 'disabled' => $disabled ? 'disabled' : '')));
- $a_js_folders['rcmrow'.$idx] = array($folder_utf8, Q($display_folder), $protected || $folder['virtual']);
+ $a_js_folders['rcmrow'.$idx] = array($folder_utf8,
+ Q($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', $CONFIG['default_imap_folders']);
+ $OUTPUT->set_env('defaultfolders', $default_folders);
$OUTPUT->set_env('delimiter', $delimiter);
return $form_start . $table->show($attrib) . $form_end;
@@ -316,38 +368,48 @@
if (!$attrib['id'])
$attrib['id'] = 'rcmfolderframe';
-
- $attrib['name'] = $attrib['id'];
- $OUTPUT->set_env('contentframe', $attrib['name']);
- $OUTPUT->set_env('blankpage', $attrib['src'] ? $OUTPUT->abs_url($attrib['src']) : 'program/blank.gif');
-
- return html::iframe($attrib);
+ return $OUTPUT->frame($attrib, true);
}
function rcmail_rename_folder($oldname, $newname)
{
global $RCMAIL;
- $delimiter = $RCMAIL->imap->get_hierarchy_delimiter();
- $rename = $RCMAIL->imap->rename_mailbox($oldname, $newname);
+ $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 ($rename !== false) {
+ if ($renamed) {
$a_threaded = (array) $RCMAIL->config->get('message_threading', array());
$oldprefix = '/^' . preg_quote($oldname . $delimiter, '/') . '/';
foreach ($a_threaded as $key => $val) {
if ($key == $oldname) {
unset($a_threaded[$key]);
- $a_threaded[$newname] = true;
+ $a_threaded[$newname] = true;
}
else if (preg_match($oldprefix, $key)) {
unset($a_threaded[$key]);
- $a_threaded[preg_replace($oldprefix, $newname.$delimiter, $key)] = true;
+ $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;
}
@@ -355,9 +417,13 @@
return false;
}
+
$OUTPUT->set_pagetitle(rcube_label('folders'));
$OUTPUT->include_script('list.js');
-$OUTPUT->set_env('quota', $IMAP->get_capability('QUOTA'));
+$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',
--
Gitblit v1.9.1