You are here: Home / API Documentation / Products.RPMManager.CookieAuthHandler

 Products.RPMManager.CookieAuthHandler  

Up one level
Zpydoc Products RPMManager CookieAuthHandler
Classes
Class  class RPMManagerCookieAuthHelper ( ExtendedCookieAuthHelper )
Multi-plugin which adds ability to throw a 401 instead of redirecting based upon a configurable set of user agents, mostly command-line clients
Plus Lock  Add User Folders
Implements ILoginPasswordHostExtractionPlugin IChallengePlugin ICredentialsUpdatePlugin ICredentialsResetPlugin ICookieAuthHelper IFolder IObjectManager ICopyContainer INavigation IAcquirer IPersistentExtra IPersistent IDAVCollection IDAVResource IWriteLock EtagBaseInterface ITraversable IPropertyManager IRoleManager IPermissionMappingSupport IItem ICopySource IOwned IUndoSupport IFindSupport ISimpleItem IHideFromBreadcrumbs
Method 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. Though we may later try to make a copy appear seamless across namespaces (e.g. from Zope to Apache), COPY is currently only supported within the Zope namespace.
Method DELETE(self, REQUEST, RESPONSE)
Delete a collection resource. For collection resources, DELETE may return either 200 (OK) or 204 (No Content) to indicate total success, or may return 207 (Multistatus) to indicate partial success. Note that in Zope a DELETE currently never returns 207.
Method HEAD(self, REQUEST, RESPONSE)
Retrieve resource information without a response body.
Method LOCK(self, REQUEST, RESPONSE)
Lock a resource
Method MKCOL(self, REQUEST, RESPONSE)
Create a new collection resource. If called on an existing resource, MKCOL must fail with 405 (Method Not Allowed).
Method MOVE(self, REQUEST, RESPONSE)
Move a resource to a new location. Though we may later try to make a move appear seamless across namespaces (e.g. from Zope to Apache), MOVE is currently only supported within the Zope namespace.
Method OPTIONS(self, REQUEST, RESPONSE)
Retrieve communication options.
Method PROPFIND(self, REQUEST, RESPONSE)
Retrieve properties defined on the resource.
Method PROPPATCH(self, REQUEST, RESPONSE)
Set and/or remove properties defined on the resource.
Method PUT(self, REQUEST, RESPONSE)
The PUT method has no inherent meaning for collection resources, though collections are not specifically forbidden to handle PUT requests. The default response to a PUT request for collections is 405 (Method Not Allowed).
Method ZopeFind(self, obj, obj_ids=None, obj_metatypes=None, obj_searchterm=None, obj_expr=None, obj_mtime=None, obj_mspec=None, obj_permission=None, obj_roles=None, search_sub=0, REQUEST=None, result=None, pre='')
Zope Find interface
Method SQLConnectionIDs(container)
Find SQL database connections in the current folder and above This function returns a list of two-element tuples. The second element is the connection ID, the first element either its title, or if the title is empty, its ID.
Method TRACE(self, REQUEST, RESPONSE)
Return the HTTP message received back to the client as the entity-body of a 200 (OK) response. This will often usually be intercepted by the web server in use. If not, the TRACE request will fail with a 405 (Method Not Allowed), since it is not often possible to reproduce the HTTP request verbatim from within the Zope environment.
Method UNLOCK(self, REQUEST, RESPONSE)
Remove an existing lock on a resource.
Method ZQueryIds(self)
Method ZopeFind(self, obj, obj_ids=None, obj_metatypes=None, obj_searchterm=None, obj_expr=None, obj_mtime=None, obj_mspec=None, obj_permission=None, obj_roles=None, search_sub=0, REQUEST=None, result=None, pre='')
Zope Find interface
Method ZopeFindAndApply(self, obj, obj_ids=None, obj_metatypes=None, obj_searchterm=None, obj_expr=None, obj_mtime=None, obj_mspec=None, obj_permission=None, obj_roles=None, search_sub=0, REQUEST=None, result=None, pre='', apply_func=None, apply_path='')
Zope Find interface and apply
Method manage_FTPlist(self, REQUEST)
Directory listing for FTP.
Method checkValidId(self, id, allow_dup=0)
Method wl_lockmapping(self, killinvalids=0, create=0)
if 'killinvalids' is 1, locks who are no longer valid will be deleted
Method absolute_url(self, relative=0)
Return the absolute URL of the object. This a canonical URL based on the object's physical containment path. It is affected by the virtual host configuration, if any, and can be used by external agents, such as a browser, to address the object. If the relative argument is provided, with a true value, then the value of virtual_url_path() is returned. Some Products incorrectly use '/'+absolute_url(1) as an absolute-path reference. This breaks in certain virtual hosting situations, and should be changed to use absolute_url_path() instead.
Method absolute_url_path(self)
Return the path portion of the absolute URL of the object. This includes the leading slash, and can be used as an 'absolute-path reference' as defined in RFC 2396.
Method ac_inherited_permissions(self, all=0)
Method access_debug_info(self)
Return debug info.
Method acquiredRolesAreUsedBy(self, permission)
Method addDTMLDocument(self, id, title='', file='', REQUEST=None, submit=None)
Add a DTML Document object with the contents of file. If 'file' is empty, default document text is used.
Method addDTMLMethod(self, id, title='', file='', REQUEST=None, submit=None)
Add a DTML Method object with the contents of file. If 'file' is empty, default document text is used.
Method all_meta_types(self, interfaces=None)
Method applyTransform(self, value)
Transform for login name. Possibly transform the login, for example by making it lower case. Normally this is done in PAS itself, but in some cases a method in a plugin may need to do it itself, when there is no method in PAS that calls that method.
Method bobobase_modification_time(self)
Method cb_dataItems(self)
Method cb_dataValid(self)
Method cb_isCopyable(self)
Method cb_isMoveable(self)
Method cb_userHasCopyOrMovePermission(self)
Method challenge(self, request, response, **kw)
Challenge the user for credentials.
Method changeOwnership(self, user, recursive=0)
Change the ownership to the given user. If 'recursive' is true then also take ownership of all sub-objects, otherwise sub-objects retain their ownership information.
Method dav__init(self, request, response)
Method dav__simpleifhandler(self, request, response, method='PUT', col=0, url=None, refresh=0)
Method dav__validate(self, object, methodname, REQUEST)
Method EditLink(self, object, borrow_lock=0, skip_data=0)
Insert the external editor link to an object if appropriate
Method extractCredentials(self, request)
Extract credentials from cookie or 'request'.
Method filtered_manage_options(self, REQUEST=None)
Method filtered_meta_types(self, user=None)
Method get(self, key, default=None)
Method getAttribute(self, name)
Method getAttributeNode(self, name)
Method getAttributes(self)
Method getChildNodes(self)
Method getElementsByTagName(self, tagname)
Method getFirstChild(self)
Method getId(self)
Return the id of the object as a string. This method should be used in preference to accessing an id attribute of an object directly. The getId method is public.
Method getLastChild(self)
Method getLoginURL(self)
Where to send people for logging in
Method getNextSibling(self)
Method getNodeName(self)
Method getNodeType(self)
Method getNodeValue(self)
Method getOwner(self, info=0, aq_get=, UnownableOwner=[], getSecurityManager=)
Get the owner If a true argument is provided, then only the owner path and id are returned. Otherwise, the owner object is returned.
Method getOwnerDocument(self)
Method getOwnerTuple(self)
Return a tuple, (userdb_path, user_id) for the owner. o Ownership can be acquired, but only from the containment path. o If unowned, return None.
Method getParentNode(self)
Method getPhysicalPath(self)
Method getPreviousSibling(self)
Method getProperty(self, id, d=None)
Method getPropertyType(self, id)
Method getSiteManager(self)
Method getTagName(self)
Method getWrappedOwner(self)
Get the owner, modestly wrapped in the user folder. o If the object is not owned, return None. o If the owner's user database doesn't exist, return Nobody. o If the owner ID does not exist in the user database, return Nobody.
Method get_local_roles(self)
Method get_local_roles_for_userid(self, userid)
Method get_valid_userids(self)
Method hasChildNodes(self)
Method hasObject(self, id)
Method hasProperty(self, id)
Method has_local_roles(self)
Method http__etag(self, readonly=0)
Method http__parseMatchList(self, REQUEST, header='if-match')
Method http__processMatchHeaders(self, REQUEST=None)
Method http__refreshEtag(self)
Method inAgents(self, request)
returns whether or not the request is 'of interest' to us
Method items(self)
Method keys(self)
Method listDAVObjects(self)
Method listInterfaces(self)
For ZMI update of interfaces.
Method list_imports(self)
Method login(self)
Set a cookie and redirect to the url that we tried to authenticate against originally. Override standard login method to avoid calling 'return response.redirect(came_from)' as there is additional processing to ignore known bad come_from templates at login_next.cpy script.
Method manage_CopyContainerAllItems(self, REQUEST)
Method manage_CopyContainerFirstItem(self, REQUEST)
Method manage_DAVget(self)
Gets the document source
Method manage_FTPlist(self, REQUEST)
Returns a directory listing consisting of a tuple of (id,stat) tuples, marshaled to a string. Note, the listing it should include '..' if there is a Folder above the current one. In the case of non-foldoid objects it should return a single tuple (id,stat) representing itself.
Method manage_FTPstat(self, REQUEST)
Psuedo stat, used by FTP for directory listings.
Method manage_access(self, REQUEST, **kw)
Return an interface for making permissions settings.
Method manage_acquiredPermissions(self, permissions=[], REQUEST=[])
Change the permissions that acquire.
Method manage_activateInterfaces(self, interfaces, RESPONSE=None)
For ZMI update of active interfaces.
Method addDTMLDocument(self, id, title='', file='', REQUEST=None, submit=None)
Add a DTML Document object with the contents of file. If 'file' is empty, default document text is used.
Method addDTMLMethod(self, id, title='', file='', REQUEST=None, submit=None)
Add a DTML Method object with the contents of file. If 'file' is empty, default document text is used.
Method addDTMLMethod(self, id, title='', file='', REQUEST=None, submit=None)
Add a DTML Method object with the contents of file. If 'file' is empty, default document text is used.
Method manage_addFile(self, id, file='', title='', precondition='', content_type='', REQUEST=None)
Add a new File object. Creates a new File object 'id' with the contents of 'file'
Method manage_addFolder(self, id, title='', createPublic=0, createUserF=0, REQUEST=None)
Add a new Folder object with id *id*. If the 'createPublic' and 'createUserF' parameters are set to any true value, an 'index_html' and a 'UserFolder' objects are created respectively in the new folder.
Method manage_addImage(self, id, file, title='', precondition='', content_type='', REQUEST=None)
Add a new Image object. Creates a new Image object 'id' with the contents of 'file'.
Method manage_addLocalRoles(self, userid, roles, REQUEST=[])
Set local roles for a user.
Method manage_addOrderedFolder(self, id, title='', createPublic=0, createUserF=0, REQUEST=None)
Add a new ordered Folder object with id *id*. If the 'createPublic' and 'createUserF' parameters are set to any true value, an 'index_html' and a 'UserFolder' objects are created respectively in the new folder.
Method manage_addProperty(self, id, value, type, REQUEST=None)
Add a new property via the web. Sets a new property with the given id, type, and value.
Method manage_addSiteRoot(self, title='', base='', path='', REQUEST=None, **ignored)
Add a SiteRoot to a container.
Method manage_addUserFolder(self, dtself=None, REQUEST=None, **ignored)
Method manage_afterAdd(self, item, container)
we do not wish to add a login_form, we want to default to Plone's ...
Method manage_afterClone(self, item)
Method manage_beforeDelete(self, item, container)
Method manage_changeOwnershipType(self, explicit=[], RESPONSE=[], REQUEST=[])
Change the type (implicit or explicit) of ownership.
Method manage_changePermissions(self, REQUEST)
Change all permissions settings, called by management screen.
Method manage_changeProperties(self, REQUEST=None, **kw)
Change existing object properties. Change object properties by passing either a REQUEST object or name=value parameters
Method manage_changePropertyTypes(self, old_ids, props, REQUEST=None)
Replace one set of properties with another Delete all properties that have ids in old_ids, then add a property for each item in props. Each item has a new_id, new_value, and new_type. The type of new_value should match new_type.
Method manage_clone(self, ob, id, REQUEST=None)
Clone an object, creating a new object with the given id.
Method manage_copyObjects(self, ids=None, REQUEST=None, RESPONSE=None)
Put a reference to the objects named in ids in the clip board
Method manage_cutObjects(self, ids=None, REQUEST=None)
Put a reference to the objects named in ids in the clip board
Method manage_defined_roles(self, submit=None, REQUEST=None)
Called by management screen.
Method manage_delLocalRoles(self, userids, REQUEST=[])
Remove all local roles for a user.
Method manage_delObjects(self, ids=[], REQUEST=None)
Delete a subordinate object The objects specified in 'ids' get deleted.
Method manage_delProperties(self, ids=None, REQUEST=None)
Delete one or more properties specified by 'ids'.
Method manage_editProperties(self, REQUEST)
Edit object properties via the web. The purpose of this method is to change all property values, even those not listed in REQUEST; otherwise checkboxes that get turned off will be ignored. Use manage_changeProperties() instead for most situations.
Method manage_editRoles(self, REQUEST, acl_type='A', acl_roles=[])
Method manage_editedDialog(self, REQUEST, **args)
Method manage_exportObject(self, id='', download=None, toxml=None, RESPONSE=None, REQUEST=None)
Exports an object to a file and returns that file.
Method manage_fixupOwnershipAfterAdd(self)
Method manage_form_title(self, *args, **kw)
Method 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.
Method manage_getUserRolesAndPermissions(self, user_id)
Used for permission/role reporting for a given user_id. Returns a dict mapping 'user_defined_in' -> path where the user account is defined 'roles' -> global roles, 'roles_in_context' -> roles in context of the current object, 'allowed_permissions' -> permissions allowed for the user, 'disallowed_permissions' -> all other permissions
Method manage_hasId(self, REQUEST)
check if the folder has an object with REQUEST['id']
Method manage_importObject(self, file, REQUEST=None, set_owner=1)
Import an object from a file
Method manage_pasteObjects(self, cb_copy_data=None, REQUEST=None)
Paste previously copied objects into the current object. If calling manage_pasteObjects from python code, pass the result of a previous call to manage_cutObjects or manage_copyObjects as the first argument. Also sends IObjectCopiedEvent and IObjectClonedEvent or IObjectWillBeMovedEvent and IObjectMovedEvent. If `REQUEST` is None it returns a list of dicts {'id': orig_id, 'new_id': new_id} otherwise it renders a HTML page.
Method manage_permission(self, permission_to_manage, roles=[], acquire=[], REQUEST=[])
Change the settings for the given permission. If optional arg acquire is true, then the roles for the permission are acquired, in addition to the ones specified, otherwise the permissions are restricted to only the designated roles.
Method manage_renameObject(self, id, new_id, REQUEST=None)
Rename a particular sub-object.
Method manage_renameObjects(self, ids=[], new_ids=[], REQUEST=None)
Rename several sub-objects
Method manage_role(self, role_to_manage, permissions=[], REQUEST=[])
Change the permissions given to the given role.
Method manage_setLocalRoles(self, userid, roles, REQUEST=[])
Set local roles for a user.
Method manage_setPermissionMapping(self, permission_names=[], class_permissions=[], REQUEST=[])
Change the permission mapping
Method manage_takeOwnership(self, REQUEST, RESPONSE, recursive=[])
Take ownership (responsibility) for an object. If 'recursive' is true, then also take ownership of all sub-objects.
Method manage_undo_transactions(self, transaction_info=(), REQUEST=None)
Method manage_workspace(self, REQUEST)
Dispatch to first interface in manage_options
Method manage_zmi_logout(self, REQUEST, RESPONSE)
Logout current user
Method objectIds(self, spec=None)
Returns a list of subobject ids of the current object. If 'spec' is specified, returns objects whose meta_type matches 'spec'.
Method objectIds_d(self, t=None)
Method objectItems(self, spec=None)
Returns a list of (id, subobject) tuples of the current object. If 'spec' is specified, returns only objects whose meta_type match 'spec'
Method objectItems_d(self, t=None)
Method objectMap(self)
Return a tuple of mappings containing subobject meta-data
Method objectMap_d(self, t=None)
Method objectValues(self, spec=None)
Returns a list of actual subobjects of the current object. If 'spec' is specified, returns only objects whose meta_type match 'spec'.
Method objectValues_d(self, t=None)
Method owner_info(self)
Get ownership info for display
Method permission_settings(self, permission=None)
Return user-role permission settings. If 'permission' is passed to the method then only the settings for 'permission' is returned.
Method permissionsOfRole(self, role)
Returns a role to permission mapping.
Method possible_permissions(self)
Method propdict(self)
Method propertyDescription(self, id)
Method propertyIds(self)
Method propertyItems(self)
Method propertyLabel(self, id)
Method propertyMap(self)
Method propertyValues(self)
Method raise_standardErrorMessage(self, client=None, REQUEST={}, error_type=None, error_value=None, tb=None, error_tb=None, error_message='', tagSearch=, error_log_url='')
Method resetCredentials(self, request, response)
Raise unauthorized to tell browser to clear credentials.
Method restrictedTraverse(self, path, default=)
Method rolesOfPermission(self, permission)
Returns a permission to role mapping.
Method setSiteManager(self, components)
Method superValues(self, t)
Method tabs_path_default(self, REQUEST, unquote=)
Method tabs_path_info(self, script, path, quote=)
Method testImplements(self, interface)
Can't access Interface.providedBy() directly in ZPT.
Method this(self)
Method title_and_id(self)
Return the title if it is not blank and the id otherwise. If the title is not blank, then the id is included in parens.
Method title_or_id(self)
Return the title if it is not blank and the id otherwise.
Method tpURL(self)
Method tpValues(self)
Method unauthorized(self)
Method undoable_transactions(self, first_transaction=None, last_transaction=None, PrincipiaUndoBatchSize=None)
Method unrestrictedTraverse(self, path, default=, restricted=False)
Lookup an object by path. path -- The path to the object. May be a sequence of strings or a slash separated string. If the path begins with an empty path element (i.e., an empty string or a slash) then the lookup is performed from the application root. Otherwise, the lookup is relative to self. Two dots (..) as a path element indicates an upward traversal to the acquisition parent. default -- If provided, this is the value returned if the path cannot be traversed for any reason (i.e., no object exists at that path or the object is inaccessible). restricted -- If false (default) then no security checking is performed. If true, then all of the objects along the path are validated with the security machinery. Usually invoked using restrictedTraverse().
Method updateCredentials(self, request, response, login, new_password)
Override standard updateCredentials method
Method userCanTakeOwnership(self)
Method userdefined_roles(self)
Return list of user-defined roles.
Method users_with_local_role(self, role)
Method cb_dataValid(self)
Method valid_roles(self)
Return list of valid roles.
Method valid_property_id(self, id)
Method valid_roles(self)
Return list of valid roles.
Method validate_roles(self, roles)
Return true if all given roles are valid.
Method values(self)
Method virtual_url_path(self)
Return a URL for the object, relative to the site root. If a virtual host is configured, the URL is a path relative to the virtual host's root object. Otherwise, it is the physical path. In either case, the URL does not begin with a slash.
Method wl_clearLocks(self)
Method wl_delLock(self, locktoken)
Method wl_getLock(self, locktoken)
Method wl_hasLock(self, token, killinvalids=0)
Method wl_isLocked(self)
Method wl_lockItems(self, killinvalids=0)
Method wl_lockTokens(self, killinvalids=0)
Method wl_lockValues(self, killinvalids=0)
Method wl_lockmapping(self, killinvalids=0, create=0)
if 'killinvalids' is 1, locks who are no longer valid will be deleted **Monkey patched by** 'plone.protect.monkey.wl_lockmapping'
Method wl_setLock(self, locktoken, lock)
Functions
Function InitializeClass (self)
Function classImplements (class_, *interfaces)
Function manage_addRPMManagerCookieAuthHelper (self, id, title='', RESPONSE=None, **kw)
Create an instance of a extended cookie auth helper.

Document Actions