Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(dav): Create SAB at installation #51144

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions apps/dav/appinfo/info.xml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@
<live-migration>
<step>OCA\DAV\Migration\ChunkCleanup</step>
</live-migration>
<install>
<step>OCA\DAV\Migration\CreateSystemAddressBookStep</step>
</install>
</repair-steps>

<commands>
Expand Down
1 change: 1 addition & 0 deletions apps/dav/composer/composer/autoload_classmap.php
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,7 @@
'OCA\\DAV\\Migration\\BuildSocialSearchIndexBackgroundJob' => $baseDir . '/../lib/Migration/BuildSocialSearchIndexBackgroundJob.php',
'OCA\\DAV\\Migration\\CalDAVRemoveEmptyValue' => $baseDir . '/../lib/Migration/CalDAVRemoveEmptyValue.php',
'OCA\\DAV\\Migration\\ChunkCleanup' => $baseDir . '/../lib/Migration/ChunkCleanup.php',
'OCA\\DAV\\Migration\\CreateSystemAddressBookStep' => $baseDir . '/../lib/Migration/CreateSystemAddressBookStep.php',
'OCA\\DAV\\Migration\\DeleteSchedulingObjects' => $baseDir . '/../lib/Migration/DeleteSchedulingObjects.php',
'OCA\\DAV\\Migration\\FixBirthdayCalendarComponent' => $baseDir . '/../lib/Migration/FixBirthdayCalendarComponent.php',
'OCA\\DAV\\Migration\\RefreshWebcalJobRegistrar' => $baseDir . '/../lib/Migration/RefreshWebcalJobRegistrar.php',
Expand Down
1 change: 1 addition & 0 deletions apps/dav/composer/composer/autoload_static.php
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,7 @@ class ComposerStaticInitDAV
'OCA\\DAV\\Migration\\BuildSocialSearchIndexBackgroundJob' => __DIR__ . '/..' . '/../lib/Migration/BuildSocialSearchIndexBackgroundJob.php',
'OCA\\DAV\\Migration\\CalDAVRemoveEmptyValue' => __DIR__ . '/..' . '/../lib/Migration/CalDAVRemoveEmptyValue.php',
'OCA\\DAV\\Migration\\ChunkCleanup' => __DIR__ . '/..' . '/../lib/Migration/ChunkCleanup.php',
'OCA\\DAV\\Migration\\CreateSystemAddressBookStep' => __DIR__ . '/..' . '/../lib/Migration/CreateSystemAddressBookStep.php',
'OCA\\DAV\\Migration\\DeleteSchedulingObjects' => __DIR__ . '/..' . '/../lib/Migration/DeleteSchedulingObjects.php',
'OCA\\DAV\\Migration\\FixBirthdayCalendarComponent' => __DIR__ . '/..' . '/../lib/Migration/FixBirthdayCalendarComponent.php',
'OCA\\DAV\\Migration\\RefreshWebcalJobRegistrar' => __DIR__ . '/..' . '/../lib/Migration/RefreshWebcalJobRegistrar.php',
Expand Down
11 changes: 7 additions & 4 deletions apps/dav/lib/CardDAV/SyncService.php
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,12 @@ public function ensureSystemAddressBookExists(string $principal, string $uri, ar
}
}

public function ensureLocalSystemAddressBookExists(): ?array {
return $this->ensureSystemAddressBookExists('principals/system/system', 'system', [
'{' . Plugin::NS_CARDDAV . '}addressbook-description' => 'System addressbook which holds all users of this instance'
]);
}

private function prepareUri(string $host, string $path): string {
/*
* The trailing slash is important for merging the uris together.
Expand Down Expand Up @@ -275,10 +281,7 @@ public function deleteUser($userOrCardId) {
*/
public function getLocalSystemAddressBook() {
if (is_null($this->localSystemAddressBook)) {
$systemPrincipal = 'principals/system/system';
$this->localSystemAddressBook = $this->ensureSystemAddressBookExists($systemPrincipal, 'system', [
'{' . Plugin::NS_CARDDAV . '}addressbook-description' => 'System addressbook which holds all users of this instance'
]);
$this->localSystemAddressBook = $this->ensureLocalSystemAddressBookExists();
}

return $this->localSystemAddressBook;
Expand Down
30 changes: 30 additions & 0 deletions apps/dav/lib/Migration/CreateSystemAddressBookStep.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<?php

declare(strict_types=1);

/**
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/

namespace OCA\DAV\Migration;

use OCA\DAV\CardDAV\SyncService;
use OCP\Migration\IOutput;
use OCP\Migration\IRepairStep;

class CreateSystemAddressBookStep implements IRepairStep {

public function __construct(
private SyncService $syncService,
) {
}

public function getName(): string {
return 'Create system address book';
}

public function run(IOutput $output): void {
$this->syncService->ensureLocalSystemAddressBookExists();
}
}
47 changes: 47 additions & 0 deletions apps/dav/tests/unit/Migration/CreateSystemAddressBookStepTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<?php

declare(strict_types=1);

/**
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/

namespace OCA\DAV\Tests\Unit\Migration;

use OCA\DAV\CardDAV\SyncService;
use OCA\DAV\Migration\CreateSystemAddressBookStep;
use OCP\Migration\IOutput;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;

class CreateSystemAddressBookStepTest extends TestCase {

private SyncService|MockObject $syncService;
private CreateSystemAddressBookStep $step;

protected function setUp(): void {
parent::setUp();

$this->syncService = $this->createMock(SyncService::class);

$this->step = new CreateSystemAddressBookStep(
$this->syncService,
);
}

public function testGetName(): void {
$name = $this->step->getName();

self::assertEquals('Create system address book', $name);
}

public function testRun(): void {
$output = $this->createMock(IOutput::class);

$this->step->run($output);

$this->addToAssertionCount(1);
}

}
Loading