Source for file folders.php

Documentation is available at folders.php

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

Documentation generated on Mon, 13 Jan 2020 04:22:30 +0100 by phpDocumentor 1.4.3