upstream/nextcloud
1
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2026-04-15 22:11:17 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 25

Added Capabilities Manager

Browse source 
* This should allow the capabilities to be intergrated into the
appframework
* Unit tests
* Throw exception if closure does not return ICapability instance
This commit is contained in:
Roeland Jago Douma 2015-03-21 20:03:56 +01:00
parent 214729a552
commit 7e6a2b71fd
8 changed files with 354 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

65
lib/private/capabilitiesmanager.php Normal file
View file

@ -0,0 +1,65 @@
<?php
/**
* @author Roeland Jago Douma <roeland@famdouma.nl>
*
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @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/>
*
*/
namespace OC;
use OCP\Capabilities\IManager;
use OCP\Capabilities\ICapability;
class CapabilitiesManager implements IManager {
/**
* @var \Closure[]
*/
private $capabilities = array();
/**
* Get an array of al the capabilities that are registered at this manager
*
* @throws \InvalidArgumentException
* @return array
*/
public function getCapabilities() {
$capabilities = [];
foreach($this->capabilities as $capability) {
$c = $capability();
if ($c instanceof ICapability) {
$capabilities = array_replace_recursive($capabilities, $c->getCapabilities());
} 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) {
array_push($this->capabilities, $callable);
}
}

8
lib/private/ocs/cloud.php
View file

@ -3,6 +3,7 @@
* @author Bart Visscher <bartv@thisnet.nl>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin McCorkell <rmccorkell@karoshi.org.uk>
* @author Roeland Jago Douma <roeland@famdouma.nl>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Tom Needham <tom@owncloud.com>
*
@ -40,8 +41,11 @@ class OC_OCS_Cloud {
'core' => array(
'pollinterval' => OC_Config::getValue('pollinterval', 60),
),
);
);
$result['capabilities'] = array_merge_recursive($result['capabilities'], \OC::$server->getCapabilitiesManager()->getCapabilities());
return new OC_OCS_Result($result);
}

14
lib/private/server.php
View file

@ -59,6 +59,7 @@ use OC\Security\SecureRandom;
use OC\Security\TrustedDomainHelper;
use OC\Tagging\TagMapper;
use OCP\IServerContainer;
use OC\CapabilitiesManager;
/**
* Class Server
@ -449,6 +450,9 @@ class Server extends SimpleContainer implements IServerContainer {
$c->getURLGenerator(),
\OC::$configDir);
});
$this->registerService('CapabilitiesManager', function () {
return new CapabilitiesManager();
});
}
/**
@ -945,4 +949,14 @@ class Server extends SimpleContainer implements IServerContainer {
public function getMimeTypeDetector() {
return $this->query('MimeTypeDetector');
}
/**
* Get the manager of all the capabilities
*
* @return \OCP\Capabilities\IManager
* @since 8.2.0
*/
public function getCapabilitiesManager() {
return $this->query('CapabilitiesManager');
}
}

46
lib/public/capabilities/icapability.php Normal file
View file

@ -0,0 +1,46 @@
<?php
/**
* @author Roeland Jago Douma <roeland@famdouma.nl>
*
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @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/>
*
*/
namespace OCP\Capabilities;
/**
* Minimal interface that has to be implemented for a class to be considered
* a capability.
*
* In an application use:
* $this->getContainer()->registerCapability('OCA\MY_APP\Capabilities');
* To register capabilities.
*
* The class 'OCA\MY_APP\Capabilities' must then implement ICapability
*
* @since 8.2.0
*/
interface ICapability {
/**
* Function an app uses to return the capabilities
*
* @return array Array containing the apps capabilities
* @since 8.2.0
*/
public function getCapabilities();
}

44
lib/public/capabilities/imanager.php Normal file
View file

@ -0,0 +1,44 @@
<?php
/**
* @author Roeland Jago Douma <roeland@famdouma.nl>
*
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @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/>
*
*/
namespace OCP\Capabilities;
interface IManager {
/**
* Get an array of al the capabilities that are registered at this manager
*
* @return array All the capabilities registered in this manager
* @since 8.2.0
*/
public function getCapabilities();
/**
* In order to improve lazy loading a closure can be registered which will be called in case
* activity consumers are actually requested
*
* $callable has to return an instance of OCP\Capabilities\ICapability
*
* @param \Closure $callable
* @since 8.2.0
*/
public function registerCapability(\Closure $callable);
}

