Happy New Year

[squirrelmail.git] / plugins / sent_subfolders / functions.php

diff --git a/plugins/sent_subfolders/functions.php b/plugins/sent_subfolders/functions.php
index 32699de512fb774c06faf34eb18cef679f4c206a..cdf2879bd7bdac476c2772c95b46549f99a64d8d 100644 (file)
--- a/plugins/sent_subfolders/functions.php
+++ b/plugins/sent_subfolders/functions.php
@@ -5,7 +5,7 @@
  *
  * This is a standard SquirrelMail 1.2 API for plugins.
  *
  *
  * This is a standard SquirrelMail 1.2 API for plugins.
  *

- * @copyright © 1999-2007 The SquirrelMail Project Team
+ * @copyright 1999-2020 The SquirrelMail Project Team

  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package plugins
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package plugins


@@ -20,7 +20,7 @@ define('SMOPT_GRP_SENT_SUBFOLDERS','SENT_SUBFOLDERS');
 
 function sent_subfolders_check_handleAsSent_do($mailbox) {
 
 
 function sent_subfolders_check_handleAsSent_do($mailbox) {
 

-    global $handleAsSent_result;
+    global $handleAsSent_result, $data_dir, $username, $sent_folder;

 
     // don't need to bother if it's already special
     if ($handleAsSent_result) return;
 
     // don't need to bother if it's already special
     if ($handleAsSent_result) return;


@@ -30,7 +30,7 @@ function sent_subfolders_check_handleAsSent_do($mailbox) {
     $use_sent_subfolders = getPref($data_dir, $username,
                                    'use_sent_subfolders', SMPREF_OFF);
     $sent_subfolders_base = getPref($data_dir, $username,
     $use_sent_subfolders = getPref($data_dir, $username,
                                    'use_sent_subfolders', SMPREF_OFF);
     $sent_subfolders_base = getPref($data_dir, $username,

-                                    'sent_subfolders_base', SMPREF_NONE);
+                                    'sent_subfolders_base', $sent_folder);

 
     /* Only check the folder string if we have been passed a mailbox. */
     if ($use_sent_subfolders && !empty($mailbox)) {
 
     /* Only check the folder string if we have been passed a mailbox. */
     if ($use_sent_subfolders && !empty($mailbox)) {


@@ -49,11 +49,11 @@ function sent_subfolders_check_handleAsSent_do($mailbox) {
  */
 function sent_subfolders_optpage_loadhook_folders_do() {
 
  */
 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, $imap_stream_options, $show_contain_subfolders_option, $sent_folder;

 
     /* Get some imap data we need later. */
 
     /* Get some imap data we need later. */

-    $imapConnection = sqimap_login($username, false, $imapServerAddress, $imapPort, 0);
+    $imapConnection = sqimap_login($username, false, $imapServerAddress, $imapPort, 0, $imap_stream_options);

     $boxes = sqimap_mailbox_list($imapConnection);
     sqimap_logout($imapConnection);
 
     $boxes = sqimap_mailbox_list($imapConnection);
     sqimap_logout($imapConnection);
 


@@ -82,14 +82,15 @@ function sent_subfolders_optpage_loadhook_folders_do() {
 
     global $sent_subfolders_base;
     $sent_subfolders_base = getPref($data_dir, $username,
 
     global $sent_subfolders_base;
     $sent_subfolders_base = getPref($data_dir, $username,

-                                    'sent_subfolders_base', SMPREF_NONE);
+                                    '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,
     $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) {
     );
 
     if ($show_contain_subfolders_option) {


@@ -130,12 +131,27 @@ function save_option_sent_subfolders_setting($option) {
     } else {
         setPref($data_dir, $username, 'use_sent_subfolders', SMPREF_ON);
         setPref($data_dir, $username, 'move_to_sent', SMPREF_ON);
     } else {
         setPref($data_dir, $username, 'use_sent_subfolders', SMPREF_ON);
         setPref($data_dir, $username, 'move_to_sent', SMPREF_ON);

+        $check_sent_subfolders_base = getPref($data_dir, $username, 'sent_subfolders_base', '');
+        if ($check_sent_subfolders_base === '') {
+            setPref($data_dir, $username, 'sent_subfolders_base', $sent_subfolders_base);
+        }

     }
 
     /* Now just save the option as normal. */
     save_option($option);
 }
 
     }
 
     /* Now just save the option as normal. */
     save_option($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
  *
 /**
  * Update sent_subfolders settings
  *


@@ -145,7 +161,7 @@ function save_option_sent_subfolders_setting($option) {
 function sent_subfolders_update_sentfolder_do() {
     global $sent_folder, $username,
            $data_dir, $imapServerAddress, $imapPort,
 function sent_subfolders_update_sentfolder_do() {
     global $sent_folder, $username,
            $data_dir, $imapServerAddress, $imapPort,

-           $move_to_sent;
+           $imap_stream_options, $move_to_sent;

 
     sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
 
 
     sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
 


@@ -155,7 +171,7 @@ function sent_subfolders_update_sentfolder_do() {
                                        'sent_subfolders_setting',
                                        SMPREF_SENT_SUBFOLDERS_DISABLED);
     $sent_subfolders_base = getPref($data_dir, $username,
                                        'sent_subfolders_setting',
                                        SMPREF_SENT_SUBFOLDERS_DISABLED);
     $sent_subfolders_base = getPref($data_dir, $username,

-                                    'sent_subfolders_base', SMPREF_NONE);
+                                    'sent_subfolders_base', $sent_folder);

 
     if ($use_sent_subfolders || $move_to_sent) {
         $year = date('Y');
 
     if ($use_sent_subfolders || $move_to_sent) {
         $year = date('Y');


@@ -202,7 +218,7 @@ function sent_subfolders_update_sentfolder_do() {
             /* Auto-create folders, if they do not yet exist. */
             if ($sent_subfolder != 'none') {
                 /* Create the imap connection. */
             /* Auto-create folders, if they do not yet exist. */
             if ($sent_subfolder != 'none') {
                 /* Create the imap connection. */

-                $ic = sqimap_login($username, false, $imapServerAddress, $imapPort, 10);
+                $ic = sqimap_login($username, false, $imapServerAddress, $imapPort, 10, $imap_stream_options);

 
                 $boxes = false;
                 /**
 
                 $boxes = false;
                 /**


@@ -213,7 +229,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)) {
                 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. */
                 } else {
                     if ($level==2) {
                         /* Auto-create the year folder, if it does not yet exist. */


@@ -232,9 +248,18 @@ function sent_subfolders_update_sentfolder_do() {
                     } else if (!sqimap_mailbox_is_subscribed($ic, $sent_subfolder)) {
                         sqimap_subscribe($ic, $sent_subfolder);
                     }
                     } 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;
                 }
                     $sent_folder = $sent_subfolder;
                     $move_to_sent = SMPREF_ON;
                 }


@@ -289,14 +314,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) {
  * @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);
 
 
     sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
 
     $use_sent_subfolders = getPref($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF);
 

-//FIXME: why "na" as the default?  Shouldn't this be SMPREF_NONE as it is elsewhere in this file?
-    $sent_subfolders_base = getPref($data_dir, $username, 'sent_subfolders_base', 'na');
+    $sent_subfolders_base = getPref($data_dir, $username, 'sent_subfolders_base', $sent_folder);

 
     /**
      * If sent_subfolders are used and mailbox is equal to subfolder base 
 
     /**
      * If sent_subfolders are used and mailbox is equal to subfolder base