• Publicity: Public Only All

apm-procs.tcl

Routines used by the package manager.

Location:
packages/acs-tcl/tcl/apm-procs.tcl
Created:
13 Apr 2000
Authors:
Bryan Quinn <bquinn@arsdigita.com>
Jon Salz <jsalz@arsdigita.com>
CVS Identification:
$Id: apm-procs.tcl,v 1.114.2.38 2021/12/13 13:26:39 antoniop Exp $

Procedures in this file

Detailed information

apm::convert_type (public)

 apm::convert_type -package_id package_id \
    -old_package_key old_package_key -new_package_key new_package_key

Convert a package instance to a new type, doing the proper instantiate and mount callbacks and parameter creation.

Switches:
-package_id (required)
The package instance to convert.
-old_package_key (required)
The package key we're converting from.
-new_package_key (required)
The new subsite type we're converting to.

Partial Call Graph (max 5 caller/called nodes):
%3 packages/acs-subsite/www/admin/subsite-convert-type.tcl packages/acs-subsite/ www/admin/subsite-convert-type.tcl apm::convert_type apm::convert_type packages/acs-subsite/www/admin/subsite-convert-type.tcl->apm::convert_type

Testcases:
No testcase defined.

apm::get_package_descendent_options (public)

 apm::get_package_descendent_options package_key

Get a list of pretty name, package key pairs for all packages which are descendents of the given package key.

Parameters:
package_key - The parent package's key.
Returns:
a list of pretty name, package key pairs suitable for use in a template select widget.

Partial Call Graph (max 5 caller/called nodes):
%3 packages/acs-subsite/www/admin/index.tcl packages/acs-subsite/ www/admin/index.tcl apm::get_package_descendent_options apm::get_package_descendent_options packages/acs-subsite/www/admin/index.tcl->apm::get_package_descendent_options packages/acs-subsite/www/admin/subsite-convert-type.tcl packages/acs-subsite/ www/admin/subsite-convert-type.tcl packages/acs-subsite/www/admin/subsite-convert-type.tcl->apm::get_package_descendent_options

Testcases:
No testcase defined.

apm::metrics (public)

 apm::metrics -package_key package_key -file_type file_type \
    [ -array array ]

Return some code metrics about the files in package $package_key. This will return an array or dict containing at least the following items:

  • count - the number of files
  • lines - the number of lines in the files
  • blank_lines - the number of blank lines in the files
  • comment_lines - the number of blank lines in the files
  • procs - the number of procs, if applicable (0 if not applicable)

Valid file_type's:

  • data_model_pg - PG datamodel files
  • data_model_ora - Oracle datamodel files
  • include_page - ADP files in package_key/lib
  • content_page - ADP files in package_key/www
  • tcl_procs - Tcl procs in package_key/tcl
  • test_procs - automated tests in package_key/tcl/test
  • documentation - docs in package_key/www/doc
When the array is provided, it will be used for setting the result. Otherwise a dict with the metrics information is returned. This proc is cached.

Switches:
-package_key (required)
The package_key of interest
-file_type (required)
See options above
-array (optional)
variable to hold the array that will be returned
Author:
Vinod Kurup
Created:
2006-02-09

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

Testcases:
No testcase defined.

apm_application_new_checkbox (public)

 apm_application_new_checkbox

Return an HTML checkbox of package_key and package names for applications that can be mounted in the site-map. Excludes singletons that are already instantiated.

Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 packages/acs-subsite/www/admin/site-map/index.tcl packages/acs-subsite/ www/admin/site-map/index.tcl apm_application_new_checkbox apm_application_new_checkbox packages/acs-subsite/www/admin/site-map/index.tcl->apm_application_new_checkbox packages/acs-subsite/www/admin/site-map/site-map.tcl packages/acs-subsite/ www/admin/site-map/site-map.tcl packages/acs-subsite/www/admin/site-map/site-map.tcl->apm_application_new_checkbox packages/acs-subsite/www/site-map/index.tcl packages/acs-subsite/ www/site-map/index.tcl packages/acs-subsite/www/site-map/index.tcl->apm_application_new_checkbox

Testcases:
No testcase defined.

apm_arg_names_for_callback_type (public)

 apm_arg_names_for_callback_type -type type

Return the list of required argument names for the given callback type.

Switches:
-type (required)
Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 test_acs_admin_require_site_wide acs_admin_require_site_wide (test acs-admin) apm_arg_names_for_callback_type apm_arg_names_for_callback_type test_acs_admin_require_site_wide->apm_arg_names_for_callback_type apm_callback_format_args apm_callback_format_args (public) apm_callback_format_args->apm_arg_names_for_callback_type apm_callback_has_valid_args apm_callback_has_valid_args (public) apm_callback_has_valid_args->apm_arg_names_for_callback_type packages/acs-admin/www/apm/version-callback-add-edit.tcl packages/acs-admin/ www/apm/version-callback-add-edit.tcl packages/acs-admin/www/apm/version-callback-add-edit.tcl->apm_arg_names_for_callback_type

Testcases:
acs_admin_require_site_wide

apm_assert_callback_type_supported (public)

 apm_assert_callback_type_supported type

Throw an error if the given callback type is not supported.

Parameters:
type
Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 apm_get_callback_proc apm_get_callback_proc (public) apm_assert_callback_type_supported apm_assert_callback_type_supported apm_get_callback_proc->apm_assert_callback_type_supported apm_remove_callback_proc apm_remove_callback_proc (public) apm_remove_callback_proc->apm_assert_callback_type_supported apm_set_callback_proc apm_set_callback_proc (public) apm_set_callback_proc->apm_assert_callback_type_supported

Testcases:
No testcase defined.

apm_body_callback (public)

 apm_body_callback string

This callback uses the document API to append more text to the stream.

Parameters:
string

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

Testcases:
No testcase defined.

apm_build_one_package_relationships (public)

 apm_build_one_package_relationships package_key

Builds the nsv dependency structures for a single package.

Parameters:
package_key

Partial Call Graph (max 5 caller/called nodes):
%3 apm_build_package_relationships apm_build_package_relationships (public) apm_build_one_package_relationships apm_build_one_package_relationships apm_build_package_relationships->apm_build_one_package_relationships apm_package_install apm_package_install (public) apm_package_install->apm_build_one_package_relationships packages/acs-admin/www/apm/package-add-2.tcl packages/acs-admin/ www/apm/package-add-2.tcl packages/acs-admin/www/apm/package-add-2.tcl->apm_build_one_package_relationships packages/acs-admin/www/apm/version-dependency-add-2.tcl packages/acs-admin/ www/apm/version-dependency-add-2.tcl packages/acs-admin/www/apm/version-dependency-add-2.tcl->apm_build_one_package_relationships packages/acs-admin/www/apm/version-dependency-remove.tcl packages/acs-admin/ www/apm/version-dependency-remove.tcl packages/acs-admin/www/apm/version-dependency-remove.tcl->apm_build_one_package_relationships

Testcases:
No testcase defined.

apm_build_package_relationships (public)

 apm_build_package_relationships

Builds the nsv dependency and ancestor structures.

Partial Call Graph (max 5 caller/called nodes):
%3 packages/acs-bootstrap-installer/bootstrap.tcl packages/acs-bootstrap-installer/ bootstrap.tcl apm_build_package_relationships apm_build_package_relationships packages/acs-bootstrap-installer/bootstrap.tcl->apm_build_package_relationships

Testcases:
No testcase defined.

apm_build_subsite_packages_list (public)

 apm_build_subsite_packages_list

Build the nsv_set cache of all packages which claim to implement subsite semantics. The kludge to add acs-subsite if it's not declared with the subsite attribute set true is needed during the upgrade process ...

