Replacing tabs with spaces, trimming white space at EOL and newline at EOF
[squirrelmail.git] / src / options.php
index 1b296972a41d21978af3644d3e0f22634f828b30..a25c7c98978ea16956d5bbeb0e73730721f32255 100644 (file)
@@ -1,41 +1,38 @@
 <?php
 
-   /**
-    **  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$
-    */
-
-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');
-
-/* Set the base uri. */
-ereg ("(^.*/)[^/]+/[^/]+$", $PHP_SELF, $regs);
-$base_uri = $regs[1];
-
-/* 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');
-}
+/**
+ * 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. ***/
 /*********************************/
 
-displayPageHeader($color, 'None');
-
 define('SMOPT_MODE_DISPLAY', 'display');
 define('SMOPT_MODE_SUBMIT', 'submit');
 define('SMOPT_MODE_LINK', 'link');
@@ -57,7 +54,8 @@ function process_optionmode_submit($optpage, $optpage_data) {
             /* 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();
@@ -74,9 +72,68 @@ function process_optionmode_link($optpage) {
    /* There will be something here, later. */
 }
 
+
+/**
+ * This function prints out an option page row.
+ */
+function print_optionpages_row($leftopt, $rightopt = false) {
+    global $color;
+
+    if ($rightopt) {
+        $rightopt_name = html_tag( 'td', '<a href="' . $rightopt['url'] . '">' . $rightopt['name'] . '</a>', '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', '&nbsp;', 'left', $color[4], 'valign="top" width="49%"' );
+        $rightopt_desc = html_tag( 'td', '&nbsp;', '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',
+                            '<a href="' . $leftopt['url'] . '">' . $leftopt['name'] . '</a>' ,
+                        'left', $color[9], 'valign="top" width="49%"' ) .
+                        html_tag( 'td',
+                            '&nbsp;' ,
+                        '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',
+                            '&nbsp;' ,
+                        '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 = '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. */
@@ -84,9 +141,9 @@ if (!isset($optmode)) {
     $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 = '';
@@ -95,46 +152,56 @@ $optpage_loader = '';
 
 /* 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_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');
 }
 
 /**********************************************************/
 /*** Second, load the option information for this page. ***/
 /**********************************************************/
 
-if ($optpage != SMOPT_PAGE_MAIN) {
+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']);
 }
@@ -143,39 +210,30 @@ if ($optpage != SMOPT_PAGE_MAIN) {
 /*** 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:
@@ -187,7 +245,8 @@ if ($optmode == SMOPT_MODE_SUBMIT)   {
         case SMOPT_PAGE_FOLDER:
             $save_hook_name = 'options_folder_save';
             break;
-        default: $save_hook_name = 'options_save';
+        default:
+            $save_hook_name = 'options_save';
             break;
     }
 
@@ -210,6 +269,16 @@ if ($optmode == SMOPT_MODE_SUBMIT) {
 /* 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' ) .
+                "<b>$optpage_title</b><br />\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.
@@ -219,14 +288,29 @@ if ($optpage == SMOPT_PAGE_MAIN) {
     /* First, display the results of a submission, if needed. */
     /**********************************************************/
     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()) {
+            echo "<font color=\"$color[2]\"><b>" . _("Error(s) happened while saving your options") . "</b></font><br />\n";
+            echo "<ul>\n";
+            foreach ($optpage_save_error as $error_message) {
+                echo '<li><small>' . $error_message . "</small></li>\n";
+            }
+            echo "</ul>\n";
+            echo '<b>' . _("Some of your preference changes are not applied.") . "</b><br />\n";
+        } else {
+            /* Display a message indicating a successful save. */
+            echo '<b>' . _("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) {
+            echo '<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>';
+            echo '<a href="../src/webmail.php?right_frame=options.php" target="' . $frame_top . '">' . _("Refresh Page") . '</a><br />';
         }
     }
     /******************************************/
@@ -254,7 +338,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
     );
 
@@ -270,7 +354,7 @@ if ($optpage == SMOPT_PAGE_MAIN) {
     $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
     );
 
@@ -283,7 +367,7 @@ 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) {
             $js_optpage_blocks[] = $cur_optpage;
@@ -295,9 +379,12 @@ if ($optpage == SMOPT_PAGE_MAIN) {
     /* 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\">";
+    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;
@@ -311,7 +398,7 @@ if ($optpage == SMOPT_PAGE_MAIN) {
         print_optionpages_row($first_optpage);
     }
 
-    echo "</TABLE></TD></TR></TABLE>\n";
+    echo "</td></tr></table></td></tr></table>\n";
 
     do_hook('options_link_and_description');
 
@@ -320,17 +407,16 @@ if ($optpage == SMOPT_PAGE_MAIN) {
 /* 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"
+    echo addForm('options.php', 'POST', 'f')
        . create_optpage_element($optpage)
-       . create_optmode_element(SMOPT_MODE_SUBMIT);
+       . 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']);
 
-    /*** 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:
@@ -345,12 +431,12 @@ if ($optpage == SMOPT_PAGE_MAIN) {
             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:
@@ -366,89 +452,21 @@ if ($optpage == SMOPT_PAGE_MAIN) {
 
     /* If it is not empty, trigger the inside hook. */
     if ($inside_hook_name != '') {
-        do_hook($inside_hook_name);    
+        do_hook($inside_hook_name);
     }
 
     /* Spit out a submit button. */
     OptionSubmit($submit_name);
-    echo '</TABLE></FORM>';
+    echo '</td></tr></table></form>';
 
     /* If it is not empty, trigger the bottom hook. */
     if ($bottom_hook_name != '') {
-        do_hook($bottom_hook_name);    
+        do_hook($bottom_hook_name);
     }
 }
-
 ?>
-    </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]\">&nbsp;</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%\">&nbsp;</TD>";
-        }
-
-        echo          '</TR>' .
-                      '<TR>' .
-                         "<TD VALIGN=top BGCOLOR=\"$color[0]\" WIDTH=\"50%\">" .
-                            $leftopt['desc'] .
-                         '</TD>' .
-                         "<TD VALIGN=top BGCOLOR=\"$color[4]\">&nbsp;</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%\">&nbsp;</TD>";
-        }
-        
-        echo          '</TR>' .
-                   '</TABLE>' .
-                '</TD></TR>' .
-             "</TABLE>\n";
-    }
-
-?>
\ No newline at end of file
+</td></tr>
+</table>
+</td></tr>
+</table>
+</body></html>
\ No newline at end of file