• Publicity: Public Only All

site-nodes-procs.tcl

site node api

Location:
packages/acs-tcl/tcl/site-nodes-procs.tcl
Created:
2000-09-06
Authors:
rhs@mit.edu
yon <yon@openforce.net>
CVS Identification:
$Id: site-nodes-procs.tcl,v 1.141.2.38 2021/10/27 16:34:45 gustafn Exp $

Procedures in this file

Detailed information

site_map_unmount_application (public, deprecated)

 site_map_unmount_application [ -sync_p sync_p ] [ -delete_p delete_p ] \
    node_id
Deprecated. Invoking this procedure generates a warning.

Unmounts the specified node.

Switches:
-sync_p (defaults to "t") (optional)
If "t", we flush the in-memory site map
-delete_p (defaults to "f") (optional)
If "t", we attempt to delete the site node. This will fail if you have not cleaned up child nodes
Parameters:
node_id - The node_id to unmount
Author:
Michael Bryzek <mbryzek@arsdigita.com>
Created:
2001-02-07

See Also:

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

Testcases:
No testcase defined.

site_node::closest_ancestor_package (public)

 site_node::closest_ancestor_package [ -url url ] [ -node_id node_id ] \
    [ -package_key package_key ] [ -include_self ] \
    [ -element element ]

Starting with the node of the given id, or at given url, climb up the site map and return the id of the first not-null mounted object. If no ancestor object is found the empty string is returned. Will ignore itself and only return true ancestors unless include_self is set.

Switches:
-url (optional)
The url of the node to start from. You must provide either url or node_id. An empty url is taken to mean the main site.
-node_id (optional)
The id of the node to start from. Takes precedence over any provided url.
-package_key (optional)
Restrict search to objects of this package type. You may supply a list of package_keys.
-include_self (boolean) (optional)
Return the package_id at the passed-in node if it is of the desired package_key. Ignored if package_key is empty.
-element (defaults to "object_id") (optional)
Returns:
The id of the first object found and an empty string if no object is found. Throws an error if no node with given url can be found.
Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 test_site_node_closest_ancestor_package site_node_closest_ancestor_package (test acs-tcl) site_node::closest_ancestor_package site_node::closest_ancestor_package test_site_node_closest_ancestor_package->site_node::closest_ancestor_package ad_conn ad_conn (public) ad_conn->site_node::closest_ancestor_package dir_navbar_list dir_navbar_list (public) dir_navbar_list->site_node::closest_ancestor_package packages/acs-subsite/www/admin/plain-master.tcl packages/acs-subsite/ www/admin/plain-master.tcl packages/acs-subsite/www/admin/plain-master.tcl->site_node::closest_ancestor_package 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->site_node::closest_ancestor_package packages/acs-subsite/www/group-master.tcl packages/acs-subsite/ www/group-master.tcl packages/acs-subsite/www/group-master.tcl->site_node::closest_ancestor_package

Testcases:
site_node_closest_ancestor_package

site_node::conn_url (public, deprecated)

 site_node::conn_url
Deprecated. Invoking this procedure generates a warning.

Use this in place of ns_conn url when referencing host_nodes. This proc returns the appropriate ns_conn url value, depending on if host_node_map is used for current connection, or hostname's domain.


See Also:

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

Testcases:
No testcase defined.

site_node::delete (public)

 site_node::delete -node_id node_id [ -delete_subnodes ] \
    [ -delete_package ]

delete the site node

Switches:
-node_id (required)
-delete_subnodes (boolean) (optional)
-delete_package (boolean) (optional)

Partial Call Graph (max 5 caller/called nodes):
%3 test_path_resolve path_resolve (test xowiki) site_node::delete site_node::delete test_path_resolve->site_node::delete test_site_node_update_cache site_node_update_cache (test acs-tcl) test_site_node_update_cache->site_node::delete test_slot_interactions slot_interactions (test xowiki) test_slot_interactions->site_node::delete test_xowiki_test_cases xowiki_test_cases (test xowiki) test_xowiki_test_cases->site_node::delete acs::test::require_package_instance acs::test::require_package_instance (public) acs::test::require_package_instance->site_node::delete apm_package_delete apm_package_delete (public) apm_package_delete->site_node::delete navigation::test::context_bar_multirow_filter navigation::test::context_bar_multirow_filter (private) navigation::test::context_bar_multirow_filter->site_node::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->site_node::delete packages/acs-subsite/www/admin/site-map/delete.tcl packages/acs-subsite/ www/admin/site-map/delete.tcl packages/acs-subsite/www/admin/site-map/delete.tcl->site_node::delete

