* Displays the options page. Pulls from proper user preference files
* and config.php. Displays preferences as selected and other options.
*
- * @copyright © 1999-2006 The SquirrelMail Project Team
+ * @copyright © 1999-2007 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.
*/
/* 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('');
+ }
+
/* Remove Debug Mode Until Needed
echo "name = '$option->name', "
. "value = '$option->value', "
/* ---------------------------- main ---------------------------- */
/* get the globals that we may need */
-sqgetGlobalVar('key', $key, SQ_COOKIE);
-sqgetGlobalVar('username', $username, SQ_SESSION);
-sqgetGlobalVar('onetimepad',$onetimepad, SQ_SESSION);
-sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
-
sqgetGlobalVar('optpage', $optpage);
sqgetGlobalVar('optmode', $optmode, SQ_FORM);
sqgetGlobalVar('optpage_data',$optpage_data, SQ_POST);
$optpage_loader = 'load_optpage_data_order';
$optpage_loadhook = 'optpage_loadhook_order';
break;
- default: do_hook('optpage_set_loadinfo');
+ default: do_hook('optpage_set_loadinfo', $null);
}
/**********************************************************/
if ( !@is_file( $optpage_file ) ) {
$optpage = SMOPT_PAGE_MAIN;
-} else if ($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);
- $optpage_data['options'] =
- create_option_groups($optpage_data['grps'], $optpage_data['vals']);
+ do_hook($optpage_loadhook, $null);
+ $optpage_data['options'] = create_option_groups($optpage_data['grps'], $optpage_data['vals']);
}
/***********************************************************/
}
}
+$optpage_title = _("Options");
+if (isset($optpage_name) && ($optpage_name != '')) {
+ $optpage_title .= " - $optpage_name";
+}
+
/*******************************************************************/
/* DO OLD SAVING OF SUBMITTED OPTIONS. THIS WILL BE REMOVED LATER. */
/*******************************************************************/
}
/* Run the options save hook. */
- do_hook($save_hook_name);
+ do_hook($save_hook_name, $null);
}
/***************************************************************/
$optpage = SMOPT_PAGE_MAIN;
}
+/***************************************************************/
+/* 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';
+ }
+
+ if (isset($optpage_save_error) && $optpage_save_error!=array()) {
+//FIXME: REMOVE HTML FROM CORE
+ $notice = _("Error(s) occurred while saving your options") . "<br />\n<ul>\n";
+ foreach ($optpage_save_error as $error_message) {
+ $notice.= '<li><small>' . $error_message . "</small></li>\n";
+ }
+ $notice.= "</ul>\n" . _("Some of your preference changes were not applied.") . "\n";
+ } else {
+ /* Display a message indicating a successful save. */
+ $notice = _("Successfully Saved Options") . ": $optpage_name</b><br />\n";
+ }
+
+ /* 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."), '<a href="../src/left_main.php" target="left">', '</a>') . '<br /><script type="text/javascript">' . "\n<!--\nparent.left.location = '../src/left_main.php';\n// -->\n</script>\n";
+ } else {
+ $notice .= '<a href="../src/left_main.php" target="left">' . _("Refresh Folder List") . '</a><br />';
+ }
+ } 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."), '<a href="../src/webmail.php?right_frame=options.php" target="' . $frame_top . '">', '</a>') . '<br /><script type="text/javascript">' . "\n<!--\nparent.location = '../src/webmail.php?right_frame=options.php';\n// -->\n</script>\n";
+ } else {
+ $notice .= '<a href="../src/webmail.php?right_frame=options.php" target="' . $frame_top . '">' . _("Refresh Page") . '</a><br />';
+ }
+ }
+ }
+
+ if (!empty($notice)) {
+ $oTemplate->assign('note', $notice);
+ $oTemplate->display('note.tpl');
+ }
+
+ /******************************************/
+ /* Build our array of Option Page Blocks. */
+ /******************************************/
+ $optpage_blocks = array();
+
+ /* Build a section for Personal Options. */
+ $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
+ );
+
+ /* Build a section for Display Options. */
+ $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
+ );
+
+ /* Build a section for Message Highlighting Options. */
+ $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
+ );
+
+ /* Build a section for Folder Options. */
+ $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
+ );
+
+ /* Build a section for Index Order Options. */
+ $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
+ );
+
+ /* 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
+ );
+
+ /* Build a section for plugins wanting to register an optionpage. */
+ do_hook('optpage_register_block', $null);
+
+ /*****************************************************/
+ /* Let's sort Javascript Option Pages to the bottom. */
+ /*****************************************************/
+ $js_optpage_blocks = array();
+ $reg_optpage_blocks = array();
+ foreach ($optpage_blocks as $cur_optpage) {
+ if (!isset($cur_optpage['js']) || !$cur_optpage['js']) {
+ $reg_optpage_blocks[] = $cur_optpage;
+ } else if (checkForJavascript()) {
+ $js_optpage_blocks[] = $cur_optpage;
+ }
+ }
+ $optpage_blocks = array_merge($reg_optpage_blocks, $js_optpage_blocks);
+
+ /********************************************/
+ /* Now, print out each option page section. */
+ /********************************************/
+ $oTemplate->assign('page_title', $optpage_title);
+ $oTemplate->assign('options', $optpage_blocks);
+
+ $oTemplate->display('option_groups.tpl');
+
+ do_hook('options_link_and_description', $null);
+
+
+/*************************************************************************/
+/* If we are not looking at the main option page, display the page here. */
+/*************************************************************************/
+} else {
+ /* Set the inside_hook_name and submit_name. */
+ switch ($optpage) {
+ case SMOPT_PAGE_PERSONAL:
+ $inside_hook_name = 'options_personal_inside';
+ $bottom_hook_name = 'options_personal_bottom';
+ $submit_name = 'submit_personal';
+ break;
+ case SMOPT_PAGE_DISPLAY:
+ $inside_hook_name = 'options_display_inside';
+ $bottom_hook_name = 'options_display_bottom';
+ $submit_name = 'submit_display';
+ break;
+ case SMOPT_PAGE_COMPOSE:
+ $inside_hook_name = 'options_compose_inside';
+ $bottom_hook_name = 'options_compose_bottom';
+ $submit_name = 'submit_compose';
+ break;
+ case SMOPT_PAGE_HIGHLIGHT:
+ $inside_hook_name = 'options_highlight_inside';
+ $bottom_hook_name = 'options_highlight_bottom';
+ $submit_name = 'submit_highlight';
+ break;
+ case SMOPT_PAGE_FOLDER:
+ $inside_hook_name = 'options_folder_inside';
+ $bottom_hook_name = 'options_folder_bottom';
+ $submit_name = 'submit_folder';
+ break;
+ case SMOPT_PAGE_ORDER:
+ $inside_hook_name = 'options_order_inside';
+ $bottom_hook_name = 'options_order_bottom';
+ $submit_name = 'submit_order';
+ break;
+ default:
+ $inside_hook_name = '';
+ $bottom_hook_name = '';
+ $submit_name = 'submit';
+ }
+
+ // Begin output form
+ echo addForm('options.php', 'post', 'f')
+ . create_optpage_element($optpage)
+ . create_optmode_element(SMOPT_MODE_SUBMIT);
+
+//FIXME: NO HTML IN THE CORE!!
+ // Wrap the template in a table to keep from breaking the hooks below
+ echo "<table cellspacing=\"0\" class=\"table_blank\">\n" .
+ " <tr>\n" .
+ " <td colspan=\"2\">\n";
+
+ // This is the only variable that is needed by *just* the template.
+ $oTemplate->assign('options', $optpage_data['options']);
+
+ global $ask_user_info, $org_name;
+ if ( $optpage == SMOPT_PAGE_PERSONAL && $ask_user_info
+ && getPref($data_dir, $username,'email_address') == "" ) {
+ $oTemplate->assign('topmessage',
+ sprintf(_("Welcome to %s. Please supply your full name and email address."), $org_name) );
+ }
+
+ /**
+ * The variables below should not be needed by the template since all plugin
+ * hooks are called here, not in the template. If we find otherwise, these
+ * variables can be passed to the template. Commenting out for now.
+ */
+/*
+ $oTemplate->assign('max_refresh', isset($max_refresh) ? $max_refresh : NULL);
+ $oTemplate->assign('page_title', $optpage_title);
+ $oTemplate->assign('optpage',$optpage);
+ $oTemplate->assign('optpage_name',$optpage_name);
+ $oTemplate->assign('optmode',$optmode);
+ $oTemplate->assign('optpage_data',$optpage_data);
+*/
+ /**
+ * END comment block
+ */
+
+ $oTemplate->assign('submit_name', $submit_name);
+ $oTemplate->display('options.tpl');
+
+//FIXME: need to remove HTML from here!
+ echo " </td>\n" .
+ " </tr>\n";
+
+ /* If it is not empty, trigger the inside hook. */
+ if ($inside_hook_name != '') {
+ do_hook($inside_hook_name, $null);
+ }
-if (isset($max_refresh)) $oTemplate->assign('max_refresh',$max_refresh);
-$oTemplate->assign('color',$color);
-$oTemplate->assign('optpage',$optpage);
-$oTemplate->assign('optpage_name',$optpage_name);
-$oTemplate->assign('optpage_data',$optpage_data);
-$oTemplate->assign('optmode',$optmode);
+//FIXME: need to remove HTML from here!
+ echo "</table>\n" .
+ "</form>\n";
+ /* If it is not empty, trigger the bottom hook. */
+ if ($bottom_hook_name != '') {
+ do_hook($bottom_hook_name, $null);
+ }
+
+}
-$oTemplate->display('options.tpl');
$oTemplate->display('footer.tpl');
-?>
\ No newline at end of file
projects / squirrelmail.git / blobdiff