Used to report a problem while validating user input. This proc does not in itself make your code terminate, you must call return if you do not want control to return to the caller.

Switches:

-key (optional)

Parameters:

message (optional)

Author:

Lars Pind <lars@pinds.com>

Created:

24 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

aa_page_contract_filters, ad_page_contract_filters, ad_complain

Returns the number of complaints encountered so far.

Author:

Lars Pind

Created:

25 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Returns the list of complaints encountered so far.

Author:

Lars Pind <lars@pinds.com>

Created:

24 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_complain

Initializes the complaints system.

Parameters:

context (required)

Author:

Lars Pind <lars@pinds.com>

Created:

24 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Parses the error-strings argument to ad_page_contract and stores the result in global variables, so it can be used by ad_complain.

Parameters:

errorstrings (required)

Author:

Lars Pind <lars@pinds.com>

Created:

25 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Sets the default errorkey to be used when ad_complaint is called. This essentially maintains a stack of errorkeys, so we can just say ad_complain without any arguments, when called from within some code that is surrounded by ad_complaints_with_key.

Parameters:

errorkey (required)

code (required)

Author:

Lars Pind

Created:

25 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Define an interface between a page and an ADP <include> similar to the page_contract. This is a light-weight implementation based on the ad_page_contract. It allows one to check the passed arguments (types, optionality) and can be used for setting defaults the usual way. Using ad_include_contracts helps to improve documentation of included content.

Parameters:

docstring (required)

documentation of the include

Author:

gustaf neumann <neumann@wu-wien.ac.at>

Created:

Sept 2015

See Also:

• ad_page_contract

Partial Call Graph (max 5 caller/called nodes):

Testcases:

page_contracts

Specifies the contract between programmer and graphic designer for a page. When called with the magic "documentation-gathering" flag set (to be defined), the proc will record the information about this page, so it can be displayed as documentation. When called during normal page execution, it will validate the query string and set corresponding variables in the caller's environment.

Example:

ad_page_contract  {
        Some documentation.
        @author me (my@email)
        @cvs-id $Id: tcl-documentation-procs.tcl,v 1.66 2024/11/13 08:43:48 gustafn Exp $
    } {
        foo
        bar:integer,notnull,multiple,trim
        {greble:integer {[expr {[lindex $bar 0] + 1}]}}
    } -validate {
        greble_is_in_range -requires {greble:integer} {
            if { $greble < 1 || $greble > 100 } {
                ad_complain
            }
        }
        greble_exists -requires { greble_is_in_range } {
            if { ![info exists ::greble_values($greble)] } {
                ad_complain [_ acs-tcl.lt_Theres_no_greble_with]
            }
        }
    } -errors {
        foo {error message goes here}
        bar:integer,notnull {another error message}
        greble_is_in_range {Greble must be between 1 and 100}
    }

1. {name[:flag,flag,flag] default}

2. name[:flag,flag,flag]

If no default value is specified, the argument is considered required, but the empty string is permissible unless you specify :notnull. For all arguments, the filter :nohtml is applied by default. If the arg is named *.tmpfile, the tmpfile filter is applied.

Possible flags are:

trim

The value will be string trimmed.

notnull

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 multiple variable, the filters will still be applied for other values, though.

optional

If there's a default value present, it's considered optional even without the flag. If a default is given, and the argument is present but blank, the default value will be used. Optional and no default value means the variable will not be set, if the argument is not present in the query string.

multiple

If multiple is specified, the var will be set as a list of all the argument values (e.g. arg=val1&arg=val2 will turn into arg=[list val1 val2]). The defaults are filled in from left to right, so it can depend on values of arguments to its left.

array

This syntax maps query variables into Tcl arrays. If you specify 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. If you use dot or comma is part of your key (i.e., y above contains comma or dot), then you can easily split on it in your Tcl code. Remember that you can use any other flag or filter with array.

verify

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 signature for the whole list. For :array it also expects one signature only, taken on the [array get] form of the array.

cached