Testcases:
site_node_update_cache, xowiki_test_cases, slot_interactions, path_resolve

site_node::delete_service_nodes (public)

 site_node::delete_service_nodes -node_id node_id

Unmount and delete all (shared) service packages under this site_node.

Switches:
-node_id (required)
starting node_id

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

Testcases:
No testcase defined.

site_node::exists_p (public)

 site_node::exists_p -url url

Returns 1 if a site node exists at the given url and 0 otherwise.

Switches:
-url (required)
URL path starting with a slash.

Partial Call Graph (max 5 caller/called nodes):
%3 test_site_node_verify_folder_name site_node_verify_folder_name (test acs-tcl) site_node::exists_p site_node::exists_p test_site_node_verify_folder_name->site_node::exists_p test_xowiki_test_cases xowiki_test_cases (test xowiki) test_xowiki_test_cases->site_node::exists_p acs_admin::require_site_wide_package acs_admin::require_site_wide_package (public) acs_admin::require_site_wide_package->site_node::exists_p acs_admin::require_site_wide_subsite acs_admin::require_site_wide_subsite (public) acs_admin::require_site_wide_subsite->site_node::exists_p site_node::instantiate_and_mount site_node::instantiate_and_mount (public) site_node::instantiate_and_mount->site_node::exists_p site_node::verify_folder_name site_node::verify_folder_name (public) site_node::verify_folder_name->site_node::exists_p

Testcases:
site_node_verify_folder_name, xowiki_test_cases

site_node::get (public)

 site_node::get [ -url url ] [ -node_id node_id ]

Returns an array representing the site node that matches the given url. Either url or node_id is required, if both are passed url is ignored. The array elements are: package_id, package_key, object_type, directory_p, instance_name, pattern_p, parent_id, node_id, object_id, url.

Switches:
-url (optional)
-node_id (optional)

Partial Call Graph (max 5 caller/called nodes):
%3 test_acs_admin_require_site_wide acs_admin_require_site_wide (test acs-admin) site_node::get site_node::get test_acs_admin_require_site_wide->site_node::get test_ad_context_bar ad_context_bar (test acs-tcl) test_ad_context_bar->site_node::get test_ad_context_bar_multirow ad_context_bar_multirow (test acs-tcl) test_ad_context_bar_multirow->site_node::get test_oacs_dav_mkcol oacs_dav_mkcol (test oacs-dav) test_oacs_dav_mkcol->site_node::get test_oacs_dav_put oacs_dav_put (test oacs-dav) test_oacs_dav_put->site_node::get acs_admin::require_site_wide_package acs_admin::require_site_wide_package (public) acs_admin::require_site_wide_package->site_node::get acs_admin::require_site_wide_subsite acs_admin::require_site_wide_subsite (public) acs_admin::require_site_wide_subsite->site_node::get ad_conn ad_conn (public) ad_conn->site_node::get ad_context_node_list ad_context_node_list (public) ad_context_node_list->site_node::get apm_package_install apm_package_install (public) apm_package_install->site_node::get

Testcases:
acs_admin_require_site_wide, ad_context_bar, ad_context_bar_multirow, site_node_update_cache, oacs_dav_put, oacs_dav_mkcol, xowiki_test_cases

site_node::get_all_from_object_id (public)

 site_node::get_all_from_object_id -object_id object_id

Return a list of site node info associated with the given object_id. The nodes will be ordered descendingly by url (children before their parents).

Switches:
-object_id (required)

Partial Call Graph (max 5 caller/called nodes):
%3 site_node_apm_integration::delete_site_nodes_and_package site_node_apm_integration::delete_site_nodes_and_package (public) site_node::get_all_from_object_id site_node::get_all_from_object_id site_node_apm_integration::delete_site_nodes_and_package->site_node::get_all_from_object_id

Testcases:
No testcase defined.

site_node::get_ancestors (public)

 site_node::get_ancestors -node_id node_id [ -element element ]
Switches:
-node_id (required)
-element (optional)
Returns:
the ancestors of this node

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

Testcases:
No testcase defined.

site_node::get_children (public)

 site_node::get_children [ -all ] [ -package_type package_type ] \
    [ -package_key package_key ] [ -filters filters ] \
    [ -element element ] -node_id node_id

This proc gives answers to questions such as: What are all the package_id's (or any of the other available elements) for all the instances of package_key or package_type mounted under node_id xxx?

