feat: create example event when a user logs in for the first time

Signed-off-by: Richard Steinmetz <[email protected]>

apps/dav/composer/composer/autoload_classmap.php

@@ -278,6 +278,7 @@
     'OCA\\DAV\\Events\\SubscriptionCreatedEvent' => $baseDir . '/../lib/Events/SubscriptionCreatedEvent.php',
     'OCA\\DAV\\Events\\SubscriptionDeletedEvent' => $baseDir . '/../lib/Events/SubscriptionDeletedEvent.php',
     'OCA\\DAV\\Events\\SubscriptionUpdatedEvent' => $baseDir . '/../lib/Events/SubscriptionUpdatedEvent.php',
+    'OCA\\DAV\\Exception\\ExampleEventException' => $baseDir . '/../lib/Exception/ExampleEventException.php',
     'OCA\\DAV\\Exception\\ServerMaintenanceMode' => $baseDir . '/../lib/Exception/ServerMaintenanceMode.php',
     'OCA\\DAV\\Exception\\UnsupportedLimitOnInitialSyncException' => $baseDir . '/../lib/Exception/UnsupportedLimitOnInitialSyncException.php',
     'OCA\\DAV\\Files\\BrowserErrorPagePlugin' => $baseDir . '/../lib/Files/BrowserErrorPagePlugin.php',
@@ -349,6 +350,7 @@
     'OCA\\DAV\\Migration\\Version1029Date20231004091403' => $baseDir . '/../lib/Migration/Version1029Date20231004091403.php',
     'OCA\\DAV\\Migration\\Version1030Date20240205103243' => $baseDir . '/../lib/Migration/Version1030Date20240205103243.php',
     'OCA\\DAV\\Migration\\Version1031Date20240610134258' => $baseDir . '/../lib/Migration/Version1031Date20240610134258.php',
+    'OCA\\DAV\\Model\\ExampleEvent' => $baseDir . '/../lib/Model/ExampleEvent.php',
     'OCA\\DAV\\Paginate\\LimitedCopyIterator' => $baseDir . '/../lib/Paginate/LimitedCopyIterator.php',
     'OCA\\DAV\\Paginate\\PaginateCache' => $baseDir . '/../lib/Paginate/PaginateCache.php',
     'OCA\\DAV\\Paginate\\PaginatePlugin' => $baseDir . '/../lib/Paginate/PaginatePlugin.php',
@@ -365,6 +367,7 @@
     'OCA\\DAV\\ServerFactory' => $baseDir . '/../lib/ServerFactory.php',
     'OCA\\DAV\\Service\\AbsenceService' => $baseDir . '/../lib/Service/AbsenceService.php',
     'OCA\\DAV\\Service\\DefaultContactService' => $baseDir . '/../lib/Service/DefaultContactService.php',
+    'OCA\\DAV\\Service\\ExampleEventService' => $baseDir . '/../lib/Service/ExampleEventService.php',
     'OCA\\DAV\\Settings\\Admin\\SystemAddressBookSettings' => $baseDir . '/../lib/Settings/Admin/SystemAddressBookSettings.php',
     'OCA\\DAV\\Settings\\AvailabilitySettings' => $baseDir . '/../lib/Settings/AvailabilitySettings.php',
     'OCA\\DAV\\Settings\\CalDAVSettings' => $baseDir . '/../lib/Settings/CalDAVSettings.php',

apps/dav/composer/composer/autoload_static.php

@@ -293,6 +293,7 @@ class ComposerStaticInitDAV
         'OCA\\DAV\\Events\\SubscriptionCreatedEvent' => __DIR__ . '/..' . '/../lib/Events/SubscriptionCreatedEvent.php',
         'OCA\\DAV\\Events\\SubscriptionDeletedEvent' => __DIR__ . '/..' . '/../lib/Events/SubscriptionDeletedEvent.php',
         'OCA\\DAV\\Events\\SubscriptionUpdatedEvent' => __DIR__ . '/..' . '/../lib/Events/SubscriptionUpdatedEvent.php',
+        'OCA\\DAV\\Exception\\ExampleEventException' => __DIR__ . '/..' . '/../lib/Exception/ExampleEventException.php',
         'OCA\\DAV\\Exception\\ServerMaintenanceMode' => __DIR__ . '/..' . '/../lib/Exception/ServerMaintenanceMode.php',
         'OCA\\DAV\\Exception\\UnsupportedLimitOnInitialSyncException' => __DIR__ . '/..' . '/../lib/Exception/UnsupportedLimitOnInitialSyncException.php',
         'OCA\\DAV\\Files\\BrowserErrorPagePlugin' => __DIR__ . '/..' . '/../lib/Files/BrowserErrorPagePlugin.php',
