correctly map 3rd party Matomo plugin's links to WP's plugin directory (#1296)

* initial working solution

* extract and refactor

* add unit and e2e test

* update expected screenshots

* update woocommerce tested against version

* add bug fix to changelog

* fix random e2e test failure

* update expected screenshots

Author: diosmosis

CHANGELOG.md

@@ -7,7 +7,7 @@
  * Version: 5.3.1
  * Domain Path: /languages
  * WC requires at least: 2.4.0
- * WC tested up to: 9.8.5
+ * WC tested up to: 9.9.3
  *
  * Matomo - free/libre analytics platform
  *

matomo.php

@@ -0,0 +1,85 @@
+<?php
+/**
+ * Matomo - free/libre analytics platform
+ *
+ * @link https://matomo.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ *
+ */
+
+namespace Piwik\Plugins\WordPress\Html;
+
+use Piwik\Common;
+
+class PluginUrlReplacer
+{
+    public function replaceThirdPartyPluginUrls($html): string
+    {
+        // replace all links to third party Matomo plugin files with their proper WordPress URLs
+        $html = preg_replace_callback(
+            '%\"((?:\\./)?plugins/.*?)\"%',
+            function ($matches) {
+                // $url looks like plugins/SearchEngineKeywordsPerformance/images/...
+                $url = $matches[1];
+                $replace = $this->rewritePathIfThirdPartyPluginUrl($url);
+                if (!empty($replace)) {
+                    return '"' . $replace . '"';
+                }
+
+                return $matches[0];
+            },
+            $html
+        );
+
+        // replace URLs to third party Matomo plugin files in JSON values (used to initiate Vue components)
+        $html = preg_replace_callback(
+            '%&quot;(?:\\.\\\\/)?plugins\\\\/.*?&quot;%',
+            function ($matches) {
+                // $url looks like plugins/SearchEngineKeywordsPerformance/images/...
+                $url = Common::unsanitizeInputValue( $matches[0] );
+                $url = json_decode($url, true);
+                if (empty($url) || !is_string($url)) { // sanity check
+                    return $matches[0];
+                }
+
+                $replace = $this->rewritePathIfThirdPartyPluginUrl($url);
+                if (!empty($replace)) {
+                    $replace = json_encode($replace);
+                    $replace = Common::sanitizeInputValue($replace);
+                    return $replace;
+                }
+
+                return $matches[0];
+            },
+            $html
+        );
+
+        return $html;
+    }
+
+    private function rewritePathIfThirdPartyPluginUrl(string $url): ?string
+    {
+        if (substr($url, 0, 2) === './') {
+            $url = substr($url, 2);
+        }
+
+        $segments = explode('/', $url);
+        $plugin = $segments[1] ?? '';
+
+        // entries in this array will look like:
+        // /path/to/wordpress/wp-content/plugins/SearchEngineKeywordsPerformance/SearchEngineKeywordsPerformance.php
+        $allPluginsInstalledInWp = $GLOBALS['MATOMO_PLUGIN_FILES'] ?? [];
+        foreach ($allPluginsInstalledInWp as $matomoPluginFile) {
+            if (basename($matomoPluginFile) === $plugin . '.php') {
+                array_shift($segments);
+                array_shift($segments);
+                $urlRelativeToPlugin = implode('/', $segments);
+
+                $replace = plugins_url($urlRelativeToPlugin, $matomoPluginFile);
+                return $replace;
+            }
+        }
+
+        return null;
+    }
+}

plugins/WordPress/Html/PluginUrlReplacer.php

@@ -19,6 +19,7 @@
 use Piwik\Plugin;
 use Piwik\Plugin\Manager;
 use Piwik\Plugins\CoreHome\SystemSummary\Item;
+use Piwik\Plugins\WordPress\Html\PluginUrlReplacer;
 use Piwik\Scheduler\Task;
 use Piwik\Url;
 use Piwik\Version;
@@ -355,11 +356,15 @@ public function onGetSystemSettingsEnd(&$settings)
         });
     }
 
-    public function onDispatchRequestEnd(&$result, $module, $action, $parameters) {
+    public function onDispatchRequestEnd(&$result, $module, $action, $parameters)
+    {
     	if (!empty($result) && is_string($result)) {
     		// https://wordpress.org/support/topic/bugged-favicon/#post-12995669
     		$result = str_replace('<link rel="mask-icon"', '<link rel="ignore-mask-icon-ignore"', $result);
     		$result = str_replace('plugins/CoreHome/images/applePinnedTab.svg', '', $result);
+
+            $pluginUrlReplacer = new PluginUrlReplacer();
+            $result = $pluginUrlReplacer->replaceThirdPartyPluginUrls( $result );
 	    }
     }
     public function onDispatchRequest(&$module, &$action, &$parameters)