"j'PdZddlZddlZddlZddlmZddlZddlmZddl m Z m Z m Z ddl mZmZdZej"eZdZGd d eZGd d eZy) ao Implementation of a WebDAV provider that provides a very basic, read-only resource layer emulation of a MySQL database. This module is specific to the WsgiDAV application. It provides a classes ``MySQLBrowserProvider``. Usage:: (see docs/sample_wsgidav.yaml) MySQLBrowserProvider(host, user, passwd, db) host - host of database server user - user_name to access database passwd - passwd to access database db - name of database on database server The ``MySQLBrowserProvider`` provides a very basic, read-only resource layer emulation of a MySQL database. It provides the following interface: - the root collection shared consists of collections that correspond to table names - in each table collection, there is a resource called "_ENTIRE_CONTENTS". This is a non-collection resource that returns a csv representation of the entire table - if the table has a single primary key, each table record will also appear as a non-collection resource in the table collection using the primary key value as its name. This resource returns a csv representation of the record and will also include the record attributes as live properties with attribute name as property name and table name suffixed with colon as the property namespace This is a very basic interface and below is a by no means thorough summary of its limitations: - Really only supports having numbers or strings as primary keys. The code uses a numeric or string comparison that may not hold up if the primary key is a date or some other datatype. - There is no handling for cases like BLOBs as primary keys or such. Well, there is no handling for BLOBs in general. - When returning contents, it buffers the entire contents! A bad way to return large tables. Ideally you would have a FileMixin that reads the database even as the application reads the file object.... - It takes too many database queries to return information. Ideally there should be some sort of caching for metadata at least, to avoid unnecessary queries to the database. N)StringIO)util)HTTP_FORBIDDENDAVError#PRECONDITION_CODE_ProtectedProperty) DAVProvider _DAVResourcereStructuredTextc&|jddS)z7Escape MySQL identifier (table, column, database name).`z``)replace) identifiers Q/srv/dav/.venv/lib/python3.12/site-packages/wsgidav/samples/mysql_dav_provider.py _escape_idrRs   c4 ((ceZdZdZfdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZfdZfdZddZxZS)MySQLBrowserResourcezlRepresents a single existing DAV resource instance. See also DAVResource and MySQLBrowserProvider. c6t||||d|_yN)super__init___cache)selfproviderpath is_collectionenviron __class__s rrzMySQLBrowserResource.__init__]s }g6 rc H|jxjdz c_|jj|j\}}d}d}d}|d}n|d}nd}|d k(rd }d }nd }d }|du}d|t j|j t jj|jjdd||dd|_ |s!t j|jd<tjd|jjzy)zhRead resource information into self._cache, for cached access. See DAVResource._init() Unknownz text/htmlNDatabasezDatabase Tableztext/csv_ENTIRE_CONTENTSzDatabase Table Contentsz$CSV Representation of Table ContentszDatabase Recordz"Attributes available as propertiesF)type typeComment)content_length contentTypecreated display_nameetagmodifiedsupport_ranges display_infor,z---> _init, nc=%s)r_count_get_resource_inst_init _split_pathrtimenamehashlibmd5update hexdigestr_loggerdebug_count_initConnection)r tableNameprimKey display_typedisplayTypeCommentr(rs r_initzMySQLBrowserResource._initas 33q83!]]66tyyA 7 !   %L _+L$K,,8 %K"0 %I" 4 #&yy{ IIKKM((3==?#%1BTU   &*iikDKK # )DMM,O,OOPrcp|j|j|jj|Sr)rr>get)rinfos r _get_infozMySQLBrowserResource._get_infos( ;;  JJL{{t$$rc$|jdS)Nr'rBrs rget_content_lengthz'MySQLBrowserResource.get_content_lengths~~.//rc$|jdS)Nr(rDrEs rget_content_typez%MySQLBrowserResource.get_content_types~~m,,rc$|jdS)Nr)rDrEs rget_creation_datez&MySQLBrowserResource.get_creation_dates~~i((rc|jSr)r2rEs rget_display_namez%MySQLBrowserResource.get_display_names yyrc$|jdS)Nr.rDrEs rget_display_infoz%MySQLBrowserResource.get_display_infos~~n--rc$|jdS)Nr+rDrEs rget_etagzMySQLBrowserResource.get_etags~~f%%rc$|jdS)Nr,rDrEs rget_last_modifiedz&MySQLBrowserResource.get_last_modifieds~~j))rc g}|jj} |jj|j\}}|r|jj |}|D]Q}|j t |jtj|j|d|jSn||jj||}|s|jj|||}|D]Q}|j t |jtj|j|d|jS|jdt |jtj|jdd|j|j|S#|jwxYw)zyReturn list of (direct) collection member names (UTF-8 byte strings). See DAVResource.get_member_list() TFrr$)r_init_connectionr0r _list_tablesappendrrjoin_urir_find_primary_key _list_fieldsinsertclose)rmembersconnr:r;retlistr2pri_keys rget_member_listz$MySQLBrowserResource.get_member_listsx }}--/$ !%!:!:499!E Iw --44T:#DNN, MM MM$))T:  LL --99$ J&"mm88y'RG '0 $ $ dii > % $ (  dii1CD  JJL JJLs E?F//GcNt}|jj|j\}}|^|jj }|jj ||}t j||d}i}|D]}|||< |j||dk(r|jtjj} djt|jjt|} | j!| | j#} | D]} |j| | j%n0|jj'|||} | |j| |j%|j)d|S)zUOpen content as a stream for reading. See DAVResource.get_content() ignore) extrasactionr$zSELECT * FROM `{db}`.`{table}`)dbtabler)rrr0rrT_get_field_listcsv DictWriterwriterowcursorMySQLdbcursors DictCursorformatr_dbexecutefetchallr[_get_record_by_primary_keyseek) r filestreamr:r;r] listFields csvwriter dictFields field_namerjsql result_setrows r get_contentz MySQLBrowserResource.get_contentsn Z !]]66tyyA 7  ==113D66tYGJz:HUIJ( 4 )3 :& 4   z *,,W__%?%?@7??!$--"3"34$Y/@s##__. %,C&&s+, mm>>tYPWX?&&s+ JJL rcDt||}|jj|j\}}|d|jj }|jj ||}|D]}|jd|d||j|S)zReturn list of supported property names in Clark Notation. Return supported live and dead properties. (See also DAVProvider.get_property_names().) In addition, all table field names are returned as properties. ) is_allprop{z:}) rget_property_namesrr0rrTrfrVr[) rr~ propNamesr:r;r] fieldlist fieldnamers rrz'MySQLBrowserResource.get_property_namessG.*.E !]]66tyyA 7  ==113D 55dIFI& A   2i[I;!?@ A JJLrc|jj|j\}}|tj|\}}||dzk(rz|jj }|jj ||}||vr0|jj||||}|j|S|jt |)|S)aReturn the value of a property. The base implementation handles: - ``{DAV:}lockdiscovery`` and ``{DAV:}supportedlock`` using the associated lock manager. - All other *live* properties (i.e. name starts with ``{DAV:}``) are delegated to self.getLivePropertyValue() - Finally, other properties are considered *dead*, and are handled using the associated property manager, if one is present. :) rr0rrsplit_namespacerTrf_get_field_by_primary_keyr[rget_property_value) rr2r:r;ns localNamer]rvalrs rrz'MySQLBrowserResource.get_property_values"]]66tyyA 7   006MB i#o&}}557 MM99$ J  )--AAi)CJJLJ w)$//rc,ttt)zTSet or remove property value. See DAVResource.set_property_value() ) err_condition)rrr)rr2valuedry_runs rset_property_valuez'MySQLBrowserResource.set_property_value2s  *M  r)F)__name__ __module__ __qualname____doc__rr>rBrFrHrJrLrNrPrRr`r|rrr __classcell__rs@rrrWsW .Q`% 0-).&*,\&P&0: rrcreZdZfdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdZxZS)MySQLBrowserProvidercht|||_||_||_||_d|_y)Nr)rr_host_user_passwdror9)rhostuserpasswdrdrs rrzMySQLBrowserProvider.__init__Bs2    %&"rc|jjd|jd|jd|jdS)Nz for db 'z' on 'z ' (user: 'z')')rrrorrrEs r__repr__zMySQLBrowserProvider.__repr__Js=..))*)DHH:VDJJ>## G""7+ rcVd}|jtjj}|j dt |z|j }|D]}|ddk(s ||d}y|j|jtjj}djt |t |jt |}|j ||f|j}||jy|jy) NrKeyPRIrFz?SELECT `{pri_key}` FROM `{db}`.`{table}` WHERE `{pri_key}` = %s)r_rdreT) rjrkrlrmrprrqr[rnrofetchone) rr]r pri_key_valuer_rjrzr{rys r_exists_record_by_primary_keyz2MySQLBrowserProvider._exists_record_by_primary_keysW__778J)??@__&  !C5zU"?!'lG  !  W__778 M &w'$((#Z(    s],-oo ; LLN rcd}|jtjj}|j dt |z|j }|D]}|ddk(s ||d}y|j|jtjj}djt |t |jt |t |} |j | |f|j}||jytj||} |j| S)Nrrrrz=SELECT `{field}` FROM `{db}`.`{table}` WHERE `{pri_key}` = %s)fieldrdrer_) rjrkrlrmrprrqr[rnrorrto_str) rr]rrrxr_rjrzr{ryrs rrz.MySQLBrowserProvider._get_field_by_primary_keysW__778J)??@__&  C5zU"?!'lG   W__778NVVZ($((#Z(w' W  s],-oo ; LLNkk#j/*  rci}d}|jtjj}|j dt |z|j }|D]}|ddk(s ||d}y|j|jtjj}djt |jt |t |} |j | |f|j}||jy|jD]} tj|| || <|j|S)Nrrrrz5SELECT * FROM `{db}`.`{table}` WHERE `{pri_key}` = %s)rdrer_)rjrkrlrmrprrqr[rnrorkeysrr) rr]rrdictRetr_rjrzr{ryfnames rrrz/MySQLBrowserProvider._get_record_by_primary_keys0W__778J)??@__&  C5zU"?!'lG   W__778FNN$((#Z(w'O  s],-oo ; LLNXXZ 5E![[U4GEN 5 rcd}|jtjj}|j dt |z|j }|D]}|d}|d}|dk(s||}y|j|S)Nrrrr)rjrkrlrmrprrqr[) rr]rr_rjrzr{rkeyvalues rrXz&MySQLBrowserProvider._find_primary_keysW__778J)??@__&  CG I5zH5 ?'G   rcg}|jtjj}dj t |t |j t |}|j||j}|D])}|jtj||+|j|S)Nz&SELECT `{field}` FROM `{db}`.`{table}`)rrdre) rjrkrlrmrnrrorprqrVrrr[) rr]rrxr^rjryrzr{s rrYz!MySQLBrowserProvider._list_fieldssW__7787??Z($((#Z(@  s__&  9C NN4;;s:7 8 9 rcg}|j}|jd|j}|D]}|jd|dz|j |S)Nz SHOW TABLESz%sr)rjrprqrVr[)rr]r^rjrzr{s rrUz!MySQLBrowserProvider._list_tabless[}%__&  ,C NN43q6? + , rc|xjdz c_|j||sy|j|\}}|du}t||||S)zJReturn info dictionary for path. See get_resource_inst() r N)_count_get_resource_instexistsr0r)rrr _tableNamer;rs rget_resource_instz&MySQLBrowserProvider.get_resource_instsU %%*%{{4)"..t4 G4 #D$ wGGrc^|j|\}}|y d}|j}|j|}||vr |r|jyy|r+|dk7r&|j ||||r|jSS |r|jyy#r|jwwxYw)NTFr$)r0rTrUr[r)rrrr:r;r]tbllists rrzMySQLBrowserProvider.existss!--d3 7   D((*D''-G'   7&8899$ 7S  t s'BBB,cZ|j|\}}|j||xr|duSr)r0r)rrrrr;s rrz"MySQLBrowserProvider.is_collection#s1"..t4 G{{4)=go=r)rrrrrr0rTrfrrrrrrXrYrUrrrrrs@rrrAsP'j$ 4::<  H(>rr)rrgr3r1iorrkwsgidavrwsgidav.dav_errorrrrwsgidav.dav_providerrr __docformat__get_module_loggerrr7rrrrrrsg6t   ;" $  *) b <b Td>;d>r