nextcloud / polls

lib/Command/Share/Add.php

<?php
/**
 * @copyright Copyright (c) 2021 Daniel Rudolf <nextcloud.com@daniel-rudolf.de>
 *
 * @author Daniel Rudolf <nextcloud.com@daniel-rudolf.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 OCA\Polls\Command\Share;

use OC\Core\Command\Base;

The type OC\Core\Command\Base was not found. Maybe you did not declare it correctly or list all dependencies?

use OCA\Polls\Db\Poll;
use OCA\Polls\Exceptions\ShareAlreadyExistsException;
use OCA\Polls\Model\Email;
use OCA\Polls\Model\Group;
use OCA\Polls\Model\User;
use OCP\AppFramework\Db\DoesNotExistException;
use Stecman\Component\Symfony\Console\BashCompletion\CompletionContext;

The type Stecman\Component\Symfony\Console\BashCompletion\CompletionContext was not found. Maybe you did not declare it correctly or list all dependencies?

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 {
	use TShareCommand;

	protected function configure(): void {
		$this
			->setName('polls:share:add')
			->setDescription('Invites users to a poll')
			->addArgument(
				'id',
				InputArgument::REQUIRED,
				'ID of the poll to invite users to'
			)->addOption(
				'user',
				null,
				InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
				'Invites the given users to the poll'
			)->addOption(
				'group',
				null,
				InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
				'Invites all members of the given groups to the poll'
			)->addOption(
				'email',
				null,
				InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
				'Sends invitation e-mails to the given addresses to participate in the poll'
			);
	}

	protected function execute(InputInterface $input, OutputInterface $output): int {
		$pollId = $input->getArgument('id');
		$users = $input->getOption('user');
		$groups = $input->getOption('group');
		$emails = $input->getOption('email');

		try {
			$poll = $this->pollMapper->find($pollId);

$pollId of type null|string|string[] is incompatible with the type integer expected by parameter $id of OCA\Polls\Db\PollMapper::find().

		} catch (DoesNotExistException $e) {
			$output->writeln('<error>Poll not found.</error>');
			return 1;
		}

		$this->inviteUsers($poll, $users);

It seems like $users can also be of type boolean and null and string; however, parameter $userIds of OCA\Polls\Command\Share\Add::inviteUsers() does only seem to accept array, maybe add an additional type check?

		$this->inviteGroups($poll, $groups);

It seems like $groups can also be of type boolean and null and string; however, parameter $groupIds of OCA\Polls\Command\Share\Add::inviteGroups() does only seem to accept array, maybe add an additional type check?

		$this->inviteEmails($poll, $emails);

It seems like $emails can also be of type boolean and null and string; however, parameter $emails of OCA\Polls\Command\Share\Add::inviteEmails() does only seem to accept array, maybe add an additional type check?

		$output->writeln('<info>Users successfully invited to poll.</info>');
		return 0;
	}

	/**
	 * @param Poll     $poll
	 * @param string[] $userIds
	 */
	private function inviteUsers(Poll $poll, array $userIds): void {
		foreach ($userIds as $userId) {
			try {
				$share = $this->shareService->add($poll->getId(), User::TYPE, $userId);
				$this->shareService->sendInvitation($share->getToken());
			} catch (ShareAlreadyExistsException $e) {
				// silently ignore already existing shares
			}
		}
	}

	/**
	 * @param Poll     $poll
	 * @param string[] $groupIds
	 */
	private function inviteGroups(Poll $poll, array $groupIds): void {
		foreach ($groupIds as $groupId) {
			try {
				$share = $this->shareService->add($poll->getId(), Group::TYPE, $groupId);
				$this->shareService->sendInvitation($share->getToken());
			} catch (ShareAlreadyExistsException $e) {
				// silently ignore already existing shares
			}
		}
	}

	/**
	 * @param Poll     $poll
	 * @param string[] $emails
	 */
	private function inviteEmails(Poll $poll, array $emails): void {
		foreach ($emails as $email) {
			try {
				$share = $this->shareService->add($poll->getId(), Email::TYPE, $email);
				$this->shareService->sendInvitation($share->getToken());
			} catch (ShareAlreadyExistsException $e) {
				// silently ignore already existing shares
			}
		}
	}

	public function completeOptionValues($optionName, CompletionContext $context) {
		switch ($optionName) {
			case 'user':
				return $this->completeUserValues($context);

			case 'group':
				return $this->completeGroupValues($context);
		}

		return parent::completeOptionValues($optionName, $context);
	}
}