Skip to content
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

Add commands to manage tags via OCC #26600

Merged
merged 1 commit into from
May 25, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 101 additions & 0 deletions core/Command/SystemTag/Add.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
<?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\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');
noiob marked this conversation as resolved.
Show resolved Hide resolved
if ($name === '') {
$output->writeln('<error>`name` can\'t be empty</error>');
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('<error>`access` property is invalid</error>');
return 1;
}

try {
$tag = $this->systemTagManager->createTag($name, $userVisible, $userAssignable);

$this->writeArrayInOutputFormat($input, $output,
noiob marked this conversation as resolved.
Show resolved Hide resolved
[
'id' => $tag->getId(),
'name' => $tag->getName(),
'access' => ISystemTag::ACCESS_LEVEL_LOOKUP[$tag->getAccessLevel()],
]);
return 0;
} catch (TagAlreadyExistsException $e) {
$output->writeln('<error>'.$e->getMessage().'</error>');
return 2;
}
}
}
64 changes: 64 additions & 0 deletions core/Command/SystemTag/Delete.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<?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;

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',
);
noiob marked this conversation as resolved.
Show resolved Hide resolved
}

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;
}
}
}
119 changes: 119 additions & 0 deletions core/Command/SystemTag/Edit.php
Original file line number Diff line number Diff line change
@@ -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)',
);
noiob marked this conversation as resolved.
Show resolved Hide resolved
}

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('<error>Tag not found</error>');
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('<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>');
noiob marked this conversation as resolved.
Show resolved Hide resolved
return 1;
} catch (TagAlreadyExistsException $e) {
$output->writeln('<error>'.$e->getMessage().'</error>');
return 2;
}
}
}
85 changes: 85 additions & 0 deletions core/Command/SystemTag/ListCommand.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
<?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;

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;
}
}
5 changes: 5 additions & 0 deletions core/register_command.php
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,11 @@
$application->add(new OC\Core\Command\Group\RemoveUser(\OC::$server->getUserManager(), \OC::$server->getGroupManager()));
$application->add(new OC\Core\Command\Group\Info(\OC::$server->get(\OCP\IGroupManager::class)));

$application->add(new OC\Core\Command\SystemTag\ListCommand(\OC::$server->get(\OCP\SystemTag\ISystemTagManager::class)));
$application->add(new OC\Core\Command\SystemTag\Delete(\OC::$server->get(\OCP\SystemTag\ISystemTagManager::class)));
$application->add(new OC\Core\Command\SystemTag\Add(\OC::$server->get(\OCP\SystemTag\ISystemTagManager::class)));
noiob marked this conversation as resolved.
Show resolved Hide resolved
$application->add(new OC\Core\Command\SystemTag\Edit(\OC::$server->get(\OCP\SystemTag\ISystemTagManager::class)));

$application->add(new OC\Core\Command\Security\ListCertificates(\OC::$server->getCertificateManager(), \OC::$server->getL10N('core')));
$application->add(new OC\Core\Command\Security\ImportCertificate(\OC::$server->getCertificateManager()));
$application->add(new OC\Core\Command\Security\RemoveCertificate(\OC::$server->getCertificateManager()));
Expand Down
4 changes: 4 additions & 0 deletions lib/composer/composer/autoload_classmap.php
Original file line number Diff line number Diff line change
Expand Up @@ -867,6 +867,10 @@
'OC\\Core\\Command\\Security\\RemoveCertificate' => $baseDir . '/core/Command/Security/RemoveCertificate.php',
'OC\\Core\\Command\\Security\\ResetBruteforceAttempts' => $baseDir . '/core/Command/Security/ResetBruteforceAttempts.php',
'OC\\Core\\Command\\Status' => $baseDir . '/core/Command/Status.php',
'OC\\Core\\Command\\SystemTag\\Add' => $baseDir . '/core/Command/SystemTag/Add.php',
'OC\\Core\\Command\\SystemTag\\Delete' => $baseDir . '/core/Command/SystemTag/Delete.php',
'OC\\Core\\Command\\SystemTag\\Edit' => $baseDir . '/core/Command/SystemTag/Edit.php',
'OC\\Core\\Command\\SystemTag\\ListCommand' => $baseDir . '/core/Command/SystemTag/ListCommand.php',
'OC\\Core\\Command\\TwoFactorAuth\\Base' => $baseDir . '/core/Command/TwoFactorAuth/Base.php',
'OC\\Core\\Command\\TwoFactorAuth\\Cleanup' => $baseDir . '/core/Command/TwoFactorAuth/Cleanup.php',
'OC\\Core\\Command\\TwoFactorAuth\\Disable' => $baseDir . '/core/Command/TwoFactorAuth/Disable.php',
Expand Down
Loading