From d606799ee2b3a6e11e616cd5606901754aa70c93 Mon Sep 17 00:00:00 2001 From: Johannes Leuker Date: Thu, 15 Apr 2021 18:02:39 +0200 Subject: Add commands to manage tags via OCC list, add, delete, edit Signed-off-by: Johannes Leuker --- core/Command/SystemTag/Add.php | 101 ++++++++++++++++++++++++++++ core/Command/SystemTag/Delete.php | 64 ++++++++++++++++++ core/Command/SystemTag/Edit.php | 119 +++++++++++++++++++++++++++++++++ core/Command/SystemTag/ListCommand.php | 85 +++++++++++++++++++++++ 4 files changed, 369 insertions(+) create mode 100644 core/Command/SystemTag/Add.php create mode 100644 core/Command/SystemTag/Delete.php create mode 100644 core/Command/SystemTag/Edit.php create mode 100644 core/Command/SystemTag/ListCommand.php (limited to 'core/Command') diff --git a/core/Command/SystemTag/Add.php b/core/Command/SystemTag/Add.php new file mode 100644 index 00000000000..e16c0da126b --- /dev/null +++ b/core/Command/SystemTag/Add.php @@ -0,0 +1,101 @@ + + * + * @author Johannes Leuker + * + * @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 OC\Core\Command\SystemTag; + +use OC\Core\Command\Base; +use OCP\SystemTag\ISystemTag; +use OCP\SystemTag\ISystemTagManager; +use OCP\SystemTag\TagAlreadyExistsException; +use Symfony\Component\Console\Input\InputArgument; +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Output\OutputInterface; + +class Add extends Base { + + /** @var ISystemTagManager */ + protected $systemTagManager; + + public function __construct(ISystemTagManager $systemTagManager) { + $this->systemTagManager = $systemTagManager; + parent::__construct(); + } + + protected function configure() { + $this + ->setName('tag:add') + ->setDescription('Add new tag') + ->addArgument( + 'name', + InputArgument::REQUIRED, + 'name of the tag', + ) + ->addArgument( + 'access', + InputArgument::REQUIRED, + 'access level of the tag (public, restricted or invisible)', + ); + parent::configure(); + } + + protected function execute(InputInterface $input, OutputInterface $output): int { + $name = $input->getArgument('name'); + if ($name === '') { + $output->writeln('`name` can\'t be empty'); + return 3; + } + + switch ($input->getArgument('access')) { + case 'public': + $userVisible = true; + $userAssignable = true; + break; + case 'restricted': + $userVisible = true; + $userAssignable = false; + break; + case 'invisible': + $userVisible = false; + $userAssignable = false; + break; + default: + $output->writeln('`access` property is invalid'); + return 1; + } + + try { + $tag = $this->systemTagManager->createTag($name, $userVisible, $userAssignable); + + $this->writeArrayInOutputFormat($input, $output, + [ + 'id' => $tag->getId(), + 'name' => $tag->getName(), + 'access' => ISystemTag::ACCESS_LEVEL_LOOKUP[$tag->getAccessLevel()], + ]); + return 0; + } catch (TagAlreadyExistsException $e) { + $output->writeln(''.$e->getMessage().''); + return 2; + } + } +} diff --git a/core/Command/SystemTag/Delete.php b/core/Command/SystemTag/Delete.php new file mode 100644 index 00000000000..cc06b7d513c --- /dev/null +++ b/core/Command/SystemTag/Delete.php @@ -0,0 +1,64 @@ + + * + * @author Johannes Leuker + * + * @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 OC\Core\Command\SystemTag; + +use OC\Core\Command\Base; +use OCP\SystemTag\ISystemTagManager; +use OCP\SystemTag\TagNotFoundException; +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Input\InputOption; +use Symfony\Component\Console\Output\OutputInterface; + +class Delete extends Base { + + /** @var ISystemTagManager */ + protected $systemTagManager; + + public function __construct(ISystemTagManager $systemTagManager) { + $this->systemTagManager = $systemTagManager; + parent::__construct(); + } + + protected function configure() { + $this + ->setName('tag:delete') + ->setDescription('delete a tag') + ->addArgument( + 'id', + InputOption::VALUE_REQUIRED, + 'The ID of the tag that should be deleted', + ); + } + + protected function execute(InputInterface $input, OutputInterface $output): int { + try { + $this->systemTagManager->deleteTags($input->getArgument('id')); + $output->writeln('The specified tag was deleted'); + return 0; + } catch (TagNotFoundException $e) { + $output->writeln('Tag not found'); + return 1; + } + } +} diff --git a/core/Command/SystemTag/Edit.php b/core/Command/SystemTag/Edit.php new file mode 100644 index 00000000000..8f58d08e2cf --- /dev/null +++ b/core/Command/SystemTag/Edit.php @@ -0,0 +1,119 @@ + + * + * @author Johannes Leuker + * + * @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 OC\Core\Command\SystemTag; + +use OC\Core\Command\Base; +use OCP\SystemTag\ISystemTagManager; +use OCP\SystemTag\TagAlreadyExistsException; +use OCP\SystemTag\TagNotFoundException; +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Input\InputOption; +use Symfony\Component\Console\Output\OutputInterface; + +class Edit extends Base { + + /** @var ISystemTagManager */ + protected $systemTagManager; + + /** + * @param ISystemTagManager $systemTagManager + */ + public function __construct(ISystemTagManager $systemTagManager) { + $this->systemTagManager = $systemTagManager; + parent::__construct(); + } + + protected function configure() { + $this + ->setName('tag:edit') + ->setDescription('edit tag attributes') + ->addArgument( + 'id', + InputOption::VALUE_REQUIRED, + 'The ID of the tag that should be deleted', + ) + ->addOption( + 'name', + null, + InputOption::VALUE_OPTIONAL, + 'sets the \'name\' parameter', + ) + ->addOption( + 'access', + null, + InputOption::VALUE_OPTIONAL, + 'sets the access control level (public, restricted, invisible)', + ); + } + + protected function execute(InputInterface $input, OutputInterface $output): int { + $tagArray = $this->systemTagManager->getTagsByIds($input->getArgument('id')); + // returns an array, but we always expect 0 or 1 results + + if (!$tagArray) { + $output->writeln('Tag not found'); + return 3; + } + + $tag = array_values($tagArray)[0]; + $name = $tag->getName(); + if (!empty($input->getOption('name'))) { + $name = $input->getOption('name'); + } + + $userVisible = $tag->isUserVisible(); + $userAssignable = $tag->isUserAssignable(); + if ($input->getOption('access')) { + switch ($input->getOption('access')) { + case 'public': + $userVisible = true; + $userAssignable = true; + break; + case 'restricted': + $userVisible = true; + $userAssignable = false; + break; + case 'invisible': + $userVisible = false; + $userAssignable = false; + break; + default: + $output->writeln('`access` property is invalid'); + return 1; + } + } + + try { + $this->systemTagManager->updateTag($input->getArgument('id'), $name, $userVisible, $userAssignable); + $output->writeln('Tag updated ("' . $name . '", '. $userVisible . ', ' . $userAssignable . ')'); + return 0; + } catch (TagNotFoundException $e) { + $output->writeln('Tag not found'); + return 1; + } catch (TagAlreadyExistsException $e) { + $output->writeln(''.$e->getMessage().''); + return 2; + } + } +} diff --git a/core/Command/SystemTag/ListCommand.php b/core/Command/SystemTag/ListCommand.php new file mode 100644 index 00000000000..72ef1467f40 --- /dev/null +++ b/core/Command/SystemTag/ListCommand.php @@ -0,0 +1,85 @@ + + * + * @author Johannes Leuker + * + * @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 OC\Core\Command\SystemTag; + +use OC\Core\Command\Base; +use OCP\SystemTag\ISystemTagManager; +use OCP\SystemTag\ISystemTag; +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Input\InputOption; +use Symfony\Component\Console\Output\OutputInterface; + +class ListCommand extends Base { + + /** @var ISystemTagManager */ + protected $systemTagManager; + + public function __construct(ISystemTagManager $systemTagManager) { + $this->systemTagManager = $systemTagManager; + parent::__construct(); + } + + protected function configure() { + $this + ->setName('tag:list') + ->setDescription('list tags') + ->addOption( + 'visibilityFilter', + null, + InputOption::VALUE_OPTIONAL, + 'filter by visibility (1,0)' + ) + ->addOption( + 'nameSearchPattern', + null, + InputOption::VALUE_OPTIONAL, + 'optional search pattern for the tag name (infix)' + ); + parent::configure(); + } + + protected function execute(InputInterface $input, OutputInterface $output): int { + $tags = $this->systemTagManager->getAllTags( + $input->getOption('visibilityFilter'), + $input->getOption('nameSearchPattern') + ); + + $this->writeArrayInOutputFormat($input, $output, $this->formatTags($tags)); + return 0; + } + + /** + * @param ISystemtag[] $tags + * @return array + */ + private function formatTags(array $tags) { + foreach ($tags as $tag) { + $result[$tag->getId()] = [ + 'name' => $tag->getName(), + 'access' => ISystemTag::ACCESS_LEVEL_LOOKUP[$tag->getAccessLevel()], + ]; + } + return $result; + } +} -- cgit v1.2.3