src/folders.php

   1 <?php
   2
   3 /**
   4  * folders.php
   5  *
   6  * Handles all interaction between the user and the other folder
   7  * scripts which do most of the work. Also handles the Special
   8  * Folders.
   9  *
  10  * @copyright &copy; 1999-2006 The SquirrelMail Project Team
  11  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  12  * @version $Id$
  13  * @package squirrelmail
  14  */
  15
  16 /**
  17  * Include the SquirrelMail initialization file.
  18  */
  19 require('../include/init.php');
  20
  21 /* SquirrelMail required files. */
  22 require_once(SM_PATH . 'functions/imap_general.php');
  23 require_once(SM_PATH . 'functions/folder_manip.php');
  24 require_once(SM_PATH . 'functions/forms.php');
  25
  26 displayPageHeader($color, 'None');
  27
  28 /* get globals we may need */
  29 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
  30 sqgetGlobalVar('smaction', $action, SQ_POST);
  31
  32 /* end of get globals */
  33
  34 $imapConnection = sqimap_login ($username, false, $imapServerAddress, $imapPort, 0);
  35
  36 /* switch to the right function based on what the user selected */
  37 if ( sqgetGlobalVar('smaction', $action, SQ_POST) ) {
  38
  39     switch ($action)
  40     {
  41         case 'create':
  42             sqgetGlobalVar('folder_name',  $folder_name,  SQ_POST);
  43             sqgetGlobalVar('subfolder',    $subfolder,    SQ_POST);
  44             sqgetGlobalVar('contain_subs', $contain_subs, SQ_POST);
  45             folders_create($imapConnection, $delimiter, $folder_name, $subfolder, $contain_subs);
  46             $td_str =  _("Created folder successfully.");
  47             break;
  48         case 'rename':
  49             if ( sqgetGlobalVar('cancelbutton', $dummy, SQ_POST) ) {
  50                 break;
  51             }
  52             if ( ! sqgetGlobalVar('new_name', $new_name, SQ_POST) ) {
  53                 sqgetGlobalVar('old_name',    $old_name, SQ_POST);
  54                 folders_rename_getname($imapConnection, $delimiter, $old_name);
  55             } else {
  56                 sqgetGlobalVar('orig',        $orig,     SQ_POST);
  57                 sqgetGlobalVar('old_name',    $old_name, SQ_POST);
  58                 folders_rename_do($imapConnection, $delimiter, $orig, $old_name, $new_name);
  59                 $td_str =  _("Renamed successfully.");
  60             }
  61             break;
  62         case 'delete':
  63             if ( sqgetGlobalVar('cancelbutton', $dummy, SQ_POST) ) {
  64                 break;
  65             }
  66             sqgetGlobalVar('folder_name',  $folder_name,  SQ_POST);
  67             if ( sqgetGlobalVar('confirmed', $dummy, SQ_POST) ) {
  68                 folders_delete_do($imapConnection, $delimiter, $folder_name);
  69                 $td_str =  _("Deleted folder successfully.");
  70             } else {
  71                 folders_delete_ask($imapConnection, $folder_name);
  72             }
  73             break;
  74         case 'subscribe':
  75             sqgetGlobalVar('folder_names',  $folder_names,  SQ_POST);
  76             folders_subscribe($imapConnection, $folder_names);
  77             $td_str =  _("Subscribed successfully.");
  78             break;
  79         case 'unsubscribe':
  80             sqgetGlobalVar('folder_names',  $folder_names,  SQ_POST);
  81             folders_unsubscribe($imapConnection, $folder_names);
  82             $td_str =  _("Unsubscribed successfully.");
  83             break;
  84         default:
  85             // TODO: add hook for plugin action processing.
  86             $td_str = '';
  87             break;
  88     }
  89
  90 }
  91
  92 $boxes = sqimap_mailbox_list($imapConnection,true);
  93
  94 /** CREATING FOLDERS **/
  95
  96 $show_selected = array();
  97 $skip_folders = array();
  98 $server_type = strtolower($imap_server_type);
  99
 100 // Special handling for courier
 101 if ( $server_type == 'courier' ) {
 102     if ( $default_folder_prefix == 'INBOX.' ) {
 103         // We don't need INBOX, since it is top folder
 104         array_push($skip_folders, 'INBOX');
 105     }
 106 } elseif ( $server_type == 'bincimap' ) {
 107     if ( $default_folder_prefix == 'INBOX/' ) {
 108         // We don't need INBOX, since it is top folder
 109         array_push($skip_folders, 'INBOX');
 110     }
 111 }
 112
 113 if ( $default_sub_of_inbox == false ) {
 114     $mbx_option_list = '<option selected="selected" value="">[ '._("None")." ]</option>\n";
 115 } else {
 116     $mbx_option_list = '<option value="">[ '._("None")." ]</option>\n";
 117     $show_selected = array('inbox');
 118 }
 119
 120 // Call sqimap_mailbox_option_list, using existing connection to IMAP server,
 121 // the arrays of folders to include or skip (assembled above),
 122 // use 'noinferiors' as a mailbox filter to leave out folders that can not contain other folders.
 123 // use the long format to show subfolders in an intelligible way if parent is missing (special folder)
 124 $mbx_option_list .= sqimap_mailbox_option_list($imapConnection, $show_selected, $skip_folders, $boxes, 'noinferiors', true);
 125
 126
 127 /** count special folders **/
 128 foreach ($boxes as $index => $aBoxData) {
 129     if (isSpecialMailbox($aBoxData['unformatted'],false) &&
 130         ! in_array($aBoxData['unformatted'],$skip_folders)) {
 131         $skip_folders[] = $aBoxData['unformatted'];
 132     }
 133 }
 134
 135 /**
 136  * Retrieve list of folders when special folders are excluded. Special folders
 137  * should be unavailable in rename/delete/unsubscribe. Theoretically user can
 138  * modify form and perform these operations with special folders, but if user
 139  * manages to delete/rename/unsubscribe special folder by hacking form...
 140  *
 141  * If script or program depends on special folder, they should not assume that
 142  * folder is available.
 143  *
 144  * $filtered_folders contains empty string or html formated option list.
 145  */
 146 $rendel_folder_list = sqimap_mailbox_option_list($imapConnection, 0, $skip_folders, $boxes, NULL, true);
 147
 148
 149 $subbox_option_list = '';
 150
 151 if ($show_only_subscribed_folders && !$no_list_for_subscribe) {
 152     // FIXME: fix subscription options when top folder is not subscribed and sub folder is subscribed
 153     // TODO: use checkboxes instead of select options.
 154
 155     /** SUBSCRIBE TO FOLDERS **/
 156     $boxes_all = sqimap_mailbox_list_all ($imapConnection);
 157
 158     // here we filter out all boxes we're already subscribed to,
 159     // so we keep only the unsubscribed ones.
 160     foreach ($boxes_all as $box_a) {
 161
 162         $use_folder = true;
 163         foreach ( $boxes as $box ) {
 164             if ($box_a['unformatted'] == $box['unformatted'] ||
 165                 $box_a['unformatted-dm'] == $folder_prefix ) {
 166                 $use_folder = false;
 167             }
 168         }
 169
 170         if ($use_folder) {
 171             $box_enc  = htmlspecialchars($box_a['unformatted-dm']);
 172             $box_disp = htmlspecialchars(imap_utf7_decode_local($box_a['unformatted-disp']));
 173             $subbox_option_list .= '<option value="' . $box_enc . '">'.$box_disp."</option>\n";
 174         }
 175     }
 176 }
 177
 178 sqimap_logout($imapConnection);
 179
 180 $oTemplate->assign('td_str', @$td_str);
 181 $oTemplate->assign('color', $color);
 182 $oTemplate->assign('mbx_option_list', $mbx_option_list);
 183 $oTemplate->assign('show_contain_subfolders_option', $show_contain_subfolders_option);
 184 $oTemplate->assign('show_only_subscribed_folders', $show_only_subscribed_folders);
 185 $oTemplate->assign('rendel_folder_list', $rendel_folder_list);
 186 $oTemplate->assign('subbox_option_list', $subbox_option_list);
 187 $oTemplate->assign('no_list_for_subscribe', $no_list_for_subscribe);
 188
 189 $oTemplate->display('folder_manip.tpl');
 190
 191 $oTemplate->display('footer.tpl');
 192