Parameters:

set_id

Parameters:

content_type (defaults to "text/html")

A filter that detect attempts to smuggle in SQL code through form data variables. The use of bind variables and ad_page_contract input validation to prevent SQL smuggling is preferred.

Parameters:

conn
args
why

See Also:

• ad_page_contract

Parameters:

url
persistent (defaults to "f")
excluded_vars (optional)

Author:

Brad Duell <bduell@ncacasi.org>

Parameters:

proc

Switches:

-bind (optional)

Parameters:

statement_name
table_name
id_column_name
generated_id
return_url
insert_dml

Note This proc is deprecated in favor of export_vars. They're very similar, but export_vars have a number of advantages:

• It can sign variables (the the :sign flag)
• It can export variables as a :multiple.
• It can export arrays with on-the-fly values (not pulled from the environment)

Helps export variables from one page to the next, either as URL variables or hidden form variables. It'll reach into arrays and grab either all values or individual values out and export them in a way that will be consistent with the ad_page_contract :array flag.

Example:

doc_body_append [ad_export_vars { msg_id user(email) { order_by date } }]

The args is a list of variable names that you want exported. You can name

• a scalar varaible, foo,
• the name of an array, bar, in which case all the values in that array will get exported, or
• an individual value in an array, bar(baz)
• a list in [array get] format { name value name value ..}. The value will get substituted normally, so you can put a computation in there.

A more involved example:

set my_vars { msg_id user(email) order_by }
doc_body_append [ad_export_vars -override { order_by $new_order_by } $my_vars]

Switches:

-form (boolean) (optional)

set this parameter if you want the variables exported as hidden form variables, as opposed to URL variables, which is the default.

-exclude (optional)

takes a list of names of variables you don't want exported, even though they might be listed in the args. The names take the same form as in the args list.

-override (optional)

takes a list of the same format as args, which will get exported no matter what you have excluded.

Parameters:

include (optional)

Author:

Lars Pind <lars@pinds.com>

Created:

21 July 2000

See Also:

• export_vars

Parameters:

length (defaults to "8")

Switches:

-include_set_cookies (defaults to "t") (optional)

Parameters:

name
default (optional)

Parameters:

level (defaults to "-2") - The level to start from, relative to this proc. Defaults to -2, meaning the proc that called this proc's caller.

Author:

Lars Pind <lars@pinds.com>

See Also:

• ad_print_stack_trace

Switches:

-url (optional)

-headers (optional)

-timeout (defaults to "30") (optional)

-depth (defaults to "0") (optional)

Switches:

-colon (boolean) (optional)

If set, will prepend all the keys with a colon; useful for bind variables

-exclude (optional)

Optional Tcl list of key names to exclude

Parameters:

set_id

Author:

Lars Pind <lars@pinds.com>

Switches:

-duplicates (defaults to "overwrite") (optional)

This optional switch argument defines what happens if the Tcl var already exists, or if there are duplicate entries for the same key. overwrites just overwrites the var, which amounts to letting the ns_set win over pre-defined vars, and later entries in the ns_set win over earlier ones. ignore means the variable isn't overwritten. fail will make this proc fail with an error. This makes it easier to track subtle errors that could occur because of unpredicted name clashes.

-level (defaults to "1") (optional)

The level to upvar to.

Parameters:

set_id

Author:

Lars Pind <lars@pinds.com>

Parameters:

first_part_of_page
content_type (defaults to "text/html")

This proc is a replacement for ns_returnredirect, but improved in two important respects:

• When the supplied target_url isn't complete, (e.g. /foo/bar.tcl or foo.tcl) the prepended location part is constructed by looking at the HTTP 1.1 Host header.
• If an URL relative to the current directory is supplied (e.g. foo.tcl) it prepends location and directory.

Switches:

-message (optional)

A message to display to the user. See util_user_message.

-html (boolean) (optional)

Set this flag if your message contains HTML. If specified, you're responsible for proper quoting of everything in your message. Otherwise, we quote it for you.

-allow_complete_url (boolean) (optional)

By default we disallow redirecting to urls outside the current host. This is based on the currently set host header or the host name in the config file if there is no host header. Set allow_complete_url if you are redirecting to a known safe external web site. This prevents redirecting to a site by URL query hacking.