Switches:
-all (boolean) (optional)
-package_type (optional)
-package_key (optional)
If specified, this will limit the returned nodes to those with a package of the specified package key mounted. Conflicts with the -package_type option. Can take one or more packages keys as a Tcl list.
-filters (optional)
Takes a list of { element value element value ... } for filtering the result list. Only nodes where element is value for each of the filters in the list will get included. For example: -filters { package_key "acs-subsite" }.
-element (optional)
The element of the site node you wish returned. Defaults to url, but the following elements are available: object_type, url, object_id, instance_name, package_type, package_id, name, node_id, directory_p.
-node_id (required)
The node for which you want to find the children.
Options:
-all
Set this if you want all children, not just direct children
-package_type
If specified, this will limit the returned nodes to those with a package of the specified package type (normally apm_service or apm_application) mounted. Conflicts with the -package_key option.
Returns:
A list of URLs of the site_nodes immediately under this site node, or all children, if the -all switch is specified.

Partial Call Graph (max 5 caller/called nodes):
%3 test_site_node_get_children site_node_get_children (test acs-tcl) site_node::get_children site_node::get_children test_site_node_get_children->site_node::get_children test_site_node_verify_folder_name site_node_verify_folder_name (test acs-tcl) test_site_node_verify_folder_name->site_node::get_children application_group::child_application_groups application_group::child_application_groups (public) application_group::child_application_groups->site_node::get_children attachments::get_attachments_url attachments::get_attachments_url (private) attachments::get_attachments_url->site_node::get_children packages/acs-subsite/lib/home.tcl packages/acs-subsite/ lib/home.tcl packages/acs-subsite/lib/home.tcl->site_node::get_children packages/acs-subsite/lib/services.tcl packages/acs-subsite/ lib/services.tcl packages/acs-subsite/lib/services.tcl->site_node::get_children packages/acs-subsite/www/admin/host-node-map/index.tcl packages/acs-subsite/ www/admin/host-node-map/index.tcl packages/acs-subsite/www/admin/host-node-map/index.tcl->site_node::get_children

Testcases:
site_node_get_children, site_node_verify_folder_name

site_node::get_element (public)

 site_node::get_element [ -node_id node_id ] [ -url url ] \
    -element element

returns an element from the array representing the site node that matches the given url either url or node_id is required, if both are passed url is ignored The array elements are: package_id, package_key, object_type, directory_p, instance_name, pattern_p, parent_id, node_id, object_id, url.

Switches:
-node_id (optional)
-url (optional)
-element (required)

See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 test_site_node_verify_folder_name site_node_verify_folder_name (test acs-tcl) site_node::get_element site_node::get_element test_site_node_verify_folder_name->site_node::get_element acs::test::require_package_instance acs::test::require_package_instance (public) acs::test::require_package_instance->site_node::get_element http_auth::site_node_authorize http_auth::site_node_authorize (public) http_auth::site_node_authorize->site_node::get_element install::xml::action::application-link install::xml::action::application-link (private) install::xml::action::application-link->site_node::get_element install::xml::action::forum-create install::xml::action::forum-create (private) install::xml::action::forum-create->site_node::get_element packages/acs-subsite/www/admin/host-node-map/index.tcl packages/acs-subsite/ www/admin/host-node-map/index.tcl packages/acs-subsite/www/admin/host-node-map/index.tcl->site_node::get_element

Testcases:
site_node_verify_folder_name

site_node::get_from_node_id (public)

 site_node::get_from_node_id -node_id node_id

returns an array representing the site node for the given node_id

Switches:
-node_id (required)

See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 packages/acs-subsite/www/admin/applications/application-delete.tcl packages/acs-subsite/ www/admin/applications/application-delete.tcl site_node::get_from_node_id site_node::get_from_node_id packages/acs-subsite/www/admin/applications/application-delete.tcl->site_node::get_from_node_id subsite::auto_mount_application subsite::auto_mount_application (public) subsite::auto_mount_application->site_node::get_from_node_id

Testcases:
No testcase defined.

site_node::get_from_object_id (public)

 site_node::get_from_object_id -object_id object_id

return the site node associated with the given object_id WARNING: Returns only the first site node associated with this object.

Switches:
-object_id (required)

Partial Call Graph (max 5 caller/called nodes):
%3 acs_admin::require_site_wide_package acs_admin::require_site_wide_package (public) site_node::get_from_object_id site_node::get_from_object_id acs_admin::require_site_wide_package->site_node::get_from_object_id navigation::test::context_bar_multirow_filter navigation::test::context_bar_multirow_filter (private) navigation::test::context_bar_multirow_filter->site_node::get_from_object_id packages/acs-subsite/lib/subsites.tcl packages/acs-subsite/ lib/subsites.tcl packages/acs-subsite/lib/subsites.tcl->site_node::get_from_object_id subsite::default::create_app_group subsite::default::create_app_group (public) subsite::default::create_app_group->site_node::get_from_object_id subsite::get subsite::get (public) subsite::get->site_node::get_from_object_id

