• Publicity: Public Only All

defs-procs.tcl

ACS-specific general utility routines.

Location:
packages/acs-tcl/tcl/defs-procs.tcl
Created:
2 April 1998
Authors:
Philip Greenspun <philg@arsdigita.com>
Many others at ArsDigita and in the OpenACS community.
CVS Identification:
$Id: defs-procs.tcl,v 1.83 2024/09/11 06:15:48 gustafn Exp $

Procedures in this file

Detailed information

acs_community_member_admin_link (public)

 acs_community_member_admin_link -user_id user_id [ -label label ]
Switches:
-user_id (required)
-label (optional)
Returns:
the HTML link of the community member page of a particular admin user.

Partial Call Graph (max 5 caller/called nodes):
%3 test_user_links_api user_links_api (test acs-tcl) acs_community_member_admin_link acs_community_member_admin_link test_user_links_api->acs_community_member_admin_link acs_community_member_admin_url acs_community_member_admin_url (public) acs_community_member_admin_link->acs_community_member_admin_url acs_user::get_element acs_user::get_element (public) acs_community_member_admin_link->acs_user::get_element person::person_p person::person_p (public) acs_community_member_admin_link->person::person_p

Testcases:
user_links_api

acs_community_member_admin_url (public)

 acs_community_member_admin_url -user_id user_id
Switches:
-user_id (required)
Returns:
the URL for the community member admin page of a particular user

Partial Call Graph (max 5 caller/called nodes):
%3 test_user_links_api user_links_api (test acs-tcl) acs_community_member_admin_url acs_community_member_admin_url test_user_links_api->acs_community_member_admin_url test_web_forum_edit web_forum_edit (test forums) test_web_forum_edit->acs_community_member_admin_url test_web_forum_new web_forum_new (test forums) test_web_forum_new->acs_community_member_admin_url test_web_forum_view web_forum_view (test forums) test_web_forum_view->acs_community_member_admin_url test_web_forums_message_and_reply web_forums_message_and_reply (test forums) test_web_forums_message_and_reply->acs_community_member_admin_url export_vars export_vars (public) acs_community_member_admin_url->export_vars parameter::get parameter::get (public) acs_community_member_admin_url->parameter::get acs_community_member_admin_link acs_community_member_admin_link (public) acs_community_member_admin_link->acs_community_member_admin_url packages/acs-admin/www/auth/batch-job.tcl packages/acs-admin/ www/auth/batch-job.tcl packages/acs-admin/www/auth/batch-job.tcl->acs_community_member_admin_url packages/acs-admin/www/users/member-state-change.tcl packages/acs-admin/ www/users/member-state-change.tcl packages/acs-admin/www/users/member-state-change.tcl->acs_community_member_admin_url packages/acs-admin/www/users/modify-admin-privileges.tcl packages/acs-admin/ www/users/modify-admin-privileges.tcl packages/acs-admin/www/users/modify-admin-privileges.tcl->acs_community_member_admin_url packages/acs-admin/www/users/user-add-3.tcl packages/acs-admin/ www/users/user-add-3.tcl packages/acs-admin/www/users/user-add-3.tcl->acs_community_member_admin_url

Testcases:
user_links_api, web_forum_new, web_forum_view, web_forum_edit, web_forums_message_and_reply

acs_community_member_link (public)

 acs_community_member_link -user_id user_id [ -label label ]
Switches:
-user_id (required)
-label (optional)
Returns:
the link of the community member page of a particular user
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 test_user_links_api user_links_api (test acs-tcl) acs_community_member_link acs_community_member_link test_user_links_api->acs_community_member_link acs_community_member_url acs_community_member_url (public) acs_community_member_link->acs_community_member_url acs_user::get acs_user::get (public) acs_community_member_link->acs_user::get packages/acs-admin/www/auth/batch-action.tcl packages/acs-admin/ www/auth/batch-action.tcl packages/acs-admin/www/auth/batch-action.tcl->acs_community_member_link packages/acs-admin/www/auth/batch-job.tcl packages/acs-admin/ www/auth/batch-job.tcl packages/acs-admin/www/auth/batch-job.tcl->acs_community_member_link packages/acs-lang/www/admin/edit-localized-message.tcl packages/acs-lang/ www/admin/edit-localized-message.tcl packages/acs-lang/www/admin/edit-localized-message.tcl->acs_community_member_link packages/bug-tracker/www/patch.tcl packages/bug-tracker/ www/patch.tcl packages/bug-tracker/www/patch.tcl->acs_community_member_link packages/file-storage/www/file.tcl packages/file-storage/ www/file.tcl packages/file-storage/www/file.tcl->acs_community_member_link

Testcases:
user_links_api

acs_community_member_page (public)

 acs_community_member_page
Returns:
the URL for the community member page

Partial Call Graph (max 5 caller/called nodes):
%3 test_user_links_api user_links_api (test acs-tcl) acs_community_member_page acs_community_member_page test_user_links_api->acs_community_member_page parameter::get parameter::get (public) acs_community_member_page->parameter::get subsite::get_element subsite::get_element (public) acs_community_member_page->subsite::get_element acs_community_member_url acs_community_member_url (public) acs_community_member_url->acs_community_member_page

