diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 412eeda..0000000 --- a/.gitattributes +++ /dev/null @@ -1,22 +0,0 @@ -# Auto detect text files and perform LF normalization -* text=auto - -# Custom for Visual Studio -*.cs diff=csharp -*.sln merge=union -*.csproj merge=union -*.vbproj merge=union -*.fsproj merge=union -*.dbproj merge=union - -# Standard to msysgit -*.doc diff=astextplain -*.DOC diff=astextplain -*.docx diff=astextplain -*.DOCX diff=astextplain -*.dot diff=astextplain -*.DOT diff=astextplain -*.pdf diff=astextplain -*.PDF diff=astextplain -*.rtf diff=astextplain -*.RTF diff=astextplain diff --git a/.gitignore b/.gitignore index 54e3828..0aa2419 100644 --- a/.gitignore +++ b/.gitignore @@ -1,174 +1,47 @@ -################# -## Eclipse -################# - -*.pydevproject -.project -.metadata -bin/ -tmp/ -*.tmp -*.bak -*.swp -*~.nib -local.properties -.classpath -.settings/ -.loadpath - -# External tool builders -.externalToolBuilders/ - -# Locally stored "Eclipse launch configurations" -*.launch - -# CDT-specific -.cproject - -# PDT-specific -.buildpath - - -################# -## Visual Studio -################# - -## Ignore Visual Studio temporary files, build results, and -## files generated by popular Visual Studio add-ons. - -# User-specific files -*.suo -*.user -*.sln.docstates - -# Build results - -[Dd]ebug/ -[Rr]elease/ -x64/ -build/ -[Bb]in/ -[Oo]bj/ - -# MSTest test Results -[Tt]est[Rr]esult*/ -[Bb]uild[Ll]og.* - -*_i.c -*_p.c -*.ilk -*.meta -*.obj -*.pch -*.pdb -*.pgc -*.pgd -*.rsp -*.sbr -*.tlb -*.tli -*.tlh -*.tmp -*.tmp_proj -*.log -*.vspscc -*.vssscc -.builds -*.pidb -*.log -*.scc - -# Visual C++ cache files -ipch/ -*.aps -*.ncb -*.opensdf -*.sdf -*.cachefile - -# Visual Studio profiler -*.psess -*.vsp -*.vspx - -# Guidance Automation Toolkit -*.gpState - -# ReSharper is a .NET coding add-in -_ReSharper*/ -*.[Rr]e[Ss]harper - -# TeamCity is a build add-in -_TeamCity* - -# DotCover is a Code Coverage Tool -*.dotCover - -# NCrunch -*.ncrunch* -.*crunch*.local.xml - -# Installshield output folder -[Ee]xpress/ - -# DocProject is a documentation generator add-in -DocProject/buildhelp/ -DocProject/Help/*.HxT -DocProject/Help/*.HxC -DocProject/Help/*.hhc -DocProject/Help/*.hhk -DocProject/Help/*.hhp -DocProject/Help/Html2 -DocProject/Help/html - -# Click-Once directory -publish/ - -# Publish Web Output -*.Publish.xml -*.pubxml - -# NuGet Packages Directory -## TODO: If you have NuGet Package Restore enabled, uncomment the next line -#packages/ - -# Windows Azure Build Output -csx -*.build.csdef - -# Windows Store app package directory -AppPackages/ - -# Others -sql/ -*.Cache -ClientBin/ -[Ss]tyle[Cc]op.* -~$* +# Created by https://www.gitignore.io + +### Linux ### *~ -*.dbmdl -*.[Pp]ublish.xml -*.pfx -*.publishsettings -# RIA/Silverlight projects -Generated_Code/ +# KDE directory preferences +.directory + +# Linux trash folder which might appear on any partition or disk +.Trash-* + + + + +### OSX ### +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + -# Backup & report files from converting an old project file to a newer -# Visual Studio version. Backup files are not needed, because we have git ;-) -_UpgradeReport_Files/ -Backup*/ -UpgradeLog*.XML -UpgradeLog*.htm +# Thumbnails +._* -# SQL Server files -App_Data/*.mdf -App_Data/*.ldf +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns -############# -## Windows detritus -############# +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + + +### Windows ### # Windows image file caches Thumbs.db ehthumbs.db @@ -179,42 +52,81 @@ Desktop.ini # Recycle Bin used on file shares $RECYCLE.BIN/ -# Mac crap -.DS_Store + +### PhpStorm ### +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm + +*.iml + +## Directory-based project format: +.idea/ +# if you remove the above rule, at least ignore the following: + +# Company-specific stuff: +# .idea/workspace.xml +# .idea/tasks.xml +# .idea/dictionaries + +# Sensitive or high-churn files: +# .idea/dataSources.ids +# .idea/dataSources.xml +# .idea/sqlDataSources.xml +# .idea/dynamic.xml +# .idea/uiDesigner.xml + +# Gradle: +# .idea/gradle.xml +# .idea/libraries + +# Mongo Explorer plugin: +# .idea/mongoSettings.xml + +## File-based project format: +*.ipr +*.iws + +## Plugin-specific files: + +# IntelliJ +/out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties + + + +### Composer ### +composer.phar +composer.lock +/vendor + + +### tests ### +coverage.xml +coverage.txt +coverage.clover + +### gulp ### +node_modules/ +npm-debug.log +public/css + +### laravel ide helper ### +.phpstorm.meta.php +_ide_helper.php + + +### DEPLOYING ### +.git_utility -############# -## Python -############# - -*.py[co] - -# Packages -*.egg -*.egg-info -dist/ -build/ -eggs/ -parts/ -var/ -sdist/ -develop-eggs/ -.installed.cfg - -# Installer logs -pip-log.txt - -# Unit test / coverage reports -.coverage -.tox - -#Translations -*.mo - -#Mr Developer -.mr.developer.cfg -/AWLUtilities.php -/index.php -/Translation.php -/XMLDocument.php -/XMLElement.php +### laravel environment ### +.env \ No newline at end of file diff --git a/CalDAVCalendar.php b/CalDAVCalendar.php deleted file mode 100644 index 4e1e983..0000000 --- a/CalDAVCalendar.php +++ /dev/null @@ -1,106 +0,0 @@ - - * - * This class represents an accsessible calendar on the server. - * - * I think the functions - * - getURL() - * - getDisplayName() - * - getCalendarID() - * - getRGBAcolor() - * - getRBGcolor() - * are pretty self-explanatory. - * - * - * getCTag() returns the ctag of the calendar. - * The ctag is an hash-value used to check, if the client is up to date. The ctag changes everytime - * someone changes something in the calendar. So, to check if anything happend since your last visit: - * just compare the ctags. - * - * getOrder() returns the order of the calendar in the list of calendars - * - * - * @package simpleCalDAV - * - */ - -class CalDAVCalendar { - private $url; - private $displayname; - private $ctag; - private $calendar_id; - private $rgba_color; - private $rbg_color; - private $order; - - function __construct ( $url, $displayname = null, $ctag = null, $calendar_id = null, $rbg_color = null, $order = null ) { - $this->url = $url; - $this->displayname = $displayname; - $this->ctag = $ctag; - $this->calendar_id = $calendar_id; - $this->rbg_color = $rbg_color; - $this->order = $order; - } - - function __toString () { - return( '(URL: '.$this->url.' Ctag: '.$this->ctag.' Displayname: '.$this->displayname .')'. "\n" ); - } - - // Getters - - function getURL () { - return $this->url; - } - - function getDisplayName () { - return $this->displayname; - } - - function getCTag () { - return $this->ctag; - } - - function getCalendarID () { - return $this->calendar_id; - } - - function getRBGcolor () { - return $this->rbg_color; - } - - function getOrder () { - return $this->order; - } - - - // Setters - - function setURL ( $url ) { - $this->url = $url; - } - - function setDisplayName ( $displayname ) { - $this->displayname = $displayname; - } - - function setCtag ( $ctag ) { - $this->ctag = $ctag; - } - - function setCalendarID ( $calendar_id ) { - $this->calendar_id = $calendar_id; - } - - function setRBGcolor ( $rbg_color ) { - $this->rbg_color = $rbg_color; - } - - function setOrder ( $order ) { - $this->order = $order; - } -} - -?> \ No newline at end of file diff --git a/CalDAVClient.php b/CalDAVClient.php deleted file mode 100644 index 10a2eb6..0000000 --- a/CalDAVClient.php +++ /dev/null @@ -1,1309 +0,0 @@ - - * - * This file is heavily based on AgenDAV caldav-client-v2.php by - * Jorge López Pérez which is again heavily based - * on DAViCal caldav-client-v2.php by Andrew McMillan - * - * - * @package simpleCalDAV - */ - -require_once('CalDAVCalendar.php'); -require_once('include/XMLDocument.php'); - - - -class CalDAVClient { - /** - * Server, username, password, calendar - * - * @var string - */ - protected $base_url, $user, $pass, $entry, $protocol, $server, $port; - - /** - * The principal-URL we're using - */ - protected $principal_url; - - /** - * The calendar-URL we're using - */ - public $calendar_url; - - /** - * The calendar-home-set we're using - */ - protected $calendar_home_set; - - /** - * The calendar_urls we have discovered - */ - protected $calendar_urls; - - /** - * The useragent which is send to the caldav server - * - * @var string - */ - public $user_agent = 'simpleCalDAVclient'; - - protected $headers = array(); - protected $body = ""; - protected $requestMethod = "GET"; - protected $httpRequest = ""; // for debugging http headers sent - protected $xmlRequest = ""; // for debugging xml sent - protected $httpResponse = ""; // http headers received - protected $xmlResponse = ""; // xml received - protected $httpResultCode = ""; - - protected $parser; // our XML parser object - - // Requests timeout - private $timeout; - - // cURL handle - private $ch; - - // Full URL - private $full_url; - - // First part of the full url - public $first_url_part; - - /** - * Constructor - * - * Valid options are: - * - * $options['auth'] : Auth type. Can be any of values for - * CURLOPT_HTTPAUTH (from - * http://www.php.net/manual/es/function.curl-setopt.php). Default: - * basic or digest - * - * $options['timeout'] : Timeout in seconds - */ - - // TODO: proxy options, interface used, - function __construct( $base_url, $user, $pass, $options = array()) { - $this->user = $user; - $this->pass = $pass; - $this->headers = array(); - - if ( preg_match( '#^((https?)://([a-z0-9.-]+)(:([0-9]+))?)(/.*)$#', $base_url, $matches ) ) { - $this->server = $matches[3]; - $this->base_url = $matches[6]; - if ( $matches[2] == 'https' ) { - $this->protocol = 'ssl'; - $this->port = 443; - } - else { - $this->protocol = 'tcp'; - $this->port = 80; - } - if ( $matches[4] != '' ) { - $this->port = intval($matches[5]); - } - } else { - trigger_error("Invalid URL: '".$base_url."'", E_USER_ERROR); - } - - $this->timeout = isset($options['timeout']) ? - $options['timeout'] : 10; - $this->ch = curl_init(); - curl_setopt_array($this->ch, array( - CURLOPT_CONNECTTIMEOUT => $this->timeout, - CURLOPT_FAILONERROR => FALSE, - CURLOPT_MAXREDIRS => 2, - CURLOPT_FORBID_REUSE => FALSE, - CURLOPT_RETURNTRANSFER => TRUE, - CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, - CURLOPT_HTTPAUTH => - isset($options['auth']) ? $options['auth'] : - (CURLAUTH_BASIC | CURLAUTH_DIGEST), - CURLOPT_USERAGENT => 'cURL based CalDAV client', - CURLINFO_HEADER_OUT => TRUE, - CURLOPT_HEADER => TRUE, - CURLOPT_SSL_VERIFYPEER => FALSE - )); - - $this->full_url = $base_url; - $this->first_url_part = $matches[1]; - } - - /** - * Check with OPTIONS if calendar-access is enabled - * - * Can be used to check authentication against server - * - */ - function isValidCalDAVServer() { - // Clean headers - $this->headers = array(); - $dav_options = $this->DoOptionsRequestAndGetDAVHeader(); - $valid_caldav_server = isset($dav_options['calendar-access']); - - return $valid_caldav_server; - } - - /** - * Issues an OPTIONS request - * - * @param string $url The URL to make the request to - * - * @return array DAV options - */ - function DoOptionsRequestAndGetDAVHeader( $url = null ) { - $this->requestMethod = "OPTIONS"; - $this->body = ""; - $headers = $this->DoRequest($url); - - $result = array(); - - $headers = preg_split('/\r?\n/', $headers); - - // DAV header(s) - $dav_header = preg_grep('/^DAV:/', $headers); - if (is_array($dav_header)) { - $dav_header = array_values($dav_header); - $dav_header = preg_replace('/^DAV: /', '', $dav_header); - - $dav_options = array(); - - foreach ($dav_header as $d) { - $dav_options = array_merge($dav_options, - array_flip(preg_split('/[, ]+/', $d))); - } - - $result = $dav_options; - - } - - return $result; - } - - - /** - * Adds an If-Match or If-None-Match header - * - * @param bool $match to Match or Not to Match, that is the question! - * @param string $etag The etag to match / not match against. - */ - function SetMatch( $match, $etag = '*' ) { - $this->headers['match'] = sprintf( "%s-Match: \"%s\"", ($match ? "If" : "If-None"), $etag); - } - - /** - * Add a Depth: header. Valid values are 0, 1 or infinity - * - * @param int $depth The depth, default to infinity - */ - function SetDepth( $depth = '0' ) { - $this->headers['depth'] = 'Depth: '. ($depth == '1' ? "1" : ($depth == 'infinity' ? $depth : "0") ); - } - - /** - * Add a Depth: header. Valid values are 1 or infinity - * - * @param int $depth The depth, default to infinity - */ - function SetUserAgent( $user_agent = null ) { - $this->user_agent = $user_agent; - curl_setopt($this->ch, CURLOPT_USERAGENT, $user_agent); - } - - /** - * Add a Content-type: header. - * - * @param string $type The content type - */ - function SetContentType( $type ) { - $this->headers['content-type'] = "Content-type: $type"; - } - - /** - * Set the calendar_url we will be using for a while. - * - * @param string $url The calendar_url - */ - function SetCalendar( $url ) { - $this->calendar_url = $url; - } - - /** - * Split response into httpResponse and xmlResponse - * - * @param string Response from server - */ - function ParseResponse( $response ) { - $pos = strpos($response, 'httpResponse = trim($response); - } - else { - $this->httpResponse = trim(substr($response, 0, $pos)); - $this->xmlResponse = trim(substr($response, $pos)); - $this->xmlResponse = preg_replace('{>[^>]*$}s', '>',$this->xmlResponse ); - $parser = xml_parser_create_ns('UTF-8'); - xml_parser_set_option ( $parser, XML_OPTION_SKIP_WHITE, 1 ); - xml_parser_set_option ( $parser, XML_OPTION_CASE_FOLDING, 0 ); - - if ( xml_parse_into_struct( $parser, $this->xmlResponse, $this->xmlnodes, $this->xmltags ) === 0 ) { - //printf( "XML parsing error: %s - %s\n", xml_get_error_code($parser), xml_error_string(xml_get_error_code($parser)) ); - // debug_print_backtrace(); - // echo "\nNodes array............................................................\n"; print_r( $this->xmlnodes ); - // echo "\nTags array............................................................\n"; print_r( $this->xmltags ); - //printf( "\nXML Reponse:\n%s\n", $this->xmlResponse ); - log_message('ERROR', 'XML parsing error: ' - . xml_get_error_code($parser) . ', ' - . xml_error_string(xml_get_error_code($parser))); - } - - xml_parser_free($parser); - } - } - - /** - * Parse response headers - */ - function ParseResponseHeaders($headers) { - $lines = preg_split('/[\r\n]+/', $headers); - $this->httpResultCode = preg_replace('/^[\S]+ (\d+).+$/', '\1', - $lines[0]); - } - - /** - * Output http request headers - * - * @return HTTP headers - */ - function GetHttpRequest() { - return $this->httpRequest; - } - /** - * Output http response headers - * - * @return HTTP headers - */ - function GetResponseHeaders() { - return $this->httpResponseHeaders; - } - /** - * Output http response body - * - * @return HTTP body - */ - function GetResponseBody() { - return $this->httpResponseBody; - } - /** - * Output request body - * - * @return raw xml - */ - function GetBody() { - return $this->body; - } - /** - * Output xml response - * - * @return raw xml - */ - function GetXmlResponse() { - return $this->xmlResponse; - } - /** - * Output HTTP status code - * - * @return string HTTP status code - */ - function GetHttpResultCode() { - return $this->httpResultCode; - } - - /** - * Send a request to the server - * - * @param string $url The URL to make the request to - * - * @return string The content of the response from the server - */ - function DoRequest( $url = null ) { - if (is_null($url)) { - $url = $this->full_url; - } - - $this->request_url = $url; - - curl_setopt($this->ch, CURLOPT_URL, $url); - - // Request method - curl_setopt($this->ch, CURLOPT_CUSTOMREQUEST, $this->requestMethod); - - // Empty body. If not used, cURL will spend ~5s on this request - if ($this->requestMethod == 'HEAD' || empty($this->body) ) { - curl_setopt($this->ch, CURLOPT_NOBODY, TRUE); - } else { - curl_setopt($this->ch, CURLOPT_NOBODY, FALSE); - } - - // Headers - if (!isset($this->headers['content-type'])) $this->headers['content-type'] = "Content-type: text/plain"; - - // Remove cURL generated 'Expect: 100-continue' - $this->headers['disable_expect'] = 'Expect:'; - curl_setopt($this->ch, CURLOPT_HTTPHEADER, - array_values($this->headers)); - - curl_setopt($this->ch, CURLOPT_USERPWD, $this->user . ':' . - $this->pass); - - // Request body - curl_setopt($this->ch, CURLOPT_POSTFIELDS, $this->body); - - // Save Request - curl_setopt($this->ch, CURLINFO_HEADER_OUT, TRUE); - - $response = curl_exec($this->ch); - - if (FALSE === $response) { - // TODO better error handling - log_message('ERROR', 'Error requesting ' . $url . ': ' - . curl_error($this->ch)); - return false; - } - - $info = curl_getinfo($this->ch); - - // Save request - $this->httpRequest = $info['request_header']; - - // Get headers (idea from SabreDAV WebDAV client) - $this->httpResponseHeaders = substr($response, 0, $info['header_size']); - $this->httpResponseBody = substr($response, $info['header_size']); - - // Get only last headers (needed when using unspecific HTTP auth - // method or request got redirected) - $this->httpResponseHeaders = preg_replace('/^.+\r\n\r\n(.+)/sU', '$1', - $this->httpResponseHeaders); - - // Parse response - $this->ParseResponseHeaders($this->httpResponseHeaders); - $this->ParseResponse($this->httpResponseBody); - - //TODO debug - - /* - log_message('INTERNALS', 'REQh: ' . var_export($info['request_header'], TRUE)); - log_message('INTERNALS', 'REQb: ' . var_export($this->body, TRUE)); - log_message('INTERNALS', 'RPLh: ' . var_export($this->httpResponseHeaders, TRUE)); - log_message('INTERNALS', 'RPLb: ' . var_export($this->httpResponseBody, TRUE)); - */ - - return $response; - } - - /** - * Send an OPTIONS request to the server - * - * @param string $url The URL to make the request to - * - * @return array The allowed options - */ - function DoOptionsRequest( $url = null ) { - $this->requestMethod = "OPTIONS"; - $this->body = ""; - $headers = $this->DoRequest($url); - $options_header = preg_replace( '/^.*Allow: ([a-z, ]+)\r?\n.*/is', '$1', $headers ); - $options = array_flip( preg_split( '/[, ]+/', $options_header )); - return $options; - } - - - - /** - * Send an XML request to the server (e.g. PROPFIND, REPORT, MKCALENDAR) - * - * @param string $method The method (PROPFIND, REPORT, etc) to use with the request - * @param string $xml The XML to send along with the request - * @param string $url The URL to make the request to - * - * @return array An array of the allowed methods - */ - function DoXMLRequest( $request_method, $xml, $url = null ) { - $this->body = $xml; - $this->requestMethod = $request_method; - $this->SetContentType("text/xml"); - return $this->DoRequest($url); - } - - - - /** - * Get a single item from the server. - * - * @param string $url The URL to GET - */ - function DoGETRequest( $url ) { - $this->body = ""; - $this->requestMethod = "GET"; - return $this->DoRequest( $url ); - } - - - /** - * Get the HEAD of a single item from the server. - * - * @param string $url The URL to HEAD - */ - function DoHEADRequest( $url ) { - $this->body = ""; - $this->requestMethod = "HEAD"; - return $this->DoRequest( $url ); - } - - - /** - * PUT a text/icalendar resource, returning the etag - * - * @param string $url The URL to make the request to - * @param string $icalendar The iCalendar resource to send to the server - * @param string $etag The etag of an existing resource to be overwritten, or '*' for a new resource. - * - * @return string The content of the response from the server - */ - function DoPUTRequest( $url, $icalendar, $etag = null ) { - $this->body = $icalendar; - - $this->requestMethod = "PUT"; - if ( $etag != null ) { - $this->SetMatch( ($etag != '*'), $etag ); - } - $this->SetContentType('text/calendar; encoding="utf-8"'); - $this->DoRequest($url); - - $etag = null; - if ( preg_match( '{^ETag:\s+"([^"]*)"\s*$}im', $this->httpResponseHeaders, $matches ) ) $etag = $matches[1]; - else if ( preg_match( '{^ETag:\s+([^\s]*)\s*$}im', $this->httpResponseHeaders, $matches ) ) $etag = $matches[1]; - if ( !isset($etag) || $etag == '' ) { - // Try with HEAD - $save_request = $this->httpRequest; - $save_response_headers = $this->httpResponseHeaders; - $save_http_result = $this->httpResultCode; - $this->DoHEADRequest( $url ); - if ( preg_match( '{^Etag:\s+"([^"]*)"\s*$}im', $this->httpResponseHeaders, $matches ) ) $etag = $matches[1]; - else if ( preg_match( '{^ETag:\s+([^\s]*)\s*$}im', $this->httpResponseHeaders, $matches ) ) $etag = $matches[1]; - /* - if ( !isset($etag) || $etag == '' ) { - printf( "Still No etag in:\n%s\n", $this->httpResponseHeaders ); - } - */ - $this->httpRequest = $save_request; - $this->httpResponseHeaders = $save_response_headers; - $this->httpResultCode = $save_http_result; - } - return $etag; - } - - - /** - * DELETE a text/icalendar resource - * - * @param string $url The URL to make the request to - * @param string $etag The etag of an existing resource to be deleted, or '*' for any resource at that URL. - * - * @return int The HTTP Result Code for the DELETE - */ - function DoDELETERequest( $url, $etag = null ) { - $this->body = ""; - - $this->requestMethod = "DELETE"; - if ( $etag != null ) { - $this->SetMatch( true, $etag ); - } - $this->DoRequest($url); - return $this->httpResultCode; - } - - - /** - * Get a single item from the server. - * - * @param string $url The URL to PROPFIND on - */ - function DoPROPFINDRequest( $url, $props, $depth = 0 ) { - $this->SetDepth($depth); - $xml = new XMLDocument( array( 'DAV:' => '', 'urn:ietf:params:xml:ns:caldav' => 'C' ) ); - $prop = new XMLElement('prop'); - foreach( $props AS $v ) { - $xml->NSElement($prop,$v); - } - - $this->body = $xml->Render('propfind',$prop ); - - $this->requestMethod = 'PROPFIND'; - $this->SetContentType('text/xml'); - $this->DoRequest($url); - return $this->GetXmlResponse(); - } - - - /** - * Get/Set the Principal URL - * - * @param $url string The Principal URL to set - */ - function PrincipalURL( $url = null ) { - if ( isset($url) ) { - $this->principal_url = $url; - } - return $this->principal_url; - } - - - /** - * Get/Set the calendar-home-set URL - * - * @param $url array of string The calendar-home-set URLs to set - */ - function CalendarHomeSet( $urls = null ) { - if ( isset($urls) ) { - if ( ! is_array($urls) ) $urls = array($urls); - $this->calendar_home_set = $urls; - } - return $this->calendar_home_set; - } - - - /** - * Get/Set the calendar-home-set URL - * - * @param $urls array of string The calendar URLs to set - */ - function CalendarUrls( $urls = null ) { - if ( isset($urls) ) { - if ( ! is_array($urls) ) $urls = array($urls); - $this->calendar_urls = $urls; - } - return $this->calendar_urls; - } - - - /** - * Return the first occurrence of an href inside the named tag. - * - * @param string $tagname The tag name to find the href inside of - */ - function HrefValueInside( $tagname ) { - foreach( $this->xmltags[$tagname] AS $k => $v ) { - $j = $v + 1; - if ( $this->xmlnodes[$j]['tag'] == 'DAV::href' ) { - return rawurldecode($this->xmlnodes[$j]['value']); - } - } - return null; - } - - - /** - * Return the href containing this property. Except only if it's inside a status != 200 - * - * @param string $tagname The tag name of the property to find the href for - * @param integer $which Which instance of the tag should we use - */ - function HrefForProp( $tagname, $i = 0 ) { - if ( isset($this->xmltags[$tagname]) && isset($this->xmltags[$tagname][$i]) ) { - $j = $this->xmltags[$tagname][$i]; - while( $j-- > 0 && $this->xmlnodes[$j]['tag'] != 'DAV::href' ) { - // printf( "Node[$j]: %s\n", $this->xmlnodes[$j]['tag']); - if ( $this->xmlnodes[$j]['tag'] == 'DAV::status' && $this->xmlnodes[$j]['value'] != 'HTTP/1.1 200 OK' ) return null; - } - // printf( "Node[$j]: %s\n", $this->xmlnodes[$j]['tag']); - if ( $j > 0 && isset($this->xmlnodes[$j]['value']) ) { - // printf( "Value[$j]: %s\n", $this->xmlnodes[$j]['value']); - return rawurldecode($this->xmlnodes[$j]['value']); - } - } - else { - // printf( "xmltags[$tagname] or xmltags[$tagname][$i] is not set\n"); - } - return null; - } - - - /** - * Return the href which has a resourcetype of the specified type - * - * @param string $tagname The tag name of the resourcetype to find the href for - * @param integer $which Which instance of the tag should we use - */ - function HrefForResourcetype( $tagname, $i = 0 ) { - if ( isset($this->xmltags[$tagname]) && isset($this->xmltags[$tagname][$i]) ) { - $j = $this->xmltags[$tagname][$i]; - while( $j-- > 0 && $this->xmlnodes[$j]['tag'] != 'DAV::resourcetype' ); - if ( $j > 0 ) { - while( $j-- > 0 && $this->xmlnodes[$j]['tag'] != 'DAV::href' ); - if ( $j > 0 && isset($this->xmlnodes[$j]['value']) ) { - return rawurldecode($this->xmlnodes[$j]['value']); - } - } - } - return null; - } - - - /** - * Return the ... of a propstat where the status is OK - * - * @param string $nodenum The node number in the xmlnodes which is the href - */ - function GetOKProps( $nodenum ) { - $props = null; - $level = $this->xmlnodes[$nodenum]['level']; - $status = ''; - while ( $this->xmlnodes[++$nodenum]['level'] >= $level ) { - if ( $this->xmlnodes[$nodenum]['tag'] == 'DAV::propstat' ) { - if ( $this->xmlnodes[$nodenum]['type'] == 'open' ) { - $props = array(); - $status = ''; - } - else { - if ( $status == 'HTTP/1.1 200 OK' ) break; - } - } - elseif ( !isset($this->xmlnodes[$nodenum]) || !is_array($this->xmlnodes[$nodenum]) ) { - break; - } - elseif ( $this->xmlnodes[$nodenum]['tag'] == 'DAV::status' ) { - $status = $this->xmlnodes[$nodenum]['value']; - } - else { - $props[] = $this->xmlnodes[$nodenum]; - } - } - return $props; - } - - - /** - * Attack the given URL in an attempt to find a principal URL - * - * @param string $url The URL to find the principal-URL from - */ - function FindPrincipal( $url = null ) { - $xml = $this->DoPROPFINDRequest( $url, array('resourcetype', 'current-user-principal', 'owner', 'principal-URL', - 'urn:ietf:params:xml:ns:caldav:calendar-home-set'), 1); - - $principal_url = $this->HrefForProp('DAV::principal'); - - if ( !isset($principal_url) ) { - foreach( array('DAV::current-user-principal', 'DAV::principal-URL', 'DAV::owner') AS $href ) { - if ( !isset($principal_url) ) { - $principal_url = $this->HrefValueInside($href); - } - } - } - - return $this->PrincipalURL($principal_url); - } - - - /** - * Attack the given URL in an attempt to find the calendar-home-url of the current principal - * - * @param string $url The URL to find the calendar-home-set from - */ - function FindCalendarHome( $recursed=false ) { - if ( !isset($this->principal_url) ) { - $this->FindPrincipal(); - } - if ( $recursed ) { - $this->DoPROPFINDRequest( $this->first_url_part.$this->principal_url, array('urn:ietf:params:xml:ns:caldav:calendar-home-set'), 0); - } - - $calendar_home = array(); - foreach( $this->xmltags['urn:ietf:params:xml:ns:caldav:calendar-home-set'] AS $k => $v ) { - if ( $this->xmlnodes[$v]['type'] != 'open' ) continue; - while( $this->xmlnodes[++$v]['type'] != 'close' && $this->xmlnodes[$v]['tag'] != 'urn:ietf:params:xml:ns:caldav:calendar-home-set' ) { - // printf( "Tag: '%s' = '%s'\n", $this->xmlnodes[$v]['tag'], $this->xmlnodes[$v]['value']); - if ( $this->xmlnodes[$v]['tag'] == 'DAV::href' && isset($this->xmlnodes[$v]['value']) ) - $calendar_home[] = rawurldecode($this->xmlnodes[$v]['value']); - } - } - - if ( !$recursed && count($calendar_home) < 1 ) { - $calendar_home = $this->FindCalendarHome(true); - } - - return $this->CalendarHomeSet($calendar_home); - } - - /* - * Find own calendars - */ - function FindCalendars( $recursed=false ) { - if ( !isset($this->calendar_home_set[0]) ) { - $this->FindCalendarHome($recursed); - } - $properties = - array( - 'resourcetype', - 'displayname', - 'http://calendarserver.org/ns/:getctag', - 'http://apple.com/ns/ical/:calendar-color', - 'http://apple.com/ns/ical/:calendar-order', - ); - $this->DoPROPFINDRequest( $this->first_url_part.$this->calendar_home_set[0], $properties, 1); - - return $this->parse_calendar_info(); - } - - /** - * Do a PROPFIND on a calendar and retrieve its information - */ - function GetCalendarDetailsByURL($url) { - $properties = - array( - 'resourcetype', - 'displayname', - 'http://calendarserver.org/ns/:getctag', - 'http://apple.com/ns/ical/:calendar-color', - 'http://apple.com/ns/ical/:calendar-order', - ); - $this->DoPROPFINDRequest($url, $properties, 0); - - return $this->parse_calendar_info(); - } - - /** - * Find the calendars, from the calendar_home_set - */ - function GetCalendarDetails( $url = null ) { - if ( isset($url) ) $this->SetCalendar($url); - - $calendar_properties = array( 'resourcetype', 'displayname', 'http://calendarserver.org/ns/:getctag', 'urn:ietf:params:xml:ns:caldav:calendar-timezone', 'supported-report-set' ); - $this->DoPROPFINDRequest( $this->calendar_url, $calendar_properties, 0); - - $hnode = $this->xmltags['DAV::href'][0]; - $href = rawurldecode($this->xmlnodes[$hnode]['value']); - - $calendar = new CalDAVCalendar($href); - $ok_props = $this->GetOKProps($hnode); - foreach( $ok_props AS $k => $v ) { - $name = preg_replace( '{^.*:}', '', $v['tag'] ); - if ( isset($v['value'] ) ) { - $calendar->{$name} = $v['value']; - } - /* else { - printf( "Calendar property '%s' has no text content\n", $v['tag'] ); - }*/ - } - - return $calendar; - } - - - /** - * Get all etags for a calendar - */ - function GetCollectionETags( $url = null ) { - if ( isset($url) ) $this->SetCalendar($url); - - $this->DoPROPFINDRequest( $this->calendar_url, array('getetag'), 1); - - $etags = array(); - if ( isset($this->xmltags['DAV::getetag']) ) { - foreach( $this->xmltags['DAV::getetag'] AS $k => $v ) { - $href = $this->HrefForProp('DAV::getetag', $k); - if ( isset($href) && isset($this->xmlnodes[$v]['value']) ) $etags[$href] = $this->xmlnodes[$v]['value']; - } - } - - return $etags; - } - - - /** - * Get a bunch of events for a calendar with a calendar-multiget report - */ - function CalendarMultiget( $event_hrefs, $url = null ) { - - if ( isset($url) ) $this->SetCalendar($url); - - $hrefs = ''; - foreach( $event_hrefs AS $k => $href ) { - $href = str_replace( rawurlencode('/'),'/',rawurlencode($href)); - $hrefs .= ''.$href.''; - } - $this->body = << - - -$hrefs - -EOXML; - - $this->requestMethod = "REPORT"; - $this->SetContentType("text/xml"); - $response = $this->DoRequest( $this->calendar_url ); - - $report = array(); - foreach( $this->xmlnodes as $k => $v ) { - switch( $v['tag'] ) { - case 'DAV::response': - if ( $v['type'] == 'open' ) { - $response = array(); - } - elseif ( $v['type'] == 'close' ) { - $report[] = $response; - } - break; - case 'DAV::href': - $response['href'] = basename( rawurldecode($v['value']) ); - break; - case 'DAV::getetag': - $response['etag'] = preg_replace('/^"?([^"]+)"?/', '$1', $v['value']); - break; - case 'urn:ietf:params:xml:ns:caldav:calendar-data': - $response['data'] = $v['value']; - break; - } - } - - return $report; - } - - - /** - * 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. - * - * @param string $filter XML fragment which is the element of a calendar-query - * @param string $url The URL of the calendar, or null to use the 'current' calendar_url - * - * @return array An array of the relative URLs, etags, and events from the server. Each element of the array will - * be an array with 'href', 'etag' and 'data' elements, corresponding to the URL, the server-supplied - * etag (which only varies when the data changes) and the calendar data in iCalendar format. - */ - function DoCalendarQuery( $filter, $url = null ) { - - if ( isset($url) ) $this->SetCalendar($url); - - $this->body = << - - - - -$filter - -EOXML; - - $this->requestMethod = "REPORT"; - $this->SetContentType("text/xml"); - $this->DoRequest( $this->calendar_url ); - - $report = array(); - foreach( $this->xmlnodes as $k => $v ) { - switch( $v['tag'] ) { - case 'DAV::response': - if ( $v['type'] == 'open' ) { - $response = array(); - } - elseif ( $v['type'] == 'close' ) { - $report[] = $response; - } - break; - case 'DAV::href': - $response['href'] = basename( rawurldecode($v['value']) ); - break; - case 'DAV::getetag': - $response['etag'] = preg_replace('/^"?([^"]+)"?/', '$1', $v['value']); - break; - case 'urn:ietf:params:xml:ns:caldav:calendar-data': - $response['data'] = $v['value']; - break; - } - } - return $report; - } - - - /** - * Get the events in a range from $start to $finish. The dates should be in the - * format yyyymmddThhmmssZ and should be in GMT. The events are returned as an - * array of event arrays. Each event array will have a 'href', 'etag' and 'event' - * part, where the 'href' is relative to the calendar and the event contains the - * definition of the event in iCalendar format. - * - * @param timestamp $start The start time for the period - * @param timestamp $finish The finish time for the period - * @param string $relative_url The URL relative to the base_url specified when the calendar was opened. Default null. - * - * @return array An array of the relative URLs, etags, and events, returned from DoCalendarQuery() @see DoCalendarQuery() - */ - function GetEvents( $start = null, $finish = null, $relative_url = null ) { - $this->SetDepth('1'); - $filter = ""; - if ( isset($start) && isset($finish) ) - $range = ""; - elseif ( isset($start) && ! isset($finish) ) - $range = ""; - elseif ( ! isset($start) && isset($finish) ) - $range = ""; - else - $range = ''; - - $filter = << - - -$range - - - -EOFILTER; - - return $this->DoCalendarQuery($filter, $relative_url); - } - - - /** - * Get the todo's in a range from $start to $finish. The dates should be in the - * format yyyymmddThhmmssZ and should be in GMT. The events are returned as an - * array of event arrays. Each event array will have a 'href', 'etag' and 'event' - * part, where the 'href' is relative to the calendar and the event contains the - * definition of the event in iCalendar format. - * - * @param timestamp $start The start time for the period - * @param timestamp $finish The finish time for the period - * @param boolean $completed Whether to include completed tasks - * @param boolean $cancelled Whether to include cancelled tasks - * @param string $relative_url The URL relative to the base_url specified when the calendar was opened. Default ''. - * - * @return array An array of the relative URLs, etags, and events, returned from DoCalendarQuery() @see DoCalendarQuery() - */ - function GetTodos( $start = null, $finish = null, $completed = null, $cancelled = null, $relative_url = "" ) { - $this->SetDepth('1'); - - if ( isset($start) && isset($finish) ) - $range = ""; - elseif ( isset($start) && ! isset($finish) ) - $range = ""; - elseif ( ! isset($start) && isset($finish) ) - $range = ""; - else - $range = ''; - - - // Warning! May contain traces of double negatives... - if(isset($completed) && $completed == true) - $completed_filter = 'COMPLETED'; - else if(isset($completed) && $completed == false) - $completed_filter = 'COMPLETED'; - else - $completed_filter = ''; - - if(isset($cancelled) && $cancelled == true) - $cancelled_filter = 'CANCELLED'; - else if(isset($cancelled) && $cancelled == false) - $cancelled_filter = 'CANCELLED'; - else - $cancelled_filter = ''; - - $filter = << - - -$completed_filter -$cancelled_filter -$range - - - -EOFILTER; - - return $this->DoCalendarQuery($filter); - } - - - /** - * Get the calendar entry by UID - * - * @param uid - * @param string $relative_url The URL relative to the base_url specified when the calendar was opened. Default ''. - * - * @return array An array of the relative URL, etag, and calendar data returned from DoCalendarQuery() @see DoCalendarQuery() - */ - function GetEntryByUid( $uid, $relative_url = null ) { - $this->SetDepth('1'); - $filter = ""; - if ( $uid ) { - $filter = << - - - -$uid - - - - -EOFILTER; - } - - return $this->DoCalendarQuery($filter, $relative_url); - } - - - /** - * Get the calendar entry by HREF - * - * @param string $href The href from a call to GetEvents or GetTodos etc. - * - * @return string The iCalendar of the calendar entry - */ - function GetEntryByHref( $href ) { - //$href = str_replace( rawurlencode('/'),'/',rawurlencode($href)); - $response = $this->DoGETRequest( $href ); - - $report = array(); - - if ( $this->GetHttpResultCode() == '404' ) { return $report; } - - $etag = null; - if ( preg_match( '{^ETag:\s+"([^"]*)"\s*$}im', $this->httpResponseHeaders, $matches ) ) $etag = $matches[1]; - else if ( preg_match( '{^ETag:\s+([^\s]*)\s*$}im', $this->httpResponseHeaders, $matches ) ) $etag = $matches[1]; - if ( !isset($etag) || $etag == '' ) { - // Try with HEAD - $save_request = $this->httpRequest; - $save_response_headers = $this->httpResponseHeaders; - $save_http_result = $this->httpResultCode; - $this->DoHEADRequest( $href ); - if ( preg_match( '{^Etag:\s+"([^"]*)"\s*$}im', $this->httpResponseHeaders, $matches ) ) $etag = $matches[1]; - else if ( preg_match( '{^ETag:\s+([^\s]*)\s*$}im', $this->httpResponseHeaders, $matches ) ) $etag = $matches[1]; - - /* - if ( !isset($etag) || $etag == '' ) { - printf( "Still No etag in:\n%s\n", $this->httpResponseHeaders ); - } - */ - $this->httpRequest = $save_request; - $this->httpResponseHeaders = $save_response_headers; - $this->httpResultCode = $save_http_result; - } - - $report = array(array('etag'=>$etag)); - - return $report; - } - - /** - * Get calendar info after a PROPFIND - */ - function parse_calendar_info() { - $calendars = array(); - if ( isset($this->xmltags['urn:ietf:params:xml:ns:caldav:calendar']) ) { - $calendar_urls = array(); - foreach( $this->xmltags['urn:ietf:params:xml:ns:caldav:calendar'] AS $k => $v ) { - $calendar_urls[$this->HrefForProp('urn:ietf:params:xml:ns:caldav:calendar', $k)] = 1; - } - - foreach( $this->xmltags['DAV::href'] AS $i => $hnode ) { - $href = rawurldecode($this->xmlnodes[$hnode]['value']); - - if ( !isset($calendar_urls[$href]) ) continue; - - // printf("Seems '%s' is a calendar.\n", $href ); - - - $calendar = new CalDAVCalendar($href); - - /* - * Transform href into calendar - * /xxxxx/yyyyy/caldav.php/principal/resource/ - * t-3 t-2 - */ - $pieces = preg_split('/\//', $href); - $total = count($pieces); - $calendar_id = $pieces[$total-2]; - $calendar->setCalendarID($calendar_id); - - $ok_props = $this->GetOKProps($hnode); - foreach( $ok_props AS $v ) { - switch( $v['tag'] ) { - case 'http://calendarserver.org/ns/:getctag': - $calendar->setCtag((isset($v['value']) ? - $v['value'] : '-')); - break; - case 'DAV::displayname': - $calendar->setDisplayName((isset($v['value']) ? - $v['value'] : '-')); - break; - case 'http://apple.com/ns/ical/:calendar-color': - $calendar->setRBGcolor((isset($v['value']) ? - $this->_rgba2rgb($v['value']) : '-')); - break; - case 'http://apple.com/ns/ical/:calendar-order': - $calendar->setOrder((isset($v['value']) ? - $v['value'] : '-')); - break; - } - } - $calendars[$calendar->getCalendarID()] = $calendar; - } - } - - return $calendars; - } - /** - * Issues a PROPPATCH on a resource - * - * @param string XML request - * @param string URL - * @return TRUE on success, FALSE otherwise - */ - function DoPROPPATCH($xml_text, $url) { - $this->DoXMLRequest('PROPPATCH', $xml_text, $url); - - $errmsg = ''; - - if ($this->httpResultCode == '207') { - $errmsg = $this->httpResultCode; - // Find propstat tag(s) - if (isset($this->xmltags['DAV::propstat'])) { - foreach ($this->xmltags['DAV::propstat'] as $i => $node) { - if ($this->xmlnodes[$node]['type'] == 'close') { - continue; - } - // propstat @ $i: open - // propstat @ $i + 1: close - // Search for prop and status - $level = $this->xmlnodes[$node]['level']; - $level++; - - while ($this->xmlnodes[++$node]['level'] >= $level) { - if ($this->xmlnodes[$node]['tag'] == 'DAV::status' - && $this->xmlnodes[$node]['value'] != - 'HTTP/1.1 200 OK') { - return $this->xmlnodes[$node]['value']; - } - } - } - } - } else if ($this->httpResultCode != 200) { - return 'Unknown HTTP code'; - } - - return TRUE; - } - - /** - * Queries server using a principal-property search - * - * @param string XML request - * @param string URL - * @return FALSE on error, array with results otherwise - */ - function principal_property_search($xml_text, $url) { - $result = array(); - $this->DoXMLRequest('REPORT', $xml_text, $url); - - if ($this->httpResultCode == '207') { - $errmsg = $this->httpResultCode; - // Find response tag(s) - if (isset($this->xmltags['DAV::response'])) { - foreach ($this->xmltags['DAV::response'] as $i => $node) { - if ($this->xmlnodes[$node]['type'] == 'close') { - continue; - } - - $result[$i]['href'] = - $this->HrefForProp('DAV::response', $i+1); - - $level = $this->xmlnodes[$node]['level']; - $level++; - - $ok_props = $this->GetOKProps($node); - - foreach ($ok_props as $v) { - switch($v['tag']) { - case 'DAV::displayname': - $result[$i]['displayname'] = - isset($v['value']) ? $v['value'] : ''; - break; - case 'DAV::email': - $result[$i]['email'] = - isset($v['value']) ? $v['value'] : ''; - break; - } - } - - } - } - } else if ($this->httpResultCode != 200) { - return 'Unknown HTTP code'; - } - - return $result; - } - - /** - * Converts a RGBA hexadecimal string (#rrggbbXX) to RGB - */ - private function _rgba2rgb($s) { - if (strlen($s) == '9') { - return substr($s, 0, 7); - } else { - // Unknown string - return $s; - } - } - - public function printLastMessages() { - $string = ''; - $dom = new DOMDocument(); - $dom->preserveWhiteSpace = FALSE; - $dom->formatOutput = TRUE; - - $string .= '
';
-		$string .= 'last request:

