-
-
-
-
-'._("Successfully saved personal information!").'
';
- } else if (isset($submit_display)) {
- /* Do checking to make sure $new_theme is in the array. */
- $theme_in_array = false;
- for ($i=0; $i < count($theme); $i++) {
- if ($theme[$i]['PATH'] == $new_chosen_theme) {
- $theme_in_array = true;
- break;
+/**
+ * options.php
+ *
+ * Displays the options page. Pulls from proper user preference files
+ * and config.php. Displays preferences as selected and other options.
+ *
+ * @copyright 1999-2012 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage prefs
+ */
+
+/** This is the options page */
+define('PAGE_NAME', 'options');
+
+/**
+ * Include the SquirrelMail initialization file.
+ */
+require('../include/init.php');
+
+/* SquirrelMail required files. */
+
+//include(SM_PATH . 'functions/imap_general.php');
+require_once(SM_PATH . 'functions/options.php');
+require_once(SM_PATH . 'functions/forms.php');
+
+/*********************************/
+/*** Build the resultant page. ***/
+/*********************************/
+
+define('SMOPT_MODE_DISPLAY', 'display');
+define('SMOPT_MODE_SUBMIT', 'submit');
+define('SMOPT_MODE_LINK', 'link');
+
+define('SMOPT_PAGE_MAIN', 'main');
+define('SMOPT_PAGE_PERSONAL', 'personal');
+define('SMOPT_PAGE_DISPLAY', 'display');
+define('SMOPT_PAGE_COMPOSE', 'compose');
+define('SMOPT_PAGE_ACCESSIBILITY', 'accessibility');
+define('SMOPT_PAGE_HIGHLIGHT', 'highlight');
+define('SMOPT_PAGE_FOLDER', 'folder');
+define('SMOPT_PAGE_ORDER', 'order');
+
+/**
+ * Save submitted options and calculate the most
+ * we need to refresh the page
+ *
+ * @param string $optpage The name of the page being submitted
+ * @param array $optpage_data An array of all the submitted options
+ *
+ * @return int The highest level of screen refresh needed per
+ * the options that were changed. This value will
+ * correspond to the SMOPT_REFRESH_* constants found
+ * in functions/options.php.
+ *
+ */
+function process_optionmode_submit($optpage, $optpage_data) {
+ /* Initialize the maximum option refresh level. */
+ $max_refresh = SMOPT_REFRESH_NONE;
+
+
+
+ /* Save each option in each option group. */
+ foreach ($optpage_data['options'] as $option_grp) {
+ foreach ($option_grp['options'] as $option) {
+
+ /* Special case: need to make sure emailaddress
+ * is saved if we use it as a test for ask_user_info */
+ global $ask_user_info;
+ if ( $optpage = SMOPT_PAGE_PERSONAL && $ask_user_info &&
+ $option->name == 'email_address' ) {
+ $option->setValue('');
}
- }
- if (!$theme_in_array) {
- $new_chosen_theme = '';
- }
-
- /* Save display preferences. */
- setPref($data_dir, $username, 'chosen_theme', $new_chosen_theme);
- setPref($data_dir, $username, 'language', $new_language);
- setPref($data_dir, $username, 'use_javascript_addr_book', $new_use_javascript_addr_book);
- setPref($data_dir, $username, 'javascript_setting', $new_javascript_setting);
- setPref($data_dir, $username, 'show_num', $new_show_num);
- setPref($data_dir, $username, 'wrap_at', $new_wrap_at);
- setPref($data_dir, $username, 'editor_size', $new_editor_size);
- setPref($data_dir, $username, 'location_of_buttons', $new_location_of_buttons);
- setPref($data_dir, $username, 'location_of_bar', $new_location_of_bar);
- setPref($data_dir, $username, 'left_size', $new_left_size);
- setPref($data_dir, $username, 'left_refresh', $new_left_refresh);
- setPref($data_dir, $username, 'alt_index_colors', $new_alt_index_colors);
- setPref($data_dir, $username, 'show_html_default', $new_show_html_default);
- setPref($data_dir, $username, 'include_self_reply_all', $new_include_self_reply_all);
- setPref($data_dir, $username, 'page_selector', $new_page_selector);
- setPref($data_dir, $username, 'page_selector_max', $new_page_selector_max);
-
- $js_autodetect_results = (isset($new_js_autodetect_results) ? $new_js_autodetect_results : SMPREF_JS_OFF);
- if ($new_javascript_setting == SMPREF_JS_AUTODETECT) {
- if ($js_autodetect_results == SMPREF_JS_ON) {
- setPref($data_dir, $username, 'javascript_on', SMPREF_JS_ON);
- } else {
- setPref($data_dir, $username, 'javascript_on', SMPREF_JS_OFF);
+
+ /* Remove Debug Mode Until Needed
+ echo "name = '$option->name', "
+ . "value = '$option->value', "
+ . "new_value = '$option->new_value'\n";
+//FIXME: NO HTML IN THE CORE!
+ echo "
";
+ */
+ if ($option->changed()) {
+ $option->save();
+ $max_refresh = max($max_refresh, $option->refresh_level);
}
- } else {
- setPref($data_dir, $username, 'javascript_on', $new_javascript_setting);
- }
-
- do_hook('options_display_save');
-
- echo '
'._("Successfully saved display preferences!").'
';
- echo '' . _("Refresh Page") . '
';
- } else if (isset($submit_folder)) {
- /* Save trash folder preferences. */
- if ($new_trash_folder != SMPREF_NONE) {
- setPref($data_dir, $username, 'move_to_trash', SMPREF_ON);
- setPref($data_dir, $username, 'trash_folder', $new_trash_folder);
- } else {
- setPref($data_dir, $username, 'move_to_trash', SMPREF_OFF);
- setPref($data_dir, $username, 'trash_folder', SMPREF_NONE);
}
+ }
- /* Save sent folder preferences. */
- if ($new_sent_folder != SMPREF_NONE) {
- setPref($data_dir, $username, 'move_to_sent', SMPREF_ON);
- setPref($data_dir, $username, 'sent_folder', $new_sent_folder);
- } else {
- setPref($data_dir, $username, 'move_to_sent', SMPREF_OFF);
- setPref($data_dir, $username, 'sent_folder', SMPREF_NONE);
+ /* Return the max refresh level. */
+ return ($max_refresh);
+}
+
+function process_optionmode_link($optpage) {
+ /* There will be something here, later. */
+}
+
+
+
+/* ---------------------------- main ---------------------------- */
+
+/* get the globals that we may need */
+sqgetGlobalVar('optpage', $optpage);
+sqgetGlobalVar('optmode', $optmode, SQ_FORM);
+sqgetGlobalVar('optpage_data',$optpage_data, SQ_POST);
+sqgetGlobalVar('smtoken', $submitted_token, SQ_FORM, '');
+/* end of getting globals */
+
+/* Make sure we have an Option Page set. Default to main. */
+if ( !isset($optpage) || $optpage == '' ) {
+ $optpage = SMOPT_PAGE_MAIN;
+} else {
+ $optpage = strip_tags( $optpage );
+}
+
+/* Make sure we have an Option Mode set. Default to display. */
+if (!isset($optmode)) {
+ $optmode = SMOPT_MODE_DISPLAY;
+}
+
+/*
+ * First, set the load information for each option page.
+ */
+
+/* Initialize load information variables. */
+$optpage_name = '';
+$optpage_file = '';
+$optpage_loader = '';
+
+/* Set the load information for each page. */
+switch ($optpage) {
+ case SMOPT_PAGE_MAIN:
+ break;
+ case SMOPT_PAGE_PERSONAL:
+ $optpage_name = _("Personal Information");
+ $optpage_file = SM_PATH . 'include/options/personal.php';
+ $optpage_loader = 'load_optpage_data_personal';
+ $optpage_loadhook = 'optpage_loadhook_personal';
+ break;
+ case SMOPT_PAGE_DISPLAY:
+ $optpage_name = _("Display Preferences");
+ $optpage_file = SM_PATH . 'include/options/display.php';
+ $optpage_loader = 'load_optpage_data_display';
+ $optpage_loadhook = 'optpage_loadhook_display';
+ break;
+ case SMOPT_PAGE_COMPOSE:
+ $optpage_name = _("Compose Preferences");
+ $optpage_file = SM_PATH . 'include/options/compose.php';
+ $optpage_loader = 'load_optpage_data_compose';
+ $optpage_loadhook = 'optpage_loadhook_compose';
+ break;
+ case SMOPT_PAGE_ACCESSIBILITY:
+ $optpage_name = _("Accessibility Preferences");
+ $optpage_file = SM_PATH . 'include/options/accessibility.php';
+ $optpage_loader = 'load_optpage_data_accessibility';
+ $optpage_loadhook = 'optpage_loadhook_accessibility';
+ break;
+ case SMOPT_PAGE_HIGHLIGHT:
+ $optpage_name = _("Message Highlighting");
+ $optpage_file = SM_PATH . 'include/options/highlight.php';
+ $optpage_loader = 'load_optpage_data_highlight';
+ $optpage_loadhook = 'optpage_loadhook_highlight';
+ break;
+ case SMOPT_PAGE_FOLDER:
+ $optpage_name = _("Folder Preferences");
+ $optpage_file = SM_PATH . 'include/options/folder.php';
+ $optpage_loader = 'load_optpage_data_folder';
+ $optpage_loadhook = 'optpage_loadhook_folder';
+ break;
+ case SMOPT_PAGE_ORDER:
+ $optpage_name = _("Index Order");
+ $optpage_file = SM_PATH . 'include/options/order.php';
+ $optpage_loader = 'load_optpage_data_order';
+ $optpage_loadhook = 'optpage_loadhook_order';
+ break;
+ default: do_hook('optpage_set_loadinfo', $null);
+}
+
+/**********************************************************/
+/*** Second, load the option information for this page. ***/
+/**********************************************************/
+
+if ( !@is_file( $optpage_file ) ) {
+ $optpage = SMOPT_PAGE_MAIN;
+} elseif ($optpage != SMOPT_PAGE_MAIN ) {
+ /* Include the file for this optionpage. */
+
+ require_once($optpage_file);
+
+ /* Assemble the data for this option page. */
+ $optpage_data = array();
+ $optpage_data = $optpage_loader();
+ do_hook($optpage_loadhook, $null);
+ $optpage_data['options'] = create_option_groups($optpage_data['grps'], $optpage_data['vals']);
+}
+
+/***********************************************************/
+/*** Next, process anything that needs to be processed. ***/
+/***********************************************************/
+
+// security check before saving anything...
+//FIXME: what about SMOPT_MODE_LINK??
+if ($optmode == SMOPT_MODE_SUBMIT) {
+ sm_validate_security_token($submitted_token, -1, TRUE);
+}
+
+$optpage_save_error=array();
+
+if ( isset( $optpage_data ) ) {
+ switch ($optmode) {
+ case SMOPT_MODE_SUBMIT:
+ $max_refresh = process_optionmode_submit($optpage, $optpage_data);
+ break;
+ case SMOPT_MODE_LINK:
+ $max_refresh = process_optionmode_link($optpage, $optpage_data);
+ break;
+ }
+}
+
+$optpage_title = _("Options");
+if (isset($optpage_name) && ($optpage_name != '')) {
+ $optpage_title .= " - $optpage_name";
+}
+
+/*******************************************************************/
+/* DO OLD SAVING OF SUBMITTED OPTIONS. THIS WILL BE REMOVED LATER. */
+/*******************************************************************/
+
+//FIXME: let's remove these finally in 1.5.2..... but first, are there any plugins using them?
+/* If in submit mode, select a save hook name and run it. */
+if ($optmode == SMOPT_MODE_SUBMIT) {
+ /* Select a save hook name. */
+ switch ($optpage) {
+ case SMOPT_PAGE_PERSONAL:
+ $save_hook_name = 'options_personal_save';
+ break;
+ case SMOPT_PAGE_DISPLAY:
+ $save_hook_name = 'options_display_save';
+ break;
+ case SMOPT_PAGE_COMPOSE:
+ $save_hook_name = 'options_compose_save';
+ break;
+ case SMOPT_PAGE_ACCESSIBILITY:
+ $save_hook_name = 'options_accessibility_save';
+ break;
+ case SMOPT_PAGE_FOLDER:
+ $save_hook_name = 'options_folder_save';
+ break;
+ default:
+ $save_hook_name = 'options_save';
+ break;
+ }
+
+ /* Run the options save hook. */
+ do_hook($save_hook_name, $null);
+}
+
+/***************************************************************/
+/* Apply logic to decide what optpage we want to display next. */
+/***************************************************************/
+
+/* If this is the result of an option page being submitted, then */
+/* show the main page. Otherwise, show whatever page was called. */
+
+if ($optmode == SMOPT_MODE_SUBMIT) {
+ $optpage = SMOPT_PAGE_MAIN;
+ $optpage_title = _("Options");
+}
+
+/***************************************************************/
+/* Finally, display whatever page we are supposed to show now. */
+/***************************************************************/
+
+displayPageHeader($color, null, (isset($optpage_data['xtra']) ? $optpage_data['xtra'] : ''));
+
+/*
+ * The main option page has a different layout then the rest of the option
+ * pages. Therefore, we create it here first, then the others below.
+ */
+if ($optpage == SMOPT_PAGE_MAIN) {
+ /**********************************************************/
+ /* First, display the results of a submission, if needed. */
+ /**********************************************************/
+ $notice = '';
+ if ($optmode == SMOPT_MODE_SUBMIT) {
+ if (!isset($frame_top)) {
+ $frame_top = '_top';
}
- /* Save draft folder preferences. */
- if ($new_draft_folder != SMPREF_NONE) {
- setPref($data_dir, $username, 'save_as_draft', SMPREF_ON);
- setPref($data_dir, $username, 'draft_folder', $new_draft_folder);
+ if (isset($optpage_save_error) && $optpage_save_error!=array()) {
+//FIXME: REMOVE HTML FROM CORE
+ $notice = _("Error(s) occurred while saving your options") . "
\n\n";
+ foreach ($optpage_save_error as $error_message) {
+ $notice.= '- ' . $error_message . "
\n";
+ }
+ $notice.= " \n" . _("Some of your preference changes were not applied.") . "\n";
} else {
- setPref($data_dir, $username, 'save_as_draft', SMPREF_OFF);
- setPref($data_dir, $username, 'draft_folder', SMPREF_NONE);
+ /* Display a message indicating a successful save. */
+ // i18n: The %s represents the name of the option page saving the options
+ $notice = sprintf(_("Successfully Saved Options: %s"), $optpage_name) . "
\n";
}
- /* Save folder prefix preferences. */
- if (isset($folderprefix)) {
- setPref($data_dir, $username, 'folder_prefix', $folderprefix);
- } else {
- setPref($data_dir, $username, 'folder_prefix', '');
+ /* If $max_refresh != SMOPT_REFRESH_NONE, provide a refresh link. */
+ if ( !isset( $max_refresh ) ) {
+ } else if ($max_refresh == SMOPT_REFRESH_FOLDERLIST) {
+//FIXME: REMOVE HTML FROM CORE - when migrating, keep in mind that the javascript below assumes the folder list is in a separate sibling frame under the same parent, and it is called "left"
+ if (checkForJavascript()) {
+ $notice .= sprintf(_("Folder list should automatically %srefresh%s."), '', '') . '
\n";
+ } else {
+ $notice .= '' . _("Refresh Folder List") . '
';
+ }
+ } else if ($max_refresh) {
+ if (checkForJavascript()) {
+//FIXME: REMOVE HTML FROM CORE - when migrating, keep in mind that the javascript below assumes the parent is the top-most SM frame and is what should be refreshed with webmail.php
+ $notice .= sprintf(_("This page should automatically %srefresh%s."), '', '') . '
\n";
+ } else {
+ $notice .= '' . _("Refresh Page") . '
';
+ }
}
- setPref($data_dir, $username, 'unseen_notify', $unseennotify);
- setPref($data_dir, $username, 'unseen_type', $unseentype);
- if (isset($collapsefolders))
- setPref($data_dir, $username, 'collapse_folders', $collapsefolders);
- else
- removePref($data_dir, $username, 'collapse_folders');
- setPref($data_dir, $username, 'date_format', $dateformat);
- setPref($data_dir, $username, 'hour_format', $hourformat);
- do_hook('options_folders_save');
- echo '
'._("Successfully saved folder preferences!").'
';
- echo '' . _("Refresh Folder List") . '
';
- } else {
- do_hook('options_save');
}
+
+ if (!empty($notice)) {
+ $oTemplate->assign('note', $notice);
+ $oTemplate->display('note.tpl');
+ }
+
+ /******************************************/
+ /* Build our array of Option Page Blocks. */
+ /******************************************/
+ $optpage_blocks = array();
- /****************************************/
- /* Now build our array of option pages. */
- /****************************************/
+ // access keys...
+ global $accesskey_options_personal, $accesskey_options_display,
+ $accesskey_options_highlighting, $accesskey_options_folders,
+ $accesskey_options_index_order, $accesskey_options_compose,
+ $accesskey_options_accessibility;
/* Build a section for Personal Options. */
- $optionpages[] = array(
- 'name' => _("Personal Information"),
- 'url' => 'options_personal.php',
- 'desc' => _("This contains personal information about yourself such as your name, your email address, etc."),
- 'js' => false
+ $optpage_blocks[] = array(
+ 'name' => _("Personal Information"),
+ 'url' => 'options.php?optpage=' . SMOPT_PAGE_PERSONAL,
+ 'desc' => _("This contains personal information about yourself such as your name, your email address, etc."),
+ 'js' => false,
+ 'accesskey' => $accesskey_options_personal,
);
/* Build a section for Display Options. */
- $optionpages[] = array(
- 'name' => _("Display Preferences"),
- 'url' => 'options_display.php',
- 'desc' => _("You can change the way that SquirrelMail looks and displays information to you, such as the colors, the language, and other settings."),
- 'js' => false
+ $optpage_blocks[] = array(
+ 'name' => _("Display Preferences"),
+ 'url' => 'options.php?optpage=' . SMOPT_PAGE_DISPLAY,
+ 'desc' => _("You can change the way that SquirrelMail looks and displays information to you, such as the colors, the language, and other settings."),
+ 'js' => false,
+ 'accesskey' => $accesskey_options_display,
);
/* Build a section for Message Highlighting Options. */
- $optionpages[] = array(
- 'name' =>_("Message Highlighting"),
- 'url' => 'options_highlight.php',
- '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."),
- 'js' => false
+ $optpage_blocks[] = array(
+ 'name' =>_("Message Highlighting"),
+ 'url' => 'options_highlight.php',
+ '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."),
+ 'js' => false,
+ 'accesskey' => $accesskey_options_highlighting,
);
/* Build a section for Folder Options. */
- $optionpages[] = array(
- 'name' => _("Folder Preferences"),
- 'url' => 'options_folder.php',
- 'desc' => _("These settings change the way your folders are displayed and manipulated."),
- 'js' => false
+ $optpage_blocks[] = array(
+ 'name' => _("Folder Preferences"),
+ 'url' => 'options.php?optpage=' . SMOPT_PAGE_FOLDER,
+ 'desc' => _("These settings change the way your folders are displayed and manipulated."),
+ 'js' => false,
+ 'accesskey' => $accesskey_options_folders,
);
/* Build a section for Index Order Options. */
- $optionpages[] = array(
- 'name' => _("Index Order"),
- 'url' => 'options_order.php',
- 'desc' => _("The order of the message index can be rearanged and changed to contain the headers in any order you want."),
- 'js' => false
+ $optpage_blocks[] = array(
+ 'name' => _("Index Order"),
+ 'url' => 'options_order.php',
+ 'desc' => _("The order of the message index can be rearranged and changed to contain the headers in any order you want."),
+ 'js' => false,
+ 'accesskey' => $accesskey_options_index_order,
+ );
+
+ /* Build a section for Compose Options. */
+ $optpage_blocks[] = array(
+ 'name' => _("Compose Preferences"),
+ 'url' => 'options.php?optpage=' . SMOPT_PAGE_COMPOSE,
+ 'desc' => _("Control the behaviour and layout of writing new mail messages, replying to and forwarding messages."),
+ 'js' => false,
+ 'accesskey' => $accesskey_options_compose,
+ );
+
+ /* Build a section for Accessibility Options. */
+ $optpage_blocks[] = array(
+ 'name' => _("Accessibility Preferences"),
+ 'url' => 'options.php?optpage=' . SMOPT_PAGE_ACCESSIBILITY,
+ 'desc' => _("You can configure features that improve interface usability."),
+ 'js' => false,
+ 'accesskey' => $accesskey_options_accessibility,
);
+
/* Build a section for plugins wanting to register an optionpage. */
- do_hook('options_register');
+ do_hook('optpage_register_block', $null);
/*****************************************************/
/* Let's sort Javascript Option Pages to the bottom. */
/*****************************************************/
- foreach ($optionpages as $optpage) {
- if (!$optpage['js']) {
- $reg_optionpages[] = $optpage;
- } else if ($javascript_on == SMPREF_JS_ON) {
- $js_optionpages[] = $optpage;
+ $js_optpage_blocks = array();
+ $reg_optpage_blocks = array();
+ foreach ($optpage_blocks as $cur_optpage) {
+ if (!isset($cur_optpage['accesskey'])) {
+ $cur_optpage['accesskey'] = 'NONE';
+ }
+ if (!isset($cur_optpage['js']) || !$cur_optpage['js']) {
+ $reg_optpage_blocks[] = $cur_optpage;
+ } else if (checkForJavascript()) {
+ $js_optpage_blocks[] = $cur_optpage;
}
}
- $optionpages = array_merge($reg_optionpages, $js_optionpages);
+ $optpage_blocks = array_merge($reg_optpage_blocks, $js_optpage_blocks);
/********************************************/
/* Now, print out each option page section. */
/********************************************/
- $first_optpage = false;
- foreach ($optionpages as $next_optpage) {
- if ($first_optpage == false) {
- $first_optpage = $next_optpage;
- } else {
- print_optionpages_row($first_optpage, $next_optpage);
- $first_optpage = false;
- }
- }
+ $oTemplate->assign('page_title', $optpage_title);
+ $oTemplate->assign('options', $optpage_blocks);
- if ($first_optpage != false) {
- print_optionpages_row($first_optpage);
- }
+ $oTemplate->display('option_groups.tpl');
+
+ do_hook('options_link_and_description', $null);
- do_hook('options_link_and_description');
-?>
- |
-
+/*************************************************************************/
+/* If we are not looking at the main option page, display the page here. */
+/*************************************************************************/
+} else {
+ /* Set the bottom_hook_name and submit_name. */
+ switch ($optpage) {
+ case SMOPT_PAGE_PERSONAL:
+ $bottom_hook_name = 'options_personal_bottom';
+ $submit_name = 'submit_personal';
+ break;
+ case SMOPT_PAGE_DISPLAY:
+ $bottom_hook_name = 'options_display_bottom';
+ $submit_name = 'submit_display';
+ break;
+ case SMOPT_PAGE_COMPOSE:
+ $bottom_hook_name = 'options_compose_bottom';
+ $submit_name = 'submit_compose';
+ break;
+ case SMOPT_PAGE_ACCESSIBILITY:
+ $bottom_hook_name = 'options_accessibility_bottom';
+ $submit_name = 'submit_accessibility';
+ break;
+ case SMOPT_PAGE_HIGHLIGHT:
+ $bottom_hook_name = 'options_highlight_bottom';
+ $submit_name = 'submit_highlight';
+ break;
+ case SMOPT_PAGE_FOLDER:
+ $bottom_hook_name = 'options_folder_bottom';
+ $submit_name = 'submit_folder';
+ break;
+ case SMOPT_PAGE_ORDER:
+ $bottom_hook_name = 'options_order_bottom';
+ $submit_name = 'submit_order';
+ break;
+ default:
+ $bottom_hook_name = '';
+ $submit_name = 'submit';
+ }
- |
-