Sabre\CalDAV\ICSExportPlugin Class Reference

ICS Exporter. More...

Inheritance diagram for Sabre\CalDAV\ICSExportPlugin:

Collaboration diagram for Sabre\CalDAV\ICSExportPlugin:

Public Member Functions
	initialize (DAV\Server $server)
	Initializes the plugin and registers event handlers. More...
	httpGet (RequestInterface $request, ResponseInterface $response)
	Intercepts GET requests on calendar urls ending with ?export. More...
	mergeObjects (array $properties, array $inputObjects)
	Merges all calendar objects, and builds one big iCalendar blob. More...
	getPluginName ()
	Returns a plugin name. More...
	getPluginInfo ()
	Returns a bunch of meta-data about the plugin. More...
Public Member Functions inherited from Sabre\DAV\ServerPlugin
	initialize (Server $server)
	This initializes the plugin. More...
	getFeatures ()
	This method should return a list of server-features. More...
	getHTTPMethods ($path)
	Use this method to tell the server this plugin defines additional HTTP methods. More...
	getPluginName ()
	Returns a plugin name. More...
	getSupportedReportSet ($uri)
	Returns a list of reports this plugin supports. More...
	getPluginInfo ()
	Returns a bunch of meta-data about the plugin. More...

Protected Member Functions
	generateResponse ($path, $start, $end, $expand, $componentType, $format, $properties, ResponseInterface $response)
	This method is responsible for generating the actual, full response. More...

Protected Attributes
	$server

Detailed Description

ICS Exporter.

This plugin adds the ability to export entire calendars as .ics files. This is useful for clients that don't support CalDAV yet. They often do support ics files.

To use this, point a http client to a caldav calendar, and add ?expand to the url.

Further options that can be added to the url: start=123456789 - Only return events after the given unix timestamp end=123245679 - Only return events from before the given unix timestamp expand=1 - Strip timezone information and expand recurring events. If you'd like to expand, you must also specify start and end.

By default this plugin returns data in the text/calendar format (iCalendar 2.0). If you'd like to receive jCal data instead, you can use an Accept header:

Accept: application/calendar+json

Alternatively, you can also specify this in the url using accept=application/calendar+json, or accept=jcal for short. If the url parameter and Accept header is specified, the url parameter wins.

Note that specifying a start or end data implies that only events will be returned. VTODO and VJOURNAL will be stripped.

Copyright