';
-		
-		$string .= $this->httpRequest;
-		 
-		if(!empty($this->body)) {
-			$dom->loadXML($this->body);
-			$string .= htmlentities($dom->saveXml());
-		}
-		
-		$string .= '
last response:

';
-		
-		$string .= $this->httpResponse;
-		 
-		if(!empty($this->xmlResponse)) {
-			$dom->loadXML($this->xmlResponse);
-			$string .= htmlentities($dom->saveXml());
-		}
-		
-		$string .= '
'; - - echo $string; - } -} - - /** - * Error handeling functions - */ - -$debug = TRUE; - -function log_message ($type, $message) { - global $debug; - if ($debug) { - echo '['.$type.'] '.$message.'\n'; - } -} diff --git a/CalDAVException.php b/CalDAVException.php deleted file mode 100644 index 7dd2a80..0000000 --- a/CalDAVException.php +++ /dev/null @@ -1,93 +0,0 @@ - - * - * This class is an extension to the Exception-class, to store and report additional data in the case - * of a problem. - * For debugging purposes, just sorround all of your SimpleCalDAVClient-Code with try { ... } catch (Exception $e) { echo $e->__toString(); } - * - * @package simpleCalDAV - * - */ - -class CalDAVException extends Exception { - private $requestHeader; - private $requestBody; - private $responseHeader; - private $responseBody; - - public function __construct($message, $client, $code = 0, Exception $previous = null) { - parent::__construct($message, $code, $previous); - - $this->requestHeader = $client->GetHttpRequest(); - $this->requestBody = $client->GetBody(); - $this->responseHeader = $client->GetResponseHeaders(); - $this->responseBody = $client->GetResponseBody(); - } - - public function __toString() { - $string = ''; - $dom = new DOMDocument(); - $dom->preserveWhiteSpace = FALSE; - $dom->formatOutput = TRUE; - - $string .= '
';
-		$string .= 'Exception: '.$this->getMessage().'