Parameters:

target_url

See Also:

• util_user_message
• ad_script_abort

Switches:

-thread (defaults to "f") (optional)

t/f If true run scheduled proc in its own thread

-once (defaults to "f") (optional)

t/f. If true only run the scheduled proc once

-debug (defaults to "f") (optional)

t/f If true log debugging information

-all_servers (defaults to "f") (optional)

If true run on all servers in a cluster

-schedule_proc (optional)

ns_schedule_daily, ns_schedule_weekly or blank

Parameters:

interval - If schedule_proc is empty, the interval to run the proc in seconds, otherwise a list of interval arguments to pass to ns_schedule_daily or ns_schedule_weekly
proc - The proc to schedule

Switches:

-replace (defaults to "f") (optional)

forces the current output headers to be checked for the same cookie. If the same cookie is set for a second time without the replace option being specified, the client will receive both copies of the cookie.

-secure (defaults to "f") (optional)

specifies to the user agent that the cookie should only be transmitted back to the server of secure transport.

-expire (defaults to "f") (optional)

specifies whether we should expire (clear) the cookie. Setting Max-Age to zero ought to do this, but it doesn't in some browsers (tested on IE 6).

-max_age (optional)

specifies the maximum age of the cookies in seconds (consistent with RFC 2109). max_age inf specifies cookies that never expire. The default behavior is to issue session cookies.

-domain (optional)

specifies the domain(s) to which this cookie applies. See RFC2109 for the semantics of this cookie attribute.

-path (defaults to "/") (optional)

specifies a subset of URLs to which this cookie applies. It must be a prefix of the URL being accessed.

Parameters:

name
value (optional) - is autmatically URL encoded.

See Also:

• ad_get_cookie

    #
    # Register special rules for form variables.
    #
    # Example:
    #
    #    ad_set_typed_form_variable_filter /my_module/* {a_id number} {b_id word} {*_id integer}
    #
    # For all pages under /my_module, set_form_variables would set 
    # $a_id only if it was number, and $b_id only if it was a 'word' 
    # (a string that contains only letters, numbers, dashes, and 
    # underscores), and all other variables that match the pattern
    # *_id would be set only if they were integers.
    #
    # Variables not listed have no restrictions on them.
    #
    # By default, the three supported datatypes are 'integer', 'number',
    # and 'word', although you can add your own type by creating
    # functions named ad_var_type_check_${type_name}_p which should
    # return 1 if the value is a valid $type_name, or 0 otherwise.
    #
    # There's also a special datatype named 'nocheck', which will
    # return success regardless of the value. (See the docs for 
    # ad_var_type_check_${type_name}_p to see how this might be
    # useful.)
    #
    # The default data_type is 'integer', which allows you shorten the
    # command above to:
    #
    #    ad_set_typed_form_variable_filter /my_module/* a_id {b_id word}
    #

    ad_page_contract is the preferred mechanism to do automated
    validation of form variables.
    

Parameters:

url_pattern

See Also:

• ad_page_contract

Switches:

-set_id (optional)

If this switch is specified, it'll use this set instead of creating a new one.

-put (boolean) (optional)

If this boolean switch is specified, it'll use ns_set put instead of ns_set update (update is default)

Parameters:

kv_pairs - A list of lists containing key/value pairs to be stuffed into the ns_set

Author:

Yonatan Feldman <yon@arsdigita.com>

Switches:

-set_id (optional)

If this switch is specified, it'll use this set instead of creating a new one.

-put (boolean) (optional)

If this boolean switch is specified, it'll use ns_set put instead of ns_set update (update is default)

Parameters:

vars_list

Author:

Lars Pind <lars@pinds.com>

Switches:

-set_id (optional)

If this switch is specified, it'll use this set instead of creating a new one.

-put (boolean) (optional)

If this boolean switch is specified, it'll use ns_set put instead of ns_set update (update is default)

Author:

Lars Pind <lars@pinds.com>

Parameters:

string

    #
    # return 0 if $value contains a / or \, 1 otherwise.
    #
    
	


Parameters:

value

    #
    # A check that always returns 0. Useful if you want to disable all access
    # to a page.
    #
    
	


Parameters:

