plugins/sent_subfolders/setup.php

   1 <?php
   2
   3 /**
   4  * setup.php -- Sent Subfolders Setup File
   5  *
   6  * Copyright (c) 1999-2002 The SquirrelMail Project Team
   7  * Licensed under the GNU GPL. For full terms see the file COPYING.
   8  *
   9  * This is a standard Squirrelmail-1.2 API for plugins.
  10  *
  11  * $Id$
  12  */
  13
  14 define('SMPREF_SENT_SUBFOLDERS_DISABLED',  0);
  15 define('SMPREF_SENT_SUBFOLDERS_YEARLY',    1);
  16 define('SMPREF_SENT_SUBFOLDERS_QUARTERLY', 2);
  17 define('SMPREF_SENT_SUBFOLDERS_MONTHLY',   3);
  18 define('SMOPT_GRP_SENT_SUBFOLDERS','SENT_SUBFOLDERS');
  19
  20 function squirrelmail_plugin_init_sent_subfolders() {
  21     /* Standard initialization API. */
  22     global $squirrelmail_plugin_hooks;
  23
  24     /* The hooks to make the sent subfolders display correctly. */
  25     $squirrelmail_plugin_hooks
  26     ['check_handleAsSent_result']['sent_subfolders'] =
  27         'sent_subfolders_check_handleAsSent';
  28
  29     /* The hooks to automatically update sent subfolders. */
  30     $squirrelmail_plugin_hooks
  31     ['left_main_before']['sent_subfolders'] =
  32         'sent_subfolders_update_sentfolder';
  33
  34     $squirrelmail_plugin_hooks
  35     ['compose_send']['sent_subfolders'] =
  36         'sent_subfolders_update_sentfolder';
  37
  38     /* The hook to load the sent subfolders prefs. */
  39     $squirrelmail_plugin_hooks
  40     ['loading_prefs']['sent_subfolders'] =
  41         'sent_subfolders_load_prefs';
  42
  43     /* The hooks to handle sent subfolders options. */
  44     $squirrelmail_plugin_hooks
  45     ['optpage_loadhook_folder']['sent_subfolders'] =
  46         'sent_subfolders_optpage_loadhook_folders';
  47 }
  48
  49 function sent_subfolders_check_handleAsSent() {
  50     global $handleAsSent_result, $sent_subfolders_base;
  51     global $use_sent_subfolders;
  52     $sent_subfolders_base = 'INBOX.Sent';
  53     $args = func_get_arg(0);
  54
  55     /* Only check the folder string if we have been passed a mailbox. */
  56     if ($use_sent_subfolders && (count($args) > 1)) {
  57         /* Chop up the folder strings as needed. */
  58         $base_str = $sent_subfolders_base . $delimiter;
  59         $mbox_str = substr($args[1], 0, strlen($base_str));
  60
  61         /* Perform the comparison. */
  62         $handleAsSent_result =
  63             ( $handleAsSent_result
  64             || ($base_str == $mbox_str)
  65             || ($sent_subfolders_base == $args[1])
  66             );
  67     }
  68 }
  69
  70 function sent_subfolders_load_prefs() {
  71     global $use_sent_subfolders;
  72     global $sent_subfolders_setting, $sent_subfolders_base;
  73
  74     $use_sent_subfolders = getPref
  75     ($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF);
  76
  77     $sent_subfolders_setting = getPref
  78     ($data_dir, $username, 'sent_subfolders_setting', SMPREF_SENT_SUBFOLDERS_DISABLED);
  79
  80     $sent_subfolders_base = getPref
  81     ($data_dir, $username, 'sent_subfolders_base', SMPREF_NONE);
  82 }
  83
  84 function sent_subfolders_optpage_loadhook_folders() {
  85     global $optpage_data, $username, $key, $imapServerAddress, $imapPort;
  86
  87     /* Get some imap data we need later. */
  88     $imapConnection =
  89         sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
  90     $boxes = sqimap_mailbox_list($imapConnection);
  91     sqimap_logout($imapConnection);
  92
  93     /* Load the Sent Subfolder Options into an array. */
  94     $optgrp = _("Sent Subfolders Options");
  95     $optvals = array();
  96
  97     $optvals[] = array(
  98         'name'    => 'sent_subfolders_setting',
  99         'caption' => _("Use Sent Subfolders"),
 100         'type'    => SMOPT_TYPE_STRLIST,
 101         'refresh' => SMOPT_REFRESH_FOLDERLIST,
 102         'posvals' => array(SMPREF_SENT_SUBFOLDERS_DISABLED  => _("Disabled"),
 103                         SMPREF_SENT_SUBFOLDERS_MONTHLY   => _("Monthly"),
 104                         SMPREF_SENT_SUBFOLDERS_QUARTERLY => _("Quarterly"),
 105                         SMPREF_SENT_SUBFOLDERS_YEARLY    => _("Yearly")),
 106         'save'    => 'save_option_sent_subfolders_setting'
 107     );
 108
 109     $sent_subfolders_base_values = array();
 110     foreach ($boxes as $folder) {
 111         if (strtolower($folder['unformatted']) != 'inbox') {
 112             $real_value = $folder['unformatted-dm'];
 113             $disp_value = str_replace(' ', '&nbsp;', $folder['formatted']);
 114             $sent_subfolders_base_values[$real_value] = $disp_value;
 115         }
 116     }
 117
 118     $optvals[] = array(
 119         'name'    => 'sent_subfolders_base',
 120         'caption' => _("Base Sent Folder"),
 121         'type'    => SMOPT_TYPE_STRLIST,
 122         'refresh' => SMOPT_REFRESH_FOLDERLIST,
 123         'posvals' => $sent_subfolders_base_values
 124     );
 125
 126     /* Add our option data to the global array. */
 127     $optpage_data['grps'][SMOPT_GRP_SENT_SUBFOLDERS] = $optgrp;
 128     $optpage_data['vals'][SMOPT_GRP_SENT_SUBFOLDERS] = $optvals;
 129 }
 130
 131 function save_option_sent_subfolders_setting($option) {
 132     global $data_dir, $username, $use_sent_subfolders;
 133
 134     /* Set use_sent_subfolders as either on or off. */
 135     if ($option->new_value == SMPREF_SENT_SUBFOLDERS_DISABLED) {
 136         setPref($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF);
 137     } else {
 138         setPref($data_dir, $username, 'use_sent_subfolders', SMPREF_ON);
 139         setPref($data_dir, $username, 'move_to_sent', SMPREF_ON);
 140     }
 141
 142     /* Now just save the option as normal. */
 143     save_option($option);
 144 }
 145
 146 function sent_subfolders_update_sentfolder() {
 147     global $sent_folder, $delimiter, $auto_create_special, $auto_create_done;
 148     global $sent_subfolders_base, $sent_subfolders_setting;
 149     global $username, $data_dir, $key, $imapServerAddress, $imapPort;
 150     global $use_sent_subfolders, $move_to_sent;
 151
 152     if ($use_sent_subfolders || $move_to_sent) {
 153         $year = date('Y');
 154         $month = date('m');
 155         $quarter = sent_subfolder_getQuarter($month);
 156
 157         /*
 158             Regarding the structure we've got three main possibilities.
 159             One sent holder. level 0.
 160             Multiple year holders with messages in it. level 1.
 161             Multiple year folders with holders in it. level 2.
 162         */
 163         switch ($sent_subfolders_setting) {
 164         case SMPREF_SENT_SUBFOLDERS_YEARLY:
 165             $level = 1;
 166             $sent_subfolder = $sent_subfolders_base
 167                             . $year;
 168             $year_folder = $sent_subfolder;
 169             break;
 170         case SMPREF_SENT_SUBFOLDERS_QUARTERLY:
 171             $level = 2;
 172             $sent_subfolder = $sent_subfolders_base
 173                             . $year
 174                             . $delimiter . $quarter;
 175             $year_folder = $sent_subfolders_base
 176                             . $delimiter . $year;
 177             break;
 178         case SMPREF_SENT_SUBFOLDERS_MONTHLY:
 179             $level = 2;
 180             $sent_subfolder = $sent_subfolders_base
 181                             . $year
 182                             . $delimiter . $month;
 183             $year_folder = $sent_subfolders_base
 184                             . $delimiter . $year;
 185             break;
 186         case SMPREF_SENT_SUBFOLDERS_DISABLED:
 187         default:
 188             $level = 0;
 189             $sent_subfolder = $sent_folder;
 190             $year_folder = $sent_folder;
 191         }
 192
 193         /* If this folder is NOT the current sent folder, update stuff. */
 194         if ($sent_subfolder != $sent_folder) {
 195             /* First, update the sent folder. */
 196
 197             setPref($data_dir, $username, 'sent_folder', $sent_subfolder);
 198             setPref($data_dir, $username, 'move_to_sent', SMPREF_ON);
 199             $sent_folder = $sent_subfolder;
 200             $move_to_sent = SMPREF_ON;
 201
 202             /* Auto-create folders, if they do not yet exist. */
 203             if ($sent_folder != 'none') {
 204                 /* Create the imap connection. */
 205                 $ic = sqimap_login
 206                 ($username, $key, $imapServerAddress, $imapPort, 10);
 207
 208                 /* Auto-create the year folder, if it does not yet exist. */
 209                 if (!sqimap_mailbox_exists($ic, $year_folder)) {
 210                     sqimap_mailbox_create($ic, $year_folder, ($level==1)?'':'noselect');
 211                 } else if (!sqimap_mailbox_is_subscribed($ic, $year_folder)) {
 212                     sqimap_subscribe($ic, $year_folder);
 213                 }
 214
 215                 /* Auto-create the subfolder, if it does not yet exist. */
 216                 if (!sqimap_mailbox_exists($ic, $sent_folder)) {
 217                     sqimap_mailbox_create($ic, $sent_folder, '');
 218                 } else if (!sqimap_mailbox_is_subscribed($ic, $sent_subfolder)) {
 219                     sqimap_subscribe($ic, $sent_subfolder);
 220                 }
 221
 222                 /* Close the imap connection. */
 223                 sqimap_logout($ic);
 224             }
 225         }
 226     }
 227 }
 228
 229 function sent_subfolder_getQuarter($month) {
 230     switch ($month) {
 231         case '01':
 232         case '02':
 233         case '03':
 234             $result = '1';
 235             break;
 236         case '04':
 237         case '05':
 238         case '06':
 239             $result = '2';
 240             break;
 241         case '07':
 242         case '08':
 243         case '09':
 244             $result = '3';
 245             break;
 246         case '10':
 247         case '11':
 248         case '12':
 249             $result = '4';
 250             break;
 251         default:
 252             $result = 'ERR';
 253     }
 254
 255     /* Return the current quarter. */
 256     return ('Q' . $result);
 257 }
 258
 259 ?>