123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375 |
- <?php
- namespace Sabre\CalDAV;
- use Sabre\VObject;
- use DateTime;
- /**
- * CalendarQuery Validator
- *
- * This class is responsible for checking if an iCalendar object matches a set
- * of filters. The main function to do this is 'validate'.
- *
- * This is used to determine which icalendar objects should be returned for a
- * calendar-query REPORT request.
- *
- * @copyright Copyright (C) fruux GmbH (https://fruux.com/)
- * @author Evert Pot (http://evertpot.com/)
- * @license http://sabre.io/license/ Modified BSD License
- */
- class CalendarQueryValidator {
- /**
- * Verify if a list of filters applies to the calendar data object
- *
- * The list of filters must be formatted as parsed by \Sabre\CalDAV\CalendarQueryParser
- *
- * @param VObject\Component $vObject
- * @param array $filters
- * @return bool
- */
- function validate(VObject\Component\VCalendar $vObject, array $filters) {
- // The top level object is always a component filter.
- // We'll parse it manually, as it's pretty simple.
- if ($vObject->name !== $filters['name']) {
- return false;
- }
- return
- $this->validateCompFilters($vObject, $filters['comp-filters']) &&
- $this->validatePropFilters($vObject, $filters['prop-filters']);
- }
- /**
- * This method checks the validity of comp-filters.
- *
- * A list of comp-filters needs to be specified. Also the parent of the
- * component we're checking should be specified, not the component to check
- * itself.
- *
- * @param VObject\Component $parent
- * @param array $filters
- * @return bool
- */
- protected function validateCompFilters(VObject\Component $parent, array $filters) {
- foreach ($filters as $filter) {
- $isDefined = isset($parent->{$filter['name']});
- if ($filter['is-not-defined']) {
- if ($isDefined) {
- return false;
- } else {
- continue;
- }
- }
- if (!$isDefined) {
- return false;
- }
- if ($filter['time-range']) {
- foreach ($parent->{$filter['name']} as $subComponent) {
- if ($this->validateTimeRange($subComponent, $filter['time-range']['start'], $filter['time-range']['end'])) {
- continue 2;
- }
- }
- return false;
- }
- if (!$filter['comp-filters'] && !$filter['prop-filters']) {
- continue;
- }
- // If there are sub-filters, we need to find at least one component
- // for which the subfilters hold true.
- foreach ($parent->{$filter['name']} as $subComponent) {
- if (
- $this->validateCompFilters($subComponent, $filter['comp-filters']) &&
- $this->validatePropFilters($subComponent, $filter['prop-filters'])) {
- // We had a match, so this comp-filter succeeds
- continue 2;
- }
- }
- // If we got here it means there were sub-comp-filters or
- // sub-prop-filters and there was no match. This means this filter
- // needs to return false.
- return false;
- }
- // If we got here it means we got through all comp-filters alive so the
- // filters were all true.
- return true;
- }
- /**
- * This method checks the validity of prop-filters.
- *
- * A list of prop-filters needs to be specified. Also the parent of the
- * property we're checking should be specified, not the property to check
- * itself.
- *
- * @param VObject\Component $parent
- * @param array $filters
- * @return bool
- */
- protected function validatePropFilters(VObject\Component $parent, array $filters) {
- foreach ($filters as $filter) {
- $isDefined = isset($parent->{$filter['name']});
- if ($filter['is-not-defined']) {
- if ($isDefined) {
- return false;
- } else {
- continue;
- }
- }
- if (!$isDefined) {
- return false;
- }
- if ($filter['time-range']) {
- foreach ($parent->{$filter['name']} as $subComponent) {
- if ($this->validateTimeRange($subComponent, $filter['time-range']['start'], $filter['time-range']['end'])) {
- continue 2;
- }
- }
- return false;
- }
- if (!$filter['param-filters'] && !$filter['text-match']) {
- continue;
- }
- // If there are sub-filters, we need to find at least one property
- // for which the subfilters hold true.
- foreach ($parent->{$filter['name']} as $subComponent) {
- if (
- $this->validateParamFilters($subComponent, $filter['param-filters']) &&
- (!$filter['text-match'] || $this->validateTextMatch($subComponent, $filter['text-match']))
- ) {
- // We had a match, so this prop-filter succeeds
- continue 2;
- }
- }
- // If we got here it means there were sub-param-filters or
- // text-match filters and there was no match. This means the
- // filter needs to return false.
- return false;
- }
- // If we got here it means we got through all prop-filters alive so the
- // filters were all true.
- return true;
- }
- /**
- * This method checks the validity of param-filters.
- *
- * A list of param-filters needs to be specified. Also the parent of the
- * parameter we're checking should be specified, not the parameter to check
- * itself.
- *
- * @param VObject\Property $parent
- * @param array $filters
- * @return bool
- */
- protected function validateParamFilters(VObject\Property $parent, array $filters) {
- foreach ($filters as $filter) {
- $isDefined = isset($parent[$filter['name']]);
- if ($filter['is-not-defined']) {
- if ($isDefined) {
- return false;
- } else {
- continue;
- }
- }
- if (!$isDefined) {
- return false;
- }
- if (!$filter['text-match']) {
- continue;
- }
- // If there are sub-filters, we need to find at least one parameter
- // for which the subfilters hold true.
- foreach ($parent[$filter['name']]->getParts() as $paramPart) {
- if ($this->validateTextMatch($paramPart, $filter['text-match'])) {
- // We had a match, so this param-filter succeeds
- continue 2;
- }
- }
- // If we got here it means there was a text-match filter and there
- // were no matches. This means the filter needs to return false.
- return false;
- }
- // If we got here it means we got through all param-filters alive so the
- // filters were all true.
- return true;
- }
- /**
- * This method checks the validity of a text-match.
- *
- * A single text-match should be specified as well as the specific property
- * or parameter we need to validate.
- *
- * @param VObject\Node|string $check Value to check against.
- * @param array $textMatch
- * @return bool
- */
- protected function validateTextMatch($check, array $textMatch) {
- if ($check instanceof VObject\Node) {
- $check = $check->getValue();
- }
- $isMatching = \Sabre\DAV\StringUtil::textMatch($check, $textMatch['value'], $textMatch['collation']);
- return ($textMatch['negate-condition'] xor $isMatching);
- }
- /**
- * Validates if a component matches the given time range.
- *
- * This is all based on the rules specified in rfc4791, which are quite
- * complex.
- *
- * @param VObject\Node $component
- * @param DateTime $start
- * @param DateTime $end
- * @return bool
- */
- protected function validateTimeRange(VObject\Node $component, $start, $end) {
- if (is_null($start)) {
- $start = new DateTime('1900-01-01');
- }
- if (is_null($end)) {
- $end = new DateTime('3000-01-01');
- }
- switch ($component->name) {
- case 'VEVENT' :
- case 'VTODO' :
- case 'VJOURNAL' :
- return $component->isInTimeRange($start, $end);
- case 'VALARM' :
- // If the valarm is wrapped in a recurring event, we need to
- // expand the recursions, and validate each.
- //
- // Our datamodel doesn't easily allow us to do this straight
- // in the VALARM component code, so this is a hack, and an
- // expensive one too.
- if ($component->parent->name === 'VEVENT' && $component->parent->RRULE) {
- // Fire up the iterator!
- $it = new VObject\Recur\EventIterator($component->parent->parent, (string)$component->parent->UID);
- while ($it->valid()) {
- $expandedEvent = $it->getEventObject();
- // We need to check from these expanded alarms, which
- // one is the first to trigger. Based on this, we can
- // determine if we can 'give up' expanding events.
- $firstAlarm = null;
- if ($expandedEvent->VALARM !== null) {
- foreach ($expandedEvent->VALARM as $expandedAlarm) {
- $effectiveTrigger = $expandedAlarm->getEffectiveTriggerTime();
- if ($expandedAlarm->isInTimeRange($start, $end)) {
- return true;
- }
- if ((string)$expandedAlarm->TRIGGER['VALUE'] === 'DATE-TIME') {
- // This is an alarm with a non-relative trigger
- // time, likely created by a buggy client. The
- // implication is that every alarm in this
- // recurring event trigger at the exact same
- // time. It doesn't make sense to traverse
- // further.
- } else {
- // We store the first alarm as a means to
- // figure out when we can stop traversing.
- if (!$firstAlarm || $effectiveTrigger < $firstAlarm) {
- $firstAlarm = $effectiveTrigger;
- }
- }
- }
- }
- if (is_null($firstAlarm)) {
- // No alarm was found.
- //
- // Or technically: No alarm that will change for
- // every instance of the recurrence was found,
- // which means we can assume there was no match.
- return false;
- }
- if ($firstAlarm > $end) {
- return false;
- }
- $it->next();
- }
- return false;
- } else {
- return $component->isInTimeRange($start, $end);
- }
- case 'VFREEBUSY' :
- throw new \Sabre\DAV\Exception\NotImplemented('time-range filters are currently not supported on ' . $component->name . ' components');
- case 'COMPLETED' :
- case 'CREATED' :
- case 'DTEND' :
- case 'DTSTAMP' :
- case 'DTSTART' :
- case 'DUE' :
- case 'LAST-MODIFIED' :
- return ($start <= $component->getDateTime() && $end >= $component->getDateTime());
- default :
- throw new \Sabre\DAV\Exception\BadRequest('You cannot create a time-range filter on a ' . $component->name . ' component');
- }
- }
- }
|