Registers code to run after server initialization is complete.

Parameters:

name (required)

a human-readable name for the code block (for debugging purposes).

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

Testcases:

ad_after_server_initialization

Returns 1 if $path is a backup file, or 0 if not. We consider it a backup file if any of the following apply:

• its name begins with #
• its name is bak
• its name begins with bak and one or more non-alphanumeric characters
• its name ends with .old, .bak, or ~

Parameters:

path (required)

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

Testcases:

No testcase defined.

Source a single file during initial bootstrapping and set APM data.

Parameters:

root_directory (required)

file (required)

errorVarName (optional)

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

Testcases:

No testcase defined.

Scan all the files in the "tcl" dir of the package and load those asked for by the init and procs flags. This proc is an analog of apm_load_libraries. In addition though this proc sets apm_first_time_loading_p variable.

Switches:

-load_tests (optional, boolean, defaults to "0")

-init (optional, boolean)

Load initialization files

-procs (optional, boolean)

Load the proc library files

Parameters:

package_key (required)

The package to load (normally acs-tcl)

errorVarName (optional)

Authors:

Don Baccus <dhogaza@pacifier.com>

Peter Marklund

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

Testcases:

No testcase defined.

Copy the files from acs-bootstrap-installer/installer/tcl to the Tcl files in the acs root directory. This makes it possible to incorporate changes to these files by only updating the acs-bootstrap-installer package (rather than a full tar file install as in earlier versions). Caveat: don't modify these files in your local installation, adding extra files to $::acs::rootdir/tcl is fine.

Switches:

-from_version_name (required)

-to_version_name (required)

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

Testcases:

apm_bootstrap_upgrade

Returns 1 if this is a -procs.tcl file's first time loading, or 0 otherwise.

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

Testcases:

apm_first_time_loading_p

Returns all files, or files of a certain types, belonging to an APM package. Ignores files based on proc apm_include_file_p and determines file type of files with proc apm_guess_file_type. Only returns file with no db type or a db type matching that of the system, unless '-all' is specified.

Goes directly to the filesystem to find files instead of using a file listing in the package info file or the database.

Switches:

-include_data_model_files (optional, boolean)

-all (optional, boolean)

When specified, return all files in the package, regardless of their file or database type.

-all_db_types (optional, boolean)

-package_key (required)

The key of the package to return file paths for

-package_path (optional)

The full path of the root directory of the package. Defaults to acs_package_root_dir.

-file_types (optional)

The type of files to return. If not provided files of all types recognized by the APM are returned.

Returns:

The paths, relative to the root dir of the package, of matching files.

Author:

Peter Marklund

See Also:

• apm_include_file_p
• apm_guess_file_type
• apm_guess_db_type

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

Testcases:

get_package_files, apm_tarballs, files__tcl_file_syntax_errors, files__check_upgrade_ordering, files__check_xql_files, files__trailing_whitespace, files__page_contracts

Guesses and returns the database type key corresponding to a particular path (or an empty string if none is known). $path should be relative to the package directory (e.g., www/index.tcl for /packages/bboard/admin-www/index.tcl). We consider two cases: 1. Data model files. If the path contains a string matching "sql/" followed by a database type known to this version of OpenACS, the file is assumed to be specific to that database type. The empty string is returned for all other data model files. Example: "sql/postgresql/apm-create.sql" is assumed to be the PostgreSQL-specific file used to create the APM datamodel. If the path contains a string matching "sql/common" the file is assumed to be compatible with all supported RDBMS's and a blank db_type is returned. Otherwise "oracle" is returned. This is a hardwired kludge to allow us to handle legacy ACS 4 packages. 2. Other files. If it is a .tcl, .xql, or .sqlj file not under the "sql" dir and whose name ends in a dash and database type, the file is assumed to be specific to that database type. Example: "tcl/10-database-postgresql-proc.tcl" is assumed to be the file that defines the PostgreSQL-specific portions of the database API.

