X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=src%2Foptions.php;h=42ecaedd5c4fbcb1b786c3e7c906076926a633bd;hp=bf0c796b46751cc8dc609d20cd900cb1053396f9;hb=99aaff8b9e275cf29a0771a740f67bb8fb9f5f75;hpb=56b52934be8ce6632aec987b6530036dccdd71d7 diff --git a/src/options.php b/src/options.php index bf0c796b..42ecaedd 100644 --- a/src/options.php +++ b/src/options.php @@ -1,243 +1,378 @@ - -
- -
-
- - -
- -'._("Successfully saved personal information!").'
'; - } else if (isset($submit_display)) { - // Do checking to make sure $chosentheme is in the array - $in_ary = false; - for ($i=0; $i < count($theme); $i++) { - if ($theme[$i]['PATH'] == $chosentheme) { - $in_ary = true; - break; +/** + * options.php + * + * Copyright (c) 1999-2004 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. + * + * @version $Id$ + * @package squirrelmail + */ + +/** + * Path for SquirrelMail required files. + * @ignore + */ +define('SM_PATH','../'); + +/* 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'); +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. ***/ +/*********************************/ + +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_HIGHLIGHT', 'highlight'); +define('SMOPT_PAGE_FOLDER', 'folder'); +define('SMOPT_PAGE_ORDER', 'order'); + +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) { + /* Remove Debug Mode Until Needed + echo "name = '$option->name', " + . "value = '$option->value', " + . "new_value = '$option->new_value'\n"; + echo "
"; + */ + if ($option->changed()) { + $option->save(); + $max_refresh = max($max_refresh, $option->refresh_level); } } - if (! $in_ary) { - $chosentheme = ''; - } - - /* Save display preferences. */ - setPref($data_dir, $username, 'chosen_theme', $chosentheme); - setPref($data_dir, $username, 'language', $language); - setPref($data_dir, $username, 'use_javascript_addr_book', $javascript_abook); - setPref($data_dir, $username, 'javascript_setting', $new_javascript_setting); - setPref($data_dir, $username, 'show_num', $shownum); - setPref($data_dir, $username, 'wrap_at', $wrapat); - setPref($data_dir, $username, 'editor_size', $editorsize); - setPref($data_dir, $username, 'left_refresh', $leftrefresh); - setPref($data_dir, $username, 'location_of_bar', $folder_new_location); - setPref($data_dir, $username, 'location_of_buttons', $button_new_location); - setPref($data_dir, $username, 'left_size', $leftsize); - - if (isset($altIndexColors) && $altIndexColors == 1) { - setPref($data_dir, $username, 'alt_index_colors', 1); - } else { - setPref($data_dir, $username, 'alt_index_colors', 0); - } + } - setPref($data_dir, $username, 'show_html_default', ($showhtmldefault?1:0) ); + /* Return the max refresh level. */ + return ($max_refresh); +} - if (isset($includeselfreplyall)) { - setPref($data_dir, $username, 'include_self_reply_all', 1); - } else { - removePref($data_dir, $username, 'include_self_reply_all'); - } +function process_optionmode_link($optpage) { + /* There will be something here, later. */ +} - if (isset($pageselectormax)) { - setPref($data_dir, $username, 'page_selector_max', $pageselectormax); - } else { - removePref($data_dir, $username, 'page_selector_max', 0 ); - } - if (isset($pageselector)) { - removePref($data_dir, $username, 'page_selector'); - } else { - setPref($data_dir, $username, 'page_selector', 1); - } +/** + * This function prints out an option page row. + */ +function print_optionpages_row($leftopt, $rightopt = false) { + global $color; - $js_autodetect_results = (isset($js_autodetect_results) ? $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); - } - } 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 folder preferences. */ - if ($trash != 'none') { - setPref($data_dir, $username, 'move_to_trash', true); - setPref($data_dir, $username, 'trash_folder', $trash); - } else { - setPref($data_dir, $username, 'move_to_trash', '0'); - setPref($data_dir, $username, 'trash_folder', 'none'); - } - if ($sent != 'none') { - setPref($data_dir, $username, 'move_to_sent', true); - setPref($data_dir, $username, 'sent_folder', $sent); - } else { - setPref($data_dir, $username, 'move_to_sent', '0'); - setPref($data_dir, $username, 'sent_folder', 'none'); - } - if ($draft != 'none') { - setPref($data_dir, $username, 'save_as_draft', true); - setPref($data_dir, $username, 'draft_folder', $draft); - } else { - setPref($data_dir, $username, 'save_as_draft', '0'); - setPref($data_dir, $username, 'draft_folder', 'none'); - } - if (isset($folderprefix)) { - setPref($data_dir, $username, 'folder_prefix', $folderprefix); - } else { - setPref($data_dir, $username, 'folder_prefix', ''); - } - 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") . '
'; + 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 { - do_hook('options_save'); + $rightopt_name = html_tag( 'td', ' ', 'left', $color[4], 'valign="top" width="49%"' ); + $rightopt_desc = html_tag( 'td', ' ', 'left', $color[4], 'valign="top" width="49%"' ); } - /****************************************/ - /* Now build our array of option pages. */ - /****************************************/ + 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); +/* 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_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'); +} + +/**********************************************************/ +/*** Second, load the option information for this page. ***/ +/**********************************************************/ + +if ( !@is_file( $optpage_file ) ) { + $optpage = SMOPT_PAGE_MAIN; +} else if ($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']); +} + +/***********************************************************/ +/*** Next, process anything that needs to be processed. ***/ +/***********************************************************/ + +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. */ +/*******************************************************************/ + +/* 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_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); +} + +/***************************************************************/ +/* 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; +} + +/***************************************************************/ +/* 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"; + +/* + * 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. */ + /**********************************************************/ + 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 $max_refresh != SMOPT_REFRESH_NONE, provide a refresh link. */ + if ( !isset( $max_refresh ) ) { + } else if ($max_refresh == SMOPT_REFRESH_FOLDERLIST) { + echo '' . _("Refresh Folder List") . '
'; + } else if ($max_refresh) { + echo '' . _("Refresh Page") . '
'; + } + } + /******************************************/ + /* Build our array of Option Page Blocks. */ + /******************************************/ + $optpage_blocks = array(); /* Build a section for Personal Options. */ - $optionpages[] = array( + $optpage_blocks[] = array( 'name' => _("Personal Information"), - 'url' => 'options_personal.php', + '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. */ - $optionpages[] = array( + $optpage_blocks[] = array( 'name' => _("Display Preferences"), - 'url' => 'options_display.php', + '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. */ - $optionpages[] = array( + $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 ); /* Build a section for Folder Options. */ - $optionpages[] = array( + $optpage_blocks[] = array( 'name' => _("Folder Preferences"), - 'url' => 'options_folder.php', + '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. */ - $optionpages[] = array( + $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 plugins wanting to register an optionpage. */ - do_hook('options_register'); + do_hook('optpage_register_block'); /*****************************************************/ /* Let's sort Javascript Option Pages to the bottom. */ /*****************************************************/ - foreach ($optionpages as $optpage) { - if (!$optpage['js']) { - $reg_optionpages[] = $optpage; + $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 ($javascript_on == SMPREF_JS_ON) { - $js_optionpages[] = $optpage; + $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) { + 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 { @@ -250,78 +385,77 @@ print_optionpages_row($first_optpage); } + echo "
\n"; + do_hook('options_link_and_description'); -?> - - - - +/*************************************************************************/ +/* 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" + . 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: + $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_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); + } -'; - /*******************************************************************/ - /* 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 "" . - '' . - "
' . - '' . - '' . - "'. - ""; - if( $rightopt ) { - echo "'; - } else { - echo ""; - } - - echo '' . - '' . - "' . - ""; - if( $rightopt ) { - echo "'; - }else { - echo ""; - } - - echo '' . - '
" . - '' . $leftopt['name'] . ''. - ' " . - '' . $rightopt['name'] . '' . - ' 
" . - $leftopt['desc'] . - ' " . - $rightopt['desc'] . - ' 
' . - '
\n"; + /* If it is not empty, trigger the bottom hook. */ + if ($bottom_hook_name != '') { + do_hook($bottom_hook_name); } +} -?> \ No newline at end of file +echo '' . + ''. + ''. + '' . + ''; + +?>