Partial Call Graph (max 5 caller/called nodes):
%3 apm_package_install apm_package_install (public) apm_build_subsite_packages_list apm_build_subsite_packages_list apm_package_install->apm_build_subsite_packages_list packages/acs-admin/www/apm/package-add-2.tcl packages/acs-admin/ www/apm/package-add-2.tcl packages/acs-admin/www/apm/package-add-2.tcl->apm_build_subsite_packages_list packages/acs-bootstrap-installer/bootstrap.tcl packages/acs-bootstrap-installer/ bootstrap.tcl packages/acs-bootstrap-installer/bootstrap.tcl->apm_build_subsite_packages_list

Testcases:
No testcase defined.

apm_callback_and_log (public)

 apm_callback_and_log [ -severity severity ] callback message

Executes the $callback callback routine with $message as an argument, and calls ns_log with the given $severity.

Switches:
-severity (defaults to "Notice") (optional)
Parameters:
callback
message

Partial Call Graph (max 5 caller/called nodes):
%3 test_upgrade upgrade (test acs-lang) apm_callback_and_log apm_callback_and_log test_upgrade->apm_callback_and_log apm_dependency_check apm_dependency_check (private) apm_dependency_check->apm_callback_and_log apm_files_load apm_files_load (private) apm_files_load->apm_callback_and_log apm_load_apm_file apm_load_apm_file (public) apm_load_apm_file->apm_callback_and_log apm_package_deinstall apm_package_deinstall (public) apm_package_deinstall->apm_callback_and_log apm_package_delete apm_package_delete (public) apm_package_delete->apm_callback_and_log

Testcases:
upgrade

apm_callback_format_args (public)

 apm_callback_format_args [ -version_id version_id ] \
    [ -package_key package_key ] -type type [ -arg_list arg_list ]

Return a string on format -arg_name1 arg_value1 -arg_name2 arg_value2 ... for the callback proc of given type.

Switches:
-version_id (optional)
-package_key (optional)
-type (required)
-arg_list (optional)
Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 test_apm__test_callback_invoke apm__test_callback_invoke (test acs-tcl) apm_callback_format_args apm_callback_format_args test_apm__test_callback_invoke->apm_callback_format_args apm_invoke_callback_proc apm_invoke_callback_proc (public) apm_invoke_callback_proc->apm_callback_format_args

Testcases:
apm__test_callback_invoke

apm_callback_has_valid_args (public)

 apm_callback_has_valid_args -type type -proc_name proc_name

Returns 1 if the specified callback proc of a certain type has a valid argument list in its definition and 0 otherwise. Assumes that the callback proc is defined with ad_proc.

Switches:
-type (required)
-proc_name (required)
Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 packages/acs-admin/www/apm/version-callback-add-edit.tcl packages/acs-admin/ www/apm/version-callback-add-edit.tcl apm_callback_has_valid_args apm_callback_has_valid_args packages/acs-admin/www/apm/version-callback-add-edit.tcl->apm_callback_has_valid_args

Testcases:
No testcase defined.

apm_callback_type_supported_p (public)

 apm_callback_type_supported_p type

Return 1 if the given type of callback is supported and 0 otherwise.

Parameters:
type
Author:
Peter Marklund

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

Testcases:
No testcase defined.

apm_dependency_add (public)

 apm_dependency_add [ -callback callback ] \
    [ -dependency_id dependency_id ] dependency_type version_id \
    dependency_uri dependency_version

Add a dependency to a version.

Switches:
-callback (defaults to "apm_dummy_callback") (optional)
-dependency_id (optional)
Parameters:
dependency_type
version_id
dependency_uri
dependency_version
Returns:
The id of the new dependency.

Partial Call Graph (max 5 caller/called nodes):
%3 apm_package_install_dependencies apm_package_install_dependencies (private) apm_dependency_add apm_dependency_add apm_package_install_dependencies->apm_dependency_add packages/acs-admin/www/apm/version-dependency-add-2.tcl packages/acs-admin/ www/apm/version-dependency-add-2.tcl packages/acs-admin/www/apm/version-dependency-add-2.tcl->apm_dependency_add

Testcases:
No testcase defined.

apm_dependency_remove (public)

 apm_dependency_remove dependency_id

Removes a dependency from the system.

Parameters:
dependency_id

Partial Call Graph (max 5 caller/called nodes):
%3 apm_package_install_dependencies apm_package_install_dependencies (private) apm_dependency_remove apm_dependency_remove apm_package_install_dependencies->apm_dependency_remove packages/acs-admin/www/apm/version-dependency-remove.tcl packages/acs-admin/ www/apm/version-dependency-remove.tcl packages/acs-admin/www/apm/version-dependency-remove.tcl->apm_dependency_remove

Testcases:
No testcase defined.

apm_dummy_callback (public)

 apm_dummy_callback string

A dummy callback routine which does nothing.

Parameters:
string

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

Testcases:
No testcase defined.

apm_enabled_packages (public)

 apm_enabled_packages

Returns a list of package_key's for all enabled packages.

Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 api_add_calling_info_to_procdoc api_add_calling_info_to_procdoc (private) apm_enabled_packages apm_enabled_packages api_add_calling_info_to_procdoc->apm_enabled_packages apm_build_package_relationships apm_build_package_relationships (public) apm_build_package_relationships->apm_enabled_packages apm_load_libraries apm_load_libraries (private) apm_load_libraries->apm_enabled_packages apm_load_packages apm_load_packages (public) apm_load_packages->apm_enabled_packages apm_load_queries apm_load_queries (private) apm_load_queries->apm_enabled_packages

Testcases:
No testcase defined.

apm_flush_package_id_cache (public)

 apm_flush_package_id_cache package_key

Flush the package id cache for this package at least in the current thread. TODO: should be refactored together with the 2level cache (per thread and util_memoize).

Parameters:
package_key

Partial Call Graph (max 5 caller/called nodes):
%3 packages/search/tcl/search-init.tcl packages/search/ tcl/search-init.tcl apm_flush_package_id_cache apm_flush_package_id_cache packages/search/tcl/search-init.tcl->apm_flush_package_id_cache search::init::schedule_indexer search::init::schedule_indexer (private) search::init::schedule_indexer->apm_flush_package_id_cache

Testcases:
No testcase defined.

apm_get_callback_proc (public)

 apm_get_callback_proc -type type [ -package_key package_key ] \
    [ -version_id version_id ]

Return Tcl procedure name for the callback of a certain type for the given package. If no callback proc for the given type is present returns the empty string.

Switches:
-type (required)
-package_key (optional)
-version_id (optional)
Author:
Peter Marklund

See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 test_apm__test_callback_get_set apm__test_callback_get_set (test acs-tcl) apm_get_callback_proc apm_get_callback_proc test_apm__test_callback_get_set->apm_get_callback_proc apm_invoke_callback_proc apm_invoke_callback_proc (public) apm_invoke_callback_proc->apm_get_callback_proc apm_set_callback_proc apm_set_callback_proc (public) apm_set_callback_proc->apm_get_callback_proc packages/acs-admin/www/apm/version-callback-add-edit.tcl packages/acs-admin/ www/apm/version-callback-add-edit.tcl packages/acs-admin/www/apm/version-callback-add-edit.tcl->apm_get_callback_proc packages/acs-admin/www/apm/version-callback-invoke.tcl packages/acs-admin/ www/apm/version-callback-invoke.tcl packages/acs-admin/www/apm/version-callback-invoke.tcl->apm_get_callback_proc

Testcases:
apm__test_callback_get_set