This syntax will check to see if a value is being passed in for this variable. If it is not, it will then look in cache for this variable in the package that this page is located, and get this value if it exists.

date

Pluggable filter, installed by default, that makes sure the array validates as a date. Use this filter with :array to do automatic date filtering. To use it, set up in your HTML form a call to a date formfield. Then on the receiving page, specify the filter using varname:array,date. If the date validates, there will be a variable set in your environment varname with four keys: day, month, year, and date. 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 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 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 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, and removed any leading zeros.

naturalnum

Pluggable filter, installed by default, that makes sure the value is a natural number, i.e. non-decimal numbers >= 0.

oneof

Pluggable filter, installed by default, that makes sure the value X contained in the set of the provided values. Usage example: color:oneof(red|blue|green)

range

Pluggable filter, installed by default, that makes sure the value X is in range [Y, Z]. Usage example: foo:range(1|100)

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). 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

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 non-external url, which can be used in ad_returnredirect without throwing an error.

clock

Pluggable filter, installed by default, that makes sure that argument is a time string formatted according to the format specified in the flag. The format uses the syntax from the clock Tcl command. Usage example time:clock(%H:%M:%S).

more filters...

Note that there can be no spaces between name, 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 (space, tab, newline, possibly others) 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 can be used in place of flags (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).

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, the QQ-variables aren't necessary anymore, and thus, ad_page_contract doesn't waste time setting them.

Default Values

Errors Argument

Validation Blocks

-validate {
        name {
            code block
        }
        another_name -requires { argname[:filter-or-validation-block-name,...] ... } {
            code block
        }
    }

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 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 successfully validated as an integer.

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. You can have as many requirements as you like.

Switches:

-form (optional)

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.

-level (optional, defaults to "1")

-context (optional)

-warn (optional, boolean)

-properties (optional)

What properties the resulting document will contain.

Parameters:

docstring (required)

The documentation for your page; will be parsed like ad_proc and ad_library.

Authors:

Lars Pind <lars@pinds.com>

Yonatan Feldman <yon@arsdigita.com>

Bryan Quinn <bquinn@arsdigita.com>

Created:

16 June 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

page_contracts

Returns the regexp defining what an argspec flag should look like.

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

This just uplevels its args. We need this proc, so that the return -code statements get processed correctly inside a catch block. This processing is namely done by the proc invocation.

Author:

Lars Pind <lars@pinds.com>

Created:

25 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

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
    } {
        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
    }
    

    ad_page_contract {
        foo:integer
    } {}
    

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 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 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.

Switches:

-deprecated (optional, boolean)

used to flag a filter as deprecated

-type (optional, defaults to "filter")

The type of filter; i.e. filter or post. Default is filter.

-priority (optional, defaults to "1000")

Parameters:

name (required)

The name of the flag as used in ad_page_contract

proc_args (required)

the arguments to your filter. The filter must take three arguments, name, value, and parameters, although you can name them any way you want. The first will be set to the name of the variable, the second will be upvar'd to the value, so that any change you make to the value will be reflected in the value ultimately being set in the page's environment, and the third is a list of arguments to the filter. This third argument can have multiple parameters split by | with no spaces or any other characters. Something like foo:range(3|5)

doc_string (required)

Standard documentation-string. Tell other programmers what your filter does.

body (required)

The body is a procedure body that performs the filtering. It'll automatically have one argument named value set, and it must either return the possibly transformed value, or throw an error. The error message will be displayed to the user.

Author:

Lars Pind <lars@pinds.com>

Created:

25 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

page_contracts

Invokes a filter on the argument and returns the result (1 or 0). The value may be modified during the invocation of the filter.

Parameters:

filter (required)

the name of the filter to invoke

name (required)

the logical name of the variable to filter

value_varname (required)

the name of the variable holding the value to be filtered.

parameters (optional)

any arguments to pass to the filter

Authors:

Lars Pind <lars@pinds.com>

Yonatan Feldman <yon@arsdigita.com>

Created:

25 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Returns the type of proc that executes the given ad_page_contract filter, or the empty string if the filter is not defined.

