apm-admin-procs.tcl

Definitions for the APM administration interface.

Location:
packages/acs-admin/tcl/apm-admin-procs.tcl
Created:
29 September 2000
Author:
Bryan Quinn <bquinn@arsdigita.com>
CVS Identification:
$Id: apm-admin-procs.tcl,v 1.36 2025/06/09 12:52:45 gustafn Exp $

Procedures in this file

Detailed information

apm_build_repository (private)

 apm_build_repository [ -debug ] [ -channels channels ] \
    [ -head_channel head_channel ]

Rebuild the repository on the local machine. Only useful for the openacs.org site. Adapted from Lars' build-repository.tcl page.

Switches:
-debug (optional, boolean, defaults to "0")
Set to 1 to test with only a small subset of packages instead of the whole cvs tree.
-channels (optional, defaults to "*")
Generate apm files for the matching channels only
-head_channel (optional, defaults to "HEAD")
The artificial branch label to apply to HEAD. Should be one minor version past the current release.
Returns:
0 for success. Also outputs debug messages to log.
Author:
Lars Pind <lars@collaboraid.biz>

Testcases:
No testcase defined.

apm_git_build_repository (private)

 apm_git_build_repository [ -debug ] [ -force_fresh ] \
    [ -channels channels ] [ -min_final_version min_final_version ] \
    [ -min_compat_version min_compat_version ]

Rebuild the repository on the local machine. Only useful for the openacs.org site. Adapted from the CVS implementation, which came from Lars' build-repository.tcl page.

Switches:
-debug (optional, boolean, defaults to "0")
Set to 1 to test with only a small subset of packages and branches instead of all of them.
-force_fresh (optional, boolean, defaults to "false")
Force a frech clone of the Git repos.
-channels (optional, defaults to "*")
A string match style pattern. Generate apm files for the matching channels only
-min_final_version (optional, defaults to "5.8.0")
-min_compat_version (optional, defaults to "5.3.0")

Testcases:
No testcase defined.

apm_git_checkout_repo (private)

 apm_git_checkout_repo -path path -branch branch

Checks out a repository branch or tag, making also sure that this is up to date via 'git pull' (if this is a branch) This assumes the specific Git setup for our repo, hence it is meant for internal use only.

Switches:
-path (required)
-branch (required)
Returns:
list of branch names

Testcases:
No testcase defined.

apm_git_fetch_repo (private)

 apm_git_fetch_repo -path path -repo repo

Fetches a repo from the Git mirror. Clones it first when it does not exist. This assumes the specific Git setup for our repo, hence it is meant for internal use only.

Switches:
-path (required)
-repo (required)
Returns:
list of branch names

Testcases:
No testcase defined.

apm_git_repo_branches (private)

 apm_git_repo_branches -path path

Extracts the available branches from an OpenACS Git repo. This assumes the specific Git setup for our repo, hence it is meant for internal use only.

Switches:
-path (required)
Returns:
list of branch names

Testcases:
No testcase defined.

apm_git_repo_channels (private)

 apm_git_repo_channels -path path

Extracts the available tags and branches from an OpenACS Git repo. This assumes the specific Git setup for our repo, hence it is meant for internal use only.

Switches:
-path (required)
Returns:
list of branch names

Testcases:
No testcase defined.

apm_git_repo_tags (private)

 apm_git_repo_tags -path path

Extracts the available tags from an OpenACS Git repo. This assumes the specific Git setup for our repo, hence it is meant for internal use only.

Switches:
-path (required)
Returns:
list of tag names.

Testcases:
No testcase defined.

apm_header (public, deprecated)

 apm_header [ -form form ] [ args... ]
Deprecated. Invoking this procedure generates a warning.

Generates HTML for the header of a page (including context bar). Must only be used for APM admin pages (under /acs-admin/apm). We are adding the APM index page to the context bar so it doesn't have to be added on each page

Switches:
-form (optional)
Author:
Peter Marklund

Testcases:
No testcase defined.

apm_higher_version_installed_p (public)

 apm_higher_version_installed_p package_key version_name
Parameters:
package_key (required)
The package in question.
version_name (required)
The name of the currently installed version.
Returns:
The return value of this procedure doesn't really fit with its name. What it returns is:
  • -1 if there's already a higher version of the given package installed than the version_name you gave it.
  • 0 if the same version is installed as the one you supplied.
  • 1 if the version you gave is higher than the highest version installed, or no version of this package is installed.

Testcases:
apm_higher_version_installed_p

apm_package_selection_widget (private)

 apm_package_selection_widget pkg_info_list [ to_install ] \
    [ operation ] [ form ]

Provides a widget for selecting packages. Displays dependency information if available.

Parameters:
pkg_info_list (required)
list of package infos for all packages to be listed
to_install (optional)
list of package_keys to install
operation (optional, defaults to "all")
filter for added operations (all, upgrade, install)
form (optional, defaults to "pkgsForm")

Testcases:
No testcase defined.

apm_parameter_section_slider (private)

 apm_parameter_section_slider package_key

Build a dynamic section dimensional slider.

Parameters:
package_key (required)

Testcases:
acs_admin_apm_parameter_section_slider

apm_shell_wrap (public, deprecated)

 apm_shell_wrap cmd
Deprecated. Invoking this procedure generates a warning.

The value provided by this proc is unclear, quite hardcoded, and it is used nowhere in usptream code.

Parameters:
cmd (required)
Returns:
a command string, wrapped it shell-style (with backslashes) in case lines get too long.
See Also:
  • many possible plain tcl idioms

Testcases:
No testcase defined.
[ show source ]