CMFPlone.MembershipTool.MembershipTool

Package CMFPlone :: Module MembershipTool :: Class MembershipTool

[show private | hide private]

Type MembershipTool

             ActionProviderBase --+        
                                  |        
         object --+               |        
                  |               |        
               Base --+           |        
                      |           |        
    EtagSupport --+   |           |        
                  |   |           |        
       LockableItem --+           |        
                      |           |        
               Resource --+       |        
                          |       |        
                 Collection --+   |        
                              |   |        
             object --+       |   |        
                      |       |   |        
                   Base --+   |   |        
                          |   |   |        
                FindSupport --+   |        
                              |   |        
             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 --+           |   |        
                  |           |   |        
EtagSupport --+   |           |   |        
              |   |           |   |        
   LockableItem --+           |   |        
                  |           |   |        
           Resource --+       |   |        
                      |       |   |        
             Collection --+   |   |        
                          |   |   |        
         object --+       |   |   |        
                  |       |   |   |        
               Base --+   |   |   |        
                      |   |   |   |        
          CopyContainer --+   |   |        
                          |   |   |        
         object --+       |   |   |        
                  |       |   |   |        
               Base --+   |   |   |        
                      |   |   |   |        
             Navigation --+   |   |        
                          |   |   |        
         object --+       |   |   |        
                  |       |   |   |        
               Base --+   |   |   |        
                      |   |   |   |        
         object --+   |   |   |   |        
                  |   |   |   |   |        
         Persistent --+   |   |   |        
                      |   |   |   |        
             Persistent --+   |   |        
                          |   |   |        
         object --+       |   |   |        
                  |       |   |   |        
               Base --+   |   |   |        
                      |   |   |   |        
                   Tabs --+   |   |        
                          |   |   |        
            Traversable --+   |   |        
                          |   |   |        
         object --+       |   |   |        
                  |       |   |   |        
               Base --+   |   |   |        
                      |   |   |   |        
               Acquirer --+   |   |        
                          |   |   |        
              ObjectManager --+   |        
                              |   |        
             object --+       |   |        
                      |       |   |        
                   Base --+   |   |        
                          |   |   |        
           Node --+       |   |   |        
                  |       |   |   |        
            Element --+   |   |   |        
                      |   |   |   |        
  ElementWithAttributes --+   |   |        
                          |   |   |        
            PropertyManager --+   |        
                              |   |        
             object --+       |   |        
                      |       |   |        
                   Base --+   |   |        
                          |   |   |        
            RoleManager --+   |   |        
                          |   |   |        
                RoleManager --+   |        
                              |   |        
                         Folder --+        
                                  |        
             object --+           |        
                      |           |        
                   Base --+       |        
                          |       |        
                ImmutableId --+   |        
                              |   |        
                   UniqueObject --+        
                                  |        
                     MembershipTool --+    
                                      |    
                         MembershipTool --+
                                          |
                          PloneBaseTool --+
                                          |
                                         MembershipTool

Implement 'portal_membership' interface using "stock" policies.

Method Summary
	`changeMemberPortrait(self, portrait, member_id)` given a portrait we will modify the users portrait we put this method here because we do not want .personal or portrait in the catalog
	`createMemberArea(self, member_id, minimal)` Create a member area for 'member_id' or the authenticated user.
	`createMemberarea(self, member_id, minimal)` Create a member area for 'member_id' or the authenticated user.
	`deletePersonalPortrait(self, member_id)` deletes the Portait of member_id
	`getCandidateLocalRoles(self, obj)` What local roles can I assign? Override the CMFCore version so that we can see the local roles on an object, and so that local managers can assign all roles locally.
	`getHomeFolder(self, id, verifyPermission)` Return a member's home folder object, or None.
	`getMemberInfo(self, memberId)` Return 'harmless' Memberinfo of any member, such as Full name, Location, etc
	`getPersonalFolder(self, member_id)` returns the Personal Item folder for a member if no Personal Folder exists will return None
	`getPersonalPortrait(self, member_id, verifyPermission)` returns the Portait for a member_id
	`immediateLogout(self)` Log the current user out immediately.
	`listMemberIds(self)` Lists the ids of all members.
	`listMembers(self)` Gets the list of all members.
	`manage_setMemberAreaType(self, type_name, REQUEST)` ZMI method to set the home folder type by its type name.
	`searchForMembers(self, REQUEST, kw)` searchForMembers(self, REQUEST=None, kw) => normal or fast search method.
	`setLoginTimes(self)` Called by logged_in to set the login time properties even if members lack the "Set own properties" permission.
	`setMemberAreaType(self, type_name)` Sets the portal type to use for new home folders.
	`setPassword(self, password, domains)` Allows the authenticated member to set his/her own password.
	`testCurrentPassword(self, password, username)` test to see if password is current
