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