From cf8b98bf5f1da01a5992bd88ea4a8ed83e797eba Mon Sep 17 00:00:00 2001 From: Thomas Citharel Date: Wed, 18 May 2022 11:10:36 +0200 Subject: [PATCH] Make sure activities are not created when a deleted calendar object expires Closes https://github.com/nextcloud/activity/issues/784 Signed-off-by: Thomas Citharel --- apps/dav/lib/CalDAV/CalDavBackend.php | 5 +- .../tests/unit/CalDAV/CalDavBackendTest.php | 6 +- .../Listener/ActivityUpdaterListenerTest.php | 104 ++++++++++++++++++ 3 files changed, 111 insertions(+), 4 deletions(-) create mode 100644 apps/dav/tests/unit/Listener/ActivityUpdaterListenerTest.php diff --git a/apps/dav/lib/CalDAV/CalDavBackend.php b/apps/dav/lib/CalDAV/CalDavBackend.php index 3253d41a5cdb9..8bdc084cd7b44 100644 --- a/apps/dav/lib/CalDAV/CalDavBackend.php +++ b/apps/dav/lib/CalDAV/CalDavBackend.php @@ -1139,7 +1139,7 @@ public function getDeletedCalendarObjectsByPrincipal(string $principalUri): arra */ public function getCalendarObject($calendarId, $objectUri, int $calendarType = self::CALENDAR_TYPE_CALENDAR) { $query = $this->db->getQueryBuilder(); - $query->select(['id', 'uri', 'lastmodified', 'etag', 'calendarid', 'size', 'calendardata', 'componenttype', 'classification']) + $query->select(['id', 'uri', 'lastmodified', 'etag', 'calendarid', 'size', 'calendardata', 'componenttype', 'classification', 'deleted_at']) ->from('calendarobjects') ->where($query->expr()->eq('calendarid', $query->createNamedParameter($calendarId))) ->andWhere($query->expr()->eq('uri', $query->createNamedParameter($objectUri))) @@ -1161,7 +1161,8 @@ public function getCalendarObject($calendarId, $objectUri, int $calendarType = s 'size' => (int)$row['size'], 'calendardata' => $this->readBlob($row['calendardata']), 'component' => strtolower($row['componenttype']), - 'classification' => (int)$row['classification'] + 'classification' => (int)$row['classification'], + '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_NEXTCLOUD . '}deleted-at' => $row['deleted_at'] === null ? $row['deleted_at'] : (int) $row['deleted_at'], ]; } diff --git a/apps/dav/tests/unit/CalDAV/CalDavBackendTest.php b/apps/dav/tests/unit/CalDAV/CalDavBackendTest.php index 3a5cf56409c16..a6439ee6d2b08 100644 --- a/apps/dav/tests/unit/CalDAV/CalDavBackendTest.php +++ b/apps/dav/tests/unit/CalDAV/CalDavBackendTest.php @@ -35,6 +35,7 @@ use DateTimeZone; use OCA\DAV\CalDAV\CalDavBackend; use OCA\DAV\CalDAV\Calendar; +use OCA\DAV\DAV\Sharing\Plugin as SharingPlugin; use OCA\DAV\Events\CalendarDeletedEvent; use OCP\IConfig; use OCP\IL10N; @@ -232,13 +233,13 @@ public function testCalendarObjectsOperations() { ->method('dispatchTyped'); $this->backend->createCalendarObject($calendarId, $uri, $calData); - // get all the cards + // get all the calendar objects $calendarObjects = $this->backend->getCalendarObjects($calendarId); $this->assertCount(1, $calendarObjects); $this->assertEquals($calendarId, $calendarObjects[0]['calendarid']); $this->assertArrayHasKey('classification', $calendarObjects[0]); - // get the cards + // get the calendar objects $calendarObject = $this->backend->getCalendarObject($calendarId, $uri); $this->assertNotNull($calendarObject); $this->assertArrayHasKey('id', $calendarObject); @@ -247,6 +248,7 @@ public function testCalendarObjectsOperations() { $this->assertArrayHasKey('etag', $calendarObject); $this->assertArrayHasKey('size', $calendarObject); $this->assertArrayHasKey('classification', $calendarObject); + $this->assertArrayHasKey('{' . SharingPlugin::NS_NEXTCLOUD . '}deleted-at', $calendarObject); $this->assertEquals($calData, $calendarObject['calendardata']); // update the card diff --git a/apps/dav/tests/unit/Listener/ActivityUpdaterListenerTest.php b/apps/dav/tests/unit/Listener/ActivityUpdaterListenerTest.php new file mode 100644 index 0000000000000..03c4046991c61 --- /dev/null +++ b/apps/dav/tests/unit/Listener/ActivityUpdaterListenerTest.php @@ -0,0 +1,104 @@ + + * + * @author Thomas Citharel + * + * @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 . + * + */ +namespace OCA\DAV\Tests\Unit\Listener; + +use OCA\DAV\CalDAV\Activity\Backend as ActivityBackend; +use OCA\DAV\CalDAV\Activity\Provider\Event; +use OCA\DAV\DAV\Sharing\Plugin as SharingPlugin; +use OCA\DAV\Events\CalendarDeletedEvent; +use OCA\DAV\Events\CalendarObjectDeletedEvent; +use OCA\DAV\Listener\ActivityUpdaterListener; +use PHPUnit\Framework\MockObject\MockObject; +use Psr\Log\LoggerInterface; +use Test\TestCase; + +class ActivityUpdaterListenerTest extends TestCase { + + /** @var ActivityBackend|MockObject */ + private $activityBackend; + /** @var LoggerInterface|MockObject */ + private $logger; + /** @var ActivityUpdaterListener */ + private ActivityUpdaterListener $listener; + + protected function setUp(): void { + parent::setUp(); + + $this->activityBackend = $this->createMock(ActivityBackend::class); + $this->logger = $this->createMock(LoggerInterface::class); + + $this->listener = new ActivityUpdaterListener( + $this->activityBackend, + $this->logger + ); + } + + /** + * @dataProvider dataForTestHandleCalendarObjectDeletedEvent + */ + public function testHandleCalendarObjectDeletedEvent(int $calendarId, array $calendarData, array $shares, array $objectData, bool $createsActivity): void { + $event = new CalendarObjectDeletedEvent($calendarId, $calendarData, $shares, $objectData); + $this->logger->expects($this->once())->method('debug')->with( + $createsActivity ? "Activity generated for deleted calendar object in calendar $calendarId" : "Calendar object in calendar $calendarId was already in trashbin, skipping deletion activity" + ); + $this->activityBackend->expects($createsActivity ? $this->once() : $this->never())->method('onTouchCalendarObject')->with( + Event::SUBJECT_OBJECT_DELETE, + $calendarData, + $shares, + $objectData + ); + $this->listener->handle($event); + } + + public function dataForTestHandleCalendarObjectDeletedEvent(): array { + return [ + [1, [], [], [], true], + [1, [], [], ['{' . SharingPlugin::NS_NEXTCLOUD . '}deleted-at' => 120], false], + ]; + } + + /** + * @dataProvider dataForTestHandleCalendarDeletedEvent + */ + public function testHandleCalendarDeletedEvent(int $calendarId, array $calendarData, array $shares, bool $createsActivity): void { + $event = new CalendarDeletedEvent($calendarId, $calendarData, $shares); + $this->logger->expects($this->once())->method('debug')->with( + $createsActivity ? "Activity generated for deleted calendar $calendarId" : "Calendar $calendarId was already in trashbin, skipping deletion activity" + ); + $this->activityBackend->expects($createsActivity ? $this->once() : $this->never())->method('onCalendarDelete')->with( + $calendarData, + $shares + ); + $this->listener->handle($event); + } + + public function dataForTestHandleCalendarDeletedEvent(): array { + return [ + [1, [], [], true], + [1, ['{' . SharingPlugin::NS_NEXTCLOUD . '}deleted-at' => 120], [], false], + ]; + } +}