apm_get_installed_provides (public)

 apm_get_installed_provides -array array

Sets the dependencies provided by the packages installed on this system in an array keyed by dependency service-uri.

Switches:
-array (required)
Name of array in caller's namespace where you want this set

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

Testcases:
No testcase defined.

apm_get_installed_versions (public)

 apm_get_installed_versions -array array

Sets the current installed version of packages installed on this system in an array keyed by package_key.

Switches:
-array (required)
Name of array in caller's namespace where you want this set

Partial Call Graph (max 5 caller/called nodes):
%3 test_files__check_xql_files files__check_xql_files (test acs-tcl) apm_get_installed_versions apm_get_installed_versions test_files__check_xql_files->apm_get_installed_versions test_files__page_contracts files__page_contracts (test acs-tcl) test_files__page_contracts->apm_get_installed_versions test_files__tcl_file_syntax_errors files__tcl_file_syntax_errors (test acs-tcl) test_files__tcl_file_syntax_errors->apm_get_installed_versions test_files__trailing_whitespace files__trailing_whitespace (test acs-tcl) test_files__trailing_whitespace->apm_get_installed_versions apm_get_installed_provides apm_get_installed_provides (public) apm_get_installed_provides->apm_get_installed_versions apm_get_package_repository apm_get_package_repository (public) apm_get_package_repository->apm_get_installed_versions packages/acs-admin/www/apm/packages-install-2.tcl packages/acs-admin/ www/apm/packages-install-2.tcl packages/acs-admin/www/apm/packages-install-2.tcl->apm_get_installed_versions packages/acs-admin/www/install/install.tcl packages/acs-admin/ www/install/install.tcl packages/acs-admin/www/install/install.tcl->apm_get_installed_versions

Testcases:
files__tcl_file_syntax_errors, files__check_xql_files, files__trailing_whitespace, files__page_contracts

apm_highest_version (public)

 apm_highest_version package_key

Return the highest version of the indicated package.

Parameters:
package_key
Returns:
the version_id of the highest installed version of a package.

Partial Call Graph (max 5 caller/called nodes):
%3 packages/acs-admin/www/apm/package-instances.tcl packages/acs-admin/ www/apm/package-instances.tcl apm_highest_version apm_highest_version packages/acs-admin/www/apm/package-instances.tcl->apm_highest_version packages/acs-admin/www/install/install-3.tcl packages/acs-admin/ www/install/install-3.tcl packages/acs-admin/www/install/install-3.tcl->apm_highest_version

Testcases:
No testcase defined.

apm_highest_version_name (public)

 apm_highest_version_name package_key

Return the highest version of the indicated package.

Parameters:
package_key
Returns:
the version_name of the highest installed version of a package.

Partial Call Graph (max 5 caller/called nodes):
%3 apm_higher_version_installed_p apm_higher_version_installed_p (public) apm_highest_version_name apm_highest_version_name apm_higher_version_installed_p->apm_highest_version_name apm_package_upgrade_p apm_package_upgrade_p (public) apm_package_upgrade_p->apm_highest_version_name packages/acs-admin/www/install/install-3.tcl packages/acs-admin/ www/install/install-3.tcl packages/acs-admin/www/install/install-3.tcl->apm_highest_version_name xo::db::require proc function_args xo::db::require proc function_args (public) xo::db::require proc function_args->apm_highest_version_name

Testcases:
No testcase defined.

apm_instance_name_from_id (public)

 apm_instance_name_from_id package_id
Parameters:
package_id
Returns:
The name of the instance.

Partial Call Graph (max 5 caller/called nodes):
%3 fs::install::after_instantiate fs::install::after_instantiate (private) apm_instance_name_from_id apm_instance_name_from_id fs::install::after_instantiate->apm_instance_name_from_id fs::new_root_folder fs::new_root_folder (public) fs::new_root_folder->apm_instance_name_from_id packages/acs-lang/www/change-locale-include.tcl packages/acs-lang/ www/change-locale-include.tcl packages/acs-lang/www/change-locale-include.tcl->apm_instance_name_from_id packages/acs-subsite/www/admin/applications/application-delete.tcl packages/acs-subsite/ www/admin/applications/application-delete.tcl packages/acs-subsite/www/admin/applications/application-delete.tcl->apm_instance_name_from_id packages/acs-subsite/www/admin/applications/permissions-user-add.tcl packages/acs-subsite/ www/admin/applications/permissions-user-add.tcl packages/acs-subsite/www/admin/applications/permissions-user-add.tcl->apm_instance_name_from_id

Testcases:
No testcase defined.

apm_interface_add (public)

 apm_interface_add [ -callback callback ] \
    [ -interface_id interface_id ] version_id interface_uri \
    interface_version

Add a interface to a version.

Switches:
-callback (defaults to "apm_dummy_callback") (optional)
-interface_id (optional)
Parameters:
version_id
interface_uri
interface_version
Returns:
The id of the new interface.

Partial Call Graph (max 5 caller/called nodes):
%3 test_upgrade upgrade (test acs-lang) apm_interface_add apm_interface_add test_upgrade->apm_interface_add apm_package_install_dependencies apm_package_install_dependencies (private) apm_package_install_dependencies->apm_interface_add apm_package_install_version apm_package_install_version (public) apm_package_install_version->apm_interface_add

Testcases:
upgrade

apm_interface_remove (public)

 apm_interface_remove interface_id

Removes a interface from the system.

Parameters:
interface_id

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

Testcases:
No testcase defined.

apm_invoke_callback_proc (public)

 apm_invoke_callback_proc [ -proc_name proc_name ] \
    [ -version_id version_id ] [ -package_key package_key ] \
    [ -arg_list arg_list ] -type type

Invoke the Tcl callback proc of a given type for a given package version. Any errors during invocation are logged.

Switches:
-proc_name (optional)
if this is provided it is called instead of attempting to look up the proc via the package_key or version_id (needed for before-install callbacks since the db is not populated when those are called).
-version_id (optional)
-package_key (optional)
-arg_list (optional)
-type (required)
Returns:
1 if invocation was carried out successfully, 0 if no proc to invoke could be found. Will propagate any error thrown by the callback.
Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 test_apm__test_callback_invoke apm__test_callback_invoke (test acs-tcl) apm_invoke_callback_proc apm_invoke_callback_proc test_apm__test_callback_invoke->apm_invoke_callback_proc apm::convert_type apm::convert_type (public) apm::convert_type->apm_invoke_callback_proc apm_package_delete apm_package_delete (public) apm_package_delete->apm_invoke_callback_proc apm_package_install apm_package_install (public) apm_package_install->apm_invoke_callback_proc apm_package_instance_delete apm_package_instance_delete (public) apm_package_instance_delete->apm_invoke_callback_proc apm_package_instance_new apm_package_instance_new (public) apm_package_instance_new->apm_invoke_callback_proc

Testcases:
apm__test_callback_invoke

apm_load_any_changed_libraries (public)

 apm_load_any_changed_libraries [ -version_files version_files ] \
    [ errorVarName ]

In the running interpreter, reloads files marked for reload by apm_mark_version_for_reload. If any watches are set, examines watched files to see whether they need to be reloaded as well. This is intended to be called only by the request processor (since it should be invoked before any filters or registered procedures are applied).

Switches:
-version_files (optional)
Parameters:
errorVarName (optional)

Partial Call Graph (max 5 caller/called nodes):
%3 packages/acs-admin/www/apm/version-reload.tcl packages/acs-admin/ www/apm/version-reload.tcl apm_load_any_changed_libraries apm_load_any_changed_libraries packages/acs-admin/www/apm/version-reload.tcl->apm_load_any_changed_libraries

