6 * Displays the options page. Pulls from proper user preference files
7 * and config.php. Displays preferences as selected and other options.
9 * @copyright © 1999-2006 The SquirrelMail Project Team
10 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
12 * @package squirrelmail
17 * Include the SquirrelMail initialization file.
19 require('../include/init.php');
21 /* SquirrelMail required files. */
23 //include(SM_PATH . 'functions/imap_general.php');
24 require_once(SM_PATH
. 'functions/options.php');
25 require_once(SM_PATH
. 'functions/forms.php');
27 /*********************************/
28 /*** Build the resultant page. ***/
29 /*********************************/
31 define('SMOPT_MODE_DISPLAY', 'display');
32 define('SMOPT_MODE_SUBMIT', 'submit');
33 define('SMOPT_MODE_LINK', 'link');
35 define('SMOPT_PAGE_MAIN', 'main');
36 define('SMOPT_PAGE_PERSONAL', 'personal');
37 define('SMOPT_PAGE_DISPLAY', 'display');
38 define('SMOPT_PAGE_COMPOSE', 'compose');
39 define('SMOPT_PAGE_HIGHLIGHT', 'highlight');
40 define('SMOPT_PAGE_FOLDER', 'folder');
41 define('SMOPT_PAGE_ORDER', 'order');
43 function process_optionmode_submit($optpage, $optpage_data) {
44 /* Initialize the maximum option refresh level. */
45 $max_refresh = SMOPT_REFRESH_NONE
;
47 /* Save each option in each option group. */
48 foreach ($optpage_data['options'] as $option_grp) {
49 foreach ($option_grp['options'] as $option) {
50 /* Remove Debug Mode Until Needed
51 echo "name = '$option->name', "
52 . "value = '$option->value', "
53 . "new_value = '$option->new_value'\n";
56 if ($option->changed()) {
58 $max_refresh = max($max_refresh, $option->refresh_level
);
63 /* Return the max refresh level. */
64 return ($max_refresh);
67 function process_optionmode_link($optpage) {
68 /* There will be something here, later. */
73 * This function prints out an option page row.
75 function print_optionpages_row($leftopt, $rightopt = false) {
79 $rightopt_name = html_tag( 'td', '<a href="' . $rightopt['url'] . '">' . $rightopt['name'] . '</a>', 'left', $color[9], 'valign="top" width="49%"' );
80 $rightopt_desc = html_tag( 'td', $rightopt['desc'], 'left', $color[0], 'valign="top" width="49%"' );
82 $rightopt_name = html_tag( 'td', ' ', 'left', $color[4], 'valign="top" width="49%"' );
83 $rightopt_desc = html_tag( 'td', ' ', 'left', $color[4], 'valign="top" width="49%"' );
87 html_tag( 'table', "\n" .
88 html_tag( 'tr', "\n" .
89 html_tag( 'td', "\n" .
90 html_tag( 'table', "\n" .
91 html_tag( 'tr', "\n" .
93 '<a href="' . $leftopt['url'] . '">' . $leftopt['name'] . '</a>' ,
94 'left', $color[9], 'valign="top" width="49%"' ) .
97 'left', $color[4], 'valign="top" width="2%"' ) . "\n" .
100 html_tag( 'tr', "\n" .
103 'left', $color[0], 'valign="top" width="49%"' ) .
106 'left', $color[4], 'valign="top" width="2%"' ) . "\n" .
109 '', '', 'width="100%" cellpadding="2" cellspacing="0" border="0"' ) ,
110 'left', '', 'valign="top"' )
112 '', $color[4], 'width="100%" cellpadding="0" cellspacing="5" border="0"' );
115 /* ---------------------------- main ---------------------------- */
117 /* get the globals that we may need */
118 sqgetGlobalVar('key', $key, SQ_COOKIE
);
119 sqgetGlobalVar('username', $username, SQ_SESSION
);
120 sqgetGlobalVar('onetimepad',$onetimepad, SQ_SESSION
);
121 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION
);
123 sqgetGlobalVar('optpage', $optpage);
124 sqgetGlobalVar('optmode', $optmode, SQ_FORM
);
125 sqgetGlobalVar('optpage_data',$optpage_data, SQ_POST
);
126 /* end of getting globals */
128 /* Make sure we have an Option Page set. Default to main. */
129 if ( !isset($optpage) ||
$optpage == '' ) {
130 $optpage = SMOPT_PAGE_MAIN
;
132 $optpage = strip_tags( $optpage );
135 /* Make sure we have an Option Mode set. Default to display. */
136 if (!isset($optmode)) {
137 $optmode = SMOPT_MODE_DISPLAY
;
141 * First, set the load information for each option page.
144 /* Initialize load information variables. */
147 $optpage_loader = '';
149 /* Set the load information for each page. */
151 case SMOPT_PAGE_MAIN
:
153 case SMOPT_PAGE_PERSONAL
:
154 $optpage_name = _("Personal Information");
155 $optpage_file = SM_PATH
. 'include/options/personal.php';
156 $optpage_loader = 'load_optpage_data_personal';
157 $optpage_loadhook = 'optpage_loadhook_personal';
159 case SMOPT_PAGE_DISPLAY
:
160 $optpage_name = _("Display Preferences");
161 $optpage_file = SM_PATH
. 'include/options/display.php';
162 $optpage_loader = 'load_optpage_data_display';
163 $optpage_loadhook = 'optpage_loadhook_display';
165 case SMOPT_PAGE_COMPOSE
:
166 $optpage_name = _("Compose Preferences");
167 $optpage_file = SM_PATH
. 'include/options/compose.php';
168 $optpage_loader = 'load_optpage_data_compose';
169 $optpage_loadhook = 'optpage_loadhook_compose';
171 case SMOPT_PAGE_HIGHLIGHT
:
172 $optpage_name = _("Message Highlighting");
173 $optpage_file = SM_PATH
. 'include/options/highlight.php';
174 $optpage_loader = 'load_optpage_data_highlight';
175 $optpage_loadhook = 'optpage_loadhook_highlight';
177 case SMOPT_PAGE_FOLDER
:
178 $optpage_name = _("Folder Preferences");
179 $optpage_file = SM_PATH
. 'include/options/folder.php';
180 $optpage_loader = 'load_optpage_data_folder';
181 $optpage_loadhook = 'optpage_loadhook_folder';
183 case SMOPT_PAGE_ORDER
:
184 $optpage_name = _("Index Order");
185 $optpage_file = SM_PATH
. 'include/options/order.php';
186 $optpage_loader = 'load_optpage_data_order';
187 $optpage_loadhook = 'optpage_loadhook_order';
189 default: do_hook('optpage_set_loadinfo');
192 /**********************************************************/
193 /*** Second, load the option information for this page. ***/
194 /**********************************************************/
196 if ( !@is_file
( $optpage_file ) ) {
197 $optpage = SMOPT_PAGE_MAIN
;
198 } else if ($optpage != SMOPT_PAGE_MAIN
) {
199 /* Include the file for this optionpage. */
201 require_once($optpage_file);
203 /* Assemble the data for this option page. */
204 $optpage_data = array();
205 $optpage_data = $optpage_loader();
206 do_hook($optpage_loadhook);
207 $optpage_data['options'] =
208 create_option_groups($optpage_data['grps'], $optpage_data['vals']);
211 /***********************************************************/
212 /*** Next, process anything that needs to be processed. ***/
213 /***********************************************************/
215 $optpage_save_error=array();
217 if ( isset( $optpage_data ) ) {
219 case SMOPT_MODE_SUBMIT
:
220 $max_refresh = process_optionmode_submit($optpage, $optpage_data);
222 case SMOPT_MODE_LINK
:
223 $max_refresh = process_optionmode_link($optpage, $optpage_data);
228 $optpage_title = _("Options");
229 if (isset($optpage_name) && ($optpage_name != '')) {
230 $optpage_title .= " - $optpage_name";
233 /*******************************************************************/
234 /* DO OLD SAVING OF SUBMITTED OPTIONS. THIS WILL BE REMOVED LATER. */
235 /*******************************************************************/
237 /* If in submit mode, select a save hook name and run it. */
238 if ($optmode == SMOPT_MODE_SUBMIT
) {
239 /* Select a save hook name. */
241 case SMOPT_PAGE_PERSONAL
:
242 $save_hook_name = 'options_personal_save';
244 case SMOPT_PAGE_DISPLAY
:
245 $save_hook_name = 'options_display_save';
247 case SMOPT_PAGE_COMPOSE
:
248 $save_hook_name = 'options_compose_save';
250 case SMOPT_PAGE_FOLDER
:
251 $save_hook_name = 'options_folder_save';
254 $save_hook_name = 'options_save';
258 /* Run the options save hook. */
259 do_hook($save_hook_name);
262 /***************************************************************/
263 /* Apply logic to decide what optpage we want to display next. */
264 /***************************************************************/
266 /* If this is the result of an option page being submitted, then */
267 /* show the main page. Otherwise, show whatever page was called. */
269 if ($optmode == SMOPT_MODE_SUBMIT
) {
270 $optpage = SMOPT_PAGE_MAIN
;
273 /***************************************************************/
274 /* Finally, display whatever page we are supposed to show now. */
275 /***************************************************************/
277 displayPageHeader($color, 'None', (isset($optpage_data['xtra']) ?
$optpage_data['xtra'] : ''));
279 echo html_tag( 'table', '', 'center', $color[0], 'width="95%" cellpadding="1" cellspacing="0" border="0"' ) . "\n" .
280 html_tag( 'tr' ) . "\n" .
281 html_tag( 'td', '', 'center' ) .
282 "<b>$optpage_title</b><br />\n".
283 html_tag( 'table', '', '', '', 'width="100%" cellpadding="5" cellspacing="0" border="0"' ) . "\n" .
284 html_tag( 'tr' ) . "\n" .
285 html_tag( 'td', '', 'center', $color[4] ) . "\n";
288 * The main option page has a different layout then the rest of the option
289 * pages. Therefore, we create it here first, then the others below.
291 if ($optpage == SMOPT_PAGE_MAIN
) {
292 /**********************************************************/
293 /* First, display the results of a submission, if needed. */
294 /**********************************************************/
295 if ($optmode == SMOPT_MODE_SUBMIT
) {
296 if (!isset($frame_top)) {
300 if (isset($optpage_save_error) && $optpage_save_error!=array()) {
301 echo "<font color=\"$color[2]\"><b>" . _("Error(s) occurred while saving your options") . "</b></font><br />\n";
303 foreach ($optpage_save_error as $error_message) {
304 echo '<li><small>' . $error_message . "</small></li>\n";
307 echo '<b>' . _("Some of your preference changes were not applied.") . "</b><br />\n";
309 /* Display a message indicating a successful save. */
310 echo '<b>' . _("Successfully Saved Options") . ": $optpage_name</b><br />\n";
313 /* If $max_refresh != SMOPT_REFRESH_NONE, provide a refresh link. */
314 if ( !isset( $max_refresh ) ) {
315 } else if ($max_refresh == SMOPT_REFRESH_FOLDERLIST
) {
316 echo '<a href="../src/left_main.php" target="left">' . _("Refresh Folder List") . '</a><br />';
317 } else if ($max_refresh) {
318 echo '<a href="../src/webmail.php?right_frame=options.php" target="' . $frame_top . '">' . _("Refresh Page") . '</a><br />';
321 /******************************************/
322 /* Build our array of Option Page Blocks. */
323 /******************************************/
324 $optpage_blocks = array();
326 /* Build a section for Personal Options. */
327 $optpage_blocks[] = array(
328 'name' => _("Personal Information"),
329 'url' => 'options.php?optpage=' . SMOPT_PAGE_PERSONAL
,
330 'desc' => _("This contains personal information about yourself such as your name, your email address, etc."),
334 /* Build a section for Display Options. */
335 $optpage_blocks[] = array(
336 'name' => _("Display Preferences"),
337 'url' => 'options.php?optpage=' . SMOPT_PAGE_DISPLAY
,
338 'desc' => _("You can change the way that SquirrelMail looks and displays information to you, such as the colors, the language, and other settings."),
342 /* Build a section for Message Highlighting Options. */
343 $optpage_blocks[] = array(
344 'name' =>_("Message Highlighting"),
345 'url' => 'options_highlight.php',
346 '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."),
350 /* Build a section for Folder Options. */
351 $optpage_blocks[] = array(
352 'name' => _("Folder Preferences"),
353 'url' => 'options.php?optpage=' . SMOPT_PAGE_FOLDER
,
354 'desc' => _("These settings change the way your folders are displayed and manipulated."),
358 /* Build a section for Index Order Options. */
359 $optpage_blocks[] = array(
360 'name' => _("Index Order"),
361 'url' => 'options_order.php',
362 'desc' => _("The order of the message index can be rearranged and changed to contain the headers in any order you want."),
366 /* Build a section for Compose Options. */
367 $optpage_blocks[] = array(
368 'name' => _("Compose Preferences"),
369 'url' => 'options.php?optpage=' . SMOPT_PAGE_COMPOSE
,
370 'desc' => _("Control the behaviour and layout of writing new mail messages, replying to and forwarding messages."),
374 /* Build a section for plugins wanting to register an optionpage. */
375 do_hook('optpage_register_block');
377 /*****************************************************/
378 /* Let's sort Javascript Option Pages to the bottom. */
379 /*****************************************************/
380 $js_optpage_blocks = array();
381 $reg_optpage_blocks = array();
382 foreach ($optpage_blocks as $cur_optpage) {
383 if (!isset($cur_optpage['js']) ||
!$cur_optpage['js']) {
384 $reg_optpage_blocks[] = $cur_optpage;
385 } else if ($javascript_on == SMPREF_JS_ON
) {
386 $js_optpage_blocks[] = $cur_optpage;
389 $optpage_blocks = array_merge($reg_optpage_blocks, $js_optpage_blocks);
391 /********************************************/
392 /* Now, print out each option page section. */
393 /********************************************/
394 $first_optpage = false;
395 echo html_tag( 'table', '', '', $color[4], 'width="100%" cellpadding="0" cellspacing="5" border="0"' ) . "\n" .
396 html_tag( 'tr' ) . "\n" .
397 html_tag( 'td', '', 'left', '', 'valign="top"' ) .
398 html_tag( 'table', '', '', $color[4], 'width="100%" cellpadding="3" cellspacing="0" border="0"' ) . "\n" .
399 html_tag( 'tr' ) . "\n" .
400 html_tag( 'td', '', 'left' );
401 foreach ($optpage_blocks as $next_optpage) {
402 if ($first_optpage == false) {
403 $first_optpage = $next_optpage;
405 print_optionpages_row($first_optpage, $next_optpage);
406 $first_optpage = false;
410 if ($first_optpage != false) {
411 print_optionpages_row($first_optpage);
414 echo "</td></tr></table></td></tr></table>\n";
416 do_hook('options_link_and_description');
419 /*************************************************************************/
420 /* If we are not looking at the main option page, display the page here. */
421 /*************************************************************************/
423 echo addForm('options.php', 'post', 'f')
424 . create_optpage_element($optpage)
425 . create_optmode_element(SMOPT_MODE_SUBMIT
)
426 . html_tag( 'table', '', '', '', 'width="100%" cellpadding="2" cellspacing="0" border="0"' ) . "\n";
428 /* Output the option groups for this page. */
429 print_option_groups($optpage_data['options']);
431 /* Set the inside_hook_name and submit_name. */
433 case SMOPT_PAGE_PERSONAL
:
434 $inside_hook_name = 'options_personal_inside';
435 $bottom_hook_name = 'options_personal_bottom';
436 $submit_name = 'submit_personal';
438 case SMOPT_PAGE_DISPLAY
:
439 $inside_hook_name = 'options_display_inside';
440 $bottom_hook_name = 'options_display_bottom';
441 $submit_name = 'submit_display';
443 case SMOPT_PAGE_COMPOSE
:
444 $inside_hook_name = 'options_compose_inside';
445 $bottom_hook_name = 'options_compose_bottom';
446 $submit_name = 'submit_compose';
448 case SMOPT_PAGE_HIGHLIGHT
:
449 $inside_hook_name = 'options_highlight_inside';
450 $bottom_hook_name = 'options_highlight_bottom';
451 $submit_name = 'submit_highlight';
453 case SMOPT_PAGE_FOLDER
:
454 $inside_hook_name = 'options_folder_inside';
455 $bottom_hook_name = 'options_folder_bottom';
456 $submit_name = 'submit_folder';
458 case SMOPT_PAGE_ORDER
:
459 $inside_hook_name = 'options_order_inside';
460 $bottom_hook_name = 'options_order_bottom';
461 $submit_name = 'submit_order';
464 $inside_hook_name = '';
465 $bottom_hook_name = '';
466 $submit_name = 'submit';
469 /* If it is not empty, trigger the inside hook. */
470 if ($inside_hook_name != '') {
471 do_hook($inside_hook_name);
474 /* Spit out a submit button. */
475 OptionSubmit($submit_name);
476 echo '</table></form>';
478 /* If it is not empty, trigger the bottom hook. */
479 if ($bottom_hook_name != '') {
480 do_hook($bottom_hook_name);
490 $oTemplate->display('footer.tpl');