value

    #
    # return 1 if $value is an integer, 0 otherwise.
    #
    
	


Parameters:

value

    #
    # return 1 if list contains only numbers, spaces, and commas.
    # Example '5, 3, 1'. Note: it doesn't allow negative numbers,
    # because that could let people sneak in numbers that get
    # treated like math expressions like '1, 5-2'
    #
    #
    
	


Parameters:

value

    #
    # return 1 regardless of the value. This useful if you want to 
    # set a filter over the entire site, then create a few exceptions.
    #
    # For example:
    #
    #   ad_set_typed_form_variable_filter /my-dangerous-page.tcl {user_id nocheck}
    #   ad_set_typed_form_variable_filter /*.tcl user_id
    #
    

Parameters:

value (optional)

    #
    # return 1 if $value contains any single-quotes
    #
    
	


Parameters:

value

    #
    # return 1 if $value is a valid number
    #
    
	


Parameters:

value

    #
    # return 0 if the file contains ".."
    #
    
	


Parameters:

value

    #
    # Returns 1 if the third path element in the URL is integer.
    #
    
	


Parameters:

args (optional)

    #
    # return 1 if $value contains only letters, numbers, dashes, 
    # and underscores, otherwise returns 0.
    #
    

Parameters:

value

Parameters:

func
arglist

Parameters:

name
value

Switches:

-bind (optional)

-select_option (optional)

Parameters:

stmt_name
sql

Author:

yon [yon@arsdigita.com]

Switches:

-bind (optional)

-select_option (defaults to "[list]") (optional)

-value_index (defaults to "0") (optional)

-option_index (defaults to "1") (optional)

Parameters:

stmt_name
sql

Author:

yon [yon@arsdigita.com]

Parameters:

varname
value

Author:

Peter Marklund

See Also:

• exists_and_not_null

Parameters:

varname

See Also:

• export_vars

Parameters:

vars_to_passthrough (optional)

See Also:

• export_vars

Exports a number of variables as hidden input fields in a form. Specify a list of variable names. The proc will reach up in the caller's name space to grab the value of the variables. Variables that are not defined are silently ignored. You can append :multiple to the name of a variable. In this case, the value will be treated as a list, and each of the elements output separately.

export_vars is now the prefered interface.

Example usage: [export_form_vars -sign foo bar:multiple baz]

Switches:

-sign (boolean) (optional)

If this flag is set, all the variables output will be signed using ad_sign. These variables should then be verified using the :verify flag to ad_page_contract, which in turn uses ad_verify_signature. This ensures that the value hasn't been tampered with at the user's end.

See Also:

• export_vars

Parameters:

format (defaults to "url") - either url or form
exclusion_list (optional) - list of fields to exclude
setid (optional) - if null then it is ns_getform

See Also:

• export_vars

Instead of naming a variable you can also say name=value. Note that the value here is not the name of a variable but the literal value you want to export e.g., export_url_vars [ns_urlencode foo]=[ns_urlencode $the_value].

For normal variables, you can say export_url_vars foo:multiple. In this case, the value of foo will be treated as a Tcl list, and each value will be output separately e.g., foo=item0&foo=item1&foo=item2...

You cannot combine the foo=bar syntax with the foo:multiple syntax. Why? Because there's no way we can distinguish between the :multiple being part of the value of foo or being a flag intended for export_url_vars.

Switches:

-sign (boolean) (optional)

If this flag is set, all the variables output will be signed using ad_sign. These variables should then be verified using the :verify flag to ad_page_contract, which in turn uses ad_verify_signature. This ensures that the value hasn't been tampered with at the user's end.

See Also:

• export_vars

Example usage: [export_vars -form { foo bar baz }]

This will export the three variables foo, bar and baz as hidden HTML form fields. It does exactly the same as [export_form_vars foo bar baz].

Example usage: [export_vars -url -sign -override {{foo "new value"}} -exclude { bar } { foo bar baz }]

This will export a variable named foo with the value "new value" and a variable named baz with the value of baz in the caller's environment. Since we've specified that bar should be excluded, bar won't get exported even though it's specified in the last argument. Additionally, even though foo is specified also in the last argument, the value we use is the one given in the override argument. Finally, both variables are signed, because we specified the -sign switch.

