Merge branch '5.x-dev' into security-fixes

Author: lachiebol

.github/workflows/matomo-tests.yml

@@ -1,7 +1,7 @@
 # Action for running tests
 # This file has been automatically created.
 # To recreate it you can run this command
-# ./console generate:test-action --plugin="ApiReference" --php-versions="7.2,8.4" --schedule-cron="0 19 * * 6"
+# ./console generate:test-action --plugin="ApiReference" --php-versions="7.4,8.4" --schedule-cron="0 19 * * 6"
 
 name: Plugin ApiReference Tests
 
@@ -37,7 +37,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: [ '7.2', '8.4' ]
+        php: [ '7.4', 'matomo5_max_php' ]
         target: ['minimum_required_matomo', 'maximum_supported_matomo']
     steps:
       - uses: actions/checkout@v3
@@ -55,4 +55,4 @@ jobs:
           matomo-test-branch: ${{ matrix.target }}
           redis-service: true
           artifacts-pass: ${{ secrets.ARTIFACTS_PASS }}
-          upload-artifacts: ${{ matrix.php == '7.2' && matrix.target == 'maximum_supported_matomo' }}
+          upload-artifacts: ${{ matrix.php == '7.4' && matrix.target == 'maximum_supported_matomo' }}

ApiReference.php

@@ -29,18 +29,32 @@ public function registerEvents()
 
     public function getClientSideTranslationKeys(&$translationKeys): void
     {
+        $translationKeys[] = 'General_API';
         $translationKeys[] = 'CoreHome_LearnMoreFullStop';
+        $translationKeys[] = 'ApiReference_LookingForLegacyApiReference';
         $translationKeys[] = 'ApiReference_ReportingApiMoreInformation';
         $translationKeys[] = 'ApiReference_ReportingApiReference';
         $translationKeys[] = 'ApiReference_ReportingApiSummary';
-        $translationKeys[] = 'ApiReference_SwaggerApi';
         $translationKeys[] = 'ApiReference_SwaggerPagePluginEmpty';
         $translationKeys[] = 'ApiReference_SwaggerPageRequestFailed';
         $translationKeys[] = 'ApiReference_SwaggerPageSpecLoadFailed';
+        $translationKeys[] = 'ApiReference_SwaggerPageSpecNotAvailable';
         $translationKeys[] = 'ApiReference_SwaggerPageSearchNoResults';
         $translationKeys[] = 'ApiReference_SwaggerPageSearchPlaceholder';
         $translationKeys[] = 'ApiReference_UserAuthentication';
         $translationKeys[] = 'ApiReference_UserAuthenticationManageTokens';
         $translationKeys[] = 'ApiReference_UserAuthenticationUsingTokenAuth';
     }
+
+    public function install()
+    {
+        $config = new Configuration();
+        $config->install();
+    }
+
+    public function uninstall()
+    {
+        $config = new Configuration();
+        $config->uninstall();
+    }
 }

Configuration.php

@@ -0,0 +1,70 @@
+<?php
+
+/**
+ * Matomo - free/libre analytics platform
+ *
+ * @link    https://matomo.org
+ * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+namespace Piwik\Plugins\ApiReference;
+
+use Piwik\Config;
+
+class Configuration
+{
+    public const DEFAULT_ENABLE_SPEC_GENERATION = 1;
+    public const KEY_ENABLE_SPEC_GENERATION = 'enable_spec_generation_task';
+
+    public function install()
+    {
+        $config = $this->getConfig();
+
+        $apiReferenceConfig = $config->ApiReference;
+        if (empty($apiReferenceConfig)) {
+            $apiReferenceConfig = array();
+        }
+
+        // we make sure to set a value only if none has been configured yet, eg in common config.
+        if (!array_key_exists(self::KEY_ENABLE_SPEC_GENERATION, $apiReferenceConfig)) {
+            $apiReferenceConfig[self::KEY_ENABLE_SPEC_GENERATION] = self::DEFAULT_ENABLE_SPEC_GENERATION;
+        }
+
+        $config->ApiReference = $apiReferenceConfig;
+        $config->forceSave();
+    }
+
+    public function uninstall()
+    {
+        $config = $this->getConfig();
+        $config->ApiReference = array();
+        $config->forceSave();
+    }
+
+
+    public function specGenerationEnabled()
+    {
+        $value = $this->getConfigValue(self::KEY_ENABLE_SPEC_GENERATION, self::DEFAULT_ENABLE_SPEC_GENERATION);
+
+        if ($value === false || $value === '' || $value === null) {
+            $value = self::DEFAULT_ENABLE_SPEC_GENERATION;
+        }
+
+        return (bool) $value;
+    }
+
+    private function getConfigValue($name, $default)
+    {
+        $config = $this->getConfig();
+        $attribution = $config->ApiReference;
+        if (isset($attribution[$name])) {
+            return $attribution[$name];
+        }
+        return $default;
+    }
+
+    private function getConfig()
+    {
+        return Config::getInstance();
+    }
+}

Controller.php

@@ -12,6 +12,7 @@
 namespace Piwik\Plugins\ApiReference;
 
 use Piwik\Piwik;
+use Piwik\Plugins\UsersManager\UserPreferences;
 use Piwik\View;
 
 class Controller extends \Piwik\Plugin\ControllerAdmin
@@ -22,7 +23,19 @@ public function swagger(): string
 
         $view = new View('@ApiReference/swagger');
         $this->setBasicVariablesView($view);
+        $view->defaultWebsiteId = $this->getDefaultWebsiteId();
 
         return $view->render();
     }
+
+    private function getDefaultWebsiteId(): ?int
+    {
+        $defaultWebsiteId = (new UserPreferences())->getDefaultWebsiteId();
+
+        if (is_numeric($defaultWebsiteId)) {
+            return (int) $defaultWebsiteId;
+        }
+
+        return null;
+    }
 }

Menu.php

@@ -20,10 +20,10 @@ public function configureAdminMenu(MenuAdmin $menu): void
             return;
         }
 
-        $menu->addPlatformItem(
-            'ApiReference_SwaggerApi',
-            $this->urlForAction('swagger'),
-            30
+        $menu->editUrl(
+            'CorePluginsAdmin_MenuPlatform',
+            'General_API',
+            $this->urlForAction('swagger')
         );
     }
 }

Tasks.php

@@ -11,7 +11,6 @@
 
 namespace Piwik\Plugins\ApiReference;
 
-use Piwik\Config;
 use Piwik\Log\LoggerInterface;
 use Piwik\Plugins\ApiReference\Generation\PluginListProvider;
 use Piwik\Plugins\ApiReference\Generation\SpecGenerationService;
@@ -32,15 +31,21 @@ class Tasks extends \Piwik\Plugin\Tasks
      * @var PluginListProvider
      */
     private $pluginListProvider;