Testcases:
No testcase defined.

apm_load_packages (public)

 apm_load_packages [ -force_reload ] \
    [ -load_libraries_p load_libraries_p ] \
    [ -load_queries_p load_queries_p ] [ -packages packages ]

Load Tcl libraries and queries for the packages with given keys into the current interpreter. Will load Tcl tests when the acs-automated-testing package is enabled.

Switches:
-force_reload (boolean) (defaults to "0") (optional)
Reload Tcl libraries even if they are already loaded.
-load_libraries_p (defaults to "1") (optional)
Switch to indicate if Tcl libraries in (-procs.tcl and -init.tcl) files should be loaded. Defaults to true.
-load_queries_p (defaults to "1") (optional)
Switch to indicate if xql query files should be loaded. Default true.
-packages (optional)
A list of package_keys for packages to be loaded. Defaults to all enabled packages. These packages, along with the packages they depend on, will be loaded in dependency-order using the information provided via the "provides" and "requires" definitions.
Author:
Peter Marklund

See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 packages/acs-bootstrap-installer/bootstrap.tcl packages/acs-bootstrap-installer/ bootstrap.tcl apm_load_packages apm_load_packages packages/acs-bootstrap-installer/bootstrap.tcl->apm_load_packages

Testcases:
No testcase defined.

apm_load_tests_p (public)

 apm_load_tests_p

Determine whether to load acs-automated-testing tests for packages.

Returns:
1 if tests should be loaded and 0 otherwise
Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 apm_load_packages apm_load_packages (public) apm_load_tests_p apm_load_tests_p apm_load_packages->apm_load_tests_p apm_mark_version_for_reload apm_mark_version_for_reload (public) apm_mark_version_for_reload->apm_load_tests_p apm_version_load_status apm_version_load_status (public) apm_version_load_status->apm_load_tests_p packages/acs-bootstrap-installer/bootstrap.tcl packages/acs-bootstrap-installer/ bootstrap.tcl packages/acs-bootstrap-installer/bootstrap.tcl->apm_load_tests_p

Testcases:
No testcase defined.

apm_log (public)

 apm_log level msg

Centralized APM logging. If you want to debug the APM, change APMDebug to Debug and restart the server.

Parameters:
level
msg

Partial Call Graph (max 5 caller/called nodes):
%3 apm_data_model_scripts_find apm_data_model_scripts_find (public) apm_log apm_log apm_data_model_scripts_find->apm_log apm_generate_package_spec apm_generate_package_spec (public) apm_generate_package_spec->apm_log apm_read_package_info_file apm_read_package_info_file (public) apm_read_package_info_file->apm_log packages/acs-admin/www/apm/packages-install.tcl packages/acs-admin/ www/apm/packages-install.tcl packages/acs-admin/www/apm/packages-install.tcl->apm_log

Testcases:
No testcase defined.

apm_mark_files_for_reload (public)

 apm_mark_files_for_reload [ -force_reload ] file_list

Mark the given list of Tcl and query files for reload in all interpreters. Only marks files for reload if they haven't been loaded before or they have changed since last reload.

Switches:
-force_reload (boolean) (optional)
Mark the files for reload even if their modification time in the nsv cache doesn't differ from the one in the filesystem.
Parameters:
file_list - A list of paths relative to $::acs::rootdir
Returns:
The list of files marked for reload.
Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 test_acs_sc_impl_new_from_spec acs_sc_impl_new_from_spec (test acs-service-contract) apm_mark_files_for_reload apm_mark_files_for_reload test_acs_sc_impl_new_from_spec->apm_mark_files_for_reload acs_sc::impl::binding::init_procs acs_sc::impl::binding::init_procs (private) acs_sc::impl::binding::init_procs->apm_mark_files_for_reload apm_mark_version_for_reload apm_mark_version_for_reload (public) apm_mark_version_for_reload->apm_mark_files_for_reload

Testcases:
acs_sc_impl_new_from_spec

apm_mark_version_for_reload (public)

 apm_mark_version_for_reload version_id [ changed_files_var ]

Examines all tcl_procs files in package version $version_id; if any have changed since they were loaded, marks (in the apm_reload array) that they must be reloaded by each Tcl interpreter (using the apm_load_any_changed_libraries procedure).

Saves a list of files that have changed (and thus marked to be reloaded) in the variable named $file_info_var, if provided. Each element of this list is of the form:

[list $file_id $path]

Parameters:
version_id
changed_files_var (optional)

Partial Call Graph (max 5 caller/called nodes):
%3 packages/acs-admin/www/apm/version-reload.tcl packages/acs-admin/ www/apm/version-reload.tcl apm_mark_version_for_reload apm_mark_version_for_reload packages/acs-admin/www/apm/version-reload.tcl->apm_mark_version_for_reload packages/acs-automated-testing/www/admin/record-test.tcl packages/acs-automated-testing/ www/admin/record-test.tcl packages/acs-automated-testing/www/admin/record-test.tcl->apm_mark_version_for_reload

Testcases:
No testcase defined.

apm_ns_write_callback (public)

 apm_ns_write_callback string

A simple callback which prints out the log message to the server stream.

Parameters:
string

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

Testcases:
No testcase defined.

apm_num_instances (public)

 apm_num_instances package_key
Parameters:
package_key
Returns:
The number of instances of the indicated package.

Partial Call Graph (max 5 caller/called nodes):
%3 packages/acs-admin/www/apm/version-view.tcl packages/acs-admin/ www/apm/version-view.tcl apm_num_instances apm_num_instances packages/acs-admin/www/apm/version-view.tcl->apm_num_instances

Testcases:
No testcase defined.

apm_one_package_inherit_order (public)

 apm_one_package_inherit_order package_key

Returns a list of package keys in package inheritance order.

Parameters:
package_key

Partial Call Graph (max 5 caller/called nodes):
%3 apm_build_one_package_relationships apm_build_one_package_relationships (public) apm_one_package_inherit_order apm_one_package_inherit_order apm_build_one_package_relationships->apm_one_package_inherit_order apm_generate_package_spec apm_generate_package_spec (public) apm_generate_package_spec->apm_one_package_inherit_order packages/acs-admin/www/apm/version-parameters.tcl packages/acs-admin/ www/apm/version-parameters.tcl packages/acs-admin/www/apm/version-parameters.tcl->apm_one_package_inherit_order

Testcases:
No testcase defined.

apm_package_descendents (public)

 apm_package_descendents package_key

Wrapper that returns the cached package descendents list.

Parameters:
package_key

Partial Call Graph (max 5 caller/called nodes):
%3 apm::get_package_descendent_options apm::get_package_descendent_options (public) apm_package_descendents apm_package_descendents apm::get_package_descendent_options->apm_package_descendents

Testcases:
No testcase defined.

apm_package_enabled_p (public)

 apm_package_enabled_p package_key

Returns 1 if there is an enabled package version corresponding to the package_key and 0 otherwise.

Parameters:
package_key

Partial Call Graph (max 5 caller/called nodes):
%3 apm_data_model_scripts_find apm_data_model_scripts_find (public) apm_package_enabled_p apm_package_enabled_p apm_data_model_scripts_find->apm_package_enabled_p apm_load_tests_p apm_load_tests_p (public) apm_load_tests_p->apm_package_enabled_p ds_watch_packages ds_watch_packages (private) ds_watch_packages->apm_package_enabled_p packages/acs-admin/www/install/install-3.tcl packages/acs-admin/ www/install/install-3.tcl packages/acs-admin/www/install/install-3.tcl->apm_package_enabled_p rp_handler rp_handler (private) rp_handler->apm_package_enabled_p