';
-		$string .= 'If you think there is a bug in SimpleCalDAV, please report the following information on github or send it at palm.michael@gmx.de.


';
-		$string .= '
For debugging purposes:
';
-		$string .= '
last request:

';
-		
-    	$string .= $this->requestHeader;
-    	
-    	if(!empty($this->requestBody)) {
-    		
-    		if(!preg_match( '#^Content-type:.*?text/calendar.*?$#', $this->requestHeader, $matches)) {
-    			$dom->loadXML($this->requestBody);
-    			$string .= htmlentities($dom->saveXml());
-    		}
-    		
-    		else $string .= htmlentities($this->requestBody).'

';
-    	}
-
-    	$string .= '
last response:

';
-		
-    	$string .= $this->responseHeader;
-    	
-    	if(!empty($this->responseBody)) {
-    		if(!preg_match( '#^Content-type:.*?text/calendar.*?$#', $this->responseHeader, $matches)) {
-    			$dom->loadXML($this->responseBody);
-    			$string .= htmlentities($dom->saveXml());
-    		}
-	    	
-    		else $string .= htmlentities($this->responseBody);
-    	}
-    	
-    	$string .= '

';
-    	
-    	$string .= 'Trace:

'.$this->getTraceAsString();
-    
-    	$string .= '
'; - - return $string; - } - - public function getRequestHeader() { - return $this->requestHeader; - } - - public function getrequestBody() { - return $this->requestBody; - } - - public function getResponseHeader() { - return $this->responseHeader; - } - - public function getresponseBody() { - return $this->responseBody; - } -} - -?> \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8cdb845 --- /dev/null +++ b/LICENSE @@ -0,0 +1,340 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {description} + Copyright (C) {year} {fullname} + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + {signature of Ty Coon}, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. + diff --git a/README b/README.md similarity index 54% rename from README rename to README.md index cd39f07..0a47575 100644 --- a/README +++ b/README.md @@ -1,17 +1,27 @@ +# simpleCalDAV + +Build status: [![Latest Stable Version](https://poser.pugx.org/thecsea/simple-caldav-client/v/stable)](https://packagist.org/packages/thecsea/simple-caldav-client) [![Total Downloads](https://poser.pugx.org/thecsea/simple-caldav-client/downloads)](https://packagist.org/packages/thecsea/simple-caldav-client) [![Latest Unstable Version](https://poser.pugx.org/thecsea/simple-caldav-client/v/unstable)](https://packagist.org/packages/thecsea/simple-caldav-client) [![License](https://poser.pugx.org/thecsea/simple-caldav-client/license)](https://packagist.org/packages/thecsea/simple-caldav-client) + +This library is just a porting for packagist of [https://github.com/wvrzel/simpleCalDAV](https://github.com/wvrzel/simpleCalDAV) + +# Examples of use +* [https://github.com/dsd-meetme/backend](https://github.com/dsd-meetme/backend) + simpleCalDAV Copyright 2014 Michael Palm Table of content + 1. About -2. Requirements -3. Installation -4. How to get started -5. Example Code +1. Requirements +1. Installation +1. How to get started +1. Example Code ------------------------ -1. About +1) About simpleCalDAV is a php library that allows you to connect to a calDAV-server to get event-, todo- and free/busy-calendar resources from the server, to change them, to delete them, to create new ones, etc. simpleCalDAV was made and tested for connections to the CalDAV-server Baikal 0.2.7. But it should work with any other CalDAV-server too. @@ -29,17 +39,17 @@ It contains the following functions: All of those functions are really easy to use, self-explanatory and are deliverd with a big innitial comment, which explains all needed arguments and the return values. -This library is heavily based on AgenDAV caldav-client-v2.php by Jorge López Pérez which again is heavily based on DAViCal caldav-client-v2.php by Andrew McMillan . +This library is heavily based on AgenDAV simple-caldav-client-v2.php by Jorge López Pérez which again is heavily based on DAViCal caldav-client-v2.php by Andrew McMillan . Actually, I hardly added any features. The main point of my work is to make everything straight forward and easy to use. You can use simpleCalDAV whithout a deeper understanding of the calDAV-protocol. -2. Requirements +2) Requirements Requirements of this library are - The php extension cURL ( http://www.php.net/manual/en/book.curl.php ) -3. Installation +3) Installation Just navigate into a directory on your server and execute git clone https://github.com/wvrzel/simpleCalDAV.git @@ -49,11 +59,11 @@ Assure yourself that cURL is installed. Import SimpleCalDAVClient.php in your code and you are ready to go ;-) -4. How to get started +4) How to get started Read the comments in SimpleCalDAVClient.php and the example code. -5. Example Code +5) Example Code Example code is provided under "/example code/". diff --git a/SimpleCalDAVClient.php b/SimpleCalDAVClient.php deleted file mode 100644 index 2cebbea..0000000 --- a/SimpleCalDAVClient.php +++ /dev/null @@ -1,415 +0,0 @@ - - * - * simpleCalDAV is a php library that allows you to connect to a calDAV-server to get event-, todo- - * and free/busy-calendar resources from the server, to change them, to delete them, to create new ones, etc. - * simpleCalDAV was made and tested for connections to the CalDAV-server Baikal 0.2.7. But it should work - * with any other CalDAV-server too. - * - * It contains the following functions: - * - connect() - * - findCalendars() - * - setCalendar() - * - create() - * - change() - * - delete() - * - getEvents() - * - getTODOs() - * - getCustomReport() - * - * All of those functions - except the last one - are realy easy to use, self-explanatory and are - * deliverd with a big innitial comment, which explains all needed arguments and the return values. - * - * This library is heavily based on AgenDAV caldav-client-v2.php by Jorge López Pérez which - * again is heavily based on DAViCal caldav-client-v2.php by Andrew McMillan . - * Actually, I hardly added any features. The main point of my work is to make everything straight - * forward and easy to use. You can use simpleCalDAV whithout a deeper understanding of the - * calDAV-protocol. - * - * Requirements of this library are - * - The php extension cURL ( http://www.php.net/manual/en/book.curl.php ) - * - From Andrew’s Web Libraries: ( https://github.com/andrews-web-libraries/awl ) - * - XMLDocument.php - * - XMLElement.php - * - AWLUtilities.php - * - * @package simpleCalDAV - */ - - - -require_once('CalDAVClient.php'); -require_once('CalDAVException.php'); -require_once('CalDAVFilter.php'); -require_once('CalDAVObject.php'); - -class SimpleCalDAVClient { - private $client; - private $url; - - /** - * function connect() - * Connects to a CalDAV-Server. - * - * Arguments: - * @param $url URL to the CalDAV-server. E.g. http://exam.pl/baikal/cal.php/username/calendername/ - * @param $user Username to login with - * @param $pass Password to login with - * - * Debugging: - * @throws CalDAVException - * For debugging purposes, just sorround everything with try { ... } catch (Exception $e) { echo $e->__toString(); } - */ - function connect ( $url, $user, $pass ) - { - - // Connect to CalDAV-Server and log in - $client = new CalDAVClient($url, $user, $pass); - - // Valid CalDAV-Server? Or is it just a WebDAV-Server? - if( ! $client->isValidCalDAVServer() ) - { - - if( $client->GetHttpResultCode() == '401' ) // unauthorisized - { - throw new CalDAVException('Login failed', $client); - } - - elseif( $client->GetHttpResultCode() == '' ) // can't reach server - { - throw new CalDAVException('Can\'t reach server', $client); - } - - else throw new CalDAVException('Could\'n find a CalDAV-collection under the url', $client); - } - - // Check for errors - if( $client->GetHttpResultCode() != '200' ) { - if( $client->GetHttpResultCode() == '401' ) // unauthorisized - { - throw new CalDAVException('Login failed', $client); - } - - elseif( $client->GetHttpResultCode() == '' ) // can't reach server - { - throw new CalDAVException('Can\'t reach server', $client); - } - - else // Unknown status - { - throw new CalDAVException('Recieved unknown HTTP status while checking the connection after establishing it', $client); - } - } - - $this->client = $client; - } - - /** - * function findCalendars() - * - * Requests a list of all accessible calendars on the server - * - * Return value: - * @return an array of CalDAVCalendar-Objects (see CalDAVCalendar.php), representing all calendars accessible by the current principal (user). - * - * Debugging: - * @throws CalDAVException - * For debugging purposes, just sorround everything with try { ... } catch (Exception $e) { echo $e->__toString(); exit(-1); } - */ - function findCalendars() - { - if(!isset($this->client)) throw new Exception('No connection. Try connect().'); - - return $this->client->FindCalendars(true); - } - - /** - * function setCalendar() - * - * Sets the actual calendar to work with - * - * Debugging: - * @throws CalDAVException - * For debugging purposes, just sorround everything with try { ... } catch (Exception $e) { echo $e->__toString(); exit(-1); } - */ - function setCalendar ( CalDAVCalendar $calendar ) - { - if(!isset($this->client)) throw new Exception('No connection. Try connect().'); - - $this->client->SetCalendar($this->client->first_url_part.$calendar->getURL()); - - // Is there a '/' at the end of the calendar_url? - if ( ! preg_match( '#^.*?/$#', $this->client->calendar_url, $matches ) ) { $this->url = $this->client->calendar_url.'/'; } - else { $this->url = $this->client->calendar_url; } - } - - /** - * function create() - * Creates a new calendar resource on the CalDAV-Server (event, todo, etc.). - * - * Arguments: - * @param $cal iCalendar-data of the resource you want to create. - * Notice: The iCalendar-data contains the unique ID which specifies where the event is being saved. - * - * Return value: - * @return An CalDAVObject-representation (see CalDAVObject.php) of your created resource - * - * Debugging: - * @throws CalDAVException - * For debugging purposes, just sorround everything with try { ... } catch (Exception $e) { echo $e->__toString(); exit(-1); } - */ - function create ( $cal ) - { - // Connection and calendar set? - if(!isset($this->client)) throw new Exception('No connection. Try connect().'); - if(!isset($this->client->calendar_url)) throw new Exception('No calendar selected. Try findCalendars() and setCalendar().'); - - // Parse $cal for UID - if (! preg_match( '#^UID:(.*?)\r?\n?$#m', $cal, $matches ) ) { throw new Exception('Can\'t find UID in $cal'); } - else { $uid = $matches[1]; } - - // Does $this->url.$uid.'.ics' already exist? - $result = $this->client->GetEntryByHref( $this->url.$uid.'.ics' ); - if ( $this->client->GetHttpResultCode() == '200' ) { throw new CalDAVException($this->url.$uid.'.ics already exists. UID not unique?', $this->client); } - else if ( $this->client->GetHttpResultCode() == '404' ); - else throw new CalDAVException('Recieved unknown HTTP status', $this->client); - - // Put it! - $newEtag = $this->client->DoPUTRequest( $this->url.$uid.'.ics', $cal ); - - // PUT-request successfull? - if ( $this->client->GetHttpResultCode() != '201' ) - { - if ( $this->client->GetHttpResultCode() == '204' ) // $url.$uid.'.ics' already existed on server - { - throw new CalDAVException( $this->url.$uid.'.ics already existed. Entry has been overwritten.', $this->client); - } - - else // Unknown status - { - throw new CalDAVException('Recieved unknown HTTP status', $this->client); - } - } - - return new CalDAVObject($this->url.$uid.'.ics', $cal, $newEtag); - } - - /** - * function change() - * Changes a calendar resource (event, todo, etc.) on the CalDAV-Server. - * - * Arguments: - * @param $href See CalDAVObject.php - * @param $cal The new iCalendar-data that should be used to overwrite the old one. - * @param $etag See CalDAVObject.php - * - * Return value: - * @return An CalDAVObject-representation (see CalDAVObject.php) of your changed resource - * - * Debugging: - * @throws CalDAVException - * For debugging purposes, just sorround everything with try { ... } catch (Exception $e) { echo $e->__toString(); exit(-1); } - */ - function change ( $href, $new_data, $etag ) - { - // Connection and calendar set? - if(!isset($this->client)) throw new Exception('No connection. Try connect().'); - if(!isset($this->client->calendar_url)) throw new Exception('No calendar selected. Try findCalendars() and setCalendar().'); - - // Does $href exist? - $result = $this->client->GetEntryByHref($href); - if ( $this->client->GetHttpResultCode() == '200' ); - else if ( $this->client->GetHttpResultCode() == '404' ) throw new CalDAVException('Can\'t find '.$href.' on the server', $this->client); - else throw new CalDAVException('Recieved unknown HTTP status', $this->client); - - // $etag correct? - if($result[0]['etag'] != $etag) { throw new CalDAVException('Wrong entity tag. The entity seems to have changed.', $this->client); } - - // Put it! - $newEtag = $this->client->DoPUTRequest( $href, $new_data, $etag ); - - // PUT-request successfull? - if ( $this->client->GetHttpResultCode() != '204' && $this->client->GetHttpResultCode() != '200' ) - { - throw new CalDAVException('Recieved unknown HTTP status', $this->client); - } - - return new CalDAVObject($href, $new_data, $newEtag); - } - - /** - * function delete() - * Delets an event or a TODO from the CalDAV-Server. - * - * Arguments: - * @param $href See CalDAVObject.php - * @param $etag See CalDAVObject.php - * - * Debugging: - * @throws CalDAVException - * For debugging purposes, just sorround everything with try { ... } catch (Exception $e) { echo $e->__toString(); exit(-1); } - */ - function delete ( $href, $etag ) - { - // Connection and calendar set? - if(!isset($this->client)) throw new Exception('No connection. Try connect().'); - if(!isset($this->client->calendar_url)) throw new Exception('No calendar selected. Try findCalendars() and setCalendar().'); - - // Does $href exist? - $result = $this->client->GetEntryByHref($href); - if(count($result) == 0) throw new CalDAVException('Can\'t find '.$href.'on server', $this->client); - - // $etag correct? - if($result[0]['etag'] != $etag) { throw new CalDAVException('Wrong entity tag. The entity seems to have changed.', $this->client); } - - // Do the deletion - $this->client->DoDELETERequest($href, $etag); - - // Deletion successfull? - if ( $this->client->GetHttpResultCode() != '200' and $this->client->GetHttpResultCode() != '204' ) - { - throw new CalDAVException('Recieved unknown HTTP status', $this->client); - } - } - - /** - * function getEvents() - * Gets a all events from the CalDAV-Server which lie in a defined time interval. - * - * Arguments: - * @param $start The starting point of the time interval. Must be in the format yyyymmddThhmmssZ and should be in - * GMT. If omitted the value is set to -infinity. - * @param $end The end point of the time interval. Must be in the format yyyymmddThhmmssZ and should be in - * GMT. If omitted the value is set to +infinity. - * - * Return value: - * @return an array of CalDAVObjects (See CalDAVObject.php), representing the found events. - * - * Debugging: - * @throws CalDAVException - * For debugging purposes, just sorround everything with try { ... } catch (Exception $e) { echo $e->__toString(); exit(-1); } - */ - function getEvents ( $start = null, $end = null ) - { - // Connection and calendar set? - if(!isset($this->client)) throw new Exception('No connection. Try connect().'); - if(!isset($this->client->calendar_url)) throw new Exception('No calendar selected. Try findCalendars() and setCalendar().'); - - // Are $start and $end in the correct format? - if ( ( isset($start) and ! preg_match( '#^\d\d\d\d\d\d\d\dT\d\d\d\d\d\dZ$#', $start, $matches ) ) - or ( isset($end) and ! preg_match( '#^\d\d\d\d\d\d\d\dT\d\d\d\d\d\dZ$#', $end, $matches ) ) ) - { trigger_error('$start or $end are in the wrong format. They must have the format yyyymmddThhmmssZ and should be in GMT', E_USER_ERROR); } - - // Get it! - $results = $this->client->GetEvents( $start, $end ); - - // GET-request successfull? - if ( $this->client->GetHttpResultCode() != '207' ) - { - throw new CalDAVException('Recieved unknown HTTP status', $this->client); - } - - // Reformat - $report = array(); - foreach($results as $event) $report[] = new CalDAVObject($this->url.$event['href'], $event['data'], $event['etag']); - - return $report; - } - - /** - * function getTODOs() - * Gets a all TODOs from the CalDAV-Server which lie in a defined time interval and match the - * given criteria. - * - * Arguments: - * @param $start The starting point of the time interval. Must be in the format yyyymmddThhmmssZ and should be in - * GMT. If omitted the value is set to -infinity. - * @param $end The end point of the time interval. Must be in the format yyyymmddThhmmssZ and should be in - * GMT. If omitted the value is set to +infinity. - * @param $complete Filter for completed tasks (true) or for uncompleted tasks (false). If omitted, the function will return both. - * @param $cancelled Filter for cancelled tasks (true) or for uncancelled tasks (false). If omitted, the function will return both. - * - * Return value: - * @return an array of CalDAVObjects (See CalDAVObject.php), representing the found TODOs. - * - * Debugging: - * @throws CalDAVException - * For debugging purposes, just sorround everything with try { ... } catch (Exception $e) { echo $e->__toString(); exit(-1); } - */ - function getTODOs ( $start = null, $end = null, $completed = null, $cancelled = null ) - { - // Connection and calendar set? - if(!isset($this->client)) throw new Exception('No connection. Try connect().'); - if(!isset($this->client->calendar_url)) throw new Exception('No calendar selected. Try findCalendars() and setCalendar().'); - - // Are $start and $end in the correct format? - if ( ( isset($start) and ! preg_match( '#^\d\d\d\d\d\d\d\dT\d\d\d\d\d\dZ$#', $start, $matches ) ) - or ( isset($end) and ! preg_match( '#^\d\d\d\d\d\d\d\dT\d\d\d\d\d\dZ$#', $end, $matches ) ) ) - { trigger_error('$start or $end are in the wrong format. They must have the format yyyymmddThhmmssZ and should be in GMT', E_USER_ERROR); } - - // Get it! - $results = $this->client->GetTodos( $start, $end, $completed, $cancelled ); - - // GET-request successfull? - if ( $this->client->GetHttpResultCode() != '207' ) - { - throw new CalDAVException('Recieved unknown HTTP status', $this->client); - } - - // Reformat - $report = array(); - foreach($results as $event) $report[] = new CalDAVObject($this->url.$event['href'], $event['data'], $event['etag']); - - return $report; - } - - /** - * function getCustomReport() - * Sends a custom request to the server - * (Sends a REPORT-request with a custom -tag) - * - * You can either write the filterXML yourself or build an CalDAVFilter-object (see CalDAVFilter.php). - * - * See http://www.rfcreader.com/#rfc4791_line1524 for more information about how to write filters on your own. - * - * Arguments: - * @param $filterXML The stuff, you want to send encapsulated in the -tag. - * - * Return value: - * @return an array of CalDAVObjects (See CalDAVObject.php), representing the found calendar resources. - * - * Debugging: - * @throws CalDAVException - * For debugging purposes, just sorround everything with try { ... } catch (Exception $e) { echo $e->__toString(); exit(-1); } - */ - function getCustomReport ( $filterXML ) - { - // Connection and calendar set? - if(!isset($this->client)) throw new Exception('No connection. Try connect().'); - if(!isset($this->client->calendar_url)) throw new Exception('No calendar selected. Try findCalendars() and setCalendar().'); - - // Get report! - $this->client->SetDepth('1'); - - // Get it! - $results = $this->client->DoCalendarQuery(''.$filterXML.''); - - // GET-request successfull? - if ( $this->client->GetHttpResultCode() != '207' ) - { - throw new CalDAVException('Recieved unknown HTTP status', $this->client); - } - - // Reformat - $report = array(); - foreach($results as $event) $report[] = new CalDAVObject($this->url.$event['href'], $event['data'], $event['etag']); - - return $report; - } -} - -?> diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..9be68eb --- /dev/null +++ b/composer.json @@ -0,0 +1,27 @@ +{ + "name": "thecsea/simple-caldav-client", + "type": "library", + "keywords": ["caldav","client", "simple"], + "description": "A simple and complete php caldav client", + "homepage": "http://www.thecsea.it", + "minimum-stability": "stable", + "license": "GPL-2.0", + "authors": [ + { + "name": "claudio cardinale", + "email": "cardi@thecsea.it", + "homepage": "http://thecsea.it" + } + ], + "require": { + "php": ">=5.3.0", + "ext-curl": "*", + "ext-xml": "*" + }, + "autoload": { + "psr-4": { + "it\\thecsea\\simple_caldav_client\\": "src/" + } + } + +} \ No newline at end of file diff --git a/config/listCalendars.php b/config/listCalendars.php index e24d2f3..95375c1 100644 --- a/config/listCalendars.php +++ b/config/listCalendars.php @@ -11,7 +11,9 @@ * @package simpleCalDAV */ -require_once('../SimpleCalDAVClient.php'); +require_once('../vendor/autoload.php'); + +use it\thecsea\simple_caldav_client\SimpleCalDAVClient; if($_POST == null) { echo ' diff --git a/example code/example.php b/example code/example.php index c0dfca8..4b26279 100644 --- a/example code/example.php +++ b/example code/example.php @@ -1,6 +1,8 @@ connect('http://yourServer/baikal/cal.php/calendars/yourUser/yourCalendar', 'username', 'password'); + $client->connect('http://yourServer/baikal/cal.php/calendars/yourUser/yourCalendar', 'username', 'password'); + /* With proxy + $client->connect('http://yourServer/baikal/cal.php/calendars/yourUser/yourCalendar', 'username', 'password', ['proxy_host'=>'http://myproxyip:myproxyport']); + */ + $arrayOfCalendars = $client->findCalendars(); // Returns an array of all accessible calendars on the server. diff --git a/src/CalDAVCalendar.php b/src/CalDAVCalendar.php new file mode 100644 index 0000000..2aa0f7e --- /dev/null +++ b/src/CalDAVCalendar.php @@ -0,0 +1,108 @@ + + * + * This class represents an accsessible calendar on the server. + * + * I think the functions + * - getURL() + * - getDisplayName() + * - getCalendarID() + * - getRGBAcolor() + * - getRBGcolor() + * are pretty self-explanatory. + * + * + * getCTag() returns the ctag of the calendar. + * The ctag is an hash-value used to check, if the client is up to date. The ctag changes everytime + * someone changes something in the calendar. So, to check if anything happend since your last visit: + * just compare the ctags. + * + * getOrder() returns the order of the calendar in the list of calendars + * + * + * @package simpleCalDAV + * + */ + +namespace it\thecsea\simple_caldav_client; + +class CalDAVCalendar { + private $url; + private $displayname; + private $ctag; + private $calendar_id; + private $rgba_color; + private $rbg_color; + private $order; + + function __construct ( $url, $displayname = null, $ctag = null, $calendar_id = null, $rbg_color = null, $order = null ) { + $this->url = $url; + $this->displayname = $displayname; + $this->ctag = $ctag; + $this->calendar_id = $calendar_id; + $this->rbg_color = $rbg_color; + $this->order = $order; + } + + function __toString () { + return( '(URL: '.$this->url.' Ctag: '.$this->ctag.' Displayname: '.$this->displayname .')'. "\n" ); + } + + // Getters + + function getURL () { + return $this->url; + } + + function getDisplayName () { + return $this->displayname; + } + + function getCTag () { + return $this->ctag; + } + + function getCalendarID () { + return $this->calendar_id; + } + + function getRBGcolor () { + return $this->rbg_color; + } + + function getOrder () { + return $this->order; + } + + + // Setters + + function setURL ( $url ) { + $this->url = $url; + } + + function setDisplayName ( $displayname ) { + $this->displayname = $displayname; + } + + function setCtag ( $ctag ) { + $this->ctag = $ctag; + } + + function setCalendarID ( $calendar_id ) { + $this->calendar_id = $calendar_id; + } + + function setRBGcolor ( $rbg_color ) { + $this->rbg_color = $rbg_color; + } + + function setOrder ( $order ) { + $this->order = $order; + } +} + +?> \ No newline at end of file diff --git a/src/CalDAVClient.php b/src/CalDAVClient.php new file mode 100644 index 0000000..e731a5a --- /dev/null +++ b/src/CalDAVClient.php @@ -0,0 +1,1347 @@ + + * + * This file is heavily based on AgenDAV caldav-client-v2.php by + * Jorge López Pérez which is again heavily based + * on DAViCal caldav-client-v2.php by Andrew McMillan + * + * + * @package simpleCalDAV + */ + +namespace it\thecsea\simple_caldav_client; + +use it\thecsea\simple_caldav_client\includes\XMLDocument; +use it\thecsea\simple_caldav_client\includes\XMLElement; + +class CalDAVClient { + /** + * Server, username, password, calendar + * + * @var string + */ + protected $base_url, $user, $pass, $entry, $protocol, $server, $port; + + /** + * The principal-URL we're using + */ + protected $principal_url; + + /** + * The calendar-URL we're using + */ + public $calendar_url; + + /** + * The calendar-home-set we're using + */ + protected $calendar_home_set; + + /** + * The calendar_urls we have discovered + */ + protected $calendar_urls; + + /** + * The useragent which is send to the caldav server + * + * @var string + */ + public $user_agent = 'simpleCalDAVclient'; + + protected $headers = array(); + protected $body = ""; + protected $requestMethod = "GET"; + protected $httpRequest = ""; // for debugging http headers sent + protected $xmlRequest = ""; // for debugging xml sent + protected $httpResponse = ""; // http headers received + protected $xmlResponse = ""; // xml received + protected $httpResultCode = ""; + private $httpResponseHeaders = ''; + private $httpResponseBody = ''; + + protected $parser; // our XML parser object + protected $request_url = ""; + protected $xmlnodes = array(); + protected $xmltags = array(); + + // Requests timeout + private $timeout; + + // cURL handle + private $ch; + + // Full URL + private $full_url; + + // First part of the full url + public $first_url_part; + + /** + * Constructor + * + * @param string $base_url + * @param string $user + * @param string $pass + * @param array $options + * + * Valid options are: + * + * $options['auth'] : Auth type. Can be any of values for + * CURLOPT_HTTPAUTH (from + * http://www.php.net/manual/es/function.curl-setopt.php). Default: + * basic or digest + * + * $options['timeout'] : Timeout in seconds + */ + + // TODO: proxy options, interface used, + function __construct( $base_url, $user, $pass, $options = array()) { + $this->user = $user; + $this->pass = $pass; + $this->headers = array(); + + if ( preg_match( '#^((https?)://([a-z0-9.-]+)(:([0-9]+))?)(/.*)$#', $base_url, $matches ) ) { + $this->server = $matches[3]; + $this->base_url = $matches[6]; + if ( $matches[2] == 'https' ) { + $this->protocol = 'ssl'; + $this->port = 443; + } + else { + $this->protocol = 'tcp'; + $this->port = 80; + } + if ( $matches[4] != '' ) { + $this->port = intval($matches[5]); + } + } else { + trigger_error("Invalid URL: '".$base_url."'", E_USER_ERROR); + } + + $this->timeout = isset($options['timeout']) ? + $options['timeout'] : 10; + $this->ch = curl_init(); + curl_setopt_array($this->ch, array( + CURLOPT_CONNECTTIMEOUT => $this->timeout, + CURLOPT_FAILONERROR => FALSE, + CURLOPT_MAXREDIRS => 2, + CURLOPT_FORBID_REUSE => FALSE, + CURLOPT_RETURNTRANSFER => TRUE, + CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, + CURLOPT_HTTPAUTH => + isset($options['auth']) ? $options['auth'] : + (CURLAUTH_BASIC | CURLAUTH_DIGEST), + CURLOPT_USERAGENT => 'cURL based CalDAV client', + CURLINFO_HEADER_OUT => TRUE, + CURLOPT_HEADER => TRUE, + CURLOPT_SSL_VERIFYPEER => FALSE + )); + + // Define Proxy + if(isset($options['proxy_host'])) { + curl_setopt($this->ch, CURLOPT_PROXY, $options['proxy_host']); + } + + $this->full_url = $base_url; + $this->first_url_part = $matches[1]; + } + + /** + * Check with OPTIONS if calendar-access is enabled + * + * Can be used to check authentication against server + * + * @return bool + */ + function isValidCalDAVServer() { + // Clean headers + $this->headers = array(); + $dav_options = $this->DoOptionsRequestAndGetDAVHeader(); + return isset($dav_options['calendar-access']); + } + + /** + * Issues an OPTIONS request + * + * @param string $url The URL to make the request to + * + * @return array DAV options + */ + function DoOptionsRequestAndGetDAVHeader( $url = null ) { + $this->requestMethod = "OPTIONS"; + $this->body = ""; + $headers = $this->DoRequest($url); + + $result = array(); + + $headers = preg_split('/\r?\n/', $headers); + + // DAV header(s) + $dav_header = preg_grep('/^DAV:/i', $headers); // /i for case insensitive as some servers (example Nextcloud) do not send uppercase headers + if (is_array($dav_header)) { + $dav_header = array_values($dav_header); + $dav_header = preg_replace('/^DAV: /i', '', $dav_header); // /i for case insensitive + $dav_options = array(); + + foreach ($dav_header as $d) { + $dav_options = array_merge($dav_options, + array_flip(preg_split('/[, ]+/', $d))); + } + + $result = $dav_options; + + } + + return $result; + } + + + /** + * Adds an If-Match or If-None-Match header + * + * @param bool $match to Match or Not to Match, that is the question! + * @param string $etag The etag to match / not match against. + */ + function SetMatch( $match, $etag = '*' ) { + $this->headers['match'] = sprintf( "%s-Match: \"%s\"", ($match ? "If" : "If-None"), $etag); + } + + /** + * Add a Depth: header. Valid values are 0, 1 or infinity + * + * @param string $depth The depth, default to infinity + */ + function SetDepth( $depth = '0' ) { + $this->headers['depth'] = 'Depth: '. ($depth == '1' ? "1" : ($depth == 'infinity' ? $depth : "0") ); + } + + /** + * @param string|null $user_agent + */ + function SetUserAgent( $user_agent = null ) { + $this->user_agent = $user_agent; + curl_setopt($this->ch, CURLOPT_USERAGENT, $user_agent); + } + + /** + * Add a Content-type: header. + * + * @param string $type The content type + */ + function SetContentType( $type ) { + $this->headers['content-type'] = "Content-type: $type"; + } + + /** + * Set the calendar_url we will be using for a while. + * + * @param string $url The calendar_url + */ + function SetCalendar( $url ) { + $this->calendar_url = $url; + } + + /** + * Split response into httpResponse and xmlResponse + * + * @param string $response Response from server + */ + function ParseResponse( $response ) { + $pos = strpos($response, 'httpResponse = trim($response); + } + else { + $this->httpResponse = trim(substr($response, 0, $pos)); + $this->xmlResponse = trim(substr($response, $pos)); + $this->xmlResponse = preg_replace('{>[^>]*$}s', '>',$this->xmlResponse ); + $parser = xml_parser_create_ns('UTF-8'); + xml_parser_set_option ( $parser, XML_OPTION_SKIP_WHITE, 1 ); + xml_parser_set_option ( $parser, XML_OPTION_CASE_FOLDING, 0 ); + + if ( xml_parse_into_struct( $parser, $this->xmlResponse, $this->xmlnodes, $this->xmltags ) === 0 ) { + //printf( "XML parsing error: %s - %s\n", xml_get_error_code($parser), xml_error_string(xml_get_error_code($parser)) ); + // debug_print_backtrace(); + // echo "\nNodes array............................................................\n"; print_r( $this->xmlnodes ); + // echo "\nTags array............................................................\n"; print_r( $this->xmltags ); + //printf( "\nXML Reponse:\n%s\n", $this->xmlResponse ); + log_message('ERROR', 'XML parsing error: ' + . xml_get_error_code($parser) . ', ' + . xml_error_string(xml_get_error_code($parser))); + } + + xml_parser_free($parser); + } + } + + /** + * Parse response headers + * + * @param string $headers + */ + function ParseResponseHeaders($headers) { + $lines = preg_split('/[\r\n]+/', $headers); + $this->httpResultCode = preg_replace('/^[\S]+ (\d+).+$/', '\1', + $lines[0]); + } + + /** + * Output http request headers + * + * @return string HTTP headers + */ + function GetHttpRequest() { + return $this->httpRequest; + } + /** + * Output http response headers + * + * @return string HTTP headers + */ + function GetResponseHeaders() { + return $this->httpResponseHeaders; + } + /** + * Output http response body + * + * @return string HTTP body + */ + function GetResponseBody() { + return $this->httpResponseBody; + } + /** + * Output request body + * + * @return string raw xml + */ + function GetBody() { + return $this->body; + } + /** + * Output xml response + * + * @return string raw xml + */ + function GetXmlResponse() { + return $this->xmlResponse; + } + /** + * Output HTTP status code + * + * @return string HTTP status code + */ + function GetHttpResultCode() { + return $this->httpResultCode; + } + + /** + * Send a request to the server + * + * @param string $url The URL to make the request to + * + * @return bool|string The content of the response from the server + */ + function DoRequest( $url = null ) { + if (is_null($url)) { + $url = $this->full_url; + } + + $this->request_url = $url; + + curl_setopt($this->ch, CURLOPT_URL, $url); + + // Request method + curl_setopt($this->ch, CURLOPT_CUSTOMREQUEST, $this->requestMethod); + + // Empty body. If not used, cURL will spend ~5s on this request + if ($this->requestMethod == 'HEAD' || empty($this->body) ) { + curl_setopt($this->ch, CURLOPT_NOBODY, TRUE); + } else { + curl_setopt($this->ch, CURLOPT_NOBODY, FALSE); + } + + // Headers + if (!isset($this->headers['content-type'])) $this->headers['content-type'] = "Content-type: text/plain"; + + // Remove cURL generated 'Expect: 100-continue' + $this->headers['disable_expect'] = 'Expect:'; + curl_setopt($this->ch, CURLOPT_HTTPHEADER, + array_values($this->headers)); + + curl_setopt($this->ch, CURLOPT_USERPWD, $this->user . ':' . + $this->pass); + + // Request body + curl_setopt($this->ch, CURLOPT_POSTFIELDS, $this->body); + + // Save Request + curl_setopt($this->ch, CURLINFO_HEADER_OUT, TRUE); + curl_setopt($this->ch, CURLOPT_HTTP09_ALLOWED, true); + + $response = curl_exec($this->ch); + + if (FALSE === $response) { + // TODO better error handling + log_message('ERROR', 'Error requesting ' . $url . ': ' + . curl_error($this->ch)); + return false; + } + + $info = curl_getinfo($this->ch); + + // Save request + $this->httpRequest = $info['request_header']; + + // Get headers (idea from SabreDAV WebDAV client) + $this->httpResponseHeaders = substr($response, 0, $info['header_size']); + $this->httpResponseBody = substr($response, $info['header_size']); + + // Get only last headers (needed when using unspecific HTTP auth + // method or request got redirected) + $this->httpResponseHeaders = preg_replace('/^.+\r\n\r\n(.+)/sU', '$1', + $this->httpResponseHeaders); + + // Parse response + $this->ParseResponseHeaders($this->httpResponseHeaders); + $this->ParseResponse($this->httpResponseBody); + + //TODO debug + + /* + log_message('INTERNALS', 'REQh: ' . var_export($info['request_header'], TRUE)); + log_message('INTERNALS', 'REQb: ' . var_export($this->body, TRUE)); + log_message('INTERNALS', 'RPLh: ' . var_export($this->httpResponseHeaders, TRUE)); + log_message('INTERNALS', 'RPLb: ' . var_export($this->httpResponseBody, TRUE)); + */ + + return $response; + } + + /** + * Send an OPTIONS request to the server + * + * @param string $url The URL to make the request to + * + * @return array The allowed options + */ + function DoOptionsRequest( $url = null ) { + $this->requestMethod = "OPTIONS"; + $this->body = ""; + $headers = $this->DoRequest($url); + $options_header = preg_replace( '/^.*Allow: ([a-z, ]+)\r?\n.*/is', '$1', $headers ); + $options = array_flip( preg_split( '/[, ]+/', $options_header )); + return $options; + } + + + + /** + * Send an XML request to the server (e.g. PROPFIND, REPORT, MKCALENDAR) + * + * @param string $request_method The method (PROPFIND, REPORT, etc) to use with the request + * @param string $xml The XML to send along with the request + * @param string $url The URL to make the request to + * + * @return array An array of the allowed methods + */ + function DoXMLRequest( $request_method, $xml, $url = null ) { + $this->body = $xml; + $this->requestMethod = $request_method; + $this->SetContentType("text/xml"); + return $this->DoRequest($url); + } + + + + /** + * Get a single item from the server. + * + * @param string $url The URL to GET + */ + function DoGETRequest( $url ) { + $this->body = ""; + $this->requestMethod = "GET"; + return $this->DoRequest( $url ); + } + + + /** + * Get the HEAD of a single item from the server. + * + * @param string $url The URL to HEAD + */ + function DoHEADRequest( $url ) { + $this->body = ""; + $this->requestMethod = "HEAD"; + return $this->DoRequest( $url ); + } + + + /** + * PUT a text/icalendar resource, returning the etag + * + * @param string $url The URL to make the request to + * @param string $icalendar The iCalendar resource to send to the server + * @param string $etag The etag of an existing resource to be overwritten, or '*' for a new resource. + * + * @return string The content of the response from the server + */ + function DoPUTRequest( $url, $icalendar, $etag = null ) { + $this->body = $icalendar; + + $this->requestMethod = "PUT"; + if ( $etag != null ) { + $this->SetMatch( ($etag != '*'), $etag ); + } + $this->SetContentType('text/calendar; encoding="utf-8"'); + $this->DoRequest($url); + + $etag = null; + if ( preg_match( '{^ETag:\s+"([^"]*)"\s*$}im', $this->httpResponseHeaders, $matches ) ) $etag = $matches[1]; + else if ( preg_match( '{^ETag:\s+([^\s]*)\s*$}im', $this->httpResponseHeaders, $matches ) ) $etag = $matches[1]; + if ( !isset($etag) || $etag == '' ) { + // Try with HEAD + $save_request = $this->httpRequest; + $save_response_headers = $this->httpResponseHeaders; + $save_http_result = $this->httpResultCode; + $this->DoHEADRequest( $url ); + if ( preg_match( '{^Etag:\s+"([^"]*)"\s*$}im', $this->httpResponseHeaders, $matches ) ) $etag = $matches[1]; + else if ( preg_match( '{^ETag:\s+([^\s]*)\s*$}im', $this->httpResponseHeaders, $matches ) ) $etag = $matches[1]; + /* + if ( !isset($etag) || $etag == '' ) { + printf( "Still No etag in:\n%s\n", $this->httpResponseHeaders ); + } + */ + $this->httpRequest = $save_request; + $this->httpResponseHeaders = $save_response_headers; + $this->httpResultCode = $save_http_result; + } + return $etag; + } + + + /** + * DELETE a text/icalendar resource + * + * @param string $url The URL to make the request to + * @param string $etag The etag of an existing resource to be deleted, or '*' for any resource at that URL. + * + * @return int The HTTP Result Code for the DELETE + */ + function DoDELETERequest( $url, $etag = null ) { + $this->body = ""; + + $this->requestMethod = "DELETE"; + if ( $etag != null ) { + $this->SetMatch( true, $etag ); + } + $this->DoRequest($url); + return $this->httpResultCode; + } + + + /** + * Get a single item from the server. + * + * @param string $url The URL to PROPFIND on + * @param raw|string + */ + function DoPROPFINDRequest( $url, $props, $depth = 0 ) { + $this->SetDepth($depth); + $xml = new XMLDocument( array( 'DAV:' => '', 'urn:ietf:params:xml:ns:caldav' => 'C' ) ); + $prop = new XMLElement('prop'); + foreach( $props AS $v ) { + $xml->NSElement($prop,$v); + } + + $this->body = $xml->Render('propfind',$prop ); + + $this->requestMethod = 'PROPFIND'; + $this->SetContentType('text/xml'); + $this->DoRequest($url); + return $this->GetXmlResponse(); + } + + + /** + * Get/Set the Principal URL + * + * @param $url string|null The Principal URL to set + * @return string + */ + function PrincipalURL( $url = null ) { + if ( isset($url) ) { + $this->principal_url = $url; + } + return $this->principal_url; + } + + + /** + * Get/Set the calendar-home-set URL + * + * @param $urls array|null of string The calendar-home-set URLs to set + * @return array|array[] + */ + function CalendarHomeSet( $urls = null ) { + if ( isset($urls) ) { + if ( ! is_array($urls) ) $urls = array($urls); + $this->calendar_home_set = $urls; + } + return $this->calendar_home_set; + } + + + /** + * Get/Set the calendar-home-set URL + * + * @param $urls array of string The calendar URLs to set + * @return array|array[] + */ + function CalendarUrls( $urls = null ) { + if ( isset($urls) ) { + if ( ! is_array($urls) ) $urls = array($urls); + $this->calendar_urls = $urls; + } + return $this->calendar_urls; + } + + + /** + * Return the first occurrence of an href inside the named tag. + * + * @param string $tagname The tag name to find the href inside of + * @return string|null + */ + function HrefValueInside( $tagname ) { + if (!isset($this->xmltags[$tagname])) { + return null; + } + + foreach( $this->xmltags[$tagname] AS $k => $v ) { + $j = $v + 1; + if ( $this->xmlnodes[$j]['tag'] == 'DAV::href' ) { + return rawurldecode($this->xmlnodes[$j]['value']); + } + } + return null; + } + + + /** + * Return the href containing this property. Except only if it's inside a status != 200 + * + * @param string $tagname The tag name of the property to find the href for + * @param int $i Which instance of the tag should we use + */ + function HrefForProp( $tagname, $i = 0 ) { + if ( isset($this->xmltags[$tagname]) && isset($this->xmltags[$tagname][$i]) ) { + $j = $this->xmltags[$tagname][$i]; + while( $j-- > 0 && $this->xmlnodes[$j]['tag'] != 'DAV::href' ) { + // printf( "Node[$j]: %s\n", $this->xmlnodes[$j]['tag']); + if ( $this->xmlnodes[$j]['tag'] == 'DAV::status' && $this->xmlnodes[$j]['value'] != 'HTTP/1.1 200 OK' ) return null; + } + // printf( "Node[$j]: %s\n", $this->xmlnodes[$j]['tag']); + if ( $j > 0 && isset($this->xmlnodes[$j]['value']) ) { + // printf( "Value[$j]: %s\n", $this->xmlnodes[$j]['value']); + return rawurldecode($this->xmlnodes[$j]['value']); + } + } + else { + // printf( "xmltags[$tagname] or xmltags[$tagname][$i] is not set\n"); + } + return null; + } + + + /** + * Return the href which has a resourcetype of the specified type + * + * @param string $tagname The tag name of the resourcetype to find the href for + * @param int $i Which instance of the tag should we use + */ + function HrefForResourcetype( $tagname, $i = 0 ) { + if ( isset($this->xmltags[$tagname]) && isset($this->xmltags[$tagname][$i]) ) { + $j = $this->xmltags[$tagname][$i]; + while( $j-- > 0 && $this->xmlnodes[$j]['tag'] != 'DAV::resourcetype' ); + if ( $j > 0 ) { + while( $j-- > 0 && $this->xmlnodes[$j]['tag'] != 'DAV::href' ); + if ( $j > 0 && isset($this->xmlnodes[$j]['value']) ) { + return rawurldecode($this->xmlnodes[$j]['value']); + } + } + } + return null; + } + + + /** + * Return the ... of a propstat where the status is OK + * + * @param string $nodenum The node number in the xmlnodes which is the href + */ + function GetOKProps( $nodenum ) { + $props = null; + $level = $this->xmlnodes[$nodenum]['level']; + $status = ''; + while ( $this->xmlnodes[++$nodenum]['level'] >= $level ) { + if ( $this->xmlnodes[$nodenum]['tag'] == 'DAV::propstat' ) { + if ( $this->xmlnodes[$nodenum]['type'] == 'open' ) { + $props = array(); + $status = ''; + } + else { + if ( $status == 'HTTP/1.1 200 OK' ) break; + } + } + elseif ( !isset($this->xmlnodes[$nodenum]) || !is_array($this->xmlnodes[$nodenum]) ) { + break; + } + elseif ( $this->xmlnodes[$nodenum]['tag'] == 'DAV::status' ) { + $status = $this->xmlnodes[$nodenum]['value']; + } + else { + $props[] = $this->xmlnodes[$nodenum]; + } + } + return $props; + } + + + /** + * Attack the given URL in an attempt to find a principal URL + * + * @param string $url The URL to find the principal-URL from + */ + function FindPrincipal( $url = null ) { + $xml = $this->DoPROPFINDRequest( $url, array('resourcetype', 'current-user-principal', 'owner', 'principal-URL', + 'urn:ietf:params:xml:ns:caldav:calendar-home-set'), 1); + + $principal_url = $this->HrefForProp('DAV::principal'); + + if ( !isset($principal_url) ) { + foreach( array('DAV::current-user-principal', 'DAV::principal-URL', 'DAV::owner') AS $href ) { + if ( !isset($principal_url) ) { + $principal_url = $this->HrefValueInside($href); + } + } + } + + return $this->PrincipalURL($principal_url); + } + + + /** + * @param bool $recursed + * @return array|array[] + */ + function FindCalendarHome( $recursed=false ) { + if ( !isset($this->principal_url) ) { + $this->FindPrincipal(); + } + if ( $recursed ) { + $this->DoPROPFINDRequest( $this->first_url_part.$this->principal_url, array('urn:ietf:params:xml:ns:caldav:calendar-home-set'), 0); + } + + $calendar_home = array(); + if (isset($this->xmltags['urn:ietf:params:xml:ns:caldav:calendar-home-set'])) { + foreach( $this->xmltags['urn:ietf:params:xml:ns:caldav:calendar-home-set'] AS $k => $v ) { + if ( $this->xmlnodes[$v]['type'] != 'open' ) continue; + while( $this->xmlnodes[++$v]['type'] != 'close' && $this->xmlnodes[$v]['tag'] != 'urn:ietf:params:xml:ns:caldav:calendar-home-set' ) { + // printf( "Tag: '%s' = '%s'\n", $this->xmlnodes[$v]['tag'], $this->xmlnodes[$v]['value']); + if ( $this->xmlnodes[$v]['tag'] == 'DAV::href' && isset($this->xmlnodes[$v]['value']) ) + $calendar_home[] = rawurldecode($this->xmlnodes[$v]['value']); + } + } + } + + if ( !$recursed && count($calendar_home) < 1 ) { + $calendar_home = $this->FindCalendarHome(true); + } + + return $this->CalendarHomeSet($calendar_home); + } + + /** + * Find own calendars + * + * @param bool $recursed + * @return array + */ + function FindCalendars( $recursed=false ) { + if ( !isset($this->calendar_home_set[0]) ) { + $this->FindCalendarHome($recursed); + } + $properties = array( + 'resourcetype', + 'displayname', + 'http://calendarserver.org/ns/:getctag', + 'http://apple.com/ns/ical/:calendar-color', + 'http://apple.com/ns/ical/:calendar-order', + ); + @$this->DoPROPFINDRequest( $this->first_url_part.$this->calendar_home_set[0], $properties, 1); + + return $this->parse_calendar_info(); + } + + /** + * Do a PROPFIND on a calendar and retrieve its information + * + * @param string $url + * @return array + */ + function GetCalendarDetailsByURL($url) { + $properties = array( + 'resourcetype', + 'displayname', + 'http://calendarserver.org/ns/:getctag', + 'http://apple.com/ns/ical/:calendar-color', + 'http://apple.com/ns/ical/:calendar-order', + ); + $this->DoPROPFINDRequest($url, $properties, 0); + + return $this->parse_calendar_info(); + } + + /** + * Find the calendars, from the calendar_home_set + * + * @param string|null $url + * @return CalDAVCalendar + */ + function GetCalendarDetails( $url = null ) { + if ( isset($url) ) $this->SetCalendar($url); + + $calendar_properties = array( 'resourcetype', 'displayname', 'http://calendarserver.org/ns/:getctag', 'urn:ietf:params:xml:ns:caldav:calendar-timezone', 'supported-report-set' ); + $this->DoPROPFINDRequest( $this->calendar_url, $calendar_properties, 0); + + $hnode = $this->xmltags['DAV::href'][0]; + $href = rawurldecode($this->xmlnodes[$hnode]['value']); + + $calendar = new CalDAVCalendar($href); + $ok_props = $this->GetOKProps($hnode); + foreach( $ok_props AS $k => $v ) { + $name = preg_replace( '{^.*:}', '', $v['tag'] ); + if ( isset($v['value'] ) ) { + $calendar->{$name} = $v['value']; + } + /* else { + printf( "Calendar property '%s' has no text content\n", $v['tag'] ); + }*/ + } + + return $calendar; + } + + + /** + * Get all etags for a calendar + * + * @param string|null $url + * @return array + */ + function GetCollectionETags( $url = null ) { + if ( isset($url) ) $this->SetCalendar($url); + + $this->DoPROPFINDRequest( $this->calendar_url, array('getetag'), 1); + + $etags = array(); + if ( isset($this->xmltags['DAV::getetag']) ) { + foreach( $this->xmltags['DAV::getetag'] AS $k => $v ) { + $href = $this->HrefForProp('DAV::getetag', $k); + if ( isset($href) && isset($this->xmlnodes[$v]['value']) ) $etags[$href] = $this->xmlnodes[$v]['value']; + } + } + + return $etags; + } + + + /** + * Get a bunch of events for a calendar with a calendar-multiget report + * + * @param array $event_hrefs + * @param string|null $url + * @return array + */ + function CalendarMultiget( $event_hrefs, $url = null ) { + + if ( isset($url) ) $this->SetCalendar($url); + + $hrefs = ''; + foreach( $event_hrefs AS $k => $href ) { + $href = str_replace( rawurlencode('/'),'/',rawurlencode($href)); + $hrefs .= ''.$href.''; + } + $this->body = << + + +$hrefs + +EOXML; + + $this->requestMethod = "REPORT"; + $this->SetContentType("text/xml"); + $response = $this->DoRequest( $this->calendar_url ); + + $report = array(); + foreach( $this->xmlnodes as $k => $v ) { + switch( $v['tag'] ) { + case 'DAV::response': + if ( $v['type'] == 'open' ) { + $response = array(); + } + elseif ( $v['type'] == 'close' ) { + $report[] = $response; + } + break; + case 'DAV::href': + $response['href'] = basename( rawurldecode($v['value']) ); + break; + case 'DAV::getetag': + $response['etag'] = preg_replace('/^"?([^"]+)"?/', '$1', $v['value']); + break; + case 'urn:ietf:params:xml:ns:caldav:calendar-data': + $response['data'] = $v['value']; + break; + } + } + + return $report; + } + + + /** + * 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. + * + * @param string $filter XML fragment which is the element of a calendar-query + * @param string $url The URL of the calendar, or null to use the 'current' calendar_url + * + * @return array An array of the relative URLs, etags, and events from the server. Each element of the array will + * be an array with 'href', 'etag' and 'data' elements, corresponding to the URL, the server-supplied + * etag (which only varies when the data changes) and the calendar data in iCalendar format. + */ + function DoCalendarQuery( $filter, $url = null ) { + + if ( isset($url) ) $this->SetCalendar($url); + + $this->body = << + + + + +$filter + +EOXML; + + $this->requestMethod = "REPORT"; + $this->SetContentType("text/xml"); + $this->DoRequest( $this->calendar_url ); + + $report = array(); + foreach( $this->xmlnodes as $k => $v ) { + switch( $v['tag'] ) { + case 'DAV::response': + if ( $v['type'] == 'open' ) { + $response = array(); + } + elseif ( $v['type'] == 'close' ) { + $report[] = $response; + } + break; + case 'DAV::href': + $response['href'] = basename( rawurldecode($v['value']) ); + break; + case 'DAV::getetag': + $response['etag'] = preg_replace('/^"?([^"]+)"?/', '$1', $v['value']); + break; + case 'urn:ietf:params:xml:ns:caldav:calendar-data': + $response['data'] = $v['value']; + break; + } + } + return $report; + } + + + /** + * Get the events in a range from $start to $finish. The dates should be in the + * format yyyymmddThhmmssZ and should be in GMT. The events are returned as an + * array of event arrays. Each event array will have a 'href', 'etag' and 'event' + * part, where the 'href' is relative to the calendar and the event contains the + * definition of the event in iCalendar format. + * + * @param string $start The start time for the period + * @param string $finish The finish time for the period + * @param string $relative_url The URL relative to the base_url specified when the calendar was opened. Default null. + * + * @return array An array of the relative URLs, etags, and events, returned from DoCalendarQuery() @see DoCalendarQuery() + */ + function GetEvents( $start = null, $finish = null, $relative_url = null ) { + $this->SetDepth('1'); + $filter = ""; + if ( isset($start) && isset($finish) ) + $range = ""; + elseif ( isset($start) && ! isset($finish) ) + $range = ""; + elseif ( ! isset($start) && isset($finish) ) + $range = ""; + else + $range = ''; + + $filter = << + + +$range + + + +EOFILTER; + + return $this->DoCalendarQuery($filter, $relative_url); + } + + + /** + * Get the todo's in a range from $start to $finish. The dates should be in the + * format yyyymmddThhmmssZ and should be in GMT. The events are returned as an + * array of event arrays. Each event array will have a 'href', 'etag' and 'event' + * part, where the 'href' is relative to the calendar and the event contains the + * definition of the event in iCalendar format. + * + * @param string $start The start time for the period + * @param string $finish The finish time for the period + * @param boolean $completed Whether to include completed tasks + * @param boolean $cancelled Whether to include cancelled tasks + * @param string $relative_url The URL relative to the base_url specified when the calendar was opened. Default ''. + * + * @return array An array of the relative URLs, etags, and events, returned from DoCalendarQuery() @see DoCalendarQuery() + */ + function GetTodos( $start = null, $finish = null, $completed = null, $cancelled = null, $relative_url = "" ) { + $this->SetDepth('1'); + + if ( isset($start) && isset($finish) ) + $range = ""; + elseif ( isset($start) && ! isset($finish) ) + $range = ""; + elseif ( ! isset($start) && isset($finish) ) + $range = ""; + else + $range = ''; + + + // Warning! May contain traces of double negatives... + if(isset($completed) && $completed == true) + $completed_filter = 'COMPLETED'; + else if(isset($completed) && $completed == false) + $completed_filter = 'COMPLETED'; + else + $completed_filter = ''; + + if(isset($cancelled) && $cancelled == true) + $cancelled_filter = 'CANCELLED'; + else if(isset($cancelled) && $cancelled == false) + $cancelled_filter = 'CANCELLED'; + else + $cancelled_filter = ''; + + $filter = << + + +$completed_filter +$cancelled_filter +$range + + + +EOFILTER; + + return $this->DoCalendarQuery($filter); + } + + + /** + * Get the calendar entry by UID + * + * @param string $uid + * @param string $relative_url The URL relative to the base_url specified when the calendar was opened. Default ''. + * + * @return array An array of the relative URL, etag, and calendar data returned from DoCalendarQuery() @see DoCalendarQuery() + */ + function GetEntryByUid( $uid, $relative_url = null ) { + $this->SetDepth('1'); + $filter = ""; + if ( $uid ) { + $filter = << + + + +$uid + + + + +EOFILTER; + } + + return $this->DoCalendarQuery($filter, $relative_url); + } + + + /** + * Get the calendar entry by HREF + * + * @param string $href The href from a call to GetEvents or GetTodos etc. + * + * @return string The iCalendar of the calendar entry + */ + function GetEntryByHref( $href ) { + //$href = str_replace( rawurlencode('/'),'/',rawurlencode($href)); + $response = $this->DoGETRequest( $href ); + + $report = array(); + + if ( $this->GetHttpResultCode() == '404' ) { return $report; } + + $etag = null; + if ( preg_match( '{^ETag:\s+"([^"]*)"\s*$}im', $this->httpResponseHeaders, $matches ) ) $etag = $matches[1]; + else if ( preg_match( '{^ETag:\s+([^\s]*)\s*$}im', $this->httpResponseHeaders, $matches ) ) $etag = $matches[1]; + if ( !isset($etag) || $etag == '' ) { + // Try with HEAD + $save_request = $this->httpRequest; + $save_response_headers = $this->httpResponseHeaders; + $save_http_result = $this->httpResultCode; + $this->DoHEADRequest( $href ); + if ( preg_match( '{^Etag:\s+"([^"]*)"\s*$}im', $this->httpResponseHeaders, $matches ) ) $etag = $matches[1]; + else if ( preg_match( '{^ETag:\s+([^\s]*)\s*$}im', $this->httpResponseHeaders, $matches ) ) $etag = $matches[1]; + + /* + if ( !isset($etag) || $etag == '' ) { + printf( "Still No etag in:\n%s\n", $this->httpResponseHeaders ); + } + */ + $this->httpRequest = $save_request; + $this->httpResponseHeaders = $save_response_headers; + $this->httpResultCode = $save_http_result; + } + + $report = array(array('etag'=>$etag)); + + return $report; + } + + /** + * Get calendar info after a PROPFIND + */ + function parse_calendar_info() { + $calendars = array(); + if ( isset($this->xmltags['urn:ietf:params:xml:ns:caldav:calendar']) ) { + $calendar_urls = array(); + foreach( $this->xmltags['urn:ietf:params:xml:ns:caldav:calendar'] AS $k => $v ) { + $calendar_urls[$this->HrefForProp('urn:ietf:params:xml:ns:caldav:calendar', $k)] = 1; + } + + foreach( $this->xmltags['DAV::href'] AS $i => $hnode ) { + $href = rawurldecode($this->xmlnodes[$hnode]['value']); + + if ( !isset($calendar_urls[$href]) ) continue; + + // printf("Seems '%s' is a calendar.\n", $href ); + + + $calendar = new CalDAVCalendar($href); + + /* + * Transform href into calendar + * /xxxxx/yyyyy/caldav.php/principal/resource/ + * t-3 t-2 + */ + $pieces = preg_split('/\//', $href); + $total = count($pieces); + $calendar_id = $pieces[$total-2]; + $calendar->setCalendarID($calendar_id); + + $ok_props = $this->GetOKProps($hnode); + foreach( $ok_props AS $v ) { + switch( $v['tag'] ) { + case 'http://calendarserver.org/ns/:getctag': + $calendar->setCtag((isset($v['value']) ? + $v['value'] : '-')); + break; + case 'DAV::displayname': + $calendar->setDisplayName((isset($v['value']) ? + $v['value'] : '-')); + break; + case 'http://apple.com/ns/ical/:calendar-color': + $calendar->setRBGcolor((isset($v['value']) ? + $this->_rgba2rgb($v['value']) : '-')); + break; + case 'http://apple.com/ns/ical/:calendar-order': + $calendar->setOrder((isset($v['value']) ? + $v['value'] : '-')); + break; + } + } + $calendars[$calendar->getCalendarID()] = $calendar; + } + } + + return $calendars; + } + /** + * Issues a PROPPATCH on a resource + * + * @param string XML request + * @param string URL + * @return TRUE on success, FALSE otherwise + */ + function DoPROPPATCH($xml_text, $url) { + $this->DoXMLRequest('PROPPATCH', $xml_text, $url); + + $errmsg = ''; + + if ($this->httpResultCode == '207') { + $errmsg = $this->httpResultCode; + // Find propstat tag(s) + if (isset($this->xmltags['DAV::propstat'])) { + foreach ($this->xmltags['DAV::propstat'] as $i => $node) { + if ($this->xmlnodes[$node]['type'] == 'close') { + continue; + } + // propstat @ $i: open + // propstat @ $i + 1: close + // Search for prop and status + $level = $this->xmlnodes[$node]['level']; + $level++; + + while ($this->xmlnodes[++$node]['level'] >= $level) { + if ($this->xmlnodes[$node]['tag'] == 'DAV::status' + && $this->xmlnodes[$node]['value'] != + 'HTTP/1.1 200 OK') { + return $this->xmlnodes[$node]['value']; + } + } + } + } + } else if ($this->httpResultCode != 200) { + return 'Unknown HTTP code'; + } + + return TRUE; + } + + /** + * Queries server using a principal-property search + * + * @param string XML request + * @param string URL + * @return FALSE on error, array with results otherwise + */ + function principal_property_search($xml_text, $url) { + $result = array(); + $this->DoXMLRequest('REPORT', $xml_text, $url); + + if ($this->httpResultCode == '207') { + $errmsg = $this->httpResultCode; + // Find response tag(s) + if (isset($this->xmltags['DAV::response'])) { + foreach ($this->xmltags['DAV::response'] as $i => $node) { + if ($this->xmlnodes[$node]['type'] == 'close') { + continue; + } + + $result[$i]['href'] = + $this->HrefForProp('DAV::response', $i+1); + + $level = $this->xmlnodes[$node]['level']; + $level++; + + $ok_props = $this->GetOKProps($node); + + foreach ($ok_props as $v) { + switch($v['tag']) { + case 'DAV::displayname': + $result[$i]['displayname'] = + isset($v['value']) ? $v['value'] : ''; + break; + case 'DAV::email': + $result[$i]['email'] = + isset($v['value']) ? $v['value'] : ''; + break; + } + } + + } + } + } else if ($this->httpResultCode != 200) { + return 'Unknown HTTP code'; + } + + return $result; + } + + /** + * Converts a RGBA hexadecimal string (#rrggbbXX) to RGB + */ + private function _rgba2rgb($s) { + if (strlen($s) == '9') { + return substr($s, 0, 7); + } else { + // Unknown string + return $s; + } + } + + public function printLastMessages() { + $string = ''; + $dom = new DOMDocument(); + $dom->preserveWhiteSpace = FALSE; + $dom->formatOutput = TRUE; + + $string .= '
';
+        $string .= 'last request:

