Fixed broken RFC1918 reference in contrib/.htaccess and doc/.htaccess (#2798839).
[squirrelmail.git] / plugins / sent_subfolders / functions.php
index ae8140b..8225199 100644 (file)
@@ -5,59 +5,52 @@
  *
  * This is a standard SquirrelMail 1.2 API for plugins.
  *
- * @copyright © 1999-2007 The SquirrelMail Project Team
+ * @copyright © 1999-2009 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package plugins
  * @subpackage sent_subfolders
  */
 
-function sent_subfolders_check_handleAsSent_do() {
-    global $handleAsSent_result, $sent_subfolders_base,
-           $use_sent_subfolders;
+define('SMPREF_SENT_SUBFOLDERS_DISABLED',  0);
+define('SMPREF_SENT_SUBFOLDERS_YEARLY',    1);
+define('SMPREF_SENT_SUBFOLDERS_QUARTERLY', 2);
+define('SMPREF_SENT_SUBFOLDERS_MONTHLY',   3);
+define('SMOPT_GRP_SENT_SUBFOLDERS','SENT_SUBFOLDERS');
+
+function sent_subfolders_check_handleAsSent_do($mailbox) {
+
+    global $handleAsSent_result, $data_dir, $username, $sent_folder;
+
+    // don't need to bother if it's already special
+    if ($handleAsSent_result) return;
 
-    // FIXME: hardcoded folder
-    $sent_subfolders_base = 'INBOX.Sent';
-    $args = func_get_arg(0);
     sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
 
+    $use_sent_subfolders = getPref($data_dir, $username,
+                                   'use_sent_subfolders', SMPREF_OFF);
+    $sent_subfolders_base = getPref($data_dir, $username,
+                                    'sent_subfolders_base', $sent_folder);
+
     /* Only check the folder string if we have been passed a mailbox. */
-    if ($use_sent_subfolders && (count($args) > 1)) {
+    if ($use_sent_subfolders && !empty($mailbox)) {
         /* Chop up the folder strings as needed. */
         $base_str = $sent_subfolders_base . $delimiter;
-        $mbox_str = substr($args[1], 0, strlen($base_str));
+        $mbox_str = substr($mailbox, 0, strlen($base_str));
 
         /* Perform the comparison. */
-        $handleAsSent_result =
-            ( $handleAsSent_result
-            || ($base_str == $mbox_str)
-            || ($sent_subfolders_base == $args[1])
-            );
+        $handleAsSent_result = ( ($base_str == $mbox_str)
+                              || ($sent_subfolders_base == $mailbox) );
     }
 }
 
 /**
- * Loads sent_subfolders settings
- */
-function sent_subfolders_load_prefs_do() {
-    global $use_sent_subfolders, $data_dir, $username,
-           $sent_subfolders_setting, $sent_subfolders_base;
-
-    $use_sent_subfolders = getPref
-    ($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF);
-
-    $sent_subfolders_setting = getPref
-    ($data_dir, $username, 'sent_subfolders_setting', SMPREF_SENT_SUBFOLDERS_DISABLED);
-
-    $sent_subfolders_base = getPref
-    ($data_dir, $username, 'sent_subfolders_base', SMPREF_NONE);
-}
-
-/**
  * Adds sent_subfolders options in folder preferences
  */
 function sent_subfolders_optpage_loadhook_folders_do() {
-    global $username, $optpage_data, $imapServerAddress, $imapPort, $show_contain_subfolders_option;
+
+    global $data_dir, $username, $optpage_data, $imapServerAddress,
+           $imapPort, $show_contain_subfolders_option, $sent_folder;
 
     /* Get some imap data we need later. */
     $imapConnection = sqimap_login($username, false, $imapServerAddress, $imapPort, 0);
@@ -68,6 +61,10 @@ function sent_subfolders_optpage_loadhook_folders_do() {
     $optgrp = _("Sent Subfolders Options");
     $optvals = array();
 
+    global $sent_subfolders_setting;
+    $sent_subfolders_setting = getPref($data_dir, $username,
+                                       'sent_subfolders_setting',
+                                       SMPREF_SENT_SUBFOLDERS_DISABLED);
     $optvals[] = array(
         'name'    => 'sent_subfolders_setting',
         'caption' => _("Use Sent Subfolders"),
@@ -83,13 +80,17 @@ function sent_subfolders_optpage_loadhook_folders_do() {
     $filtered_folders=array_filter($boxes, "filter_folders");
     $sent_subfolders_base_values = array('whatever'=>$filtered_folders);
 
+    global $sent_subfolders_base;
+    $sent_subfolders_base = getPref($data_dir, $username,
+                                    'sent_subfolders_base', $sent_folder);
     $optvals[] = array(
         'name'    => 'sent_subfolders_base',
         'caption' => _("Base Sent Folder"),
         'type'    => SMOPT_TYPE_FLDRLIST,
         'refresh' => SMOPT_REFRESH_FOLDERLIST,
         'posvals' => $sent_subfolders_base_values,
-        'folder_filter' => 'noinferiors'
+        'folder_filter' => 'noinferiors',
+        'save'    => 'save_option_sent_subfolders_base'
     );
 
     if ($show_contain_subfolders_option) {
@@ -122,7 +123,7 @@ function filter_folders($fldr) {
  * Saves sent_subfolder_options
  */
 function save_option_sent_subfolders_setting($option) {
-    global $data_dir, $username, $use_sent_subfolders;
+    global $data_dir, $username;
 
     /* Set use_sent_subfolders as either on or off. */
     if ($option->new_value == SMPREF_SENT_SUBFOLDERS_DISABLED) {
@@ -137,19 +138,37 @@ function save_option_sent_subfolders_setting($option) {
 }
 
 /**
+ * Update the folder settings/auto-create new subfolder
+ */
+function save_option_sent_subfolders_base($option) {
+    // first save the option as normal
+    save_option($option);
+
+    // now update folder settings and auto-create first subfolder if needed
+    sent_subfolders_update_sentfolder_do();
+}
+
+/**
  * Update sent_subfolders settings
  *
  * function updates default sent folder value and
  * creates required imap folders
  */
 function sent_subfolders_update_sentfolder_do() {
-    global $sent_folder, $username;
-    global $sent_subfolders_base, $sent_subfolders_setting;
-    global $data_dir, $imapServerAddress, $imapPort;
-    global $use_sent_subfolders, $move_to_sent;
+    global $sent_folder, $username,
+           $data_dir, $imapServerAddress, $imapPort,
+           $move_to_sent;
 
     sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
 
+    $use_sent_subfolders = getPref($data_dir, $username,
+                                   'use_sent_subfolders', SMPREF_OFF);
+    $sent_subfolders_setting = getPref($data_dir, $username,
+                                       'sent_subfolders_setting',
+                                       SMPREF_SENT_SUBFOLDERS_DISABLED);
+    $sent_subfolders_base = getPref($data_dir, $username,
+                                    'sent_subfolders_base', $sent_folder);
+
     if ($use_sent_subfolders || $move_to_sent) {
         $year = date('Y');
         $month = date('m');
@@ -206,7 +225,7 @@ function sent_subfolders_update_sentfolder_do() {
                 if (sqimap_mailbox_is_noselect($ic,$sent_subfolder,$boxes) ||
                     ($level==2 && sqimap_mailbox_is_noinferiors($ic,$year_folder,$boxes)) ||
                      sqimap_mailbox_is_noinferiors($ic,$sent_subfolders_base,$boxes)) {
-                    error_box(_("Sent Subfolders plugin is misconfigured."));
+                    error_box(_("Sent subfolders options are misconfigured."));
                 } else {
                     if ($level==2) {
                         /* Auto-create the year folder, if it does not yet exist. */
@@ -225,9 +244,18 @@ function sent_subfolders_update_sentfolder_do() {
                     } else if (!sqimap_mailbox_is_subscribed($ic, $sent_subfolder)) {
                         sqimap_subscribe($ic, $sent_subfolder);
                     }
-                    /* Update sent_folder setting. */
-                    //setPref($data_dir, $username, 'sent_folder', $sent_subfolder);
-                    //setPref($data_dir, $username, 'move_to_sent', SMPREF_ON);
+                    /* Update sent_folder setting in prefs only if the base
+                       subfolders setting is not the same as the normal sent
+                       folder...  otherwise, it is quite misleading to the user.
+                       If the sent folder is the same as the subfolders base, it's
+                       OK to leave the sent folder as is.
+                       The sent_folder setting itself needs to be the actual
+                       subfolder (not the base) for proper functionality */
+                    if ($sent_subfolders_base != $sent_folder) {
+                        setPref($data_dir, $username, 'sent_folder', $sent_subfolders_base);
+                        setPref($data_dir, $username, 'move_to_sent', SMPREF_ON);
+                        setPref($data_dir, $username, 'translate_special_folders', SMPREF_OFF);
+                    }
                     $sent_folder = $sent_subfolder;
                     $move_to_sent = SMPREF_ON;
                 }
@@ -282,13 +310,13 @@ function sent_subfolder_getQuarter($month) {
  * @return boolean 1 - is part of sent_subfolders, 0 - is not part of sent_subfolders
  */
 function sent_subfolders_special_mailbox_do($mb) {
-    global $data_dir, $username;
+    global $data_dir, $username, $sent_folder;
 
     sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
 
-    $use_sent_subfolders = getPref
-        ($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF);
-    $sent_subfolders_base = getPref($data_dir, $username, 'sent_subfolders_base', 'na');
+    $use_sent_subfolders = getPref($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF);
+
+    $sent_subfolders_base = getPref($data_dir, $username, 'sent_subfolders_base', $sent_folder);
 
     /**
      * If sent_subfolders are used and mailbox is equal to subfolder base