From a5164eef3517c3ba8026592740af3de27970e1bc Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Fri, 31 Jan 2020 15:06:26 +0100 Subject: [PATCH] merge the two almost identical custom property backends Signed-off-by: Robin Appelman --- .../Sabre/CustomPropertiesBackend.php | 350 ------------------ .../dav/lib/Connector/Sabre/ServerFactory.php | 2 +- apps/dav/lib/DAV/CustomPropertiesBackend.php | 118 +++++- .../Sabre/CustomPropertiesBackendTest.php | 4 +- .../unit/DAV/CustomPropertiesBackendTest.php | 38 +- 5 files changed, 136 insertions(+), 376 deletions(-) delete mode 100644 apps/dav/lib/Connector/Sabre/CustomPropertiesBackend.php diff --git a/apps/dav/lib/Connector/Sabre/CustomPropertiesBackend.php b/apps/dav/lib/Connector/Sabre/CustomPropertiesBackend.php deleted file mode 100644 index f3f685a8b9..0000000000 --- a/apps/dav/lib/Connector/Sabre/CustomPropertiesBackend.php +++ /dev/null @@ -1,350 +0,0 @@ - - * @author Lukas Reschke - * @author Thomas Müller - * @author Vincent Petry - * - * @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 - * - */ - -namespace OCA\DAV\Connector\Sabre; - -use OCP\IDBConnection; -use OCP\IUser; -use Sabre\DAV\PropertyStorage\Backend\BackendInterface; -use Sabre\DAV\PropFind; -use Sabre\DAV\PropPatch; -use Sabre\DAV\Tree; -use Sabre\DAV\Exception\NotFound; -use Sabre\DAV\Exception\ServiceUnavailable; - -class CustomPropertiesBackend implements BackendInterface { - - /** - * Ignored properties - * - * @var array - */ - private $ignoredProperties = array( - '{DAV:}getcontentlength', - '{DAV:}getcontenttype', - '{DAV:}getetag', - '{DAV:}quota-used-bytes', - '{DAV:}quota-available-bytes', - '{http://owncloud.org/ns}permissions', - '{http://owncloud.org/ns}downloadURL', - '{http://owncloud.org/ns}dDC', - '{http://owncloud.org/ns}size', - '{http://nextcloud.org/ns}is-encrypted', - ); - - /** - * @var Tree - */ - private $tree; - - /** - * @var IDBConnection - */ - private $connection; - - /** - * @var IUser - */ - private $user; - - /** - * Properties cache - * - * @var array - */ - private $cache = []; - - /** - * @param Tree $tree node tree - * @param IDBConnection $connection database connection - * @param IUser $user owner of the tree and properties - */ - public function __construct( - Tree $tree, - IDBConnection $connection, - IUser $user) { - $this->tree = $tree; - $this->connection = $connection; - $this->user = $user->getUID(); - } - - /** - * Fetches properties for a path. - * - * @param string $path - * @param PropFind $propFind - * @return void - */ - public function propFind($path, PropFind $propFind) { - try { - $node = $this->tree->getNodeForPath($path); - if (!($node instanceof Node)) { - return; - } - } catch (ServiceUnavailable $e) { - // might happen for unavailable mount points, skip - return; - } catch (NotFound $e) { - // in some rare (buggy) cases the node might not be found, - // we catch the exception to prevent breaking the whole list with a 404 - // (soft fail) - \OC::$server->getLogger()->warning( - 'Could not get node for path: \"' . $path . '\" : ' . $e->getMessage(), - array('app' => 'files') - ); - return; - } - - $requestedProps = $propFind->get404Properties(); - - // these might appear - $requestedProps = array_diff( - $requestedProps, - $this->ignoredProperties - ); - - if (empty($requestedProps)) { - return; - } - - $props = $this->getProperties($node, $requestedProps); - foreach ($props as $propName => $propValue) { - $propFind->set($propName, $propValue); - } - } - - /** - * Updates properties for a path - * - * @param string $path - * @param PropPatch $propPatch - * - * @return void - */ - public function propPatch($path, PropPatch $propPatch) { - $node = $this->tree->getNodeForPath($path); - if (!($node instanceof Node)) { - return; - } - - $propPatch->handleRemaining(function($changedProps) use ($node) { - return $this->updateProperties($node, $changedProps); - }); - } - - /** - * This method is called after a node is deleted. - * - * @param string $path path of node for which to delete properties - */ - public function delete($path) { - $statement = $this->connection->prepare( - 'DELETE FROM `*PREFIX*properties` WHERE `userid` = ? AND `propertypath` = ?' - ); - $statement->execute(array($this->user, '/' . $path)); - $statement->closeCursor(); - - unset($this->cache[$path]); - } - - /** - * This method is called after a successful MOVE - * - * @param string $source - * @param string $destination - * - * @return void - */ - public function move($source, $destination) { - $statement = $this->connection->prepare( - 'UPDATE `*PREFIX*properties` SET `propertypath` = ?' . - ' WHERE `userid` = ? AND `propertypath` = ?' - ); - $statement->execute(array('/' . $destination, $this->user, '/' . $source)); - $statement->closeCursor(); - } - - /** - * Returns a list of properties for this nodes.; - * @param Node $node - * @param array $requestedProperties requested properties or empty array for "all" - * @return array - * @note The properties list is a list of propertynames the client - * requested, encoded as xmlnamespace#tagName, for example: - * http://www.example.org/namespace#author If the array is empty, all - * properties should be returned - */ - private function getProperties(Node $node, array $requestedProperties) { - $path = $node->getPath(); - if (isset($this->cache[$path])) { - return $this->cache[$path]; - } - - // TODO: chunking if more than 1000 properties - $sql = 'SELECT * FROM `*PREFIX*properties` WHERE `userid` = ? AND `propertypath` = ?'; - - $whereValues = array($this->user, $path); - $whereTypes = array(null, null); - - if (!empty($requestedProperties)) { - // request only a subset - $sql .= ' AND `propertyname` in (?)'; - $whereValues[] = $requestedProperties; - $whereTypes[] = \Doctrine\DBAL\Connection::PARAM_STR_ARRAY; - } - - $result = $this->connection->executeQuery( - $sql, - $whereValues, - $whereTypes - ); - - $props = []; - while ($row = $result->fetch()) { - $props[$row['propertyname']] = $row['propertyvalue']; - } - - $result->closeCursor(); - - $this->cache[$path] = $props; - return $props; - } - - /** - * Update properties - * - * @param Node $node node for which to update properties - * @param array $properties array of properties to update - * - * @return bool - */ - private function updateProperties($node, $properties) { - $path = $node->getPath(); - - $deleteStatement = 'DELETE FROM `*PREFIX*properties`' . - ' WHERE `userid` = ? AND `propertypath` = ? AND `propertyname` = ?'; - - $insertStatement = 'INSERT INTO `*PREFIX*properties`' . - ' (`userid`,`propertypath`,`propertyname`,`propertyvalue`) VALUES(?,?,?,?)'; - - $updateStatement = 'UPDATE `*PREFIX*properties` SET `propertyvalue` = ?' . - ' WHERE `userid` = ? AND `propertypath` = ? AND `propertyname` = ?'; - - // TODO: use "insert or update" strategy ? - $existing = $this->getProperties($node, array()); - $this->connection->beginTransaction(); - foreach ($properties as $propertyName => $propertyValue) { - // If it was null, we need to delete the property - if (is_null($propertyValue)) { - if (array_key_exists($propertyName, $existing)) { - $this->connection->executeUpdate($deleteStatement, - array( - $this->user, - $path, - $propertyName - ) - ); - } - } else { - if (!array_key_exists($propertyName, $existing)) { - $this->connection->executeUpdate($insertStatement, - array( - $this->user, - $path, - $propertyName, - $propertyValue - ) - ); - } else { - $this->connection->executeUpdate($updateStatement, - array( - $propertyValue, - $this->user, - $path, - $propertyName - ) - ); - } - } - } - - $this->connection->commit(); - unset($this->cache[$path]); - - return true; - } - - /** - * Bulk load properties for directory children - * - * @param Directory $node - * @param array $requestedProperties requested properties - * - * @return void - */ - private function loadChildrenProperties(Directory $node, $requestedProperties) { - $path = $node->getPath(); - if (isset($this->cache[$path])) { - // we already loaded them at some point - return; - } - - $childNodes = $node->getChildren(); - // pre-fill cache - foreach ($childNodes as $childNode) { - $this->cache[$childNode->getPath()] = []; - } - - $sql = 'SELECT * FROM `*PREFIX*properties` WHERE `userid` = ? AND `propertypath` LIKE ?'; - $sql .= ' AND `propertyname` in (?) ORDER BY `propertypath`, `propertyname`'; - - $result = $this->connection->executeQuery( - $sql, - array($this->user, $this->connection->escapeLikeParameter(rtrim($path, '/')) . '/%', $requestedProperties), - array(null, null, \Doctrine\DBAL\Connection::PARAM_STR_ARRAY) - ); - - $oldPath = null; - $props = []; - while ($row = $result->fetch()) { - $path = $row['propertypath']; - if ($oldPath !== $path) { - // save previously gathered props - $this->cache[$oldPath] = $props; - $oldPath = $path; - // prepare props for next path - $props = []; - } - $props[$row['propertyname']] = $row['propertyvalue']; - } - if (!is_null($oldPath)) { - // save props from last run - $this->cache[$oldPath] = $props; - } - - $result->closeCursor(); - } - -} diff --git a/apps/dav/lib/Connector/Sabre/ServerFactory.php b/apps/dav/lib/Connector/Sabre/ServerFactory.php index 1821638189..03b72b41e3 100644 --- a/apps/dav/lib/Connector/Sabre/ServerFactory.php +++ b/apps/dav/lib/Connector/Sabre/ServerFactory.php @@ -186,7 +186,7 @@ class ServerFactory { // custom properties plugin must be the last one $server->addPlugin( new \Sabre\DAV\PropertyStorage\Plugin( - new \OCA\DAV\Connector\Sabre\CustomPropertiesBackend( + new \OCA\DAV\DAV\CustomPropertiesBackend( $objectTree, $this->databaseConnection, $this->userSession->getUser() diff --git a/apps/dav/lib/DAV/CustomPropertiesBackend.php b/apps/dav/lib/DAV/CustomPropertiesBackend.php index 99a9f4e0b8..147aba1736 100644 --- a/apps/dav/lib/DAV/CustomPropertiesBackend.php +++ b/apps/dav/lib/DAV/CustomPropertiesBackend.php @@ -3,9 +3,11 @@ * @copyright Copyright (c) 2016, ownCloud, Inc. * @copyright Copyright (c) 2017, Georg Ehrke * - * @author Georg Ehrke - * @author Robin Appelman + * @author Aaron Wood + * @author Lukas Reschke + * @author Roeland Jago Douma * @author Thomas Müller + * @author Vincent Petry * * @license AGPL-3.0 * @@ -25,8 +27,12 @@ namespace OCA\DAV\DAV; +use OCA\DAV\Connector\Sabre\Directory; +use OCA\DAV\Connector\Sabre\Node; use OCP\IDBConnection; use OCP\IUser; +use Sabre\DAV\Exception\NotFound; +use Sabre\DAV\Exception\ServiceUnavailable; use Sabre\DAV\PropertyStorage\Backend\BackendInterface; use Sabre\DAV\PropFind; use Sabre\DAV\PropPatch; @@ -63,7 +69,7 @@ class CustomPropertiesBackend implements BackendInterface { private $connection; /** - * @var string + * @var IUser */ private $user; @@ -85,7 +91,7 @@ class CustomPropertiesBackend implements BackendInterface { IUser $user) { $this->tree = $tree; $this->connection = $connection; - $this->user = $user->getUID(); + $this->user = $user; } /** @@ -96,6 +102,24 @@ class CustomPropertiesBackend implements BackendInterface { * @return void */ public function propFind($path, PropFind $propFind) { + try { + $node = $this->tree->getNodeForPath($path); + if (!($node instanceof Node)) { + return; + } + } catch (ServiceUnavailable $e) { + // might happen for unavailable mount points, skip + return; + } catch (NotFound $e) { + // in some rare (buggy) cases the node might not be found, + // we catch the exception to prevent breaking the whole list with a 404 + // (soft fail) + \OC::$server->getLogger()->warning( + 'Could not get node for path: \"' . $path . '\" : ' . $e->getMessage(), + array('app' => 'files') + ); + return; + } $requestedProps = $propFind->get404Properties(); @@ -129,7 +153,7 @@ class CustomPropertiesBackend implements BackendInterface { return; } - $props = $this->getProperties($path, $requestedProps); + $props = $this->getProperties($node, $requestedProps); foreach ($props as $propName => $propValue) { $propFind->set($propName, $propValue); } @@ -144,8 +168,13 @@ class CustomPropertiesBackend implements BackendInterface { * @return void */ public function propPatch($path, PropPatch $propPatch) { - $propPatch->handleRemaining(function($changedProps) use ($path) { - return $this->updateProperties($path, $changedProps); + $node = $this->tree->getNodeForPath($path); + if (!($node instanceof Node)) { + return; + } + + $propPatch->handleRemaining(function($changedProps) use ($node) { + return $this->updateProperties($node, $changedProps); }); } @@ -158,7 +187,7 @@ class CustomPropertiesBackend implements BackendInterface { $statement = $this->connection->prepare( 'DELETE FROM `*PREFIX*properties` WHERE `userid` = ? AND `propertypath` = ?' ); - $statement->execute(array($this->user, $path)); + $statement->execute(array($this->user->getUID(), $path)); $statement->closeCursor(); unset($this->cache[$path]); @@ -177,13 +206,13 @@ class CustomPropertiesBackend implements BackendInterface { 'UPDATE `*PREFIX*properties` SET `propertypath` = ?' . ' WHERE `userid` = ? AND `propertypath` = ?' ); - $statement->execute(array($destination, $this->user, $source)); + $statement->execute(array($destination, $this->user->getUID(), $source)); $statement->closeCursor(); } /** * Returns a list of properties for this nodes.; - * @param string $path + * @param Node $node * @param array $requestedProperties requested properties or empty array for "all" * @return array * @note The properties list is a list of propertynames the client @@ -191,7 +220,8 @@ class CustomPropertiesBackend implements BackendInterface { * http://www.example.org/namespace#author If the array is empty, all * properties should be returned */ - private function getProperties($path, array $requestedProperties) { + private function getProperties(Node $node, array $requestedProperties) { + $path = $node->getPath(); if (isset($this->cache[$path])) { return $this->cache[$path]; } @@ -199,7 +229,7 @@ class CustomPropertiesBackend implements BackendInterface { // TODO: chunking if more than 1000 properties $sql = 'SELECT * FROM `*PREFIX*properties` WHERE `userid` = ? AND `propertypath` = ?'; - $whereValues = array($this->user, $path); + $whereValues = array($this->user->getUID(), $path); $whereTypes = array(null, null); if (!empty($requestedProperties)) { @@ -229,12 +259,13 @@ class CustomPropertiesBackend implements BackendInterface { /** * Update properties * - * @param string $path node for which to update properties + * @param Node $node node for which to update properties * @param array $properties array of properties to update * * @return bool */ - private function updateProperties($path, $properties) { + private function updateProperties($node, $properties) { + $path = $node->getPath(); $deleteStatement = 'DELETE FROM `*PREFIX*properties`' . ' WHERE `userid` = ? AND `propertypath` = ? AND `propertyname` = ?'; @@ -246,7 +277,7 @@ class CustomPropertiesBackend implements BackendInterface { ' WHERE `userid` = ? AND `propertypath` = ? AND `propertyname` = ?'; // TODO: use "insert or update" strategy ? - $existing = $this->getProperties($path, array()); + $existing = $this->getProperties($node, array()); $this->connection->beginTransaction(); foreach ($properties as $propertyName => $propertyValue) { // If it was null, we need to delete the property @@ -254,7 +285,7 @@ class CustomPropertiesBackend implements BackendInterface { if (array_key_exists($propertyName, $existing)) { $this->connection->executeUpdate($deleteStatement, array( - $this->user, + $this->user->getUID(), $path, $propertyName ) @@ -264,7 +295,7 @@ class CustomPropertiesBackend implements BackendInterface { if (!array_key_exists($propertyName, $existing)) { $this->connection->executeUpdate($insertStatement, array( - $this->user, + $this->user->getUID(), $path, $propertyName, $propertyValue @@ -274,7 +305,7 @@ class CustomPropertiesBackend implements BackendInterface { $this->connection->executeUpdate($updateStatement, array( $propertyValue, - $this->user, + $this->user->getUID(), $path, $propertyName ) @@ -289,4 +320,55 @@ class CustomPropertiesBackend implements BackendInterface { return true; } + /** + * Bulk load properties for directory children + * + * @param Directory $node + * @param array $requestedProperties requested properties + * + * @return void + */ + private function loadChildrenProperties(Directory $node, $requestedProperties) { + $path = $node->getPath(); + if (isset($this->cache[$path])) { + // we already loaded them at some point + return; + } + + $childNodes = $node->getChildren(); + // pre-fill cache + foreach ($childNodes as $childNode) { + $this->cache[$childNode->getPath()] = []; + } + + $sql = 'SELECT * FROM `*PREFIX*properties` WHERE `userid` = ? AND `propertypath` LIKE ?'; + $sql .= ' AND `propertyname` in (?) ORDER BY `propertypath`, `propertyname`'; + + $result = $this->connection->executeQuery( + $sql, + array($this->user->getUID(), $this->connection->escapeLikeParameter(rtrim($path, '/')) . '/%', $requestedProperties), + array(null, null, \Doctrine\DBAL\Connection::PARAM_STR_ARRAY) + ); + + $oldPath = null; + $props = []; + while ($row = $result->fetch()) { + $path = $row['propertypath']; + if ($oldPath !== $path) { + // save previously gathered props + $this->cache[$oldPath] = $props; + $oldPath = $path; + // prepare props for next path + $props = []; + } + $props[$row['propertyname']] = $row['propertyvalue']; + } + if (!is_null($oldPath)) { + // save props from last run + $this->cache[$oldPath] = $props; + } + + $result->closeCursor(); + } + } diff --git a/apps/dav/tests/unit/Connector/Sabre/CustomPropertiesBackendTest.php b/apps/dav/tests/unit/Connector/Sabre/CustomPropertiesBackendTest.php index 3b7bd859b9..7b0c9b81e0 100644 --- a/apps/dav/tests/unit/Connector/Sabre/CustomPropertiesBackendTest.php +++ b/apps/dav/tests/unit/Connector/Sabre/CustomPropertiesBackendTest.php @@ -57,7 +57,7 @@ class CustomPropertiesBackendTest extends \Test\TestCase { private $tree; /** - * @var \OCA\DAV\Connector\Sabre\CustomPropertiesBackend + * @var \OCA\DAV\DAV\CustomPropertiesBackend */ private $plugin; @@ -82,7 +82,7 @@ class CustomPropertiesBackendTest extends \Test\TestCase { ->method('getUID') ->will($this->returnValue($userId)); - $this->plugin = new \OCA\DAV\Connector\Sabre\CustomPropertiesBackend( + $this->plugin = new \OCA\DAV\DAV\CustomPropertiesBackend( $this->tree, \OC::$server->getDatabaseConnection(), $this->user diff --git a/apps/dav/tests/unit/DAV/CustomPropertiesBackendTest.php b/apps/dav/tests/unit/DAV/CustomPropertiesBackendTest.php index 780324abaa..6f69f92e67 100644 --- a/apps/dav/tests/unit/DAV/CustomPropertiesBackendTest.php +++ b/apps/dav/tests/unit/DAV/CustomPropertiesBackendTest.php @@ -22,9 +22,11 @@ */ namespace OCA\DAV\Tests\DAV; +use OCA\DAV\Connector\Sabre\Node; use OCA\DAV\DAV\CustomPropertiesBackend; use OCP\IDBConnection; use OCP\IUser; +use Sabre\DAV\Exception\NotFound; use Sabre\DAV\PropFind; use Sabre\DAV\PropPatch; use Sabre\DAV\Tree; @@ -44,19 +46,42 @@ class CustomPropertiesBackendTest extends TestCase { /** @var CustomPropertiesBackend | \PHPUnit_Framework_MockObject_MockObject */ private $backend; - public function setUp() { + /** @var (Node | \PHPUnit_Framework_MockObject_MockObject)[] */ + private $nodes = []; + + protected function setUp() { parent::setUp(); $this->tree = $this->createMock(Tree::class); $this->dbConnection = $this->createMock(IDBConnection::class); $this->user = $this->createMock(IUser::class); - $this->user->expects($this->once()) - ->method('getUID') + $this->user->method('getUID') ->with() ->will($this->returnValue('dummy_user_42')); $this->backend = new CustomPropertiesBackend($this->tree, $this->dbConnection, $this->user); + + $this->tree->method('getNodeForPath') + ->willReturnCallback(function ($path) { + if (isset($this->nodes[$path])) { + return $this->nodes[$path]; + } else { + throw new NotFound(); + } + }); + } + + /** + * @param string $path + * @return Node|\PHPUnit\Framework\MockObject\MockObject + */ + private function addNode($path) { + $node = $this->createMock(Node::class); + $node->method('getPath') + ->willReturn($path); + $this->nodes[$path] = $node; + return $node; } public function testPropFindNoDbCalls() { @@ -74,6 +99,7 @@ class CustomPropertiesBackendTest extends TestCase { $this->dbConnection->expects($this->never()) ->method($this->anything()); + $this->addNode('foo_bar_path_1337_0'); $this->backend->propFind('foo_bar_path_1337_0', $propFind); } @@ -86,7 +112,7 @@ class CustomPropertiesBackendTest extends TestCase { '{DAV:}getcontentlength', '{DAV:}getcontenttype', '{DAV:}getetag', - '{abc}def' + '{abc}def', ])); $propFind->expects($this->at(1)) @@ -99,7 +125,7 @@ class CustomPropertiesBackendTest extends TestCase { '{DAV:}displayname', '{urn:ietf:params:xml:ns:caldav}calendar-description', '{urn:ietf:params:xml:ns:caldav}calendar-timezone', - '{abc}def' + '{abc}def', ])); $statement = $this->createMock('\Doctrine\DBAL\Driver\Statement'); @@ -114,6 +140,7 @@ class CustomPropertiesBackendTest extends TestCase { [null, null, 102]) ->will($this->returnValue($statement)); + $this->addNode('calendars/foo/bar_path_1337_0'); $this->backend->propFind('calendars/foo/bar_path_1337_0', $propFind); } @@ -121,6 +148,7 @@ class CustomPropertiesBackendTest extends TestCase { * @dataProvider propPatchProvider */ public function testPropPatch($path, $propPatch) { + $this->addNode($path); $propPatch->expects($this->once()) ->method('handleRemaining');