X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=src%2Foptions.php;h=2a3fd2a42e76f7496cf0ea5b710c1ceb6d1a72ce;hp=7b4d367ba209f3ea6cf7e444c5d7c635c6074d5d;hb=97eea19dd325ccf33df16522fb1a0410dbca831f;hpb=52608668d89d69ee9456e0812be97d7e31fa885c diff --git a/src/options.php b/src/options.php index 7b4d367b..2a3fd2a4 100644 --- a/src/options.php +++ b/src/options.php @@ -3,30 +3,28 @@ /** * options.php * - * Copyright (c) 1999-2005 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. * + * @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'); + /** - * Path for SquirrelMail required files. - * @ignore + * Include the SquirrelMail initialization file. */ -define('SM_PATH','../'); +require('../include/init.php'); /* SquirrelMail required files. */ -require_once(SM_PATH . 'include/validate.php'); -require_once(SM_PATH . 'functions/global.php'); -require_once(SM_PATH . 'functions/display_messages.php'); -require_once(SM_PATH . 'functions/imap.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'); /*********************************/ @@ -41,21 +39,47 @@ 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(''); + } + /* 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()) { @@ -74,60 +98,14 @@ 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 */ -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); +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. */ @@ -173,6 +151,12 @@ switch ($optpage) { $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'; @@ -191,7 +175,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); } /**********************************************************/ @@ -200,7 +184,7 @@ 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); @@ -208,15 +192,20 @@ if ( !@is_file( $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. ***/ /***********************************************************/ +// security check before saving anything... +//FIXME: what about SMOPT_MODE_LINK?? +if ($optmode == SMOPT_MODE_SUBMIT) { + sm_validate_security_token($submitted_token, 3600, TRUE); +} + $optpage_save_error=array(); if ( isset( $optpage_data ) ) { @@ -239,6 +228,7 @@ if (isset($optpage_name) && ($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. */ @@ -249,6 +239,12 @@ 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_ACCESSIBILITY: + $save_hook_name = 'options_accessibility_save'; + break; case SMOPT_PAGE_FOLDER: $save_hook_name = 'options_folder_save'; break; @@ -258,7 +254,7 @@ if ($optmode == SMOPT_MODE_SUBMIT) { } /* Run the options save hook. */ - do_hook($save_hook_name); + do_hook($save_hook_name, $null); } /***************************************************************/ @@ -270,21 +266,14 @@ if ($optmode == SMOPT_MODE_SUBMIT) { if ($optmode == SMOPT_MODE_SUBMIT) { $optpage = SMOPT_PAGE_MAIN; + $optpage_title = _("Options"); } /***************************************************************/ /* Finally, display whatever page we are supposed to show now. */ /***************************************************************/ -displayPageHeader($color, 'None', (isset($optpage_data['xtra']) ? $optpage_data['xtra'] : '')); - -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"; +displayPageHeader($color, null, (isset($optpage_data['xtra']) ? $optpage_data['xtra'] : '')); /* * The main option page has a different layout then the rest of the option @@ -294,87 +283,125 @@ 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()) { - echo "" . _("Error(s) occurred while saving your options") . "
\n"; - echo "\n" . _("Some of your preference changes were not applied.") . "\n"; } else { /* Display a message indicating a successful save. */ - echo '' . _("Successfully Saved Options") . ": $optpage_name
\n"; + // i18n: The %s represents the name of the option page saving the options + $notice = sprintf(_("Successfully Saved Options: %s"), $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. */ /******************************************/ $optpage_blocks = array(); + // 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. */ $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 + '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. */ $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 + '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. */ $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 + '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. */ $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 + '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. */ $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 + '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 + '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('optpage_register_block'); + do_hook('optpage_register_block', $null); /*****************************************************/ /* Let's sort Javascript Option Pages to the bottom. */ @@ -382,9 +409,12 @@ if ($optpage == SMOPT_PAGE_MAIN) { $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 ($javascript_on == SMPREF_JS_ON) { + } else if (checkForJavascript()) { $js_optpage_blocks[] = $cur_optpage; } } @@ -393,98 +423,89 @@ 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 addForm('options.php', 'post', 'f') - . create_optpage_element($optpage) - . create_optmode_element(SMOPT_MODE_SUBMIT) - . html_tag( 'table', '', '', '', 'width="100%" cellpadding="2" cellspacing="0" border="0"' ) . "\n"; - - /* Output the option groups for this page. */ - print_option_groups($optpage_data['options']); - - /* Set the inside_hook_name and submit_name. */ + /* Set the bottom_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_ACCESSIBILITY: + $bottom_hook_name = 'options_accessibility_bottom'; + $submit_name = 'submit_accessibility'; + 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'; } - /* If it is not empty, trigger the inside hook. */ - if ($inside_hook_name != '') { - do_hook($inside_hook_name); - } + // Begin output form + echo addForm('options.php', 'post', 'option_form', '', '', array(), TRUE) + . create_optpage_element($optpage) + . create_optmode_element(SMOPT_MODE_SUBMIT); - /* Spit out a submit button. */ - OptionSubmit($submit_name); - echo ''; + // This is the only variable that is needed by *just* the template. + $oTemplate->assign('option_groups', $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) ); + } + + // These variables are not specifically needed by the template, + // but they are relevant to the page being built, so we'll add + // them in case some plugin is modifying the page, etc.... + // + $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); + + $oTemplate->assign('submit_name', $submit_name); + $oTemplate->display('options.tpl'); + + $oTemplate->display('form_close.tpl'); /* If it is not empty, trigger the bottom hook. */ if ($bottom_hook_name != '') { - do_hook($bottom_hook_name); + do_hook($bottom_hook_name, $null); } + } -?> - - - - - + +$oTemplate->display('footer.tpl');