"jyb dZddlZddlZddlmZddlmZddlmZddl m Z m Z m Z m Z ddlmZmZmZddlmZd Zej*eZd Z d Zd d dddgddej4j7edej4j7edgddddddgddej4j7edgdddj9ddgddej4j7edgdgZd Zd!ZGd"d#eZ Gd$d%eZ!Gd&d'eZ"Gd(d)eZ#Gd*d+eZ$Gd,d-e$Z%Gd.d/e$Z&Gd0d1eZ'y)2aN Sample implementation of a DAV provider that provides a browsable, multi-categorized resource tree. Note that this is simply an example with no concrete real world benefit. But it demonstrates some techniques to customize WsgiDAV. Compared to a published file system, we have these main differences: #. A resource like ``My doc 1`` has several attributes like ``key``, ``orga``, ``tags``, ``status``, ``description``. Also there may be a list of attached files. #. These attributes are used to dynamically create a virtual hierarchy. For example, if ``status`` is ``draft``, a collection ``/by_status/draft/`` is created and the resource is mapped to ``/by_status/draft/My doc 1``. #. The resource ``My doc 1`` is rendered as a collection, that contains some virtual descriptive files and the attached files. #. The same resource may be referenced using different paths For example ``/by_tag/cool/My doc 1``, ``/by_tag/hot/My doc 1``, and ``/by_key/1`` map to the same resource. Only the latter is considered the *real-path*, all others are *virtual-paths*. #. The attributes are exposed as live properties, like "{virtres:}key", "{virtres:}tags", and "{virtres:}description". Some of them are even writable. Note that modifying an attribute may also change the dynamically created tree structure. For example changing "{virtres:}status" from 'draft' to 'published' will make the resource appear as ``/by_status/published/My doc 1``. #. This provider implements native delete/move/copy methods, to change the semantics of these operations for the virtual '/by_tag/' collection. For example issuing a DELETE on ``/by_tag/cool/My doc 1`` will simply remove the 'cool' tag from that resource. #. Virtual collections and artifacts cannot be locked. However a resource can be locked. For example locking ``/by_tag/cool/My doc 1`` will also lock ``/by_key/1``. #. Some paths may be hidden, i.e. by_key is not browsable (but can be referenced) TODO: is this WebDAV compliant? The *database* is a simple hard coded variable ``_resourceData``, that contains a list of resource description dictionaries. A resource is served as an collection, which is generated on-the-fly and contains some virtual files (*artifacts*). In general, a URL is interpreted like this:: //// An example layout:: / by_tag/ cool/ My doc 1/ .Info.html .Info.txt .Description.txt MySpec.pdf MySpec.doc My doc 2/ hot/ My doc 1/ My doc 2/ nice/ My doc 2/ My doc 3 by_orga/ development/ My doc 3/ marketing/ My doc 1/ My doc 2/ by_status/ draft/ My doc 2 published/ My doc 1 My doc 3 by_key/ 1/ 2/ 3/ When accessed using WebDAV, the following URLs both return the same resource 'My doc 1':: /by_tag/cool/My doc 1 /by_tag/hot/My doc 1 /by_key/1 N)BytesIO)quote)util)HTTP_FORBIDDENHTTP_INTERNAL_ERRORDAVError#PRECONDITION_CODE_ProtectedProperty) DAVCollectionDAVNonCollection DAVProvider)join_urizreStructuredText eni zc:\temp\virtfiles1zMy doc 1 developmentcoolhotdraftz/This resource contains two specification files.z MySpec.docz MySpec.pdf)keytitleorgatagsstatus description resPathList2zMy doc 2nice publishedz This resource contains one file.z My URS.doc3uMy doc (euro:€, uuml:��) marketingzLong text describing itc^|tjvsJ|dk(r)tDcgc]}|jd|k(s|c}S|dk(r*tDcgc]}|jd|k(s|}}|S|dk(r'tDcgc]}||jdvs|}}Scc}wcc}wcc}w) by_statusrby_orgarby_tagr)RootCollection_visibleMemberNames _resourceDataget)attrNameattrValdataresLists S/srv/dav/.venv/lib/python3.12/site-packages/wsgidav/samples/virtual_dav_provider.py_get_res_list_by_attrr-s ~99 99 9;!.P$((82D2OPP Y $1QDTXXf5E5P4QQ N X $1QDW@P5P4QQ N QQQs"B B B%*B%?B*B*c2tD]}|d|k(s |cSy)r rN)r&)rr*s r,_get_res_by_keyr/s' ;# K c<eZdZdZdZedzZfdZdZdZxZ S)r$zResolve top-level requests '/'.)r"r#r!)by_keyc&t|d|y)N/super__init__)selfenviron __class__s r,r7zRootCollection.__init__s g&r0c|jSN)r%r8s r,get_member_nameszRootCollection.get_member_namess'''r0ct||jvr*tt|j||jSyr<)_validMemberNamesCategoryTypeCollectionr pathr9)r8names r, get_memberzRootCollection.get_members/ 4)) ))(499d*CT\\R Rr0) __name__ __module__ __qualname____doc__r%r@r7r>rD __classcell__r:s@r,r$r$s&)<+k9'(r0r$c4eZdZdZfdZdZdZdZxZS)rAz/Resolve '/catType' URLs, for example '/by_tag'.c&t|||yr<r5r8rBr9r:s r,r7zCategoryTypeCollection.__init__ w'r0c ddiS)Ntypez Category typer=s r,get_display_infoz'CategoryTypeCollection.get_display_infos ((r0cPg}tD]}|jdk(r|d|vs|j|d/|jdk(r|d|vsF|j|d[|jdk(sk|dD]}||vs|j||j|S)Nr!rr"rr#r)r&rCappendsort)r8namesr*tags r,r>z'CategoryTypeCollection.get_member_namess! *DyyK'>.LLh0i'rDrIrJs@r,rArAs9()"Vr0rAc4eZdZdZfdZdZdZdZxZS)rZz8Resolve '/catType/cat' URLs, for example '/by_tag/cool'.c4t|||||_yr<)r6r7catType)r8rBr9r_r:s r,r7zCategoryCollection.__init__s w' r0c ddiS)NrPCategoryrQr=s r,rRz#CategoryCollection.get_display_infos  ##r0ct|j|jDcgc]}|d }}|j|Scc}wNr)r-r_rCrU)r8r*rVs r,r>z#CategoryCollection.get_member_namessD&;DLL$))&T "DM      s Act|j|jD]7}|d|k(s tt |j ||j |cSyrc)r-r_rCrYr rBr9r[s r,rDzCategoryCollection.get_membersR)$,, B VDG}$&x 4'@$,,PTUU Vr0r\rJs@r,rZrZsB$r0rZcteZdZdZdZgdZfdZdZdZdZ dZ d Z d Z d Z fd Zfd ZddZxZS)rYzGA virtual 'resource', displayed as a collection of artifacts and files.) .Info.txt .Info.html.Description.txt) {virtres:}key{virtres:}title{virtres:}status{virtres:}orga{virtres:}tags{virtres:}descriptionc4t|||||_yr<r6r7r*r8rBr9r*r:s r,r7zVirtualResource.__init__s w' r0c ddiS)NrPzVirtual ResourcerQr=s r,rRz VirtualResource.get_display_info#s*++r0ct|j}|jdD]2}tjj |}|j |4|SNr)list_artifactNamesr*osrBbasenamerT)r8rVfrCs r,r>z VirtualResource.get_member_names&sQT(()=) A77##A&D LL   r0cj||jvr5tt|j||j|j S|j dD]^}t jj|}||k(s(tt|j||j|j |cSyrt) rvVirtualArtifactr rBr9r*rwrxVirtualResFile)r8rC file_pathfnames r,rDzVirtualResource.get_member-s 4&& &"8DIIt#* *"oodiiooc.BCKe("""dii'''' &  %r0cd|vrtttj|j ddd\}}}|dk(sJ||j dvr|j dj |y)z-Change semantic of COPY to add resource tags.rr4rr#rT)rrrrrr*rT)r8 dest_pathdepth_infinityr_rWrs r, handle_copyzVirtualResource.handle_copyDsr Y &>* *"ooiooc.BCKe(""" dii' ' IIf  $ $S )r0cd|jvrttd|vrtttj|jj ddd\}}}|dk(sJ||j dvsJ|j dj|tj|j ddd\}}}|dk(sJ||j dvr|j dj|y)z0Change semantic of MOVE to change resource tags.rr4rr#rT) rBrrrrrr*rrT)r8rr_rWrs r, handle_movezVirtualResource.handle_moveOs TYY &>* * Y &>* *"oodiiooc.BCKe("""dii'''' &  %"ooiooc.BCKe(""" dii' ' IIf  $ $S )r0cjd|jdz}t|jj|zS)Nz /by_key/%sr)r*rprovider share_pathr8refPaths r, get_ref_urlzVirtualResource.get_ref_url`s/5!11T]]--788r0cft||}|jtj|S)zqReturn list of supported property names in Clark Notation. See DAVResource.get_property_names() ) is_allprop)r6get_property_namesextendrY_supportedProps)r8r propNameListr:s r,rz"VirtualResource.get_property_namesds1 w1Z1H O;;<r0c0|dk(r|jdS|dk(r|jdS|dk(r|jdS|dk(r|jdS|d k(rd j|jd S|d k(r|jd St| |S)zJReturn the value of a property. See get_property_value() rirrjrrkrrlrrm,rrnr)r*joinr6get_property_value)r8rCr:s r,rz"VirtualResource.get_property_valueos ? "99U# # & &99W% % ' '99X& & % %99V$ $ % %88DIIf-. . , ,99]+ +w)$//r0c*|tt|dk(r)|jjd|jd<y|dk(r|j|jd<y|t j vrttttt)zTSet or remove property value. See DAVResource.set_property_value() Nrmrrrnr) err_condition)rrtextsplitr*rYrr )r8rCvaluedry_runs r,set_property_valuez"VirtualResource.set_property_values =>* * # # % 0 0 5DIIf  , ,',zzDIIm $ _44 4.Q  >* *r0)F)rErFrGrHrvrr7rRr>rDrrrrrrrrIrJs@r,rYrY sKQN O,   "9 0,r0rYcReZdZdZfdZdZdZdZdZdZ dZ d Z d Z xZ S) _VirtualNonCollectionz5Abstract base class for all non-collection resources.c&t|||yr<r5rMs r,r7z_VirtualNonCollection.__init__rNr0cyr<rQr=s r,get_content_lengthz(_VirtualNonCollection.get_content_lengthr0cyr<rQr=s r,get_content_typez&_VirtualNonCollection.get_content_typerr0cyr<rQr=s r,get_creation_datez'_VirtualNonCollection.get_creation_daterr0c|jSr<)rCr=s r,get_display_namez&_VirtualNonCollection.get_display_names yyr0ctr<)NotImplementedErrorr=s r,rRz&_VirtualNonCollection.get_display_infos!!r0cyr<rQr=s r,get_etagz_VirtualNonCollection.get_etagrr0cyr<rQr=s r,get_last_modifiedz'_VirtualNonCollection.get_last_modifiedrr0cy)NFrQr=s r,support_rangesz$_VirtualNonCollection.support_rangessr0)rErFrGrHr7rrrrrRrrrrIrJs@r,rrs3?("r0rcFeZdZdZfdZdZdZdZdZdZ dZ xZ S) r{z1A virtual file, containing resource descriptions.c4t|||||_yr<rprqs r,r7zVirtualArtifact.__init__s w' r0cPt|jjSr<)len get_contentreadr=s r,rz"VirtualArtifact.get_content_lengths4##%**,--r0c<|jjdryy)Nz.txtz text/plain text/html)rCendswithr=s r,rz VirtualArtifact.get_content_types 99  f %r0c ddiS)NrPzVirtual info filerQr=s r,rRz VirtualArtifact.get_display_infos+,,r0cy)NTrQr=s r,prevent_lockingzVirtualArtifact.prevent_lockingrr0cdj|jd|j}t|jj |zSNz /by_key/{}/{}r)formatr*rCrrrrs r,rzVirtualArtifact.get_ref_urls;!((5)9499ET]]--788r0c  |jdDcgc](}dtjj|d|d*}}|jj }dj ||d<|j dk(rd|z}n|j d k(r|jd d t|jd z|jd d d|jdzd|jdzddj |jdzd|jdzg}dj |}n<|j dk(r|jd }nttd|j zttj|Scc}w)Nrz z z, fileLinksrga0 %(title)s