Inherited from MembershipTool
	`getHomeUrl(self, id, verifyPermission)` Return the URL to a member's home folder, or None.
	`getMembersFolder(self)` Get the members folder object.
	`getRoster(self)` Return a list of mappings for 'listed' members.
	`manage_setMembersFolderById(self, id, REQUEST)` ZMI method to set the members folder object by its id.
	`setMembersFolderById(self, id)` Set the members folder object by its id.
Inherited from MembershipTool
	`addMember(self, id, password, roles, domains, properties)` Adds a new member to the user folder.
	`checkPermission(self, permissionName, object, subobjectName)` Checks whether the current user has the given permission on the given object or subobject.
	`credentialsChanged(self, password)` Notifies the authentication mechanism that this user has changed passwords.
	`deleteLocalRoles(self, obj, member_ids, reindex, recursive)` Delete local roles of specified members.
	`deleteMemberArea(self, member_id)` Delete member area of member specified by member_id.
	`deleteMembers(self, member_ids, delete_memberareas, delete_localroles)` Delete members specified by member_ids.
	`getAuthenticatedMember(self)` Returns the currently authenticated member object or the Anonymous User.
	`getMappedRole(self, portal_role)` returns a role name if the portal role is mapped to something else or an empty string if it is not
	`getMemberareaCreationFlag(self)` Returns the flag indicating whether the membership tool will create a member area if an authenticated user from an underlying user folder logs in first without going through the join process
	`getMemberById(self, id)` Returns the given member.
	`getPortalRoles(self)` Return all local roles defined by the portal itself, which means roles that are useful and understood by the portal object
	`isAnonymousUser(self)` Returns 1 if the user is not logged in.
	`searchMembers(self, search_param, search_term)` Search the membership
	`setLocalRoles(self, obj, member_ids, member_role, reindex)` Add local roles on an item.
	`setMemberareaCreationFlag(self)` sets the flag indicating whether the membership tool will create a member area if an authenticated user from an underlying user folder logs in first without going through the join process
	`setRoleMapping(self, portal_role, userfolder_role)` set the mapping of roles between roles understood by the portal and roles coming from outside user sources
	`wrapUser(self, u, wrap_anon)` Set up the correct acquisition wrappers for a user object.
Inherited from Folder
	`__init__(self, id)`
	`externalEditLink_(self, object, borrow_lock)` Insert the external editor link to an object if appropriate
	`manage_addZGadflyConnection(self, id, title, connection, check, REQUEST)`
	`manage_addZGadflyConnectionForm(self, REQUEST, args, *kw)`
	`SQLConnectionIDs(self)` Find SQL database connections in the current folder and above
	`ZQueryIds(self)`
Inherited from ObjectManager
	`__class_init__(self)`
	`__getitem__(self, key)`
	`_checkId(self, id, allow_dup)`
	`addDTMLDocument(self, id, title, file, REQUEST, submit)` Add a DTML Document object with the contents of file.
	`addDTMLMethod(self, id, title, file, REQUEST, submit)` Add a DTML Method object with the contents of file.
	`all_meta_types(self, interfaces)`
	`filtered_meta_types(self, user)`
	`list_imports(self)`
	`manage_addDocument(self, id, title, file, REQUEST, submit)` Add a DTML Method object with the contents of file.
	`manage_addDTMLDocument(self, id, title, file, REQUEST, submit)` Add a DTML Document object with the contents of file.
	`manage_addDTMLMethod(self, id, title, file, REQUEST, submit)` Add a DTML Method object with the contents of file.
	`manage_addFile(self, id, file, title, precondition, content_type, REQUEST)` Add a new File object.
	`manage_addFolder(self, id, title, createPublic, createUserF, REQUEST)` Add a new Folder object with id id.
	`manage_addImage(self, id, file, title, precondition, content_type, REQUEST)` Add a new Image object.
	`manage_addOrderedFolder(self, id, title, createPublic, createUserF, REQUEST)` Add a new ordered Folder object with id id.
	`manage_addSiteRoot(self, title, base, path, REQUEST, **ignored)`
	`manage_addUserFolder(self, dtself, REQUEST, **ignored)`
	`manage_afterAdd(self, item, container)`
	`manage_afterClone(self, item)`
	`manage_beforeDelete(self, item, container)`
	`manage_delObjects(self, ids, REQUEST)` Delete a subordinate object
	`manage_exportObject(self, id, download, toxml, RESPONSE, REQUEST)` Exports an object to a file and returns that file.
	`manage_FTPlist(self, REQUEST)` Directory listing for FTP.
	`manage_FTPstat(self, REQUEST)` Psuedo stat, used by FTP for directory listings.
	`manage_hasId(self, REQUEST)` check if the folder has an object with REQUEST['id']
	`manage_importObject(self, file, REQUEST, set_owner)` Import an object from a file
	`objectIds(self, spec)`
	`objectIds_d(self, t)`
	`objectItems(self, spec)`
	`objectItems_d(self, t)`
	`objectMap(self)`
	`objectMap_d(self, t)`
	`objectValues(self, spec)`
	`objectValues_d(self, t)`
	`superValues(self, t)`
	`tpValues(self)`
