OwlCyberSecurity - MANAGER
Edit File: idav.pyc
� �t�ac @ sk d Z d d d g Z d d l m Z d e f d � � YZ d e f d � � YZ d e f d � � YZ d S( s web2.dav interfaces. t IDAVResourcet IDAVPrincipalResourcet IDAVPrincipalCollectionResourcei����( t IResourcec B s� e Z d Z d � Z d � Z d � Z d � Z d � Z d � Z d � Z d � Z e d � Z d � Z d � Z d � Z d � Z e e d � Z d � Z d � Z d � Z d � Z d � Z d � Z d � Z d � Z d � Z RS( s WebDAV resource. c C s d S( s� Checks whether this resource is a collection resource. @return: C{True} if this resource is a collection resource, C{False} otherwise. N( ( ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt isCollection& t c C s d S( sh Returns an iterable of child resources for the given depth. Because resources do not know their request URIs, children are returned as tuples C{(resource, uri)}, where C{resource} is the child resource and C{uri} is a URL path relative to this resource. @param depth: the search depth (one of C{"0"}, C{"1"}, or C{"infinity"}) @param request: The current L{IRequest} responsible for this call. @param callback: C{callable} that will be called for each child found @param privileges: the list of L{Privilege}s to test for. This should default to None. @param inherited_aces: a list of L{Privilege}s for aces being inherited from the parent collection used to bypass inheritance lookup. @return: An L{Deferred} that fires when all the children have been found N( ( t deptht requestt callbackt privilegest inherited_aces( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt findChildren- R c C s d S( se Checks whether the given property is defined on this resource. @param property: an empty L{davxml.WebDAVElement} instance or a qname tuple. @param request: the request being processed. @return: a deferred value of C{True} if the given property is set on this resource, or C{False} otherwise. N( ( t propertyR ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt hasProperty= R c C s d S( s� Reads the given property on this resource. @param property: an empty L{davxml.WebDAVElement} class or instance, or a qname tuple. @param request: the request being processed. @return: a deferred L{davxml.WebDAVElement} instance containing the value of the given property. @raise HTTPError: (containing a response with a status code of L{responsecode.CONFLICT}) if C{property} is not set on this resource. N( ( R R ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt readPropertyG R c C s d S( s� Writes the given property on this resource. @param property: a L{davxml.WebDAVElement} instance. @param request: the request being processed. @return: an empty deferred which fires when the operation is completed. @raise HTTPError: (containing a response with a status code of L{responsecode.CONFLICT}) if C{property} is a read-only property. N( ( R R ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt writePropertyT R c C s d S( s� Removes the given property from this resource. @param property: a L{davxml.WebDAVElement} instance or a qname tuple. @param request: the request being processed. @return: an empty deferred which fires when the operation is completed. @raise HTTPError: (containing a response with a status code of L{responsecode.CONFLICT}) if C{property} is a read-only property or if the property does not exist. N( ( R R ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt removeProperty^ R c C s d S( s� @param request: the request being processed. @return: a deferred iterable of qnames for all properties defined for this resource. N( ( R ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt listPropertiesi R c C s d S( s{ @return: an iterable of L{davxml.Report} elements for each report supported by this resource. N( ( ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt supportedReportsp R c C s d S( s� Verify that the given request is authorized to perform actions that require the given privileges. @param request: the request being processed. @param privileges: an iterable of L{davxml.WebDAVElement} elements denoting access control privileges. @param recurse: C{True} if a recursive check on all child resources of this resource should be performed as well, C{False} otherwise. @return: a Deferred which fires with C{None} when authorization is complete, or errbacks with L{HTTPError} (containing a response with a status code of L{responsecode.UNAUTHORIZED}) if not authorized. N( ( R R t recurse( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt authorizev R c C s d S( s� @return: an iterable of L{IDAVPrincipalCollectionResource}s which contain principals used in ACLs for this resource. N( ( ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt principalCollections� R c C s d S( s� Sets the access control list containing the access control list for this resource. @param acl: an L{davxml.ACL} element. N( ( t acl( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt setAccessControlList� R c C s d S( s� @param request: the request being processed. @return: a L{Deferred} with an L{davxml.SupportedPrivilegeSet} result describing the access control privileges which are supported by this resource. N( ( R ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt supportedPrivileges� R c C s d S( s� @param request: the request being processed. @return: a sequence of the access control privileges which are set for the currently authenticated user. N( ( R ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt currentPrivileges� R c C s d S( sH Obtains the access control list for this resource. @param request: the request being processed. @param inheritance: if True, replace inherited privileges with those from the import resource being inherited from, if False just return whatever is set in this ACL. @param expanding: if C{True}, method is called during parent inheritance expansion, if C{False} then not doing parent expansion. @return: a deferred L{davxml.ACL} element containing the access control list for this resource. N( ( R t inheritancet expanding( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt accessControlList� R c C s d S( s� Evaluate the set of privileges that apply to the specified principal. This involves examining all ace's and granting/denying as appropriate for the specified principal's membership of the ace's principal. @param request: the request being processed. @return: a list of L{Privilege}s that are allowed on this resource for the specified principal. N( ( t principalR ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt privilegesForPrincipal� R c C s d S( s3 Get current available & used quota values for this resource's quota root collection. @return: a C{tuple} containing two C{int}'s the first is quota-available-bytes, the second is quota-used-bytes, or C{None} if quota is not defined on the resource. N( ( R ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt quota� R c C s d S( s� Check whether this resource is under quota control by checking each parent to see if it has a quota root. @return: C{True} if under quota control, C{False} if not. N( ( R ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt hasQuota� R c C s d S( s� Determine whether the resource has a quota root. @return: a C{True} if this resource has quota root, C{False} otherwise. N( ( R ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt hasQuotaRoot� R c C s d S( s� Get the quota root (max. allowed bytes) value for this collection. @return: a C{int} containing the maximum allowed bytes if this collection is quota-controlled, or C{None} if not quota controlled. N( ( R ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt quotaRoot� R c C s d S( s� Set the quota root (max. allowed bytes) value for this collection. @param maxsize: a C{int} containing the maximum allowed bytes for the contents of this collection. N( ( R t maxsize( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt setQuotaRoot� R c C s d S( s� Get the size of this resource (if its a collection get total for all children as well). TODO: Take into account size of dead-properties. @return: a L{Deferred} with a C{int} result containing the size of the resource. N( ( R ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt quotaSize� R c C s d S( s1 Get the cached quota use value, or if not present (or invalid) determine quota use by brute force. @return: an L{Deferred} with a C{int} result containing the current used byte count if this collection is quota-controlled, or C{None} if not quota controlled. N( ( R ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt currentQuotaUse� R c C s d S( s� Adjust current quota use on this all all parent collections that also have quota roots. @param adjust: a C{int} containing the number of bytes added (positive) or removed (negative) that should be used to adjust the cached total. @return: an L{Deferred} with a C{int} result containing the current used byte if this collection is quota-controlled, or C{None} if not quota controlled. N( ( R t adjust( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt updateQuotaUse� R ( t __name__t __module__t __doc__R R R R R R R R t FalseR R R R R t TrueR R R R R! R" R$ R% R& R( ( ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyR " s0 c B sD e Z d Z d � Z d � Z d � Z d � Z d � Z d � Z RS( s; WebDAV principal resource. (RFC 3744, section 2) c C s d S( s� Provides the URIs of network resources with additional descriptive information about the principal, for example, a URI to an LDAP record. (RFC 3744, section 4.1) @return: a iterable of URIs. N( ( ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt alternateURIs R c C s d S( s� Provides the URL which must be used to identify this principal in ACL requests. (RFC 3744, section 4.2) @return: a URL. N( ( ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt principalURL R c C s d S( s� Provides the XML element which must be used to identify this principal in ACL requests. (RFC 3744, section 4.2) @return: L{element.Principal}. N( ( ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt principalElement R c C s d S( s� Provides the principal URLs of principals that are direct members of this (group) principal. (RFC 3744, section 4.3) @return: a deferred returning an iterable of principal URLs. N( ( ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt groupMembers R c C s d S( s Provides the principal URLs of principals that are members of this (group) principal, as well as members of any group principal which are members of this one. @return: a L{Deferred} that fires with an iterable of principal URLs. N( ( ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt expandedGroupMembers' R c C s d S( s� Provides the URLs of the group principals in which the principal is directly a member. (RFC 3744, section 4.4) @return: a deferred containing an iterable of group principal URLs. N( ( ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt groupMemberships0 R ( R) R* R+ R. R/ R0 R1 R2 R3 ( ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyR s c B s e Z d Z d � Z d � Z RS( sH WebDAV principal collection resource. (RFC 3744, section 5.8) c C s d S( s� Provides a URL for this resource which may be used to identify this resource in ACL requests. (RFC 3744, section 5.8) @return: a URL. N( ( ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt principalCollectionURL= R c C s d S( s Retrieve the principal for a given username. @param user: the (short) name of a user. @type user: C{str} @return: the resource representing the DAV principal resource for the given username. @rtype: L{IDAVPrincipalResource} N( ( t user( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt principalForUserD R ( R) R* R+ R4 R6 ( ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyR 8 s N( R+ t __all__t txweb2.iwebR R R R ( ( ( s" /opt/cpanel-ccs/txweb2/dav/idav.pyt <module> s �3