feat(CalDAV): Add function to check if calendar is publicly accessible with the provided token

Signed-off-by: David Dreschner <david.dreschner@nextcloud.com>

Author: DerDreschner

apps/dav/lib/CalDAV/CalendarImpl.php

@@ -16,13 +16,15 @@
 use OCP\Calendar\Exceptions\CalendarException;
 use OCP\Calendar\ICalendarExport;
 use OCP\Calendar\ICalendarIsEnabled;
+use OCP\Calendar\ICalendarIsPublic;
 use OCP\Calendar\ICalendarIsShared;
 use OCP\Calendar\ICalendarIsWritable;
 use OCP\Calendar\ICreateFromString;
 use OCP\Calendar\IHandleImipMessage;
 use OCP\Constants;
 use Sabre\CalDAV\Xml\Property\ScheduleCalendarTransp;
 use Sabre\DAV\Exception\Conflict;
+use Sabre\DAV\Exception\NotFound;
 use Sabre\VObject\Component\VCalendar;
 use Sabre\VObject\Component\VTimeZone;
 use Sabre\VObject\ITip\Message;
@@ -32,7 +34,7 @@
 
 use function Sabre\Uri\split as uriSplit;
 
-class CalendarImpl implements ICreateFromString, IHandleImipMessage, ICalendarIsWritable, ICalendarIsShared, ICalendarExport, ICalendarIsEnabled {
+class CalendarImpl implements ICreateFromString, IHandleImipMessage, ICalendarIsWritable, ICalendarIsShared, ICalendarExport, ICalendarIsEnabled, ICalendarIsPublic {
 	public function __construct(
 		private Calendar $calendar,
 		/** @var array<string, mixed> */
@@ -168,6 +170,19 @@ public function isShared(): bool {
 		return $this->calendar->isShared();
 	}
 
+	/**
+	 * @since 33.0.1, 32.0.7, 31.0.14.1, 30.0.17.8
+	 */
+	public function matchesToken(string $token): bool {
+		try {
+			$this->backend->getPublicCalendar($token);
+
+			return true;
+		} catch (NotFound) {
+			return false;
+		}
+	}
+
 	/**
 	 * @throws CalendarException
 	 */
@@ -336,5 +351,4 @@ public function export(?CalendarExportOptions $options = null): Generator {
 			}
 		}
 	}
-
 }

apps/dav/tests/unit/CalDAV/CalendarImplTest.php

@@ -33,7 +33,7 @@ protected function setUp(): void {
 		$this->backend = $this->createMock(CalDavBackend::class);
 		$this->calendar = $this->createMock(Calendar::class);
 		$this->calendarInfo = [
-			'id' => 'fancy_id_123',
+			'id' => 123,
 			'{DAV:}displayname' => 'user readable name 123',
 			'{http://apple.com/ns/ical/}calendar-color' => '#AABBCC',
 			'uri' => '/this/is/a/uri',
@@ -62,7 +62,7 @@ protected function setUp(): void {
 
 
 	public function testGetKey(): void {
-		$this->assertEquals($this->calendarImpl->getKey(), 'fancy_id_123');
+		$this->assertEquals($this->calendarImpl->getKey(), '123');
 	}
 
 	public function testGetDisplayname(): void {
@@ -73,6 +73,28 @@ public function testGetDisplayColor(): void {
 		$this->assertEquals($this->calendarImpl->getDisplayColor(), '#AABBCC');
 	}
 
+	public function testMatchesTokenWithValidToken(): void {
+		$testToken = 'abc123';
+
+		$this->backend->expects($this->once())
+			->method('getPublicCalendar')
+			->with($testToken)
+			->willReturn(true);
+
+		$this->assertTrue($this->calendarImpl->matchesToken($testToken));
+	}
+
+	public function testMatchesTokenWithInvalidToken(): void {
+		$testToken = 'abc123';
+
+		$this->backend->expects($this->once())
+			->method('getPublicCalendar')
+			->with($testToken)
+			->willReturn(false);
+
+		$this->assertTrue($this->calendarImpl->matchesToken($testToken));
+	}
+
 	public function testSearch(): void {
 		$this->backend->expects($this->once())
 			->method('search')
@@ -266,5 +288,4 @@ public function getHrefs(): array {
 
 		$calendarImpl->handleIMipMessage('fakeUser', $vObject->serialize());
 	}
-
 }

lib/composer/composer/autoload_classmap.php

@@ -222,6 +222,7 @@
     'OCP\\Calendar\\ICalendarEventBuilder' => $baseDir . '/lib/public/Calendar/ICalendarEventBuilder.php',
     'OCP\\Calendar\\ICalendarExport' => $baseDir . '/lib/public/Calendar/ICalendarExport.php',
     'OCP\\Calendar\\ICalendarIsEnabled' => $baseDir . '/lib/public/Calendar/ICalendarIsEnabled.php',
+    'OCP\\Calendar\\ICalendarIsPublic' => $baseDir . '/lib/public/Calendar/ICalendarIsPublic.php',
     'OCP\\Calendar\\ICalendarIsShared' => $baseDir . '/lib/public/Calendar/ICalendarIsShared.php',
     'OCP\\Calendar\\ICalendarIsWritable' => $baseDir . '/lib/public/Calendar/ICalendarIsWritable.php',
     'OCP\\Calendar\\ICalendarProvider' => $baseDir . '/lib/public/Calendar/ICalendarProvider.php',

lib/composer/composer/autoload_static.php

@@ -263,6 +263,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OCP\\Calendar\\ICalendarEventBuilder' => __DIR__ . '/../../..' . '/lib/public/Calendar/ICalendarEventBuilder.php',
         'OCP\\Calendar\\ICalendarExport' => __DIR__ . '/../../..' . '/lib/public/Calendar/ICalendarExport.php',
         'OCP\\Calendar\\ICalendarIsEnabled' => __DIR__ . '/../../..' . '/lib/public/Calendar/ICalendarIsEnabled.php',
+        'OCP\\Calendar\\ICalendarIsPublic' => __DIR__ . '/../../..' . '/lib/public/Calendar/ICalendarIsPublic.php',
         'OCP\\Calendar\\ICalendarIsShared' => __DIR__ . '/../../..' . '/lib/public/Calendar/ICalendarIsShared.php',
         'OCP\\Calendar\\ICalendarIsWritable' => __DIR__ . '/../../..' . '/lib/public/Calendar/ICalendarIsWritable.php',
         'OCP\\Calendar\\ICalendarProvider' => __DIR__ . '/../../..' . '/lib/public/Calendar/ICalendarProvider.php',

lib/public/Calendar/ICalendarIsPublic.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Calendar;
+
+/**
+ * @since 33.0.1, 32.0.7, 31.0.14.1, 30.0.17.8
+ */
+interface ICalendarIsPublic {
+	/**
+	 * Indicates whether the calendar is public
+	 * and accessible via the provided token.
+	 *
+	 * @since 33.0.1, 32.0.7, 31.0.14.1, 30.0.17.8
+	 */
+	public function matchesToken(string $token): bool;
+}