Preparation to begin using phpdocumentor.
[squirrelmail.git] / include / load_prefs.php
1 <?php
2
3 /**
4 * load_prefs.php
5 *
6 * Copyright (c) 1999-2003 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
8 *
9 * Loads preferences from the $username.pref file used by almost
10 * every other script in the source directory and alswhere.
11 *
12 * $Id$
13 */
14
15 /* SquirrelMail required files. */
16 require_once(SM_PATH . 'include/validate.php');
17 require_once(SM_PATH . 'functions/prefs.php');
18 require_once(SM_PATH . 'functions/plugin.php');
19 require_once(SM_PATH . 'functions/constants.php');
20
21 if( ! sqgetGlobalVar('username', $username, SQ_SESSION) ) {
22 $username = '';
23 }
24
25 $custom_css = getPref($data_dir, $username, 'custom_css', 'none' );
26
27 $theme = ( !isset($theme) ? array() : $theme );
28 $color = ( !isset($color) ? array() : $color );
29
30 $chosen_theme = getPref($data_dir, $username, 'chosen_theme');
31 $found_theme = false;
32
33 /* need to adjust $chosen_theme path with SM_PATH */
34 $chosen_theme = preg_replace("/(\.\.\/){1,}/", SM_PATH, $chosen_theme);
35
36 for ($i = 0; $i < count($theme); ++$i){
37 if ($theme[$i]['PATH'] == $chosen_theme) {
38 $found_theme = true;
39 break;
40 }
41 }
42 $chosen_theme = (!$found_theme ? '' : $chosen_theme);
43
44 /**
45 * This theme as a failsafe if no themes were found. It makes
46 * no sense to cause the whole thing to exit just because themes
47 * were not found. This is the absolute last resort.
48 * Moved here to provide 'sane' defaults for incomplete themes.
49 */
50 $color[0] = '#DCDCDC'; /* light gray TitleBar */
51 $color[1] = '#800000'; /* red */
52 $color[2] = '#CC0000'; /* light red Warning/Error Messages */
53 $color[3] = '#A0B8C8'; /* green-blue Left Bar Background */
54 $color[4] = '#FFFFFF'; /* white Normal Background */
55 $color[5] = '#FFFFCC'; /* light yellow Table Headers */
56 $color[6] = '#000000'; /* black Text on left bar */
57 $color[7] = '#0000CC'; /* blue Links */
58 $color[8] = '#000000'; /* black Normal text */
59 $color[9] = '#ABABAB'; /* mid-gray Darker version of #0 */
60 $color[10] = '#666666'; /* dark gray Darker version of #9 */
61 $color[11] = '#770000'; /* dark red Special Folders color */
62 $color[12] = '#EDEDED';
63 $color[15] = '#002266'; /* (dark blue) Unselectable folders */
64
65 if (isset($chosen_theme) && $found_theme && (file_exists($chosen_theme))) {
66 @include_once($chosen_theme);
67 } else {
68 if (isset($theme) && isset($theme[$theme_default]) && file_exists($theme[$theme_default]['PATH'])) {
69 @include_once($theme[$theme_default]['PATH']);
70 $chosen_theme = $theme[$theme_default]['PATH'];
71 }
72 }
73
74
75 if (!defined('download_php')) {
76 sqsession_register($theme_css, 'theme_css');
77 }
78
79 $use_javascript_addr_book = getPref($data_dir, $username, 'use_javascript_addr_book', $default_use_javascript_addr_book);
80
81 /* Load the user's special folder preferences */
82 $move_to_sent =
83 getPref($data_dir, $username, 'move_to_sent', $default_move_to_sent);
84 $move_to_trash =
85 getPref($data_dir, $username, 'move_to_trash', $default_move_to_trash);
86 $save_as_draft =
87 getPref($data_dir, $username, 'save_as_draft', $default_save_as_draft);
88
89 if ($default_unseen_type == '') {
90 $default_unseen_type = 1;
91 }
92 if ($default_unseen_notify == '') {
93 $default_unseen_notify = 2;
94 }
95 $unseen_type =
96 getPref($data_dir, $username, 'unseen_type', $default_unseen_type);
97 $unseen_notify =
98 getPref($data_dir, $username, 'unseen_notify', $default_unseen_notify);
99
100 $unseen_cum =
101 getPref($data_dir, $username, 'unseen_cum', false);
102
103 $folder_prefix =
104 getPref($data_dir, $username, 'folder_prefix', $default_folder_prefix);
105
106 /* Load special folder - trash */
107 $load_trash_folder = getPref($data_dir, $username, 'trash_folder');
108 if (($load_trash_folder == '') && ($move_to_trash)) {
109 $trash_folder = $folder_prefix . $trash_folder;
110 } else {
111 $trash_folder = $load_trash_folder;
112 }
113
114 /* Load special folder - sent */
115 $load_sent_folder = getPref($data_dir, $username, 'sent_folder');
116 if (($load_sent_folder == '') && ($move_to_sent)) {
117 $sent_folder = $folder_prefix . $sent_folder;
118 } else {
119 $sent_folder = $load_sent_folder;
120 }
121
122 /* Load special folder - draft */
123 $load_draft_folder = getPref($data_dir, $username, 'draft_folder');
124 if (($load_draft_folder == '') && ($save_as_draft)) {
125 $draft_folder = $folder_prefix . $draft_folder;
126 } else {
127 $draft_folder = $load_draft_folder;
128 }
129
130 $show_num = getPref($data_dir, $username, 'show_num', 15 );
131
132 $wrap_at = getPref( $data_dir, $username, 'wrap_at', 86 );
133 if ($wrap_at < 15) { $wrap_at = 15; }
134
135 $left_size = getPref($data_dir, $username, 'left_size');
136 if ($left_size == '') {
137 if (isset($default_left_size)) {
138 $left_size = $default_left_size;
139 } else {
140 $left_size = 200;
141 }
142 }
143
144 $editor_size = getPref($data_dir, $username, 'editor_size', 76 );
145 $use_signature = getPref($data_dir, $username, 'use_signature', SMPREF_OFF );
146 $prefix_sig = getPref($data_dir, $username, 'prefix_sig');
147
148 /* Load timezone preferences */
149 $timezone = getPref($data_dir, $username, 'timezone', SMPREF_NONE );
150
151 /* Load preferences for reply citation style. */
152
153 $reply_citation_style =
154 getPref($data_dir, $username, 'reply_citation_style', SMPREF_NONE );
155 $reply_citation_start = getPref($data_dir, $username, 'reply_citation_start');
156 $reply_citation_end = getPref($data_dir, $username, 'reply_citation_end');
157
158 // who is using those darn block comments? poo!
159
160 // Load preference for cursor behavior for replies
161 //
162 $reply_focus = getPref($data_dir, $username, 'reply_focus', '');
163
164 /* left refresh rate, strtolower makes 1.0.6 prefs compatible */
165 $left_refresh = getPref($data_dir, $username, 'left_refresh', SMPREF_NONE );
166 $left_refresh = strtolower($left_refresh);
167
168 $sort = getPref($data_dir, $username, 'sort', 6 );
169
170 /** Load up the Signature file **/
171 $signature_abs = $signature = getSig($data_dir, $username, 'g');
172
173 /* Message Highlighting Rules */
174 $message_highlight_list = array();
175
176 /* use new way of storing highlighting rules */
177 if( $ser = getPref($data_dir, $username, 'hililist') ) {
178 $message_highlight_list = unserialize($ser);
179 } else {
180 /* use old way */
181 for ($i = 0; $hlt = getPref($data_dir, $username, "highlight$i"); ++$i) {
182 $highlight_array = explode(',', $hlt);
183 $message_highlight_list[$i]['name'] = $highlight_array[0];
184 $message_highlight_list[$i]['color'] = $highlight_array[1];
185 $message_highlight_list[$i]['value'] = $highlight_array[2];
186 $message_highlight_list[$i]['match_type'] = $highlight_array[3];
187 removePref($data_dir, $username, "highlight$i");
188 }
189 /* store in new format for the next time */
190 setPref($data_dir, $username, 'hililist', serialize($message_highlight_list));
191 }
192
193 /* Index order lets you change the order of the message index */
194 $order = getPref($data_dir, $username, 'order1');
195 for ($i = 1; $order; ++$i) {
196 $index_order[$i] = $order;
197 $order = getPref($data_dir, $username, 'order'.($i+1));
198 }
199 if (!isset($index_order)) {
200 $index_order[1] = 1;
201 $index_order[2] = 2;
202 $index_order[3] = 3;
203 $index_order[4] = 5;
204 $index_order[5] = 4;
205 }
206
207 $alt_index_colors =
208 getPref($data_dir, $username, 'alt_index_colors', SMPREF_ON );
209
210 /* Folder List Display Format */
211 $use_javascript_folder_list = getPref($data_dir, $username, 'use_javascript_folder_list');
212 $location_of_bar =
213 getPref($data_dir, $username, 'location_of_bar', SMPREF_LOC_LEFT);
214 $location_of_buttons =
215 getPref($data_dir, $username, 'location_of_buttons', SMPREF_LOC_BETWEEN);
216
217 $collapse_folders =
218 getPref($data_dir, $username, 'collapse_folders', SMPREF_ON);
219
220 $show_html_default =
221 getPref($data_dir, $username, 'show_html_default', SMPREF_OFF);
222
223 $enable_forward_as_attachment =
224 getPref($data_dir, $username, 'enable_forward_as_attachment', SMPREF_ON);
225
226 $show_xmailer_default =
227 getPref($data_dir, $username, 'show_xmailer_default', SMPREF_OFF );
228 $attachment_common_show_images = getPref($data_dir, $username, 'attachment_common_show_images', SMPREF_OFF );
229 $pf_cleandisplay = getPref($data_dir, $username, 'pf_cleandisplay', SMPREF_OFF);
230
231 /* message disposition notification support setting */
232 $mdn_user_support = getPref($data_dir, $username, 'mdn_user_support', SMPREF_ON);
233
234 $include_self_reply_all =
235 getPref($data_dir, $username, 'include_self_reply_all', SMPREF_ON);
236
237 $page_selector = getPref($data_dir, $username, 'page_selector', SMPREF_ON);
238 $page_selector_max = getPref($data_dir, $username, 'page_selector_max', 10);
239
240 /* SqClock now in the core */
241 $date_format = getPref($data_dir, $username, 'date_format', 3);
242 $hour_format = getPref($data_dir, $username, 'hour_format', 2);
243
244 /* compose in new window setting */
245 $compose_new_win = getPref($data_dir, $username, 'compose_new_win', 0);
246 $compose_height = getPref($data_dir, $username, 'compose_height', 550);
247 $compose_width = getPref($data_dir, $username, 'compose_width', 640);
248
249
250 /* signature placement settings */
251 $sig_first = getPref($data_dir, $username, 'sig_first', 0);
252
253 /* Strip signature when replying */
254 $strip_sigs = getPref($data_dir, $username, 'strip_sigs', 0);
255
256 /* use the internal date of the message for sorting instead of the supplied header date */
257 $internal_date_sort = getPref($data_dir, $username, 'internal_date_sort', SMPREF_ON);
258
259 /* if server sorting is enabled/disabled */
260 $sort_by_ref = getPref($data_dir, $username, 'sort_by_ref', 1);
261
262 /* Load the javascript settings. */
263 $javascript_setting =
264 getPref($data_dir, $username, 'javascript_setting', SMPREF_JS_AUTODETECT);
265 $javascript_on = getPref($data_dir, $username, 'javascript_on', SMPREF_ON);
266
267
268 $search_memory = getPref($data_dir, $username, 'search_memory', 0);
269
270 $forward_cc = getPref($data_dir, $username, 'forward_cc', 0);
271
272 $mailbox_select_style = getPref($data_dir, $username, 'mailbox_select_style', 0);
273
274 /* Allow user to customize, and display the full date, instead of day, or time based
275 on time distance from date of message */
276 $show_full_date = getPref($data_dir, $username, 'show_full_date', 0);
277
278 /* Allow user to customize length of from field */
279 $truncate_sender = getPref($data_dir, $username, 'truncate_sender', 0);
280 /* Allow user to customize length of subject field */
281 $truncate_subject = getPref($data_dir, $username, 'truncate_subject', 50);
282 /* Allow user to show recipient name if the message is from default identity */
283 $show_recipient_instead = getPref($data_dir, $username, 'show_recipient_instead', 0);
284
285 do_hook('loading_prefs');
286
287 ?>