CMFPlone.GroupsTool.GroupsTool

Package CMFPlone :: Module GroupsTool :: Class GroupsTool

[show private | hide private]

Type GroupsTool

         ActionProviderBase --+    
                              |    
         object --+           |    
                  |           |    
               Base --+       |    
                      |       |    
     object --+       |       |    
              |       |       |    
           Base --+   |       |    
                  |   |       |    
         CopySource --+       |    
                      |       |    
           Node --+   |       |    
                  |   |       |    
            Element --+       |    
                      |       |    
     object --+       |       |    
              |       |       |    
           Base --+   |       |    
                  |   |       |    
              Owned --+       |    
                      |       |    
     object --+       |       |    
              |       |       |    
           Base --+   |       |    
                  |   |       |    
EtagSupport --+   |   |       |    
              |   |   |       |    
   LockableItem --+   |       |    
                  |   |       |    
           Resource --+       |    
                      |       |    
     object --+       |       |    
              |       |       |    
           Base --+   |       |    
                  |   |       |    
               Tabs --+       |    
                      |       |    
        Traversable --+       |    
                      |       |    
     object --+       |       |    
              |       |       |    
           Base --+   |       |    
                  |   |       |    
        UndoSupport --+       |    
                      |       |    
                   Item --+   |    
                          |   |    
         object --+       |   |    
                  |       |   |    
               Base --+   |   |    
                      |   |   |    
         object --+   |   |   |    
                  |   |   |   |    
         Persistent --+   |   |    
                      |   |   |    
             Persistent --+   |    
                          |   |    
         object --+       |   |    
                  |       |   |    
               Base --+   |   |    
                      |   |   |    
        RoleManager --+   |   |    
                      |   |   |    
            RoleManager --+   |    
                          |   |    
         object --+       |   |    
                  |       |   |    
               Base --+   |   |    
                      |   |   |    
               Acquirer --+   |    
                          |   |    
                 SimpleItem --+    
                              |    
         object --+           |    
                  |           |    
               Base --+       |    
                      |       |    
            ImmutableId --+   |    
                          |   |    
               UniqueObject --+    
                              |    
                     GroupsTool --+
                                  |
                  PloneBaseTool --+
                                  |
                                 GroupsTool

This tool accesses group data through a GRUF acl_users object.

It can be replaced with something that groups member data in a different way.

Method Summary
	`createGrouparea(self, id)` Override the method to make sure the groups folder gets indexed, GRUF makes a policy decision to unindex the groups folder.
	`getGroupInfo(self, groupId)` Return default group info of any group
