Source for file options.php

Documentation is available at options.php

  1. <?php
  2.  
  3. /**
  4.  * options.php
  5.  *
  6.  * Functions needed to display the options pages.
  7.  *
  8.  * @copyright 1999-2017 The SquirrelMail Project Team
  9.  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  10.  * @version $Id: options.php 14657 2017-06-03 16:29:26Z pdontthink $
  11.  * @package squirrelmail
  12.  * @subpackage prefs
  13.  */
  14.  
  15. /**********************************************/
  16. /* Define constants used in the options code. */
  17. /**********************************************/
  18.  
  19. /* Define constants for the various option types. */
  20. define('SMOPT_TYPE_STRING'0);
  21. define('SMOPT_TYPE_STRLIST'1);
  22. define('SMOPT_TYPE_TEXTAREA'2);
  23. define('SMOPT_TYPE_INTEGER'3);
  24. define('SMOPT_TYPE_FLOAT'4);
  25. define('SMOPT_TYPE_BOOLEAN'5);
  26. define('SMOPT_TYPE_HIDDEN'6);
  27. define('SMOPT_TYPE_COMMENT'7);
  28. define('SMOPT_TYPE_FLDRLIST'8);
  29. define('SMOPT_TYPE_FLDRLIST_MULTI'9);
  30. define('SMOPT_TYPE_EDIT_LIST'10);
  31. define('SMOPT_TYPE_EDIT_LIST_ASSOCIATIVE'11);
  32. define('SMOPT_TYPE_STRLIST_MULTI'12);
  33. define('SMOPT_TYPE_BOOLEAN_CHECKBOX'13);
  34. define('SMOPT_TYPE_BOOLEAN_RADIO'14);
  35. define('SMOPT_TYPE_STRLIST_RADIO'15);
  36. define('SMOPT_TYPE_SUBMIT'16);
  37. define('SMOPT_TYPE_INFO'17);
  38. define('SMOPT_TYPE_PASSWORD'18);
  39.  
  40. /* Define constants for the layout scheme for edit lists. */
  41. define('SMOPT_EDIT_LIST_LAYOUT_LIST'0);
  42. define('SMOPT_EDIT_LIST_LAYOUT_SELECT'1);
  43.  
  44. /* Define constants for the options refresh levels. */
  45. define('SMOPT_REFRESH_NONE'0);
  46. define('SMOPT_REFRESH_FOLDERLIST'1);
  47. define('SMOPT_REFRESH_ALL'2);
  48.  
  49. /* Define constants for the options size. */
  50. define('SMOPT_SIZE_TINY'0);
  51. define('SMOPT_SIZE_SMALL'1);
  52. define('SMOPT_SIZE_MEDIUM'2);
  53. define('SMOPT_SIZE_LARGE'3);
  54. define('SMOPT_SIZE_HUGE'4);
  55. define('SMOPT_SIZE_NORMAL'5);
  56.  
  57. define('SMOPT_SAVE_DEFAULT''save_option');
  58. define('SMOPT_SAVE_NOOP''save_option_noop');
  59.  
  60. /**
  61.  * SquirrelOption: An option for Squirrelmail.
  62.  *
  63.  * This class is a work in progress. When complete, it will handle
  64.  * presentation and saving of Squirrelmail user options in a simple,
  65.  * streamline manner. Stay tuned for more stuff.
  66.  *
  67.  * Also, I'd like to ask that people leave this alone (mostly :) until
  68.  * I get it a little further along. That should only be a day or two or
  69.  * three. I will remove this message when it is ready for primetime usage.
  70.  * @package squirrelmail
  71.  */
  72. class SquirrelOption {
  73.     /* The basic stuff. */
  74.     var $raw_option_array;
  75.     var $name;
  76.     var $caption;
  77.     var $caption_wrap;
  78.     var $type;
  79.     var $refresh_level;
  80.     var $size;
  81.     var $layout_type;
  82.     var $comment;
  83.     var $script;
  84.     var $post_script;
  85.     var $trailing_text;
  86.     var $trailing_text_small;
  87.     var $yes_text;
  88.     var $no_text;
  89.     var $use_add_widget;
  90.     var $use_delete_widget;
  91.     var $poss_value_folders;
  92.  
  93.     /* The name of the Save Function for this option. */
  94.     var $save_function;
  95.  
  96.     /* The various 'values' for this options. */
  97.     var $value;
  98.     var $new_value;
  99.     var $possible_values;
  100.     var $htmlencoded=false;
  101.  
  102.     /**
  103.      * Constructor (PHP5 style, required in some future version of PHP)
  104.      */
  105.     function __construct
  106.     ($raw_option_array$name$caption$type$refresh_level$initial_value ''$possible_values ''$htmlencoded false{
  107.         /* Set the basic stuff. */
  108.         $this->raw_option_array = $raw_option_array;
  109.         $this->name = $name;
  110.         $this->caption = $caption;
  111.         $this->caption_wrap = TRUE;
  112.         $this->type = $type;
  113.         $this->refresh_level = $refresh_level;
  114.         $this->possible_values = $possible_values;
  115.         $this->htmlencoded = $htmlencoded;
  116. // FIXME: why isn't this set by default to NORMAL?
  117.         $this->size = SMOPT_SIZE_MEDIUM;
  118.         $this->layout_type = 0;
  119.         $this->comment = '';
  120.         $this->script = '';
  121.         $this->post_script = '';
  122.         $this->trailing_text = '';
  123.         $this->trailing_text_small = FALSE;
  124.         $this->yes_text = '';
  125.         $this->no_text = '';
  126.         $this->use_add_widget = TRUE;
  127.         $this->use_delete_widget = TRUE;
  128.         $this->poss_value_folders = '';
  129.  
  130.         /* Check for a current value. */
  131.         if (isset($GLOBALS[$name])) {
  132.             $this->value = $GLOBALS[$name];
  133.         else if (!empty($initial_value)) {
  134.             $this->value = $initial_value;
  135.         else {
  136.             $this->value = '';
  137.         }
  138.  
  139.         /* Check for a new value. */
  140.     if !sqgetGlobalVar("new_$name"$this->new_valueSQ_POST ) ) {
  141.             $this->new_value = NULL;
  142.         }
  143.  
  144.         /* Set the default save function. */
  145.         if ($type != SMOPT_TYPE_HIDDEN
  146.          && $type != SMOPT_TYPE_INFO
  147.          && $type != SMOPT_TYPE_COMMENT{
  148.             $this->save_function = SMOPT_SAVE_DEFAULT;
  149.         else {
  150.             $this->save_function = SMOPT_SAVE_NOOP;
  151.         }
  152.     }
  153.  
  154.     /**
  155.      * Constructor (PHP4 style, kept for compatibility reasons)
  156.      */
  157.     function SquirrelOption
  158.     ($raw_option_array$name$caption$type$refresh_level$initial_value ''$possible_values ''$htmlencoded false{
  159.         self::__construct($raw_option_array$name$caption$type$refresh_level$initial_value$possible_values$htmlencoded);
  160.     }
  161.  
  162.     /** Convenience function that identifies which types of
  163.         widgets are stored as (serialized) array values. */
  164.     function is_multiple_valued({
  165.         return ($this->type == SMOPT_TYPE_FLDRLIST_MULTI
  166.              || $this->type == SMOPT_TYPE_STRLIST_MULTI
  167.              || $this->type == SMOPT_TYPE_EDIT_LIST
  168.              || $this->type == SMOPT_TYPE_EDIT_LIST_ASSOCIATIVE);
  169.     }
  170.  
  171.     /* Set the value for this option. */
  172.     function setValue($value{
  173.         $this->value = $value;
  174.     }
  175.  
  176.     /* Set the new value for this option. */
  177.     function setNewValue($new_value{
  178.         $this->new_value = $new_value;
  179.     }
  180.  
  181.     /* Set whether the caption is allowed to wrap for this option. */
  182.     function setCaptionWrap($caption_wrap{
  183.         $this->caption_wrap = $caption_wrap;
  184.     }
  185.  
  186.     /* Set the size for this option. */
  187.     function setSize($size{
  188.         $this->size = $size;
  189.     }
  190.  
  191.     /* Set the trailing text for this option. */
  192.     function setTrailingText($trailing_text{
  193.         $this->trailing_text = $trailing_text;
  194.     }
  195.  
  196.     /* Set the trailing text for this option. */
  197.     function setTrailingTextSmall($trailing_text_small{
  198.         $this->trailing_text_small = $trailing_text_small;
  199.     }
  200.  
  201.     /* Set the yes text for this option. */
  202.     function setYesText($yes_text{
  203.         $this->yes_text = $yes_text;
  204.     }
  205.  
  206.     /* Set the no text for this option. */
  207.     function setNoText($no_text{
  208.         $this->no_text = $no_text;
  209.     }
  210.  
  211.     /* Set the "use add widget" value for this option. */
  212.     function setUseAddWidget($use_add_widget{
  213.         $this->use_add_widget = $use_add_widget;
  214.     }
  215.  
  216.     /* Set the "use delete widget" value for this option. */
  217.     function setUseDeleteWidget($use_delete_widget{
  218.         $this->use_delete_widget = $use_delete_widget;
  219.     }
  220.  
  221.     /* Set the "poss value folders" value for this option.
  222.        See the associative edit list widget, which uses this
  223.        to offer folder list selection for the values */
  224.     function setPossValueFolders($poss_value_folders{
  225.         $this->poss_value_folders = $poss_value_folders;
  226.     }
  227.  
  228.     /* Set the layout type for this option. */
  229.     function setLayoutType($layout_type{
  230.         $this->layout_type = $layout_type;
  231.     }
  232.  
  233.     /* Set the comment for this option. */
  234.     function setComment($comment{
  235.         $this->comment = $comment;
  236.     }
  237.  
  238.     /* Set the script for this option. */
  239.     function setScript($script{
  240.         $this->script = $script;
  241.     }
  242.  
  243.     /* Set the "post script" for this option. */
  244.     function setPostScript($post_script{
  245.         $this->post_script = $post_script;
  246.     }
  247.  
  248.     /* Set the save function for this option. */
  249.     function setSaveFunction($save_function{
  250.         $this->save_function = $save_function;
  251.     }
  252.  
  253.     function createHTMLWidget({
  254.         global $javascript_on$color;
  255.  
  256.         // Use new value if available
  257.         if (!is_null($this->new_value)) {
  258.             $tempValue $this->value;
  259.             $this->value = $this->new_value;
  260.         }
  261.  
  262.         /* Get the widget for this option type. */
  263.         switch ($this->type{
  264.             case SMOPT_TYPE_STRING:
  265.                 $result $this->createWidget_String();
  266.                 break;
  267.             case SMOPT_TYPE_PASSWORD:
  268.                 $result $this->createWidget_String(TRUE);
  269.                 break;
  270.             case SMOPT_TYPE_STRLIST:
  271.                 $result $this->createWidget_StrList();
  272.                 break;
  273.             case SMOPT_TYPE_TEXTAREA:
  274.                 $result $this->createWidget_TextArea();
  275.                 break;
  276.             case SMOPT_TYPE_INTEGER:
  277.                 $result $this->createWidget_Integer();
  278.                 break;
  279.             case SMOPT_TYPE_FLOAT:
  280.                 $result $this->createWidget_Float();
  281.                 break;
  282.             case SMOPT_TYPE_BOOLEAN:
  283.                 $result $this->createWidget_Boolean();
  284.                 break;
  285.             case SMOPT_TYPE_BOOLEAN_CHECKBOX:
  286.                 $result $this->createWidget_Boolean(TRUE);
  287.                 break;
  288.             case SMOPT_TYPE_BOOLEAN_RADIO:
  289.                 $result $this->createWidget_Boolean(FALSE);
  290.                 break;
  291.             case SMOPT_TYPE_HIDDEN:
  292.                 $result $this->createWidget_Hidden();
  293.                 break;
  294.             case SMOPT_TYPE_COMMENT:
  295.                 $result $this->createWidget_Comment();
  296.                 break;
  297.             case SMOPT_TYPE_FLDRLIST:
  298.                 $result $this->createWidget_FolderList();
  299.                 break;
  300.             case SMOPT_TYPE_FLDRLIST_MULTI:
  301.                 $result $this->createWidget_FolderList(TRUE);
  302.                 break;
  303.             case SMOPT_TYPE_EDIT_LIST:
  304.                 $result $this->createWidget_EditList();
  305.                 break;
  306.             case SMOPT_TYPE_EDIT_LIST_ASSOCIATIVE:
  307.                 $result $this->createWidget_EditListAssociative();
  308.                 break;
  309.             case SMOPT_TYPE_STRLIST_MULTI:
  310.                 $result $this->createWidget_StrList(TRUE);
  311.                 break;
  312.             case SMOPT_TYPE_STRLIST_RADIO:
  313.                 $result $this->createWidget_StrList(FALSETRUE);
  314.                 break;
  315.             case SMOPT_TYPE_SUBMIT:
  316.                 $result $this->createWidget_Submit();
  317.                 break;
  318.             case SMOPT_TYPE_INFO:
  319.                 $result $this->createWidget_Info();
  320.                 break;
  321.             default:
  322.                $result '<font color="' $color[2'">'
  323.                        . sprintf(_("Option Type '%s' Not Found")$this->type)
  324.                        . '</font>';
  325.         }
  326.  
  327.         /* Add the "post script" for this option. */
  328.         $result .= $this->post_script;
  329.  
  330.         // put correct value back if need be
  331.         if (!is_null($this->new_value)) {
  332.             $this->value = $tempValue;
  333.         }
  334.  
  335.         /* Now, return the created widget. */
  336.         return $result;
  337.     }
  338.  
  339.     function createWidget_Info({
  340.         // $result = sm_encode_html_special_chars($this->value) . "\n";
  341.         // like COMMENT, allow HTML here
  342.         $result $this->value . "\n";
  343.         return $result;
  344.     }
  345.  
  346.     /**
  347.      * Create text box
  348.      *
  349.      * @param boolean $password When TRUE, the text in the input
  350.      *                           widget will be obscured (OPTIONAL;
  351.      *                           default = FALSE).
  352.      *
  353.      * @return string html formated text input
  354.      *
  355.      */
  356.     function createWidget_String($password=FALSE{
  357.         switch ($this->size{
  358.             case SMOPT_SIZE_TINY:
  359.                 $width 5;
  360.                 break;
  361.             case SMOPT_SIZE_SMALL:
  362.                 $width 12;
  363.                 break;
  364.             case SMOPT_SIZE_LARGE:
  365.                 $width 38;
  366.                 break;
  367.             case SMOPT_SIZE_HUGE:
  368.                 $width 50;
  369.                 break;
  370.             case SMOPT_SIZE_NORMAL:
  371.             default:
  372.                 $width 25;
  373.         }
  374.  
  375.         $result "<input type=\"" 
  376.                 . ($password 'password' 'text'
  377.                 . "\" name=\"new_$this->name\" value=\""
  378.                 . sm_encode_html_special_chars($this->value)
  379.                 . "\" size=\"$width\" $this->script /> 
  380.                 . ($this->trailing_text_small ? '<small>' '')
  381.                 . sm_encode_html_special_chars($this->trailing_text)
  382.                 . ($this->trailing_text_small ? '</small>' '')
  383.                 . "\n";
  384.         return $result;
  385.     }
  386.  
  387.     /**
  388.      * Create selection box or radio group
  389.      *
  390.      * When $this->htmlencoded is TRUE, the keys and values in
  391.      * $this->possible_values are assumed to be display-safe.
  392.      * Use with care!
  393.      *
  394.      * Note that when building radio buttons instead of a select
  395.      * widget, if the "size" attribute is SMOPT_SIZE_TINY, the
  396.      * radio buttons will be output one after another without
  397.      * linebreaks between them.  Otherwise, each radio button
  398.      * goes on a line of its own.
  399.      *
  400.      * @param boolean $multiple_select When TRUE, the select widget
  401.      *                                  will allow multiple selections
  402.      *                                  (OPTIONAL; default is FALSE
  403.      *                                  (single select list))
  404.      * @param boolean $radio_buttons   When TRUE, the widget will
  405.      *                                  instead be built as a group
  406.      *                                  of radio buttons (and
  407.      *                                  $multiple_select will be
  408.      *                                  forced to FALSE) (OPTIONAL;
  409.      *                                  default is FALSE (select widget))
  410.      *
  411.      * @return string html formated selection box or radio buttons
  412.      *
  413.      */
  414.     function createWidget_StrList($multiple_select=FALSE$radio_buttons=FALSE{
  415.  
  416.         // radio buttons instead of select widget?
  417.         //
  418.         if ($radio_buttons{
  419.  
  420.             $result '';
  421.             foreach ($this->possible_values as $real_value => $disp_value{
  422.                 $result .= "\n" '<input type="radio" name="new_' $this->name 
  423.                          . '" id="new_' $this->name . '_' 
  424.                          . ($this->htmlencoded ? $real_value sm_encode_html_special_chars($real_value))
  425.                          . '" value="'
  426.                          . ($this->htmlencoded ? $real_value sm_encode_html_special_chars($real_value))
  427.                          . '"' ($real_value == $this->value ? ' checked="checked"' '')
  428.                          . ' /> <label for="new_' $this->name . '_'
  429.                          . ($this->htmlencoded ? $real_value sm_encode_html_special_chars($real_value))
  430.                          . '">'
  431.                          . ($this->htmlencoded ? $disp_value sm_encode_html_special_chars($disp_value))
  432.                          . '</label>';
  433.                 if ($this->size != SMOPT_SIZE_TINY)
  434.                     $result .= '<br />';
  435.             }
  436.  
  437.             return $result;
  438.         }
  439.  
  440.  
  441.         // everything below applies to select widgets
  442.         //
  443.         switch ($this->size{
  444. //FIXME: not sure about these sizes... seems like we could add another on the "large" side...
  445.             case SMOPT_SIZE_TINY:
  446.                 $height 3;
  447.                 break;
  448.             case SMOPT_SIZE_SMALL:
  449.                 $height 8;
  450.                 break;
  451.             case SMOPT_SIZE_LARGE:
  452.                 $height 15;
  453.                 break;
  454.             case SMOPT_SIZE_HUGE:
  455.                 $height 25;
  456.                 break;
  457.             case SMOPT_SIZE_NORMAL:
  458.             default:
  459.                 $height 5;
  460.         }
  461.  
  462.         // multiple select lists should already have array values
  463.         if (is_array($this->value))
  464.             $selected $this->value;
  465.         else
  466.             $selected array(strtolower($this->value));
  467.  
  468.         /* Begin the select tag. */
  469.         $result '<select name="new_' $this->name
  470.             . ($multiple_select '[]" multiple="multiple" size="' $height '" ' '" ')
  471.             . $this->script . ">\n";
  472.  
  473.         /* Add each possible value to the select list. */
  474.         foreach ($this->possible_values as $real_value => $disp_value{
  475.             /* Start the next new option string. */
  476.             $new_option '<option value="' .
  477.                 ($this->htmlencoded ? $real_value sm_encode_html_special_chars($real_value)) '"';
  478.  
  479.             // multiple select lists have possibly more than one default selection
  480.             if ($multiple_select{
  481.                 foreach ($selected as $default{
  482.                     if ((string)$default == (string)$real_value{
  483.                         $new_option .= ' selected="selected"';
  484.                         break;
  485.                     }
  486.                 }
  487.             }
  488.  
  489.             /* If this value is the current value, select it. */
  490.             else if ($real_value == $this->value{
  491.                $new_option .= ' selected="selected"';
  492.             }
  493.  
  494.             /* Add the display value to our option string. */
  495.             $new_option .= '>' ($this->htmlencoded ? $disp_value sm_encode_html_special_chars($disp_value)) "</option>\n";
  496.             /* And add the new option string to our select tag. */
  497.             $result .= $new_option;
  498.         }
  499.  
  500.         /* Close the select tag and return our happy result. */
  501.         $result .= '</select> '
  502.                 . ($this->trailing_text_small ? '<small>' '')
  503.                 . sm_encode_html_special_chars($this->trailing_text)
  504.                 . ($this->trailing_text_small ? '</small>' '')
  505.                 . "\n";
  506.         return $result;
  507.     }
  508.  
  509.     /**
  510.      * Create folder selection box
  511.      *
  512.      * @param boolean $multiple_select When TRUE, the select widget
  513.      *                                  will allow multiple selections
  514.      *                                  (OPTIONAL; default is FALSE
  515.      *                                  (single select list))
  516.      *
  517.      * @return string html formated selection box
  518.      *
  519.      */
  520.     function createWidget_FolderList($multiple_select=FALSE{
  521.  
  522.         switch ($this->size{
  523. //FIXME: not sure about these sizes... seems like we could add another on the "large" side...
  524.             case SMOPT_SIZE_TINY:
  525.                 $height 3;
  526.                 break;
  527.             case SMOPT_SIZE_SMALL:
  528.                 $height 8;
  529.                 break;
  530.             case SMOPT_SIZE_LARGE:
  531.                 $height 15;
  532.                 break;
  533.             case SMOPT_SIZE_HUGE:
  534.                 $height 25;
  535.                 break;
  536.             case SMOPT_SIZE_NORMAL:
  537.             default:
  538.                 $height 5;
  539.         }
  540.  
  541.         // multiple select lists should already have array values
  542.         if (is_array($this->value))
  543.             $selected $this->value;
  544.         else
  545.             $selected array(strtolower($this->value));
  546.  
  547.         /* Begin the select tag. */
  548.         $result '<select name="new_' $this->name
  549.                 . ($multiple_select '[]" multiple="multiple" size="' $height '"' '"')
  550.                 . " $this->script>\n";
  551.  
  552.         /* Add each possible value to the select list. */
  553.         foreach ($this->possible_values as $real_value => $disp_value{
  554.  
  555.             if is_array($disp_value) ) {
  556.                 /* For folder list, we passed in the array of boxes.. */
  557.                 $selected_lowercase array();
  558.                 foreach ($selected as $i => $box
  559.                     $selected_lowercase[$istrtolower($box);
  560.                 $new_option sqimap_mailbox_option_list(0$selected_lowercase0$disp_value);
  561.  
  562.             else {
  563.                 /* Start the next new option string. */
  564.                 $new_option '<option value="' sm_encode_html_special_chars($real_value'"';
  565.  
  566.                 // multiple select lists have possibly more than one default selection
  567.                 if ($multiple_select{
  568.                     foreach ($selected as $default{
  569.                         if ((string)$default == (string)$real_value{
  570.                             $new_option .= ' selected="selected"';
  571.                             break;
  572.                         }
  573.                     }
  574.                 }
  575.  
  576.                 /* If this value is the current value, select it. */
  577.                 else if ($real_value == $this->value{
  578.                    $new_option .= ' selected="selected"';
  579.                 }
  580.  
  581.                 /* Add the display value to our option string. */
  582.                 $new_option .= '>' sm_encode_html_special_chars($disp_value"</option>\n";
  583.             }
  584.             /* And add the new option string to our select tag. */
  585.             $result .= $new_option;
  586.         }
  587.         /* Close the select tag and return our happy result. */
  588.         $result .= '</select> '
  589.                 . ($this->trailing_text_small ? '<small>' '')
  590.                 . sm_encode_html_special_chars($this->trailing_text)
  591.                 . ($this->trailing_text_small ? '</small>' '')
  592.                 . "\n";
  593.         return $result;
  594.     }
  595.  
  596.  
  597.     function createWidget_TextArea({
  598.         switch ($this->size{
  599.             case SMOPT_SIZE_TINY:  $rows 3$cols =  10break;
  600.             case SMOPT_SIZE_SMALL$rows 4$cols =  30break;
  601.             case SMOPT_SIZE_LARGE$rows 10$cols =  60break;
  602.             case SMOPT_SIZE_HUGE:  $rows 20$cols =  80break;
  603.             case SMOPT_SIZE_NORMAL:
  604.             default$rows 5$cols =  50;
  605.         }
  606.         $result "<textarea name=\"new_$this->name\" rows=\"$rows\" "
  607.                 . "cols=\"$cols\" $this->script>"
  608.                 . sm_encode_html_special_chars($this->value"</textarea>\n";
  609.         return ($result);
  610.     }
  611.  
  612.     function createWidget_Integer({
  613.  
  614.         global $javascript_on;
  615.  
  616.         // add onChange javascript handler to a regular string widget
  617.         // which will strip out all non-numeric chars
  618.         if ($javascript_on)
  619.            return preg_replace('/\/>/'' onChange="origVal=this.value; newVal=\'\'; '
  620.                     . 'for (i=0;i<origVal.length;i++) { if (origVal.charAt(i)>=\'0\' '
  621.                     . '&& origVal.charAt(i)<=\'9\') newVal += origVal.charAt(i); } '
  622.                     . 'this.value=newVal;" />'$this->createWidget_String());
  623.         else
  624.            return $this->createWidget_String();
  625.     }
  626.  
  627.     function createWidget_Float({
  628.  
  629.         global $javascript_on;
  630.  
  631.         // add onChange javascript handler to a regular string widget
  632.         // which will strip out all non-numeric (period also OK) chars
  633.         if ($javascript_on)
  634.            return preg_replace('/\/>/'' onChange="origVal=this.value; newVal=\'\'; '
  635.                     . 'for (i=0;i<origVal.length;i++) { if ((origVal.charAt(i)>=\'0\' '
  636.                     . '&& origVal.charAt(i)<=\'9\') || origVal.charAt(i)==\'.\') '
  637.                     . 'newVal += origVal.charAt(i); } this.value=newVal;" />'
  638.                 $this->createWidget_String());
  639.         else
  640.            return $this->createWidget_String();
  641.     }
  642.  
  643.     /**
  644.      * Create boolean widget
  645.      *
  646.      * When creating Yes/No radio buttons, the "yes_text"
  647.      * and "no_text" option attributes are used to override
  648.      * the typical "Yes" and "No" text.
  649.      *
  650.      * @param boolean $checkbox When TRUE, the widget will be
  651.      *                           constructed as a checkbox,
  652.      *                           otherwise it will be a set of
  653.      *                           Yes/No radio buttons (OPTIONAL;
  654.      *                           default is TRUE (checkbox)).
  655.      *
  656.      * @return string html formated boolean widget
  657.      *
  658.      */
  659.     function createWidget_Boolean($checkbox=TRUE{
  660.         /* Do the whole current value thing. */
  661.         if ($this->value != SMPREF_NO{
  662.             $yes_chk ' checked="checked"';
  663.             $no_chk '';
  664.         else {
  665.             $yes_chk '';
  666.             $no_chk ' checked="checked"';
  667.         }
  668.  
  669.         // checkbox...
  670.         //
  671.         if ($checkbox{
  672.             $result '<input type="checkbox" name="new_' $this->name
  673.                     . '" id="new_' $this->name . '" value="' SMPREF_YES
  674.                     . "\" $yes_chk $this->script . ' />&nbsp;'
  675.                     . '<label for="new_' $this->name . '">' 
  676.                     . ($this->trailing_text_small ? '<small>' '')
  677.                     . sm_encode_html_special_chars($this->trailing_text)
  678.                     . ($this->trailing_text_small ? '</small>' '')
  679.                     . '</label>';
  680.         }
  681.  
  682.         // radio buttons...
  683.         //
  684.         else {
  685.  
  686.             /* Build the yes choice. */
  687.             $yes_option '<input type="radio" name="new_' $this->name 
  688.                         . '" id="new_' $this->name . '_yes"'
  689.                         . ' value="' SMPREF_YES "\"$yes_chk $this->script />&nbsp;"
  690.                         . '<label for="new_' $this->name . '_yes">' (!empty($this->yes_textsm_encode_html_special_chars($this->yes_text_("Yes")) '</label>';
  691.  
  692.             /* Build the no choice. */
  693.             $no_option '<input type="radio" name="new_' $this->name
  694.                        . '" id="new_' $this->name . '_no"'
  695.                        . ' value="' SMPREF_NO "\"$no_chk $this->script />&nbsp;"
  696.                        . '<label for="new_' $this->name . '_no">' (!empty($this->no_textsm_encode_html_special_chars($this->no_text_("No")) '</label>';
  697.     
  698.             /* Build the combined "boolean widget". */
  699.             $result "$yes_option&nbsp;&nbsp;&nbsp;&nbsp;$no_option";
  700.  
  701.         }
  702.  
  703.         return ($result);
  704.     }
  705.  
  706.     function createWidget_Hidden({
  707.         $result '<input type="hidden" name="new_' $this->name
  708.                 . '" value="' sm_encode_html_special_chars($this->value)
  709.                 . '" ' $this->script . ' />';
  710.         return ($result);
  711.     }
  712.  
  713.     function createWidget_Comment({
  714.         $result $this->comment;
  715.         return ($result);
  716.     }
  717.  
  718.     /**
  719.      * Creates a (non-associative) edit list
  720.      *
  721.      * Note that multiple layout types are supported for this widget.
  722.      * $this->layout_type must be one of the SMOPT_EDIT_LIST_LAYOUT_*
  723.      * constants.
  724.      *
  725.      * @return string html formated list of edit fields and
  726.      *                 their associated controls
  727.      */
  728.     function createWidget_EditList({
  729.  
  730.         switch ($this->size{
  731.             case SMOPT_SIZE_TINY:
  732.                 $height 3;
  733.                 break;
  734.             case SMOPT_SIZE_SMALL:
  735.                 $height 8;
  736.                 break;
  737.             case SMOPT_SIZE_MEDIUM:
  738.                 $height 15;
  739.                 break;
  740.             case SMOPT_SIZE_LARGE:
  741.                 $height 25;
  742.                 break;
  743.             case SMOPT_SIZE_HUGE:
  744.                 $height 40;
  745.                 break;
  746.             case SMOPT_SIZE_NORMAL:
  747.             default:
  748.                 $height 5;
  749.         }
  750.  
  751.  
  752.         // ensure correct format of current value(s)
  753.         //
  754.         if (empty($this->possible_values)) $this->possible_values = array();
  755.         if (!is_array($this->possible_values)) $this->possible_values = array($this->possible_values);
  756.  
  757.  
  758.         global $javascript_on$color;
  759.  
  760.         switch ($this->layout_type{
  761.             case SMOPT_EDIT_LIST_LAYOUT_SELECT:
  762.                 $result '';
  763.                 if ($this->use_add_widget)
  764.                     $result .= _("Add"'&nbsp;<input name="add_' $this->name 
  765.                              . '" size="38" /><br />';
  766.                 $result .= '<select name="new_' $this->name
  767.                     . '[]" multiple="multiple" size="' $height '"'
  768.                     . ($javascript_on ' onchange="if (typeof(window.addinput_' $this->name . ') == \'undefined\') { var f = document.forms.length; var i = 0; var pos = -1; while( pos == -1 && i < f ) { var e = document.forms[i].elements.length; var j = 0; while( pos == -1 && j < e ) { if ( document.forms[i].elements[j].type == \'text\' && document.forms[i].elements[j].name == \'add_' $this->name . '\' ) { pos = j; i=f-1; j=e-1; } j++; } i++; } if( pos >= 0 ) { window.addinput_' $this->name . ' = document.forms[i-1].elements[pos]; } } for (x = 0; x < this.length; x++) { if (this.options[x].selected) { window.addinput_' $this->name . '.value = this.options[x].text; break; } }"' '')
  769. // NOTE: i=f-1; j=e-1 is in lieu of break 2
  770.                     . ' ' $this->script . ">\n";
  771.  
  772.  
  773.                 if (is_array($this->value))
  774.                     $selected $this->value;
  775.                 else
  776.                     $selected array($this->value);
  777.  
  778.  
  779.                 // Add each possible value to the select list.
  780.                 //
  781.                 foreach ($this->possible_values as $value{
  782.  
  783.                     // Start the next new option string.
  784.                     //
  785.                     $result .= '<option value="' sm_encode_html_special_chars($value'"';
  786.  
  787.                     // having a selected item in the edit list doesn't have
  788.                     // any meaning, but maybe someone will think of a way to
  789.                     // use it, so we might as well put the code in
  790.                     //
  791.                     foreach ($selected as $default{
  792.                         if ((string)$default == (string)$value{
  793.                             $result .= ' selected="selected"';
  794.                             break;
  795.                         }
  796.                     }
  797.  
  798.                     // Add the display value to our option string.
  799.                     //
  800.                     $result .= '>' sm_encode_html_special_chars($value"</option>\n";
  801.  
  802.                 }
  803.  
  804.                 $result .= '</select>';
  805.                 if (!empty($this->possible_values&& $this->use_delete_widget)
  806.                     $result .= '<br /><input type="checkbox" name="delete_' 
  807.                              . $this->name . '" id="delete_' $this->name 
  808.                              . '" value="1" />&nbsp;<label for="delete_'
  809.                              . $this->name . '">' _("Delete Selected")
  810.                              . '</label>';
  811.  
  812.                 break;
  813.  
  814.  
  815.  
  816.             case SMOPT_EDIT_LIST_LAYOUT_LIST:
  817.                 $result '<table width="80%" cellpadding="1" cellspacing="0" border="0" bgcolor="'
  818.                         . $color[0'"><tr><td>';
  819.                 if ($this->use_add_widget)
  820.                     $result .= _("Add"'&nbsp;<input name="add_' $this->name 
  821.                              . '" size="38" /><br />';
  822.                 $result .= '<table width="100%" cellpadding="1" cellspacing="0" border="0" bgcolor="' $color[5'">';
  823.  
  824.                 $bgcolor 4;
  825.                 if (!isset($color[12]))
  826.                     $color[12'#EAEAEA';
  827.                 $index 0;
  828.  
  829.                 if (is_array($this->value))
  830.                     $selected $this->value;
  831.                 else
  832.                     $selected array($this->value);
  833.  
  834.                 foreach ($this->possible_values as $key => $value{
  835.  
  836.                     if ($bgcolor == 4$bgcolor 12;
  837.                     else $bgcolor 4;
  838.  
  839.                     $result .= '<tr bgcolor="' $color[$bgcolor'">'
  840.                              . '<td width="1%"><input type="checkbox" name="new_'
  841.                              . $this->name . '[' ($index++']" id="' $this->name
  842.                              . '_list_item_' $key '" value="'
  843.                              . sm_encode_html_special_chars($value);
  844.  
  845.                     // having a selected item in the edit list doesn't have
  846.                     // any meaning, but maybe someone will think of a way to
  847.                     // use it, so we might as well put the code in
  848.                     //
  849.                     foreach ($selected as $default{
  850.                         if ((string)$default == (string)$value{
  851.                             $result .= '" checked="checked';
  852.                             break;
  853.                         }
  854.                     }
  855.  
  856.                     $result .= '"></td>'
  857.                              . '<td><label for="' $this->name . '_list_item_' $key
  858.                              . '">' sm_encode_html_special_chars($value'</label></td>'
  859.                              . "</tr>\n";
  860.  
  861.                 }
  862.  
  863.                 $result .= '</table>';
  864.  
  865.                 if (!empty($this->possible_values&& $this->use_delete_widget)
  866.                     $result .= '<input type="checkbox" name="delete_' 
  867.                         . $this->name . '" id="delete_' $this->name 
  868.                         . '" value="1" />&nbsp;<label for="delete_' $this->name . '">'
  869.                         . _("Delete Selected"'</label>';
  870.  
  871.                 $result .= '</td></tr></table>';
  872.  
  873.                 break;
  874.  
  875.  
  876.             default:
  877.                 $result '<font color="' $color[2'">'
  878.                         . sprintf(_("Edit List Layout Type '%s' Not Found")$this->layout_type)
  879.                         . '</font>';
  880.         }
  881.  
  882.         return $result;
  883.  
  884.     }
  885.  
  886.     /**
  887.      * Creates an associative edit list
  888.      *
  889.      * Note that multiple layout types are supported for this widget.
  890.      * $this->layout_type must be one of the SMOPT_EDIT_LIST_LAYOUT_*
  891.      * constants.
  892.      *
  893.      * @return string html formated list of edit fields and
  894.      *                 their associated controls
  895.      */
  896.     function createWidget_EditListAssociative({
  897.  
  898.         switch ($this->size{
  899.             case SMOPT_SIZE_TINY:
  900.                 $height 3;
  901.                 break;
  902.             case SMOPT_SIZE_SMALL:
  903.                 $height 8;
  904.                 break;
  905.             case SMOPT_SIZE_MEDIUM:
  906.                 $height 15;
  907.                 break;
  908.             case SMOPT_SIZE_LARGE:
  909.                 $height 25;
  910.                 break;
  911.             case SMOPT_SIZE_HUGE:
  912.                 $height 40;
  913.                 break;
  914.             case SMOPT_SIZE_NORMAL:
  915.             default:
  916.                 $height 5;
  917.         }
  918.  
  919.  
  920.         // ensure correct format of current value(s)
  921.         //
  922.         if (empty($this->possible_values)) $this->possible_values = array();
  923.         if (!is_array($this->possible_values)) $this->possible_values = array($this->possible_values);
  924.  
  925.  
  926.         global $javascript_on$color;
  927.  
  928.         switch ($this->layout_type{
  929.             case SMOPT_EDIT_LIST_LAYOUT_SELECT:
  930.                 $result '';
  931.                 if ($this->use_add_widget{
  932. //FIXME implement poss_key_folders here? probably not worth the trouble, is there a use case?
  933.                     $result .= _("Add"'&nbsp;<input name="add_' $this->name 
  934.                              . '_key" size="22" /> ';
  935. // FIXME: shall we allow these "poss value folders" (folder list selection for edit list values) for NON-Associative EDIT_LIST widgets?
  936.                     if ($this->poss_value_folders{
  937.                         $result .= '<select name="add_' $this->name . '_value">';
  938.  
  939.                         /* Add each possible value to the select list. */
  940.                         foreach ($this->poss_value_folders as $real_value => $disp_value{
  941.  
  942.                             if is_array($disp_value) ) {
  943.                                 /* For folder list, we passed in the array of boxes.. */
  944.                                 $new_option sqimap_mailbox_option_list(000$disp_value);
  945.  
  946.                             else {
  947.                                 /* Start the next new option string. */
  948.                                 $new_option '<option value="' sm_encode_html_special_chars($real_value'"';
  949.  
  950.                                 /* Add the display value to our option string. */
  951.                                 $new_option .= '>' sm_encode_html_special_chars($disp_value"</option>\n";
  952.                             }
  953.                             /* And add the new option string to our select tag. */
  954.                             $result .= $new_option;
  955.                         }
  956.                         /* Close the select tag and return our happy result. */
  957.                         $result .= '</select>';
  958.                     }
  959.                     else
  960.                         $result .= '<input name="add_' $this->name
  961.                                  . '_value" size="12" /><br />';
  962.                 }
  963.                 $result .= '<select name="new_' $this->name
  964.                     . '[]" multiple="multiple" size="' $height '"'
  965. // FIXME: this can be fooled by having the delimiter " = " in a key value - in general, we may want to use a different delimiter other than " = "
  966.                     . ($javascript_on ' onchange="if (typeof(window.addinput_key_' $this->name . ') == \'undefined\') { var f = document.forms.length; var i = 0; var pos = -1; while( pos == -1 && i < f ) { var e = document.forms[i].elements.length; var j = 0; while( pos == -1 && j < e ) { if ( document.forms[i].elements[j].type == \'text\' && document.forms[i].elements[j].name == \'add_' $this->name . '_key\' ) { pos = j; j=e-1; i=f-1; } j++; } i++; } if( pos >= 0 ) { window.addinput_key_' $this->name . ' = document.forms[i-1].elements[pos]; } } if (typeof(window.addinput_value_' $this->name . ') == \'undefined\') { var f = document.forms.length; var i = 0; var pos = -1; while( pos == -1 && i < f ) { var e = document.forms[i].elements.length; var j = 0; while( pos == -1 && j < e ) { if ( document.forms[i].elements[j].type == \'text\' && document.forms[i].elements[j].name == \'add_' $this->name . '_value\' ) { pos = j; j=e-1; i=f-1; } j++; } i++; } if( pos >= 0 ) { window.addinput_value_' $this->name . ' = document.forms[i-1].elements[pos]; } } for (x = 0; x < this.length; x++) { if (this.options[x].selected) { pos = this.options[x].text.indexOf(\' = \'); if (pos > -1) { window.addinput_key_' $this->name . '.value = this.options[x].text.substr(0, pos); if (typeof(window.addinput_value_' $this->name . ') != \'undefined\') window.addinput_value_' $this->name . '.value = this.options[x].text.substr(pos + 3); } break; } }"' '')
  967. // NOTE: i=f-1; j=e-1 is in lieu of break 2
  968.                     . ' ' $this->script . ">\n";
  969.  
  970.  
  971.                 if (is_array($this->value))
  972.                     $selected $this->value;
  973.                 else
  974.                     $selected array($this->value);
  975.  
  976.  
  977.                 // Add each possible value to the select list.
  978.                 //
  979.                 foreach ($this->possible_values as $key => $value{
  980.  
  981.                     // Start the next new option string.
  982.                     //
  983.                     $result .= '<option value="' urlencode($key'"';
  984.  
  985.                     // having a selected item in the edit list doesn't have
  986.                     // any meaning, but maybe someone will think of a way to
  987.                     // use it, so we might as well put the code in
  988.                     //
  989.                     foreach ($selected as $default{
  990.                         if ((string)$default == (string)$key{
  991.                             $result .= ' selected="selected"';
  992.                             break;
  993.                         }
  994.                     }
  995.  
  996.                     // Add the display value to our option string.
  997.                     //
  998.                     $result .= '>' sm_encode_html_special_chars($key' = ';
  999.                     if ($this->poss_value_folders{
  1000.                         foreach ($this->poss_value_folders as $real_value => $disp_value{
  1001.                             if is_array($disp_value) ) {
  1002.                                 foreach ($disp_value as $folder_info{
  1003.                                     if ($value == $folder_info['unformatted']{
  1004.                                         $result .= sm_encode_html_special_chars(str_replace('&nbsp;'''$folder_info['formatted']));
  1005.                                         break 2;
  1006.                                     }
  1007.                                 }
  1008.                             }
  1009.                             else
  1010.                                 if ($value == $disp_value{
  1011.                                     $result .= sm_encode_html_special_chars($disp_value);
  1012.                                     break;
  1013.                                 }
  1014.                         }
  1015.                     }
  1016.                     else
  1017.                         $result .= sm_encode_html_special_chars($value);
  1018.                     $result .= "</option>\n";
  1019.  
  1020.                 }
  1021.  
  1022.                 $result .= '</select>';
  1023.                 if (!empty($this->possible_values&& $this->use_delete_widget)
  1024.                     $result .= '<br /><input type="checkbox" name="delete_' 
  1025.                              . $this->name . '" id="delete_' $this->name 
  1026.                              . '" value="1" />&nbsp;<label for="delete_'
  1027.                              . $this->name . '">' _("Delete Selected")
  1028.                              . '</label>';
  1029.  
  1030.                 break;
  1031.  
  1032.  
  1033.  
  1034.             case SMOPT_EDIT_LIST_LAYOUT_LIST:
  1035.                 $result '<table width="80%" cellpadding="1" cellspacing="0" border="0" bgcolor="'
  1036.                         . $color[0'"><tr><td>';
  1037.                 if ($this->use_add_widget{
  1038. //FIXME implement poss_key_folders here? probably not worth the trouble, is there a use case?
  1039.                     $result .= _("Add"'&nbsp;<input name="add_' $this->name 
  1040.                              . '_key" size="22" /> ';
  1041.                     if ($this->poss_value_folders{
  1042.                         $result .= '<select name="add_' $this->name . '_value">';
  1043.  
  1044.                         /* Add each possible value to the select list. */
  1045.                         foreach ($this->poss_value_folders as $real_value => $disp_value{
  1046.  
  1047.                             if is_array($disp_value) ) {
  1048.                                 /* For folder list, we passed in the array of boxes.. */
  1049.                                 $new_option sqimap_mailbox_option_list(000$disp_value);
  1050.  
  1051.                             else {
  1052.                                 /* Start the next new option string. */
  1053.                                 $new_option '<option value="' sm_encode_html_special_chars($real_value'"';
  1054.  
  1055.                                 /* Add the display value to our option string. */
  1056.                                 $new_option .= '>' sm_encode_html_special_chars($disp_value"</option>\n";
  1057.                             }
  1058.                             /* And add the new option string to our select tag. */
  1059.                             $result .= $new_option;
  1060.                         }
  1061.                         /* Close the select tag and return our happy result. */
  1062.                         $result .= '</select>';
  1063.                     }
  1064.                     else
  1065.                         $result .= '<input name="add_' $this->name
  1066.                                  . '_value" size="12" /><br />';
  1067.                 }
  1068.                 $result .= '<table width="100%" cellpadding="1" cellspacing="0" border="0" bgcolor="' $color[5'">';
  1069.  
  1070.                 $bgcolor 4;
  1071.                 if (!isset($color[12]))
  1072.                     $color[12'#EAEAEA';
  1073.  
  1074.                 if (is_array($this->value))
  1075.                     $selected $this->value;
  1076.                 else
  1077.                     $selected array($this->value);
  1078.  
  1079.                 foreach ($this->possible_values as $key => $value{
  1080.  
  1081.                     if ($bgcolor == 4$bgcolor 12;
  1082.                     else $bgcolor 4;
  1083.  
  1084.                     $result .= '<tr bgcolor="' $color[$bgcolor'">'
  1085.                              . '<td width="1%"><input type="checkbox" name="new_'
  1086.                              . $this->name . '[' urlencode($key']" id="'
  1087.                              . $this->name . '_list_item_' urlencode($key)
  1088.                              . '" value="' sm_encode_html_special_chars($value);
  1089.  
  1090.                     // having a selected item in the edit list doesn't have
  1091.                     // any meaning, but maybe someone will think of a way to
  1092.                     // use it, so we might as well put the code in
  1093.                     //
  1094.                     foreach ($selected as $default{
  1095.                         if ((string)$default == (string)$key{
  1096.                             $result .= '" checked="checked';
  1097.                             break;
  1098.                         }
  1099.                     }
  1100.  
  1101.                     $result .= '"></td>'
  1102.                              . '<td><label for="' $this->name . '_list_item_'
  1103.                              . urlencode($key'">'
  1104.                              . sm_encode_html_special_chars($key' = ';
  1105.                     if ($this->poss_value_folders{
  1106.                         foreach ($this->poss_value_folders as $real_value => $disp_value{
  1107.                             if is_array($disp_value) ) {
  1108.                                 foreach ($disp_value as $folder_info{
  1109.                                     if ($value == $folder_info['unformatted']{
  1110.                                         $result .= sm_encode_html_special_chars(str_replace('&nbsp;'''$folder_info['formatted']));
  1111.                                         break 2;
  1112.                                     }
  1113.                                 }
  1114.                             }
  1115.                             else
  1116.                                 if ($value == $disp_value{
  1117.                                     $result .= sm_encode_html_special_chars($disp_value);
  1118.                                     break;
  1119.                                 }
  1120.                         }
  1121.                     }
  1122.                     else
  1123.                         $result .= sm_encode_html_special_chars($value);
  1124.                     $result .= '</label></td>'
  1125.                              . "</tr>\n";
  1126.  
  1127.                 }
  1128.  
  1129.                 $result .= '</table>';
  1130.  
  1131.                 if (!empty($this->possible_values&& $this->use_delete_widget)
  1132.                     $result .= '<input type="checkbox" name="delete_' 
  1133.                         . $this->name . '" id="delete_' $this->name 
  1134.                         . '" value="1" />&nbsp;<label for="delete_' $this->name . '">'
  1135.                         . _("Delete Selected"'</label>';
  1136.  
  1137.                 $result .= '</td></tr></table>';
  1138.  
  1139.                 break;
  1140.  
  1141.  
  1142.             default:
  1143.                 $result '<font color="' $color[2'">'
  1144.                         . sprintf(_("Edit List Layout Type '%s' Not Found")$this->layout_type)
  1145.                         . '</font>';
  1146.         }
  1147.  
  1148.         return $result;
  1149.  
  1150.     }
  1151.  
  1152.     /**
  1153.      * Creates a submit button
  1154.      *
  1155.      * @return string html formated submit button widget
  1156.      *
  1157.      */
  1158.     function createWidget_Submit({
  1159.  
  1160.         $result "<input type=\"submit\" name=\"$this->name\" value=\""
  1161.                 . sm_encode_html_special_chars($this->comment)
  1162.                 . "\" $this->script /> "
  1163.                 . ($this->trailing_text_small ? '<small>' '')
  1164.                 . sm_encode_html_special_chars($this->trailing_text)
  1165.                 . ($this->trailing_text_small ? '</small>' '')
  1166.                 . "\n";
  1167.  
  1168.         return $result;
  1169.  
  1170.     }
  1171.  
  1172.     function save({
  1173.         $function $this->save_function;
  1174.         $function($this);
  1175.     }
  1176.  
  1177.     function changed({
  1178.  
  1179.         // edit lists have a lot going on, so we'll always process them
  1180.         //
  1181.         if ($this->type == SMOPT_TYPE_EDIT_LIST
  1182.          || $this->type == SMOPT_TYPE_EDIT_LIST_ASSOCIATIVE)
  1183.             return TRUE;
  1184.  
  1185.         return ($this->value != $this->new_value);
  1186.     }
  1187. }
  1188.  
  1189. function save_option($option{
  1190.  
  1191.     // Can't save the pref if we don't have the username
  1192.     //
  1193.     if !sqgetGlobalVar('username'$usernameSQ_SESSION ) ) {
  1194.         return;
  1195.     }
  1196.  
  1197.     // if the widget is a selection list, make sure the new
  1198.     // value is actually in the selection list and is not an
  1199.     // injection attack
  1200.     //
  1201.     if ($option->type == SMOPT_TYPE_STRLIST
  1202.      && !array_key_exists($option->new_value$option->possible_values))
  1203.         return;
  1204.  
  1205.  
  1206.     // all other widgets except TEXTAREAs should never be allowed to have newlines
  1207.     //
  1208.     else if ($option->type != SMOPT_TYPE_TEXTAREA)
  1209.         $option->new_value str_replace(array("\r""\n")''$option->new_value);
  1210.  
  1211.  
  1212.     global $data_dir;
  1213.  
  1214.     // edit lists: first add new elements to list, then
  1215.     // remove any selected ones (note that we must add
  1216.     // before deleting because the javascript that populates
  1217.     // the "add" textbox when selecting items in the list
  1218.     // (for deletion))
  1219.     //
  1220.     if ($option->type == SMOPT_TYPE_EDIT_LIST{
  1221.  
  1222.         if (empty($option->possible_values)) $option->possible_values array();
  1223.         if (!is_array($option->possible_values)) $option->possible_values array($option->possible_values);
  1224.  
  1225.         // add element if given
  1226.         //
  1227.         if ((isset($option->use_add_widget&& $option->use_add_widget)
  1228.          && sqGetGlobalVar('add_' $option->name$new_elementSQ_POST)) {
  1229.             $new_element trim($new_element);
  1230.             if (!empty($new_element)
  1231.              && !in_array($new_element$option->possible_values))
  1232.                 $option->possible_values[$new_element;
  1233.         }
  1234.  
  1235.         // delete selected elements if needed
  1236.         //
  1237.         if ((isset($option->use_delete_widget&& $option->use_delete_widget)
  1238.          && is_array($option->new_value)
  1239.          && sqGetGlobalVar('delete_' $option->name$ignoreSQ_POST))
  1240.             $option->possible_values array_diff($option->possible_values$option->new_value);
  1241.  
  1242.         // save full list (stored in "possible_values")
  1243.         //
  1244.         setPref($data_dir$username$option->nameserialize($option->possible_values));
  1245.  
  1246.     // associative edit lists are handled similar to
  1247.     // non-associative ones
  1248.     //
  1249.     else if ($option->type == SMOPT_TYPE_EDIT_LIST_ASSOCIATIVE{
  1250.  
  1251.         if (empty($option->possible_values)) $option->possible_values array();
  1252.         if (!is_array($option->possible_values)) $option->possible_values array($option->possible_values);
  1253.  
  1254.         // add element if given
  1255.         //
  1256.         $new_element_key '';
  1257.         $new_element_value '';
  1258.         $retrieve_key sqGetGlobalVar('add_' $option->name '_key'$new_element_keySQ_POST);
  1259.         $retrieve_value sqGetGlobalVar('add_' $option->name '_value'$new_element_valueSQ_POST);
  1260.  
  1261.         if ((isset($option->use_add_widget&& $option->use_add_widget)
  1262.          && ($retrieve_key || $retrieve_value)) {
  1263.             $new_element_key trim($new_element_key);
  1264.             $new_element_value trim($new_element_value);
  1265.             if ($option->poss_value_folders && empty($new_element_key))
  1266.                 $new_element_value '';
  1267.             if (!empty($new_element_key|| !empty($new_element_value)) {
  1268.                 if (empty($new_element_key)) $new_element_key '0';
  1269.                 $option->possible_values[$new_element_key$new_element_value;
  1270.             }
  1271.         }
  1272.  
  1273.         // delete selected elements if needed
  1274.         //
  1275.         if ((isset($option->use_delete_widget&& $option->use_delete_widget)
  1276.          && is_array($option->new_value)
  1277.          && sqGetGlobalVar('delete_' $option->name$ignoreSQ_POST)) {
  1278.  
  1279.             if ($option->layout_type == SMOPT_EDIT_LIST_LAYOUT_SELECT{
  1280.                 foreach ($option->new_value as $key)
  1281.                     unset($option->possible_values[urldecode($key)]);
  1282.             }
  1283.             else
  1284.                 $option->possible_values array_diff($option->possible_values$option->new_value);
  1285.         }
  1286.  
  1287.         // save full list (stored in "possible_values")
  1288.         //
  1289.         setPref($data_dir$username$option->nameserialize($option->possible_values));
  1290.  
  1291.     // Certain option types need to be serialized because
  1292.     // they are not scalar
  1293.     //
  1294.     else if ($option->is_multiple_valued())
  1295.         setPref($data_dir$username$option->nameserialize($option->new_value));
  1296.  
  1297.     // Checkboxes, when unchecked, don't submit anything in
  1298.     // the POST, so set to SMPREF_OFF if not found
  1299.     //
  1300.     else if (($option->type == SMOPT_TYPE_BOOLEAN
  1301.            || $option->type == SMOPT_TYPE_BOOLEAN_CHECKBOX)
  1302.           && empty($option->new_value)) 
  1303.         setPref($data_dir$username$option->nameSMPREF_OFF);
  1304.  
  1305.     // For integer fields, make sure we only have digits...
  1306.     // We'll be nice and instead of just converting to an integer,
  1307.     // we'll physically remove each non-digit in the string.
  1308.     //
  1309.     else if ($option->type == SMOPT_TYPE_INTEGER{
  1310.         $option->new_value preg_replace('/[^0-9]/'''$option->new_value);
  1311.         setPref($data_dir$username$option->name$option->new_value);
  1312.     }
  1313.  
  1314.     else
  1315.         setPref($data_dir$username$option->name$option->new_value);
  1316.  
  1317.  
  1318.     // if a checkbox or multi select is zeroed/cleared out, it
  1319.     // needs to have an empty value pushed into its "new_value" slot
  1320.     //
  1321.     if (($option->type == SMOPT_TYPE_STRLIST_MULTI
  1322.       || $option->type == SMOPT_TYPE_BOOLEAN_CHECKBOX)
  1323.      && is_null($option->new_value))
  1324.         $option->new_value '';
  1325.  
  1326. }
  1327.  
  1328. function save_option_noop($option{
  1329.     /* Do nothing here... */
  1330. }
  1331.  
  1332. function create_optpage_element($optpage{
  1333.     return create_hidden_element('optpage'$optpage);
  1334. }
  1335.  
  1336. function create_optmode_element($optmode{
  1337.     return create_hidden_element('optmode'$optmode);
  1338. }
  1339.  
  1340. function create_hidden_element($name$value{
  1341.     $result '<input type="hidden" '
  1342.             . 'name="' $name '" '
  1343.             . 'value="' sm_encode_html_special_chars($value'" />';
  1344.     return ($result);
  1345. }
  1346.  
  1347. function create_option_groups($optgrps$optvals{
  1348.     /* Build a simple array with which to start. */
  1349.     $result array();
  1350.  
  1351.     /* Create option group for each option group name. */
  1352.     foreach ($optgrps as $grpkey => $grpname{
  1353.         $result[$grpkeyarray();
  1354.         $result[$grpkey]['name'$grpname;
  1355.         $result[$grpkey]['options'array();
  1356.     }
  1357.  
  1358.      /* Create a new SquirrelOption for each set of option values. */
  1359.     foreach ($optvals as $grpkey => $grpopts{
  1360.         foreach ($grpopts as $optset{
  1361.             /* Create a new option with all values given. */
  1362.             $next_option new SquirrelOption(
  1363.                 $optset,
  1364.                 $optset['name'],
  1365.                 $optset['caption'],
  1366.                 $optset['type'],
  1367.                 (isset($optset['refresh']$optset['refresh'SMOPT_REFRESH_NONE),
  1368.                 (isset($optset['initial_value']$optset['initial_value'''),
  1369.                 (isset($optset['posvals']$optset['posvals'''),
  1370.                 (isset($optset['htmlencoded']$optset['htmlencoded'false)
  1371.                 );
  1372.  
  1373.             /* If provided, set if the caption is allowed to wrap for this option. */
  1374.             if (isset($optset['caption_wrap'])) {
  1375.                 $next_option->setCaptionWrap($optset['caption_wrap']);
  1376.             }
  1377.  
  1378.             /* If provided, set the size for this option. */
  1379.             if (isset($optset['size'])) {
  1380.                 $next_option->setSize($optset['size']);
  1381.             }
  1382.  
  1383.             /* If provided, set the trailing_text for this option. */
  1384.             if (isset($optset['trailing_text'])) {
  1385.                 $next_option->setTrailingText($optset['trailing_text']);
  1386.             }
  1387.  
  1388.             /* If provided, set whether the trailing_text should be rendered small for this option. */
  1389.             if (isset($optset['trailing_text_small'])) {
  1390.                 $next_option->setTrailingTextSmall($optset['trailing_text_small']);
  1391.             }
  1392.  
  1393.             /* If provided, set the yes_text for this option. */
  1394.             if (isset($optset['yes_text'])) {
  1395.                 $next_option->setYesText($optset['yes_text']);
  1396.             }
  1397.  
  1398.             /* If provided, set the no_text for this option. */
  1399.             if (isset($optset['no_text'])) {
  1400.                 $next_option->setNoText($optset['no_text']);
  1401.             }
  1402.  
  1403.             /* If provided, set the use_add_widget value for this option. */
  1404.             if (isset($optset['use_add_widget'])) {
  1405.                 $next_option->setUseAddWidget($optset['use_add_widget']);
  1406.             }
  1407.  
  1408.             /* If provided, set the use_delete_widget value for this option. */
  1409.             if (isset($optset['use_delete_widget'])) {
  1410.                 $next_option->setUseDeleteWidget($optset['use_delete_widget']);
  1411.             }
  1412.  
  1413.             /* If provided, set the poss_value_folders value for this option. */
  1414.             if (isset($optset['poss_value_folders'])) {
  1415.                 $next_option->setPossValueFolders($optset['poss_value_folders']);
  1416.             }
  1417.  
  1418.             /* If provided, set the layout type for this option. */
  1419.             if (isset($optset['layout_type'])) {
  1420.                 $next_option->setLayoutType($optset['layout_type']);
  1421.             }
  1422.  
  1423.             /* If provided, set the comment for this option. */
  1424.             if (isset($optset['comment'])) {
  1425.                 $next_option->setComment($optset['comment']);
  1426.             }
  1427.  
  1428.             /* If provided, set the save function for this option. */
  1429.             if (isset($optset['save'])) {
  1430.                 $next_option->setSaveFunction($optset['save']);
  1431.             }
  1432.  
  1433.             /* If provided, set the script for this option. */
  1434.             if (isset($optset['script'])) {
  1435.                 $next_option->setScript($optset['script']);
  1436.             }
  1437.  
  1438.             /* If provided, set the "post script" for this option. */
  1439.             if (isset($optset['post_script'])) {
  1440.                 $next_option->setPostScript($optset['post_script']);
  1441.             }
  1442.  
  1443.             /* Add this option to the option array. */
  1444.             $result[$grpkey]['options'][$next_option;
  1445.         }
  1446.     }
  1447.  
  1448.     /* Return our resulting array. */
  1449.     return ($result);
  1450. }
  1451.  
  1452. function print_option_groups($option_groups{
  1453.     /* Print each option group. */
  1454.     foreach ($option_groups as $next_optgrp{
  1455.         /* If it is not blank, print the name for this option group. */
  1456.         if ($next_optgrp['name'!= ''{
  1457.             echo html_tag'tr'"\n".
  1458.                         html_tag'td',
  1459.                             '<b>' $next_optgrp['name''</b>' ,
  1460.                         'center' ,'''valign="middle" colspan="2" nowrap' )
  1461.                     ."\n";
  1462.         }
  1463.  
  1464.         /* Print each option in this option group. */
  1465.         $hidden_options '';
  1466.         foreach ($next_optgrp['options'as $option{
  1467.             if ($option->type != SMOPT_TYPE_HIDDEN{
  1468.  
  1469.                 // although trailing_text will be a label for the checkbox,
  1470.                 // make the caption a label too - some widgets won't have
  1471.                 // trailing_text and having both as labels is perfectly fine
  1472.                 //
  1473.                 if ($option->type == SMOPT_TYPE_BOOLEAN_CHECKBOX
  1474.                  || $option->type == SMOPT_TYPE_BOOLEAN)
  1475.                     $option->caption '<label for="new_' $option->name '">'
  1476.                                      . $option->caption '</label>';
  1477.  
  1478.                 // text area trailing text just goes under the caption
  1479.                 //
  1480.                 if ($option->type == SMOPT_TYPE_TEXTAREA && !empty($option->trailing_text))
  1481. //TODO: I guess we should change this to obey trailing_text_small, but that would break existing plugins
  1482.                     $option->caption .= '<br /><small>' $option->trailing_text '</small>';
  1483.  
  1484.                 global $color;
  1485.                 //$info_bgcolor = 0;
  1486.                 $info_bgcolor 4;
  1487.                 $info_width 80;
  1488.                 if ($option->type == SMOPT_TYPE_INFO)
  1489.                     echo html_tag('tr'"\n" html_tag('td'"\n" html_tag('table'"\n" html_tag('tr'"\n" html_tag('td'"\n" $option->createHTMLWidget()))''$color[$info_bgcolor]'width="' $info_width '%"')'center' ,'''colspan="2" valign="middle"')) ."\n";
  1490.                 else
  1491.                     echo html_tag'tr'"\n".
  1492.                                html_tag'td'$option->caption (!empty($option->caption':' '')'right' ,'''valign="middle"' ($option->caption_wrap '' ' style="white-space:nowrap"') ) .
  1493.                                html_tag'td'$option->createHTMLWidget()'left' )
  1494.                            ."\n";
  1495.             else {
  1496.                 $hidden_options .= $option->createHTMLWidget();
  1497.             }
  1498.         }
  1499.  
  1500.         /* Print an empty row after this option group. */
  1501.         echo html_tag'tr',
  1502.                    html_tag'td''&nbsp;' $hidden_options'left''''colspan="2"' )
  1503.                 "\n";
  1504.     }
  1505. }
  1506.  
  1507. function OptionSubmit$name {
  1508.         echo html_tag'tr',
  1509.                    html_tag'td''<input type="submit" value="' _("Submit"'" name="' $name '" />&nbsp;&nbsp;&nbsp;&nbsp;''right''''colspan="2"' )
  1510.                 "\n";
  1511. }

Documentation generated on Sat, 24 Jun 2017 04:22:46 +0200 by phpDocumentor 1.4.3