Testcases:
user_links_api

acs_community_member_url (public)

 acs_community_member_url -user_id user_id
Switches:
-user_id (required)
Returns:
the URL for the community member page of a particular user

Partial Call Graph (max 5 caller/called nodes):
%3 test_user_links_api user_links_api (test acs-tcl) acs_community_member_url acs_community_member_url test_user_links_api->acs_community_member_url acs_community_member_page acs_community_member_page (public) acs_community_member_url->acs_community_member_page export_vars export_vars (public) acs_community_member_url->export_vars acs_community_member_link acs_community_member_link (public) acs_community_member_link->acs_community_member_url bug_tracker::bug::get_multirow bug_tracker::bug::get_multirow (public) bug_tracker::bug::get_multirow->acs_community_member_url packages/acs-admin/www/users/one.tcl packages/acs-admin/ www/users/one.tcl packages/acs-admin/www/users/one.tcl->acs_community_member_url packages/acs-lang/www/admin/audit-include.tcl packages/acs-lang/ www/admin/audit-include.tcl packages/acs-lang/www/admin/audit-include.tcl->acs_community_member_url packages/acs-subsite/lib/home.tcl packages/acs-subsite/ lib/home.tcl packages/acs-subsite/lib/home.tcl->acs_community_member_url

Testcases:
user_links_api

ad_acs_release_date (public)

 ad_acs_release_date

The OpenACS release date of this instance. Uses the release date of the acs-kernel package.

Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 test_acs_system_information_api acs_system_information_api (test acs-tcl) ad_acs_release_date ad_acs_release_date test_acs_system_information_api->ad_acs_release_date apm_version_get apm_version_get (public) ad_acs_release_date->apm_version_get

Testcases:
acs_system_information_api

ad_acs_version (public)

 ad_acs_version

The OpenACS version of this instance. Uses the version name of the acs-kernel package.

Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 test_acs_system_information_api acs_system_information_api (test acs-tcl) ad_acs_version ad_acs_version test_acs_system_information_api->ad_acs_version apm_version_get apm_version_get (public) ad_acs_version->apm_version_get Class ::xowiki::WikiForm Class ::xowiki::WikiForm (public) Class ::xowiki::WikiForm->ad_acs_version apm_get_repository_channel apm_get_repository_channel (public) apm_get_repository_channel->ad_acs_version auth::authority::get_column_defaults auth::authority::get_column_defaults (private) auth::authority::get_column_defaults->ad_acs_version auth::authority::get_not_cached auth::authority::get_not_cached (private) auth::authority::get_not_cached->ad_acs_version auth::authority::get_sc_impl_columns auth::authority::get_sc_impl_columns (public) auth::authority::get_sc_impl_columns->ad_acs_version

Testcases:
acs_system_information_api

ad_admin_home (public)

 ad_admin_home

Returns the directory for the admin home.

Partial Call Graph (max 5 caller/called nodes):
%3 test_user_links_api user_links_api (test acs-tcl) ad_admin_home ad_admin_home test_user_links_api->ad_admin_home subsite::get_element subsite::get_element (public) ad_admin_home->subsite::get_element ad_package_admin_home ad_package_admin_home (public, deprecated) ad_package_admin_home->ad_admin_home

Testcases:
user_links_api

ad_decorate_top (public, deprecated)

 ad_decorate_top simple_headline potential_decoration
Deprecated. Invoking this procedure generates a warning.

Use this for pages that might or might not have an image defined in ad.ini; if the second argument isn't the empty string, ad_decorate_top will make a one-row table for the top of the page DEPRECATED: use the template system, e.g. master and slave tags to achieve better control of headers.

Parameters:
simple_headline (required)
potential_decoration (required)
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) ad_decorate_top ad_decorate_top ad_decorate_top->ad_log_deprecated

Testcases:
No testcase defined.

ad_host_administrator (public)

 ad_host_administrator

As defined in the HostAdministrator kernel parameter.

Returns:
The e-mail address of a technical person who can fix problems

Partial Call Graph (max 5 caller/called nodes):
%3 test_host_admin_and_outgoing_sender host_admin_and_outgoing_sender (test acs-tcl) ad_host_administrator ad_host_administrator test_host_admin_and_outgoing_sender->ad_host_administrator parameter::get parameter::get (public) ad_host_administrator->parameter::get acs_admin::check_expired_certificates acs_admin::check_expired_certificates (private) acs_admin::check_expired_certificates->ad_host_administrator packages/acs-admin/www/users/complex-search.tcl packages/acs-admin/ www/users/complex-search.tcl packages/acs-admin/www/users/complex-search.tcl->ad_host_administrator packages/acs-admin/www/users/search.tcl packages/acs-admin/ www/users/search.tcl packages/acs-admin/www/users/search.tcl->ad_host_administrator packages/chat/www/search-2.tcl packages/chat/ www/search-2.tcl packages/chat/www/search-2.tcl->ad_host_administrator xo::pool_remap_watchdog xo::pool_remap_watchdog (private) xo::pool_remap_watchdog->ad_host_administrator

