nextcloud / server

apps/federation/lib/Hooks.php

Indentation +20 added lines, -20 removed lines

@@ -27,25 +27,25 @@
 
 class Hooks {
 
-	/** @var TrustedServers */
-	private $trustedServers;
-
-	public function __construct(TrustedServers $trustedServers) {
-		$this->trustedServers = $trustedServers;
-	}
-
-	/**
-	 * add servers to the list of trusted servers once a federated share was established
-	 *
-	 * @param array $params
-	 */
-	public function addServerHook($params) {
-		if (
-			$this->trustedServers->getAutoAddServers() === true &&
-			$this->trustedServers->isTrustedServer($params['server']) === false
-		) {
-			$this->trustedServers->addServer($params['server']);
-		}
-	}
+    /** @var TrustedServers */
+    private $trustedServers;
+
+    public function __construct(TrustedServers $trustedServers) {
+        $this->trustedServers = $trustedServers;
+    }
+
+    /**
+     * add servers to the list of trusted servers once a federated share was established
+     *
+     * @param array $params
+     */
+    public function addServerHook($params) {
+        if (
+            $this->trustedServers->getAutoAddServers() === true &&
+            $this->trustedServers->isTrustedServer($params['server']) === false
+        ) {
+            $this->trustedServers->addServer($params['server']);
+        }
+    }
 
 }

apps/dav/lib/DAV/PublicAuth.php

Indentation +58 added lines, -58 removed lines

@@ -26,67 +26,67 @@
 
 class PublicAuth implements BackendInterface {
 
-	/** @var string[] */
-	private $publicURLs;
+    /** @var string[] */
+    private $publicURLs;
 
-	public function __construct() {
-		$this->publicURLs = [
-			'public-calendars',
-			'principals/system/public'
-		];
-	}
+    public function __construct() {
+        $this->publicURLs = [
+            'public-calendars',
+            'principals/system/public'
+        ];
+    }
 
-	/**
-	 * When this method is called, the backend must check if authentication was
-	 * successful.
-	 *
-	 * The returned value must be one of the following
-	 *
-	 * [true, "principals/username"]
-	 * [false, "reason for failure"]
-	 *
-	 * If authentication was successful, it's expected that the authentication
-	 * backend returns a so-called principal url.
-	 *
-	 * Examples of a principal url:
-	 *
-	 * principals/admin
-	 * principals/user1
-	 * principals/users/joe
-	 * principals/uid/123457
-	 *
-	 * If you don't use WebDAV ACL (RFC3744) we recommend that you simply
-	 * return a string such as:
-	 *
-	 * principals/users/[username]
-	 *
-	 * @param RequestInterface $request
-	 * @param ResponseInterface $response
-	 * @return array
-	 */
-	function check(RequestInterface $request, ResponseInterface $response) {
+    /**
+     * When this method is called, the backend must check if authentication was
+     * successful.
+     *
+     * The returned value must be one of the following
+     *
+     * [true, "principals/username"]
+     * [false, "reason for failure"]
+     *
+     * If authentication was successful, it's expected that the authentication
+     * backend returns a so-called principal url.
+     *
+     * Examples of a principal url:
+     *
+     * principals/admin
+     * principals/user1
+     * principals/users/joe
+     * principals/uid/123457
+     *
+     * If you don't use WebDAV ACL (RFC3744) we recommend that you simply
+     * return a string such as:
+     *
+     * principals/users/[username]
+     *
+     * @param RequestInterface $request
+     * @param ResponseInterface $response
+     * @return array
+     */
+    function check(RequestInterface $request, ResponseInterface $response) {
 
-		if ($this->isRequestPublic($request)) {
-			return [true, "principals/system/public"];
-		}
-		return [false, "No public access to this resource."];
-	}
+        if ($this->isRequestPublic($request)) {
+            return [true, "principals/system/public"];
+        }
+        return [false, "No public access to this resource."];
+    }
 
-	/**
-	 * @inheritdoc
-	 */
-	function challenge(RequestInterface $request, ResponseInterface $response) {
-	}
+    /**
+     * @inheritdoc
+     */
+    function challenge(RequestInterface $request, ResponseInterface $response) {
+    }
 
-	/**
-	 * @param RequestInterface $request
-	 * @return bool
-	 */
-	private function isRequestPublic(RequestInterface $request) {
-		$url = $request->getPath();
-		$matchingUrls = array_filter($this->publicURLs, function ($publicUrl) use ($url) {
-			return strpos($url, $publicUrl, 0) === 0;
-		});
-		return !empty($matchingUrls);
-	}
+    /**
+     * @param RequestInterface $request
+     * @return bool
+     */
+    private function isRequestPublic(RequestInterface $request) {
+        $url = $request->getPath();
+        $matchingUrls = array_filter($this->publicURLs, function ($publicUrl) use ($url) {
+            return strpos($url, $publicUrl, 0) === 0;
+        });
+        return !empty($matchingUrls);
+    }
 }

apps/dav/lib/DAV/Sharing/Xml/Invite.php

Indentation +126 added lines, -126 removed lines

