Add notes about the fact that the new custom date option needs a better UI
[squirrelmail.git] / include / load_prefs.php
CommitLineData
59177427 1<?php
895905c0 2
35586184 3/**
4 * load_prefs.php
5 *
35586184 6 * Loads preferences from the $username.pref file used by almost
7 * every other script in the source directory and alswhere.
8 *
4b5049de 9 * @copyright &copy; 1999-2007 The SquirrelMail Project Team
4b4abf93 10 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
763b63fe 11 * @version $Id$
2b646597 12 * @package squirrelmail
35586184 13 */
f7b1b3b1 14
202bcbcc 15/**
16 * do not allow to call this file directly
975d6cb0 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.
202bcbcc 19 */
f627180c 20if (isset($_SERVER['SCRIPT_FILENAME']) && $_SERVER['SCRIPT_FILENAME'] == __FILE__) {
202bcbcc 21 header("Location: ../src/login.php");
22 die();
23}
0f2447d8 24
e56e1b18 25if( ! sqgetGlobalVar('username', $username, SQ_SESSION) ) {
26 $username = '';
27}
202bcbcc 28// TODO Get rid of "none" strings when NULL or false should be used, i hate them i hate them i hate them!!!.
8f1ba72b 29$custom_css = getPref($data_dir, $username, 'custom_css', 'none' );
30
0f2447d8 31
0f7d6a84 32// template set setup
33//
34$sDefaultTemplateID = Template::get_default_template_set();
35$sTemplateID = getPref($data_dir, $username, 'sTemplateID', $sDefaultTemplateID);
7442e064 36
28294310 37
a571cff3 38// load user theme
28294310 39//
deb25c8f 40$chosen_theme = getPref($data_dir, $username, 'chosen_theme');
acd7fdf2 41$chosen_theme_path = empty($chosen_theme) ?
c44481fc 42 $chosen_theme_path = $user_themes[$user_theme_default]['PATH'] :
acd7fdf2 43 $chosen_theme;
44
0f2447d8 45
6395c46d 46// user's icon theme, if using icons
1e721874 47$icon_theme = getPref($data_dir, $username, 'icon_theme');
48$default_icon_theme = $icon_themes[$icon_theme_def]['PATH'];
341fd984 49$fallback_icon_theme = $icon_themes[$icon_theme_fallback]['PATH'];
1e721874 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;
56while (!$found_theme && $k < count($icon_themes)) {
57 if ($icon_themes[$k]['PATH'] == $icon_theme)
58 $found_theme = true;
59 $k++;
60}
61if (!$found_theme) {
62 $icon_theme = $default_icon_theme;
63}
991c88e7 64
6395c46d 65
fd181f53 66// show (or not) flag and unflag buttons on mailbox list screen
91a98838 67$show_flag_buttons = getPref($data_dir, $username, 'show_flag_buttons', SMPREF_ON );
fd181f53 68
0842b54b 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);
0f2447d8 76
324ac3c5 77if ($default_unseen_type == '') {
78 $default_unseen_type = 1;
99e3bfd0 79}
324ac3c5 80if ($default_unseen_notify == '') {
81 $default_unseen_notify = 2;
99e3bfd0 82}
0842b54b 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);
0f2447d8 87
1f16606e 88$unseen_cum =
89 getPref($data_dir, $username, 'unseen_cum', false);
90
0842b54b 91$folder_prefix =
92 getPref($data_dir, $username, 'folder_prefix', $default_folder_prefix);
0f2447d8 93
0842b54b 94/* Load special folder - trash */
0f2447d8 95$load_trash_folder = getPref($data_dir, $username, 'trash_folder');
96if (($load_trash_folder == '') && ($move_to_trash)) {
97 $trash_folder = $folder_prefix . $trash_folder;
98} else {
99 $trash_folder = $load_trash_folder;
100}
101
0842b54b 102/* Load special folder - sent */
0f2447d8 103$load_sent_folder = getPref($data_dir, $username, 'sent_folder');
104if (($load_sent_folder == '') && ($move_to_sent)) {
105 $sent_folder = $folder_prefix . $sent_folder;
106} else {
107 $sent_folder = $load_sent_folder;
108}
109
0842b54b 110/* Load special folder - draft */
0f2447d8 111$load_draft_folder = getPref($data_dir, $username, 'draft_folder');
112if (($load_draft_folder == '') && ($save_as_draft)) {
113 $draft_folder = $folder_prefix . $draft_folder;
114} else {
115 $draft_folder = $load_draft_folder;
116}
117
0f2447d8 118$show_num = getPref($data_dir, $username, 'show_num', 15 );
119
120$wrap_at = getPref( $data_dir, $username, 'wrap_at', 86 );
121if ($wrap_at < 15) { $wrap_at = 15; }
122
123$left_size = getPref($data_dir, $username, 'left_size');
0842b54b 124if ($left_size == '') {
0f2447d8 125 if (isset($default_left_size)) {
126 $left_size = $default_left_size;
f7b1b3b1 127 } else {
0f2447d8 128 $left_size = 200;
f7b1b3b1 129 }
0f2447d8 130}
131
0842b54b 132$editor_size = getPref($data_dir, $username, 'editor_size', 76 );
3cb80c8c 133$editor_height = getPref($data_dir, $username, 'editor_height', 20 );
0f2447d8 134$use_signature = getPref($data_dir, $username, 'use_signature', SMPREF_OFF );
0842b54b 135$prefix_sig = getPref($data_dir, $username, 'prefix_sig');
0f2447d8 136
7bcc8f54 137/* Load timezone preferences */
138$timezone = getPref($data_dir, $username, 'timezone', SMPREF_NONE );
139
0f2447d8 140/* Load preferences for reply citation style. */
0f2447d8 141
0842b54b 142$reply_citation_style =
de3e0fcb 143 getPref($data_dir, $username, 'reply_citation_style', 'date_time_author' );
0f2447d8 144$reply_citation_start = getPref($data_dir, $username, 'reply_citation_start');
145$reply_citation_end = getPref($data_dir, $username, 'reply_citation_end');
146
a46ecf66 147$body_quote = getPref($data_dir, $username, 'body_quote', '>');
148if ($body_quote == 'NONE') $body_quote = '';
149
9f2f6126 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
e02e27fd 156/* left refresh rate, strtolower makes 1.0.6 prefs compatible */
721db745 157$left_refresh = getPref($data_dir, $username, 'left_refresh', 600 );
e02e27fd 158$left_refresh = strtolower($left_refresh);
159
8fb26613 160/* Message Highlighting Rules */
161$message_highlight_list = array();
162
1c159927 163/* use new way of storing highlighting rules */
164if( $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];
673f9350 174 removePref($data_dir, $username, "highlight$i");
1c159927 175 }
176 /* store in new format for the next time */
177 setPref($data_dir, $username, 'hililist', serialize($message_highlight_list));
0f2447d8 178}
179
91c27aee 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
0f2447d8 185/* Index order lets you change the order of the message index */
0f2447d8 186$order = getPref($data_dir, $username, 'order1');
91c27aee 187if (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));
0f2447d8 201}
91c27aee 202$index_order = getPref($data_dir, $username, 'index_order');
203if (is_string($index_order)) {
204 $index_order = unserialize($index_order);
0f2447d8 205}
206
91c27aee 207
208// new Index order handling
209//$default_mailbox_pref = unserialize(getPref($data_dir, $username, 'default_mailbox_pref'));
210
211if (!$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
91c27aee 220if (!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
0842b54b 241$alt_index_colors =
242 getPref($data_dir, $username, 'alt_index_colors', SMPREF_ON );
0f2447d8 243
18adc53f 244$fancy_index_highlite =
91a98838 245 getPref($data_dir, $username, 'fancy_index_highlite', SMPREF_ON );
18adc53f 246
d175eab9 247/* Folder List Display Format */
0842b54b 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);
0f2447d8 252
0842b54b 253$collapse_folders =
254 getPref($data_dir, $username, 'collapse_folders', SMPREF_ON);
0f2447d8 255
0842b54b 256$show_html_default =
721db745 257 getPref($data_dir, $username, 'show_html_default', SMPREF_ON);
6206f6c4 258
56196737 259$addrsrch_fullname =
260 getPref($data_dir, $username, 'addrsrch_fullname', SMPREF_ON);
261
6206f6c4 262$enable_forward_as_attachment =
263 getPref($data_dir, $username, 'enable_forward_as_attachment', SMPREF_ON);
0f2447d8 264
0842b54b 265$show_xmailer_default =
266 getPref($data_dir, $username, 'show_xmailer_default', SMPREF_OFF );
0f2447d8 267$attachment_common_show_images = getPref($data_dir, $username, 'attachment_common_show_images', SMPREF_OFF );
0f2447d8 268
91c27aee 269
51e2fd04 270/* message disposition notification support setting */
57257333 271$mdn_user_support = getPref($data_dir, $username, 'mdn_user_support', SMPREF_ON);
272
0842b54b 273$include_self_reply_all =
274 getPref($data_dir, $username, 'include_self_reply_all', SMPREF_ON);
0f2447d8 275
0bb37159 276/* Page selector options */
0f2447d8 277$page_selector = getPref($data_dir, $username, 'page_selector', SMPREF_ON);
0bb37159 278$compact_paginator = getPref($data_dir, $username, 'compact_paginator', SMPREF_OFF);
0f2447d8 279$page_selector_max = getPref($data_dir, $username, 'page_selector_max', 10);
280
281/* SqClock now in the core */
0f2447d8 282$date_format = getPref($data_dir, $username, 'date_format', 3);
4eefb12f 283$hour_format = getPref($data_dir, $username, 'hour_format', SMPREF_TIME_12HR);
0f2447d8 284
9c3e6cd4 285/* compose in new window setting */
91c27aee 286$compose_new_win = getPref($data_dir, $username, 'compose_new_win', SMPREF_OFF);
07687736 287$compose_height = getPref($data_dir, $username, 'compose_height', 550);
288$compose_width = getPref($data_dir, $username, 'compose_width', 640);
289
9c3e6cd4 290
3b17e952 291/* signature placement settings */
721db745 292$sig_first = getPref($data_dir, $username, 'sig_first', SMPREF_OFF);
3b17e952 293
d175eab9 294/* Strip signature when replying */
721db745 295$strip_sigs = getPref($data_dir, $username, 'strip_sigs', SMPREF_ON);
d175eab9 296
51e2fd04 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
be081af7 300/* if server sorting is enabled/disabled */
721db745 301$sort_by_ref = getPref($data_dir, $username, 'sort_by_ref', SMPREF_ON);
7c612fdd 302
0f2447d8 303/* Load the javascript settings. */
ae958cd3 304$javascript_setting = getPref($data_dir, $username, 'javascript_setting', SMPREF_JS_AUTODETECT);
1a531551 305if ( 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}
99e3bfd0 313
721db745 314$search_memory = getPref($data_dir, $username, 'search_memory', SMPREF_OFF);
0d672ac0 315
4d5f2b31 316$show_only_subscribed_folders =
317 getPref($data_dir, $username, 'show_only_subscribed_folders', SMPREF_ON);
318
91c27aee 319
721db745 320/* How are mailbox select lists displayed: 0. full names, 1. indented (default),
321 * 3. delimited) */
d56050e1 322$mailbox_select_style = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_MAILBOX_SELECT_INDENTED);
be2d5495 323
3e3b60e3 324/* Allow user to customize, and display the full date, instead of day, or time based
325 on time distance from date of message */
26017e66 326$custom_date_format = getPref($data_dir, $username, 'custom_date_format', '');
721db745 327$show_full_date = getPref($data_dir, $username, 'show_full_date', SMPREF_OFF);
3e3b60e3 328
459e3347 329/* Allow user to customize length of from field */
721db745 330$truncate_sender = getPref($data_dir, $username, 'truncate_sender', 50);
d175eab9 331/* Allow user to customize length of subject field */
332$truncate_subject = getPref($data_dir, $username, 'truncate_subject', 50);
1ae2832e 333/* Allow user to show recipient name if the message is from default identity */
721db745 334$show_recipient_instead = getPref($data_dir, $username, 'show_recipient_instead', SMPREF_OFF);
459e3347 335
721db745 336$delete_prev_next_display = getPref($data_dir, $username, 'delete_prev_next_display', SMPREF_ON);
48dc9174 337
a144f6b8 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
81132de8 344if (! isset($default_fontset)) $default_fontset=SMPREF_NONE;
345$chosen_fontset = getPref($data_dir, $username, 'chosen_fontset', $default_fontset);
346if (! isset($default_fontsize)) $default_fontsize=SMPREF_NONE;
347$chosen_fontsize = getPref($data_dir, $username, 'chosen_fontsize', $default_fontsize);
348
7652c651 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);
24bb7e49 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);
202bcbcc 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!!!.
363if (! isset($smtp_auth_mech)) {
364 $smtp_auth_mech = 'none';
365}
366
367if (! isset($imap_auth_mech)) {
368 $imap_auth_mech = 'login';
369}
370
371if (! isset($use_imap_tls)) {
372 $use_imap_tls = false;
373}
374
375if (! isset($use_smtp_tls)) {
376 $use_smtp_tls = false;
377}
378
a571cff3 379
380// allow plugins to override user prefs
381//
d849b570 382do_hook('loading_prefs', $null);
a571cff3 383
384
385// check user prefs template selection against templates actually available
386//
387$found_templateset = false;
388for ($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//
398if (!$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;
411while (!$found_theme && (list($index, $data) = each($user_themes))) {
412 if ($data['PATH'] == $chosen_theme_path)
413 $found_theme = true;
414}
415
416if (!$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
424if (!$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
2d6b9047 438/* Load up the Signature file */
439$signature_abs = $signature = getSig($data_dir, $username, 'g');
440