Testcases:
No testcase defined.

apm_package_id_from_key (public)

 apm_package_id_from_key package_key
Parameters:
package_key
Returns:
The package id of the instance of the package. 0 if no instance exists, error if several instances exist.

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) apm_package_id_from_key apm_package_id_from_key test_acs_mail_lite_inbound_procs_check->apm_package_id_from_key test_acs_object_procs_test acs_object_procs_test (test acs-tcl) test_acs_object_procs_test->apm_package_id_from_key test_locale__test_system_package_setting locale__test_system_package_setting (test acs-lang) test_locale__test_system_package_setting->apm_package_id_from_key test_logout_from_everywhere logout_from_everywhere (test acs-tcl) test_logout_from_everywhere->apm_package_id_from_key test_parameter__check_procs parameter__check_procs (test acs-tcl) test_parameter__check_procs->apm_package_id_from_key acs::test::http acs::test::http (public) acs::test::http->apm_package_id_from_key acs_mail_lite::bounce_address acs_mail_lite::bounce_address (private) acs_mail_lite::bounce_address->apm_package_id_from_key acs_mail_lite::check_bounces acs_mail_lite::check_bounces (private) acs_mail_lite::check_bounces->apm_package_id_from_key acs_mail_lite::get_package_id acs_mail_lite::get_package_id (private) acs_mail_lite::get_package_id->apm_package_id_from_key acs_mail_lite::imap_check_incoming acs_mail_lite::imap_check_incoming (private) acs_mail_lite::imap_check_incoming->apm_package_id_from_key

Testcases:
locale__test_system_package_setting, acs_mail_lite_inbound_procs_check, parameter_register_test, parameter__check_procs, acs_object_procs_test, logout_from_everywhere

apm_package_ids_from_key (public)

 apm_package_ids_from_key -package_key package_key [ -mounted ]
Switches:
-package_key (required)
The package key we are looking for the package
-mounted (boolean) (optional)
Does the package have to be mounted?
Returns:
List of package ids of all instances of the package. Empty string

Partial Call Graph (max 5 caller/called nodes):
%3 email_image::get_priv_email email_image::get_priv_email (public) apm_package_ids_from_key apm_package_ids_from_key email_image::get_priv_email->apm_package_ids_from_key email_image::get_priv_email_from_parameter email_image::get_priv_email_from_parameter (private) email_image::get_priv_email_from_parameter->apm_package_ids_from_key forum::use_ReadingInfo_p forum::use_ReadingInfo_p (public) forum::use_ReadingInfo_p->apm_package_ids_from_key install::xml::object_id::package install::xml::object_id::package (public) install::xml::object_id::package->apm_package_ids_from_key xolirc::Package proc create-page-from-log xolirc::Package proc create-page-from-log (public) xolirc::Package proc create-page-from-log->apm_package_ids_from_key

Testcases:
No testcase defined.

apm_package_inherit_order (public)

 apm_package_inherit_order package_key

Wrapper that returns the cached package inheritance order list.

Parameters:
package_key

Partial Call Graph (max 5 caller/called nodes):
%3 apm::convert_type apm::convert_type (public) apm_package_inherit_order apm_package_inherit_order apm::convert_type->apm_package_inherit_order

Testcases:
No testcase defined.

apm_package_installed_p (public)

 apm_package_installed_p package_key

Returns 1 if there is an installed package version corresponding to the package_key, 0 otherwise. Uses a cached value for performance.

Parameters:
package_key

Partial Call Graph (max 5 caller/called nodes):
%3 test_files__check_info_files files__check_info_files (test acs-tcl) apm_package_installed_p apm_package_installed_p test_files__check_info_files->apm_package_installed_p ad_verify_install ad_verify_install (public) ad_verify_install->apm_package_installed_p apm_data_model_scripts_find apm_data_model_scripts_find (public) apm_data_model_scripts_find->apm_package_installed_p apm_load_catalog_files apm_load_catalog_files (private) apm_load_catalog_files->apm_package_installed_p apm_scan_packages apm_scan_packages (public) apm_scan_packages->apm_package_installed_p apm_simple_package_install apm_simple_package_install (public) apm_simple_package_install->apm_package_installed_p

Testcases:
files__check_info_files

apm_package_instance_delete (public)

 apm_package_instance_delete package_id

Deletes an instance of a package

Parameters:
package_id

Partial Call Graph (max 5 caller/called nodes):
%3 apm_package_delete apm_package_delete (public) apm_package_instance_delete apm_package_instance_delete apm_package_delete->apm_package_instance_delete packages/acs-subsite/www/admin/applications/application-delete.tcl packages/acs-subsite/ www/admin/applications/application-delete.tcl packages/acs-subsite/www/admin/applications/application-delete.tcl->apm_package_instance_delete packages/acs-subsite/www/admin/site-map/instance-delete.tcl packages/acs-subsite/ www/admin/site-map/instance-delete.tcl packages/acs-subsite/www/admin/site-map/instance-delete.tcl->apm_package_instance_delete site_node::delete site_node::delete (public) site_node::delete->apm_package_instance_delete site_node_apm_integration::delete_site_nodes_and_package site_node_apm_integration::delete_site_nodes_and_package (public) site_node_apm_integration::delete_site_nodes_and_package->apm_package_instance_delete

Testcases:
No testcase defined.

apm_package_instance_new (public)

 apm_package_instance_new -package_key package_key \
    [ -instance_name instance_name ] [ -package_id package_id ] \
    [ -context_id context_id ]

Creates a new instance of a package and calls the post instantiation proc, if any. If the package is a singleton and already exists then this procedure will silently do nothing.

Switches:
-package_key (required)
The package_key of the package to instantiate.
-instance_name (optional)
The name of the package instance, defaults to the pretty name of the package type.
-package_id (optional)
The id of the new package. Optional.
-context_id (optional)
The context_id of the new package. Optional.
Returns:
The id of the instantiated package

Partial Call Graph (max 5 caller/called nodes):
%3 test_test_apm_package_instance__new test_apm_package_instance__new (test acs-tcl) apm_package_instance_new apm_package_instance_new test_test_apm_package_instance__new->apm_package_instance_new apm_package_install apm_package_install (public) apm_package_install->apm_package_instance_new install::xml::action::create-package install::xml::action::create-package (public) install::xml::action::create-package->apm_package_instance_new packages/acs-admin/www/apm/package-instance-create.tcl packages/acs-admin/ www/apm/package-instance-create.tcl packages/acs-admin/www/apm/package-instance-create.tcl->apm_package_instance_new site_node::instantiate_and_mount site_node::instantiate_and_mount (public) site_node::instantiate_and_mount->apm_package_instance_new

Testcases:
test_apm_package_instance__new

apm_package_key_from_id (public)

 apm_package_key_from_id package_id
Parameters:
package_id
Returns:
The package key of the instance.

Partial Call Graph (max 5 caller/called nodes):
%3 acs::test::require_package_instance acs::test::require_package_instance (public) apm_package_key_from_id apm_package_key_from_id acs::test::require_package_instance->apm_package_key_from_id apm_package_instance_delete apm_package_instance_delete (public) apm_package_instance_delete->apm_package_key_from_id callback::subsite::parameter_changed::impl::acs-content-repository callback::subsite::parameter_changed::impl::acs-content-repository (private) callback::subsite::parameter_changed::impl::acs-content-repository->apm_package_key_from_id callback::subsite::parameter_changed::impl::xotcl-core_param_changed callback::subsite::parameter_changed::impl::xotcl-core_param_changed (private) callback::subsite::parameter_changed::impl::xotcl-core_param_changed->apm_package_key_from_id fs::new_folder fs::new_folder (public) fs::new_folder->apm_package_key_from_id

