Info

 Products.RPMDistro.CookieAuthHandler  

Up one level

Classes

  class RPMDistroCookieAuthHelper ( 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

  Add User Folders

Implements

ILoginPasswordHostExtractionPlugin IChallengePlugin ICredentialsUpdatePlugin ICredentialsResetPlugin ICookieAuthHelper IFolder IObjectManager IContainer ICopyContainer INavigation IAcquirer IPersistentExtra IPersistent IDAVCollection IDAVResource IWriteLock ITraversable IPropertyManager IRoleManager IPermissionMappingSupport IItem ICopySource IOwned IUndoSupport IFindSupport ISimpleItem IHideFromBreadcrumbs WriteLockInterface

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.

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.

HEAD(self, REQUEST, RESPONSE)

Retrieve resource information without a response body.

LOCK(self, REQUEST, RESPONSE)

Lock a resource

MKCOL(self, REQUEST, RESPONSE)

Create a new collection resource. If called on an existing resource, MKCOL must fail with 405 (Method Not Allowed).

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.

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)

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

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

SQLConnectionIDs(self)

Find SQL database connections in the current folder and above This function return a list of ids.

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.

UNLOCK(self, REQUEST, RESPONSE)

Remove an existing lock on a resource.

ZQueryIds(self)

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

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

checkValidId(self, id, allow_dup=0)

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.

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.

ac_inherited_permissions(self, all=0)

access_debug_info(self)

Return debug info.

acquiredRolesAreUsedBy(self, permission)

Used by management screen.

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.

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.

all_meta_types(self, interfaces=None)

bobobase_modification_time(self)

cb_dataItems(self)

cb_dataValid(self)

cb_isCopyable(self)

cb_isMoveable(self)

cb_userHasCopyOrMovePermission(self)

challenge(self, request, response, **kw)

Challenge the user for credentials.

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.

class_manage_path(self)

dav__init(self, request, response)

dav__simpleifhandler(self, request, response, method='PUT', col=0, url=None, refresh=0)

dav__validate(self, object, methodname, REQUEST)

EditLink(self, object, borrow_lock=0, skip_data=0)

Insert the external editor link to an object if appropriate

extractCredentials(self, request)

Extract credentials from cookie or 'request'.

filtered_manage_options(self, REQUEST=None)

filtered_meta_types(self, user=None)

get(self, key, default=None)

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.

getChildNodes(self)

Returns a NodeList that contains all children of this node. If there are no children, this is a empty NodeList

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. Parameter: tagname The name of the tag to match (* = all tags). Return Value: A new NodeList object containing all the matched Elements.

getFirstChild(self)

The first child of this node. If there is no such node this returns None

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.

getLastChild(self)

The last child of this node. If there is no such node this returns None.

getLoginURL(self)

Where to send people for logging in

getNextSibling(self)

The node immediately preceding this node. If there is no such node, this returns None.

getNodeName(self)

The name of this node, depending on its type

getNodeType(self)

A code representing the type of the node.

getNodeValue(self)

The value of this node, depending on its type

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.

getOwnerDocument(self)

The Document object associated with this node. When this is a document this is None

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.

getParentNode(self)

The parent of this node. All nodes except Document DocumentFragment and Attr may have a parent

getPhysicalPath(self)

Get the physical path of the object. Returns a path (an immutable sequence of strings) that can be used to access this object again later, for example in a copy/paste operation. getPhysicalRoot() and getPhysicalPath() are designed to operate together.

getPreviousSibling(self)

The node immediately preceding this node. If there is no such node, this returns None.

getProperty(self, id, d=None)

Get the property 'id'. Returns the optional second argument or None if no such property is found.

getPropertyType(self, id)

Get the type of property 'id'. Returns None if no such property exists.

getSiteManager(self)

getTagName(self)

The name of the element

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.

get_local_roles(self)

get_local_roles_for_userid(self, userid)

get_request_var_or_attr(self, name, default)

get_valid_userids(self)

hasChildNodes(self)

Returns true if the node has any children, false if it doesn't.

hasObject(self, id)

Indicate whether the folder has an item by ID. This doesn't try to be more intelligent than _getOb, and doesn't consult _objects (for performance reasons). The common use case is to check that an object does *not* exist.

hasProperty(self, id)

Return true if object has a property 'id'.

has_local_roles(self)

http__etag(self, readonly=0)

http__parseMatchList(self, REQUEST, header='if-match')

http__processMatchHeaders(self, REQUEST=None)

http__refreshEtag(self)

