nextcloud / server

apps/dav/lib/DAV/CustomPropertiesBackend.php

Indentation +309 added lines, -309 removed lines

@@ -35,313 +35,313 @@
 
 class CustomPropertiesBackend implements BackendInterface {
 
-	/** @var string */
-	private const TABLE_NAME = 'properties';
-
-	/**
-	 * Ignored properties
-	 *
-	 * @var string[]
-	 */
-	private const IGNORED_PROPERTIES = [
-		'{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',
-	];
-
-	/**
-	 * Properties set by one user, readable by all others
-	 *
-	 * @var array[]
-	 */
-	private const PUBLISHED_READ_ONLY_PROPERTIES = [
-		'{urn:ietf:params:xml:ns:caldav}calendar-availability',
-	];
-
-	/**
-	 * @var Tree
-	 */
-	private $tree;
-
-	/**
-	 * @var IDBConnection
-	 */
-	private $connection;
-
-	/**
-	 * @var IUser
-	 */
-	private $user;
-
-	/**
-	 * Properties cache
-	 *
-	 * @var array
-	 */
-	private $userCache = [];
-
-	/**
-	 * @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;
-	}
-
-	/**
-	 * Fetches properties for a path.
-	 *
-	 * @param string $path
-	 * @param PropFind $propFind
-	 * @return void
-	 */
-	public function propFind($path, PropFind $propFind) {
-		$requestedProps = $propFind->get404Properties();
-
-		// these might appear
-		$requestedProps = array_diff(
-			$requestedProps,
-			self::IGNORED_PROPERTIES
-		);
-
-		// substr of calendars/ => path is inside the CalDAV component
-		// two '/' => this a calendar (no calendar-home nor calendar object)
-		if (substr($path, 0, 10) === 'calendars/' && substr_count($path, '/') === 2) {
-			$allRequestedProps = $propFind->getRequestedProperties();
-			$customPropertiesForShares = [
-				'{DAV:}displayname',
-				'{urn:ietf:params:xml:ns:caldav}calendar-description',
-				'{urn:ietf:params:xml:ns:caldav}calendar-timezone',
-				'{http://apple.com/ns/ical/}calendar-order',
-				'{http://apple.com/ns/ical/}calendar-color',
-				'{urn:ietf:params:xml:ns:caldav}schedule-calendar-transp',
-			];
-
-			foreach ($customPropertiesForShares as $customPropertyForShares) {
-				if (in_array($customPropertyForShares, $allRequestedProps)) {
-					$requestedProps[] = $customPropertyForShares;
-				}
-			}
-		}
-
-		if (empty($requestedProps)) {
-			return;
-		}
-
-		// First fetch the published properties (set by another user), then get the ones set by
-		// the current user. If both are set then the latter as priority.
-		foreach ($this->getPublishedProperties($path, $requestedProps) as $propName => $propValue) {
-			$propFind->set($propName, $propValue);
-		}
-		foreach ($this->getUserProperties($path, $requestedProps) 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) {
-		$propPatch->handleRemaining(function ($changedProps) use ($path) {
-			return $this->updateProperties($path, $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([$this->user->getUID(), $this->formatPath($path)]);
-		$statement->closeCursor();
-
-		unset($this->userCache[$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([$this->formatPath($destination), $this->user->getUID(), $this->formatPath($source)]);
-		$statement->closeCursor();
-	}
-
-	/**
-	 * @param string $path
-	 * @param string[] $requestedProperties
-	 *
-	 * @return array
-	 */
-	private function getPublishedProperties(string $path, array $requestedProperties): array {
-		$allowedProps = array_intersect(self::PUBLISHED_READ_ONLY_PROPERTIES, $requestedProperties);
-
-		if (empty($allowedProps)) {
-			return [];
-		}
-
-		$qb = $this->connection->getQueryBuilder();
-		$qb->select('*')
-			->from(self::TABLE_NAME)
-			->where($qb->expr()->eq('propertypath', $qb->createNamedParameter($path)));
-		$result = $qb->executeQuery();
-		$props = [];
-		while ($row = $result->fetch()) {
-			$props[$row['propertyname']] = $row['propertyvalue'];
-		}
-		$result->closeCursor();
-		return $props;
-	}
-
-	/**
-	 * Returns a list of properties for the given path and current user
-	 *
-	 * @param string $path
-	 * @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 getUserProperties(string $path, array $requestedProperties) {
-		if (isset($this->userCache[$path])) {
-			return $this->userCache[$path];
-		}
-
-		// TODO: chunking if more than 1000 properties
-		$sql = 'SELECT * FROM `*PREFIX*properties` WHERE `userid` = ? AND `propertypath` = ?';
-
-		$whereValues = [$this->user->getUID(), $this->formatPath($path)];
-		$whereTypes = [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->userCache[$path] = $props;
-		return $props;
-	}
-
-	/**
-	 * Update properties
-	 *
-	 * @param string $path path for which to update properties
-	 * @param array $properties array of properties to update
-	 *
-	 * @return bool
-	 */
-	private function updateProperties(string $path, array $properties) {
-		$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->getUserProperties($path, []);
-		$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,
-						[
-							$this->user->getUID(),
-							$this->formatPath($path),
-							$propertyName,
-						]
-					);
-				}
-			} else {
-				if (!array_key_exists($propertyName, $existing)) {
-					$this->connection->executeUpdate($insertStatement,
-						[
-							$this->user->getUID(),
-							$this->formatPath($path),
-							$propertyName,
-							$propertyValue,
-						]
-					);
-				} else {
-					$this->connection->executeUpdate($updateStatement,
-						[
-							$propertyValue,
-							$this->user->getUID(),
-							$this->formatPath($path),
-							$propertyName,
-						]
-					);
-				}
-			}
-		}
-
-		$this->connection->commit();
-		unset($this->userCache[$path]);
-
-		return true;
-	}
-
-	/**
-	 * long paths are hashed to ensure they fit in the database
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	private function formatPath(string $path): string {
-		if (strlen($path) > 250) {
-			return sha1($path);
-		} else {
-			return $path;
-		}
-	}
+    /** @var string */
+    private const TABLE_NAME = 'properties';
+
+    /**
+     * Ignored properties
+     *
+     * @var string[]
+     */
+    private const IGNORED_PROPERTIES = [
+        '{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',
+    ];
+
+    /**
+     * Properties set by one user, readable by all others
+     *
+     * @var array[]
+     */
+    private const PUBLISHED_READ_ONLY_PROPERTIES = [
+        '{urn:ietf:params:xml:ns:caldav}calendar-availability',
+    ];
+
+    /**
+     * @var Tree
+     */
+    private $tree;
+
+    /**
+     * @var IDBConnection
+     */
+    private $connection;
+
+    /**
+     * @var IUser
+     */
+    private $user;
+
+    /**
+     * Properties cache
+     *
+     * @var array
+     */
+    private $userCache = [];
+
+    /**
+     * @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;
+    }
+
+    /**
+     * Fetches properties for a path.
+     *
+     * @param string $path
+     * @param PropFind $propFind
+     * @return void
+     */
+    public function propFind($path, PropFind $propFind) {
+        $requestedProps = $propFind->get404Properties();
+
+        // these might appear
+        $requestedProps = array_diff(
+            $requestedProps,
+            self::IGNORED_PROPERTIES
+        );
+
+        // substr of calendars/ => path is inside the CalDAV component
+        // two '/' => this a calendar (no calendar-home nor calendar object)
+        if (substr($path, 0, 10) === 'calendars/' && substr_count($path, '/') === 2) {
+            $allRequestedProps = $propFind->getRequestedProperties();
+            $customPropertiesForShares = [
+                '{DAV:}displayname',
+                '{urn:ietf:params:xml:ns:caldav}calendar-description',
+                '{urn:ietf:params:xml:ns:caldav}calendar-timezone',
+                '{http://apple.com/ns/ical/}calendar-order',
+                '{http://apple.com/ns/ical/}calendar-color',
+                '{urn:ietf:params:xml:ns:caldav}schedule-calendar-transp',
+            ];
+
+            foreach ($customPropertiesForShares as $customPropertyForShares) {
+                if (in_array($customPropertyForShares, $allRequestedProps)) {
+                    $requestedProps[] = $customPropertyForShares;
+                }
+            }
+        }
+
+        if (empty($requestedProps)) {
+            return;
+        }
+
+        // First fetch the published properties (set by another user), then get the ones set by
+        // the current user. If both are set then the latter as priority.
+        foreach ($this->getPublishedProperties($path, $requestedProps) as $propName => $propValue) {
+            $propFind->set($propName, $propValue);
+        }
+        foreach ($this->getUserProperties($path, $requestedProps) 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) {
+        $propPatch->handleRemaining(function ($changedProps) use ($path) {
+            return $this->updateProperties($path, $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([$this->user->getUID(), $this->formatPath($path)]);
+        $statement->closeCursor();
+
+        unset($this->userCache[$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([$this->formatPath($destination), $this->user->getUID(), $this->formatPath($source)]);
+        $statement->closeCursor();
+    }
+
+    /**
+     * @param string $path
+     * @param string[] $requestedProperties
+     *
+     * @return array
+     */
+    private function getPublishedProperties(string $path, array $requestedProperties): array {
+        $allowedProps = array_intersect(self::PUBLISHED_READ_ONLY_PROPERTIES, $requestedProperties);
+
+        if (empty($allowedProps)) {
+            return [];
+        }
+
+        $qb = $this->connection->getQueryBuilder();
+        $qb->select('*')
+            ->from(self::TABLE_NAME)
+            ->where($qb->expr()->eq('propertypath', $qb->createNamedParameter($path)));
+        $result = $qb->executeQuery();
+        $props = [];
+        while ($row = $result->fetch()) {
+            $props[$row['propertyname']] = $row['propertyvalue'];
+        }
+        $result->closeCursor();
+        return $props;
+    }
+
+    /**
+     * Returns a list of properties for the given path and current user
+     *
+     * @param string $path
+     * @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 getUserProperties(string $path, array $requestedProperties) {
+        if (isset($this->userCache[$path])) {
+            return $this->userCache[$path];
+        }
+
+        // TODO: chunking if more than 1000 properties
+        $sql = 'SELECT * FROM `*PREFIX*properties` WHERE `userid` = ? AND `propertypath` = ?';
+
+        $whereValues = [$this->user->getUID(), $this->formatPath($path)];
+        $whereTypes = [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->userCache[$path] = $props;
+        return $props;
+    }
+
+    /**
+     * Update properties
+     *
+     * @param string $path path for which to update properties
+     * @param array $properties array of properties to update
+     *
+     * @return bool
+     */
+    private function updateProperties(string $path, array $properties) {
+        $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->getUserProperties($path, []);
+        $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,
+                        [
+                            $this->user->getUID(),
+                            $this->formatPath($path),
+                            $propertyName,
+                        ]
+                    );
+                }
+            } else {
+                if (!array_key_exists($propertyName, $existing)) {
+                    $this->connection->executeUpdate($insertStatement,
+                        [
+                            $this->user->getUID(),
+                            $this->formatPath($path),
+                            $propertyName,
+                            $propertyValue,
+                        ]
+                    );
+                } else {
+                    $this->connection->executeUpdate($updateStatement,
+                        [
+                            $propertyValue,
+                            $this->user->getUID(),
+                            $this->formatPath($path),
+                            $propertyName,
+                        ]
+                    );
+                }
+            }
+        }
+
+        $this->connection->commit();
+        unset($this->userCache[$path]);
+
+        return true;
+    }
+
+    /**
+     * long paths are hashed to ensure they fit in the database
+     *
+     * @param string $path
+     * @return string
+     */
+    private function formatPath(string $path): string {
+        if (strlen($path) > 250) {
+            return sha1($path);
+        } else {
+            return $path;
+        }
+    }
 }