From 37786c4d74618bcedc9f6087a8994aa224a349ff Mon Sep 17 00:00:00 2001 From: Christoph Wurst Date: Thu, 19 Mar 2020 09:47:36 +0100 Subject: [PATCH] Convert share event to an interaction event Signed-off-by: Christoph Wurst --- .../composer/composer/autoload_real.php | 3 + .../composer/composer/autoload_classmap.php | 1 + .../composer/composer/autoload_static.php | 1 + .../files_sharing/lib/AppInfo/Application.php | 3 +- .../lib/Listener/ShareInteractionListener.php | 95 +++++++++++++++++++ 5 files changed, 102 insertions(+), 1 deletion(-) create mode 100644 apps/files_sharing/lib/Listener/ShareInteractionListener.php diff --git a/apps/contactsinteraction/composer/composer/autoload_real.php b/apps/contactsinteraction/composer/composer/autoload_real.php index 33a78bc418..efb953248d 100644 --- a/apps/contactsinteraction/composer/composer/autoload_real.php +++ b/apps/contactsinteraction/composer/composer/autoload_real.php @@ -13,6 +13,9 @@ class ComposerAutoloaderInitContactsInteraction } } + /** + * @return \Composer\Autoload\ClassLoader + */ public static function getLoader() { if (null !== self::$loader) { diff --git a/apps/files_sharing/composer/composer/autoload_classmap.php b/apps/files_sharing/composer/composer/autoload_classmap.php index da355a48ce..046f626d04 100644 --- a/apps/files_sharing/composer/composer/autoload_classmap.php +++ b/apps/files_sharing/composer/composer/autoload_classmap.php @@ -50,6 +50,7 @@ return array( 'OCA\\Files_Sharing\\ISharedStorage' => $baseDir . '/../lib/ISharedStorage.php', 'OCA\\Files_Sharing\\Listener\\LoadAdditionalListener' => $baseDir . '/../lib/Listener/LoadAdditionalListener.php', 'OCA\\Files_Sharing\\Listener\\LoadSidebarListener' => $baseDir . '/../lib/Listener/LoadSidebarListener.php', + 'OCA\\Files_Sharing\\Listener\\ShareInteractionListener' => $baseDir . '/../lib/Listener/ShareInteractionListener.php', 'OCA\\Files_Sharing\\Listener\\UserAddedToGroupListener' => $baseDir . '/../lib/Listener/UserAddedToGroupListener.php', 'OCA\\Files_Sharing\\Listener\\UserShareAcceptanceListener' => $baseDir . '/../lib/Listener/UserShareAcceptanceListener.php', 'OCA\\Files_Sharing\\Middleware\\OCSShareAPIMiddleware' => $baseDir . '/../lib/Middleware/OCSShareAPIMiddleware.php', diff --git a/apps/files_sharing/composer/composer/autoload_static.php b/apps/files_sharing/composer/composer/autoload_static.php index 08e7a502f7..c1e8874458 100644 --- a/apps/files_sharing/composer/composer/autoload_static.php +++ b/apps/files_sharing/composer/composer/autoload_static.php @@ -65,6 +65,7 @@ class ComposerStaticInitFiles_Sharing 'OCA\\Files_Sharing\\ISharedStorage' => __DIR__ . '/..' . '/../lib/ISharedStorage.php', 'OCA\\Files_Sharing\\Listener\\LoadAdditionalListener' => __DIR__ . '/..' . '/../lib/Listener/LoadAdditionalListener.php', 'OCA\\Files_Sharing\\Listener\\LoadSidebarListener' => __DIR__ . '/..' . '/../lib/Listener/LoadSidebarListener.php', + 'OCA\\Files_Sharing\\Listener\\ShareInteractionListener' => __DIR__ . '/..' . '/../lib/Listener/ShareInteractionListener.php', 'OCA\\Files_Sharing\\Listener\\UserAddedToGroupListener' => __DIR__ . '/..' . '/../lib/Listener/UserAddedToGroupListener.php', 'OCA\\Files_Sharing\\Listener\\UserShareAcceptanceListener' => __DIR__ . '/..' . '/../lib/Listener/UserShareAcceptanceListener.php', 'OCA\\Files_Sharing\\Middleware\\OCSShareAPIMiddleware' => __DIR__ . '/..' . '/../lib/Middleware/OCSShareAPIMiddleware.php', diff --git a/apps/files_sharing/lib/AppInfo/Application.php b/apps/files_sharing/lib/AppInfo/Application.php index 40c024eea4..51f7ab75a1 100644 --- a/apps/files_sharing/lib/AppInfo/Application.php +++ b/apps/files_sharing/lib/AppInfo/Application.php @@ -36,9 +36,9 @@ use OCA\Files_Sharing\Capabilities; use OCA\Files_Sharing\Controller\ExternalSharesController; use OCA\Files_Sharing\Controller\ShareController; use OCA\Files_Sharing\External\Manager; -use OCA\Files_Sharing\Listener\GlobalShareAcceptanceListener; use OCA\Files_Sharing\Listener\LoadAdditionalListener; use OCA\Files_Sharing\Listener\LoadSidebarListener; +use OCA\Files_Sharing\Listener\ShareInteractionListener; use OCA\Files_Sharing\Listener\UserAddedToGroupListener; use OCA\Files_Sharing\Listener\UserShareAcceptanceListener; use OCA\Files_Sharing\Middleware\OCSShareAPIMiddleware; @@ -213,6 +213,7 @@ class Application extends App { // sidebar and files scripts $dispatcher->addServiceListener(LoadAdditionalScriptsEvent::class, LoadAdditionalListener::class); $dispatcher->addServiceListener(LoadSidebar::class, LoadSidebarListener::class); + $dispatcher->addServiceListener(ShareCreatedEvent::class, ShareInteractionListener::class); $dispatcher->addListener('\OCP\Collaboration\Resources::loadAdditionalScripts', function() { \OCP\Util::addScript('files_sharing', 'dist/collaboration'); }); diff --git a/apps/files_sharing/lib/Listener/ShareInteractionListener.php b/apps/files_sharing/lib/Listener/ShareInteractionListener.php new file mode 100644 index 0000000000..de4753d3da --- /dev/null +++ b/apps/files_sharing/lib/Listener/ShareInteractionListener.php @@ -0,0 +1,95 @@ + + * + * @author 2020 Christoph Wurst + * + * @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 . + */ + +namespace OCA\Files_Sharing\Listener; + +use OCP\Contacts\Events\ContactInteractedWithEvent; +use OCP\EventDispatcher\Event; +use OCP\EventDispatcher\IEventDispatcher; +use OCP\EventDispatcher\IEventListener; +use OCP\ILogger; +use OCP\IUserManager; +use OCP\Share\Events\ShareCreatedEvent; +use OCP\Share\IShare; +use function in_array; + +class ShareInteractionListener implements IEventListener { + + private const SUPPORTED_SHARE_TYPES = [ + IShare::TYPE_USER, + IShare::TYPE_EMAIL, + IShare::TYPE_REMOTE, + ]; + + /** @var IEventDispatcher */ + private $dispatcher; + + /** @var IUserManager */ + private $userManager; + + /** @var ILogger */ + private $logger; + + public function __construct(IEventDispatcher $dispatcher, + IUserManager $userManager, + ILogger $logger) { + $this->dispatcher = $dispatcher; + $this->userManager = $userManager; + $this->logger = $logger; + } + + public function handle(Event $event): void { + if (!($event instanceof ShareCreatedEvent)) { + // Unrelated + return; + } + + $share = $event->getShare(); + if (!in_array($share->getShareType(), self::SUPPORTED_SHARE_TYPES, true)) { + $this->logger->debug('Share type does not allow to emit interaction event'); + return; + } + $actor = $this->userManager->get($share->getSharedBy()); + if ($actor === null) { + $this->logger->warning('Share was not created by a user, can\'t emit interaction event'); + return; + } + $interactionEvent = new ContactInteractedWithEvent($actor); + switch ($share->getShareType()) { + case IShare::TYPE_USER: + $interactionEvent->setUid($share->getSharedWith()); + break; + case IShare::TYPE_EMAIL: + $interactionEvent->setEmail($share->getSharedWith()); + break; + case IShare::TYPE_REMOTE: + $interactionEvent->setFederatedCloudId($share->getSharedWith()); + break; + } + + $this->dispatcher->dispatchTyped($interactionEvent); + } + +}