feat: OCC and OCS Calendar Import/Export by SebastianKrupinski · Pull Request #49995 · nextcloud/server

SebastianKrupinski · 2024-12-30T20:47:00Z

Summary

This adds the ability to export calendars via the OCS and OCC.

OCC Export

Command: calendar:export
Arguments: userId calendarId format filepath

OCC Import

Command: calendar:import
Arguments: userId calendarId format filepath
Options: errors, validation, supersede, show-created, show-updated, show-skipped, show-errors

OCS Export

Endpoint: /ocs/v2.php/calendar/export
Request: POST

{
    "id": "personal",
    "format": "xcal", (optional "ical, jcal, xcal", defaults to "ical")
	"options": {
		"rangeStart": '' or 'UID of previous last event',
		"rangeCount": 100
	},
	"user": "user1" (optional admin permissions required)
}

OCS Import

Endpoint: /ocs/v2.php/calendar/import
Request: POST

{
	"id": "personal",
	"options": {
		"format": "xcal", (optional "ical, jcal, xcal", defaults to "ical")
		"validation": 0, (0 - no validate, 1 - validate and skip, 2 - validate and error)
		"errors": 0, (0 - continue, 1 - fail)
		"supersede": true,
		"showCreated": true,
		"showUpdated": true,
		"showSkipped": true,
		"showErrors": true
	},
	"user": "user1", (optional admin permissions required)
	"data": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><calendar><event><title>Meeting</title><date>2025-02-18</date></event></calendar>"
}

Performance

Export performance bottle neck seems to be CPU core max out due to single process execution, tests on dev setup with 16k of events takes about 5min or 60 items / second
Import performance bottle neck seems to be database write performance, tests on dev setup with 16k of events, takes about 30min or 10 items / second

Checklist

Code is properly formatted
Sign-off message is added to all commits
Tests (unit, integration, api and/or acceptance) are included
Screenshots before/after for front-end changes
Documentation (manuals or wiki) has been updated or is not required
Backports requested where applicable (ex: critical bugfixes)

SebastianKrupinski · 2025-01-27T15:04:54Z

Hi @tcitworld

I was wondering if you would be willing to test this out with some of your larger live data calendars?

lib/public/AppFramework/Http/StreamGeneratorResponse.php

ChristophWurst

First round of feedback

apps/dav/lib/CalDAV/CalendarImpl.php

apps/dav/lib/CalDAV/Export/ExportService.php

apps/dav/lib/Command/ExportCalendar.php

apps/dav/lib/Controller/CalendarExportController.php

apps/dav/lib/Controller/CalendarImportController.php

ChristophWurst · 2025-02-13T08:03:39Z

When adding a new controller for HTTP routes I'm wondering if we shouldn't got for OCS and openapi specs right away. Could you please check how doable that is with the different input/output formats you want to support?

SebastianKrupinski · 2025-02-17T13:53:36Z

Found a new internal use for this, this morning, calendar subscriptions can use the same import code to reduce redundant code, complexity and increase performance.

SebastianKrupinski · 2025-02-19T00:33:11Z

When adding a new controller for HTTP routes I'm wondering if we shouldn't got for OCS and openapi specs right away. Could you please check how doable that is with the different input/output formats you want to support?

I think we can make it work, Import is good already, just struggling getting a proper phpdoc export

apps/dav/lib/CalDAV/CalDavBackend.php

apps/dav/lib/Controller/CalendarExportController.php

SebastianKrupinski · 2025-02-20T18:31:43Z

When adding a new controller for HTTP routes I'm wondering if we shouldn't got for OCS and openapi specs right away. Could you please check how doable that is with the different input/output formats you want to support?

I think we can make it work, Import is good already, just struggling getting a proper phpdoc export

Done

SebastianKrupinski · 2025-02-20T21:54:39Z

Failed tests unrelated.

The OpenApi test will clear up after... nextcloud/openapi-extractor#213

apps/dav/lib/Controller/CalendarExportController.php

lib/public/AppFramework/Http/StreamGeneratorResponse.php

apps/dav/lib/CalDAV/Import/TextImporter.php

apps/dav/lib/Controller/CalendarImportController.php

ChristophWurst

Looks good!

apps/dav/lib/CalDAV/Import/XmlImporter.php

apps/dav/lib/Command/ExportCalendar.php

apps/dav/lib/Command/ImportCalendar.php

ChristophWurst · 2025-02-21T15:28:21Z

lib/public/AppFramework/Http/StreamGeneratorResponse.php

