6 * Loads preferences from the $username.pref file used by almost
7 * every other script in the source directory and alswhere.
9 * @copyright © 1999-2006 The SquirrelMail Project Team
10 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
12 * @package squirrelmail
15 /** SquirrelMail required files. */
16 include_once(SM_PATH
. 'functions/constants.php');
17 include_once(SM_PATH
. 'include/validate.php');
18 include_once(SM_PATH
. 'functions/plugin.php');
21 if( ! sqgetGlobalVar('username', $username, SQ_SESSION
) ) {
25 $custom_css = getPref($data_dir, $username, 'custom_css', 'none' );
27 $theme = ( !isset($theme) ?
array() : $theme );
28 $color = ( !isset($color) ?
array() : $color );
29 $aTemplateSet = ( !isset($aTemplateSet) ?
array() : $aTemplateSet );
30 $templateset_default = ( !isset($templateset_default) ?
0 : $templateset_default );
32 $chosen_theme = getPref($data_dir, $username, 'chosen_theme');
33 $sTplDir = getPref($data_dir, $username, 'sTplDir', SM_PATH
. 'templates/default/');
34 $found_templateset = false;
36 /* need to adjust $chosen_template path with SM_PATH */
37 $sTplDir = preg_replace("/(\.\.\/){1,}/", SM_PATH
, $sTplDir);
39 for ($i = 0; $i < count($aTemplateSet); ++
$i){
40 if ($aTemplateSet[$i]['PATH'] == $sTplDir) {
41 $found_templateset = true;
45 $sTplDir = ($found_templateset ?
$sTplDir : '');
46 if (!$found_templateset) {
47 if (isset($aTemplateSet) && isset($aTemplateSet[$templateset_default]) && file_exists($aTemplateSet[$templateset_default]['PATH'])) {
48 $sTplDir = $aTemplateSet[$templateset_default]['PATH'];
50 $sTplDir = SM_PATH
.'templates/default/';
52 } else if (!file_exists($sTplDir)) {
53 $sTplDir = SM_PATH
.'templates/default/';
58 /* need to adjust $chosen_theme path with SM_PATH */
59 $chosen_theme = preg_replace("/(\.\.\/){1,}/", SM_PATH
, $chosen_theme);
61 for ($i = 0; $i < count($theme); ++
$i){
62 if ($theme[$i]['PATH'] == $chosen_theme) {
67 $chosen_theme = (!$found_theme ?
'' : $chosen_theme);
71 * This theme as a failsafe if no themes were found. It makes
72 * no sense to cause the whole thing to exit just because themes
73 * were not found. This is the absolute last resort.
74 * Moved here to provide 'sane' defaults for incomplete themes.
76 $color[0] = '#DCDCDC'; /* light gray TitleBar */
77 $color[1] = '#800000'; /* red */
78 $color[2] = '#CC0000'; /* light red Warning/Error Messages */
79 $color[3] = '#A0B8C8'; /* green-blue Left Bar Background */
80 $color[4] = '#FFFFFF'; /* white Normal Background */
81 $color[5] = '#FFFFCC'; /* light yellow Table Headers */
82 $color[6] = '#000000'; /* black Text on left bar */
83 $color[7] = '#0000CC'; /* blue Links */
84 $color[8] = '#000000'; /* black Normal text */
85 $color[9] = '#ABABAB'; /* mid-gray Darker version of #0 */
86 $color[10] = '#666666'; /* dark gray Darker version of #9 */
87 $color[11] = '#770000'; /* dark red Special Folders color */
88 $color[12] = '#EDEDED';
89 $color[15] = '#002266'; /* (dark blue) Unselectable folders */
91 if (isset($chosen_theme) && $found_theme && (file_exists($chosen_theme))) {
92 @include_once
($chosen_theme);
94 if (isset($theme) && isset($theme[$theme_default]) && file_exists($theme[$theme_default]['PATH'])) {
95 @include_once
($theme[$theme_default]['PATH']);
96 $chosen_theme = $theme[$theme_default]['PATH'];
101 if (!defined('download_php')) {
102 sqsession_register($theme_css, 'theme_css');
105 // user's icon theme, if using icons
106 $icon_theme = getPref($data_dir, $username, 'icon_theme', 'images/themes/xp/' );
109 * NOTE: The $icon_theme_path var should contain the path to the icon
110 * theme to use. If the admin has disabled icons, or the user has
111 * set the icon theme to "None," no icons will be used.
113 $icon_theme_path = (!$use_icons ||
$icon_theme=='none') ?
NULL : $icon_theme;
115 // show (or not) flag and unflag buttons on mailbox list screen
116 $show_flag_buttons = getPref($data_dir, $username, 'show_flag_buttons', SMPREF_ON
);
118 /* Load the user's special folder preferences */
120 getPref($data_dir, $username, 'move_to_sent', $default_move_to_sent);
122 getPref($data_dir, $username, 'move_to_trash', $default_move_to_trash);
124 getPref($data_dir, $username, 'save_as_draft', $default_save_as_draft);
126 if ($default_unseen_type == '') {
127 $default_unseen_type = 1;
129 if ($default_unseen_notify == '') {
130 $default_unseen_notify = 2;
133 getPref($data_dir, $username, 'unseen_type', $default_unseen_type);
135 getPref($data_dir, $username, 'unseen_notify', $default_unseen_notify);
138 getPref($data_dir, $username, 'unseen_cum', false);
141 getPref($data_dir, $username, 'folder_prefix', $default_folder_prefix);
143 /* Load special folder - trash */
144 $load_trash_folder = getPref($data_dir, $username, 'trash_folder');
145 if (($load_trash_folder == '') && ($move_to_trash)) {
146 $trash_folder = $folder_prefix . $trash_folder;
148 $trash_folder = $load_trash_folder;
151 /* Load special folder - sent */
152 $load_sent_folder = getPref($data_dir, $username, 'sent_folder');
153 if (($load_sent_folder == '') && ($move_to_sent)) {
154 $sent_folder = $folder_prefix . $sent_folder;
156 $sent_folder = $load_sent_folder;
159 /* Load special folder - draft */
160 $load_draft_folder = getPref($data_dir, $username, 'draft_folder');
161 if (($load_draft_folder == '') && ($save_as_draft)) {
162 $draft_folder = $folder_prefix . $draft_folder;
164 $draft_folder = $load_draft_folder;
167 $show_num = getPref($data_dir, $username, 'show_num', 15 );
169 $wrap_at = getPref( $data_dir, $username, 'wrap_at', 86 );
170 if ($wrap_at < 15) { $wrap_at = 15; }
172 $left_size = getPref($data_dir, $username, 'left_size');
173 if ($left_size == '') {
174 if (isset($default_left_size)) {
175 $left_size = $default_left_size;
181 $editor_size = getPref($data_dir, $username, 'editor_size', 76 );
182 $editor_height = getPref($data_dir, $username, 'editor_height', 20 );
183 $use_signature = getPref($data_dir, $username, 'use_signature', SMPREF_OFF
);
184 $prefix_sig = getPref($data_dir, $username, 'prefix_sig');
186 /* Load timezone preferences */
187 $timezone = getPref($data_dir, $username, 'timezone', SMPREF_NONE
);
189 /* Load preferences for reply citation style. */
191 $reply_citation_style =
192 getPref($data_dir, $username, 'reply_citation_style', 'date_time_author' );
193 $reply_citation_start = getPref($data_dir, $username, 'reply_citation_start');
194 $reply_citation_end = getPref($data_dir, $username, 'reply_citation_end');
196 $body_quote = getPref($data_dir, $username, 'body_quote', '>');
197 if ($body_quote == 'NONE') $body_quote = '';
199 // who is using those darn block comments? poo!
201 // Load preference for cursor behavior for replies
203 $reply_focus = getPref($data_dir, $username, 'reply_focus', '');
205 /* left refresh rate, strtolower makes 1.0.6 prefs compatible */
206 $left_refresh = getPref($data_dir, $username, 'left_refresh', 600 );
207 $left_refresh = strtolower($left_refresh);
209 /* Load up the Signature file */
210 $signature_abs = $signature = getSig($data_dir, $username, 'g');
212 /* Message Highlighting Rules */
213 $message_highlight_list = array();
215 /* use new way of storing highlighting rules */
216 if( $ser = getPref($data_dir, $username, 'hililist') ) {
217 $message_highlight_list = unserialize($ser);
220 for ($i = 0; $hlt = getPref($data_dir, $username, "highlight$i"); ++
$i) {
221 $highlight_array = explode(',', $hlt);
222 $message_highlight_list[$i]['name'] = $highlight_array[0];
223 $message_highlight_list[$i]['color'] = $highlight_array[1];
224 $message_highlight_list[$i]['value'] = $highlight_array[2];
225 $message_highlight_list[$i]['match_type'] = $highlight_array[3];
226 removePref($data_dir, $username, "highlight$i");
228 /* store in new format for the next time */
229 setPref($data_dir, $username, 'hililist', serialize($message_highlight_list));
232 /* use the internal date of the message for sorting instead of the supplied header date */
235 $internal_date_sort = getPref($data_dir, $username, 'internal_date_sort', SMPREF_ON
);
237 /* Index order lets you change the order of the message index */
238 $order = getPref($data_dir, $username, 'order1');
239 if (isset($order1)) {
240 removePref($data_dir, $username, 'order1');
241 for ($i = 1; $order; ++
$i) {
242 $index_order[$i-1] = $order -1;
243 $order = getPref($data_dir, $username, 'order'.($i+
1));
244 removePref($data_dir, $username, 'order'.($i+
1));
246 if (isset($internal_date_sort) && $internal_date_sort) {
247 if (in_array(SQM_COL_DATE
,$index_order)) {
248 $k = array_search(SQM_COL_DATE
,$index_order,true);
249 $index_order[$k] = SQM_COL_INT_DATE
;
252 setPref($data_dir, $username, 'index_order', serialize($index_order));
254 $index_order = getPref($data_dir, $username, 'index_order');
255 if (is_string($index_order)) {
256 $index_order = unserialize($index_order);
260 // new Index order handling
261 //$default_mailbox_pref = unserialize(getPref($data_dir, $username, 'default_mailbox_pref'));
264 if (isset($internal_date_sort) && $internal_date_sort == false) {
265 $index_order = array(SQM_COL_CHECK
,SQM_COL_FROM
,SQM_COL_DATE
,SQM_COL_FLAGS
,SQM_COL_ATTACHMENT
,SQM_COL_PRIO
,SQM_COL_SUBJ
);
267 $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
);
269 setPref($data_dir, $username, 'index_order', serialize($index_order));
274 if (!isset($default_mailbox_pref)) {
275 $show_num = (isset($show_num)) ?
$show_num : 15;
277 $default_mailbox_pref = array (
279 MBX_PREF_LIMIT
=> $show_num,
280 MBX_PREF_AUTO_EXPUNGE
=> $auto_expunge,
281 MBX_PREF_COLUMNS
=> $index_order);
282 // setPref($data_dir, $username, 'default_mailbox_pref', serialize($default_mailbox_pref));
283 // clean up the old prefs
284 // if (isset($prefs_cache['internal_date_sort'])) {
285 // unset($prefs_cache['internal_date_sort']);
286 // removePref($data_dir,$username,'internal_date_sort');
288 // if (isset($prefs_cache['show_num'])) {
289 // unset($prefs_cache['show_num']);
290 // removePref($data_dir,$username,'show_num');
296 getPref($data_dir, $username, 'alt_index_colors', SMPREF_ON
);
298 $fancy_index_highlite =
299 getPref($data_dir, $username, 'fancy_index_highlite', SMPREF_ON
);
301 /* Folder List Display Format */
303 getPref($data_dir, $username, 'location_of_bar', SMPREF_LOC_LEFT
);
304 $location_of_buttons =
305 getPref($data_dir, $username, 'location_of_buttons', SMPREF_LOC_BETWEEN
);
308 getPref($data_dir, $username, 'collapse_folders', SMPREF_ON
);
311 getPref($data_dir, $username, 'show_html_default', SMPREF_ON
);
313 $enable_forward_as_attachment =
314 getPref($data_dir, $username, 'enable_forward_as_attachment', SMPREF_ON
);
316 $show_xmailer_default =
317 getPref($data_dir, $username, 'show_xmailer_default', SMPREF_OFF
);
318 $attachment_common_show_images = getPref($data_dir, $username, 'attachment_common_show_images', SMPREF_OFF
);
321 /* message disposition notification support setting */
322 $mdn_user_support = getPref($data_dir, $username, 'mdn_user_support', SMPREF_ON
);
324 $include_self_reply_all =
325 getPref($data_dir, $username, 'include_self_reply_all', SMPREF_ON
);
327 /* Page selector options */
328 $page_selector = getPref($data_dir, $username, 'page_selector', SMPREF_ON
);
329 $compact_paginator = getPref($data_dir, $username, 'compact_paginator', SMPREF_OFF
);
330 $page_selector_max = getPref($data_dir, $username, 'page_selector_max', 10);
332 /* SqClock now in the core */
333 $date_format = getPref($data_dir, $username, 'date_format', 3);
334 $hour_format = getPref($data_dir, $username, 'hour_format', SMPREF_TIME_12HR
);
336 /* compose in new window setting */
337 $compose_new_win = getPref($data_dir, $username, 'compose_new_win', SMPREF_OFF
);
338 $compose_height = getPref($data_dir, $username, 'compose_height', 550);
339 $compose_width = getPref($data_dir, $username, 'compose_width', 640);
342 /* signature placement settings */
343 $sig_first = getPref($data_dir, $username, 'sig_first', SMPREF_OFF
);
345 /* Strip signature when replying */
346 $strip_sigs = getPref($data_dir, $username, 'strip_sigs', SMPREF_ON
);
348 /* use the internal date of the message for sorting instead of the supplied header date */
349 $internal_date_sort = getPref($data_dir, $username, 'internal_date_sort', SMPREF_ON
);
351 /* if server sorting is enabled/disabled */
352 $sort_by_ref = getPref($data_dir, $username, 'sort_by_ref', SMPREF_ON
);
354 /* Load the javascript settings. */
355 $javascript_setting = getPref($data_dir, $username, 'javascript_setting', SMPREF_JS_AUTODETECT
);
356 if ( checkForJavascript() )
358 $use_javascript_folder_list = getPref($data_dir, $username, 'use_javascript_folder_list');
359 $use_javascript_addr_book = getPref($data_dir, $username, 'use_javascript_addr_book', $default_use_javascript_addr_book);
361 $use_javascript_folder_list = false;
362 $use_javascript_addr_book = false;
365 $search_memory = getPref($data_dir, $username, 'search_memory', SMPREF_OFF
);
367 $show_only_subscribed_folders =
368 getPref($data_dir, $username, 'show_only_subscribed_folders', SMPREF_ON
);
371 $forward_cc = getPref($data_dir, $username, 'forward_cc', SMPREF_OFF
);
373 /* How are mailbox select lists displayed: 0. full names, 1. indented (default),
375 $mailbox_select_style = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_ON
);
377 /* Allow user to customize, and display the full date, instead of day, or time based
378 on time distance from date of message */
379 $show_full_date = getPref($data_dir, $username, 'show_full_date', SMPREF_OFF
);
381 /* Allow user to customize length of from field */
382 $truncate_sender = getPref($data_dir, $username, 'truncate_sender', 50);
383 /* Allow user to customize length of subject field */
384 $truncate_subject = getPref($data_dir, $username, 'truncate_subject', 50);
385 /* Allow user to show recipient name if the message is from default identity */
386 $show_recipient_instead = getPref($data_dir, $username, 'show_recipient_instead', SMPREF_OFF
);
388 $delete_prev_next_display = getPref($data_dir, $username, 'delete_prev_next_display', SMPREF_ON
);
391 * Height of iframe that displays html formated emails
394 $iframe_height = getPref($data_dir, $username, 'iframe_height', '300');
396 if (! isset($default_fontset)) $default_fontset=SMPREF_NONE
;
397 $chosen_fontset = getPref($data_dir, $username, 'chosen_fontset', $default_fontset);
398 if (! isset($default_fontsize)) $default_fontsize=SMPREF_NONE
;
399 $chosen_fontsize = getPref($data_dir, $username, 'chosen_fontsize', $default_fontsize);
401 do_hook('loading_prefs');