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

Documentation generated on Fri, 02 Dec 2016 04:27:45 +0100 by phpDocumentor 1.4.3