@@ -364,6 +365,7 @@ class ComposerStaticInitDAV
         'OCA\\DAV\\Migration\\Version1029Date20231004091403' => __DIR__ . '/..' . '/../lib/Migration/Version1029Date20231004091403.php',
         'OCA\\DAV\\Migration\\Version1030Date20240205103243' => __DIR__ . '/..' . '/../lib/Migration/Version1030Date20240205103243.php',
         'OCA\\DAV\\Migration\\Version1031Date20240610134258' => __DIR__ . '/..' . '/../lib/Migration/Version1031Date20240610134258.php',
+        'OCA\\DAV\\Model\\ExampleEvent' => __DIR__ . '/..' . '/../lib/Model/ExampleEvent.php',
         'OCA\\DAV\\Paginate\\LimitedCopyIterator' => __DIR__ . '/..' . '/../lib/Paginate/LimitedCopyIterator.php',
         'OCA\\DAV\\Paginate\\PaginateCache' => __DIR__ . '/..' . '/../lib/Paginate/PaginateCache.php',
         'OCA\\DAV\\Paginate\\PaginatePlugin' => __DIR__ . '/..' . '/../lib/Paginate/PaginatePlugin.php',
@@ -380,6 +382,7 @@ class ComposerStaticInitDAV
         'OCA\\DAV\\ServerFactory' => __DIR__ . '/..' . '/../lib/ServerFactory.php',
         'OCA\\DAV\\Service\\AbsenceService' => __DIR__ . '/..' . '/../lib/Service/AbsenceService.php',
         'OCA\\DAV\\Service\\DefaultContactService' => __DIR__ . '/..' . '/../lib/Service/DefaultContactService.php',
+        'OCA\\DAV\\Service\\ExampleEventService' => __DIR__ . '/..' . '/../lib/Service/ExampleEventService.php',
         'OCA\\DAV\\Settings\\Admin\\SystemAddressBookSettings' => __DIR__ . '/..' . '/../lib/Settings/Admin/SystemAddressBookSettings.php',
         'OCA\\DAV\\Settings\\AvailabilitySettings' => __DIR__ . '/..' . '/../lib/Settings/AvailabilitySettings.php',
         'OCA\\DAV\\Settings\\CalDAVSettings' => __DIR__ . '/..' . '/../lib/Settings/CalDAVSettings.php',

apps/dav/lib/Controller/ExampleContentController.php

@@ -10,9 +10,13 @@
 namespace OCA\DAV\Controller;
 
 use OCA\DAV\AppInfo\Application;
+use OCA\DAV\Service\ExampleEventService;
 use OCP\App\IAppManager;
 use OCP\AppFramework\ApiController;
 use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\Attribute\FrontpageRoute;
+use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
+use OCP\AppFramework\Http\DataDownloadResponse;
 use OCP\AppFramework\Http\JSONResponse;
 use OCP\Files\AppData\IAppDataFactory;
 use OCP\Files\IAppData;
