Added auth on file method
[squirrelmail.git] / plugins / sent_subfolders / setup.php
CommitLineData
a3439b27 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
14define('SMPREF_SENT_SUBFOLDERS_DISABLED', 0);
15define('SMPREF_SENT_SUBFOLDERS_YEARLY', 1);
16define('SMPREF_SENT_SUBFOLDERS_QUARTERLY', 2);
17define('SMPREF_SENT_SUBFOLDERS_MONTHLY', 3);
18define('SMOPT_GRP_SENT_SUBFOLDERS','SENT_SUBFOLDERS');
19
20function 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
49function 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
d79e01f5 64 || ($base_str == $mbox_str)
65 || ($sent_subfolders_base == $args[1])
a3439b27 66 );
67 }
68}
69
70function 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);
d79e01f5 76
a3439b27 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
84function 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"),
d79e01f5 103 SMPREF_SENT_SUBFOLDERS_MONTHLY => _("Monthly"),
104 SMPREF_SENT_SUBFOLDERS_QUARTERLY => _("Quarterly"),
105 SMPREF_SENT_SUBFOLDERS_YEARLY => _("Yearly")),
a3439b27 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
131function 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
146function 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;
64727b20 150 global $use_sent_subfolders, $move_to_sent, $imap_server_type;
d79e01f5 151
1c52ba77 152 if ($use_sent_subfolders || $move_to_sent) {
a3439b27 153 $year = date('Y');
154 $month = date('m');
155 $quarter = sent_subfolder_getQuarter($month);
156
1c52ba77 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 */
72b9aff9 163
164 if( $imap_server_type == 'uw' ) {
165 $cnd_delimiter = '';
166 } else {
167 $cnd_delimiter = $delimiter;
168 }
169
a3439b27 170 switch ($sent_subfolders_setting) {
1c52ba77 171 case SMPREF_SENT_SUBFOLDERS_YEARLY:
172 $level = 1;
72b9aff9 173 $sent_subfolder = $sent_subfolders_base . $cnd_delimiter
1c52ba77 174 . $year;
1c52ba77 175 break;
176 case SMPREF_SENT_SUBFOLDERS_QUARTERLY:
177 $level = 2;
72b9aff9 178 $sent_subfolder = $sent_subfolders_base . $cnd_delimiter
1c52ba77 179 . $year
180 . $delimiter . $quarter;
181 $year_folder = $sent_subfolders_base
a3add160 182 . $year;
1c52ba77 183 break;
184 case SMPREF_SENT_SUBFOLDERS_MONTHLY:
185 $level = 2;
72b9aff9 186 $sent_subfolder = $sent_subfolders_base . $cnd_delimiter
1c52ba77 187 . $year
188 . $delimiter . $month;
a3add160 189 $year_folder = $sent_subfolders_base . $year;
1c52ba77 190 break;
191 case SMPREF_SENT_SUBFOLDERS_DISABLED:
192 default:
193 $level = 0;
194 $sent_subfolder = $sent_folder;
195 $year_folder = $sent_folder;
a3439b27 196 }
197
198 /* If this folder is NOT the current sent folder, update stuff. */
199 if ($sent_subfolder != $sent_folder) {
200 /* First, update the sent folder. */
1c52ba77 201
a3439b27 202 setPref($data_dir, $username, 'sent_folder', $sent_subfolder);
203 setPref($data_dir, $username, 'move_to_sent', SMPREF_ON);
204 $sent_folder = $sent_subfolder;
205 $move_to_sent = SMPREF_ON;
206
207 /* Auto-create folders, if they do not yet exist. */
208 if ($sent_folder != 'none') {
209 /* Create the imap connection. */
210 $ic = sqimap_login
211 ($username, $key, $imapServerAddress, $imapPort, 10);
d79e01f5 212
a3439b27 213 /* Auto-create the year folder, if it does not yet exist. */
214 if (!sqimap_mailbox_exists($ic, $year_folder)) {
1c52ba77 215 sqimap_mailbox_create($ic, $year_folder, ($level==1)?'':'noselect');
a3439b27 216 } else if (!sqimap_mailbox_is_subscribed($ic, $year_folder)) {
217 sqimap_subscribe($ic, $year_folder);
218 }
d79e01f5 219
a3439b27 220 /* Auto-create the subfolder, if it does not yet exist. */
221 if (!sqimap_mailbox_exists($ic, $sent_folder)) {
222 sqimap_mailbox_create($ic, $sent_folder, '');
1c52ba77 223 } else if (!sqimap_mailbox_is_subscribed($ic, $sent_subfolder)) {
224 sqimap_subscribe($ic, $sent_subfolder);
a3439b27 225 }
226
227 /* Close the imap connection. */
228 sqimap_logout($ic);
229 }
230 }
231 }
232}
233
234function sent_subfolder_getQuarter($month) {
235 switch ($month) {
236 case '01':
237 case '02':
d79e01f5 238 case '03':
239 $result = '1';
240 break;
a3439b27 241 case '04':
242 case '05':
d79e01f5 243 case '06':
244 $result = '2';
245 break;
a3439b27 246 case '07':
247 case '08':
d79e01f5 248 case '09':
249 $result = '3';
250 break;
a3439b27 251 case '10':
252 case '11':
d79e01f5 253 case '12':
254 $result = '4';
255 break;
256 default:
257 $result = 'ERR';
a3439b27 258 }
259
260 /* Return the current quarter. */
261 return ('Q' . $result);
262}
263
264?>