## CalDAVRequest

Description

A class for collecting things to do with this request.

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

Variable Summary
mixed $collection_id
mixed $collection_path
mixed $collection_type
mixed $current_user_principal_xml
mixed $depth
mixed $method
mixed $options
CalDAVPrincipal $principal
mixed $raw_post
mixed $supported_privileges
mixed $user_agent
Method Summary
CalDAVRequest CalDAVRequest ([ $options = array()])
void AllowedTo (string $activity)
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 IsCalendar ()
void IsCollection ()
void IsInfiniteDepth ()
void IsLocked ()
void IsPrincipal ()
void IsProxyRequest ()
void IsPublic ()
void RenderPrivileges ( $privilege_names)
void RenderSupportedPrivileges ([ $privs = null])
void ServerProperty ( $tag, $prop, [ $reply = null])
void setPermissions (int $user_no)
array SupportedPrivileges ()
void UnsupportedRequest (array $unsupported)
void UserFromPath ()
void ValidateLockToken (string $lock_token)
void XMLResponse (int $status, XMLElement $xmltree)
Variables
mixed $collection_id (line 67)

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

mixed $collection_path (line 72)

The path corresponding to the collection_id

mixed $collection_type (line 78)

The type of collection being requested:

calendar, schedule-inbox, schedule-outbox

mixed $current_user_principal_xml (line 57)

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

mixed $depth (line 45)

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 $method (line 39)

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

mixed $options (line 29)
CalDAVPrincipal $principal (line 51)

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

mixed $raw_post (line 34)

The raw data sent along with the request

mixed $supported_privileges (line 83)

A static structure of supported privileges.

mixed $user_agent (line 62)

The user agent making the request.

Methods
Constructor CalDAVRequest (line 88)

Create a new CalDAVRequest object.

CalDAVRequest CalDAVRequest ([ $options = array()])

- $options

AllowedTo (line 867)

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.

DepthRegexTail (line 586)

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

void DepthRegexTail ()
DoResponse (line 966)

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 668)

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 577)

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

void GetDepthName ()
GetLockDetails (line 654)

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 597)

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

IsCalendar (line 714)

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

void IsCalendar ()
IsCollection (line 703)

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

void IsCollection ()
IsInfiniteDepth (line 745)

Returns true if the request asked for infinite depth

void IsInfiniteDepth ()
IsLocked (line 534)

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 723)

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

void IsPrincipal ()
IsProxyRequest (line 734)

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

void IsProxyRequest ()
IsPublic (line 566)

Checks whether the collection is public

void IsPublic ()
RenderPrivileges (line 782)

Returns the array of privilege names converted into XMLElements

void RenderPrivileges ( $privilege_names)

- $privilege_names

RenderSupportedPrivileges (line 753)

Returns the array of supported privileges converted into XMLElements

void RenderSupportedPrivileges ([ $privs = null])

- $privs

ServerProperty (line 798)

Return general server-related properties for this URL

void ServerProperty ( $tag, $prop, [ $reply = null])

- $tag
- $prop
- $reply

setPermissions (line 448)

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

SupportedPrivileges (line 1003)

Return an array of what the DAV privileges are that are supported

- return: The supported privileges.

array SupportedPrivileges ()
UnsupportedRequest (line 931)

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.

UserFromPath (line 404)

Work out the user whose calendar we are accessing, based on elements of the path.

void UserFromPath ()
ValidateLockToken (line 623)

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 951)

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 Sat, 24 Oct 2009 12:40:39 +1300 by phpDocumentor 1.3.2