@@ -23,12 +27,14 @@
 
 class ExampleContentController extends ApiController {
 	private IAppData $appData;
+
 	public function __construct(
 		IRequest $request,
+		IAppManager $appManager,
 		private IConfig $config,
 		private IAppDataFactory $appDataFactory,
-		private IAppManager $appManager,
 		private LoggerInterface $logger,
+		private ExampleEventService $exampleEventService,
 	) {
 		parent::__construct(Application::APP_ID, $request);
 		$this->appData = $this->appDataFactory->get('dav');
@@ -83,4 +89,37 @@ private function defaultContactExists(): bool {
 		return $folder->fileExists('defaultContact.vcf');
 	}
 
+	#[FrontpageRoute(verb: 'POST', url: '/api/exampleEvent/enable')]
+	public function setCreateExampleEvent(bool $enable): JSONResponse {
+		$this->exampleEventService->setCreateExampleEvent($enable);
+		return new JsonResponse([]);
+	}
+
+	#[FrontpageRoute(verb: 'GET', url: '/api/exampleEvent/event')]
+	#[NoCSRFRequired]
+	public function downloadExampleEvent(): DataDownloadResponse {
+		$exampleEvent = $this->exampleEventService->getExampleEvent();
+		return new DataDownloadResponse(
+			$exampleEvent->getIcs(),
+			'example_event.ics',
+			'text/calendar',
+		);
+	}
+
+	#[FrontpageRoute(verb: 'POST', url: '/api/exampleEvent/event')]
+	public function uploadExampleEvent(string $ics): JSONResponse {
+		if (!$this->exampleEventService->shouldCreateExampleEvent()) {
+			return new JSONResponse([], Http::STATUS_FORBIDDEN);
+		}
+
+		$this->exampleEventService->saveCustomExampleEvent($ics);
+		return new JsonResponse([]);
+	}
+
+	#[FrontpageRoute(verb: 'DELETE', url: '/api/exampleEvent/event')]
+	public function deleteExampleEvent(): JSONResponse {
+		$this->exampleEventService->deleteCustomExampleEvent();
+		return new JsonResponse([]);
+	}
+
 }

apps/dav/lib/Exception/ExampleEventException.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\DAV\Exception;
+
+class ExampleEventException extends \Exception {
+}

apps/dav/lib/Listener/UserEventsListener.php

@@ -13,13 +13,13 @@
 use OCA\DAV\CardDAV\CardDavBackend;
 use OCA\DAV\CardDAV\SyncService;
 use OCA\DAV\Service\DefaultContactService;
+use OCA\DAV\Service\ExampleEventService;
 use OCP\Accounts\UserUpdatedEvent;
 use OCP\Defaults;
 use OCP\EventDispatcher\Event;
 use OCP\EventDispatcher\IEventListener;
 use OCP\IUser;
 use OCP\IUserManager;
-use OCP\Server;
 use OCP\User\Events\BeforeUserDeletedEvent;
 use OCP\User\Events\BeforeUserIdUnassignedEvent;
 use OCP\User\Events\UserChangedEvent;
@@ -47,6 +47,8 @@ public function __construct(
 		private CardDavBackend $cardDav,
 		private Defaults $themingDefaults,
 		private DefaultContactService $defaultContactService,
+		private ExampleEventService $exampleEventService,
+		private LoggerInterface $logger,
 	) {
 	}
 
@@ -137,25 +139,39 @@ public function changeUser(IUser $user, string $feature): void {
 
 	public function firstLogin(IUser $user): void {
 		$principal = 'principals/users/' . $user->getUID();
+
+		$calendarId = null;
 		if ($this->calDav->getCalendarsForUserCount($principal) === 0) {
 			try {
-				$this->calDav->createCalendar($principal, CalDavBackend::PERSONAL_CALENDAR_URI, [
+				$calendarId = $this->calDav->createCalendar($principal, CalDavBackend::PERSONAL_CALENDAR_URI, [
 					'{DAV:}displayname' => CalDavBackend::PERSONAL_CALENDAR_NAME,
 					'{http://apple.com/ns/ical/}calendar-color' => $this->themingDefaults->getColorPrimary(),
 					'components' => 'VEVENT'
 				]);
 			} catch (\Exception $e) {
-				Server::get(LoggerInterface::class)->error($e->getMessage(), ['exception' => $e]);
+				$this->logger->error($e->getMessage(), ['exception' => $e]);
 			}
 		}
+		if ($calendarId !== null) {
+			try {
+				$this->exampleEventService->createExampleEvent($calendarId);
+			} catch (\Exception $e) {
+				$this->logger->error('Failed to create example event: ' . $e->getMessage(), [
+					'exception' => $e,
+					'userId' => $user->getUID(),
+					'calendarId' => $calendarId,
+				]);
+			}
+		}
+
 		$addressBookId = null;
 		if ($this->cardDav->getAddressBooksForUserCount($principal) === 0) {
 			try {
 				$addressBookId = $this->cardDav->createAddressBook($principal, CardDavBackend::PERSONAL_ADDRESSBOOK_URI, [
 					'{DAV:}displayname' => CardDavBackend::PERSONAL_ADDRESSBOOK_NAME,
 				]);
 			} catch (\Exception $e) {
-				Server::get(LoggerInterface::class)->error($e->getMessage(), ['exception' => $e]);
+				$this->logger->error($e->getMessage(), ['exception' => $e]);
 			}
 		}
 		if ($addressBookId) {

apps/dav/lib/Model/ExampleEvent.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\DAV\Model;
+
+use Sabre\VObject\Component\VCalendar;
+
+/**
+ * Simple DTO to store a parsed example event and its UID.
+ */
+final class ExampleEvent {
+	public function __construct(
+		private readonly VCalendar $vCalendar,
+		private readonly string $uid,
+	) {
+	}
+
+	public function getUid(): string {
+		return $this->uid;
+	}
+
+	public function getIcs(): string {
+		return $this->vCalendar->serialize();
+	}
+}