source: subversion/trunk/roundcubemail/program/steps/settings/manage_folders.inc @ 4132

Last change on this file since 4132 was 4132, checked in by alec, 3 years ago
  • Add basic IMAP LIST's \Noselect option support (mark unselectable folders as virtual, etc.)
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 15.0 KB
Line 
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-2009, 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$
19
20*/
21
22// WARNING: folder names in UI are encoded with RCMAIL_CHARSET
23
24// init IMAP connection
25$RCMAIL->imap_connect();
26
27// subscribe to one or more mailboxes
28if ($RCMAIL->action=='subscribe')
29  {
30  if ($mbox = get_input_value('_mbox', RCUBE_INPUT_POST, false, 'UTF7-IMAP'))
31    $IMAP->subscribe(array($mbox));
32  }
33
34// unsubscribe one or more mailboxes
35else if ($RCMAIL->action=='unsubscribe')
36  {
37  if ($mbox = get_input_value('_mbox', RCUBE_INPUT_POST, false, 'UTF7-IMAP'))
38    $IMAP->unsubscribe(array($mbox));
39  }
40
41// enable threading for one or more mailboxes
42else if ($RCMAIL->action=='enable-threading')
43  {
44  if ($mbox = get_input_value('_mbox', RCUBE_INPUT_POST, false, 'UTF7-IMAP'))
45    rcube_set_threading($mbox, true);
46  }
47
48// enable threading for one or more mailboxes
49else if ($RCMAIL->action=='disable-threading')
50  {
51  if ($mbox = get_input_value('_mbox', RCUBE_INPUT_POST, false, 'UTF7-IMAP'))
52    rcube_set_threading($mbox, false);
53  }
54
55// create a new mailbox
56else if ($RCMAIL->action=='create-folder')
57  {
58  if (!empty($_POST['_name']))
59    {
60    $name = trim(get_input_value('_name', RCUBE_INPUT_POST, FALSE, 'UTF7-IMAP'));
61    $create = $IMAP->create_mailbox($name, TRUE);
62    }
63 
64  if ($create && $OUTPUT->ajax_call)
65    {
66    $delimiter = $IMAP->get_hierarchy_delimiter();
67    $folderlist = $IMAP->list_unsubscribed();
68    $index = array_search($create, $folderlist);
69    $before = $index !== false && isset($folderlist[$index+1]) ? rcube_charset_convert($folderlist[$index+1], 'UTF7-IMAP') : false;
70   
71    $create = rcube_charset_convert($create, 'UTF7-IMAP');
72    $foldersplit = explode($delimiter, $create);
73    $display_create = str_repeat('&nbsp;&nbsp;&nbsp;&nbsp;', substr_count($create, $delimiter)) . $foldersplit[count($foldersplit)-1];
74
75    $OUTPUT->command('add_folder_row', $create, $display_create, false, $before);
76    }
77  else if (!$create)
78    {
79    $OUTPUT->show_message('errorsaving', 'error');
80    }
81  }
82
83// rename a mailbox
84else if ($RCMAIL->action=='rename-folder')
85  {
86  if (!empty($_POST['_folder_oldname']) && !empty($_POST['_folder_newname']))
87    {
88    $name_utf8 = trim(get_input_value('_folder_newname', RCUBE_INPUT_POST));
89    $oldname_utf8 = get_input_value('_folder_oldname', RCUBE_INPUT_POST);
90    $name = rcube_charset_convert($name_utf8, RCMAIL_CHARSET, 'UTF7-IMAP');
91    $oldname = rcube_charset_convert($oldname_utf8, RCMAIL_CHARSET, 'UTF7-IMAP');
92
93    $rename = $IMAP->rename_mailbox($oldname, $name);
94    }
95
96  // update per-folder options for modified folder and its subfolders
97  if ($rename) {
98    $a_threaded = $RCMAIL->config->get('message_threading', array());
99    $delimiter = $IMAP->get_hierarchy_delimiter();
100    $oldprefix = '/^' . preg_quote($oldname . $delimiter, '/') . '/';
101    foreach ($a_threaded as $key => $val)
102      if ($key == $oldname) {
103        unset($a_threaded[$key]);
104        $a_threaded[$name] = true;
105        }
106      else if (preg_match($oldprefix, $key)) {
107        unset($a_threaded[$key]);
108        $a_threaded[preg_replace($oldprefix, $name.$delimiter, $key)] = true;     
109      }
110     
111    $RCMAIL->user->save_prefs(array('message_threading' => $a_threaded));
112    }
113
114  if ($rename && $OUTPUT->ajax_call)
115    {
116    $folderlist = $IMAP->list_unsubscribed();
117    $delimiter = $IMAP->get_hierarchy_delimiter();
118
119    $regexp = '/^' . preg_quote($rename . $delimiter, '/') . '/';
120
121    // subfolders
122    for ($x=sizeof($folderlist)-1; $x>=0; $x--)
123      {
124      if (preg_match($regexp, $folderlist[$x]))
125        {
126        $oldfolder = $oldname . $delimiter . preg_replace($regexp, '', $folderlist[$x]);
127        $foldersplit = explode($delimiter, $folderlist[$x]);
128        $level = count($foldersplit) - 1;
129        $display_rename = str_repeat('&nbsp;&nbsp;&nbsp;&nbsp;', $level)
130          . rcube_charset_convert($foldersplit[$level], 'UTF7-IMAP');
131
132        $before = isset($folderlist[$x+1]) ? rcube_charset_convert($folderlist[$x+1], 'UTF7-IMAP') : false;
133       
134        $OUTPUT->command('replace_folder_row', rcube_charset_convert($oldfolder, 'UTF7-IMAP'),
135          rcube_charset_convert($folderlist[$x], 'UTF7-IMAP'), $display_rename, $before);
136        }
137      }
138
139    $foldersplit = explode($delimiter, $rename);
140    $level = count($foldersplit) - 1;
141    $display_rename = str_repeat('&nbsp;&nbsp;&nbsp;&nbsp;', $level) . rcube_charset_convert($foldersplit[$level], 'UTF7-IMAP');
142    $index = array_search($rename, $folderlist);
143    $before = $index !== false && isset($folderlist[$index+1]) ? rcube_charset_convert($folderlist[$index+1], 'UTF7-IMAP') : false;
144
145    $OUTPUT->command('replace_folder_row', $oldname_utf8, rcube_charset_convert($rename, 'UTF7-IMAP'), $display_rename, $before);
146    $OUTPUT->command('reset_folder_rename');
147    }
148  else if (!$rename && $OUTPUT->ajax_call)
149    {
150    $OUTPUT->command('reset_folder_rename');
151    $OUTPUT->show_message('errorsaving', 'error');
152    }
153  else if (!$rename)
154    $OUTPUT->show_message('errorsaving', 'error');
155  }
156
157// delete an existing IMAP mailbox
158else if ($RCMAIL->action=='delete-folder')
159  {
160  $a_mboxes = $IMAP->list_unsubscribed();
161  $delimiter = $IMAP->get_hierarchy_delimiter();
162 
163  $mboxes_utf8 = get_input_value('_mboxes', RCUBE_INPUT_POST);
164  $mboxes = rcube_charset_convert($mboxes_utf8, RCMAIL_CHARSET, 'UTF7-IMAP');
165
166  if ($mboxes)
167    $deleted = $IMAP->delete_mailbox(array($mboxes));
168
169  if ($OUTPUT->ajax_call && $deleted)
170    {
171    $OUTPUT->command('remove_folder_row', $mboxes_utf8);
172    foreach ($a_mboxes as $mbox)
173      {
174      if (preg_match('/^'. preg_quote($mboxes.$delimiter, '/') .'/', $mbox))
175        {
176        $OUTPUT->command('remove_folder_row', rcube_charset_convert($mbox, 'UTF7-IMAP'));
177        }
178      }
179    $OUTPUT->show_message('folderdeleted', 'confirmation');
180    }
181  else if (!$deleted)
182    {
183    $OUTPUT->show_message('errorsaving', 'error');
184    }
185  }
186
187if ($OUTPUT->ajax_call)
188  $OUTPUT->send();
189
190
191// build table with all folders listed by server
192function rcube_subscription_form($attrib)
193  {
194  global $RCMAIL, $IMAP, $CONFIG, $OUTPUT;
195
196  $threading_supported = $IMAP->get_capability('thread=references')
197    || $IMAP->get_capability('thread=orderedsubject')
198    || $IMAP->get_capability('thread=refs');
199
200  list($form_start, $form_end) = get_form_tags($attrib, 'folders');
201  unset($attrib['form']);
202 
203  if (!$attrib['id'])
204    $attrib['id'] = 'rcmSubscriptionlist';
205
206  $table = new html_table();
207
208  // add table header
209  $table->add_header('name', rcube_label('foldername'));
210  $table->add_header('msgcount', rcube_label('messagecount'));
211  $table->add_header('subscribed', rcube_label('subscribed'));
212  if ($threading_supported)
213    $table->add_header('threaded', rcube_label('threaded'));
214  $table->add_header('rename', '&nbsp;');
215  $table->add_header('delete', '&nbsp;');
216
217  // get folders from server
218  $IMAP->clear_cache('mailboxes');
219
220  $a_unsubscribed = $IMAP->list_unsubscribed();
221  $a_subscribed = $IMAP->list_mailboxes();
222  $a_threaded = $a_threaded_copy = $RCMAIL->config->get('message_threading', array());
223  $delimiter = $IMAP->get_hierarchy_delimiter();
224  $a_js_folders = $seen = $list_folders = array();
225
226  // pre-process folders list
227  foreach ($a_unsubscribed as $i => $folder) {
228    $foldersplit = explode($delimiter, $folder);
229    $name = rcube_charset_convert(array_pop($foldersplit), 'UTF7-IMAP');
230    $parent_folder = join($delimiter, $foldersplit);
231    $level = count($foldersplit);
232
233    // add any necessary "virtual" parent folders
234    if ($parent_folder && !$seen[$parent_folder]) {
235      for ($i=1; $i<=$level; $i++) {
236            $ancestor_folder = join($delimiter, array_slice($foldersplit, 0, $i));
237            if ($ancestor_folder && !$seen[$ancestor_folder]++) {
238              $ancestor_name = rcube_charset_convert($foldersplit[$i-1], 'UTF7-IMAP');
239              $list_folders[] = array('id' => $ancestor_folder, 'name' => $ancestor_name, 'level' => $i-1, 'virtual' => true);
240            }
241      }
242    }
243   
244    unset($a_threaded_copy[$folder]);
245   
246    $list_folders[] = array('id' => $folder, 'name' => $name, 'level' => $level);
247    $seen[$folder]++;
248  }
249
250  unset($seen);
251
252  // remove 'message_threading' option for not existing folders
253  if ($a_threaded_copy) {
254    foreach ($a_threaded_copy as $key => $val)
255      unset($a_threaded[$key]);
256    unset($a_threaded_copy);
257    $RCMAIL->user->save_prefs(array('message_threading' => $a_threaded));
258  }
259
260  $checkbox_subscribe = new html_checkbox(array(
261    'name' => '_subscribed[]',
262    'onclick' => JS_OBJECT_NAME.".command(this.checked?'subscribe':'unsubscribe',this.value)",
263  ));
264  $checkbox_threaded = new html_checkbox(array(
265    'name' => '_threaded[]',
266    'onclick' => JS_OBJECT_NAME.".command(this.checked?'enable-threading':'disable-threading',this.value)",
267  ));
268 
269  if (!empty($attrib['deleteicon']))
270    $del_button = html::img(array('src' => $CONFIG['skin_path'] . $attrib['deleteicon'], 'alt' => rcube_label('delete')));
271  else
272    $del_button = rcube_label('delete');
273
274  if (!empty($attrib['renameicon']))
275    $edit_button = html::img(array('src' => $CONFIG['skin_path'] . $attrib['renameicon'], 'alt' => rcube_label('rename')));
276  else
277    $edit_button = rcube_label('rename');
278   
279  // create list of available folders
280  foreach ($list_folders as $i => $folder) {
281    $idx = $i + 1;
282    $subscribed = in_array($folder['id'], $a_subscribed);
283    $threaded = $a_threaded[$folder['id']];
284    $protected = ($CONFIG['protect_default_folders'] == true && in_array($folder['id'], $CONFIG['default_imap_folders']));
285    $classes = array($i%2 ? 'even' : 'odd');
286    $folder_js = JQ($folder['id']);
287    $display_folder = str_repeat('&nbsp;&nbsp;&nbsp;&nbsp;', $folder['level']) . ($protected ? rcmail_localize_foldername($folder['id']) : $folder['name']);
288    $folder_utf8 = rcube_charset_convert($folder['id'], 'UTF7-IMAP');
289   
290    if ($folder['virtual']) {
291      $classes[] = 'virtual';
292    }
293
294    if (!$protected) {
295      $opts = $IMAP->mailbox_options($folder['id']);
296      $noselect = in_array('\\Noselect', $opts);
297    }
298
299    $table->add_row(array('id' => 'rcmrow'.$idx, 'class' => join(' ', $classes)));
300   
301    $table->add('name', Q($display_folder));
302    $table->add('msgcount', ($folder['virtual'] ? '' : $IMAP->messagecount($folder['id'], 'ALL', false, false)));
303    $table->add('subscribed', $checkbox_subscribe->show(($subscribed ? $folder_utf8 : ''),
304      array('value' => $folder_utf8, 'disabled' => ($protected || $noselect) ? 'disabled' : '')));
305    if ($threading_supported) {
306      $table->add('threaded', $folder['virtual'] ? '' :
307            $checkbox_threaded->show(($threaded ? $folder_utf8 : ''), array('value' => $folder_utf8)));
308    }
309   
310    // add rename and delete buttons
311    if (!$protected && !$folder['virtual']) {
312      $table->add('rename', html::a(array('href' => "#rename", 'title' => rcube_label('renamefolder')), $edit_button));
313      $table->add('delete', html::a(array('href' => "#delete", 'title' => rcube_label('deletefolder')), $del_button));
314    }
315    else {
316      $table->add('rename', '&nbsp;');
317      $table->add('delete', '&nbsp;');
318    }
319   
320    $a_js_folders['rcmrow'.$idx] = array($folder_utf8, $display_folder, $protected || $folder['virtual']);
321  }
322
323  rcmail::get_instance()->plugins->exec_hook('folders_list', array('table'=>$table));
324
325  $OUTPUT->add_gui_object('subscriptionlist', $attrib['id']);
326  $OUTPUT->set_env('subscriptionrows', $a_js_folders);
327  $OUTPUT->set_env('defaultfolders', $CONFIG['default_imap_folders']);
328  $OUTPUT->set_env('delimiter', $delimiter);
329
330  return $form_start . $table->show($attrib) . $form_end;
331  }
332
333
334function rcube_create_folder_form($attrib)
335  {
336  global $OUTPUT;
337 
338  list($form_start, $form_end) = get_form_tags($attrib, 'create-folder');
339  unset($attrib['form']);
340
341  if ($attrib['hintbox'])
342    $OUTPUT->add_gui_object('createfolderhint', $attrib['hintbox']);
343
344  // return the complete edit form as table
345  $out = "$form_start\n";
346
347  $input = new html_inputfield(array('name' => '_folder_name'));
348  $out .= $input->show();
349 
350  if (get_boolean($attrib['button']))
351    {
352    $button = new html_inputfield(array('type' => 'button',
353                                    'value' => rcube_label('create'),
354                                    'onclick' => JS_OBJECT_NAME.".command('create-folder',this.form)"));
355    $out .= $button->show();
356    }
357
358  $out .= "\n$form_end";
359
360  return $out;
361  }
362
363function rcube_rename_folder_form($attrib)
364  {
365  global $CONFIG, $IMAP;
366
367  list($form_start, $form_end) = get_form_tags($attrib, 'rename-folder');
368  unset($attrib['form']);
369
370  // return the complete edit form as table
371  $out = "$form_start\n";
372
373  $a_unsubscribed = $IMAP->list_unsubscribed();
374  $select_folder = new html_select(array('name' => '_folder_oldname', 'id' => 'rcmfd_oldfolder'));
375
376  foreach ($a_unsubscribed as $i => $folder)
377    {
378    if ($CONFIG['protect_default_folders'] == TRUE && in_array($folder,$CONFIG['default_imap_folders']))
379      continue;
380
381    $select_folder->add($folder);
382    }
383
384  $out .= $select_folder->show();
385
386  $out .= " to ";
387  $inputtwo = new html_inputfield(array('name' => '_folder_newname'));
388  $out .= $inputtwo->show();
389
390  if (get_boolean($attrib['button']))
391    {
392    $button = new html_inputfield(array('type' => 'button',
393                                    'value' => rcube_label('rename'),
394                                    'onclick' => JS_OBJECT_NAME.".command('rename-folder',this.form)"));
395    $out .= $button->show();
396    }
397
398  $out .= "\n$form_end";
399 
400  return $out;
401  }
402
403
404// (un)set 'threading' for selected folder
405function rcube_set_threading($mbox, $state=true)
406  {
407  global $RCMAIL;
408  $mbox = (array)$mbox;
409  $a_prefs = (array)$RCMAIL->config->get('message_threading');
410
411  if ($state) {
412    foreach ($mbox as $box)
413      $a_prefs[$box] = true;
414    }
415  else {
416    foreach ($mbox as $box)
417      unset($a_prefs[$box]);
418    }
419
420  $RCMAIL->user->save_prefs(array('message_threading' => $a_prefs));
421  }
422
423
424$OUTPUT->set_pagetitle(rcube_label('folders'));
425$OUTPUT->include_script('list.js');
426
427// register UI objects
428$OUTPUT->add_handlers(array(
429  'foldersubscription' => 'rcube_subscription_form',
430  'createfolder' => 'rcube_create_folder_form',
431  'renamefolder' => 'rcube_rename_folder_form'
432));
433
434// add some labels to client
435$OUTPUT->add_label('deletefolderconfirm','addsubfolderhint','forbiddencharacter','folderdeleting','folderrenaming','foldercreating','foldermoving');
436
437$OUTPUT->send('managefolders');
438
Note: See TracBrowser for help on using the repository browser.