Add commands to manage tags via OCC

list, add, delete, edit

Signed-off-by: Johannes Leuker <j.leuker@hosting.de>

core/Command/SystemTag/Add.php

@@ -0,0 +1,108 @@
+<?php
+/**
+ * @copyright Copyright (c) 2021, hosting.de, Johannes Leuker <developers@hosting.de>
+ *
+ * @author Johannes Leuker <developers@hosting.de>
+ *
+ * @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 <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OC\Core\Command\SystemTag;
+
+use OC\Core\Command\Base;
+use OCP\SystemTag\ISystemTagManager;
+use OCP\SystemTag\TagAlreadyExistsException;
+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 Add 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:add')
+			->setDescription('Add new tag')
+			->addArgument(
+				'name',
+				InputArgument::REQUIRED,
+				'sets the \'name\' parameter',
+			)
+			->addArgument(
+				'access',
+				InputArgument::REQUIRED,
+				'sets the `visible` and `assignable` parameters (public, restricted, invisible)',
+			)
+			->addOption(
+				'output',
+				null,
+				InputOption::VALUE_OPTIONAL,
+				'Output format (plain, json or json_pretty, default is plain)',
+				$this->defaultOutputFormat
+			);
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output): int {
+		$name = $input->getArgument('name');
+
+		if ($input->getArgument('access')) {
+			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('<error>`access` property is invalid</error>');
+					return 1;
+			}
+		}
+
+		try {
+			$tag = $this->systemTagManager->createTag($name, $userVisible, $userAssignable);
+			$this->writeArrayInOutputFormat($input, $output,
+				[
+					$tag->getId() => [
+						'name' => $tag->getName(),
+						'access' => $tag->getHumanReadableAccess(),
+					]
+				]);
+			return 0;
+		} catch (TagAlreadyExistsException $e) {
+			$output->writeln('<error>'.$e->getMessage().'</error>');
+			return 2;
+		}
+	}
+}

core/Command/SystemTag/Delete.php

@@ -0,0 +1,67 @@
+<?php
+/**
+ * @copyright Copyright (c) 2021, hosting.de, Johannes Leuker <developers@hosting.de>
+ *
+ * @author Johannes Leuker <developers@hosting.de>
+ *
+ * @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 <http://www.gnu.org/licenses/>.
+ *
+ */
+
+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;
+
+	/**
+	 * @param ISystemTagManager $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('<info>The specified tag was deleted</info>');
+			return 0;
+		} catch (TagNotFoundException $e) {
+			$output->writeln('<error>Tag not found</error>');
+			return 1;
+		}
+	}
+}

core/Command/SystemTag/Edit.php

@@ -0,0 +1,119 @@
+<?php
+/**
+ * @copyright Copyright (c) 2021, hosting.de, Johannes Leuker <developers@hosting.de>
+ *
+ * @author Johannes Leuker <developers@hosting.de>
+ *
+ * @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 <http://www.gnu.org/licenses/>.
+ *
+ */
+
+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 {
+		$tag_arr = $this->systemTagManager->getTagsByIds($input->getArgument('id'));
+		// returns an array, but we always expect 0 or 1 results
+
+		if ($tag_arr) {
+			$tag = array_values($tag_arr)[0];
+			$name = $tag->getName();
+			if ($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('<error>`access` property is invalid</error>');
+						return 1;
+				}
+			}
+
+			try {
+				$this->systemTagManager->updateTag($input->getArgument('id'), $name, $userVisible, $userAssignable);
+				$output->writeln('<info>Tag updated ("' . $name . '", '. $userVisible . ', ' . $userAssignable . ')</info>');
+				return 0;
+			} catch (TagNotFoundException $e) {
+				$output->writeln('<error>Tag not found</error>');
+				return 1;
+			} catch (TagAlreadyExistsException $e) {
+				$output->writeln('<error>'.$e->getMessage().'</error>');
+				return 2;
+			}
+		} else {
+			$output->writeln('<error>Tag not found</error>');
+			return 3;
+		}
+	}
+}

core/Command/SystemTag/ListCommand.php

@@ -0,0 +1,96 @@
+<?php
+/**
+ * @copyright Copyright (c) 2021, hosting.de, Johannes Leuker <developers@hosting.de>
+ *
+ * @author Johannes Leuker <developers@hosting.de>
+ *
+ * @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 <http://www.gnu.org/licenses/>.
+ *
+ */
+
+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;
+
+	/**
+	 * @param ISystemTagManager $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)'
+			)
+			->addOption(
+				'output',
+				null,
+				InputOption::VALUE_OPTIONAL,
+				'Output format (plain, json or json_pretty, default is plain)',
+				$this->defaultOutputFormat
+			);
+	}
+
+	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
+	 * @param bool [$detailed=false]
+	 * @return array
+	 */
+	private function formatTags(array $tags) {
+		$result = [];
+		foreach ($tags as $tag) {
+			$result[$tag->getId()] = [
+				'name' => $tag->getName(),
+				'access' => $tag->getHumanReadableAccess(),
+			];
+		}
+		return $result;
+	}
+}