You can specify variables with three different precedences, namely override, exclude or vars. If a variable is present in override, that's what'll get exported, no matter what. If a variable is in exclude and not in override, then it will not get output. However, if it is in vars and not in either of override or exclude, then it'll get output. In other words, we check override, exclude and vars in that order of precedence.

The two variable specs, vars and override both look the same: They take a list of variable specs. Examples of variable specs are:

• foo
• foo:multiple,sign
• {foo "the value"}
• {foo {[my_function arg]}}
• {foo:array,sign {[array get my_array]}}

Right after the name, you may specify a colon and some flags, separated by commas. Valid flags are:

multiple

Treat the value as a list and output each element separately.

array

The value is an array and should be exported in a way compliant with the :array flag of ad_page_contract, which means that each entry will get output as name.key=value.

If you don't specify a value directly, but want it pulled out of the Tcl environment, then you don't need to specify :array. If you do, and the variable is in fact not an array, an error will be thrown.

sign

Sign this variable. This goes hand-in-hand with the :verify flag of ad_page_contract and makes sure that the value isn't tampered with on the client side. The -sign switch to export_vars, is a short-hand for specifying the :sign switch on every variable.

Intended use: A page may have a set of variables that it cares about. You can store this in a variable once and pass that to export_vars like this:

set my_vars { user_id sort_by filter_by }
... [export_vars $my_vars] ...

Then, say one of them contains a column to filter on. When you want to clear that column, you can say [export_vars -exclude { filter_by } $my_vars].

Similarly, if you want to change the sort order, you can say [export_vars -override { { sort_by $column } } $my_vars], and sorting will be done according to the new value of column.

If the variable name contains a colon (:), that colon must be escaped with a backslash, so for example "form:id" becomes "form\:id". Sorry.

Switches:

-sign (boolean) (optional)

Sign all variables.

-form (boolean) (optional)

Export in form format. You can't specify both URL and form format.

-url (boolean) (optional)

Export in URL format. This is the default.

-quotehtml (boolean) (optional)

HTML quote the entire resulting string. This is an interim solution while we're waiting for the templating system to do the quoting for us.

-entire_form (boolean) (optional)

Export the entire form from the GET query string or the POST.

-no_empty (boolean) (optional)

-base (optional)

-anchor (optional)

-exclude (optional)

-override (optional)

Parameters:

vars (optional)

Options:

-no_empty

If specified, variables with an empty string value will be suppressed from being exported. This avoids cluttering up the URLs with lots of unnecessary variables.

-base

The base URL to make a link to. This will be prepended to the query string along with a question mark (?), if the query is non-empty. so the returned string can be used directly in a link. This is only relevant to URL export.

Author:

Lars Pind <lars@pinds.com>

Created:

December 7, 2000

Parameters:

list
proc_name

Author:

Lars Pind <lars@pinds.com>

Created:

31 August 2000

Switches:

-bind (optional)

A ns_set stuffed with bind variables for the sql_qry.

Parameters:

form - the form to be stuffed.
statement_name - An identifier for the sql_qry to be executed.
sql_qry - The sql that must be executed.

Author:

Ken Mayer <kmayer@bitwrangler.com>

Created:

26 September 2002

Parameters:

seed

Parameters:

range

Returns:

integer

Parameters:

old_set_id

Returns:

new ns_set

Switches:

-timestamp_ansi (required)

The older timestamp in full ANSI: YYYY-MM-DD HH24:MI:SS

-sysdate_ansi (required)

The newer timestamp.

-hours_limit (defaults to "12") (optional)

The upper limit, in hours, for mode 1.

-days_limit (defaults to "3") (optional)

The upper limit, in days, for mode 2.

-mode_2_fmt (defaults to "%X, %A") (optional)

A formatting string, as per lc_time_fmt, for mode 2

-mode_3_fmt (defaults to "%X, %d %b %Y") (optional)

A formatting string, as per lc_time_fmt, for mode 3

-locale (optional)

If present, overrides the default locale

Returns:

Interval between timestamp and sysdate, as localized text string.

Parameters:

list
indent (defaults to "0")

Switches:

-file_path (required)

-backup_suffix (defaults to ".bak") (optional)

The suffix to add to the backup file.

