server/apps/workflowengine/lib/Check/UserGroupMembership.php
Arthur Schiwon 849d025d09
let a dedicate service serve a stateful process
* includes making ICheck not requiring any context setter
* and IFileCheck extending the IEntityCheck as entity data can be handed in
  via Dispatcher

Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>
2019-09-09 22:56:05 +02:00

116 lines
2.9 KiB
PHP

<?php
/**
* @copyright Copyright (c) 2016 Morris Jobke <hey@morrisjobke.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\WorkflowEngine\Check;
use OCP\IGroupManager;
use OCP\IL10N;
use OCP\IUser;
use OCP\IUserSession;
use OCP\WorkflowEngine\ICheck;
use OCP\WorkflowEngine\IManager;
class UserGroupMembership implements ICheck {
/** @var string */
protected $cachedUser;
/** @var string[] */
protected $cachedGroupMemberships;
/** @var IUserSession */
protected $userSession;
/** @var IGroupManager */
protected $groupManager;
/** @var IL10N */
protected $l;
/**
* @param IUserSession $userSession
* @param IGroupManager $groupManager
* @param IL10N $l
*/
public function __construct(IUserSession $userSession, IGroupManager $groupManager, IL10N $l) {
$this->userSession = $userSession;
$this->groupManager = $groupManager;
$this->l = $l;
}
/**
* @param string $operator
* @param string $value
* @return bool
*/
public function executeCheck($operator, $value) {
$user = $this->userSession->getUser();
if ($user instanceof IUser) {
$groupIds = $this->getUserGroups($user);
return ($operator === 'is') === in_array($value, $groupIds);
} else {
return $operator !== 'is';
}
}
/**
* @param string $operator
* @param string $value
* @throws \UnexpectedValueException
*/
public function validateCheck($operator, $value) {
if (!in_array($operator, ['is', '!is'])) {
throw new \UnexpectedValueException($this->l->t('The given operator is invalid'), 1);
}
if (!$this->groupManager->groupExists($value)) {
throw new \UnexpectedValueException($this->l->t('The given group does not exist'), 2);
}
}
/**
* @param IUser $user
* @return string[]
*/
protected function getUserGroups(IUser $user) {
$uid = $user->getUID();
if ($this->cachedUser !== $uid) {
$this->cachedUser = $uid;
$this->cachedGroupMemberships = $this->groupManager->getUserGroupIds($user);
}
return $this->cachedGroupMemberships;
}
public function supportedEntities(): array {
// universal by default
return [];
}
public function isAvailableForScope(int $scope): bool {
// admin only by default
return $scope === IManager::SCOPE_ADMIN;
}
}