Merge pull request #390 from nextcloud/occ-user

More occ user management commands

core/Command/Group/AddUser.php

@@ -0,0 +1,77 @@
+<?php
+/**
+ * @copyright Copyright (c) 2016 Robin Appelman <robin@icewind.nl>
+ *
+ * @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\Group;
+
+use OC\Core\Command\Base;
+use OCP\IGroupManager;
+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 AddUser extends Base {
+	/** @var IUserManager */
+	protected $userManager;
+	/** @var IGroupManager */
+	protected $groupManager;
+
+	/**
+	 * @param IUserManager $userManager
+	 * @param IGroupManager $groupManager
+	 */
+	public function __construct(IUserManager $userManager, IGroupManager $groupManager) {
+		$this->userManager = $userManager;
+		$this->groupManager = $groupManager;
+		parent::__construct();
+	}
+
+	protected function configure() {
+		$this
+			->setName('group:adduser')
+			->setDescription('add a user to a group')
+			->addArgument(
+				'group',
+				InputArgument::REQUIRED,
+				'group to add the user to'
+			)->addArgument(
+				'user',
+				InputArgument::REQUIRED,
+				'user to add to the group'
+			);
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output) {
+		$group = $this->groupManager->get($input->getArgument('group'));
+		if (is_null($group)) {
+			$output->writeln('<error>group not found</error>');
+			return 1;
+		}
+		$user = $this->userManager->get($input->getArgument('user'));
+		if (is_null($user)) {
+			$output->writeln('<error>user not found</error>');
+			return 1;
+		}
+		$group->addUser($user);
+	}
+}

core/Command/Group/ListCommand.php

@@ -0,0 +1,89 @@
+<?php
+/**
+ * @copyright Copyright (c) 2016 Robin Appelman <robin@icewind.nl>
+ *
+ * @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\Group;
+
+use OC\Core\Command\Base;
+use OCP\IGroup;
+use OCP\IGroupManager;
+use OCP\IUser;
+use OCP\IUserManager;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class ListCommand extends Base {
+	/** @var IGroupManager */
+	protected $groupManager;
+
+	/**
+	 * @param IGroupManager $groupManager
+	 */
+	public function __construct(IGroupManager $groupManager) {
+		$this->groupManager = $groupManager;
+		parent::__construct();
+	}
+
+	protected function configure() {
+		$this
+			->setName('group:list')
+			->setDescription('list configured groups')
+			->addOption(
+				'limit',
+				'l',
+				InputOption::VALUE_OPTIONAL,
+				'Number of groups to retrieve',
+				500
+			)->addOption(
+				'offset',
+				'o',
+				InputOption::VALUE_OPTIONAL,
+				'Offset for retrieving groups',
+				0
+			)->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) {
+		$groups = $this->groupManager->search('', (int)$input->getOption('limit'), (int)$input->getOption('offset'));
+		$this->writeArrayInOutputFormat($input, $output, $this->formatGroups($groups));
+	}
+
+	/**
+	 * @param IGroup[] $groups
+	 * @return array
+	 */
+	private function formatGroups(array $groups) {
+		$keys = array_map(function (IGroup $group) {
+			return $group->getGID();
+		}, $groups);
+		$values = array_map(function (IGroup $group) {
+			return array_keys($group->getUsers());
+		}, $groups);
+		return array_combine($keys, $values);
+	}
+}

core/Command/Group/RemoveUser.php

@@ -0,0 +1,77 @@
+<?php
+/**
+ * @copyright Copyright (c) 2016 Robin Appelman <robin@icewind.nl>
+ *
+ * @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\Group;
+
+use OC\Core\Command\Base;
+use OCP\IGroupManager;
+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 RemoveUser extends Base {
+	/** @var IUserManager */
+	protected $userManager;
+	/** @var IGroupManager */
+	protected $groupManager;
+
+	/**
+	 * @param IUserManager $userManager
+	 * @param IGroupManager $groupManager
+	 */
+	public function __construct(IUserManager $userManager, IGroupManager $groupManager) {
+		$this->userManager = $userManager;
+		$this->groupManager = $groupManager;
+		parent::__construct();
+	}
+
+	protected function configure() {
+		$this
+			->setName('group:removeuser')
+			->setDescription('remove a user from a group')
+			->addArgument(
+				'group',
+				InputArgument::REQUIRED,
+				'group to remove the user from'
+			)->addArgument(
+				'user',
+				InputArgument::REQUIRED,
+				'user to remove from the group'
+			);
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output) {
+		$group = $this->groupManager->get($input->getArgument('group'));
+		if (is_null($group)) {
+			$output->writeln('<error>group not found</error>');
+			return 1;
+		}
+		$user = $this->userManager->get($input->getArgument('user'));
+		if (is_null($user)) {
+			$output->writeln('<error>user not found</error>');
+			return 1;
+		}
+		$group->removeUser($user);
+	}
+}

core/Command/User/Info.php