Testcases:
host_admin_and_outgoing_sender

ad_outgoing_sender (public)

 ad_outgoing_sender
Returns:
The email address that will sign outgoing alerts

Partial Call Graph (max 5 caller/called nodes):
%3 test_auth_registration_implementations auth_registration_implementations (test acs-authentication) ad_outgoing_sender ad_outgoing_sender test_auth_registration_implementations->ad_outgoing_sender test_host_admin_and_outgoing_sender host_admin_and_outgoing_sender (test acs-tcl) test_host_admin_and_outgoing_sender->ad_outgoing_sender parameter::get parameter::get (public) ad_outgoing_sender->parameter::get acs_mail_lite::email_type acs_mail_lite::email_type (public) acs_mail_lite::email_type->ad_outgoing_sender auth::local::password::ChangePassword auth::local::password::ChangePassword (private) auth::local::password::ChangePassword->ad_outgoing_sender auth::local::password::RetrievePassword auth::local::password::RetrievePassword (private) auth::local::password::RetrievePassword->ad_outgoing_sender auth::local::registration::Register auth::local::registration::Register (private) auth::local::registration::Register->ad_outgoing_sender

Testcases:
auth_registration_implementations, host_admin_and_outgoing_sender

ad_package_admin_home (public, deprecated)

 ad_package_admin_home package_key
Deprecated. Invoking this procedure generates a warning.

Parameters:
package_key (required)
Returns:
directory for the especified package's admin home. # is this accurate? (rbm, aug 2002) DEPRECATED: a package URL may not have anything to do with the package key. Furthermore, the admin pages are normally located in "-package-/admin" and not in "/admin/-package-". One is better off generating package URLs by way of the site_nodes.
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 ad_admin_home ad_admin_home (public) ad_log_deprecated ad_log_deprecated (public) ad_package_admin_home ad_package_admin_home ad_package_admin_home->ad_admin_home ad_package_admin_home->ad_log_deprecated

Testcases:
No testcase defined.

ad_parameter_all_values_as_list (public, deprecated)

 ad_parameter_all_values_as_list [ -package_id package_id ] name \
    [ subsection ]
Deprecated. Invoking this procedure generates a warning.

Returns multiple values for a parameter as a list. DEPRECATED: this proc does not do much that joining a string coming from a parameter, which does not make an invalid string into a list. Best to take the value from the parameter directly and rely on proper quoting by the user. Furthermore, the 'subsection' argument is not used anywhere.

Switches:
-package_id (optional)
Parameters:
name (required)
subsection (optional)
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) parameter::get parameter::get (public) ad_parameter_all_values_as_list ad_parameter_all_values_as_list ad_parameter_all_values_as_list->ad_log_deprecated ad_parameter_all_values_as_list->parameter::get

Testcases:
No testcase defined.

ad_parameter_cache (public)

 ad_parameter_cache [ -set set ] [ -delete ] [ -global ] key \
    parameter_name

Manages the cache for ad_parameter.

Switches:
-set (optional)
Use this flag to indicate a value to set in the cache.
-delete (optional, boolean)
Delete the value from the cache
-global (optional, boolean)
If true, global param, false, instance param
Parameters:
key (required)
Specifies the key for the cache'd parameter, either the package instance id (instance parameter) or package key (global parameter).
parameter_name (required)
Specifies the parameter name that is being cached.
Returns:
The cached value.

Partial Call Graph (max 5 caller/called nodes):
%3 test_auth_email_on_password_change auth_email_on_password_change (test acs-authentication) ad_parameter_cache ad_parameter_cache test_auth_email_on_password_change->ad_parameter_cache test_auth_password_change auth_password_change (test acs-authentication) test_auth_password_change->ad_parameter_cache test_auth_use_email_for_login_p auth_use_email_for_login_p (test acs-authentication) test_auth_use_email_for_login_p->ad_parameter_cache test_parameter__check_procs parameter__check_procs (test acs-tcl) test_parameter__check_procs->ad_parameter_cache acs::clusterwide acs::clusterwide ad_parameter_cache->acs::clusterwide db_string db_string (public) ad_parameter_cache->db_string acs_admin::check_expired_certificates acs_admin::check_expired_certificates (private) acs_admin::check_expired_certificates->ad_parameter_cache ad_parameter_cache_all ad_parameter_cache_all (private) ad_parameter_cache_all->ad_parameter_cache apm_parameter_sync apm_parameter_sync (public) apm_parameter_sync->ad_parameter_cache apm_parameter_unregister apm_parameter_unregister (public) apm_parameter_unregister->ad_parameter_cache parameter::get parameter::get (public) parameter::get->ad_parameter_cache

Testcases:
auth_password_change, auth_use_email_for_login_p, auth_email_on_password_change, parameter__check_procs

ad_parameter_from_configuration_file (public)

 ad_parameter_from_configuration_file name [ package_key ]

