ef02ed880d83d3ca6ec4e830511630671e76bb7e
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 /* Path for SquirrelMail required files. */
16 define('SM_PATH','../');
18 /* SquirrelMail required files. */
19 require_once(SM_PATH
. 'include/validate.php');
20 require_once(SM_PATH
. 'functions/display_messages.php');
21 require_once(SM_PATH
. 'functions/imap.php');
22 require_once(SM_PATH
. 'functions/array.php');
23 require_once(SM_PATH
. 'functions/options.php');
24 require_once(SM_PATH
. 'functions/strings.php');
25 require_once(SM_PATH
. 'functions/html.php');
27 /*********************************/
28 /*** Build the resultant page. ***/
29 /*********************************/
31 displayPageHeader($color, 'None');
33 define('SMOPT_MODE_DISPLAY', 'display');
34 define('SMOPT_MODE_SUBMIT', 'submit');
35 define('SMOPT_MODE_LINK', 'link');
37 define('SMOPT_PAGE_MAIN', 'main');
38 define('SMOPT_PAGE_PERSONAL', 'personal');
39 define('SMOPT_PAGE_DISPLAY', 'display');
40 define('SMOPT_PAGE_HIGHLIGHT', 'highlight');
41 define('SMOPT_PAGE_FOLDER', 'folder');
42 define('SMOPT_PAGE_ORDER', 'order');
44 function process_optionmode_submit($optpage, $optpage_data) {
45 /* Initialize the maximum option refresh level. */
46 $max_refresh = SMOPT_REFRESH_NONE
;
48 /* Save each option in each option group. */
49 foreach ($optpage_data['options'] as $option_grp) {
50 foreach ($option_grp['options'] as $option) {
51 /* Remove Debug Mode Until Needed
52 echo "name = '$option->name', "
53 . "value = '$option->value', "
54 . "new_value = '$option->new_value'\n";
57 if ($option->changed()) {
59 $max_refresh = max($max_refresh, $option->refresh_level
);
64 /* Return the max refresh level. */
65 return ($max_refresh);
68 function process_optionmode_link($optpage) {
69 /* There will be something here, later. */
74 * This function prints out an option page row.
76 function print_optionpages_row($leftopt, $rightopt = false) {
80 $rightopt_name = html_tag( 'td', '<a href="' . $rightopt['url'] . '">' . $rightopt['name'] . '</a>', 'left', $color[9], 'valign="top" width="49%"' );
81 $rightopt_desc = html_tag( 'td', $rightopt['desc'], 'left', $color[0], 'valign="top" width="49%"' );
83 $rightopt_name = html_tag( 'td', ' ', 'left', $color[4], 'valign="top" width="49%"' );
84 $rightopt_desc = html_tag( 'td', ' ', 'left', $color[4], 'valign="top" width="49%"' );
88 html_tag( 'table', "\n" .
89 html_tag( 'tr', "\n" .
90 html_tag( 'td', "\n" .
91 html_tag( 'table', "\n" .
92 html_tag( 'tr', "\n" .
94 '<a href="' . $leftopt['url'] . '">' . $leftopt['name'] . '</a>' ,
95 'left', $color[9], 'valign="top" width="49%"' ) .
98 'left', $color[4], 'valign="top" width="2%"' ) . "\n" .
101 html_tag( 'tr', "\n" .
104 'left', $color[0], 'valign="top" width="49%"' ) .
107 'left', $color[4], 'valign="top" width="2%"' ) . "\n" .
110 '', '', 'width="100%" cellpadding="2" cellspacing="0" border="0"' ) ,
111 'left', '', 'valign="top"' )
113 '', $color[4], 'width="100%" cellpadding="0" cellspacing="5" border="0"' );
116 /* ---------------------------- main ---------------------------- */
118 /* Make sure we have an Option Page set. Default to main. */
119 if (!isset($optpage)) {
123 /* Make sure we have an Option Mode set. Default to display. */
124 if (!isset($optmode)) {
125 $optmode = SMOPT_MODE_DISPLAY
;
129 * First, set the load information for each option page.
132 /* Initialize load information variables. */
135 $optpage_loader = '';
137 /* Set the load information for each page. */
139 case SMOPT_PAGE_MAIN
: break;
140 case SMOPT_PAGE_PERSONAL
:
141 $optpage_name = _("Personal Information");
142 $optpage_file = SM_PATH
. 'include/options/personal.php';
143 $optpage_loader = 'load_optpage_data_personal';
144 $optpage_loadhook = 'optpage_loadhook_personal';
146 case SMOPT_PAGE_DISPLAY
:
147 $optpage_name = _("Display Preferences");
148 $optpage_file = SM_PATH
. 'include/options/display.php';
149 $optpage_loader = 'load_optpage_data_display';
150 $optpage_loadhook = 'optpage_loadhook_display';
152 case SMOPT_PAGE_HIGHLIGHT
:
153 $optpage_name = _("Message Highlighting");
154 $optpage_file = SM_PATH
. 'include/options/highlight.php';
155 $optpage_loader = 'load_optpage_data_highlight';
156 $optpage_loadhook = 'optpage_loadhook_highlight';
158 case SMOPT_PAGE_FOLDER
:
159 $optpage_name = _("Folder Preferences");
160 $optpage_file = SM_PATH
. 'include/options/folder.php';
161 $optpage_loader = 'load_optpage_data_folder';
162 $optpage_loadhook = 'optpage_loadhook_folder';
164 case SMOPT_PAGE_ORDER
:
165 $optpage_name = _("Index Order");
166 $optpage_file = SM_PATH
. 'include/options/order.php';
167 $optpage_loader = 'load_optpage_data_order';
168 $optpage_loadhook = 'optpage_loadhook_order';
170 default: do_hook('optpage_set_loadinfo');
173 /**********************************************************/
174 /*** Second, load the option information for this page. ***/
175 /**********************************************************/
177 if ($optpage != SMOPT_PAGE_MAIN
) {
178 /* Include the file for this optionpage. */
179 require_once($optpage_file);
181 /* Assemble the data for this option page. */
182 $optpage_data = array();
183 $optpage_data = $optpage_loader();
184 do_hook($optpage_loadhook);
185 $optpage_data['options'] =
186 create_option_groups($optpage_data['grps'], $optpage_data['vals']);
189 /***********************************************************/
190 /*** Next, process anything that needs to be processed. ***/
191 /***********************************************************/
193 if ( isset( $optpage_data ) ) {
195 case SMOPT_MODE_SUBMIT
:
196 $max_refresh = process_optionmode_submit($optpage, $optpage_data);
198 case SMOPT_MODE_LINK
:
199 $max_refresh = process_optionmode_link($optpage, $optpage_data);
203 /*** MOVE THIS DISPLAY CODE DOWN EVENTUALLY!!! ***/
205 $optpage_title = _("Options");
206 if (isset($optpage_name) && ($optpage_name != '')) {
207 $optpage_title .= " - $optpage_name";
210 echo html_tag( 'table', '', 'center', $color[0], 'width="95%" cellpadding="1" cellspacing="0" border="0"' ) . "\n" .
211 html_tag( 'tr' ) . "\n" .
212 html_tag( 'td', '', 'center' ) .
213 "<b>$optpage_title</b><br>\n".
214 html_tag( 'table', '', '', '', 'width="100%" cellpadding="5" cellspacing="0" border="0"' ) . "\n" .
215 html_tag( 'tr' ) . "\n" .
216 html_tag( 'td', '', 'center', $color[4] ) . "\n";
218 /*******************************************************************/
219 /* DO OLD SAVING OF SUBMITTED OPTIONS. THIS WILL BE REMOVED LATER. */
220 /*******************************************************************/
222 /* If in submit mode, select a save hook name and run it. */
223 if ($optmode == SMOPT_MODE_SUBMIT
) {
224 /* Select a save hook name. */
226 case SMOPT_PAGE_PERSONAL
:
227 $save_hook_name = 'options_personal_save';
229 case SMOPT_PAGE_DISPLAY
:
230 $save_hook_name = 'options_display_save';
232 case SMOPT_PAGE_FOLDER
:
233 $save_hook_name = 'options_folder_save';
236 $save_hook_name = 'options_save';
240 /* Run the options save hook. */
241 do_hook($save_hook_name);
244 /***************************************************************/
245 /* Apply logic to decide what optpage we want to display next. */
246 /***************************************************************/
248 /* If this is the result of an option page being submitted, then */
249 /* show the main page. Otherwise, show whatever page was called. */
251 if ($optmode == SMOPT_MODE_SUBMIT
) {
252 $optpage = SMOPT_PAGE_MAIN
;
255 /***************************************************************/
256 /* Finally, display whatever page we are supposed to show now. */
257 /***************************************************************/
260 * The main option page has a different layout then the rest of the option
261 * pages. Therefore, we create it here first, then the others below.
263 if ($optpage == SMOPT_PAGE_MAIN
) {
264 /**********************************************************/
265 /* First, display the results of a submission, if needed. */
266 /**********************************************************/
267 if ($optmode == SMOPT_MODE_SUBMIT
) {
268 if (!isset($frame_top)) {
271 /* Display a message indicating a successful save. */
272 echo '<b>' . _("Successfully Saved Options") . ": $optpage_name</b><br>\n";
274 /* If $max_refresh != SMOPT_REFRESH_NONE, provide a refresh link. */
275 if ( !isset( $max_refresh ) ) {
276 } else if ($max_refresh == SMOPT_REFRESH_FOLDERLIST
) {
277 echo '<a href="../src/left_main.php" target="left">' . _("Refresh Folder List") . '</a><br>';
278 } else if ($max_refresh) {
279 echo '<a href="../src/webmail.php?right_frame=options.php" target="' . $frame_top . '">' . _("Refresh Page") . '</a><br>';
282 /******************************************/
283 /* Build our array of Option Page Blocks. */
284 /******************************************/
285 $optpage_blocks = array();
287 /* Build a section for Personal Options. */
288 $optpage_blocks[] = array(
289 'name' => _("Personal Information"),
290 'url' => 'options.php?optpage=' . SMOPT_PAGE_PERSONAL
,
291 'desc' => _("This contains personal information about yourself such as your name, your email address, etc."),
295 /* Build a section for Display Options. */
296 $optpage_blocks[] = array(
297 'name' => _("Display Preferences"),
298 'url' => 'options.php?optpage=' . SMOPT_PAGE_DISPLAY
,
299 'desc' => _("You can change the way that SquirrelMail looks and displays information to you, such as the colors, the language, and other settings."),
303 /* Build a section for Message Highlighting Options. */
304 $optpage_blocks[] = array(
305 'name' =>_("Message Highlighting"),
306 'url' => 'options_highlight.php',
307 '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."),
311 /* Build a section for Folder Options. */
312 $optpage_blocks[] = array(
313 'name' => _("Folder Preferences"),
314 'url' => 'options.php?optpage=' . SMOPT_PAGE_FOLDER
,
315 'desc' => _("These settings change the way your folders are displayed and manipulated."),
319 /* Build a section for Index Order Options. */
320 $optpage_blocks[] = array(
321 'name' => _("Index Order"),
322 'url' => 'options_order.php',
323 'desc' => _("The order of the message index can be rearranged and changed to contain the headers in any order you want."),
327 /* Build a section for plugins wanting to register an optionpage. */
328 do_hook('optpage_register_block');
330 /*****************************************************/
331 /* Let's sort Javascript Option Pages to the bottom. */
332 /*****************************************************/
333 $js_optpage_blocks = array();
334 $reg_optpage_blocks = array();
335 foreach ($optpage_blocks as $cur_optpage) {
336 if (!$cur_optpage['js']) {
337 $reg_optpage_blocks[] = $cur_optpage;
338 } else if ($javascript_on == SMPREF_JS_ON
) {
339 $js_optpage_blocks[] = $cur_optpage;
342 $optpage_blocks = array_merge($reg_optpage_blocks, $js_optpage_blocks);
344 /********************************************/
345 /* Now, print out each option page section. */
346 /********************************************/
347 $first_optpage = false;
348 echo html_tag( 'table', '', '', $color[4], 'width="100%" cellpadding="0" cellspacing="5" border="0"' ) . "\n" .
349 html_tag( 'tr' ) . "\n" .
350 html_tag( 'td', '', 'left', '', 'valign="top"' ) .
351 html_tag( 'table', '', '', $color[4], 'width="100%" cellpadding="3" cellspacing="0" border="0"' ) . "\n" .
352 html_tag( 'tr' ) . "\n" .
353 html_tag( 'td', '', 'left' );
354 foreach ($optpage_blocks as $next_optpage) {
355 if ($first_optpage == false) {
356 $first_optpage = $next_optpage;
358 print_optionpages_row($first_optpage, $next_optpage);
359 $first_optpage = false;
363 if ($first_optpage != false) {
364 print_optionpages_row($first_optpage);
367 echo "</td></tr></table></td></tr></table>\n";
369 do_hook('options_link_and_description');
372 /*************************************************************************/
373 /* If we are not looking at the main option page, display the page here. */
374 /*************************************************************************/
376 echo '<form name="f" action="options.php" method="post"><br>' . "\n"
377 . create_optpage_element($optpage)
378 . create_optmode_element(SMOPT_MODE_SUBMIT
)
379 . html_tag( 'table', '', '', '', 'width="100%" cellpadding="2" cellspacing="0" border="0"' ) . "\n"
380 . html_tag( 'tr' ) . "\n"
381 . html_tag( 'td', '', 'left' ) . "\n";
383 /* Output the option groups for this page. */
384 print_option_groups($optpage_data['options']);
386 /* Set the inside_hook_name and submit_name. */
388 case SMOPT_PAGE_PERSONAL
:
389 $inside_hook_name = 'options_personal_inside';
390 $bottom_hook_name = 'options_personal_bottom';
391 $submit_name = 'submit_personal';
393 case SMOPT_PAGE_DISPLAY
:
394 $inside_hook_name = 'options_display_inside';
395 $bottom_hook_name = 'options_display_bottom';
396 $submit_name = 'submit_display';
398 case SMOPT_PAGE_HIGHLIGHT
:
399 $inside_hook_name = 'options_highlight_inside';
400 $bottom_hook_name = 'options_highlight_bottom';
401 $submit_name = 'submit_highlight';
403 case SMOPT_PAGE_FOLDER
:
404 $inside_hook_name = 'options_folder_inside';
405 $bottom_hook_name = 'options_folder_bottom';
406 $submit_name = 'submit_folder';
408 case SMOPT_PAGE_ORDER
:
409 $inside_hook_name = 'options_order_inside';
410 $bottom_hook_name = 'options_order_bottom';
411 $submit_name = 'submit_order';
414 $inside_hook_name = '';
415 $bottom_hook_name = '';
416 $submit_name = 'submit';
419 /* If it is not empty, trigger the inside hook. */
420 if ($inside_hook_name != '') {
421 do_hook($inside_hook_name);
424 /* Spit out a submit button. */
425 OptionSubmit($submit_name);
426 echo '</td></tr></table></form>';
428 /* If it is not empty, trigger the bottom hook. */
429 if ($bottom_hook_name != '') {
430 do_hook($bottom_hook_name);