adding more charsets to sq_mb_list_encodings
[squirrelmail.git] / plugins / sent_subfolders / setup.php
CommitLineData
a3439b27 1<?php
2
3/**
4 * setup.php -- Sent Subfolders Setup File
5 *
598294a7 6 * This is a standard SquirrelMail 1.2 API for plugins.
a3439b27 7 *
4b4abf93 8 * @copyright &copy; 1999-2005 The SquirrelMail Project Team
9 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
4f51df66 10 * @version $Id$
ea5f4b8e 11 * @package plugins
12 * @subpackage sent_subfolders
a3439b27 13 */
14
91e0dccc 15/**
ea5f4b8e 16 */
a3439b27 17define('SMPREF_SENT_SUBFOLDERS_DISABLED', 0);
18define('SMPREF_SENT_SUBFOLDERS_YEARLY', 1);
19define('SMPREF_SENT_SUBFOLDERS_QUARTERLY', 2);
20define('SMPREF_SENT_SUBFOLDERS_MONTHLY', 3);
21define('SMOPT_GRP_SENT_SUBFOLDERS','SENT_SUBFOLDERS');
22
bb58f260 23/**
598294a7 24 * Adds plugin to SquirrelMail's hooks
bb58f260 25 */
a3439b27 26function 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';
bb58f260 53
54 /* mark base sent folder as special mailbox */
55 $squirrelmail_plugin_hooks
91e0dccc 56 ['special_mailbox']['sent_subfolders'] =
57 'sent_subfolders_special_mailbox';
a3439b27 58}
59
60function sent_subfolders_check_handleAsSent() {
b6b31355 61 global $handleAsSent_result, $sent_subfolders_base,
04f6008a 62 $use_sent_subfolders;
b587ac51 63
a3439b27 64 $sent_subfolders_base = 'INBOX.Sent';
65 $args = func_get_arg(0);
b587ac51 66 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
a3439b27 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
d79e01f5 77 || ($base_str == $mbox_str)
78 || ($sent_subfolders_base == $args[1])
a3439b27 79 );
80 }
81}
82
bb58f260 83/**
84 * Loads sent_subfolders settings
85 */
a3439b27 86function sent_subfolders_load_prefs() {
88cb1b4d 87 global $use_sent_subfolders, $data_dir, $username,
88 $sent_subfolders_setting, $sent_subfolders_base;
a3439b27 89
90 $use_sent_subfolders = getPref
91 ($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF);
d79e01f5 92
a3439b27 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
bb58f260 100/**
101 * Adds sent_subfolders options in folder preferences
102 */
a3439b27 103function sent_subfolders_optpage_loadhook_folders() {
04f6008a 104 global $optpage_data, $imapServerAddress, $imapPort;
105
b587ac51 106 sqgetGlobalVar('username', $username, SQ_SESSION);
107 sqgetGlobalVar('key', $key, SQ_COOKIE);
a3439b27 108
109 /* Get some imap data we need later. */
110 $imapConnection =
111 sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
112 $boxes = sqimap_mailbox_list($imapConnection);
113 sqimap_logout($imapConnection);
114
115 /* Load the Sent Subfolder Options into an array. */
116 $optgrp = _("Sent Subfolders Options");
117 $optvals = array();
118
119 $optvals[] = array(
120 'name' => 'sent_subfolders_setting',
121 'caption' => _("Use Sent Subfolders"),
122 'type' => SMOPT_TYPE_STRLIST,
123 'refresh' => SMOPT_REFRESH_FOLDERLIST,
124 'posvals' => array(SMPREF_SENT_SUBFOLDERS_DISABLED => _("Disabled"),
d79e01f5 125 SMPREF_SENT_SUBFOLDERS_MONTHLY => _("Monthly"),
126 SMPREF_SENT_SUBFOLDERS_QUARTERLY => _("Quarterly"),
127 SMPREF_SENT_SUBFOLDERS_YEARLY => _("Yearly")),
a3439b27 128 'save' => 'save_option_sent_subfolders_setting'
129 );
130
2589ba9a 131 $filtered_folders=array_filter($boxes, "filter_folders");
132 $sent_subfolders_base_values = array('whatever'=>$filtered_folders);
a3439b27 133
134 $optvals[] = array(
135 'name' => 'sent_subfolders_base',
136 'caption' => _("Base Sent Folder"),
2589ba9a 137 'type' => SMOPT_TYPE_FLDRLIST,
a3439b27 138 'refresh' => SMOPT_REFRESH_FOLDERLIST,
99ecf044 139 'posvals' => $sent_subfolders_base_values,
140 'folder_filter' => 'noinferiors'
a3439b27 141 );
142
143 /* Add our option data to the global array. */
144 $optpage_data['grps'][SMOPT_GRP_SENT_SUBFOLDERS] = $optgrp;
145 $optpage_data['vals'][SMOPT_GRP_SENT_SUBFOLDERS] = $optvals;
146}
147
bb58f260 148/**
2589ba9a 149 * Defines folder filtering rules
150 *
151 * Callback function that should exclude some folders from folder listing.
152 * @param array $fldr list of folders. See sqimap_mailbox_list
153 * @return boolean returns true, if folder has to included in folder listing
91e0dccc 154 * @access private
2589ba9a 155 */
156function filter_folders($fldr) {
157 return strtolower($fldr['unformatted'])!='inbox';
158}
159
160/**
bb58f260 161 * Saves sent_subfolder_options
162 */
a3439b27 163function save_option_sent_subfolders_setting($option) {
164 global $data_dir, $username, $use_sent_subfolders;
165
166 /* Set use_sent_subfolders as either on or off. */
167 if ($option->new_value == SMPREF_SENT_SUBFOLDERS_DISABLED) {
168 setPref($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF);
169 } else {
170 setPref($data_dir, $username, 'use_sent_subfolders', SMPREF_ON);
171 setPref($data_dir, $username, 'move_to_sent', SMPREF_ON);
172 }
173
174 /* Now just save the option as normal. */
175 save_option($option);
176}
177
bb58f260 178/**
179 * Update sent_subfolders settings
180 *
91e0dccc 181 * function updates default sent folder value and
bb58f260 182 * creates required imap folders
183 */
a3439b27 184function sent_subfolders_update_sentfolder() {
ce68b76b 185 global $sent_folder;
a3439b27 186 global $sent_subfolders_base, $sent_subfolders_setting;
04f6008a 187 global $data_dir, $imapServerAddress, $imapPort;
ce68b76b 188 global $use_sent_subfolders, $move_to_sent;
d79e01f5 189
b587ac51 190 sqgetGlobalVar('username', $username, SQ_SESSION);
191 sqgetGlobalVar('key', $key, SQ_COOKIE);
192 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
91e0dccc 193
1c52ba77 194 if ($use_sent_subfolders || $move_to_sent) {
a3439b27 195 $year = date('Y');
196 $month = date('m');
197 $quarter = sent_subfolder_getQuarter($month);
198
99ecf044 199 /**
200 * Regarding the structure we've got three main possibilities.
201 * One sent holder. level 0.
202 * Multiple year holders with messages in it. level 1.
203 * Multiple year folders with holders in it. level 2.
204 */
4965e012 205 $cnd_delimiter = $delimiter;
91e0dccc 206
a3439b27 207 switch ($sent_subfolders_setting) {
1c52ba77 208 case SMPREF_SENT_SUBFOLDERS_YEARLY:
209 $level = 1;
72b9aff9 210 $sent_subfolder = $sent_subfolders_base . $cnd_delimiter
1c52ba77 211 . $year;
1c52ba77 212 break;
213 case SMPREF_SENT_SUBFOLDERS_QUARTERLY:
214 $level = 2;
91e0dccc 215 $sent_subfolder = $sent_subfolders_base . $cnd_delimiter
1c52ba77 216 . $year
217 . $delimiter . $quarter;
99ecf044 218 $year_folder = $sent_subfolders_base . $cnd_delimiter
a3add160 219 . $year;
1c52ba77 220 break;
221 case SMPREF_SENT_SUBFOLDERS_MONTHLY:
222 $level = 2;
72b9aff9 223 $sent_subfolder = $sent_subfolders_base . $cnd_delimiter
1c52ba77 224 . $year
225 . $delimiter . $month;
99ecf044 226 $year_folder = $sent_subfolders_base. $cnd_delimiter . $year;
1c52ba77 227 break;
228 case SMPREF_SENT_SUBFOLDERS_DISABLED:
229 default:
230 $level = 0;
231 $sent_subfolder = $sent_folder;
232 $year_folder = $sent_folder;
a3439b27 233 }
234
235 /* If this folder is NOT the current sent folder, update stuff. */
236 if ($sent_subfolder != $sent_folder) {
99ecf044 237 /**
238 * $sent_subfolder should not have \noselect flag or folder should
239 * not exist.
240 * if $level=2, $year_folder should not have \noinferiors or folder
241 * should not exist.
242 *
243 * If some condition fails - sent_subfolders is misconfigured
244 */
245
246 /* Update sent_folder setting. */
a3439b27 247 setPref($data_dir, $username, 'sent_folder', $sent_subfolder);
248 setPref($data_dir, $username, 'move_to_sent', SMPREF_ON);
249 $sent_folder = $sent_subfolder;
250 $move_to_sent = SMPREF_ON;
251
252 /* Auto-create folders, if they do not yet exist. */
253 if ($sent_folder != 'none') {
254 /* Create the imap connection. */
99ecf044 255 $ic = sqimap_login($username, $key, $imapServerAddress, $imapPort, 10);
256
257 if ($level==2) {
258 /* Auto-create the year folder, if it does not yet exist. */
259 if (!sqimap_mailbox_exists($ic, $year_folder)) {
260 sqimap_mailbox_create($ic, $year_folder, 'noselect');
261 } else if (!sqimap_mailbox_is_subscribed($ic, $year_folder)) {
262 sqimap_subscribe($ic, $year_folder);
263 }
a3439b27 264 }
d79e01f5 265
a3439b27 266 /* Auto-create the subfolder, if it does not yet exist. */
99ecf044 267 if (!sqimap_mailbox_exists($ic, $sent_subfolder)) {
268 sqimap_mailbox_create($ic, $sent_subfolder, '');
1c52ba77 269 } else if (!sqimap_mailbox_is_subscribed($ic, $sent_subfolder)) {
270 sqimap_subscribe($ic, $sent_subfolder);
a3439b27 271 }
272
273 /* Close the imap connection. */
274 sqimap_logout($ic);
275 }
99ecf044 276
a3439b27 277 }
278 }
279}
280
bb58f260 281/**
282 * Sets quarter subfolder names
283 *
284 * @param string $month numeric month
285 * @return string quarter name (Q + number)
286 */
a3439b27 287function sent_subfolder_getQuarter($month) {
288 switch ($month) {
289 case '01':
290 case '02':
d79e01f5 291 case '03':
292 $result = '1';
293 break;
a3439b27 294 case '04':
295 case '05':
d79e01f5 296 case '06':
297 $result = '2';
298 break;
a3439b27 299 case '07':
300 case '08':
d79e01f5 301 case '09':
302 $result = '3';
303 break;
a3439b27 304 case '10':
305 case '11':
d79e01f5 306 case '12':
307 $result = '4';
308 break;
309 default:
310 $result = 'ERR';
a3439b27 311 }
312
313 /* Return the current quarter. */
314 return ('Q' . $result);
315}
316
bb58f260 317/**
318 * detects if mailbox is part of sent_subfolders
319 *
320 * @param string $mb imap folder name
321 * @return boolean 1 - is part of sent_subfolders, 0 - is not part of sent_subfolders
322 */
323function sent_subfolders_special_mailbox($mb) {
324 global $data_dir, $username;
325
326 $use_sent_subfolders = getPref
327 ($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF);
328 $sent_subfolders_base = getPref($data_dir, $username, 'sent_subfolders_base', 'na');
329
91e0dccc 330 if ($use_sent_subfolders == SMPREF_ON &&
bb58f260 331 ($mb == $sent_subfolders_base || stristr($mb,$sent_subfolders_base) ) ) {
91e0dccc 332 return 1;
bb58f260 333 }
334 return 0;
335}
91e0dccc 336?>