U Vc@sdZddlmZmZmZddlmZmZmZm Z m Z ddl m Z ddl Z ddlZddlZddlZdZeeZddd d d d d dgZddgZGdddeZGdddeZGdddeZGdddeZdS)a Abstract base class for DAV resource providers. This module serves these purposes: 1. Documentation of the DAVProvider interface 2. Common base class for all DAV providers 3. Default implementation for most functionality that a resource provider must deliver. If no default implementation can be provided, then all write actions generate FORBIDDEN errors. Read requests generate NOT_IMPLEMENTED errors. **_DAVResource, DAVCollection, DAVNonCollection** Represents an existing (i.e. mapped) WebDAV resource or collection. A _DAVResource object is created by a call to the DAVProvider. The resource may then be used to query different attributes like ``res.name``, ``res.is_collection``, ``res.get_content_length()``, and ``res.support_etag()``. It also implements operations, that require an *existing* resource, like: ``get_preferred_path()``, ``create_collection()``, or ``get_property_value()``. Usage:: res = provider.get_resource_inst(path, environ) if res is not None: print(res.getName()) **DAVProvider** A DAV provider represents a shared WebDAV system. There is only one provider instance per share, which is created during server start-up. After that, the dispatcher (``request_resolver.RequestResolver``) parses the request URL and adds it to the WSGI environment, so it can be accessed like this:: provider = environ["wsgidav.provider"] The main purpose of the provider is to create _DAVResource objects for URLs:: res = provider.get_resource_inst(path, environ) **Supporting Objects** The DAVProvider takes two supporting objects: propertyManager An object that provides storage for dead properties assigned for webDAV resources. PropertyManagers must provide the methods as described in ``wsgidav.interfaces.propertymanagerinterface`` See prop_man.property_manager.PropertyManager for a sample implementation using shelve. lockManager An object that provides storage for locks made on webDAV resources. LockManagers must provide the methods as described in ``wsgidav.interfaces.lockmanagerinterface`` See lock_manager.LockManager for a sample implementation using shelve. See :doc:`reference_guide` for more information about the WsgiDAV architecture. )compatutil xml_tools) as_DAVErrorDAVErrorHTTP_FORBIDDENHTTP_NOT_FOUND#PRECONDITION_CODE_ProtectedProperty)etreeNreStructuredText{DAV:}creationdate{DAV:}displayname{DAV:}getcontenttype{DAV:}resourcetype{DAV:}getlastmodified{DAV:}getcontentlength {DAV:}getetagz{DAV:}getcontentlanguage{DAV:}lockdiscovery{DAV:}supportedlockc@sxeZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ ddZ ddZddZddZddZddZd d!Zd"d#Zd$d%Zd&d'Zd(d)Zd^d-d.Zd/d0Zd_d2d3Zd4d5Zd`d6d7Zd8d9Zd:d;Zdd?Z d@dAZ!dBdCZ"dDdEZ#dadFdGZ$dHdIZ%dJdKZ&dLdMZ'dNdOZ(dPdQZ)dRdSZ*dTdUZ+dVdWZ,dXdYZ-dZd[Z.d\d]Z/d1S)b _DAVResourcea Represents a single existing DAV resource instance. A resource may be a collection (aka 'folder') or a non-collection (aka 'file'). _DAVResource is the common base class for the specialized classes:: _DAVResource +- DAVCollection \- DAVNonCollection Instances of this class are created through the DAVProvider:: res = provider.get_resource_inst(path, environ) if res and res.is_collection(): print(res.get_display_name()) In the example above, res will be ``None``, if the path cannot be mapped to an existing resource. The following attributes and methods are considered 'cheap':: res.path res.provider res.name res.is_collection res.environ Querying other attributes is considered 'expensive' and may be delayed until the first access. get_content_length() get_content_type() get_creation_date() get_display_name() get_etag() get_last_modified() support_ranges() support_etag() support_modified() support_content_length() These functions return ``None``, if the property is not available, or not supported. See also DAVProvider.get_resource_inst(). cCsRt|st|dks$|ds$t|d|_||_||_||_t |j|_ dS)N/zwsgidav.provider) r is_nativeAssertionError startswithproviderpath is_collectionenvironr get_uri_namename)selfrrrr"$/opt/wsgidav/wsgidav/dav_provider.py__init__s z_DAVResource.__init__cCsd|jj|jS)Nz{}({!r}))format __class____name__rr!r"r"r#__repr__sz_DAVResource.__repr__cCs|jr dStdS)a9Contains the Content-Length header returned by a GET without accept headers. The getcontentlength property MUST be defined on any DAV compliant resource that returns the Content-Length header in response to a GET. This method MUST be implemented by non-collections only. NrNotImplementedErrorr(r"r"r#get_content_lengths z_DAVResource.get_content_lengthcCs|jr dStdS)aContains the Content-Type header returned by a GET without accept headers. This getcontenttype property MUST be defined on any DAV compliant resource that returns the Content-Type header in response to a GET. See http://www.webdav.org/specs/rfc4918.html#PROPERTY_getcontenttype This method MUST be implemented by non-collections only. Nr*r(r"r"r#get_content_types z_DAVResource.get_content_typecCsdS)afRecords the time and date the resource was created. The creationdate property should be defined on all DAV compliant resources. If present, it contains a timestamp of the moment when the resource was created (i.e., the moment it had non-null state). This method SHOULD be implemented, especially by non-collections. Nr"r(r"r"r#get_creation_dates z_DAVResource.get_creation_datecCs|js tdS)aReturn a list of dictionaries with information for directory rendering. This default implementation return None, so the dir browser will traverse all members. This method COULD be implemented for collection resources. N)rrr(r"r"r#get_directory_infos z_DAVResource.get_directory_infocCs|jS)aProvides a name for the resource that is suitable for presentation to a user. The displayname property should be defined on all DAV compliant resources. If present, the property contains a description of the resource that is suitable for presentation to a user. This default implementation returns `name`, which is the last path segment. )r r(r"r"r#get_display_names z_DAVResource.get_display_namecCsR|jrddiStj|jkrJ|jtjd}t|dkrJdd|iSddiS)zReturn additional info dictionary for displaying (optional). This information is not part of the DAV specification, but meant for use by the dir browser middleware. This default implementation returns ``{'type': '...'}`` typeZ Directoryz{}-FileZFile)rosextsepr splitupperlenr%)r!extr"r"r#get_display_infos  z_DAVResource.get_display_infocCsdS)z See http://www.webdav.org/specs/rfc4918.html#PROPERTY_getetag This method SHOULD be implemented, especially by non-collections. Nr"r(r"r"r#get_etag sz_DAVResource.get_etagcCsdS)aContains the Last-Modified header returned by a GET method without accept headers. Return None, if this live property is not supported. Note that the last-modified date on a resource may reflect changes in any part of the state of the resource, not necessarily just a change to the response to the GET method. For example, a change in a property may cause the last-modified date to change. The getlastmodified property MUST be defined on any DAV compliant resource that returns the Last-Modified header in response to a GET. This method SHOULD be implemented, especially by non-collections. Nr"r(r"r"r#get_last_modifiedsz_DAVResource.get_last_modifiedcCstdS)z@Set last modified time for destPath to timeStamp on epoch-formatNr+)r! dest_path time_stampdry_runr"r"r#set_last_modified#sz_DAVResource.set_last_modifiedcCstdS)zReturn True, if this non-resource supports Range on GET requests. This method MUST be implemented by non-collections only. Nr=r(r"r"r#support_ranges'sz_DAVResource.support_rangescCs |dk S)zReturn True, if this resource supports Content-Length. This default implementation checks `self.get_content_length() is None`. N)r,r(r"r"r#support_content_length.sz#_DAVResource.support_content_lengthcCs |dk S)z}Return True, if this resource supports ETags. This default implementation checks `self.get_etag() is None`. N)r;r(r"r"r# support_etag5sz_DAVResource.support_etagcCs |dk S)zReturn True, if this resource supports last modified dates. This default implementation checks `self.get_last_modified() is None`. N)r<r(r"r"r#support_modified<sz_DAVResource.support_modifiedcCs0|jdkrdS|jr*|jds*|jdS|jS)aReturn preferred mapping for a resource mapping. Different URLs may map to the same resource, e.g.: '/a/b' == '/A/b' == '/a/b/' get_preferred_path() returns the same value for all these variants, e.g.: '/a/b/' (assuming resource names considered case insensitive) @param path: a UTF-8 encoded, unquoted byte string. @return: a UTF-8 encoded, unquoted byte string. rrr)rrendswithr(r"r"r#get_preferred_pathCs  z_DAVResource.get_preferred_pathcCst|jj|S)aReturn the quoted, absolute, unique URL of a resource, relative to appRoot. Byte string, UTF-8 encoded, quoted. Starts with a '/'. Collections also have a trailing '/'. This is basically the same as get_preferred_path, but deals with 'virtual locations' as well. e.g. '/a/b' == '/A/b' == '/bykey/123' == '/byguid/abc532' get_ref_url() returns the same value for all these URLs, so it can be used as a key for locking and persistence storage. DAV providers that allow virtual-mappings must override this method. See also comments in DEVELOPERS.txt glossary. )rquoter share_pathrHr(r"r"r# get_ref_urlZsz_DAVResource.get_ref_urlcCs&d}tj|jj|jj||dS)a*Convert path to a URL that can be passed to XML responses. Byte string, UTF-8 encoded, quoted. See http://www.webdav.org/specs/rfc4918.html#rfc.section.8.3 We are using the path-absolute option. i.e. starting with '/'. URI ; See section 3.2.1 of [RFC2068] z /!*'(),$-_|.)safe)rrIr mount_pathrJrH)r!rLr"r"r#get_href|s z_DAVResource.get_hrefcCs@|js tg}|D]$}||}|dk s0t||q|S)zReturn a list of direct members (_DAVResource or derived objects). This default implementation calls self.get_member_names() and self.get_member() for each of them. A provider COULD overwrite this for performance reasons. N)rr+get_member_names get_memberrappend)r!Z memberListr memberr"r"r#get_member_lists    z_DAVResource.get_member_listcCstdS)zReturn list of (direct) collection member names (UTF-8 byte strings). Every provider MUST provide this method for collection resources. Nr=r(r"r"r#rOsz_DAVResource.get_member_namesTFinfinityc Cs|dks tg}|r"|s"|||dkr|jr|D]r}|sH||rR|jp\|o\|j }|rp|sp|||jr|dkr||j||||dd|r8|r8||q8|r|r|||S)acReturn a list _DAVResource objects of a collection (children, grand-children, ...). This default implementation calls self.get_member_list() recursively. This function may also be called for non-collections (with add_self=True). :Parameters: depth_first : bool use , to list containers before content. (e.g. when moving / copying branches.) Use , to list content before containers. (e.g. when deleting branches.) depth : string '0' | '1' | 'infinity' )01rTrUrTF)add_self)rrQrrSextendget_descendants) r! collectionsZ resources depth_firstdepthrWreschildZwantr"r"r#rYs8        z_DAVResource.get_descendantscCsg}|d|dk r$|d|dk rD|jr:t|d|dk rZ|d|dk rp|d|dk r|d|dk r|d|j j r| s| t |j jr|}| |j j||j|S) aReturn list of supported property names in Clark Notation. Note that 'allprop', despite its name, which remains for backward-compatibility, does not return every property, but only dead properties and the live properties defined in RFC4918. This default implementation returns a combination of: - Supported standard live properties in the {DAV:} namespace, if the related getter method returns not None. - {DAV:}lockdiscovery and {DAV:}supportedlock, if a lock manager is present - If a property manager is present, then a list of dead properties is appended A resource provider may override this method, to add a list of supported custom live property names. rNr rrrr r)rQr.r,rrr-r<r0r;r lock_managerprevent_lockingrX_lockPropertyNames prop_managerrKget_propertiesr)r!Z is_allprop propNameListrefUrlr"r"r#get_property_namess.               z_DAVResource.get_property_namesNc Cs|dks t|dkr0|dks t||dk}n |dk s must not exist - there must be no conflicting locks Returns a DAVResuource. This method MUST be implemented by all providers that support write access. This default implementation simply raises HTTP_FORBIDDEN. Nrrrrr!r r"r"r#create_empty_resourceHs z"_DAVResource.create_empty_resourcecCs|js tttdSaCreate a new collection as member of self. Preconditions (to be ensured by caller): - this must be a collection - must not exist - there must be no conflicting locks This method MUST be implemented by all providers that support write access. This default implementation raises HTTP_FORBIDDEN. Nrrr"r"r#create_collection\s z_DAVResource.create_collectioncCs|jr ttdS)a Open content as a stream for reading. Returns a file-like object / stream containing the contents of the resource specified. The calling application will close() the stream. This method MUST be implemented by all providers. Nrrr+r(r"r"r# get_contentls z_DAVResource.get_contentcCs|jr tttdSzOpen content as a stream for writing. This method MUST be implemented by all providers that support write access. Nrr! content_typer"r"r# begin_writexs z_DAVResource.begin_writecCsdS)ziCalled when PUT has finished writing. This is only a notification. that MAY be handled. Nr"r! with_errorsr"r"r# end_writesz_DAVResource.end_writecCsdS)aHandle a DELETE request natively. This method is called by the DELETE handler after checking for valid request syntax and making sure that there are no conflicting locks and If-headers. Depending on the return value, this provider can control further processing: False: handle_delete() did not do anything. WsgiDAV will process the request by calling delete() for every resource, bottom-up. True: handle_delete() has successfully performed the DELETE request. HTTP_NO_CONTENT will be reported to the DAV client. List of errors: handle_delete() tried to perform the delete request, but failed completely or partially. A list of errors is returned like ``[ (, ), ... ]`` These errors will be reported to the client. DAVError raised: handle_delete() refuses to perform the delete request. The DAVError will be reported to the client. An implementation may choose to apply other semantics and return True. For example deleting '/by_tag/cool/myres' may simply remove the 'cool' tag from 'my_res'. In this case, the resource might still be available by other URLs, so locks and properties are not removed. This default implementation returns ``False``, so standard processing takes place. Implementation of this method is OPTIONAL. Fr"r(r"r"r# handle_deletes#z_DAVResource.handle_deletecCs|js ttdS)zReturn True, if delete() may be called on non-empty collections (see comments there). This method MUST be implemented for collections (not called on non-collections). Nrr(r"r"r#support_recursive_deletes z%_DAVResource.support_recursive_deletecCstdS)aRemove this resource (recursive). Preconditions (ensured by caller): - there are no conflicting locks or If-headers - if support_recursive_delete() is False, and this is a collection, all members have already been deleted. When support_recursive_delete is True, this method must be prepared to handle recursive deletes. This implies that child errors must be reported as tuple list [ (, ), ... ]. See http://www.webdav.org/specs/rfc4918.html#delete-collections This function - removes this resource - if this is a non-empty collection, also removes all members. Note that this may only occur, if support_recursive_delete is True. - For recursive deletes, return a list of error tuples for all failed resource paths. - removes associated direct locks - removes associated dead properties - raises HTTP_FORBIDDEN for read-only resources - raises HTTP_INTERNAL_ERROR on error This method MUST be implemented by all providers that support write access. Nr=r(r"r"r#deletesz_DAVResource.deletecCsdS)aHandle a COPY request natively. This method is called by the COPY handler after checking for valid request syntax and making sure that there are no conflicting locks and If-headers. Depending on the return value, this provider can control further processing: False: handle_copy() did not do anything. WsgiDAV will process the request by calling copy_move_single() for every resource, bottom-up. True: handle_copy() has successfully performed the COPY request. HTTP_NO_CONTENT/HTTP_CREATED will be reported to the DAV client. List of errors: handle_copy() tried to perform the copy request, but failed completely or partially. A list of errors is returned like ``[ (, ), ... ]`` These errors will be reported to the client. DAVError raised: handle_copy() refuses to perform the copy request. The DAVError will be reported to the client. An implementation may choose to apply other semantics and return True. For example copying '/by_tag/cool/myres' to '/by_tag/hot/myres' may simply add a 'hot' tag. In this case, the resource might still be available by other URLs, so locks and properties are not removed. This default implementation returns ``False``, so standard processing takes place. Implementation of this method is OPTIONAL. Fr")r!r>Zdepth_infinityr"r"r# handle_copys#z_DAVResource.handle_copycCstdS)aCopy or move this resource to destPath (non-recursive). Preconditions (ensured by caller): - there must not be any conflicting locks on destination - overwriting is only allowed (i.e. destPath exists), when source and dest are of the same type ((non-)collections) and a Overwrite='T' was passed - destPath must not be a child path of this resource This function - Overwrites non-collections content, if destination exists. - MUST NOT copy collection members. - MUST NOT copy locks. - SHOULD copy live properties, when appropriate. E.g. displayname should be copied, but creationdate should be reset if the target did not exist before. See http://www.webdav.org/specs/rfc4918.html#dav.properties - SHOULD copy dead properties. - raises HTTP_FORBIDDEN for read-only providers - raises HTTP_INTERNAL_ERROR on error When is_move is True, - Live properties should be moved too (e.g. creationdate) - Non-collections must be moved, not copied - For collections, this function behaves like in copy-mode: detination collection must be created and properties are copied. Members are NOT created. The source collection MUST NOT be removed. This method MUST be implemented by all providers that support write access. Nr=r!r>is_mover"r"r#copy_move_singles$z_DAVResource.copy_move_singlecCsdS)a9Handle a MOVE request natively. This method is called by the MOVE handler after checking for valid request syntax and making sure that there are no conflicting locks and If-headers. Depending on the return value, this provider can control further processing: False: handle_move() did not do anything. WsgiDAV will process the request by calling delete() and copy_move_single() for every resource, bottom-up. True: handle_move() has successfully performed the MOVE request. HTTP_NO_CONTENT/HTTP_CREATED will be reported to the DAV client. List of errors: handle_move() tried to perform the move request, but failed completely or partially. A list of errors is returned like ``[ (, ), ... ]`` These errors will be reported to the client. DAVError raised: handle_move() refuses to perform the move request. The DAVError will be reported to the client. An implementation may choose to apply other semantics and return True. For example moving '/by_tag/cool/myres' to '/by_tag/hot/myres' may simply remove the 'cool' tag from 'my_res' and add a 'hot' tag instead. In this case, the resource might still be available by other URLs, so locks and properties are not removed. This default implementation returns ``False``, so standard processing takes place. Implementation of this method is OPTIONAL. Fr"r!r>r"r"r# handle_move!s$z_DAVResource.handle_movecCs|js ttdS)CReturn True, if move_recursive() is available (see comments there).Nrrr"r"r#support_recursive_moveGs z#_DAVResource.support_recursive_movecCs ttdS)aMove this resource and members to destPath. This method is only called, when support_recursive_move() returns True. MOVE is frequently used by clients to rename a file without changing its parent collection, so it's not appropriate to reset all live properties that are set at resource creation. For example, the DAV:creationdate property value SHOULD remain the same after a MOVE. Preconditions (ensured by caller): - there must not be any conflicting locks or If-header on source - there must not be any conflicting locks or If-header on destination - destPath must not exist - destPath must not be a member of this resource This method must be prepared to handle recursive moves. This implies that child errors must be reported as tuple list [ (, ), ... ]. See http://www.webdav.org/specs/rfc4918.html#move-collections This function - moves this resource and all members to destPath. - MUST NOT move associated locks. Instead, if the source (or children thereof) have locks, then these locks should be removed. - SHOULD maintain associated live properties, when applicable See http://www.webdav.org/specs/rfc4918.html#dav.properties - MUST maintain associated dead properties - raises HTTP_FORBIDDEN for read-only resources - raises HTTP_INTERNAL_ERROR on error An implementation may choose to apply other semantics. For example copying '/by_tag/cool/myres' to '/by_tag/new/myres' may simply add a 'new' tag to 'my_res'. This method is only called, when self.support_recursive_move() returns True. Otherwise, the request server implements MOVE using delete/copy. This method MAY be implemented in order to improve performance. Nrrrr"r"r#move_recursiveLs+z_DAVResource.move_recursivecCstdS)zReturn a _DAVResource object for the path (None, if not found). `path_info`: is a URL relative to this object. DAVCollection.resolve() provides an implementation. Nr=r! script_name path_infor"r"r#resolveysz_DAVResource.resolvecCsdS)zPerform custom operations on the response headers. This gets called before the response is started. It enables adding additional headers or modifying the default ones. Nr")r!rresponse_headersr"r"r#finalize_headerssz_DAVResource.finalize_headers)TTFrTF)N)F)N)0r' __module__ __qualname____doc__r$r)r,r-r.r/r0r:r;r<rArBrCrDrErHrKrNrSrOrYrfrcrkrrr`rrrrrrrrrrrrrrrrrr"r"r"r#rvsf/      "  33 0 [   % %&&- rc@sReZdZdZddZddZddZdd Zd d Zdd dZ ddZ ddZ d S)DAVNonCollectionz A DAVNonCollection is a _DAVResource, that has content (like a 'file' on a filesystem). A DAVNonCollecion is able to read and write file content. See also _DAVResource cCst||d|dSNFrr$r!rrr"r"r#r$szDAVNonCollection.__init__cCstdS)zReturns the byte length of the content. MUST be implemented. See also _DAVResource.get_content_length() Nr=r(r"r"r#r,sz#DAVNonCollection.get_content_lengthcCstdS)a?Contains the Content-Type header returned by a GET without accept headers. This getcontenttype property MUST be defined on any DAV compliant resource that returns the Content-Type header in response to a GET. See http://www.webdav.org/specs/rfc4918.html#PROPERTY_getcontenttype Nr=r(r"r"r#r-sz!DAVNonCollection.get_content_typecCstdS)aOpen content as a stream for reading. Returns a file-like object / stream containing the contents of the resource specified. The application will close() the stream. This method MUST be implemented by all providers. Nr=r(r"r"r#rs zDAVNonCollection.get_contentcCsdS)z~Return True, if this non-resource supports Range on GET requests. This default implementation returns False. Fr"r(r"r"r#rBszDAVNonCollection.support_rangesNcCs ttdSrrrr"r"r#rszDAVNonCollection.begin_writecCsdS)zhCalled when PUT has finished writing. This is only a notification that MAY be handled. Nr"rr"r"r#rszDAVNonCollection.end_writecCs|dkr |SdS)zReturn a _DAVResource object for the path (None, if not found). Since non-collection don't have members, we return None if path is not empty. rFNr"rr"r"r#rszDAVNonCollection.resolve)N) r'rrrr$r,r-rrBrrrr"r"r"r#rs     rc@sxeZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ ddZ ddZddZddZdS) DAVCollectiona A DAVCollection is a _DAVResource, that has members (like a 'folder' on a filesystem). A DAVCollecion 'knows' its members, and how to obtain them from the backend storage. There is also optional built-in support for member caching. See also _DAVResource cCst||d|dS)NTrrr"r"r#r$szDAVCollection.__init__cCsdSrr"r(r"r"r#r,sz DAVCollection.get_content_lengthcCsdSrr"r(r"r"r#r-szDAVCollection.get_content_typecCs ttdSrrrr"r"r#rsz#DAVCollection.create_empty_resourcecCs|js tttdSrrrr"r"r#r)s zDAVCollection.create_collectioncCs$|js t|jt|j||jS)zReturn child resource with a given name (None, if not found). This method COULD be overridden by a derived class, for performance reasons. This default implementation calls self.provider.get_resource_inst(). )rrrrrjoin_urirrrr"r"r#rP9s   zDAVCollection.get_membercCs|js ttdS)zxReturn list of (direct) collection member names (UTF-8 byte strings). This method MUST be implemented. Nrr(r"r"r#rOEs zDAVCollection.get_member_namescCsdS)zReturn True, if delete() may be called on non-empty collections (see comments there). This default implementation returns False. Fr"r(r"r"r#rMsz&DAVCollection.support_recursive_deletecCs ttdS)zRemove this resource (possibly recursive). This method MUST be implemented if resource allows write access. See _DAVResource.delete() Nrr(r"r"r#rUszDAVCollection.deletecCs ttdS)zCopy or move this resource to destPath (non-recursive). This method MUST be implemented if resource allows write access. See _DAVResource.copy_move_single() Nrrr"r"r#r^szDAVCollection.copy_move_singlecCsdS)rFr"rr"r"r#rgsz$DAVCollection.support_recursive_movecCs ttdS)z}Move this resource and members to destPath. This method MAY be implemented in order to improve performance. Nrrr"r"r#rkszDAVCollection.move_recursivecCsZ|dkr |S|dstt|\}}||}|dksB|dkrF|S|t|||S)zReturn a _DAVResource object for the path (None, if not found). `path_info`: is a URL relative to this object. rFrN)rrrpop_pathrPrr)r!rrr restr]r"r"r#rrs zDAVCollection.resolveN)r'rrrr$r,r-rrrPrOrrrrrrr"r"r"r#rs '   rc@speZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ ddZ ddZddZdS) DAVProviderzAbstract base class for DAV resource providers. There will be only one DAVProvider instance per share (not per request). cCs.d|_d|_d|_d|_d|_d|_d|_dS)Nrr)rMrJr_rbrm_count_get_resource_instZ_count_get_resource_inst_initr(r"r"r#r$szDAVProvider.__init__cCs|jjSr)r&r'r(r"r"r#r)szDAVProvider.__repr__cCsdSrr"r(r"r"r# is_readonlyszDAVProvider.is_readonlycCs |dks|drt||_dS)zSet application root for this resource provider. This is the value of SCRIPT_NAME, when WsgiDAVApp is called. rFrN)rGrrM)r!rMr"r"r#set_mount_pathszDAVProvider.set_mount_pathcCsB|dks|dst|dkr"d}|dks8|dr8t||_dS)zSet application location for this resource provider. @param share_path: a UTF-8 encoded, unquoted byte string. rrrFN)rrrGrJ)r!rJr"r"r#set_share_paths zDAVProvider.set_share_pathcCs |rt|dstd||_dS)Ncheck_write_permissionz8Must be compatible with wsgidav.lock_manager.LockManager)hasattrrr_)r!r_r"r"r#set_lock_managerszDAVProvider.set_lock_managercCs |rt|dstd||_dS)Ncopy_propertieszIMust be compatible with wsgidav.prop_man.property_manager.PropertyManager)rrrb)r!rbr"r"r#set_prop_managerszDAVProvider.set_prop_managercCsdtt||jdS)zConvert a refUrl to a path, by stripping the share prefix. Used to calculate the from a storage key by inverting get_ref_url(). r)runquoter lstripstrrJlstrip)r!ref_urlr"r"r#rszDAVProvider.ref_url_to_pathcCstdS)aReturn a _DAVResource object for path. Should be called only once per request and resource:: res = provider.get_resource_inst(path, environ) if res and not res.is_collection: print(res.get_content_type()) If does not exist, None is returned. may be used by the provider to implement per-request caching. See _DAVResource for details. This method MUST be implemented. Nr=rr"r"r#rszDAVProvider.get_resource_instcCs|||dk S)aReturn True, if path maps to an existing resource. This method should only be used, if no other information is queried for . Otherwise a _DAVResource should be created first. This method SHOULD be overridden by a more efficient implementation. N)rrr"r"r#existsszDAVProvider.existscCs|||}|o|jS)zReturn True, if path maps to an existing collection resource. This method should only be used, if no other information is queried for . Otherwise a _DAVResource should be created first. )rr)r!rrr]r"r"r#rs zDAVProvider.is_collectioncCs |||S)zOptionally implement custom request handling. requestmethod = environ["REQUEST_METHOD"] Either - handle the request completely - do additional processing and call default_handler(environ, start_response) r")r!rstart_responseZdefault_handlerr"r"r#custom_request_handlers z"DAVProvider.custom_request_handlerN)r'rrrr$r)rrrrrrrrrrr"r"r"r#rs     r)rwsgidavrrrwsgidav.dav_errorrrrrr Z wsgidav.utilr r4rprrn __docformat__get_module_loggerr'rrraobjectrrrrr"r"r"r#s@I    O*