@@ -0,0 +1,88 @@
+<?php
+/**
+ * @copyright Copyright (c) 2016 Robin Appelman <robin@icewind.nl>
+ *
+ * @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\User;
+
+use OC\Core\Command\Base;
+use OCP\IGroupManager;
+use OCP\IUser;
+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 Info extends Base {
+	/** @var IUserManager */
+	protected $userManager;
+	/** @var IGroupManager */
+	protected $groupManager;
+
+	/**
+	 * @param IUserManager $userManager
+	 * @param IGroupManager $groupManager
+	 */
+	public function __construct(IUserManager $userManager, IGroupManager $groupManager) {
+		$this->userManager = $userManager;
+		$this->groupManager = $groupManager;
+		parent::__construct();
+	}
+
+	protected function configure() {
+		$this
+			->setName('user:info')
+			->setDescription('show user info')
+			->addArgument(
+				'user',
+				InputArgument::REQUIRED,
+				'user to show'
+			)->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) {
+		$user = $this->userManager->get($input->getArgument('user'));
+		if (is_null($user)) {
+			$output->writeln('<error>user not found</error>');
+			return 1;
+		}
+		$groups = $this->groupManager->getUserGroupIds($user);
+		$data = [
+			'user_id' => $user->getUID(),
+			'display_name' => $user->getDisplayName(),
+			'email' => ($user->getEMailAddress()) ? $user->getEMailAddress() : '',
+			'cloud_id' => $user->getCloudId(),
+			'enabled' => $user->isEnabled(),
+			'groups' => $groups,
+			'quota' => $user->getQuota(),
+			'last_seen' => date(\DateTime::ATOM, $user->getLastLogin()), // ISO-8601
+			'user_directory' => $user->getHome(),
+			'backend' => $user->getBackendClassName()
+		];
+		$this->writeArrayInOutputFormat($input, $output, $data);
+	}
+}

core/Command/User/ListCommand.php

@@ -0,0 +1,87 @@
+<?php
+/**
+ * @copyright Copyright (c) 2016 Robin Appelman <robin@icewind.nl>
+ *
+ * @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\User;
+
+use OC\Core\Command\Base;
+use OCP\IUser;
+use OCP\IUserManager;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class ListCommand extends Base {
+	/** @var IUserManager */
+	protected $userManager;
+
+	/**
+	 * @param IUserManager $userManager
+	 */
+	public function __construct(IUserManager $userManager) {
+		$this->userManager = $userManager;
+		parent::__construct();
+	}
+
+	protected function configure() {
+		$this
+			->setName('user:list')
+			->setDescription('list configured users')
+			->addOption(
+				'limit',
+				'l',
+				InputOption::VALUE_OPTIONAL,
+				'Number of users to retrieve',
+				500
+			)->addOption(
+				'offset',
+				'o',
+				InputOption::VALUE_OPTIONAL,
+				'Offset for retrieving users',
+				0
+			)->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) {
+		$users = $this->userManager->search('', (int)$input->getOption('limit'), (int)$input->getOption('offset'));
+		$this->writeArrayInOutputFormat($input, $output, $this->formatUsers($users));
+	}
+
+	/**
+	 * @param IUser[] $users
+	 * @return array
+	 */
+	private function formatUsers(array $users) {
+		$keys = array_map(function (IUser $user) {
+			return $user->getUID();
+		}, $users);
+		$values = array_map(function (IUser $user) {
+			return $user->getDisplayName();
+		}, $users);
+		return array_combine($keys, $values);
+	}
+}

core/register_command.php

@@ -137,6 +137,12 @@ if (\OC::$server->getConfig()->getSystemValue('installed', false)) {
 	$application->add(new OC\Core\Command\User\Report(\OC::$server->getUserManager()));
 	$application->add(new OC\Core\Command\User\ResetPassword(\OC::$server->getUserManager()));
 	$application->add(new OC\Core\Command\User\Setting(\OC::$server->getUserManager(), \OC::$server->getConfig(), \OC::$server->getDatabaseConnection()));
+	$application->add(new OC\Core\Command\User\ListCommand(\OC::$server->getUserManager()));
+	$application->add(new OC\Core\Command\User\Info(\OC::$server->getUserManager(), \OC::$server->getGroupManager()));
+
+	$application->add(new OC\Core\Command\Group\ListCommand(\OC::$server->getGroupManager()));
+	$application->add(new OC\Core\Command\Group\AddUser(\OC::$server->getUserManager(), \OC::$server->getGroupManager()));
+	$application->add(new OC\Core\Command\Group\RemoveUser(\OC::$server->getUserManager(), \OC::$server->getGroupManager()));
 
 	$application->add(new OC\Core\Command\Security\ListCertificates(\OC::$server->getCertificateManager(null), \OC::$server->getL10N('core')));
 	$application->add(new OC\Core\Command\Security\ImportCertificate(\OC::$server->getCertificateManager(null)));