nextcloud / server

apps/dav/lib/Connector/Sabre/ChecksumList.php

Unused Use Statements -1 removed lines

@@ -21,7 +21,6 @@
 namespace OCA\DAV\Connector\Sabre;
 
 use Sabre\Xml\XmlSerializable;
-use Sabre\Xml\Element;
 use Sabre\Xml\Writer;
 
 /**

Indentation +33 added lines, -33 removed lines

@@ -32,41 +32,41 @@
  * checksum name.
  */
 class ChecksumList implements XmlSerializable {
-	const NS_OWNCLOUD = 'http://owncloud.org/ns';
+    const NS_OWNCLOUD = 'http://owncloud.org/ns';
 
-	/** @var string[] of TYPE:CHECKSUM */
-	private $checksums;
+    /** @var string[] of TYPE:CHECKSUM */
+    private $checksums;
 
-	/**
-	 * @param string $checksum
-	 */
-	public function __construct($checksum) {
-		$this->checksums = explode(',', $checksum);
-	}
+    /**
+     * @param string $checksum
+     */
+    public function __construct($checksum) {
+        $this->checksums = explode(',', $checksum);
+    }
 
-	/**
-	 * The xmlSerialize metod is called during xml writing.
-	 *
-	 * Use the $writer argument to write its own xml serialization.
-	 *
-	 * An important note: do _not_ create a parent element. Any element
-	 * implementing XmlSerializble should only ever write what's considered
-	 * its 'inner xml'.
-	 *
-	 * The parent of the current element is responsible for writing a
-	 * containing element.
-	 *
-	 * This allows serializers to be re-used for different element names.
-	 *
-	 * If you are opening new elements, you must also close them again.
-	 *
-	 * @param Writer $writer
-	 * @return void
-	 */
-	function xmlSerialize(Writer $writer) {
+    /**
+     * The xmlSerialize metod is called during xml writing.
+     *
+     * Use the $writer argument to write its own xml serialization.
+     *
+     * An important note: do _not_ create a parent element. Any element
+     * implementing XmlSerializble should only ever write what's considered
+     * its 'inner xml'.
+     *
+     * The parent of the current element is responsible for writing a
+     * containing element.
+     *
+     * This allows serializers to be re-used for different element names.
+     *
+     * If you are opening new elements, you must also close them again.
+     *
+     * @param Writer $writer
+     * @return void
+     */
+    function xmlSerialize(Writer $writer) {
 
-		foreach ($this->checksums as $checksum) {
-			$writer->writeElement('{' . self::NS_OWNCLOUD . '}checksum', $checksum);
-		}
-	}
+        foreach ($this->checksums as $checksum) {
+            $writer->writeElement('{' . self::NS_OWNCLOUD . '}checksum', $checksum);
+        }
+    }
 }

Spacing +1 added lines, -1 removed lines

@@ -66,7 +66,7 @@
 	function xmlSerialize(Writer $writer) {
 
 		foreach ($this->checksums as $checksum) {
-			$writer->writeElement('{' . self::NS_OWNCLOUD . '}checksum', $checksum);
+			$writer->writeElement('{'.self::NS_OWNCLOUD.'}checksum', $checksum);
 		}
 	}
 }

apps/dav/lib/Connector/Sabre/CustomPropertiesBackend.php

Doc Comments +1 added lines, -1 removed lines

@@ -75,7 +75,7 @@
 	private $cache = [];
 
 	/**
-	 * @param Tree $tree node tree
+	 * @param ObjectTree $tree node tree
 	 * @param IDBConnection $connection database connection
 	 * @param IUser $user owner of the tree and properties
 	 */

Indentation +317 added lines, -317 removed lines

@@ -36,322 +36,322 @@
 
 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',
-		'{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 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;
-		}
-
-		if ($node instanceof 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 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();
-	}
+    /**
+     * 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 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;
+        }
+
+        if ($node instanceof 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 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();
+    }
 
 }

Spacing +8 added lines, -8 removed lines

@@ -111,7 +111,7 @@ 
 			// 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(),
+				'Could not get node for path: \"'.$path.'\" : '.$e->getMessage(),
 				array('app' => 'files')
 			);
 			return;
@@ -170,7 +170,7 @@ 
 		$statement = $this->connection->prepare(
 			'DELETE FROM `*PREFIX*properties` WHERE `userid` = ? AND `propertypath` = ?'
 		);
-		$statement->execute(array($this->user, '/' . $path));
+		$statement->execute(array($this->user, '/'.$path));
 		$statement->closeCursor();
 
 		unset($this->cache[$path]);
@@ -186,10 +186,10 @@ 
 	 */
 	public function move($source, $destination) {
 		$statement = $this->connection->prepare(
-			'UPDATE `*PREFIX*properties` SET `propertypath` = ?' .
+			'UPDATE `*PREFIX*properties` SET `propertypath` = ?'.
 			' WHERE `userid` = ? AND `propertypath` = ?'
 		);
-		$statement->execute(array('/' . $destination, $this->user, '/' . $source));
+		$statement->execute(array('/'.$destination, $this->user, '/'.$source));
 		$statement->closeCursor();
 	}
 
@@ -250,13 +250,13 @@ 
 	private function updateProperties($node, $properties) {
 		$path = $node->getPath();
 
-		$deleteStatement = 'DELETE FROM `*PREFIX*properties`' .
+		$deleteStatement = 'DELETE FROM `*PREFIX*properties`'.
 			' WHERE `userid` = ? AND `propertypath` = ? AND `propertyname` = ?';
 
-		$insertStatement = 'INSERT INTO `*PREFIX*properties`' .
+		$insertStatement = 'INSERT INTO `*PREFIX*properties`'.
 			' (`userid`,`propertypath`,`propertyname`,`propertyvalue`) VALUES(?,?,?,?)';
 
-		$updateStatement = 'UPDATE `*PREFIX*properties` SET `propertyvalue` = ?' .
+		$updateStatement = 'UPDATE `*PREFIX*properties` SET `propertyvalue` = ?'.
 			' WHERE `userid` = ? AND `propertypath` = ? AND `propertyname` = ?';
 
 		// TODO: use "insert or update" strategy ?
@@ -329,7 +329,7 @@ 
 
 		$result = $this->connection->executeQuery(
 			$sql,
-			array($this->user, $this->connection->escapeLikeParameter(rtrim($path, '/')) . '/%', $requestedProperties),
+			array($this->user, $this->connection->escapeLikeParameter(rtrim($path, '/')).'/%', $requestedProperties),
 			array(null, null, \Doctrine\DBAL\Connection::PARAM_STR_ARRAY)
 		);
 

apps/dav/lib/Connector/Sabre/File.php

Doc Comments +3 added lines

@@ -232,6 +232,9 @@
 		return '"' . $this->info->getEtag() . '"';
 	}
 
+	/**
+	 * @param string $path
+	 */
 	private function getPartFileBasePath($path) {
 		$partFileInStorage = \OC::$server->getConfig()->getSystemValue('part_file_in_storage', true);
 		if ($partFileInStorage) {

Spacing +14 added lines, -14 removed lines

@@ -92,7 +92,7 @@ 
 				throw new Forbidden();
 			}
 		} catch (StorageNotAvailableException $e) {
-			throw new ServiceUnavailable("File is not updatable: " . $e->getMessage());
+			throw new ServiceUnavailable("File is not updatable: ".$e->getMessage());
 		}
 
 		// verify path of the target
@@ -112,7 +112,7 @@ 
 
 		if ($needsPartFile) {
 			// mark file as partial while uploading (ignored by the scanner)
-			$partFilePath = $this->getPartFileBasePath($this->path) . '.ocTransferId' . rand() . '.part';
+			$partFilePath = $this->getPartFileBasePath($this->path).'.ocTransferId'.rand().'.part';
 		} else {
 			// upload file directly as the final path
 			$partFilePath = $this->path;
@@ -138,7 +138,7 @@ 
 				if (isset($_SERVER['CONTENT_LENGTH'])) {
 					$expected = $_SERVER['CONTENT_LENGTH'];
 				}
-				throw new Exception('Error while copying file to target location (copied bytes: ' . $count . ', expected filesize: ' . $expected . ' )');
+				throw new Exception('Error while copying file to target location (copied bytes: '.$count.', expected filesize: '.$expected.' )');
 			}
 
 			// if content length is sent by client:
@@ -147,7 +147,7 @@ 
 			if (isset($_SERVER['CONTENT_LENGTH']) && $_SERVER['REQUEST_METHOD'] === 'PUT') {
 				$expected = $_SERVER['CONTENT_LENGTH'];
 				if ($count != $expected) {
-					throw new BadRequest('expected filesize ' . $expected . ' got ' . $count);
+					throw new BadRequest('expected filesize '.$expected.' got '.$count);
 				}
 			}
 
@@ -227,10 +227,10 @@ 
 			}
 
 		} catch (StorageNotAvailableException $e) {
-			throw new ServiceUnavailable("Failed to check file size: " . $e->getMessage());
+			throw new ServiceUnavailable("Failed to check file size: ".$e->getMessage());
 		}
 
-		return '"' . $this->info->getEtag() . '"';
+		return '"'.$this->info->getEtag().'"';
 	}
 
 	private function getPartFileBasePath($path) {
@@ -309,9 +309,9 @@ 
 			return $res;
 		} catch (GenericEncryptionException $e) {
 			// returning 503 will allow retry of the operation at a later point in time
-			throw new ServiceUnavailable("Encryption not ready: " . $e->getMessage());
+			throw new ServiceUnavailable("Encryption not ready: ".$e->getMessage());
 		} catch (StorageNotAvailableException $e) {
-			throw new ServiceUnavailable("Failed to open file: " . $e->getMessage());
+			throw new ServiceUnavailable("Failed to open file: ".$e->getMessage());
 		} catch (ForbiddenException $ex) {
 			throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
 		} catch (LockedException $e) {
@@ -336,7 +336,7 @@ 
 				throw new Forbidden();
 			}
 		} catch (StorageNotAvailableException $e) {
-			throw new ServiceUnavailable("Failed to unlink: " . $e->getMessage());
+			throw new ServiceUnavailable("Failed to unlink: ".$e->getMessage());
 		} catch (ForbiddenException $ex) {
 			throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
 		} catch (LockedException $e) {
@@ -403,7 +403,7 @@ 
 				if ($bytesWritten != $expected) {
 					$chunk_handler->remove($info['index']);
 					throw new BadRequest(
-						'expected filesize ' . $expected . ' got ' . $bytesWritten);
+						'expected filesize '.$expected.' got '.$bytesWritten);
 				}
 			}
 		}
@@ -413,7 +413,7 @@ 
 			$needsPartFile = $this->needsPartFile($storage);
 			$partFile = null;
 
-			$targetPath = $path . '/' . $info['name'];
+			$targetPath = $path.'/'.$info['name'];
 			/** @var \OC\Files\Storage\Storage $targetStorage */
 			list($targetStorage, $targetInternalPath) = $this->fileView->resolvePath($targetPath);
 
@@ -429,7 +429,7 @@ 
 
 				if ($needsPartFile) {
 					// we first assembly the target file as a part file
-					$partFile = $this->getPartFileBasePath($path . '/' . $info['name']) . '.ocTransferId' . $info['transferid'] . '.part';
+					$partFile = $this->getPartFileBasePath($path.'/'.$info['name']).'.ocTransferId'.$info['transferid'].'.part';
 					/** @var \OC\Files\Storage\Storage $targetStorage */
 					list($partStorage, $partInternalPath) = $this->fileView->resolvePath($partFile);
 
@@ -548,10 +548,10 @@ 
 		}
 		if ($e instanceof GenericEncryptionException) {
 			// returning 503 will allow retry of the operation at a later point in time
-			throw new ServiceUnavailable('Encryption not ready: ' . $e->getMessage(), 0, $e);
+			throw new ServiceUnavailable('Encryption not ready: '.$e->getMessage(), 0, $e);
 		}
 		if ($e instanceof StorageNotAvailableException) {
-			throw new ServiceUnavailable('Failed to write file contents: ' . $e->getMessage(), 0, $e);
+			throw new ServiceUnavailable('Failed to write file contents: '.$e->getMessage(), 0, $e);
 		}
 
 		throw new \Sabre\DAV\Exception($e->getMessage(), 0, $e);

Indentation +508 added lines, -508 removed lines

