-
-
Notifications
You must be signed in to change notification settings - Fork 4.7k
feat: command to list and delete calendar subscriptions #51136
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
Merged
kesselb
merged 1 commit into
master
from
feat/noid/occ-list-delete-calendar-subscription
Mar 11, 2025
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors | ||
| * SPDX-License-Identifier: AGPL-3.0-or-later | ||
| */ | ||
|
|
||
| namespace OCA\DAV\Command; | ||
|
|
||
| use OCA\DAV\CalDAV\CachedSubscription; | ||
| use OCA\DAV\CalDAV\CalDavBackend; | ||
| use OCP\IUserManager; | ||
| use Symfony\Component\Console\Attribute\AsCommand; | ||
| use Symfony\Component\Console\Command\Command; | ||
| use Symfony\Component\Console\Input\InputArgument; | ||
| use Symfony\Component\Console\Input\InputInterface; | ||
| use Symfony\Component\Console\Output\OutputInterface; | ||
|
|
||
| #[AsCommand( | ||
| name: 'dav:delete-subscription', | ||
| description: 'Delete a calendar subscription for a user', | ||
| hidden: false, | ||
| )] | ||
| class DeleteSubscription extends Command { | ||
| public function __construct( | ||
| private CalDavBackend $calDavBackend, | ||
| private IUserManager $userManager, | ||
| ) { | ||
| parent::__construct(); | ||
| } | ||
|
|
||
| protected function configure(): void { | ||
| $this | ||
| ->addArgument( | ||
| 'uid', | ||
| InputArgument::REQUIRED, | ||
| 'User who owns the calendar subscription' | ||
| ) | ||
| ->addArgument( | ||
| 'uri', | ||
| InputArgument::REQUIRED, | ||
| 'URI of the calendar to be deleted' | ||
| ); | ||
| } | ||
|
|
||
| protected function execute(InputInterface $input, OutputInterface $output): int { | ||
| $user = (string)$input->getArgument('uid'); | ||
| if (!$this->userManager->userExists($user)) { | ||
| throw new \InvalidArgumentException("User $user is unknown"); | ||
| } | ||
|
|
||
| $uri = (string)$input->getArgument('uri'); | ||
| if ($uri === '') { | ||
| throw new \InvalidArgumentException('Specify the URI of the calendar to be deleted'); | ||
| } | ||
|
|
||
| $subscriptionInfo = $this->calDavBackend->getSubscriptionByUri( | ||
| 'principals/users/' . $user, | ||
| $uri | ||
| ); | ||
|
|
||
| if ($subscriptionInfo === null) { | ||
| throw new \InvalidArgumentException("User $user has no calendar subscription with the URI $uri"); | ||
| } | ||
|
|
||
| $subscription = new CachedSubscription( | ||
| $this->calDavBackend, | ||
| $subscriptionInfo, | ||
| ); | ||
|
|
||
| $subscription->delete(); | ||
|
|
||
| $output->writeln("Calendar subscription with the URI $uri for user $user deleted"); | ||
|
|
||
| return self::SUCCESS; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors | ||
| * SPDX-License-Identifier: AGPL-3.0-or-later | ||
| */ | ||
|
|
||
| namespace OCA\DAV\Command; | ||
|
|
||
| use OCA\DAV\CalDAV\CalDavBackend; | ||
| use OCP\IAppConfig; | ||
| use OCP\IUserManager; | ||
| use Symfony\Component\Console\Attribute\AsCommand; | ||
| use Symfony\Component\Console\Command\Command; | ||
| use Symfony\Component\Console\Helper\Table; | ||
| use Symfony\Component\Console\Input\InputArgument; | ||
| use Symfony\Component\Console\Input\InputInterface; | ||
| use Symfony\Component\Console\Output\OutputInterface; | ||
|
|
||
| #[AsCommand( | ||
| name: 'dav:list-subscriptions', | ||
| description: 'List all calendar subscriptions for a user', | ||
| hidden: false, | ||
| )] | ||
| class ListSubscriptions extends Command { | ||
| public function __construct( | ||
| private IUserManager $userManager, | ||
| private IAppConfig $appConfig, | ||
| private CalDavBackend $caldav, | ||
| ) { | ||
| parent::__construct(); | ||
| } | ||
|
|
||
| protected function configure(): void { | ||
| $this->addArgument( | ||
| 'uid', | ||
| InputArgument::REQUIRED, | ||
| 'User whose calendar subscriptions will be listed' | ||
| ); | ||
| } | ||
|
|
||
| protected function execute(InputInterface $input, OutputInterface $output): int { | ||
| $user = (string)$input->getArgument('uid'); | ||
| if (!$this->userManager->userExists($user)) { | ||
| throw new \InvalidArgumentException("User $user is unknown"); | ||
| } | ||
|
|
||
| $defaultRefreshRate = $this->appConfig->getValueString('dav', 'calendarSubscriptionRefreshRate', 'P1D'); | ||
| $subscriptions = $this->caldav->getSubscriptionsForUser("principals/users/$user"); | ||
| $rows = []; | ||
|
|
||
| foreach ($subscriptions as $subscription) { | ||
| $rows[] = [ | ||
| $subscription['uri'], | ||
| $subscription['{DAV:}displayname'], | ||
| $subscription['{http://apple.com/ns/ical/}refreshrate'] ?? ($defaultRefreshRate . ' (default)'), | ||
| $subscription['source'], | ||
| ]; | ||
| } | ||
|
|
||
| usort($rows, static fn (array $a, array $b) => $a[0] <=> $b[0]); | ||
|
|
||
| if (count($rows) > 0) { | ||
| $table = new Table($output); | ||
| $table | ||
| ->setHeaders(['URI', 'Displayname', 'Refresh rate', 'Source']) | ||
| ->setRows($rows) | ||
| ->render(); | ||
| } else { | ||
| $output->writeln("User $user has no subscriptions"); | ||
| } | ||
|
|
||
| return self::SUCCESS; | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I really hate, that we have to do this, but I get it at the moment there is no other way.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is the issue? I don't see it yet
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That we constantly have to append and remove 'principals/users/'