8
lib/public/iservercontainer.php
View file

@ -438,4 +438,12 @@ interface IServerContainer {
* @since 8.2.0
*/
public function getMimeTypeDetector();
/**
* Get the manager of all the capabilities
*
* @return \OCP\Capabilities\IManager
* @since 8.2.0
*/
public function getCapabilitiesManager();
}

167
tests/lib/capabilitiesmanager.php Normal file
View file

@ -0,0 +1,167 @@
<?php
/**
* @author Roeland Jago Douma <roeland@famdouma.nl>
*
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @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/>
*
*/
namespace Test;
use OC\CapabilitiesManager;
class CapabilitiesManagerTest extends TestCase {
/**
* Test no capabilities
*/
public function testNoCapabilities() {
$manager = new \OC\CapabilitiesManager();
$res = $manager->getCapabilities();
$this->assertEmpty($res);
}
/**
* Test a valid capabilitie
*/
public function testValidCapability() {
$manager = new \OC\CapabilitiesManager();
$manager->registerCapability(function() {
return new SimpleCapability();
});
$res = $manager->getCapabilities();
$this->assertEquals(['foo' => 1], $res);
}
/**
* Test that we need something that implents ICapability
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage The given Capability (Test\NoCapability) does not implement the ICapability interface
*/
public function testNoICapability() {
$manager = new \OC\CapabilitiesManager();
$manager->registerCapability(function() {
return new NoCapability();
});
$res = $manager->getCapabilities();
$this->assertEquals([], $res);
}
/**
* Test a bunch of merged Capabilities
*/
public function testMergedCapabilities() {
$manager = new \OC\CapabilitiesManager();
$simple1 = new SimpleCapability();
$simple2 = new SimpleCapability2();
$simple3 = new SimpleCapability3();
$manager->registerCapability(function() use ($simple1) {
return $simple1;
});
$manager->registerCapability(function() use ($simple2) {
return $simple2;
});
$manager->registerCapability(function() use ($simple3) {
return $simple3;
});
$res = $manager->getCapabilities();
$expected = [
'foo' => 1,
'bar' => [
'x' => 1,
'y' => 2
]
];
$this->assertEquals($expected, $res);
}
/**
* Test deep identical capabilities
*/
public function testDeepIdenticalCapabilities() {
$manager = new \OC\CapabilitiesManager();
$manager->registerCapability(function() {
return new DeepCapability();
});
$manager->registerCapability(function() {
return new DeepCapability();
});
$res = $manager->getCapabilities();
$expected = [
'foo' => [
'bar' => [
'baz' => true
]
]
];
$this->assertEquals($expected, $res);
}
}
class SimpleCapability implements \OCP\Capabilities\ICapability {
public function getCapabilities() {
return [
'foo' => 1
];
}
}
class SimpleCapability2 implements \OCP\Capabilities\ICapability {
public function getCapabilities() {
return [
'bar' => ['x' => 1]
];
}
}
class SimpleCapability3 implements \OCP\Capabilities\ICapability {
public function getCapabilities() {
return [
'bar' => ['y' => 2]
];
}
}
class DeepCapability implements \OCP\Capabilities\ICapability {
public function getCapabilities() {
return [
'foo' => [
'bar' => [
'baz' => true
]
]
];
}
}
class NoCapability {
public function getCapabilities() {
return [
'baz' => 'z'
];
}
}

4
tests/lib/server.php
View file

@ -1,6 +1,9 @@
<?php
/**
* @author Joas Schilling <nickvergessen@owncloud.com>
* @author Lukas Reschke <lukas@owncloud.com>
* @author Roeland Jago Douma <roeland@famdouma.nl>
* @author Thomas Müller <thomas.mueller@tmit.eu>
*
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @license AGPL-3.0
@ -48,6 +51,7 @@ class Server extends \Test\TestCase {
['AvatarManager', '\OC\AvatarManager'],
['AvatarManager', '\OCP\IAvatarManager'],
['CapabilitiesManager', '\OCP\Capabilities\IManager'],
['ContactsManager', '\OC\ContactsManager'],
['ContactsManager', '\OCP\Contacts\IManager'],
['Crypto', '\OC\Security\Crypto'],