nextcloud/apps/dav/lib/Connector/Sabre/CommentPropertiesPlugin.php

172 lines
4.8 KiB
PHP
Raw Normal View History

2016-01-27 20:30:09 +03:00
<?php
/**
2016-07-21 17:49:16 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
2016-05-26 20:56:05 +03:00
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin Appelman <robin@icewind.nl>
* @author Roeland Jago Douma <roeland@famdouma.nl>
2016-01-27 20:30:09 +03:00
*
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
2016-01-27 20:30:09 +03:00
*
*/
namespace OCA\DAV\Connector\Sabre;
use OCP\Comments\ICommentsManager;
use OCP\IUserSession;
use Sabre\DAV\PropFind;
use Sabre\DAV\ServerPlugin;
class CommentPropertiesPlugin extends ServerPlugin {
public const PROPERTY_NAME_HREF = '{http://owncloud.org/ns}comments-href';
public const PROPERTY_NAME_COUNT = '{http://owncloud.org/ns}comments-count';
public const PROPERTY_NAME_UNREAD = '{http://owncloud.org/ns}comments-unread';
2016-01-27 20:30:09 +03:00
/** @var \Sabre\DAV\Server */
protected $server;
/** @var ICommentsManager */
private $commentsManager;
/** @var IUserSession */
private $userSession;
private $cachedUnreadCount = [];
2016-01-27 20:30:09 +03:00
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 \Sabre\DAV\Server $server
* @return void
*/
public function initialize(\Sabre\DAV\Server $server) {
2016-01-27 20:30:09 +03:00
$this->server = $server;
$this->server->on('propFind', [$this, 'handleGetProperties']);
2016-01-27 20:30:09 +03:00
}
private function cacheDirectory(Directory $directory) {
$children = $directory->getChildren();
$ids = [];
foreach ($children as $child) {
if (!($child instanceof File || $child instanceof Directory)) {
continue;
}
$id = $child->getId();
if ($id === null) {
continue;
}
$ids[] = (string)$id;
}
$ids[] = (string) $directory->getId();
$unread = $this->commentsManager->getNumberOfUnreadCommentsForObjects('files', $ids, $this->userSession->getUser());
foreach ($unread as $id => $count) {
$this->cachedUnreadCount[(int)$id] = $count;
}
}
2016-01-27 20:30:09 +03:00
/**
* 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 File) && !($node instanceof Directory)) {
return;
}
// need prefetch ?
if ($node instanceof \OCA\DAV\Connector\Sabre\Directory
&& $propFind->getDepth() !== 0
&& !is_null($propFind->getStatus(self::PROPERTY_NAME_UNREAD))
) {
$this->cacheDirectory($node);
}
$propFind->handle(self::PROPERTY_NAME_COUNT, function () use ($node) {
return $this->commentsManager->getNumberOfCommentsForObject('files', (string)$node->getId());
2016-01-27 20:30:09 +03:00
});
$propFind->handle(self::PROPERTY_NAME_HREF, function () use ($node) {
2016-01-27 20:30:09 +03:00
return $this->getCommentsLink($node);
});
$propFind->handle(self::PROPERTY_NAME_UNREAD, function () use ($node) {
if (isset($this->cachedUnreadCount[$node->getId()])) {
return $this->cachedUnreadCount[$node->getId()];
}
return $this->getUnreadCount($node);
2016-01-27 20:30:09 +03:00
});
}
/**
* returns a reference to the comments node
*
* @param Node $node
* @return mixed|string
*/
public function getCommentsLink(Node $node) {
$href = $this->server->getBaseUri();
$entryPoint = strpos($href, '/remote.php/');
if ($entryPoint === false) {
2016-01-27 20:30:09 +03:00
// in case we end up somewhere else, unexpectedly.
return null;
}
$commentsPart = 'dav/comments/files/' . rawurldecode($node->getId());
$href = substr_replace($href, $commentsPart, $entryPoint + strlen('/remote.php/'));
2016-01-27 20:30:09 +03:00
return $href;
}
/**
* returns the number of unread comments for the currently logged in user
* on the given file or directory node
*
* @param Node $node
* @return Int|null
*/
public function getUnreadCount(Node $node) {
$user = $this->userSession->getUser();
if (is_null($user)) {
2016-01-27 20:30:09 +03:00
return null;
}
$lastRead = $this->commentsManager->getReadMark('files', (string)$node->getId(), $user);
2016-01-27 20:30:09 +03:00
return $this->commentsManager->getNumberOfCommentsForObject('files', (string)$node->getId(), $lastRead);
2016-01-27 20:30:09 +03:00
}
}