Testcases:
No testcase defined.

apm_package_key_from_version_id (public)

 apm_package_key_from_version_id version_id

Returns the package_key for the given APM package version id. Goes to the database the first time called and then uses a cached value. Calls the proc apm_package_key_from_version_id_mem.

Parameters:
version_id
Author:
Peter Marklund <peter@collaboraid.biz>

Partial Call Graph (max 5 caller/called nodes):
%3 apm_generate_tarball apm_generate_tarball (public) apm_package_key_from_version_id apm_package_key_from_version_id apm_generate_tarball->apm_package_key_from_version_id apm_invoke_callback_proc apm_invoke_callback_proc (public) apm_invoke_callback_proc->apm_package_key_from_version_id apm_mark_version_for_reload apm_mark_version_for_reload (public) apm_mark_version_for_reload->apm_package_key_from_version_id apm_version_disable apm_version_disable (public) apm_version_disable->apm_package_key_from_version_id apm_version_enable apm_version_enable (public) apm_version_enable->apm_package_key_from_version_id

Testcases:
No testcase defined.

apm_package_list_url_resolution (public)

 apm_package_list_url_resolution package_list

Use a left-right, breadth-first traverse of the inheritance DAG to build a structure to be used by the request processor to resolve URLs based on a package's "extends" and "embeds" dependencies.

Parameters:
package_list

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

Testcases:
No testcase defined.

apm_package_load_libraries_order (public)

 apm_package_load_libraries_order package_key

Wrapper that returns the cached package library load order list.

Parameters:
package_key

Partial Call Graph (max 5 caller/called nodes):
%3 test_apm_dependencies_api apm_dependencies_api (test acs-tcl) apm_package_load_libraries_order apm_package_load_libraries_order test_apm_dependencies_api->apm_package_load_libraries_order apm_load_packages apm_load_packages (public) apm_load_packages->apm_package_load_libraries_order

Testcases:
apm_dependencies_api

apm_package_parameters (public)

 apm_package_parameters package_key
Parameters:
package_key
Returns:
A list of all the package parameter names.

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

Testcases:
No testcase defined.

apm_package_registered_p (public)

 apm_package_registered_p package_key

Returns 1 if there is a registered package with the indicated package_key. Returns 0 otherwise.

Parameters:
package_key

Partial Call Graph (max 5 caller/called nodes):
%3 ad_core_docs_uninstalled_packages_internal ad_core_docs_uninstalled_packages_internal (private) apm_package_registered_p apm_package_registered_p ad_core_docs_uninstalled_packages_internal->apm_package_registered_p apm_package_deinstall apm_package_deinstall (public) apm_package_deinstall->apm_package_registered_p apm_package_install apm_package_install (public) apm_package_install->apm_package_registered_p apm_package_selection_widget apm_package_selection_widget (private) apm_package_selection_widget->apm_package_registered_p packages/acs-admin/www/apm/package-add-2.tcl packages/acs-admin/ www/apm/package-add-2.tcl packages/acs-admin/www/apm/package-add-2.tcl->apm_package_registered_p

Testcases:
No testcase defined.

apm_package_rename (public)

 apm_package_rename [ -package_id package_id ] \
    -instance_name instance_name

Renames a package instance

Switches:
-package_id (optional)
-instance_name (required)

Partial Call Graph (max 5 caller/called nodes):
%3 install::xml::action::rename-instance install::xml::action::rename-instance (public) apm_package_rename apm_package_rename install::xml::action::rename-instance->apm_package_rename packages/acs-subsite/www/admin/applications/application-add.tcl packages/acs-subsite/ www/admin/applications/application-add.tcl packages/acs-subsite/www/admin/applications/application-add.tcl->apm_package_rename packages/acs-subsite/www/admin/configure.tcl packages/acs-subsite/ www/admin/configure.tcl packages/acs-subsite/www/admin/configure.tcl->apm_package_rename packages/acs-subsite/www/admin/site-map/rename.tcl packages/acs-subsite/ www/admin/site-map/rename.tcl packages/acs-subsite/www/admin/site-map/rename.tcl->apm_package_rename

Testcases:
No testcase defined.

apm_package_supported_databases (public)

 apm_package_supported_databases package_key

Return a list of db types (i.e. oracle, postgresql) supported by the package with given key.

Parameters:
package_key
Author:
Peter Marklund

See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 packages/acs-admin/www/apm/version-view.tcl packages/acs-admin/ www/apm/version-view.tcl apm_package_supported_databases apm_package_supported_databases packages/acs-admin/www/apm/version-view.tcl->apm_package_supported_databases

Testcases:
No testcase defined.

apm_package_url_from_id (public)

 apm_package_url_from_id package_id

Will return the first url found for a given package_id

Parameters:
package_id
Returns:
The package url of the instance of the package.

Partial Call Graph (max 5 caller/called nodes):
%3 apm_package_url_from_key apm_package_url_from_key (public) apm_package_url_from_id apm_package_url_from_id apm_package_url_from_key->apm_package_url_from_id bug_tracker::bug::notification_info::get_notification_info bug_tracker::bug::notification_info::get_notification_info (private) bug_tracker::bug::notification_info::get_notification_info->apm_package_url_from_id bug_tracker::search::bug::datasource bug_tracker::search::bug::datasource (private) bug_tracker::search::bug::datasource->apm_package_url_from_id bug_tracker::search::bug::url bug_tracker::search::bug::url (private) bug_tracker::search::bug::url->apm_package_url_from_id bug_tracker::search::patch::url bug_tracker::search::patch::url (private) bug_tracker::search::patch::url->apm_package_url_from_id

Testcases:
No testcase defined.

apm_package_url_from_key (public)

 apm_package_url_from_key package_key
Parameters:
package_key
Returns:
The package url of the instance of the package. only valid for singleton packages.

Partial Call Graph (max 5 caller/called nodes):
%3 adp_parse_ad_conn_file adp_parse_ad_conn_file (public) apm_package_url_from_key apm_package_url_from_key adp_parse_ad_conn_file->apm_package_url_from_key ds_support_url ds_support_url (private) ds_support_url->apm_package_url_from_key lang::util::edit_lang_key_url lang::util::edit_lang_key_url (public) lang::util::edit_lang_key_url->apm_package_url_from_key notification::display::get_urls notification::display::get_urls (public) notification::display::get_urls->apm_package_url_from_key notification::display::request_widget notification::display::request_widget (public) notification::display::request_widget->apm_package_url_from_key

Testcases:
No testcase defined.

apm_package_url_resolution (public)

 apm_package_url_resolution package_key

Wrapper that returns the cached package search order list.

Parameters:
package_key

Partial Call Graph (max 5 caller/called nodes):
%3 rp_handle_request rp_handle_request (private) apm_package_url_resolution apm_package_url_resolution rp_handle_request->apm_package_url_resolution

Testcases:
No testcase defined.

apm_package_version_enabled_p (public)

 apm_package_version_enabled_p version_id
Parameters:
version_id
Returns:
1 if the indicated package version is installed, 0 otherwise.

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

Testcases:
No testcase defined.

apm_package_version_installed_p (public)

 apm_package_version_installed_p package_key version_name
Parameters:
package_key
version_name
Returns:
1 if the indicated package version is installed, 0 otherwise.