Parameters:

filter (required)

Author:

Lars Pind <lars@pinds.com>

Created:

25 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Returns the proc that executes the given ad_page_contract filter.

Parameters:

filter (required)

Author:

Lars Pind <lars@pinds.com>

Created:

25 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

aa_page_contract_filters, ad_page_contract_filters

Allows any html tags (a no-op filter)

Parameters:

name (required)

value_varname (required)

Author:

Lars Pind <lars@pinds.com>

Created:

25 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Checks whether the value is boolean (1 or 0) or predicate (t or f) or otherwise a 2 state value (true or false, y or n, yes or no)

Parameters:

name (required)

value_varname (required)

Author:

Randy Beggs <randyb@arsdigita.com>

Created:

23 August 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Ensures the supplied date string is in one of the specified clock formats.

Parameters:

name (required)

value_varname (required)

formats (optional, defaults to "%Y-%m-%d")

Author:

Antonio Pisano

See Also:

• clock

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Validates date type variables

Parameters:

name (required)

date_varname (required)

Author:

Yonatan Feldman <yon@arsdigita.com>

Created:

25 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Ensure that the value can be used in an SQL query. Note that this is not the same as quoting or otherwise ensuring the safety of the statement itself. What we enforce here is that the value will be accepted by the db interface without complaining. The actual definition may change or be database specific in the future.

Parameters:

name (required)

value_varname (required)

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Checks whether the value is a valid email address (stolen from philg_email_valid_p)

Parameters:

name (required)

value_varname (required)

Authors:

Philip Greenspun <philip@mit.edu>

Randy Beggs <randyb@arsdigita.com>

Created:

22 August 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Checks to make sure that the value in question is a valid number, possibly with a decimal point - randyb took this from the ACS dev bboard

Parameters:

name (required)

value_varname (required)

Author:

Steven Pulito <stevenp@seas.upenn.edu>

Created:

22 August 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Checks whether the value contains naughty HTML

Parameters:

name (required)

value_varname (required)

Author:

Lars Pind <lars@pinds.com>

Created:

25 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

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.

Parameters:

name (required)

value_varname (required)

Author:

Lars Pind <lars@pinds.com>

Created:

25 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters, page_contracts

Checks whether the value is an acceptable (non-external) url, which can be used in ad_returnredirect without throwing an error.

Parameters:

name (required)

value_varname (required)

Author:

Gustaf Neumann

Created:

19 Mai 2016

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

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.

Parameters:

name (required)

value_varname (required)

Author:

Lars Pind <lars@pinds.com>

Created:

25 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Same as float but allows negative numbers too GN: this is deprecated, since "float" allows as well negative numbers

Parameters:

name (required)

value_varname (required)

Author:

Brian Fenton

Created:

1 December 2004

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Doesn't allow any HTML to pass through.

Parameters:

name (required)

value_varname (required)

Author:

Lars Pind <lars@pinds.com>

Created:

25 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Checks whether the value is a valid object_id, i.e. in the range defined for the SQL datatype "integer", which is the same for Oracle and PostgreSQL. In case, object_types are altered in future versions of OpenACS to e.g. "longinteger", this function has to be adjusted as well. The function is essentially the same as ad_page_contract_filter "integer", but with the additional value range check.

Parameters:

name (required)

value_varname (required)

Author:

Gustaf Neumann

Created:

May 23, 2021

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Checks whether the supplied object_id is an acs_object of one of the types specified in the flag parameters. The check will take the object_type hierarchy into account e.g. will always succeed if one of the types is "acs_object". In this case the filter will just behave as an existence check. Example: some_user_id:object_type(user),notnull

Parameters:

name (required)

object_id_varname (required)

types (required)

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Checks whether the value is contained in the set of provided values. Example spec: w:oneof(red|green)

Parameters:

name (required)

value_varname (required)

set (required)

Author:

Gustaf Neumann

Created:

Feb, 2018

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Checks whether the value is a Tcl word, or contains a few rather safe other characters ("-", "/", ".") used in (file-system) paths

