X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=src%2Foptions.php;h=b13e04a045c577e56a47a17c1ad1d930b3e93159;hp=abf23cc97abee2256a5bb4a7d87acca801893f67;hb=c4dcda235cd69f4a5cfab95cec25b128224cda80;hpb=a32985a59fe460e2bf5c2e9ea2dd6004d0f66b54 diff --git a/src/options.php b/src/options.php index abf23cc9..b13e04a0 100644 --- a/src/options.php +++ b/src/options.php @@ -3,33 +3,34 @@ /** * options.php * - * Copyright (c) 1999-2002 The SquirrelMail Project 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 */ -/* Path for SquirrelMail required files. */ -define('SM_PATH','../'); +/** This is the options page */ +define('PAGE_NAME', 'options'); + +/** + * Include the SquirrelMail initialization file. + */ +require('../include/init.php'); /* SquirrelMail required files. */ -require_once(SM_PATH . 'include/validate.php'); -require_once(SM_PATH . 'functions/display_messages.php'); -require_once(SM_PATH . 'functions/imap.php'); -require_once(SM_PATH . 'functions/array.php'); + +//include(SM_PATH . 'functions/imap_general.php'); require_once(SM_PATH . 'functions/options.php'); -require_once(SM_PATH . 'functions/strings.php'); -require_once(SM_PATH . 'functions/html.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'); @@ -37,6 +38,7 @@ 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'); @@ -45,14 +47,25 @@ 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(''); + } + /* Remove Debug Mode Until Needed echo "name = '$option->name', " . "value = '$option->value', " . "new_value = '$option->new_value'\n"; - echo "
"; + echo "
"; */ if ($option->changed()) { $option->save(); @@ -70,69 +83,13 @@ function process_optionmode_link($optpage) { } -/** - * This function prints out an option page row. - */ -function print_optionpages_row($leftopt, $rightopt = false) { - global $color; - - if ($rightopt) { - $rightopt_name = html_tag( 'td', '' . $rightopt['name'] . '', 'left', $color[9], 'valign="top" width="49%"' ); - $rightopt_desc = html_tag( 'td', $rightopt['desc'], 'left', $color[0], 'valign="top" width="49%"' ); - } else { - $rightopt_name = html_tag( 'td', ' ', 'left', $color[4], 'valign="top" width="49%"' ); - $rightopt_desc = html_tag( 'td', ' ', 'left', $color[4], 'valign="top" width="49%"' ); - } - - echo - html_tag( 'table', "\n" . - html_tag( 'tr', "\n" . - html_tag( 'td', "\n" . - html_tag( 'table', "\n" . - html_tag( 'tr', "\n" . - html_tag( 'td', - '' . $leftopt['name'] . '' , - 'left', $color[9], 'valign="top" width="49%"' ) . - html_tag( 'td', - ' ' , - 'left', $color[4], 'valign="top" width="2%"' ) . "\n" . - $rightopt_name - ) . "\n" . - html_tag( 'tr', "\n" . - html_tag( 'td', - $leftopt['desc'] , - 'left', $color[0], 'valign="top" width="49%"' ) . - html_tag( 'td', - ' ' , - 'left', $color[4], 'valign="top" width="2%"' ) . "\n" . - $rightopt_desc - ) , - '', '', 'width="100%" cellpadding="2" cellspacing="0" border="0"' ) , - 'left', '', 'valign="top"' ) - ) , - '', $color[4], 'width="100%" cellpadding="0" cellspacing="5" border="0"' ); -} /* ---------------------------- main ---------------------------- */ /* get the globals that we may need */ -if (isset($_GET['optpage'])) { - $optpage = $_GET['optpage']; -} -elseif (isset($_POST['optpage'])) { - $optpage = $_POST['optpage']; -} -if (isset($_POST['optmode'])) { - $optmode = $_POST['optmode']; -} -if (isset($_POST['optpage_data'])) { - $optpage_data = $_POST['optpage_data']; -} -$username = $_SESSION['username']; -$key = $_COOKIE['key']; -$onetimepad = $_SESSION['onetimepad']; -$delimiter = $_SESSION['delimiter']; - +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. */ @@ -148,7 +105,7 @@ if (!isset($optmode)) { } /* - * First, set the load information for each option page. + * First, set the load information for each option page. */ /* Initialize load information variables. */ @@ -158,7 +115,7 @@ $optpage_loader = ''; /* Set the load information for each page. */ switch ($optpage) { - case SMOPT_PAGE_MAIN: + case SMOPT_PAGE_MAIN: break; case SMOPT_PAGE_PERSONAL: $optpage_name = _("Personal Information"); @@ -172,6 +129,12 @@ switch ($optpage) { $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 = SM_PATH . 'include/options/highlight.php'; @@ -190,7 +153,7 @@ switch ($optpage) { $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); } /**********************************************************/ @@ -199,23 +162,24 @@ switch ($optpage) { 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']); } /***********************************************************/ /*** Next, process anything that needs to be processed. ***/ /***********************************************************/ +$optpage_save_error=array(); + if ( isset( $optpage_data ) ) { switch ($optmode) { case SMOPT_MODE_SUBMIT: @@ -226,21 +190,12 @@ if ( isset( $optpage_data ) ) { break; } } -/*** MOVE THIS DISPLAY CODE DOWN EVENTUALLY!!! ***/ $optpage_title = _("Options"); if (isset($optpage_name) && ($optpage_name != '')) { $optpage_title .= " - $optpage_name"; } -echo html_tag( 'table', '', 'center', $color[0], 'width="95%" cellpadding="1" cellspacing="0" border="0"' ) . "\n" . - html_tag( 'tr' ) . "\n" . - html_tag( 'td', '', 'center' ) . - "$optpage_title
\n". - html_tag( 'table', '', '', '', 'width="100%" cellpadding="5" cellspacing="0" border="0"' ) . "\n" . - html_tag( 'tr' ) . "\n" . - html_tag( 'td', '', 'center', $color[4] ) . "\n"; - /*******************************************************************/ /* DO OLD SAVING OF SUBMITTED OPTIONS. THIS WILL BE REMOVED LATER. */ /*******************************************************************/ @@ -255,16 +210,19 @@ if ($optmode == SMOPT_MODE_SUBMIT) { 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: + default: $save_hook_name = 'options_save'; break; } /* Run the options save hook. */ - do_hook($save_hook_name); + do_hook($save_hook_name, $null); } /***************************************************************/ @@ -282,6 +240,8 @@ if ($optmode == SMOPT_MODE_SUBMIT) { /* 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. @@ -290,21 +250,48 @@ 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'; } - /* Display a message indicating a successful save. */ - echo '' . _("Successfully Saved Options") . ": $optpage_name
\n"; + + if (isset($optpage_save_error) && $optpage_save_error!=array()) { +//FIXME: REMOVE HTML FROM CORE + $notice = _("Error(s) occurred while saving your options") . "
\n\n" . _("Some of your preference changes were not applied.") . "\n"; + } else { + /* Display a message indicating a successful save. */ + $notice = _("Successfully Saved Options") . ": $optpage_name
\n"; + } /* If $max_refresh != SMOPT_REFRESH_NONE, provide a refresh link. */ if ( !isset( $max_refresh ) ) { } else if ($max_refresh == SMOPT_REFRESH_FOLDERLIST) { - echo '' . _("Refresh Folder List") . '
'; +//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) { - echo '' . _("Refresh Page") . '
'; + 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") . '
'; + } } } + + if (!empty($notice)) { + $oTemplate->assign('note', $notice); + $oTemplate->display('note.tpl'); + } + /******************************************/ /* Build our array of Option Page Blocks. */ /******************************************/ @@ -330,7 +317,7 @@ if ($optpage == SMOPT_PAGE_MAIN) { $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 ); @@ -350,8 +337,16 @@ if ($optpage == SMOPT_PAGE_MAIN) { '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. */ @@ -359,9 +354,9 @@ if ($optpage == SMOPT_PAGE_MAIN) { $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; } } @@ -370,45 +365,18 @@ if ($optpage == SMOPT_PAGE_MAIN) { /********************************************/ /* Now, print out each option page section. */ /********************************************/ - $first_optpage = false; - echo html_tag( 'table', '', '', $color[4], 'width="100%" cellpadding="0" cellspacing="5" border="0"' ) . "\n" . - html_tag( 'tr' ) . "\n" . - html_tag( 'td', '', 'left', '', 'valign="top"' ) . - html_tag( 'table', '', '', $color[4], 'width="100%" cellpadding="3" cellspacing="0" border="0"' ) . "\n" . - html_tag( 'tr' ) . "\n" . - html_tag( 'td', '', 'left' ); - 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); - } - - echo "\n"; + $oTemplate->assign('page_title', $optpage_title); + $oTemplate->assign('options', $optpage_blocks); - 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 '

' . "\n" - . create_optpage_element($optpage) - . create_optmode_element(SMOPT_MODE_SUBMIT) - . html_tag( 'table', '', '', '', 'width="100%" cellpadding="2" cellspacing="0" border="0"' ) . "\n" - . html_tag( 'tr' ) . "\n" - . html_tag( 'td', '', 'left' ) . "\n"; - - /* Output the option groups for this page. */ - print_option_groups($optpage_data['options']); - /* Set the inside_hook_name and submit_name. */ switch ($optpage) { case SMOPT_PAGE_PERSONAL: @@ -421,6 +389,11 @@ if ($optpage == SMOPT_PAGE_MAIN) { $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'; @@ -442,25 +415,65 @@ if ($optpage == SMOPT_PAGE_MAIN) { $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 "\n" . + " \n" . + " \n" . + " \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 '
\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 "
'; +//FIXME: need to remove HTML from here! + echo "\n" . + "\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); } + } -echo '' . - ''. - ''. - '' . - ''; - -?> +$oTemplate->display('footer.tpl');