Class CalDAVRequest

Description

A class for collecting things to do with this request.

Located in /inc/CalDAVRequest.php (line 29)


	
			
Variable Summary
Method Summary
 CalDAVRequest __construct ([ $options = array()])
 void AllowedTo (string $activity)
 void BuildSupportedPrivileges ( &$reply, [ $privs = null])
 void CollectionId ()
 void dav_name ()
 void DepthRegexTail ()
 void DoResponse (int $status, [string $message = ""], [ $content_type = "text/plain; charset=\"utf-8\""])
 mixed FailIfLocked ()
 void GetDepthName ()
 void GetLockDetails (string $lock_token)
 void GetLockRow ( $lock_token, string $dav_name)
 void HavePrivilegeTo ( $do_what)
 void IsAddressBook ()
 void IsCalendar ()
 void IsCollection ()
 void IsInfiniteDepth ()
 void IsLocked ()
 void IsPrincipal ()
 void IsProxyRequest ()
 void IsPublic ()
 void MalformedRequest ([string $text = 'Bad request'])
 void NeedPrivilege ( $privileges, [string $href = null], string $privilege)
 void PreconditionFailed (int $status, string $precondition, [string $explanation = ''], [ $xmlns = 'DAV:'])
 void Privileges ()
 void setPermissions (int $user_no)
 void UnsupportedRequest (array $unsupported)
 void ValidateLockToken (string $lock_token)
 void XMLResponse (int $status, XMLElement $xmltree)
Variables
mixed $collection_id (line 69)

The ID of the collection containing this path, or of this path if it is a collection

mixed $collection_path (line 74)

The path corresponding to the collection_id

mixed $collection_type (line 80)

The type of collection being requested:

calendar, schedule-inbox, schedule-outbox

mixed $current_user_principal_xml (line 59)

The 'current_user_principal_xml' the DAV:current-user-principal answer. An XMLElement object with an <href> or <unauthenticated> fragment.

mixed $depth (line 47)

The depth parameter from the request headers, coerced into a valid integer: 0, 1 or DEPTH_INFINITY which is defined above. The default is set per various RFCs.

mixed $destination (line 91)

The value of any 'Destionation:' header, if present.

mixed $exists (line 86)

The type of collection being requested:

calendar, schedule-inbox, schedule-outbox

  • access: protected
mixed $method (line 41)

The HTTP request method: PROPFIND, LOCK, REPORT, OPTIONS, etc...

mixed $options (line 31)
DAVPrincipal $principal (line 53)

The 'principal' (user/resource/...) which this request seeks to access

mixed $privileges (line 96)

The decimal privileges allowed by this user to the identified resource.

  • access: protected
mixed $raw_post (line 36)

The raw data sent along with the request

mixed $supported_privileges (line 101)

A static structure of supported privileges.

mixed $ticket (line 106)

A DAVTicket object, if there is a ?ticket=id or Ticket: id with this request

  • access: public
mixed $user_agent (line 64)

The user agent making the request.

Methods
Constructor __construct (line 111)

Create a new CalDAVRequest object.

CalDAVRequest __construct ([ $options = array()])
  • $options
AllowedTo (line 1002)

Are we allowed to do the requested activity

+------------+------------------------------------------------------+ | METHOD | PRIVILEGES | +------------+------------------------------------------------------+ | MKCALENDAR | DAV:bind | | REPORT | DAV:read or CALDAV:read-free-busy (on all referenced | | | resources) | +------------+------------------------------------------------------+

void AllowedTo (string $activity)
  • string $activity: The activity we want to do.
BuildSupportedPrivileges (line 964)

Returns the array of supported privileges converted into XMLElements

void BuildSupportedPrivileges ( &$reply, [ $privs = null])
  • &$reply
  • $privs
CoerceContentType (line 856)

Coerces the Content-type of the request into something valid/appropriate

void CoerceContentType ()
CollectionId (line 956)

Returns the ID of the collection of, or containing this request

void CollectionId ()
dav_name (line 722)

Returns the dav_name of the resource in our internal namespace

void dav_name ()
DepthRegexTail (line 740)

Returns the tail of a Regex appropriate for this Depth, when appended to

void DepthRegexTail ()
DoResponse (line 1179)

Utility function we call when we have a simple status-based response to return to the client. Possibly

