diff options
Diffstat (limited to 'apps/files/lib/Activity/Provider.php')
-rw-r--r-- | apps/files/lib/Activity/Provider.php | 505 |
1 files changed, 315 insertions, 190 deletions
diff --git a/apps/files/lib/Activity/Provider.php b/apps/files/lib/Activity/Provider.php index 3da1f3c1157..3ef79ac107f 100644 --- a/apps/files/lib/Activity/Provider.php +++ b/apps/files/lib/Activity/Provider.php @@ -1,77 +1,47 @@ <?php + /** - * @copyright Copyright (c) 2016 Joas Schilling <coding@schilljs.com> - * - * @author Joas Schilling <coding@schilljs.com> - * @author Morris Jobke <hey@morrisjobke.de> - * - * @license GNU AGPL version 3 or any later version - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU Affero General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * 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 - * along with this program. If not, see <http://www.gnu.org/licenses/>. - * + * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later */ - namespace OCA\Files\Activity; +use OCP\Activity\Exceptions\UnknownActivityException; use OCP\Activity\IEvent; use OCP\Activity\IEventMerger; use OCP\Activity\IManager; use OCP\Activity\IProvider; +use OCP\Contacts\IManager as IContactsManager; +use OCP\Federation\ICloudIdManager; +use OCP\Files\Folder; +use OCP\Files\InvalidPathException; +use OCP\Files\IRootFolder; +use OCP\Files\Node; +use OCP\Files\NotFoundException; use OCP\IL10N; use OCP\IURLGenerator; -use OCP\IUser; use OCP\IUserManager; use OCP\L10N\IFactory; class Provider implements IProvider { - - /** @var IFactory */ - protected $languageFactory; - /** @var IL10N */ protected $l; - /** @var IL10N */ - protected $activityLang; - - /** @var IURLGenerator */ - protected $url; - - /** @var IManager */ - protected $activityManager; - /** @var IUserManager */ - protected $userManager; - - /** @var IEventMerger */ - protected $eventMerger; - - /** @var string[] cached displayNames - key is the UID and value the displayname */ + /** @var string[] cached displayNames - key is the cloud id and value the displayname */ protected $displayNames = []; - /** - * @param IFactory $languageFactory - * @param IURLGenerator $url - * @param IManager $activityManager - * @param IUserManager $userManager - * @param IEventMerger $eventMerger - */ - public function __construct(IFactory $languageFactory, IURLGenerator $url, IManager $activityManager, IUserManager $userManager, IEventMerger $eventMerger) { - $this->languageFactory = $languageFactory; - $this->url = $url; - $this->activityManager = $activityManager; - $this->userManager = $userManager; - $this->eventMerger = $eventMerger; + protected $fileIsEncrypted = false; + + public function __construct( + protected IFactory $languageFactory, + protected IURLGenerator $url, + protected IManager $activityManager, + protected IUserManager $userManager, + protected IRootFolder $rootFolder, + protected ICloudIdManager $cloudIdManager, + protected IContactsManager $contactsManager, + protected IEventMerger $eventMerger, + ) { } /** @@ -79,21 +49,20 @@ class Provider implements IProvider { * @param IEvent $event * @param IEvent|null $previousEvent * @return IEvent - * @throws \InvalidArgumentException + * @throws UnknownActivityException * @since 11.0.0 */ - public function parse($language, IEvent $event, IEvent $previousEvent = null) { + public function parse($language, IEvent $event, ?IEvent $previousEvent = null) { if ($event->getApp() !== 'files') { - throw new \InvalidArgumentException(); + throw new UnknownActivityException(); } $this->l = $this->languageFactory->get('files', $language); - $this->activityLang = $this->languageFactory->get('activity', $language); if ($this->activityManager->isFormattingFilteredObject()) { try { return $this->parseShortVersion($event, $previousEvent); - } catch (\InvalidArgumentException $e) { + } catch (UnknownActivityException) { // Ignore and simply use the long version... } } @@ -101,60 +70,49 @@ class Provider implements IProvider { return $this->parseLongVersion($event, $previousEvent); } + protected function setIcon(IEvent $event, string $icon, string $app = 'files') { + if ($this->activityManager->getRequirePNG()) { + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath($app, $icon . '.png'))); + } else { + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath($app, $icon . '.svg'))); + } + } + /** * @param IEvent $event * @param IEvent|null $previousEvent * @return IEvent - * @throws \InvalidArgumentException + * @throws UnknownActivityException * @since 11.0.0 */ - public function parseShortVersion(IEvent $event, IEvent $previousEvent = null) { + public function parseShortVersion(IEvent $event, ?IEvent $previousEvent = null): IEvent { $parsedParameters = $this->getParameters($event); if ($event->getSubject() === 'created_by') { $subject = $this->l->t('Created by {user}'); - if ($this->activityManager->getRequirePNG()) { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'add-color.png'))); - } else { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'add-color.svg'))); - } - } else if ($event->getSubject() === 'changed_by') { + $this->setIcon($event, 'add-color'); + } elseif ($event->getSubject() === 'changed_by') { $subject = $this->l->t('Changed by {user}'); - if ($this->activityManager->getRequirePNG()) { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'change.png'))); - } else { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'change.svg'))); - } - } else if ($event->getSubject() === 'deleted_by') { + $this->setIcon($event, 'change'); + } elseif ($event->getSubject() === 'deleted_by') { $subject = $this->l->t('Deleted by {user}'); - if ($this->activityManager->getRequirePNG()) { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'delete-color.png'))); - } else { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'delete-color.svg'))); - } - } else if ($event->getSubject() === 'restored_by') { + $this->setIcon($event, 'delete-color'); + } elseif ($event->getSubject() === 'restored_by') { $subject = $this->l->t('Restored by {user}'); - } else if ($event->getSubject() === 'renamed_by') { + $this->setIcon($event, 'actions/history', 'core'); + } elseif ($event->getSubject() === 'renamed_by') { $subject = $this->l->t('Renamed by {user}'); - if ($this->activityManager->getRequirePNG()) { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'change.png'))); - } else { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'change.svg'))); - } - } else if ($event->getSubject() === 'moved_by') { + $this->setIcon($event, 'change'); + } elseif ($event->getSubject() === 'moved_by') { $subject = $this->l->t('Moved by {user}'); - if ($this->activityManager->getRequirePNG()) { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'change.png'))); - } else { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'change.svg'))); - } + $this->setIcon($event, 'change'); } else { - throw new \InvalidArgumentException(); + throw new UnknownActivityException(); } if (!isset($parsedParameters['user'])) { // External user via public link share - $subject = str_replace('{user}', $this->activityLang->t('"remote user"'), $subject); + $subject = str_replace('{user}', $this->l->t('"remote account"'), $subject); } $this->setSubjects($event, $subject, $parsedParameters); @@ -166,105 +124,122 @@ class Provider implements IProvider { * @param IEvent $event * @param IEvent|null $previousEvent * @return IEvent - * @throws \InvalidArgumentException + * @throws UnknownActivityException * @since 11.0.0 */ - public function parseLongVersion(IEvent $event, IEvent $previousEvent = null) { + public function parseLongVersion(IEvent $event, ?IEvent $previousEvent = null): IEvent { + $this->fileIsEncrypted = false; $parsedParameters = $this->getParameters($event); if ($event->getSubject() === 'created_self') { $subject = $this->l->t('You created {file}'); - if ($this->activityManager->getRequirePNG()) { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'add-color.png'))); - } else { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'add-color.svg'))); + if ($this->fileIsEncrypted) { + $subject = $this->l->t('You created an encrypted file in {file}'); } - } else if ($event->getSubject() === 'created_by') { + $this->setIcon($event, 'add-color'); + } elseif ($event->getSubject() === 'created_by') { $subject = $this->l->t('{user} created {file}'); - if ($this->activityManager->getRequirePNG()) { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'add-color.png'))); - } else { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'add-color.svg'))); + if ($this->fileIsEncrypted) { + $subject = $this->l->t('{user} created an encrypted file in {file}'); } - } else if ($event->getSubject() === 'created_public') { + $this->setIcon($event, 'add-color'); + } elseif ($event->getSubject() === 'created_public') { $subject = $this->l->t('{file} was created in a public folder'); - if ($this->activityManager->getRequirePNG()) { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'add-color.png'))); - } else { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'add-color.svg'))); - } - } else if ($event->getSubject() === 'changed_self') { + $this->setIcon($event, 'add-color'); + } elseif ($event->getSubject() === 'changed_self') { $subject = $this->l->t('You changed {file}'); - if ($this->activityManager->getRequirePNG()) { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'change.png'))); - } else { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'change.svg'))); + if ($this->fileIsEncrypted) { + $subject = $this->l->t('You changed an encrypted file in {file}'); } - } else if ($event->getSubject() === 'changed_by') { + $this->setIcon($event, 'change'); + } elseif ($event->getSubject() === 'changed_by') { $subject = $this->l->t('{user} changed {file}'); - if ($this->activityManager->getRequirePNG()) { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'change.png'))); - } else { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'change.svg'))); + if ($this->fileIsEncrypted) { + $subject = $this->l->t('{user} changed an encrypted file in {file}'); } - } else if ($event->getSubject() === 'deleted_self') { + $this->setIcon($event, 'change'); + } elseif ($event->getSubject() === 'deleted_self') { $subject = $this->l->t('You deleted {file}'); - if ($this->activityManager->getRequirePNG()) { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'delete-color.png'))); - } else { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'delete-color.svg'))); + if ($this->fileIsEncrypted) { + $subject = $this->l->t('You deleted an encrypted file in {file}'); } - } else if ($event->getSubject() === 'deleted_by') { + $this->setIcon($event, 'delete-color'); + } elseif ($event->getSubject() === 'deleted_by') { $subject = $this->l->t('{user} deleted {file}'); - if ($this->activityManager->getRequirePNG()) { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'delete-color.png'))); - } else { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'delete-color.svg'))); + if ($this->fileIsEncrypted) { + $subject = $this->l->t('{user} deleted an encrypted file in {file}'); } - } else if ($event->getSubject() === 'restored_self') { + $this->setIcon($event, 'delete-color'); + } elseif ($event->getSubject() === 'restored_self') { $subject = $this->l->t('You restored {file}'); - } else if ($event->getSubject() === 'restored_by') { + $this->setIcon($event, 'actions/history', 'core'); + } elseif ($event->getSubject() === 'restored_by') { $subject = $this->l->t('{user} restored {file}'); - } else if ($event->getSubject() === 'renamed_self') { - $subject = $this->l->t('You renamed {oldfile} to {newfile}'); - if ($this->activityManager->getRequirePNG()) { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'change.png'))); + $this->setIcon($event, 'actions/history', 'core'); + } elseif ($event->getSubject() === 'renamed_self') { + $oldFileName = $parsedParameters['oldfile']['name']; + $newFileName = $parsedParameters['newfile']['name']; + + if ($this->isHiddenFile($oldFileName)) { + if ($this->isHiddenFile($newFileName)) { + $subject = $this->l->t('You renamed {oldfile} (hidden) to {newfile} (hidden)'); + } else { + $subject = $this->l->t('You renamed {oldfile} (hidden) to {newfile}'); + } } else { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'change.svg'))); + if ($this->isHiddenFile($newFileName)) { + $subject = $this->l->t('You renamed {oldfile} to {newfile} (hidden)'); + } else { + $subject = $this->l->t('You renamed {oldfile} to {newfile}'); + } } - } else if ($event->getSubject() === 'renamed_by') { - $subject = $this->l->t('{user} renamed {oldfile} to {newfile}'); - if ($this->activityManager->getRequirePNG()) { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'change.png'))); + + $this->setIcon($event, 'change'); + } elseif ($event->getSubject() === 'renamed_by') { + $oldFileName = $parsedParameters['oldfile']['name']; + $newFileName = $parsedParameters['newfile']['name']; + + if ($this->isHiddenFile($oldFileName)) { + if ($this->isHiddenFile($newFileName)) { + $subject = $this->l->t('{user} renamed {oldfile} (hidden) to {newfile} (hidden)'); + } else { + $subject = $this->l->t('{user} renamed {oldfile} (hidden) to {newfile}'); + } } else { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'change.svg'))); + if ($this->isHiddenFile($newFileName)) { + $subject = $this->l->t('{user} renamed {oldfile} to {newfile} (hidden)'); + } else { + $subject = $this->l->t('{user} renamed {oldfile} to {newfile}'); + } } - } else if ($event->getSubject() === 'moved_self') { + + $this->setIcon($event, 'change'); + } elseif ($event->getSubject() === 'moved_self') { $subject = $this->l->t('You moved {oldfile} to {newfile}'); - if ($this->activityManager->getRequirePNG()) { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'change.png'))); - } else { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'change.svg'))); - } - } else if ($event->getSubject() === 'moved_by') { + $this->setIcon($event, 'change'); + } elseif ($event->getSubject() === 'moved_by') { $subject = $this->l->t('{user} moved {oldfile} to {newfile}'); - if ($this->activityManager->getRequirePNG()) { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'change.png'))); - } else { - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('files', 'change.svg'))); - } + $this->setIcon($event, 'change'); } else { - throw new \InvalidArgumentException(); + throw new UnknownActivityException(); + } + + if ($this->fileIsEncrypted) { + $event->setSubject($event->getSubject() . '_enc', $event->getSubjectParameters()); } if (!isset($parsedParameters['user'])) { // External user via public link share - $subject = str_replace('{user}', $this->activityLang->t('"remote user"'), $subject); + $subject = str_replace('{user}', $this->l->t('"remote account"'), $subject); } $this->setSubjects($event, $subject, $parsedParameters); - $event = $this->eventMerger->mergeEvents('file', $event, $previousEvent); + if ($event->getSubject() === 'moved_self' || $event->getSubject() === 'moved_by') { + $event = $this->eventMerger->mergeEvents('oldfile', $event, $previousEvent); + } else { + $event = $this->eventMerger->mergeEvents('file', $event, $previousEvent); + } if ($event->getChildEvent() === null) { // Couldn't group by file, maybe we can group by user @@ -274,27 +249,20 @@ class Provider implements IProvider { return $event; } - protected function setSubjects(IEvent $event, $subject, array $parameters) { - $placeholders = $replacements = []; - foreach ($parameters as $placeholder => $parameter) { - $placeholders[] = '{' . $placeholder . '}'; - if ($parameter['type'] === 'file') { - $replacements[] = $parameter['path']; - } else { - $replacements[] = $parameter['name']; - } - } + private function isHiddenFile(string $filename): bool { + return strlen($filename) > 0 && $filename[0] === '.'; + } - $event->setParsedSubject(str_replace($placeholders, $replacements, $subject)) - ->setRichSubject($subject, $parameters); + protected function setSubjects(IEvent $event, string $subject, array $parameters): void { + $event->setRichSubject($subject, $parameters); } /** * @param IEvent $event * @return array - * @throws \InvalidArgumentException + * @throws UnknownActivityException */ - protected function getParameters(IEvent $event) { + protected function getParameters(IEvent $event): array { $parameters = $event->getSubjectParameters(); switch ($event->getSubject()) { case 'created_self': @@ -347,55 +315,212 @@ class Provider implements IProvider { * @param array|string $parameter * @param IEvent|null $event * @return array - * @throws \InvalidArgumentException + * @throws UnknownActivityException */ - protected function getFile($parameter, IEvent $event = null) { + protected function getFile($parameter, ?IEvent $event = null): array { if (is_array($parameter)) { $path = reset($parameter); - $id = (string) key($parameter); - } else if ($event !== null) { + $id = (int)key($parameter); + } elseif ($event !== null) { // Legacy from before ownCloud 8.2 $path = $parameter; $id = $event->getObjectId(); } else { - throw new \InvalidArgumentException('Could not generate file parameter'); + throw new UnknownActivityException('Could not generate file parameter'); + } + + $encryptionContainer = $this->getEndToEndEncryptionContainer($id, $path); + if ($encryptionContainer instanceof Folder) { + $this->fileIsEncrypted = true; + try { + $fullPath = rtrim($encryptionContainer->getPath(), '/'); + // Remove /user/files/... + [,,, $path] = explode('/', $fullPath, 4); + if (!$path) { + throw new InvalidPathException('Path could not be split correctly'); + } + + return [ + 'type' => 'file', + 'id' => (string)$encryptionContainer->getId(), + 'name' => $encryptionContainer->getName(), + 'path' => $path, + 'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $encryptionContainer->getId()]), + ]; + } catch (\Exception $e) { + // fall back to the normal one + $this->fileIsEncrypted = false; + } } return [ 'type' => 'file', - 'id' => $id, + 'id' => (string)$id, 'name' => basename($path), 'path' => trim($path, '/'), 'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $id]), ]; } + protected $fileEncrypted = []; + + /** + * Check if a file is end2end encrypted + * @param int $fileId + * @param string $path + * @return Folder|null + */ + protected function getEndToEndEncryptionContainer($fileId, $path) { + if (isset($this->fileEncrypted[$fileId])) { + return $this->fileEncrypted[$fileId]; + } + + $fileName = basename($path); + if (!preg_match('/^[0-9a-fA-F]{32}$/', $fileName)) { + $this->fileEncrypted[$fileId] = false; + return $this->fileEncrypted[$fileId]; + } + + $userFolder = $this->rootFolder->getUserFolder($this->activityManager->getCurrentUserId()); + $file = $userFolder->getFirstNodeById($fileId); + if (!$file) { + try { + // Deleted, try with parent + $file = $this->findExistingParent($userFolder, dirname($path)); + } catch (NotFoundException $e) { + return null; + } + + if (!$file instanceof Folder || !$file->isEncrypted()) { + return null; + } + + $this->fileEncrypted[$fileId] = $file; + return $file; + } + + if ($file instanceof Folder && $file->isEncrypted()) { + // If the folder is encrypted, it is the Container, + // but can be the name is just fine. + $this->fileEncrypted[$fileId] = true; + return null; + } + + $this->fileEncrypted[$fileId] = $this->getParentEndToEndEncryptionContainer($userFolder, $file); + return $this->fileEncrypted[$fileId]; + } + + /** + * @param Folder $userFolder + * @param string $path + * @return Folder + * @throws NotFoundException + */ + protected function findExistingParent(Folder $userFolder, $path) { + if ($path === '/') { + throw new NotFoundException('Reached the root'); + } + + try { + $folder = $userFolder->get(dirname($path)); + } catch (NotFoundException $e) { + return $this->findExistingParent($userFolder, dirname($path)); + } + + return $folder; + } + + /** + * Check all parents until the user's root folder if one is encrypted + * + * @param Folder $userFolder + * @param Node $file + * @return Node|null + */ + protected function getParentEndToEndEncryptionContainer(Folder $userFolder, Node $file) { + try { + $parent = $file->getParent(); + + if ($userFolder->getId() === $parent->getId()) { + return null; + } + } catch (\Exception $e) { + return null; + } + + if ($parent->isEncrypted()) { + return $parent; + } + + return $this->getParentEndToEndEncryptionContainer($userFolder, $parent); + } + /** * @param string $uid * @return array */ protected function getUser($uid) { - if (!isset($this->displayNames[$uid])) { - $this->displayNames[$uid] = $this->getDisplayName($uid); + // First try local user + $displayName = $this->userManager->getDisplayName($uid); + if ($displayName !== null) { + return [ + 'type' => 'user', + 'id' => $uid, + 'name' => $displayName, + ]; + } + + // Then a contact from the addressbook + if ($this->cloudIdManager->isValidCloudId($uid)) { + $cloudId = $this->cloudIdManager->resolveCloudId($uid); + return [ + 'type' => 'user', + 'id' => $cloudId->getUser(), + 'name' => $this->getDisplayNameFromAddressBook($cloudId->getDisplayId()), + 'server' => $cloudId->getRemote(), + ]; } + // Fallback to empty dummy data return [ 'type' => 'user', 'id' => $uid, - 'name' => $this->displayNames[$uid], + 'name' => $uid, ]; } - /** - * @param string $uid - * @return string - */ - protected function getDisplayName($uid) { - $user = $this->userManager->get($uid); - if ($user instanceof IUser) { - return $user->getDisplayName(); - } else { - return $uid; + protected function getDisplayNameFromAddressBook(string $search): string { + if (isset($this->displayNames[$search])) { + return $this->displayNames[$search]; } + + $addressBookContacts = $this->contactsManager->search($search, ['CLOUD'], [ + 'limit' => 1, + 'enumeration' => false, + 'fullmatch' => false, + 'strict_search' => true, + ]); + foreach ($addressBookContacts as $contact) { + if (isset($contact['isLocalSystemBook'])) { + continue; + } + + if (isset($contact['CLOUD'])) { + $cloudIds = $contact['CLOUD']; + if (is_string($cloudIds)) { + $cloudIds = [$cloudIds]; + } + + $lowerSearch = strtolower($search); + foreach ($cloudIds as $cloudId) { + if (strtolower($cloudId) === $lowerSearch) { + $this->displayNames[$search] = $contact['FN'] . " ($cloudId)"; + return $this->displayNames[$search]; + } + } + } + } + + return $search; } } |