feat: OCC and OCS Calendar Import/Export

apps/dav/lib/CalDAV/CalDavBackend.php

@@ -9,6 +9,7 @@
 use DateTime;
 use DateTimeImmutable;
 use DateTimeInterface;
+use Generator;
 use OCA\DAV\AppInfo\Application;
 use OCA\DAV\CalDAV\Sharing\Backend;
 use OCA\DAV\Connector\Sabre\Principal;
@@ -34,6 +35,7 @@
 use OCA\DAV\Events\SubscriptionDeletedEvent;
 use OCA\DAV\Events\SubscriptionUpdatedEvent;
 use OCP\AppFramework\Db\TTransactional;
+use OCP\Calendar\CalendarExportRange;
 use OCP\Calendar\Exceptions\CalendarException;
 use OCP\DB\Exception;
 use OCP\DB\QueryBuilder\IQueryBuilder;
@@ -950,6 +952,29 @@ public function restoreCalendar(int $id): void {
 		}, $this->db);
 	}
 
+
+	public function exportCalendar($calendarId, $calendarType = self::CALENDAR_TYPE_CALENDAR, ?CalendarExportRange $range = null): Generator {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('*')
+			->from('calendarobjects')
+			->where($qb->expr()->eq('calendarid', $qb->createNamedParameter($calendarId)))
+			->andWhere($qb->expr()->eq('calendartype', $qb->createNamedParameter($calendarType)))
+			->andWhere($qb->expr()->isNull('deleted_at'));
+		if ($range?->start !== null) {
+			$qb->setFirstResult($range->start);
+		}
+		if ($range?->count !== null) {
+			$qb->setMaxResults($range->count);
+		}
+		$rs = $qb->executeQuery();
+
+		while (($row = $rs->fetch()) !== false) {
+			yield $row;
+		}
+
+		$rs->closeCursor();
+	}
+
 	/**
 	 * Returns all calendar objects with limited metadata for a calendar
 	 *

apps/dav/lib/CalDAV/CalendarImpl.php

@@ -8,9 +8,17 @@
  */
 namespace OCA\DAV\CalDAV;
 
+use Generator;
+use InvalidArgumentException;
 use OCA\DAV\CalDAV\Auth\CustomPrincipalPlugin;
 use OCA\DAV\CalDAV\InvitationResponse\InvitationResponseServer;
+use OCP\Calendar\CalendarExportRange;
+use OCP\Calendar\CalendarImportSettings;
 use OCP\Calendar\Exceptions\CalendarException;
+use OCP\Calendar\ICalendarExport;
+use OCP\Calendar\ICalendarImport;
+use OCP\Calendar\ICalendarIsShared;
+use OCP\Calendar\ICalendarIsWritable;
 use OCP\Calendar\ICreateFromString;
 use OCP\Calendar\IHandleImipMessage;
 use OCP\Constants;
@@ -22,9 +30,11 @@
 use Sabre\VObject\ITip\Message;
 use Sabre\VObject\Property;
 use Sabre\VObject\Reader;
+use Sabre\VObject\UUIDUtil;
+
 use function Sabre\Uri\split as uriSplit;
 