Testcases:
No testcase defined.

site_node::get_from_url (public)

 site_node::get_from_url -url url [ -exact ]

Returns an array representing the site node that matches the given url.

A trailing '/' will be appended to $url if required and not present.

If the '-exact' switch is not present and $url is not found, returns the first match found by successively removing the trailing $url path component.

Switches:
-url (required)
-exact (boolean) (optional)

See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 test_acs_subsite_expose_bug_1144 acs_subsite_expose_bug_1144 (test acs-subsite) site_node::get_from_url site_node::get_from_url test_acs_subsite_expose_bug_1144->site_node::get_from_url test_front_page_1 front_page_1 (test acs-tcl) test_front_page_1->site_node::get_from_url test_xowiki_test_cases xowiki_test_cases (test xowiki) test_xowiki_test_cases->site_node::get_from_url attachments::get_attachments_url attachments::get_attachments_url (private) attachments::get_attachments_url->site_node::get_from_url boomerang::get_relevant_subsite boomerang::get_relevant_subsite (private) boomerang::get_relevant_subsite->site_node::get_from_url cookieconsent::get_relevant_subsite cookieconsent::get_relevant_subsite (private) cookieconsent::get_relevant_subsite->site_node::get_from_url install::xml::action::mount install::xml::action::mount (public) install::xml::action::mount->site_node::get_from_url install::xml::action::mount-existing install::xml::action::mount-existing (public) install::xml::action::mount-existing->site_node::get_from_url

Testcases:
acs_subsite_expose_bug_1144, front_page_1, xowiki_test_cases

site_node::get_node_id (public)

 site_node::get_node_id -url url
Switches:
-url (required)
Returns:
the node_id for this url

Partial Call Graph (max 5 caller/called nodes):
%3 test_path_resolve path_resolve (test xowiki) site_node::get_node_id site_node::get_node_id test_path_resolve->site_node::get_node_id test_site_node_closest_ancestor_package site_node_closest_ancestor_package (test acs-tcl) test_site_node_closest_ancestor_package->site_node::get_node_id test_site_node_get_children site_node_get_children (test acs-tcl) test_site_node_get_children->site_node::get_node_id test_site_node_update_cache site_node_update_cache (test acs-tcl) test_site_node_update_cache->site_node::get_node_id test_site_node_verify_folder_name site_node_verify_folder_name (test acs-tcl) test_site_node_verify_folder_name->site_node::get_node_id apm_package_install apm_package_install (public) apm_package_install->site_node::get_node_id attachments::get_attachments_url attachments::get_attachments_url (private) attachments::get_attachments_url->site_node::get_node_id install::xml::action::mount install::xml::action::mount (public) install::xml::action::mount->site_node::get_node_id install::xml::action::mount-existing install::xml::action::mount-existing (public) install::xml::action::mount-existing->site_node::get_node_id install::xml::object_id::package install::xml::object_id::package (public) install::xml::object_id::package->site_node::get_node_id

Testcases:
site_node_get_children, site_node_verify_folder_name, site_node_update_cache, site_node_closest_ancestor_package, slot_interactions, path_resolve

site_node::get_node_id_from_object_id (public)

 site_node::get_node_id_from_object_id -object_id object_id
Switches:
-object_id (required)
Returns:
the site node id associated with the given object_id

Partial Call Graph (max 5 caller/called nodes):
%3 apm::convert_type apm::convert_type (public) site_node::get_node_id_from_object_id site_node::get_node_id_from_object_id apm::convert_type->site_node::get_node_id_from_object_id apm_package_ids_from_key_not_cached apm_package_ids_from_key_not_cached (private) apm_package_ids_from_key_not_cached->site_node::get_node_id_from_object_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->site_node::get_node_id_from_object_id packages/acs-subsite/www/admin/site-map/allow-for-view.tcl packages/acs-subsite/ www/admin/site-map/allow-for-view.tcl packages/acs-subsite/www/admin/site-map/allow-for-view.tcl->site_node::get_node_id_from_object_id 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->site_node::get_node_id_from_object_id

Testcases:
No testcase defined.

site_node::get_object_id (public)

 site_node::get_object_id -node_id node_id
Switches:
-node_id (required)
Returns:
the object_id for this node

