Adding a second principal backend which holds system principals - as of now only one principals/system/system

3 files changed, 191 insertions, 15 deletions

diff --git a/apps/dav/lib/connector/sabre/principal.php b/apps/dav/lib/connector/sabre/principal.php
index 7852eca61ab..cc9c1c40d59 100644
--- a/apps/dav/lib/connector/sabre/principal.php
+++ b/apps/dav/lib/connector/sabre/principal.php
@@ -74,11 +74,6 @@ class Principal implements \Sabre\DAVACL\PrincipalBackend\BackendInterface {
 			}
 		}
 
-		$principals[] = [
-				'uri' => 'principals/system',
-				'{DAV:}displayname' => 'system',
-		];
-
 		return $principals;
 	}
 
@@ -95,13 +90,6 @@ class Principal implements \Sabre\DAVACL\PrincipalBackend\BackendInterface {
 		if ($elements[0] !== 'principals') {
 			return null;
 		}
-		if ($elements[1] === 'system') {
-			$principal = [
-					'uri' => 'principals/system',
-					'{DAV:}displayname' => 'system',
-			];
-			return $principal;
-		}
 		if ($elements[1] !== 'users') {
 			return null;
 		}
diff --git a/apps/dav/lib/dav/systemprincipalbackend.php b/apps/dav/lib/dav/systemprincipalbackend.php
new file mode 100644
index 00000000000..2c2049ace60
--- /dev/null
+++ b/apps/dav/lib/dav/systemprincipalbackend.php
@@ -0,0 +1,183 @@
+<?php
+/**
+ * @author Thomas Müller <thomas.mueller@tmit.eu>
+ *
+ * @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 OCA\DAV\DAV;
+
+use Sabre\DAVACL\PrincipalBackend\AbstractBackend;
+use Sabre\HTTP\URLUtil;
+
+class SystemPrincipalBackend extends AbstractBackend {
+
+	/**
+	 * Returns a list of principals based on a prefix.
+	 *
+	 * This prefix will often contain something like 'principals'. You are only
+	 * expected to return principals that are in this base path.
+	 *
+	 * You are expected to return at least a 'uri' for every user, you can
+	 * return any additional properties if you wish so. Common properties are:
+	 *   {DAV:}displayname
+	 *   {http://sabredav.org/ns}email-address - This is a custom SabreDAV
+	 *     field that's actually injected in a number of other properties. If
+	 *     you have an email address, use this property.
+	 *
+	 * @param string $prefixPath
+	 * @return array
+	 */
+	function getPrincipalsByPrefix($prefixPath) {
+		$principals = [];
+
+		if ($prefixPath === 'principals/system') {
+			$principals[] = [
+				'uri' => 'principals/system/system',
+				'{DAV:}displayname' => 'system',
+			];
+		}
+
+		return $principals;
+	}
+
+	/**
+	 * Returns a specific principal, specified by it's path.
+	 * The returned structure should be the exact same as from
+	 * getPrincipalsByPrefix.
+	 *
+	 * @param string $path
+	 * @return array
+	 */
+	function getPrincipalByPath($path) {
+
+		$elements = explode('/', $path);
+		if ($elements[0] !== 'principals') {
+			return null;
+		}
+		if ($elements[1] === 'system') {
+			$principal = [
+				'uri' => 'principals/system/system',
+				'{DAV:}displayname' => 'system',
+			];
+			return $principal;
+		}
+
+		return null;
+	}
+
+	/**
+	 * Updates one ore more webdav properties on a principal.
+	 *
+	 * The list of mutations is stored in a Sabre\DAV\PropPatch object.
+	 * To do the actual updates, you must tell this object which properties
+	 * you're going to process with the handle() method.
+	 *
+	 * Calling the handle method is like telling the PropPatch object "I
+	 * promise I can handle updating this property".
+	 *
+	 * Read the PropPatch documentation for more info and examples.
+	 *
+	 * @param string $path
+	 * @param \Sabre\DAV\PropPatch $propPatch
+	 * @return void
+	 */
+	function updatePrincipal($path, \Sabre\DAV\PropPatch $propPatch) {
+	}
+
+	/**
+	 * This method is used to search for principals matching a set of
+	 * properties.
+	 *
+	 * This search is specifically used by RFC3744's principal-property-search
+	 * REPORT.
+	 *
+	 * The actual search should be a unicode-non-case-sensitive search. The
+	 * keys in searchProperties are the WebDAV property names, while the values
+	 * are the property values to search on.
+	 *
+	 * By default, if multiple properties are submitted to this method, the
+	 * various properties should be combined with 'AND'. If $test is set to
+	 * 'anyof', it should be combined using 'OR'.
+	 *
+	 * This method should simply return an array with full principal uri's.
+	 *
+	 * If somebody attempted to search on a property the backend does not
+	 * support, you should simply return 0 results.
+	 *
+	 * You can also just return 0 results if you choose to not support
+	 * searching at all, but keep in mind that this may stop certain features
+	 * from working.
+	 *
+	 * @param string $prefixPath
+	 * @param array $searchProperties
+	 * @param string $test
+	 * @return array
+	 */
+	function searchPrincipals($prefixPath, array $searchProperties, $test = 'allof') {
+		return [];
+	}
+
+	/**
+	 * Returns the list of members for a group-principal
+	 *
+	 * @param string $principal
+	 * @return array
+	 */
+	function getGroupMemberSet($principal) {
+		// TODO: for now the group principal has only one member, the user itself
+		$principal = $this->getPrincipalByPath($principal);
+		if (!$principal) {
+			throw new \Sabre\DAV\Exception('Principal not found');
+		}
+
+		return [$principal['uri']];
+	}
+
+	/**
+	 * Returns the list of groups a principal is a member of
+	 *
+	 * @param string $principal
+	 * @return array
+	 */
+	function getGroupMembership($principal) {
+		list($prefix, $name) = URLUtil::splitPath($principal);
+
+		if ($prefix === 'principals/system') {
+			$principal = $this->getPrincipalByPath($principal);
+			if (!$principal) {
+				throw new \Sabre\DAV\Exception('Principal not found');
+			}
+
+			return [];
+		}
+		return [];
+	}
+
+	/**
+	 * Updates the list of group members for a group principal.
+	 *
+	 * The principals should be passed as a list of uri's.
+	 *
+	 * @param string $principal
+	 * @param array $members
+	 * @return void
+	 */
+	function setGroupMemberSet($principal, array $members) {
+		throw new \Sabre\DAV\Exception('Setting members of the group is not supported yet');
+	}
+}
diff --git a/apps/dav/lib/rootcollection.php b/apps/dav/lib/rootcollection.php
index 3e349fa31c9..11fdc7c9605 100644
--- a/apps/dav/lib/rootcollection.php
+++ b/apps/dav/lib/rootcollection.php
@@ -6,6 +6,7 @@ use OCA\DAV\CalDAV\CalDavBackend;
 use OCA\DAV\CardDAV\AddressBookRoot;
 use OCA\DAV\CardDAV\CardDavBackend;
 use OCA\DAV\Connector\Sabre\Principal;
