Typo
[squirrelmail.git] / src / options.php
index 0058c3b1e0a066ca340c5d09a172e55d6c8e3ad8..480dde5ce0d2c3d01fd177205b991eb7d870e344 100644 (file)
@@ -3,30 +3,25 @@
 /**
  * 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-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.
- * @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');
 
 /*********************************/
@@ -49,9 +44,20 @@ 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', "
@@ -74,57 +80,10 @@ 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', '<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);
@@ -191,7 +150,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 +159,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,9 +167,8 @@ 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']);
 }
 
 /***********************************************************/
@@ -249,6 +207,9 @@ 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;
@@ -258,7 +219,7 @@ if ($optmode == SMOPT_MODE_SUBMIT) {
     }
 
     /* Run the options save hook. */
-    do_hook($save_hook_name);
+    do_hook($save_hook_name, $null);
 }
 
 /***************************************************************/
@@ -276,15 +237,7 @@ 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";
+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,32 +247,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';
         }
 
         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";
+//FIXME: REMOVE HTML FROM CORE
+            $notice = _("Error(s) occurred while saving your options") . "<br />\n<ul>\n";
             foreach ($optpage_save_error as $error_message) {
-                echo '<li><small>' . $error_message . "</small></li>\n";
+                $notice.= '<li><small>' . $error_message . "</small></li>\n";
             }
-            echo "</ul>\n";
-            echo '<b>' . _("Some of your preference changes are not applied.") . "</b><br />\n";
+            $notice.= "</ul>\n" . _("Some of your preference changes were not applied.") . "\n";
         } else {
             /* Display a message indicating a successful save. */
-            echo '<b>' . _("Successfully Saved Options") . ": $optpage_name</b><br />\n";
+            $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) {
-            echo '<a href="../src/left_main.php" target="left">' . _("Refresh Folder List") . '</a><br />';
+//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."), '<a href="../src/left_main.php" target="left">', '</a>') . '<br /><script type="text/javascript">' . "\n<!--\nparent.left.location = '../src/left_main.php';\n// -->\n</script>\n";
+            } else {
+                $notice .= '<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="' . $frame_top . '">' . _("Refresh Page") . '</a><br />';
+            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."), '<a href="../src/webmail.php?right_frame=options.php" target="' . $frame_top . '">', '</a>') . '<br /><script type="text/javascript">' . "\n<!--\nparent.location = '../src/webmail.php?right_frame=options.php';\n// -->\n</script>\n";
+            } else {
+                $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. */
     /******************************************/
@@ -364,7 +333,7 @@ if ($optpage == SMOPT_PAGE_MAIN) {
         '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"),
@@ -374,7 +343,7 @@ if ($optpage == SMOPT_PAGE_MAIN) {
     );
 
     /* 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. */
@@ -384,7 +353,7 @@ if ($optpage == SMOPT_PAGE_MAIN) {
     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) {
+        } else if (checkForJavascript()) {
             $js_optpage_blocks[] = $cur_optpage;
         }
     }
@@ -393,43 +362,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);
-    }
+    $oTemplate->assign('page_title', $optpage_title);
+    $oTemplate->assign('options', $optpage_blocks);
 
-    echo "</td></tr></table></td></tr></table>\n";
-
-    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. */
     switch ($optpage) {
         case SMOPT_PAGE_PERSONAL:
@@ -442,6 +386,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';
@@ -463,23 +412,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 "<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']);
+    
+    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 "  </td>\n" .
+         " </tr>\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 '</table></form>';
+//FIXME: need to remove HTML from here!
+    echo "</table>\n" .
+         "</form>\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);
     }
+    
 }
-?>
-</td></tr>
-</table>
-</td></tr>
-</table>
-</body></html>
+
+$oTemplate->display('footer.tpl');