Partial Call Graph (max 5 caller/called nodes):
%3 ad_conn ad_conn (public) site_node::get_object_id site_node::get_object_id ad_conn->site_node::get_object_id boomerang::get_relevant_subsite boomerang::get_relevant_subsite (private) boomerang::get_relevant_subsite->site_node::get_object_id cookieconsent::get_relevant_subsite cookieconsent::get_relevant_subsite (private) cookieconsent::get_relevant_subsite->site_node::get_object_id install::xml::object_id::package install::xml::object_id::package (public) install::xml::object_id::package->site_node::get_object_id irc::logger::update_log irc::logger::update_log (public) irc::logger::update_log->site_node::get_object_id

Testcases:
No testcase defined.

site_node::get_package_url (public)

 site_node::get_package_url -package_key package_key

Get the URL of any mounted instance of a package with the given package_key. If there is more than one mounted instance of a package, returns the first URL. To see all of the mounted URLs, use the site_node::get_children proc.

Switches:
-package_key (required)
Returns:
a URL, or empty string if no instance of the package is mounted.

See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 aa_get_first_url aa_get_first_url (public) site_node::get_package_url site_node::get_package_url aa_get_first_url->site_node::get_package_url general_comments_package_url general_comments_package_url (public) general_comments_package_url->site_node::get_package_url packages/acs-admin/lib/developer-services.tcl packages/acs-admin/ lib/developer-services.tcl packages/acs-admin/lib/developer-services.tcl->site_node::get_package_url packages/acs-admin/www/users/one.tcl packages/acs-admin/ www/users/one.tcl packages/acs-admin/www/users/one.tcl->site_node::get_package_url packages/acs-developer-support/lib/toolbar.tcl packages/acs-developer-support/ lib/toolbar.tcl packages/acs-developer-support/lib/toolbar.tcl->site_node::get_package_url

Testcases:
No testcase defined.

site_node::get_parent (public)

 site_node::get_parent -node_id node_id
Switches:
-node_id (required)
Returns:
the parent node of this node

Partial Call Graph (max 5 caller/called nodes):
%3 attachments::get_root_folder attachments::get_root_folder (public) site_node::get_parent site_node::get_parent attachments::get_root_folder->site_node::get_parent packages/attachments/www/admin/new-root-folder-map.tcl packages/attachments/ www/admin/new-root-folder-map.tcl packages/attachments/www/admin/new-root-folder-map.tcl->site_node::get_parent

Testcases:
No testcase defined.

site_node::get_parent_id (public)

 site_node::get_parent_id -node_id node_id
Switches:
-node_id (required)
Returns:
the parent_id of this node

Partial Call Graph (max 5 caller/called nodes):
%3 irc::logger::update_log irc::logger::update_log (public) site_node::get_parent_id site_node::get_parent_id irc::logger::update_log->site_node::get_parent_id packages/acs-subsite/www/admin/site-map/allow-for-view.tcl packages/acs-subsite/ www/admin/site-map/allow-for-view.tcl packages/acs-subsite/www/admin/site-map/allow-for-view.tcl->site_node::get_parent_id packages/acs-subsite/www/admin/site-map/delete.tcl packages/acs-subsite/ www/admin/site-map/delete.tcl packages/acs-subsite/www/admin/site-map/delete.tcl->site_node::get_parent_id site_node::get_parent site_node::get_parent (public) site_node::get_parent->site_node::get_parent_id site_node::mount site_node::mount (public) site_node::mount->site_node::get_parent_id

Testcases:
No testcase defined.

site_node::get_url (public)

 site_node::get_url -node_id node_id [ -notrailing ]

return the url of this node_id

Switches:
-node_id (required)
-notrailing (boolean) (optional)
If true then strip any trailing slash ('/'). This means the empty string is returned for the root.

Partial Call Graph (max 5 caller/called nodes):
%3 test_site_node_update_cache site_node_update_cache (test acs-tcl) site_node::get_url site_node::get_url test_site_node_update_cache->site_node::get_url acs::root_of_host_noncached acs::root_of_host_noncached (private) acs::root_of_host_noncached->site_node::get_url ad_conn ad_conn (public) ad_conn->site_node::get_url ad_context_bar_multirow ad_context_bar_multirow (public) ad_context_bar_multirow->site_node::get_url apm_package_delete apm_package_delete (public) apm_package_delete->site_node::get_url application_group::closest_ancestor_application_group_site_node application_group::closest_ancestor_application_group_site_node (public) application_group::closest_ancestor_application_group_site_node->site_node::get_url

