mirror of https://github.com/nextcloud/server.git
feat(caldav): add repair steps in sabre calendarobject change hook
Signed-off-by: Thomas Citharel <tcit@tcit.fr>add-caldav-repair-middleware
Thomas Citharel
7 months ago
parent
0ff674607f
commit
da8b3b85c6
@ -0,0 +1,80 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright 2023, Thomas Citharel <nextcloud@tcit.fr>
|
||||
*
|
||||
* @author Thomas Citharel <nextcloud@tcit.fr>
|
||||
*
|
||||
* @license AGPL-3.0
|
||||
*
|
||||
* This code is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License, version 3,
|
||||
* as published by the Free Software Foundation.
|
||||
*
|
||||
* 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, version 3,
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
||||
*
|
||||
*/
|
||||
namespace OCA\DAV\CalDAV\Repair;
|
||||
|
||||
use Sabre\VObject\Component;
|
||||
use Sabre\VObject\Component\VCalendar;
|
||||
|
||||
class Description implements IRepairStep {
|
||||
|
||||
private const X_ALT_DESC_PROP_NAME = "X-ALT-DESC";
|
||||
|
||||
private const SUPPORTED_COMPONENTS = ['VEVENT', 'VTODO'];
|
||||
|
||||
public function runOnCreate(): bool {
|
||||
return false;
|
||||
}
|
||||
|
||||
public function onCalendarObjectChange(?VCalendar $oldVCalendar, ?VCalendar $newVCalendar, bool &$modified): void {
|
||||
$keyedOldComponents = [];
|
||||
foreach ($oldVCalendar->children() as $child) {
|
||||
if (!($child instanceof Component)) {
|
||||
continue;
|
||||
}
|
||||
$keyedOldComponents[$child->UID] = $child;
|
||||
}
|
||||
|
||||
foreach (self::SUPPORTED_COMPONENTS as $supportedComponent) {
|
||||
foreach ($newVCalendar->{$supportedComponent} as $newComponent) {
|
||||
$this->onCalendarComponentChange($keyedOldComponents[$newComponent->UID], $newComponent, $modified);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public function onCalendarComponentChange(?Component $oldObject, ?Component $newObject, bool &$modified): void {
|
||||
// Get presence of description fields
|
||||
$hasOldDescription = isset($oldObject->DESCRIPTION);
|
||||
$hasNewDescription = isset($newObject->DESCRIPTION);
|
||||
$hasOldXAltDesc = isset($oldObject->{self::X_ALT_DESC_PROP_NAME});
|
||||
$hasNewXAltDesc = isset($newObject->{self::X_ALT_DESC_PROP_NAME});
|
||||
$hasOldAltRep = isset($oldObject->DESCRIPTION['ALTREP']);
|
||||
$hasNewAltRep = isset($newObject->DESCRIPTION['ALTREP']);
|
||||
|
||||
// If all description fields are present, then verify consistency
|
||||
if ($hasOldDescription && $hasNewDescription && (($hasOldXAltDesc && $hasNewXAltDesc) || ($hasOldAltRep && $hasNewAltRep))) {
|
||||
// Compare descriptions
|
||||
$isSameDescription = (string) $oldObject->DESCRIPTION === (string) $newObject->DESCRIPTION;
|
||||
$isSameXAltDesc = (string) $oldObject->{self::X_ALT_DESC_PROP_NAME} === (string) $newObject->{self::X_ALT_DESC_PROP_NAME};
|
||||
$isSameAltRep = (string) $oldObject->DESCRIPTION['ALTREP'] === (string) $newObject->DESCRIPTION['ALTREP'];
|
||||
|
||||
// If the description changed, but not the alternate one, then delete the latest
|
||||
if (!$isSameDescription && $isSameXAltDesc) {
|
||||
unset($newObject->{self::X_ALT_DESC_PROP_NAME});
|
||||
$modified = true;
|
||||
}
|
||||
if (!$isSameDescription && $isSameAltRep) {
|
||||
unset($newObject->DESCRIPTION['ALTREP']);
|
||||
$modified = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,37 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright 2023, Thomas Citharel <nextcloud@tcit.fr>
|
||||
*
|
||||
* @author Thomas Citharel <nextcloud@tcit.fr>
|
||||
*
|
||||
* @license AGPL-3.0
|
||||
*
|
||||
* This code is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License, version 3,
|
||||
* as published by the Free Software Foundation.
|
||||
*
|
||||
* 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, version 3,
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
||||
*
|
||||
*/
|
||||
namespace OCA\DAV\CalDAV\Repair;
|
||||
|
||||
use Sabre\VObject\Component\VCalendar;
|
||||
|
||||
interface IRepairStep {
|
||||
/**
|
||||
* Returns true if the step will be run on new data as well as updated one
|
||||
*/
|
||||
public function runOnCreate(): bool;
|
||||
|
||||
/**
|
||||
* The callback to implement while checking. If it runs on create, beware that oldObject will logically be null for this condition.
|
||||
* Fix the updated object by editing the $newObject and setting $modified to true.
|
||||
*/
|
||||
public function onCalendarObjectChange(?VCalendar $oldVCalendar, ?VCalendar $newVCalendar, bool &$modified): void;
|
||||
}
|
||||
@ -0,0 +1,72 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright 2023, Thomas Citharel <nextcloud@tcit.fr>
|
||||
*
|
||||
* @author Thomas Citharel <nextcloud@tcit.fr>
|
||||
*
|
||||
* @license AGPL-3.0
|
||||
*
|
||||
* This code is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License, version 3,
|
||||
* as published by the Free Software Foundation.
|
||||
*
|
||||
* 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, version 3,
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
||||
*
|
||||
*/
|
||||
namespace OCA\DAV\CalDAV\Repair;
|
||||
|
||||
use Sabre\CalDAV\ICalendarObject;
|
||||
use Sabre\DAV\Exception\NotFound;
|
||||
use Sabre\DAV\Server;
|
||||
use Sabre\DAV\ServerPlugin;
|
||||
use Sabre\HTTP\RequestInterface;
|
||||
use Sabre\HTTP\ResponseInterface;
|
||||
use Sabre\VObject\Component\VCalendar;
|
||||
use Sabre\VObject\Reader;
|
||||
|
||||
class Plugin extends ServerPlugin {
|
||||
|
||||
private Server $server;
|
||||
|
||||
public function __construct(private RepairStepFactory $repairStepFactory) { }
|
||||
|
||||
/**
|
||||
* Returns the name of the plugin.
|
||||
*
|
||||
* Using this name other plugins will be able to access other plugins
|
||||
* using Server::getPlugin
|
||||
*/
|
||||
public function getPluginName(): string {
|
||||
return 'nc-caldav-repair';
|
||||
}
|
||||
|
||||
public function initialize(Server $server): void {
|
||||
$this->server = $server;
|
||||
$server->on('calendarObjectChange', [$this, 'calendarObjectChange']);
|
||||
}
|
||||
|
||||
public function calendarObjectChange(RequestInterface $request, ResponseInterface $response, VCalendar $vCal, string $calendarPath, bool &$modified, bool $isNew): void {
|
||||
foreach ($this->repairStepFactory->getRepairSteps() as $repairStep) {
|
||||
if ($repairStep->runOnCreate() && $isNew) {
|
||||
$repairStep->onCalendarObjectChange(null, $vCal, $modified);
|
||||
} else if (!$isNew) {
|
||||
try {
|
||||
/** @var ICalendarObject $node */
|
||||
$node = $this->server->tree->getNodeForPath($request->getPath());
|
||||
/** @var VCalendar $oldObj */
|
||||
$oldObj = Reader::read($node->get());
|
||||
$repairStep->onCalendarObjectChange($oldObj, $vCal, $modified);
|
||||
} catch (NotFound) {
|
||||
// Nothing, we just skip
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,46 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright 2023, Thomas Citharel <nextcloud@tcit.fr>
|
||||
*
|
||||
* @author Thomas Citharel <nextcloud@tcit.fr>
|
||||
*
|
||||
* @license AGPL-3.0
|
||||
*
|
||||
* This code is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License, version 3,
|
||||
* as published by the Free Software Foundation.
|
||||
*
|
||||
* 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, version 3,
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
||||
*
|
||||
*/
|
||||
namespace OCA\DAV\CalDAV\Repair;
|
||||
|
||||
class RepairStepFactory {
|
||||
/**
|
||||
* @var IRepairStep[]
|
||||
*/
|
||||
private array $repairSteps = [];
|
||||
|
||||
/**
|
||||
* @return IRepairStep[]
|
||||
*/
|
||||
public function getRepairSteps(): array {
|
||||
return $this->repairSteps;
|
||||
}
|
||||
|
||||
public function addRepairStep(IRepairStep $repairStep): self {
|
||||
$this->repairSteps[] = $repairStep;
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function registerRepairStep(string $repairStep): self {
|
||||
$this->addRepairStep(new $repairStep);
|
||||
return $this;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,109 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright 2023, Thomas Citharel <nextcloud@tcit.fr>
|
||||
*
|
||||
* @author Thomas Citharel <nextcloud@tcit.fr>
|
||||
*
|
||||
* @license AGPL-3.0
|
||||
*
|
||||
* This code is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License, version 3,
|
||||
* as published by the Free Software Foundation.
|
||||
*
|
||||
* 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, version 3,
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
||||
*
|
||||
*/
|
||||
namespace OCA\DAV\Tests\unit\CalDAV\Repair;
|
||||
|
||||
use OCA\DAV\CalDAV\Repair\IRepairStep;
|
||||
use OCA\DAV\CalDAV\Repair\Plugin;
|
||||
use OCA\DAV\CalDAV\Repair\RepairStepFactory;
|
||||
use PHPUnit\Framework\MockObject\MockObject;
|
||||
use Sabre\CalDAV\ICalendarObject;
|
||||
use Sabre\DAV\Server;
|
||||
use Sabre\DAV\Tree;
|
||||
use Sabre\HTTP\RequestInterface;
|
||||
use Sabre\HTTP\ResponseInterface;
|
||||
use Sabre\VObject\Component;
|
||||
use Sabre\VObject\Component\VCalendar;
|
||||
use Test\TestCase;
|
||||
|
||||
class PluginTest extends TestCase {
|
||||
|
||||
private RequestInterface|MockObject $request;
|
||||
private ResponseInterface|MockObject $response;
|
||||
private Tree|MockObject $tree;
|
||||
private IRepairStep|MockObject $repairStep;
|
||||
|
||||
private Plugin $plugin;
|
||||
|
||||
protected function setUp(): void {
|
||||
parent::setUp();
|
||||
$this->request = $this->createMock(RequestInterface::class);
|
||||
$this->response = $this->createMock(ResponseInterface::class);
|
||||
$server = $this->createMock(Server::class);
|
||||
$this->tree = $this->createMock(Tree::class);
|
||||
$server->tree = $this->tree;
|
||||
$this->repairStep = $this->createMock(IRepairStep::class);
|
||||
$this->repairStepFactory = new RepairStepFactory();
|
||||
$this->repairStepFactory->addRepairStep($this->repairStep);
|
||||
|
||||
$this->plugin = new Plugin($this->repairStepFactory);
|
||||
$this->plugin->initialize($server);
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider dataForTestRunRepairStepsOnCalendarData
|
||||
*/
|
||||
public function testRunRepairStepsOnCalendarData(VCalendar $VCalendar, ?VCalendar $oldVCalendar, bool $modified, bool $isNew, bool $repairStepRunOnCreate): void {
|
||||
$modifiedChanged = false;
|
||||
$this->repairStep->expects($this->once())->method('runOnCreate')->willReturn($repairStepRunOnCreate);
|
||||
$this->repairStep->expects($this->once())->method('onCalendarObjectChange')->with(self::callback(function (?VCalendar $value) use ($oldVCalendar) {
|
||||
// Can't simply check object equality because of missing references to parents, so checking the serialized value
|
||||
self::assertSame($oldVCalendar?->serialize(), $value?->serialize());
|
||||
return true;
|
||||
}), self::callback(function (VCalendar $value) use ($VCalendar) {
|
||||
self::assertSame($VCalendar->serialize(), $value->serialize());
|
||||
return true;
|
||||
}), $modifiedChanged);
|
||||
$node = $this->createMock(ICalendarObject::class);
|
||||
$node->expects($isNew ? $this->never() : $this->once())->method('get')->willReturn($oldVCalendar?->serialize());
|
||||
$this->request->expects($isNew ? $this->never() : $this->once())->method('getPath')->willReturn('/a-path');
|
||||
$this->tree->expects($isNew ? $this->never() : $this->once())->method('getNodeForPath')->with('/a-path')->willReturn($node);
|
||||
$this->plugin->calendarObjectChange($this->request, $this->response, $VCalendar, '', $modifiedChanged, $isNew);
|
||||
self::assertSame($modified, $modifiedChanged);
|
||||
}
|
||||
|
||||
public function dataForTestRunRepairStepsOnCalendarData(): array {
|
||||
|
||||
$vCalendar = new VCalendar();
|
||||
$oldVCalendar = new VCalendar();
|
||||
|
||||
$vCalendar->add('VEVENT', [
|
||||
'UID' => 'uid-1234',
|
||||
'LAST-MODIFIED' => 123456,
|
||||
'SEQUENCE' => 2,
|
||||
'SUMMARY' => 'Fellowship meeting',
|
||||
'DTSTART' => new \DateTime('2016-01-01 00:00:00'),
|
||||
]);
|
||||
|
||||
$oldVCalendar->add('VEVENT', [
|
||||
'UID' => 'uid-1234',
|
||||
'LAST-MODIFIED' => 123456,
|
||||
'SEQUENCE' => 2,
|
||||
'SUMMARY' => 'Fellowship meeting updated',
|
||||
'DTSTART' => new \DateTime('2018-01-01 00:00:00'),
|
||||
]);
|
||||
|
||||
return [
|
||||
[$vCalendar, null, false, true, true],
|
||||
[$vCalendar, $oldVCalendar, false, false, false]
|
||||
];
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue