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

Documentation generated on Mon, 16 Jan 2017 04:29:43 +0100 by phpDocumentor 1.4.3