[2.x] feat: support opcache flushing

composer.json

@@ -110,6 +110,7 @@
         "flarum/suspend": "self.version",
         "flarum/tags": "self.version",
         "flarum/messages": "self.version",
+        "flarum/composer-plugin": "self.version",
         "flarum/phpstan": "self.version",
         "flarum/testing": "self.version"
     },
@@ -122,6 +123,7 @@
         "doctrine/dbal": "^3.6.2",
         "dragonmantank/cron-expression": "^3.3",
         "fakerphp/faker": "^1.9.1",
+        "flarum/composer-plugin": "2.x-dev",
         "flarum/json-api-server": "^0.1.0",
         "franzl/whoops-middleware": "2.0",
         "guzzlehttp/guzzle": "*",

extensions/package-manager/src/ExtensionManagerServiceProvider.php

@@ -15,8 +15,11 @@
 use Flarum\Extension\ExtensionManager;
 use Flarum\ExtensionManager\Composer\ComposerAdapter;
 use Flarum\ExtensionManager\Event\FlarumUpdated;
+use Flarum\ExtensionManager\Extension\Event\Installed;
+use Flarum\ExtensionManager\Extension\Event\Removed;
 use Flarum\ExtensionManager\Extension\Event\Updated;
 use Flarum\ExtensionManager\Listener\ClearCacheAfterUpdate;
+use Flarum\ExtensionManager\Listener\ClearOPCacheAfterUpdate;
 use Flarum\ExtensionManager\Listener\ReCheckForUpdates;
 use Flarum\Foundation\AbstractServiceProvider;
 use Flarum\Foundation\Paths;
@@ -100,5 +103,6 @@ function (Updated $event) use ($container) {
 
         $events->listen(FlarumUpdated::class, ClearCacheAfterUpdate::class);
         $events->listen([FlarumUpdated::class, Updated::class], ReCheckForUpdates::class);
+        $events->listen([Installed::class, Updated::class, Removed::class, FlarumUpdated::class], ClearOPCacheAfterUpdate::class);
     }
 }

extensions/package-manager/src/Listener/ClearOPCacheAfterUpdate.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Flarum\ExtensionManager\Listener;
+
+use Flarum\Foundation\Paths;
+use Flarum\Http\Middleware\ClearOPCache;
+
+readonly class ClearOPCacheAfterUpdate
+{
+    public function __construct(private readonly Paths $paths)
+    {
+    }
+
+    public function handle(): void
+    {
+        $path = $this->paths->storage . ClearOPCache::PATH;
+
+        if (file_exists($path) || ! function_exists('opcache_reset')) {
+            return;
+        }
+
+        @file_put_contents($path, (string) time());
+    }
+}

framework/core/composer.json

@@ -42,6 +42,7 @@
         "doctrine/dbal": "^3.6",
         "dragonmantank/cron-expression": "*",
         "fakerphp/faker": "^1.9.1",
+        "flarum/composer-plugin": "2.x-dev",
         "franzl/whoops-middleware": "2.0",
         "guzzlehttp/guzzle": "^7.7",
         "illuminate/bus": "^13.0",

framework/core/src/Admin/AdminServiceProvider.php