Parameters:

package_key (required)

path (required)

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

Testcases:

files__check_upgrade_ordering

Guesses and returns the file type key corresponding to a particular path (or an empty string if none is known). $path should be relative to the package directory (e.g., www/index.tcl) for /packages/bboard/admin-www/index.tcl. We use the following rules:

1. Files with extension .sql are considered data-model files,
2. Files with extension .dat are considered SQL data files.
3. Files with extension .ctl are considered sql data loader control files. or if any path contains the substring upgrade, data-model upgrade files.
4. Files with extension .sqlj are considered sqlj_code files.
5. Files with extension .info are considered package specification files.
6. Files with extension .xql are considered query files.
7. Files with extension .java are considered java code files.
8. Files with extension .jar are considered java archive files.
9. Files with a path component named doc are considered documentation files.
10. Files with extension .pl or .sh or which have a path component named bin, are considered shell-executable files.
11. Files with a path component named templates are considered template files.
12. Files with extension .html or .adp, in the top level of the package, are considered documentation files.
13. Files with a path component named www or admin-www are considered content-page files.
14. Files with a path component named lib are considered include_page files.
15. Files under package-key/tcl ending in -procs(-)+()*.tcl) or -init.tcl are considered Tcl procedure or Tcl initialization files, respectively.
16. File ending in .tcl are considered Tcl utility script files (normally found only in the bootstrap installer).
17. Files with extension .xml in the directory catalog are considered message catalog files.
18. Tcl procs or init files under package-key/tcl in a test directory are of type test_procs and test_init respectively.

Parameters:

package_key (required)

path (required)

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

Testcases:

apm_guess_file_type

Return 1 if $path should, in general, be ignored for package operations. Currently, a file is ignored if it is a backup file or a CVS directory.

Switches:

-data_model_files (optional, boolean)

Parameters:

path (required)

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

Testcases:

files__page_contracts

Check if the APM should consider a file found by ad_find_all_files. Files for which apm_ignore_file_p returns true will be ignored. Backup files are ignored.

Parameters:

filename (required)

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

Testcases:

No testcase defined.

Check if the APM should consider a file found by ad_find_all_files. Files for which apm_ignore_file_p returns true will be ignored. Backup files and SQL scripts (including the ones in upgrade directory) are ignored.

Parameters:

filename (required)

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

Testcases:

No testcase defined.

Get the path of the install.xml file.

Author:

Peter Marklund

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

Testcases:

No testcase defined.

Given a file path return 1 if the path represents a message catalog file and 0 otherwise.

Parameters:

file_path (required)

Should be absolute or relative to OpenACS /packages dir or one of its parent dirs.

Author:

Peter Marklund

See Also:

• apm_parse_catalog_path

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

Testcases:

apm_guess_file_type

Loads any install.xml file and returns the root node. Returns the empty string if there is no install.xml file.

Author:

Peter Marklund

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

Testcases:

No testcase defined.

Returns 1 if the given package supports the rdbms of the system and 0 otherwise. The package is considered to support the given rdbms if there is at least one file in the package of matching db_type, or if there are no files in the package of a certain db type.

Switches:

-package_key (required)

Author:

Peter Marklund

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

Testcases:

apm_package_supports_rdbms_p

Given the path of a file attempt to extract package_key, prefix, charset and locale information from the path assuming the path is on valid format for a message catalog file. If the parsing fails then the file is not considered a catalog file and the empty list is returned.

Parameters:

file_path (required)

Path of file, relative to the OpenACS /packages dir, one of its parent directories, or absolute path.

Author:

Peter Marklund

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

Testcases:

apm_parse_catalog_path

Sources $__file in a clean environment, returning 1 if successful or 0 if not. Records that the file has been sourced and stores its mtime in the nsv array apm_library_mtime

Parameters:

__file (required)

errorVarName (optional)

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

Testcases:

apm_source