Added plugin list service with event to hook in to

Author: lachiebol

API.php

@@ -10,36 +10,31 @@
 namespace Piwik\Plugins\OpenApiDocs;
 
 use Piwik\Piwik;
+use Piwik\Plugins\OpenApiDocs\Generation\PluginListProvider;
 use Piwik\Plugin\Manager;
 use Piwik\Plugins\OpenApiDocs\Specs\SpecGenerator;
 use Piwik\Plugins\OpenApiDocs\Specs\PathResolver;
 
 /**
  * Provides Reporting API endpoints for reading OpenAPI plugin configuration and specifications.
  *
- * Exposes endpoints to return the configured plugin whitelist, read pre-generated spec files,
+ * Exposes endpoints to return the effective plugin list for spec generation, read pre-generated spec files,
  * or generate plugin OpenAPI specifications on demand.
  *
  * @method static \Piwik\Plugins\OpenApiDocs\API getInstance()
  */
 class API extends \Piwik\Plugin\API
 {
     /**
-     * Returns the plugin names configured for OpenApiDocs spec generation.
+     * Returns the plugin names used for OpenApiDocs spec generation.
      *
-     * @return array<int, string> The configured whitelist of plugin names from
-     *                            `config/plugins.php`.
+     * @return array<int, string>
      */
     public function getPluginWhitelist(): array
     {
         Piwik::checkUserHasSomeViewAccess();
 
-        $pluginWhitelist = $this->loadPluginWhitelist();
-        if (!is_array($pluginWhitelist)) {
-            throw new \Exception('OpenApiDocs plugin whitelist config is invalid.');
-        }
-
-        return $pluginWhitelist;
+        return PluginListProvider::getPluginsForSpecGeneration();
     }
 
     /**
@@ -88,14 +83,6 @@ protected function getSpecFilePath(string $pluginName): string
         return $this->getSpecPathResolver()->getSpecFilePath($pluginName);
     }
 
-    /**
-     * @return mixed
-     */
-    protected function loadPluginWhitelist()
-    {
-        return require __DIR__ . '/config/plugins.php';
-    }
-
     protected function isSpecFileReadable(string $filePath): bool
     {
         return is_file($filePath) && is_readable($filePath);
@@ -126,7 +113,6 @@ protected function getSpecPathResolver(): PathResolver
     {
         return new PathResolver();
     }
-
     /**
      * Generates an OpenAPI specification for one or more plugins and returns it immediately.
      *

Generation/PluginListProvider.php

@@ -0,0 +1,65 @@
+<?php
+
+/**
+ * Matomo - free/libre analytics platform
+ *
+ * @link    https://matomo.org
+ * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+declare(strict_types=1);
+
+namespace Piwik\Plugins\OpenApiDocs\Generation;
+
+use Piwik\Plugin\Manager;
+use Piwik\Piwik;
+use Piwik\Plugins\OpenApiDocs\OpenApiDocs;
+
+class PluginListProvider
+{
+    /**
+     * @return string[]
+     */
+    public static function getPluginsForSpecGeneration(): array
+    {
+        $pluginNames = [];
+
+        foreach (Manager::getInstance()->getInstalledPluginsName() as $pluginName) {
+            if (!self::shouldIncludePlugin($pluginName)) {
+                continue;
+            }
+
+            $pluginNames[] = $pluginName;
+        }
+
+        self::dispatchUpdatePluginListEvent($pluginNames);
+
+        return array_values(array_unique($pluginNames));
+    }
+
+    private static function shouldIncludePlugin(string $pluginName): bool
+    {
+        if (in_array($pluginName, OpenApiDocs::PLUGIN_BLOCKLIST, true)) {
+            return false;
+        }
+
+        $pluginManager = Manager::getInstance();
+
+        if (
+            !$pluginManager->isPluginActivated($pluginName)
+            || !$pluginManager->isPluginInFilesystem($pluginName)
+        ) {
+            return false;
+        }
+
+        return is_file(Manager::getPluginDirectory($pluginName) . '/API.php');
+    }
+
+    /**
+     * @param string[] $pluginNames
+     */
+    private static function dispatchUpdatePluginListEvent(array &$pluginNames): void
+    {
+        Piwik::postEvent('OpenApiDocs.updatePluginList', [&$pluginNames]);
+    }
+}

Tasks.php

@@ -13,6 +13,7 @@
 
 use Piwik\Config;
 use Piwik\Log\LoggerInterface;
+use Piwik\Plugins\OpenApiDocs\Generation\PluginListProvider;
 use Piwik\Plugins\OpenApiDocs\Generation\SpecGenerationService;
 
 class Tasks extends \Piwik\Plugin\Tasks
@@ -42,7 +43,7 @@ public function schedule()
 
     public function generateConfiguredPluginSpecs(): void
     {
-        $pluginNames = require __DIR__ . '/config/plugins.php';
+        $pluginNames = PluginListProvider::getPluginsForSpecGeneration();
 
         foreach ($pluginNames as $pluginName) {
             try {