%(title)s

Description %(description)s
Status %(status)s
Tags %(tags)s
Orga unit %(orga)s
Files %(fileLinks)s
Key %(key)s

This is a virtual WsgiDAV resource called '%(title)s'.

rfr=rz Status: %srz Orga: %8srz Tags: '%s'z', 'rz Key: %sr rhzInvalid artifact '%s') r*rwrBrxcopyrrCrrrrrto_bytes)r8ryrdicthtmlliness r,rzVirtualArtifact.get_contents~YY}- ((+,Bqc 8  yy~~ IIi0[ 99 $89 >YY+ % '"c$))G,-- -(tyy22 & 11TYYv->!??tyy// E99U#D YY, ,99]+D.0G$))0ST Tt}}T*++m s-F ) rErFrGrHr7rrrRrrrrIrJs@r,r{r{s); . -97,r0r{cLeZdZdZfdZdZdZdZdZdZ dZ d Z xZ S) r|zCRepresents an existing file, that is a member of a VirtualResource.ctjj|stj d|zt |||||_||_y)Nz"VirtualResFile(%r) does not exist.) rwrBexists_loggererrorr6r7r*r})r8rBr9r*r}r:s r,r7zVirtualResFile.__init__&sBww~~i( MM>J K w' "r0cftj|j}|tjSr<)rwstatr}ST_SIZEr8 statresultss r,rz!VirtualResFile.get_content_length-s#ggdnn- 4<<((r0ctjj|jsyt j |jS)Nr)rwrBisfiler}rguess_mime_typer=s r,rzVirtualResFile.get_content_type1s0ww~~dnn- ##DNN33r0cftj|j}|tjSr<)rwrr}ST_CTIMErs r,rz VirtualResFile.get_creation_date:#ggdnn- 4==))r0c ddiS)NrPz Content filerQr=s r,rRzVirtualResFile.get_display_info>s ''r0cftj|j}|tjSr<)rwrr}ST_MTIMErs r,rz VirtualResFile.get_last_modifiedArr0cdj|jdtjj |j }t |jj|zSr) rr*rwrBrxr}rrrrs r,rzVirtualResFile.get_ref_urlEsO!(( IIe bgg..t~~> T]]--788r0c8t|jdtS)Nrb)openr} BUFFER_SIZEr=s r,rzVirtualResFile.get_contentKs DNND+66r0) rErFrGrHr7rrrrRrrrrIrJs@r,r|r|#s.M#)4*(*9 7r0r|c(eZdZdZfdZdZxZS)VirtualResourceProviderzG DAV provider that serves a VirtualResource derived structure. c8t|t|_yr<)r6r7r& resourceData)r8r:s r,r7z VirtualResourceProvider.__init__[s )r0ctjd|z|xjdz c_t|}|j d|S)zReturn _VirtualResource object for path. path is expected to be categoryType/category/name/artifact for example: 'by_tag/cool/My doc 2/info.html' See DAVProvider.get_resource_inst() zget_resource_inst('%s')r)rinfo_count_get_resource_instr$resolve)r8rBr9roots r,get_resource_instz)VirtualResourceProvider.get_resource_inst_sB  .56 %%*%g&||B%%r0)rErFrGrHr7rrIrJs@r,rrVs* &r0r)(rHrwrior urllib.parserwsgidavrwsgidav.dav_errorrrrr wsgidav.dav_providerr r r wsgidav.utilr __docformat__get_module_loggerrErr FILE_FOLDERrBrencoder&r-r/r$rArZrYrr{r|rrQr0r,rs]~  NM!% $  *  # H GGLLl 3 GGLLl 3   9 [,?@4;;=0 [,?@- D ]&!V]!VH6OmOj,TQ,+Q,n-7*-7f&k&r0