Return the value of a parameter that has been set in the configuration file. It is possible to set Example snippets of the configuration file:

       ns_section ns/server/$server/acs {
           ns_param CSPEnabledP 1
           ns_param PasswordHashAlgorithm "argon2-12288-3-1 scram-sha-256  salted-sha1"
       }
       ns_section ns/server/$server/acs/acs-templating {
           ns_param UseHtmlAreaForRichtextP 2
       }
       ns_section ns/server/$server/acs/xowiki {
           ns_param MenuBar 1
       }
    
Note that kernel parameters have no package key included in the section name of the configuration file (see above).

Parameters:
name (required)
The name of the parameter.
package_key (optional)
package key of the package from which the parameter value is to be retrieved. When the package_key is omitted, the kernel parameters are assumed
Returns:
The parameter of the object or if it doesn't exist, the default.

Partial Call Graph (max 5 caller/called nodes):
%3 test_ad_parameter_from_configuration_file ad_parameter_from_configuration_file (test acs-tcl) ad_parameter_from_configuration_file ad_parameter_from_configuration_file test_ad_parameter_from_configuration_file->ad_parameter_from_configuration_file ad_parameter_from_file ad_parameter_from_file (public, deprecated) ad_parameter_from_file->ad_parameter_from_configuration_file packages/acs-subsite/www/shared/parameters.tcl packages/acs-subsite/ www/shared/parameters.tcl packages/acs-subsite/www/shared/parameters.tcl->ad_parameter_from_configuration_file parameter::get parameter::get (public) parameter::get->ad_parameter_from_configuration_file parameter::get_from_package_key parameter::get_from_package_key (public) parameter::get_from_package_key->ad_parameter_from_configuration_file parameter::get_global_value parameter::get_global_value (public) parameter::get_global_value->ad_parameter_from_configuration_file

Testcases:
ad_parameter_from_configuration_file

ad_parameter_from_file (public, deprecated)

 ad_parameter_from_file name [ package_key ]
Deprecated. Invoking this procedure generates a warning.

Old version of ad_parameter_from_configuration_file

Parameters:
name (required)
package_key (optional)
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) ad_parameter_from_configuration_file ad_parameter_from_configuration_file (public) ad_parameter_from_file ad_parameter_from_file ad_parameter_from_file->ad_log_deprecated ad_parameter_from_file->ad_parameter_from_configuration_file

Testcases:
No testcase defined.

ad_progress_bar_begin (public)

 ad_progress_bar_begin -title title [ -message_1 message_1 ] \
    [ -message_2 message_2 ] [ -template template ]

Return a progress bar.

Example:

ad_progress_bar_begin -title "Installing..." -message_1 "Please wait..." -message_2 "Will continue automatically"
...
ad_progress_bar_end -url $next_page

Switches:
-title (required)
The title of the page
-message_1 (optional)
Message to display above the progress bar.
-message_2 (optional)
Message to display below the progress bar.
-template (optional, defaults to "/packages/acs-tcl/lib/progress-bar")
Name of template to use. Default value is recommended.
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 packages/acs-admin/www/install/install-3.tcl packages/acs-admin/ www/install/install-3.tcl ad_progress_bar_begin ad_progress_bar_begin packages/acs-admin/www/install/install-3.tcl->ad_progress_bar_begin packages/file-storage/www/download-zip.tcl packages/file-storage/ www/download-zip.tcl packages/file-storage/www/download-zip.tcl->ad_progress_bar_begin ad_http_cache_control ad_http_cache_control (private) ad_progress_bar_begin->ad_http_cache_control ad_parse_template ad_parse_template (public) ad_progress_bar_begin->ad_parse_template db_release_unused_handles db_release_unused_handles (public) ad_progress_bar_begin->db_release_unused_handles util_return_headers util_return_headers (public) ad_progress_bar_begin->util_return_headers

Testcases:
No testcase defined.

ad_progress_bar_end (public)

 ad_progress_bar_end -url url \
    [ -message_after_redirect message_after_redirect ]

Ends the progress bar by causing the browser to redirect to a new URL.

Switches:
-url (required)
-message_after_redirect (optional)
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 packages/acs-admin/www/install/install-3.tcl packages/acs-admin/ www/install/install-3.tcl ad_progress_bar_end ad_progress_bar_end packages/acs-admin/www/install/install-3.tcl->ad_progress_bar_end packages/file-storage/www/download-zip.tcl packages/file-storage/ www/download-zip.tcl packages/file-storage/www/download-zip.tcl->ad_progress_bar_end security::csp::nonce security::csp::nonce (public) ad_progress_bar_end->security::csp::nonce util_user_message util_user_message (public) ad_progress_bar_end->util_user_message

Testcases:
No testcase defined.

ad_publisher_name (public)

 ad_publisher_name

A human-readable name of the publisher, suitable for legal blather.

Partial Call Graph (max 5 caller/called nodes):
%3 test_user_links_api user_links_api (test acs-tcl) ad_publisher_name ad_publisher_name test_user_links_api->ad_publisher_name parameter::get parameter::get (public) ad_publisher_name->parameter::get

