Callback for executing code after the subsite theme has been send changed

Switches:

-subsite_id (required)

subsite, of which the theme was changed

-old_theme (required)

the old theme

-new_theme (required)

the new theme

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

Testcases:

No testcase defined.

Helper proc for adding rows of sections to the page flow of the subsite.

Switches:

-array (required)

-base_url (required)

-multirow (required)

-section (optional)

See Also:

• subsite::define_pageflow

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

Testcases:

No testcase defined.

Used on pages that add users to the application group of the current subsite to assert that the currently logged-in user may add users.

Author:

Peter Marklund

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

Testcases:

No testcase defined.

Mounts a new instance of the application specified by package_key beneath node_id. This proc makes sure that the instance_name (the name of the new node) is unique before invoking site_node::instantiate_and_mount.

Switches:

-instance_name (optional)

The name to use for the url in the site-map. Defaults to the package_key plus a possible digit to serve as a unique identifier (e.g. news-2)

-pretty_name (optional)

The english name to use for the site-map and for things like context bars. Defaults to the name of the object mounted at this node + the package pretty name (e.g. Intranet News)

-node_id (optional)

Defaults to [ad_conn node_id]

Parameters:

package_key (required)

Returns:

The package id of the newly mounted package

Author:

Michael Bryzek <mbryzek@arsdigita.com>

Created:

2001-02-28

See Also:

• site_node::instantiate_and_mount

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

Testcases:

subsite_api

Create the default application group for a subsite.

• Create application group
• Create segment "Subsite Users"
• Create relational constraint to make subsite registration require supersite registration.

Switches:

-package_id (optional)

-name (optional)

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

Testcases:

No testcase defined.

Delete the default application group for a subsite.

Switches:

-package_id (optional)

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

Testcases:

No testcase defined.

Defines the page flow of the subsite TODO: add an image TODO: add link_p/selected_p for subsections

Switches:

-sections_multirow (optional, defaults to "sections")

-subsections_multirow (optional, defaults to "subsections")

-section (optional)

-url (optional)

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

Testcases:

No testcase defined.

Delete a subsite theme, making it unavailable to the theme configuration code.

Switches:

-key (required)

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

Testcases:

subsite_api

Get information about a subsite.

Switches:

-subsite_id (optional)

The id of the subsite for which info is requested. If no id is provided, then the id of the closest ancestor subsite will be used.

-array (optional)

The name of an array in which information will be returned.

Returns:

dict with subsite attributed

Author:

Frank Nikolajsen <frank@warpspace.com>

Created:

2003-03-08

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

Testcases:

subsite_api

Gets options list for applications to install

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

Testcases:

subsite_api

Return a single element from the information about a subsite.

Switches:

-subsite_id (optional)

The node id of the subsite for which info is requested. If no id is provided, then the id of the closest ancestor subsite will be used.

-element (required)

The element you want, one of: directory_p object_type package_key package_id name pattern_p instance_name node_id parent_id url object_id

-notrailing (optional, boolean)

If true and the element requested is a URL, then strip any trailing slash ('/'). This means the empty string is returned for the root.

Returns:

The element you asked for

Author:

Frank Nikolajsen <frank@warpspace.com>

Created:

2003-03-08

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

Testcases:

user_links_api

Defines the page flow structure.

Switches:

-url (optional)

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

Testcases:

No testcase defined.

Takes the sections_multirow and sets the passed array name with the elements label and url of the selected section.

Switches:

-array (optional, defaults to "section_info")

-sections_multirow (optional, defaults to "sections")

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

Testcases:

No testcase defined.

Get the theme for the given (or current) subsite.

Switches:

-subsite_id (optional)

id of the subsite

Returns:

Name of the theme (theme key)

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

Testcases:

subsite_api

Gets options for subsite themes for use with a form builder select widget.

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

Testcases:

subsite_api

Returns a list of all packages implementing subsite that are currently using specified theme. Optionally, returns a list of just those that were not locally modified.

Switches:

-theme (required)

theme key to lookup for.

-subsite_id (optional)

narrow search to this subsite only. Useful to check whether a single subsite is using a theme with or without local modifications.

-unmodified (optional, boolean)

decides whether we include subsites which theme was locally modified.

Returns:

list of subsite_id

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

Testcases:

subsite_api

Returns the url stub for the specified subsite. If -absolute is supplied then this function will generate absolute URLs. If the site is currently being accessed via a host node mapping then URLs will omit the corresponding subsite url stub. The hostname will be used for any appropriate subsite when absolute URLs are generated.

Switches:

-node_id (optional)

the subsite's node_id (defaults to nearest subsite node).

-absolute_p (optional, defaults to "0")

whether to include the host in the returned url.

-force_host (optional)

Use a certain host. In case "any" is specified, and we have a host-node-mapping (e.g. non-connected cases) behave like a virtual server on the first host-node-mapping entry. In connected cases, "any" means: take whatever is provided via vhost.

-strict_p (optional, defaults to "0")

-protocol (optional)

-port (optional)

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

Testcases:

subsite_api