void DoResponse (int $status, [string $message = ""], [ $content_type = "text/plain; charset=\"utf-8\""])
  • int $status: The HTTP status code to send.
  • string $message: The friendly text message to send with the response.
  • $content_type
FailIfLocked (line 821)

This will either (a) return false if no locks apply, or (b) return the lock_token which the request successfully included to open the lock, or: (c) respond directly to the client with the failure.

  • return: false (no lock) or opaquelocktoken (opened lock)
mixed FailIfLocked ()
GetDepthName (line 731)

Returns the name for this depth: 0, 1, infinity

void GetDepthName ()
GetLockDetails (line 807)

Returns the DB object associated with a lock token, or false.

void GetLockDetails (string $lock_token)
  • string $lock_token: The opaquelocktoken which we are looking for
GetLockRow (line 751)

Returns the locked row, either from the cache or from the database

void GetLockRow ( $lock_token, string $dav_name)
  • string $dav_name: The resource which we want to know the lock status for
  • $lock_token
HavePrivilegeTo (line 1075)

Is the user has the privileges to do what is requested.

void HavePrivilegeTo ( $do_what)
  • $do_what
IsAddressBook (line 917)

Returns true if the URL referenced by this request points at an addressbook collection.

void IsAddressBook ()
IsCalendar (line 908)

Returns true if the URL referenced by this request points at a calendar collection.

void IsCalendar ()
IsCollection (line 897)

Returns true if the URL referenced by this request points at a collection.

void IsCollection ()
IsInfiniteDepth (line 948)

Returns true if the request asked for infinite depth

void IsInfiniteDepth ()
IsLocked (line 643)

Checks whether the resource is locked, returning any lock token, or false

  • todo: This logic does not catch all locking scenarios. For example an infinite depth request should check the permissions for all collections and resources within that. At present we only maintain permissions on a per-collection basis though.
void IsLocked ()
IsPrincipal (line 926)

Returns true if the URL referenced by this request points at a principal.

void IsPrincipal ()
IsProxyRequest (line 937)

Returns true if the URL referenced by this request is within a proxy URL

void IsProxyRequest ()
IsPublic (line 680)

Checks whether the collection is public

void IsPublic ()
MalformedRequest (line 1152)

Send a simple error informing the client that was a malformed request

void MalformedRequest ([string $text = 'Bad request'])
  • string $text: An optional text description of the failure.
NeedPrivilege (line 1111)

Send a need-privileges error response. This function will only return if the $href is not supplied and the current user has the specified permission for the request path.

void NeedPrivilege ( $privileges, [string $href = null], string $privilege)
  • string $privilege: The name of the needed privilege.
  • string $href: The unconstructed URI where we needed the privilege.
  • $privileges
PreconditionFailed (line 1136)

Send an error response for a failed precondition.

void PreconditionFailed (int $status, string $precondition, [string $explanation = ''], [ $xmlns = 'DAV:'])
  • int $status: The status code for the failed precondition. Normally 403
  • string $precondition: The namespaced precondition tag.
  • string $explanation: An optional text explanation for the failure.
  • $xmlns
Privileges (line 1067)

Return the privileges bits for the current session user to this resource

void Privileges ()
setPermissions (line 575)

Permissions are controlled as follows:

  1. if the path is '/', the request has read privileges
  2. if the requester is an admin, the request has read/write priviliges
  3. if there is a <user name> component which matches the logged on user then the request has read/write privileges
  4. otherwise we query the defined relationships between users and use the minimum privileges returned from that analysis.

void setPermissions (int $user_no)
  • int $user_no: The current user number
UnsupportedRequest (line 1088)

Sometimes it's a perfectly formed request, but we just don't do that :-(

void UnsupportedRequest (array $unsupported)
  • array $unsupported: An array of the properties we don't support.
ValidateLockToken (line 776)

Checks to see whether the lock token given matches one of the ones handed in with the request.

void ValidateLockToken (string $lock_token)
  • string $lock_token: The opaquelocktoken which we are looking for
XMLResponse (line 1164)

Send an XML Response. This function will never return.

void XMLResponse (int $status, XMLElement $xmltree)
  • int $status: The HTTP status to respond
  • XMLElement $xmltree: An XMLElement tree to be rendered

Documentation generated on Fri, 13 Jan 2012 23:44:53 +1300 by phpDocumentor 1.4.3