X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Foptions.php;h=7b60af67ea5b414d51ad394437ac07a85b677bf0;hb=991c88e71dc934df78cc7db33bceac29e0343c98;hp=e1de4e73880e08eae49b8a5d153fd80c897e152f;hpb=e697b6cc39af08f80d3ee3743c9d4088791af634;p=squirrelmail.git diff --git a/functions/options.php b/functions/options.php index e1de4e73..7b60af67 100644 --- a/functions/options.php +++ b/functions/options.php @@ -1,15 +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. */ + //Check for a current value. if (isset($GLOBALS[$name])) { $this->value = $GLOBALS[$name]; + } else if (!empty($initial_value)) { + $this->value = $initial_value; } else { $this->value = ''; } /* Check for a new value. */ - if (isset($GLOBALS["new_$name"])) { - $this->new_value = $GLOBALS["new_$name"]; - } else { + if ( !sqgetGlobalVar("new_$name", $this->new_value, SQ_POST ) ) { $this->new_value = ''; } /* Set the default save function. */ - if ((type != SMOPT_TYPE_HIDDEN) && ($type != SMOPT_TYPE_COMMENT)) { + 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. */ + /** + * Set the value for this option. + * @param mixed $value + */ function setValue($value) { $this->value = $value; } - /* Set the new value for this option. */ + /** + * 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. */ + /** + * Set the size for this option. + * @param integer $size + */ function setSize($size) { $this->size = $size; } - /* Set the comment for this option. */ + /** + * 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. */ + /** + * Set the script for this option. + * @param string $script + */ function setScript($script) { $this->script = $script; } - /* Set the save function for this option. */ + /** + * 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; } + /** + * Set the trailing_text for this option. + * @param string $folder_filter + * @since 1.5.1 + */ + function setFolderFilter($folder_filter) { + $this->folder_filter = $folder_filter; + } + + /** + * Creates fields on option pages according to option type + * + * Function that calls other createWidget* functions. + * @return string html formated option field + */ function createHTMLWidget() { - global $javascript_on; + 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) { @@ -162,59 +311,136 @@ class SquirrelOption { 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 script for this option. */ - $result .= $this->script; + /* 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() { 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_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; + default: + $width = 25; } - $result = "name\" VALUE=\"$this->value\" SIZE=\"$width\">"; + $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)); + + /* set initial value */ + $result = ''; + + /* Add each possible value to the select list. */ + foreach ($this->possible_values as $real_value => $disp_value) { + if ( is_array($disp_value) ) { + /* For folder list, we passed in the array of boxes.. */ + $new_option = sqimap_mailbox_option_list(0, $selected, 0, $disp_value, $this->folder_filter); + } else { + /* Start the next new option string. */ + $new_option = '\n"; + } + /* And add the new option string to our select tag. */ + $result .= $new_option; + } + + + if (empty($result)) { + // string is displayed when interface can't build folder selection box + return _("unavailable"); + } else { + /* Begin the select tag. */ + $ret = "\n"; + return ($ret); + } + } + + /** + * Creates textarea + * @return string html formated textarea field + */ function createWidget_TextArea() { switch ($this->size) { case SMOPT_SIZE_TINY: $rows = 3; $cols = 10; break; @@ -224,97 +450,176 @@ class SquirrelOption { case SMOPT_SIZE_NORMAL: default: $rows = 5; $cols = 50; } - $result = ""; + $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'; + $yes_chk = ' checked="checked"'; $no_chk = ''; } else { $yes_chk = ''; - $no_chk = ' CHECKED'; + $no_chk = ' checked="checked"'; } /* Build the yes choice. */ - $yes_option = ' " - . _("Yes"); + $yes_option = 'script . ' /> ' + . ''; /* Build the no choice. */ - $no_option = ' " - . _("No"); + $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); } + /** + * 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); + 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) { - global $data_dir, $username; + 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); - - /* I do not know if this next line does any good. */ - $GLOBALS[$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); } +/** + * 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 = ''; + $result = ''; return ($result); } - -function createOptionGroups($optgrps, $optvals) { - return create_option_groups($optgrps, $optvals); -} - +/** + * @param array $optgrps + * @param array $optvals + * @return array + */ function create_option_groups($optgrps, $optvals) { /* Build a simple array with which to start. */ $result = array(); @@ -329,30 +634,27 @@ function create_option_groups($optgrps, $optvals) { /* Create a new SquirrelOption for each set of option values. */ foreach ($optvals as $grpkey => $grpopts) { foreach ($grpopts as $optset) { - if (isset($optset['posvals'])) { - /* Create a new option with all values given. */ - $next_option = new SquirrelOption( + /* Create a new option with all values given. */ + $next_option = new SquirrelOption( $optset['name'], $optset['caption'], $optset['type'], - $optset['refresh'], - $optset['posvals'] - ); - } else { - /* Create a new option with all but possible values given. */ - $next_option = new SquirrelOption( - $optset['name'], - $optset['caption'], - $optset['type'], - $optset['refresh'] - ); - } + (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) + ); /* If provided, set the size for this option. */ if (isset($optset['size'])) { $next_option->setSize($optset['size']); } + /* If provided, set the trailing_text for this option. */ + if (isset($optset['trailing_text'])) { + $next_option->setTrailingText($optset['trailing_text']); + } + /* If provided, set the comment for this option. */ if (isset($optset['comment'])) { $next_option->setComment($optset['comment']); @@ -368,6 +670,16 @@ function create_option_groups($optgrps, $optvals) { $next_option->setScript($optset['script']); } + /* If provided, set the "post script" for this option. */ + if (isset($optset['post_script'])) { + $next_option->setPostScript($optset['post_script']); + } + + /* If provided, set the folder_filter for this option. */ + if (isset($optset['folder_filter'])) { + $next_option->setFolderFilter($optset['folder_filter']); + } + /* Add this option to the option array. */ $result[$grpkey]['options'][] = $next_option; } @@ -377,32 +689,48 @@ function create_option_groups($optgrps, $optvals) { return ($result); } -function printOptionGroups($option_groups) { - print_option_groups($option_groups); -} - +/** + * @param array $option_groups + */ function print_option_groups($option_groups) { + /* Print each option group. */ foreach ($option_groups as $next_optgrp) { - echo '' - . $next_optgrp['name'] . "\n"; + /* 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"; + } + + /* Print each option in this option group. */ foreach ($next_optgrp['options'] as $option) { if ($option->type != SMOPT_TYPE_HIDDEN) { - echo "\n"; - echo ' ' - . $option->caption . ":\n"; - echo ' ' . $option->createHTMLWidget() . "\n"; - echo "\n"; + echo html_tag( 'tr', "\n". + html_tag( 'td', $option->caption . ':', 'right' ,'', 'valign="middle"' ) . + html_tag( 'td', $option->createHTMLWidget(), 'left' ) + ) ."\n"; } else { echo $option->createHTMLWidget(); } } - echo " \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