Parameters:

name (required)

value_varname (required)

Author:

Gustaf Neumann

Created:

24 June 2015

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Checks whether the value is more or less a valid phone number with 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 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:

• (800) 888-8888 will pass
• 800-888-8888 will pass
• 800.888.8888 will pass
• 8008888888 will pass
• (800) 888-8888 extension 405 will pass
• (800) 888-8888abcd will pass
• "" (the empty string) will pass
• 1-800-888-8888 will fail
• 10-10-220 800.888.8888 will fail
• abcd(800) 888-8888 will fail

Parameters:

name (required)

value_varname (required)

Author:

Randy Beggs <randyb@arsdigita.com>

Created:

August 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Checks whether the value contains only characters with a printable representation. This represents character class of the Tcl character class "print", which consists of the characters with a visible representation and space. This filter is useful for e.g. avoiding invalid byte sequences for the database.

Parameters:

name (required)

value_varname (required)

Author:

Gustaf Neumann

Created:

22 April 2021

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Checks whether the value falls between the specified range. Range must be a list of two elements: min and max. Example spec: w:range(3|7)

Parameters:

name (required)

value_varname (required)

range (required)

Author:

Yonatan Feldman <yon@arsdigita.com>

Created:

August 18, 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Checks whether the value contains just characters, which can be used safely in a Tcl eval or subst command. This means, that the characters '$', '[', ']' and '\' disallowed,.

Parameters:

name (required)

value_varname (required)

Author:

Gustaf Neumann

Created:

15 Mar 2023

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Checks whether the value is a valid SQL identifier

Parameters:

name (required)

value_varname (required)

Author:

Lars Pind <lars@pinds.com>

Created:

25 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Checks whether the string is less or greater than the minimum or maximum length specified, inclusive e.g.address_1:notnull,string_length(max|100) will test address_1 for maximum length of 100.

Parameters:

name (required)

value_varname (required)

length (required)

Author:

Randy Beggs <randyb@arsdigita.com>

Created:

August 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Checks whether the string is within the specified range, inclusive

Parameters:

name (required)

value_varname (required)

range (required)

Author:

Randy Beggs <randyb@arsdigita.com>

Created:

August 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Validates time type variables of the regular variety (that is 8:12:21 PM)

Parameters:

name (required)

time_varname (required)

Author:

Yonatan Feldman <yon@arsdigita.com>

Created:

25 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Validates time type variables of the 24HR variety (that is 20:12:21)

Parameters:

name (required)

time_varname (required)

Author:

Yonatan Feldman <yon@arsdigita.com>

Created:

25 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Validate a tmpfile path. This must exist, be a direct child of the configured tmpfolder in the server-wide parameter and be readable and writable by the current user. Example usage: uploaded_file.tmpfile:tmpfile,optional

Parameters:

name (required)

value_varname (required)

Author:

Lars Pind <lars@pinds.com>

Created:

25 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Checks whether the value is a Tcl word, or contains a few rather safe other characters (".", ",", "-") used e.g. in orderby.

Parameters:

name (required)

value_varname (required)

Author:

Gustaf Neumann

Created:

24 June 2015

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

Checks whether the value is more or less a valid US phone number with the area code. Exact filter is XXX-XXX-XXXX DEPRECATED: this filter is US-specific. One should use less specific alternatives.

Parameters:

name (required)

value_varname (required)

Author:

Randy Beggs <randyb@arsdigita.com>

Created:

22 August 2000

See Also:

• ad_page_contract_filter_proc_phone

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Checks whether the value is a Tcl word, i.e. it consists of just characters, digits and underscore.

Parameters:

name (required)

value_varname (required)

Author:

Gustaf Neumann

Created:

24 June 2015

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_filters

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.

Unlike the filters themselves (registered with ad_page_contract_filter), all rules are always applied to all formal arguments of all pages.

Parameters:

name (required)

filter rules must be named. The name isn't referred to anywhere.

proc_args (required)

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.

doc_string (required)