Testcases:
user_links_api

ad_pvt_home (public)

 ad_pvt_home

This is the URL of a user's private workspace on the system, usually [subsite]/pvt/home.tcl

Partial Call Graph (max 5 caller/called nodes):
%3 test_user_links_api user_links_api (test acs-tcl) ad_pvt_home ad_pvt_home test_user_links_api->ad_pvt_home parameter::get parameter::get (public) ad_pvt_home->parameter::get subsite::get_element subsite::get_element (public) ad_pvt_home->subsite::get_element ad_pvt_home_link ad_pvt_home_link (public) ad_pvt_home_link->ad_pvt_home ad_site_home_link ad_site_home_link (public) ad_site_home_link->ad_pvt_home packages/acs-admin/lib/become.tcl packages/acs-admin/ lib/become.tcl packages/acs-admin/lib/become.tcl->ad_pvt_home packages/acs-admin/lib/password-update.tcl packages/acs-admin/ lib/password-update.tcl packages/acs-admin/lib/password-update.tcl->ad_pvt_home packages/acs-mail-lite/www/restore-bounce.tcl packages/acs-mail-lite/ www/restore-bounce.tcl packages/acs-mail-lite/www/restore-bounce.tcl->ad_pvt_home

Testcases:
user_links_api

ad_pvt_home_link (public)

 ad_pvt_home_link
Returns:
the HTML fragment for the /pvt link

Partial Call Graph (max 5 caller/called nodes):
%3 test_user_links_api user_links_api (test acs-tcl) ad_pvt_home_link ad_pvt_home_link test_user_links_api->ad_pvt_home_link ad_pvt_home ad_pvt_home (public) ad_pvt_home_link->ad_pvt_home ad_pvt_home_name ad_pvt_home_name (public) ad_pvt_home_link->ad_pvt_home_name

Testcases:
user_links_api

ad_pvt_home_name (public)

 ad_pvt_home_name

This is the name that will be used for the user's workspace (usually "Your Workspace").

Returns:
the name especified for the user's workspace in the HomeName kernel parameter.

Partial Call Graph (max 5 caller/called nodes):
%3 test_user_links_api user_links_api (test acs-tcl) ad_pvt_home_name ad_pvt_home_name test_user_links_api->ad_pvt_home_name lang::util::localize lang::util::localize (public) ad_pvt_home_name->lang::util::localize parameter::get parameter::get (public) ad_pvt_home_name->parameter::get ad_pvt_home_link ad_pvt_home_link (public) ad_pvt_home_link->ad_pvt_home_name auth::local::password::ChangePassword auth::local::password::ChangePassword (private) auth::local::password::ChangePassword->ad_pvt_home_name packages/acs-admin/lib/password-update.tcl packages/acs-admin/ lib/password-update.tcl packages/acs-admin/lib/password-update.tcl->ad_pvt_home_name packages/acs-mail-lite/www/restore-bounce.tcl packages/acs-mail-lite/ www/restore-bounce.tcl packages/acs-mail-lite/www/restore-bounce.tcl->ad_pvt_home_name packages/acs-subsite/lib/home.tcl packages/acs-subsite/ lib/home.tcl packages/acs-subsite/lib/home.tcl->ad_pvt_home_name

Testcases:
user_links_api

ad_return_complaint (public)

 ad_return_complaint exception_count exception_text

Return a page complaining about the user's input (as opposed to an error in our software, for which ad_return_error is more appropriate)

Parameters:
exception_count (required)
Number of exceptions. Used to say either 'a problem' or 'some problems'.
exception_text (required)
HTML chunk to go inside an UL tag with the error messages.

Partial Call Graph (max 5 caller/called nodes):
%3 test_create_folder_with_page create_folder_with_page (test xowf) ad_return_complaint ad_return_complaint test_create_folder_with_page->ad_return_complaint test_create_form_with_form_instance create_form_with_form_instance (test xowiki) test_create_form_with_form_instance->ad_return_complaint test_create_workflow_with_instance create_workflow_with_instance (test xowf) test_create_workflow_with_instance->ad_return_complaint test_xowiki_test_cases xowiki_test_cases (test xowiki) test_xowiki_test_cases->ad_return_complaint ad_parse_template ad_parse_template (public) ad_return_complaint->ad_parse_template lang::util::localize lang::util::localize (public) ad_return_complaint->lang::util::localize parameter::get_from_package_key parameter::get_from_package_key (public) ad_return_complaint->parameter::get_from_package_key Class ::xo::Context Class ::xo::Context (public) Class ::xo::Context->ad_return_complaint Class ::xowiki::includelet::categories Class ::xowiki::includelet::categories (public) Class ::xowiki::includelet::categories->ad_return_complaint ad_form ad_form (public) ad_form->ad_return_complaint calendar::item::edit calendar::item::edit (public) calendar::item::edit->ad_return_complaint calendar::item::new calendar::item::new (public) calendar::item::new->ad_return_complaint

Testcases:
create_folder_with_page, create_workflow_with_instance, xowiki_test_cases, create_form_with_form_instance

