Add notes about the fact that the new custom date option needs a better UI
[squirrelmail.git] / include / load_prefs.php
1 <?php
2
3 /**
4 * load_prefs.php
5 *
6 * Loads preferences from the $username.pref file used by almost
7 * every other script in the source directory and alswhere.
8 *
9 * @copyright &copy; 1999-2007 The SquirrelMail Project Team
10 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
11 * @version $Id$
12 * @package squirrelmail
13 */
14
15 /**
16 * do not allow to call this file directly
17 * FIXME: PHP CGI (at least on IIS 5.1) does not set 'SCRIPT_FILENAME' and
18 * code does not handle magic_quotes_gpc=on.
19 */
20 if (isset($_SERVER['SCRIPT_FILENAME']) && $_SERVER['SCRIPT_FILENAME'] == __FILE__) {
21 header("Location: ../src/login.php");
22 die();
23 }
24
25 if( ! sqgetGlobalVar('username', $username, SQ_SESSION) ) {
26 $username = '';
27 }
28 // TODO Get rid of "none" strings when NULL or false should be used, i hate them i hate them i hate them!!!.
29 $custom_css = getPref($data_dir, $username, 'custom_css', 'none' );
30
31
32 // template set setup
33 //
34 $sDefaultTemplateID = Template::get_default_template_set();
35 $sTemplateID = getPref($data_dir, $username, 'sTemplateID', $sDefaultTemplateID);
36
37
38 // load user theme
39 //
40 $chosen_theme = getPref($data_dir, $username, 'chosen_theme');
41 $chosen_theme_path = empty($chosen_theme) ?
42 $chosen_theme_path = $user_themes[$user_theme_default]['PATH'] :
43 $chosen_theme;
44
45
46 // user's icon theme, if using icons
47 $icon_theme = getPref($data_dir, $username, 'icon_theme');
48 $default_icon_theme = $icon_themes[$icon_theme_def]['PATH'];
49 $fallback_icon_theme = $icon_themes[$icon_theme_fallback]['PATH'];
50 $found_theme = false;
51
52 // Make sure the chosen icon theme is a legitimate one.
53 // need to adjust $icon_theme path with SM_PATH
54 $icon_theme = preg_replace("/(\.\.\/){1,}/", SM_PATH, $icon_theme);
55 $k = 0;
56 while (!$found_theme && $k < count($icon_themes)) {
57 if ($icon_themes[$k]['PATH'] == $icon_theme)
58 $found_theme = true;
59 $k++;
60 }
61 if (!$found_theme) {
62 $icon_theme = $default_icon_theme;
63 }
64
65
66 // show (or not) flag and unflag buttons on mailbox list screen
67 $show_flag_buttons = getPref($data_dir, $username, 'show_flag_buttons', SMPREF_ON );
68
69 /* Load the user's special folder preferences */
70 $move_to_sent =
71 getPref($data_dir, $username, 'move_to_sent', $default_move_to_sent);
72 $move_to_trash =
73 getPref($data_dir, $username, 'move_to_trash', $default_move_to_trash);
74 $save_as_draft =
75 getPref($data_dir, $username, 'save_as_draft', $default_save_as_draft);
76
77 if ($default_unseen_type == '') {
78 $default_unseen_type = 1;
79 }
80 if ($default_unseen_notify == '') {
81 $default_unseen_notify = 2;
82 }
83 $unseen_type =
84 getPref($data_dir, $username, 'unseen_type', $default_unseen_type);
85 $unseen_notify =
86 getPref($data_dir, $username, 'unseen_notify', $default_unseen_notify);
87
88 $unseen_cum =
89 getPref($data_dir, $username, 'unseen_cum', false);
90
91 $folder_prefix =
92 getPref($data_dir, $username, 'folder_prefix', $default_folder_prefix);
93
94 /* Load special folder - trash */
95 $load_trash_folder = getPref($data_dir, $username, 'trash_folder');
96 if (($load_trash_folder == '') && ($move_to_trash)) {
97 $trash_folder = $folder_prefix . $trash_folder;
98 } else {
99 $trash_folder = $load_trash_folder;
100 }
101
102 /* Load special folder - sent */
103 $load_sent_folder = getPref($data_dir, $username, 'sent_folder');
104 if (($load_sent_folder == '') && ($move_to_sent)) {
105 $sent_folder = $folder_prefix . $sent_folder;
106 } else {
107 $sent_folder = $load_sent_folder;
108 }
109
110 /* Load special folder - draft */
111 $load_draft_folder = getPref($data_dir, $username, 'draft_folder');
112 if (($load_draft_folder == '') && ($save_as_draft)) {
113 $draft_folder = $folder_prefix . $draft_folder;
114 } else {
115 $draft_folder = $load_draft_folder;
116 }
117
118 $show_num = getPref($data_dir, $username, 'show_num', 15 );
119
120 $wrap_at = getPref( $data_dir, $username, 'wrap_at', 86 );
121 if ($wrap_at < 15) { $wrap_at = 15; }
122
123 $left_size = getPref($data_dir, $username, 'left_size');
124 if ($left_size == '') {
125 if (isset($default_left_size)) {
126 $left_size = $default_left_size;
127 } else {
128 $left_size = 200;
129 }
130 }
131
132 $editor_size = getPref($data_dir, $username, 'editor_size', 76 );
133 $editor_height = getPref($data_dir, $username, 'editor_height', 20 );
134 $use_signature = getPref($data_dir, $username, 'use_signature', SMPREF_OFF );
135 $prefix_sig = getPref($data_dir, $username, 'prefix_sig');
136
137 /* Load timezone preferences */
138 $timezone = getPref($data_dir, $username, 'timezone', SMPREF_NONE );
139
140 /* Load preferences for reply citation style. */
141
142 $reply_citation_style =
143 getPref($data_dir, $username, 'reply_citation_style', 'date_time_author' );
144 $reply_citation_start = getPref($data_dir, $username, 'reply_citation_start');
145 $reply_citation_end = getPref($data_dir, $username, 'reply_citation_end');
146
147 $body_quote = getPref($data_dir, $username, 'body_quote', '>');
148 if ($body_quote == 'NONE') $body_quote = '';
149
150 // who is using those darn block comments? poo!
151
152 // Load preference for cursor behavior for replies
153 //
154 $reply_focus = getPref($data_dir, $username, 'reply_focus', '');
155
156 /* left refresh rate, strtolower makes 1.0.6 prefs compatible */
157 $left_refresh = getPref($data_dir, $username, 'left_refresh', 600 );
158 $left_refresh = strtolower($left_refresh);
159
160 /* Message Highlighting Rules */
161 $message_highlight_list = array();
162
163 /* use new way of storing highlighting rules */
164 if( $ser = getPref($data_dir, $username, 'hililist') ) {
165 $message_highlight_list = unserialize($ser);
166 } else {
167 /* use old way */
168 for ($i = 0; $hlt = getPref($data_dir, $username, "highlight$i"); ++$i) {
169 $highlight_array = explode(',', $hlt);
170 $message_highlight_list[$i]['name'] = $highlight_array[0];
171 $message_highlight_list[$i]['color'] = $highlight_array[1];
172 $message_highlight_list[$i]['value'] = $highlight_array[2];
173 $message_highlight_list[$i]['match_type'] = $highlight_array[3];
174 removePref($data_dir, $username, "highlight$i");
175 }
176 /* store in new format for the next time */
177 setPref($data_dir, $username, 'hililist', serialize($message_highlight_list));
178 }
179
180 /* use the internal date of the message for sorting instead of the supplied header date */
181 /* OBSOLETE */
182
183 $internal_date_sort = getPref($data_dir, $username, 'internal_date_sort', SMPREF_ON);
184
185 /* Index order lets you change the order of the message index */
186 $order = getPref($data_dir, $username, 'order1');
187 if (isset($order1)) {
188 removePref($data_dir, $username, 'order1');
189 for ($i = 1; $order; ++$i) {
190 $index_order[$i-1] = $order -1;
191 $order = getPref($data_dir, $username, 'order'.($i+1));
192 removePref($data_dir, $username, 'order'.($i+1));
193 }
194 if (isset($internal_date_sort) && $internal_date_sort) {
195 if (in_array(SQM_COL_DATE,$index_order)) {
196 $k = array_search(SQM_COL_DATE,$index_order,true);
197 $index_order[$k] = SQM_COL_INT_DATE;
198 }
199 }
200 setPref($data_dir, $username, 'index_order', serialize($index_order));
201 }
202 $index_order = getPref($data_dir, $username, 'index_order');
203 if (is_string($index_order)) {
204 $index_order = unserialize($index_order);
205 }
206
207
208 // new Index order handling
209 //$default_mailbox_pref = unserialize(getPref($data_dir, $username, 'default_mailbox_pref'));
210
211 if (!$index_order) {
212 if (isset($internal_date_sort) && $internal_date_sort == false) {
213 $index_order = array(SQM_COL_CHECK,SQM_COL_FROM,SQM_COL_DATE,SQM_COL_FLAGS,SQM_COL_ATTACHMENT,SQM_COL_PRIO,SQM_COL_SUBJ);
214 } else {
215 $index_order = array(SQM_COL_CHECK,SQM_COL_FROM,SQM_COL_INT_DATE,SQM_COL_FLAGS,SQM_COL_ATTACHMENT,SQM_COL_PRIO,SQM_COL_SUBJ);
216 }
217 setPref($data_dir, $username, 'index_order', serialize($index_order));
218 }
219
220 if (!isset($default_mailbox_pref)) {
221 $show_num = (isset($show_num)) ? $show_num : 15;
222
223 $default_mailbox_pref = array (
224 MBX_PREF_SORT => 0,
225 MBX_PREF_LIMIT => $show_num,
226 MBX_PREF_AUTO_EXPUNGE => $auto_expunge,
227 MBX_PREF_COLUMNS => $index_order);
228 // setPref($data_dir, $username, 'default_mailbox_pref', serialize($default_mailbox_pref));
229 // clean up the old prefs
230 // if (isset($prefs_cache['internal_date_sort'])) {
231 // unset($prefs_cache['internal_date_sort']);
232 // removePref($data_dir,$username,'internal_date_sort');
233 // }
234 // if (isset($prefs_cache['show_num'])) {
235 // unset($prefs_cache['show_num']);
236 // removePref($data_dir,$username,'show_num');
237 // }
238 }
239
240
241 $alt_index_colors =
242 getPref($data_dir, $username, 'alt_index_colors', SMPREF_ON );
243
244 $fancy_index_highlite =
245 getPref($data_dir, $username, 'fancy_index_highlite', SMPREF_ON );
246
247 /* Folder List Display Format */
248 $location_of_bar =
249 getPref($data_dir, $username, 'location_of_bar', SMPREF_LOC_LEFT);
250 $location_of_buttons =
251 getPref($data_dir, $username, 'location_of_buttons', SMPREF_LOC_BETWEEN);
252
253 $collapse_folders =
254 getPref($data_dir, $username, 'collapse_folders', SMPREF_ON);
255
256 $show_html_default =
257 getPref($data_dir, $username, 'show_html_default', SMPREF_ON);
258
259 $addrsrch_fullname =
260 getPref($data_dir, $username, 'addrsrch_fullname', SMPREF_ON);
261
262 $enable_forward_as_attachment =
263 getPref($data_dir, $username, 'enable_forward_as_attachment', SMPREF_ON);
264
265 $show_xmailer_default =
266 getPref($data_dir, $username, 'show_xmailer_default', SMPREF_OFF );
267 $attachment_common_show_images = getPref($data_dir, $username, 'attachment_common_show_images', SMPREF_OFF );
268
269
270 /* message disposition notification support setting */
271 $mdn_user_support = getPref($data_dir, $username, 'mdn_user_support', SMPREF_ON);
272
273 $include_self_reply_all =
274 getPref($data_dir, $username, 'include_self_reply_all', SMPREF_ON);
275
276 /* Page selector options */
277 $page_selector = getPref($data_dir, $username, 'page_selector', SMPREF_ON);
278 $compact_paginator = getPref($data_dir, $username, 'compact_paginator', SMPREF_OFF);
279 $page_selector_max = getPref($data_dir, $username, 'page_selector_max', 10);
280
281 /* SqClock now in the core */
282 $date_format = getPref($data_dir, $username, 'date_format', 3);
283 $hour_format = getPref($data_dir, $username, 'hour_format', SMPREF_TIME_12HR);
284
285 /* compose in new window setting */
286 $compose_new_win = getPref($data_dir, $username, 'compose_new_win', SMPREF_OFF);
287 $compose_height = getPref($data_dir, $username, 'compose_height', 550);
288 $compose_width = getPref($data_dir, $username, 'compose_width', 640);
289
290
291 /* signature placement settings */
292 $sig_first = getPref($data_dir, $username, 'sig_first', SMPREF_OFF);
293
294 /* Strip signature when replying */
295 $strip_sigs = getPref($data_dir, $username, 'strip_sigs', SMPREF_ON);
296
297 /* use the internal date of the message for sorting instead of the supplied header date */
298 $internal_date_sort = getPref($data_dir, $username, 'internal_date_sort', SMPREF_ON);
299
300 /* if server sorting is enabled/disabled */
301 $sort_by_ref = getPref($data_dir, $username, 'sort_by_ref', SMPREF_ON);
302
303 /* Load the javascript settings. */
304 $javascript_setting = getPref($data_dir, $username, 'javascript_setting', SMPREF_JS_AUTODETECT);
305 if ( checkForJavascript() )
306 {
307 $use_javascript_folder_list = getPref($data_dir, $username, 'use_javascript_folder_list');
308 $use_javascript_addr_book = getPref($data_dir, $username, 'use_javascript_addr_book', $default_use_javascript_addr_book);
309 } else {
310 $use_javascript_folder_list = false;
311 $use_javascript_addr_book = false;
312 }
313
314 $search_memory = getPref($data_dir, $username, 'search_memory', SMPREF_OFF);
315
316 $show_only_subscribed_folders =
317 getPref($data_dir, $username, 'show_only_subscribed_folders', SMPREF_ON);
318
319
320 /* How are mailbox select lists displayed: 0. full names, 1. indented (default),
321 * 3. delimited) */
322 $mailbox_select_style = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_MAILBOX_SELECT_INDENTED);
323
324 /* Allow user to customize, and display the full date, instead of day, or time based
325 on time distance from date of message */
326 $custom_date_format = getPref($data_dir, $username, 'custom_date_format', '');
327 $show_full_date = getPref($data_dir, $username, 'show_full_date', SMPREF_OFF);
328
329 /* Allow user to customize length of from field */
330 $truncate_sender = getPref($data_dir, $username, 'truncate_sender', 50);
331 /* Allow user to customize length of subject field */
332 $truncate_subject = getPref($data_dir, $username, 'truncate_subject', 50);
333 /* Allow user to show recipient name if the message is from default identity */
334 $show_recipient_instead = getPref($data_dir, $username, 'show_recipient_instead', SMPREF_OFF);
335
336 $delete_prev_next_display = getPref($data_dir, $username, 'delete_prev_next_display', SMPREF_ON);
337
338 /**
339 * Height of iframe that displays html formated emails
340 * @since 1.5.1
341 */
342 $iframe_height = getPref($data_dir, $username, 'iframe_height', '300');
343
344 if (! isset($default_fontset)) $default_fontset=SMPREF_NONE;
345 $chosen_fontset = getPref($data_dir, $username, 'chosen_fontset', $default_fontset);
346 if (! isset($default_fontsize)) $default_fontsize=SMPREF_NONE;
347 $chosen_fontsize = getPref($data_dir, $username, 'chosen_fontsize', $default_fontsize);
348
349 /**
350 * Controls translation of special folders
351 * @since 1.5.2
352 */
353 $translate_special_folders = getPref($data_dir, $username, 'translate_special_folders', SMPREF_OFF);
354 /**
355 * Controls display of message copy options
356 * @since 1.5.2
357 */
358 $show_copy_buttons = getPref($data_dir, $username, 'show_copy_buttons', SMPREF_OFF);
359
360 /** Put in a safety net for authentication here, in case a naughty admin didn't run conf.pl when they upgraded */
361
362 // TODO Get rid of "none" strings when NULL should be used, i hate them i hate them i hate them!!!.
363 if (! isset($smtp_auth_mech)) {
364 $smtp_auth_mech = 'none';
365 }
366
367 if (! isset($imap_auth_mech)) {
368 $imap_auth_mech = 'login';
369 }
370
371 if (! isset($use_imap_tls)) {
372 $use_imap_tls = false;
373 }
374
375 if (! isset($use_smtp_tls)) {
376 $use_smtp_tls = false;
377 }
378
379
380 // allow plugins to override user prefs
381 //
382 do_hook('loading_prefs', $null);
383
384
385 // check user prefs template selection against templates actually available
386 //
387 $found_templateset = false;
388 for ($i = 0; $i < count($aTemplateSet); ++$i){
389 if ($aTemplateSet[$i]['ID'] == $sTemplateID) {
390 $found_templateset = true;
391 break;
392 }
393 }
394
395 // FIXME: do we need/want to check here for actual presence of template sets?
396 // selected template not available, fall back to default template
397 //
398 if (!$found_templateset) $sTemplateID = $sDefaultTemplateID;
399
400 // need to build this object now because it is used below to validate
401 // user css theme choice
402 //
403 $oTemplate = Template::construct_template($sTemplateID);
404
405
406 // Make sure the chosen theme is a legitimate one.
407 //
408 // need to adjust $chosen_theme path with SM_PATH
409 $chosen_theme_path = preg_replace("/(\.\.\/){1,}/", SM_PATH, $chosen_theme_path);
410 $found_theme = false;
411 while (!$found_theme && (list($index, $data) = each($user_themes))) {
412 if ($data['PATH'] == $chosen_theme_path)
413 $found_theme = true;
414 }
415
416 if (!$found_theme) {
417 $template_themes = $oTemplate->get_alternative_stylesheets(true);
418 while (!$found_theme && (list($path, $name) = each($template_themes))) {
419 if ($path == $chosen_theme_path)
420 $found_theme = true;
421 }
422 }
423
424 if (!$found_theme || $chosen_theme == 'none') {
425 $chosen_theme_path = NULL;
426 }
427
428
429 /*
430 * NOTE: The $icon_theme_path var should contain the path to the icon
431 * theme to use. If the admin has disabled icons, or the user has
432 * set the icon theme to "None," no icons will be used.
433 */
434 $icon_theme_path = (!$use_icons || $icon_theme=='none') ? NULL : ($icon_theme == 'template' ? SM_PATH . Template::calculate_template_images_directory($sTemplateID) : $icon_theme);
435 $default_icon_theme_path = (!$use_icons || $default_icon_theme=='none') ? NULL : ($default_icon_theme == 'template' ? SM_PATH . Template::calculate_template_images_directory($sTemplateID) : $default_icon_theme);
436 $fallback_icon_theme_path = (!$use_icons || $fallback_icon_theme=='none') ? NULL : ($fallback_icon_theme == 'template' ? SM_PATH . Template::calculate_template_images_directory($sTemplateID) : $fallback_icon_theme);
437
438 /* Load up the Signature file */
439 $signature_abs = $signature = getSig($data_dir, $username, 'g');
440