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-2008, 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 1159 2008-02-29 11:49:09Z thomasb $
  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       {
 123       $regex = get_input_value('_mboxes', RCUBE_INPUT_POST) . $delimiter;
 124       $regex = preg_quote($regex, '/');
 125       if (preg_match('/^'. $regex .'/', $mbox))
 126         {
 127         $OUTPUT->command('remove_folder_row', $mbox);
 128         }
 129       }
 130     $OUTPUT->show_message('folderdeleted', 'confirmation');
 131     $OUTPUT->send();
 132     }
 133   else if ($OUTPUT->ajax_call)
 134     {
 135     $OUTPUT->show_message('errorsaving', 'error');
 136     $OUTPUT->send();
 137     }
 138   }
 139
 140
 141
 142 // build table with all folders listed by server
 143 function rcube_subscription_form($attrib)
 144   {
 145   global $IMAP, $CONFIG, $OUTPUT;
 146
 147   list($form_start, $form_end) = get_form_tags($attrib, 'folders');
 148   unset($attrib['form']);
 149
 150
 151   if (!$attrib['id'])
 152     $attrib['id'] = 'rcmSubscriptionlist';
 153
 154   // allow the following attributes to be added to the <table> tag
 155   $attrib_str = create_attrib_string($attrib, array('style', 'class', 'id', 'cellpadding', 'cellspacing', 'border', 'summary'));
 156
 157   $out = "$form_start\n<table" . $attrib_str . ">\n";
 158
 159
 160   // add table header
 161   $out .= "<thead><tr>\n";
 162   $out .= sprintf('<td class="name">%s</td><td class="msgcount">%s</td><td class="subscribed">%s</td>'.
 163                   '<td class="rename">&nbsp;</td><td class="delete">&nbsp;</td>',
 164                   rcube_label('foldername'), rcube_label('messagecount'), rcube_label('subscribed'));
 165
 166   $out .= "\n</tr></thead>\n<tbody>\n";
 167
 168
 169   // get folders from server
 170   $IMAP->clear_cache('mailboxes');
 171
 172   $a_unsubscribed = $IMAP->list_unsubscribed();
 173   $a_subscribed = $IMAP->list_mailboxes();
 174   $delimiter = $IMAP->get_hierarchy_delimiter();
 175   $a_js_folders = array();
 176
 177   $checkbox_subscribe = new checkbox(array('name' => '_subscribed[]', 'onclick' => JS_OBJECT_NAME.".command(this.checked?'subscribe':'unsubscribe',this.value)"));
 178
 179   if (!empty($attrib['deleteicon']))
 180     $del_button = sprintf('<img src="%s%s" alt="%s" border="0" />', $CONFIG['skin_path'], $attrib['deleteicon'], rcube_label('delete'));
 181   else
 182     $del_button = rcube_label('delete');
 183
 184   if (!empty($attrib['renameicon']))
 185     $edit_button = sprintf('<img src="%s%s" alt="%s" border="0" />', $CONFIG['skin_path'], $attrib['renameicon'], rcube_label('rename'));
 186   else
 187     $del_button = rcube_label('rename');
 188
 189   // create list of available folders
 190   foreach ($a_unsubscribed as $i => $folder)
 191     {
 192     $subscribed = in_array($folder, $a_subscribed);
 193     $protected = ($CONFIG['protect_default_folders'] == TRUE && in_array($folder,$CONFIG['default_imap_folders']));
 194     $zebra_class = $i%2 ? 'even' : 'odd';
 195     $folder_js = JQ($folder);
 196     $foldersplit = explode($delimiter, $folder);
 197     $level = count($foldersplit) - 1;
 198     $display_folder = str_repeat('&nbsp;&nbsp;&nbsp;&nbsp;', $level) . rcube_charset_convert($foldersplit[$level], 'UTF-7');
 199     $folder_html = $CONFIG['protect_default_folders'] && in_array($folder, $CONFIG['default_imap_folders']) ? rcmail_localize_foldername($folder) : $display_folder;
 200
 201     if (!$protected)
 202       $a_js_folders['rcmrow'.($i+1)] = array($folder, rcube_charset_convert($folder, 'UTF-7'));
 203
 204     $out .= sprintf('<tr id="rcmrow%d" class="%s"><td class="name">%s</td><td class="msgcount">%d</td>',
 205                     $i+1,
 206                     $zebra_class,
 207                     Q($folder_html),
 208                     $IMAP->messagecount($folder));
 209
 210     if ($protected)
 211       $out .= '<td class="subscribed">&nbsp;'.($subscribed ? '&#x2022;' : '-').'</td>';
 212     else
 213       $out .= '<td class="subscribed">'.$checkbox_subscribe->show($subscribed?$folder:'', array('value' => $folder)).'</td>';
 214
 215     // add rename and delete buttons
 216     if (!$protected)
 217       $out .= sprintf('<td class="rename"><a href="#rename" title="%s">%s</a>'.
 218                       '<td class="delete"><a href="#delete" title="%s">%s</a></td>',
 219                       rcube_label('renamefolder'),
 220                       $edit_button,
 221                       rcube_label('deletefolder'),
 222                       $del_button);
 223     else
 224       $out .= '<td></td><td></td>';
 225
 226     $out .= "</tr>\n";
 227     }
 228
 229   $out .= "</tbody>\n</table>";
 230   $out .= "\n$form_end";
 231
 232   $OUTPUT->add_gui_object('subscriptionlist', $attrib['id']);
 233   $OUTPUT->set_env('subscriptionrows', $a_js_folders);
 234   $OUTPUT->set_env('defaultfolders', $CONFIG['default_imap_folders']);
 235   $OUTPUT->set_env('delimiter', $delimiter);
 236
 237   return $out;
 238   }
 239
 240
 241 function rcube_create_folder_form($attrib)
 242   {
 243   global $OUTPUT;
 244
 245   list($form_start, $form_end) = get_form_tags($attrib, 'create-folder');
 246   unset($attrib['form']);
 247
 248   if ($attrib['hintbox'])
 249     $OUTPUT->add_gui_object('createfolderhint', $attrib['hintbox']);
 250
 251   // return the complete edit form as table
 252   $out = "$form_start\n";
 253
 254   $input = new textfield(array('name' => '_folder_name'));
 255   $out .= $input->show();
 256
 257   if (get_boolean($attrib['button']))
 258     {
 259     $button = new input_field(array('type' => 'button',
 260                                     'value' => rcube_label('create'),
 261                                     'onclick' => JS_OBJECT_NAME.".command('create-folder',this.form)"));
 262     $out .= $button->show();
 263     }
 264
 265   $out .= "\n$form_end";
 266
 267   return $out;
 268   }
 269
 270 function rcube_rename_folder_form($attrib)
 271   {
 272   global $CONFIG, $IMAP;
 273
 274   list($form_start, $form_end) = get_form_tags($attrib, 'rename-folder');
 275   unset($attrib['form']);
 276
 277   // return the complete edit form as table
 278   $out = "$form_start\n";
 279
 280   $a_unsubscribed = $IMAP->list_unsubscribed();
 281   $select_folder = new select(array('name' => '_folder_oldname', 'id' => 'rcmfd_oldfolder'));
 282
 283   foreach ($a_unsubscribed as $i => $folder)
 284     {
 285     if ($CONFIG['protect_default_folders'] == TRUE && in_array($folder,$CONFIG['default_imap_folders']))
 286       continue;
 287
 288     $select_folder->add($folder);
 289     }
 290
 291   $out .= $select_folder->show();
 292
 293   $out .= " to ";
 294   $inputtwo = new textfield(array('name' => '_folder_newname'));
 295   $out .= $inputtwo->show();
 296
 297   if (get_boolean($attrib['button']))
 298     {
 299     $button = new input_field(array('type' => 'button',
 300                                     'value' => rcube_label('rename'),
 301                                     'onclick' => JS_OBJECT_NAME.".command('rename-folder',this.form)"));
 302     $out .= $button->show();
 303     }
 304
 305   $out .= "\n$form_end";
 306
 307   return $out;
 308   }
 309
 310
 311 // register UI objects
 312 $OUTPUT->add_handlers(array(
 313   'foldersubscription' => 'rcube_subscription_form',
 314   'createfolder' => 'rcube_create_folder_form',
 315   'renamefolder' => 'rcube_rename_folder_form'
 316 ));
 317
 318 // add some labels to client
 319 rcube_add_label('deletefolderconfirm','addsubfolderhint');
 320
 321 $OUTPUT->send('managefolders');
 322 ?>