123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526 |
- <?php
- namespace Sabre\VObject\Component;
- use DateTime;
- use DateTimeZone;
- use Sabre\VObject;
- use Sabre\VObject\Component;
- use Sabre\VObject\Recur\EventIterator;
- use Sabre\VObject\Recur\NoInstancesException;
- /**
- * The VCalendar component
- *
- * This component adds functionality to a component, specific for a VCALENDAR.
- *
- * @copyright Copyright (C) fruux GmbH (https://fruux.com/)
- * @author Evert Pot (http://evertpot.com/)
- * @license http://sabre.io/license/ Modified BSD License
- */
- class VCalendar extends VObject\Document {
- /**
- * The default name for this component.
- *
- * This should be 'VCALENDAR' or 'VCARD'.
- *
- * @var string
- */
- static $defaultName = 'VCALENDAR';
- /**
- * This is a list of components, and which classes they should map to.
- *
- * @var array
- */
- static $componentMap = array(
- 'VALARM' => 'Sabre\\VObject\\Component\\VAlarm',
- 'VEVENT' => 'Sabre\\VObject\\Component\\VEvent',
- 'VFREEBUSY' => 'Sabre\\VObject\\Component\\VFreeBusy',
- 'VAVAILABILITY' => 'Sabre\\VObject\\Component\\VAvailability',
- 'AVAILABLE' => 'Sabre\\VObject\\Component\\Available',
- 'VJOURNAL' => 'Sabre\\VObject\\Component\\VJournal',
- 'VTIMEZONE' => 'Sabre\\VObject\\Component\\VTimeZone',
- 'VTODO' => 'Sabre\\VObject\\Component\\VTodo',
- );
- /**
- * List of value-types, and which classes they map to.
- *
- * @var array
- */
- static $valueMap = array(
- 'BINARY' => 'Sabre\\VObject\\Property\\Binary',
- 'BOOLEAN' => 'Sabre\\VObject\\Property\\Boolean',
- 'CAL-ADDRESS' => 'Sabre\\VObject\\Property\\ICalendar\\CalAddress',
- 'DATE' => 'Sabre\\VObject\\Property\\ICalendar\\Date',
- 'DATE-TIME' => 'Sabre\\VObject\\Property\\ICalendar\\DateTime',
- 'DURATION' => 'Sabre\\VObject\\Property\\ICalendar\\Duration',
- 'FLOAT' => 'Sabre\\VObject\\Property\\FloatValue',
- 'INTEGER' => 'Sabre\\VObject\\Property\\IntegerValue',
- 'PERIOD' => 'Sabre\\VObject\\Property\\ICalendar\\Period',
- 'RECUR' => 'Sabre\\VObject\\Property\\ICalendar\\Recur',
- 'TEXT' => 'Sabre\\VObject\\Property\\Text',
- 'TIME' => 'Sabre\\VObject\\Property\\Time',
- 'UNKNOWN' => 'Sabre\\VObject\\Property\\Unknown', // jCard / jCal-only.
- 'URI' => 'Sabre\\VObject\\Property\\Uri',
- 'UTC-OFFSET' => 'Sabre\\VObject\\Property\\UtcOffset',
- );
- /**
- * List of properties, and which classes they map to.
- *
- * @var array
- */
- static $propertyMap = array(
- // Calendar properties
- 'CALSCALE' => 'Sabre\\VObject\\Property\\FlatText',
- 'METHOD' => 'Sabre\\VObject\\Property\\FlatText',
- 'PRODID' => 'Sabre\\VObject\\Property\\FlatText',
- 'VERSION' => 'Sabre\\VObject\\Property\\FlatText',
- // Component properties
- 'ATTACH' => 'Sabre\\VObject\\Property\\Uri',
- 'CATEGORIES' => 'Sabre\\VObject\\Property\\Text',
- 'CLASS' => 'Sabre\\VObject\\Property\\FlatText',
- 'COMMENT' => 'Sabre\\VObject\\Property\\FlatText',
- 'DESCRIPTION' => 'Sabre\\VObject\\Property\\FlatText',
- 'GEO' => 'Sabre\\VObject\\Property\\FloatValue',
- 'LOCATION' => 'Sabre\\VObject\\Property\\FlatText',
- 'PERCENT-COMPLETE' => 'Sabre\\VObject\\Property\\IntegerValue',
- 'PRIORITY' => 'Sabre\\VObject\\Property\\IntegerValue',
- 'RESOURCES' => 'Sabre\\VObject\\Property\\Text',
- 'STATUS' => 'Sabre\\VObject\\Property\\FlatText',
- 'SUMMARY' => 'Sabre\\VObject\\Property\\FlatText',
- // Date and Time Component Properties
- 'COMPLETED' => 'Sabre\\VObject\\Property\\ICalendar\\DateTime',
- 'DTEND' => 'Sabre\\VObject\\Property\\ICalendar\\DateTime',
- 'DUE' => 'Sabre\\VObject\\Property\\ICalendar\\DateTime',
- 'DTSTART' => 'Sabre\\VObject\\Property\\ICalendar\\DateTime',
- 'DURATION' => 'Sabre\\VObject\\Property\\ICalendar\\Duration',
- 'FREEBUSY' => 'Sabre\\VObject\\Property\\ICalendar\\Period',
- 'TRANSP' => 'Sabre\\VObject\\Property\\FlatText',
- // Time Zone Component Properties
- 'TZID' => 'Sabre\\VObject\\Property\\FlatText',
- 'TZNAME' => 'Sabre\\VObject\\Property\\FlatText',
- 'TZOFFSETFROM' => 'Sabre\\VObject\\Property\\UtcOffset',
- 'TZOFFSETTO' => 'Sabre\\VObject\\Property\\UtcOffset',
- 'TZURL' => 'Sabre\\VObject\\Property\\Uri',
- // Relationship Component Properties
- 'ATTENDEE' => 'Sabre\\VObject\\Property\\ICalendar\\CalAddress',
- 'CONTACT' => 'Sabre\\VObject\\Property\\FlatText',
- 'ORGANIZER' => 'Sabre\\VObject\\Property\\ICalendar\\CalAddress',
- 'RECURRENCE-ID' => 'Sabre\\VObject\\Property\\ICalendar\\DateTime',
- 'RELATED-TO' => 'Sabre\\VObject\\Property\\FlatText',
- 'URL' => 'Sabre\\VObject\\Property\\Uri',
- 'UID' => 'Sabre\\VObject\\Property\\FlatText',
- // Recurrence Component Properties
- 'EXDATE' => 'Sabre\\VObject\\Property\\ICalendar\\DateTime',
- 'RDATE' => 'Sabre\\VObject\\Property\\ICalendar\\DateTime',
- 'RRULE' => 'Sabre\\VObject\\Property\\ICalendar\\Recur',
- 'EXRULE' => 'Sabre\\VObject\\Property\\ICalendar\\Recur', // Deprecated since rfc5545
- // Alarm Component Properties
- 'ACTION' => 'Sabre\\VObject\\Property\\FlatText',
- 'REPEAT' => 'Sabre\\VObject\\Property\\IntegerValue',
- 'TRIGGER' => 'Sabre\\VObject\\Property\\ICalendar\\Duration',
- // Change Management Component Properties
- 'CREATED' => 'Sabre\\VObject\\Property\\ICalendar\\DateTime',
- 'DTSTAMP' => 'Sabre\\VObject\\Property\\ICalendar\\DateTime',
- 'LAST-MODIFIED' => 'Sabre\\VObject\\Property\\ICalendar\\DateTime',
- 'SEQUENCE' => 'Sabre\\VObject\\Property\\IntegerValue',
- // Request Status
- 'REQUEST-STATUS' => 'Sabre\\VObject\\Property\\Text',
- // Additions from draft-daboo-valarm-extensions-04
- 'ALARM-AGENT' => 'Sabre\\VObject\\Property\\Text',
- 'ACKNOWLEDGED' => 'Sabre\\VObject\\Property\\ICalendar\\DateTime',
- 'PROXIMITY' => 'Sabre\\VObject\\Property\\Text',
- 'DEFAULT-ALARM' => 'Sabre\\VObject\\Property\\Boolean',
- // Additions from draft-daboo-calendar-availability-05
- 'BUSYTYPE' => 'Sabre\\VObject\\Property\\Text',
- );
- /**
- * Returns the current document type.
- *
- * @return void
- */
- function getDocumentType() {
- return self::ICALENDAR20;
- }
- /**
- * Returns a list of all 'base components'. For instance, if an Event has
- * a recurrence rule, and one instance is overridden, the overridden event
- * will have the same UID, but will be excluded from this list.
- *
- * VTIMEZONE components will always be excluded.
- *
- * @param string $componentName filter by component name
- * @return VObject\Component[]
- */
- function getBaseComponents($componentName = null) {
- $components = array();
- foreach($this->children as $component) {
- if (!$component instanceof VObject\Component)
- continue;
- if (isset($component->{'RECURRENCE-ID'}))
- continue;
- if ($componentName && $component->name !== strtoupper($componentName))
- continue;
- if ($component->name === 'VTIMEZONE')
- continue;
- $components[] = $component;
- }
- return $components;
- }
- /**
- * Returns the first component that is not a VTIMEZONE, and does not have
- * an RECURRENCE-ID.
- *
- * If there is no such component, null will be returned.
- *
- * @param string $componentName filter by component name
- * @return VObject\Component|null
- */
- function getBaseComponent($componentName = null) {
- foreach($this->children as $component) {
- if (!$component instanceof VObject\Component)
- continue;
- if (isset($component->{'RECURRENCE-ID'}))
- continue;
- if ($componentName && $component->name !== strtoupper($componentName))
- continue;
- if ($component->name === 'VTIMEZONE')
- continue;
- return $component;
- }
- }
- /**
- * If this calendar object, has events with recurrence rules, this method
- * can be used to expand the event into multiple sub-events.
- *
- * Each event will be stripped from it's recurrence information, and only
- * the instances of the event in the specified timerange will be left
- * alone.
- *
- * In addition, this method will cause timezone information to be stripped,
- * and normalized to UTC.
- *
- * This method will alter the VCalendar. This cannot be reversed.
- *
- * This functionality is specifically used by the CalDAV standard. It is
- * possible for clients to request expand events, if they are rather simple
- * clients and do not have the possibility to calculate recurrences.
- *
- * @param DateTime $start
- * @param DateTime $end
- * @param DateTimeZone $timeZone reference timezone for floating dates and
- * times.
- * @return void
- */
- function expand(DateTime $start, DateTime $end, DateTimeZone $timeZone = null) {
- $newEvents = array();
- if (!$timeZone) {
- $timeZone = new DateTimeZone('UTC');
- }
- // An array of events. Events are indexed by UID. Each item in this
- // array is a list of one or more events that match the UID.
- $recurringEvents = array();
- foreach($this->select('VEVENT') as $key=>$vevent) {
- $uid = (string)$vevent->UID;
- if (!$uid) {
- throw new \LogicException('Event did not have a UID!');
- }
- if (isset($vevent->{'RECURRENCE-ID'}) || isset($vevent->RRULE)) {
- if (isset($recurringEvents[$uid])) {
- $recurringEvents[$uid][] = $vevent;
- } else {
- $recurringEvents[$uid] = array($vevent);
- }
- continue;
- }
- if (!isset($vevent->RRULE)) {
- if ($vevent->isInTimeRange($start, $end)) {
- $newEvents[] = $vevent;
- }
- continue;
- }
- }
- foreach($recurringEvents as $events) {
- try {
- $it = new EventIterator($events, $timeZone);
- } catch (NoInstancesException $e) {
- // This event is recurring, but it doesn't have a single
- // instance. We are skipping this event from the output
- // entirely.
- continue;
- }
- $it->fastForward($start);
- while($it->valid() && $it->getDTStart() < $end) {
- if ($it->getDTEnd() > $start) {
- $newEvents[] = $it->getEventObject();
- }
- $it->next();
- }
- }
- // Wiping out all old VEVENT objects
- unset($this->VEVENT);
- // Setting all properties to UTC time.
- foreach($newEvents as $newEvent) {
- foreach($newEvent->children as $child) {
- if ($child instanceof VObject\Property\ICalendar\DateTime && $child->hasTime()) {
- $dt = $child->getDateTimes($timeZone);
- // We only need to update the first timezone, because
- // setDateTimes will match all other timezones to the
- // first.
- $dt[0]->setTimeZone(new DateTimeZone('UTC'));
- $child->setDateTimes($dt);
- }
- }
- $this->add($newEvent);
- }
- // Removing all VTIMEZONE components
- unset($this->VTIMEZONE);
- }
- /**
- * This method should return a list of default property values.
- *
- * @return array
- */
- protected function getDefaults() {
- return array(
- 'VERSION' => '2.0',
- 'PRODID' => '-//Sabre//Sabre VObject ' . VObject\Version::VERSION . '//EN',
- 'CALSCALE' => 'GREGORIAN',
- );
- }
- /**
- * A simple list of validation rules.
- *
- * This is simply a list of properties, and how many times they either
- * must or must not appear.
- *
- * Possible values per property:
- * * 0 - Must not appear.
- * * 1 - Must appear exactly once.
- * * + - Must appear at least once.
- * * * - Can appear any number of times.
- * * ? - May appear, but not more than once.
- *
- * @var array
- */
- function getValidationRules() {
- return array(
- 'PRODID' => 1,
- 'VERSION' => 1,
- 'CALSCALE' => '?',
- 'METHOD' => '?',
- );
- }
- /**
- * Validates the node for correctness.
- *
- * The following options are supported:
- * Node::REPAIR - May attempt to automatically repair the problem.
- * Node::PROFILE_CARDDAV - Validate the vCard for CardDAV purposes.
- * Node::PROFILE_CALDAV - Validate the iCalendar for CalDAV purposes.
- *
- * This method returns an array with detected problems.
- * Every element has the following properties:
- *
- * * level - problem level.
- * * message - A human-readable string describing the issue.
- * * node - A reference to the problematic node.
- *
- * The level means:
- * 1 - The issue was repaired (only happens if REPAIR was turned on).
- * 2 - A warning.
- * 3 - An error.
- *
- * @param int $options
- * @return array
- */
- function validate($options = 0) {
- $warnings = parent::validate($options);
- if ($ver = $this->VERSION) {
- if ((string)$ver !== '2.0') {
- $warnings[] = array(
- 'level' => 3,
- 'message' => 'Only iCalendar version 2.0 as defined in rfc5545 is supported.',
- 'node' => $this,
- );
- }
- }
- $uidList = array();
- $componentsFound = 0;
- $componentTypes = array();
- foreach($this->children as $child) {
- if($child instanceof Component) {
- $componentsFound++;
- if (!in_array($child->name, array('VEVENT', 'VTODO', 'VJOURNAL'))) {
- continue;
- }
- $componentTypes[] = $child->name;
- $uid = (string)$child->UID;
- $isMaster = isset($child->{'RECURRENCE-ID'})?0:1;
- if (isset($uidList[$uid])) {
- $uidList[$uid]['count']++;
- if ($isMaster && $uidList[$uid]['hasMaster']) {
- $warnings[] = array(
- 'level' => 3,
- 'message' => 'More than one master object was found for the object with UID ' . $uid,
- 'node' => $this,
- );
- }
- $uidList[$uid]['hasMaster']+=$isMaster;
- } else {
- $uidList[$uid] = array(
- 'count' => 1,
- 'hasMaster' => $isMaster,
- );
- }
- }
- }
- if ($componentsFound===0) {
- $warnings[] = array(
- 'level' => 3,
- 'message' => 'An iCalendar object must have at least 1 component.',
- 'node' => $this,
- );
- }
- if ($options & self::PROFILE_CALDAV) {
- if (count($uidList)>1) {
- $warnings[] = array(
- 'level' => 3,
- 'message' => 'A calendar object on a CalDAV server may only have components with the same UID.',
- 'node' => $this,
- );
- }
- if (count(array_unique($componentTypes))===0) {
- $warnings[] = array(
- 'level' => 3,
- 'message' => 'A calendar object on a CalDAV server must have at least 1 component (VTODO, VEVENT, VJOURNAL).',
- 'node' => $this,
- );
- }
- if (count(array_unique($componentTypes))>1) {
- $warnings[] = array(
- 'level' => 3,
- 'message' => 'A calendar object on a CalDAV server may only have 1 type of component (VEVENT, VTODO or VJOURNAL).',
- 'node' => $this,
- );
- }
- if (isset($this->METHOD)) {
- $warnings[] = array(
- 'level' => 3,
- 'message' => 'A calendar object on a CalDAV server MUST NOT have a METHOD property.',
- 'node' => $this,
- );
- }
- }
- return $warnings;
- }
- /**
- * Returns all components with a specific UID value.
- *
- * @return array
- */
- function getByUID($uid) {
- return array_filter($this->children, function($item) use ($uid) {
- if (!$item instanceof Component) {
- return false;
- }
- if (!$itemUid = $item->select('UID')) {
- return false;
- }
- $itemUid = current($itemUid)->getValue();
- return $uid === $itemUid;
- });
- }
- }
|