/**
* options.php
*
- * Copyright (c) 1999-2001 The SquirrelMail Development Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
* Displays the options page. Pulls from proper user preference files
* and config.php. Displays preferences as selected and other options.
*
- * $Id$
+ * @copyright © 1999-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage prefs
*/
-require_once('../src/validate.php');
-require_once('../functions/display_messages.php');
-require_once('../functions/imap.php');
-require_once('../functions/array.php');
-require_once('../functions/options.php');
+/**
+ * Include the SquirrelMail initialization file.
+ */
+require('../include/init.php');
-/* Set the base uri. */
-ereg ("(^.*/)[^/]+/[^/]+$", $PHP_SELF, $regs);
-$base_uri = $regs[1];
+/* SquirrelMail required files. */
-/* First and foremost, deal with language stuff. */
-if (isset($language)) {
- setcookie('squirrelmail_language', $language, time()+2592000, $base_uri);
- $squirrelmail_language = $language;
-} else {
- $language = getPref($data_dir, $username, 'language');
-}
+//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. ***/
/*********************************/
-displayPageHeader($color, 'None');
-
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_HIGHLIGHT', 'highlight');
define('SMOPT_PAGE_FOLDER', 'folder');
define('SMOPT_PAGE_ORDER', 'order');
/* 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', "
- . "new_value = '$option->new_value'<BR>\n";
+ . "new_value = '$option->new_value'\n";
+ echo "<br />";
*/
if ($option->changed()) {
$option->save();
/* 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);
+/* end of getting globals */
+
/* Make sure we have an Option Page set. Default to main. */
-if (!isset($optpage)) {
- $optpage = '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. */
$optmode = SMOPT_MODE_DISPLAY;
}
-/*************************************************************/
-/*** First, set the load information for each option page. ***/
-/*************************************************************/
+/*
+ * First, set the load information for each option page.
+ */
/* Initialize load information variables. */
$optpage_name = '';
/* Set the load information for each page. */
switch ($optpage) {
- case SMOPT_PAGE_MAIN: break;
+ case SMOPT_PAGE_MAIN:
+ break;
case SMOPT_PAGE_PERSONAL:
- $optpage_name = _("Personal Information");
- $optpage_file = 'options_personal.php';
- $optpage_loader = 'load_optpage_data_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 = 'options_display.php';
+ $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_HIGHLIGHT:
$optpage_name = _("Message Highlighting");
- $optpage_file = 'options_highlight.php';
+ $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 = 'options_folder.php';
+ $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 = 'options_order.php';
+ $optpage_file = SM_PATH . 'include/options/order.php';
$optpage_loader = 'load_optpage_data_order';
+ $optpage_loadhook = 'optpage_loadhook_order';
break;
- default: do_hook('set_optpage_loadinfo');
+ default: do_hook('optpage_set_loadinfo', $null);
}
/**********************************************************/
/*** Second, load the option information for this page. ***/
/**********************************************************/
-if ($optpage != SMOPT_PAGE_MAIN) {
+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();
- $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']);
}
/***********************************************************/
/*** Next, process anything that needs to be processed. ***/
/***********************************************************/
-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_save_error=array();
-/*** MOVE THIS DISPLAY CODE DOWN EVENTUALLY!!! ***/
+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";
}
-?>
-
-<BR>
-<TABLE BGCOLOR="<?php echo $color[0] ?>" WIDTH="95%" ALIGN="CENTER" CELLPADDING="2" CELLSPACING="0" BORDER="0">
-<TR><TD ALIGN="CENTER">
- <B><?php echo $optpage_title; ?></B><BR>
- <TABLE WIDTH="100%" BORDER="0" CELLPADDING="5" CELLSPACING="0">
- <TR><TD BGCOLOR="<?php echo $color[4] ?>" ALIGN="CENTER">
-
-<?php
-
/*******************************************************************/
/* DO OLD SAVING OF SUBMITTED OPTIONS. THIS WILL BE REMOVED LATER. */
/*******************************************************************/
/* If in submit mode, select a save hook name and run it. */
-if ($optmode == SMOPT_MODE_SUBMIT) {
+if ($optmode == SMOPT_MODE_SUBMIT) {
/* Select a save hook name. */
switch ($optpage) {
case SMOPT_PAGE_PERSONAL:
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_FOLDER:
$save_hook_name = 'options_folder_save';
break;
- default: $save_hook_name = 'options_save';
+ default:
+ $save_hook_name = 'options_save';
break;
}
/* Run the options save hook. */
- do_hook($save_hook_name);
+ do_hook($save_hook_name, $null);
}
/***************************************************************/
/* 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.
/**********************************************************/
/* First, display the results of a submission, if needed. */
/**********************************************************/
+ $notice = '';
if ($optmode == SMOPT_MODE_SUBMIT) {
- /* Display a message indicating a successful save. */
- echo '<B>' . _("Successfully Saved Options") . ": $optpage_name</B><BR>\n";
+ 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 ($max_refresh == SMOPT_REFRESH_FOLDERLIST) {
- echo '<A HREF="../src/left_main.php" TARGET="left">' . _("Refresh Folder List") . '</A><BR>';
+ 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) {
- echo '<A HREF="../src/webmail.php?right_frame=options.php" TARGET="_top">' . _("Refresh Page") . '</A><BR>';
+ 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(
'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."),
+ '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' => _("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."),
+ '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');
+ 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 (!$cur_optpage['js']) {
+ if (!isset($cur_optpage['js']) || !$cur_optpage['js']) {
$reg_optpage_blocks[] = $cur_optpage;
- } else if ($javascript_on == SMPREF_JS_ON) {
+ } else if (checkForJavascript()) {
$js_optpage_blocks[] = $cur_optpage;
}
}
/********************************************/
/* Now, print out each option page section. */
/********************************************/
- $first_optpage = false;
- echo "<TABLE BGCOLOR=\"$color[4]\" WIDTH=\"100%\" CELLPADDING=0 CELLSPACING=\"5\" BORDER=\"0\">" .
- '<TR><TD VALIGN="TOP">' .
- "<TABLE BGCOLOR=\"$color[4]\" WIDTH=\"100%\" CELLPADDING=\"3\" CELLSPACING=\"0\" BORDER=\"0\">";
- foreach ($optpage_blocks as $next_optpage) {
- if ($first_optpage == false) {
- $first_optpage = $next_optpage;
- } else {
- print_optionpages_row($first_optpage, $next_optpage);
- $first_optpage = false;
- }
- }
-
- if ($first_optpage != false) {
- print_optionpages_row($first_optpage);
- }
+ $oTemplate->assign('page_title', $optpage_title);
+ $oTemplate->assign('options', $optpage_blocks);
- echo "</TABLE></TD></TR></TABLE>\n";
-
- do_hook('options_link_and_description');
+ $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 {
- echo '<FORM NAME="f" ACTION="options.php" METHOD="POST"><BR>' . "\n"
- . '<TABLE WIDTH="100%" CELLPADDING="2" CELLSPACING="0" BORDER="0">' . "\n"
- . create_optpage_element($optpage)
- . create_optmode_element(SMOPT_MODE_SUBMIT);
-
- /* Output the option groups for this page. */
- print_option_groups($optpage_data['options']);
-
- /*** FIXME: CURRENTLY, THIS NEXT SWITCH STATEMENT DOES NOT TAKE
- *** INTO ACCOUNT FOR PLUGINS. NEED TO FIX IT. ***/
-
/* Set the inside_hook_name and submit_name. */
switch ($optpage) {
case SMOPT_PAGE_PERSONAL:
$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_display_bottom';
+ $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_display_bottom';
+ $bottom_hook_name = 'options_folder_bottom';
$submit_name = 'submit_folder';
break;
case SMOPT_PAGE_ORDER:
$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);
+ do_hook($inside_hook_name, $null);
}
- /* Spit out a submit button. */
- OptionSubmit($submit_name);
- echo '</TABLE></FORM>';
+//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);
+ do_hook($bottom_hook_name, $null);
}
+
}
-?>
- </TD></TR>
- </TABLE>
-
-</TD></TR>
-</TABLE>
-
-</BODY></HTML>
-
-<?php
-
- /*******************************************************************/
- /* Please be warned. The code below this point sucks. This is just */
- /* my first implementation to make the option rows work for both */
- /* Javascript and non-Javascript option chunks. */
- /* */
- /* Please, someone make these better for me. All three functions */
- /* below REALLY do close to the same thing. */
- /* */
- /* This code would be GREATLY improved by a templating system. */
- /* Don't try to implement that now, however. That will come later. */
- /*******************************************************************/
-
- /*******************************************************************/
- /* Actually, now that I think about it, don't do anything with */
- /* this code yet. There is ACTUALLY supposed to be a difference */
- /* between the three functions that write the option rows. I just */
- /* have not yet gotten to integrating that yet. */
- /*******************************************************************/
-
- /**
- * This function prints out an option page row.
- */
- function print_optionpages_row($leftopt, $rightopt = false) {
- global $color;
-
- echo "<TABLE BGCOLOR=\"$color[4]\" WIDTH=\"100%\" CELLPADDING=0 CELLSPACING=5 BORDER=0>" .
- '<TR><TD VALIGN="TOP">' .
- '<TABLE WIDTH="100%" CELLPADDING="3" CELLSPACING="0" BORDER="0">' .
- '<TR>' .
- "<TD VALIGN=TOP BGCOLOR=\"$color[9]\" WIDTH=\"50%\">" .
- '<A HREF="' . $leftopt['url'] . '">' . $leftopt['name'] . '</A>'.
- '</TD>'.
- "<TD VALIGN=TOP BGCOLOR=\"$color[4]\"> </TD>";
- if ($rightopt) {
- echo "<TD VALIGN=top BGCOLOR=\"$color[9]\" WIDTH=\"50%\">" .
- '<A HREF="' . $rightopt['url'] . '">' . $rightopt['name'] . '</A>' .
- '</TD>';
- } else {
- echo "<TD VALIGN=top BGCOLOR=\"$color[4]\" WIDTH=\"50%\"> </TD>";
- }
-
- echo '</TR>' .
- '<TR>' .
- "<TD VALIGN=top BGCOLOR=\"$color[0]\" WIDTH=\"50%\">" .
- $leftopt['desc'] .
- '</TD>' .
- "<TD VALIGN=top BGCOLOR=\"$color[4]\"> </TD>";
- if ($rightopt) {
- echo "<TD VALIGN=top BGCOLOR=\"$color[0]\" WIDTH=\"50%\">" .
- $rightopt['desc'] .
- '</TD>';
- } else {
- echo "<TD VALIGN=top BGCOLOR=\"$color[4]\" WIDTH=\"50%\"> </TD>";
- }
-
- echo '</TR>' .
- '</TABLE>' .
- '</TD></TR>' .
- "</TABLE>\n";
- }
-
-?>
+$oTemplate->display('footer.tpl');
projects / squirrelmail.git / blobdiff