Update branch for 0.5-rc releasev0.5-rc@4349

1 files changed, 377 insertions, 0 deletions

diff --git a/program/steps/settings/folders.inc b/program/steps/settings/folders.inc
new file mode 100644
index 000000000..7ae4fb35d
--- /dev/null
+++ b/program/steps/settings/folders.inc
@@ -0,0 +1,377 @@
+<?php
+
+/*
+ +-----------------------------------------------------------------------+
+ | 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                                            |
+ |                                                                       |
+ | PURPOSE:                                                              |
+ |   Provide functionality of folders management                         |
+ |                                                                       |
+ +-----------------------------------------------------------------------+
+ | 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();
+
+// 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));
+
+        // Handle virtual (non-existing) folders
+        if (!$result && $IMAP->get_error_code() == -1 &&
+            $IMAP->get_response_code() == rcube_imap::TRYCREATE
+        ) {
+            $result = $IMAP->create_mailbox($mbox, true);
+            if ($result) {
+                // @TODO: remove 'virtual' class of folder's row
+            }
+        }
+
+        if ($result)
+            $OUTPUT->show_message('foldersubscribed', 'confirmation');
+        else
+            rcmail_display_server_error('errorsaving');
+    }
+}
+
+// unsubscribe mailbox
+else if ($RCMAIL->action == 'unsubscribe')
+{
+    $mbox = get_input_value('_mbox', RCUBE_INPUT_POST, true, 'UTF7-IMAP');
+    if (strlen($mbox)) {
+        $result = $IMAP->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 = 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))
+        $deleted = $IMAP->delete_mailbox($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->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(get_input_value('_folder_newname', RCUBE_INPUT_POST, true));
+    $oldname_utf8 = trim(get_input_value('_folder_oldname', RCUBE_INPUT_POST, true));
+
+    if (strlen($name_utf8) && strlen($oldname_utf8)) {
+        $name    = rcube_charset_convert($name_utf8, RCMAIL_CHARSET, 'UTF7-IMAP');
+        $oldname = rcube_charset_convert($oldname_utf8, RCMAIL_CHARSET, 'UTF7-IMAP');
+
+        $rename = rcmail_rename_folder($oldname, $name);
+    }
+
+    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('&nbsp;&nbsp;&nbsp;&nbsp;', $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('&nbsp;&nbsp;&nbsp;&nbsp;', $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);
+    }
+    else if (!$rename) {
+        rcmail_display_server_error('errorsaving');
+    }
+}
+
+// clear mailbox
+else if ($RCMAIL->action == 'purge')
+{
+    $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();
+    $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);
+        $delete = true;
+    }
+    // copy to Trash
+    else {
+        $success = $IMAP->move_message('1:*', $CONFIG['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 = trim(get_input_value('_mbox', RCUBE_INPUT_POST, true));
+
+    $size = $IMAP->get_mailbox_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();
+    }
+}
+
+if ($OUTPUT->ajax_call)
+    $OUTPUT->send();
+
+
+// build table with all folders listed by server
+function rcube_subscription_form($attrib)
+{
+    global $RCMAIL, $IMAP, $CONFIG, $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', rcube_label('foldername'));
+        $table->add_header('subscribed', '');
+    }
+
+    // get folders from server
+    $IMAP->clear_cache('mailboxes');
+
+    $a_unsubscribed = $IMAP->list_unsubscribed();
+    $a_subscribed   = $IMAP->list_mailboxes();
+    $delimiter      = $IMAP->get_hierarchy_delimiter();
+    $a_js_folders   = array();
+    $seen           = array();
+    $list_folders   = array();
+
+    // pre-process folders list
+    foreach ($a_unsubscribed as $i => $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 && !$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,
+                    );
+	            }
+            }
+        }
+    
+        $seen[$folder]++;
+
+        $list_folders[] = array(
+            'id'    => $folder,
+            'name'  => $name,
+            'level' => $level,
+        );
+    }
+
+    unset($seen);
+
+    $checkbox_subscribe = new html_checkbox(array(
+        'name'    => '_subscribed[]',
+        'title'   => rcube_label('changesubscription'),
+        'onclick' => JS_OBJECT_NAME.".command(this.checked?'subscribe':'unsubscribe',this.value)",
+    ));
+
+    // 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']));
+        $classes    = array($i%2 ? 'even' : 'odd');
+
+        $folder_js      = Q($folder['id']);
+        $folder_utf8    = rcube_charset_convert($folder['id'], 'UTF7-IMAP');
+        $display_folder = str_repeat('&nbsp;&nbsp;&nbsp;&nbsp;', $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);
+        }
+
+        $table->add_row(array('id' => 'rcmrow'.$idx, 'class' => join(' ', $classes)));
+    
+        $table->add('name', $display_folder);
+        $table->add('subscribed', $checkbox_subscribe->show(($subscribed ? $folder_utf8 : ''),
+            array('value' => $folder_utf8, 'disabled' => ($protected || $noselect) ? 'disabled' : '')));
+
+        $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('delimiter', $delimiter);
+
+    return $form_start . $table->show($attrib) . $form_end;
+}
+
+function rcmail_folder_frame($attrib)
+{
+    global $OUTPUT;
+
+    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);
+}
+
+function rcmail_rename_folder($oldname, $newname)
+{
+    global $RCMAIL;
+
+    $delimiter = $RCMAIL->imap->get_hierarchy_delimiter();
+    $rename    = $RCMAIL->imap->rename_mailbox($oldname, $newname);
+
+    // update per-folder options for modified folder and its subfolders
+    if ($rename !== false) {
+        $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;
+            }
+            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));
+
+        return true;
+    }
+
+    return false;
+}
+
+$OUTPUT->set_pagetitle(rcube_label('folders'));
+$OUTPUT->include_script('list.js');
+$OUTPUT->set_env('quota', $IMAP->get_capability('QUOTA'));
+
+// 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' => 'rcmail_quota_display',
+));
+
+$OUTPUT->send('folders');
+