ad_return_error (public)

 ad_return_error title explanation

Returns a page with the HTTP 500 (Error) code, along with the given title and explanation. Should be used when an unexpected error is detected while processing a page.

Parameters:
title (required)
explanation (required)

Partial Call Graph (max 5 caller/called nodes):
%3 Class ::xo::db::CrFolder Class ::xo::db::CrFolder (public) ad_return_error ad_return_error Class ::xo::db::CrFolder->ad_return_error ad_form ad_form (public) ad_form->ad_return_error forum::message::new forum::message::new (public) forum::message::new->ad_return_error packages/acs-admin/lib/become.tcl packages/acs-admin/ lib/become.tcl packages/acs-admin/lib/become.tcl->ad_return_error packages/acs-admin/lib/password-update.tcl packages/acs-admin/ lib/password-update.tcl packages/acs-admin/lib/password-update.tcl->ad_return_error ad_return_exception_page ad_return_exception_page (public) ad_return_error->ad_return_exception_page

Testcases:
No testcase defined.

ad_return_exception_page (public)

 ad_return_exception_page status title explanation

Returns an exception page.

Parameters:
status (required)
HTTP status to be returned (e.g. 500, 404)
title (required)
Title to be used for the error (will be shown to user)
explanation (required)
Explanation for the exception.
Author:
Unknown

Partial Call Graph (max 5 caller/called nodes):
%3 ad_return_error ad_return_error (public) ad_return_exception_page ad_return_exception_page ad_return_error->ad_return_exception_page ad_return_forbidden ad_return_forbidden (public) ad_return_forbidden->ad_return_exception_page ad_return_warning ad_return_warning (public) ad_return_warning->ad_return_exception_page download_repository_info download_repository_info (public) download_repository_info->ad_return_exception_page packages/faq/www/one-faq.tcl packages/faq/ www/one-faq.tcl packages/faq/www/one-faq.tcl->ad_return_exception_page ad_conn ad_conn (public) ad_return_exception_page->ad_conn ad_parse_template ad_parse_template (public) ad_return_exception_page->ad_parse_template parameter::get_from_package_key parameter::get_from_package_key (public) ad_return_exception_page->parameter::get_from_package_key

Testcases:
No testcase defined.

ad_return_forbidden (public)

 ad_return_forbidden [ title ] [ explanation ]

Returns a page with the HTTP 403 (Forbidden) code, along with the given title and explanation. Should be used by access-control filters that determine whether a user has permission to request a particular page. Title and explanation are optional. If 'title' is not specified, then a default localized system message will be displayed. If 'explanation' is not specified, it will default to the title.

Parameters:
title (optional)
explanation (optional)

Partial Call Graph (max 5 caller/called nodes):
%3 bug_tracker::security_violation bug_tracker::security_violation (public) ad_return_forbidden ad_return_forbidden bug_tracker::security_violation->ad_return_forbidden ds_require_permission ds_require_permission (private) ds_require_permission->ad_return_forbidden etp::check_write_access etp::check_write_access (public) etp::check_write_access->ad_return_forbidden packages/acs-admin/lib/service-parameters.tcl packages/acs-admin/ lib/service-parameters.tcl packages/acs-admin/lib/service-parameters.tcl->ad_return_forbidden packages/acs-subsite/www/members/member-invite.tcl packages/acs-subsite/ www/members/member-invite.tcl packages/acs-subsite/www/members/member-invite.tcl->ad_return_forbidden _ _ (public) ad_return_forbidden->_ ad_return_exception_page ad_return_exception_page (public) ad_return_forbidden->ad_return_exception_page

Testcases:
No testcase defined.

ad_return_if_another_copy_is_running (public)

 ad_return_if_another_copy_is_running [ max_simultaneous_copies ] \
    [ call_adp_break_p ]

Returns a page to the user about how this server is busy if another copy of the same script is running. Then terminates execution of the thread. Useful for expensive pages that do sequential searches through database tables, etc. You don't want to tie up all of your database handles and deny service to everyone else. The call_adp_break_p argument is essential if you are calling this from an ADP page and want to avoid the performance hit of continuing to parse and run.

Parameters:
max_simultaneous_copies (optional, defaults to "1")
call_adp_break_p (optional, defaults to "0")

Partial Call Graph (max 5 caller/called nodes):
%3 ad_conn ad_conn (public) ad_return_warning ad_return_warning (public) ad_return_if_another_copy_is_running ad_return_if_another_copy_is_running ad_return_if_another_copy_is_running->ad_conn ad_return_if_another_copy_is_running->ad_return_warning

Testcases:
No testcase defined.

ad_return_string_as_file (public)

 ad_return_string_as_file -string string -filename filename \
    -mime_type mime_type

Return a string as the content of a file

Switches:
-string (required)
Content of the file to be sent back
-filename (required)
Name of the file to be returned
-mime_type (required)
Mime Type of the file being returned

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

Testcases:
No testcase defined.

