6 * Copyright (c) 1999-2002 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
9 * Displays the options page. Pulls from proper user preference files
10 * and config.php. Displays preferences as selected and other options.
15 require_once('../src/validate.php');
16 require_once('../functions/display_messages.php');
17 require_once('../functions/imap.php');
18 require_once('../functions/array.php');
19 require_once('../functions/options.php');
20 require_once('../functions/strings.php');
22 /* Set the base uri. */
23 ereg ("(^.*/)[^/]+/[^/]+$", $PHP_SELF, $regs);
26 /* First and foremost, deal with language stuff. */
27 if (isset($language)) {
28 setcookie('squirrelmail_language', $language, time()+
2592000, $base_uri);
29 $squirrelmail_language = $language;
31 $language = getPref($data_dir, $username, 'language');
34 /*********************************/
35 /*** Build the resultant page. ***/
36 /*********************************/
38 displayPageHeader($color, 'None');
40 define('SMOPT_MODE_DISPLAY', 'display');
41 define('SMOPT_MODE_SUBMIT', 'submit');
42 define('SMOPT_MODE_LINK', 'link');
44 define('SMOPT_PAGE_MAIN', 'main');
45 define('SMOPT_PAGE_PERSONAL', 'personal');
46 define('SMOPT_PAGE_DISPLAY', 'display');
47 define('SMOPT_PAGE_HIGHLIGHT', 'highlight');
48 define('SMOPT_PAGE_FOLDER', 'folder');
49 define('SMOPT_PAGE_ORDER', 'order');
51 function process_optionmode_submit($optpage, $optpage_data) {
52 /* Initialize the maximum option refresh level. */
53 $max_refresh = SMOPT_REFRESH_NONE
;
55 /* Save each option in each option group. */
56 foreach ($optpage_data['options'] as $option_grp) {
57 foreach ($option_grp['options'] as $option) {
58 /* Remove Debug Mode Until Needed
59 echo "name = '$option->name', "
60 . "value = '$option->value', "
61 . "new_value = '$option->new_value'<BR>\n";
63 if ($option->changed()) {
65 $max_refresh = max($max_refresh, $option->refresh_level
);
70 /* Return the max refresh level. */
71 return ($max_refresh);
74 function process_optionmode_link($optpage) {
75 /* There will be something here, later. */
78 /* Make sure we have an Option Page set. Default to main. */
79 if (!isset($optpage)) {
83 /* Make sure we have an Option Mode set. Default to display. */
84 if (!isset($optmode)) {
85 $optmode = SMOPT_MODE_DISPLAY
;
88 /*************************************************************/
89 /*** First, set the load information for each option page. ***/
90 /*************************************************************/
92 /* Initialize load information variables. */
97 /* Set the load information for each page. */
99 case SMOPT_PAGE_MAIN
: break;
100 case SMOPT_PAGE_PERSONAL
:
101 $optpage_name = _("Personal Information");
102 $optpage_file = '../src/options_personal.php';
103 $optpage_loader = 'load_optpage_data_personal';
104 $optpage_loadhook = 'optpage_loadhook_personal';
106 case SMOPT_PAGE_DISPLAY
:
107 $optpage_name = _("Display Preferences");
108 $optpage_file = '../src/options_display.php';
109 $optpage_loader = 'load_optpage_data_display';
110 $optpage_loadhook = 'optpage_loadhook_display';
112 case SMOPT_PAGE_HIGHLIGHT
:
113 $optpage_name = _("Message Highlighting");
114 $optpage_file = '../src/options_highlight.php';
115 $optpage_loader = 'load_optpage_data_highlight';
116 $optpage_loadhook = 'optpage_loadhook_highlight';
118 case SMOPT_PAGE_FOLDER
:
119 $optpage_name = _("Folder Preferences");
120 $optpage_file = '../src/options_folder.php';
121 $optpage_loader = 'load_optpage_data_folder';
122 $optpage_loadhook = 'optpage_loadhook_folder';
124 case SMOPT_PAGE_ORDER
:
125 $optpage_name = _("Index Order");
126 $optpage_file = '../src/options_order.php';
127 $optpage_loader = 'load_optpage_data_order';
128 $optpage_loadhook = 'optpage_loadhook_order';
130 default: do_hook('optpage_set_loadinfo');
133 /**********************************************************/
134 /*** Second, load the option information for this page. ***/
135 /**********************************************************/
137 if ($optpage != SMOPT_PAGE_MAIN
) {
138 /* Include the file for this optionpage. */
139 require_once($optpage_file);
141 /* Assemble the data for this option page. */
142 $optpage_data = array();
143 $optpage_data = $optpage_loader();
144 do_hook($optpage_loadhook);
145 $optpage_data['options'] =
146 create_option_groups($optpage_data['grps'], $optpage_data['vals']);
149 /***********************************************************/
150 /*** Next, process anything that needs to be processed. ***/
151 /***********************************************************/
153 if ( isset( $optpage_data ) ) {
155 case SMOPT_MODE_SUBMIT
:
156 $max_refresh = process_optionmode_submit($optpage, $optpage_data);
158 case SMOPT_MODE_LINK
:
159 $max_refresh = process_optionmode_link($optpage, $optpage_data);
163 /*** MOVE THIS DISPLAY CODE DOWN EVENTUALLY!!! ***/
165 $optpage_title = _("Options");
166 if (isset($optpage_name) && ($optpage_name != '')) {
167 $optpage_title .= " - $optpage_name";
173 <TABLE BGCOLOR
="<?php echo $color[0] ?>" WIDTH
="95%" ALIGN
="CENTER" CELLPADDING
="2" CELLSPACING
="0" BORDER
="0">
174 <TR
><TD ALIGN
="CENTER">
175 <B
><?php
echo $optpage_title; ?
></B
><BR
>
176 <TABLE WIDTH
="100%" BORDER
="0" CELLPADDING
="5" CELLSPACING
="0">
177 <TR
><TD BGCOLOR
="<?php echo $color[4] ?>" ALIGN
="CENTER">
181 /*******************************************************************/
182 /* DO OLD SAVING OF SUBMITTED OPTIONS. THIS WILL BE REMOVED LATER. */
183 /*******************************************************************/
185 /* If in submit mode, select a save hook name and run it. */
186 if ($optmode == SMOPT_MODE_SUBMIT
) {
187 /* Select a save hook name. */
189 case SMOPT_PAGE_PERSONAL
:
190 $save_hook_name = 'options_personal_save';
192 case SMOPT_PAGE_DISPLAY
:
193 $save_hook_name = 'options_display_save';
195 case SMOPT_PAGE_FOLDER
:
196 $save_hook_name = 'options_folder_save';
199 $save_hook_name = 'options_save';
203 /* Run the options save hook. */
204 do_hook($save_hook_name);
207 /***************************************************************/
208 /* Apply logic to decide what optpage we want to display next. */
209 /***************************************************************/
211 /* If this is the result of an option page being submitted, then */
212 /* show the main page. Otherwise, show whatever page was called. */
214 if ($optmode == SMOPT_MODE_SUBMIT
) {
215 $optpage = SMOPT_PAGE_MAIN
;
218 /***************************************************************/
219 /* Finally, display whatever page we are supposed to show now. */
220 /***************************************************************/
223 * The main option page has a different layout then the rest of the option
224 * pages. Therefore, we create it here first, then the others below.
226 if ($optpage == SMOPT_PAGE_MAIN
) {
227 /**********************************************************/
228 /* First, display the results of a submission, if needed. */
229 /**********************************************************/
230 if ($optmode == SMOPT_MODE_SUBMIT
) {
231 /* Display a message indicating a successful save. */
232 echo '<B>' . _("Successfully Saved Options") . ": $optpage_name</B><BR>\n";
234 /* If $max_refresh != SMOPT_REFRESH_NONE, provide a refresh link. */
235 if ($max_refresh == SMOPT_REFRESH_FOLDERLIST
) {
236 echo '<A HREF="../src/left_main.php" TARGET="left">' . _("Refresh Folder List") . '</A><BR>';
237 } else if ($max_refresh) {
238 echo '<A HREF="../src/webmail.php?right_frame=options.php" TARGET="$frame_top">' . _("Refresh Page") . '</A><BR>';
241 /******************************************/
242 /* Build our array of Option Page Blocks. */
243 /******************************************/
244 $optpage_blocks = array();
246 /* Build a section for Personal Options. */
247 $optpage_blocks[] = array(
248 'name' => _("Personal Information"),
249 'url' => 'options.php?optpage=' . SMOPT_PAGE_PERSONAL
,
250 'desc' => _("This contains personal information about yourself such as your name, your email address, etc."),
254 /* Build a section for Display Options. */
255 $optpage_blocks[] = array(
256 'name' => _("Display Preferences"),
257 'url' => 'options.php?optpage=' . SMOPT_PAGE_DISPLAY
,
258 'desc' => _("You can change the way that SquirrelMail looks and displays information to you, such as the colors, the language, and other settings."),
262 /* Build a section for Message Highlighting Options. */
263 $optpage_blocks[] = array(
264 'name' =>_("Message Highlighting"),
265 'url' => 'options_highlight.php',
266 'desc' =>_("Based upon given criteria, incoming messages can have different background colors in the message list. This helps to easily distinguish who the messages are from, especially for mailing lists."),
270 /* Build a section for Folder Options. */
271 $optpage_blocks[] = array(
272 'name' => _("Folder Preferences"),
273 'url' => 'options.php?optpage=' . SMOPT_PAGE_FOLDER
,
274 'desc' => _("These settings change the way your folders are displayed and manipulated."),
278 /* Build a section for Index Order Options. */
279 $optpage_blocks[] = array(
280 'name' => _("Index Order"),
281 'url' => 'options_order.php',
282 'desc' => _("The order of the message index can be rearranged and changed to contain the headers in any order you want."),
286 /* Build a section for plugins wanting to register an optionpage. */
287 do_hook('optpage_register_block');
289 /*****************************************************/
290 /* Let's sort Javascript Option Pages to the bottom. */
291 /*****************************************************/
292 $js_optpage_blocks = array();
293 $reg_optpage_blocks = array();
294 foreach ($optpage_blocks as $cur_optpage) {
295 if (!$cur_optpage['js']) {
296 $reg_optpage_blocks[] = $cur_optpage;
297 } else if ($javascript_on == SMPREF_JS_ON
) {
298 $js_optpage_blocks[] = $cur_optpage;
301 $optpage_blocks = array_merge($reg_optpage_blocks, $js_optpage_blocks);
303 /********************************************/
304 /* Now, print out each option page section. */
305 /********************************************/
306 $first_optpage = false;
307 echo "<TABLE BGCOLOR=\"$color[4]\" WIDTH=\"100%\" CELLPADDING=0 CELLSPACING=\"5\" BORDER=\"0\">" .
308 '<TR><TD VALIGN="TOP">' .
309 "<TABLE BGCOLOR=\"$color[4]\" WIDTH=\"100%\" CELLPADDING=\"3\" CELLSPACING=\"0\" BORDER=\"0\"><TR><TD>";
310 foreach ($optpage_blocks as $next_optpage) {
311 if ($first_optpage == false) {
312 $first_optpage = $next_optpage;
314 print_optionpages_row($first_optpage, $next_optpage);
315 $first_optpage = false;
319 if ($first_optpage != false) {
320 print_optionpages_row($first_optpage);
323 echo "</TD></TR></TABLE></TD></TR></TABLE>\n";
325 do_hook('options_link_and_description');
328 /*************************************************************************/
329 /* If we are not looking at the main option page, display the page here. */
330 /*************************************************************************/
332 echo '<FORM NAME="f" ACTION="options.php" METHOD="POST"><BR>' . "\n"
333 . create_optpage_element($optpage)
334 . create_optmode_element(SMOPT_MODE_SUBMIT
)
335 . '<TABLE WIDTH="100%" CELLPADDING=2 CELLSPACING=0 BORDER=0>' . "\n";
337 /* Output the option groups for this page. */
338 print_option_groups($optpage_data['options']);
340 /* Set the inside_hook_name and submit_name. */
342 case SMOPT_PAGE_PERSONAL
:
343 $inside_hook_name = 'options_personal_inside';
344 $bottom_hook_name = 'options_personal_bottom';
345 $submit_name = 'submit_personal';
347 case SMOPT_PAGE_DISPLAY
:
348 $inside_hook_name = 'options_display_inside';
349 $bottom_hook_name = 'options_display_bottom';
350 $submit_name = 'submit_display';
352 case SMOPT_PAGE_HIGHLIGHT
:
353 $inside_hook_name = 'options_highlight_inside';
354 $bottom_hook_name = 'options_highlight_bottom';
355 $submit_name = 'submit_highlight';
357 case SMOPT_PAGE_FOLDER
:
358 $inside_hook_name = 'options_folder_inside';
359 $bottom_hook_name = 'options_folder_bottom';
360 $submit_name = 'submit_folder';
362 case SMOPT_PAGE_ORDER
:
363 $inside_hook_name = 'options_order_inside';
364 $bottom_hook_name = 'options_order_bottom';
365 $submit_name = 'submit_order';
368 $inside_hook_name = '';
369 $bottom_hook_name = '';
370 $submit_name = 'submit';
373 /* If it is not empty, trigger the inside hook. */
374 if ($inside_hook_name != '') {
375 do_hook($inside_hook_name);
378 /* Spit out a submit button. */
379 OptionSubmit($submit_name);
380 echo '</TABLE></FORM>';
382 /* If it is not empty, trigger the bottom hook. */
383 if ($bottom_hook_name != '') {
384 do_hook($bottom_hook_name);
399 /*******************************************************************/
400 /* Please be warned. The code below this point sucks. This is just */
401 /* my first implementation to make the option rows work for both */
402 /* Javascript and non-Javascript option chunks. */
404 /* Please, someone make these better for me. All three functions */
405 /* below REALLY do close to the same thing. */
407 /* This code would be GREATLY improved by a templating system. */
408 /* Don't try to implement that now, however. That will come later. */
409 /*******************************************************************/
411 /*******************************************************************/
412 /* Actually, now that I think about it, don't do anything with */
413 /* this code yet. There is ACTUALLY supposed to be a difference */
414 /* between the three functions that write the option rows. I just */
415 /* have not yet gotten to integrating that yet. */
416 /*******************************************************************/
419 * This function prints out an option page row.
421 function print_optionpages_row($leftopt, $rightopt = false) {
424 echo "<TABLE BGCOLOR=\"$color[4]\" WIDTH=\"100%\" CELLPADDING=0 CELLSPACING=5 BORDER=0>" .
425 '<TR><TD VALIGN="TOP">' .
426 '<TABLE WIDTH="100%" CELLPADDING="3" CELLSPACING="0" BORDER="0">' .
428 "<TD VALIGN=TOP BGCOLOR=\"$color[9]\" WIDTH=\"50%\">" .
429 '<A HREF="' . $leftopt['url'] . '">' . $leftopt['name'] . '</A>'.
431 "<TD VALIGN=TOP BGCOLOR=\"$color[4]\"> </TD>";
433 echo "<TD VALIGN=top BGCOLOR=\"$color[9]\" WIDTH=\"50%\">" .
434 '<A HREF="' . $rightopt['url'] . '">' . $rightopt['name'] . '</A>' .
437 echo "<TD VALIGN=top BGCOLOR=\"$color[4]\" WIDTH=\"50%\"> </TD>";
440 echo '</TR>' . "\n" .
442 "<TD VALIGN=top BGCOLOR=\"$color[0]\" WIDTH=\"50%\">" .
445 "<TD VALIGN=top BGCOLOR=\"$color[4]\"> </TD>";
447 echo "<TD VALIGN=top BGCOLOR=\"$color[0]\" WIDTH=\"50%\">" .
451 echo "<TD VALIGN=top BGCOLOR=\"$color[4]\" WIDTH=\"50%\"> </TD>";
454 echo '</TR>' . "\n" .