phpdocumentor basic preparation, continued
[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 * @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 $use_javascript_addr_book = getPref($data_dir, $username, 'use_javascript_addr_book', $default_use_javascript_addr_book);
81
82 /* Load the user's special folder preferences */
83 $move_to_sent =
84 getPref($data_dir, $username, 'move_to_sent', $default_move_to_sent);
85 $move_to_trash =
86 getPref($data_dir, $username, 'move_to_trash', $default_move_to_trash);
87 $save_as_draft =
88 getPref($data_dir, $username, 'save_as_draft', $default_save_as_draft);
89
90 if ($default_unseen_type == '') {
91 $default_unseen_type = 1;
92 }
93 if ($default_unseen_notify == '') {
94 $default_unseen_notify = 2;
95 }
96 $unseen_type =
97 getPref($data_dir, $username, 'unseen_type', $default_unseen_type);
98 $unseen_notify =
99 getPref($data_dir, $username, 'unseen_notify', $default_unseen_notify);
100
101 $unseen_cum =
102 getPref($data_dir, $username, 'unseen_cum', false);
103
104 $folder_prefix =
105 getPref($data_dir, $username, 'folder_prefix', $default_folder_prefix);
106
107 /* Load special folder - trash */
108 $load_trash_folder = getPref($data_dir, $username, 'trash_folder');
109 if (($load_trash_folder == '') && ($move_to_trash)) {
110 $trash_folder = $folder_prefix . $trash_folder;
111 } else {
112 $trash_folder = $load_trash_folder;
113 }
114
115 /* Load special folder - sent */
116 $load_sent_folder = getPref($data_dir, $username, 'sent_folder');
117 if (($load_sent_folder == '') && ($move_to_sent)) {
118 $sent_folder = $folder_prefix . $sent_folder;
119 } else {
120 $sent_folder = $load_sent_folder;
121 }
122
123 /* Load special folder - draft */
124 $load_draft_folder = getPref($data_dir, $username, 'draft_folder');
125 if (($load_draft_folder == '') && ($save_as_draft)) {
126 $draft_folder = $folder_prefix . $draft_folder;
127 } else {
128 $draft_folder = $load_draft_folder;
129 }
130
131 $show_num = getPref($data_dir, $username, 'show_num', 15 );
132
133 $wrap_at = getPref( $data_dir, $username, 'wrap_at', 86 );
134 if ($wrap_at < 15) { $wrap_at = 15; }
135
136 $left_size = getPref($data_dir, $username, 'left_size');
137 if ($left_size == '') {
138 if (isset($default_left_size)) {
139 $left_size = $default_left_size;
140 } else {
141 $left_size = 200;
142 }
143 }
144
145 $editor_size = getPref($data_dir, $username, 'editor_size', 76 );
146 $use_signature = getPref($data_dir, $username, 'use_signature', SMPREF_OFF );
147 $prefix_sig = getPref($data_dir, $username, 'prefix_sig');
148
149 /* Load timezone preferences */
150 $timezone = getPref($data_dir, $username, 'timezone', SMPREF_NONE );
151
152 /* Load preferences for reply citation style. */
153
154 $reply_citation_style =
155 getPref($data_dir, $username, 'reply_citation_style', SMPREF_NONE );
156 $reply_citation_start = getPref($data_dir, $username, 'reply_citation_start');
157 $reply_citation_end = getPref($data_dir, $username, 'reply_citation_end');
158
159 // who is using those darn block comments? poo!
160
161 // Load preference for cursor behavior for replies
162 //
163 $reply_focus = getPref($data_dir, $username, 'reply_focus', '');
164
165 /* left refresh rate, strtolower makes 1.0.6 prefs compatible */
166 $left_refresh = getPref($data_dir, $username, 'left_refresh', SMPREF_NONE );
167 $left_refresh = strtolower($left_refresh);
168
169 $sort = getPref($data_dir, $username, 'sort', 6 );
170
171 /** Load up the Signature file **/
172 $signature_abs = $signature = getSig($data_dir, $username, 'g');
173
174 /* Message Highlighting Rules */
175 $message_highlight_list = array();
176
177 /* use new way of storing highlighting rules */
178 if( $ser = getPref($data_dir, $username, 'hililist') ) {
179 $message_highlight_list = unserialize($ser);
180 } else {
181 /* use old way */
182 for ($i = 0; $hlt = getPref($data_dir, $username, "highlight$i"); ++$i) {
183 $highlight_array = explode(',', $hlt);
184 $message_highlight_list[$i]['name'] = $highlight_array[0];
185 $message_highlight_list[$i]['color'] = $highlight_array[1];
186 $message_highlight_list[$i]['value'] = $highlight_array[2];
187 $message_highlight_list[$i]['match_type'] = $highlight_array[3];
188 removePref($data_dir, $username, "highlight$i");
189 }
190 /* store in new format for the next time */
191 setPref($data_dir, $username, 'hililist', serialize($message_highlight_list));
192 }
193
194 /* Index order lets you change the order of the message index */
195 $order = getPref($data_dir, $username, 'order1');
196 for ($i = 1; $order; ++$i) {
197 $index_order[$i] = $order;
198 $order = getPref($data_dir, $username, 'order'.($i+1));
199 }
200 if (!isset($index_order)) {
201 $index_order[1] = 1;
202 $index_order[2] = 2;
203 $index_order[3] = 3;
204 $index_order[4] = 5;
205 $index_order[5] = 4;
206 }
207
208 $alt_index_colors =
209 getPref($data_dir, $username, 'alt_index_colors', SMPREF_ON );
210
211 /* Folder List Display Format */
212 $use_javascript_folder_list = getPref($data_dir, $username, 'use_javascript_folder_list');
213 $location_of_bar =
214 getPref($data_dir, $username, 'location_of_bar', SMPREF_LOC_LEFT);
215 $location_of_buttons =
216 getPref($data_dir, $username, 'location_of_buttons', SMPREF_LOC_BETWEEN);
217
218 $collapse_folders =
219 getPref($data_dir, $username, 'collapse_folders', SMPREF_ON);
220
221 $show_html_default =
222 getPref($data_dir, $username, 'show_html_default', SMPREF_OFF);
223
224 $enable_forward_as_attachment =
225 getPref($data_dir, $username, 'enable_forward_as_attachment', SMPREF_ON);
226
227 $show_xmailer_default =
228 getPref($data_dir, $username, 'show_xmailer_default', SMPREF_OFF );
229 $attachment_common_show_images = getPref($data_dir, $username, 'attachment_common_show_images', SMPREF_OFF );
230 $pf_cleandisplay = getPref($data_dir, $username, 'pf_cleandisplay', SMPREF_OFF);
231
232 /* message disposition notification support setting */
233 $mdn_user_support = getPref($data_dir, $username, 'mdn_user_support', SMPREF_ON);
234
235 $include_self_reply_all =
236 getPref($data_dir, $username, 'include_self_reply_all', SMPREF_ON);
237
238 $page_selector = getPref($data_dir, $username, 'page_selector', SMPREF_ON);
239 $page_selector_max = getPref($data_dir, $username, 'page_selector_max', 10);
240
241 /* SqClock now in the core */
242 $date_format = getPref($data_dir, $username, 'date_format', 3);
243 $hour_format = getPref($data_dir, $username, 'hour_format', 2);
244
245 /* compose in new window setting */
246 $compose_new_win = getPref($data_dir, $username, 'compose_new_win', 0);
247 $compose_height = getPref($data_dir, $username, 'compose_height', 550);
248 $compose_width = getPref($data_dir, $username, 'compose_width', 640);
249
250
251 /* signature placement settings */
252 $sig_first = getPref($data_dir, $username, 'sig_first', 0);
253
254 /* Strip signature when replying */
255 $strip_sigs = getPref($data_dir, $username, 'strip_sigs', 0);
256
257 /* use the internal date of the message for sorting instead of the supplied header date */
258 $internal_date_sort = getPref($data_dir, $username, 'internal_date_sort', SMPREF_ON);
259
260 /* if server sorting is enabled/disabled */
261 $sort_by_ref = getPref($data_dir, $username, 'sort_by_ref', 1);
262
263 /* Load the javascript settings. */
264 $javascript_setting =
265 getPref($data_dir, $username, 'javascript_setting', SMPREF_JS_AUTODETECT);
266 $javascript_on = getPref($data_dir, $username, 'javascript_on', SMPREF_ON);
267
268
269 $search_memory = getPref($data_dir, $username, 'search_memory', 0);
270
271 $forward_cc = getPref($data_dir, $username, 'forward_cc', 0);
272
273 $mailbox_select_style = getPref($data_dir, $username, 'mailbox_select_style', 0);
274
275 /* Allow user to customize, and display the full date, instead of day, or time based
276 on time distance from date of message */
277 $show_full_date = getPref($data_dir, $username, 'show_full_date', 0);
278
279 /* Allow user to customize length of from field */
280 $truncate_sender = getPref($data_dir, $username, 'truncate_sender', 0);
281 /* Allow user to customize length of subject field */
282 $truncate_subject = getPref($data_dir, $username, 'truncate_subject', 50);
283 /* Allow user to show recipient name if the message is from default identity */
284 $show_recipient_instead = getPref($data_dir, $username, 'show_recipient_instead', 0);
285
286 do_hook('loading_prefs');
287
288 ?>