-class CalendarImpl implements ICreateFromString, IHandleImipMessage {
+class CalendarImpl implements ICreateFromString, IHandleImipMessage, ICalendarIsWritable, ICalendarIsShared, ICalendarImport, ICalendarExport {
 	public function __construct(
 		private Calendar $calendar,
 		/** @var array<string, mixed> */
@@ -257,4 +267,66 @@
 	public function getInvitationResponseServer(): InvitationResponseServer {
 		return new InvitationResponseServer(false);
 	}
+
+	/**
+	 * Export objects
+	 *
+	 * @since 31.0.0
+	 *
+	 * @return Generator<\Sabre\VObject\Component\VCalendar>
+	 */
+	public function export(?CalendarExportRange $range = null): Generator {
+		foreach (
+			$this->backend->exportCalendar(
+				$this->calendarInfo['id'],
+				$this->backend::CALENDAR_TYPE_CALENDAR,
+				$range
+			) as $event
+		) {
+			yield Reader::read($event['calendardata']);
+		}
+	}
+
+	/**
+	 * Import objects
+	 *
+	 * @since 31.0.0
+	 * 
+	 */
+	public function import(CalendarImportSettings $settings, VCalendar ...$vObjects): array {
+
+		$calendarId = $this->getKey();
+		$outcome = [];
+		foreach ($vObjects as $vObject) {
+
+			$components = $vObject->getBaseComponents();
+			if (count($components) > 1) {
+				throw new InvalidArgumentException('Import failure: objects can not contain more than one base instance object');
+			}
+			$uid = $components[0]->UID->getValue();
+
+			$objectId = $this->backend->getCalendarObjectByUID($this->calendarInfo['principaluri'], $uid);
+			$objectData = $vObject->serialize();
+
+			// create or update object
+			if ($objectId === null) {
+				$objectId = UUIDUtil::getUUID();
+				$this->backend->createCalendarObject(
+					$calendarId,
+					$objectId,
+					$objectData
+				);
+			} elseif ($objectId !== null && $settings->supersede) {
+				$this->backend->updateCalendarObject(
+					$calendarId,
+					$objectId,
+					$objectData
+				);
+			}
+		}
+
+		return $outcome;
+
+	}
+
 }

lib/composer/composer/autoload_classmap.php

@@ -110,6 +110,7 @@
     'OCP\\AppFramework\\Http\\RedirectToDefaultAppResponse' => $baseDir . '/lib/public/AppFramework/Http/RedirectToDefaultAppResponse.php',
     'OCP\\AppFramework\\Http\\Response' => $baseDir . '/lib/public/AppFramework/Http/Response.php',
     'OCP\\AppFramework\\Http\\StandaloneTemplateResponse' => $baseDir . '/lib/public/AppFramework/Http/StandaloneTemplateResponse.php',
+    'OCP\\AppFramework\\Http\\StreamGeneratorResponse' => $baseDir . '/lib/public/AppFramework/Http/StreamGeneratorResponse.php',
     'OCP\\AppFramework\\Http\\StreamResponse' => $baseDir . '/lib/public/AppFramework/Http/StreamResponse.php',
     'OCP\\AppFramework\\Http\\StrictContentSecurityPolicy' => $baseDir . '/lib/public/AppFramework/Http/StrictContentSecurityPolicy.php',
     'OCP\\AppFramework\\Http\\StrictEvalContentSecurityPolicy' => $baseDir . '/lib/public/AppFramework/Http/StrictEvalContentSecurityPolicy.php',
@@ -190,10 +191,14 @@
     'OCP\\Broadcast\\Events\\IBroadcastEvent' => $baseDir . '/lib/public/Broadcast/Events/IBroadcastEvent.php',
     'OCP\\Cache\\CappedMemoryCache' => $baseDir . '/lib/public/Cache/CappedMemoryCache.php',
     'OCP\\Calendar\\BackendTemporarilyUnavailableException' => $baseDir . '/lib/public/Calendar/BackendTemporarilyUnavailableException.php',
+    'OCP\\Calendar\\CalendarExportRange' => $baseDir . '/lib/public/Calendar/CalendarExportRange.php',
+    'OCP\\Calendar\\CalendarImportSettings' => $baseDir . '/lib/public/Calendar/CalendarImportSettings.php',
     'OCP\\Calendar\\Exceptions\\CalendarException' => $baseDir . '/lib/public/Calendar/Exceptions/CalendarException.php',
     'OCP\\Calendar\\IAvailabilityResult' => $baseDir . '/lib/public/Calendar/IAvailabilityResult.php',
     'OCP\\Calendar\\ICalendar' => $baseDir . '/lib/public/Calendar/ICalendar.php',
     'OCP\\Calendar\\ICalendarEventBuilder' => $baseDir . '/lib/public/Calendar/ICalendarEventBuilder.php',
+    'OCP\\Calendar\\ICalendarExport' => $baseDir . '/lib/public/Calendar/ICalendarExport.php',
+    'OCP\\Calendar\\ICalendarImport' => $baseDir . '/lib/public/Calendar/ICalendarImport.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

@@ -159,6 +159,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OCP\\AppFramework\\Http\\RedirectToDefaultAppResponse' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Http/RedirectToDefaultAppResponse.php',
         'OCP\\AppFramework\\Http\\Response' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Http/Response.php',
         'OCP\\AppFramework\\Http\\StandaloneTemplateResponse' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Http/StandaloneTemplateResponse.php',
+        'OCP\\AppFramework\\Http\\StreamGeneratorResponse' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Http/StreamGeneratorResponse.php',
         'OCP\\AppFramework\\Http\\StreamResponse' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Http/StreamResponse.php',
         'OCP\\AppFramework\\Http\\StrictContentSecurityPolicy' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Http/StrictContentSecurityPolicy.php',
         'OCP\\AppFramework\\Http\\StrictEvalContentSecurityPolicy' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Http/StrictEvalContentSecurityPolicy.php',
@@ -239,10 +240,14 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OCP\\Broadcast\\Events\\IBroadcastEvent' => __DIR__ . '/../../..' . '/lib/public/Broadcast/Events/IBroadcastEvent.php',
         'OCP\\Cache\\CappedMemoryCache' => __DIR__ . '/../../..' . '/lib/public/Cache/CappedMemoryCache.php',
         'OCP\\Calendar\\BackendTemporarilyUnavailableException' => __DIR__ . '/../../..' . '/lib/public/Calendar/BackendTemporarilyUnavailableException.php',
+        'OCP\\Calendar\\CalendarExportRange' => __DIR__ . '/../../..' . '/lib/public/Calendar/CalendarExportRange.php',
+        'OCP\\Calendar\\CalendarImportSettings' => __DIR__ . '/../../..' . '/lib/public/Calendar/CalendarImportSettings.php',
         'OCP\\Calendar\\Exceptions\\CalendarException' => __DIR__ . '/../../..' . '/lib/public/Calendar/Exceptions/CalendarException.php',
         'OCP\\Calendar\\IAvailabilityResult' => __DIR__ . '/../../..' . '/lib/public/Calendar/IAvailabilityResult.php',
         'OCP\\Calendar\\ICalendar' => __DIR__ . '/../../..' . '/lib/public/Calendar/ICalendar.php',
         'OCP\\Calendar\\ICalendarEventBuilder' => __DIR__ . '/../../..' . '/lib/public/Calendar/ICalendarEventBuilder.php',
+        'OCP\\Calendar\\ICalendarExport' => __DIR__ . '/../../..' . '/lib/public/Calendar/ICalendarExport.php',
+        'OCP\\Calendar\\ICalendarImport' => __DIR__ . '/../../..' . '/lib/public/Calendar/ICalendarImport.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/AppFramework/Http/StreamGeneratorResponse.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+namespace OCP\AppFramework\Http;
+
+use OCP\AppFramework\Http;
+
+/**
+ * Class StreamResponse
+ *
+ * @since 31.0.0
+ *
+ * @template-extends Response<int, array<string, mixed>>
+ */
+class StreamGeneratorResponse extends Response implements ICallbackResponse {
+	protected $generator;
+
+	/**
+	 * @since 31.0.0
+	 *
+	 * @param \Generator $generator the function to call to generate the response
+	 * @param String $contentType http response content type e.g. 'application/json; charset=UTF-8'
+	 * @param int $status http response status
+	 */
+	public function __construct($generator, $contentType, $status = Http::STATUS_OK) {
+		parent::__construct();
+
+		$this->generator = $generator;
+
+		$this->setStatus($status);
+		$this->cacheFor(0);
+		$this->addHeader('Content-Type', $contentType);
+
+	}
+
+	/**
+	 * Streams content directly to client
+	 *
+	 * @since 31.0.0
+	 *
+	 * @param IOutput $output a small wrapper that handles output
+	 */
+	public function callback(IOutput $output) {
+
+		foreach ($this->generator as $chunk) {
+			print($chunk);
+			flush();
+		}
+
+	}
+
+}

lib/public/Calendar/CalendarExportRange.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Calendar;
+
+/**
+ * Calendar Export Limit Range
+ *
+ * @since 31.0.0
+ */
+class CalendarExportRange {
+
+	public ?int $start = null;
+	public ?int $count = null;
+
+}

lib/public/Calendar/CalendarImportSettings.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Calendar;
+
+/**
+ * Calendar Export Limit Range
+ *
+ * @since 31.0.0
+ */
+class CalendarImportSettings {
+
+	public string $format = 'ical';
+	public bool $supersede = false;
+	public bool $emitEvent = false;
+	public bool $emitITip = false;
+	public int $bulk = 32;
+	public int $validate = 1;	// 0 - no validation, 1 - validate and skip on issue, 2 - validate and fail on issue
+
+}

lib/public/Calendar/ICalendarExport.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Calendar;
+
+use Generator;
+
+/**
+ * ICalendar Interface Extension to export data
+ *
+ * @since 31.0.0
+ */
+interface ICalendarExport {
+
+	/**
+	 * Export objects
+	 *
+	 * @since 31.0.0
+	 *
+	 * @return Generator<\Sabre\VObject\Component\VCalendar>
+	 */
+	public function export(?CalendarExportRange $range = null): Generator;
+
+}

lib/public/Calendar/ICalendarImport.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Calendar;
+
+use OCP\Calendar\CalendarImportSettings;
+use Sabre\VObject\Component\VCalendar;
+
+/**
+ * ICalendar Interface Extension to import data
+ *
+ * @since 31.0.0
+ */
+interface ICalendarImport {
+
+	/**
+	 * Import objects
+	 *
+	 * @since 31.0.0
+	 * 
+	 * @param VCalendar $vObjects
+	 */
+	public function import(CalendarImportSettings $settings, VCalendar ...$vObjects): array;
+
+}