Author:

Peter Marklund

Parameters:

command - A list of arguments to pass to exec
result_var - Variable name in caller's scope to set the result in

Returns:

0 or 1. 0 if no error, 1 if an error occured. If an error occured the error message will be put into result_var in the caller's scope.

Author:

Dave Bauer

Created:

2008-01-28

Parameters:

time

Parameters:

url

Switches:

-include_dirs (defaults to "0") (optional)

Should directories be included in the list of files.

-max_depth (defaults to "1") (optional)

How many levels of directories should be searched. Defaults to 1 which is the current directory

-check_file_func (optional)

Function which can be executed upon the file to determine if it is worth the effort

-extension (optional)

Only return files with this extension (single value !)

-path (required)

The path in which to search for the files. Note that this is an absolute Path

Returns:

list of lists (filename and full_path) of all files found.

Switches:

-seconds (defaults to "0") (optional)

Parameters:

list

Parameters:

list

Parameters:

s1

Parameters:

s1
s2

Parameters:

string

Parameters:

prog - name of the program to be located on the search path

Returns:

fully qualified name including path, when specified program is found, or otherwise empty string

Author:

Gustaf Neumann Use environment variable PATH to search for the specified executable program. Replacement for UNIX command "which", avoiding exec. exec which: 3368.445 microseconds per iteration ::util::which: 282.372 microseconds per iteration In addition of being more than 10 time faster than the version via exec, this version is less platform dependent.

Switches:

-old (required)

The original text.

-new (required)

The modified text.

-split_by (optional)

If split_by is a space, the diff will be made on a word-by-word basis. If it is the empty string, it will be made on a char-by-char basis.

-filter_proc (defaults to "ad_quotehtml") (optional)

A filter to run the old/new text through before doing the diff and inserting the HTML fragments below. Keep in mind that if the input text is HTML, and the start_old, etc... fragments are inserted at arbitrary locations depending on where the diffs are, you might end up with invalid HTML unless the original HTML is quoted.

-start_old (defaults to "") (optional)

HTML fragment to place before text that has been removed.

-end_old (defaults to "") (optional)

HTML fragment to place after text that has been removed.

-start_new (defaults to "") (optional)

HTML fragment to place before new text.

-end_new (defaults to "") (optional)

HTML fragment to place after new text.

Author:

Gabriel Burca

See Also:

• ad_quotehtml

Parameters:

sql_date

Parameters:

zero_or_one

Parameters:

url
seconds_delay (defaults to "0")

Parameters:

path

Switches:

-pass_vars (optional)

Names of variables which you want passed to the code chunk

-name (required)

The name of the thread. No two chunks with the same name can run at the same time.

Parameters:

code_chunk - The chunk you want executed

Switches:

-name (required)

Switches:

-name (required)

Switches:

-name (required)

Parameters:

num

Parameters:

string

We can't just use [file dirname [ad_conn url]] because we want /foo/bar/ to return /foo/bar/ and not /foo .

Also, we want to return directory WITH the trailing slash so that programs that use this proc don't have to treat the root directory as a special case.

Authors:

Lars Pind <lars@collaboraid.biz>

Peter Marklund

Switches:

-array (required)

the array to populate with proto and port

-driver (optional)

the driver to query (defaults to [ad_conn driver])

Parameters:

email

Author:

yon <yon@openforce.net>

Parameters:

query_email

Authors:

Philip Greenspun <philg@mit.edu>

Jeff Friedl <jfriedl@oreilly.com>

Lars Pind <lars@arsdigita.com>

Parameters:

string

Returns:

URL for the current page

Author:

Lars Pind <lars@pinds.com>

Created:

February 11, 2003

Parameters:

url
use_get_p (defaults to "1")
timeout (defaults to "30")

Parameters:

list1
list2

Returns:

The list of elements from list1 that could not be found in list2.

Author:

Peter Marklund

Switches:

-keep (boolean) (optional)

If set, then we will not clear the list of messages after getting them. Normal behavior is to clear them, so we only display the same messages once.

-multirow (required)

Name of a multirow in the current template namespace where you want the user messages set. The multirow will have one column, which is 'message'.

See Also:

• util_user_message

