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

[stable27] fix(dav): Add occ command to fix missing caldav sync tokens #44196

Merged
merged 1 commit into from
Jun 3, 2024
Merged
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
1 change: 1 addition & 0 deletions apps/dav/appinfo/info.xml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<command>OCA\DAV\Command\CreateAddressBook</command>
<command>OCA\DAV\Command\CreateCalendar</command>
<command>OCA\DAV\Command\DeleteCalendar</command>
<command>OCA\DAV\Command\FixCalendarSyncCommand</command>
<command>OCA\DAV\Command\MoveCalendar</command>
<command>OCA\DAV\Command\ListCalendars</command>
<command>OCA\DAV\Command\RetentionCleanupCommand</command>
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 @@ -133,6 +133,7 @@
'OCA\\DAV\\Command\\CreateAddressBook' => $baseDir . '/../lib/Command/CreateAddressBook.php',
'OCA\\DAV\\Command\\CreateCalendar' => $baseDir . '/../lib/Command/CreateCalendar.php',
'OCA\\DAV\\Command\\DeleteCalendar' => $baseDir . '/../lib/Command/DeleteCalendar.php',
'OCA\\DAV\\Command\\FixCalendarSyncCommand' => $baseDir . '/../lib/Command/FixCalendarSyncCommand.php',
'OCA\\DAV\\Command\\ListCalendars' => $baseDir . '/../lib/Command/ListCalendars.php',
'OCA\\DAV\\Command\\MoveCalendar' => $baseDir . '/../lib/Command/MoveCalendar.php',
'OCA\\DAV\\Command\\RemoveInvalidShares' => $baseDir . '/../lib/Command/RemoveInvalidShares.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 @@ -148,6 +148,7 @@ class ComposerStaticInitDAV
'OCA\\DAV\\Command\\CreateAddressBook' => __DIR__ . '/..' . '/../lib/Command/CreateAddressBook.php',
'OCA\\DAV\\Command\\CreateCalendar' => __DIR__ . '/..' . '/../lib/Command/CreateCalendar.php',
'OCA\\DAV\\Command\\DeleteCalendar' => __DIR__ . '/..' . '/../lib/Command/DeleteCalendar.php',
'OCA\\DAV\\Command\\FixCalendarSyncCommand' => __DIR__ . '/..' . '/../lib/Command/FixCalendarSyncCommand.php',
'OCA\\DAV\\Command\\ListCalendars' => __DIR__ . '/..' . '/../lib/Command/ListCalendars.php',
'OCA\\DAV\\Command\\MoveCalendar' => __DIR__ . '/..' . '/../lib/Command/MoveCalendar.php',
'OCA\\DAV\\Command\\RemoveInvalidShares' => __DIR__ . '/..' . '/../lib/Command/RemoveInvalidShares.php',
Expand Down
75 changes: 59 additions & 16 deletions apps/dav/lib/CalDAV/CalDavBackend.php
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@
use Sabre\VObject\Reader;
use Sabre\VObject\Recur\EventIterator;
use function array_column;
use function array_map;
use function array_merge;
use function array_values;
use function explode;
Expand Down Expand Up @@ -882,7 +883,7 @@ public function updateCalendar($calendarId, PropPatch $propPatch) {
$query->where($query->expr()->eq('id', $query->createNamedParameter($calendarId)));
$query->executeStatement();

$this->addChange($calendarId, "", 2);
$this->addChanges($calendarId, [""], 2);

$calendarData = $this->getCalendarById($calendarId);
$shares = $this->getShares($calendarId);
Expand Down Expand Up @@ -1301,7 +1302,7 @@ public function createCalendarObject($calendarId, $objectUri, $calendarData, $ca
->executeStatement();

$this->updateProperties($calendarId, $objectUri, $calendarData, $calendarType);
$this->addChange($calendarId, $objectUri, 1, $calendarType);
$this->addChanges($calendarId, [$objectUri], 1, $calendarType);

$objectRow = $this->getCalendarObject($calendarId, $objectUri, $calendarType);
assert($objectRow !== null);
Expand Down Expand Up @@ -1362,7 +1363,7 @@ public function updateCalendarObject($calendarId, $objectUri, $calendarData, $ca
->executeStatement();

$this->updateProperties($calendarId, $objectUri, $calendarData, $calendarType);
$this->addChange($calendarId, $objectUri, 2, $calendarType);
$this->addChanges($calendarId, [$objectUri], 2, $calendarType);

$objectRow = $this->getCalendarObject($calendarId, $objectUri, $calendarType);
if (is_array($objectRow)) {
Expand Down Expand Up @@ -1412,8 +1413,8 @@ public function moveCalendarObject(int $sourceCalendarId, int $targetCalendarId,
$this->purgeProperties($sourceCalendarId, $objectId);
$this->updateProperties($targetCalendarId, $object['uri'], $object['calendardata'], $calendarType);

$this->addChange($sourceCalendarId, $object['uri'], 3, $calendarType);
$this->addChange($targetCalendarId, $object['uri'], 1, $calendarType);
$this->addChanges($sourceCalendarId, [$object['uri']], 3, $calendarType);
$this->addChanges($targetCalendarId, [$object['uri']], 1, $calendarType);

$object = $this->getCalendarObjectById($newPrincipalUri, $objectId);
// Calendar Object wasn't found - possibly because it was deleted in the meantime by a different client
Expand Down Expand Up @@ -1540,7 +1541,7 @@ public function deleteCalendarObject($calendarId, $objectUri, $calendarType = se
}
}

$this->addChange($calendarId, $objectUri, 3, $calendarType);
$this->addChanges($calendarId, [$objectUri], 3, $calendarType);
}, $this->db);
}

Expand Down Expand Up @@ -1582,7 +1583,7 @@ public function restoreCalendarObject(array $objectData): void {
// Welp, this should possibly not have happened, but let's ignore
return;
}
$this->addChange($row['calendarid'], $row['uri'], 1, (int) $row['calendartype']);
$this->addChanges($row['calendarid'], [$row['uri']], 1, (int) $row['calendartype']);

$calendarRow = $this->getCalendarById((int) $row['calendarid']);
if ($calendarRow === null) {
Expand Down Expand Up @@ -2742,16 +2743,16 @@ public function createSchedulingObject($principalUri, $objectUri, $objectData) {
* Adds a change record to the calendarchanges table.
*
* @param mixed $calendarId
* @param string $objectUri
* @param string[] $objectUris
* @param int $operation 1 = add, 2 = modify, 3 = delete.
* @param int $calendarType
* @return void
*/
protected function addChange(int $calendarId, string $objectUri, int $operation, int $calendarType = self::CALENDAR_TYPE_CALENDAR): void {
protected function addChanges(int $calendarId, array $objectUris, int $operation, int $calendarType = self::CALENDAR_TYPE_CALENDAR): void {
$this->cachedObjects = [];
$table = $calendarType === self::CALENDAR_TYPE_CALENDAR ? 'calendars': 'calendarsubscriptions';

$this->atomic(function () use ($calendarId, $objectUri, $operation, $calendarType, $table) {
$this->atomic(function () use ($calendarId, $objectUris, $operation, $calendarType, $table) {
$query = $this->db->getQueryBuilder();
$query->select('synctoken')
->from($table)
Expand All @@ -2763,13 +2764,16 @@ protected function addChange(int $calendarId, string $objectUri, int $operation,
$query = $this->db->getQueryBuilder();
$query->insert('calendarchanges')
->values([
'uri' => $query->createNamedParameter($objectUri),
'uri' => $query->createParameter('uri'),
'synctoken' => $query->createNamedParameter($syncToken),
'calendarid' => $query->createNamedParameter($calendarId),
'operation' => $query->createNamedParameter($operation),
'calendartype' => $query->createNamedParameter($calendarType),
])
->executeStatement();
]);
foreach ($objectUris as $uri) {
$query->setParameter('uri', $uri);
$query->executeStatement();
}

$query = $this->db->getQueryBuilder();
$query->update($table)
Expand All @@ -2779,6 +2783,47 @@ protected function addChange(int $calendarId, string $objectUri, int $operation,
}, $this->db);
}

public function restoreChanges(int $calendarId, int $calendarType = self::CALENDAR_TYPE_CALENDAR): void {
$this->cachedObjects = [];

$this->atomic(function () use ($calendarId, $calendarType) {
$qbAdded = $this->db->getQueryBuilder();
$qbAdded->select('uri')
->from('calendarobjects')
->where(
$qbAdded->expr()->andX(
$qbAdded->expr()->eq('calendarid', $qbAdded->createNamedParameter($calendarId)),
$qbAdded->expr()->eq('calendartype', $qbAdded->createNamedParameter($calendarType)),
$qbAdded->expr()->isNull('deleted_at'),
)
);
$resultAdded = $qbAdded->executeQuery();
$addedUris = $resultAdded->fetchAll(\PDO::FETCH_COLUMN);
$resultAdded->closeCursor();
// Track everything as changed
// Tracking the creation is not necessary because \OCA\DAV\CalDAV\CalDavBackend::getChangesForCalendar
// only returns the last change per object.
$this->addChanges($calendarId, $addedUris, 2, $calendarType);

$qbDeleted = $this->db->getQueryBuilder();
$qbDeleted->select('uri')
->from('calendarobjects')
->where(
$qbDeleted->expr()->andX(
$qbDeleted->expr()->eq('calendarid', $qbDeleted->createNamedParameter($calendarId)),
$qbDeleted->expr()->eq('calendartype', $qbDeleted->createNamedParameter($calendarType)),
$qbDeleted->expr()->isNotNull('deleted_at'),
)
);
$resultDeleted = $qbDeleted->executeQuery();
$deletedUris = array_map(function (string $uri) {
return str_replace("-deleted.ics", ".ics", $uri);
}, $resultDeleted->fetchAll(\PDO::FETCH_COLUMN));
$resultDeleted->closeCursor();
$this->addChanges($calendarId, $deletedUris, 3, $calendarType);
}, $this->db);
}

/**
* Parses some information from calendar objects, used for optimized
* calendar-queries.
Expand Down Expand Up @@ -3120,9 +3165,7 @@ public function purgeAllCachedEventsForSubscription($subscriptionId) {
->andWhere($query->expr()->eq('calendartype', $query->createNamedParameter(self::CALENDAR_TYPE_SUBSCRIPTION)))
->executeStatement();

foreach ($uris as $uri) {
$this->addChange($subscriptionId, $uri, 3, self::CALENDAR_TYPE_SUBSCRIPTION);
}
$this->addChanges($subscriptionId, $uris, 3, self::CALENDAR_TYPE_SUBSCRIPTION);
}, $this->db);
}

Expand Down
86 changes: 86 additions & 0 deletions apps/dav/lib/Command/FixCalendarSyncCommand.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
<?php

declare(strict_types=1);

/*
* @copyright 2024 Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @author 2024 Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

namespace OCA\DAV\Command;

use OCA\DAV\CalDAV\CalDavBackend;
use OCP\IUser;
use OCP\IUserManager;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class FixCalendarSyncCommand extends Command {

public function __construct(private IUserManager $userManager,
private CalDavBackend $calDavBackend) {
parent::__construct('dav:fix-missing-caldav-changes');
}

protected function configure(): void {
$this->setDescription('Insert missing calendarchanges rows for existing events');
$this->addArgument(
'user',
InputArgument::OPTIONAL,
'User to fix calendar sync tokens for, if omitted all users will be fixed',
null,
);
}

public function execute(InputInterface $input, OutputInterface $output): int {
$userArg = $input->getArgument('user');
if ($userArg !== null) {
$user = $this->userManager->get($userArg);
if ($user === null) {
$output->writeln("<error>User $userArg does not exist</error>");
return 1;
}

$this->fixUserCalendars($user);
} else {
$progress = new ProgressBar($output);
$this->userManager->callForSeenUsers(function (IUser $user) use ($progress) {
$this->fixUserCalendars($user, $progress);
});
$progress->finish();
}
return 0;
}

private function fixUserCalendars(IUser $user, ?ProgressBar $progress = null): void {
$calendars = $this->calDavBackend->getCalendarsForUser("principals/users/" . $user->getUID());

foreach ($calendars as $calendar) {
$this->calDavBackend->restoreChanges($calendar['id']);
}

if ($progress !== null) {
$progress->advance();
}
}

}
33 changes: 12 additions & 21 deletions apps/dav/tests/unit/CalDAV/AbstractCalDavBackend.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
use OCP\App\IAppManager;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\IConfig;
use OCP\IDBConnection;
use OCP\IGroupManager;
use OCP\IUserManager;
use OCP\IUserSession;
Expand All @@ -56,26 +57,16 @@
*/
abstract class AbstractCalDavBackend extends TestCase {

/** @var CalDavBackend */
protected $backend;

/** @var Principal | MockObject */
protected $principal;
/** @var IUserManager|MockObject */
protected $userManager;
/** @var IGroupManager|MockObject */
protected $groupManager;
/** @var IEventDispatcher|MockObject */
protected $dispatcher;


/** @var IConfig | MockObject */
private $config;
/** @var ISecureRandom */
private $random;
/** @var LoggerInterface*/
private $logger;

protected CalDavBackend $backend;
protected Principal|MockObject $principal;
protected IUserManager|MockObject $userManager;
protected IGroupManager|MockObject $groupManager;
protected IEventDispatcher|MockObject $dispatcher;
private LoggerInterface|MockObject $logger;
private IConfig|MockObject $config;
private ISecureRandom $random;
protected IDBConnection $db;
public const UNIT_TEST_USER = 'principals/users/caldav-unit-test';
public const UNIT_TEST_USER1 = 'principals/users/caldav-unit-test1';
public const UNIT_TEST_GROUP = 'principals/groups/caldav-unit-test-group';
Expand Down Expand Up @@ -111,12 +102,12 @@ protected function setUp(): void {
->withAnyParameters()
->willReturn([self::UNIT_TEST_GROUP, self::UNIT_TEST_GROUP2]);

$db = \OC::$server->getDatabaseConnection();
$this->db = \OC::$server->getDatabaseConnection();
$this->random = \OC::$server->getSecureRandom();
$this->logger = $this->createMock(LoggerInterface::class);
$this->config = $this->createMock(IConfig::class);
$this->backend = new CalDavBackend(
$db,
$this->db,
$this->principal,
$this->userManager,
$this->groupManager,
Expand Down
Loading
Loading