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