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

Documentation generated on Mon, 21 Aug 2017 04:26:36 +0200 by phpDocumentor 1.4.3