Emit typed event when preview is requested

Signed-off-by: Julius Härtl <jus@bitgrid.net>

diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php
index a4468d54b90ee157a372d0fe8f7c2aab1cfb9c45..0b229fb63fda8aa9d2ccdf381c84a48461ece4e2 100644 (file)
--- a/lib/composer/composer/autoload_classmap.php
+++ b/lib/composer/composer/autoload_classmap.php
@@ -493,6 +493,7 @@ return array(
     'OCP\\Notification\\INotifier' => $baseDir . '/lib/public/Notification/INotifier.php',
     'OCP\\OCS\\IDiscoveryService' => $baseDir . '/lib/public/OCS/IDiscoveryService.php',
     'OCP\\PreConditionNotMetException' => $baseDir . '/lib/public/PreConditionNotMetException.php',
+    'OCP\\Preview\\BeforePreviewFetchedEvent' => $baseDir . '/lib/public/Preview/BeforePreviewFetchedEvent.php',
     'OCP\\Preview\\IProvider' => $baseDir . '/lib/public/Preview/IProvider.php',
     'OCP\\Preview\\IProviderV2' => $baseDir . '/lib/public/Preview/IProviderV2.php',
     'OCP\\Preview\\IVersionedPreviewFile' => $baseDir . '/lib/public/Preview/IVersionedPreviewFile.php',

diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php
index 13da8f91274ec5c443a54d0578dd16454e59e20c..333a0e65ef3fedff00b2d060f8ec8035993ef790 100644 (file)
--- a/lib/composer/composer/autoload_static.php
+++ b/lib/composer/composer/autoload_static.php
@@ -526,6 +526,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OCP\\Notification\\INotifier' => __DIR__ . '/../../..' . '/lib/public/Notification/INotifier.php',
         'OCP\\OCS\\IDiscoveryService' => __DIR__ . '/../../..' . '/lib/public/OCS/IDiscoveryService.php',
         'OCP\\PreConditionNotMetException' => __DIR__ . '/../../..' . '/lib/public/PreConditionNotMetException.php',
+        'OCP\\Preview\\BeforePreviewFetchedEvent' => __DIR__ . '/../../..' . '/lib/public/Preview/BeforePreviewFetchedEvent.php',
         'OCP\\Preview\\IProvider' => __DIR__ . '/../../..' . '/lib/public/Preview/IProvider.php',
         'OCP\\Preview\\IProviderV2' => __DIR__ . '/../../..' . '/lib/public/Preview/IProviderV2.php',
         'OCP\\Preview\\IVersionedPreviewFile' => __DIR__ . '/../../..' . '/lib/public/Preview/IVersionedPreviewFile.php',

diff --git a/lib/private/Preview/Generator.php b/lib/private/Preview/Generator.php
index ef44188da74da8ff624ff958f37a40360a5ec8bd..a49cc8e522ec8f4ba4da0de05a4bf5d1525db428 100644 (file)
--- a/lib/private/Preview/Generator.php
+++ b/lib/private/Preview/Generator.php
@@ -29,6 +29,7 @@
  */
 namespace OC\Preview;
 
+use OCP\EventDispatcher\IEventDispatcher;
 use OCP\Files\File;
 use OCP\Files\IAppData;
 use OCP\Files\InvalidPathException;
@@ -40,6 +41,7 @@ use OCP\IConfig;
 use OCP\IImage;
 use OCP\IPreview;
 use OCP\IStreamImage;
+use OCP\Preview\BeforePreviewFetchedEvent;
 use OCP\Preview\IProviderV2;
 use OCP\Preview\IVersionedPreviewFile;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
@@ -56,26 +58,23 @@ class Generator {
        /** @var GeneratorHelper */
        private $helper;
        /** @var EventDispatcherInterface */
+       private $legacyEventDispatcher;
+       /** @var IEventDispatcher */
        private $eventDispatcher;
 
-       /**
-        * @param IConfig $config
-        * @param IPreview $previewManager
-        * @param IAppData $appData
-        * @param GeneratorHelper $helper
-        * @param EventDispatcherInterface $eventDispatcher
-        */
        public function __construct(
                IConfig $config,
                IPreview $previewManager,
                IAppData $appData,
                GeneratorHelper $helper,
-               EventDispatcherInterface $eventDispatcher
+               EventDispatcherInterface $legacyEventDispatcher,
+               IEventDispatcher $eventDispatcher
        ) {
                $this->config = $config;
                $this->previewManager = $previewManager;
                $this->appData = $appData;
                $this->helper = $helper;
+               $this->legacyEventDispatcher = $legacyEventDispatcher;
                $this->eventDispatcher = $eventDispatcher;
        }
 
@@ -102,10 +101,14 @@ class Generator {
                        'crop' => $crop,
                        'mode' => $mode,
                ];
-               $this->eventDispatcher->dispatch(
+
+               $this->legacyEventDispatcher->dispatch(
                        IPreview::EVENT,
                        new GenericEvent($file, $specification)
                );
+               $this->eventDispatcher->dispatchTyped(new BeforePreviewFetchedEvent(
+                       $file
+               ));
 
                // since we only ask for one preview, and the generate method return the last one it created, it returns the one we want
                return $this->generatePreviews($file, [$specification], $mimeType);

diff --git a/lib/private/PreviewManager.php b/lib/private/PreviewManager.php
index a2d34892c6866b061333dc5e4a176eb31077521b..0d08ef3eba57d713f4bdbb863c75df45e3b74262 100644 (file)
--- a/lib/private/PreviewManager.php
+++ b/lib/private/PreviewManager.php
@@ -34,6 +34,7 @@ use OC\AppFramework\Bootstrap\Coordinator;
 use OC\Preview\Generator;
 use OC\Preview\GeneratorHelper;
 use OCP\AppFramework\QueryException;
+use OCP\EventDispatcher\IEventDispatcher;
 use OCP\Files\File;
 use OCP\Files\IAppData;
 use OCP\Files\IRootFolder;
@@ -51,7 +52,8 @@ class PreviewManager implements IPreview {
        protected IConfig $config;
        protected IRootFolder $rootFolder;
        protected IAppData $appData;
-       protected EventDispatcherInterface $eventDispatcher;
+       protected IEventDispatcher $eventDispatcher;
+       protected EventDispatcherInterface $legacyEventDispatcher;
        private ?Generator $generator = null;
        private GeneratorHelper $helper;
        protected bool $providerListDirty = false;
@@ -73,20 +75,22 @@ class PreviewManager implements IPreview {
        private IBinaryFinder $binaryFinder;
 
        public function __construct(
-               IConfig $config,
-               IRootFolder $rootFolder,
-               IAppData $appData,
-               EventDispatcherInterface $eventDispatcher,
-               GeneratorHelper $helper,
-               ?string $userId,
-               Coordinator $bootstrapCoordinator,
-               IServerContainer $container,
-               IBinaryFinder $binaryFinder
+               IConfig                  $config,
+               IRootFolder              $rootFolder,
+               IAppData                 $appData,
+               IEventDispatcher                 $eventDispatcher,
+               EventDispatcherInterface $legacyEventDispatcher,
+               GeneratorHelper          $helper,
+               ?string                  $userId,
+               Coordinator              $bootstrapCoordinator,
+               IServerContainer         $container,
+               IBinaryFinder            $binaryFinder
        ) {
                $this->config = $config;
                $this->rootFolder = $rootFolder;
                $this->appData = $appData;
                $this->eventDispatcher = $eventDispatcher;
+               $this->legacyEventDispatcher = $legacyEventDispatcher;
                $this->helper = $helper;
                $this->userId = $userId;
                $this->bootstrapCoordinator = $bootstrapCoordinator;
@@ -153,6 +157,7 @@ class PreviewManager implements IPreview {
                                        $this->rootFolder,
                                        $this->config
                                ),
+                               $this->legacyEventDispatcher,
                                $this->eventDispatcher
                        );
                }

diff --git a/lib/private/Server.php b/lib/private/Server.php
index d804cca2086778d5b66629a2b9ff95a2bfdc1f00..1da1b614b5b2ccf7034ab6e21a0f65b01150a32e 100644 (file)
--- a/lib/private/Server.php
+++ b/lib/private/Server.php
@@ -335,6 +335,7 @@ class Server extends ServerContainer implements IServerContainer {
                                        $c->get(IRootFolder::class),
                                        $c->get(SystemConfig::class)
                                ),
+                               $c->get(IEventDispatcher::class),
                                $c->get(SymfonyAdapter::class),
                                $c->get(GeneratorHelper::class),
                                $c->get(ISession::class)->get('user_id'),

diff --git a/lib/public/Preview/BeforePreviewFetchedEvent.php b/lib/public/Preview/BeforePreviewFetchedEvent.php
new file mode 100644 (file)
index 0000000..37da63b
--- /dev/null
+++ b/lib/public/Preview/BeforePreviewFetchedEvent.php
@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2022 Julius Härtl <jus@bitgrid.net>
+ *
+ * @author Julius Härtl <jus@bitgrid.net>
+ *
+ * @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/>.
+ */
+
+
+namespace OCP\Preview;
+
+use OCP\Files\Node;
+
+/**
+ * @since 25.0.1
+ */
+class BeforePreviewFetchedEvent extends \OCP\EventDispatcher\Event {
+       private Node $node;
+
+       /**
+        * @since 25.0.1
+        */
+       public function __construct(Node $node) {
+               parent::__construct();
+               $this->node = $node;
+       }
+
+       /**
+        * @since 25.0.1
+        */
+       public function getNode(): Node {
+               return $this->node;
+       }
+}

diff --git a/tests/lib/Preview/GeneratorTest.php b/tests/lib/Preview/GeneratorTest.php
index 1e38afd7744c1560e114934a750e33ffb7ddcf1c..0dec1aaafa8fab72875e00afbbb79551986a61ab 100644 (file)
--- a/tests/lib/Preview/GeneratorTest.php
+++ b/tests/lib/Preview/GeneratorTest.php
@@ -25,6 +25,7 @@ namespace Test\Preview;
 
 use OC\Preview\Generator;
 use OC\Preview\GeneratorHelper;
+use OCP\EventDispatcher\IEventDispatcher;
 use OCP\Files\File;
 use OCP\Files\IAppData;
 use OCP\Files\NotFoundException;
@@ -32,6 +33,7 @@ use OCP\Files\SimpleFS\ISimpleFile;
 use OCP\Files\SimpleFS\ISimpleFolder;
 use OCP\IConfig;
 use OCP\IPreview;
+use OCP\Preview\BeforePreviewFetchedEvent;
 use OCP\Preview\IProviderV2;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\EventDispatcher\GenericEvent;
@@ -50,9 +52,12 @@ class GeneratorTest extends \Test\TestCase {
        /** @var GeneratorHelper|\PHPUnit\Framework\MockObject\MockObject */
        private $helper;
 
-       /** @var EventDispatcherInterface|\PHPUnit\Framework\MockObject\MockObject */
+       /** @var IEventDispatcher|\PHPUnit\Framework\MockObject\MockObject */
        private $eventDispatcher;
 
+       /** @var EventDispatcherInterface|\PHPUnit\Framework\MockObject\MockObject */
+       private $legacyEventDispatcher;
+
        /** @var Generator */
        private $generator;
 
@@ -63,13 +68,15 @@ class GeneratorTest extends \Test\TestCase {
                $this->previewManager = $this->createMock(IPreview::class);
                $this->appData = $this->createMock(IAppData::class);
                $this->helper = $this->createMock(GeneratorHelper::class);
-               $this->eventDispatcher = $this->createMock(EventDispatcherInterface::class);
+               $this->eventDispatcher = $this->createMock(IEventDispatcher::class);
+               $this->legacyEventDispatcher = $this->createMock(EventDispatcherInterface::class);
 
                $this->generator = new Generator(
                        $this->config,
                        $this->previewManager,
                        $this->appData,
                        $this->helper,
+                       $this->legacyEventDispatcher,
                        $this->eventDispatcher
                );
        }
@@ -109,7 +116,7 @@ class GeneratorTest extends \Test\TestCase {
                        ->with($this->equalTo('256-256.png'))
                        ->willReturn($previewFile);
 
-               $this->eventDispatcher->expects($this->once())
+               $this->legacyEventDispatcher->expects($this->once())
                        ->method('dispatch')
                        ->with(
                                $this->equalTo(IPreview::EVENT),
@@ -120,6 +127,10 @@ class GeneratorTest extends \Test\TestCase {
                                })
                        );
 
+               $this->eventDispatcher->expects($this->once())
+                       ->method('dispatchTyped')
+                       ->with(new BeforePreviewFetchedEvent($file));
+
                $result = $this->generator->getPreview($file, 100, 100);
                $this->assertSame($previewFile, $result);
        }
@@ -239,7 +250,7 @@ class GeneratorTest extends \Test\TestCase {
                        ->method('putContent')
                        ->with('my resized data');
 
-               $this->eventDispatcher->expects($this->once())
+               $this->legacyEventDispatcher->expects($this->once())
                        ->method('dispatch')
                        ->with(
                                $this->equalTo(IPreview::EVENT),
@@ -250,6 +261,10 @@ class GeneratorTest extends \Test\TestCase {
                                })
                        );
 
+               $this->eventDispatcher->expects($this->once())
+                       ->method('dispatchTyped')
+                       ->with(new BeforePreviewFetchedEvent($file));
+
                $result = $this->generator->getPreview($file, 100, 100);
                $this->assertSame($previewFile, $result);
        }
@@ -285,7 +300,7 @@ class GeneratorTest extends \Test\TestCase {
                        ->with($this->equalTo('1024-512-crop.png'))
                        ->willThrowException(new NotFoundException());
 
-               $this->eventDispatcher->expects($this->once())
+               $this->legacyEventDispatcher->expects($this->once())
                        ->method('dispatch')
                        ->with(
                                $this->equalTo(IPreview::EVENT),
@@ -298,6 +313,10 @@ class GeneratorTest extends \Test\TestCase {
                                })
                        );
 
+               $this->eventDispatcher->expects($this->once())
+                       ->method('dispatchTyped')
+                       ->with(new BeforePreviewFetchedEvent($file));
+
                $this->generator->getPreview($file, 1024, 512, true, IPreview::MODE_COVER, 'invalidType');
        }
 
@@ -333,7 +352,7 @@ class GeneratorTest extends \Test\TestCase {
                $this->previewManager->expects($this->never())
                        ->method('isMimeSupported');
 
-               $this->eventDispatcher->expects($this->once())
+               $this->legacyEventDispatcher->expects($this->once())
                        ->method('dispatch')
                        ->with(
                                $this->equalTo(IPreview::EVENT),
@@ -346,6 +365,10 @@ class GeneratorTest extends \Test\TestCase {
                                })
                        );
 
+               $this->eventDispatcher->expects($this->once())
+                       ->method('dispatchTyped')
+                       ->with(new BeforePreviewFetchedEvent($file));
+
                $result = $this->generator->getPreview($file, 1024, 512, true, IPreview::MODE_COVER, 'invalidType');
                $this->assertSame($preview, $result);
        }
@@ -370,7 +393,7 @@ class GeneratorTest extends \Test\TestCase {
                $this->previewManager->method('getProviders')
                        ->willReturn([]);
 
-               $this->eventDispatcher->expects($this->once())
+               $this->legacyEventDispatcher->expects($this->once())
                        ->method('dispatch')
                        ->with(
                                $this->equalTo(IPreview::EVENT),
@@ -381,6 +404,10 @@ class GeneratorTest extends \Test\TestCase {
                                })
                        );
 
+               $this->eventDispatcher->expects($this->once())
+                       ->method('dispatchTyped')
+                       ->with(new BeforePreviewFetchedEvent($file));
+
                $this->expectException(NotFoundException::class);
                $this->generator->getPreview($file, 100, 100);
        }
@@ -502,7 +529,7 @@ class GeneratorTest extends \Test\TestCase {
                        ->with($this->equalTo($filename))
                        ->willReturn($preview);
 
-               $this->eventDispatcher->expects($this->once())
+               $this->legacyEventDispatcher->expects($this->once())
                        ->method('dispatch')
                        ->with(
                                $this->equalTo(IPreview::EVENT),
@@ -515,6 +542,10 @@ class GeneratorTest extends \Test\TestCase {
                                })
                        );
 
+               $this->eventDispatcher->expects($this->once())
+                       ->method('dispatchTyped')
+                       ->with(new BeforePreviewFetchedEvent($file));
+
                $result = $this->generator->getPreview($file, $reqX, $reqY, $crop, $mode);
                if ($expectedX === $maxX && $expectedY === $maxY) {
                        $this->assertSame($maxPreview, $result);