+use OCP\AppFramework\Http;
+
+/**
+ * Class StreamResponse


Outdated. Drop this first line if it just duplicates the class name

ChristophWurst · 2025-02-21T15:30:57Z

lib/public/AppFramework/Http/StreamGeneratorResponse.php

+		$this->generator = $generator;
+
+		$this->setStatus($status);
+		$this->cacheFor(0);


I don't see this for other app framework responses. would it make sense to move this into your new usages where you don't want caching?

Done, made it an option

lib/public/Calendar/CalendarExportOptions.php

lib/public/Calendar/CalendarImportOptions.php

SebastianKrupinski · 2025-02-27T18:36:39Z

@SebastianKrupinski for awareness: if you force-push over a PR with 3k changed LOC, Github also resets where we left with the last review. Now the full diff is to review again.

Keep that in mind.

😞 Sorry, I was just trying to keep it up to date, there was 100+ changes on master.

ChristophWurst · 2025-02-27T18:39:58Z

I recommend to familiarize yourself with https://git-scm.com/docs/git-merge#_description.

If you need input on specific sections of your changes let me know. I'll wait for the second reviewer before going through the full diff another time.

SebastianKrupinski · 2025-02-27T18:53:19Z

If you need input on specific sections of your changes let me know. I'll wait for the second reviewer before going through the full diff another time.

There are no more changes on my end, the only changes are they ones you asked for.

ChristophWurst · 2025-02-27T19:13:53Z

Okay, then I'll leave this for the second reviewer.

SebastianKrupinski · 2025-03-13T12:52:31Z

@hamza221 @kesselb any chance I can get a test/review on this?

tcitworld · 2025-03-13T13:04:14Z

apps/dav/lib/CalDAV/Export/ExportService.php

+	 */
+	private function exportStart(string $format): string {
+		return match ($format) {
+			'jcal' => '["vcalendar",[["version",{},"text","2.0"],["prodid",{},"text","-\/\/IDN nextcloud.com\/\/Calendar App\/\/EN"]],[',


Change prodid to something specific so we can know where the content comes from (something like nextcloud.com/Calendar Export Service).

Sure, can do that.

@SebastianKrupinski unhandled

apps/dav/lib/Controller/CalendarExportController.php

hamza221 · 2025-03-27T11:00:04Z

apps/dav/lib/Controller/CalendarImportController.php

+		$calendars = $this->calendarManager->getCalendarsForPrincipal('principals/users/' . $userId, [$calendarId]);
+		if ($calendars === []) {
+			return new DataResponse(['error' => 'calendar not found'], Http::STATUS_BAD_REQUEST);
+		}
+		$calendar = $calendars[0];
+		if (!$calendar instanceof ICalendarImport) {
+			return new DataResponse(['error' => 'calendar export not supported'], Http::STATUS_BAD_REQUEST);
+		}


No this is required, but there is a spelling error

hamza221 · 2025-03-27T11:01:15Z

apps/dav/lib/Controller/CalendarImportController.php

+		if (!$calendar instanceof ICalendarImport) {
+			return new DataResponse(['error' => 'calendar export not supported'], Http::STATUS_BAD_REQUEST);
+		}
+		// evaluate if requested format is supported and convert to output content type


hamza221 · 2025-03-27T11:02:41Z

apps/dav/lib/Controller/CalendarImportController.php

+		if ($format !== null && !in_array($format, $this->importService::FORMATS)) {
+			return new DataResponse(['error' => "Format <$format> is not valid."], Http::STATUS_BAD_REQUEST);
+		} else {
+			$options->setFormat($format ?? 'ical');
+		}


another duplicate code, maybe also leftover ?

Nope required to confirm input format

ChristophWurst · 2025-04-02T16:49:44Z

This is too big to review or test. Please split it.

Signed-off-by: SebastianKrupinski <krupinskis05@gmail.com>

ChristophWurst · 2025-09-16T06:25:55Z

Superseded or is there anything left to integrate?

SebastianKrupinski · 2025-09-17T12:49:20Z

@ChristophWurst This still has the OCS api to create and export calendar events. I'll rebase it and remove the already merged parts of this.

SebastianKrupinski added the 2. developing Work in progress label Dec 30, 2024

SebastianKrupinski self-assigned this Dec 30, 2024

SebastianKrupinski mentioned this pull request Dec 30, 2024

feat: OCC and OCS Calendar Import/Export nextcloud/calendar#6596

Closed

1 task

SebastianKrupinski force-pushed the enh/issues-563-calendar-import-export branch from b0ee614 to 5198d6b Compare January 18, 2025 19:26

SebastianKrupinski force-pushed the enh/issues-563-calendar-import-export branch from c69a4fb to 8a6dd83 Compare January 26, 2025 18:15

SebastianKrupinski force-pushed the enh/issues-563-calendar-import-export branch from 59a2223 to 67dc029 Compare January 27, 2025 21:35

SebastianKrupinski force-pushed the enh/issues-563-calendar-import-export branch from 67dc029 to 8ad0991 Compare February 4, 2025 17:18

SebastianKrupinski marked this pull request as ready for review February 4, 2025 17:19

SebastianKrupinski requested review from st3iny and tcitworld as code owners February 4, 2025 17:19

SebastianKrupinski force-pushed the enh/issues-563-calendar-import-export branch from 8ad0991 to 213c1aa Compare February 4, 2025 17:20

SebastianKrupinski force-pushed the enh/issues-563-calendar-import-export branch from a2f9ff4 to 8eff6e4 Compare February 11, 2025 19:37

SebastianKrupinski requested a review from kesselb February 11, 2025 19:39

kesselb reviewed Feb 11, 2025

View reviewed changes

lib/public/AppFramework/Http/StreamGeneratorResponse.php Outdated Show resolved Hide resolved

ChristophWurst reviewed Feb 13, 2025

View reviewed changes

ChristophWurst requested changes Feb 19, 2025

View reviewed changes

apps/dav/lib/CalDAV/CalDavBackend.php Outdated Show resolved Hide resolved

apps/dav/lib/Controller/CalendarExportController.php Show resolved Hide resolved

SebastianKrupinski force-pushed the enh/issues-563-calendar-import-export branch from 719db50 to 364b0e6 Compare February 19, 2025 21:17

SebastianKrupinski requested a review from provokateurin as a code owner February 20, 2025 18:13

SebastianKrupinski mentioned this pull request Feb 20, 2025

enh: add stream generator response nextcloud/openapi-extractor#213

Merged

provokateurin reviewed Feb 21, 2025

View reviewed changes

apps/dav/lib/Controller/CalendarExportController.php Outdated Show resolved Hide resolved

provokateurin reviewed Feb 21, 2025

View reviewed changes

lib/public/AppFramework/Http/StreamGeneratorResponse.php Outdated Show resolved Hide resolved

ChristophWurst reviewed Feb 21, 2025

View reviewed changes

apps/dav/lib/CalDAV/Import/TextImporter.php Outdated Show resolved Hide resolved

kesselb reviewed Feb 21, 2025

View reviewed changes

apps/dav/lib/Controller/CalendarImportController.php Show resolved Hide resolved

apps/dav/lib/Controller/CalendarImportController.php Outdated Show resolved Hide resolved

ChristophWurst reviewed Feb 21, 2025

View reviewed changes

SebastianKrupinski requested a review from ChristophWurst February 27, 2025 18:25

susnux added this to the Nextcloud 32 milestone Mar 2, 2025

tcitworld reviewed Mar 13, 2025

View reviewed changes

GVodyanov approved these changes Mar 24, 2025

View reviewed changes

hamza221 reviewed Mar 27, 2025

View reviewed changes

SebastianKrupinski requested a review from a team as a code owner March 27, 2025 14:02

SebastianKrupinski requested review from ArtificialOwl, come-nc and provokateurin and removed request for a team March 27, 2025 14:02

ChristophWurst marked this pull request as draft April 2, 2025 16:49

ChristophWurst added 1. to develop Accepted and waiting to be taken care of and removed 2. developing Work in progress labels Apr 2, 2025

SebastianKrupinski force-pushed the enh/issues-563-calendar-import-export branch from 11da3e6 to a6599a6 Compare April 3, 2025 22:49

This was referenced Apr 4, 2025

feat: Calendar Export #51924

Merged

feat: Calendar Import #51925

Merged

feat: OCC and OCS Calendar Import/Export

f08b795

Signed-off-by: SebastianKrupinski <krupinskis05@gmail.com>

SebastianKrupinski force-pushed the enh/issues-563-calendar-import-export branch from a6599a6 to f08b795 Compare August 26, 2025 17:32

SebastianKrupinski mentioned this pull request Aug 29, 2025

feat: import contacts from files via ocs nextcloud/contacts#4654

Merged

SebastianKrupinski mentioned this pull request Sep 18, 2025

feat: OCS Calendar Export + Import #55178

Open

4 tasks

skjnldsv modified the milestones: Nextcloud 32, Nextcloud 33 Sep 28, 2025

Uh oh!

Conversation

SebastianKrupinski commented Dec 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

OCC Export

OCC Import

OCS Export

OCS Import

Performance

Checklist

Uh oh!

SebastianKrupinski commented Jan 27, 2025

Uh oh!

Uh oh!

ChristophWurst left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ChristophWurst commented Feb 13, 2025

Uh oh!

SebastianKrupinski commented Feb 17, 2025

Uh oh!

SebastianKrupinski commented Feb 19, 2025

Uh oh!

Uh oh!

Uh oh!

SebastianKrupinski commented Feb 20, 2025

Uh oh!

SebastianKrupinski commented Feb 20, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ChristophWurst left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

SebastianKrupinski commented Feb 27, 2025

Uh oh!

ChristophWurst commented Feb 27, 2025

Uh oh!

SebastianKrupinski commented Feb 27, 2025

Uh oh!

ChristophWurst commented Feb 27, 2025

Uh oh!

SebastianKrupinski commented Mar 13, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

SebastianKrupinski commented Dec 30, 2024 •

edited

Loading