Similar to util_httppost, but enhanced to be able to upload a file as multipart/form-data. Also useful for posting to forms that require their input to be encoded as multipart/form-data instead of as application/x-www-form-urlencoded.

The switches -file /path/to/file and -data $raw_data are mutually exclusive. You can specify one or the other, but not both. NOTE: it is perfectly valid to not specify either, in which case no file is uploaded, but form variables are encoded using multipart/form-data instead of the usual encoding (as noted aboved).

If you specify either -file or -data you must supply a value for -name, which is the name of the <INPUT TYPE="file" NAME="..."> form tag.

Specify the -binary switch if the file (or data) needs to be base-64 encoded. Not all servers seem to be able to handle this. (For example, http://mol-stage.usps.com/mml.adp, which expects to receive an XML file doesn't seem to grok any kind of Content-Transfer-Encoding.)

If you specify -file then -filename is optional (it can be infered from the name of the file). However, if you specify -data then it is mandatory.

If -mime_type is not specified then ns_guesstype is used to try and find a mime type based on the filename. If ns_guesstype returns */* the generic value of application/octet-stream will be used.

Any form variables may be specified in one of four formats:

• array (list of key value pairs like what [array get] returns)
• formvars (list of url encoded formvars, i.e. foo=bar&x=1)
• ns_set (an ns_set containing key/value pairs)
• vars (a list of tcl vars to grab from the calling enviroment)

-rqset specifies an ns_set of extra headers to send to the server when doing the POST.

timeout, depth, and http_referer are optional, and are included as optional positional variables in the same order they are used in util_httppost. NOTE: util_http_file_upload does not (currently) follow any redirects, so depth is superfulous.

Switches:

-file (optional)

-data (optional)

-binary (boolean) (optional)

-filename (optional)

-name (optional)

-mime_type (defaults to "*/*") (optional)

-mode (defaults to "formvars") (optional)

-rqset (optional)

Parameters:

url
formvars (optional)
timeout (defaults to "30")
depth (defaults to "10")
http_referer (optional)

Author:

Michael A. Cleverly <michael@cleverly.com>

Created:

3 September 2002

Parameters:

url
headers (optional)
timeout (defaults to "30")
depth (defaults to "0")

See Also:

• ad_httpget

Parameters:

method
url
rqset (optional)
timeout (defaults to "30")
http_referer (optional)

post is encoded as application/x-www-form-urlencoded. See util_http_file_upload for file uploads via post (encoded multipart/form-data).

Parameters:

url
formvars
timeout (defaults to "30")
depth (defaults to "0")
http_referer (optional)

See Also:

• util_http_file_upload

Parameters:

url
list_of_bad_codes (defaults to "404")

See Also:

• util_get_http_status

Switches:

-list_of_ns_sets (required)

Author:

Ola Hansson <ola@polyxena.net>

Created:

September 27, 2002

Parameters:

aList - The list to convert

Returns:

The id of a (non-persistent) ns_set

Switches:

-set (required)

The ns_set to convert

Returns:

An array of equivalent keys and values as the ns_set specified.

Parameters:

extra_message (optional)

Parameters:

extra_message (optional)

Parameters:

list_of_lists
query_string
sublist_element_pos (defaults to "0")

Parameters:

list1
list2

Returns:

1 if the lists have identical sets and 0 otherwise

Author:

Peter Marklund

Parameters:

list1
list2

Returns:

1 if list1 is a subset of list2.

Author:

Peter Marklund

Examples:
util_text_to_url -text "Foo Bar" returns foo-bar
util_text_to_url -existing_urls {foo-bar some-other-item} -text "Foo Bar" returns foo-bar-2

Switches:

-existing_urls (optional)

a list of URLs that already exist on the same level and would cause a conflict

-no_resolve (boolean) (optional)

Specify this flag if you do not want util_text_to_url to automatically generate "foo-bar-2" if "foo-bar" is already in existing_urls, and would rather have an error thrown.

-replacement (defaults to "-") (optional)

the character that is used to replace illegal characters

-text (optional)

the text to modify, e.g. "Foo Bar"

Parameters:

_text (optional) - the text to modify, e.g. "Foo Bar" (Deprecated, use -text instead. Fails when the value starts with a dash.)

Author:

Tilmann Singer

Parameters:

list

Parameters:

query_url

Author:

Philip Greenspun <philg@mit.edu>

Switches:

-replace (boolean) (optional)

Set this if you want to replace existing messages. Default behavior is to append to a list of messages.

-html (boolean) (optional)

Set this flag if your message contains HTML. If specified, you're responsible for proper quoting of everything in your message. Otherwise, we quote it for you.

-message (optional)

The message to display.

See Also:

• util_get_user_messages

Switches:

-eol (defaults to " \") (optional)

the string to be used at the end of each line.

-indent (defaults to "4") (optional)

the number of spaces to use to indent all lines after the first.

-length (defaults to "70") (optional)

the maximum line length.

Parameters:

items - the list of items to be wrapped. Items are HTML-formatted. An individual item will never be wrapped onto separate lines.

validate via ad_page_contract

Parameters:

field_name
column
form
allow_null (defaults to "0")

See Also:

• ad_page_contract

Throws an error if the string isn't a decimal integer; otherwise strips any leading zeros (so this won't work for octals) and returns the result.

validate via ad_page_contract

Parameters:

field_name
string

See Also:

• ad_page_contract

Given a string, signals an error if it's not a legal zip code

validate via ad_page_contract

Parameters:

field_name
zip_string
country_code

See Also:

• ad_page_contract

Parameters:

var_name

Parameters:

error_var
body
on_error

Switches:

-code (required)

Code to be executed that could throw and error

-finally (required)

Cleanup code to be executed even if an error occurs

Example:

    set tree [xml_parse -persist "
<enterprise>
  <properties>
    <datasource>University of Durham: SIS</datasource>
    <target>University of Durham: LMS</target>
    <type>CREATE</type>
    <datetime>2001-08-08</datetime>
  </properties>
  <group recstatus = "1">
    <sourcedid>
      <source>University of Durham</source>
      <id>CS1</id>
    </sourcedid>
    <grouptype>
      <scheme>University of Durham</scheme>
      <typevalue level = "2"/>
    </grouptype>

    .....

  </group>
</enterprise>

"]
    set root_node [xml_doc_get_first_node $tree]
    set group_node [xml_node_get_children_by_name $root_node "group"] 
    set typevalue [xml_get_child_node_attribute_by_path $group_node {grouptype typevalue} "level"]
	


Parameters:

node - The node to start from

path_list - List of the node to try, e.g. 
                         { grouptype typevalue }.

attribute_name - Attribute name at the very end of the very botton of the tree route at path_list.


Author:
Rocael Hernandez <roc@viaro.net>

Example:

set tree [xml_parse -persist {
    <enterprise>
      <properties>
        <datasource>Dunelm Services Limited</datasource>
        <target>Telecommunications LMS</target>
        <type>DATABASE UPDATE</type>
        <datetime>2001-08-08</datetime>
      </properties>
      <person recstatus = "1">
        <comments>Add a new Person record.</comments>
        <sourcedid>
          <source>Dunelm Services Limited</source>
          <id>CK1</id>
        </sourcedid>
        <name>
          <fn>Clark Kent</fn>
          <sort>Kent, C</sort>
          <nickname>Superman</nickname>
        </name>
        <demographics>
          <gender>2</gender>
        </demographics>
        <adr>
          <extadd>The Daily Planet</extadd>
          <locality>Metropolis</locality>
          <country>USA</country>
        </adr>
      </person>
    </enterprise>
}]

set root_node [xml_doc_get_first_node $tree]

aa_equals "person -> name -> nickname is Superman"  [xml_get_child_node_content_by_path $root_node { { person name nickname } }] "Superman"

aa_equals "Same, but after trying a couple of non-existent paths or empty notes"  [xml_get_child_node_content_by_path $root_node { { does not exist } { properties } { person name nickname } { person sourcedid id } }] "Superman"
aa_equals "properties -> datetime"  [xml_get_child_node_content_by_path $root_node { { person commments foo } { person name first_names } { properties datetime } }] "2001-08-08"

Parameters:

node - The node to start from
path_list - List of list of nodes to try, e.g. { { user_id } { sourcedid id } }, or { { name given } { name fn } }.

Author:

Lars Pind <lars@collaboraid.biz>