123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138 |
- <?php
- declare(strict_types=1);
- /**
- * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
- * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
- * SPDX-License-Identifier: AGPL-3.0-only
- */
- namespace OCA\DAV\Connector\Sabre;
- use OCP\Comments\ICommentsManager;
- use OCP\IUserSession;
- use Sabre\DAV\PropFind;
- use Sabre\DAV\Server;
- 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';
- protected ?Server $server = null;
- private ICommentsManager $commentsManager;
- private IUserSession $userSession;
- private array $cachedUnreadCount = [];
- 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) {
- $this->server = $server;
- $this->server->on('propFind', [$this, 'handleGetProperties']);
- }
- private function cacheDirectory(Directory $directory): void {
- $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;
- }
- }
- /**
- * 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 Directory
- && $propFind->getDepth() !== 0
- && !is_null($propFind->getStatus(self::PROPERTY_NAME_UNREAD))
- ) {
- $this->cacheDirectory($node);
- }
- $propFind->handle(self::PROPERTY_NAME_COUNT, function () use ($node): int {
- return $this->commentsManager->getNumberOfCommentsForObject('files', (string)$node->getId());
- });
- $propFind->handle(self::PROPERTY_NAME_HREF, function () use ($node): ?string {
- return $this->getCommentsLink($node);
- });
- $propFind->handle(self::PROPERTY_NAME_UNREAD, function () use ($node): ?int {
- return $this->cachedUnreadCount[$node->getId()] ?? $this->getUnreadCount($node);
- });
- }
- /**
- * Returns a reference to the comments node
- */
- public function getCommentsLink(Node $node): ?string {
- $href = $this->server->getBaseUri();
- $entryPoint = strpos($href, '/remote.php/');
- if ($entryPoint === false) {
- // in case we end up somewhere else, unexpectedly.
- return null;
- }
- $commentsPart = 'dav/comments/files/' . rawurldecode((string)$node->getId());
- return substr_replace($href, $commentsPart, $entryPoint + strlen('/remote.php/'));
- }
- /**
- * Returns the number of unread comments for the currently logged in user
- * on the given file or directory node
- */
- public function getUnreadCount(Node $node): ?int {
- $user = $this->userSession->getUser();
- if (is_null($user)) {
- return null;
- }
- $lastRead = $this->commentsManager->getReadMark('files', (string)$node->getId(), $user);
- return $this->commentsManager->getNumberOfCommentsForObject('files', (string)$node->getId(), $lastRead);
- }
- }
|