New events for custom manipulation

lochmueller · Oct 21, 2024 · 1220e14 · 1220e14
1 parent 77d8ad0
commit 1220e14
Show file tree

Hide file tree

Showing 8 changed files with 78 additions and 5 deletions.
diff --git a/Classes/Event/GeneratorConfigManipulationEvent.php b/Classes/Event/GeneratorConfigManipulationEvent.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SFC\Staticfilecache\Event;
+
+use Psr\Http\Message\ResponseInterface;
+
+final class GeneratorConfigManipulationEvent
+{
+    public function __construct(
+        protected array $config,
+    ) {}
+
+    public function getConfig(): array
+    {
+        return $this->config;
+    }
+
+    public function setConfig(array $config): void
+    {
+        $this->config = $config;
+    }
+
+
+}
diff --git a/Classes/Event/GeneratorContentManipulationEvent.php b/Classes/Event/GeneratorContentManipulationEvent.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SFC\Staticfilecache\Event;
+
+use Psr\Http\Message\ResponseInterface;
+
+final class GeneratorContentManipulationEvent
+{
+    public function __construct(
+        protected string $content,
+    ) {}
+
+    public function getContent(): string
+    {
+        return $this->content;
+    }
+
+    public function setContent(string $content): void
+    {
+        $this->content = $content;
+    }
+
+
+}
diff --git a/Classes/Generator/AbstractGenerator.php b/Classes/Generator/AbstractGenerator.php
@@ -4,6 +4,7 @@
 
 namespace SFC\Staticfilecache\Generator;
 
+use Psr\EventDispatcher\EventDispatcherInterface;
 use Psr\Http\Message\ResponseInterface;
 use SFC\Staticfilecache\Event\GeneratorCreate;
 use SFC\Staticfilecache\Event\GeneratorRemove;
@@ -14,6 +15,8 @@
 
 abstract class AbstractGenerator
 {
+    public function __construct(protected EventDispatcherInterface $eventDispatcher) {}
+
     abstract public function generate(GeneratorCreate $generatorCreateEvent): void;
 
     abstract public function remove(GeneratorRemove $generatorRemoveEvent): void;

diff --git a/Classes/Generator/BrotliGenerator.php b/Classes/Generator/BrotliGenerator.php
@@ -7,6 +7,7 @@
 use Psr\Http\Message\ResponseInterface;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerAwareTrait;
+use SFC\Staticfilecache\Event\GeneratorContentManipulationEvent;
 use SFC\Staticfilecache\Event\GeneratorCreate;
 use SFC\Staticfilecache\Event\GeneratorRemove;
 use SFC\Staticfilecache\Service\RemoveService;
@@ -21,7 +22,9 @@ public function generate(GeneratorCreate $generatorCreateEvent): void
         if (!$this->checkAvailable()) {
             return;
         }
-        $contentCompress = brotli_compress((string) $generatorCreateEvent->getResponse()->getBody());
+        /** @var GeneratorContentManipulationEvent  $contentManipulationEvent */
+        $contentManipulationEvent = $this->eventDispatcher->dispatch(new GeneratorContentManipulationEvent((string) $generatorCreateEvent->getResponse()->getBody()));
+        $contentCompress = brotli_compress($contentManipulationEvent->getContent());
         if ($contentCompress) {
             $this->writeFile($generatorCreateEvent->getFileName() . '.br', $contentCompress);
         }

diff --git a/Classes/Generator/ConfigGenerator.php b/Classes/Generator/ConfigGenerator.php
@@ -5,6 +5,7 @@
 namespace SFC\Staticfilecache\Generator;
 
 use Psr\Http\Message\ResponseInterface;
+use SFC\Staticfilecache\Event\GeneratorConfigManipulationEvent;
 use SFC\Staticfilecache\Event\GeneratorCreate;
 use SFC\Staticfilecache\Event\GeneratorRemove;
 use SFC\Staticfilecache\Service\ConfigurationService;
@@ -20,7 +21,10 @@ public function generate(GeneratorCreate $generatorCreateEvent): void
             'headers' => GeneralUtility::makeInstance(ConfigurationService::class)
                 ->getValidHeaders($generatorCreateEvent->getResponse()->getHeaders(), 'validFallbackHeaders'),
         ];
-        $this->writeFile($generatorCreateEvent->getFileName() . '.config.json', json_encode($config, JSON_PRETTY_PRINT));
+        /** @var GeneratorConfigManipulationEvent  $configManipulationEvent */
+        $configManipulationEvent = $this->eventDispatcher->dispatch(new GeneratorConfigManipulationEvent($config));
+
+        $this->writeFile($generatorCreateEvent->getFileName() . '.config.json', json_encode($configManipulationEvent->getConfig(), JSON_PRETTY_PRINT));
     }
 
     public function remove(GeneratorRemove $generatorRemoveEvent): void