let other programmers know what your filter rule does.

body (required)

the code to manipulate the filter list.

Author:

Lars Pind <lars@pinds.com>

Created:

25 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Returns the proc that executes the given ad_page_contract default-filter.

Parameters:

filter (required)

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Makes sure the filter nohtml gets applied, unless some other html filter (html or allhtml) is already specified.

Parameters:

name (required)

filters_varname (required)

Author:

Lars Pind <lars@pinds.com>

Created:

25 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Makes sure the tmpfile filter gets applied for all vars named *.tmpfile.

Parameters:

name (required)

filters_varname (required)

Author:

Lars Pind <lars@pinds.com>

Created:

25 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Returns the proc that executes the given ad_page_contract default-filter.

Parameters:

filter (required)

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Returns the type of proc that executes the given ad_page_contract filter, or the empty string if the filter is not defined.

Parameters:

filter (required)

Author:

Lars Pind <lars@pinds.com>

Created:

25 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Returns the type of proc that executes the given ad_page_contract filter, or the empty string if the filter is not defined.

Parameters:

filter (required)

Author:

Lars Pind <lars@pinds.com>

Created:

25 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Find out whether the named validation block has been passed or not.

Parameters:

key (required)

Is the key, in the format of either formal_name or formal_name:flag_name.

Author:

Lars Pind <lars@pinds.com>

Created:

24 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Returns a list of all the formal variables specified in ad_page_contract. If no variables have been specified, returns an empty list.

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Output a diagnostic page. Treats both special and generic error messages.

Parameters:

error (required)

Author:

Christian Brechbuehler

Created:

13 Aug 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Parse the argument spec: this is a string in the form <name>:<flag_spec>[,<flag_spec>...]

• <name> is a token made of any non-space, non-tab and non-colon
• <flag_spec> is string in the form <flag_name&lgt;[(<flag_parameter>[|<flag_parameter>...])]
• <flag_parameter> is a string containing arbitrary characters, however, because parenthesys ")" and "(" and pipe "|" are separators in the argspec syntax, they need to be escaped via the character backslash (\)

    - my_page_parameter
    - my_page_parameter:integer
    - my_page_parameter:integer,notnull
    - my_page_parameter:integer,notnull,oneof(1|2|3)
    - another_page_parameter:oneof(this is valid|This, is also valid|This is valid \(as well!\))

Parameters:

arg_spec (required)

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_argspec_parsing

Call this to signal that a certain validation block has passed successfully. This can be tested later using ad_page_contract_get_validation_passed_p.

Parameters:

key (required)

Is the key, in the format of either formal_name or formal_name:flag_name.

Author:

Lars Pind <lars@pinds.com>

Created:

24 July 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

aa_page_contract_filters, ad_page_contract_filters

Splits the flag parameters from an argespec into a list of values. Flag parameters are a list of values expressed as <value>[|<value> ...]

Parameters:

flag_parameters (required)

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_argspec_parsing

Splits the flags in an argspec definition into a list.

Parameters:

flags (required)

Partial Call Graph (max 5 caller/called nodes):

Testcases:

ad_page_contract_argspec_parsing

Check if all the datasources (properties) promised in the page contract have actually been set.

Author:

Christian Brechbuehler

Created:

13 Aug 2000

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Determines whether the thread is in "gathering documentation" or "executing the page" mode.

Returns:

true if the thread is in "gathering documentation" mode, or false otherwise.

See Also:

• doc_set_page_documentation_mode

Partial Call Graph (max 5 caller/called nodes):

Testcases:

package_normalize_path, xowiki_test_cases, link_tests, slot_interactions, path_resolve

Set a flag in the environment determining whether the thread is in "gathering documentation" or "executing the page" mode.

Parameters:

page_documentation_mode_p (required)

true to set the "gathering documentation" flag, or false to clear it.

See Also:

• api_page_documentation_mode_p

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

validate a csrf token

Switches:

-package_id (optional)

Author:

Gustaf Neumann

Created:

Feb 2, 2017

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.