@@ -50,6 +50,7 @@ public function register(): void
 
         $this->container->singleton('flarum.admin.middleware', function () {
             return [
+                HttpMiddleware\ClearOPCache::class,
                 HttpMiddleware\InjectActorReference::class,
                 'flarum.admin.error_handler',
                 HttpMiddleware\ParseJsonBody::class,

framework/core/src/Api/ApiServiceProvider.php

@@ -86,6 +86,7 @@ public function register(): void
 
         $this->container->singleton('flarum.api.middleware', function () {
             return [
+                HttpMiddleware\ClearOPCache::class,
                 HttpMiddleware\InjectActorReference::class,
                 'flarum.api.error_handler',
                 HttpMiddleware\ParseJsonBody::class,

framework/core/src/Forum/ForumServiceProvider.php

@@ -61,6 +61,7 @@ public function register(): void
 
         $this->container->singleton('flarum.forum.middleware', function () {
             return [
+                HttpMiddleware\ClearOPCache::class,
                 HttpMiddleware\InjectActorReference::class,
                 'flarum.forum.error_handler',
                 HttpMiddleware\ParseJsonBody::class,

framework/core/src/Http/Middleware/ClearOPCache.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Flarum\Http\Middleware;
+
+use Exception;
+use Flarum\Foundation\Paths;
+use Illuminate\Contracts\Container\Container;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Server\MiddlewareInterface as Middleware;
+use Psr\Http\Server\RequestHandlerInterface;
+
+class ClearOPCache implements Middleware
+{
+    const PATH = '/cache/clear-opcache';
+
+    public function __construct(private readonly Container $container)
+    {}
+
+    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
+    {
+        if (! function_exists('opcache_reset') || ! file_exists($this->path())) {
+            return $handler->handle($request);
+        }
+
+        opcache_reset();
+
+        @unlink($this->path());
+
+        return $handler->handle($request);
+    }
+
+    public function path(): string
+    {
+        if ($this->container->bound(Paths::class)) {
+            return $this->container->make(Paths::class)->storage . static::PATH;
+        }
+
+        // Fallback when Paths is not available during installation.
+        $path = dirname(__DIR__, 3);
+        $upTo = dirname(__DIR__, 6);
+
+        while(true) {
+            if ($path === $upTo) throw new Exception('Could not find storage directory');
+            if ($path === '.') throw new Exception('Could not find storage directory');
+
+            if (is_dir("$path/storage")) break;
+            $path = dirname($path);
+        }
+
+        return "$path/storage" . static::PATH;
+    }
+}

framework/core/src/Install/Installer.php

@@ -34,6 +34,7 @@ public function getContainer(): Container
     public function getRequestHandler(): RequestHandlerInterface
     {
         $pipe = new MiddlewarePipe;
+        $pipe->pipe(new HttpMiddleware\ClearOPCache($this->getContainer()));
         $pipe->pipe(new HttpMiddleware\HandleErrors(
             $this->container->make(Registry::class),
             $this->container->make(WhoopsFormatter::class),

php-packages/composer-plugin/composer.json

@@ -0,0 +1,23 @@
+{
+    "name": "flarum/composer-plugin",
+    "description": "Assists Flarum with Composer",
+    "type": "composer-plugin",
+    "license": "MIT",
+    "require": {
+        "composer-plugin-api": "^2.0"
+    },
+    "require-dev": {
+        "composer/composer": "^2.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Flarum\\Composer\\Plugin\\": "src/"
+        }
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-main": "2.x-dev"
+        },
+        "class": "Flarum\\Composer\\Plugin\\ComposerPlugin"
+    }
+}

php-packages/composer-plugin/src/ComposerPlugin.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Flarum\Composer\Plugin;
+
+use Composer\Composer;
+use Composer\EventDispatcher\EventSubscriberInterface;
+use Composer\IO\IOInterface;
+use Composer\Plugin\PluginInterface;
+use Flarum\Http\Middleware\ClearOPCache;
+
+class ComposerPlugin implements PluginInterface, EventSubscriberInterface
+{
+    private Composer $composer;
+
+    public function activate(Composer $composer, IOInterface $io): void
+    {
+        $this->composer = $composer;
+    }
+
+    public function deactivate(Composer $composer, IOInterface $io): void {}
+    public function uninstall(Composer $composer, IOInterface $io): void {}
+
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            'post-autoload-dump' => 'flag',
+        ];
+    }
+
+    public function flag(): void
+    {
+        $path = class_exists(ClearOPCache::class) ? ClearOPCache::PATH : '/storage/cache/clear-opcache';
+
+        $vendorDir  = $this->composer->getConfig()->get('vendor-dir');
+        $flagFile   = dirname($vendorDir) . $path;
+
+        if (is_dir(dirname($flagFile)) && ! file_exists($flagFile)) {
+            @file_put_contents($flagFile, (string) time());
+        }
+    }
+}