ad_return_url (public)

 ad_return_url [ -urlencode ] [ -path_encode ] [ -qualified ] \
    [ -default_url default_url ] [ extra_args ]

Build a return url suitable for passing to a page you expect to return back to the current page. Per default, the result is URL-encoded (like the result of "export_vars" or ":pretty_link").

Example for direct inclusion in a link:

    ad_returnredirect "foo?return_url=[ad_return_url]"
    
Example setting a variable to be used by export_vars:
    set return_url [ad_return_url]
    set edit_link [export_vars -base edit item_id return_url]
    
Example setting a variable with extra_vars:
    set return_url [ad_return_url [list [list some_id $some_id] [list some_other_id $some_other_id]]]
    

Switches:
-urlencode (optional, boolean)
-path_encode (optional, boolean, defaults to "true")
If false do no URL-encode the result
-qualified (optional, boolean)
If provided the return URL will be fully qualified including http or https.
-default_url (optional, defaults to ".")
When there is no connection, fall back to this URL
Parameters:
extra_args (optional)
A list of {name value} lists to append to the query string
Author:
Don Baccus <dhogaza@pacifier.com>

Partial Call Graph (max 5 caller/called nodes):
%3 test_login_logout_urls login_logout_urls (test acs-tcl) ad_return_url ad_return_url test_login_logout_urls->ad_return_url test_xowiki_test_cases xowiki_test_cases (test xowiki) test_xowiki_test_cases->ad_return_url export_vars export_vars (public) ad_return_url->export_vars security::get_qualified_url security::get_qualified_url (public) ad_return_url->security::get_qualified_url Class ::xowf::test_item::Answer_manager Class ::xowf::test_item::Answer_manager (public) Class ::xowf::test_item::Answer_manager->ad_return_url Class ::xowf::test_item::AssessmentInterface Class ::xowf::test_item::AssessmentInterface (public) Class ::xowf::test_item::AssessmentInterface->ad_return_url Class ::xowiki::includelet::child-resources Class ::xowiki::includelet::child-resources (public) Class ::xowiki::includelet::child-resources->ad_return_url Class ::xowiki::includelet::form-usages Class ::xowiki::includelet::form-usages (public) Class ::xowiki::includelet::form-usages->ad_return_url Class ::xowiki::includelet::my-categories Class ::xowiki::includelet::my-categories (public) Class ::xowiki::includelet::my-categories->ad_return_url

Testcases:
login_logout_urls, xowiki_test_cases

ad_return_warning (public)

 ad_return_warning title explanation

Returns a page with the HTTP 200 (Success) code, along with the given title and explanation. Should be used when an exceptional condition arises while processing a page which the user should be warned about, but which does not qualify as an error.

Parameters:
title (required)
explanation (required)

Partial Call Graph (max 5 caller/called nodes):
%3 ad_return_if_another_copy_is_running ad_return_if_another_copy_is_running (public) ad_return_warning ad_return_warning ad_return_if_another_copy_is_running->ad_return_warning packages/acs-admin/www/users/delete-user.tcl packages/acs-admin/ www/users/delete-user.tcl packages/acs-admin/www/users/delete-user.tcl->ad_return_warning packages/acs-api-browser/www/content-page-view.tcl packages/acs-api-browser/ www/content-page-view.tcl packages/acs-api-browser/www/content-page-view.tcl->ad_return_warning packages/acs-api-browser/www/display-sql.tcl packages/acs-api-browser/ www/display-sql.tcl packages/acs-api-browser/www/display-sql.tcl->ad_return_warning packages/acs-api-browser/www/procs-file-view.tcl packages/acs-api-browser/ www/procs-file-view.tcl packages/acs-api-browser/www/procs-file-view.tcl->ad_return_warning ad_return_exception_page ad_return_exception_page (public) ad_return_warning->ad_return_exception_page

Testcases:
No testcase defined.

ad_site_home_link (public)

 ad_site_home_link
Returns:
a link to the user's workspace if the user is logged in. Otherwise, a link to the page root.

Partial Call Graph (max 5 caller/called nodes):
%3 test_user_links_api user_links_api (test acs-tcl) ad_site_home_link ad_site_home_link test_user_links_api->ad_site_home_link ad_conn ad_conn (public) ad_site_home_link->ad_conn ad_pvt_home ad_pvt_home (public) ad_site_home_link->ad_pvt_home subsite::get_element subsite::get_element (public) ad_site_home_link->subsite::get_element packages/acs-admin/lib/password-update.tcl packages/acs-admin/ lib/password-update.tcl packages/acs-admin/lib/password-update.tcl->ad_site_home_link packages/acs-admin/www/users/password-update.tcl packages/acs-admin/ www/users/password-update.tcl packages/acs-admin/www/users/password-update.tcl->ad_site_home_link packages/acs-subsite/lib/email-confirm.tcl packages/acs-subsite/ lib/email-confirm.tcl packages/acs-subsite/lib/email-confirm.tcl->ad_site_home_link packages/acs-subsite/www/register/explain-persistent-cookies.tcl packages/acs-subsite/ www/register/explain-persistent-cookies.tcl packages/acs-subsite/www/register/explain-persistent-cookies.tcl->ad_site_home_link packages/acs-subsite/www/user/password-reset.tcl packages/acs-subsite/ www/user/password-reset.tcl packages/acs-subsite/www/user/password-reset.tcl->ad_site_home_link