Partial Call Graph (max 5 caller/called nodes):
%3 apm_load_apm_file apm_load_apm_file (public) apm_package_version_installed_p apm_package_version_installed_p apm_load_apm_file->apm_package_version_installed_p packages/acs-admin/www/apm/packages-install-4.tcl packages/acs-admin/ www/apm/packages-install-4.tcl packages/acs-admin/www/apm/packages-install-4.tcl->apm_package_version_installed_p packages/acs-admin/www/install/install-3.tcl packages/acs-admin/ www/install/install-3.tcl packages/acs-admin/www/install/install-3.tcl->apm_package_version_installed_p

Testcases:
No testcase defined.

apm_parameter_register (public)

 apm_parameter_register [ -callback callback ] \
    [ -parameter_id parameter_id ] [ -scope scope ] parameter_name \
    description package_key default_value datatype [ section_name ] \
    [ min_n_values ] [ max_n_values ]

Register a parameter in the system. The new "scope" parameter is named rather than positional to avoid breaking existing code.

Switches:
-callback (defaults to "apm_dummy_callback") (optional)
-parameter_id (optional)
-scope (defaults to "instance") (optional)
Parameters:
parameter_name
description
package_key
default_value
datatype
section_name (optional)
min_n_values (defaults to "1")
max_n_values (defaults to "1")
Returns:
The parameter id of the new parameter.

Partial Call Graph (max 5 caller/called nodes):
%3 test_parameter__check_procs parameter__check_procs (test acs-tcl) apm_parameter_register apm_parameter_register test_parameter__check_procs->apm_parameter_register test_parameter_register_test parameter_register_test (test acs-tcl) test_parameter_register_test->apm_parameter_register test_test_apm_parameter__register test_apm_parameter__register (test acs-tcl) test_test_apm_parameter__register->apm_parameter_register acs_admin::check_expired_certificates acs_admin::check_expired_certificates (private) acs_admin::check_expired_certificates->apm_parameter_register apm_package_install_parameters apm_package_install_parameters (private) apm_package_install_parameters->apm_parameter_register apm_package_upgrade_parameters apm_package_upgrade_parameters (private) apm_package_upgrade_parameters->apm_parameter_register boomerang::after-install boomerang::after-install (private) boomerang::after-install->apm_parameter_register cookieconsent::after-install cookieconsent::after-install (private) cookieconsent::after-install->apm_parameter_register

Testcases:
test_apm_parameter__register, parameter_register_test, parameter__check_procs

apm_parameter_sync (public)

 apm_parameter_sync package_key package_id

Syncs the parameters in the database with the memory cache. This must be called after creating a new package instance.

Parameters:
package_key
package_id

Partial Call Graph (max 5 caller/called nodes):
%3 apm::convert_type apm::convert_type (public) apm_parameter_sync apm_parameter_sync apm::convert_type->apm_parameter_sync apm_package_instance_new apm_package_instance_new (public) apm_package_instance_new->apm_parameter_sync packages/edit-this-page/www/etp-setup.tcl packages/edit-this-page/ www/etp-setup.tcl packages/edit-this-page/www/etp-setup.tcl->apm_parameter_sync packages/edit-this-page/www/etp-subtopic-create.tcl packages/edit-this-page/ www/etp-subtopic-create.tcl packages/edit-this-page/www/etp-subtopic-create.tcl->apm_parameter_sync

Testcases:
No testcase defined.

apm_parameter_unregister (public)

 apm_parameter_unregister [ -callback callback ] \
    [ -package_key package_key ] [ -parameter parameter ] \
    [ -parameter_id parameter_id ] [ parameter_id_legacy ]

Unregisters a parameter from the system.

Switches:
-callback (defaults to "apm_dummy_callback") (optional)
-package_key (optional)
-parameter (optional)
-parameter_id (optional)
Parameters:
parameter_id_legacy (optional) - DEPRECATED: previous versions of this proc would specify parameter_id as an unnamed argument. This has now be changed to a flag, but the old syntax is still tolerated in old code. This will generate a warning though and will be dropped in future versions.

Partial Call Graph (max 5 caller/called nodes):
%3 test_parameter__check_procs parameter__check_procs (test acs-tcl) apm_parameter_unregister apm_parameter_unregister test_parameter__check_procs->apm_parameter_unregister test_parameter_register_test parameter_register_test (test acs-tcl) test_parameter_register_test->apm_parameter_unregister apm_unregister_disinherited_params apm_unregister_disinherited_params (public) apm_unregister_disinherited_params->apm_parameter_unregister boomerang::before-uninstall boomerang::before-uninstall (private) boomerang::before-uninstall->apm_parameter_unregister chat::apm::after_upgrade chat::apm::after_upgrade (private) chat::apm::after_upgrade->apm_parameter_unregister cookieconsent::before-uninstall cookieconsent::before-uninstall (private) cookieconsent::before-uninstall->apm_parameter_unregister packages/acs-admin/www/apm/parameter-delete.tcl packages/acs-admin/ www/apm/parameter-delete.tcl packages/acs-admin/www/apm/parameter-delete.tcl->apm_parameter_unregister

Testcases:
parameter_register_test, parameter__check_procs

apm_parameter_update (public)

 apm_parameter_update [ -callback callback ] parameter_id package_key \
    parameter_name description default_value datatype [ section_name ] \
    [ min_n_values ] [ max_n_values ]
Switches:
-callback (defaults to "apm_dummy_callback") (optional)
Parameters:
parameter_id
package_key
parameter_name
description
default_value
datatype
section_name (optional)
min_n_values (defaults to "1")
max_n_values (defaults to "1")
Returns:
The parameter id that has been updated.

Partial Call Graph (max 5 caller/called nodes):
%3 apm_package_upgrade_parameters apm_package_upgrade_parameters (private) apm_parameter_update apm_parameter_update apm_package_upgrade_parameters->apm_parameter_update packages/acs-admin/www/apm/parameter-edit-2.tcl packages/acs-admin/ www/apm/parameter-edit-2.tcl packages/acs-admin/www/apm/parameter-edit-2.tcl->apm_parameter_update

Testcases:
No testcase defined.

apm_pretty_name_for_file_type (public)

 apm_pretty_name_for_file_type type

Returns the pretty name corresponding to a particular file type key

Parameters:
type
Author:
Peter Marklund

See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 packages/acs-admin/www/apm/packages-install-3.tcl packages/acs-admin/ www/apm/packages-install-3.tcl apm_pretty_name_for_file_type apm_pretty_name_for_file_type packages/acs-admin/www/apm/packages-install-3.tcl->apm_pretty_name_for_file_type

Testcases:
No testcase defined.

apm_remove_callback_proc (public)

 apm_remove_callback_proc -type type -package_key package_key

Remove the callback of a certain type for the given package.

Switches:
-type (required)
-package_key (required)
Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 test_apm__test_callback_get_set apm__test_callback_get_set (test acs-tcl) apm_remove_callback_proc apm_remove_callback_proc test_apm__test_callback_get_set->apm_remove_callback_proc test_apm__test_callback_invoke apm__test_callback_invoke (test acs-tcl) test_apm__test_callback_invoke->apm_remove_callback_proc packages/acs-admin/www/apm/version-callback-delete.tcl packages/acs-admin/ www/apm/version-callback-delete.tcl packages/acs-admin/www/apm/version-callback-delete.tcl->apm_remove_callback_proc

Testcases:
apm__test_callback_get_set, apm__test_callback_invoke

apm_set_callback_proc (public)

 apm_set_callback_proc [ -version_id version_id ] \
    [ -package_key package_key ] -type type proc

Set the name of an APM Tcl procedure callback for a certain package version. Checks if the callback already exists and updates if it does. If version_id is not supplied the id of the currently enabled version of the package will be used.