Testcases:
site_node_update_cache

site_node::get_url_from_object_id (public)

 site_node::get_url_from_object_id -object_id object_id

Returns a list of URLs for site_nodes that have the given object mounted or the empty list if there are none. The url:s will be returned in descending order meaning any children will come before their parents. This ordering is useful when deleting site nodes as we must delete child site nodes before their parents.

Switches:
-object_id (required)

Partial Call Graph (max 5 caller/called nodes):
%3 test_link_tests link_tests (test xowiki) site_node::get_url_from_object_id site_node::get_url_from_object_id test_link_tests->site_node::get_url_from_object_id test_package_normalize_path package_normalize_path (test xowiki) test_package_normalize_path->site_node::get_url_from_object_id test_path_resolve path_resolve (test xowiki) test_path_resolve->site_node::get_url_from_object_id test_site_node_update_cache site_node_update_cache (test acs-tcl) test_site_node_update_cache->site_node::get_url_from_object_id test_slot_interactions slot_interactions (test xowiki) test_slot_interactions->site_node::get_url_from_object_id Class ::xowiki::RSS Class ::xowiki::RSS (public) Class ::xowiki::RSS->site_node::get_url_from_object_id apm_package_url_from_id apm_package_url_from_id (public) apm_package_url_from_id->site_node::get_url_from_object_id calendar::notification::get_url calendar::notification::get_url (public) calendar::notification::get_url->site_node::get_url_from_object_id callback::search::url::impl::forums_forum callback::search::url::impl::forums_forum (private) callback::search::url::impl::forums_forum->site_node::get_url_from_object_id callback::search::url::impl::forums_message callback::search::url::impl::forums_message (private) callback::search::url::impl::forums_message->site_node::get_url_from_object_id

Testcases:
site_node_update_cache, package_normalize_path, xowiki_test_cases, link_tests, slot_interactions, path_resolve

site_node::instantiate_and_mount (public)

 site_node::instantiate_and_mount [ -node_id node_id ] \
    [ -parent_node_id parent_node_id ] [ -node_name node_name ] \
    [ -package_name package_name ] [ -context_id context_id ] \
    -package_key package_key [ -package_id package_id ]

Instantiate and mount a package of given type. Will use an existing site node if possible.

Switches:
-node_id (optional)
The id of the node in the site map where the package should be mounted.
-parent_node_id (optional)
If no node_id is specified this will be the parent node under which the new node is created. Defaults to the main site node id.
-node_name (optional)
If node_id is not specified then this will be the name of the new site node that is created. Defaults to package_key.
-package_name (optional)
The name of the new package instance. Defaults to pretty name of package type.
-context_id (optional)
The context_id of the package. Defaults to the closest ancestor package in the site map.
-package_key (required)
The key of the package type to instantiate.
-package_id (optional)
The id of the new package. Optional.
Returns:
The id of the instantiated package
Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 test_ad_proc_permission_grant_and_revoke ad_proc_permission_grant_and_revoke (test acs-tcl) site_node::instantiate_and_mount site_node::instantiate_and_mount test_ad_proc_permission_grant_and_revoke->site_node::instantiate_and_mount test_ad_proc_permission_permission_p ad_proc_permission_permission_p (test acs-tcl) test_ad_proc_permission_permission_p->site_node::instantiate_and_mount test_site_node_closest_ancestor_package site_node_closest_ancestor_package (test acs-tcl) test_site_node_closest_ancestor_package->site_node::instantiate_and_mount test_site_node_update_cache site_node_update_cache (test acs-tcl) test_site_node_update_cache->site_node::instantiate_and_mount test_xowiki_test_cases xowiki_test_cases (test xowiki) test_xowiki_test_cases->site_node::instantiate_and_mount aa_get_first_url aa_get_first_url (public) aa_get_first_url->site_node::instantiate_and_mount acs::test::require_package_instance acs::test::require_package_instance (public) acs::test::require_package_instance->site_node::instantiate_and_mount acs_admin::require_site_wide_package acs_admin::require_site_wide_package (public) acs_admin::require_site_wide_package->site_node::instantiate_and_mount acs_admin::require_site_wide_subsite acs_admin::require_site_wide_subsite (public) acs_admin::require_site_wide_subsite->site_node::instantiate_and_mount apm_mount_core_packages apm_mount_core_packages (private) apm_mount_core_packages->site_node::instantiate_and_mount

Testcases:
site_node_update_cache, site_node_closest_ancestor_package, ad_proc_permission_grant_and_revoke, ad_proc_permission_permission_p, xowiki_test_cases