Inherited from GroupsTool
	`addGroup(self, id, roles, groups, args, *kw)` Create a group, and a group workspace if the toggle is on, with the supplied id, roles, and domains.
	`editGroup(self, id, roles, groups, args, *kw)` Edit the given group with the supplied password, roles, and domains.
	`getGroupareaFolder(self, id, verifyPermission)` Returns the object of the group's work area.
	`getGroupareaURL(self, id, verifyPermission)` Returns the full URL to the group's work area.
	`getGroupById(self, id)` Returns the portal_groupdata-ish object for a group corresponding to this id.
	`getGroupsByUserId(self, userid)` Return a list of the groups the user corresponding to 'userid' belongs to.
	`getGroupWorkspaceContainerType(self)` Return the Type (as in TypesTool) to make the GroupWorkspace.
	`getGroupWorkspacesCreationFlag(self)` Return the (boolean) flag indicating whether the Groups Tool will create a group workspace upon the creation of the group (if one doesn't exist already).
	`getGroupWorkspacesFolder(self)` Get the Group Workspaces folder object.
	`getGroupWorkspacesFolderId(self)` Get the Group Workspaces folder object's id.
	`getGroupWorkspacesFolderTitle(self)` Get the Group Workspaces folder object's title.
	`getGroupWorkspaceType(self)` Return the Type (as in TypesTool) to make the GroupWorkspace.
	`isGroup(self, u)` Test if a user/group object is a group or not.
	`listGroupIds(self)` Return a list of the available groups' ids as entered (without group prefixes).
	`listGroupNames(self)` Return a list of the available groups' ids as entered (without group prefixes).
	`listGroups(self)` Return a list of the available portal_groupdata-ish objects.
	`manage_setGroupWorkspaceContainerType(self, type, REQUEST)` ZMI method for workspace type set.
	`manage_setGroupWorkspacesFolder(self, id, title, REQUEST)` ZMI method for workspace container name set.
	`manage_setGroupWorkspaceType(self, type, REQUEST)` ZMI method for workspace type set.
	`removeGroups(self, ids, keep_workspaces)` Remove the group in the provided list (if possible).
	`searchForGroups(self, REQUEST, **kw)` Return a list of groups meeting certain conditions.
	`setGroupOwnership(self, group, object)` Make the object 'object' owned by group 'group' (a portal_groupdata-ish object).
	`setGroupWorkspaceContainerType(self, type)` Set the Type (as in TypesTool) to make the GroupWorkspace.
	`setGroupWorkspacesFolder(self, id, title)` Set the location of the Group Workspaces folder by id.
	`setGroupWorkspaceType(self, type)` Set the Type (as in TypesTool) to make the GroupWorkspace.
	`toggleGroupWorkspacesCreation(self, REQUEST)` Toggles the flag for creation of a GroupWorkspaces folder upon creation of the group.
	`wrapGroup(self, g, wrap_anon)` Sets up the correct acquisition wrappers for a user object and provides an opportunity for a portal_memberdata tool to retrieve and store member data independently of the user object.
Inherited from Item
	`__len__(self)`
	`__repr__(self)` Show the physical path of the object and its context if available.
	`analyseDocumentation(self, object, type, filter)`
	`getId(self)` Return the id of the object as a string.
	`manage(self, URL1)`
	`manage_afterAdd(self, item, container)`
	`manage_afterClone(self, item)`
	`manage_beforeDelete(self, item, container)`
	`manage_editedDialog(self, REQUEST, **args)`
	`manage_FTPlist(self, REQUEST)` Directory listing for FTP.
	`manage_FTPstat(self, REQUEST)` Psuedo stat, used by FTP for directory listings.
	`objectIds(self, spec)`
	`objectItems(self, spec)`
	`objectValues(self, spec)`
	`raise_standardErrorMessage(self, client, REQUEST, error_type, error_value, tb, error_tb, error_message, tagSearch, error_log_url)`
	`this(self)`
	`title_and_id(self)` Return the title if it is not blank and the id otherwise.
	`title_or_id(self)` Return the title if it is not blank and the id otherwise.
	`tpURL(self)`
	`tpValues(self)`
Inherited from Resource
	`COPY(self, REQUEST, RESPONSE)` Create a duplicate of the source resource whose state and behavior match that of the source resource as closely as possible.
	`dav__init(self, request, response)`
	`dav__simpleifhandler(self, request, response, method, col, url, refresh)`
	`dav__validate(self, object, methodname, REQUEST)`
	`DELETE(self, REQUEST, RESPONSE)` Delete a resource.
	`HEAD(self, REQUEST, RESPONSE)` Retrieve resource information without a response body.
	`listDAVObjects(self)`
	`LOCK(self, REQUEST, RESPONSE)` Lock a resource
	`manage_DAVget(self)` Gets the document source
	`MKCOL(self, REQUEST, RESPONSE)` Create a new collection resource.
	`MOVE(self, REQUEST, RESPONSE)` Move a resource to a new location.
	`OPTIONS(self, REQUEST, RESPONSE)` Retrieve communication options.
	`PROPFIND(self, REQUEST, RESPONSE)` Retrieve properties defined on the resource.
	`PROPPATCH(self, REQUEST, RESPONSE)` Set and/or remove properties defined on the resource.
	`PUT(self, REQUEST, RESPONSE)` Replace the GET response entity of an existing resource.
	`TRACE(self, REQUEST, RESPONSE)` Return the HTTP message received back to the client as the entity-body of a 200 (OK) response.
	`UNLOCK(self, REQUEST, RESPONSE)` Remove an existing lock on a resource.
Inherited from LockableItem
	`wl_clearLocks(self)`
	`wl_delLock(self, locktoken)`
	`wl_getLock(self, locktoken)`
	`wl_hasLock(self, token, killinvalids)`
	`wl_isLocked(self)`
	`wl_lockItems(self, killinvalids)`
	`wl_lockmapping(self, killinvalids, create)` if 'killinvalids' is 1, locks who are no longer valid will be deleted
	`wl_lockTokens(self, killinvalids)`
	`wl_lockValues(self, killinvalids)`
	`wl_setLock(self, locktoken, lock)`
Inherited from EtagSupport
	`http__etag(self, readonly)`
	`http__parseMatchList(self, REQUEST, header)`
	`http__processMatchHeaders(self, REQUEST)`
	`http__refreshEtag(self)`
Inherited from CopySource
	`cb_isCopyable(self)`
	`cb_isMoveable(self)`
	`cb_userHasCopyOrMovePermission(self)`
Inherited from Tabs
	`_old_filtered_manage_options(self, REQUEST)`
	`class_manage_path(self)`
	`filtered_manage_options(self, REQUEST)`
	`manage_workspace(self, REQUEST)` Dispatch to first interface in manage_options
	`tabs_path_default(self, REQUEST, unquote)`
	`tabs_path_info(self, script, path, quote)`
Inherited from Traversable
	`absolute_url(self, relative)` Return the absolute URL of the object.
	`absolute_url_path(self)` Return the path portion of the absolute URL of the object.
	`getPhysicalPath(self)` Get the physical path of the object.
	`restrictedTraverse(self, path, default)`
	`unrestrictedTraverse(self, path, default, restricted)` Lookup an object by path.
	`virtual_url_path(self)` Return a URL for the object, relative to the site root.
Inherited from Element
	`getAttribute(self, name)` Retrieves an attribute value by name.
	`getAttributeNode(self, name)` Retrieves an Attr node by name or None if there is no such attribute.
	`getChildNodes(self)` Returns a NodeList that contains all children of this node.
	`getElementsByTagName(self, tagname)` Returns a NodeList of all the Elements with a given tag name in the order in which they would be encountered in a preorder traversal of the Document tree.
	`getFirstChild(self)` The first child of this node.
	`getLastChild(self)` The last child of this node.
	`getNextSibling(self)` The node immediately preceding this node.
	`getNodeName(self)` The name of this node, depending on its type
	`getNodeType(self)` A code representing the type of the node.
	`getParentNode(self)` The parent of this node.
	`getPreviousSibling(self)` The node immediately preceding this node.
	`getTagName(self)` The name of the element
Inherited from Node
	`getAttributes(self)` Returns a NamedNodeMap containing the attributes of this node (if it is an element) or None otherwise.
	`getNodeValue(self)` The value of this node, depending on its type
	`getOwnerDocument(self)` The Document object associated with this node.
	`hasChildNodes(self)` Returns true if the node has any children, false if it doesn't.
Inherited from Owned
	`changeOwnership(self, user, recursive)` Change the ownership to the given user.
	`getOwner(self, info, aq_get, UnownableOwner, getSecurityManager)` Get the owner
	`getOwnerTuple(self)` Return a tuple, (userdb_path, user_id) for the owner.
	`getWrappedOwner(self)` Get the owner, modestly wrapped in the user folder.
	`manage_changeOwnershipType(self, explicit, RESPONSE, REQUEST)` Change the type (implicit or explicit) of ownership.
	`manage_fixupOwnershipAfterAdd(self)`
	`manage_takeOwnership(self, REQUEST, RESPONSE, recursive)` Take ownership (responsibility) for an object.
	`owner_info(self)` Get ownership info for display
	`userCanTakeOwnership(self)`
Inherited from UndoSupport
	`get_request_var_or_attr(self, name, default)`
	`manage_undo_transactions(self, transaction_info, REQUEST)`
	`undoable_transactions(self, first_transaction, last_transaction, PrincipiaUndoBatchSize)`
Inherited from Persistent
	`__class_init__(self)`
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`bobobase_modification_time(self)`
	`locked_in_version(self)` Was the object modified in any version?
	`modified_in_version(self)` Was the object modified in this version?
Inherited from Persistent
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getstate__(...)` Get the object serialization state
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` Reduce an object to contituent parts for serialization
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__setstate__(...)` Set the object serialization state The state should be in one of 3 forms: - None Ignored - A dictionary In this case, the object's instance dictionary will be cleared and updated with the new state.
Inherited from RoleManager
	`ac_inherited_permissions(self, all)`
	`access_debug_info(self)` Return debug info.
	`acquiredRolesAreUsedBy(self, permission)` Used by management screen.
	`get_local_roles(self)`
	`get_local_roles_for_userid(self, userid)`
	`get_valid_userids(self)`
	`has_local_roles(self)`
	`manage_access(self, REQUEST, **kw)` Return an interface for making permissions settings.
	`manage_acquiredPermissions(self, permissions, REQUEST)` Change the permissions that acquire.
	`manage_addLocalRoles(self, userid, roles, REQUEST)` Set local roles for a user.
	`manage_changePermissions(self, REQUEST)` Change all permissions settings, called by management screen.
	`manage_defined_roles(self, submit, REQUEST)` Called by management screen.
	`manage_delLocalRoles(self, userids, REQUEST)` Remove all local roles for a user.
	`manage_editRoles(self, REQUEST, acl_type, acl_roles)`
	`manage_permission(self, permission_to_manage, roles, acquire, REQUEST)` Change the settings for the given permission.
	`manage_role(self, role_to_manage, permissions, REQUEST)` Change the permissions given to the given role.
	`manage_setLocalRoles(self, userid, roles, REQUEST)` Set local roles for a user.
	`permission_settings(self, permission)` Return user-role permission settings.
	`permissionsOfRole(self, role)` Used by management screen.
	`possible_permissions(self)`
	`rolesOfPermission(self, permission)` Used by management screen.
	`userdefined_roles(self)` Return list of user-defined roles.
	`users_with_local_role(self, role)`
	`valid_roles(self)` Return list of valid roles.
	`validate_roles(self, roles)` Return true if all given roles are valid.
	`validRoles(self)` Return list of valid roles.
Inherited from RoleManager
	`manage_getPermissionMapping(self)` Return the permission mapping for the object This is a list of dictionaries with: permission_name -- The name of the native object permission class_permission -- The class permission the permission is mapped to.
	`manage_setPermissionMapping(self, permission_names, class_permissions, REQUEST)` Change the permission mapping
Inherited from ActionProviderBase
	`addAction(self, id, name, action, condition, permission, category, visible, REQUEST)` Add an action to our list.
	`changeActions(self, properties, REQUEST)` Update our list of actions.
	`deleteActions(self, selections, REQUEST)` Delete actions indicated by indexes in 'selections'.
	`getActionInfo(self, action_chain, object, check_visibility, check_condition)` Get an ActionInfo object specified by a chain of actions.
	`getActionObject(self, action)` Return the actions object or None if action doesn't exist.
	`listActionInfos(self, action_chain, object, check_visibility, check_permissions, check_condition, max)`
	`listActions(self, info, object)` List all the actions defined by a provider.
	`manage_editActionsForm(self, REQUEST, manage_tabs_message)` Show the 'Actions' management tab.
	`moveDownActions(self, selections, REQUEST)` Move the specified actions down one slot in our list.
	`moveUpActions(self, selections, REQUEST)` Move the specified actions up one slot in our list.
Inherited from Base
	`__getnewargs__(...)` Get arguments to be passed to __new__
Inherited from object
	`__init__(...)` x.__init__(...) initializes x; see x.__class__.__doc__ for signature
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__reduce_ex__(...)` helper for pickle
	`__str__(x)` x.__str__() <==> str(x)

Class Variable Summary
`tuple`	`__ac_permissions__` = `()`
`tuple`	`__implements__` = `(<Interface Products.CMFPlone.interface...`
`NoneType`	`getGroupInfo__roles__` = None
`int`	`groupWorkspacesCreationFlag` = 0
`str`	`meta_type` = `'Plone Groups Tool'`
`str`	`toolicon` = `'skins/plone_images/group.gif'`
Inherited from GroupsTool
`str`	`__factory_meta_type__` = `'CMF Groups Tool'`
`PermissionRole`	`addGroup__roles__` = `<PermissionRole object at 0xb6178758...`
`PermissionRole`	`createGrouparea__roles__` = `<PermissionRole object at 0xb...`
`PermissionRole`	`editGroup__roles__` = `<PermissionRole object at 0xb617887...`
`NoneType`	`getGroupareaFolder__roles__` = None
`NoneType`	`getGroupareaURL__roles__` = None
`PermissionRole`	`getGroupById__roles__` = `<PermissionRole object at 0xb617...`
`PermissionRole`	`getGroupsByUserId__roles__` = `<PermissionRole object at 0...`
`PermissionRole`	`getGroupWorkspaceContainerType__roles__` = `<PermissionRol...`
`PermissionRole`	`getGroupWorkspacesCreationFlag__roles__` = `<PermissionRol...`
`NoneType`	`getGroupWorkspacesFolder__roles__` = None
`PermissionRole`	`getGroupWorkspacesFolderId__roles__` = `<PermissionRole ob...`
`PermissionRole`	`getGroupWorkspacesFolderTitle__roles__` = `<PermissionRole...`
`PermissionRole`	`getGroupWorkspaceType__roles__` = `<PermissionRole object ...`
`str`	`groupWorkspaceContainerType` = `'Folder'`
`str`	`groupworkspaces_id` = `'groups'`
`str`	`groupworkspaces_title` = `'Groups'`
`str`	`groupWorkspaceType` = `'Folder'`
`str`	`icon` = `'misc_/GroupUserFolder/tool.gif'`
`str`	`id` = `'portal_groups'`
`NoneType`	`isGroup__roles__` = None
`PermissionRole`	`listGroupIds__roles__` = `<PermissionRole object at 0xb617...`
`PermissionRole`	`listGroupNames__roles__` = `<PermissionRole object at 0xb6...`
`PermissionRole`	`listGroups__roles__` = `<PermissionRole object at 0xb61786...`
`DTMLFile`	`manage_config` = `<App.special_dtml.DTMLFile object at 0xb...`
`PermissionRole`	`manage_config__roles__` = `<PermissionRole object at 0xb61...`
`tuple`	`manage_options` = `({'action': 'manage_config', 'label': '...`
`DTMLFile`	`manage_overview` = `<App.special_dtml.DTMLFile object at 0...`
`PermissionRole`	`manage_overview__roles__` = `<PermissionRole object at 0xb...`
`PermissionRole`	`manage_setGroupWorkspaceContainerType__roles__` = `<Permis...`
`PermissionRole`	`manage_setGroupWorkspacesFolder__roles__` = `<PermissionRo...`
`PermissionRole`	`manage_setGroupWorkspaceType__roles__` = `<PermissionRole ...`
`PermissionRole`	`removeGroups__roles__` = `<PermissionRole object at 0xb617...`
`PermissionRole`	`searchForGroups__roles__` = `<PermissionRole object at 0xb...`
`PermissionRole`	`setGroupOwnership__roles__` = `<PermissionRole object at 0...`
`PermissionRole`	`setGroupWorkspaceContainerType__roles__` = `<PermissionRol...`
`PermissionRole`	`setGroupWorkspacesFolder__roles__` = `<PermissionRole obje...`
`PermissionRole`	`setGroupWorkspaceType__roles__` = `<PermissionRole object ...`
`PermissionRole`	`toggleGroupWorkspacesCreation__roles__` = `<PermissionRole...`
`tuple`	`wrapGroup__roles__` = `()`
Inherited from UniqueObject
`Implements`	`__implemented__` = `<implementedBy Products.CMFCore.utils....`
`ClassProvides`	`__provides__` = `<zope.interface.declarations.ClassProvide...`
`int`	`__replaceable__` = 2
Inherited from ImmutableId
`ClassProvides`	`__providedBy__` = `<zope.interface.declarations.ClassProvi...`
Inherited from Item
`int`	`__allow_access_to_unprotected_subobjects__` = 1
`str`	`__name__` = `'Item'`
`tuple`	`__propsets__` = `()`
`PermissionRole`	`analyseDocumentation__roles__` = `<PermissionRole object a...`
`NoneType`	`getId__roles__` = None
`int`	`isPrincipiaFolderish` = 0
`int`	`isTopLevelPrincipiaApplicationObject` = 0
`tuple`	`manage__roles__` = `('Manager',)`
`tuple`	`manage_afterAdd__roles__` = `('Manager',)`
`tuple`	`manage_afterClone__roles__` = `('Manager',)`
`tuple`	`manage_beforeDelete__roles__` = `('Manager',)`
`tuple`	`manage_editedDialog__roles__` = `('Manager',)`
`tuple`	`manage_FTPlist__roles__` = `('Manager',)`
`tuple`	`manage_FTPstat__roles__` = `('Manager',)`
`str`	`REQUEST` = `'<Special Object Used to Force Acquisition>'`
`ClassicHTMLFile`	`showDocumentation` = `<App.special_dtml.ClassicHTMLFile ob...`
`PermissionRole`	`showDocumentation__roles__` = `<PermissionRole object at 0...`
`str`	`title` = `''`
Inherited from Resource
`int`	`__dav_resource__` = 1
`tuple`	`__http_methods__` = `('GET', 'HEAD', 'POST', 'PUT', 'DELET...`
`tuple`	`COPY__roles__` = `('Anonymous',)`
`PermissionRole`	`DELETE__roles__` = `<PermissionRole object at 0xb7457188>`
`PermissionRole`	`HEAD__roles__` = `<PermissionRole object at 0xb7457140>`
`PermissionRole`	`listDAVObjects__roles__` = `<PermissionRole object at 0xb7...`
`PermissionRole`	`LOCK__roles__` = `<PermissionRole object at 0xb74571a0>`
`PermissionRole`	`manage_DAVget__roles__` = `<PermissionRole object at 0xb74...`
`tuple`	`MOVE__roles__` = `('Anonymous',)`
`NoneType`	`OPTIONS__roles__` = None
`PermissionRole`	`PROPFIND__roles__` = `<PermissionRole object at 0xb7457158...`
`PermissionRole`	`PROPPATCH__roles__` = `<PermissionRole object at 0xb745717...`
`NoneType`	`TRACE__roles__` = None
`PermissionRole`	`UNLOCK__roles__` = `<PermissionRole object at 0xb74571b8>`
Inherited from LockableItem
`PermissionRole`	`wl_clearLocks__roles__` = `<PermissionRole object at 0xb75...`
`PermissionRole`	`wl_delLock__roles__` = `<PermissionRole object at 0xb7558d...`
`NoneType`	`wl_getLock__roles__` = None
`PermissionRole`	`wl_grantLockToUser__roles__` = `<PermissionRole object at ...`
`NoneType`	`wl_isLocked__roles__` = None
`NoneType`	`wl_isLockedByUser__roles__` = None
`NoneType`	`wl_lockItems__roles__` = None
`tuple`	`wl_lockmapping__roles__` = `()`
`NoneType`	`wl_lockTokens__roles__` = None
`NoneType`	`wl_lockValues__roles__` = None
`PermissionRole`	`wl_setLock__roles__` = `<PermissionRole object at 0xb7558e...`
Inherited from Tabs
`NoneType`	`class_manage_path__roles__` = None
`NoneType`	`filtered_manage_options__roles__` = None
`DTMLFile`	`manage_tabs` = `<App.special_dtml.DTMLFile object at 0xb74...`
`tuple`	`manage_tabs__roles__` = `('Anonymous',)`
`tuple`	`manage_workspace__roles__` = `('Authenticated',)`