2015-03-21 22:03:56 +03:00
|
|
|
<?php
|
|
|
|
/**
|
2016-01-12 17:02:16 +03:00
|
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
2016-07-21 18:07:57 +03:00
|
|
|
*
|
2017-11-06 17:56:42 +03:00
|
|
|
* @author Julius Härtl <jus@bitgrid.net>
|
2016-07-21 18:07:57 +03:00
|
|
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
|
|
|
*
|
2015-03-21 22:03:56 +03:00
|
|
|
* @license AGPL-3.0
|
|
|
|
*
|
|
|
|
* This code is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU Affero General Public License, version 3,
|
|
|
|
* as published by the Free Software Foundation.
|
|
|
|
*
|
|
|
|
* 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, version 3,
|
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2018-01-13 21:53:31 +03:00
|
|
|
declare(strict_types=1);
|
|
|
|
|
|
|
|
namespace OC;
|
2015-03-21 22:03:56 +03:00
|
|
|
|
2016-08-15 21:22:48 +03:00
|
|
|
use OCP\AppFramework\QueryException;
|
2015-03-21 22:03:56 +03:00
|
|
|
use OCP\Capabilities\ICapability;
|
2017-06-30 12:08:04 +03:00
|
|
|
use OCP\Capabilities\IPublicCapability;
|
2016-08-15 21:22:48 +03:00
|
|
|
use OCP\ILogger;
|
2015-03-21 22:03:56 +03:00
|
|
|
|
2015-07-22 14:04:56 +03:00
|
|
|
class CapabilitiesManager {
|
2015-03-21 22:03:56 +03:00
|
|
|
|
2016-08-15 21:22:48 +03:00
|
|
|
/** @var \Closure[] */
|
2015-03-21 22:03:56 +03:00
|
|
|
private $capabilities = array();
|
|
|
|
|
2016-08-15 21:22:48 +03:00
|
|
|
/** @var ILogger */
|
|
|
|
private $logger;
|
|
|
|
|
|
|
|
public function __construct(ILogger $logger) {
|
|
|
|
$this->logger = $logger;
|
|
|
|
}
|
|
|
|
|
2015-03-21 22:03:56 +03:00
|
|
|
/**
|
|
|
|
* Get an array of al the capabilities that are registered at this manager
|
|
|
|
*
|
2017-06-30 12:08:04 +03:00
|
|
|
* @param bool $public get public capabilities only
|
2015-03-21 22:03:56 +03:00
|
|
|
* @throws \InvalidArgumentException
|
|
|
|
* @return array
|
|
|
|
*/
|
2018-01-13 21:53:31 +03:00
|
|
|
public function getCapabilities(bool $public = false) : array {
|
2015-03-21 22:03:56 +03:00
|
|
|
$capabilities = [];
|
|
|
|
foreach($this->capabilities as $capability) {
|
2016-08-15 21:22:48 +03:00
|
|
|
try {
|
|
|
|
$c = $capability();
|
|
|
|
} catch (QueryException $e) {
|
|
|
|
$this->logger->error('CapabilitiesManager: {message}', ['app' => 'core', 'message' => $e->getMessage()]);
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
2015-03-21 22:03:56 +03:00
|
|
|
if ($c instanceof ICapability) {
|
2017-06-30 15:18:16 +03:00
|
|
|
if(!$public || $c instanceof IPublicCapability) {
|
2017-06-30 12:08:04 +03:00
|
|
|
$capabilities = array_replace_recursive($capabilities, $c->getCapabilities());
|
|
|
|
}
|
2015-03-21 22:03:56 +03:00
|
|
|
} else {
|
|
|
|
throw new \InvalidArgumentException('The given Capability (' . get_class($c) . ') does not implement the ICapability interface');
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return $capabilities;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* In order to improve lazy loading a closure can be registered which will be called in case
|
|
|
|
* capabilities are actually requested
|
|
|
|
*
|
|
|
|
* $callable has to return an instance of OCP\Capabilities\ICapability
|
|
|
|
*
|
|
|
|
* @param \Closure $callable
|
|
|
|
*/
|
|
|
|
public function registerCapability(\Closure $callable) {
|
2018-01-13 21:53:31 +03:00
|
|
|
$this->capabilities[] = $callable;
|
2015-03-21 22:03:56 +03:00
|
|
|
}
|
|
|
|
}
|