site_node::mount (public)

 site_node::mount -node_id node_id -object_id object_id \
    [ -context_id context_id ]

mount object at site node

Switches:
-node_id (required)
-object_id (required)
-context_id (optional)

Partial Call Graph (max 5 caller/called nodes):
%3 test_ad_context_bar ad_context_bar (test acs-tcl) site_node::mount site_node::mount test_ad_context_bar->site_node::mount install::xml::action::mount-existing install::xml::action::mount-existing (public) install::xml::action::mount-existing->site_node::mount packages/acs-subsite/www/admin/site-map/mount-2.tcl packages/acs-subsite/ www/admin/site-map/mount-2.tcl packages/acs-subsite/www/admin/site-map/mount-2.tcl->site_node::mount site_node::instantiate_and_mount site_node::instantiate_and_mount (public) site_node::instantiate_and_mount->site_node::mount subsite::pivot_root subsite::pivot_root (public) subsite::pivot_root->site_node::mount template::apm::after_upgrade template::apm::after_upgrade (private) template::apm::after_upgrade->site_node::mount

Testcases:
ad_context_bar

site_node::new (public)

 site_node::new -name name -parent_id parent_id \
    [ -directory_p directory_p ] [ -pattern_p pattern_p ]

create a new site node

Switches:
-name (required)
-parent_id (required)
-directory_p (defaults to "t") (optional)
-pattern_p (defaults to "t") (optional)

Partial Call Graph (max 5 caller/called nodes):
%3 test_ad_context_bar ad_context_bar (test acs-tcl) site_node::new site_node::new test_ad_context_bar->site_node::new test_site_node_closest_ancestor_package site_node_closest_ancestor_package (test acs-tcl) test_site_node_closest_ancestor_package->site_node::new apm_package_install apm_package_install (public) apm_package_install->site_node::new install::xml::action::mount install::xml::action::mount (public) install::xml::action::mount->site_node::new install::xml::action::mount-existing install::xml::action::mount-existing (public) install::xml::action::mount-existing->site_node::new packages/acs-subsite/www/admin/site-map/new.tcl packages/acs-subsite/ www/admin/site-map/new.tcl packages/acs-subsite/www/admin/site-map/new.tcl->site_node::new site_node::instantiate_and_mount site_node::instantiate_and_mount (public) site_node::instantiate_and_mount->site_node::new

Testcases:
ad_context_bar, site_node_closest_ancestor_package

site_node::rename (public)

 site_node::rename -node_id node_id -name name

Rename the site node.

Switches:
-node_id (required)
-name (required)

Partial Call Graph (max 5 caller/called nodes):
%3 test_site_node_update_cache site_node_update_cache (test acs-tcl) site_node::rename site_node::rename test_site_node_update_cache->site_node::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->site_node::rename

Testcases:
site_node_update_cache

site_node::unmount (public)

 site_node::unmount -node_id node_id

unmount an object from the site node

Switches:
-node_id (required)

Partial Call Graph (max 5 caller/called nodes):
%3 test_path_resolve path_resolve (test xowiki) site_node::unmount site_node::unmount test_path_resolve->site_node::unmount test_site_node_update_cache site_node_update_cache (test acs-tcl) test_site_node_update_cache->site_node::unmount test_slot_interactions slot_interactions (test xowiki) test_slot_interactions->site_node::unmount test_xowiki_test_cases xowiki_test_cases (test xowiki) test_xowiki_test_cases->site_node::unmount apm_package_delete apm_package_delete (public) apm_package_delete->site_node::unmount 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->site_node::unmount 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->site_node::unmount packages/acs-subsite/www/admin/site-map/unmount.tcl packages/acs-subsite/ www/admin/site-map/unmount.tcl packages/acs-subsite/www/admin/site-map/unmount.tcl->site_node::unmount packages/edit-this-page/www/etp-trash.tcl packages/edit-this-page/ www/etp-trash.tcl packages/edit-this-page/www/etp-trash.tcl->site_node::unmount

Testcases:
site_node_update_cache, xowiki_test_cases, slot_interactions, path_resolve

site_node::update_cache (public)

 site_node::update_cache [ -sync_children ] -node_id node_id \
    [ -url url ] [ -object_id object_id ]

Brings the in-memory copy of the site nodes hierarchy in sync with the database version. Only updates the given node and its children.

Switches:
-sync_children (boolean) (optional)
-node_id (required)
-url (optional)
-object_id (optional)