Returns 1 if the instance_name exists at this node. 0 otherwise. Note that the search is case-sensitive.

Parameters:

node_id (required)

instance_name (required)

Author:

Michael Bryzek <mbryzek@arsdigita.com>

Created:

2001-03-01

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

Testcases:

No testcase defined.

Get the package_id of the Main Site. The Main Site is the subsite that is always mounted at '/' and that has a number of site-wide parameter settings.

Author:

Peter Marklund

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

Testcases:

acs_subsite_trivial_smoke_test, acs_subsite_test_email_confirmation, password_recovery_page, site_node_closest_ancestor_package

Add a new subsite theme, making it available to the theme configuration code.

Switches:

-key (required)

-name (required)

-template (required)

-css (optional)

-js (optional)

-form_template (optional)

-list_template (optional)

-list_filter_template (optional)

-dimensional_template (optional)

-resource_dir (optional)

-streaming_head (optional)

-local_p (optional, defaults to "true")

-create_or_replace (optional, boolean)

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

Testcases:

subsite_api

Get the list of packages which can be subsites. This is built during the bootstrap process. If you install a new subsite-implementing package and don't accept the installers invitation to reboot openacs, tough luck.

Returns:

the packages keys of all installed packages acting as subsites.

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

Testcases:

subsite_api

Pivot the package associated with node_id onto the root. Mounting the current root package under node_id.

Switches:

-node_id (required)

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

Testcases:

No testcase defined.

Reload theme subsite parameters from defaults on every subsite currently using specified theme. This might be used, for example, in upgrade callbacks for themes if desired behavior is to upgrade all subsites using it without manual intervention. By default this proc will not refresh locally modified templates.

Switches:

-theme (optional)

theme key to lookup for

-include_modified (optional, boolean)

force reload also for locally modified templates

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

Testcases:

subsite_api

Save the actual theming parameter set of the given/current subsite as default for the given/current theme. These default values are used, whenever a subsite switches to the specified theme.

Switches:

-subsite_id (optional)

Id of the subsite

-theme (optional)

Name of the theme (theme key)

-local_p (optional)

Author:

Gustaf Neumann

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

Testcases:

No testcase defined.

Save the actual theming parameter for the given/current subsite under a new name.

Switches:

-subsite_id (optional)

Id of the subsite

-theme (required)

Name of the theme (theme key)

-pretty_name (required)

Pretty Name (of the theme)

Author:

Gustaf Neumann

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

Testcases:

No testcase defined.

Set the theme for the given or current subsite. This will change the subsite's ThemeKey, DefaultMaster, and ThemeCSS, DefaultFormStyle, DefaultListStyle, DefaultListFilterStyle, DefaultDimensionalStyle, and ResourceDir parameters.

Switches:

-subsite_id (optional)

Id of the subsite

-theme (required)

Name of the theme (theme key)

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

Testcases:

subsite_api

Update the default theming parameters in the database

Switches:

-key (required)

-name (required)

-template (required)

-css (optional)

-js (optional)

-form_template (optional)

-list_template (optional)

-list_filter_template (optional)

-dimensional_template (optional)

-resource_dir (optional)

-streaming_head (optional)

-local_p (optional, defaults to "false")

Author:

Gustaf Neumann

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

Testcases:

subsite_api

Verifies SolicitPortraitP parameter to ensure upload portrait security.

Author:

Hector Amado <hr_amado@galileo.edu>

Created:

2004-06-16

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

Testcases:

No testcase defined.

Get a list of pretty name, package key pairs for all packages which identify themselves as implementing subsite semantics.

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):

Testcases:

subsite_api

Parameters:

object_type (required)

ancestor_type (optional, defaults to "acs_object")

Returns:

the object type hierarchy for the given object type from ancestor_type to object_type

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

Testcases:

No testcase defined.

returns pretty name of object. We need this so often that I thought I'd stick it in a proc so it can possibly be cached later.

Parameters:

object_type (required)

Author:

Oumi Mehrotra <oumi@arsdigita.com>

Created:

2000-02-07

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

Testcases:

No testcase defined.

Return a list of package_id's for the subsite containing node_id This is a memoized function which caches for 20 minutes.

Switches:

-node_id (optional)

Author:

Jeff Davis davis@xarg.net

Created:

2004-05-07

See Also:

• subsite::util::packages_no_mem

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

Testcases:

subsite_api

return a list of package_id's for children of the passed node_id

Switches:

-node_id (optional)

Author:

Jeff Davis davis@xarg.net

Created:

2004-05-07

See Also:

• subsite::util::packages

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

Testcases:

No testcase defined.

Given a list of return_urls, we recursively encode them into one return_url that can be redirected to or passed into a page. As long as each page in the list does the typical redirect to return_url, then the page flow will go through each of the pages in $return_url_list

Parameters:

return_url_list (required)

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

Testcases:

No testcase defined.

Parameters:

object_type (required)

Returns:

1 if object_type has sub types, or 0 otherwise

Author:

Oumi Mehrotra <oumi@arsdigita.com>

Created:

2000-02-07

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

Testcases:

No testcase defined.