OwlCyberSecurity - MANAGER
Edit File: cache.pyc
� �t�ac @ s� d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z m Z m Z d d l m Z d d l m Z m Z d d l m Z m Z d d l m Z d d l Z d d l Z d d l Z d d l Z d e f d � � YZ d e f d � � YZ d e f d � � YZ d e f d � � YZ! d e f d � � YZ" d e f d � � YZ# d e# e f d � � YZ$ d e f d � � YZ% d e f d � � YZ& d e f d � � YZ' d e f d! � � YZ( d S(" i����( t Logger( t allDataFromStream( t Response( t IResource( t MemoryStream( t succeedt inlineCallbackst returnValue( t config( t CachePoolUserMixInt defaultCachePool( t IStoreNotifierFactoryt IStoreNotifier( t implementsNt DisabledCacheNotifierc B s e Z d � Z d d � Z RS( c O s d S( N( ( t selft argst kwargs( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt __init__K s c C s t d � S( N( R t None( R t url( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt changedN s N( t __name__t __module__R R R ( ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR I s t DisabledCachec B s e Z d � Z d � Z RS( c C s t d � S( N( R R ( R t request( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt getResponseForRequestT s c C s t | � S( N( R ( R R t response( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt cacheResponseForRequestW s ( R R R R ( ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR R s t URINotFoundExceptionc B s e Z d � Z d � Z RS( c C s | | _ d S( N( t uri( R R ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR ] s c C s d | j j | j f S( Ns %s: Could not find URI %r( t __class__R R ( R ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt __repr__` s ( R R R R ( ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR [ s t MemcacheChangeNotifierc B s; e Z d Z e � Z d d d � Z d � Z d d � Z RS( sB A change notifier used by resources (not store objects). t Defaultc C s | | _ | | _ | | _ d S( N( t _resourcet _cachePoolt _cachePoolHandle( R t resourcet cachePoolt cacheHandle( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR l s c C s t t j � � S( N( t strt uuidt uuid4( R ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt _newCacheTokenq s c C sd | d k r | j j � } n | j j d d | �| j � j d | f | j � d t j d �S( s Change the cache token for a resource @param url: the url whose token is being changed, or C{None} to determine the URL from the supplied resource @type: L{str} return: A L{Deferred} that fires when the token has been changed. s Changing Cache Token for {url}R s cacheToken:%st expireTimei< N( R R# R t logt debugt getCachePoolt setR, R t ResponseCacheTimeout( R R ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR t s N( R R t __doc__R R. R R R, R ( ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR! f s t MemcacheURLPatternChangeNotifierc B s8 e Z d Z e � Z d d d � Z d � Z d � Z RS( s< A change notifier used to target arbitrary tokens. R" c C s | | _ | | _ | | _ d S( N( t _urlPatternR$ R% ( R t urlPatternR' R( ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR � s c C s t t j � � S( N( R) R* R+ ( R ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR, � s c C s` | j j d | � } | j j d d | �| j � j d j d | � | j � d t j d �S( s� Change the cache token for a resource return: A L{Deferred} that fires when the token has been changed. t tokens Changing Cache Token for {url}R s cacheToken:{url}R- i< ( R5 t formatR. R/ R0 R1 R, R R2 ( R R7 R ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR � s N( R R R3 R R. R R R, R ( ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR4 � s t BaseResponseCachec B sb e Z d Z e � Z d � Z d � Z d � Z e d � � Z d � Z e d � � Z d � Z RS( s< A base class which provides some common operations c C s | d k r | j � Sd S( Nt unauthenticated( R t principalURL( R t principal( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt _principalURI� s c C s | j t � t | � � d S( N( t trapt AttributeErrorR ( R t fR ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt _uriNotFound� s c C sV d � } y) | j | � j | � j | j | � SWn t k rQ t | � � n Xd S( sN Return the directory record for the specified principal uri. c S s t | d � r | j Sd S( Nt record( t hasattrRB ( t resrc( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt _getRecord� s N( t locateResourcet addCallbackt addErrbackRA t AssertionErrorR ( R R R RE ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt _getRecordForURI� s c c s | j d � } t | � d k r� | d d k r� | d d k rN t | � q� | d } | d } | j j j � } | j | j | � | � V} | d k r� d | d <| j j d � | d <t d j | � � q� n y$ | j | � V} t | j � � Wn t k rt | � � n Xd S( s� Always use canonicalized forms of the URIs for caching (i.e. __uids__ paths). Do this without calling locateResource which may cause a query on the store. t /i t principalst calendarst addressbooksi t __uids__i s utf-8N( RL RM RN ( t splitt lenR t siteR& t getDirectoryt recordWithShortNamet oldNameToRecordTypeR t uidt encodet joinRF R RI R ( R R R t uribitst recordTypet recordNamet directoryRB RD ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt _canonicalizeURIForRequest� s& " c s8 � � f d � } � j � j � � } | j | � | S( sC Get principal and resource URIs from the request. c s. � j � j � j � � � j � f d � � S( Nc s | � f S( N( ( t pURI( t rURI( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt <lambda>� t ( R] R= t authnUserRG ( R_ ( R R ( R_ s& /opt/cpanel-ccs/twistedcaldav/cache.pyt _getSecondURI� s ( R] R RG ( R R Rc t d( ( R R s& /opt/cpanel-ccs/twistedcaldav/cache.pyt _getURIs� s c c s� t | j � V} | d k r_ t | � | _ d | j _ | j � } | j � d j | � } n | j | j | j � | j | j j d � t | � f | _ t | j � d S( s� Get a key for this request. This depends on the method, Depth: header, authn user principal, request uri and a hash of the request body (the body being normalized for property order). s t depthN( R t streamR R t doStartReadingt splitlinest sortRX t methodR= Rb R t headerst getHeadert hasht cacheKeyR ( R R t requestBodyt requestLines( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt _requestKey� s c s) t | j � } | j � f d � � | S( Nc s � | f S( N( ( t responseBody( t key( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR` Ra ( R Rg RG ( R Rt R t d1( ( Rt s& /opt/cpanel-ccs/twistedcaldav/cache.pyt _getResponseBody s ( R R R3 R R. R= RA RJ R R] Re Rr Rv ( ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR9 � s t MemcacheResponseCachec B s� e Z d d � Z e d d � � Z e d � � Z e d � � Z e d � � Z e d � � Z e d � � Z e d � � Z RS( c C s | | _ | | _ d S( N( t _docrootR$ ( R t docrootR' ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR s c c s� t | t � r! | j d � } n | rG t | � j d | f � V} n | j � j d | f � V} | d k r | \ } } n t | � d S( s= Get the current token for a particular URI. s utf-8s cacheToken:%sN( t isinstancet unicodeRW R t getR0 R R ( R R t cachePoolHandlet resultt _ignore_flags( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt _tokenForURI s c c s' | j | | � V} t | j � � d S( sZ Get the current token for a particular principal URI's directory record. N( RJ R t cacheToken( R R R RB ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt _tokenForRecord% s c c s\ t | d � rN t g | j D] } | | j | � Vf ^ q � } t | � n t i � d S( s� Create a dict of child resource tokens for any "recorded" during this request in the childCacheURIs attribute. t childCacheURIsN( RC t dictR� R� R ( R R_ R R t tokens( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt _tokensForChildren. s 2 c c s� g } | j | � V\ } } | j | j | d � V� | j | j | | � V� | j | j | � V� | j | j | | � V� t | � d S( s� Tokens are a principal token, directory record token, resource token and list of child resource tokens. A change to any one of those will cause cache invalidation. t PrincipalTokenN( Re t appendR� R� R� R ( R R R� R^ R_ ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt _getTokens: s c c s{ | j | � V} t j d j g | D] } t | � ^ q# � � j � | _ } | j j d d | d | �t | j � d S( s� Make a key for a response cache entry. This depends on various request parameters (see _requestKey for details). t :s' hashing key for get: {old!r} to {new!r}t oldt newN( Rr t hashlibt md5RX R) t hexdigestRo R. R/ R ( R R t oldkeyt tRt ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt _hashedRequestKeyH s 8 c c s� yy| j | � V} | j j d d | �| j � j | � V\ } } | d k rt | j j d d | �t d � n t j | � \ } } } } \ } } } | j j d d | d | | | | f �| j | � V} | d | k r| j j d d | j d | d d | �t d � n | d | k r_| j j d d | j d | d d | �t d � n | d | k r�| j j d d | j d | d d | �t d � n xn | j � D]` \ } } | j | � V} | | k r�| j j d d | d | j d | d | �t d � q�q�W| j j d � t | d t | � �} x- | j � D] \ } } | j j | | � qKWt | � Wn3 t k r�} | j j d d | �t d � n Xd S( s9 Try to match a request and a response cache entry. We first get the request key and match that, then pull the cache entry and decompose it into tokens and response. We then compare the cached tokens with their current values. If all match, we can return the cached response data. s Checking cache for: {key!r}Rt s Not in cache: {key!r}s# Found in cache: {key!r} = {value!r}t valuei sQ Principal token doesn't match for {key!r}: {currentToken!r} != {principalToken!r}t currentTokent principalTokeni sX Directory Record Token doesn't match for {key!r}: {currentToken!r} != {directoryToken!r}t directoryTokeni sE URI token doesn't match for {key!r}: {currentToken!r} != {uriToken!r}t uriTokensJ Child {uri} token doesn't match for {key!r}: {currentToken!r} != {token!r}R R7 s Response cache matchedRg s Could not locate URI: {e!r}t eN( R� R. R/ R0 R| R R t cPicklet loadsR� Ro t itemsR� R R t iteritemsRl t setRawHeadersR ( R R Rt R R� R� R� R� t childTokenst codeRl t bodyt currentTokenst childuriR7 R� t rR� ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR T sn ' c c sH yt | d � r | j } n | j | � V} | j | | � V\ } } | j j d � t | � | _ | j | � V\ } } } } t j | | | | | j t t | j j � � � | f f � } | j j d d | d | | | | f �| j � j | | d t j d �VWn) t k r9} | j j d d | �n Xt | � d S( sG Given a request and its response, make a response cache entry that encodes the response and various cache tokens. Later, when getResponseForRequest is called we retrieve this entry and compare the old cache tokens with the current ones. If any have changed the response cache entry is removed. Ro t dates. Adding to cache: {key!r} = tokens - {tokens!r}Rt R� R- i< s Could not locate URI: {e!r}R� N( RC Ro R� Rv Rl t removeHeaderR Rg R� R� t dumpsR� R� t listt getAllRawHeadersR. R/ R0 R1 R R2 R R ( R R R Rt Rs t pTokent dTokent uTokent cTokenst cacheEntryR� ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR � s8 N( R R R R R R� R� R� R� R� R R ( ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyRw s Rt _CachedResponseResourcec B s- e Z e e � d � Z d � Z d � Z RS( c C s | | _ d S( N( t _response( R R ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR � s c C s/ t | d � s i | _ n d | j d <| j S( Nt extendedLogItemst 1t cached( RC R� R� ( R R ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt renderHTTP� s c C s | g f S( N( ( R R t segments( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt locateChild� s ( R R R R R R� R� ( ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR� � s t PropfindCacheMixinc B s e Z d Z e d � � Z RS( s� A mixin that causes a resource's PROPFIND response to be cached. It also adds an api to change the resource's uriToken - this must be used whenever something changes to cause the cache to be invalidated. c c so t t | � j | � V} | j d k ra | j d � V} t | d � ra | j j | | � Vqa n t | � d S( Nt PROPFINDRK t responseCache( t superR� R� Rk RF RC R� R R ( R R R R& ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR� � s ( R R R3 R R� ( ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR� � s t CacheStoreNotifierFactoryc B s< e Z d Z e � Z e e � d � Z d � Z d � Z RS( su A notifier factory specifically for store object notifications. This is handed of to the data store object, which calls .newNotifier() each time a home object is created and gives the new notifier to the home. That object is also inherited by home child objects created from the home. This object uses a memcachepool for setting new cache tokens. c C s t | | � S( N( t CacheStoreNotifier( R t storeObject( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt newNotifier s c C s t t j � � S( N( R) R* R+ ( R ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR, s c C sF | j j d d | �| j � j d | f | j � d t j d �S( s� Change the cache token for a store object. return: A L{Deferred} that fires when the token has been changed. s Changing Cache Token for {id!r}t ids cacheToken:%sR- i< ( R. R/ R0 R1 R, R R2 ( R t cache_id( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR s ( R R R3 R R. R R R� R, R ( ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR� � s R� c B s9 e Z d Z e e � d � Z e d � � Z d � Z RS( s[ A notifier for store objects. Store objects will call .notify() when they change. c C s | | _ | | _ d S( N( t _notifierFactoryt _storeObject( R t notifierFactoryR� ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR # s c c s� | j j � \ } } | d k r1 d | f } n | d k rM d | f } n t j | � f } d | k r� | j d � d } | d k r� d | f } n | d k r� d | f } n | t j | � f 7} n x | D] } | j j | � Vq� Wd S( s We need to convert the store object notifier ID into a URI, since the cache uses URIs. Note that for a home child resource we also need to change the token for the home as the sync token on the home changes implicitly without a direct notification. t CalDAVs /calendars/__uids__/%s/t CardDAVs /addressbooks/__uids__/%s/RK i N( R� t notifierIDt urllibt quoteRP R� R ( R t prefixR� R t uris( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt notify' s c C s | j | j | � S( N( R R� ( R R� ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt cloneB s ( R R R3 R R R R R� R� ( ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyR� s () t twext.python.logR t txweb2.dav.utilR t txweb2.httpR t txweb2.iwebR t txweb2.streamR t twisted.internet.deferR R R t twistedcaldav.configR t twistedcaldav.memcachepoolR R t txdav.idavR R t zope.interfaceR R� R� R� R* t objectR R t ExceptionR R! R4 R9 Rw R� R� R� R� ( ( ( s& /opt/cpanel-ccs/twistedcaldav/cache.pyt <module> s0 & # h