plugins/sent_subfolders/setup.php

   1 <?php
   2
   3 /**
   4  * setup.php -- Sent Subfolders Setup File
   5  *
   6  * This is a standard SquirrelMail 1.2 API for plugins.
   7  *
   8  * @copyright &copy; 1999-2006 The SquirrelMail Project Team
   9  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  10  * @version $Id$
  11  * @package plugins
  12  * @subpackage sent_subfolders
  13  */
  14
  15 /**
  16  */
  17 define('SMPREF_SENT_SUBFOLDERS_DISABLED',  0);
  18 define('SMPREF_SENT_SUBFOLDERS_YEARLY',    1);
  19 define('SMPREF_SENT_SUBFOLDERS_QUARTERLY', 2);
  20 define('SMPREF_SENT_SUBFOLDERS_MONTHLY',   3);
  21 define('SMOPT_GRP_SENT_SUBFOLDERS','SENT_SUBFOLDERS');
  22
  23 /**
  24  * Adds plugin to SquirrelMail's hooks
  25  */
  26 function squirrelmail_plugin_init_sent_subfolders() {
  27     /* Standard initialization API. */
  28     global $squirrelmail_plugin_hooks;
  29
  30     /* The hooks to make the sent subfolders display correctly. */
  31     $squirrelmail_plugin_hooks
  32     ['check_handleAsSent_result']['sent_subfolders'] =
  33         'sent_subfolders_check_handleAsSent';
  34
  35     /* The hooks to automatically update sent subfolders. */
  36     $squirrelmail_plugin_hooks
  37     ['left_main_before']['sent_subfolders'] =
  38         'sent_subfolders_update_sentfolder';
  39
  40     $squirrelmail_plugin_hooks
  41     ['compose_send']['sent_subfolders'] =
  42         'sent_subfolders_update_sentfolder';
  43
  44     /* The hook to load the sent subfolders prefs. */
  45     $squirrelmail_plugin_hooks
  46     ['loading_prefs']['sent_subfolders'] =
  47         'sent_subfolders_load_prefs';
  48
  49     /* The hooks to handle sent subfolders options. */
  50     $squirrelmail_plugin_hooks
  51     ['optpage_loadhook_folder']['sent_subfolders'] =
  52         'sent_subfolders_optpage_loadhook_folders';
  53
  54     /* mark base sent folder as special mailbox */
  55     $squirrelmail_plugin_hooks
  56     ['special_mailbox']['sent_subfolders'] =
  57         'sent_subfolders_special_mailbox';
  58 }
  59
  60 function sent_subfolders_check_handleAsSent() {
  61     global $handleAsSent_result, $sent_subfolders_base,
  62            $use_sent_subfolders;
  63
  64     $sent_subfolders_base = 'INBOX.Sent';
  65     $args = func_get_arg(0);
  66     sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
  67
  68     /* Only check the folder string if we have been passed a mailbox. */
  69     if ($use_sent_subfolders && (count($args) > 1)) {
  70         /* Chop up the folder strings as needed. */
  71         $base_str = $sent_subfolders_base . $delimiter;
  72         $mbox_str = substr($args[1], 0, strlen($base_str));
  73
  74         /* Perform the comparison. */
  75         $handleAsSent_result =
  76             ( $handleAsSent_result
  77             || ($base_str == $mbox_str)
  78             || ($sent_subfolders_base == $args[1])
  79             );
  80     }
  81 }
  82
  83 /**
  84  * Loads sent_subfolders settings
  85  */
  86 function sent_subfolders_load_prefs() {
  87     global $use_sent_subfolders, $data_dir, $username,
  88            $sent_subfolders_setting, $sent_subfolders_base;
  89
  90     $use_sent_subfolders = getPref
  91     ($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF);
  92
  93     $sent_subfolders_setting = getPref
  94     ($data_dir, $username, 'sent_subfolders_setting', SMPREF_SENT_SUBFOLDERS_DISABLED);
  95
  96     $sent_subfolders_base = getPref
  97     ($data_dir, $username, 'sent_subfolders_base', SMPREF_NONE);
  98 }
  99
 100 /**
 101  * Adds sent_subfolders options in folder preferences
 102  */
 103 function sent_subfolders_optpage_loadhook_folders() {
 104     global $optpage_data, $imapServerAddress, $imapPort, $show_contain_subfolders_option;
 105
 106     sqgetGlobalVar('username', $username, SQ_SESSION);
 107
 108     /* Get some imap data we need later. */
 109     $imapConnection = sqimap_login($username, false, $imapServerAddress, $imapPort, 0);
 110     $boxes = sqimap_mailbox_list($imapConnection);
 111     sqimap_logout($imapConnection);
 112
 113     /* Load the Sent Subfolder Options into an array. */
 114     $optgrp = _("Sent Subfolders Options");
 115     $optvals = array();
 116
 117     $optvals[] = array(
 118         'name'    => 'sent_subfolders_setting',
 119         'caption' => _("Use Sent Subfolders"),
 120         'type'    => SMOPT_TYPE_STRLIST,
 121         'refresh' => SMOPT_REFRESH_FOLDERLIST,
 122         'posvals' => array(SMPREF_SENT_SUBFOLDERS_DISABLED  => _("Disabled"),
 123                         SMPREF_SENT_SUBFOLDERS_MONTHLY   => _("Monthly"),
 124                         SMPREF_SENT_SUBFOLDERS_QUARTERLY => _("Quarterly"),
 125                         SMPREF_SENT_SUBFOLDERS_YEARLY    => _("Yearly")),
 126         'save'    => 'save_option_sent_subfolders_setting'
 127     );
 128
 129     $filtered_folders=array_filter($boxes, "filter_folders");
 130     $sent_subfolders_base_values = array('whatever'=>$filtered_folders);
 131
 132     $optvals[] = array(
 133         'name'    => 'sent_subfolders_base',
 134         'caption' => _("Base Sent Folder"),
 135         'type'    => SMOPT_TYPE_FLDRLIST,
 136         'refresh' => SMOPT_REFRESH_FOLDERLIST,
 137         'posvals' => $sent_subfolders_base_values,
 138         'folder_filter' => 'noinferiors'
 139     );
 140
 141     if ($show_contain_subfolders_option) {
 142         $optvals[] = array(
 143             'name' => 'sent_subfolders_warning',
 144             'caption' => _("Warning"),
 145             'type' => SMOPT_TYPE_COMMENT,
 146             'comment' => _("There are some restrictions in Sent Subfolder options.")
 147             );
 148     }
 149
 150     /* Add our option data to the global array. */
 151     $optpage_data['grps'][SMOPT_GRP_SENT_SUBFOLDERS] = $optgrp;
 152     $optpage_data['vals'][SMOPT_GRP_SENT_SUBFOLDERS] = $optvals;
 153 }
 154
 155 /**
 156  * Defines folder filtering rules
 157  *
 158  * Callback function that should exclude some folders from folder listing.
 159  * @param array $fldr list of folders. See sqimap_mailbox_list
 160  * @return boolean returns true, if folder has to included in folder listing
 161  * @access private
 162  */
 163 function filter_folders($fldr) {
 164     return strtolower($fldr['unformatted'])!='inbox';
 165 }
 166
 167 /**
 168  * Saves sent_subfolder_options
 169  */
 170 function save_option_sent_subfolders_setting($option) {
 171     global $data_dir, $username, $use_sent_subfolders;
 172
 173     /* Set use_sent_subfolders as either on or off. */
 174     if ($option->new_value == SMPREF_SENT_SUBFOLDERS_DISABLED) {
 175         setPref($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF);
 176     } else {
 177         setPref($data_dir, $username, 'use_sent_subfolders', SMPREF_ON);
 178         setPref($data_dir, $username, 'move_to_sent', SMPREF_ON);
 179     }
 180
 181     /* Now just save the option as normal. */
 182     save_option($option);
 183 }
 184
 185 /**
 186  * Update sent_subfolders settings
 187  *
 188  * function updates default sent folder value and
 189  * creates required imap folders
 190  */
 191 function sent_subfolders_update_sentfolder() {
 192     global $sent_folder;
 193     global $sent_subfolders_base, $sent_subfolders_setting;
 194     global $data_dir, $imapServerAddress, $imapPort, $color;
 195     global $use_sent_subfolders, $move_to_sent;
 196
 197     sqgetGlobalVar('username', $username, SQ_SESSION);
 198     sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
 199
 200     if ($use_sent_subfolders || $move_to_sent) {
 201         $year = date('Y');
 202         $month = date('m');
 203         $quarter = sent_subfolder_getQuarter($month);
 204
 205         /**
 206          * Regarding the structure we've got three main possibilities.
 207          * One sent holder. level 0.
 208          * Multiple year holders with messages in it. level 1.
 209          * Multiple year folders with holders in it. level 2.
 210          */
 211         $cnd_delimiter = $delimiter;
 212
 213         switch ($sent_subfolders_setting) {
 214         case SMPREF_SENT_SUBFOLDERS_YEARLY:
 215             $level = 1;
 216             $sent_subfolder = $sent_subfolders_base . $cnd_delimiter
 217                             . $year;
 218             break;
 219         case SMPREF_SENT_SUBFOLDERS_QUARTERLY:
 220             $level = 2;
 221             $sent_subfolder = $sent_subfolders_base . $cnd_delimiter
 222                             . $year
 223                             . $delimiter . $quarter;
 224             $year_folder = $sent_subfolders_base . $cnd_delimiter
 225                             . $year;
 226             break;
 227         case SMPREF_SENT_SUBFOLDERS_MONTHLY:
 228             $level = 2;
 229             $sent_subfolder = $sent_subfolders_base . $cnd_delimiter
 230                             . $year
 231                             . $delimiter . $month;
 232             $year_folder = $sent_subfolders_base. $cnd_delimiter . $year;
 233             break;
 234         case SMPREF_SENT_SUBFOLDERS_DISABLED:
 235         default:
 236             $level = 0;
 237             $sent_subfolder = $sent_folder;
 238             $year_folder = $sent_folder;
 239         }
 240
 241         /* If this folder is NOT the current sent folder, update stuff. */
 242         if ($sent_subfolder != $sent_folder) {
 243             /* Auto-create folders, if they do not yet exist. */
 244             if ($sent_subfolder != 'none') {
 245                 /* Create the imap connection. */
 246                 $ic = sqimap_login($username, false, $imapServerAddress, $imapPort, 10);
 247
 248                 $boxes = false;
 249                 /**
 250                  * If sent_subfolder can't store messages (noselect) ||
 251                  * year_folder can't store subfolders (noinferiors) in level=2 setup ||
 252                  * subfolder_base can't store subfolders (noinferiors), setup is broken
 253                  */
 254                 if (sqimap_mailbox_is_noselect($ic,$sent_subfolder,$boxes) ||
 255                     ($level==2 && sqimap_mailbox_is_noinferiors($ic,$year_folder,$boxes)) ||
 256                      sqimap_mailbox_is_noinferiors($ic,$sent_subfolders_base,$boxes)) {
 257                     error_box(_("Sent Subfolders plugin is misconfigured."),$color);
 258                 } else {
 259                     if ($level==2) {
 260                         /* Auto-create the year folder, if it does not yet exist. */
 261                         if (!sqimap_mailbox_exists($ic, $year_folder)) {
 262                             sqimap_mailbox_create($ic, $year_folder, 'noselect');
 263                             // TODO: safety check for imap servers that can't create subfolders
 264
 265                         } else if (!sqimap_mailbox_is_subscribed($ic, $year_folder)) {
 266                             sqimap_subscribe($ic, $year_folder);
 267                         }
 268                     }
 269
 270                     /* Auto-create the subfolder, if it does not yet exist. */
 271                     if (!sqimap_mailbox_exists($ic, $sent_subfolder)) {
 272                         sqimap_mailbox_create($ic, $sent_subfolder, '');
 273                     } else if (!sqimap_mailbox_is_subscribed($ic, $sent_subfolder)) {
 274                         sqimap_subscribe($ic, $sent_subfolder);
 275                     }
 276                     /* Update sent_folder setting. */
 277                     setPref($data_dir, $username, 'sent_folder', $sent_subfolder);
 278                     setPref($data_dir, $username, 'move_to_sent', SMPREF_ON);
 279                     $sent_folder = $sent_subfolder;
 280                     $move_to_sent = SMPREF_ON;
 281                 }
 282                 /* Close the imap connection. */
 283                 sqimap_logout($ic);
 284             }
 285
 286         }
 287     }
 288 }
 289
 290 /**
 291  * Sets quarter subfolder names
 292  *
 293  * @param string $month numeric month
 294  * @return string quarter name (Q + number)
 295  */
 296 function sent_subfolder_getQuarter($month) {
 297     switch ($month) {
 298         case '01':
 299         case '02':
 300         case '03':
 301             $result = '1';
 302             break;
 303         case '04':
 304         case '05':
 305         case '06':
 306             $result = '2';
 307             break;
 308         case '07':
 309         case '08':
 310         case '09':
 311             $result = '3';
 312             break;
 313         case '10':
 314         case '11':
 315         case '12':
 316             $result = '4';
 317             break;
 318         default:
 319             $result = 'ERR';
 320     }
 321
 322     /* Return the current quarter. */
 323     return ('Q' . $result);
 324 }
 325
 326 /**
 327  * detects if mailbox is part of sent_subfolders
 328  *
 329  * @param string $mb imap folder name
 330  * @return boolean 1 - is part of sent_subfolders, 0 - is not part of sent_subfolders
 331  */
 332 function sent_subfolders_special_mailbox($mb) {
 333     global $data_dir, $username, $delimiter;
 334
 335     $use_sent_subfolders = getPref
 336         ($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF);
 337     $sent_subfolders_base = getPref($data_dir, $username, 'sent_subfolders_base', 'na');
 338
 339     /**
 340      * If sent_subfolders are used and mailbox is equal to subfolder base
 341      * or mailbox matches subfolder base + delimiter.
 342      */
 343     if ($use_sent_subfolders == SMPREF_ON &&
 344     ($mb == $sent_subfolders_base || stristr($mb,$sent_subfolders_base . $delimiter) ) ) {
 345         return 1;
 346     }
 347     return 0;
 348 }
 349 ?>