X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Foptions.php;h=421fe5572921a3e8b1a68803d5353968d77bcd7d;hb=bf9e5efb35d382a8e022955e690d0c19c916c6eb;hp=e5eeefffcb5f65bd37bce5867373bd82005e84ca;hpb=a3ec3c9131807abe5f36603441b0a642661882bc;p=squirrelmail.git diff --git a/functions/options.php b/functions/options.php index e5eeefff..421fe557 100644 --- a/functions/options.php +++ b/functions/options.php @@ -1,14 +1,16 @@ name = $name; $this->caption = $caption; $this->type = $type; $this->refresh_level = $refresh_level; $this->possible_values = $possible_values; + $this->htmlencoded = $htmlencoded; + $this->size = SMOPT_SIZE_MEDIUM; + $this->trailing_text = ''; + $this->comment = ''; + $this->script = ''; + $this->post_script = ''; /* Check for a current value. */ - if (isset($GLOBALS[$name])) { + if (!empty($initial_value)) { + $this->value = $initial_value; + } else if (isset($GLOBALS[$name])) { $this->value = $GLOBALS[$name]; } else { $this->value = ''; } /* Check for a new value. */ - if (isset($GLOBALS["new_$name"])) { - $this->new_value = $GLOBALS["new_$name"]; - $this->changed = ($this->value !== $this->new_value); - } else { + if ( !sqgetGlobalVar("new_$name", $this->new_value, SQ_POST ) ) { $this->new_value = ''; - $this->changed = false; } + + /* Set the default save function. */ + if (($type != SMOPT_TYPE_HIDDEN) && ($type != SMOPT_TYPE_COMMENT)) { + $this->save_function = SMOPT_SAVE_DEFAULT; + } else { + $this->save_function = SMOPT_SAVE_NOOP; + } + } + + /** + * Set the value for this option. + * @param mixed $value + */ + function setValue($value) { + $this->value = $value; + } + + /** + * Set the new value for this option. + * @param mixed $new_value + */ + function setNewValue($new_value) { + $this->new_value = $new_value; + } + + /** + * Set the size for this option. + * @param integer $size + */ + function setSize($size) { + $this->size = $size; + } + + /** + * Set the trailing_text for this option. + * @param string $trailing_text + */ + function setTrailingText($trailing_text) { + $this->trailing_text = $trailing_text; + } + + /** + * Set the comment for this option. + * @param string $comment + */ + function setComment($comment) { + $this->comment = $comment; + } + + /** + * Set the script for this option. + * @param string $script + */ + function setScript($script) { + $this->script = $script; + } + + /** + * Set the "post script" for this option. + * @param string $post_script + */ + function setPostScript($post_script) { + $this->post_script = $post_script; + } + + /** + * Set the save function for this option. + * @param string $save_function + */ + function setSaveFunction($save_function) { + $this->save_function = $save_function; } + /** + * Creates fields on option pages according to option type + * + * Function that calls other createWidget* functions. + * @return string html formated option field + */ function createHTMLWidget() { + global $color; + + // Use new value if available + if (!empty($this->new_value)) { + $tempValue = $this->value; + $this->value = $this->new_value; + } + + /* Get the widget for this option type. */ switch ($this->type) { case SMOPT_TYPE_STRING: $result = $this->createWidget_String(); @@ -105,177 +292,415 @@ class SquirrelOption { case SMOPT_TYPE_HIDDEN: $result = $this->createWidget_Hidden(); break; + case SMOPT_TYPE_COMMENT: + $result = $this->createWidget_Comment(); + break; + case SMOPT_TYPE_FLDRLIST: + $result = $this->createWidget_FolderList(); + break; default: - $result = '' + $result = '' . sprintf(_("Option Type '%s' Not Found"), $this->type) - . ''; + . ''; + } + + /* Add the "post script" for this option. */ + $result .= $this->post_script; + + // put correct value back if need be + if (!empty($this->new_value)) { + $this->value = $tempValue; } /* Now, return the created widget. */ return ($result); } + /** + * Create string field + * @return string html formated option field + */ function createWidget_String() { - $result = "name\" value=\"$this->value\" size=\"5\">"; + switch ($this->size) { + case SMOPT_SIZE_TINY: + $width = 5; + break; + case SMOPT_SIZE_SMALL: + $width = 12; + break; + case SMOPT_SIZE_LARGE: + $width = 38; + break; + case SMOPT_SIZE_HUGE: + $width = 50; + break; + case SMOPT_SIZE_NORMAL: + default: + $width = 25; + } + + $result = "name\" value=\"" . + htmlspecialchars($this->value) . + "\" size=\"$width\" $this->script />$this->trailing_text\n"; return ($result); } + /** + * Create selection box + * @return string html formated selection box + */ function createWidget_StrList() { /* Begin the select tag. */ - $result = "name\" $this->script>\n"; /* Add each possible value to the select list. */ foreach ($this->possible_values as $real_value => $disp_value) { /* Start the next new option string. */ - $new_option = ""; + $new_option .= '>' . ($this->htmlencoded ? $disp_value : htmlspecialchars($disp_value)) . "\n"; /* And add the new option string to our select tag. */ $result .= $new_option; } /* Close the select tag and return our happy result. */ - $result .= ''; + $result .= "$this->trailing_text\n"; return ($result); } + /** + * Create folder selection box + * @return string html formated selection box + */ + function createWidget_FolderList() { + $selected = array(strtolower($this->value)); + + /* Begin the select tag. */ + $result = "\n"; + return ($result); + } + + /** + * Creates textarea + * @return string html formated textarea field + */ function createWidget_TextArea() { + switch ($this->size) { + case SMOPT_SIZE_TINY: $rows = 3; $cols = 10; break; + case SMOPT_SIZE_SMALL: $rows = 4; $cols = 30; break; + case SMOPT_SIZE_LARGE: $rows = 10; $cols = 60; break; + case SMOPT_SIZE_HUGE: $rows = 20; $cols = 80; break; + case SMOPT_SIZE_NORMAL: + default: $rows = 5; $cols = 50; + } + $result = "\n"; + return ($result); } + /** + * Creates field for integer + * + * Difference from createWidget_String is visible only when javascript is enabled + * @return string html formated option field + */ function createWidget_Integer() { - return ($this->createWidget_String()); + global $javascript_on; + + // add onChange javascript handler to a regular string widget + // which will strip out all non-numeric chars + if ($javascript_on) + return preg_replace('/\/>/', ' onChange="origVal=this.value; newVal=\'\'; ' + . 'for (i=0;i=\'0\' ' + . '&& origVal.charAt(i)<=\'9\') newVal += origVal.charAt(i); } ' + . 'this.value=newVal;" />', $this->createWidget_String()); + else + return $this->createWidget_String(); } + /** + * Creates field for floating number + * Difference from createWidget_String is visible only when javascript is enabled + * @return string html formated option field + */ function createWidget_Float() { - return ($this->createWidget_String()); + global $javascript_on; + + // add onChange javascript handler to a regular string widget + // which will strip out all non-numeric (period also OK) chars + if ($javascript_on) + return preg_replace('/\/>/', ' onChange="origVal=this.value; newVal=\'\'; ' + . 'for (i=0;i=\'0\' ' + . '&& origVal.charAt(i)<=\'9\') || origVal.charAt(i)==\'.\') ' + . 'newVal += origVal.charAt(i); } this.value=newVal;" />' + , $this->createWidget_String()); + else + return $this->createWidget_String(); } + /** + * Creates radio field (yes/no) + * @return string html formated radio field + */ function createWidget_Boolean() { + /* Do the whole current value thing. */ + if ($this->value != SMPREF_NO) { + $yes_chk = ' checked="checked"'; + $no_chk = ''; + } else { + $yes_chk = ''; + $no_chk = ' checked="checked"'; + } + + /* Build the yes choice. */ + $yes_option = 'script . ' /> ' + . ''; + + /* Build the no choice. */ + $no_option = 'script . ' /> ' + . ''; + + /* Build and return the combined "boolean widget". */ + $result = "$yes_option    $no_option"; + return ($result); } + /** + * Creates hidden field + * @return string html formated hidden input field + */ function createWidget_Hidden() { - $result = ''; + $result = 'script . ' />'; return ($result); } - function hasChanged() { - return ($this->changed); + /** + * Creates comment + * @return string comment + */ + function createWidget_Comment() { + $result = $this->comment; + return ($result); } + + /** + * + */ + function save() { + $function = $this->save_function; + $function($this); + } + + /** + * + */ + function changed() { + return ($this->value != $this->new_value); + } +} /* End of SquirrelOption class*/ + +/** + * Saves option + * @param object $option object that holds option name and new_value + */ +function save_option($option) { + if ( !sqgetGlobalVar('username', $username, SQ_SESSION ) ) { + /* Can't save the pref if we don't have the username */ + return; + } + global $data_dir; + setPref($data_dir, $username, $option->name, $option->new_value); +} + +/** + * save function that does not save + * @param object $option + */ +function save_option_noop($option) { + /* Do nothing here... */ +} + +/** + * Create hidden 'optpage' input field with value set by argument + * @param string $optpage identification of option page + * @return string html formated hidden input field + */ +function create_optpage_element($optpage) { + return create_hidden_element('optpage', $optpage); } -function createOptionArray($optvals) { +/** + * Create hidden 'optmode' input field with value set by argument + * @param string $optmode + * @return string html formated hidden input field + */ +function create_optmode_element($optmode) { + return create_hidden_element('optmode', $optmode); +} + +/** + * Create hidden field. + * @param string $name field name + * @param string $value field value + * @return string html formated hidden input field + */ +function create_hidden_element($name, $value) { + $result = ''; + return ($result); +} + +/** + * @param array $optgrps + * @param array $optvals + * @return array + */ +function create_option_groups($optgrps, $optvals) { /* Build a simple array with which to start. */ $result = array(); + /* Create option group for each option group name. */ + foreach ($optgrps as $grpkey => $grpname) { + $result[$grpkey] = array(); + $result[$grpkey]['name'] = $grpname; + $result[$grpkey]['options'] = array(); + } + /* Create a new SquirrelOption for each set of option values. */ - foreach ($optvals as $optset) { - if (isset($optset['posvals'])) { + foreach ($optvals as $grpkey => $grpopts) { + foreach ($grpopts as $optset) { /* Create a new option with all values given. */ - $result[] = new SquirrelOption( - $optset['name'], - $optset['caption'], - $optset['type'], - $optset['refresh'], - $optset['posvals'] + $next_option = new SquirrelOption( + $optset['name'], + $optset['caption'], + $optset['type'], + (isset($optset['refresh']) ? $optset['refresh'] : SMOPT_REFRESH_NONE), + (isset($optset['initial_value']) ? $optset['initial_value'] : ''), + (isset($optset['posvals']) ? $optset['posvals'] : ''), + (isset($optset['htmlencoded']) ? $optset['htmlencoded'] : false) ); - } else { - /* Create a new option with all but possible values given. */ - $result[] = new SquirrelOption( - $optset['name'], - $optset['caption'], - $optset['type'], - $optset['refresh'] - ); - } - } - /* Return our resulting array. */ - return ($result); -} + /* If provided, set the size for this option. */ + if (isset($optset['size'])) { + $next_option->setSize($optset['size']); + } -function OptionSelect( $title, $name, $data, $default, $show = '', $store = '' ) { + /* If provided, set the trailing_text for this option. */ + if (isset($optset['trailing_text'])) { + $next_option->setTrailingText($optset['trailing_text']); + } - echo "$title: " . - "\n"; -} -function OptionRadio( $title, $name, $data, $default, $show = '', $store = '', $sep = '   ' ) { - echo "$title: "; - foreach( $data as $key => $opt ) { - if ( $store == '' ) { - $vl = $key; - } else{ - $vl = $opt[$store]; - } - if ( $show == '' ) { - $nm = $opt; - } else{ - $nm = $opt[$show]; - } - if ( $nm <> '') { - echo "setSaveFunction($optset['save']); + } + + /* If provided, set the script for this option. */ + if (isset($optset['script'])) { + $next_option->setScript($optset['script']); } - echo ">$nm $sep\n"; + + /* If provided, set the "post script" for this option. */ + if (isset($optset['post_script'])) { + $next_option->setPostScript($optset['post_script']); + } + + /* Add this option to the option array. */ + $result[$grpkey]['options'][] = $next_option; } } - echo "\n"; -} -function OptionText( $title, $name, $value, $size ) { - echo "$title: " . - "" . - "\n"; + /* Return our resulting array. */ + return ($result); } -function OptionHidden( $name, $value ) { - echo "\n"; -} +/** + * @param array $option_groups + */ +function print_option_groups($option_groups) { + /* Print each option group. */ + foreach ($option_groups as $next_optgrp) { + /* If it is not blank, print the name for this option group. */ + if ($next_optgrp['name'] != '') { + echo html_tag( 'tr', "\n". + html_tag( 'td', + '' . $next_optgrp['name'] . '' , + 'center' ,'', 'valign="middle" colspan="2" style="white-space: nowrap;"' ) + ) ."\n"; + } -function OptionCheck( $title, $name, $value, $comment ) { - if ( $value ) - $chk = 'checked'; - echo "$title: " . - " $comment" . - "\n"; -} + /* Print each option in this option group. */ + foreach ($next_optgrp['options'] as $option) { + if ($option->type != SMOPT_TYPE_HIDDEN) { + echo html_tag( 'tr', "\n". + html_tag( 'td', $option->caption . ':', 'right' ,'', 'valign="middle"' ) . + html_tag( 'td', $option->createHTMLWidget(), 'left' ) + ) ."\n"; + } else { + echo $option->createHTMLWidget(); + } + } -function OptionTitle( $title ) { - echo "$title\n"; + /* Print an empty row after this option group. */ + echo html_tag( 'tr', + html_tag( 'td', ' ', 'left', '', 'colspan="2"' ) + ) . "\n"; + } } +/** + * Create submit button inside table row. + * @param string $name + */ function OptionSubmit( $name ) { - echo ' ' . - ''; + echo html_tag( 'tr', + html_tag( 'td', '    ', 'right', '', 'colspan="2"' ) + ) . "\n"; } -?> +// vim: et ts=4 +?> \ No newline at end of file