Modify the API of the events to handle competing listeners

The generated pathname can now only be set once and all further attempts are rejected. Listeners are expected to test this with `hasFile()` prior to taking any action.

Author: dtdesign

wcfsetup/install/files/lib/event/file/GenerateThumbnail.class.php

@@ -16,13 +16,29 @@
  */
 final class GenerateThumbnail implements IPsr14Event
 {
-    /**
-     * The absolute path to the generated WebP image.
-     */
-    public ?string $filename = null;
+    private string $pathname;
 
     public function __construct(
         public readonly File $file,
         public readonly ThumbnailFormat $thumbnailFormat,
     ) {}
+
+    /**
+     * Sets the pathname of the generated image unless it has already been set
+     * in which case the call will throw an exception. You must check the result
+     * of `hasFile()` first.
+     */
+    public function setGeneratedFile(string $pathname): void
+    {
+        if (isset($this->pathname)) {
+            throw new \BadMethodCallException("Cannot set the generated file, a value has already been set.");
+        }
+
+        $this->pathname = $pathname;
+    }
+
+    public function getPathname(): ?string
+    {
+        return $this->pathname ?? null;
+    }
 }

wcfsetup/install/files/lib/event/file/GenerateWebpVariant.class.php

@@ -2,11 +2,12 @@
 
 namespace wcf\event\file;
 
+use BadMethodCallException;
 use wcf\data\file\File;
 use wcf\event\IPsr14Event;
 
 /**
- * Requests the generation of a WebP variant of the provided file.
+ * Requests the generation of a WebP variant for the provided image.
  *
  * @author      Alexander Ebert
  * @copyright   2001-2024 WoltLab GmbH
@@ -15,12 +16,37 @@
  */
 final class GenerateWebpVariant implements IPsr14Event
 {
-    /**
-     * The absolute path to the generated WebP image.
-     */
-    public ?string $filename = null;
+    private string $pathname;
 
     public function __construct(
         public readonly File $file
     ) {}
+
+    /**
+     * Returns true if a file has already been set and no further files are
+     * being accepted.
+     */
+    public function hasFile(): bool
+    {
+        return isset($this->pathname);
+    }
+
+    /**
+     * Sets the pathname of the generated image unless it has already been set
+     * in which case the call will throw an exception. You must check the result
+     * of `hasFile()` first.
+     */
+    public function setGeneratedFile(string $pathname): void
+    {
+        if (isset($this->pathname)) {
+            throw new \BadMethodCallException("Cannot set the generated file, a value has already been set.");
+        }
+
+        $this->pathname = $pathname;
+    }
+
+    public function getPathname(): ?string
+    {
+        return $this->pathname ?? null;
+    }
 }

wcfsetup/install/files/lib/system/file/processor/FileProcessor.class.php

@@ -165,7 +165,7 @@ public function generateWebpVariant(File $file): void
         $event = new GenerateWebpVariant($file);
         EventHandler::getInstance()->fire($event);
 
-        $filename = $event->filename;
+        $filename = $event->getPathname();
         if ($filename === null) {
             $imageAdapter = ImageHandler::getInstance()->getAdapter();
             if (!$imageAdapter->checkMemoryLimit($file->width, $file->height, $file->mimeType)) {
@@ -263,7 +263,7 @@ public function generateThumbnails(File $file): void
             $event = new GenerateThumbnail($file, $format);
             EventHandler::getInstance()->fire($event);
 
-            $filename = $event->filename;
+            $filename = $event->getPathname();
             if ($filename === null) {
                 if ($imageAdapter === null) {
                     $imageAdapter = ImageHandler::getInstance()->getAdapter();