Inherited from CopyContainer
	`cb_dataItems(self)`
	`cb_dataValid(self)`
	`manage_clone(self, ob, id, REQUEST)`
	`manage_CopyContainerAllItems(self, REQUEST)`
	`manage_CopyContainerFirstItem(self, REQUEST)`
	`manage_copyObjects(self, ids, REQUEST, RESPONSE)` Put a reference to the objects named in ids in the clip board
	`manage_cutObjects(self, ids, REQUEST)` Put a reference to the objects named in ids in the clip board
	`manage_pasteObjects(self, cb_copy_data, REQUEST)` Paste previously copied objects into the current object.
	`manage_renameObject(self, id, new_id, REQUEST)` Rename a particular sub-object
	`manage_renameObjects(self, ids, new_ids, REQUEST)` Rename several sub-objects
	`validClipData(self)`
Inherited from Navigation
	`manage_zmi_logout(self, REQUEST, RESPONSE)` Logout current user
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 Persistent
	`__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
	`__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 Collection
	`dav__init(self, request, response)`
	`DELETE(self, REQUEST, RESPONSE)` Delete a collection resource.
	`HEAD(self, REQUEST, RESPONSE)` Retrieve resource information without a response body.
	`listDAVObjects(self)`
	`PUT(self, REQUEST, RESPONSE)` The PUT method has no inherent meaning for collection resources, though collections are not specifically forbidden to handle PUT requests.
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__simpleifhandler(self, request, response, method, col, url, refresh)`
	`dav__validate(self, object, methodname, REQUEST)`
	`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.
	`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 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 PropertyManager
	`getProperty(self, id, d)` Get the property 'id'.
	`getPropertyType(self, id)` Get the type of property 'id'.
	`hasProperty(self, id)` Return true if object has a property 'id'.
	`manage_addProperty(self, id, value, type, REQUEST)` Add a new property via the web.
	`manage_changeProperties(self, REQUEST, **kw)` Change existing object properties.
	`manage_changePropertyTypes(self, old_ids, props, REQUEST)` Replace one set of properties with another
	`manage_delProperties(self, ids, REQUEST)` Delete one or more properties specified by 'ids'.
	`manage_editProperties(self, REQUEST)` Edit object properties via the web.
	`propdict(self)`
	`propertyIds(self)` Return a list of property ids.
	`propertyItems(self)` Return a list of (id,property) tuples.
	`propertyLabel(self, id)` Return a label for the given property id
	`propertyMap(self)` Return a tuple of mappings, giving meta-data for properties.
	`propertyValues(self)` Return a list of actual property objects.
	`valid_property_id(self, id)`
Inherited from ElementWithAttributes
	`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.
	`getAttributes(self)` Returns a NamedNodeMap containing the attributes of this node (if it is an element) or None otherwise.
Inherited from Element
	`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
	`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 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 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_editedDialog(self, REQUEST, **args)`
	`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)`
Inherited from CopySource
	`cb_isCopyable(self)`
	`cb_isMoveable(self)`
	`cb_userHasCopyOrMovePermission(self)`
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 FindSupport
	`PrincipiaFind(self, obj, obj_ids, obj_metatypes, obj_searchterm, obj_expr, obj_mtime, obj_mspec, obj_permission, obj_roles, search_sub, REQUEST, result, pre)` Zope Find interface
	`ZopeFind(self, obj, obj_ids, obj_metatypes, obj_searchterm, obj_expr, obj_mtime, obj_mspec, obj_permission, obj_roles, search_sub, REQUEST, result, pre)` Zope Find interface
	`ZopeFindAndApply(self, obj, obj_ids, obj_metatypes, obj_searchterm, obj_expr, obj_mtime, obj_mspec, obj_permission, obj_roles, search_sub, REQUEST, result, pre, apply_func, apply_path)` Zope Find interface and apply
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
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__reduce_ex__(...)` helper for pickle
	`__str__(x)` x.__str__() <==> str(x)

Class Variable Summary
`tuple`	`__ac_permissions__` = `(('Manage portal', ('manage_setMemb...`
`tuple`	`__implements__` = `(<Interface Products.CMFPlone.interface...`
`NoneType`	`createMemberArea__roles__` = None
`str`	`default_portrait` = `'defaultUser.gif'`
`PermissionRole`	`getCandidateLocalRoles__roles__` = `<PermissionRole object...`
`NoneType`	`getMemberInfo__roles__` = None
`PermissionRole`	`getPortalRoles__roles__` = `<PermissionRole object at 0xb4...`
`PermissionRole`	`immediateLogout__roles__` = `<PermissionRole object at 0xb...`
`DTMLFile`	`manage_mapRoles` = `<App.special_dtml.DTMLFile object at 0...`