- trim
- The value will be string trimmed.
-
+
- notnull
-
- When set, will barf if the value is the empty string.
+
- When set, will barf if the value is the empty string.
Checked after processing the
trim flag. If not set,
the empty string is always considered valid input, and no other
- filters are processed for that particular value. If it's an array or
+ filters are processed for that particular value. If it's an array or
multiple variable, the filters will still be applied for other values, though.
- optional
@@ -315,7 +315,7 @@
- array
-
This syntax maps query variables into Tcl arrays. If you specify
-
customfield:array, then query var customfield.foo will
+ customfield:array, then query var customfield.foo will
translate into the Tcl array entry $customfield(foo). In other words:
whatever comes after the dot is used as the key into the array,
or, more mathematically: x.y=z => set x(y) z.
@@ -327,9 +327,9 @@
- Will invoke
ad_verify_signature
to verify the value of the variable, to make sure it's the value that was output by us, and haven't been tampered with.
If you use export_vars -form -sign
- or export_vars -sign to export the
- variable, use this flag to verify it. To verify a variable named foo, the verify flag
- looks for a form variable named foo:sig. For a :multiple, it only expects one single
+ or export_vars -sign to export the
+ variable, use this flag to verify it. To verify a variable named foo, the verify flag
+ looks for a form variable named foo:sig. For a :multiple, it only expects one single
signature for the whole list. For :array it also expects one signature only, taken on the
[array get] form of the array.
@@ -346,25 +346,25 @@
You can safely pass $varname(date) to Oracle.
- time
-
- Pluggable filter, installed by default, that makes sure the array validates as a time in
- am/pm format. That is that it has two fields:
time and ampm that have
- valid values. Use this filter with :array to do automatic time filtering. To use it, set up
+ - Pluggable filter, installed by default, that makes sure the array validates as a time in
+ am/pm format. That is that it has two fields:
time and ampm that have
+ valid values. Use this filter with :array to do automatic time filtering. To use it, set up
in you HTML form using [ec_timeentrywidget varname] or equivalent. Then on the processing page
specify the filter using varname:array,time. If the time validates, there will be
a variable set in your environment varname with five keys: time, ampm,
hours, minutes, and seconds.
- time24
-
- Pluggable filter, installed by default, that makes sure the array validates as a time in
+
- Pluggable filter, installed by default, that makes sure the array validates as a time in
24hr format. That is that it has one field:
time that has valid values. Use this
filter with :array to do automatic time filtering. To use it, set up in you HTML form using
- <input type="text" name="varname".time>. Then on the processing page specify the filter using
+ <input type="text" name="varname".time>. Then on the processing page specify the filter using
varname:array,time24. If the time validates, there will be a variable set in your
environment varname with four keys: time, hours, minutes, and
seconds.
- integer
-
- Pluggable filter, installed by default, that makes sure the value is integer,
+
- Pluggable filter, installed by default, that makes sure the value is integer,
and removed any leading zeros.
- naturalnum
@@ -377,38 +377,38 @@
- nohtml
- Pluggable filter, installed by default, that disallows any and all html.
-
+
- html
- Pluggable filter, installed by default, that only allows certain, safe allowed tags to pass (see
- ad_html_security_check).
+ ad_html_security_check).
The purpose of screening naughty html is to prevent users from uploading
HTML with tags that hijack page formatting or execute malicious code on the users's computer.
-
+
- allhtml
- Pluggable filter, installed by default, that allows any and all html. Use of this filter
is not recommended, except for cases when the HTML will not be presented to the user or there is some
other reason for overriding the site-wide control over naughty html.
-
+
- tmpfile
- Checks to see if the path and file specified by tmpfile are allowed on this system.
-
- sql_identifier
+
- sql_identifier
- Pluggable filter, installed by default, that makes sure the value is a valid SQL identifier.
- path
- Pluggable filter, installed by default, that makes sure that argument contains only Tcl word
characters or a few additional safe characters used in paths ("/", ".", "-")
-
+
- token
- Pluggable filter, installed by default, that makes sure that argument contains only Tcl word
characters or a few additional safe characters (",", ":", "-").
-
+
- word
- Pluggable filter, installed by default, that makes sure that argument contains only Tcl word
characters (as defined by \w in Tcl regular expressions, i.e. characters, digits and underscore).
- localurl
-
- Pluggable filter, installed by default, that makes sure that argument contains a
+
- Pluggable filter, installed by default, that makes sure that argument contains a
non-external url, which can be used in ad_returnredirect without throwing an error.
@@ -420,25 +420,25 @@
Note that there can be no spaces between name,
- colon, flags, commas, etc. The first space encountered denotes the
+ colon, flags, commas, etc. The first space encountered denotes the
beginning of the default value. Also, variable names can't contain
- commas, colons or anything Tcl accepts as list element separators
+ commas, colons or anything Tcl accepts as list element separators
(space, tab, newline, possibly others)
- If more than one value is specified for something that's not
+ If more than one value is specified for something that's not
a multiple, a complaint will be thrown ("you supplied more than one value for foo").
- There's an interface for enhancing ad_page_contract with pluggable filters, whose names
+ There's an interface for enhancing ad_page_contract with pluggable filters, whose names
can be used in place of flags
- (see ad_page_contract_filter).
+ (see ad_page_contract_filter).
There's also an interface for pluggable filter rules, which determine
what filters are applied to arguments (see ad_page_contract_filter_rule).
+ href="proc-view?proc=ad_page_contract_filter_rule">ad_page_contract_filter_rule).
-
- Note on QQ-variables: Unlike the old ad_page_variables,
+
+ Note on QQ-variables: Unlike the old ad_page_variables,
ad_page_contract does not set QQ-versions of variables.
The QQ-versions (had each single-quote replaced by two single-quotes) were only necessary
for building up SQL statements directly in a Tcl string. Now that we're using bind variables,
@@ -448,54 +448,54 @@
Default Values
Default values are filled in from left to right (or top to
- bottom), so it can depend on the values or variables that comes
+ bottom), so it can depend on the values or variables that comes
before it, like in the example above. Default values are only used when
- the argument is not supplied, thus you can't use default values to override the
+ the argument is not supplied, thus you can't use default values to override the
empty string. (This behavior has been questioned and may have to
- be changed at a later point.)
+ be changed at a later point.)
Also, default values are not checked, even if you've specified
- flags and filters. If the argument has the multiple flag specified,
+ flags and filters. If the argument has the multiple flag specified,
the default value is treated as a list. If the array flag is specified, we
expect it to be in array get format, i.e. a list of { name value name value ... }
- pairs. If both multiple and array are set, the value elements of the
+ pairs. If both multiple and array are set, the value elements of the
before-mentioned array get format are treated as lists themselves.
-
+
Errors Argument
The -errors block defines custom error messages. The format is a list in array get format
- with alternating error-names and error texts. The error names can be foo, which
- means it's thrown when the variable is not supplied. Or foo:flag,flag,..., which
- means it'll get thrown whenever one of the flags fail. If you want the same error to be
+ with alternating error-names and error texts. The error names can be foo, which
+ means it's thrown when the variable is not supplied. Or foo:flag,flag,..., which
+ means it'll get thrown whenever one of the flags fail. If you want the same error to be
thrown for both not supplying a var, and for a flag, you can say foo:,flag,...
(a comma immediately after the colon).
Validation Blocks
- The -validate is used to fully customized user input validation. The format is a list
+ The -validate is used to fully customized user input validation. The format is a list
of named chunks of code, for example:
-validate {
- name {
- code block
- }
- another_name -requires { argname[:filter-or-validation-block-name,...] ... } {
- code block
- }
-}
-
+ name {
+ code block
+ }
+ another_name -requires { argname[:filter-or-validation-block-name,...] ... } {
+ code block
+ }
+ }
+
The name is for use with the -errors block, and for use within the -requires
argument of another validation block.
The validation blocks will get executed after all flags and filters have been evaluated.
- The code chunk should perform some validation, and if it's unhappy it should call
+ The code chunk should perform some validation, and if it's unhappy it should call
ad_complain, optionally with an error message.
If no error message is specified, the error should be declared in the -errors section.
- Each validation block can also have a -requires switch, which takes a list of
+ Each validation block can also have a -requires switch, which takes a list of
validations that must already have been successfully passed, for the validation to get executed.
- The intent is that you want to provide as much feedback as possible at once, but you don't want
+ The intent is that you want to provide as much feedback as possible at once, but you don't want
redundant feedback, like "foo must be an integer" and "foo must be in range 10 to 20".
So a check for foo in range 10 to 20 would have a -requires { foo:integer } switch,
to ensure that the check only gets executed if foo was sucessfully validated as an integer.
@@ -504,24 +504,24 @@
In the -requires argument, you can specify a list of (1) the
name of an argument, which means that the argument must be supplied.
- Or (2) you can specify argname:filter or
- argname:validation_block to say that a given filter, flag or
- valdiation block must have been executed and satisfied for this validation block to get executed.
+ Or (2) you can specify argname:filter or
+ argname:validation_block to say that a given filter, flag or
+ valdiation block must have been executed and satisfied for this validation block to get executed.
You can have as many requirements as you like.
-
+
- @param docstring the documentation for your page;
+ @param docstring the documentation for your page;
will be parsed like ad_proc and ad_library.
@param query the query arguments that this page accepts. The query
argument takes form of a list of argument specs. See above.
@param properties what properties the resulting document will contain.
-
- @param form Optionally supply the parameters directly here instead of fetching them from the page's form (ns_getform).
+
+ @param form Optionally supply the parameters directly here instead of fetching them from the page's form (ns_getform).
This should be a reference to an ns_set.
-
+
@author Lars Pind (lars@pinds.com)
@author Yonatan Feldman (yon@arsdigita.com)
@author Bryan Quinn (bquinn@arsdigita.com)
@@ -537,22 +537,22 @@
if { [llength $args] == 0 } {
- set query [list]
+ set query [list]
} else {
-
- set valid_args { validate errors return_errors properties } ;# add type later
- # If the first arg isn't a switch, it should be the query
- if { [string index [lindex $args 0] 0] ne "-" } {
- set query [lindex $args 0]
- set args [lrange $args 1 end]
- } else {
- # otherwise, accept a -query argument
- lappend valid_args query
- set query [list]
- }
-
- ad_arg_parser $valid_args $args
+ set valid_args { validate errors return_errors properties } ;# add type later
+
+ # If the first arg isn't a switch, it should be the query
+ if { [string index [lindex $args 0] 0] ne "-" } {
+ set query [lindex $args 0]
+ set args [lrange $args 1 end]
+ } else {
+ # otherwise, accept a -query argument
+ lappend valid_args query
+ set query [list]
+ }
+
+ ad_arg_parser $valid_args $args
}
# reset $::ad_page_contract_variables
@@ -561,9 +561,9 @@
}
####################
- #
+ #
# Check supplied query form and set up variables in caller's environment
- #
+ #
####################
#
# These are the steps:
@@ -584,7 +584,7 @@
# list apc_formals list of formals in the order specified by in the arguments
# array apc_formal($name) 1 if there is a formal argument with that name
# array apc_default_value($name) the default value, if any
- #
+ #
# FILTERS:
# array apc_internal_filter($name:$flag): 1 if the given flag is set, undefined
# array apc_filters($name): contains a list of the filters to apply
@@ -594,7 +594,7 @@
# DOCUMENTATION:
# array apc_flags($name): contains a list of the flags that apply
#
-
+
set apc_formals [list]
array set apc_formal [list]
array set apc_default_value [list]
@@ -607,94 +607,94 @@
array set apc_flags [list]
foreach element $query {
- set element_len [llength $element]
+ set element_len [llength $element]
- if { $element_len > 2 } {
- return -code error [_ acs-tcl.lt_Argspec_element_is_in]
- }
+ if { $element_len > 2 } {
+ return -code error [_ acs-tcl.lt_Argspec_element_is_in]
+ }
- set arg_spec [lindex $element 0]
+ set arg_spec [lindex $element 0]
- if { ![regexp {^([^ \t:]+)(?::([a-zA-Z0-9_,(|)]*))?$} $arg_spec match name flags] } {
- return -code error "Argspec '$arg_spec' doesn't have the right format. It must be var\[:flag\[,flag ...\]\]"
- }
+ if { ![regexp {^([^ \t:]+)(?::([a-zA-Z0-9_,(|)]*))?$} $arg_spec match name flags] } {
+ return -code error "Argspec '$arg_spec' doesn't have the right format. It must be var\[:flag\[,flag ...\]\]"
+ }
- lappend apc_formals $name
+ lappend apc_formals $name
set apc_formal($name) 1
-
- if { $element_len == 2 } {
- set apc_default_value($name) [lindex $element 1]
- }
- set pre_flag_list [split [string tolower $flags] ,]
- set flag_list [list]
+ if { $element_len == 2 } {
+ set apc_default_value($name) [lindex $element 1]
+ }
- # find parameterized flags
- foreach flag $pre_flag_list {
- set left_paren [string first "(" $flag]
- if { $left_paren == -1 } {
- lappend flag_list $flag
- } else {
- if { [string index $flag end] ne ")" } {
- return -code error "Missing or misplaced end parenthesis for flag '$flag' on argument '$name'"
- }
- set flag_parameters [string range $flag $left_paren+1 [string length $flag]-2]
- set flag [string range $flag 0 $left_paren-1]
+ set pre_flag_list [split [string tolower $flags] ,]
+ set flag_list [list]
- lappend flag_list $flag
- foreach flag_parameter [split $flag_parameters "|"] {
- lappend apc_filter_parameters($name:$flag) $flag_parameter
- }
- }
- }
+ # find parameterized flags
+ foreach flag $pre_flag_list {
+ set left_paren [string first "(" $flag]
+ if { $left_paren == -1 } {
+ lappend flag_list $flag
+ } else {
+ if { [string index $flag end] ne ")" } {
+ return -code error "Missing or misplaced end parenthesis for flag '$flag' on argument '$name'"
+ }
+ set flag_parameters [string range $flag $left_paren+1 [string length $flag]-2]
+ set flag [string range $flag 0 $left_paren-1]
- #
- # Apply filter rules
- #
+ lappend flag_list $flag
+ foreach flag_parameter [split $flag_parameters "|"] {
+ lappend apc_filter_parameters($name:$flag) $flag_parameter
+ }
+ }
+ }
- foreach filter_rule [nsv_array names ad_page_contract_filter_rules] {
- [ad_page_contract_filter_rule_proc $filter_rule] $name flag_list
- }
+ #
+ # Apply filter rules
+ #
- #
- # Sort the flag list according to priority
- #
+ foreach filter_rule [nsv_array names ad_page_contract_filter_rules] {
+ [ad_page_contract_filter_rule_proc $filter_rule] $name flag_list
+ }
- set flag_list_for_sorting [list]
- foreach flag $flag_list {
- lappend flag_list_for_sorting [list [ad_page_contract_filter_priority $flag] $flag]
- }
- set flag_list_sorted [lsort -index 0 $flag_list_for_sorting]
+ #
+ # Sort the flag list according to priority
+ #
- #
- # Split flag_list up into the different kinds, i.e. internal, filter (classic) or post_filter.
- #
- # apc_flags($name) is for documentation only.
- #
+ set flag_list_for_sorting [list]
+ foreach flag $flag_list {
+ lappend flag_list_for_sorting [list [ad_page_contract_filter_priority $flag] $flag]
+ }
+ set flag_list_sorted [lsort -index 0 $flag_list_for_sorting]
- set apc_flags($name) [list]
- set apc_filters($name) [list]
- set apc_post_filters($name) [list]
+ #
+ # Split flag_list up into the different kinds, i.e. internal, filter (classic) or post_filter.
+ #
+ # apc_flags($name) is for documentation only.
+ #
- foreach flag_entry $flag_list_sorted {
- set flag [lindex $flag_entry 1]
- lappend apc_flags($name) $flag
-
- switch [ad_page_contract_filter_type $flag] {
- internal {
- set apc_internal_filter($name:$flag) 1
- }
- filter {
- lappend apc_filters($name) $flag
- }
- post {
- lappend apc_post_filters($name) $flag
- }
- default {
- return -code error "Unrecognized flag or filter \"$flag\" specified for query argument $name"
- }
- }
- }
+ set apc_flags($name) [list]
+ set apc_filters($name) [list]
+ set apc_post_filters($name) [list]
+
+ foreach flag_entry $flag_list_sorted {
+ set flag [lindex $flag_entry 1]
+ lappend apc_flags($name) $flag
+
+ switch [ad_page_contract_filter_type $flag] {
+ internal {
+ set apc_internal_filter($name:$flag) 1
+ }
+ filter {
+ lappend apc_filters($name) $flag
+ }
+ post {
+ lappend apc_post_filters($name) $flag
+ }
+ default {
+ return -code error "Unrecognized flag or filter \"$flag\" specified for query argument $name"
+ }
+ }
+ }
}
####################
@@ -704,32 +704,32 @@
####################
if { [api_page_documentation_mode_p] } {
- # Just gather documentation for this page
+ # Just gather documentation for this page
- ad_parse_documentation_string $docstring doc_elements
+ ad_parse_documentation_string $docstring doc_elements
- # copy all the standard elements over
- foreach element { query properties } {
- if { [info exists $element] } {
- set doc_elements($element) [set $element]
- }
- }
- # then the arrays
- foreach element { apc_default_value apc_flags } {
- set doc_elements($element) [array get $element]
- }
- # then the array names
- set doc_elements(apc_arg_names) $apc_formals
-
- # figure out where the calling script is located, relative to the ACS root
- set root_dir [nsv_get acs_properties root_directory]
- set script [info script]
- set root_length [string length $root_dir]
- if { $root_dir eq [string range $script 0 $root_length-1 ] } {
- set script [string range $script $root_length+1 end]
- }
+ # copy all the standard elements over
+ foreach element { query properties } {
+ if { [info exists $element] } {
+ set doc_elements($element) [set $element]
+ }
+ }
+ # then the arrays
+ foreach element { apc_default_value apc_flags } {
+ set doc_elements($element) [array get $element]
+ }
+ # then the array names
+ set doc_elements(apc_arg_names) $apc_formals
- error [array get doc_elements] "ad_page_contract documentation"
+ # figure out where the calling script is located, relative to the ACS root
+ set root_dir [nsv_get acs_properties root_directory]
+ set script [info script]
+ set root_length [string length $root_dir]
+ if { $root_dir eq [string range $script 0 $root_length-1 ] } {
+ set script [string range $script $root_length+1 end]
+ }
+
+ error [array get doc_elements] "ad_page_contract documentation"
}
#
@@ -744,13 +744,13 @@
# This must happen even if the query (aka parameters, formals) is empty
if { [info exists properties] } {
- upvar 1 __page_contract_property property
- array set property [doc_parse_property_string $properties]
+ upvar 1 __page_contract_property property
+ array set property [doc_parse_property_string $properties]
}
# If there are no query arguments to process, we're done
if { ![info exists query] || $query eq "" } {
- return
+ return
}
####################
@@ -768,50 +768,50 @@
array set apc_validation_blocks [list]
if { ![info exists validate] } {
- set validate [list]
+ set validate [list]
}
set validate_len [llength $validate]
for { set i 0 } { $i < $validate_len } { incr i } {
- set name [lindex $validate $i]
+ set name [lindex $validate $i]
- if { [string first : $name] != -1 } {
- return -code error [_ acs-tcl.lt_Validation_block_name]
- }
- if { [info exists apc_formal($name)] } {
- return -code error [_ acs-tcl.lt_You_cant_name_your_va]
- }
- if { [info exists apc_validation_blocks($name)] } {
- return -code error [_ acs-tcl.lt_You_cant_have_two_val]
- }
+ if { [string first : $name] != -1 } {
+ return -code error [_ acs-tcl.lt_Validation_block_name]
+ }
+ if { [info exists apc_formal($name)] } {
+ return -code error [_ acs-tcl.lt_You_cant_name_your_va]
+ }
+ if { [info exists apc_validation_blocks($name)] } {
+ return -code error [_ acs-tcl.lt_You_cant_have_two_val]
+ }
- incr i
- if { [string index [lindex $validate $i] 0] == "-" } {
- if { [lindex $validate $i] ne "-requires" } {
- return -code error [_ acs-tcl.lt_Valid_switches_are_-r]
- }
- set requires [lindex $validate [incr i]]
+ incr i
+ if { [string index [lindex $validate $i] 0] == "-" } {
+ if { [lindex $validate $i] ne "-requires" } {
+ return -code error [_ acs-tcl.lt_Valid_switches_are_-r]
+ }
+ set requires [lindex $validate [incr i]]
- foreach element $requires {
- if { [string first , $element] != -1 } {
- return -code error [_ acs-tcl.lt_The_-requires_element]
- }
- set parts_v [split $element ":"]
- set parts_c [llength $parts_v]
- if { $parts_c > 2 } {
- return -code error [_ acs-tcl.lt_The_-requires_element_1]
- }
- set req_filter [lindex $parts_v 1]
- if { $req_filter in {array multiple} } {
- return -code error "You can't require \"$req_name:$req_filter\" for block \"$name\"."
- }
- }
- incr i
- } else {
- set requires [list]
- }
- set code [lindex $validate $i]
- set apc_validation_blocks($name) [list $requires $code]
+ foreach element $requires {
+ if { [string first , $element] != -1 } {
+ return -code error [_ acs-tcl.lt_The_-requires_element]
+ }
+ set parts_v [split $element ":"]
+ set parts_c [llength $parts_v]
+ if { $parts_c > 2 } {
+ return -code error [_ acs-tcl.lt_The_-requires_element_1]
+ }
+ set req_filter [lindex $parts_v 1]
+ if { $req_filter in {array multiple} } {
+ return -code error "You can't require \"$req_name:$req_filter\" for block \"$name\"."
+ }
+ }
+ incr i
+ } else {
+ set requires [list]
+ }
+ set code [lindex $validate $i]
+ set apc_validation_blocks($name) [list $requires $code]
}
####################
@@ -821,37 +821,37 @@
####################
if { [info exists errors] } {
- ad_complaints_parse_error_strings $errors
+ ad_complaints_parse_error_strings $errors
}
####################
#
# Step 2: Go through all the actual arguments supplied in the form
- #
+ #
####################
if { $form eq "" } {
set form [ns_getform]
}
-
+
if { $form eq "" } {
- set form_size 0
+ set form_size 0
} else {
- set form_size [ns_set size $form]
+ set form_size [ns_set size $form]
}
# This is the array in which we store the signature variables as we come across them
# Whenever we see a variable named foo:sig, we record it here as apc_signatures(foo).
array set apc_signatures [list]
-
+
for { set form_counter_i 0 } { $form_counter_i < $form_size } { incr form_counter_i } {
-
- #
- # Map actual argument to formal argument ... only complication is from arrays
- #
+ #
+ # Map actual argument to formal argument ... only complication is from arrays
+ #
- # Check the name of the argument to passed in the form, ignore if not valid
+
+ # Check the name of the argument to passed in the form, ignore if not valid
if { [regexp -nocase -- {^[a-z0-9_\-\.\:]*$} [ns_set key $form $form_counter_i] ] } {
set actual_name [ns_set key $form $form_counter_i]
@@ -861,25 +861,25 @@
# This will be var(key) for an array
set variable_to_set var
- # This is the value
+ # This is the value
set actual_value [ns_set value $form $form_counter_i]
# This is needed for double click protection so we can access the two variables down below.
if {$actual_name eq "__submit_button_name" || $actual_name eq "__submit_button_value"} {
set $actual_name $actual_value
}
-
+
# It may be a signature for another variable
if { [regexp {^(.*):sig$} $actual_name match formal_name] } {
set apc_signatures($formal_name) $actual_value
# We're done with this variable
continue
}
-
- # If there is no formal with this name, _or_ the formal that has this name is an array,
+
+ # If there is no formal with this name, _or_ the formal that has this name is an array,
# in which case it can't be the right formal, since we'd have to have a dot and then the key
if { ![info exists apc_formal($formal_name)] || [info exists apc_internal_filter($formal_name:array)] } {
-
+
# loop over all the occurrences of dot in the argument name
# and search for a variable spec with that name, e.g.
# foo.bar.greble can be interpreted as foo(bar.greble) or foo.bar(greble)
@@ -896,44 +896,44 @@
}
if { !$found_p } {
# The user supplied a value for which we didn't have any arg_spec
- # It might be safest to fail completely in this case, but for now,
+ # It might be safest to fail completely in this case, but for now,
# we just ignore it and go on with the next arg
continue
}
}
-
- if { [info exists apc_internal_filter($formal_name:multiple)]
- && $actual_value eq ""
+
+ if { [info exists apc_internal_filter($formal_name:multiple)]
+ && $actual_value eq ""
} {
# LARS:
# If you lappend an emptry_string, it'll actually add the empty string to the list as an element
# which is not what we want
continue
}
-
-
+
+
# Remember that we've found the spec so we don't complain that this argument is missing
ad_page_contract_set_validation_passed $formal_name
-
+
#
# Apply filters
#
-
+
if { [info exists apc_internal_filter($formal_name:trim)] } {
set actual_value [string trim $actual_value]
ad_page_contract_set_validation_passed $formal_name:trim
}
if { $actual_value eq "" } {
if { [info exists apc_internal_filter($formal_name:notnull)] } {
- ad_complain -key $formal_name:notnull "[_ acs-tcl.lt_You_must_specify_some]"
+ ad_complain -key $formal_name:notnull [_ acs-tcl.lt_You_must_specify_some]
continue
- } else {
+ } else {
ad_page_contract_set_validation_passed $formal_name:notnull
}
} else {
set ::ad_page_contract_validations_passed($formal_name:notnull) 1
-
+
foreach filter $apc_filters($formal_name) {
set ::ad_page_contract_errorkeys [concat $formal_name:$filter $::ad_page_contract_errorkeys]
if { ![info exists apc_filter_parameters($formal_name:$filter)] } {
@@ -943,21 +943,21 @@
$apc_filter_parameters($formal_name:$filter)]
}
set ::ad_page_contract_errorkeys [lrange $::ad_page_contract_errorkeys 1 end]
-
+
if { $filter_ok_p } {
set ::ad_page_contract_validations_passed($formal_name:$filter) 1
} else {
break
}
}
}
-
+
#
# Set the variable in the caller's environment
#
-
+
upvar 1 $formal_name var
-
+
if { [info exists apc_internal_filter($formal_name:multiple)] } {
lappend $variable_to_set $actual_value
} else {
@@ -974,77 +974,77 @@
ad_log warning "ad_page_contract: attempt to use a nonstandard variable name in form. [ns_set key $form $form_counter_i] "
}
}
-
+
####################
- #
+ #
# Step 3: Pass over each formal argument to make sure all the required
- # things are there, and setting defaults if they're provided,
+ # things are there, and setting defaults if they're provided,
# apply post filters, and validate signatures.
#
####################
foreach formal_name $apc_formals {
-
- upvar $level $formal_name var
- if { [info exists apc_internal_filter($formal_name:cached)] } {
- if { ![ad_page_contract_get_validation_passed_p $formal_name]
- && ![info exists apc_internal_filter($formal_name:notnull)]
- && (![info exists apc_default_value($formal_name)]
- || $apc_default_value($formal_name) eq "")
- } {
- if { [info exists apc_internal_filter($formal_name:array)] } {
- # This is an array variable, so we need to loop through each name.* variable for this package we have ...
- set array_list ""
- foreach arrayvar [ns_cache names util_memoize] {
- if {[regexp [list [ad_conn session_id] [ad_conn package_id] "$formal_name."] $arrayvar]} {
- set arrayvar [lindex $arrayvar [llength $arrayvar]-1]
- if { $array_list ne "" } {
- append array_list " "
- }
- set arrayvar_formal [string range $arrayvar [string first "." $arrayvar]+1 [string length $arrayvar]]
- append array_list "{$arrayvar_formal} {[ad_get_client_property [ad_conn package_id] $arrayvar]}"
- }
- }
- set apc_default_value($formal_name) $array_list
- } else {
- set apc_default_value($formal_name) [ad_get_client_property [ad_conn package_id] $formal_name]
- }
- }
- }
+ upvar $level $formal_name var
+ if { [info exists apc_internal_filter($formal_name:cached)] } {
+ if { ![ad_page_contract_get_validation_passed_p $formal_name]
+ && ![info exists apc_internal_filter($formal_name:notnull)]
+ && (![info exists apc_default_value($formal_name)]
+ || $apc_default_value($formal_name) eq "")
+ } {
+ if { [info exists apc_internal_filter($formal_name:array)] } {
+ # This is an array variable, so we need to loop through each name.* variable for this package we have ...
+ set array_list ""
+ foreach arrayvar [ns_cache names util_memoize] {
+ if {[regexp [list [ad_conn session_id] [ad_conn package_id] "$formal_name."] $arrayvar]} {
+ set arrayvar [lindex $arrayvar [llength $arrayvar]-1]
+ if { $array_list ne "" } {
+ append array_list " "
+ }
+ set arrayvar_formal [string range $arrayvar [string first "." $arrayvar]+1 [string length $arrayvar]]
+ append array_list "{$arrayvar_formal} {[ad_get_client_property [ad_conn package_id] $arrayvar]}"
+ }
+ }
+ set apc_default_value($formal_name) $array_list
+ } else {
+ set apc_default_value($formal_name) [ad_get_client_property [ad_conn package_id] $formal_name]
+ }
+ }
+ }
+
#
# Perform these checks only, when the validation is passed and
# a we have a value for the variable
#
- if { [ad_page_contract_get_validation_passed_p $formal_name] && [info exists var]} {
-
- if { [info exists apc_internal_filter($formal_name:verify)] } {
- if { ![info exists apc_internal_filter($formal_name:array)] } {
- # This is not an array, verify the scalar variable
- if { ![info exists apc_signatures($formal_name)]
- || ![ad_verify_signature \
+ if { [ad_page_contract_get_validation_passed_p $formal_name] && [info exists var]} {
+
+ if { [info exists apc_internal_filter($formal_name:verify)] } {
+ if { ![info exists apc_internal_filter($formal_name:array)] } {
+ # This is not an array, verify the scalar variable
+ if { ![info exists apc_signatures($formal_name)]
+ || ![ad_verify_signature \
-secret [ns_config "ns/server/[ns_info server]/acs" parametersecret ""] \
$var $apc_signatures($formal_name)]
- } {
- ad_complain -key $formal_name:verify [_ acs-tcl.lt_The_signature_for_the]
- continue
- }
- } else {
- # This is an array: verify the [array get] form of the array
- if { ![info exists apc_signatures($formal_name)]
- || ![ad_verify_signature \
+ } {
+ ad_complain -key $formal_name:verify [_ acs-tcl.lt_The_signature_for_the]
+ continue
+ }
+ } else {
+ # This is an array: verify the [array get] form of the array
+ if { ![info exists apc_signatures($formal_name)]
+ || ![ad_verify_signature \
-secret [ns_config "ns/server/[ns_info server]/acs" parametersecret ""] \
- [lsort [array get var]] $apc_signatures($formal_name)]
- } {
- ad_complain -key $formal_name:verify [_ acs-tcl.lt_The_signature_for_the]
- continue
- }
- }
- }
+ [lsort [array get var]] $apc_signatures($formal_name)]
+ } {
+ ad_complain -key $formal_name:verify [_ acs-tcl.lt_The_signature_for_the]
+ continue
+ }
+ }
+ }
- # Apply post filters
+ # Apply post filters
foreach filter $apc_post_filters($formal_name) {
ad_complaints_with_key $formal_name:$filter {
set filter_proc [ad_page_contract_filter_proc $filter]
@@ -1056,30 +1056,30 @@
}
if { $filter_ok_p } {
ad_page_contract_set_validation_passed $formal_name:$filter
- } else {
+ } else {
break
- }
- }
-
- } else {
-
- # no value supplied for this arg spec
-
- if { [info exists apc_default_value($formal_name)] } {
-
- # Only use the default value if there has been no complaints so far
- # Why? Because if there are complaints, the page isn't going to serve anyway,
- # and because one default value may depend on another variable having a correct value.
- if { [ad_complaints_count] == 0 } {
- # we need to set the default value
- if { [info exists apc_internal_filter($formal_name:array)] } {
- array set var [uplevel subst \{$apc_default_value($formal_name)\}]
- } else {
- set var [uplevel subst \{$apc_default_value($formal_name)\}]
- }
- }
-
- } elseif { ![info exists apc_internal_filter($formal_name:optional)]} {
+ }
+ }
+
+ } else {
+
+ # no value supplied for this arg spec
+
+ if { [info exists apc_default_value($formal_name)] } {
+
+ # Only use the default value if there has been no complaints so far
+ # Why? Because if there are complaints, the page isn't going to serve anyway,
+ # and because one default value may depend on another variable having a correct value.
+ if { [ad_complaints_count] == 0 } {
+ # we need to set the default value
+ if { [info exists apc_internal_filter($formal_name:array)] } {
+ array set var [uplevel subst \{$apc_default_value($formal_name)\}]
+ } else {
+ set var [uplevel subst \{$apc_default_value($formal_name)\}]
+ }
+ }
+
+ } elseif { ![info exists apc_internal_filter($formal_name:optional)]} {
#
# The element is not optional.
#
@@ -1097,71 +1097,71 @@
&& ![uplevel $level [list info exists $formal_name]] } {
ad_complain -key $formal_name [_ acs-tcl.lt_You_must_supply_a_val]
}
- }
- }
+ }
+ }
}
####################
#
- # Step 4: Execute validation blocks
+ # Step 4: Execute validation blocks
#
####################
set done_p 0
while { !$done_p } {
- set done_p 1
- foreach validation_name [array names apc_validation_blocks] {
+ set done_p 1
+ foreach validation_name [array names apc_validation_blocks] {
lassign $apc_validation_blocks($validation_name) dependencies code
- set dependencies_met_p 1
- #
- # Check, of the variables of the dependencies were provided.
- #
- foreach dependency $dependencies {
- set varName [lindex [split $dependency ":"] 0]
- if { ![ad_page_contract_get_validation_passed_p $varName] } {
- # var $varName was not provided
- set dependencies_met_p 0
- break
- }
- }
+ set dependencies_met_p 1
+ #
+ # Check, of the variables of the dependencies were provided.
+ #
+ foreach dependency $dependencies {
+ set varName [lindex [split $dependency ":"] 0]
+ if { ![ad_page_contract_get_validation_passed_p $varName] } {
+ # var $varName was not provided
+ set dependencies_met_p 0
+ break
+ }
+ }
- #
- # Check, whether the earlier section haven't returned
- # errors, in which case the detailed validation is not
- # necessary.
- #
- if { $dependencies_met_p && [ad_complaints_count] > 0} {
- set dependencies_met_p 0
- }
+ #
+ # Check, whether the earlier section haven't returned
+ # errors, in which case the detailed validation is not
+ # necessary.
+ #
+ if { $dependencies_met_p && [ad_complaints_count] > 0} {
+ set dependencies_met_p 0
+ }
- if { $dependencies_met_p } {
+ if { $dependencies_met_p } {
- # remove from validation blocks array, so we don't execute the same block twice
- unset apc_validation_blocks($validation_name)
+ # remove from validation blocks array, so we don't execute the same block twice
+ unset apc_validation_blocks($validation_name)
- set no_complaints_before [ad_complaints_count]
+ set no_complaints_before [ad_complaints_count]
- # Execute the validation block with an environment with a default error key set
- set ::ad_page_contract_errorkeys [concat $validation_name $::ad_page_contract_errorkeys]
- set validation_ok_p [ad_page_contract_eval uplevel 1 $code]
- set ::ad_page_contract_errorkeys [lrange $::ad_page_contract_errorkeys 1 end]
+ # Execute the validation block with an environment with a default error key set
+ set ::ad_page_contract_errorkeys [concat $validation_name $::ad_page_contract_errorkeys]
+ set validation_ok_p [ad_page_contract_eval uplevel 1 $code]
+ set ::ad_page_contract_errorkeys [lrange $::ad_page_contract_errorkeys 1 end]
- if { $validation_ok_p eq ""
- || ($validation_ok_p ne "1" && $validation_ok_p ne "0" )
- } {
- set validation_ok_p [expr {[ad_complaints_count] == $no_complaints_before}]
- }
-
- if { $validation_ok_p } {
- set ::ad_page_contract_validations_passed($validation_name) 1
- # more stuff to process still
- set done_p 0
- }
-
- }
- }
+ if { $validation_ok_p eq ""
+ || ($validation_ok_p ne "1" && $validation_ok_p ne "0" )
+ } {
+ set validation_ok_p [expr {[ad_complaints_count] == $no_complaints_before}]
+ }
+
+ if { $validation_ok_p } {
+ set ::ad_page_contract_validations_passed($validation_name) 1
+ # more stuff to process still
+ set done_p 0
+ }
+
+ }
+ }
}
####################
@@ -1179,7 +1179,7 @@
# Add safety belt to prevent recursive loop
#
if {[incr ::__ad_complain_depth] < 10} {
-
+
if { [info exists return_errors] } {
upvar 1 $return_errors error_list
set error_list [ad_complaints_get_list]
@@ -1210,15 +1210,15 @@
ns_return 422 text/html $html
ad_script_abort
}
- }
+ }
}
# Set the __submit_button_variable. This is used in double click protection.
- if {[info exists __submit_button_name]
- && $__submit_button_name ne ""
- && [info exists __submit_button_value]
+ if {[info exists __submit_button_name]
+ && $__submit_button_name ne ""
+ && [info exists __submit_button_value]
} {
- uplevel 1 [list set $__submit_button_name $__submit_button_value]
+ uplevel 1 [list set $__submit_button_name $__submit_button_value]
}
@@ -1227,27 +1227,27 @@
ad_proc -public ad_page_contract_get_variables { } {
Returns a list of all the formal variables specified in
ad_page_contract. If no variables have been specified, returns an
- empty list.
+ empty list.
} {
if { [info exists ::ad_page_contract_variables] && $::ad_page_contract_variables ne "" } {
- return $::ad_page_contract_variables
- }
+ return $::ad_page_contract_variables
+ }
return [list]
}
ad_proc ad_include_contract {docstring args} {
-
+
Define interface between a page and an similar to the
page_contract. This is a light-weight implementation based on the
ad_page_contract. It allows to check the passed arguments (types,
- optionality) and can be used for setting defaults the usual way.
+ optionality) and can be used for setting defaults the usual way.
Using ad_include_contracts helps to improve documentation of
included content.
-
+
@param docstring documentation of the include
@param args passed parameter
@see ad_page_contract
-
+
@author gustaf neumann (neumann@wu-wien.ac.at)
@creation-date Sept 2015
} {
@@ -1278,11 +1278,11 @@
# }
continue
}
-
+
#ns_log notice "V=$__v exists: [uplevel [list info exists $__v]]"
lappend __cmd $__v [uplevel [list set $__v]]
}
-
+
#ns_log notice "final command: $__cmd"
if {[uplevel {info exists __adp_remember_stub}]} {
@@ -1311,52 +1311,52 @@
if { [apm_first_time_loading_p] } {
nsv_array set ad_page_contract_filters {
- multiple {internal}
- array {internal}
- optional {internal}
- trim {internal}
+ multiple {internal}
+ array {internal}
+ optional {internal}
+ trim {internal}
notnull {internal}
- verify {internal}
- cached {internal}
+ verify {internal}
+ cached {internal}
}
-
+
nsv_array set ad_page_contract_filter_rules [list]
nsv_set ad_page_contract_mutex filters [ns_mutex create]
nsv_set ad_page_contract_mutex filter_rules [ns_mutex create]
}
-ad_proc -public ad_page_contract_filter {
+ad_proc -public ad_page_contract_filter {
{-type filter}
{-priority 1000}
name
proc_args
doc_string
- body
+ body
} {
Declare a filter to be available for use in ad_page_contract.
Here's an example of how to declare a filter:
ad_page_contract_filter integer { name value } {
- Checks whether the value is a valid integer, and removes any leading zeros so as
- not to confuse Tcl into thinking it's octal
+ Checks whether the value is a valid integer, and removes any leading zeros so as
+ not to confuse Tcl into thinking it's octal
} {
- if { ![regexp {^[0-9]+$} $value] } {
- ad_complain [_ acs-tcl.lt_Value_is_not_an_integ]
- return 0
- }
+ if { ![regexp {^[0-9]+$} $value] } {
+ ad_complain [_ acs-tcl.lt_Value_is_not_an_integ]
+ return 0
+ }
set value [util::trim_leading_zeros $value]
- return 1
+ return 1
}
-
- After the filter has been declared, it can be used as a flag in ad_page_contract, e.g.
+
+ After the filter has been declared, it can be used as a flag in ad_page_contract, e.g.
ad_page_contract {
- foo:integer
+ foo:integer
} {}
@@ -1366,19 +1366,19 @@
The filter proc must return either 1 if it accepts the value or 0 if it rejects it.
- Any problem with the value is reported using ad_complain (see documentation
- for this). Note: Any modifications you make to value from inside your code block will modify
+ Any problem with the value is reported using ad_complain (see documentation
+ for this). Note: Any modifications you make to value from inside your code block will modify
the actual value being set in the page.
There are two types of filters. They differ in scope for variables that are multiple or array.
- The standard type of filter (filter classic) is invoked on each individual value before it's being put into the
+ The standard type of filter (filter classic) is invoked on each individual value before it's being put into the
list or the array. A post filter is invoked after all values have been collected, and is invoked on the
list or array as a whole.
-
+
@param type The type of filter; i.e. filter or post. Default is filter.
@param name The name of the flag as used in ad_page_contract
@@ -1395,27 +1395,27 @@
value set, and it must either return the possibly
transformed value, or throw an error. The error message will
be displayed to the user.
-
+
@param doc_string Standard documentation-string. Tell other programmers what your filter does.
@author Lars Pind (lars@pinds.com)
@creation-date 25 July 2000
} {
if { ![string is wordchar $name] || $name eq "" } {
- return -code error "[_ acs-tcl.lt_Flag_name_must_be_a_v]"
+ return -code error [_ acs-tcl.lt_Flag_name_must_be_a_v]
}
if { [string tolower $name] ne $name } {
- return -code error "[_ acs-tcl.lt_Flag_names_must_be_al]"
+ return -code error [_ acs-tcl.lt_Flag_names_must_be_al]
}
if { ![string match $type filter] && ![string match $type post] } {
- return -code error "[_ acs-tcl.lt_Filter_type_must_be_f]"
+ return -code error [_ acs-tcl.lt_Filter_type_must_be_f]
}
set proc_args_len [llength $proc_args]
if { $proc_args_len != 2 && $proc_args_len != 3 } {
- return -code error "[_ acs-tcl.lt_Invalid_number_of_arg]"
+ return -code error [_ acs-tcl.lt_Invalid_number_of_arg]
}
set script [info script]
@@ -1431,13 +1431,13 @@
set prior_type [ad_page_contract_filter_type $name]
if {$prior_type eq "internal"} {
- ns_mutex unlock $mutex
- return -code error [_ acs-tcl.lt_The_flag_name_name_is]
+ ns_mutex unlock $mutex
+ return -code error [_ acs-tcl.lt_The_flag_name_name_is]
} elseif { $prior_type ne "" } {
- set prior_script [ad_page_contract_filter_script $name]
- if { $prior_script ne $script } {
- ns_log Warning [_ acs-tcl.lt_Multiple_definitions_]
- }
+ set prior_script [ad_page_contract_filter_script $name]
+ if { $prior_script ne $script } {
+ ns_log Warning [_ acs-tcl.lt_Multiple_definitions_]
+ }
}
nsv_set ad_page_contract_filters $name [list $type $proc_name $doc_string $script $priority]
@@ -1447,7 +1447,7 @@
# Declare the proc
#
- # this may look complicated, but it's really pretty simple:
+ # this may look complicated, but it's really pretty simple:
# If you declare a filter like this: ad_page_contract_filter foo { name value } { ... }
# it turns into this proc:
# ad_proc ad_page_contract_filter_proc_foo { name value_varname } { upvar $value_varname value ; ... }
@@ -1456,23 +1456,23 @@
lassign $proc_args arg0 arg1 arg2
if { $proc_args_len == 2 } {
- ad_proc -public $proc_name [list $arg0 ${arg1}_varname] $doc_string "upvar \$${arg1}_varname $arg1\n$body"
+ ad_proc -public $proc_name [list $arg0 ${arg1}_varname] $doc_string "upvar \$${arg1}_varname $arg1\n$body"
} else {
- ad_proc -public $proc_name [list $arg0 ${arg1}_varname $arg2] $doc_string "upvar \$${arg1}_varname $arg1\n$body"
+ ad_proc -public $proc_name [list $arg0 ${arg1}_varname $arg2] $doc_string "upvar \$${arg1}_varname $arg1\n$body"
}
}
ad_proc ad_page_contract_filter_type { filter } {
- Returns the type of proc that executes the given ad_page_contract filter,
+ Returns the type of proc that executes the given ad_page_contract filter,
or the empty string if the filter is not defined.
-
+
@author Lars Pind (lars@pinds.com)
@creation-date 25 July 2000
} {
if { [nsv_exists ad_page_contract_filters $filter] } {
- return [lindex [nsv_get ad_page_contract_filters $filter] 0]
+ return [lindex [nsv_get ad_page_contract_filters $filter] 0]
} else {
- return {}
+ return {}
}
}
@@ -1486,7 +1486,7 @@
}
ad_proc ad_page_contract_filter_script { filter } {
- Returns the type of proc that executes the given ad_page_contract filter,
+ Returns the type of proc that executes the given ad_page_contract filter,
or the empty string if the filter is not defined.
@author Lars Pind (lars@pinds.com)
@@ -1496,7 +1496,7 @@
}
ad_proc ad_page_contract_filter_priority { filter } {
- Returns the type of proc that executes the given ad_page_contract filter,
+ Returns the type of proc that executes the given ad_page_contract filter,
or the empty string if the filter is not defined.
@author Lars Pind (lars@pinds.com)
@@ -1518,19 +1518,19 @@
@param name the logical name of the variable to filter
@param value_varname the name of the variable holding the value to be filtered.
@param parameters any arguments to pass to the filter
-
+
@author Lars Pind (lars@pinds.com)
@author Yonatan Feldman (yon@arsdigita.com)
@creation-date 25 July 2000
} {
upvar $value_varname value
if { $parameters eq "" } {
- set filter_result [[ad_page_contract_filter_proc $filter] $name value]
+ set filter_result [[ad_page_contract_filter_proc $filter] $name value]
} else {
- set filter_result [[ad_page_contract_filter_proc $filter] $name value $parameters]
+ set filter_result [[ad_page_contract_filter_proc $filter] $name value $parameters]
}
if { $filter_result } {
- ad_page_contract_set_validation_passed $name:$filter
+ ad_page_contract_set_validation_passed $name:$filter
}
return $filter_result
}
@@ -1552,24 +1552,24 @@
proc_args
doc_string
body
-} {
- A filter rule determines what filters are applied to a given value. The code is passed the
- name of the formal argument and the list of filters currently being applied, and should
+} {
+ A filter rule determines what filters are applied to a given value. The code is passed the
+ name of the formal argument and the list of filters currently being applied, and should
on that basis modify the list of filters to suit its needs. Usually a filter rule will add
- a certain filter, unless some list of filters are already present.
+ a certain filter, unless some list of filters are already present.
-
- Unlike the filters themselves (registered with ad_page_contract_filter, all rules
+
+ Unlike the filters themselves (registered with ad_page_contract_filter), all rules
are always applied to all formal arguments of all pages.
@param name filter rules must be named. The name isn't referred to anywhere.
-
- @param proc_args the filter rule proc must take two arguments, name and filters,
- although you can name them as you like. The first will be set to the name of the formal argument,
- the second will be upvar'd to the list of filters, so that any modifications you make to this list
- are reflected in the actual list of filters being applied.
+ @param proc_args the filter rule proc must take two arguments, name and filters,
+ although you can name them as you like. The first will be set to the name of the formal argument,
+ the second will be upvar'd to the list of filters, so that any modifications you make to this list
+ are reflected in the actual list of filters being applied.
+
@param doc_string let other programmers know what your filter rule does.
@param body the code to manipulate the filter list.
@@ -1578,31 +1578,31 @@
@creation-date 25 July 2000
} {
if { [llength $proc_args] != 2 } {
- return -code error "[_ acs-tcl.lt_The_proc_must_accept_]"
+ return -code error [_ acs-tcl.lt_The_proc_must_accept_]
}
-
+
set script [info script]
set proc_name ad_page_contract_filter_rule_proc_$name
-
+
set mutex [nsv_get ad_page_contract_mutex filter_rules]
ns_mutex lock $mutex
-
+
if { [nsv_exists ad_page_contract_filter_rules $name] } {
- set prior_script [ad_page_contract_filter_rule_script $name]
- if { $script ne $prior_script } {
- ns_log Warning "Multiple definitions of the ad_page_contract_filter_rule \"$name\" in $script and $prior_script"
- }
+ set prior_script [ad_page_contract_filter_rule_script $name]
+ if { $script ne $prior_script } {
+ ns_log Warning "Multiple definitions of the ad_page_contract_filter_rule \"$name\" in $script and $prior_script"
+ }
}
-
+
nsv_set ad_page_contract_filter_rules $name [list $proc_name $doc_string $script]
ns_mutex unlock $mutex
-
+
# same trick as ad_page_contract_filter does.
-
+
lassign $proc_args arg0 arg1
ad_proc $proc_name [list $arg0 ${arg1}_varname] $doc_string "upvar \$${arg1}_varname $arg1\n$body"
}
-
+
ad_proc ad_page_contract_filter_rule_proc { filter } {
Returns the proc that executes the given ad_page_contract default-filter.
} {
@@ -1622,47 +1622,47 @@
####################
ad_page_contract_filter integer { name value } {
- Checks whether the value is a valid integer, and removes any leading zeros so as
+ Checks whether the value is a valid integer, and removes any leading zeros so as
not to confuse Tcl into thinking it's octal. Allows negative numbers.
@author Lars Pind (lars@pinds.com)
@creation-date 25 July 2000
} {
- # First simple a quick check avoiding the slow regexp
- if {[string is integer -strict $value]} {
- return 1
- }
+ # First simple a quick check avoiding the slow regexp
+ if {[string is integer -strict $value]} {
+ return 1
+ }
- if { [regexp {^(-)(.*)$} $value match sign rest] } {
- # Trim the value for any leading zeros
- set value $sign[util::trim_leading_zeros $rest]
- # the string might be still to large, so check again...
- if {[string is integer -strict $value]} {
- return 1
- }
- }
- ad_complain [_ acs-tcl.lt_name_is_not_an_intege]
- return 0
+ if { [regexp {^(-)(.*)$} $value match sign rest] } {
+ # Trim the value for any leading zeros
+ set value $sign[util::trim_leading_zeros $rest]
+ # the string might be still to large, so check again...
+ if {[string is integer -strict $value]} {
+ return 1
+ }
+ }
+ ad_complain [_ acs-tcl.lt_name_is_not_an_intege]
+ return 0
}
ad_page_contract_filter naturalnum { name value } {
- Checks whether the value is a valid integer >= 0,
- and removes any leading zeros so as
+ Checks whether the value is a valid integer >= 0,
+ and removes any leading zeros so as
not to confuse Tcl into thinking it's octal.
@author Lars Pind (lars@pinds.com)
@creation-date 25 July 2000
} {
# First a simple quick check to avoid the slow regexp
if {[string is integer -strict $value] && $value >= 0} {
- return 1
+ return 1
}
# Check with leading zeros, but no "-" allowed, so it must be positive
if { [regexp {^(0*)([1-9][0-9]*|0)$} $value match zeros value] } {
- if {[string is integer -strict $value]} {
- return 1
- }
+ if {[string is integer -strict $value]} {
+ return 1
+ }
}
ad_complain [_ acs-tcl.lt_name_is_not_a_natural]
@@ -1679,16 +1679,16 @@
@creation-date August 18, 2000
} {
if { [llength $range] != 2 } {
- error [_ acs-tcl.lt_Invalid_number_of_par]
- ad_script_abort
+ error [_ acs-tcl.lt_Invalid_number_of_par]
+ ad_script_abort
}
lassign $range min max
set value [util::trim_leading_zeros $value]
-
+
if { ![string is integer -strict $value] || $value < $min || $value > $max } {
- ad_complain [_ acs-tcl.lt_name_is_not_in_the_ra]
- return 0
+ ad_complain [_ acs-tcl.lt_name_is_not_in_the_ra]
+ return 0
}
return 1
}
@@ -1697,11 +1697,11 @@
Checks whether the value is a valid SQL identifier
@author Lars Pind (lars@pinds.com)
@creation-date 25 July 2000
-} {
+} {
if { ![string is wordchar $value] } {
- ad_complain [_ acs-tcl.lt_name_is_not_a_valid_S]
- return 0
- }
+ ad_complain [_ acs-tcl.lt_name_is_not_a_valid_S]
+ return 0
+ }
return 1
}
@@ -1719,8 +1719,8 @@
@creation-date 25 July 2000
} {
if { [string first < $value] >= 0 } {
- ad_complain [_ acs-tcl.lt_Value_for_name_contai]
- return 0
+ ad_complain [_ acs-tcl.lt_Value_for_name_contai]
+ return 0
}
return 1
}
@@ -1732,8 +1732,8 @@
} {
set naughty_prompt [ad_html_security_check $value]
if { $naughty_prompt ne "" } {
- ad_complain $naughty_prompt
- return 0
+ ad_complain $naughty_prompt
+ return 0
}
return 1
}
@@ -1742,22 +1742,22 @@
Checks to see that the tmpfile path is allowed on the system
@author Lars Pind (lars@pinds.com)
@creation-date 25 July 2000
-} {
+} {
# ensure no .. in the path
ns_normalizepath $value
-
+
# check to make sure path is to an authorized directory
set tmpdir_list [ad_parameter_all_values_as_list -package_id [ad_conn subsite_id] TmpDir]
if { $tmpdir_list eq "" } {
- set tmpdir_list [list "/var/tmp" "/tmp" [ns_config ns/parameters tmpdir]]
+ set tmpdir_list [list "/var/tmp" "/tmp" [ns_config ns/parameters tmpdir]]
}
-
+
foreach tmpdir $tmpdir_list {
- if { [string match "$tmpdir*" $value] } {
- return 1
- }
+ if { [string match "$tmpdir*" $value] } {
+ return 1
+ }
}
-
+
# Log details about this filter failing, to make it easier to debug.
ns_log Notice "ad_page_contract tmpfile filter on variable '$name' at URL '[ad_conn url]': The tmpfile given was '$value', and the list of valid directories is '$tmpdir_list'."
@@ -1771,54 +1771,54 @@
@creation-date 25 July 2000
} {
foreach date_element { day month year } {
- if { ![info exists date($date_element)] } {
- ad_complain [_ acs-tcl.lt_Invalid_date_date_ele]
- return 0
- }
+ if { ![info exists date($date_element)] } {
+ ad_complain [_ acs-tcl.lt_Invalid_date_date_ele]
+ return 0
+ }
}
-
+
# check if all elements are blank
if { "$date(day)$date(month)$date(year)" eq ""} {
- set date(date) {}
- return 1
- }
+ set date(date) {}
+ return 1
+ }
foreach date_element { day year } {
- if { ![regexp {^(0*)(([1-9][0-9]*|0))$} $date($date_element) match zeros real_value] } {
- ad_complain [_ acs-tcl.lt_Invalid_date_date_ele_1]
- return 0
- }
- set date($date_element) $real_value
+ if { ![regexp {^(0*)(([1-9][0-9]*|0))$} $date($date_element) match zeros real_value] } {
+ ad_complain [_ acs-tcl.lt_Invalid_date_date_ele_1]
+ return 0
+ }
+ set date($date_element) $real_value
}
if { $date(year) ne "" && [string length $date(year)] != 4 } {
- ad_complain [_ acs-tcl.lt_Invalid_date_The_year]
- return 0
- }
+ ad_complain [_ acs-tcl.lt_Invalid_date_The_year]
+ return 0
+ }
if { [regexp {^(0*)(([1-9][0-9]*|0))$} $date(month) match zeros real_value] } {
- set date(month) $real_value
+ set date(month) $real_value
} else {
set months_list {January February March April May June July August September October November December}
- set date(month) [expr {[lsearch $months_list $date(month)] + 1}]
+ set date(month) [expr {[lsearch $months_list $date(month)] + 1}]
}
if {
- "" eq $date(month)
- || "" eq $date(day)
- || "" eq $date(year)
- || $date(month) < 1 || $date(month) > 12
- || $date(day) < 1 || $date(day) > 31
- || $date(year) < 1
- || ($date(month) == 2 && $date(day) > 29)
- || (($date(year) % 4) != 0 && $date(month) == 2 && $date(day) > 28)
- || ($date(month) == 4 && $date(day) > 30)
- || ($date(month) == 6 && $date(day) > 30)
- || ($date(month) == 9 && $date(day) > 30)
- || ($date(month) == 11 && $date(day) > 30)
+ "" eq $date(month)
+ || "" eq $date(day)
+ || "" eq $date(year)
+ || $date(month) < 1 || $date(month) > 12
+ || $date(day) < 1 || $date(day) > 31
+ || $date(year) < 1
+ || ($date(month) == 2 && $date(day) > 29)
+ || (($date(year) % 4) != 0 && $date(month) == 2 && $date(day) > 28)
+ || ($date(month) == 4 && $date(day) > 30)
+ || ($date(month) == 6 && $date(day) > 30)
+ || ($date(month) == 9 && $date(day) > 30)
+ || ($date(month) == 11 && $date(day) > 30)
} {
- ad_complain [_ acs-tcl.lt_Invalid_date_datemont]
- return 0
+ ad_complain [_ acs-tcl.lt_Invalid_date_datemont]
+ return 0
}
set date(date) [format "%04d-%02d-%02d" $date(year) $date(month) $date(day)]
@@ -1832,40 +1832,40 @@
@creation-date 25 July 2000
} {
foreach time_element { time ampm } {
- if { ![info exists time($time_element)] } {
- ad_complain [_ acs-tcl.lt_Invalid_time_time_ele]
- return 0
- }
+ if { ![info exists time($time_element)] } {
+ ad_complain [_ acs-tcl.lt_Invalid_time_time_ele]
+ return 0
+ }
}
-
+
# check if all elements are blank
if { "$time(time)$time(ampm)" eq "" } {
- return 1
- }
+ return 1
+ }
set time_element_values [split $time(time) ":"]
if { [llength $time_element_values] != 3 } {
- ad_complain [_ acs-tcl.lt_Invalid_time_timetime]
- return 0
+ ad_complain [_ acs-tcl.lt_Invalid_time_timetime]
+ return 0
}
set time_element_names [list hours minutes seconds]
for { set i 0 } { $i < 3 } { incr i } {
- array set time [list [lindex $time_element_names $i] [lindex $time_element_values $i]]
+ array set time [list [lindex $time_element_names $i] [lindex $time_element_values $i]]
}
if {
- "" eq $time(hours)
- || "" eq $time(minutes)
- || "" eq $time(seconds)
- || (![string equal -nocase "pm" $time(ampm)] && ![string equal -nocase "am" $time(ampm)])
- || $time(hours) < 1 || $time(hours) > 12
- || $time(minutes) < 0 || $time(minutes) > 59
- || $time(seconds) < 0 || $time(seconds) > 59
+ "" eq $time(hours)
+ || "" eq $time(minutes)
+ || "" eq $time(seconds)
+ || (![string equal -nocase "pm" $time(ampm)] && ![string equal -nocase "am" $time(ampm)])
+ || $time(hours) < 1 || $time(hours) > 12
+ || $time(minutes) < 0 || $time(minutes) > 59
+ || $time(seconds) < 0 || $time(seconds) > 59
} {
- ad_complain [_ acs-tcl.lt_Invalid_time_timetime_1]
- return 0
+ ad_complain [_ acs-tcl.lt_Invalid_time_timetime_1]
+ return 0
}
return 1
@@ -1878,37 +1878,37 @@
@creation-date 25 July 2000
} {
if { ![info exists time(time)] } {
- ad_complain [_ acs-tcl.lt_Invalid_time_time_is_]
- return 0
+ ad_complain [_ acs-tcl.lt_Invalid_time_time_is_]
+ return 0
}
-
+
# check if all elements are blank
if { "$time(time)" eq "" } {
- return 1
- }
+ return 1
+ }
set time_element_values [split $time(time) ":"]
if { [llength $time_element_values] != 3 } {
- ad_complain [_ acs-tcl.lt_Invalid_time_timetime]
- return 0
+ ad_complain [_ acs-tcl.lt_Invalid_time_timetime]
+ return 0
}
set time_element_names [list hours minutes seconds]
for { set i 0 } { $i < 3 } { incr i } {
- array set time [list [lindex $time_element_names $i] [lindex $time_element_values $i]]
+ array set time [list [lindex $time_element_names $i] [lindex $time_element_values $i]]
}
if {
- "" eq $time(hours) \
- || "" eq $time(minutes) \
- || "" eq $time(seconds) \
- || $time(hours) < 0 || $time(hours) > 23 \
- || $time(minutes) < 0 || $time(minutes) > 59 \
- || $time(seconds) < 0 || $time(seconds) > 59
+ "" eq $time(hours) \
+ || "" eq $time(minutes) \
+ || "" eq $time(seconds) \
+ || $time(hours) < 0 || $time(hours) > 23 \
+ || $time(minutes) < 0 || $time(minutes) > 59 \
+ || $time(seconds) < 0 || $time(seconds) > 59
} {
- ad_complain [_ acs-tcl.lt_Invalid_time_timetime_2]
- return 0
+ ad_complain [_ acs-tcl.lt_Invalid_time_timetime_2]
+ return 0
}
return 1
@@ -1923,13 +1923,13 @@
} {
set actual_length [string length $value]
if { $actual_length < [lindex $range 0] } {
- set binding [list name $name actual_length $actual_length min_length [lindex $range 0]]
- ad_complain [_ acs-tcl.lt_name_is_too_short__Pl $binding]
- return 0
+ set binding [list name $name actual_length $actual_length min_length [lindex $range 0]]
+ ad_complain [_ acs-tcl.lt_name_is_too_short__Pl $binding]
+ return 0
} elseif { $actual_length > [lindex $range 1] } {
- set binding [list name $name actual_length $actual_length max_length [lindex $range 1]]
- ad_complain [_ acs-tcl.lt_name_is_too_long__Ple $binding]
- return 0
+ set binding [list name $name actual_length $actual_length max_length [lindex $range 1]]
+ ad_complain [_ acs-tcl.lt_name_is_too_long__Ple $binding]
+ return 0
}
return 1
}
@@ -1946,33 +1946,33 @@
set actual_length [string length $value]
lassign $length op nr
if { $op eq "min" } {
- if { $actual_length < $nr } {
- set binding [list name $name actual_length $actual_length min_length $nr]
- ad_complain [_ acs-tcl.lt_name_is_too_short__Pl_1]
- return 0
- }
+ if { $actual_length < $nr } {
+ set binding [list name $name actual_length $actual_length min_length $nr]
+ ad_complain [_ acs-tcl.lt_name_is_too_short__Pl_1]
+ return 0
+ }
} else {
- if { $actual_length > $nr } {
- set binding [list name $name actual_length $actual_length max_length $nr]
- ad_complain [_ acs-tcl.lt_name_is_too_long__Ple_1 $binding]
- return 0
- }
+ if { $actual_length > $nr } {
+ set binding [list name $name actual_length $actual_length max_length $nr]
+ ad_complain [_ acs-tcl.lt_name_is_too_long__Ple_1 $binding]
+ return 0
+ }
}
return 1
}
ad_page_contract_filter email { name value } {
Checks whether the value is a valid email address (stolen from
- philg_email_valid_p)
+ philg_email_valid_p)
@author Philip Greenspun (philip@mit.edu)
@author Randy Beggs (randyb@arsdigita.com)
@creation-date 22 August 20000
} {
set valid_p [regexp "^\[^@\t ]+@\[^@.\t]+(\\.\[^@.\n ]+)+$" $value]
if { !$valid_p } {
- ad_complain [_ acs-tcl.lt_name_does_not_appear_]
- return 0
+ ad_complain [_ acs-tcl.lt_name_does_not_appear_]
+ return 0
}
return 1
}
@@ -2010,10 +2010,10 @@
ad_page_contract_filter negative_float { name value } {
Same as float but allows negative numbers too
-
+
GN: this is deprecated, since "float" allows as well negative numbers
- @author Brian Fenton
+ @author Brian Fenton
@creation-date 1 December 2004
} {
# Check if the first character is a "+" or "-"
@@ -2046,7 +2046,7 @@
the area code. Specifically, area code excluding leading "1",
optionally enclosed in parentheses; followed by phone number in
the format xxx xxx xxxx (either spaces, periods or dashes
- separating the number). This filter matches the beginning of the
+ separating the number). This filter matches the beginning of the
value being checked, and considers any user input following the
match as valid (to allow for extensions, etc.). Add a
$ at the end of the regexp to disallow extensions. Examples:
@@ -2068,10 +2068,10 @@
@creation-date August 2000
} {
if { [string trim $value] ne "" } {
- if { ![regexp {^\(?([1-9][0-9]{2})\)?(-|\.|\ )?([0-9]{3})(-|\.|\ )?([0-9]{4})} $value] } {
- ad_complain [_ acs-tcl.lt_value_does_not_appear]
- return 0
- }
+ if { ![regexp {^\(?([1-9][0-9]{2})\)?(-|\.|\ )?([0-9]{3})(-|\.|\ )?([0-9]{4})} $value] } {
+ ad_complain [_ acs-tcl.lt_value_does_not_appear]
+ return 0
+ }
}
return 1
}
@@ -2085,10 +2085,10 @@
@author Randy Beggs (randyb@arsdigita.com)
@creation-date 22 August 2000
} {
- if { [string trim $value] ne ""
- && ![regexp {[1-9][0-9][0-9]-[0-9][0-9][0-9]-[0-9][0-9][0-9][0-9]} $value]} {
- ad_complain [_ acs-tcl.lt_name_does_not_appear__1]
- return 0
+ if { [string trim $value] ne ""
+ && ![regexp {[1-9][0-9][0-9]-[0-9][0-9][0-9]-[0-9][0-9][0-9][0-9]} $value]} {
+ ad_complain [_ acs-tcl.lt_name_does_not_appear__1]
+ return 0
}
return 1
}
@@ -2103,7 +2103,7 @@
} {
if {[string is boolean -strict $value]} {
- return 1
+ return 1
}
ad_complain [_ acs-tcl.lt_name_does_not_appear__2]
return 0
@@ -2118,29 +2118,29 @@
} {
if {[regexp {^\w+$} $value]} {
- return 1
+ return 1
}
ad_complain [_ acs-tcl.lt_name_is_not_a_word]
return 0
}
ad_page_contract_filter token { name value } {
- Checks whether the value is a Tcl word, or contains a few
+ Checks whether the value is a Tcl word, or contains a few
rather safe other characters (".", ",", "-") used e.g. in orderby.
@author Gustaf Neumann
@creation-date 24 June 2015
} {
if {[regexp {^[\w.,: -]+$} $value]} {
- return 1
+ return 1
}
ad_complain [_ acs-tcl.lt_name_contains_invalid]
return 0
}
ad_page_contract_filter path { name value } {
- Checks whether the value is a Tcl word, or contains a few
+ Checks whether the value is a Tcl word, or contains a few
rather safe other characters ("-", "/", ".") used
in (file-system) paths
@@ -2149,7 +2149,7 @@
} {
if {[regexp {^[\w/.-]+$} $value]} {
- return 1
+ return 1
}
ad_complain [_ acs-tcl.lt_name_contains_invalid]
return 0
@@ -2174,21 +2174,21 @@
####################
-#
+#
# Standard filter rules
#
####################
ad_page_contract_filter_rule html { name filters } {
- Makes sure the filter nohtml gets applied, unless some other html filter (html or allhtml)
+ Makes sure the filter nohtml gets applied, unless some other html filter (html or allhtml)
is already specified.
@author Lars Pind (lars@pinds.com)
@creation-date 25 July 2000
} {
foreach flag $filters {
- if { $flag in { nohtml html allhtml integer naturalnum word token } } {
- return
- }
+ if { $flag in { nohtml html allhtml integer naturalnum word token } } {
+ return
+ }
}
lappend filters nohtml
}
@@ -2199,7 +2199,7 @@
@creation-date 25 July 2000
} {
if { [string match "*tmpfile" $name] && "tmpfile" ni $filters } {
- lappend filters tmpfile
+ lappend filters tmpfile
}
}
@@ -2211,29 +2211,29 @@
####################
ad_proc ad_page_contract_verify_datasources {} {
- Check if all the datasources (properties) promised in the page contract have
- actually been set.
+ Check if all the datasources (properties) promised in the page contract have
+ actually been set.
- @author Chrisitan Brechbuehler
- @creation-date 13 Aug 2000
+ @author Chrisitan Brechbuehler
+ @creation-date 13 Aug 2000
} {
- # for now this is a dummy proc.
- # todo: check if all datasources are defined based on property declarations
- return 1; # ok
+ # for now this is a dummy proc.
+ # todo: check if all datasources are defined based on property declarations
+ return 1; # ok
}
-
+
ad_proc ad_page_contract_handle_datasource_error {error} {
- Output a diagnostic page. Treats both special and generic error messages.
+ Output a diagnostic page. Treats both special and generic error messages.
- @author Chrisitan Brechbuehler
- @creation-date 13 Aug 2000
+ @author Chrisitan Brechbuehler
+ @creation-date 13 Aug 2000
} {
set complaint_template [parameter::get_from_package_key \
- -package_key "acs-tcl" \
- -parameter "ReturnComplaint" \
- -default "/packages/acs-tcl/lib/ad-return-complaint"]
+ -package_key "acs-tcl" \
+ -parameter "ReturnComplaint" \
+ -default "/packages/acs-tcl/lib/ad-return-complaint"]
set exception_count 1
set exception_text $error
ns_return 422 text/html [ad_parse_template \
@@ -2260,9 +2260,9 @@
}
set validateCSRF_p [parameter::get \
-package_id $package_id \
- -parameter "ValidateCSRFP" \
+ -parameter "ValidateCSRFP" \
-default 1]
-
+
if {$validateCSRF_p ne "" && $validateCSRF_p} {
security::csrf::validate
}