diff --git a/Classes/Generator/GzipGenerator.php b/Classes/Generator/GzipGenerator.php
@@ -5,6 +5,7 @@
 namespace SFC\Staticfilecache\Generator;
 
 use Psr\Http\Message\ResponseInterface;
+use SFC\Staticfilecache\Event\GeneratorContentManipulationEvent;
 use SFC\Staticfilecache\Event\GeneratorCreate;
 use SFC\Staticfilecache\Event\GeneratorRemove;
 use SFC\Staticfilecache\Service\RemoveService;
@@ -24,7 +25,9 @@ public function generate(GeneratorCreate $generatorCreateEvent): void
         if (!$this->getConfigurationService()->get('enableGeneratorGzip')) {
             return;
         }
-        $contentGzip = gzencode((string) $generatorCreateEvent->getResponse()->getBody(), $this->getCompressionLevel());
+        /** @var GeneratorContentManipulationEvent  $contentManipulationEvent */
+        $contentManipulationEvent = $this->eventDispatcher->dispatch(new GeneratorContentManipulationEvent((string) $generatorCreateEvent->getResponse()->getBody()));
+        $contentGzip = gzencode($contentManipulationEvent->getContent(), $this->getCompressionLevel());
         if ($contentGzip) {
             $this->writeFile($generatorCreateEvent->getFileName() . '.gz', $contentGzip);
         }

diff --git a/Classes/Generator/PhpGenerator.php b/Classes/Generator/PhpGenerator.php
@@ -5,6 +5,7 @@
 namespace SFC\Staticfilecache\Generator;
 
 use Psr\Http\Message\ResponseInterface;
+use SFC\Staticfilecache\Event\GeneratorContentManipulationEvent;
 use SFC\Staticfilecache\Event\GeneratorCreate;
 use SFC\Staticfilecache\Event\GeneratorRemove;
 use SFC\Staticfilecache\Service\ConfigurationService;
@@ -35,12 +36,15 @@ public function generate(GeneratorCreate $generatorCreateEvent): void
         $headers = array_map(fn($item) => str_replace("'", "\'", $item), $headers);
         $requestUri = GeneralUtility::getIndpEnv('REQUEST_URI');
 
+        /** @var GeneratorContentManipulationEvent  $contentManipulationEvent */
+        $contentManipulationEvent = $this->eventDispatcher->dispatch(new GeneratorContentManipulationEvent((string) $generatorCreateEvent->getResponse()->getBody()));
+
         $variables = [
             'expires' => (new DateTimeService())->getCurrentTime() + $lifetime,
             'sendCacheControlHeaderRedirectAfterCacheTimeout' => $configuration->isBool('sendCacheControlHeaderRedirectAfterCacheTimeout'),
             'headers' => $headers,
             'requestUri' => $requestUri,
-            'body' => (string) $generatorCreateEvent->getResponse()->getBody(),
+            'body' => $contentManipulationEvent->getContent(),
         ];
 
         $this->renderTemplateToFile($this->getTemplateName(), $variables, $generatorCreateEvent->getFileName() . '.php');

diff --git a/Classes/Generator/PlainGenerator.php b/Classes/Generator/PlainGenerator.php
@@ -4,6 +4,7 @@
 
 namespace SFC\Staticfilecache\Generator;
 
+use SFC\Staticfilecache\Event\GeneratorContentManipulationEvent;
 use SFC\Staticfilecache\Event\GeneratorCreate;
 use SFC\Staticfilecache\Event\GeneratorRemove;
 
@@ -15,7 +16,10 @@ public function generate(GeneratorCreate $generatorCreateEvent): void
         if (!$this->getConfigurationService()->get('enableGeneratorPlain')) {
             return;
         }
-        $this->writeFile($generatorCreateEvent->getFileName(), (string) $generatorCreateEvent->getResponse()->getBody());
+        /** @var GeneratorContentManipulationEvent  $contentManipulationEvent */
+        $contentManipulationEvent = $this->eventDispatcher->dispatch(new GeneratorContentManipulationEvent((string) $generatorCreateEvent->getResponse()->getBody()));
+
+        $this->writeFile($generatorCreateEvent->getFileName(), $contentManipulationEvent->getContent());
     }
 
     public function remove(GeneratorRemove $generatorRemoveEvent): void