Partial Call Graph (max 5 caller/called nodes):
%3 apm::convert_type apm::convert_type (public) site_node::update_cache site_node::update_cache apm::convert_type->site_node::update_cache apm_package_rename apm_package_rename (public) apm_package_rename->site_node::update_cache site_node::delete site_node::delete (public) site_node::delete->site_node::update_cache site_node::mount site_node::mount (public) site_node::mount->site_node::update_cache site_node::rename site_node::rename (public) site_node::rename->site_node::update_cache

Testcases:
No testcase defined.

site_node::verify_folder_name (public)

 site_node::verify_folder_name -parent_node_id parent_node_id \
    [ -current_node_id current_node_id ] \
    [ -instance_name instance_name ] [ -folder folder ]

Verifies that the given folder name is valid for a folder under the given parent_node_id. If current_node_id is supplied, it's assumed that we're renaming an existing node, not creating a new one. If folder name is not supplied, we'll generate one from the instance name, which must then be supplied. Returns folder name to use, or empty string if the supplied folder name wasn't acceptable.

Switches:
-parent_node_id (required)
-current_node_id (optional)
-instance_name (optional)
-folder (optional)

Partial Call Graph (max 5 caller/called nodes):
%3 test_site_node_verify_folder_name site_node_verify_folder_name (test acs-tcl) site_node::verify_folder_name site_node::verify_folder_name test_site_node_verify_folder_name->site_node::verify_folder_name 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->site_node::verify_folder_name packages/acs-subsite/www/admin/applications/multiple-add.tcl packages/acs-subsite/ www/admin/applications/multiple-add.tcl packages/acs-subsite/www/admin/applications/multiple-add.tcl->site_node::verify_folder_name packages/acs-subsite/www/admin/subsite-add.tcl packages/acs-subsite/ www/admin/subsite-add.tcl packages/acs-subsite/www/admin/subsite-add.tcl->site_node::verify_folder_name

Testcases:
site_node_verify_folder_name

site_node_closest_ancestor_package (public, deprecated)

 site_node_closest_ancestor_package [ -default default ] [ -url url ] \
    package_keys
Deprecated. Invoking this procedure generates a warning.

Use site_node::closest_ancestor_package. Note that site_node_closest_ancestor_package will include the passed-in node in the search, whereas the new proc doesn't by default. If you want to include the passed-in node, call site_node::closest_ancestor_package with the -include_self flag

Finds the package id of a package of specified type that is closest to the node id represented by url (or by ad_conn url).Note that closest means the nearest ancestor node of the specified type, or the current node if it is of the correct type.

Usage:

    # Pull out the package_id of the subsite closest to our current node
    set pkg_id [site_node::closest_ancestor_package -include_self -package_key "acs-subsite"]
    

Switches:
-default (optional)
The value to return if no package can be found
-url (optional)
The url of the node from which to start the search
Parameters:
package_keys - The type(s) of the package(s) for which we are looking
Returns:
package_id of the nearest package of the specified type (package_key). Returns $default if no such package can be found.
Author:
Michael Bryzek <mbryzek@arsdigita.com>
Created:
1/17/2001

See Also:

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

Testcases:
No testcase defined.

site_node_closest_ancestor_package_url (public, deprecated)

 site_node_closest_ancestor_package_url [ -default default ] \
    [ -package_key package_key ]
Deprecated. Invoking this procedure generates a warning.

Returns the url stub of the nearest application of the specified type.

Switches:
-default (optional)
The default value to return if no package of the specified type was found
-package_key (optional)
The types of packages for which we're looking (defaults to subsite packages)
Author:
Michael Bryzek <mbryzek@arsdigita.com>
Created:
2001-02-05

See Also:
  • site::node::closest_ancestor_package

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

Testcases:
No testcase defined.

site_node_delete_package_instance (public, deprecated)

 site_node_delete_package_instance -node_id node_id
Deprecated. Invoking this procedure generates a warning.

Wrapper for apm_package_instance_delete

Switches:
-node_id (required)
Author:
Arjun Sanyal <arjun@openforc.net>
Created:
2002-05-02

See Also:

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

Testcases:
No testcase defined.

site_node_id (public, deprecated)

 site_node_id url
Deprecated. Invoking this procedure generates a warning.

Returns the node_id of a site node. Throws an error if there is no matching node.

Parameters:
url

See Also:

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

Testcases:
No testcase defined.

site_nodes_sync (public, deprecated)

 site_nodes_sync [ args... ]
Deprecated. Invoking this procedure generates a warning.

Brings the in-memory copy of the url hierarchy in sync with the database version.


See Also:

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

Testcases:
No testcase defined.
[ show source ]