';
+
+        $string .= $this->httpRequest;
+
+        if(!empty($this->body)) {
+            $dom->loadXML($this->body);
+            $string .= htmlentities($dom->saveXml());
+        }
+
+        $string .= '
last response:

';
+
+        $string .= $this->httpResponse;
+
+        if(!empty($this->xmlResponse)) {
+            $dom->loadXML($this->xmlResponse);
+            $string .= htmlentities($dom->saveXml());
+        }
+
+        $string .= '
'; + + echo $string; + } +} + + /** + * Error handeling functions + */ + +$debug = TRUE; + +function log_message ($type, $message) { + global $debug; + if ($debug) { + echo '['.$type.'] '.$message.'\n'; + } +} diff --git a/src/CalDAVException.php b/src/CalDAVException.php new file mode 100644 index 0000000..70749e1 --- /dev/null +++ b/src/CalDAVException.php @@ -0,0 +1,95 @@ + + * + * This class is an extension to the Exception-class, to store and report additional data in the case + * of a problem. + * For debugging purposes, just sorround all of your SimpleCalDAVClient-Code with try { ... } catch (Exception $e) { echo $e->__toString(); } + * + * @package simpleCalDAV + * + */ + +namespace it\thecsea\simple_caldav_client; + +class CalDAVException extends \Exception { + private $requestHeader; + private $requestBody; + private $responseHeader; + private $responseBody; + + public function __construct($message, $client, $code = 0, Exception $previous = null) { + parent::__construct($message, $code, $previous); + + $this->requestHeader = $client->GetHttpRequest(); + $this->requestBody = $client->GetBody(); + $this->responseHeader = $client->GetResponseHeaders(); + $this->responseBody = $client->GetResponseBody(); + } + + public function __toString() { + $string = ''; + $dom = new \DOMDocument(); + $dom->preserveWhiteSpace = FALSE; + $dom->formatOutput = TRUE; + + $string .= '
';
+        $string .= 'Exception: '.$this->getMessage().'