@@ -57,512 +57,512 @@
 
 class File extends Node implements IFile {
 
-	/**
-	 * Updates the data
-	 *
-	 * The data argument is a readable stream resource.
-	 *
-	 * After a successful put operation, you may choose to return an ETag. The
-	 * etag must always be surrounded by double-quotes. These quotes must
-	 * appear in the actual string you're returning.
-	 *
-	 * Clients may use the ETag from a PUT request to later on make sure that
-	 * when they update the file, the contents haven't changed in the mean
-	 * time.
-	 *
-	 * If you don't plan to store the file byte-by-byte, and you return a
-	 * different object on a subsequent GET you are strongly recommended to not
-	 * return an ETag, and just return null.
-	 *
-	 * @param resource $data
-	 *
-	 * @throws Forbidden
-	 * @throws UnsupportedMediaType
-	 * @throws BadRequest
-	 * @throws Exception
-	 * @throws EntityTooLarge
-	 * @throws ServiceUnavailable
-	 * @throws FileLocked
-	 * @return string|null
-	 */
-	public function put($data) {
-		try {
-			$exists = $this->fileView->file_exists($this->path);
-			if ($this->info && $exists && !$this->info->isUpdateable()) {
-				throw new Forbidden();
-			}
-		} catch (StorageNotAvailableException $e) {
-			throw new ServiceUnavailable("File is not updatable: " . $e->getMessage());
-		}
-
-		// verify path of the target
-		$this->verifyPath();
-
-		// chunked handling
-		if (isset($_SERVER['HTTP_OC_CHUNKED'])) {
-			try {
-				return $this->createFileChunked($data);
-			} catch (\Exception $e) {
-				$this->convertToSabreException($e);
-			}
-		}
-
-		list($partStorage) = $this->fileView->resolvePath($this->path);
-		$needsPartFile = $this->needsPartFile($partStorage) && (strlen($this->path) > 1);
-
-		if ($needsPartFile) {
-			// mark file as partial while uploading (ignored by the scanner)
-			$partFilePath = $this->getPartFileBasePath($this->path) . '.ocTransferId' . rand() . '.part';
-		} else {
-			// upload file directly as the final path
-			$partFilePath = $this->path;
-		}
-
-		// the part file and target file might be on a different storage in case of a single file storage (e.g. single file share)
-		/** @var \OC\Files\Storage\Storage $partStorage */
-		list($partStorage, $internalPartPath) = $this->fileView->resolvePath($partFilePath);
-		/** @var \OC\Files\Storage\Storage $storage */
-		list($storage, $internalPath) = $this->fileView->resolvePath($this->path);
-		try {
-			$target = $partStorage->fopen($internalPartPath, 'wb');
-			if ($target === false) {
-				\OCP\Util::writeLog('webdav', '\OC\Files\Filesystem::fopen() failed', \OCP\Util::ERROR);
-				// because we have no clue about the cause we can only throw back a 500/Internal Server Error
-				throw new Exception('Could not write file contents');
-			}
-			list($count, $result) = \OC_Helper::streamCopy($data, $target);
-			fclose($target);
-
-			if ($result === false) {
-				$expected = -1;
-				if (isset($_SERVER['CONTENT_LENGTH'])) {
-					$expected = $_SERVER['CONTENT_LENGTH'];
-				}
-				throw new Exception('Error while copying file to target location (copied bytes: ' . $count . ', expected filesize: ' . $expected . ' )');
-			}
-
-			// if content length is sent by client:
-			// double check if the file was fully received
-			// compare expected and actual size
-			if (isset($_SERVER['CONTENT_LENGTH']) && $_SERVER['REQUEST_METHOD'] === 'PUT') {
-				$expected = $_SERVER['CONTENT_LENGTH'];
-				if ($count != $expected) {
-					throw new BadRequest('expected filesize ' . $expected . ' got ' . $count);
-				}
-			}
-
-		} catch (\Exception $e) {
-			if ($needsPartFile) {
-				$partStorage->unlink($internalPartPath);
-			}
-			$this->convertToSabreException($e);
-		}
-
-		try {
-			$view = \OC\Files\Filesystem::getView();
-			if ($view) {
-				$run = $this->emitPreHooks($exists);
-			} else {
-				$run = true;
-			}
-
-			try {
-				$this->changeLock(ILockingProvider::LOCK_EXCLUSIVE);
-			} catch (LockedException $e) {
-				if ($needsPartFile) {
-					$partStorage->unlink($internalPartPath);
-				}
-				throw new FileLocked($e->getMessage(), $e->getCode(), $e);
-			}
-
-			if ($needsPartFile) {
-				// rename to correct path
-				try {
-					if ($run) {
-						$renameOkay = $storage->moveFromStorage($partStorage, $internalPartPath, $internalPath);
-						$fileExists = $storage->file_exists($internalPath);
-					}
-					if (!$run || $renameOkay === false || $fileExists === false) {
-						\OCP\Util::writeLog('webdav', 'renaming part file to final file failed', \OCP\Util::ERROR);
-						throw new Exception('Could not rename part file to final file');
-					}
-				} catch (ForbiddenException $ex) {
-					throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
-				} catch (\Exception $e) {
-					$partStorage->unlink($internalPartPath);
-					$this->convertToSabreException($e);
-				}
-			}
-
-			// since we skipped the view we need to scan and emit the hooks ourselves
-			$storage->getUpdater()->update($internalPath);
-
-			try {
-				$this->changeLock(ILockingProvider::LOCK_SHARED);
-			} catch (LockedException $e) {
-				throw new FileLocked($e->getMessage(), $e->getCode(), $e);
-			}
-
-			if ($view) {
-				$this->emitPostHooks($exists);
-			}
-
-			// allow sync clients to send the mtime along in a header
-			$request = \OC::$server->getRequest();
-			if (isset($request->server['HTTP_X_OC_MTIME'])) {
-				if ($this->fileView->touch($this->path, $request->server['HTTP_X_OC_MTIME'])) {
-					header('X-OC-MTime: accepted');
-				}
-			}
-
-			$this->refreshInfo();
-
-			if (isset($request->server['HTTP_OC_CHECKSUM'])) {
-				$checksum = trim($request->server['HTTP_OC_CHECKSUM']);
-				$this->fileView->putFileInfo($this->path, ['checksum' => $checksum]);
-				$this->refreshInfo();
-			} else if ($this->getChecksum() !== null && $this->getChecksum() !== '') {
-				$this->fileView->putFileInfo($this->path, ['checksum' => '']);
-				$this->refreshInfo();
-			}
-
-		} catch (StorageNotAvailableException $e) {
-			throw new ServiceUnavailable("Failed to check file size: " . $e->getMessage());
-		}
-
-		return '"' . $this->info->getEtag() . '"';
-	}
-
-	private function getPartFileBasePath($path) {
-		$partFileInStorage = \OC::$server->getConfig()->getSystemValue('part_file_in_storage', true);
-		if ($partFileInStorage) {
-			return $path;
-		} else {
-			return md5($path); // will place it in the root of the view with a unique name
-		}
-	}
-
-	/**
-	 * @param string $path
-	 */
-	private function emitPreHooks($exists, $path = null) {
-		if (is_null($path)) {
-			$path = $this->path;
-		}
-		$hookPath = Filesystem::getView()->getRelativePath($this->fileView->getAbsolutePath($path));
-		$run = true;
-
-		if (!$exists) {
-			\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_create, array(
-				\OC\Files\Filesystem::signal_param_path => $hookPath,
-				\OC\Files\Filesystem::signal_param_run => &$run,
-			));
-		} else {
-			\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_update, array(
-				\OC\Files\Filesystem::signal_param_path => $hookPath,
-				\OC\Files\Filesystem::signal_param_run => &$run,
-			));
-		}
-		\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_write, array(
-			\OC\Files\Filesystem::signal_param_path => $hookPath,
-			\OC\Files\Filesystem::signal_param_run => &$run,
-		));
-		return $run;
-	}
-
-	/**
-	 * @param string $path
-	 */
-	private function emitPostHooks($exists, $path = null) {
-		if (is_null($path)) {
-			$path = $this->path;
-		}
-		$hookPath = Filesystem::getView()->getRelativePath($this->fileView->getAbsolutePath($path));
-		if (!$exists) {
-			\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_create, array(
-				\OC\Files\Filesystem::signal_param_path => $hookPath
-			));
-		} else {
-			\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_update, array(
-				\OC\Files\Filesystem::signal_param_path => $hookPath
-			));
-		}
-		\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_write, array(
-			\OC\Files\Filesystem::signal_param_path => $hookPath
-		));
-	}
-
-	/**
-	 * Returns the data
-	 *
-	 * @return resource
-	 * @throws Forbidden
-	 * @throws ServiceUnavailable
-	 */
-	public function get() {
-		//throw exception if encryption is disabled but files are still encrypted
-		try {
-			$res = $this->fileView->fopen(ltrim($this->path, '/'), 'rb');
-			if ($res === false) {
-				throw new ServiceUnavailable("Could not open file");
-			}
-			return $res;
-		} catch (GenericEncryptionException $e) {
-			// returning 503 will allow retry of the operation at a later point in time
-			throw new ServiceUnavailable("Encryption not ready: " . $e->getMessage());
-		} catch (StorageNotAvailableException $e) {
-			throw new ServiceUnavailable("Failed to open file: " . $e->getMessage());
-		} catch (ForbiddenException $ex) {
-			throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
-		} catch (LockedException $e) {
-			throw new FileLocked($e->getMessage(), $e->getCode(), $e);
-		}
-	}
-
-	/**
-	 * Delete the current file
-	 *
-	 * @throws Forbidden
-	 * @throws ServiceUnavailable
-	 */
-	public function delete() {
-		if (!$this->info->isDeletable()) {
-			throw new Forbidden();
-		}
-
-		try {
-			if (!$this->fileView->unlink($this->path)) {
-				// assume it wasn't possible to delete due to permissions
-				throw new Forbidden();
-			}
-		} catch (StorageNotAvailableException $e) {
-			throw new ServiceUnavailable("Failed to unlink: " . $e->getMessage());
-		} catch (ForbiddenException $ex) {
-			throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
-		} catch (LockedException $e) {
-			throw new FileLocked($e->getMessage(), $e->getCode(), $e);
-		}
-	}
-
-	/**
-	 * Returns the mime-type for a file
-	 *
-	 * If null is returned, we'll assume application/octet-stream
-	 *
-	 * @return string
-	 */
-	public function getContentType() {
-		$mimeType = $this->info->getMimetype();
-
-		// PROPFIND needs to return the correct mime type, for consistency with the web UI
-		if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'PROPFIND') {
-			return $mimeType;
-		}
-		return \OC::$server->getMimeTypeDetector()->getSecureMimeType($mimeType);
-	}
-
-	/**
-	 * @return array|false
-	 */
-	public function getDirectDownload() {
-		if (\OCP\App::isEnabled('encryption')) {
-			return [];
-		}
-		/** @var \OCP\Files\Storage $storage */
-		list($storage, $internalPath) = $this->fileView->resolvePath($this->path);
-		if (is_null($storage)) {
-			return [];
-		}
-
-		return $storage->getDirectDownload($internalPath);
-	}
-
-	/**
-	 * @param resource $data
-	 * @return null|string
-	 * @throws Exception
-	 * @throws BadRequest
-	 * @throws NotImplemented
-	 * @throws ServiceUnavailable
-	 */
-	private function createFileChunked($data) {
-		list($path, $name) = \Sabre\HTTP\URLUtil::splitPath($this->path);
-
-		$info = \OC_FileChunking::decodeName($name);
-		if (empty($info)) {
-			throw new NotImplemented('Invalid chunk name');
-		}
-
-		$chunk_handler = new \OC_FileChunking($info);
-		$bytesWritten = $chunk_handler->store($info['index'], $data);
-
-		//detect aborted upload
-		if (isset ($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'PUT') {
-			if (isset($_SERVER['CONTENT_LENGTH'])) {
-				$expected = $_SERVER['CONTENT_LENGTH'];
-				if ($bytesWritten != $expected) {
-					$chunk_handler->remove($info['index']);
-					throw new BadRequest(
-						'expected filesize ' . $expected . ' got ' . $bytesWritten);
-				}
-			}
-		}
-
-		if ($chunk_handler->isComplete()) {
-			list($storage,) = $this->fileView->resolvePath($path);
-			$needsPartFile = $this->needsPartFile($storage);
-			$partFile = null;
-
-			$targetPath = $path . '/' . $info['name'];
-			/** @var \OC\Files\Storage\Storage $targetStorage */
-			list($targetStorage, $targetInternalPath) = $this->fileView->resolvePath($targetPath);
-
-			$exists = $this->fileView->file_exists($targetPath);
-
-			try {
-				$this->fileView->lockFile($targetPath, ILockingProvider::LOCK_SHARED);
-
-				$this->emitPreHooks($exists, $targetPath);
-				$this->fileView->changeLock($targetPath, ILockingProvider::LOCK_EXCLUSIVE);
-				/** @var \OC\Files\Storage\Storage $targetStorage */
-				list($targetStorage, $targetInternalPath) = $this->fileView->resolvePath($targetPath);
-
-				if ($needsPartFile) {
-					// we first assembly the target file as a part file
-					$partFile = $this->getPartFileBasePath($path . '/' . $info['name']) . '.ocTransferId' . $info['transferid'] . '.part';
-					/** @var \OC\Files\Storage\Storage $targetStorage */
-					list($partStorage, $partInternalPath) = $this->fileView->resolvePath($partFile);
-
-
-					$chunk_handler->file_assemble($partStorage, $partInternalPath);
-
-					// here is the final atomic rename
-					$renameOkay = $targetStorage->moveFromStorage($partStorage, $partInternalPath, $targetInternalPath);
-					$fileExists = $targetStorage->file_exists($targetInternalPath);
-					if ($renameOkay === false || $fileExists === false) {
-						\OCP\Util::writeLog('webdav', '\OC\Files\Filesystem::rename() failed', \OCP\Util::ERROR);
-						// only delete if an error occurred and the target file was already created
-						if ($fileExists) {
-							// set to null to avoid double-deletion when handling exception
-							// stray part file
-							$partFile = null;
-							$targetStorage->unlink($targetInternalPath);
-						}
-						$this->fileView->changeLock($targetPath, ILockingProvider::LOCK_SHARED);
-						throw new Exception('Could not rename part file assembled from chunks');
-					}
-				} else {
-					// assemble directly into the final file
-					$chunk_handler->file_assemble($targetStorage, $targetInternalPath);
-				}
-
-				// allow sync clients to send the mtime along in a header
-				$request = \OC::$server->getRequest();
-				if (isset($request->server['HTTP_X_OC_MTIME'])) {
-					if ($targetStorage->touch($targetInternalPath, $request->server['HTTP_X_OC_MTIME'])) {
-						header('X-OC-MTime: accepted');
-					}
-				}
-
-				// since we skipped the view we need to scan and emit the hooks ourselves
-				$targetStorage->getUpdater()->update($targetInternalPath);
-
-				$this->fileView->changeLock($targetPath, ILockingProvider::LOCK_SHARED);
-
-				$this->emitPostHooks($exists, $targetPath);
-
-				// FIXME: should call refreshInfo but can't because $this->path is not the of the final file
-				$info = $this->fileView->getFileInfo($targetPath);
-
-				if (isset($request->server['HTTP_OC_CHECKSUM'])) {
-					$checksum = trim($request->server['HTTP_OC_CHECKSUM']);
-					$this->fileView->putFileInfo($targetPath, ['checksum' => $checksum]);
-				} else if ($info->getChecksum() !== null && $info->getChecksum() !== '') {
-					$this->fileView->putFileInfo($this->path, ['checksum' => '']);
-				}
-
-				$this->fileView->unlockFile($targetPath, ILockingProvider::LOCK_SHARED);
-
-				return $info->getEtag();
-			} catch (\Exception $e) {
-				if ($partFile !== null) {
-					$targetStorage->unlink($targetInternalPath);
-				}
-				$this->convertToSabreException($e);
-			}
-		}
-
-		return null;
-	}
-
-	/**
-	 * Returns whether a part file is needed for the given storage
-	 * or whether the file can be assembled/uploaded directly on the
-	 * target storage.
-	 *
-	 * @param \OCP\Files\Storage $storage
-	 * @return bool true if the storage needs part file handling
-	 */
-	private function needsPartFile($storage) {
-		// TODO: in the future use ChunkHandler provided by storage
-		// and/or add method on Storage called "needsPartFile()"
-		return !$storage->instanceOfStorage('OCA\Files_Sharing\External\Storage') &&
-		!$storage->instanceOfStorage('OC\Files\Storage\OwnCloud');
-	}
-
-	/**
-	 * Convert the given exception to a SabreException instance
-	 *
-	 * @param \Exception $e
-	 *
-	 * @throws \Sabre\DAV\Exception
-	 */
-	private function convertToSabreException(\Exception $e) {
-		if ($e instanceof \Sabre\DAV\Exception) {
-			throw $e;
-		}
-		if ($e instanceof NotPermittedException) {
-			// a more general case - due to whatever reason the content could not be written
-			throw new Forbidden($e->getMessage(), 0, $e);
-		}
-		if ($e instanceof ForbiddenException) {
-			// the path for the file was forbidden
-			throw new DAVForbiddenException($e->getMessage(), $e->getRetry(), $e);
-		}
-		if ($e instanceof EntityTooLargeException) {
-			// the file is too big to be stored
-			throw new EntityTooLarge($e->getMessage(), 0, $e);
-		}
-		if ($e instanceof InvalidContentException) {
-			// the file content is not permitted
-			throw new UnsupportedMediaType($e->getMessage(), 0, $e);
-		}
-		if ($e instanceof InvalidPathException) {
-			// the path for the file was not valid
-			// TODO: find proper http status code for this case
-			throw new Forbidden($e->getMessage(), 0, $e);
-		}
-		if ($e instanceof LockedException || $e instanceof LockNotAcquiredException) {
-			// the file is currently being written to by another process
-			throw new FileLocked($e->getMessage(), $e->getCode(), $e);
-		}
-		if ($e instanceof GenericEncryptionException) {
-			// returning 503 will allow retry of the operation at a later point in time
-			throw new ServiceUnavailable('Encryption not ready: ' . $e->getMessage(), 0, $e);
-		}
-		if ($e instanceof StorageNotAvailableException) {
-			throw new ServiceUnavailable('Failed to write file contents: ' . $e->getMessage(), 0, $e);
-		}
-
-		throw new \Sabre\DAV\Exception($e->getMessage(), 0, $e);
-	}
-
-	/**
-	 * Get the checksum for this file
-	 *
-	 * @return string
-	 */
-	public function getChecksum() {
-		return $this->info->getChecksum();
-	}
+    /**
+     * Updates the data
+     *
+     * The data argument is a readable stream resource.
+     *
+     * After a successful put operation, you may choose to return an ETag. The
+     * etag must always be surrounded by double-quotes. These quotes must
+     * appear in the actual string you're returning.
+     *
+     * Clients may use the ETag from a PUT request to later on make sure that
+     * when they update the file, the contents haven't changed in the mean
+     * time.
+     *
+     * If you don't plan to store the file byte-by-byte, and you return a
+     * different object on a subsequent GET you are strongly recommended to not
+     * return an ETag, and just return null.
+     *
+     * @param resource $data
+     *
+     * @throws Forbidden
+     * @throws UnsupportedMediaType
+     * @throws BadRequest
+     * @throws Exception
+     * @throws EntityTooLarge
+     * @throws ServiceUnavailable
+     * @throws FileLocked
+     * @return string|null
+     */
+    public function put($data) {
+        try {
+            $exists = $this->fileView->file_exists($this->path);
+            if ($this->info && $exists && !$this->info->isUpdateable()) {
+                throw new Forbidden();
+            }
+        } catch (StorageNotAvailableException $e) {
+            throw new ServiceUnavailable("File is not updatable: " . $e->getMessage());
+        }
+
+        // verify path of the target
+        $this->verifyPath();
+
+        // chunked handling
+        if (isset($_SERVER['HTTP_OC_CHUNKED'])) {
+            try {
+                return $this->createFileChunked($data);
+            } catch (\Exception $e) {
+                $this->convertToSabreException($e);
+            }
+        }
+
+        list($partStorage) = $this->fileView->resolvePath($this->path);
+        $needsPartFile = $this->needsPartFile($partStorage) && (strlen($this->path) > 1);
+
+        if ($needsPartFile) {
+            // mark file as partial while uploading (ignored by the scanner)
+            $partFilePath = $this->getPartFileBasePath($this->path) . '.ocTransferId' . rand() . '.part';
+        } else {
+            // upload file directly as the final path
+            $partFilePath = $this->path;
+        }
+
+        // the part file and target file might be on a different storage in case of a single file storage (e.g. single file share)
+        /** @var \OC\Files\Storage\Storage $partStorage */
+        list($partStorage, $internalPartPath) = $this->fileView->resolvePath($partFilePath);
+        /** @var \OC\Files\Storage\Storage $storage */
+        list($storage, $internalPath) = $this->fileView->resolvePath($this->path);
+        try {
+            $target = $partStorage->fopen($internalPartPath, 'wb');
+            if ($target === false) {
+                \OCP\Util::writeLog('webdav', '\OC\Files\Filesystem::fopen() failed', \OCP\Util::ERROR);
+                // because we have no clue about the cause we can only throw back a 500/Internal Server Error
+                throw new Exception('Could not write file contents');
+            }
+            list($count, $result) = \OC_Helper::streamCopy($data, $target);
+            fclose($target);
+
+            if ($result === false) {
+                $expected = -1;
+                if (isset($_SERVER['CONTENT_LENGTH'])) {
+                    $expected = $_SERVER['CONTENT_LENGTH'];
+                }
+                throw new Exception('Error while copying file to target location (copied bytes: ' . $count . ', expected filesize: ' . $expected . ' )');
+            }
+
+            // if content length is sent by client:
+            // double check if the file was fully received
+            // compare expected and actual size
+            if (isset($_SERVER['CONTENT_LENGTH']) && $_SERVER['REQUEST_METHOD'] === 'PUT') {
+                $expected = $_SERVER['CONTENT_LENGTH'];
+                if ($count != $expected) {
+                    throw new BadRequest('expected filesize ' . $expected . ' got ' . $count);
+                }
+            }
+
+        } catch (\Exception $e) {
+            if ($needsPartFile) {
+                $partStorage->unlink($internalPartPath);
+            }
+            $this->convertToSabreException($e);
+        }
+
+        try {
+            $view = \OC\Files\Filesystem::getView();
+            if ($view) {
+                $run = $this->emitPreHooks($exists);
+            } else {
+                $run = true;
+            }
+
+            try {
+                $this->changeLock(ILockingProvider::LOCK_EXCLUSIVE);
+            } catch (LockedException $e) {
+                if ($needsPartFile) {
+                    $partStorage->unlink($internalPartPath);
+                }
+                throw new FileLocked($e->getMessage(), $e->getCode(), $e);
+            }
+
+            if ($needsPartFile) {
+                // rename to correct path
+                try {
+                    if ($run) {
+                        $renameOkay = $storage->moveFromStorage($partStorage, $internalPartPath, $internalPath);
+                        $fileExists = $storage->file_exists($internalPath);
+                    }
+                    if (!$run || $renameOkay === false || $fileExists === false) {
+                        \OCP\Util::writeLog('webdav', 'renaming part file to final file failed', \OCP\Util::ERROR);
+                        throw new Exception('Could not rename part file to final file');
+                    }
+                } catch (ForbiddenException $ex) {
+                    throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
+                } catch (\Exception $e) {
+                    $partStorage->unlink($internalPartPath);
+                    $this->convertToSabreException($e);
+                }
+            }
+
+            // since we skipped the view we need to scan and emit the hooks ourselves
+            $storage->getUpdater()->update($internalPath);
+
+            try {
+                $this->changeLock(ILockingProvider::LOCK_SHARED);
+            } catch (LockedException $e) {
+                throw new FileLocked($e->getMessage(), $e->getCode(), $e);
+            }
+
+            if ($view) {
+                $this->emitPostHooks($exists);
+            }
+
+            // allow sync clients to send the mtime along in a header
+            $request = \OC::$server->getRequest();
+            if (isset($request->server['HTTP_X_OC_MTIME'])) {
+                if ($this->fileView->touch($this->path, $request->server['HTTP_X_OC_MTIME'])) {
+                    header('X-OC-MTime: accepted');
+                }
+            }
+
+            $this->refreshInfo();
+
+            if (isset($request->server['HTTP_OC_CHECKSUM'])) {
+                $checksum = trim($request->server['HTTP_OC_CHECKSUM']);
+                $this->fileView->putFileInfo($this->path, ['checksum' => $checksum]);
+                $this->refreshInfo();
+            } else if ($this->getChecksum() !== null && $this->getChecksum() !== '') {
+                $this->fileView->putFileInfo($this->path, ['checksum' => '']);
+                $this->refreshInfo();
+            }
+
+        } catch (StorageNotAvailableException $e) {
+            throw new ServiceUnavailable("Failed to check file size: " . $e->getMessage());
+        }
+
+        return '"' . $this->info->getEtag() . '"';
+    }
+
+    private function getPartFileBasePath($path) {
+        $partFileInStorage = \OC::$server->getConfig()->getSystemValue('part_file_in_storage', true);
+        if ($partFileInStorage) {
+            return $path;
+        } else {
+            return md5($path); // will place it in the root of the view with a unique name
+        }
+    }
+
+    /**
+     * @param string $path
+     */
+    private function emitPreHooks($exists, $path = null) {
+        if (is_null($path)) {
+            $path = $this->path;
+        }
+        $hookPath = Filesystem::getView()->getRelativePath($this->fileView->getAbsolutePath($path));
+        $run = true;
+
+        if (!$exists) {
+            \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_create, array(
+                \OC\Files\Filesystem::signal_param_path => $hookPath,
+                \OC\Files\Filesystem::signal_param_run => &$run,
+            ));
+        } else {
+            \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_update, array(
+                \OC\Files\Filesystem::signal_param_path => $hookPath,
+                \OC\Files\Filesystem::signal_param_run => &$run,
+            ));
+        }
+        \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_write, array(
+            \OC\Files\Filesystem::signal_param_path => $hookPath,
+            \OC\Files\Filesystem::signal_param_run => &$run,
+        ));
+        return $run;
+    }
+
+    /**
+     * @param string $path
+     */
+    private function emitPostHooks($exists, $path = null) {
+        if (is_null($path)) {
+            $path = $this->path;
+        }
+        $hookPath = Filesystem::getView()->getRelativePath($this->fileView->getAbsolutePath($path));
+        if (!$exists) {
+            \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_create, array(
+                \OC\Files\Filesystem::signal_param_path => $hookPath
+            ));
+        } else {
+            \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_update, array(
+                \OC\Files\Filesystem::signal_param_path => $hookPath
+            ));
+        }
+        \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_write, array(
+            \OC\Files\Filesystem::signal_param_path => $hookPath
+        ));
+    }
+
+    /**
+     * Returns the data
+     *
+     * @return resource
+     * @throws Forbidden
+     * @throws ServiceUnavailable
+     */
+    public function get() {
+        //throw exception if encryption is disabled but files are still encrypted
+        try {
+            $res = $this->fileView->fopen(ltrim($this->path, '/'), 'rb');
+            if ($res === false) {
+                throw new ServiceUnavailable("Could not open file");
+            }
+            return $res;
+        } catch (GenericEncryptionException $e) {
+            // returning 503 will allow retry of the operation at a later point in time
+            throw new ServiceUnavailable("Encryption not ready: " . $e->getMessage());
+        } catch (StorageNotAvailableException $e) {
+            throw new ServiceUnavailable("Failed to open file: " . $e->getMessage());
+        } catch (ForbiddenException $ex) {
+            throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
+        } catch (LockedException $e) {
+            throw new FileLocked($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    /**
+     * Delete the current file
+     *
+     * @throws Forbidden
+     * @throws ServiceUnavailable
+     */
+    public function delete() {
+        if (!$this->info->isDeletable()) {
+            throw new Forbidden();
+        }
+
+        try {
+            if (!$this->fileView->unlink($this->path)) {
+                // assume it wasn't possible to delete due to permissions
+                throw new Forbidden();
+            }
+        } catch (StorageNotAvailableException $e) {
+            throw new ServiceUnavailable("Failed to unlink: " . $e->getMessage());
+        } catch (ForbiddenException $ex) {
+            throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
+        } catch (LockedException $e) {
+            throw new FileLocked($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    /**
+     * Returns the mime-type for a file
+     *
+     * If null is returned, we'll assume application/octet-stream
+     *
+     * @return string
+     */
+    public function getContentType() {
+        $mimeType = $this->info->getMimetype();
+
+        // PROPFIND needs to return the correct mime type, for consistency with the web UI
+        if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'PROPFIND') {
+            return $mimeType;
+        }
+        return \OC::$server->getMimeTypeDetector()->getSecureMimeType($mimeType);
+    }
+
+    /**
+     * @return array|false
+     */
+    public function getDirectDownload() {
+        if (\OCP\App::isEnabled('encryption')) {
+            return [];
+        }
+        /** @var \OCP\Files\Storage $storage */
+        list($storage, $internalPath) = $this->fileView->resolvePath($this->path);
+        if (is_null($storage)) {
+            return [];
+        }
+
+        return $storage->getDirectDownload($internalPath);
+    }
+
+    /**
+     * @param resource $data
+     * @return null|string
+     * @throws Exception
+     * @throws BadRequest
+     * @throws NotImplemented
+     * @throws ServiceUnavailable
+     */
+    private function createFileChunked($data) {
+        list($path, $name) = \Sabre\HTTP\URLUtil::splitPath($this->path);
+
+        $info = \OC_FileChunking::decodeName($name);
+        if (empty($info)) {
+            throw new NotImplemented('Invalid chunk name');
+        }
+
+        $chunk_handler = new \OC_FileChunking($info);
+        $bytesWritten = $chunk_handler->store($info['index'], $data);
+
+        //detect aborted upload
+        if (isset ($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'PUT') {
+            if (isset($_SERVER['CONTENT_LENGTH'])) {
+                $expected = $_SERVER['CONTENT_LENGTH'];
+                if ($bytesWritten != $expected) {
+                    $chunk_handler->remove($info['index']);
+                    throw new BadRequest(
+                        'expected filesize ' . $expected . ' got ' . $bytesWritten);
+                }
+            }
+        }
+
+        if ($chunk_handler->isComplete()) {
+            list($storage,) = $this->fileView->resolvePath($path);
+            $needsPartFile = $this->needsPartFile($storage);
+            $partFile = null;
+
+            $targetPath = $path . '/' . $info['name'];
+            /** @var \OC\Files\Storage\Storage $targetStorage */
+            list($targetStorage, $targetInternalPath) = $this->fileView->resolvePath($targetPath);
+
+            $exists = $this->fileView->file_exists($targetPath);
+
+            try {
+                $this->fileView->lockFile($targetPath, ILockingProvider::LOCK_SHARED);
+
+                $this->emitPreHooks($exists, $targetPath);
+                $this->fileView->changeLock($targetPath, ILockingProvider::LOCK_EXCLUSIVE);
+                /** @var \OC\Files\Storage\Storage $targetStorage */
+                list($targetStorage, $targetInternalPath) = $this->fileView->resolvePath($targetPath);
+
+                if ($needsPartFile) {
+                    // we first assembly the target file as a part file
+                    $partFile = $this->getPartFileBasePath($path . '/' . $info['name']) . '.ocTransferId' . $info['transferid'] . '.part';
+                    /** @var \OC\Files\Storage\Storage $targetStorage */
+                    list($partStorage, $partInternalPath) = $this->fileView->resolvePath($partFile);
+
+
+                    $chunk_handler->file_assemble($partStorage, $partInternalPath);
+
+                    // here is the final atomic rename
+                    $renameOkay = $targetStorage->moveFromStorage($partStorage, $partInternalPath, $targetInternalPath);
+                    $fileExists = $targetStorage->file_exists($targetInternalPath);
+                    if ($renameOkay === false || $fileExists === false) {
+                        \OCP\Util::writeLog('webdav', '\OC\Files\Filesystem::rename() failed', \OCP\Util::ERROR);
+                        // only delete if an error occurred and the target file was already created
+                        if ($fileExists) {
+                            // set to null to avoid double-deletion when handling exception
+                            // stray part file
+                            $partFile = null;
+                            $targetStorage->unlink($targetInternalPath);
+                        }
+                        $this->fileView->changeLock($targetPath, ILockingProvider::LOCK_SHARED);
+                        throw new Exception('Could not rename part file assembled from chunks');
+                    }
+                } else {
+                    // assemble directly into the final file
+                    $chunk_handler->file_assemble($targetStorage, $targetInternalPath);
+                }
+
+                // allow sync clients to send the mtime along in a header
+                $request = \OC::$server->getRequest();
+                if (isset($request->server['HTTP_X_OC_MTIME'])) {
+                    if ($targetStorage->touch($targetInternalPath, $request->server['HTTP_X_OC_MTIME'])) {
+                        header('X-OC-MTime: accepted');
+                    }
+                }
+
+                // since we skipped the view we need to scan and emit the hooks ourselves
+                $targetStorage->getUpdater()->update($targetInternalPath);
+
+                $this->fileView->changeLock($targetPath, ILockingProvider::LOCK_SHARED);
+
+                $this->emitPostHooks($exists, $targetPath);
+
+                // FIXME: should call refreshInfo but can't because $this->path is not the of the final file
+                $info = $this->fileView->getFileInfo($targetPath);
+
+                if (isset($request->server['HTTP_OC_CHECKSUM'])) {
+                    $checksum = trim($request->server['HTTP_OC_CHECKSUM']);
+                    $this->fileView->putFileInfo($targetPath, ['checksum' => $checksum]);
+                } else if ($info->getChecksum() !== null && $info->getChecksum() !== '') {
+                    $this->fileView->putFileInfo($this->path, ['checksum' => '']);
+                }
+
+                $this->fileView->unlockFile($targetPath, ILockingProvider::LOCK_SHARED);
+
+                return $info->getEtag();
+            } catch (\Exception $e) {
+                if ($partFile !== null) {
+                    $targetStorage->unlink($targetInternalPath);
+                }
+                $this->convertToSabreException($e);
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * Returns whether a part file is needed for the given storage
+     * or whether the file can be assembled/uploaded directly on the
+     * target storage.
+     *
+     * @param \OCP\Files\Storage $storage
+     * @return bool true if the storage needs part file handling
+     */
+    private function needsPartFile($storage) {
+        // TODO: in the future use ChunkHandler provided by storage
+        // and/or add method on Storage called "needsPartFile()"
+        return !$storage->instanceOfStorage('OCA\Files_Sharing\External\Storage') &&
+        !$storage->instanceOfStorage('OC\Files\Storage\OwnCloud');
+    }
+
+    /**
+     * Convert the given exception to a SabreException instance
+     *
+     * @param \Exception $e
+     *
+     * @throws \Sabre\DAV\Exception
+     */
+    private function convertToSabreException(\Exception $e) {
+        if ($e instanceof \Sabre\DAV\Exception) {
+            throw $e;
+        }
+        if ($e instanceof NotPermittedException) {
+            // a more general case - due to whatever reason the content could not be written
+            throw new Forbidden($e->getMessage(), 0, $e);
+        }
+        if ($e instanceof ForbiddenException) {
+            // the path for the file was forbidden
+            throw new DAVForbiddenException($e->getMessage(), $e->getRetry(), $e);
+        }
+        if ($e instanceof EntityTooLargeException) {
+            // the file is too big to be stored
+            throw new EntityTooLarge($e->getMessage(), 0, $e);
+        }
+        if ($e instanceof InvalidContentException) {
+            // the file content is not permitted
+            throw new UnsupportedMediaType($e->getMessage(), 0, $e);
+        }
+        if ($e instanceof InvalidPathException) {
+            // the path for the file was not valid
+            // TODO: find proper http status code for this case
+            throw new Forbidden($e->getMessage(), 0, $e);
+        }
+        if ($e instanceof LockedException || $e instanceof LockNotAcquiredException) {
+            // the file is currently being written to by another process
+            throw new FileLocked($e->getMessage(), $e->getCode(), $e);
+        }
+        if ($e instanceof GenericEncryptionException) {
+            // returning 503 will allow retry of the operation at a later point in time
+            throw new ServiceUnavailable('Encryption not ready: ' . $e->getMessage(), 0, $e);
+        }
+        if ($e instanceof StorageNotAvailableException) {
+            throw new ServiceUnavailable('Failed to write file contents: ' . $e->getMessage(), 0, $e);
+        }
+
+        throw new \Sabre\DAV\Exception($e->getMessage(), 0, $e);
+    }
+
+    /**
+     * Get the checksum for this file
+     *
+     * @return string
+     */
+    public function getChecksum() {
+        return $this->info->getChecksum();
+    }
 }

apps/dav/lib/Connector/Sabre/FilesReportPlugin.php

Doc Comments +3 added lines, -2 removed lines

@@ -89,7 +89,7 @@ 
 	private $userFolder;
 
 	/**
-	 * @param Tree $tree
+	 * @param ObjectTree $tree
 	 * @param View $view
 	 */
 	public function __construct(Tree $tree,
@@ -134,7 +134,7 @@ 
 	 * This will be used in the {DAV:}supported-report-set property.
 	 *
 	 * @param string $uri
-	 * @return array
+	 * @return string[]
 	 */
 	public function getSupportedReportSet($uri) {
 		return [self::REPORT_NAME];
@@ -265,6 +265,7 @@ 
 	 *
 	 * @param string[] $requestedProps requested properties
 	 * @param Node[] nodes nodes for which to fetch and prepare responses
+	 * @param Node[] $nodes
 	 * @return Response[]
 	 */
 	public function prepareResponses($requestedProps, $nodes) {

Indentation +289 added lines, -289 removed lines

@@ -42,293 +42,293 @@
 
 class FilesReportPlugin extends ServerPlugin {
 
-	// namespace
-	const NS_OWNCLOUD = 'http://owncloud.org/ns';
-	const REPORT_NAME            = '{http://owncloud.org/ns}filter-files';
-	const SYSTEMTAG_PROPERTYNAME = '{http://owncloud.org/ns}systemtag';
-
-	/**
-	 * Reference to main server object
-	 *
-	 * @var \Sabre\DAV\Server
-	 */
-	private $server;
-
-	/**
-	 * @var Tree
-	 */
-	private $tree;
-
-	/**
-	 * @var View
-	 */
-	private $fileView;
-
-	/**
-	 * @var ISystemTagManager
-	 */
-	private $tagManager;
-
-	/**
-	 * @var ISystemTagObjectMapper
-	 */
-	private $tagMapper;
-
-	/**
-	 * @var IUserSession
-	 */
-	private $userSession;
-
-	/**
-	 * @var IGroupManager
-	 */
-	private $groupManager;
-
-	/**
-	 * @var Folder
-	 */
-	private $userFolder;
-
-	/**
-	 * @param Tree $tree
-	 * @param View $view
-	 */
-	public function __construct(Tree $tree,
-								View $view,
-								ISystemTagManager $tagManager,
-								ISystemTagObjectMapper $tagMapper,
-								IUserSession $userSession,
-								IGroupManager $groupManager,
-								Folder $userFolder
-	) {
-		$this->tree = $tree;
-		$this->fileView = $view;
-		$this->tagManager = $tagManager;
-		$this->tagMapper = $tagMapper;
-		$this->userSession = $userSession;
-		$this->groupManager = $groupManager;
-		$this->userFolder = $userFolder;
-	}
-
-	/**
-	 * This initializes the plugin.
-	 *
-	 * This function is called by \Sabre\DAV\Server, after
-	 * addPlugin is called.
-	 *
-	 * This method should set up the required event subscriptions.
-	 *
-	 * @param \Sabre\DAV\Server $server
-	 * @return void
-	 */
-	public function initialize(\Sabre\DAV\Server $server) {
-
-		$server->xml->namespaceMap[self::NS_OWNCLOUD] = 'oc';
-
-		$this->server = $server;
-		$this->server->on('report', array($this, 'onReport'));
-	}
-
-	/**
-	 * Returns a list of reports this plugin supports.
-	 *
-	 * This will be used in the {DAV:}supported-report-set property.
-	 *
-	 * @param string $uri
-	 * @return array
-	 */
-	public function getSupportedReportSet($uri) {
-		return [self::REPORT_NAME];
-	}
-
-	/**
-	 * REPORT operations to look for files
-	 *
-	 * @param string $reportName
-	 * @param [] $report
-	 * @param string $uri
-	 * @return bool
-	 * @throws NotFound
-	 * @throws ReportNotSupported
-	 */
-	public function onReport($reportName, $report, $uri) {
-		$reportTargetNode = $this->server->tree->getNodeForPath($uri);
-		if (!$reportTargetNode instanceof Directory || $reportName !== self::REPORT_NAME) {
-			throw new ReportNotSupported();
-		}
-
-		$ns = '{' . $this::NS_OWNCLOUD . '}';
-		$requestedProps = [];
-		$filterRules = [];
-
-		// parse report properties and gather filter info
-		foreach ($report as $reportProps) {
-			$name = $reportProps['name'];
-			if ($name === $ns . 'filter-rules') {
-				$filterRules = $reportProps['value'];
-			} else if ($name === '{DAV:}prop') {
-				// propfind properties
-				foreach ($reportProps['value'] as $propVal) {
-					$requestedProps[] = $propVal['name'];
-				}
-			}
-		}
-
-		if (empty($filterRules)) {
-			// an empty filter would return all existing files which would be slow
-			throw new BadRequest('Missing filter-rule block in request');
-		}
-
-		// gather all file ids matching filter
-		try {
-			$resultFileIds = $this->processFilterRules($filterRules);
-		} catch (TagNotFoundException $e) {
-			throw new PreconditionFailed('Cannot filter by non-existing tag', 0, $e);
-		}
-
-		// find sabre nodes by file id, restricted to the root node path
-		$results = $this->findNodesByFileIds($reportTargetNode, $resultFileIds);
-
-		$responses = $this->prepareResponses($requestedProps, $results);
-
-		$xml = $this->server->xml->write(
-			'{DAV:}multistatus',
-			new MultiStatus($responses)
-		);
-
-		$this->server->httpResponse->setStatus(207);
-		$this->server->httpResponse->setHeader('Content-Type', 'application/xml; charset=utf-8');
-		$this->server->httpResponse->setBody($xml);
-
-		return false;
-	}
-
-	/**
-	 * Find file ids matching the given filter rules
-	 *
-	 * @param array $filterRules
-	 * @return array array of unique file id results
-	 *
-	 * @throws TagNotFoundException whenever a tag was not found
-	 */
-	protected function processFilterRules($filterRules) {
-		$ns = '{' . $this::NS_OWNCLOUD . '}';
-		$resultFileIds = null;
-		$systemTagIds = [];
-		foreach ($filterRules as $filterRule) {
-			if ($filterRule['name'] === $ns . 'systemtag') {
-				$systemTagIds[] = $filterRule['value'];
-			}
-		}
-
-		// check user permissions, if applicable
-		if (!$this->isAdmin()) {
-			// check visibility/permission
-			$tags = $this->tagManager->getTagsByIds($systemTagIds);
-			$unknownTagIds = [];
-			foreach ($tags as $tag) {
-				if (!$tag->isUserVisible()) {
-					$unknownTagIds[] = $tag->getId();
-				}
-			}
-
-			if (!empty($unknownTagIds)) {
-				throw new TagNotFoundException('Tag with ids ' . implode(', ', $unknownTagIds) . ' not found');
-			}
-		}
-
-		// fetch all file ids and intersect them
-		foreach ($systemTagIds as $systemTagId) {
-			$fileIds = $this->tagMapper->getObjectIdsForTags($systemTagId, 'files');
-
-			if (empty($fileIds)) {
-				// This tag has no files, nothing can ever show up
-				return [];
-			}
-
-			// first run ?
-			if ($resultFileIds === null) {
-				$resultFileIds = $fileIds;
-			} else {
-				$resultFileIds = array_intersect($resultFileIds, $fileIds);
-			}
-
-			if (empty($resultFileIds)) {
-				// Empty intersection, nothing can show up anymore
-				return [];
-			}
-		}
-		return $resultFileIds;
-	}
-
-	/**
-	 * Prepare propfind response for the given nodes
-	 *
-	 * @param string[] $requestedProps requested properties
-	 * @param Node[] nodes nodes for which to fetch and prepare responses
-	 * @return Response[]
-	 */
-	public function prepareResponses($requestedProps, $nodes) {
-		$responses = [];
-		foreach ($nodes as $node) {
-			$propFind = new PropFind($node->getPath(), $requestedProps);
-
-			$this->server->getPropertiesByNode($propFind, $node);
-			// copied from Sabre Server's getPropertiesForPath
-			$result = $propFind->getResultForMultiStatus();
-			$result['href'] = $propFind->getPath();
-
-			$resourceType = $this->server->getResourceTypeForNode($node);
-			if (in_array('{DAV:}collection', $resourceType) || in_array('{DAV:}principal', $resourceType)) {
-				$result['href'] .= '/';
-			}
-
-			$responses[] = new Response(
-				rtrim($this->server->getBaseUri(), '/') . $node->getPath(),
-				$result,
-				200
-			);
-		}
-		return $responses;
-	}
-
-	/**
-	 * Find Sabre nodes by file ids
-	 *
-	 * @param Node $rootNode root node for search
-	 * @param array $fileIds file ids
-	 * @return Node[] array of Sabre nodes
-	 */
-	public function findNodesByFileIds($rootNode, $fileIds) {
-		$folder = $this->userFolder;
-		if (trim($rootNode->getPath(), '/') !== '') {
-			$folder = $folder->get($rootNode->getPath());
-		}
-
-		$results = [];
-		foreach ($fileIds as $fileId) {
-			$entry = $folder->getById($fileId);
-			if ($entry) {
-				$entry = current($entry);
-				if ($entry instanceof \OCP\Files\File) {
-					$results[] = new File($this->fileView, $entry);
-				} else if ($entry instanceof \OCP\Files\Folder) {
-					$results[] = new Directory($this->fileView, $entry);
-				}
-			}
-		}
-
-		return $results;
-	}
-
-	/**
-	 * Returns whether the currently logged in user is an administrator
-	 */
-	private function isAdmin() {
-		$user = $this->userSession->getUser();
-		if ($user !== null) {
-			return $this->groupManager->isAdmin($user->getUID());
-		}
-		return false;
-	}
+    // namespace
+    const NS_OWNCLOUD = 'http://owncloud.org/ns';
+    const REPORT_NAME            = '{http://owncloud.org/ns}filter-files';
+    const SYSTEMTAG_PROPERTYNAME = '{http://owncloud.org/ns}systemtag';
+
+    /**
+     * Reference to main server object
+     *
+     * @var \Sabre\DAV\Server
+     */
+    private $server;
+
+    /**
+     * @var Tree
+     */
+    private $tree;
+
+    /**
+     * @var View
+     */
+    private $fileView;
+
+    /**
+     * @var ISystemTagManager
+     */
+    private $tagManager;
+
+    /**
+     * @var ISystemTagObjectMapper
+     */
+    private $tagMapper;
+
+    /**
+     * @var IUserSession
+     */
+    private $userSession;
+
+    /**
+     * @var IGroupManager
+     */
+    private $groupManager;
+
+    /**
+     * @var Folder
+     */
+    private $userFolder;
+
+    /**
+     * @param Tree $tree
+     * @param View $view
+     */
+    public function __construct(Tree $tree,
+                                View $view,
+                                ISystemTagManager $tagManager,
+                                ISystemTagObjectMapper $tagMapper,
+                                IUserSession $userSession,
+                                IGroupManager $groupManager,
+                                Folder $userFolder
+    ) {
+        $this->tree = $tree;
+        $this->fileView = $view;
+        $this->tagManager = $tagManager;
+        $this->tagMapper = $tagMapper;
+        $this->userSession = $userSession;
+        $this->groupManager = $groupManager;
+        $this->userFolder = $userFolder;
+    }
+
+    /**
+     * This initializes the plugin.
+     *
+     * This function is called by \Sabre\DAV\Server, after
+     * addPlugin is called.
+     *
+     * This method should set up the required event subscriptions.
+     *
+     * @param \Sabre\DAV\Server $server
+     * @return void
+     */
+    public function initialize(\Sabre\DAV\Server $server) {
+
+        $server->xml->namespaceMap[self::NS_OWNCLOUD] = 'oc';
+
+        $this->server = $server;
+        $this->server->on('report', array($this, 'onReport'));
+    }
+
+    /**
+     * Returns a list of reports this plugin supports.
+     *
+     * This will be used in the {DAV:}supported-report-set property.
+     *
+     * @param string $uri
+     * @return array
+     */
+    public function getSupportedReportSet($uri) {
+        return [self::REPORT_NAME];
+    }
+
+    /**
+     * REPORT operations to look for files
+     *
+     * @param string $reportName
+     * @param [] $report
+     * @param string $uri
+     * @return bool
+     * @throws NotFound
+     * @throws ReportNotSupported
+     */
+    public function onReport($reportName, $report, $uri) {
+        $reportTargetNode = $this->server->tree->getNodeForPath($uri);
+        if (!$reportTargetNode instanceof Directory || $reportName !== self::REPORT_NAME) {
+            throw new ReportNotSupported();
+        }
+
+        $ns = '{' . $this::NS_OWNCLOUD . '}';
+        $requestedProps = [];
+        $filterRules = [];
+
+        // parse report properties and gather filter info
+        foreach ($report as $reportProps) {
+            $name = $reportProps['name'];
+            if ($name === $ns . 'filter-rules') {
+                $filterRules = $reportProps['value'];
+            } else if ($name === '{DAV:}prop') {
+                // propfind properties
+                foreach ($reportProps['value'] as $propVal) {
+                    $requestedProps[] = $propVal['name'];
+                }
+            }
+        }
+
+        if (empty($filterRules)) {
+            // an empty filter would return all existing files which would be slow
+            throw new BadRequest('Missing filter-rule block in request');
+        }
+
+        // gather all file ids matching filter
+        try {
+            $resultFileIds = $this->processFilterRules($filterRules);
+        } catch (TagNotFoundException $e) {
+            throw new PreconditionFailed('Cannot filter by non-existing tag', 0, $e);
+        }
+
+        // find sabre nodes by file id, restricted to the root node path
+        $results = $this->findNodesByFileIds($reportTargetNode, $resultFileIds);
+
+        $responses = $this->prepareResponses($requestedProps, $results);
+
+        $xml = $this->server->xml->write(
+            '{DAV:}multistatus',
+            new MultiStatus($responses)
+        );
+
+        $this->server->httpResponse->setStatus(207);
+        $this->server->httpResponse->setHeader('Content-Type', 'application/xml; charset=utf-8');
+        $this->server->httpResponse->setBody($xml);
+
+        return false;
+    }
+
+    /**
+     * Find file ids matching the given filter rules
+     *
+     * @param array $filterRules
+     * @return array array of unique file id results
+     *
+     * @throws TagNotFoundException whenever a tag was not found
+     */
+    protected function processFilterRules($filterRules) {
+        $ns = '{' . $this::NS_OWNCLOUD . '}';
+        $resultFileIds = null;
+        $systemTagIds = [];
+        foreach ($filterRules as $filterRule) {
+            if ($filterRule['name'] === $ns . 'systemtag') {
+                $systemTagIds[] = $filterRule['value'];
+            }
+        }
+
+        // check user permissions, if applicable
+        if (!$this->isAdmin()) {
+            // check visibility/permission
+            $tags = $this->tagManager->getTagsByIds($systemTagIds);
+            $unknownTagIds = [];
+            foreach ($tags as $tag) {
+                if (!$tag->isUserVisible()) {
+                    $unknownTagIds[] = $tag->getId();
+                }
+            }
+
+            if (!empty($unknownTagIds)) {
+                throw new TagNotFoundException('Tag with ids ' . implode(', ', $unknownTagIds) . ' not found');
+            }
+        }
+
+        // fetch all file ids and intersect them
+        foreach ($systemTagIds as $systemTagId) {
+            $fileIds = $this->tagMapper->getObjectIdsForTags($systemTagId, 'files');
+
+            if (empty($fileIds)) {
+                // This tag has no files, nothing can ever show up
+                return [];
+            }
+
+            // first run ?
+            if ($resultFileIds === null) {
+                $resultFileIds = $fileIds;
+            } else {
+                $resultFileIds = array_intersect($resultFileIds, $fileIds);
+            }
+
+            if (empty($resultFileIds)) {
+                // Empty intersection, nothing can show up anymore
+                return [];
+            }
+        }
+        return $resultFileIds;
+    }
+
+    /**
+     * Prepare propfind response for the given nodes
+     *
+     * @param string[] $requestedProps requested properties
+     * @param Node[] nodes nodes for which to fetch and prepare responses
+     * @return Response[]
+     */
+    public function prepareResponses($requestedProps, $nodes) {
+        $responses = [];
+        foreach ($nodes as $node) {
+            $propFind = new PropFind($node->getPath(), $requestedProps);
+
+            $this->server->getPropertiesByNode($propFind, $node);
+            // copied from Sabre Server's getPropertiesForPath
+            $result = $propFind->getResultForMultiStatus();
+            $result['href'] = $propFind->getPath();
+
+            $resourceType = $this->server->getResourceTypeForNode($node);
+            if (in_array('{DAV:}collection', $resourceType) || in_array('{DAV:}principal', $resourceType)) {
+                $result['href'] .= '/';
+            }
+
+            $responses[] = new Response(
+                rtrim($this->server->getBaseUri(), '/') . $node->getPath(),
+                $result,
+                200
+            );
+        }
+        return $responses;
+    }
+
+    /**
+     * Find Sabre nodes by file ids
+     *
+     * @param Node $rootNode root node for search
+     * @param array $fileIds file ids
+     * @return Node[] array of Sabre nodes
+     */
+    public function findNodesByFileIds($rootNode, $fileIds) {
+        $folder = $this->userFolder;
+        if (trim($rootNode->getPath(), '/') !== '') {
+            $folder = $folder->get($rootNode->getPath());
+        }
+
+        $results = [];
+        foreach ($fileIds as $fileId) {
+            $entry = $folder->getById($fileId);
+            if ($entry) {
+                $entry = current($entry);
+                if ($entry instanceof \OCP\Files\File) {
+                    $results[] = new File($this->fileView, $entry);
+                } else if ($entry instanceof \OCP\Files\Folder) {
+                    $results[] = new Directory($this->fileView, $entry);
+                }
+            }
+        }
+
+        return $results;
+    }
+
+    /**
+     * Returns whether the currently logged in user is an administrator
+     */
+    private function isAdmin() {
+        $user = $this->userSession->getUser();
+        if ($user !== null) {
+            return $this->groupManager->isAdmin($user->getUID());
+        }
+        return false;
+    }
 }

Spacing +6 added lines, -6 removed lines

@@ -157,14 +157,14 @@ 
 			throw new ReportNotSupported();
 		}
 
-		$ns = '{' . $this::NS_OWNCLOUD . '}';
+		$ns = '{'.$this::NS_OWNCLOUD.'}';
 		$requestedProps = [];
 		$filterRules = [];
 
 		// parse report properties and gather filter info
 		foreach ($report as $reportProps) {
 			$name = $reportProps['name'];
-			if ($name === $ns . 'filter-rules') {
+			if ($name === $ns.'filter-rules') {
 				$filterRules = $reportProps['value'];
 			} else if ($name === '{DAV:}prop') {
 				// propfind properties
@@ -212,11 +212,11 @@ 
 	 * @throws TagNotFoundException whenever a tag was not found
 	 */
 	protected function processFilterRules($filterRules) {
-		$ns = '{' . $this::NS_OWNCLOUD . '}';
+		$ns = '{'.$this::NS_OWNCLOUD.'}';
 		$resultFileIds = null;
 		$systemTagIds = [];
 		foreach ($filterRules as $filterRule) {
-			if ($filterRule['name'] === $ns . 'systemtag') {
+			if ($filterRule['name'] === $ns.'systemtag') {
 				$systemTagIds[] = $filterRule['value'];
 			}
 		}
@@ -233,7 +233,7 @@ 
 			}
 
 			if (!empty($unknownTagIds)) {
-				throw new TagNotFoundException('Tag with ids ' . implode(', ', $unknownTagIds) . ' not found');
+				throw new TagNotFoundException('Tag with ids '.implode(', ', $unknownTagIds).' not found');
 			}
 		}
 
@@ -284,7 +284,7 @@ 
 			}
 
 			$responses[] = new Response(
-				rtrim($this->server->getBaseUri(), '/') . $node->getPath(),
+				rtrim($this->server->getBaseUri(), '/').$node->getPath(),
 				$result,
 				200
 			);

apps/dav/lib/Connector/Sabre/ShareTypeList.php

Doc Comments +1 added lines, -1 removed lines

@@ -60,7 +60,7 @@
 	 * The deserialize method is called during xml parsing.
 	 *
 	 * @param Reader $reader
-	 * @return mixed
+	 * @return ShareTypeList
 	 */
 	static function xmlDeserialize(Reader $reader) {
 		$shareTypes = [];

Indentation +47 added lines, -47 removed lines

@@ -32,57 +32,57 @@
  * This property contains multiple "share-type" elements, each containing a share type.
  */
 class ShareTypeList implements Element {
-	const NS_OWNCLOUD = 'http://owncloud.org/ns';
+    const NS_OWNCLOUD = 'http://owncloud.org/ns';
 
-	/**
-	 * Share types
-	 *
-	 * @var int[]
-	 */
-	private $shareTypes;
+    /**
+     * Share types
+     *
+     * @var int[]
+     */
+    private $shareTypes;
 
-	/**
-	 * @param int[] $shareTypes
-	 */
-	public function __construct($shareTypes) {
-		$this->shareTypes = $shareTypes;
-	}
+    /**
+     * @param int[] $shareTypes
+     */
+    public function __construct($shareTypes) {
+        $this->shareTypes = $shareTypes;
+    }
 
-	/**
-	 * Returns the share types
-	 *
-	 * @return int[]
-	 */
-	public function getShareTypes() {
-		return $this->shareTypes;
-	}
+    /**
+     * Returns the share types
+     *
+     * @return int[]
+     */
+    public function getShareTypes() {
+        return $this->shareTypes;
+    }
 
-	/**
-	 * The deserialize method is called during xml parsing.
-	 *
-	 * @param Reader $reader
-	 * @return mixed
-	 */
-	static function xmlDeserialize(Reader $reader) {
-		$shareTypes = [];
+    /**
+     * The deserialize method is called during xml parsing.
+     *
+     * @param Reader $reader
+     * @return mixed
+     */
+    static function xmlDeserialize(Reader $reader) {
+        $shareTypes = [];
 
-		foreach ($reader->parseInnerTree() as $elem) {
-			if ($elem['name'] === '{' . self::NS_OWNCLOUD . '}share-type') {
-				$shareTypes[] = (int)$elem['value'];
-			}
-		}
-		return new self($shareTypes);
-	}
+        foreach ($reader->parseInnerTree() as $elem) {
+            if ($elem['name'] === '{' . self::NS_OWNCLOUD . '}share-type') {
+                $shareTypes[] = (int)$elem['value'];
+            }
+        }
+        return new self($shareTypes);
+    }
 
-	/**
-	 * The xmlSerialize metod is called during xml writing.
-	 *
-	 * @param Writer $writer
-	 * @return void
-	 */
-	function xmlSerialize(Writer $writer) {
-		foreach ($this->shareTypes as $shareType) {
-			$writer->writeElement('{' . self::NS_OWNCLOUD . '}share-type', $shareType);
-		}
-	}
+    /**
+     * The xmlSerialize metod is called during xml writing.
+     *
+     * @param Writer $writer
+     * @return void
+     */
+    function xmlSerialize(Writer $writer) {
+        foreach ($this->shareTypes as $shareType) {
+            $writer->writeElement('{' . self::NS_OWNCLOUD . '}share-type', $shareType);
+        }
+    }
 }

Spacing +3 added lines, -3 removed lines

@@ -67,8 +67,8 @@ 
 		$shareTypes = [];
 
 		foreach ($reader->parseInnerTree() as $elem) {
-			if ($elem['name'] === '{' . self::NS_OWNCLOUD . '}share-type') {
-				$shareTypes[] = (int)$elem['value'];
+			if ($elem['name'] === '{'.self::NS_OWNCLOUD.'}share-type') {
+				$shareTypes[] = (int) $elem['value'];
 			}
 		}
 		return new self($shareTypes);
@@ -82,7 +82,7 @@ 
 	 */
 	function xmlSerialize(Writer $writer) {
 		foreach ($this->shareTypes as $shareType) {
-			$writer->writeElement('{' . self::NS_OWNCLOUD . '}share-type', $shareType);
+			$writer->writeElement('{'.self::NS_OWNCLOUD.'}share-type', $shareType);
 		}
 	}
 }

apps/dav/lib/Connector/Sabre/TagList.php

Doc Comments +1 added lines, -1 removed lines

@@ -79,7 +79,7 @@
 	 * the next element.
 	 *
 	 * @param Reader $reader
-	 * @return mixed
+	 * @return TagList
 	 */
 	static function xmlDeserialize(Reader $reader) {
 		$tags = [];

Indentation +75 added lines, -75 removed lines

@@ -34,88 +34,88 @@
  * This property contains multiple "tag" elements, each containing a tag name.
  */
 class TagList implements Element {
-	const NS_OWNCLOUD = 'http://owncloud.org/ns';
+    const NS_OWNCLOUD = 'http://owncloud.org/ns';
 
-	/**
-	 * tags
-	 *
-	 * @var array
-	 */
-	private $tags;
+    /**
+     * tags
+     *
+     * @var array
+     */
+    private $tags;
 
-	/**
-	 * @param array $tags
-	 */
-	public function __construct(array $tags) {
-		$this->tags = $tags;
-	}
+    /**
+     * @param array $tags
+     */
+    public function __construct(array $tags) {
+        $this->tags = $tags;
+    }
 
-	/**
-	 * Returns the tags
-	 *
-	 * @return array
-	 */
-	public function getTags() {
+    /**
+     * Returns the tags
+     *
+     * @return array
+     */
+    public function getTags() {
 
-		return $this->tags;
+        return $this->tags;
 
-	}
+    }
 
-	/**
-	 * The deserialize method is called during xml parsing.
-	 *
-	 * This method is called statictly, this is because in theory this method
-	 * may be used as a type of constructor, or factory method.
-	 *
-	 * Often you want to return an instance of the current class, but you are
-	 * free to return other data as well.
-	 *
-	 * You are responsible for advancing the reader to the next element. Not
-	 * doing anything will result in a never-ending loop.
-	 *
-	 * If you just want to skip parsing for this element altogether, you can
-	 * just call $reader->next();
-	 *
-	 * $reader->parseInnerTree() will parse the entire sub-tree, and advance to
-	 * the next element.
-	 *
-	 * @param Reader $reader
-	 * @return mixed
-	 */
-	static function xmlDeserialize(Reader $reader) {
-		$tags = [];
+    /**
+     * The deserialize method is called during xml parsing.
+     *
+     * This method is called statictly, this is because in theory this method
+     * may be used as a type of constructor, or factory method.
+     *
+     * Often you want to return an instance of the current class, but you are
+     * free to return other data as well.
+     *
+     * You are responsible for advancing the reader to the next element. Not
+     * doing anything will result in a never-ending loop.
+     *
+     * If you just want to skip parsing for this element altogether, you can
+     * just call $reader->next();
+     *
+     * $reader->parseInnerTree() will parse the entire sub-tree, and advance to
+     * the next element.
+     *
+     * @param Reader $reader
+     * @return mixed
+     */
+    static function xmlDeserialize(Reader $reader) {
+        $tags = [];
 
-		foreach ($reader->parseInnerTree() as $elem) {
-			if ($elem['name'] === '{' . self::NS_OWNCLOUD . '}tag') {
-				$tags[] = $elem['value'];
-			}
-		}
-		return new self($tags);
-	}
+        foreach ($reader->parseInnerTree() as $elem) {
+            if ($elem['name'] === '{' . self::NS_OWNCLOUD . '}tag') {
+                $tags[] = $elem['value'];
+            }
+        }
+        return new self($tags);
+    }
 
-	/**
-	 * The xmlSerialize metod is called during xml writing.
-	 *
-	 * Use the $writer argument to write its own xml serialization.
-	 *
-	 * An important note: do _not_ create a parent element. Any element
-	 * implementing XmlSerializble should only ever write what's considered
-	 * its 'inner xml'.
-	 *
-	 * The parent of the current element is responsible for writing a
-	 * containing element.
-	 *
-	 * This allows serializers to be re-used for different element names.
-	 *
-	 * If you are opening new elements, you must also close them again.
-	 *
-	 * @param Writer $writer
-	 * @return void
-	 */
-	function xmlSerialize(Writer $writer) {
+    /**
+     * The xmlSerialize metod is called during xml writing.
+     *
+     * Use the $writer argument to write its own xml serialization.
+     *
+     * An important note: do _not_ create a parent element. Any element
+     * implementing XmlSerializble should only ever write what's considered
+     * its 'inner xml'.
+     *
+     * The parent of the current element is responsible for writing a
+     * containing element.
+     *
+     * This allows serializers to be re-used for different element names.
+     *
+     * If you are opening new elements, you must also close them again.
+     *
+     * @param Writer $writer
+     * @return void
+     */
+    function xmlSerialize(Writer $writer) {
 
-		foreach ($this->tags as $tag) {
-			$writer->writeElement('{' . self::NS_OWNCLOUD . '}tag', $tag);
-		}
-	}
+        foreach ($this->tags as $tag) {
+            $writer->writeElement('{' . self::NS_OWNCLOUD . '}tag', $tag);
+        }
+    }
 }

Spacing +2 added lines, -2 removed lines

@@ -86,7 +86,7 @@ 
 		$tags = [];
 
 		foreach ($reader->parseInnerTree() as $elem) {
-			if ($elem['name'] === '{' . self::NS_OWNCLOUD . '}tag') {
+			if ($elem['name'] === '{'.self::NS_OWNCLOUD.'}tag') {
 				$tags[] = $elem['value'];
 			}
 		}
@@ -115,7 +115,7 @@ 
 	function xmlSerialize(Writer $writer) {
 
 		foreach ($this->tags as $tag) {
-			$writer->writeElement('{' . self::NS_OWNCLOUD . '}tag', $tag);
+			$writer->writeElement('{'.self::NS_OWNCLOUD.'}tag', $tag);
 		}
 	}
 }

apps/dav/lib/Connector/Sabre/TagsPlugin.php

Doc Comments +1 added lines, -1 removed lines

@@ -85,7 +85,7 @@
 	private $tree;
 
 	/**
-	 * @param \Sabre\DAV\Tree $tree tree
+	 * @param ObjectTree $tree tree
 	 * @param \OCP\ITagManager $tagManager tag manager
 	 */
 	public function __construct(\Sabre\DAV\Tree $tree, \OCP\ITagManager $tagManager) {

Spacing +3 added lines, -3 removed lines

@@ -220,9 +220,9 @@ 
 		)) {
 			// note: pre-fetching only supported for depth <= 1
 			$folderContent = $node->getChildren();
-			$fileIds[] = (int)$node->getId();
+			$fileIds[] = (int) $node->getId();
 			foreach ($folderContent as $info) {
-				$fileIds[] = (int)$info->getId();
+				$fileIds[] = (int) $info->getId();
 			}
 			$tags = $this->getTagger()->getTagsForObjects($fileIds);
 			if ($tags === false) {
@@ -281,7 +281,7 @@ 
 			if (is_null($node)) {
 				return 404;
 			}
-			if ((int)$favState === 1 || $favState === 'true') {
+			if ((int) $favState === 1 || $favState === 'true') {
 				$this->getTagger()->tagAs($node->getId(), self::TAG_FAVORITE);
 			} else {
 				$this->getTagger()->unTag($node->getId(), self::TAG_FAVORITE);

Indentation +218 added lines, -218 removed lines

@@ -49,246 +49,246 @@
 class TagsPlugin extends \Sabre\DAV\ServerPlugin
 {
 
-	// namespace
-	const NS_OWNCLOUD = 'http://owncloud.org/ns';
-	const TAGS_PROPERTYNAME = '{http://owncloud.org/ns}tags';
-	const FAVORITE_PROPERTYNAME = '{http://owncloud.org/ns}favorite';
-	const TAG_FAVORITE = '_$!<Favorite>!$_';
+    // namespace
+    const NS_OWNCLOUD = 'http://owncloud.org/ns';
+    const TAGS_PROPERTYNAME = '{http://owncloud.org/ns}tags';
+    const FAVORITE_PROPERTYNAME = '{http://owncloud.org/ns}favorite';
+    const TAG_FAVORITE = '_$!<Favorite>!$_';
 
-	/**
-	 * Reference to main server object
-	 *
-	 * @var \Sabre\DAV\Server
-	 */
-	private $server;
+    /**
+     * Reference to main server object
+     *
+     * @var \Sabre\DAV\Server
+     */
+    private $server;
 
-	/**
-	 * @var \OCP\ITagManager
-	 */
-	private $tagManager;
+    /**
+     * @var \OCP\ITagManager
+     */
+    private $tagManager;
 
-	/**
-	 * @var \OCP\ITags
-	 */
-	private $tagger;
+    /**
+     * @var \OCP\ITags
+     */
+    private $tagger;
 
-	/**
-	 * Array of file id to tags array
-	 * The null value means the cache wasn't initialized.
-	 *
-	 * @var array
-	 */
-	private $cachedTags;
+    /**
+     * Array of file id to tags array
+     * The null value means the cache wasn't initialized.
+     *
+     * @var array
+     */
+    private $cachedTags;
 
-	/**
-	 * @var \Sabre\DAV\Tree
-	 */
-	private $tree;
+    /**
+     * @var \Sabre\DAV\Tree
+     */
+    private $tree;
 
-	/**
-	 * @param \Sabre\DAV\Tree $tree tree
-	 * @param \OCP\ITagManager $tagManager tag manager
-	 */
-	public function __construct(\Sabre\DAV\Tree $tree, \OCP\ITagManager $tagManager) {
-		$this->tree = $tree;
-		$this->tagManager = $tagManager;
-		$this->tagger = null;
-		$this->cachedTags = array();
-	}
+    /**
+     * @param \Sabre\DAV\Tree $tree tree
+     * @param \OCP\ITagManager $tagManager tag manager
+     */
+    public function __construct(\Sabre\DAV\Tree $tree, \OCP\ITagManager $tagManager) {
+        $this->tree = $tree;
+        $this->tagManager = $tagManager;
+        $this->tagger = null;
+        $this->cachedTags = array();
+    }
 
-	/**
-	 * This initializes the plugin.
-	 *
-	 * This function is called by \Sabre\DAV\Server, after
-	 * addPlugin is called.
-	 *
-	 * This method should set up the required event subscriptions.
-	 *
-	 * @param \Sabre\DAV\Server $server
-	 * @return void
-	 */
-	public function initialize(\Sabre\DAV\Server $server) {
+    /**
+     * This initializes the plugin.
+     *
+     * This function is called by \Sabre\DAV\Server, after
+     * addPlugin is called.
+     *
+     * This method should set up the required event subscriptions.
+     *
+     * @param \Sabre\DAV\Server $server
+     * @return void
+     */
+    public function initialize(\Sabre\DAV\Server $server) {
 
-		$server->xml->namespaceMap[self::NS_OWNCLOUD] = 'oc';
-		$server->xml->elementMap[self::TAGS_PROPERTYNAME] = 'OCA\\DAV\\Connector\\Sabre\\TagList';
+        $server->xml->namespaceMap[self::NS_OWNCLOUD] = 'oc';
+        $server->xml->elementMap[self::TAGS_PROPERTYNAME] = 'OCA\\DAV\\Connector\\Sabre\\TagList';
 
-		$this->server = $server;
-		$this->server->on('propFind', array($this, 'handleGetProperties'));
-		$this->server->on('propPatch', array($this, 'handleUpdateProperties'));
-	}
+        $this->server = $server;
+        $this->server->on('propFind', array($this, 'handleGetProperties'));
+        $this->server->on('propPatch', array($this, 'handleUpdateProperties'));
+    }
 
-	/**
-	 * Returns the tagger
-	 *
-	 * @return \OCP\ITags tagger
-	 */
-	private function getTagger() {
-		if (!$this->tagger) {
-			$this->tagger = $this->tagManager->load('files');
-		}
-		return $this->tagger;
-	}
+    /**
+     * Returns the tagger
+     *
+     * @return \OCP\ITags tagger
+     */
+    private function getTagger() {
+        if (!$this->tagger) {
+            $this->tagger = $this->tagManager->load('files');
+        }
+        return $this->tagger;
+    }
 
-	/**
-	 * Returns tags and favorites.
-	 *
-	 * @param integer $fileId file id
-	 * @return array list($tags, $favorite) with $tags as tag array
-	 * and $favorite is a boolean whether the file was favorited
-	 */
-	private function getTagsAndFav($fileId) {
-		$isFav = false;
-		$tags = $this->getTags($fileId);
-		if ($tags) {
-			$favPos = array_search(self::TAG_FAVORITE, $tags);
-			if ($favPos !== false) {
-				$isFav = true;
-				unset($tags[$favPos]);
-			}
-		}
-		return array($tags, $isFav);
-	}
+    /**
+     * Returns tags and favorites.
+     *
+     * @param integer $fileId file id
+     * @return array list($tags, $favorite) with $tags as tag array
+     * and $favorite is a boolean whether the file was favorited
+     */
+    private function getTagsAndFav($fileId) {
+        $isFav = false;
+        $tags = $this->getTags($fileId);
+        if ($tags) {
+            $favPos = array_search(self::TAG_FAVORITE, $tags);
+            if ($favPos !== false) {
+                $isFav = true;
+                unset($tags[$favPos]);
+            }
+        }
+        return array($tags, $isFav);
+    }
 
-	/**
-	 * Returns tags for the given file id
-	 *
-	 * @param integer $fileId file id
-	 * @return array list of tags for that file
-	 */
-	private function getTags($fileId) {
-		if (isset($this->cachedTags[$fileId])) {
-			return $this->cachedTags[$fileId];
-		} else {
-			$tags = $this->getTagger()->getTagsForObjects(array($fileId));
-			if ($tags !== false) {
-				if (empty($tags)) {
-					return array();
-				}
-				return current($tags);
-			}
-		}
-		return null;
-	}
+    /**
+     * Returns tags for the given file id
+     *
+     * @param integer $fileId file id
+     * @return array list of tags for that file
+     */
+    private function getTags($fileId) {
+        if (isset($this->cachedTags[$fileId])) {
+            return $this->cachedTags[$fileId];
+        } else {
+            $tags = $this->getTagger()->getTagsForObjects(array($fileId));
+            if ($tags !== false) {
+                if (empty($tags)) {
+                    return array();
+                }
+                return current($tags);
+            }
+        }
+        return null;
+    }
 
-	/**
-	 * Updates the tags of the given file id
-	 *
-	 * @param int $fileId
-	 * @param array $tags array of tag strings
-	 */
-	private function updateTags($fileId, $tags) {
-		$tagger = $this->getTagger();
-		$currentTags = $this->getTags($fileId);
+    /**
+     * Updates the tags of the given file id
+     *
+     * @param int $fileId
+     * @param array $tags array of tag strings
+     */
+    private function updateTags($fileId, $tags) {
+        $tagger = $this->getTagger();
+        $currentTags = $this->getTags($fileId);
 
-		$newTags = array_diff($tags, $currentTags);
-		foreach ($newTags as $tag) {
-			if ($tag === self::TAG_FAVORITE) {
-				continue;
-			}
-			$tagger->tagAs($fileId, $tag);
-		}
-		$deletedTags = array_diff($currentTags, $tags);
-		foreach ($deletedTags as $tag) {
-			if ($tag === self::TAG_FAVORITE) {
-				continue;
-			}
-			$tagger->unTag($fileId, $tag);
-		}
-	}
+        $newTags = array_diff($tags, $currentTags);
+        foreach ($newTags as $tag) {
+            if ($tag === self::TAG_FAVORITE) {
+                continue;
+            }
+            $tagger->tagAs($fileId, $tag);
+        }
+        $deletedTags = array_diff($currentTags, $tags);
+        foreach ($deletedTags as $tag) {
+            if ($tag === self::TAG_FAVORITE) {
+                continue;
+            }
+            $tagger->unTag($fileId, $tag);
+        }
+    }
 
-	/**
-	 * Adds tags and favorites properties to the response,
-	 * if requested.
-	 *
-	 * @param PropFind $propFind
-	 * @param \Sabre\DAV\INode $node
-	 * @return void
-	 */
-	public function handleGetProperties(
-		PropFind $propFind,
-		\Sabre\DAV\INode $node
-	) {
-		if (!($node instanceof \OCA\DAV\Connector\Sabre\Node)) {
-			return;
-		}
+    /**
+     * Adds tags and favorites properties to the response,
+     * if requested.
+     *
+     * @param PropFind $propFind
+     * @param \Sabre\DAV\INode $node
+     * @return void
+     */
+    public function handleGetProperties(
+        PropFind $propFind,
+        \Sabre\DAV\INode $node
+    ) {
+        if (!($node instanceof \OCA\DAV\Connector\Sabre\Node)) {
+            return;
+        }
 
-		// need prefetch ?
-		if ($node instanceof \OCA\DAV\Connector\Sabre\Directory
-			&& $propFind->getDepth() !== 0
-			&& (!is_null($propFind->getStatus(self::TAGS_PROPERTYNAME))
-			|| !is_null($propFind->getStatus(self::FAVORITE_PROPERTYNAME))
-		)) {
-			// note: pre-fetching only supported for depth <= 1
-			$folderContent = $node->getChildren();
-			$fileIds[] = (int)$node->getId();
-			foreach ($folderContent as $info) {
-				$fileIds[] = (int)$info->getId();
-			}
-			$tags = $this->getTagger()->getTagsForObjects($fileIds);
-			if ($tags === false) {
-				// the tags API returns false on error...
-				$tags = array();
-			}
+        // need prefetch ?
+        if ($node instanceof \OCA\DAV\Connector\Sabre\Directory
+            && $propFind->getDepth() !== 0
+            && (!is_null($propFind->getStatus(self::TAGS_PROPERTYNAME))
+            || !is_null($propFind->getStatus(self::FAVORITE_PROPERTYNAME))
+        )) {
+            // note: pre-fetching only supported for depth <= 1
+            $folderContent = $node->getChildren();
+            $fileIds[] = (int)$node->getId();
+            foreach ($folderContent as $info) {
+                $fileIds[] = (int)$info->getId();
+            }
+            $tags = $this->getTagger()->getTagsForObjects($fileIds);
+            if ($tags === false) {
+                // the tags API returns false on error...
+                $tags = array();
+            }
 
-			$this->cachedTags = $this->cachedTags + $tags;
-			$emptyFileIds = array_diff($fileIds, array_keys($tags));
-			// also cache the ones that were not found
-			foreach ($emptyFileIds as $fileId) {
-				$this->cachedTags[$fileId] = [];
-			}
-		}
+            $this->cachedTags = $this->cachedTags + $tags;
+            $emptyFileIds = array_diff($fileIds, array_keys($tags));
+            // also cache the ones that were not found
+            foreach ($emptyFileIds as $fileId) {
+                $this->cachedTags[$fileId] = [];
+            }
+        }
 
-		$tags = null;
-		$isFav = null;
+        $tags = null;
+        $isFav = null;
 
-		$propFind->handle(self::TAGS_PROPERTYNAME, function() use ($tags, &$isFav, $node) {
-			list($tags, $isFav) = $this->getTagsAndFav($node->getId());
-			return new TagList($tags);
-		});
+        $propFind->handle(self::TAGS_PROPERTYNAME, function() use ($tags, &$isFav, $node) {
+            list($tags, $isFav) = $this->getTagsAndFav($node->getId());
+            return new TagList($tags);
+        });
 
-		$propFind->handle(self::FAVORITE_PROPERTYNAME, function() use ($isFav, $node) {
-			if (is_null($isFav)) {
-				list(, $isFav) = $this->getTagsAndFav($node->getId());
-			}
-			return $isFav;
-		});
-	}
+        $propFind->handle(self::FAVORITE_PROPERTYNAME, function() use ($isFav, $node) {
+            if (is_null($isFav)) {
+                list(, $isFav) = $this->getTagsAndFav($node->getId());
+            }
+            return $isFav;
+        });
+    }
 
-	/**
-	 * Updates tags and favorites properties, if applicable.
-	 *
-	 * @param string $path
-	 * @param PropPatch $propPatch
-	 *
-	 * @return void
-	 */
-	public function handleUpdateProperties($path, PropPatch $propPatch) {
-		$propPatch->handle(self::TAGS_PROPERTYNAME, function($tagList) use ($path) {
-			$node = $this->tree->getNodeForPath($path);
-			if (is_null($node)) {
-				return 404;
-			}
-			$this->updateTags($node->getId(), $tagList->getTags());
-			return true;
-		});
+    /**
+     * Updates tags and favorites properties, if applicable.
+     *
+     * @param string $path
+     * @param PropPatch $propPatch
+     *
+     * @return void
+     */
+    public function handleUpdateProperties($path, PropPatch $propPatch) {
+        $propPatch->handle(self::TAGS_PROPERTYNAME, function($tagList) use ($path) {
+            $node = $this->tree->getNodeForPath($path);
+            if (is_null($node)) {
+                return 404;
+            }
+            $this->updateTags($node->getId(), $tagList->getTags());
+            return true;
+        });
 
-		$propPatch->handle(self::FAVORITE_PROPERTYNAME, function($favState) use ($path) {
-			$node = $this->tree->getNodeForPath($path);
-			if (is_null($node)) {
-				return 404;
-			}
-			if ((int)$favState === 1 || $favState === 'true') {
-				$this->getTagger()->tagAs($node->getId(), self::TAG_FAVORITE);
-			} else {
-				$this->getTagger()->unTag($node->getId(), self::TAG_FAVORITE);
-			}
+        $propPatch->handle(self::FAVORITE_PROPERTYNAME, function($favState) use ($path) {
+            $node = $this->tree->getNodeForPath($path);
+            if (is_null($node)) {
+                return 404;
+            }
+            if ((int)$favState === 1 || $favState === 'true') {
+                $this->getTagger()->tagAs($node->getId(), self::TAG_FAVORITE);
+            } else {
+                $this->getTagger()->unTag($node->getId(), self::TAG_FAVORITE);
+            }
 
-			if (is_null($favState)) {
-				// confirm deletion
-				return 204;
-			}
+            if (is_null($favState)) {
+                // confirm deletion
+                return 204;
+            }
 
-			return 200;
-		});
-	}
+            return 200;
+        });
+    }
 }

apps/dav/lib/DAV/Sharing/Plugin.php

Unused Use Statements -1 removed lines

@@ -24,7 +24,6 @@
 use OCA\DAV\Connector\Sabre\Auth;
 use OCA\DAV\DAV\Sharing\Xml\Invite;
 use OCP\IRequest;
-use Sabre\DAV\Exception\BadRequest;
 use Sabre\DAV\Exception\NotFound;
 use Sabre\DAV\INode;
 use Sabre\DAV\PropFind;

Indentation +161 added lines, -161 removed lines

@@ -36,166 +36,166 @@
 
 class Plugin extends ServerPlugin {
 
-	const NS_OWNCLOUD = 'http://owncloud.org/ns';
-
-	/** @var Auth */
-	private $auth;
-
-	/** @var IRequest */
-	private $request;
-
-	/**
-	 * Plugin constructor.
-	 *
-	 * @param Auth $authBackEnd
-	 * @param IRequest $request
-	 */
-	public function __construct(Auth $authBackEnd, IRequest $request) {
-		$this->auth = $authBackEnd;
-		$this->request = $request;
-	}
-
-	/**
-	 * Reference to SabreDAV server object.
-	 *
-	 * @var \Sabre\DAV\Server
-	 */
-	protected $server;
-
-	/**
-	 * This method should return a list of server-features.
-	 *
-	 * This is for example 'versioning' and is added to the DAV: header
-	 * in an OPTIONS response.
-	 *
-	 * @return string[]
-	 */
-	function getFeatures() {
-		return ['oc-resource-sharing'];
-	}
-
-	/**
-	 * Returns a plugin name.
-	 *
-	 * Using this name other plugins will be able to access other plugins
-	 * using Sabre\DAV\Server::getPlugin
-	 *
-	 * @return string
-	 */
-	function getPluginName() {
-		return 'oc-resource-sharing';
-	}
-
-	/**
-	 * This initializes the plugin.
-	 *
-	 * This function is called by Sabre\DAV\Server, after
-	 * addPlugin is called.
-	 *
-	 * This method should set up the required event subscriptions.
-	 *
-	 * @param Server $server
-	 * @return void
-	 */
-	function initialize(Server $server) {
-		$this->server = $server;
-		$this->server->xml->elementMap['{' . Plugin::NS_OWNCLOUD . '}share'] = 'OCA\\DAV\\DAV\\Sharing\\Xml\\ShareRequest';
-		$this->server->xml->elementMap['{' . Plugin::NS_OWNCLOUD . '}invite'] = 'OCA\\DAV\\DAV\\Sharing\\Xml\\Invite';
-
-		$this->server->on('method:POST', [$this, 'httpPost']);
-		$this->server->on('propFind',    [$this, 'propFind']);
-	}
-
-	/**
-	 * We intercept this to handle POST requests on a dav resource.
-	 *
-	 * @param RequestInterface $request
-	 * @param ResponseInterface $response
-	 * @return null|false
-	 */
-	function httpPost(RequestInterface $request, ResponseInterface $response) {
-
-		$path = $request->getPath();
-
-		// Only handling xml
-		$contentType = $request->getHeader('Content-Type');
-		if (strpos($contentType, 'application/xml') === false && strpos($contentType, 'text/xml') === false)
-			return;
-
-		// Making sure the node exists
-		try {
-			$node = $this->server->tree->getNodeForPath($path);
-		} catch (NotFound $e) {
-			return;
-		}
-
-		$requestBody = $request->getBodyAsString();
-
-		// If this request handler could not deal with this POST request, it
-		// will return 'null' and other plugins get a chance to handle the
-		// request.
-		//
-		// However, we already requested the full body. This is a problem,
-		// because a body can only be read once. This is why we preemptively
-		// re-populated the request body with the existing data.
-		$request->setBody($requestBody);
-
-		$message = $this->server->xml->parse($requestBody, $request->getUrl(), $documentType);
-
-		switch ($documentType) {
-
-			// Dealing with the 'share' document, which modified invitees on a
-			// calendar.
-			case '{' . self::NS_OWNCLOUD . '}share' :
-
-				// We can only deal with IShareableCalendar objects
-				if (!$node instanceof IShareable) {
-					return;
-				}
-
-				$this->server->transactionType = 'post-oc-resource-share';
-
-				// Getting ACL info
-				$acl = $this->server->getPlugin('acl');
-
-				// If there's no ACL support, we allow everything
-				if ($acl) {
-					/** @var \Sabre\DAVACL\Plugin $acl */
-					$acl->checkPrivileges($path, '{DAV:}write');
-				}
-
-				$node->updateShares($message->set, $message->remove);
-
-				$response->setStatus(200);
-				// Adding this because sending a response body may cause issues,
-				// and I wanted some type of indicator the response was handled.
-				$response->setHeader('X-Sabre-Status', 'everything-went-well');
-
-				// Breaking the event chain
-				return false;
-		}
-	}
-
-	/**
-	 * This event is triggered when properties are requested for a certain
-	 * node.
-	 *
-	 * This allows us to inject any properties early.
-	 *
-	 * @param PropFind $propFind
-	 * @param INode $node
-	 * @return void
-	 */
-	function propFind(PropFind $propFind, INode $node) {
-		if ($node instanceof IShareable) {
-
-			$propFind->handle('{' . Plugin::NS_OWNCLOUD . '}invite', function() use ($node) {
-				return new Invite(
-					$node->getShares()
-				);
-			});
-
-		}
-	}
+    const NS_OWNCLOUD = 'http://owncloud.org/ns';
+
+    /** @var Auth */
+    private $auth;
+
+    /** @var IRequest */
+    private $request;
+
+    /**
+     * Plugin constructor.
+     *
+     * @param Auth $authBackEnd
+     * @param IRequest $request
+     */
+    public function __construct(Auth $authBackEnd, IRequest $request) {
+        $this->auth = $authBackEnd;
+        $this->request = $request;
+    }
+
+    /**
+     * Reference to SabreDAV server object.
+     *
+     * @var \Sabre\DAV\Server
+     */
+    protected $server;
+
+    /**
+     * This method should return a list of server-features.
+     *
+     * This is for example 'versioning' and is added to the DAV: header
+     * in an OPTIONS response.
+     *
+     * @return string[]
+     */
+    function getFeatures() {
+        return ['oc-resource-sharing'];
+    }
+
+    /**
+     * Returns a plugin name.
+     *
+     * Using this name other plugins will be able to access other plugins
+     * using Sabre\DAV\Server::getPlugin
+     *
+     * @return string
+     */
+    function getPluginName() {
+        return 'oc-resource-sharing';
+    }
+
+    /**
+     * This initializes the plugin.
+     *
+     * This function is called by Sabre\DAV\Server, after
+     * addPlugin is called.
+     *
+     * This method should set up the required event subscriptions.
+     *
+     * @param Server $server
+     * @return void
+     */
+    function initialize(Server $server) {
+        $this->server = $server;
+        $this->server->xml->elementMap['{' . Plugin::NS_OWNCLOUD . '}share'] = 'OCA\\DAV\\DAV\\Sharing\\Xml\\ShareRequest';
+        $this->server->xml->elementMap['{' . Plugin::NS_OWNCLOUD . '}invite'] = 'OCA\\DAV\\DAV\\Sharing\\Xml\\Invite';
+
+        $this->server->on('method:POST', [$this, 'httpPost']);
+        $this->server->on('propFind',    [$this, 'propFind']);
+    }
+
+    /**
+     * We intercept this to handle POST requests on a dav resource.
+     *
+     * @param RequestInterface $request
+     * @param ResponseInterface $response
+     * @return null|false
+     */
+    function httpPost(RequestInterface $request, ResponseInterface $response) {
+
+        $path = $request->getPath();
+
+        // Only handling xml
+        $contentType = $request->getHeader('Content-Type');
+        if (strpos($contentType, 'application/xml') === false && strpos($contentType, 'text/xml') === false)
+            return;
+
+        // Making sure the node exists
+        try {
+            $node = $this->server->tree->getNodeForPath($path);
+        } catch (NotFound $e) {
+            return;
+        }
+
+        $requestBody = $request->getBodyAsString();
+
+        // If this request handler could not deal with this POST request, it
+        // will return 'null' and other plugins get a chance to handle the
+        // request.
+        //
+        // However, we already requested the full body. This is a problem,
+        // because a body can only be read once. This is why we preemptively
+        // re-populated the request body with the existing data.
+        $request->setBody($requestBody);
+
+        $message = $this->server->xml->parse($requestBody, $request->getUrl(), $documentType);
+
+        switch ($documentType) {
+
+            // Dealing with the 'share' document, which modified invitees on a
+            // calendar.
+            case '{' . self::NS_OWNCLOUD . '}share' :
+
+                // We can only deal with IShareableCalendar objects
+                if (!$node instanceof IShareable) {
+                    return;
+                }
+
+                $this->server->transactionType = 'post-oc-resource-share';
+
+                // Getting ACL info
+                $acl = $this->server->getPlugin('acl');
+
+                // If there's no ACL support, we allow everything
+                if ($acl) {
+                    /** @var \Sabre\DAVACL\Plugin $acl */
+                    $acl->checkPrivileges($path, '{DAV:}write');
+                }
+
+                $node->updateShares($message->set, $message->remove);
+
+                $response->setStatus(200);
+                // Adding this because sending a response body may cause issues,
+                // and I wanted some type of indicator the response was handled.
+                $response->setHeader('X-Sabre-Status', 'everything-went-well');
+
+                // Breaking the event chain
+                return false;
+        }
+    }
+
+    /**
+     * This event is triggered when properties are requested for a certain
+     * node.
+     *
+     * This allows us to inject any properties early.
+     *
+     * @param PropFind $propFind
+     * @param INode $node
+     * @return void
+     */
+    function propFind(PropFind $propFind, INode $node) {
+        if ($node instanceof IShareable) {
+
+            $propFind->handle('{' . Plugin::NS_OWNCLOUD . '}invite', function() use ($node) {
+                return new Invite(
+                    $node->getShares()
+                );
+            });
+
+        }
+    }
 
 }

Spacing +5 added lines, -5 removed lines

@@ -99,11 +99,11 @@ 
 	 */
 	function initialize(Server $server) {
 		$this->server = $server;
-		$this->server->xml->elementMap['{' . Plugin::NS_OWNCLOUD . '}share'] = 'OCA\\DAV\\DAV\\Sharing\\Xml\\ShareRequest';
-		$this->server->xml->elementMap['{' . Plugin::NS_OWNCLOUD . '}invite'] = 'OCA\\DAV\\DAV\\Sharing\\Xml\\Invite';
+		$this->server->xml->elementMap['{'.Plugin::NS_OWNCLOUD.'}share'] = 'OCA\\DAV\\DAV\\Sharing\\Xml\\ShareRequest';
+		$this->server->xml->elementMap['{'.Plugin::NS_OWNCLOUD.'}invite'] = 'OCA\\DAV\\DAV\\Sharing\\Xml\\Invite';
 
 		$this->server->on('method:POST', [$this, 'httpPost']);
-		$this->server->on('propFind',    [$this, 'propFind']);
+		$this->server->on('propFind', [$this, 'propFind']);
 	}
 
 	/**
@@ -146,7 +146,7 @@ 
 
 			// Dealing with the 'share' document, which modified invitees on a
 			// calendar.
-			case '{' . self::NS_OWNCLOUD . '}share' :
+			case '{'.self::NS_OWNCLOUD.'}share' :
 
 				// We can only deal with IShareableCalendar objects
 				if (!$node instanceof IShareable) {
@@ -189,7 +189,7 @@ 
 	function propFind(PropFind $propFind, INode $node) {
 		if ($node instanceof IShareable) {
 
-			$propFind->handle('{' . Plugin::NS_OWNCLOUD . '}invite', function() use ($node) {
+			$propFind->handle('{'.Plugin::NS_OWNCLOUD.'}invite', function() use ($node) {
 				return new Invite(
 					$node->getShares()
 				);

Braces +3 added lines, -2 removed lines

@@ -119,8 +119,9 @@
 
 		// Only handling xml
 		$contentType = $request->getHeader('Content-Type');
-		if (strpos($contentType, 'application/xml') === false && strpos($contentType, 'text/xml') === false)
-			return;
+		if (strpos($contentType, 'application/xml') === false && strpos($contentType, 'text/xml') === false) {
+					return;
+		}
 
 		// Making sure the node exists
 		try {

apps/dav/lib/DAV/SystemPrincipalBackend.php

Doc Comments +1 added lines, -1 removed lines

@@ -132,7 +132,7 @@
 	 * Returns the list of members for a group-principal
 	 *
 	 * @param string $principal
-	 * @return array
+	 * @return string[]
 	 */
 	function getGroupMemberSet($principal) {
 		// TODO: for now the group principal has only one member, the user itself

Indentation +150 added lines, -150 removed lines

@@ -27,154 +27,154 @@
 
 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) {
-
-		if ($path === 'principals/system/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');
-	}
+    /**
+     * 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) {
+
+        if ($path === 'principals/system/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');
+    }
 }