123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273 |
- <?php
- declare(strict_types=1);
- /**
- * SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors
- * SPDX-License-Identifier: AGPL-3.0-or-later
- */
- namespace OCA\DAV\Search;
- use OCA\DAV\CalDAV\CalDavBackend;
- use OCP\IUser;
- use OCP\Search\IFilteringProvider;
- use OCP\Search\ISearchQuery;
- use OCP\Search\SearchResult;
- use OCP\Search\SearchResultEntry;
- use Sabre\VObject\Component;
- use Sabre\VObject\DateTimeParser;
- use Sabre\VObject\Property;
- use function array_combine;
- use function array_fill;
- use function array_key_exists;
- use function array_map;
- /**
- * Class EventsSearchProvider
- *
- * @package OCA\DAV\Search
- */
- class EventsSearchProvider extends ACalendarSearchProvider implements IFilteringProvider {
- /**
- * @var string[]
- */
- private static $searchProperties = [
- 'SUMMARY',
- 'LOCATION',
- 'DESCRIPTION',
- 'ATTENDEE',
- 'ORGANIZER',
- 'CATEGORIES',
- ];
- /**
- * @var string[]
- */
- private static $searchParameters = [
- 'ATTENDEE' => ['CN'],
- 'ORGANIZER' => ['CN'],
- ];
- /**
- * @var string
- */
- private static $componentType = 'VEVENT';
- /**
- * @inheritDoc
- */
- public function getId(): string {
- return 'calendar';
- }
- /**
- * @inheritDoc
- */
- public function getName(): string {
- return $this->l10n->t('Events');
- }
- /**
- * @inheritDoc
- */
- public function getOrder(string $route, array $routeParameters): ?int {
- if ($this->appManager->isEnabledForUser('calendar')) {
- return $route === 'calendar.View.index' ? -1 : 30;
- }
- return null;
- }
- /**
- * @inheritDoc
- */
- public function search(
- IUser $user,
- ISearchQuery $query,
- ): SearchResult {
- if (!$this->appManager->isEnabledForUser('calendar', $user)) {
- return SearchResult::complete($this->getName(), []);
- }
- $principalUri = 'principals/users/' . $user->getUID();
- $calendarsById = $this->getSortedCalendars($principalUri);
- $subscriptionsById = $this->getSortedSubscriptions($principalUri);
- /** @var string|null $term */
- $term = $query->getFilter('term')?->get();
- if ($term === null) {
- $searchResults = [];
- } else {
- $searchResults = $this->backend->searchPrincipalUri(
- $principalUri,
- $term,
- [self::$componentType],
- self::$searchProperties,
- self::$searchParameters,
- [
- 'limit' => $query->getLimit(),
- 'offset' => $query->getCursor(),
- 'timerange' => [
- 'start' => $query->getFilter('since')?->get(),
- 'end' => $query->getFilter('until')?->get(),
- ],
- ]
- );
- }
- /** @var IUser|null $person */
- $person = $query->getFilter('person')?->get();
- $personDisplayName = $person?->getDisplayName();
- if ($personDisplayName !== null) {
- $attendeeSearchResults = $this->backend->searchPrincipalUri(
- $principalUri,
- $personDisplayName,
- [self::$componentType],
- ['ATTENDEE'],
- self::$searchParameters,
- [
- 'limit' => $query->getLimit(),
- 'offset' => $query->getCursor(),
- 'timerange' => [
- 'start' => $query->getFilter('since')?->get(),
- 'end' => $query->getFilter('until')?->get(),
- ],
- ],
- );
- $searchResultIndex = array_combine(
- array_map(fn ($event) => $event['calendarid'] . '-' . $event['uri'], $searchResults),
- array_fill(0, count($searchResults), null),
- );
- foreach ($attendeeSearchResults as $attendeeResult) {
- if (array_key_exists($attendeeResult['calendarid'] . '-' . $attendeeResult['uri'], $searchResultIndex)) {
- // Duplicate
- continue;
- }
- $searchResults[] = $attendeeResult;
- }
- }
- $formattedResults = \array_map(function (array $eventRow) use ($calendarsById, $subscriptionsById): SearchResultEntry {
- $component = $this->getPrimaryComponent($eventRow['calendardata'], self::$componentType);
- $title = (string)($component->SUMMARY ?? $this->l10n->t('Untitled event'));
- $subline = $this->generateSubline($component);
- if ($eventRow['calendartype'] === CalDavBackend::CALENDAR_TYPE_CALENDAR) {
- $calendar = $calendarsById[$eventRow['calendarid']];
- } else {
- $calendar = $subscriptionsById[$eventRow['calendarid']];
- }
- $resourceUrl = $this->getDeepLinkToCalendarApp($calendar['principaluri'], $calendar['uri'], $eventRow['uri']);
- return new SearchResultEntry('', $title, $subline, $resourceUrl, 'icon-calendar-dark', false);
- }, $searchResults);
- return SearchResult::paginated(
- $this->getName(),
- $formattedResults,
- $query->getCursor() + count($formattedResults)
- );
- }
- protected function getDeepLinkToCalendarApp(
- string $principalUri,
- string $calendarUri,
- string $calendarObjectUri,
- ): string {
- $davUrl = $this->getDavUrlForCalendarObject($principalUri, $calendarUri, $calendarObjectUri);
- // This route will automatically figure out what recurrence-id to open
- return $this->urlGenerator->getAbsoluteURL(
- $this->urlGenerator->linkToRoute('calendar.view.index')
- . 'edit/'
- . base64_encode($davUrl)
- );
- }
- protected function getDavUrlForCalendarObject(
- string $principalUri,
- string $calendarUri,
- string $calendarObjectUri
- ): string {
- [,, $principalId] = explode('/', $principalUri, 3);
- return $this->urlGenerator->linkTo('', 'remote.php') . '/dav/calendars/'
- . $principalId . '/'
- . $calendarUri . '/'
- . $calendarObjectUri;
- }
- protected function generateSubline(Component $eventComponent): string {
- $dtStart = $eventComponent->DTSTART;
- $dtEnd = $this->getDTEndForEvent($eventComponent);
- $isAllDayEvent = $dtStart instanceof Property\ICalendar\Date;
- $startDateTime = new \DateTime($dtStart->getDateTime()->format(\DateTimeInterface::ATOM));
- $endDateTime = new \DateTime($dtEnd->getDateTime()->format(\DateTimeInterface::ATOM));
- if ($isAllDayEvent) {
- $endDateTime->modify('-1 day');
- if ($this->isDayEqual($startDateTime, $endDateTime)) {
- return $this->l10n->l('date', $startDateTime, ['width' => 'medium']);
- }
- $formattedStart = $this->l10n->l('date', $startDateTime, ['width' => 'medium']);
- $formattedEnd = $this->l10n->l('date', $endDateTime, ['width' => 'medium']);
- return "$formattedStart - $formattedEnd";
- }
- $formattedStartDate = $this->l10n->l('date', $startDateTime, ['width' => 'medium']);
- $formattedEndDate = $this->l10n->l('date', $endDateTime, ['width' => 'medium']);
- $formattedStartTime = $this->l10n->l('time', $startDateTime, ['width' => 'short']);
- $formattedEndTime = $this->l10n->l('time', $endDateTime, ['width' => 'short']);
- if ($this->isDayEqual($startDateTime, $endDateTime)) {
- return "$formattedStartDate $formattedStartTime - $formattedEndTime";
- }
- return "$formattedStartDate $formattedStartTime - $formattedEndDate $formattedEndTime";
- }
- protected function getDTEndForEvent(Component $eventComponent):Property {
- if (isset($eventComponent->DTEND)) {
- $end = $eventComponent->DTEND;
- } elseif (isset($eventComponent->DURATION)) {
- $isFloating = $eventComponent->DTSTART->isFloating();
- $end = clone $eventComponent->DTSTART;
- $endDateTime = $end->getDateTime();
- $endDateTime = $endDateTime->add(DateTimeParser::parse($eventComponent->DURATION->getValue()));
- $end->setDateTime($endDateTime, $isFloating);
- } elseif (!$eventComponent->DTSTART->hasTime()) {
- $isFloating = $eventComponent->DTSTART->isFloating();
- $end = clone $eventComponent->DTSTART;
- $endDateTime = $end->getDateTime();
- $endDateTime = $endDateTime->modify('+1 day');
- $end->setDateTime($endDateTime, $isFloating);
- } else {
- $end = clone $eventComponent->DTSTART;
- }
- return $end;
- }
- protected function isDayEqual(
- \DateTime $dtStart,
- \DateTime $dtEnd,
- ): bool {
- return $dtStart->format('Y-m-d') === $dtEnd->format('Y-m-d');
- }
- public function getSupportedFilters(): array {
- return [
- 'term',
- 'person',
- 'since',
- 'until',
- ];
- }
- public function getAlternateIds(): array {
- return [];
- }
- public function getCustomFilters(): array {
- return [];
- }
- }
|