Oops, text inputs never had a type attribute!
[squirrelmail.git] / functions / options.php
index 0137114c74023db4f98de46ff78893bb7a46e2aa..3a3ed2ee247ea300606aa1ef97f9de6bb6ef9819 100644 (file)
@@ -3,12 +3,13 @@
 /**
  * options.php
  *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Copyright (c) 1999-2004 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * Functions needed to display the options pages.
  *
- * $Id$
+ * @version $Id$
+ * @package squirrelmail
  */
 
 /**********************************************/
@@ -24,6 +25,7 @@ define('SMOPT_TYPE_FLOAT', 4);
 define('SMOPT_TYPE_BOOLEAN', 5);
 define('SMOPT_TYPE_HIDDEN', 6);
 define('SMOPT_TYPE_COMMENT', 7);
+define('SMOPT_TYPE_FLDRLIST', 8);
 
 /* Define constants for the options refresh levels. */
 define('SMOPT_REFRESH_NONE', 0);
@@ -51,6 +53,7 @@ define('SMOPT_SAVE_NOOP', 'save_option_noop');
  * Also, I'd like to ask that people leave this alone (mostly :) until
  * I get it a little further along. That should only be a day or two or
  * three. I will remove this message when it is ready for primetime usage.
+ * @package squirrelmail
  */
 class SquirrelOption {
     /* The basic stuff. */
@@ -61,6 +64,7 @@ class SquirrelOption {
     var $size;
     var $comment;
     var $script;
+    var $post_script;
 
     /* The name of the Save Function for this option. */
     var $save_function;
@@ -71,7 +75,7 @@ class SquirrelOption {
     var $possible_values;
 
     function SquirrelOption
-    ($name, $caption, $type, $refresh_level, $possible_values = '') {
+    ($name, $caption, $type, $refresh_level, $initial_value = '', $possible_values = '') {
         /* Set the basic stuff. */
         $this->name = $name;
         $this->caption = $caption;
@@ -81,18 +85,19 @@ class SquirrelOption {
         $this->size = SMOPT_SIZE_MEDIUM;
         $this->comment = '';
         $this->script = '';
+        $this->post_script = '';
 
         /* Check for a current value. */
-        if (isset($GLOBALS[$name])) {
+        if (!empty($initial_value)) {
+            $this->value = $initial_value;
+        } else if (isset($GLOBALS[$name])) {
             $this->value = $GLOBALS[$name];
         } else {
             $this->value = '';
         }
 
         /* Check for a new value. */
-        if (isset($GLOBALS["new_$name"])) {
-            $this->new_value = $GLOBALS["new_$name"];
-        } else {
+    if ( !sqgetGlobalVar("new_$name", $this->new_value, SQ_POST ) ) {
             $this->new_value = '';
         }
 
@@ -129,6 +134,11 @@ class SquirrelOption {
         $this->script = $script;
     }
 
+    /* Set the "post script" for this option. */
+    function setPostScript($post_script) {
+        $this->post_script = $post_script;
+    }
+
     /* Set the save function for this option. */
     function setSaveFunction($save_function) {
         $this->save_function = $save_function;
@@ -163,15 +173,18 @@ class SquirrelOption {
             case SMOPT_TYPE_COMMENT:
                 $result = $this->createWidget_Comment();
                 break;
+            case SMOPT_TYPE_FLDRLIST:
+                $result = $this->createWidget_FolderList();
+                break;
             default:
-               $result = '<FONT COLOR="' . $color[2] . '">'
+               $result = '<font color="' . $color[2] . '">'
                        . sprintf(_("Option Type '%s' Not Found"), $this->type)
-                       . '</FONT>';
+                       . '</font>';
         }
 
-        /* Add the script for this option. */
-        $result .= $this->script;
-
+        /* Add the "post script" for this option. */
+        $result .= $this->post_script;
+        
         /* Now, return the created widget. */
         return ($result);
     }
@@ -195,36 +208,71 @@ class SquirrelOption {
                 $width = 25;
         }
 
-        $result = "<INPUT NAME=\"new_$this->name\" VALUE=\"$this->value\" SIZE=\"$width\">";
+        $result = "<input type=\"text\" name=\"new_$this->name\" value=\"" .
+            htmlspecialchars($this->value) . 
+            "\" size=\"$width\" $this->script />\n";
         return ($result);
     }
 
     function createWidget_StrList() {
         /* Begin the select tag. */
-        $result = "<SELECT NAME=\"new_$this->name\">";
+        $result = "<select name=\"new_$this->name\" $this->script>\n";
 
         /* Add each possible value to the select list. */
         foreach ($this->possible_values as $real_value => $disp_value) {
             /* Start the next new option string. */
-            $new_option = "<OPTION VALUE=\"$real_value\"";
+            $new_option = '<option value="' . 
+                htmlspecialchars($real_value) . '"';
 
             /* If this value is the current value, select it. */
             if ($real_value == $this->value) {
-               $new_option .= ' SELECTED';
+               $new_option .= ' selected="selected"';
             }
 
             /* Add the display value to our option string. */
-            $new_option .= ">$disp_value</OPTION>";
+            $new_option .= '>' . htmlspecialchars($disp_value) . "</option>\n";
 
             /* And add the new option string to our select tag. */
             $result .= $new_option;
         }
 
         /* Close the select tag and return our happy result. */
-        $result .= '</SELECT>';
+        $result .= "</select>\n";
+        return ($result);
+    }
+
+    function createWidget_FolderList() {
+        $selected = array(strtolower($this->value));
+
+        /* Begin the select tag. */
+        $result = "<select name=\"new_$this->name\" $this->script>\n";
+
+        /* Add each possible value to the select list. */
+        foreach ($this->possible_values as $real_value => $disp_value) {
+            if ( is_array($disp_value) ) { 
+              /* For folder list, we passed in the array of boxes.. */
+              $new_option = sqimap_mailbox_option_list(0, $selected, 0, $disp_value);
+            } else {
+              /* Start the next new option string. */
+              $new_option = '<option value="' . htmlspecialchars($real_value) . '"';
+  
+              /* If this value is the current value, select it. */
+              if ($real_value == $this->value) {
+                 $new_option .= ' selected="selected"';
+              }
+  
+              /* Add the display value to our option string. */
+              $new_option .= '>' . htmlspecialchars($disp_value) . "</option>\n";
+            }
+            /* And add the new option string to our select tag. */
+            $result .= $new_option;
+        }        
+        /* Close the select tag and return our happy result. */
+        $result .= "</select>\n";
         return ($result);
     }
 
+
     function createWidget_TextArea() {
         switch ($this->size) {
             case SMOPT_SIZE_TINY:  $rows = 3; $cols =  10; break;
@@ -234,38 +282,64 @@ class SquirrelOption {
             case SMOPT_SIZE_NORMAL:
             default: $rows = 5; $cols =  50;
         }
-        $result = "<TEXTAREA NAME=\"new_$this->name\" ROWS=\"$rows\" "
-                . "COLS=\"$cols\">$this->value</TEXTAREA>";
+        $result = "<textarea name=\"new_$this->name\" rows=\"$rows\" "
+                . "cols=\"$cols\" $this->script>"
+                . htmlspecialchars($this->value) . "</textarea>\n";
         return ($result);
     }
 
     function createWidget_Integer() {
-        return ($this->createWidget_String());
+
+        global $javascript_on;
+
+        // add onChange javascript handler to a regular string widget
+        // which will strip out all non-numeric chars
+        if ($javascript_on)
+           return preg_replace('/\/>/', ' onChange="origVal=this.value; newVal=\'\'; '
+                    . 'for (i=0;i<origVal.length;i++) { if (origVal.charAt(i)>=\'0\' '
+                    . '&& origVal.charAt(i)<=\'9\') newVal += origVal.charAt(i); } '
+                    . 'this.value=newVal;" />', $this->createWidget_String());
+        else
+           return $this->createWidget_String();
     }
 
     function createWidget_Float() {
-        return ($this->createWidget_String());
+        
+        global $javascript_on;
+
+        // add onChange javascript handler to a regular string widget
+        // which will strip out all non-numeric (period also OK) chars 
+        if ($javascript_on)
+           return preg_replace('/\/>/', ' onChange="origVal=this.value; newVal=\'\'; '
+                    . 'for (i=0;i<origVal.length;i++) { if ((origVal.charAt(i)>=\'0\' '
+                    . '&& origVal.charAt(i)<=\'9\') || origVal.charAt(i)==\'.\') '
+                    . 'newVal += origVal.charAt(i); } this.value=newVal;" />'
+                , $this->createWidget_String());
+        else
+           return $this->createWidget_String();
     }
 
     function createWidget_Boolean() {
         /* Do the whole current value thing. */
         if ($this->value != SMPREF_NO) {
-            $yes_chk = ' CHECKED';
+            $yes_chk = ' checked=""';
             $no_chk = '';
         } else {
             $yes_chk = '';
-            $no_chk = ' CHECKED';
+            $no_chk = ' checked=""';
         }
 
         /* Build the yes choice. */
-        $yes_option = '<INPUT TYPE="RADIO" NAME="new_' . $this->name
-                    . '" VALUE="' . SMPREF_YES . "\"$yes_chk>&nbsp;"
-                    . _("Yes");
+        $yes_option = '<input type="radio" id="new_' . $this->name . '_yes" '
+                    . 'name="new_' . $this->name . '" value="' . SMPREF_YES . '"'
+                    . $yes_chk . ' ' . $this->script . ' />&nbsp;'
+                    . '<label for="new_'.$this->name.'_yes">' . _("Yes") . '</label>';
 
         /* Build the no choice. */
-        $no_option = '<INPUT TYPE="RADIO" NAME="new_' . $this->name
-                   . '" VALUE="' . SMPREF_NO . "\"$no_chk>&nbsp;"
-                   . _("No");
+        $no_option = '<input type="radio" id="new_' . $this->name . '_no" '
+                   . 'name="new_' . $this->name . '" value="' . SMPREF_NO . '"'
+                   . $no_chk . ' ' . $this->script . ' />&nbsp;'
+                    . '<label for="new_'.$this->name.'_no">' . _("No") . '</label>';
 
         /* Build and return the combined "boolean widget". */
         $result = "$yes_option&nbsp;&nbsp;&nbsp;&nbsp;$no_option";
@@ -273,8 +347,9 @@ class SquirrelOption {
     }
 
     function createWidget_Hidden() {
-        $result = '<INPUT TYPE="HIDDEN" NAME="new_' . $this->name
-                . '" VALUE="' . $this->value . '">';
+        $result = '<input type="hidden" name="new_' . $this->name
+                . '" value="' . htmlspecialchars($this->value)
+                . '" ' . $this->script . ' />';
         return ($result);
     }
 
@@ -289,16 +364,17 @@ class SquirrelOption {
     }
 
     function changed() {
-        return ($this->value !== $this->new_value);
+        return ($this->value != $this->new_value);
     }
 }
 
 function save_option($option) {
-    global $data_dir, $username;
+    if ( !sqgetGlobalVar('username', $username, SQ_SESSION ) ) {
+        /* Can't save the pref if we don't have the username */
+        return;
+    }
+    global $data_dir;
     setPref($data_dir, $username, $option->name, $option->new_value);
-
-    /* I do not know if this next line does any good. */
-    $GLOBALS[$option->name] = $option->new_value;
 }
 
 function save_option_noop($option) {
@@ -314,9 +390,9 @@ function create_optmode_element($optmode) {
 }
 
 function create_hidden_element($name, $value) {
-    $result = '<INPUT TYPE="HIDDEN" '
-            . 'NAME="' . $name . '" '
-            . 'VALUE="' . $value . '">';
+    $result = '<input type="hidden" '
+            . 'name="' . $name . '" '
+            . 'value="' . htmlspecialchars($value) . '" />';
     return ($result);
 }
 
@@ -340,7 +416,8 @@ function create_option_groups($optgrps, $optvals) {
                     $optset['name'],
                     $optset['caption'],
                     $optset['type'],
-                    $optset['refresh'],
+                    (isset($optset['refresh']) ? $optset['refresh'] : SMOPT_REFRESH_NONE),
+                    (isset($optset['initial_value']) ? $optset['initial_value'] : ''),
                     $optset['posvals']
                 );
             } else {
@@ -349,7 +426,8 @@ function create_option_groups($optgrps, $optvals) {
                     $optset['name'],
                     $optset['caption'],
                     $optset['type'],
-                    $optset['refresh']
+                    (isset($optset['refresh']) ? $optset['refresh'] : SMOPT_REFRESH_NONE),
+                    (isset($optset['initial_value']) ? $optset['initial_value'] : '')
                 );
             }
 
@@ -373,6 +451,11 @@ function create_option_groups($optgrps, $optvals) {
                 $next_option->setScript($optset['script']);
             }
 
+            /* If provided, set the "post script" for this option. */
+            if (isset($optset['post_script'])) {
+                $next_option->setPostScript($optset['post_script']);
+            }
+
             /* Add this option to the option array. */
             $result[$grpkey]['options'][] = $next_option;
         }
@@ -387,32 +470,37 @@ function print_option_groups($option_groups) {
     foreach ($option_groups as $next_optgrp) {
         /* If it is not blank, print the name for this option group. */
         if ($next_optgrp['name'] != '') {
-            echo '<TR><TD ALIGN=CENTER VALIGN=MIDDLE COLSPAN=2 NOWRAP><B>'
-               .   $next_optgrp['name']
-               . "</B></TD></TR>\n";
+            echo html_tag( 'tr', "\n".
+                        html_tag( 'td',
+                            '<b>' . $next_optgrp['name'] . '</b>' ,
+                        'center' ,'', 'valign="middle" colspan="2" nowrap' )
+                    ) ."\n";
         }
 
         /* Print each option in this option group. */
         foreach ($next_optgrp['options'] as $option) {
             if ($option->type != SMOPT_TYPE_HIDDEN) {
-                echo "<TR>\n";
-                echo '  <TD ALIGN="RIGHT" VALIGN="MIDDLE">'
-                   . $option->caption . ":</TD>\n";
-                echo '  <TD>' . $option->createHTMLWidget() . "</TD>\n";
-                echo "</TR>\n";
+                echo html_tag( 'tr', "\n".
+                           html_tag( 'td', $option->caption . ':', 'right' ,'', 'valign="middle"' ) .
+                           html_tag( 'td', $option->createHTMLWidget(), 'left' )
+                       ) ."\n";
             } else {
                 echo $option->createHTMLWidget();
             }
         }
 
         /* Print an empty row after this option group. */
-        echo "<TR><TD COLSPAN=\"2\">&nbsp;</TD></TR>\n";
+        echo html_tag( 'tr',
+                   html_tag( 'td', '&nbsp;', 'left', '', 'colspan="2"' )
+                ) . "\n";
     }
 }
 
 function OptionSubmit( $name ) {
-    echo '<tr><td>&nbsp;</td><td><input type="submit" value="' . _("Submit") . '" name="' . $name . '">' .
-         '</td></tr>';
+        echo html_tag( 'tr',
+                   html_tag( 'td', '<input type="submit" value="' . _("Submit") . '" name="' . $name . '">&nbsp;&nbsp;&nbsp;&nbsp;', 'right', '', 'colspan="2"' )
+                ) . "\n";
 }
 
+// vim: et ts=4
 ?>