@@ -41,130 +41,130 @@
  */
 class Invite implements XmlSerializable {
 
-	/**
-	 * The list of users a calendar has been shared to.
-	 *
-	 * @var array
-	 */
-	protected $users;
-
-	/**
-	 * The organizer contains information about the person who shared the
-	 * object.
-	 *
-	 * @var array|null
-	 */
-	protected $organizer;
-
-	/**
-	 * Creates the property.
-	 *
-	 * Users is an array. Each element of the array has the following
-	 * properties:
-	 *
-	 *   * href - Often a mailto: address
-	 *   * commonName - Optional, for example a first and lastname for a user.
-	 *   * status - One of the SharingPlugin::STATUS_* constants.
-	 *   * readOnly - true or false
-	 *   * summary - Optional, description of the share
-	 *
-	 * The organizer key is optional to specify. It's only useful when a
-	 * 'sharee' requests the sharing information.
-	 *
-	 * The organizer may have the following properties:
-	 *   * href - Often a mailto: address.
-	 *   * commonName - Optional human-readable name.
-	 *   * firstName - Optional first name.
-	 *   * lastName - Optional last name.
-	 *
-	 * If you wonder why these two structures are so different, I guess a
-	 * valid answer is that the current spec is still a draft.
-	 *
-	 * @param array $users
-	 */
-	function __construct(array $users, array $organizer = null) {
-
-		$this->users = $users;
-		$this->organizer = $organizer;
-
-	}
-
-	/**
-	 * Returns the list of users, as it was passed to the constructor.
-	 *
-	 * @return array
-	 */
-	function getValue() {
-
-		return $this->users;
-
-	}
-
-	/**
-	 * 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) {
-
-		$cs = '{' . Plugin::NS_OWNCLOUD . '}';
-
-		if (!is_null($this->organizer)) {
-
-			$writer->startElement($cs . 'organizer');
-			$writer->writeElement('{DAV:}href', $this->organizer['href']);
-
-			if (isset($this->organizer['commonName']) && $this->organizer['commonName']) {
-				$writer->writeElement($cs . 'common-name', $this->organizer['commonName']);
-			}
-			if (isset($this->organizer['firstName']) && $this->organizer['firstName']) {
-				$writer->writeElement($cs . 'first-name', $this->organizer['firstName']);
-			}
-			if (isset($this->organizer['lastName']) && $this->organizer['lastName']) {
-				$writer->writeElement($cs . 'last-name', $this->organizer['lastName']);
-			}
-			$writer->endElement(); // organizer
-
-		}
-
-		foreach ($this->users as $user) {
-
-			$writer->startElement($cs . 'user');
-			$writer->writeElement('{DAV:}href', $user['href']);
-			if (isset($user['commonName']) && $user['commonName']) {
-				$writer->writeElement($cs . 'common-name', $user['commonName']);
-			}
-			$writer->writeElement($cs . 'invite-accepted');
-
-			$writer->startElement($cs . 'access');
-			if ($user['readOnly']) {
-				$writer->writeElement($cs . 'read');
-			} else {
-				$writer->writeElement($cs . 'read-write');
-			}
-			$writer->endElement(); // access
-
-			if (isset($user['summary']) && $user['summary']) {
-				$writer->writeElement($cs . 'summary', $user['summary']);
-			}
-
-			$writer->endElement(); //user
-
-		}
-
-	}
+    /**
+     * The list of users a calendar has been shared to.
+     *
+     * @var array
+     */
+    protected $users;
+
+    /**
+     * The organizer contains information about the person who shared the
+     * object.
+     *
+     * @var array|null
+     */
+    protected $organizer;
+
+    /**
+     * Creates the property.
+     *
+     * Users is an array. Each element of the array has the following
+     * properties:
+     *
+     *   * href - Often a mailto: address
+     *   * commonName - Optional, for example a first and lastname for a user.
+     *   * status - One of the SharingPlugin::STATUS_* constants.
+     *   * readOnly - true or false
+     *   * summary - Optional, description of the share
+     *
+     * The organizer key is optional to specify. It's only useful when a
+     * 'sharee' requests the sharing information.
+     *
+     * The organizer may have the following properties:
+     *   * href - Often a mailto: address.
+     *   * commonName - Optional human-readable name.
+     *   * firstName - Optional first name.
+     *   * lastName - Optional last name.
+     *
+     * If you wonder why these two structures are so different, I guess a
+     * valid answer is that the current spec is still a draft.
+     *
+     * @param array $users
+     */
+    function __construct(array $users, array $organizer = null) {
+
+        $this->users = $users;
+        $this->organizer = $organizer;
+
+    }
+
+    /**
+     * Returns the list of users, as it was passed to the constructor.
+     *
+     * @return array
+     */
+    function getValue() {
+
+        return $this->users;
+
+    }
+
+    /**
+     * 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) {
+
+        $cs = '{' . Plugin::NS_OWNCLOUD . '}';
+
+        if (!is_null($this->organizer)) {
+
+            $writer->startElement($cs . 'organizer');
+            $writer->writeElement('{DAV:}href', $this->organizer['href']);
+
+            if (isset($this->organizer['commonName']) && $this->organizer['commonName']) {
+                $writer->writeElement($cs . 'common-name', $this->organizer['commonName']);
+            }
+            if (isset($this->organizer['firstName']) && $this->organizer['firstName']) {
+                $writer->writeElement($cs . 'first-name', $this->organizer['firstName']);
+            }
+            if (isset($this->organizer['lastName']) && $this->organizer['lastName']) {
+                $writer->writeElement($cs . 'last-name', $this->organizer['lastName']);
+            }
+            $writer->endElement(); // organizer
+
+        }
+
+        foreach ($this->users as $user) {
+
+            $writer->startElement($cs . 'user');
+            $writer->writeElement('{DAV:}href', $user['href']);
+            if (isset($user['commonName']) && $user['commonName']) {
+                $writer->writeElement($cs . 'common-name', $user['commonName']);
+            }
+            $writer->writeElement($cs . 'invite-accepted');
+
+            $writer->startElement($cs . 'access');
+            if ($user['readOnly']) {
+                $writer->writeElement($cs . 'read');
+            } else {
+                $writer->writeElement($cs . 'read-write');
+            }
+            $writer->endElement(); // access
+
+            if (isset($user['summary']) && $user['summary']) {
+                $writer->writeElement($cs . 'summary', $user['summary']);
+            }
+
+            $writer->endElement(); //user
+
+        }
+
+    }
 }

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

Indentation +40 added lines, -40 removed lines

@@ -28,48 +28,48 @@
  */
 interface IShareable extends INode {
 
-	/**
-	 * Updates the list of shares.
-	 *
-	 * The first array is a list of people that are to be added to the
-	 * resource.
-	 *
-	 * Every element in the add array has the following properties:
-	 *   * href - A url. Usually a mailto: address
-	 *   * commonName - Usually a first and last name, or false
-	 *   * summary - A description of the share, can also be false
-	 *   * readOnly - A boolean value
-	 *
-	 * Every element in the remove array is just the address string.
-	 *
-	 * @param array $add
-	 * @param array $remove
-	 * @return void
-	 */
-	function updateShares(array $add, array $remove);
+    /**
+     * Updates the list of shares.
+     *
+     * The first array is a list of people that are to be added to the
+     * resource.
+     *
+     * Every element in the add array has the following properties:
+     *   * href - A url. Usually a mailto: address
+     *   * commonName - Usually a first and last name, or false
+     *   * summary - A description of the share, can also be false
+     *   * readOnly - A boolean value
+     *
+     * Every element in the remove array is just the address string.
+     *
+     * @param array $add
+     * @param array $remove
+     * @return void
+     */
+    function updateShares(array $add, array $remove);
 
-	/**
-	 * Returns the list of people whom this resource is shared with.
-	 *
-	 * Every element in this array should have the following properties:
-	 *   * href - Often a mailto: address
-	 *   * commonName - Optional, for example a first + last name
-	 *   * status - See the Sabre\CalDAV\SharingPlugin::STATUS_ constants.
-	 *   * readOnly - boolean
-	 *   * summary - Optional, a description for the share
-	 *
-	 * @return array
-	 */
-	function getShares();
+    /**
+     * Returns the list of people whom this resource is shared with.
+     *
+     * Every element in this array should have the following properties:
+     *   * href - Often a mailto: address
+     *   * commonName - Optional, for example a first + last name
+     *   * status - See the Sabre\CalDAV\SharingPlugin::STATUS_ constants.
+     *   * readOnly - boolean
+     *   * summary - Optional, a description for the share
+     *
+     * @return array
+     */
+    function getShares();
 
-	/**
-	 * @return int
-	 */
-	public function getResourceId();
+    /**
+     * @return int
+     */
+    public function getResourceId();
 
-	/**
-	 * @return string
-	 */
-	public function getOwner();
+    /**
+     * @return string
+     */
+    public function getOwner();
 
 }
\ No newline at end of file

apps/dav/lib/Comments/EntityTypeCollection.php

Indentation +74 added lines, -74 removed lines

@@ -43,85 +43,85 @@
  */
 class EntityTypeCollection extends RootCollection {
 
-	/** @var ILogger */
-	protected $logger;
+    /** @var ILogger */
+    protected $logger;
 
-	/** @var IUserManager */
-	protected $userManager;
+    /** @var IUserManager */
+    protected $userManager;
 
-	/** @var \Closure */
-	protected $childExistsFunction;
+    /** @var \Closure */
+    protected $childExistsFunction;
 
-	/**
-	 * @param string $name
-	 * @param ICommentsManager $commentsManager
-	 * @param IUserManager $userManager
-	 * @param IUserSession $userSession
-	 * @param ILogger $logger
-	 * @param \Closure $childExistsFunction
-	 */
-	public function __construct(
-		$name,
-		ICommentsManager $commentsManager,
-		IUserManager $userManager,
-		IUserSession $userSession,
-		ILogger $logger,
-		\Closure $childExistsFunction
-	) {
-		$name = trim($name);
-		if(empty($name) || !is_string($name)) {
-			throw new \InvalidArgumentException('"name" parameter must be non-empty string');
-		}
-		$this->name = $name;
-		$this->commentsManager = $commentsManager;
-		$this->logger = $logger;
-		$this->userManager = $userManager;
-		$this->userSession = $userSession;
-		$this->childExistsFunction = $childExistsFunction;
-	}
+    /**
+     * @param string $name
+     * @param ICommentsManager $commentsManager
+     * @param IUserManager $userManager
+     * @param IUserSession $userSession
+     * @param ILogger $logger
+     * @param \Closure $childExistsFunction
+     */
+    public function __construct(
+        $name,
+        ICommentsManager $commentsManager,
+        IUserManager $userManager,
+        IUserSession $userSession,
+        ILogger $logger,
+        \Closure $childExistsFunction
+    ) {
+        $name = trim($name);
+        if(empty($name) || !is_string($name)) {
+            throw new \InvalidArgumentException('"name" parameter must be non-empty string');
+        }
+        $this->name = $name;
+        $this->commentsManager = $commentsManager;
+        $this->logger = $logger;
+        $this->userManager = $userManager;
+        $this->userSession = $userSession;
+        $this->childExistsFunction = $childExistsFunction;
+    }
 
-	/**
-	 * Returns a specific child node, referenced by its name
-	 *
-	 * This method must throw Sabre\DAV\Exception\NotFound if the node does not
-	 * exist.
-	 *
-	 * @param string $name
-	 * @return \Sabre\DAV\INode
-	 * @throws NotFound
-	 */
-	function getChild($name) {
-		if(!$this->childExists($name)) {
-			throw new NotFound('Entity does not exist or is not available');
-		}
-		return new EntityCollection(
-			$name,
-			$this->name,
-			$this->commentsManager,
-			$this->userManager,
-			$this->userSession,
-			$this->logger
-		);
-	}
+    /**
+     * Returns a specific child node, referenced by its name
+     *
+     * This method must throw Sabre\DAV\Exception\NotFound if the node does not
+     * exist.
+     *
+     * @param string $name
+     * @return \Sabre\DAV\INode
+     * @throws NotFound
+     */
+    function getChild($name) {
+        if(!$this->childExists($name)) {
+            throw new NotFound('Entity does not exist or is not available');
+        }
+        return new EntityCollection(
+            $name,
+            $this->name,
+            $this->commentsManager,
+            $this->userManager,
+            $this->userSession,
+            $this->logger
+        );
+    }
 
-	/**
-	 * Returns an array with all the child nodes
-	 *
-	 * @return \Sabre\DAV\INode[]
-	 * @throws MethodNotAllowed
-	 */
-	function getChildren() {
-		throw new MethodNotAllowed('No permission to list folder contents');
-	}
+    /**
+     * Returns an array with all the child nodes
+     *
+     * @return \Sabre\DAV\INode[]
+     * @throws MethodNotAllowed
+     */
+    function getChildren() {
+        throw new MethodNotAllowed('No permission to list folder contents');
+    }
 
-	/**
-	 * Checks if a child-node with the specified name exists
-	 *
-	 * @param string $name
-	 * @return bool
-	 */
-	function childExists($name) {
-		return call_user_func($this->childExistsFunction, $name);
-	}
+    /**
+     * Checks if a child-node with the specified name exists
+     *
+     * @param string $name
+     * @return bool
+     */
+    function childExists($name) {
+        return call_user_func($this->childExistsFunction, $name);
+    }
 
 }

apps/dav/lib/Comments/CommentNode.php

Indentation +241 added lines, -241 removed lines

@@ -36,270 +36,270 @@
 use Sabre\DAV\PropPatch;
 
 class CommentNode implements \Sabre\DAV\INode, \Sabre\DAV\IProperties {
-	const NS_OWNCLOUD = 'http://owncloud.org/ns';
+    const NS_OWNCLOUD = 'http://owncloud.org/ns';
 
-	const PROPERTY_NAME_UNREAD = '{http://owncloud.org/ns}isUnread';
-	const PROPERTY_NAME_MESSAGE = '{http://owncloud.org/ns}message';
-	const PROPERTY_NAME_ACTOR_DISPLAYNAME = '{http://owncloud.org/ns}actorDisplayName';
-	const PROPERTY_NAME_MENTIONS = '{http://owncloud.org/ns}mentions';
-	const PROPERTY_NAME_MENTION = '{http://owncloud.org/ns}mention';
-	const PROPERTY_NAME_MENTION_TYPE = '{http://owncloud.org/ns}mentionType';
-	const PROPERTY_NAME_MENTION_ID = '{http://owncloud.org/ns}mentionId';
-	const PROPERTY_NAME_MENTION_DISPLAYNAME = '{http://owncloud.org/ns}mentionDisplayName';
+    const PROPERTY_NAME_UNREAD = '{http://owncloud.org/ns}isUnread';
+    const PROPERTY_NAME_MESSAGE = '{http://owncloud.org/ns}message';
+    const PROPERTY_NAME_ACTOR_DISPLAYNAME = '{http://owncloud.org/ns}actorDisplayName';
+    const PROPERTY_NAME_MENTIONS = '{http://owncloud.org/ns}mentions';
+    const PROPERTY_NAME_MENTION = '{http://owncloud.org/ns}mention';
+    const PROPERTY_NAME_MENTION_TYPE = '{http://owncloud.org/ns}mentionType';
+    const PROPERTY_NAME_MENTION_ID = '{http://owncloud.org/ns}mentionId';
+    const PROPERTY_NAME_MENTION_DISPLAYNAME = '{http://owncloud.org/ns}mentionDisplayName';
 
-	/** @var  IComment */
-	public $comment;
+    /** @var  IComment */
+    public $comment;
 
-	/** @var ICommentsManager */
-	protected $commentsManager;
+    /** @var ICommentsManager */
+    protected $commentsManager;
 
-	/** @var  ILogger */
-	protected $logger;
+    /** @var  ILogger */
+    protected $logger;
 
-	/** @var array list of properties with key being their name and value their setter */
-	protected $properties = [];
+    /** @var array list of properties with key being their name and value their setter */
+    protected $properties = [];
 
-	/** @var IUserManager */
-	protected $userManager;
+    /** @var IUserManager */
+    protected $userManager;
 
-	/** @var IUserSession */
-	protected $userSession;
+    /** @var IUserSession */
+    protected $userSession;
 
-	/**
-	 * CommentNode constructor.
-	 *
-	 * @param ICommentsManager $commentsManager
-	 * @param IComment $comment
-	 * @param IUserManager $userManager
-	 * @param IUserSession $userSession
-	 * @param ILogger $logger
-	 */
-	public function __construct(
-		ICommentsManager $commentsManager,
-		IComment $comment,
-		IUserManager $userManager,
-		IUserSession $userSession,
-		ILogger $logger
-	) {
-		$this->commentsManager = $commentsManager;
-		$this->comment = $comment;
-		$this->logger = $logger;
+    /**
+     * CommentNode constructor.
+     *
+     * @param ICommentsManager $commentsManager
+     * @param IComment $comment
+     * @param IUserManager $userManager
+     * @param IUserSession $userSession
+     * @param ILogger $logger
+     */
+    public function __construct(
+        ICommentsManager $commentsManager,
+        IComment $comment,
+        IUserManager $userManager,
+        IUserSession $userSession,
+        ILogger $logger
+    ) {
+        $this->commentsManager = $commentsManager;
+        $this->comment = $comment;
+        $this->logger = $logger;
 
-		$methods = get_class_methods($this->comment);
-		$methods = array_filter($methods, function($name){
-			return strpos($name, 'get') === 0;
-		});
-		foreach($methods as $getter) {
-			if($getter === 'getMentions') {
-				continue;	// special treatment
-			}
-			$name = '{'.self::NS_OWNCLOUD.'}' . lcfirst(substr($getter, 3));
-			$this->properties[$name] = $getter;
-		}
-		$this->userManager = $userManager;
-		$this->userSession = $userSession;
-	}
+        $methods = get_class_methods($this->comment);
+        $methods = array_filter($methods, function($name){
+            return strpos($name, 'get') === 0;
+        });
+        foreach($methods as $getter) {
+            if($getter === 'getMentions') {
+                continue;	// special treatment
+            }
+            $name = '{'.self::NS_OWNCLOUD.'}' . lcfirst(substr($getter, 3));
+            $this->properties[$name] = $getter;
+        }
+        $this->userManager = $userManager;
+        $this->userSession = $userSession;
+    }
 
-	/**
-	 * returns a list of all possible property names
-	 *
-	 * @return array
-	 */
-	static public function getPropertyNames() {
-		return [
-			'{http://owncloud.org/ns}id',
-			'{http://owncloud.org/ns}parentId',
-			'{http://owncloud.org/ns}topmostParentId',
-			'{http://owncloud.org/ns}childrenCount',
-			'{http://owncloud.org/ns}verb',
-			'{http://owncloud.org/ns}actorType',
-			'{http://owncloud.org/ns}actorId',
-			'{http://owncloud.org/ns}creationDateTime',
-			'{http://owncloud.org/ns}latestChildDateTime',
-			'{http://owncloud.org/ns}objectType',
-			'{http://owncloud.org/ns}objectId',
-			// re-used property names are defined as constants
-			self::PROPERTY_NAME_MESSAGE,
-			self::PROPERTY_NAME_ACTOR_DISPLAYNAME,
-			self::PROPERTY_NAME_UNREAD,
-			self::PROPERTY_NAME_MENTIONS,
-			self::PROPERTY_NAME_MENTION,
-			self::PROPERTY_NAME_MENTION_TYPE,
-			self::PROPERTY_NAME_MENTION_ID,
-			self::PROPERTY_NAME_MENTION_DISPLAYNAME,
-		];
-	}
+    /**
+     * returns a list of all possible property names
+     *
+     * @return array
+     */
+    static public function getPropertyNames() {
+        return [
+            '{http://owncloud.org/ns}id',
+            '{http://owncloud.org/ns}parentId',
+            '{http://owncloud.org/ns}topmostParentId',
+            '{http://owncloud.org/ns}childrenCount',
+            '{http://owncloud.org/ns}verb',
+            '{http://owncloud.org/ns}actorType',
+            '{http://owncloud.org/ns}actorId',
+            '{http://owncloud.org/ns}creationDateTime',
+            '{http://owncloud.org/ns}latestChildDateTime',
+            '{http://owncloud.org/ns}objectType',
+            '{http://owncloud.org/ns}objectId',
+            // re-used property names are defined as constants
+            self::PROPERTY_NAME_MESSAGE,
+            self::PROPERTY_NAME_ACTOR_DISPLAYNAME,
+            self::PROPERTY_NAME_UNREAD,
+            self::PROPERTY_NAME_MENTIONS,
+            self::PROPERTY_NAME_MENTION,
+            self::PROPERTY_NAME_MENTION_TYPE,
+            self::PROPERTY_NAME_MENTION_ID,
+            self::PROPERTY_NAME_MENTION_DISPLAYNAME,
+        ];
+    }
 
-	protected function checkWriteAccessOnComment() {
-		$user = $this->userSession->getUser();
-		if(    $this->comment->getActorType() !== 'users'
-			|| is_null($user)
-			|| $this->comment->getActorId() !== $user->getUID()
-		) {
-			throw new Forbidden('Only authors are allowed to edit their comment.');
-		}
-	}
+    protected function checkWriteAccessOnComment() {
+        $user = $this->userSession->getUser();
+        if(    $this->comment->getActorType() !== 'users'
+            || is_null($user)
+            || $this->comment->getActorId() !== $user->getUID()
+        ) {
+            throw new Forbidden('Only authors are allowed to edit their comment.');
+        }
+    }
 
-	/**
-	 * Deleted the current node
-	 *
-	 * @return void
-	 */
-	function delete() {
-		$this->checkWriteAccessOnComment();
-		$this->commentsManager->delete($this->comment->getId());
-	}
+    /**
+     * Deleted the current node
+     *
+     * @return void
+     */
+    function delete() {
+        $this->checkWriteAccessOnComment();
+        $this->commentsManager->delete($this->comment->getId());
+    }
 
-	/**
-	 * Returns the name of the node.
-	 *
-	 * This is used to generate the url.
-	 *
-	 * @return string
-	 */
-	function getName() {
-		return $this->comment->getId();
-	}
+    /**
+     * Returns the name of the node.
+     *
+     * This is used to generate the url.
+     *
+     * @return string
+     */
+    function getName() {
+        return $this->comment->getId();
+    }
 
-	/**
-	 * Renames the node
-	 *
-	 * @param string $name The new name
-	 * @throws MethodNotAllowed
-	 */
-	function setName($name) {
-		throw new MethodNotAllowed();
-	}
+    /**
+     * Renames the node
+     *
+     * @param string $name The new name
+     * @throws MethodNotAllowed
+     */
+    function setName($name) {
+        throw new MethodNotAllowed();
+    }
 
-	/**
-	 * Returns the last modification time, as a unix timestamp
-	 *
-	 * @return int
-	 */
-	function getLastModified() {
-		return null;
-	}
+    /**
+     * Returns the last modification time, as a unix timestamp
+     *
+     * @return int
+     */
+    function getLastModified() {
+        return null;
+    }
 
-	/**
-	 * update the comment's message
-	 *
-	 * @param $propertyValue
-	 * @return bool
-	 * @throws BadRequest
-	 * @throws \Exception
-	 */
-	public function updateComment($propertyValue) {
-		$this->checkWriteAccessOnComment();
-		try {
-			$this->comment->setMessage($propertyValue);
-			$this->commentsManager->save($this->comment);
-			return true;
-		} catch (\Exception $e) {
-			$this->logger->logException($e, ['app' => 'dav/comments']);
-			if($e instanceof MessageTooLongException) {
-				$msg = 'Message exceeds allowed character limit of ';
-				throw new BadRequest($msg . IComment::MAX_MESSAGE_LENGTH, 0, $e);
-			}
-			throw $e;
-		}
-	}
+    /**
+     * update the comment's message
+     *
+     * @param $propertyValue
+     * @return bool
+     * @throws BadRequest
+     * @throws \Exception
+     */
+    public function updateComment($propertyValue) {
+        $this->checkWriteAccessOnComment();
+        try {
+            $this->comment->setMessage($propertyValue);
+            $this->commentsManager->save($this->comment);
+            return true;
+        } catch (\Exception $e) {
+            $this->logger->logException($e, ['app' => 'dav/comments']);
+            if($e instanceof MessageTooLongException) {
+                $msg = 'Message exceeds allowed character limit of ';
+                throw new BadRequest($msg . IComment::MAX_MESSAGE_LENGTH, 0, $e);
+            }
+            throw $e;
+        }
+    }
 
-	/**
-	 * Updates properties on this node.
-	 *
-	 * This method received a PropPatch object, which contains all the
-	 * information about the update.
-	 *
-	 * To update specific properties, call the 'handle' method on this object.
-	 * Read the PropPatch documentation for more information.
-	 *
-	 * @param PropPatch $propPatch
-	 * @return void
-	 */
-	function propPatch(PropPatch $propPatch) {
-		// other properties than 'message' are read only
-		$propPatch->handle(self::PROPERTY_NAME_MESSAGE, [$this, 'updateComment']);
-	}
+    /**
+     * Updates properties on this node.
+     *
+     * This method received a PropPatch object, which contains all the
+     * information about the update.
+     *
+     * To update specific properties, call the 'handle' method on this object.
+     * Read the PropPatch documentation for more information.
+     *
+     * @param PropPatch $propPatch
+     * @return void
+     */
+    function propPatch(PropPatch $propPatch) {
+        // other properties than 'message' are read only
+        $propPatch->handle(self::PROPERTY_NAME_MESSAGE, [$this, 'updateComment']);
+    }
 
-	/**
-	 * Returns a list of properties for this nodes.
-	 *
-	 * The properties list is a list of propertynames the client requested,
-	 * encoded in clark-notation {xmlnamespace}tagname
-	 *
-	 * If the array is empty, it means 'all properties' were requested.
-	 *
-	 * Note that it's fine to liberally give properties back, instead of
-	 * conforming to the list of requested properties.
-	 * The Server class will filter out the extra.
-	 *
-	 * @param array $properties
-	 * @return array
-	 */
-	function getProperties($properties) {
-		$properties = array_keys($this->properties);
+    /**
+     * Returns a list of properties for this nodes.
+     *
+     * The properties list is a list of propertynames the client requested,
+     * encoded in clark-notation {xmlnamespace}tagname
+     *
+     * If the array is empty, it means 'all properties' were requested.
+     *
+     * Note that it's fine to liberally give properties back, instead of
+     * conforming to the list of requested properties.
+     * The Server class will filter out the extra.
+     *
+     * @param array $properties
+     * @return array
+     */
+    function getProperties($properties) {
+        $properties = array_keys($this->properties);
 
-		$result = [];
-		foreach($properties as $property) {
-			$getter = $this->properties[$property];
-			if(method_exists($this->comment, $getter)) {
-				$result[$property] = $this->comment->$getter();
-			}
-		}
+        $result = [];
+        foreach($properties as $property) {
+            $getter = $this->properties[$property];
+            if(method_exists($this->comment, $getter)) {
+                $result[$property] = $this->comment->$getter();
+            }
+        }
 
-		if($this->comment->getActorType() === 'users') {
-			$user = $this->userManager->get($this->comment->getActorId());
-			$displayName = is_null($user) ? null : $user->getDisplayName();
-			$result[self::PROPERTY_NAME_ACTOR_DISPLAYNAME] = $displayName;
-		}
+        if($this->comment->getActorType() === 'users') {
+            $user = $this->userManager->get($this->comment->getActorId());
+            $displayName = is_null($user) ? null : $user->getDisplayName();
+            $result[self::PROPERTY_NAME_ACTOR_DISPLAYNAME] = $displayName;
+        }
 
-		$result[self::PROPERTY_NAME_MENTIONS] = $this->composeMentionsPropertyValue();
+        $result[self::PROPERTY_NAME_MENTIONS] = $this->composeMentionsPropertyValue();
 
-		$unread = null;
-		$user =  $this->userSession->getUser();
-		if(!is_null($user)) {
-			$readUntil = $this->commentsManager->getReadMark(
-				$this->comment->getObjectType(),
-				$this->comment->getObjectId(),
-				$user
-			);
-			if(is_null($readUntil)) {
-				$unread = 'true';
-			} else {
-				$unread = $this->comment->getCreationDateTime() > $readUntil;
-				// re-format for output
-				$unread = $unread ? 'true' : 'false';
-			}
-		}
-		$result[self::PROPERTY_NAME_UNREAD] = $unread;
+        $unread = null;
+        $user =  $this->userSession->getUser();
+        if(!is_null($user)) {
+            $readUntil = $this->commentsManager->getReadMark(
+                $this->comment->getObjectType(),
+                $this->comment->getObjectId(),
+                $user
+            );
+            if(is_null($readUntil)) {
+                $unread = 'true';
+            } else {
+                $unread = $this->comment->getCreationDateTime() > $readUntil;
+                // re-format for output
+                $unread = $unread ? 'true' : 'false';
+            }
+        }
+        $result[self::PROPERTY_NAME_UNREAD] = $unread;
 
-		return $result;
-	}
+        return $result;
+    }
 
-	/**
-	 * transforms a mentions array as returned from IComment->getMentions to an
-	 * array with DAV-compatible structure that can be assigned to the
-	 * PROPERTY_NAME_MENTION property.
-	 *
-	 * @return array
-	 */
-	protected function composeMentionsPropertyValue() {
-		return array_map(function($mention) {
-			try {
-				$displayName = $this->commentsManager->resolveDisplayName($mention['type'], $mention['id']);
-			} catch (\OutOfBoundsException $e) {
-				$this->logger->logException($e);
-				// No displayname, upon client's discretion what to display.
-				$displayName = '';
-			}
+    /**
+     * transforms a mentions array as returned from IComment->getMentions to an
+     * array with DAV-compatible structure that can be assigned to the
+     * PROPERTY_NAME_MENTION property.
+     *
+     * @return array
+     */
+    protected function composeMentionsPropertyValue() {
+        return array_map(function($mention) {
+            try {
+                $displayName = $this->commentsManager->resolveDisplayName($mention['type'], $mention['id']);
+            } catch (\OutOfBoundsException $e) {
+                $this->logger->logException($e);
+                // No displayname, upon client's discretion what to display.
+                $displayName = '';
+            }
 
-			return [
-				self::PROPERTY_NAME_MENTION => [
-					self::PROPERTY_NAME_MENTION_TYPE        => $mention['type'],
-					self::PROPERTY_NAME_MENTION_ID          => $mention['id'],
-					self::PROPERTY_NAME_MENTION_DISPLAYNAME => $displayName,
-				]
-			];
-		}, $this->comment->getMentions());
-	}
+            return [
+                self::PROPERTY_NAME_MENTION => [
+                    self::PROPERTY_NAME_MENTION_TYPE        => $mention['type'],
+                    self::PROPERTY_NAME_MENTION_ID          => $mention['id'],
+                    self::PROPERTY_NAME_MENTION_DISPLAYNAME => $displayName,
+                ]
+            ];
+        }, $this->comment->getMentions());
+    }
 }

apps/dav/lib/Comments/RootCollection.php

Indentation +173 added lines, -173 removed lines

@@ -36,177 +36,177 @@
 
 class RootCollection implements ICollection {
 
-	/** @var EntityTypeCollection[]|null */
-	private $entityTypeCollections;
-
-	/** @var ICommentsManager */
-	protected $commentsManager;
-
-	/** @var string */
-	protected $name = 'comments';
-
-	/** @var ILogger */
-	protected $logger;
-
-	/** @var IUserManager */
-	protected $userManager;
-
-	/** @var IUserSession */
-	protected $userSession;
-
-	/** @var EventDispatcherInterface */
-	protected $dispatcher;
-
-	/**
-	 * @param ICommentsManager $commentsManager
-	 * @param IUserManager $userManager
-	 * @param IUserSession $userSession
-	 * @param EventDispatcherInterface $dispatcher
-	 * @param ILogger $logger
-	 */
-	public function __construct(
-		ICommentsManager $commentsManager,
-		IUserManager $userManager,
-		IUserSession $userSession,
-		EventDispatcherInterface $dispatcher,
-		ILogger $logger)
-	{
-		$this->commentsManager = $commentsManager;
-		$this->logger = $logger;
-		$this->userManager = $userManager;
-		$this->userSession = $userSession;
-		$this->dispatcher = $dispatcher;
-	}
-
-	/**
-	 * initializes the collection. At this point of time, we need the logged in
-	 * user. Since it is not the case when the instance is created, we cannot
-	 * have this in the constructor.
-	 *
-	 * @throws NotAuthenticated
-	 */
-	protected function initCollections() {
-		if($this->entityTypeCollections !== null) {
-			return;
-		}
-		$user = $this->userSession->getUser();
-		if(is_null($user)) {
-			throw new NotAuthenticated();
-		}
-
-		$event = new CommentsEntityEvent(CommentsEntityEvent::EVENT_ENTITY);
-		$this->dispatcher->dispatch(CommentsEntityEvent::EVENT_ENTITY, $event);
-
-		$this->entityTypeCollections = [];
-		foreach ($event->getEntityCollections() as $entity => $entityExistsFunction) {
-			$this->entityTypeCollections[$entity] = new EntityTypeCollection(
-				$entity,
-				$this->commentsManager,
-				$this->userManager,
-				$this->userSession,
-				$this->logger,
-				$entityExistsFunction
-			);
-		}
-	}
-
-	/**
-	 * Creates a new file in the directory
-	 *
-	 * @param string $name Name of the file
-	 * @param resource|string $data Initial payload
-	 * @return null|string
-	 * @throws Forbidden
-	 */
-	function createFile($name, $data = null) {
-		throw new Forbidden('Cannot create comments by id');
-	}
-
-	/**
-	 * Creates a new subdirectory
-	 *
-	 * @param string $name
-	 * @throws Forbidden
-	 */
-	function createDirectory($name) {
-		throw new Forbidden('Permission denied to create collections');
-	}
-
-	/**
-	 * Returns a specific child node, referenced by its name
-	 *
-	 * This method must throw Sabre\DAV\Exception\NotFound if the node does not
-	 * exist.
-	 *
-	 * @param string $name
-	 * @return \Sabre\DAV\INode
-	 * @throws NotFound
-	 */
-	function getChild($name) {
-		$this->initCollections();
-		if(isset($this->entityTypeCollections[$name])) {
-			return $this->entityTypeCollections[$name];
-		}
-		throw new NotFound('Entity type "' . $name . '" not found."');
-	}
-
-	/**
-	 * Returns an array with all the child nodes
-	 *
-	 * @return \Sabre\DAV\INode[]
-	 */
-	function getChildren() {
-		$this->initCollections();
-		return $this->entityTypeCollections;
-	}
-
-	/**
-	 * Checks if a child-node with the specified name exists
-	 *
-	 * @param string $name
-	 * @return bool
-	 */
-	function childExists($name) {
-		$this->initCollections();
-		return isset($this->entityTypeCollections[$name]);
-	}
-
-	/**
-	 * Deleted the current node
-	 *
-	 * @throws Forbidden
-	 */
-	function delete() {
-		throw new Forbidden('Permission denied to delete this collection');
-	}
-
-	/**
-	 * Returns the name of the node.
-	 *
-	 * This is used to generate the url.
-	 *
-	 * @return string
-	 */
-	function getName() {
-		return $this->name;
-	}
-
-	/**
-	 * Renames the node
-	 *
-	 * @param string $name The new name
-	 * @throws Forbidden
-	 */
-	function setName($name) {
-		throw new Forbidden('Permission denied to rename this collection');
-	}
-
-	/**
-	 * Returns the last modification time, as a unix timestamp
-	 *
-	 * @return int
-	 */
-	function getLastModified() {
-		return null;
-	}
+    /** @var EntityTypeCollection[]|null */
+    private $entityTypeCollections;
+
+    /** @var ICommentsManager */
+    protected $commentsManager;
+
+    /** @var string */
+    protected $name = 'comments';
+
+    /** @var ILogger */
+    protected $logger;
+
+    /** @var IUserManager */
+    protected $userManager;
+
+    /** @var IUserSession */
+    protected $userSession;
+
+    /** @var EventDispatcherInterface */
+    protected $dispatcher;
+
+    /**
+     * @param ICommentsManager $commentsManager
+     * @param IUserManager $userManager
+     * @param IUserSession $userSession
+     * @param EventDispatcherInterface $dispatcher
+     * @param ILogger $logger
+     */
+    public function __construct(
+        ICommentsManager $commentsManager,
+        IUserManager $userManager,
+        IUserSession $userSession,
+        EventDispatcherInterface $dispatcher,
+        ILogger $logger)
+    {
+        $this->commentsManager = $commentsManager;
+        $this->logger = $logger;
+        $this->userManager = $userManager;
+        $this->userSession = $userSession;
+        $this->dispatcher = $dispatcher;
+    }
+
+    /**
+     * initializes the collection. At this point of time, we need the logged in
+     * user. Since it is not the case when the instance is created, we cannot
+     * have this in the constructor.
+     *
+     * @throws NotAuthenticated
+     */
+    protected function initCollections() {
+        if($this->entityTypeCollections !== null) {
+            return;
+        }
+        $user = $this->userSession->getUser();
+        if(is_null($user)) {
+            throw new NotAuthenticated();
+        }
+
+        $event = new CommentsEntityEvent(CommentsEntityEvent::EVENT_ENTITY);
+        $this->dispatcher->dispatch(CommentsEntityEvent::EVENT_ENTITY, $event);
+
+        $this->entityTypeCollections = [];
+        foreach ($event->getEntityCollections() as $entity => $entityExistsFunction) {
+            $this->entityTypeCollections[$entity] = new EntityTypeCollection(
+                $entity,
+                $this->commentsManager,
+                $this->userManager,
+                $this->userSession,
+                $this->logger,
+                $entityExistsFunction
+            );
+        }
+    }
+
+    /**
+     * Creates a new file in the directory
+     *
+     * @param string $name Name of the file
+     * @param resource|string $data Initial payload
+     * @return null|string
+     * @throws Forbidden
+     */
+    function createFile($name, $data = null) {
+        throw new Forbidden('Cannot create comments by id');
+    }
+
+    /**
+     * Creates a new subdirectory
+     *
+     * @param string $name
+     * @throws Forbidden
+     */
+    function createDirectory($name) {
+        throw new Forbidden('Permission denied to create collections');
+    }
+
+    /**
+     * Returns a specific child node, referenced by its name
+     *
+     * This method must throw Sabre\DAV\Exception\NotFound if the node does not
+     * exist.
+     *
+     * @param string $name
+     * @return \Sabre\DAV\INode
+     * @throws NotFound
+     */
+    function getChild($name) {
+        $this->initCollections();
+        if(isset($this->entityTypeCollections[$name])) {
+            return $this->entityTypeCollections[$name];
+        }
+        throw new NotFound('Entity type "' . $name . '" not found."');
+    }
+
+    /**
+     * Returns an array with all the child nodes
+     *
+     * @return \Sabre\DAV\INode[]
+     */
+    function getChildren() {
+        $this->initCollections();
+        return $this->entityTypeCollections;
+    }
+
+    /**
+     * Checks if a child-node with the specified name exists
+     *
+     * @param string $name
+     * @return bool
+     */
+    function childExists($name) {
+        $this->initCollections();
+        return isset($this->entityTypeCollections[$name]);
+    }
+
+    /**
+     * Deleted the current node
+     *
+     * @throws Forbidden
+     */
+    function delete() {
+        throw new Forbidden('Permission denied to delete this collection');
+    }
+
+    /**
+     * Returns the name of the node.
+     *
+     * This is used to generate the url.
+     *
+     * @return string
+     */
+    function getName() {
+        return $this->name;
+    }
+
+    /**
+     * Renames the node
+     *
+     * @param string $name The new name
+     * @throws Forbidden
+     */
+    function setName($name) {
+        throw new Forbidden('Permission denied to rename this collection');
+    }
+
+    /**
+     * Returns the last modification time, as a unix timestamp
+     *
+     * @return int
+     */
+    function getLastModified() {
+        return null;
+    }
 }

apps/dav/lib/Comments/CommentsPlugin.php

Indentation +207 added lines, -207 removed lines

@@ -43,213 +43,213 @@
  * Sabre plugin to handle comments:
  */
 class CommentsPlugin extends ServerPlugin {
-	// namespace
-	const NS_OWNCLOUD = 'http://owncloud.org/ns';
-
-	const REPORT_NAME            = '{http://owncloud.org/ns}filter-comments';
-	const REPORT_PARAM_LIMIT     = '{http://owncloud.org/ns}limit';
-	const REPORT_PARAM_OFFSET    = '{http://owncloud.org/ns}offset';
-	const REPORT_PARAM_TIMESTAMP = '{http://owncloud.org/ns}datetime';
-
-	/** @var ICommentsManager  */
-	protected $commentsManager;
-
-	/** @var \Sabre\DAV\Server $server */
-	private $server;
-
-	/** @var  \OCP\IUserSession */
-	protected $userSession;
-
-	/**
-	 * Comments plugin
-	 *
-	 * @param ICommentsManager $commentsManager
-	 * @param IUserSession $userSession
-	 */
-	public function __construct(ICommentsManager $commentsManager, IUserSession $userSession) {
-		$this->commentsManager = $commentsManager;
-		$this->userSession = $userSession;
-	}
-
-	/**
-	 * 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;
-		if(strpos($this->server->getRequestUri(), 'comments/') !== 0) {
-			return;
-		}
-
-		$this->server->xml->namespaceMap[self::NS_OWNCLOUD] = 'oc';
-
-		$this->server->xml->classMap['DateTime'] = function(Writer $writer, \DateTime $value) {
-			$writer->write(\Sabre\HTTP\toDate($value));
-		};
-
-		$this->server->on('report', [$this, 'onReport']);
-		$this->server->on('method:POST', [$this, 'httpPost']);
-	}
-
-	/**
-	 * POST operation on Comments collections
-	 *
-	 * @param RequestInterface $request request object
-	 * @param ResponseInterface $response response object
-	 * @return null|false
-	 */
-	public function httpPost(RequestInterface $request, ResponseInterface $response) {
-		$path = $request->getPath();
-		$node = $this->server->tree->getNodeForPath($path);
-		if (!$node instanceof EntityCollection) {
-			return null;
-		}
-
-		$data = $request->getBodyAsString();
-		$comment = $this->createComment(
-			$node->getName(),
-			$node->getId(),
-			$data,
-			$request->getHeader('Content-Type')
-		);
-
-		// update read marker for the current user/poster to avoid
-		// having their own comments marked as unread
-		$node->setReadMarker(null);
-
-		$url = rtrim($request->getUrl(), '/') . '/' . urlencode($comment->getId());
-
-		$response->setHeader('Content-Location', $url);
-
-		// created
-		$response->setStatus(201);
-		return false;
-	}
-
-	/**
-	 * 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 comments
-	 *
-	 * @param string $reportName
-	 * @param array $report
-	 * @param string $uri
-	 * @return bool
-	 * @throws NotFound
-	 * @throws ReportNotSupported
-	 */
-	public function onReport($reportName, $report, $uri) {
-		$node = $this->server->tree->getNodeForPath($uri);
-		if(!$node instanceof EntityCollection || $reportName !== self::REPORT_NAME) {
-			throw new ReportNotSupported();
-		}
-		$args = ['limit' => 0, 'offset' => 0, 'datetime' => null];
-		$acceptableParameters = [
-			$this::REPORT_PARAM_LIMIT,
-			$this::REPORT_PARAM_OFFSET,
-			$this::REPORT_PARAM_TIMESTAMP
-		];
-		$ns = '{' . $this::NS_OWNCLOUD . '}';
-		foreach($report as $parameter) {
-			if(!in_array($parameter['name'], $acceptableParameters) || empty($parameter['value'])) {
-				continue;
-			}
-			$args[str_replace($ns, '', $parameter['name'])] = $parameter['value'];
-		}
-
-		if(!is_null($args['datetime'])) {
-			$args['datetime'] = new \DateTime($args['datetime']);
-		}
-
-		$results = $node->findChildren($args['limit'], $args['offset'], $args['datetime']);
-
-		$responses = [];
-		foreach($results as $node) {
-			$nodePath = $this->server->getRequestUri() . '/' . $node->comment->getId();
-			$resultSet = $this->server->getPropertiesForPath($nodePath, CommentNode::getPropertyNames());
-			if(isset($resultSet[0]) && isset($resultSet[0][200])) {
-				$responses[] = new Response(
-					$this->server->getBaseUri() . $nodePath,
-					[200 => $resultSet[0][200]],
-					200
-				);
-			}
-
-		}
-
-		$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;
-	}
-
-	/**
-	 * Creates a new comment
-	 *
-	 * @param string $objectType e.g. "files"
-	 * @param string $objectId e.g. the file id
-	 * @param string $data JSON encoded string containing the properties of the tag to create
-	 * @param string $contentType content type of the data
-	 * @return IComment newly created comment
-	 *
-	 * @throws BadRequest if a field was missing
-	 * @throws UnsupportedMediaType if the content type is not supported
-	 */
-	private function createComment($objectType, $objectId, $data, $contentType = 'application/json') {
-		if (explode(';', $contentType)[0] === 'application/json') {
-			$data = json_decode($data, true);
-		} else {
-			throw new UnsupportedMediaType();
-		}
-
-		$actorType = $data['actorType'];
-		$actorId = null;
-		if($actorType === 'users') {
-			$user = $this->userSession->getUser();
-			if(!is_null($user)) {
-				$actorId = $user->getUID();
-			}
-		}
-		if(is_null($actorId)) {
-			throw new BadRequest('Invalid actor "' .  $actorType .'"');
-		}
-
-		try {
-			$comment = $this->commentsManager->create($actorType, $actorId, $objectType, $objectId);
-			$comment->setMessage($data['message']);
-			$comment->setVerb($data['verb']);
-			$this->commentsManager->save($comment);
-			return $comment;
-		} catch (\InvalidArgumentException $e) {
-			throw new BadRequest('Invalid input values', 0, $e);
-		} catch (\OCP\Comments\MessageTooLongException $e) {
-			$msg = 'Message exceeds allowed character limit of ';
-			throw new BadRequest($msg . \OCP\Comments\IComment::MAX_MESSAGE_LENGTH, 0,	$e);
-		}
-	}
+    // namespace
+    const NS_OWNCLOUD = 'http://owncloud.org/ns';
+
+    const REPORT_NAME            = '{http://owncloud.org/ns}filter-comments';
+    const REPORT_PARAM_LIMIT     = '{http://owncloud.org/ns}limit';
+    const REPORT_PARAM_OFFSET    = '{http://owncloud.org/ns}offset';
+    const REPORT_PARAM_TIMESTAMP = '{http://owncloud.org/ns}datetime';
+
+    /** @var ICommentsManager  */
+    protected $commentsManager;
+
+    /** @var \Sabre\DAV\Server $server */
+    private $server;
+
+    /** @var  \OCP\IUserSession */
+    protected $userSession;
+
+    /**
+     * Comments plugin
+     *
+     * @param ICommentsManager $commentsManager
+     * @param IUserSession $userSession
+     */
+    public function __construct(ICommentsManager $commentsManager, IUserSession $userSession) {
+        $this->commentsManager = $commentsManager;
+        $this->userSession = $userSession;
+    }
+
+    /**
+     * 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;
+        if(strpos($this->server->getRequestUri(), 'comments/') !== 0) {
+            return;
+        }
+
+        $this->server->xml->namespaceMap[self::NS_OWNCLOUD] = 'oc';
+
+        $this->server->xml->classMap['DateTime'] = function(Writer $writer, \DateTime $value) {
+            $writer->write(\Sabre\HTTP\toDate($value));
+        };
+
+        $this->server->on('report', [$this, 'onReport']);
+        $this->server->on('method:POST', [$this, 'httpPost']);
+    }
+
+    /**
+     * POST operation on Comments collections
+     *
+     * @param RequestInterface $request request object
+     * @param ResponseInterface $response response object
+     * @return null|false
+     */
+    public function httpPost(RequestInterface $request, ResponseInterface $response) {
+        $path = $request->getPath();
+        $node = $this->server->tree->getNodeForPath($path);
+        if (!$node instanceof EntityCollection) {
+            return null;
+        }
+
+        $data = $request->getBodyAsString();
+        $comment = $this->createComment(
+            $node->getName(),
+            $node->getId(),
+            $data,
+            $request->getHeader('Content-Type')
+        );
+
+        // update read marker for the current user/poster to avoid
+        // having their own comments marked as unread
+        $node->setReadMarker(null);
+
+        $url = rtrim($request->getUrl(), '/') . '/' . urlencode($comment->getId());
+
+        $response->setHeader('Content-Location', $url);
+
+        // created
+        $response->setStatus(201);
+        return false;
+    }
+
+    /**
+     * 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 comments
+     *
+     * @param string $reportName
+     * @param array $report
+     * @param string $uri
+     * @return bool
+     * @throws NotFound
+     * @throws ReportNotSupported
+     */
+    public function onReport($reportName, $report, $uri) {
+        $node = $this->server->tree->getNodeForPath($uri);
+        if(!$node instanceof EntityCollection || $reportName !== self::REPORT_NAME) {
+            throw new ReportNotSupported();
+        }
+        $args = ['limit' => 0, 'offset' => 0, 'datetime' => null];
+        $acceptableParameters = [
+            $this::REPORT_PARAM_LIMIT,
+            $this::REPORT_PARAM_OFFSET,
+            $this::REPORT_PARAM_TIMESTAMP
+        ];
+        $ns = '{' . $this::NS_OWNCLOUD . '}';
+        foreach($report as $parameter) {
+            if(!in_array($parameter['name'], $acceptableParameters) || empty($parameter['value'])) {
+                continue;
+            }
+            $args[str_replace($ns, '', $parameter['name'])] = $parameter['value'];
+        }
+
+        if(!is_null($args['datetime'])) {
+            $args['datetime'] = new \DateTime($args['datetime']);
+        }
+
+        $results = $node->findChildren($args['limit'], $args['offset'], $args['datetime']);
+
+        $responses = [];
+        foreach($results as $node) {
+            $nodePath = $this->server->getRequestUri() . '/' . $node->comment->getId();
+            $resultSet = $this->server->getPropertiesForPath($nodePath, CommentNode::getPropertyNames());
+            if(isset($resultSet[0]) && isset($resultSet[0][200])) {
+                $responses[] = new Response(
+                    $this->server->getBaseUri() . $nodePath,
+                    [200 => $resultSet[0][200]],
+                    200
+                );
+            }
+
+        }
+
+        $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;
+    }
+
+    /**
+     * Creates a new comment
+     *
+     * @param string $objectType e.g. "files"
+     * @param string $objectId e.g. the file id
+     * @param string $data JSON encoded string containing the properties of the tag to create
+     * @param string $contentType content type of the data
+     * @return IComment newly created comment
+     *
+     * @throws BadRequest if a field was missing
+     * @throws UnsupportedMediaType if the content type is not supported
+     */
+    private function createComment($objectType, $objectId, $data, $contentType = 'application/json') {
+        if (explode(';', $contentType)[0] === 'application/json') {
+            $data = json_decode($data, true);
+        } else {
+            throw new UnsupportedMediaType();
+        }
+
+        $actorType = $data['actorType'];
+        $actorId = null;
+        if($actorType === 'users') {
+            $user = $this->userSession->getUser();
+            if(!is_null($user)) {
+                $actorId = $user->getUID();
+            }
+        }
+        if(is_null($actorId)) {
+            throw new BadRequest('Invalid actor "' .  $actorType .'"');
+        }
+
+        try {
+            $comment = $this->commentsManager->create($actorType, $actorId, $objectType, $objectId);
+            $comment->setMessage($data['message']);
+            $comment->setVerb($data['verb']);
+            $this->commentsManager->save($comment);
+            return $comment;
+        } catch (\InvalidArgumentException $e) {
+            throw new BadRequest('Invalid input values', 0, $e);
+        } catch (\OCP\Comments\MessageTooLongException $e) {
+            $msg = 'Message exceeds allowed character limit of ';
+            throw new BadRequest($msg . \OCP\Comments\IComment::MAX_MESSAGE_LENGTH, 0,	$e);
+        }
+    }
 
 
 

apps/dav/lib/Comments/EntityCollection.php

Indentation +140 added lines, -140 removed lines

@@ -41,156 +41,156 @@
  * @package OCA\DAV\Comments
  */
 class EntityCollection extends RootCollection implements IProperties {
-	const PROPERTY_NAME_READ_MARKER  = '{http://owncloud.org/ns}readMarker';
+    const PROPERTY_NAME_READ_MARKER  = '{http://owncloud.org/ns}readMarker';
 
-	/** @var  string */
-	protected $id;
+    /** @var  string */
+    protected $id;
 
-	/** @var  ILogger */
-	protected $logger;
+    /** @var  ILogger */
+    protected $logger;
 
-	/**
-	 * @param string $id
-	 * @param string $name
-	 * @param ICommentsManager $commentsManager
-	 * @param IUserManager $userManager
-	 * @param IUserSession $userSession
-	 * @param ILogger $logger
-	 */
-	public function __construct(
-		$id,
-		$name,
-		ICommentsManager $commentsManager,
-		IUserManager $userManager,
-		IUserSession $userSession,
-		ILogger $logger
-	) {
-		foreach(['id', 'name'] as $property) {
-			$$property = trim($$property);
-			if(empty($$property) || !is_string($$property)) {
-				throw new \InvalidArgumentException('"' . $property . '" parameter must be non-empty string');
-			}
-		}
-		$this->id = $id;
-		$this->name = $name;
-		$this->commentsManager = $commentsManager;
-		$this->logger = $logger;
-		$this->userManager = $userManager;
-		$this->userSession = $userSession;
-	}
+    /**
+     * @param string $id
+     * @param string $name
+     * @param ICommentsManager $commentsManager
+     * @param IUserManager $userManager
+     * @param IUserSession $userSession
+     * @param ILogger $logger
+     */
+    public function __construct(
+        $id,
+        $name,
+        ICommentsManager $commentsManager,
+        IUserManager $userManager,
+        IUserSession $userSession,
+        ILogger $logger
+    ) {
+        foreach(['id', 'name'] as $property) {
+            $$property = trim($$property);
+            if(empty($$property) || !is_string($$property)) {
+                throw new \InvalidArgumentException('"' . $property . '" parameter must be non-empty string');
+            }
+        }
+        $this->id = $id;
+        $this->name = $name;
+        $this->commentsManager = $commentsManager;
+        $this->logger = $logger;
+        $this->userManager = $userManager;
+        $this->userSession = $userSession;
+    }
 
-	/**
-	 * returns the ID of this entity
-	 *
-	 * @return string
-	 */
-	public function getId() {
-		return $this->id;
-	}
+    /**
+     * returns the ID of this entity
+     *
+     * @return string
+     */
+    public function getId() {
+        return $this->id;
+    }
 
-	/**
-	 * Returns a specific child node, referenced by its name
-	 *
-	 * This method must throw Sabre\DAV\Exception\NotFound if the node does not
-	 * exist.
-	 *
-	 * @param string $name
-	 * @return \Sabre\DAV\INode
-	 * @throws NotFound
-	 */
-	function getChild($name) {
-		try {
-			$comment = $this->commentsManager->get($name);
-			return new CommentNode(
-				$this->commentsManager,
-				$comment,
-				$this->userManager,
-				$this->userSession,
-				$this->logger
-			);
-		} catch (NotFoundException $e) {
-			throw new NotFound();
-		}
-	}
+    /**
+     * Returns a specific child node, referenced by its name
+     *
+     * This method must throw Sabre\DAV\Exception\NotFound if the node does not
+     * exist.
+     *
+     * @param string $name
+     * @return \Sabre\DAV\INode
+     * @throws NotFound
+     */
+    function getChild($name) {
+        try {
+            $comment = $this->commentsManager->get($name);
+            return new CommentNode(
+                $this->commentsManager,
+                $comment,
+                $this->userManager,
+                $this->userSession,
+                $this->logger
+            );
+        } catch (NotFoundException $e) {
+            throw new NotFound();
+        }
+    }
 
-	/**
-	 * Returns an array with all the child nodes
-	 *
-	 * @return \Sabre\DAV\INode[]
-	 */
-	function getChildren() {
-		return $this->findChildren();
-	}
+    /**
+     * Returns an array with all the child nodes
+     *
+     * @return \Sabre\DAV\INode[]
+     */
+    function getChildren() {
+        return $this->findChildren();
+    }
 
-	/**
-	 * Returns an array of comment nodes. Result can be influenced by offset,
-	 * limit and date time parameters.
-	 *
-	 * @param int $limit
-	 * @param int $offset
-	 * @param \DateTime|null $datetime
-	 * @return CommentNode[]
-	 */
-	function findChildren($limit = 0, $offset = 0, \DateTime $datetime = null) {
-		$comments = $this->commentsManager->getForObject($this->name, $this->id, $limit, $offset, $datetime);
-		$result = [];
-		foreach($comments as $comment) {
-			$result[] = new CommentNode(
-				$this->commentsManager,
-				$comment,
-				$this->userManager,
-				$this->userSession,
-				$this->logger
-			);
-		}
-		return $result;
-	}
+    /**
+     * Returns an array of comment nodes. Result can be influenced by offset,
+     * limit and date time parameters.
+     *
+     * @param int $limit
+     * @param int $offset
+     * @param \DateTime|null $datetime
+     * @return CommentNode[]
+     */
+    function findChildren($limit = 0, $offset = 0, \DateTime $datetime = null) {
+        $comments = $this->commentsManager->getForObject($this->name, $this->id, $limit, $offset, $datetime);
+        $result = [];
+        foreach($comments as $comment) {
+            $result[] = new CommentNode(
+                $this->commentsManager,
+                $comment,
+                $this->userManager,
+                $this->userSession,
+                $this->logger
+            );
+        }
+        return $result;
+    }
 
-	/**
-	 * Checks if a child-node with the specified name exists
-	 *
-	 * @param string $name
-	 * @return bool
-	 */
-	function childExists($name) {
-		try {
-			$this->commentsManager->get($name);
-			return true;
-		} catch (NotFoundException $e) {
-			return false;
-		}
-	}
+    /**
+     * Checks if a child-node with the specified name exists
+     *
+     * @param string $name
+     * @return bool
+     */
+    function childExists($name) {
+        try {
+            $this->commentsManager->get($name);
+            return true;
+        } catch (NotFoundException $e) {
+            return false;
+        }
+    }
 
-	/**
-	 * Sets the read marker to the specified date for the logged in user
-	 *
-	 * @param \DateTime $value
-	 * @return bool
-	 */
-	public function setReadMarker($value) {
-		$dateTime = new \DateTime($value);
-		$user = $this->userSession->getUser();
-		$this->commentsManager->setReadMark($this->name, $this->id, $dateTime, $user);
-		return true;
-	}
+    /**
+     * Sets the read marker to the specified date for the logged in user
+     *
+     * @param \DateTime $value
+     * @return bool
+     */
+    public function setReadMarker($value) {
+        $dateTime = new \DateTime($value);
+        $user = $this->userSession->getUser();
+        $this->commentsManager->setReadMark($this->name, $this->id, $dateTime, $user);
+        return true;
+    }
 
-	/**
-	 * @inheritdoc
-	 */
-	function propPatch(PropPatch $propPatch) {
-		$propPatch->handle(self::PROPERTY_NAME_READ_MARKER, [$this, 'setReadMarker']);
-	}
+    /**
+     * @inheritdoc
+     */
+    function propPatch(PropPatch $propPatch) {
+        $propPatch->handle(self::PROPERTY_NAME_READ_MARKER, [$this, 'setReadMarker']);
+    }
 
-	/**
-	 * @inheritdoc
-	 */
-	function getProperties($properties) {
-		$marker = null;
-		$user = $this->userSession->getUser();
-		if(!is_null($user)) {
-			$marker = $this->commentsManager->getReadMark($this->name, $this->id, $user);
-		}
-		return [self::PROPERTY_NAME_READ_MARKER => $marker];
-	}
+    /**
+     * @inheritdoc
+     */
+    function getProperties($properties) {
+        $marker = null;
+        $user = $this->userSession->getUser();
+        if(!is_null($user)) {
+            $marker = $this->commentsManager->getReadMark($this->name, $this->id, $user);
+        }
+        return [self::PROPERTY_NAME_READ_MARKER => $marker];
+    }
 }