inAgents(self, request)

returns whether or not the request is 'of interest' to us

items(self)

keys(self)

listDAVObjects(self)

listInterfaces(self)

For ZMI update of interfaces.

list_imports(self)

locked_in_version(self)

Was the object modified in any version?

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.

manage_CopyContainerAllItems(self, REQUEST)

manage_CopyContainerFirstItem(self, REQUEST)

manage_DAVget(self)

Gets the document source

manage_FTPlist(self, REQUEST)

Directory listing for FTP.

manage_FTPstat(self, REQUEST)

Psuedo stat, used by FTP for directory listings.

manage_access(self, REQUEST, **kw)

Return an interface for making permissions settings.

manage_acquiredPermissions(self, permissions=[], REQUEST=None)

This method is called TTW, so it needs a docstring

manage_activateInterfaces(self, interfaces, RESPONSE=None)

For ZMI update of active interfaces.

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.

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.

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.

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'

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.

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'.

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.

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.

manage_addSiteRoot(self, title='', base='', path='', REQUEST=None, **ignored)

manage_addUserFolder(self, dtself=None, REQUEST=None, **ignored)

addConnection(self, id, title, connection_string, check=None, REQUEST=None)

Add a DB connection to a folder

manage_afterAdd(self, item, container)

we do not wish to add a login_form, we want to default to Plone's ...

manage_afterClone(self, item)

manage_beforeDelete(self, item, container)

manage_changePermissions(self, REQUEST)

This method is called TTW, so it needs a docstring

manage_changeProperties(self, REQUEST=None, **kw)

Change existing object properties. Change object properties by passing either a mapping object of name:value pairs {'foo':6} or passing name=value parameters

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.

manage_clone(self, ob, id, REQUEST=None)

Clone an object, creating a new object with the given id.

manage_copyObjects(self, ids=None, REQUEST=None, RESPONSE=None)

Put a reference to the objects named in ids in the clip board

manage_cutObjects(self, ids=None, REQUEST=None)

Put a reference to the objects named in ids in the clip board

manage_defined_roles(self, submit=None, REQUEST=None)

Called by management screen.

manage_delObjects(self, ids=[], REQUEST=None)

Delete a subordinate object The objects specified in 'ids' get deleted.

manage_delProperties(self, ids=None, REQUEST=None)

Delete one or more properties specified by 'ids'.

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.

manage_editRoles(self, REQUEST, acl_type='A', acl_roles=[])

manage_editedDialog(self, REQUEST, **args)

manage_exportObject(self, id='', download=None, toxml=None, RESPONSE=None, REQUEST=None)

Exports an object to a file and returns that file.

manage_fixupOwnershipAfterAdd(self)

manage_form_title(self, *args, **kw)

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_hasId(self, REQUEST)

check if the folder has an object with REQUEST['id']

manage_importObject(self, file, REQUEST=None, set_owner=1)

Import an object from a file

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.

manage_permission(self, permission_to_manage, roles=[], acquire=0, REQUEST=None)

This method is called TTW, so it needs a docstring

manage_renameObject(self, id, new_id, REQUEST=None)

Rename a particular sub-object.

manage_renameObjects(self, ids=[], new_ids=[], REQUEST=None)

Rename several sub-objects

manage_role(self, role_to_manage, permissions=[], REQUEST=None)

This method is called TTW, so it needs a docstring

manage_undo_transactions(self, transaction_info=(), REQUEST=None)

manage_workspace(self, REQUEST)

Dispatch to first interface in manage_options

manage_zmi_logout(self, REQUEST, RESPONSE)

Logout current user

modified_in_version(self)

Was the object modified in this version?

objectIds(self, spec=None)

objectIds_d(self, t=None)

objectItems(self, spec=None)

objectItems_d(self, t=None)

objectMap(self)

objectMap_d(self, t=None)

objectValues(self, spec=None)

objectValues_d(self, t=None)

owner_info(self)

Get ownership info for display

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.

permissionsOfRole(self, role)

Used by management screen.

possible_permissions(self)

propdict(self)

propertyDescription(self, id)

Return a description for the given property id

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. Return copies of the real definitions for security.

propertyValues(self)

Return a list of actual property objects.

raise_standardErrorMessage(self, client=None, REQUEST={}, error_type=None, error_value=None, tb=None, error_tb=None, error_message='', tagSearch=, error_log_url='')

resetCredentials(self, request, response)

Raise unauthorized to tell browser to clear credentials.

restrictedTraverse(self, path, default=