+    /**
+     * @var Configuration
+     */
+    private $config;
 
     public function __construct(
         SpecGenerationService $specGenerationService,
         LoggerInterface $logger,
-        ?PluginListProvider $pluginListProvider = null
+        ?PluginListProvider $pluginListProvider = null,
+        ?Configuration $config = null
     ) {
         $this->specGenerationService = $specGenerationService;
         $this->logger = $logger;
         $this->pluginListProvider = $pluginListProvider ?? new PluginListProvider();
+        $this->config = $config ?? new Configuration();
     }
 
     public function schedule()
@@ -77,6 +82,6 @@ public function generateConfiguredPluginSpecs(): void
 
     private function isSpecGenerationEnabled(): bool
     {
-        return (bool) (Config::getInstance()->ApiReference['enable_spec_generation_task'] ?? 0);
+        return $this->config->specGenerationEnabled();
     }
 }

lang/en.json

@@ -1,15 +1,16 @@
 {
     "ApiReference": {
+        "LookingForLegacyApiReference": "Looking for the legacy API reference? The %1$slegacy API reference%2$s page is still available while we continue improving the new API documentation. If anything is missing or behaving unexpectedly in this new version, %3$splease let us know%4$s so we can improve the experience.",
         "ReportingApiMoreInformation": "More info about the Matomo APIs available in %1$sIntroduction to Matomo API%2$s and the %3$sMatomo API Reference%4$s.",
         "ReportingApiReference": "Reporting API Reference",
         "ReportingApiSummary": "All the data in Matomo is available through simple APIs.",
-        "SwaggerApi": "Swagger API",
         "SwaggerPagePluginEmpty": "No plugins are configured in the ApiReference whitelist.",
         "SwaggerPageRequestFailed": "The plugin whitelist could not be loaded.",
-        "SwaggerPageSpecLoadFailed": "The OpenAPI spec could not be loaded for this plugin.",
         "SwaggerPageSearchNoResults": "No plugins match your search.",
         "SwaggerPageSearchPlaceholder": "Search by plugin name",
         "UseTryItOutForLiveResponse": "Example responses require Super User access. Use Try it out to see a live response.",
+        "SwaggerPageSpecLoadFailed": "The OpenAPI spec could not be loaded for this plugin.",
+        "SwaggerPageSpecNotAvailable": "The OpenAPI spec is not available for this plugin yet. %1$sLearn more%2$s",
         "UserAuthentication": "User authentication",
         "UserAuthenticationManageTokens": "You can manage your authentication tokens on your security page.",
         "UserAuthenticationUsingTokenAuth": "If you want to request data within a script, a crontab, etc. you need to add the '%3$s' URL parameter to the API calls for URLs that require authentication."

plugin.json

@@ -13,6 +13,7 @@
     "license": "GPL v3+",
     "homepage": "https:\/\/matomo.org",
     "require": {
+        "php": ">=7.4.0",
         "matomo": ">=5.0.0-stable,<6.0.0-b1"
     },
     "authors": [

templates/swagger.twig

@@ -7,11 +7,12 @@
     <script src="plugins/ApiReference/vue/lib/swagger-ui/swagger-ui-bundle.js"></script>
 {% endblock %}
 
-{% set title %}{{ 'ApiReference_SwaggerApi'|translate }}{% endset %}
+{% set title %}{{ 'General_API'|translate }}{% endset %}
 
 {% block content %}
     <div
         vue-entry="ApiReference.SwaggerPage"
+        default-website-id="{{ defaultWebsiteId|default(null)|json_encode }}"
         piwik-url="{{ piwikUrl|default(null)|json_encode }}"
     ></div>
 {% endblock %}

tests/Integration/ControllerTest.php

@@ -91,6 +91,7 @@ public function testSwaggerRendersAdminPageForViewAccess(): void
 
         $this->assertNotSame('', $html);
         $this->assertStringContainsString('vue-entry="ApiReference.SwaggerPage"', $html);
+        $this->assertStringContainsString('default-website-id="1"', $html);
         $this->assertStringContainsString('piwik-url=', $html);
         $this->assertStringContainsString('plugins/ApiReference/vue/lib/swagger-ui/swagger-ui.css', $html);
         $this->assertStringContainsString('plugins/ApiReference/vue/src/SwaggerPage/swagger-ui-overrides.css', $html);