summaryrefslogtreecommitdiffstats
path: root/apps/dav
diff options
context:
space:
mode:
authorChristoph Wurst <ChristophWurst@users.noreply.github.com>2021-06-14 10:03:44 +0200
committerGitHub <noreply@github.com>2021-06-14 10:03:44 +0200
commitdfbac05f7ba00c78ac15df61a425317a890b08d1 (patch)
treee1c230bc8709ccc70978c7e14214e40a3e4e202d /apps/dav
parent1979c657f9cdc8c7fc5ae54611a577d130feca6b (diff)
parent4850dae1df586d107c18f4f249dca445ad2798f3 (diff)
downloadnextcloud-server-dfbac05f7ba00c78ac15df61a425317a890b08d1.tar.gz
nextcloud-server-dfbac05f7ba00c78ac15df61a425317a890b08d1.zip
Merge pull request #26421 from mattian/enh/25771/occ-delete-calendar
OCC command to delete calendars
Diffstat (limited to 'apps/dav')
-rw-r--r--apps/dav/appinfo/info.xml1
-rw-r--r--apps/dav/composer/composer/autoload_classmap.php1
-rw-r--r--apps/dav/composer/composer/autoload_static.php1
-rw-r--r--apps/dav/lib/Command/DeleteCalendar.php137
-rw-r--r--apps/dav/tests/unit/Command/DeleteCalendarTest.php250
5 files changed, 390 insertions, 0 deletions
diff --git a/apps/dav/appinfo/info.xml b/apps/dav/appinfo/info.xml
index c99d82a798d..0cfa2e968ea 100644
--- a/apps/dav/appinfo/info.xml
+++ b/apps/dav/appinfo/info.xml
@@ -47,6 +47,7 @@
<commands>
<command>OCA\DAV\Command\CreateAddressBook</command>
<command>OCA\DAV\Command\CreateCalendar</command>
+ <command>OCA\DAV\Command\DeleteCalendar</command>
<command>OCA\DAV\Command\MoveCalendar</command>
<command>OCA\DAV\Command\ListCalendars</command>
<command>OCA\DAV\Command\RetentionCleanupCommand</command>
diff --git a/apps/dav/composer/composer/autoload_classmap.php b/apps/dav/composer/composer/autoload_classmap.php
index 19c0e2549f6..13e78cee716 100644
--- a/apps/dav/composer/composer/autoload_classmap.php
+++ b/apps/dav/composer/composer/autoload_classmap.php
@@ -118,6 +118,7 @@ return array(
'OCA\\DAV\\CardDAV\\Xml\\Groups' => $baseDir . '/../lib/CardDAV/Xml/Groups.php',
'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\\ListCalendars' => $baseDir . '/../lib/Command/ListCalendars.php',
'OCA\\DAV\\Command\\MoveCalendar' => $baseDir . '/../lib/Command/MoveCalendar.php',
'OCA\\DAV\\Command\\RemoveInvalidShares' => $baseDir . '/../lib/Command/RemoveInvalidShares.php',
diff --git a/apps/dav/composer/composer/autoload_static.php b/apps/dav/composer/composer/autoload_static.php
index 6895064e39d..42ba59e0582 100644
--- a/apps/dav/composer/composer/autoload_static.php
+++ b/apps/dav/composer/composer/autoload_static.php
@@ -133,6 +133,7 @@ class ComposerStaticInitDAV
'OCA\\DAV\\CardDAV\\Xml\\Groups' => __DIR__ . '/..' . '/../lib/CardDAV/Xml/Groups.php',
'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\\ListCalendars' => __DIR__ . '/..' . '/../lib/Command/ListCalendars.php',
'OCA\\DAV\\Command\\MoveCalendar' => __DIR__ . '/..' . '/../lib/Command/MoveCalendar.php',
'OCA\\DAV\\Command\\RemoveInvalidShares' => __DIR__ . '/..' . '/../lib/Command/RemoveInvalidShares.php',
diff --git a/apps/dav/lib/Command/DeleteCalendar.php b/apps/dav/lib/Command/DeleteCalendar.php
new file mode 100644
index 00000000000..42aa0e3278f
--- /dev/null
+++ b/apps/dav/lib/Command/DeleteCalendar.php
@@ -0,0 +1,137 @@
+<?php
+
+declare(strict_types=1);
+/**
+ *
+ * @copyright Copyright (c) 2021, Mattia Narducci (mattianarducci1@gmail.com)
+ *
+ * @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 <https://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\DAV\Command;
+
+use OCA\DAV\CalDAV\BirthdayService;
+use OCA\DAV\CalDAV\CalDavBackend;
+use OCA\DAV\CalDAV\Calendar;
+use OCP\IConfig;
+use OCP\IL10N;
+use OCP\IUserManager;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class DeleteCalendar extends Command {
+ /** @var CalDavBackend */
+ private $calDav;
+
+ /** @var IConfig */
+ private $config;
+
+ /** @var IL10N */
+ private $l10n;
+
+ /** @var IUserManager */
+ private $userManager;
+
+ /**
+ * @param CalDavBackend $calDav
+ * @param IConfig $config
+ * @param IL10N $l10n
+ * @param IUserManager $userManager
+ */
+ public function __construct(
+ CalDavBackend $calDav,
+ IConfig $config,
+ IL10N $l10n,
+ IUserManager $userManager
+ ) {
+ parent::__construct();
+ $this->calDav = $calDav;
+ $this->config = $config;
+ $this->l10n = $l10n;
+ $this->userManager = $userManager;
+ }
+
+ protected function configure(): void {
+ $this
+ ->setName('dav:delete-calendar')
+ ->setDescription('Delete a dav calendar')
+ ->addArgument('uid',
+ InputArgument::REQUIRED,
+ 'User who owns the calendar')
+ ->addArgument('name',
+ InputArgument::OPTIONAL,
+ 'Name of the calendar to delete')
+ ->addOption('birthday',
+ null,
+ InputOption::VALUE_NONE,
+ 'Delete the birthday calendar')
+ ->addOption('force',
+ 'f',
+ InputOption::VALUE_NONE,
+ 'Force delete skipping trashbin');
+ }
+
+ protected function execute(
+ InputInterface $input,
+ OutputInterface $output
+ ): int {
+ /** @var string $user **/
+ $user = $input->getArgument('uid');
+ if (!$this->userManager->userExists($user)) {
+ throw new \InvalidArgumentException(
+ 'User <' . $user . '> is unknown.');
+ }
+
+ $birthday = $input->getOption('birthday');
+ if ($birthday !== false) {
+ $name = BirthdayService::BIRTHDAY_CALENDAR_URI;
+ } else {
+ /** @var string $name **/
+ $name = $input->getArgument('name');
+ if (!$name) {
+ throw new \InvalidArgumentException(
+ 'Please specify a calendar name or --birthday');
+ }
+ }
+
+ $calendarInfo = $this->calDav->getCalendarByUri(
+ 'principals/users/' . $user,
+ $name);
+ if ($calendarInfo === null) {
+ throw new \InvalidArgumentException(
+ 'User <' . $user . '> has no calendar named <' . $name . '>. You can run occ dav:list-calendars to list calendars URIs for this user.');
+ }
+
+ $calendar = new Calendar(
+ $this->calDav,
+ $calendarInfo,
+ $this->l10n,
+ $this->config);
+
+ $force = $input->getOption('force');
+ if ($force) {
+ $calendar->disableTrashbin();
+ }
+
+ $calendar->delete();
+
+ return 0;
+ }
+}
diff --git a/apps/dav/tests/unit/Command/DeleteCalendarTest.php b/apps/dav/tests/unit/Command/DeleteCalendarTest.php
new file mode 100644
index 00000000000..ac4e8f07413
--- /dev/null
+++ b/apps/dav/tests/unit/Command/DeleteCalendarTest.php
@@ -0,0 +1,250 @@
+<?php
+
+declare(strict_types=1);
+/**
+ *
+ * @copyright Copyright (c) 2021, Mattia Narducci (mattianarducci1@gmail.com)
+ *
+ * @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 <https://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\DAV\Tests\Command;
+
+use OCA\DAV\CalDAV\BirthdayService;
+use OCA\DAV\CalDav\CalDavBackend;
+use OCA\DAV\Command\DeleteCalendar;
+use OCP\IConfig;
+use OCP\IL10N;
+use OCP\IUserManager;
+use PHPUnit\Framework\MockObject\MockObject;
+use Symfony\Component\Console\Tester\CommandTester;
+use Test\TestCase;
+
+/**
+ * Class DeleteCalendarTest
+ *
+ * @package OCA\DAV\Tests\Command
+ */
+class DeleteCalendarTest extends TestCase {
+ public const USER = 'user';
+ public const NAME = 'calendar';
+
+ /** @var CalDavBackend|MockObject */
+ private $calDav;
+
+ /** @var IConfig|MockObject */
+ private $config;
+
+ /** @var IL10N|MockObject */
+ private $l10n;
+
+ /** @var IUserManager|MockObject */
+ private $userManager;
+
+ /** @var DeleteCalendar */
+ private $command;
+
+ protected function setUp(): void {
+ parent::setUp();
+
+ $this->calDav = $this->createMock(CalDavBackend::class);
+ $this->config = $this->createMock(IConfig::class);
+ $this->l10n = $this->createMock(IL10N::class);
+ $this->userManager = $this->createMock(IUserManager::class);
+
+ $this->command = new DeleteCalendar(
+ $this->calDav,
+ $this->config,
+ $this->l10n,
+ $this->userManager,
+ );
+ }
+
+ public function testInvalidUser() {
+ $this->expectException(\InvalidArgumentException::class);
+ $this->expectExceptionMessage(
+ 'User <' . self::USER . '> is unknown.');
+
+ $this->userManager->expects($this->once())
+ ->method('userExists')
+ ->with(self::USER)
+ ->willReturn(false);
+
+ $commandTester = new CommandTester($this->command);
+ $commandTester->execute([
+ 'uid' => self::USER,
+ 'name' => self::NAME,
+ ]);
+ }
+
+ public function testNoCalendarName() {
+ $this->expectException(\InvalidArgumentException::class);
+ $this->expectExceptionMessage(
+ 'Please specify a calendar name or --birthday');
+
+ $this->userManager->expects($this->once())
+ ->method('userExists')
+ ->with(self::USER)
+ ->willReturn(true);
+
+ $commandTester = new CommandTester($this->command);
+ $commandTester->execute([
+ 'uid' => self::USER,
+ ]);
+ }
+
+ public function testInvalidCalendar() {
+ $this->expectException(\InvalidArgumentException::class);
+ $this->expectExceptionMessage(
+ 'User <' . self::USER . '> has no calendar named <' . self::NAME . '>.');
+
+ $this->userManager->expects($this->once())
+ ->method('userExists')
+ ->with(self::USER)
+ ->willReturn(true);
+ $this->calDav->expects($this->once())
+ ->method('getCalendarByUri')
+ ->with(
+ 'principals/users/' . self::USER,
+ self::NAME
+ )
+ ->willReturn(null);
+
+ $commandTester = new CommandTester($this->command);
+ $commandTester->execute([
+ 'uid' => self::USER,
+ 'name' => self::NAME,
+ ]);
+ }
+
+ public function testDelete() {
+ $id = 1234;
+ $calendar = [
+ 'id' => $id,
+ 'principaluri' => 'principals/users/' . self::USER,
+ 'uri' => self::NAME
+ ];
+
+ $this->userManager->expects($this->once())
+ ->method('userExists')
+ ->with(self::USER)
+ ->willReturn(true);
+ $this->calDav->expects($this->once())
+ ->method('getCalendarByUri')
+ ->with(
+ 'principals/users/' . self::USER,
+ self::NAME
+ )
+ ->willReturn($calendar);
+ $this->calDav->expects($this->once())
+ ->method('deleteCalendar')
+ ->with($id, false);
+
+ $commandTester = new CommandTester($this->command);
+ $commandTester->execute([
+ 'uid' => self::USER,
+ 'name' => self::NAME,
+ ]);
+ }
+
+ public function testForceDelete() {
+ $id = 1234;
+ $calendar = [
+ 'id' => $id,
+ 'principaluri' => 'principals/users/' . self::USER,
+ 'uri' => self::NAME
+ ];
+
+ $this->userManager->expects($this->once())
+ ->method('userExists')
+ ->with(self::USER)
+ ->willReturn(true);
+ $this->calDav->expects($this->once())
+ ->method('getCalendarByUri')
+ ->with(
+ 'principals/users/' . self::USER,
+ self::NAME
+ )
+ ->willReturn($calendar);
+ $this->calDav->expects($this->once())
+ ->method('deleteCalendar')
+ ->with($id, true);
+
+ $commandTester = new CommandTester($this->command);
+ $commandTester->execute([
+ 'uid' => self::USER,
+ 'name' => self::NAME,
+ '-f' => true
+ ]);
+ }
+
+ public function testDeleteBirthday() {
+ $id = 1234;
+ $calendar = [
+ 'id' => $id,
+ 'principaluri' => 'principals/users/' . self::USER,
+ 'uri' => BirthdayService::BIRTHDAY_CALENDAR_URI
+ ];
+
+ $this->userManager->expects($this->once())
+ ->method('userExists')
+ ->with(self::USER)
+ ->willReturn(true);
+ $this->calDav->expects($this->once())
+ ->method('getCalendarByUri')
+ ->with(
+ 'principals/users/' . self::USER,
+ BirthdayService::BIRTHDAY_CALENDAR_URI
+ )
+ ->willReturn($calendar);
+ $this->calDav->expects($this->once())
+ ->method('deleteCalendar')
+ ->with($id);
+
+ $commandTester = new CommandTester($this->command);
+ $commandTester->execute([
+ 'uid' => self::USER,
+ '--birthday' => true,
+ ]);
+ }
+
+ public function testBirthdayHasPrecedence() {
+ $calendar = [
+ 'id' => 1234,
+ 'principaluri' => 'principals/users/' . self::USER,
+ 'uri' => BirthdayService::BIRTHDAY_CALENDAR_URI
+ ];
+ $this->userManager->expects($this->once())
+ ->method('userExists')
+ ->with(self::USER)
+ ->willReturn(true);
+ $this->calDav->expects($this->once())
+ ->method('getCalendarByUri')
+ ->with(
+ 'principals/users/' . self::USER,
+ BirthdayService::BIRTHDAY_CALENDAR_URI
+ )
+ ->willReturn($calendar);
+
+ $commandTester = new CommandTester($this->command);
+ $commandTester->execute([
+ 'uid' => self::USER,
+ 'name' => self::NAME,
+ '--birthday' => true,
+ ]);
+ }
+}