Add phpdoc doc blocks to some files.
[squirrelmail.git] / functions / options.php
index 67c3c132ac378c7562aaf716aa5043fb693b4100..b516e45d81b113ae2fe17ef4b83b754ad2edfccf 100644 (file)
@@ -3,12 +3,13 @@
 /**
  * options.php
  *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Copyright (c) 1999-2003 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * Functions needed to display the options pages.
  *
  * $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);
@@ -61,6 +63,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 +74,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 +84,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($_POST["new_$name"])) {
-            $this->new_value = $_POST["new_$name"];
-        } else {
+       if ( !sqgetGlobalVar("new_$name", $this->new_value, SQ_POST ) ) {
             $this->new_value = '';
         }
 
@@ -129,6 +133,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 +172,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] . '">'
                        . sprintf(_("Option Type '%s' Not Found"), $this->type)
                        . '</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,13 +207,13 @@ class SquirrelOption {
                 $width = 25;
         }
 
-        $result = "<input name=\"new_$this->name\" value=\"$this->value\" size=\"$width\">";
+        $result = "<input name=\"new_$this->name\" value=\"$this->value\" size=\"$width\" $this->script>";
         return ($result);
     }
 
     function createWidget_StrList() {
         /* Begin the select tag. */
-        $result = "<select name=\"new_$this->name\">";
+        $result = "<select name=\"new_$this->name\" $this->script>";
 
         /* Add each possible value to the select list. */
         foreach ($this->possible_values as $real_value => $disp_value) {
@@ -225,6 +237,38 @@ class SquirrelOption {
         return ($result);
     }
 
+    function createWidget_FolderList() {
+        $selected = array(strtolower($this->value));
+
+        /* Begin the select tag. */
+        $result = "<select name=\"new_$this->name\" $this->script>";
+
+        /* 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=\"$real_value\"";
+  
+              /* If this value is the current value, select it. */
+              if ($real_value == $this->value) {
+                 $new_option .= ' selected';
+              }
+  
+              /* Add the display value to our option string. */
+              $new_option .= ">$disp_value</option>";
+            }
+            /* And add the new option string to our select tag. */
+            $result .= $new_option;
+        }        
+        /* Close the select tag and return our happy result. */
+        $result .= '</select>';
+        return ($result);
+    }
+
+
     function createWidget_TextArea() {
         switch ($this->size) {
             case SMOPT_SIZE_TINY:  $rows = 3; $cols =  10; break;
@@ -235,16 +279,39 @@ class SquirrelOption {
             default: $rows = 5; $cols =  50;
         }
         $result = "<textarea name=\"new_$this->name\" rows=\"$rows\" "
-                . "cols=\"$cols\">$this->value</textarea>";
+                . "cols=\"$cols\" $this->script>$this->value</textarea>";
         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() {
@@ -259,12 +326,12 @@ class SquirrelOption {
 
         /* Build the yes choice. */
         $yes_option = '<input type="radio" name="new_' . $this->name
-                    . '" value="' . SMPREF_YES . "\"$yes_chk>&nbsp;"
+                    . '" value="' . SMPREF_YES . "\"$yes_chk $this->script>&nbsp;"
                     . _("Yes");
 
         /* Build the no choice. */
         $no_option = '<input type="radio" name="new_' . $this->name
-                   . '" value="' . SMPREF_NO . "\"$no_chk>&nbsp;"
+                   . '" value="' . SMPREF_NO . "\"$no_chk $this->script>&nbsp;"
                    . _("No");
 
         /* Build and return the combined "boolean widget". */
@@ -274,7 +341,7 @@ class SquirrelOption {
 
     function createWidget_Hidden() {
         $result = '<input type="hidden" name="new_' . $this->name
-                . '" value="' . $this->value . '">';
+                . '" value="' . $this->value . '" ' . $this->script . '>';
         return ($result);
     }
 
@@ -294,12 +361,11 @@ class SquirrelOption {
 }
 
 function save_option($option) {
-    if ( (float)substr(PHP_VERSION,0,3) < 4.1 ) {
-        global $_SESSION;
+    if ( !sqgetGlobalVar('username', $username, SQ_SESSION ) ) {
+        /* Can't save the pref if we don't have the username */
+        return;
     }
     global $data_dir;
-    $username = $_SESSION['username'];
-
     setPref($data_dir, $username, $option->name, $option->new_value);
 }
 
@@ -343,6 +409,7 @@ function create_option_groups($optgrps, $optvals) {
                     $optset['caption'],
                     $optset['type'],
                     $optset['refresh'],
+                    (isset($optset['initial_value']) ? $optset['initial_value'] : ''),
                     $optset['posvals']
                 );
             } else {
@@ -351,7 +418,8 @@ function create_option_groups($optgrps, $optvals) {
                     $optset['name'],
                     $optset['caption'],
                     $optset['type'],
-                    $optset['refresh']
+                    $optset['refresh'],
+                    (isset($optset['initial_value']) ? $optset['initial_value'] : '')
                 );
             }
 
@@ -375,6 +443,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;
         }