Testcases:
user_links_api

ad_system_name (public)

 ad_system_name

This is the main name of the Web service that you're offering on top of the OpenACS Web Publishing System.

Partial Call Graph (max 5 caller/called nodes):
%3 test_user_links_api user_links_api (test acs-tcl) ad_system_name ad_system_name test_user_links_api->ad_system_name parameter::get parameter::get (public) ad_system_name->parameter::get acs_admin::check_expired_certificates acs_admin::check_expired_certificates (private) acs_admin::check_expired_certificates->ad_system_name acs_mail_lite::check_bounces acs_mail_lite::check_bounces (private) acs_mail_lite::check_bounces->ad_system_name auth::authenticate auth::authenticate (public) auth::authenticate->ad_system_name auth::check_local_account_status auth::check_local_account_status (private) auth::check_local_account_status->ad_system_name auth::create_local_account auth::create_local_account (public) auth::create_local_account->ad_system_name

Testcases:
user_links_api

ad_system_owner (public)

 ad_system_owner

Person who owns the service this person would be interested in user feedback, etc.

Partial Call Graph (max 5 caller/called nodes):
%3 test_acs_mail_lite_inbound_procs_check acs_mail_lite_inbound_procs_check (test acs-mail-lite) ad_system_owner ad_system_owner test_acs_mail_lite_inbound_procs_check->ad_system_owner parameter::get parameter::get (public) ad_system_owner->parameter::get acs_admin::check_expired_certificates acs_admin::check_expired_certificates (private) acs_admin::check_expired_certificates->ad_system_owner acs_mail_lite::check_bounces acs_mail_lite::check_bounces (private) acs_mail_lite::check_bounces->ad_system_owner auth::local::registration::Register auth::local::registration::Register (private) auth::local::registration::Register->ad_system_owner auth::password::email_password auth::password::email_password (private) auth::password::email_password->ad_system_owner auth::send_email_verification_email auth::send_email_verification_email (private) auth::send_email_verification_email->ad_system_owner

Testcases:
acs_mail_lite_inbound_procs_check

ad_url (public)

 ad_url

This will be called by email alerts. Do not use ad_conn location

Returns:
the system url as defined in the kernel parameter SystemURL.
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 test_data_links_scan_links data_links_scan_links (test acs-tcl) ad_url ad_url test_data_links_scan_links->ad_url test_data_links_scan_links_with_tag data_links_scan_links_with_tag (test acs-tcl) test_data_links_scan_links_with_tag->ad_url test_sync_http_get_document sync_http_get_document (test acs-authentication) test_sync_http_get_document->ad_url test_util_http_json_encoding util_http_json_encoding (test acs-tcl) test_util_http_json_encoding->ad_url parameter::get parameter::get (public) ad_url->parameter::get Class ::xowiki::RSS Class ::xowiki::RSS (public) Class ::xowiki::RSS->ad_url Object ::xowiki::RSS::slot Object ::xowiki::RSS::slot (public) Object ::xowiki::RSS::slot->ad_url Object ::xowiki::RSS::slot::siteurl Object ::xowiki::RSS::slot::siteurl (public) Object ::xowiki::RSS::slot::siteurl->ad_url aa_selenium_init aa_selenium_init (private) aa_selenium_init->ad_url acs_mail_lite::check_bounces acs_mail_lite::check_bounces (private) acs_mail_lite::check_bounces->ad_url

Testcases:
sync_http_get_document, data_links_scan_links, data_links_scan_links_with_tag, util_http_json_encoding

doc_return (public)

 doc_return [ args... ]

A wrapper to be used instead of ns_return. It calls db_release_unused_handles prior to calling ns_return. This should be used instead of ns_return at the bottom of every non-templated user-viewable page.

Partial Call Graph (max 5 caller/called nodes):
%3 adp_parse_ad_conn_file adp_parse_ad_conn_file (private) doc_return doc_return adp_parse_ad_conn_file->doc_return packages/acs-templating/www/admin/test/chain-frac-0.tcl packages/acs-templating/ www/admin/test/chain-frac-0.tcl packages/acs-templating/www/admin/test/chain-frac-0.tcl->doc_return packages/bookmarks/www/top-frame.tcl packages/bookmarks/ www/top-frame.tcl packages/bookmarks/www/top-frame.tcl->doc_return packages/bookmarks/www/tree-dynamic.tcl packages/bookmarks/ www/tree-dynamic.tcl packages/bookmarks/www/tree-dynamic.tcl->doc_return packages/bookmarks/www/tree-frame.tcl packages/bookmarks/ www/tree-frame.tcl packages/bookmarks/www/tree-frame.tcl->doc_return ad_http_cache_control ad_http_cache_control (private) doc_return->ad_http_cache_control

Testcases:
No testcase defined.
[ show source ]