Copyright (C) fruux GmbH (https://fruux.com/)

Author

Evert Pot (http://evertpot.com/) @license http://sabre.io/license/ Modified BSD License

Definition at line 47 of file ICSExportPlugin.php.

Member Function Documentation

generateResponse()

Sabre\CalDAV\ICSExportPlugin::generateResponse (   $path,   $start,   $end,   $expand,   $componentType,   $format,   $properties, ResponseInterface  $response  )

protected

This method is responsible for generating the actual, full response.

Parameters

string	$path
DateTime | null	$start
DateTime | null	$end
bool	$expand
string	$componentType
string	$format
array	$properties
ResponseInterface	$response

Definition at line 170 of file ICSExportPlugin.php.

                                                                                                                                         {
 
        $calDataProp = '{' . Plugin::NS_CALDAV . '}calendar-data';
        $calendarNode = $this->server->tree->getNodeForPath($path);
 
        $blobs = [];
        if ($start || $end || $componentType) {
 
            // If there was a start or end filter, we need to enlist
            // calendarQuery for speed.
            $queryResult = $calendarNode->calendarQuery([
                'name'         => 'VCALENDAR',
                'comp-filters' => [
                    [
                        'name'           => $componentType,
                        'comp-filters'   => [],
                        'prop-filters'   => [],
                        'is-not-defined' => false,
                        'time-range'     => [
                            'start' => $start,
                            'end'   => $end,
                        ],
                    ],
                ],
                'prop-filters'   => [],
                'is-not-defined' => false,
                'time-range'     => null,
            ]);
 
            // queryResult is just a list of base urls. We need to prefix the
            // calendar path.
            $queryResult = array_map(
                function($item) use ($path) {
                    return $path . '/' . $item;
                },
                $queryResult
            );
            $nodes = $this->server->getPropertiesForMultiplePaths($queryResult, [$calDataProp]);
            unset($queryResult);
 
        } else {
            $nodes = $this->server->getPropertiesForPath($path, [$calDataProp], 1);
        }
 
        // Flattening the arrays
        foreach ($nodes as $node) {
            if (isset($node[200][$calDataProp])) {
                $blobs[$node['href']] = $node[200][$calDataProp];
            }
        }
        unset($nodes);
 
        $mergedCalendar = $this->mergeObjects(
            $properties,
            $blobs
        );
 
        if ($expand) {
            $calendarTimeZone = null;
            // We're expanding, and for that we need to figure out the
            // calendar's timezone.
            $tzProp = '{' . Plugin::NS_CALDAV . '}calendar-timezone';
            $tzResult = $this->server->getProperties($path, [$tzProp]);
            if (isset($tzResult[$tzProp])) {
                // This property contains a VCALENDAR with a single
                // VTIMEZONE.
                $vtimezoneObj = VObject\Reader::read($tzResult[$tzProp]);
                $calendarTimeZone = $vtimezoneObj->VTIMEZONE->getTimeZone();
                // Destroy circular references to PHP will GC the object.
                $vtimezoneObj->destroy();
                unset($vtimezoneObj);
            } else {
                // Defaulting to UTC.
                $calendarTimeZone = new DateTimeZone('UTC');
            }
 
            $mergedCalendar = $mergedCalendar->expand($start, $end, $calendarTimeZone);
        }
 
        $filenameExtension = '.ics';
 
        switch ($format) {
            case 'text/calendar' :
                $mergedCalendar = $mergedCalendar->serialize();
                $filenameExtension = '.ics';
                break;
            case 'application/calendar+json' :
                $mergedCalendar = json_encode($mergedCalendar->jsonSerialize());
                $filenameExtension = '.json';
                break;
        }
 
        $filename = preg_replace(
            '/[^a-zA-Z0-9-_ ]/um',
            '',
            $calendarNode->getName()
        );
        $filename .= '-' . date('Y-m-d') . $filenameExtension;
 
        $response->setHeader('Content-Disposition', 'attachment; filename="' . $filename . '"');
        $response->setHeader('Content-Type', $format);
 
        $response->setStatus(200);
        $response->setBody($mergedCalendar);
 
    }

References $end, $filename, $format, $nodes, $path, $response, $start, Sabre\CalDAV\ICSExportPlugin\mergeObjects(), Sabre\CalDAV\Plugin\NS_CALDAV, and Sabre\VObject\Reader\read().

Referenced by Sabre\CalDAV\ICSExportPlugin\httpGet().

Here is the call graph for this function:

Here is the caller graph for this function:

getPluginInfo()

Sabre\CalDAV\ICSExportPlugin::getPluginInfo

(

)

Returns a bunch of meta-data about the plugin.

Providing this information is optional, and is mainly displayed by the Browser plugin.

The description key in the returned array may contain html and will not be sanitized.

Returns

array

Reimplemented from Sabre\DAV\ServerPlugin.

Definition at line 368 of file ICSExportPlugin.php.

                             {
 
        return [
            'name'        => $this->getPluginName(),
            'description' => 'Adds the ability to export CalDAV calendars as a single iCalendar file.',
            'link'        => 'http://sabre.io/dav/ics-export-plugin/',
        ];
 
    }

getPluginName()

Sabre\CalDAV\ICSExportPlugin::getPluginName

(

)

Returns a plugin name.

Using this name other plugins will be able to access other plugins using \Sabre\DAV\Server::getPlugin

Returns

string

Reimplemented from Sabre\DAV\ServerPlugin.

Definition at line 351 of file ICSExportPlugin.php.

                             {
 
        return 'ics-export';
 
    }

httpGet()

Sabre\CalDAV\ICSExportPlugin::httpGet	(	RequestInterface	$request,
		ResponseInterface	$response
	)

Intercepts GET requests on calendar urls ending with ?export.

Parameters

RequestInterface	$request
ResponseInterface	$response

Returns

bool

Definition at line 81 of file ICSExportPlugin.php.

                                                                             {
 
        $queryParams = $request->getQueryParameters();
        if (!array_key_exists('export', $queryParams)) return;
 
        $path = $request->getPath();
 
        $node = $this->server->getProperties($path, [
            '{DAV:}resourcetype',
            '{DAV:}displayname',
            '{http://sabredav.org/ns}sync-token',
            '{DAV:}sync-token',
            '{http://apple.com/ns/ical/}calendar-color',
        ]);
 
        if (!isset($node['{DAV:}resourcetype']) || !$node['{DAV:}resourcetype']->is('{' . Plugin::NS_CALDAV . '}calendar')) {
            return;
        }
        // Marking the transactionType, for logging purposes.
        $this->server->transactionType = 'get-calendar-export';
 
        $properties = $node;
 
        $start = null;
        $end = null;
        $expand = false;
        $componentType = false;
        if (isset($queryParams['start'])) {
            if (!ctype_digit($queryParams['start'])) {
                throw new BadRequest('The start= parameter must contain a unix timestamp');
            }
            $start = DateTime::createFromFormat('U', $queryParams['start']);
        }
        if (isset($queryParams['end'])) {
            if (!ctype_digit($queryParams['end'])) {
                throw new BadRequest('The end= parameter must contain a unix timestamp');
            }
            $end = DateTime::createFromFormat('U', $queryParams['end']);
        }
        if (isset($queryParams['expand']) && !!$queryParams['expand']) {
            if (!$start || !$end) {
                throw new BadRequest('If you\'d like to expand recurrences, you must specify both a start= and end= parameter.');
            }
            $expand = true;
            $componentType = 'VEVENT';
        }
        if (isset($queryParams['componentType'])) {
            if (!in_array($queryParams['componentType'], ['VEVENT', 'VTODO', 'VJOURNAL'])) {
                throw new BadRequest('You are not allowed to search for components of type: ' . $queryParams['componentType'] . ' here');
            }
            $componentType = $queryParams['componentType'];
        }
 
        $format = \Sabre\HTTP\Util::Negotiate(
            $request->getHeader('Accept'),
            [
                'text/calendar',
                'application/calendar+json',
            ]
        );
 
        if (isset($queryParams['accept'])) {
            if ($queryParams['accept'] === 'application/calendar+json' || $queryParams['accept'] === 'jcal') {
                $format = 'application/calendar+json';
            }
        }
        if (!$format) {
            $format = 'text/calendar';
        }
 
        $this->generateResponse($path, $start, $end, $expand, $componentType, $format, $properties, $response);
 
        // Returning false to break the event chain
        return false;
 
    }

References $end, $format, $path, $request, $response, $start, Sabre\CalDAV\ICSExportPlugin\generateResponse(), and Sabre\CalDAV\Plugin\NS_CALDAV.

Here is the call graph for this function:

initialize()

Sabre\CalDAV\ICSExportPlugin::initialize

(

DAV\Server

$server

)

Initializes the plugin and registers event handlers.

Parameters

\Sabre\DAV\Server

$server

Returns

void

Definition at line 62 of file ICSExportPlugin.php.

                                            {
 
        $this->server = $server;
        $server->on('method:GET', [$this, 'httpGet'], 90);
        $server->on('browserButtonActions', function($path, $node, &$actions) {
            if ($node instanceof ICalendar) {
                $actions .= '<a href="' . htmlspecialchars($path, ENT_QUOTES, 'UTF-8') . '?export"><span class="oi" data-glyph="calendar"></span></a>';
            }
        });
 
    }

References $path, and Sabre\CalDAV\ICSExportPlugin\$server.

mergeObjects()

Sabre\CalDAV\ICSExportPlugin::mergeObjects	(	array	$properties,
		array	$inputObjects
	)

Merges all calendar objects, and builds one big iCalendar blob.

Parameters

array	$properties	Some CalDAV properties
array	$inputObjects

Returns

VObject\Component\VCalendar

Definition at line 284 of file ICSExportPlugin.php.

                                                                  {
 
        $calendar = new VObject\Component\VCalendar();
        $calendar->VERSION = '2.0';
        if (DAV\Server::$exposeVersion) {
            $calendar->PRODID = '-//SabreDAV//SabreDAV ' . DAV\Version::VERSION . '//EN';
        } else {
            $calendar->PRODID = '-//SabreDAV//SabreDAV//EN';
        }
        if (isset($properties['{DAV:}displayname'])) {
            $calendar->{'X-WR-CALNAME'} = $properties['{DAV:}displayname'];
        }
        if (isset($properties['{http://apple.com/ns/ical/}calendar-color'])) {
            $calendar->{'X-APPLE-CALENDAR-COLOR'} = $properties['{http://apple.com/ns/ical/}calendar-color'];
        }
 
        $collectedTimezones = [];
 
        $timezones = [];
        $objects = [];
 
        foreach ($inputObjects as $href => $inputObject) {
 
            $nodeComp = VObject\Reader::read($inputObject);
 
            foreach ($nodeComp->children() as $child) {
 
                switch ($child->name) {
                    case 'VEVENT' :
                    case 'VTODO' :
                    case 'VJOURNAL' :
                        $objects[] = clone $child;
                        break;
 
                    // VTIMEZONE is special, because we need to filter out the duplicates
                    case 'VTIMEZONE' :
                        // Naively just checking tzid.
                        if (in_array((string)$child->TZID, $collectedTimezones)) continue;
 
                        $timezones[] = clone $child;
                        $collectedTimezones[] = $child->TZID;
                        break;
 
                }
 
            }
            // Destroy circular references to PHP will GC the object.
            $nodeComp->destroy();
            unset($nodeComp);
 
        }
 
        foreach ($timezones as $tz) $calendar->add($tz);
        foreach ($objects as $obj) $calendar->add($obj);
 
        return $calendar;
 
    }

References $calendar, Sabre\DAV\Server\$exposeVersion, and Sabre\DAV\Version\VERSION.

Referenced by Sabre\CalDAV\ICSExportPlugin\generateResponse().

Here is the caller graph for this function:

Field Documentation

$server

Sabre\CalDAV\ICSExportPlugin::$server

protected

Definition at line 54 of file ICSExportPlugin.php.

Referenced by Sabre\CalDAV\ICSExportPlugin\initialize().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/sabre/dav/lib/CalDAV/ICSExportPlugin.php