';
+        $string .= 'If you think there is a bug in SimpleCalDAV, please report the following information on github or send it at palm.michael@gmx.de.


';
+        $string .= '
For debugging purposes:
';
+        $string .= '
last request:

';
+        
+        $string .= $this->requestHeader;
+        
+        if(!empty($this->requestBody)) {
+            
+            if(!preg_match( '#^Content-type:.*?text/calendar.*?$#', $this->requestHeader, $matches)) {
+                $dom->loadXML($this->requestBody);
+                $string .= htmlentities($dom->saveXml());
+            }
+            
+            else $string .= htmlentities($this->requestBody).'

';
+        }
+
+        $string .= '
last response:

';
+        
+        $string .= $this->responseHeader;
+        
+        if(!empty($this->responseBody)) {
+            if(!preg_match( '#^Content-type:.*?text/calendar.*?$#', $this->responseHeader, $matches)) {
+                $dom->loadXML($this->responseBody);
+                $string .= htmlentities($dom->saveXml());
+            }
+            
+            else $string .= htmlentities($this->responseBody);
+        }
+        
+        $string .= '

';
+        
+        $string .= 'Trace:

'.$this->getTraceAsString();
+    
+        $string .= '
'; + + return $string; + } + + public function getRequestHeader() { + return $this->requestHeader; + } + + public function getrequestBody() { + return $this->requestBody; + } + + public function getResponseHeader() { + return $this->responseHeader; + } + + public function getresponseBody() { + return $this->responseBody; + } +} + +?> diff --git a/CalDAVFilter.php b/src/CalDAVFilter.php similarity index 69% rename from CalDAVFilter.php rename to src/CalDAVFilter.php index 5f44471..48c1acd 100644 --- a/CalDAVFilter.php +++ b/src/CalDAVFilter.php @@ -22,9 +22,11 @@ * */ +namespace it\thecsea\simple_caldav_client; + class CalDAVFilter { - private $resourceType; - private $mustIncludes = array(); + private $resourceType; + private $mustIncludes = array(); /* * @param $type The type of resource you want to get. Has to be either @@ -32,75 +34,77 @@ class CalDAVFilter { * You have to decide. */ public function __construct ( $type ) { - $this->resourceType = $type; - } - - /** - * function mustInclude() - * Specifies that a certin property has to be included. The content of the + $this->resourceType = $type; + } + + /** + * function mustInclude() + * Specifies that a certin property has to be included. The content of the * property is irrelevant. * * Only call this function and mustIncludeMatchSubstr() once per property! - * - * Examples: + * + * Examples: * mustInclude("SUMMARY"); specifies that all returned resources have to * have the SUMMARY-property. * mustInclude("LOCATION "); specifies that all returned resources have to * have the LOCATION-property. - * - * Arguments: - * @param $field The name of the property. For a full list of valid + * + * Arguments: + * @param string $field The name of the property. For a full list of valid * property names see http://www.rfcreader.com/#rfc5545_line3622 * Note that the server might not support all of them. - * @param $inverse Makes the effect inverse: The resource must NOT include + * @param bool $inverse Makes the effect inverse: The resource must NOT include * the property $field - */ + */ public function mustInclude ( $field, $inverse = FALSE ) { $this->mustIncludes[] = array("mustInclude", $field, $inverse); } /** - * function mustIncludeMatchSubstr() - * Specifies that a certin property has to be included and that its value + * function mustIncludeMatchSubstr() + * Specifies that a certin property has to be included and that its value * has to match a given substring. * * Only call this function and mustInclude() once per property! - * - * Examples: + * + * Examples: * mustIncludeMatchSubstr("SUMMARY", "a part of the summary"); would return * a resource with "SUMMARY:This is a part of the summary" included, but no * resource with "SUMMARY:This is a part of the". - * - * Arguments: - * @param $field The name of the property. For a full list of valid + * + * Arguments: + * @param string $field The name of the property. For a full list of valid * property names see http://www.rfcreader.com/#rfc5545_line3622 * Note that the server might not support all of them. - * @param $substring Substring to match against the value of the property. - * @param $inverse Makes the effect inverse: The property value must NOT + * @param string $substring Substring to match against the value of the property. + * @param bool $inverse Makes the effect inverse: The property value must NOT * include the $substring - */ + */ public function mustIncludeMatchSubstr ( $field, $substring, $inverse = FALSE ) { $this->mustIncludes[] = array("mustIncludeMatchSubstr", $field, $substring, $inverse); } /** - * function mustOverlapWithTimerange() - * Specifies that the resource has to overlap with a given timerange. + * function mustOverlapWithTimerange() + * Specifies that the resource has to overlap with a given timerange. * @see http://www.rfcreader.com/#rfc4791_line3944 * * Only call this function once per CalDAVFilter-object! - * - * Arguments: - * @param $start The starting point of the time interval. Must be in the format yyyymmddThhmmssZ and should be in - * GMT. If omitted the value is set to -infinity. - * @param $end The end point of the time interval. Must be in the format yyyymmddThhmmssZ and should be in - * GMT. If omitted the value is set to +infinity. - */ + * + * Arguments: + * @param string $start The starting point of the time interval. Must be in the format yyyymmddThhmmssZ and should be in + * GMT. If omitted the value is set to -infinity. + * @param string $end The end point of the time interval. Must be in the format yyyymmddThhmmssZ and should be in + * GMT. If omitted the value is set to +infinity. + */ public function mustOverlapWithTimerange ( $start = NULL, $end = NULL) { - // Are $start and $end in the correct format? - if ( ( isset($start) and ! preg_match( '#^\d\d\d\d\d\d\d\dT\d\d\d\d\d\dZ$#', $start, $matches ) ) - or ( isset($end) and ! preg_match( '#^\d\d\d\d\d\d\d\dT\d\d\d\d\d\dZ$#', $end, $matches ) ) ) - { trigger_error('$start or $end are in the wrong format. They must have the format yyyymmddThhmmssZ and should be in GMT', E_USER_ERROR); } + // Are $start and $end in the correct format? + if ( ( isset($start) and ! preg_match( '#^\d\d\d\d\d\d\d\dT\d\d\d\d\d\dZ$#', $start, $matches ) ) + or ( isset($end) and ! preg_match( '#^\d\d\d\d\d\d\d\dT\d\d\d\d\d\dZ$#', $end, $matches ) ) ) + { + trigger_error('$start or $end are in the wrong format. They must have the format yyyymmddThhmmssZ and should be in GMT', E_USER_ERROR); + } $this->mustIncludes[] = array("mustOverlapWithTimerange", $start, $end); } @@ -109,6 +113,8 @@ public function mustOverlapWithTimerange ( $start = NULL, $end = NULL) { * Transforms the filter to xml-code for the server. Used to pass as * argument for SimpleCalDAVClient->getCustomReport() * + * @return string + * * Example: * $simpleCalDAVClient->getCustomReport($filter->toXML()); * diff --git a/CalDAVObject.php b/src/CalDAVObject.php similarity index 70% rename from CalDAVObject.php rename to src/CalDAVObject.php index 6cf94c4..ade8de7 100644 --- a/CalDAVObject.php +++ b/src/CalDAVObject.php @@ -21,31 +21,33 @@ * */ +namespace it\thecsea\simple_caldav_client; + class CalDAVObject { - private $href; - private $data; - private $etag; - - public function __construct ($href, $data, $etag) { - $this->href = $href; - $this->data = $data; - $this->etag = $etag; - } - - - // Getter - - public function getHref () { - return $this->href; - } - - public function getData () { - return $this->data; - } - - public function getEtag () { - return $this->etag; - } + private $href; + private $data; + private $etag; + + public function __construct ($href, $data, $etag) { + $this->href = $href; + $this->data = $data; + $this->etag = $etag; + } + + + // Getter + + public function getHref () { + return $this->href; + } + + public function getData () { + return $this->data; + } + + public function getEtag () { + return $this->etag; + } } ?> \ No newline at end of file diff --git a/src/SimpleCalDAVClient.php b/src/SimpleCalDAVClient.php new file mode 100644 index 0000000..6be0c5b --- /dev/null +++ b/src/SimpleCalDAVClient.php @@ -0,0 +1,447 @@ + + * + * simpleCalDAV is a php library that allows you to connect to a calDAV-server to get event-, todo- + * and free/busy-calendar resources from the server, to change them, to delete them, to create new ones, etc. + * simpleCalDAV was made and tested for connections to the CalDAV-server Baikal 0.2.7. But it should work + * with any other CalDAV-server too. + * + * It contains the following functions: + * - connect() + * - findCalendars() + * - setCalendar() + * - create() + * - change() + * - delete() + * - getEvents() + * - getTODOs() + * - getCustomReport() + * + * All of those functions - except the last one - are realy easy to use, self-explanatory and are + * deliverd with a big innitial comment, which explains all needed arguments and the return values. + * + * This library is heavily based on AgenDAV caldav-client-v2.php by Jorge L�pez P�rez which + * again is heavily based on DAViCal caldav-client-v2.php by Andrew McMillan . + * Actually, I hardly added any features. The main point of my work is to make everything straight + * forward and easy to use. You can use simpleCalDAV whithout a deeper understanding of the + * calDAV-protocol. + * + * Requirements of this library are + * - The php extension cURL ( http://www.php.net/manual/en/book.curl.php ) + * - From Andrew�s Web Libraries: ( https://github.com/andrews-web-libraries/awl ) + * - XMLDocument.php + * - XMLElement.php + * - AWLUtilities.php + * + * @package simpleCalDAV + */ + +namespace it\thecsea\simple_caldav_client; + + +class SimpleCalDAVClient { + private $client; + private $url; + + /** + * function connect() + * Connects to a CalDAV-Server. + * + * Arguments: + * @param string $url URL to the CalDAV-server. E.g. http://exam.pl/baikal/cal.php/username/calendername/ + * @param string $user Username to login with + * @param string $pass Password to login with + * @param array $options + * + * Debugging: + * @throws CalDAVException For debugging purposes, just sorround everything with try { ... } catch (Exception $e) { echo $e->__toString(); } + */ + function connect ( $url, $user, $pass, $options=[] ) + { + + // Connect to CalDAV-Server and log in + $client = new CalDAVClient($url, $user, $pass, $options); + + // Valid CalDAV-Server? Or is it just a WebDAV-Server? + if( ! $client->isValidCalDAVServer() ) + { + + if( $client->GetHttpResultCode() == '401' ) // unauthorisized + { + throw new CalDAVException('Login failed', $client); + } + + elseif( $client->GetHttpResultCode() == '' ) // can't reach server + { + throw new CalDAVException('Can\'t reach server', $client); + } + + else throw new CalDAVException('Could\'n find a CalDAV-collection under the url', $client); + } + + // Check for errors + if( $client->GetHttpResultCode() != '200' ) { + if( $client->GetHttpResultCode() == '401' ) // unauthorisized + { + throw new CalDAVException('Login failed', $client); + } + + elseif( $client->GetHttpResultCode() == '' ) // can't reach server + { + throw new CalDAVException('Can\'t reach server', $client); + } + + else // Unknown status + { + throw new CalDAVException('Recieved unknown HTTP status while checking the connection after establishing it', $client); + } + } + + $this->client = $client; + } + + /** + * function findCalendars() + * + * Requests a list of all accessible calendars on the server + * + * Return value: + * @return CalDAVCalendar[] an array of CalDAVCalendar-Objects (see CalDAVCalendar.php), representing all calendars accessible by the current principal (user). + * + * Debugging: + * @throws CalDAVException + * For debugging purposes, just sorround everything with try { ... } catch (Exception $e) { echo $e->__toString(); exit(-1); } + */ + function findCalendars() + { + if(!isset($this->client)) throw new \Exception('No connection. Try connect().'); + + return $this->client->FindCalendars(true); + } + + /** + * function setCalendar() + * + * Sets the actual calendar to work with + * @param CalDAVCalendar $calendar + * + * Debugging: + * @throws CalDAVException + * For debugging purposes, just sorround everything with try { ... } catch (Exception $e) { echo $e->__toString(); exit(-1); } + */ + function setCalendar ( CalDAVCalendar $calendar ) + { + if(!isset($this->client)) throw new \Exception('No connection. Try connect().'); + + $this->client->SetCalendar($this->client->first_url_part.$calendar->getURL()); + + // Is there a '/' at the end of the calendar_url? + if ( ! preg_match( '#^.*?/$#', $this->client->calendar_url, $matches ) ) { $this->url = $this->client->calendar_url.'/'; } + else { $this->url = $this->client->calendar_url; } + } + + /** + * function create() + * Creates a new calendar resource on the CalDAV-Server (event, todo, etc.). + * + * Arguments: + * @param string $cal iCalendar-data of the resource you want to create. + * Notice: The iCalendar-data contains the unique ID which specifies where the event is being saved. + * + * Return value: + * @return CalDAVObject An CalDAVObject-representation (see CalDAVObject.php) of your created resource + * + * Debugging: + * @throws CalDAVException + * For debugging purposes, just sorround everything with try { ... } catch (Exception $e) { echo $e->__toString(); exit(-1); } + */ + function create ( $cal ) + { + // Connection and calendar set? + if(!isset($this->client)) throw new \Exception('No connection. Try connect().'); + if(!isset($this->client->calendar_url)) throw new \Exception('No calendar selected. Try findCalendars() and setCalendar().'); + + // Parse $cal for UID + if (! preg_match( '#^UID:(.*?)\r?\n?$#m', $cal, $matches ) ) { throw new \Exception('Can\'t find UID in $cal'); } + else { $uid = $matches[1]; } + + // Does $this->url.$uid.'.ics' already exist? + $result = $this->client->GetEntryByHref( $this->url.$uid.'.ics' ); + if ( $this->client->GetHttpResultCode() == '200' ) { throw new CalDAVException($this->url.$uid.'.ics already exists. UID not unique?', $this->client); } + else if ( $this->client->GetHttpResultCode() == '404' ); + else throw new CalDAVException('Recieved unknown HTTP status', $this->client); + + // Put it! + $newEtag = $this->client->DoPUTRequest( $this->url.$uid.'.ics', $cal ); + + // PUT-request successfull? + if ( $this->client->GetHttpResultCode() != '201' ) + { + if ( $this->client->GetHttpResultCode() == '204' ) // $url.$uid.'.ics' already existed on server + { + throw new CalDAVException( $this->url.$uid.'.ics already existed. Entry has been overwritten.', $this->client); + } + + else // Unknown status + { + throw new CalDAVException('Recieved unknown HTTP status', $this->client); + } + } + + return new CalDAVObject($this->url.$uid.'.ics', $cal, $newEtag); + } + + /** + * function change() + * Changes a calendar resource (event, todo, etc.) on the CalDAV-Server. + * + * Arguments: + * @param string $href See CalDAVObject.php + * @param string $new_data The new iCalendar-data that should be used to overwrite the old one. + * @param string $etag See CalDAVObject.php + * + * Return value: + * @return CalDAVObject An CalDAVObject-representation (see CalDAVObject.php) of your changed resource + * + * Debugging: + * @throws CalDAVException + * For debugging purposes, just sorround everything with try { ... } catch (Exception $e) { echo $e->__toString(); exit(-1); } + */ + function change ( $href, $new_data, $etag ) + { + // Connection and calendar set? + if(!isset($this->client)) throw new \Exception('No connection. Try connect().'); + if(!isset($this->client->calendar_url)) throw new \Exception('No calendar selected. Try findCalendars() and setCalendar().'); + + // Does $href exist? + $result = $this->client->GetEntryByHref($href); + if ( $this->client->GetHttpResultCode() == '200' ); + else if ( $this->client->GetHttpResultCode() == '404' ) throw new CalDAVException('Can\'t find '.$href.' on the server', $this->client); + else throw new CalDAVException('Recieved unknown HTTP status', $this->client); + + // $etag correct? + if($result[0]['etag'] != $etag) { throw new CalDAVException('Wrong entity tag. The entity seems to have changed.', $this->client); } + + // Put it! + $newEtag = $this->client->DoPUTRequest( $href, $new_data, $etag ); + + // PUT-request successfull? + if ( $this->client->GetHttpResultCode() != '204' && $this->client->GetHttpResultCode() != '200' ) + { + throw new CalDAVException('Recieved unknown HTTP status', $this->client); + } + + return new CalDAVObject($href, $new_data, $newEtag); + } + + /** + * function delete() + * Delets an event or a TODO from the CalDAV-Server. + * + * Arguments: + * @param string $href See CalDAVObject.php + * @param string|null $etag See CalDAVObject.php + * + * Debugging: + * @throws CalDAVException + * For debugging purposes, just sorround everything with try { ... } catch (Exception $e) { echo $e->__toString(); exit(-1); } + */ + function delete ( $href, $etag = null ) + { + // Connection and calendar set? + if(!isset($this->client)) throw new \Exception('No connection. Try connect().'); + if(!isset($this->client->calendar_url)) throw new \Exception('No calendar selected. Try findCalendars() and setCalendar().'); + + // Does $href exist? + $result = $this->client->GetEntryByHref($href); + if(count($result) == 0) throw new CalDAVException('Can\'t find '.$href.'on server', $this->client); + + if(isset($etag) and !empty($etag)) { + // $etag correct? + if($result[0]['etag'] != $etag) { throw new CalDAVException('Wrong entity tag. The entity seems to have changed.', $this->client); } + } + + // Do the deletion + if(isset($etag) and !empty($etag)) { + $this->client->DoDELETERequest($href, $etag); + } else { + $this->client->DoDELETERequest($href); + } + + // Deletion successfull? + if ( $this->client->GetHttpResultCode() != '200' and $this->client->GetHttpResultCode() != '204' ) + { + throw new CalDAVException('Recieved unknown HTTP status', $this->client); + } + } + + /** + * function getEvents() + * Gets a all events from the CalDAV-Server which lie in a defined time interval. + * + * Arguments: + * @param string|null $start The starting point of the time interval. Must be in the format yyyymmddThhmmssZ and should be in + * GMT. If omitted the value is set to -infinity. + * @param string|null $end The end point of the time interval. Must be in the format yyyymmddThhmmssZ and should be in + * GMT. If omitted the value is set to +infinity. + * + * Return value: + * @return CalDAVObject[] an array of CalDAVObjects (See CalDAVObject.php), representing the found events. + * + * Debugging: + * @throws CalDAVException + * For debugging purposes, just sorround everything with try { ... } catch (Exception $e) { echo $e->__toString(); exit(-1); } + */ + function getEvents ( $start = null, $end = null ) + { + // Connection and calendar set? + if(!isset($this->client)) throw new \Exception('No connection. Try connect().'); + if(!isset($this->client->calendar_url)) throw new \Exception('No calendar selected. Try findCalendars() and setCalendar().'); + + // Are $start and $end in the correct format? + if ( ( isset($start) and ! preg_match( '#^\d\d\d\d\d\d\d\dT\d\d\d\d\d\dZ$#', $start, $matches ) ) + or ( isset($end) and ! preg_match( '#^\d\d\d\d\d\d\d\dT\d\d\d\d\d\dZ$#', $end, $matches ) ) ) + { trigger_error('$start or $end are in the wrong format. They must have the format yyyymmddThhmmssZ and should be in GMT', E_USER_ERROR); } + + // Get it! + $results = $this->client->GetEvents( $start, $end ); + + // GET-request successfull? + if ( $this->client->GetHttpResultCode() != '207' ) + { + throw new CalDAVException('Recieved unknown HTTP status', $this->client); + } + + // Reformat + $report = array(); + foreach($results as $event) $report[] = new CalDAVObject($this->url.$event['href'], $event['data'], $event['etag']); + + return $report; + } + + /** + * function getEventByGuid( $guid ) + * Gets an events from the CalDAV-Server with specified UID. + * + * Arguments: + * @param string $guid UID of the iCal requested. + * + * Return value: + * @return array an array of arrays containing ['href'], ['etag'] and the iCal in ['data'] for the found event. + * + */ + function getEventByGuid ( $guid ) + { + // Connection and calendar set? + if(!isset($this->client)) throw new CalDAVException('No connection. Try connect().', $this->client); + if(!isset($this->client->calendar_url)) throw new CalDAVException('No calendar selected. Try findCalendars() and setCalendar().', $this->client); + + // Get it! + $data = $this->client->GetEntryByUid($guid); + foreach ($data as &$element) { + $element['href'] = $this->client->calendar_url . $element['href']; + unset($element); + } + return $data; + + } + + /** + * function getTODOs() + * Gets a all TODOs from the CalDAV-Server which lie in a defined time interval and match the + * given criteria. + * + * Arguments: + * @param string $start The starting point of the time interval. Must be in the format yyyymmddThhmmssZ and should be in + * GMT. If omitted the value is set to -infinity. + * @param string $end The end point of the time interval. Must be in the format yyyymmddThhmmssZ and should be in + * GMT. If omitted the value is set to +infinity. + * @param bool|null $completed Filter for completed tasks (true) or for uncompleted tasks (false). If omitted, the function will return both. + * @param bool|null $cancelled Filter for cancelled tasks (true) or for uncancelled tasks (false). If omitted, the function will return both. + * + * Return value: + * @return CalDAVObject[] an array of CalDAVObjects (See CalDAVObject.php), representing the found TODOs. + * + * Debugging: + * @throws CalDAVException + * For debugging purposes, just sorround everything with try { ... } catch (Exception $e) { echo $e->__toString(); exit(-1); } + */ + function getTODOs ( $start = null, $end = null, $completed = null, $cancelled = null ) + { + // Connection and calendar set? + if(!isset($this->client)) throw new \Exception('No connection. Try connect().'); + if(!isset($this->client->calendar_url)) throw new \Exception('No calendar selected. Try findCalendars() and setCalendar().'); + + // Are $start and $end in the correct format? + if ( ( isset($start) and ! preg_match( '#^\d\d\d\d\d\d\d\dT\d\d\d\d\d\dZ$#', $start, $matches ) ) + or ( isset($end) and ! preg_match( '#^\d\d\d\d\d\d\d\dT\d\d\d\d\d\dZ$#', $end, $matches ) ) ) + { + trigger_error('$start or $end are in the wrong format. They must have the format yyyymmddThhmmssZ and should be in GMT', E_USER_ERROR); + } + + // Get it! + $results = $this->client->GetTodos( $start, $end, $completed, $cancelled ); + + // GET-request successfull? + if ( $this->client->GetHttpResultCode() != '207' ) + { + throw new CalDAVException('Recieved unknown HTTP status', $this->client); + } + + // Reformat + $report = array(); + foreach($results as $event) $report[] = new CalDAVObject($this->url.$event['href'], $event['data'], $event['etag']); + + return $report; + } + + /** + * function getCustomReport() + * Sends a custom request to the server + * (Sends a REPORT-request with a custom -tag) + * + * You can either write the filterXML yourself or build an CalDAVFilter-object (see CalDAVFilter.php). + * + * See http://www.rfcreader.com/#rfc4791_line1524 for more information about how to write filters on your own. + * + * Arguments: + * @param string $filterXML The stuff, you want to send encapsulated in the -tag. + * + * Return value: + * @return CalDAVObject[] an array of CalDAVObjects (See CalDAVObject.php), representing the found calendar resources. + * + * Debugging: + * @throws CalDAVException + * For debugging purposes, just sorround everything with try { ... } catch (Exception $e) { echo $e->__toString(); exit(-1); } + */ + function getCustomReport ( $filterXML ) + { + // Connection and calendar set? + if(!isset($this->client)) throw new \Exception('No connection. Try connect().'); + if(!isset($this->client->calendar_url)) throw new \Exception('No calendar selected. Try findCalendars() and setCalendar().'); + + // Get report! + $this->client->SetDepth('1'); + + // Get it! + $results = $this->client->DoCalendarQuery(''.$filterXML.''); + + // GET-request successfull? + if ( $this->client->GetHttpResultCode() != '207' ) + { + throw new CalDAVException('Recieved unknown HTTP status', $this->client); + } + + // Reformat + $report = array(); + foreach($results as $event) $report[] = new CalDAVObject($this->url.$event['href'], $event['data'], $event['etag']); + + return $report; + } +} + +?> diff --git a/include/AWLUtilities.php b/src/includes/AWLUtilities.php similarity index 99% rename from include/AWLUtilities.php rename to src/includes/AWLUtilities.php index 7fe9884..58fba1e 100644 --- a/include/AWLUtilities.php +++ b/src/includes/AWLUtilities.php @@ -376,7 +376,7 @@ function uuid() { } if ( !function_exists("translate") ) { - require("Translation.php"); + require(__DIR__."/Translation.php"); } if ( !function_exists("clone") && version_compare(phpversion(), '5.0') < 0) { diff --git a/include/README b/src/includes/README similarity index 100% rename from include/README rename to src/includes/README diff --git a/include/Translation.php b/src/includes/Translation.php similarity index 100% rename from include/Translation.php rename to src/includes/Translation.php diff --git a/include/XMLDocument.php b/src/includes/XMLDocument.php similarity index 99% rename from include/XMLDocument.php rename to src/includes/XMLDocument.php index b2beac7..924a6b4 100644 --- a/include/XMLDocument.php +++ b/src/includes/XMLDocument.php @@ -10,13 +10,15 @@ * */ -require_once("XMLElement.php"); +namespace it\thecsea\simple_caldav_client\includes; + /** * A class for XML Documents which will contain namespaced XML elements * * @package awl */ +#[\AllowDynamicProperties] class XMLDocument { /**#@+ diff --git a/include/XMLElement.php b/src/includes/XMLElement.php similarity index 99% rename from include/XMLElement.php rename to src/includes/XMLElement.php index 2c9b017..7afa55d 100644 --- a/include/XMLElement.php +++ b/src/includes/XMLElement.php @@ -9,7 +9,9 @@ * @license http://www.gnu.org/licenses/lgpl-3.0.txt GNU LGPL version 3 or later */ -require_once('AWLUtilities.php'); +namespace it\thecsea\simple_caldav_client\includes; + +require_once(__DIR__.'/AWLUtilities.php'); /** * A class for XML elements which may have attributes, or contain