Switches:
-version_id (optional)
-package_key (optional)
-type (required)
Parameters:
proc
Author:
Peter Marklund

See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 test_apm__test_callback_get_set apm__test_callback_get_set (test acs-tcl) apm_set_callback_proc apm_set_callback_proc test_apm__test_callback_get_set->apm_set_callback_proc test_apm__test_callback_invoke apm__test_callback_invoke (test acs-tcl) test_apm__test_callback_invoke->apm_set_callback_proc apm_package_install_callbacks apm_package_install_callbacks (private) apm_package_install_callbacks->apm_set_callback_proc packages/acs-admin/www/apm/version-callback-add-edit.tcl packages/acs-admin/ www/apm/version-callback-add-edit.tcl packages/acs-admin/www/apm/version-callback-add-edit.tcl->apm_set_callback_proc

Testcases:
apm__test_callback_get_set, apm__test_callback_invoke

apm_supported_callback_types (public)

 apm_supported_callback_types

Gets the list of package callback types that are supported by the system. Each callback type represents a certain event or time when a Tcl procedure should be invoked, such as after-install

Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 test_apm__test_callback_get_set apm__test_callback_get_set (test acs-tcl) apm_supported_callback_types apm_supported_callback_types test_apm__test_callback_get_set->apm_supported_callback_types test_apm__test_callback_invoke apm__test_callback_invoke (test acs-tcl) test_apm__test_callback_invoke->apm_supported_callback_types test_apm__test_info_file apm__test_info_file (test acs-tcl) test_apm__test_info_file->apm_supported_callback_types apm_assert_callback_type_supported apm_assert_callback_type_supported (public) apm_assert_callback_type_supported->apm_supported_callback_types apm_callback_type_supported_p apm_callback_type_supported_p (public) apm_callback_type_supported_p->apm_supported_callback_types apm_read_package_info_file apm_read_package_info_file (public) apm_read_package_info_file->apm_supported_callback_types apm_unused_callback_types apm_unused_callback_types (public) apm_unused_callback_types->apm_supported_callback_types

Testcases:
apm__test_info_file, apm__test_callback_get_set, apm__test_callback_invoke

apm_unused_callback_types (public)

 apm_unused_callback_types -version_id version_id

Get a list enumerating the supported callback types that are not used by the given package version.

Switches:
-version_id (required)

Partial Call Graph (max 5 caller/called nodes):
%3 packages/acs-admin/www/apm/version-callback-add-edit.tcl packages/acs-admin/ www/apm/version-callback-add-edit.tcl apm_unused_callback_types apm_unused_callback_types packages/acs-admin/www/apm/version-callback-add-edit.tcl->apm_unused_callback_types packages/acs-admin/www/apm/version-callbacks.tcl packages/acs-admin/ www/apm/version-callbacks.tcl packages/acs-admin/www/apm/version-callbacks.tcl->apm_unused_callback_types

Testcases:
No testcase defined.

apm_version_get (public)

 apm_version_get [ -version_id version_id ] \
    [ -package_key package_key ] -array array

Gets information about a package version. TODO: Cache this proc, put it in a namespace and make sure it's used everywhere.

Switches:
-version_id (optional)
The id of the package version to get info for
-package_key (optional)
Can be specified instead of version_id in which case the live version of the package will be used.
-array (required)
The name of the array variable to upvar the info to
Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 ad_acs_release_date ad_acs_release_date (public) apm_version_get apm_version_get ad_acs_release_date->apm_version_get ad_acs_version ad_acs_version (public) ad_acs_version->apm_version_get

Testcases:
No testcase defined.

apm_version_id_from_package_key (public)

 apm_version_id_from_package_key [ -all ] package_key

Return the id of the (per default enabled) version of the given package_key. If no such version id can be found, returns the empty string.

Switches:
-all (boolean) (optional)
when specified, return the enabled or disabled version_ids of the package_key.
Parameters:
package_key
Returns:
the supposedly unique version_id for the enabled package, or a list of all the enabled and disabled versions when -all flag is specified
Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 test_apm__test_callback_get_set apm__test_callback_get_set (test acs-tcl) apm_version_id_from_package_key apm_version_id_from_package_key test_apm__test_callback_get_set->apm_version_id_from_package_key test_apm__test_callback_invoke apm__test_callback_invoke (test acs-tcl) test_apm__test_callback_invoke->apm_version_id_from_package_key apm::package_version::attributes::get_instance_name apm::package_version::attributes::get_instance_name (private) apm::package_version::attributes::get_instance_name->apm_version_id_from_package_key apm_get_callback_proc apm_get_callback_proc (public) apm_get_callback_proc->apm_version_id_from_package_key apm_package_delete apm_package_delete (public) apm_package_delete->apm_version_id_from_package_key apm_package_install apm_package_install (public) apm_package_install->apm_version_id_from_package_key apm_set_callback_proc apm_set_callback_proc (public) apm_set_callback_proc->apm_version_id_from_package_key

Testcases:
apm__test_callback_get_set, apm__test_callback_invoke

apm_version_info (public)

 apm_version_info version_id

Sets a set of common package information in the caller's environment.

Parameters:
version_id

Partial Call Graph (max 5 caller/called nodes):
%3 apm_package_install_spec apm_package_install_spec (public) apm_version_info apm_version_info apm_package_install_spec->apm_version_info packages/acs-admin/www/apm/package-deinstall.tcl packages/acs-admin/ www/apm/package-deinstall.tcl packages/acs-admin/www/apm/package-deinstall.tcl->apm_version_info packages/acs-admin/www/apm/package-delete-2.tcl packages/acs-admin/ www/apm/package-delete-2.tcl packages/acs-admin/www/apm/package-delete-2.tcl->apm_version_info packages/acs-admin/www/apm/package-delete.tcl packages/acs-admin/ www/apm/package-delete.tcl packages/acs-admin/www/apm/package-delete.tcl->apm_version_info packages/acs-admin/www/apm/package-instances.tcl packages/acs-admin/ www/apm/package-instances.tcl packages/acs-admin/www/apm/package-instances.tcl->apm_version_info

Testcases:
No testcase defined.

apm_version_installed_p (public)

 apm_version_installed_p version_id
Parameters:
version_id
Returns:
Returns 1 if the specified version_id is installed, 0 otherwise.

Partial Call Graph (max 5 caller/called nodes):
%3 packages/acs-admin/www/apm/package-deinstall.tcl packages/acs-admin/ www/apm/package-deinstall.tcl apm_version_installed_p apm_version_installed_p packages/acs-admin/www/apm/package-deinstall.tcl->apm_version_installed_p packages/acs-admin/www/apm/package-delete-2.tcl packages/acs-admin/ www/apm/package-delete-2.tcl packages/acs-admin/www/apm/package-delete-2.tcl->apm_version_installed_p

Testcases:
No testcase defined.

apm_version_load_status (public)

 apm_version_load_status version_id

If a version needs to be reloaded (i.e., a -procs.tcl has changed or been added since the version was loaded), returns "needs_reload". If the version has never been loaded, returns "never_loaded". If the version is up-to-date, returns "up_to_date".

Parameters:
version_id

Partial Call Graph (max 5 caller/called nodes):
%3 packages/acs-admin/www/apm/index.tcl packages/acs-admin/ www/apm/index.tcl apm_version_load_status apm_version_load_status packages/acs-admin/www/apm/index.tcl->apm_version_load_status

Testcases:
No testcase defined.

apm_version_loaded_p (public)

 apm_version_loaded_p version_id

Returns 1 if a version of a package has been loaded and initialized, or 0 otherwise.

Parameters:
version_id

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

Testcases:
No testcase defined.
[ show source ]