Added Capabilities Manager

* This should allow the capabilities to be intergrated into the
appframework
* Unit tests
* Throw exception if closure does not return ICapability instance

8 files changed, 354 insertions, 2 deletions

diff --git a/lib/private/capabilitiesmanager.php b/lib/private/capabilitiesmanager.php
new file mode 100644
index 00000000000..ebbd9664897
--- /dev/null
+++ b/lib/private/capabilitiesmanager.php
@@ -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);
+	}
+}
diff --git a/lib/private/ocs/cloud.php b/lib/private/ocs/cloud.php
index f662bde2858..ff6b7977cd9 100644
--- a/lib/private/ocs/cloud.php
+++ b/lib/private/ocs/cloud.php
@@ -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);
 	}
 	
diff --git a/lib/private/server.php b/lib/private/server.php
index 12981fe7f19..2c0793f4c1d 100644
--- a/lib/private/server.php
+++ b/lib/private/server.php
@@ -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');
+	}
 }
diff --git a/lib/public/capabilities/icapability.php b/lib/public/capabilities/icapability.php
new file mode 100644
index 00000000000..71a56128d26
--- /dev/null
+++ b/lib/public/capabilities/icapability.php
@@ -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();
+}
+
diff --git a/lib/public/capabilities/imanager.php b/lib/public/capabilities/imanager.php
new file mode 100644
index 00000000000..df563bd2b25
--- /dev/null
+++ b/lib/public/capabilities/imanager.php
@@ -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);
+}
diff --git a/lib/public/iservercontainer.php b/lib/public/iservercontainer.php
index f3165db33da..6cb8d668658 100644
--- a/lib/public/iservercontainer.php
+++ b/lib/public/iservercontainer.php
@@ -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();
 }
diff --git a/tests/lib/capabilitiesmanager.php b/tests/lib/capabilitiesmanager.php
new file mode 100644
index 00000000000..738715344e0
--- /dev/null
+++ b/tests/lib/capabilitiesmanager.php
@@ -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'
+		];
+	}
+}
diff --git a/tests/lib/server.php b/tests/lib/server.php
index cf0ad8265bf..1eb91173deb 100644
--- a/tests/lib/server.php
+++ b/tests/lib/server.php
@@ -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'],