Full index

Package indexes


a b c d e f g h i l m o p r s t u v w x _
a
top
Method AddDays
iCalDate::AddDays() in RRule.php
Add some integer number of days to a date
Method AddDuration
Add duration
Method AddMonths
Add some number of months to a date
Function add_arbitrary_properties
add_arbitrary_properties() in caldav-PROPFIND.php
Adds any arbitrary properties that were requested by the PROPFIND into the response.
Function add_general_properties
add_general_properties() in caldav-PROPFIND.php
Handles any properties related to the DAV::PRINCIPAL in the request
Function add_principal_properties
add_principal_properties() in caldav-PROPFIND.php
Handles any properties related to the DAV::PRINCIPAL in the request
Method AllowedTo
RSCDSUser::AllowedTo() in RSCDSUser.php
Extend parent definition of what the current user is allowed to do
Method AllowedTo
HTTPAuthSession::AllowedTo() in HTTPAuthSession.php
Checks whether a user is allowed to do something.
Method AllowedTo
CalDAVRequest::AllowedTo() in CalDAVRequest.php
Are we allowed to do the requested activity
Method ApplyBySetPos
Given set position descriptions like '1', '3', '11', '-3' or '-1' and a set, return the subset matching the list of set positions.
Function apply_filter
apply_filter() in caldav-REPORT-calquery.php
While we can construct our SQL to apply some filters in the query, other filters need to be checked against the retrieved record. This is for handling those ones.
Method AssignSessionDetails
Internal function used to assign the session details to a user's new session.
Method AssignSessionDetails
Internal function used to assign the session details to a user's new session.
Function AuthExternalAWL
AuthExternalAWL() in auth-functions.php
Authenticate against a different PostgreSQL database which contains a usr table in the AWL format.
Method AuthFailedResponse
Authorisation failed, so we send some headers to say so.
Page always.php
always.php in always.php
Page auth-functions.php
auth-functions.php in auth-functions.php
b
top
Variable $base_url
CalDAVClient::$base_url in caldav-client.php
Server, username, password, calendar, $entry
Variable $body
CalDAVClient::$body in caldav-client.php
Variable $by_email
CalDAVPrincipal::$by_email in CalDAVPrincipal.php
Method BasicAuthSession
Handle Basic HTTP Authentication (not secure unless https)
Function BuildSqlFilter
BuildSqlFilter() in caldav-REPORT-calquery.php
Build an SQL 'WHERE' clause which implements (parts of) the filter. The elements of the filter which are implemented in the SQL will be removed.
Function build_propstat_response
build_propstat_response() in caldav-PROPFIND.php
Build the <propstat><prop></prop><status></status></propstat> part of the response
c
top
Variable $calendar
CalDAVClient::$calendar in caldav-client.php
Variable $calendar_home_set
Variable $collection_id
CalDAVRequest::$collection_id in CalDAVRequest.php
The ID of the collection containing this path, or of this path if it is a collection
Variable $collection_path
CalDAVRequest::$collection_path in CalDAVRequest.php
The path corresponding to the collection_id
Variable $collection_type
CalDAVRequest::$collection_type in CalDAVRequest.php
The type of collection being requested:
Variable $curl
CalDAVClient::$curl in caldav-client.php
Our cURL connection
Variable $current_user_principal_xml
The 'current_user_principal_xml' the DAV:current-user-principal answer. An XMLElement object with an <href> or <unauthenticated> fragment.
Method CalDAVClient
CalDAVClient::CalDAVClient() in caldav-client.php
Constructor, initialises the class
Class CalDAVClient
CalDAVClient in caldav-client.php
A class for accessing DAViCal via CalDAV, as a client
Class CalDAVPrincipal
CalDAVPrincipal in CalDAVPrincipal.php
A class for things to do with a DAV Principal
Method CalDAVPrincipal
CalDAVPrincipal::CalDAVPrincipal() in CalDAVPrincipal.php
Constructor
Class CalDAVRequest
CalDAVRequest in CalDAVRequest.php
A class for collecting things to do with this request.
Method CalDAVRequest
CalDAVRequest::CalDAVRequest() in CalDAVRequest.php
Create a new CalDAVRequest object.
Function calendar_to_xml
calendar_to_xml() in caldav-REPORT.php
Return XML for a single calendar (or todo) entry from the DB
Method CheckPassword
HTTPAuthSession::CheckPassword() in HTTPAuthSession.php
CheckPassword does all of the password checking and returns a user record object, or false if it all ends in tears.
Function check_string
check_string() in check_UTF8.php
Function collection_to_xml
collection_to_xml() in caldav-PROPFIND.php
Returns an XML sub-tree for a single collection record from the DB
Function ConstructURL
ConstructURL() in always.php
Construct a URL from the supplied dav_name
Function controlRequestContainer
controlRequestContainer() in caldav-PUT-functions.php
Work out the location we are doing the PUT to, and check that we have the rights to do the needful.
Function CreateDefaultRelationships
CreateDefaultRelationships() in auth-functions.php
Create default relationships
Function CreateHomeCalendar
CreateHomeCalendar() in auth-functions.php
Create a default home calendar for the user.
Function create_scheduling_requests
create_scheduling_requests() in caldav-PUT-functions.php
Create scheduling requests in the schedule inbox for the
Page caldav.php
caldav.php in caldav.php
Page collection.php
collection.php in collection.php
Page caldav-client.php
caldav-client.php in caldav-client.php
Page caldav-DELETE.php
caldav-DELETE.php in caldav-DELETE.php
Page caldav-GET.php
caldav-GET.php in caldav-GET.php
Page caldav-LOCK.php
caldav-LOCK.php in caldav-LOCK.php
Page caldav-MKCALENDAR.php
caldav-MKCALENDAR.php in caldav-MKCALENDAR.php
Page caldav-OPTIONS.php
caldav-OPTIONS.php in caldav-OPTIONS.php
Page caldav-POST.php
caldav-POST.php in caldav-POST.php
Page caldav-PROPFIND.php
caldav-PROPFIND.php in caldav-PROPFIND.php
Page caldav-PROPPATCH.php
caldav-PROPPATCH.php in caldav-PROPPATCH.php
Page caldav-PUT-functions.php
caldav-PUT-functions.php in caldav-PUT-functions.php
Page caldav-PUT.php
caldav-PUT.php in caldav-PUT.php
Page caldav-REPORT-calquery.php
caldav-REPORT-calquery.php in caldav-REPORT-calquery.php
Page caldav-REPORT-freebusy.php
caldav-REPORT-freebusy.php in caldav-REPORT-freebusy.php
Page caldav-REPORT-multiget.php
caldav-REPORT-multiget.php in caldav-REPORT-multiget.php
Page caldav-REPORT-principal.php
caldav-REPORT-principal.php in caldav-REPORT-principal.php
Page caldav-REPORT.php
caldav-REPORT.php in caldav-REPORT.php
Page CalDAVPrincipal.php
CalDAVPrincipal.php in CalDAVPrincipal.php
Page CalDAVRequest.php
CalDAVRequest.php in CalDAVRequest.php
Page check_UTF8.php
check_UTF8.php in check_UTF8.php
d
top
Variable $delete_collection_confirmation_required
Variable $depth
CalDAVRequest::$depth in CalDAVRequest.php
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.
Variable $description
RRuleTest::$description in test-RRULE.php
Variable $dtstart
RRuleTest::$dtstart in test-RRULE.php
Method DateDifference
Produce an iCalendar format DURATION for the difference between this an another iCalDate
Method DaysInMonth
No of days in a month 1(Jan) - 12(Dec)
Method DepthRegexTail
CalDAVRequest::DepthRegexTail() in CalDAVRequest.php
Returns the tail of a Regex appropriate for this Depth, when appended to
Constant DEPTH_INFINITY
DEPTH_INFINITY in CalDAVRequest.php
Method DigestAuthSession
Handle Digest HTTP Authentication (no passwords were harmed in this transaction!)
Method DoCalendarQuery
CalDAVClient::DoCalendarQuery() in caldav-client.php
Given XML for a calendar query, return an array of the events (/todos) in the response. Each event in the array will have a 'href', 'etag' and '$response_type' part, where the 'href' is relative to the calendar and the '$response_type' contains the definition of the calendar data in iCalendar format.
Method DoDELETERequest
CalDAVClient::DoDELETERequest() in caldav-client.php
DELETE a text/icalendar resource
Method DoGETRequest
CalDAVClient::DoGETRequest() in caldav-client.php
Get a single item from the server.
Method DoOptionsRequest
Send an OPTIONS request to the server
Method DoPUTRequest
CalDAVClient::DoPUTRequest() in caldav-client.php
PUT a text/icalendar resource, returning the etag
Method DoRequest
CalDAVClient::DoRequest() in caldav-client.php
Send a request to the server
Method DoResponse
CalDAVRequest::DoResponse() in CalDAVRequest.php
Utility function we call when we have a simple status-based response to return to the client. Possibly
Method DoXMLRequest
CalDAVClient::DoXMLRequest() in caldav-client.php
Send an XML request to the server (e.g. PROPFIND, REPORT, MKCALENDAR)
Page davical_configuration_missing.php
davical_configuration_missing.php in davical_configuration_missing.php
Page drivers_ldap.php
drivers_ldap.php in drivers_ldap.php
Page drivers_squid_pam.php
drivers_squid_pam.php in drivers_squid_pam.php
e
top
Variable $entry
CalDAVClient::$entry in caldav-client.php
f
top
Method FailIfLocked
CalDAVRequest::FailIfLocked() in CalDAVRequest.php
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.
Page freebusy.php
freebusy.php in freebusy.php
Page freebusy-GET.php
freebusy-GET.php in freebusy-GET.php
g
top
Variable $group_membership
CalDAVPrincipal::$group_membership in CalDAVPrincipal.php
Variable $group_member_set
CalDAVPrincipal::$group_member_set in CalDAVPrincipal.php
Method getAllUsers
ldapDrivers::getAllUsers() in drivers_ldap.php
Retrieve all users from the LDAP directory
Method GetDepthName
CalDAVRequest::GetDepthName() in CalDAVRequest.php
Returns the name for this depth: 0, 1, infinity
Method GetEntryByHref
CalDAVClient::GetEntryByHref() in caldav-client.php
Get the calendar entry by HREF
Method GetEntryByUid
CalDAVClient::GetEntryByUid() in caldav-client.php
Get the calendar entry by UID
Method GetEvents
CalDAVClient::GetEvents() in caldav-client.php
Get the events in a range from $start to $finish. The dates should be in the
Method GetLockDetails
CalDAVRequest::GetLockDetails() in CalDAVRequest.php
Returns the DB object associated with a lock token, or false.
Method GetLockRow
CalDAVRequest::GetLockRow() in CalDAVRequest.php
Returns the locked row, either from the cache or from the database
Method GetMonthByDay
Applies any BYDAY to the month to return a set of days
Method GetMonthByMonthDay
Applies any BYMONTHDAY to the month to return a set of days
Method GetNext
RRule::GetNext() in RRule.php
This is most of the meat of the RRULE processing, where we find the next date.
Method GetRelationships
Method used to get the user's relationships
Method GetRoles
RSCDSSession::GetRoles() in RSCDSSession.php
Method used to get the user's roles
Method GetRoles
HTTPAuthSession::GetRoles() in HTTPAuthSession.php
Internal function used to get the user's roles from the database.
Function getStaticLdap
getStaticLdap() in drivers_ldap.php
A generic function to create and fetch static objects
Function getStatusMessage
getStatusMessage() in always.php
Return the HTTP status code description for a given code. Hopefully this is an efficient way to code this.
Method GetTodos
CalDAVClient::GetTodos() in caldav-client.php
Get the todo's in a range from $start to $finish. The dates should be in the
Function getUserByID
getUserByID() in always.php
Return a user record identified by a user_no, caching it for any subsequent lookup
Function getUserByName
getUserByName() in always.php
Return a user record identified by a username, caching it for any subsequent lookup
Method GetWeekByDay
Applies any BYDAY to the week to return a set of days
Function get_collection
get_collection() in caldav-PROPFIND.php
Get XML response for a single collection. If Depth is >0 then
Function get_collection_contents
get_collection_contents() in caldav-PROPFIND.php
Get XML response for items in the collection If '/' is requested, a list of visible users is given, otherwise a list of calendars for the user which are parented by this path.
Function get_item
get_item() in caldav-PROPFIND.php
Get XML response for a single item. Depth is irrelevant for this.
Method GreaterThan
Test if $this is greater than the date parameter
h
top
Variable $headers
CalDAVClient::$headers in caldav-client.php
Method HandleAction
RSCDSUser::HandleAction() in RSCDSUser.php
Handle any unusual actions we might invent
Function handle_freebusy_request
handle_freebusy_request() in caldav-POST.php
Page help.php
help.php in help.php
Method HTTPAuthSession
HTTPAuthSession::HTTPAuthSession() in HTTPAuthSession.php
The constructor, which just calls the actual type configured
Class HTTPAuthSession
HTTPAuthSession in HTTPAuthSession.php
A Class for handling a session using HTTP Basic Authentication
Page HTTPAuthSession.php
HTTPAuthSession.php in HTTPAuthSession.php
i
top
Page index.php
index.php in index.php
Method iCalDate
The constructor takes either an iCalendar date, a text string formatted as an iCalendar date, or epoch seconds.
Class iCalDate
iCalDate in RRule.php
A Class for handling dates in iCalendar format. We do make the simplifying assumption that all date handling in here is normalised to GMT. One day we might provide some functions to do that, but for now it is done externally.
Method importFromDirectory
Function import_collection
import_collection() in caldav-PUT-functions.php
This function will import a whole calendar
Page interactive-page.php
interactive-page.php in interactive-page.php
Method InitialiseRecord
Initialise the Principal object from a $usr record from the DB.
Method IsCollection
CalDAVRequest::IsCollection() in CalDAVRequest.php
Returns true if the URL referenced by this request points at a collection.
Method IsInfiniteDepth
Returns true if the request asked for infinite depth
Method IsLocked
CalDAVRequest::IsLocked() in CalDAVRequest.php
Checks whether the resource is locked, returning any lock token, or false
Method IsPrincipal
CalDAVRequest::IsPrincipal() in CalDAVRequest.php
Returns true if the URL referenced by this request points at a principal.
Function item_to_xml
item_to_xml() in caldav-PROPFIND.php
Return XML for a single data item from the DB
l
top
Class ldapDrivers
ldapDrivers in drivers_ldap.php
Method ldapDrivers
ldapDrivers::ldapDrivers() in drivers_ldap.php
Constructor.
Function LDAP_check
LDAP_check() in drivers_ldap.php
Check the username / password against the LDAP server
Method LessThan
Test if $this is less than the date parameter
Function local_session_sql
local_session_sql() in RSCDSSession.php
Method LoginRequired
RSCDSSession::LoginRequired() in RSCDSSession.php
Checks that this user is logged in, and presents a login screen if they aren't.
m
top
Variable $method
CalDAVRequest::$method in CalDAVRequest.php
The HTTP request method: PROPFIND, LOCK, REPORT, OPTIONS, etc...
Function make_help_link
make_help_link() in page-header.php
Method MonthDays
Given a MonthDays string like "1MO", "-2WE" return an integer day of the month.
o
top
Variable $options
CalDAVRequest::$options in CalDAVRequest.php
Page other_translated_strings.php
other_translated_strings.php in other_translated_strings.php
p
top
Variable $pass
CalDAVClient::$pass in caldav-client.php
Variable $principal
CalDAVRequest::$principal in CalDAVRequest.php
The 'principal' (user/resource/...) which this request seeks to access
Page public.php
public.php in public.php
Page page-footer.php
page-footer.php in page-footer.php
Page page-header.php
page-header.php in page-header.php
Method ParseDigestHeader
Parse the HTTP Digest Auth Header
Method PHPTest
RRuleTest::PHPTest() in test-RRULE.php
Function privileges
privileges() in caldav-PROPFIND.php
Returns the array of privilege names converted into XMLElements
Function public_events_only
public_events_only() in caldav-PUT-functions.php
Check if this collection should force all events to be PUBLIC.
Function putCalendarResource
putCalendarResource() in caldav-PUT-functions.php
Put the resource from this request
r
top
Variable $raw_post
CalDAVRequest::$raw_post in CalDAVRequest.php
The raw data sent along with the request
Variable $recur
RRuleTest::$recur in test-RRULE.php
Variable $result_description
Page relationship_types.php
relationship_types.php in relationship_types.php
Page roles.php
roles.php in roles.php
Page RRule.php
RRule.php in RRule.php
Page RSCDSSession.php
RSCDSSession.php in RSCDSSession.php
Page RSCDSUser.php
RSCDSUser.php in RSCDSUser.php
Method Render
iCalDate::Render() in RRule.php
Set the day of week used for calculation of week starts
Method Render
RSCDSUser::Render() in RSCDSUser.php
Render the form / viewer as HTML to show the user
Method render
Tools::render() in tools.php
Method RenderAsXML
CalDAVPrincipal::RenderAsXML() in CalDAVPrincipal.php
Render XML for a single Principal (user) from the DB
Method RenderCollections
Render the user's collections
Method renderImportFromDirectory
Method RenderImportIcs
Render input file to import ics in calendar user
Method RenderPrivileges
Returns the array of privilege names converted into XMLElements
Method RenderRelationshipsFrom
Render the user's relationships to other users & resources
Method RenderRelationshipsTo
Render the user's relationships to other users & resources
Method renderSyncLDAP
Method requestUser
ldapDrivers::requestUser() in drivers_ldap.php
Returns the result of the LDAP query
Function rollback_on_error
rollback_on_error() in caldav-PUT-functions.php
This function launches an error
Method RRule
RRule::RRule() in RRule.php
The constructor takes a start date and an RRULE definition. Both of these follow the iCalendar standard.
Class RRule
RRule in RRule.php
A Class for handling Events on a calendar which repeat
Class RRuleTest
RRuleTest in test-RRULE.php
Method RRuleTest
RRuleTest::RRuleTest() in test-RRULE.php
Method RSCDSSession
RSCDSSession::RSCDSSession() in RSCDSSession.php
Create a new RSCDSSession object.
Class RSCDSSession
RSCDSSession in RSCDSSession.php
A class for creating and holding session information.
Method RSCDSUser
RSCDSUser::RSCDSUser() in RSCDSUser.php
Constructor - nothing fancy as yet.
Class RSCDSUser
RSCDSUser in RSCDSUser.php
A class for viewing and maintaining DAViCal User records
s
top
Variable $schedule_inbox_url
Variable $schedule_outbox_url
Global $session The session object is global.
Function send_page_header
send_page_header() in page-header.php
Method SetContentType
CalDAVClient::SetContentType() in caldav-client.php
Add a Content-type: header.
Method SetDepth
CalDAVClient::SetDepth() in caldav-client.php
Add a Depth: header. Valid values are 1 or infinity
Method SetEpochDate
Set the date from an epoch
Method SetGMTDate
Set the date from a text string
Method SetLocalDate
Set the date from a text string
Method SetMatch
CalDAVClient::SetMatch() in caldav-client.php
Adds an If-Match or If-None-Match header
Method SetMonthDay
Set the day in the month to what we have been given
Method setPermissions
CalDAVRequest::setPermissions() in CalDAVRequest.php
Permissions are controlled as follows:
Method SetUserAgent
CalDAVClient::SetUserAgent() in caldav-client.php
Add a Depth: header. Valid values are 1 or infinity
Method SetWeekStart
Set the day of week used for calculation of week starts
Function SqlFilterFragment
SqlFilterFragment() in caldav-REPORT-calquery.php
Process a filter fragment returning an SQL fragment
Method SQLTest
RRuleTest::SQLTest() in test-RRULE.php
Class squidPamDrivers
squidPamDrivers in drivers_squid_pam.php
Method squidPamDrivers
squidPamDrivers::squidPamDrivers() in drivers_squid_pam.php
Constructor.
Function SQUID_PAM_check
SQUID_PAM_check() in drivers_squid_pam.php
Check the username / password against the PAM system
Method SupportedPrivileges
Return an array of what the DAV privileges are that are supported
Function sync_LDAP
sync_LDAP() in drivers_ldap.php
sync LDAP against the DB
Function sync_user_from_LDAP
sync_user_from_LDAP() in drivers_ldap.php
Synchronise a cached user with one from LDAP
t
top
Page tools.php
tools.php in tools.php
Page test-RRULE.php
test-RRULE.php in test-RRULE.php
Method TestByMonth
Test to see if our _mo matches something in the list of months we have received.
Class Tools
Tools in tools.php
Function translate_relationship_list
Translate relationship names in the relationship_list for each user. See the documentation for classBrowser::BrowserColumn for the definition of the hook function parameters.
u
top
Variable $url
CalDAVPrincipal::$url in CalDAVPrincipal.php
Variable $user
CalDAVClient::$user in caldav-client.php
Variable $user_agent
CalDAVRequest::$user_agent in CalDAVRequest.php
The user agent making the request.
Variable $user_agent
CalDAVClient::$user_agent in caldav-client.php
The useragent which is send to the caldav server
Page users.php
users.php in users.php
Page usr.php
usr.php in usr.php
Function unicodeToUtf8
unicodeToUtf8() in check_UTF8.php
Takes an array of ints representing the Unicode characters and returns a UTF-8 string. Astral planes are supported ie. the ints in the input can be > 0xFFFF. Occurrances of the BOM are ignored. Surrogates are not allowed.
Method UnsupportedRequest
Sometimes it's a perfectly formed request, but we just don't do that :-(
Function UpdateUserFromExternal
UpdateUserFromExternal() in auth-functions.php
Update the local cache of the remote user details
Method UserFromPath
CalDAVRequest::UserFromPath() in CalDAVRequest.php
Work out the user whose calendar we are accessing, based on elements of the path.
Method UsernameFromEMail
Work out the username, based on the given e-mail
Method UsernameFromPath
Work out the username, based on elements of the path.
Function utf8ToUnicode
utf8ToUnicode() in check_UTF8.php
Takes an UTF-8 string and returns an array of ints representing the Unicode characters. Astral planes are supported ie. the ints in the output can be > 0xFFFF. Occurrances of the BOM are ignored. Surrogates are not allowed.
v
top
Method Validate
RSCDSUser::Validate() in RSCDSUser.php
Validate the information the user submitted
Method ValidateLockToken
Checks to see whether the lock token given matches one of the ones handed in with the request.
w
top
Method WithinScope
Processes the array of $relative_days to $base and removes any which are not within the scope of our rule.
Method Write
RSCDSUser::Write() in RSCDSUser.php
Write the record to the file
x
top
Method XMLResponse
CalDAVRequest::XMLResponse() in CalDAVRequest.php
Send an XML Response. This function will never return.
_
top
Method _EpochFromParts
Given a local text date, convert it to an epoch
Method _GMTEpochFromParts
Given a GMT text date, convert it to an epoch
Method _GMTTextFromEpoch
Given a GMT epoch date, convert it to text
Method _PartsFromText
Given a text date, convert it to parts
Method _TextFromEpoch
Given an epoch date, convert it to text
Method __construct
squidPamDrivers::__construct() in drivers_squid_pam.php
The constructor
Method __construct
ldapDrivers::__construct() in drivers_ldap.php
Initializes the LDAP connection
Function __curl_init_callback
__curl_init_callback() in caldav-client.php
I bet you find this hard to believe, but having to write this hack really annoys the crap out of me. WTF! Why does PHP/Curl not have a function which simply accepts a string as what the request will contain. Oh no. They only think of "POST" and "PUT a file". Crap.
Function __curl_read_callback
__curl_read_callback() in caldav-client.php
As documented in the comments on this page(!)
a b c d e f g h i l m o p r s t u v w x _