program/steps/settings/manage_folders.inc

   1 <?php
   2
   3 /*
   4  +-----------------------------------------------------------------------+
   5  | program/steps/settings/manage_folders.inc                             |
   6  |                                                                       |
   7  | This file is part of the RoundCube Webmail client                     |
   8  | Copyright (C) 2005-2007, RoundCube Dev. - Switzerland                 |
   9  | Licensed under the GNU GPL                                            |
  10  |                                                                       |
  11  | PURPOSE:                                                              |
  12  |   Provide functionality to create/delete/rename folders               |
  13  |                                                                       |
  14  +-----------------------------------------------------------------------+
  15  | Author: Thomas Bruederli <roundcube@gmail.com>                        |
  16  +-----------------------------------------------------------------------+
  17
  18  $Id: manage_folders.inc 887 2007-10-19 12:24:04Z robin $
  19
  20 */
  21
  22 // init IMAP connection
  23 rcmail_imap_init(TRUE);
  24
  25 $OUTPUT->include_script('list.js');
  26
  27
  28 // subscribe to one or more mailboxes
  29 if ($_action=='subscribe')
  30   {
  31   if ($mboxes = get_input_value('_mboxes', RCUBE_INPUT_POST))
  32     $IMAP->subscribe($mboxes);
  33
  34   if ($OUTPUT->ajax_call)
  35     $OUTPUT->remote_response('// subscribed');
  36   }
  37
  38 // unsubscribe one or more mailboxes
  39 else if ($_action=='unsubscribe')
  40   {
  41   if ($mboxes = get_input_value('_mboxes', RCUBE_INPUT_POST))
  42     $IMAP->unsubscribe($mboxes);
  43
  44   if ($OUTPUT->ajax_call)
  45     $OUTPUT->remote_response('// unsubscribed');
  46   }
  47
  48 // create a new mailbox
  49 else if ($_action=='create-folder')
  50   {
  51   if (!empty($_POST['_name']))
  52     $create = $IMAP->create_mailbox(trim(get_input_value('_name', RCUBE_INPUT_POST, FALSE, 'UTF-7')), TRUE);
  53
  54   if ($create && $OUTPUT->ajax_call)
  55     {
  56     $delimiter = $IMAP->get_hierarchy_delimiter();
  57     $foldersplit = explode($delimiter, $create);
  58     $display_create = str_repeat('&nbsp;&nbsp;&nbsp;&nbsp;', substr_count($create, $delimiter)) . rcube_charset_convert($foldersplit[count($foldersplit)-1], 'UTF-7');
  59     $OUTPUT->command('add_folder_row', $create, $display_create);
  60     $OUTPUT->send();
  61     }
  62   else if (!$create && $OUTPUT->ajax_call)
  63     {
  64     $OUTPUT->show_message('errorsaving', 'error');
  65     $OUTPUT->remote_response();
  66     }
  67   else if (!$create)
  68     $OUTPUT->show_message('errorsaving', 'error');
  69   }
  70
  71 // rename a mailbox
  72 else if ($_action=='rename-folder')
  73   {
  74   $a_mboxes = array_unique(array_merge($IMAP->list_mailboxes(), $IMAP->list_unsubscribed()));
  75   $delimiter = $IMAP->get_hierarchy_delimiter();
  76
  77   if (!empty($_POST['_folder_oldname']) && !empty($_POST['_folder_newname']))
  78     $rename = $IMAP->rename_mailbox(($oldname = get_input_value('_folder_oldname', RCUBE_INPUT_POST)), trim(get_input_value('_folder_newname', RCUBE_INPUT_POST, FALSE, 'UTF-7')));
  79
  80   if ($rename && $OUTPUT->ajax_call)
  81     {
  82     $delimiter = $IMAP->get_hierarchy_delimiter();
  83     $foldersplit = explode($delimiter, $rename);
  84     $level = count($foldersplit) - 1;
  85     $display_rename = str_repeat('&nbsp;&nbsp;&nbsp;&nbsp;', $level) . rcube_charset_convert($foldersplit[$level], 'UTF-7');
  86     $OUTPUT->command('replace_folder_row', $oldname, $rename, $display_rename);
  87     foreach ($a_mboxes as $mbox)
  88       if (preg_match('/^'.preg_quote($oldname.$delimiter).'/', $mbox))
  89         {
  90         $c_rename = preg_replace('/^'.preg_quote($oldname).'/', $rename, $mbox);
  91         $foldersplit = explode($delimiter, $c_rename);
  92         $level = count($foldersplit) - 1;
  93         $display_rename = str_repeat('&nbsp;&nbsp;&nbsp;&nbsp;', $level) . rcube_charset_convert($foldersplit[$level], 'UTF-7');
  94         $OUTPUT->command('replace_folder_row', $mbox, $c_rename, $display_rename);
  95         }
  96     $OUTPUT->command('reset_folder_rename');
  97     $OUTPUT->send();
  98     }
  99   else if (!$rename && $OUTPUT->ajax_call)
 100     {
 101     $OUTPUT->command('reset_folder_rename');
 102     $OUTPUT->show_message('errorsaving', 'error');
 103     $OUTPUT->send();
 104     }
 105   else if (!$rename)
 106     $OUTPUT->show_message('errorsaving', 'error');
 107   }
 108
 109 // delete an existing IMAP mailbox
 110 else if ($_action=='delete-folder')
 111   {
 112   $a_mboxes = array_merge($IMAP->list_mailboxes(), $IMAP->list_unsubscribed());
 113   $delimiter = $IMAP->get_hierarchy_delimiter();
 114
 115   if ($mboxes = get_input_value('_mboxes', RCUBE_INPUT_POST))
 116     $deleted = $IMAP->delete_mailbox(array($mboxes));
 117
 118   if ($OUTPUT->ajax_call && $deleted)
 119     {
 120     $OUTPUT->command('remove_folder_row', get_input_value('_mboxes', RCUBE_INPUT_POST));
 121     foreach ($a_mboxes as $mbox)
 122       if (preg_match('/^'.preg_quote(get_input_value('_mboxes', RCUBE_INPUT_POST).$delimiter).'/', $mbox))
 123         $OUTPUT->command('remove_folder_row', $mbox);
 124     $OUTPUT->show_message('folderdeleted', 'confirmation');
 125     $OUTPUT->send();
 126     }
 127   else if ($OUTPUT->ajax_call)
 128     {
 129     $OUTPUT->show_message('errorsaving', 'error');
 130     $OUTPUT->send();
 131     }
 132   }
 133
 134
 135
 136 // build table with all folders listed by server
 137 function rcube_subscription_form($attrib)
 138   {
 139   global $IMAP, $CONFIG, $OUTPUT;
 140
 141   list($form_start, $form_end) = get_form_tags($attrib, 'folders');
 142   unset($attrib['form']);
 143
 144
 145   if (!$attrib['id'])
 146     $attrib['id'] = 'rcmSubscriptionlist';
 147
 148   // allow the following attributes to be added to the <table> tag
 149   $attrib_str = create_attrib_string($attrib, array('style', 'class', 'id', 'cellpadding', 'cellspacing', 'border', 'summary'));
 150
 151   $out = "$form_start\n<table" . $attrib_str . ">\n";
 152
 153
 154   // add table header
 155   $out .= "<thead><tr>\n";
 156   $out .= sprintf('<td class="name">%s</td><td class="subscribed">%s</td>'.
 157                   '<td class="rename">&nbsp;</td><td class="delete">&nbsp;</td>',
 158                   rcube_label('foldername'), rcube_label('subscribed'));
 159
 160   $out .= "\n</tr></thead>\n<tbody>\n";
 161
 162
 163   // get folders from server
 164   $IMAP->clear_cache('mailboxes');
 165
 166   $a_unsubscribed = $IMAP->list_unsubscribed();
 167   $a_subscribed = $IMAP->list_mailboxes();
 168   $delimiter = $IMAP->get_hierarchy_delimiter();
 169   $a_js_folders = array();
 170
 171   $checkbox_subscribe = new checkbox(array('name' => '_subscribed[]', 'onclick' => JS_OBJECT_NAME.".command(this.checked?'subscribe':'unsubscribe',this.value)"));
 172
 173   if (!empty($attrib['deleteicon']))
 174     $del_button = sprintf('<img src="%s%s" alt="%s" border="0" />', $CONFIG['skin_path'], $attrib['deleteicon'], rcube_label('delete'));
 175   else
 176     $del_button = rcube_label('delete');
 177
 178   if (!empty($attrib['renameicon']))
 179     $edit_button = sprintf('<img src="%s%s" alt="%s" border="0" />', $CONFIG['skin_path'], $attrib['renameicon'], rcube_label('rename'));
 180   else
 181     $del_button = rcube_label('rename');
 182
 183   // create list of available folders
 184   foreach ($a_unsubscribed as $i => $folder)
 185     {
 186     $subscribed = in_array($folder, $a_subscribed);
 187     $protected = ($CONFIG['protect_default_folders'] == TRUE && in_array($folder,$CONFIG['default_imap_folders']));
 188     $zebra_class = $i%2 ? 'even' : 'odd';
 189     $folder_js = JQ($folder);
 190     $foldersplit = explode($delimiter, $folder);
 191     $level = count($foldersplit) - 1;
 192     $display_folder = str_repeat('&nbsp;&nbsp;&nbsp;&nbsp;', $level) . rcube_charset_convert($foldersplit[$level], 'UTF-7');
 193     $folder_html = $CONFIG['protect_default_folders'] && in_array($folder, $CONFIG['default_imap_folders']) ? rcube_label(strtolower($folder)) : $display_folder;
 194
 195     if (!$protected)
 196       $a_js_folders['rcmrow'.($i+1)] = array($folder, rcube_charset_convert($folder, 'UTF-7'));
 197
 198     $out .= sprintf('<tr id="rcmrow%d" class="%s"><td>%s</td>',
 199                     $i+1,
 200                     $zebra_class,
 201                     Q($folder_html));
 202
 203     if ($protected)
 204       $out .= '<td>&nbsp;'.($subscribed ? '&#x2022;' : '-').'</td>';
 205     else
 206       $out .= '<td>'.$checkbox_subscribe->show($subscribed?$folder:'', array('value' => $folder)).'</td>';
 207
 208     // add rename and delete buttons
 209     if (!$protected)
 210       $out .= sprintf('<td><a href="#rename" title="%s">%s</a>'.
 211                       '<td><a href="#delete" title="%s">%s</a></td>',
 212                       rcube_label('renamefolder'),
 213                       $edit_button,
 214                       rcube_label('deletefolder'),
 215                       $del_button);
 216     else
 217       $out .= '<td></td><td></td>';
 218
 219     $out .= "</tr>\n";
 220     }
 221
 222   $out .= "</tbody>\n</table>";
 223   $out .= "\n$form_end";
 224
 225   $OUTPUT->add_gui_object('subscriptionlist', $attrib['id']);
 226   $OUTPUT->set_env('subscriptionrows', $a_js_folders);
 227   $OUTPUT->set_env('defaultfolders', $CONFIG['default_imap_folders']);
 228   $OUTPUT->set_env('delimiter', $delimiter);
 229
 230   return $out;
 231   }
 232
 233
 234 function rcube_create_folder_form($attrib)
 235   {
 236   list($form_start, $form_end) = get_form_tags($attrib, 'create-folder');
 237   unset($attrib['form']);
 238
 239
 240   // return the complete edit form as table
 241   $out = "$form_start\n";
 242
 243   $input = new textfield(array('name' => '_folder_name'));
 244   $out .= $input->show();
 245
 246   if (get_boolean($attrib['button']))
 247     {
 248     $button = new input_field(array('type' => 'button',
 249                                     'value' => rcube_label('create'),
 250                                     'onclick' => JS_OBJECT_NAME.".command('create-folder',this.form)"));
 251     $out .= $button->show();
 252     }
 253
 254   $out .= "\n$form_end";
 255
 256   return $out;
 257   }
 258
 259 function rcube_rename_folder_form($attrib)
 260   {
 261   global $CONFIG, $IMAP;
 262
 263   list($form_start, $form_end) = get_form_tags($attrib, 'rename-folder');
 264   unset($attrib['form']);
 265
 266   // return the complete edit form as table
 267   $out = "$form_start\n";
 268
 269   $a_unsubscribed = $IMAP->list_unsubscribed();
 270   $select_folder = new select(array('name' => '_folder_oldname', 'id' => 'rcmfd_oldfolder'));
 271
 272   foreach ($a_unsubscribed as $i => $folder)
 273     {
 274     if ($CONFIG['protect_default_folders'] == TRUE && in_array($folder,$CONFIG['default_imap_folders']))
 275       continue;
 276
 277     $select_folder->add($folder);
 278     }
 279
 280   $out .= $select_folder->show();
 281
 282   $out .= " to ";
 283   $inputtwo = new textfield(array('name' => '_folder_newname'));
 284   $out .= $inputtwo->show();
 285
 286   if (get_boolean($attrib['button']))
 287     {
 288     $button = new input_field(array('type' => 'button',
 289                                     'value' => rcube_label('rename'),
 290                                     'onclick' => JS_OBJECT_NAME.".command('rename-folder',this.form)"));
 291     $out .= $button->show();
 292     }
 293
 294   $out .= "\n$form_end";
 295
 296   return $out;
 297   }
 298
 299
 300 // register UI objects
 301 $OUTPUT->add_handlers(array(
 302   'foldersubscription' => 'rcube_subscription_form',
 303   'createfolder' => 'rcube_create_folder_form',
 304   'renamefolder' => 'rcube_rename_folder_form'
 305 ));
 306
 307 // add some labels to client
 308 rcube_add_label('deletefolderconfirm');
 309
 310 $OUTPUT->send('managefolders');
 311 ?>