Changes that follow per the inheritance and associated changes to Template.class.php
[squirrelmail.git] / src / options.php
index 291d11d8f1f05f6b70dc724282aba2af49a7b141..6ef511f044ae210a4079363f56637a55e6574600 100644 (file)
@@ -73,11 +73,6 @@ function process_optionmode_link($optpage) {
 /* ---------------------------- 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);
@@ -153,7 +148,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);
@@ -162,8 +157,7 @@ if ( !@is_file( $optpage_file ) ) {
     $optpage_data = array();
     $optpage_data = $optpage_loader();
     do_hook($optpage_loadhook);
-    $optpage_data['options'] =
-        create_option_groups($optpage_data['grps'], $optpage_data['vals']);
+    $optpage_data['options'] = create_option_groups($optpage_data['grps'], $optpage_data['vals']);
 }
 
 /***********************************************************/
@@ -183,6 +177,11 @@ if ( isset( $optpage_data ) ) {
     }
 }
 
+$optpage_title = _("Options");
+if (isset($optpage_name) && ($optpage_name != '')) {
+    $optpage_title .= " - $optpage_name";
+}
+
 /*******************************************************************/
 /* DO OLD SAVING OF SUBMITTED OPTIONS. THIS WILL BE REMOVED LATER. */
 /*******************************************************************/
@@ -223,15 +222,225 @@ 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'] : ''));
+
+/*
+ * 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()) {
+            $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) {
+            $notice .= '<a href="../src/left_main.php" target="left">' . _("Refresh Folder List") . '</a><br />';
+        } else if ($max_refresh) {
+            $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');
+
+    /*****************************************************/
+    /* 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 ($javascript_on == SMPREF_JS_ON) {
+            $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');
 
-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);
 
+/*************************************************************************/
+/* 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);
+
+    // 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']);
+    
+    /**
+     * 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 not.
+     */
+/*
+    $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->display('options.tpl');
+
+    echo "  </td>\n" .
+         " </tr>\n";
+
+    /* If it is not empty, trigger the inside hook. */
+    if ($inside_hook_name != '') {
+        do_hook($inside_hook_name);
+    }
+
+    /* Spit out a submit button. */
+    OptionSubmit($submit_name);
+    echo "</table>\n" .
+         "</form>\n";
+
+    /* If it is not empty, trigger the bottom hook. */
+    if ($bottom_hook_name != '') {
+        do_hook($bottom_hook_name);
+    }
+    
+}
 
-$oTemplate->display('options.tpl');
 $oTemplate->display('footer.tpl');
 ?>
\ No newline at end of file