+use OCA\DAV\DAV\SystemPrincipalBackend;
 use Sabre\CalDAV\CalendarRoot;
 use Sabre\CalDAV\Principal\Collection;
 use Sabre\DAV\SimpleCollection;
@@ -23,8 +24,10 @@ class RootCollection extends SimpleCollection {
 		$disableListing = !$config->getSystemValue('debug', false);
 
 		// setup the first level of the dav tree
-		$principalCollection = new Collection($principalBackend, 'principals/users');
-		$principalCollection->disableListing = $disableListing;
+		$userPrincipals = new Collection($principalBackend, 'principals/users');
+		$userPrincipals->disableListing = $disableListing;
+		$systemPrincipals = new Collection(new SystemPrincipalBackend(), 'principals/system');
+		$systemPrincipals->disableListing = $disableListing;
 		$filesCollection = new Files\RootCollection($principalBackend, 'principals/users');
 		$filesCollection->disableListing = $disableListing;
 		$caldavBackend = new CalDavBackend($db);
@@ -37,7 +40,9 @@ class RootCollection extends SimpleCollection {
 		$addressBookRoot->disableListing = $disableListing;
 
 		$children = [
-				new SimpleCollection('principals', [$principalCollection]),
+				new SimpleCollection('principals', [
+						$userPrincipals,
+						$systemPrincipals]),
 				$filesCollection,
 				$calendarRoot,
 				$addressBookRoot,