summaryrefslogtreecommitdiffstats
path: root/lib/private/connector/sabre/custompropertiesbackend.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/connector/sabre/custompropertiesbackend.php')
-rw-r--r--lib/private/connector/sabre/custompropertiesbackend.php347
1 files changed, 347 insertions, 0 deletions
diff --git a/lib/private/connector/sabre/custompropertiesbackend.php b/lib/private/connector/sabre/custompropertiesbackend.php
new file mode 100644
index 00000000000..eaf13238b63
--- /dev/null
+++ b/lib/private/connector/sabre/custompropertiesbackend.php
@@ -0,0 +1,347 @@
+<?php
+
+/**
+ * ownCloud
+ *
+ * @author Vincent Petry
+ * @copyright 2015 Vincent Petry <pvince81@owncloud.com>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or any later version.
+ *
+ * This library 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 along with this library. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OC\Connector\Sabre;
+
+use \Sabre\DAV\PropFind;
+use \Sabre\DAV\PropPatch;
+use \Sabre\HTTP\RequestInterface;
+use \Sabre\HTTP\ResponseInterface;
+
+class CustomPropertiesBackend implements \Sabre\DAV\PropertyStorage\Backend\BackendInterface {
+
+ /**
+ * Ignored properties
+ *
+ * @var array
+ */
+ private $ignoredProperties = array(
+ '{DAV:}getcontentlength',
+ '{DAV:}getcontenttype',
+ '{DAV:}getetag',
+ '{DAV:}quota-used-bytes',
+ '{DAV:}quota-available-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',
+ );
+
+ /**
+ * @var \Sabre\DAV\Tree
+ */
+ private $tree;
+
+ /**
+ * @var \OCP\IDBConnection
+ */
+ private $connection;
+
+ /**
+ * @var \OCP\IUser
+ */
+ private $user;
+
+ /**
+ * Properties cache
+ *
+ * @var array
+ */
+ private $cache = [];
+
+ /**
+ * @param \Sabre\DAV\Tree $tree node tree
+ * @param \OCP\IDBConnection $connection database connection
+ * @param \OCP\IUser $user owner of the tree and properties
+ */
+ public function __construct(
+ \Sabre\DAV\Tree $tree,
+ \OCP\IDBConnection $connection,
+ \OCP\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) {
+ $node = $this->tree->getNodeForPath($path);
+ if (!($node instanceof \OC\Connector\Sabre\Node)) {
+ return;
+ }
+
+ $requestedProps = $propFind->get404Properties();
+
+ // these might appear
+ $requestedProps = array_diff(
+ $requestedProps,
+ $this->ignoredProperties
+ );
+
+ if (empty($requestedProps)) {
+ return;
+ }
+
+ if ($node instanceof \OC\Connector\Sabre\Directory
+ && $propFind->getDepth() !== 0
+ ) {
+ // note: pre-fetching only supported for depth <= 1
+ $this->loadChildrenProperties($node, $requestedProps);
+ }
+
+ $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 \OC\Connector\Sabre\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 \OC\Connector\Sabre\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(\OC\Connector\Sabre\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 \OC\Connector\Sabre\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 = $this->connection->prepare(
+ 'DELETE FROM `*PREFIX*properties`' .
+ ' WHERE `userid` = ? AND `propertypath` = ? AND `propertyname` = ?'
+ );
+
+ $insertStatement = $this->connection->prepare(
+ 'INSERT INTO `*PREFIX*properties`' .
+ ' (`userid`,`propertypath`,`propertyname`,`propertyvalue`) VALUES(?,?,?,?)'
+ );
+
+ $updateStatement = $this->connection->prepare(
+ '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)) {
+ $deleteStatement->execute(
+ array(
+ $this->user,
+ $path,
+ $propertyName
+ )
+ );
+ $deleteStatement->closeCursor();
+ }
+ } else {
+ if (!array_key_exists($propertyName, $existing)) {
+ $insertStatement->execute(
+ array(
+ $this->user,
+ $path,
+ $propertyName,
+ $propertyValue
+ )
+ );
+ $insertStatement->closeCursor();
+ } else {
+ $updateStatement->execute(
+ array(
+ $propertyValue,
+ $this->user,
+ $path,
+ $propertyName
+ )
+ );
+ $updateStatement->closeCursor();
+ }
+ }
+ }
+
+ $this->connection->commit();
+ unset($this->cache[$path]);
+
+ return true;
+ }
+
+ /**
+ * Bulk load properties for directory children
+ *
+ * @param \OC\Connector\Sabre\Directory $node
+ * @param array $requestedProperties requested properties
+ *
+ * @return void
+ */
+ private function loadChildrenProperties(\OC\Connector\Sabre\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, rtrim($path, '/') . '/%', $requestedProperties),
+ array(null, null, \Doctrine\DBAL\Connection::PARAM_STR_ARRAY)
+ );
+
+ $props = [];
+ $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();
+ }
+
+}
generated by cgit v1.2.3 (git 2.39.1) at 2025-01-31 14:59:17 +0000