feat: OCS Calendar Export + Import by SebastianKrupinski · Pull Request #55178 · nextcloud/server

SebastianKrupinski · 2025-09-18T19:28:17Z

Summary

Extracted from #49995

This adds the ability to export and import calendars via the OCS

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>"
}

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)

provokateurin

The code comments in the controller are a bit useless, you might want to remove them to avoid confusion if the code is refactored later.

provokateurin · 2025-09-28T08:23:45Z

+	 * @param array{rangeStart:string,rangeCount:int<1,max>} $options configuration options
+	 * @param string|null $user system user id
+	 *
+	 * @return StreamGeneratorResponse<Http::STATUS_OK, array{Content-Type:string}> | DataResponse<Http::STATUS_BAD_REQUEST|Http::STATUS_UNAUTHORIZED, array{error?: non-empty-string}, array{}>


I think you could limit the Content-Type type to the possible values, so it's clear in the OpenAPI spec what might be returned.

provokateurin · 2025-09-28T08:24:28Z

+	#[ApiRoute(verb: 'POST', url: '/export', root: '/calendar')]
+	#[UserRateLimit(limit: 60, period: 60)]
+	#[NoAdminRequired]
+	public function index(string $id, ?string $type = null, ?array $options = null, ?string $user = null) {


Suggested change

public function index(string $id, ?string $type = null, ?array $options = null, ?string $user = null) {

public function export(string $id, ?string $type = null, ?array $options = null, ?string $user = null) {

provokateurin · 2025-09-28T08:24:40Z

+	#[ApiRoute(verb: 'POST', url: '/import', root: '/calendar')]
+	#[UserRateLimit(limit: 1, period: 60)]
+	#[NoAdminRequired]
+	public function index(string $id, array $options, string $data, ?string $user = null): DataResponse {


Suggested change

public function index(string $id, array $options, string $data, ?string $user = null): DataResponse {

public function import(string $id, array $options, string $data, ?string $user = null): DataResponse {

provokateurin · 2025-09-28T08:25:54Z

+	 *
+	 * @param string $id calendar id
+	 * @param string|null $type data format
+	 * @param array{rangeStart:string,rangeCount:int<1,max>} $options configuration options


Suggested change

* @param array{rangeStart:string,rangeCount:int<1,max>} $options configuration options

* @param array{rangeStart:string,rangeCount:positive-int} $options configuration options

provokateurin · 2025-09-28T08:26:19Z

+	 * Import calendar data
+	 *
+	 * @param string $id calendar id
+	 * @param array{format?:string, validation?:int<0,2>, errors?:int<0,1>, supersede?:bool, showCreated?:bool, showUpdated?:bool, showSkipped?:bool, showErrors?:bool} $options configuration options


Suggested change

* @param array{format?:string, validation?:int<0,2>, errors?:int<0,1>, supersede?:bool, showCreated?:bool, showUpdated?:bool, showSkipped?:bool, showErrors?:bool} $options configuration options

* @param array{format?:string, validation?:0|1|2, errors?:0|1, supersede?:bool, showCreated?:bool, showUpdated?:bool, showSkipped?:bool, showErrors?:bool} $options configuration options

provokateurin · 2025-09-28T08:29:06Z

+		$format = isset($options['format']) ? $options['format'] : null;
+		$validation = isset($options['validation']) ? (int)$options['validation'] : null;
+		$errors = isset($options['errors']) ? (int)$options['errors'] : null;
+		$supersede = $options['supersede'] ?? false;
+		$showCreated = $options['showCreated'] ?? false;
+		$showUpdated = $options['showUpdated'] ?? false;
+		$showSkipped = $options['showSkipped'] ?? false;
+		$showErrors = $options['showErrors'] ?? false;


Why have this options parameter instead of putting all of them into the parameters right away?

Makes for nicer json formatting and prevents function parameter bloat.

provokateurin · 2025-09-28T08:29:50Z

+	 * 400: invalid parameters
+	 * 401: user not authorized
+	 */
+	#[OpenAPI(scope: OpenAPI::SCOPE_DEFAULT)]


Suggested change

#[OpenAPI(scope: OpenAPI::SCOPE_DEFAULT)]

Not necessary

provokateurin · 2025-09-28T08:30:00Z

+	 * 400: invalid request
+	 * 401: user not authorized
+	 */
+	#[OpenAPI(scope: OpenAPI::SCOPE_DEFAULT)]


Suggested change

#[OpenAPI(scope: OpenAPI::SCOPE_DEFAULT)]

provokateurin · 2025-09-28T08:30:31Z

+use OCP\AppFramework\Http;
+
+/**
+ * @since 32.0.0


Suggested change

* @since 32.0.0

* @since 33.0.0

All @SInCE are wrong here

provokateurin · 2025-09-28T08:31:15Z

+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-only


Suggested change

* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors

* SPDX-License-Identifier: AGPL-3.0-only

* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors

* SPDX-License-Identifier: AGPL-3.0-or-later

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

SebastianKrupinski requested a review from a team as a code owner September 18, 2025 19:28

SebastianKrupinski requested review from CarlSchwan, icewind1991 and nfebe and removed request for a team September 18, 2025 19:28

SebastianKrupinski self-assigned this Sep 18, 2025

SebastianKrupinski added the 2. developing Work in progress label Sep 18, 2025

SebastianKrupinski force-pushed the feat/calendar-import-export-ocs branch from 12ad7af to 6838bbe Compare September 23, 2025 00:15

SebastianKrupinski requested a review from provokateurin as a code owner September 23, 2025 00:15

SebastianKrupinski force-pushed the feat/calendar-import-export-ocs branch 3 times, most recently from e000a47 to a3431ef Compare September 23, 2025 00:57

provokateurin requested changes Sep 28, 2025

View reviewed changes

SebastianKrupinski mentioned this pull request Oct 15, 2025

Import: check if UID already exists, check which one is newest and update if necessary. nextcloud/calendar#1508

Open

SebastianKrupinski force-pushed the feat/calendar-import-export-ocs branch from a3431ef to 3e048d5 Compare October 15, 2025 23:53

SebastianKrupinski requested a review from provokateurin October 19, 2025 18:19

SebastianKrupinski added 3 commits October 19, 2025 14:23

feat: OCS Calendar Export + Import

58821dd

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

fixup! feat: OCS Calendar Export + Import

b150521

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

fixup! feat: OCS Calendar Export + Import

20a731c

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

SebastianKrupinski force-pushed the feat/calendar-import-export-ocs branch from 2ac397f to 20a731c Compare October 19, 2025 18:23

SebastianKrupinski mentioned this pull request Nov 13, 2025

CalDAV/Calendar export and import for user migration #56241

Closed

SebastianKrupinski added 3. to review Waiting for reviews and removed 2. developing Work in progress labels Jan 7, 2026

	public function index(string $id, ?string $type = null, ?array $options = null, ?string $user = null) {
	public function export(string $id, ?string $type = null, ?array $options = null, ?string $user = null) {

	public function index(string $id, array $options, string $data, ?string $user = null): DataResponse {
	public function import(string $id, array $options, string $data, ?string $user = null): DataResponse {

	* @param array{rangeStart:string,rangeCount:int<1,max>} $options configuration options
	* @param array{rangeStart:string,rangeCount:positive-int} $options configuration options

	* @param array{format?:string, validation?:int<0,2>, errors?:int<0,1>, supersede?:bool, showCreated?:bool, showUpdated?:bool, showSkipped?:bool, showErrors?:bool} $options configuration options
	* @param array{format?:string, validation?:0\|1\|2, errors?:0\|1, supersede?:bool, showCreated?:bool, showUpdated?:bool, showSkipped?:bool, showErrors?:bool} $options configuration options

		* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
		* SPDX-License-Identifier: AGPL-3.0-only

Uh oh!

Conversation

SebastianKrupinski commented Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

OCS Export

OCS Import

Checklist

Uh oh!

provokateurin left a comment

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!

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!

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!

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!

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!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

SebastianKrupinski commented Sep 18, 2025 •

edited

Loading