acs-permissions-procs.tcl


	The Toolkit for Online Communities 13557 Community Members, 0 members online, 1810 visitors today			Log In	Register

acs-permissions-procs.tcl

OpenACS Home : ACS API Browser : ACS Tcl 4.5 : acs-permissions-procs.tcl

Publicity:
[Public Only \| All]

acs-permissions-procs.tcl

Tcl procs for the acs permissioning system.

Location:
packages/acs-tcl/tcl/acs-permissions-procs.tcl
Created:
2000-08-17
Author:
rhs@mit.edu
CVS Identification:
$Id: acs-permissions-procs.tcl,v 1.30 2008/12/23 12:22:59 gustafn Exp $

Procedures in this file

ad_permission_grant (public)
ad_permission_p (public)
ad_permission_revoke (public)
ad_require_permission (public)
permission::grant (public)
permission::inherit_p (public)
permission::permission_p (public)
permission::require_permission (public)
permission::require_write_permission (public)
permission::revoke (public)
permission::set_inherit (public)
permission::set_not_inherit (public)
permission::toggle_inherit (public)
permission::write_permission_p (public)

Detailed information

ad_permission_grant (public)

ad_permission_grant user_id object_id privilege

Deprecated.
Grant a permission

Parameters:
user_id
object_id
privilege

Author:
ben@openforce.net

See Also:
permission::grant

ad_permission_p (public)

ad_permission_p [ -user_id user_id ] object_id privilege

Deprecated.

Switches:

-user_id (optional)

Parameters:
object_id
privilege

See Also:
permission::permission_p

ad_permission_revoke (public)

ad_permission_revoke user_id object_id privilege

Deprecated.
Revoke a permission

Parameters:
user_id
object_id
privilege

Author:
ben@openforce.net

See Also:
permission::revoke

ad_require_permission (public)

ad_require_permission object_id privilege

Deprecated.

Parameters:
object_id
privilege

See Also:
permission::require_permission

permission::grant (public)

permission::grant -party_id party_id -object_id object_id \
    -privilege privilege

grant privilege Y to party X on object Z

Switches:

-party_id (required)
-object_id (required)
-privilege (required)

permission::inherit_p (public)

permission::inherit_p -object_id object_id

does this object inherit permissions

Switches:

-object_id (required)

permission::permission_p (public)

permission::permission_p [ -no_login ] [ -no_cache ] \
    [ -party_id party_id ] -object_id object_id -privilege privilege

does party X have privilege Y on object Z

Switches:

-no_login (boolean) (optional)
Don't bump to registration to refresh authentication, if the user's authentication is expired. This is specifically required in the case where you're calling this from the proc that gets the login page.
-no_cache (boolean) (optional)
force loading from db even if cached (flushes cache as well)
-party_id (optional)
if null then it is the current user_id
-object_id (required)
The object you want to check permissions on.
-privilege (required)
The privilege you want to check for.

permission::require_permission (public)

permission::require_permission [ -party_id party_id ] \
    -object_id object_id -privilege privilege

require that party X have privilege Y on object Z

Switches:

-party_id (optional)
-object_id (required)
-privilege (required)

permission::require_write_permission (public)

permission::require_write_permission -object_id object_id \
    [ -creation_user creation_user ] [ -party_id party_id ] \
    [ -action action ]

If the user is not allowed to edit this object, returns a permission denied page.

Switches:

-object_id (required)
-creation_user (optional)
Optionally specify creation_user directly as an optimization. Otherwise a query will be executed.
-party_id (optional)
The party to have or not have write permission.
-action (defaults to "edit") (optional)

See Also:
permission::write_permission_p

permission::revoke (public)

permission::revoke -party_id party_id -object_id object_id \
    -privilege privilege

revoke privilege Y from party X on object Z

Switches:

-party_id (required)
-object_id (required)
-privilege (required)

permission::set_inherit (public)

permission::set_inherit -object_id object_id

set inherit to true

Switches:

-object_id (required)

permission::set_not_inherit (public)

permission::set_not_inherit -object_id object_id

set inherit to false

Switches:

-object_id (required)

permission::toggle_inherit (public)

permission::toggle_inherit -object_id object_id

toggle whether or not this object inherits permissions from it's parent

Switches:

-object_id (required)

permission::write_permission_p (public)

permission::write_permission_p -object_id object_id \
    [ -party_id party_id ] [ -creation_user creation_user ]

Returns whether a user is allowed to edit an object. The logic is that you must have either write permission, or you must be the one who created the object.

Switches:

-object_id (required)
The object you want to check write permissions for
-party_id (optional)
The party to have or not have write permission.
-creation_user (optional)
Optionally specify creation_user directly as an optimization. Otherwise a query will be executed.

Returns:
True (1) if user has permission to edit the object, 0 otherwise.

See Also:
permission::require_write_permission