U ‡äVc/Jć@sždZddlmZddlmZmZddlmZmZm Z m Z ddl m Z ddl Z ddlZdZe e”Zdd „Zd d „Zd d „Zdd„Zdd„ZGdd„deƒZdS)a“ Implements the `LockManager` object that provides the locking functionality. The LockManager requires a LockStorage object to implement persistence. Two alternative lock storage classes are defined in the lock_storage module: - wsgidav.lock_storage.LockStorageDict - wsgidav.lock_storage.LockStorageShelve The lock data model is a dictionary with these fields: root: Resource URL. principal: Name of the authenticated user that created the lock. type: Must be 'write'. scope: Must be 'shared' or 'exclusive'. depth: Must be '0' or 'infinity'. owner: String identifying the owner. timeout: Seconds remaining until lock expiration. This value is passed to create() and refresh() expire: Converted timeout for persistence: expire = time() + timeout. token: Automatically generated unique token. é)Śpformat)ŚcompatŚutil)ŚDAVErrorŚDAVErrorConditionŚ HTTP_LOCKEDŚPRECONDITION_CODE_LockConflict)Ś ReadWriteLockNŚreStructuredTextcCsdt tt d”ƒ”S)Nzopaquelocktoken:é)rŚ to_nativeŚhexŚrandomŚ getrandbits©rrś$/opt/wsgidav/wsgidav/lock_manager.pyŚgenerate_lock_token?srcCs$|st‚t |”}d| d”}|S)Nś/)ŚAssertionErrorrr Śstrip)ŚpathrrrŚnormalize_lock_rootCs rcCs t|dƒ}|dko|t ”kS)NŚexpirer)ŚfloatŚtime)ŚlockrrrrŚis_lock_expiredKs rc Cs‚|sdS|ddkr$d |d”}n"d t |d”|dt ””}d | dd”d d …| d ”| d ”| d ”| d”|”S)zReturn readable rep.z Lock: Nonerrz Infinite ({})z{} (in {} seconds)z-Lock(<{}..>, '{}', {}, {}, depth-{}, until {}Śtokenz??????????????????????????????ééŚrootŚ principalŚscopeŚdepth)ŚformatrŚ get_log_timerŚget)Ś lock_dictrrrrŚ lock_stringPs   ’łr(cCs¾t |d”st‚|d d”s$t‚|ddks4t‚|ddksDt‚|ddksTt‚t |d ”sjt|ƒ‚t|d ƒ}|d ksŽ|d ksŽtd ƒ‚t |d”s t‚d|krŗt |d”sŗt‚dS)Nr rŚtypeŚwriter"©ŚsharedŚ exclusiver#©Ś0ŚinfinityŚownerŚtimeoutré’’’’ztimeout must be positive or -1r!r)rŚ is_nativerŚ startswithŚis_bytesr)rr2rrrŚ validate_lockgs r7c@s¤eZdZdZdZdd„Zdd„Zdd„Zd'd d „Zd d „Z dd„Z d(dd„Z d)dd„Z dd„Z dd„Zdd„Zd*dd„Zdd„Zdd „Zd!d"„Zd#d$„Zd%d&„ZdS)+Ś LockManagerzI Implements locking functionality using a custom storage layer. i€: cCs*t|dƒst‚tƒ|_||_|j ”dS)z@ storage: LockManagerStorage object Ś get_lock_listN)Śhasattrrr Ś_lockŚstorageŚopen)Śselfr<rrrŚ__init__szLockManager.__init__cCs|j ”dS)N)r<Śclose©r>rrrŚ__del__‹szLockManager.__del__cCsd |jj|j”S)Nz{}({!r}))r$Ś __class__Ś__name__r<rArrrŚ__repr__ŽszLockManager.__repr__Śc Csi}i}i}i}t d ||””|jjdddddD]Z}|d}t|ƒ||<| |dg” |”| |dg” |”| |d g” |”q6t d  t|d d d ””|ržt d t|dd d ””t d t|dd d ””t d t|dd d ””dS)Nz{}: {}rTF©Z include_rootZinclude_childrenZ token_onlyrr!r1r z Locks: {}ré’)ŚindentŚwidthzLocks by URL: {}ézLocks by principal: {}zLocks by owner: {}) Ś_loggerŚinfor$r<r9r(Ś setdefaultŚappendr)r>ŚmsgZurlDictZ ownerDictZuserDictZ tokenDictrŚtokrrrŚ_dump‘s6’  ’’’zLockManager._dumpc CsB|dkrtj}n |dkrd}|||||||dœ}|j ||”|S)aåAcquire lock and return lock_dict. principal Name of the principal. lock_type Must be 'write'. lock_scope Must be 'shared' or 'exclusive'. lock_depth Must be '0' or 'infinity'. lock_owner String identifying the owner. path Resource URL. timeout Seconds to live This function does NOT check, if the new lock creates a conflict! Nrr3)r r)r"r#r1r2r!)r8ŚLOCK_TIME_OUT_DEFAULTr<Ścreate) r>r!Ś lock_typeŚ lock_scopeŚ lock_depthŚ lock_ownerrr2r'rrrŚ_generate_lock³sł zLockManager._generate_lockc CsRt|ƒ}|j ”z.| ||||||”| |||||||”W¢S|j ”XdS)zØCheck for permissions and acquire a lock. On success return new lock dictionary. On error raise a DAVError with an embedded DAVErrorCondition. N)rr;Ś acquire_writeŚreleaseŚ_check_lock_permissionrY) r>ŚurlrUrVrWrXr2r!Ś token_listrrrŚacquireŪs* ’’zLockManager.acquireNcCs|dkrtj}|j ||”S)z0Set new timeout for lock, if existing and valid.N)r8rSr<Śrefresh)r>rr2rrrr`ųszLockManager.refreshcCs4|dks t‚|j |”}|dks(|dkr,|S||S)zīReturn lock_dict, or None, if not found or invalid. Side effect: if lock is expired, it will be purged and None is returned. key: name of lock attribute that will be returned instead of a dictionary. ) Nr)r"r#r1r r2r!rN)rr<r&)r>rŚkeyrrrrŚget_lockžs  zLockManager.get_lockcCs|j |”dS)z Delete lock.N)r<Śdelete)r>rrrrr[szLockManager.releasecCs| |d”|kS)zCReturn True, if exists, is valid, and bound to .r!)rb)r>rr!rrrŚis_token_locked_by_usersz#LockManager.is_token_locked_by_usercCs t|ƒ}|jj|dddd}|S)z™Return list of lock_dict, if is protected by at least one direct, valid lock. Side effect: expired locks for this url are purged. TFrG)rr<r9©r>r]ŚlockListrrrŚget_url_lock_lists’zLockManager.get_url_lock_listcCsvt|ƒ}g}|}|rr|jj|dddd}|D]8}||krF|ddkrFq,|dksZ||dkr,| |”q,t |”}q|S)zöReturn a list of valid lockDicts, that protect directly or indirectly. If a principal is given, only locks owned by this principal are returned. Side effect: expired locks for this path and all parents are purged. TFrGr#r0Nr!)rr<r9rOrŚget_uri_parent)r>r]r!rfŚuŚ lock_listrrrrŚget_indirect_url_lock_list)s"’  z&LockManager.get_indirect_url_lock_listcCs| |”}t|ƒdkS)z'Return True, if url is directly locked.r)rgŚlenrerrrŚ is_url_lockedBs zLockManager.is_url_lockedcCs| |d”}|ot ||”S)z?Check, if url (or any of it's parents) is locked by lock_token.r )rbrŚis_equal_or_child_uri)r>r]Ś lock_tokenZlockUrlrrrŚis_url_locked_by_tokenGs z"LockManager.is_url_locked_by_tokencCsB|j ”z&| |”}|D]}| |d”qW5|j ”XdS)Nr)r;rZr[rg)r>r]rfrrrrŚremove_all_locks_from_urlLs   z%LockManager.remove_all_locks_from_urlc Csl|dks t‚|dkst‚|dks$t‚t d ||||””ttƒ}|j ”zņ|}|rÜ|  |”} | D]j} t d |t | ƒ””||kr–| ddkr–qdn| dd kr¬|d kr¬qdt d  t | ƒ””|  | d ”qdt   |”}qR|dkr<|jj|d d d d} | D]<} t  || d ”st‚t d t | ƒ””|  | d ”qžW5|j ”Xt|jƒdkrhtt|d‚dS)auCheck, if can lock , otherwise raise an error. If locking would create a conflict, DAVError(HTTP_LOCKED) is raised. An embedded DAVErrorCondition contains the conflicting resource. @see http://www.webdav.org/specs/rfc4918.html#lock-model - Parent locks WILL NOT be conflicting, if they are depth-0. - Exclusive depth-infinity parent locks WILL be conflicting, even if they are owned by . - Child locks WILL NOT be conflicting, if we request a depth-0 lock. - Exclusive child locks WILL be conflicting, even if they are owned by . (7.7) - It is not enough to check whether a lock is owned by , but also the token must be passed with the request. (Because may run two different applications on his client.) - cannot lock-exclusive, if he holds a parent shared-lock. (This would only make sense, if he was the only shared-lock holder.) - TODO: litmus tries to acquire a shared lock on one resource twice (locks: 27 'double_sharedlock') and fails, when we return HTTP_LOCKED. So we allow multi shared locks on a resource even for the same principal. @param url: URL that shall be locked @param lock_type: "write" @param lock_scope: "shared"|"exclusive" @param lock_depth: "0"|"infinity" @param token_list: list of lock tokens, that the user submitted in If: header @param principal: name of the principal requesting a lock @return: None (or raise) r*r+r.z#checkLockPermission({}, {}, {}, {})z check parent {}, {}r#r0r"r,ś" -> DENIED due to locked parent {}r FTrGś! -> DENIED due to locked child {}r©Ś err_conditionN)rrLŚdebugr$rrr;Ś acquire_readr[rgr(Śadd_hrefrrhr<r9Ś is_child_urirlŚhrefsrr) r>r]rUrVrWr^r!ŚerrcondrirjrŚ child_ocksrrrr\Us^#   ’’  ’ ’  ’ ’  z"LockManager._check_lock_permissionc Cszt |”st‚|dkst‚t d ||||””ttƒ}|j  ”z|}|rč|  |”}t d |””|D]n}t d t |ƒ””||krœ|ddkrœqlql||dkrø|d|krøqlqlt d  t |ƒ””|  |d ”qlt |”}qJ|dkrJ|jj|d d d d } | D]>}t ||d ”s$t‚t d t |ƒ””|  |d ”q W5|j  ”Xt|jƒdkrvtt|d‚dS)aCheck, if can modify , otherwise raise HTTP_LOCKED. If modifying is prevented by a lock, DAVError(HTTP_LOCKED) is raised. An embedded DAVErrorCondition contains the conflicting locks. may be modified by , if it is not currently locked directly or indirectly (i.e. by a locked parent). For depth-infinity operations, also must not have locked children. It is not enough to check whether a lock is owned by , but also the token must be passed with the request. Because may run two different applications. See http://www.webdav.org/specs/rfc4918.html#lock-model http://www.webdav.org/specs/rfc4918.html#rfc.section.7.4 TODO: verify assumptions: - Parent locks WILL NOT be conflicting, if they are depth-0. - Exclusive child locks WILL be conflicting, even if they are owned by . @param url: URL that shall be modified, created, moved, or deleted @param depth: "0"|"infinity" @param token_list: list of lock tokens, that the principal submitted in If: header @param principal: name of the principal requesting a lock @return: None or raise error r.z&check_write_permission({}, {}, {}, {})z checking {}z lock={}r#r0r!rrrr FTrGrsrrtN)rr4rrLrvr$rrr;rwr[rgr(rxrrhr<r9ryrlrzrr) r>r]r#r^r!r{rirjrr|rrrŚcheck_write_permission³s^ ’’  ’’  ’ ’  z"LockManager.check_write_permission)rF)N)N)N)rDŚ __module__Ś __qualname__Ś__doc__rSr?rBrErRrYr_r`rbr[rdrgrkrmrprqr\r}rrrrr8ys&  "(    ^r8)r€ŚpprintrŚwsgidavrrŚwsgidav.dav_errorrrrrZwsgidav.rw_lockr rrŚ __docformat__Śget_module_loggerrDrLrrrr(r7Śobjectr8rrrrŚs!