Just remove 'inside' hooks, which make no sense in templated output and were long...
[squirrelmail.git] / src / options.php
index a3dece042ab440fcc712982566d1f02308be1a1c..c59579774cfaed5f4b38ceba10d184f31430b412 100644 (file)
@@ -6,13 +6,16 @@
  * Displays the options page. Pulls from proper user preference files
  * and config.php. Displays preferences as selected and other options.
  *
- * @copyright © 1999-2006 The SquirrelMail Project Team
+ * @copyright © 1999-2007 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');
+
 /**
  * Include the SquirrelMail initialization file.
  */
@@ -44,13 +47,25 @@ 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 "<br />";
             */
             if ($option->changed()) {
@@ -226,7 +241,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'] : ''));
+displayPageHeader($color, null, (isset($optpage_data['xtra']) ? $optpage_data['xtra'] : ''));
 
 /*
  * The main option page has a different layout then the rest of the option
@@ -243,6 +258,7 @@ if ($optpage == SMOPT_PAGE_MAIN) {
         }
 
         if (isset($optpage_save_error) && $optpage_save_error!=array()) {
+//FIXME: REMOVE HTML FROM CORE
             $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";
@@ -256,9 +272,19 @@ if ($optpage == SMOPT_PAGE_MAIN) {
         /* 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 />';
+//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) {
-            $notice .= '<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 />';
+            }
         }
     }
     
@@ -331,7 +357,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;
         }
     }
@@ -352,40 +378,33 @@ if ($optpage == SMOPT_PAGE_MAIN) {
 /* If we are not looking at the main option page, display the page here. */
 /*************************************************************************/
 } else {
-    /* 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_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';
     }
@@ -395,46 +414,31 @@ if ($optpage == SMOPT_PAGE_MAIN) {
        . 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 now.
-     */
-/*
+    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);
-*/
-    /**
-     * END comment block
-     */    
+    $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');
 
-//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, $null);
-    }
-
-//FIXME: need to remove HTML from here!
-    echo "</table>\n" .
-         "</form>\n";
+    $oTemplate->display('form_close.tpl');
 
     /* If it is not empty, trigger the bottom hook. */
     if ($bottom_hook_name != '') {
@@ -444,4 +448,3 @@ if ($optpage == SMOPT_PAGE_MAIN) {
 }
 
 $oTemplate->display('footer.tpl');
-?>