code cleanup

matomo-org · Jul 21, 2023 · cb8dd85 · cb8dd85
1 parent 675ca15
commit cb8dd85
Show file tree

Hide file tree

Showing 13 changed files with 37 additions and 28 deletions.
diff --git a/core/SiteContentDetector.php b/core/SiteContentDetector.php
@@ -36,7 +36,7 @@
 class SiteContentDetector
 {
     /**
-     * @var array<string, ?array<string, SiteContentDetectionAbstract>>
+     * @var array<string, array<string, SiteContentDetectionAbstract>>
      */
     public $detectedContent = [
         SiteContentDetectionAbstract::TYPE_TRACKER => [],
@@ -82,6 +82,8 @@ public static function getSiteContentDetectionsByType()
     }
 
     /**
+     * Returns the site content detection object with the provided id, or null if it can't be found
+     *
      * @param string $id
      * @return SiteContentDetectionAbstract|null
      */
@@ -128,7 +130,11 @@ private function resetDetections(): void
      * the details of the detected content
      *
      * @param array       $detectContent Array of content type for which to check, defaults to all, limiting this list
-     *                                   will speed up the detection check
+     *                                   will speed up the detection check.
+     *                                   Allowed values are:
+     *                                   * empty array - to run all detections
+     *                                   * an array containing ids of detections, e.g. Wordpress::getId() or any of the
+     *                                     type constants, e.g. SiteContentDetectionAbstract::TYPE_TRACKER
      * @param ?int        $idSite        Override the site ID, will use the site from the current request if null
      * @param ?array      $siteResponse  String containing the site data to search, if blank then data will be retrieved
      *                                   from the current request site via an http request
@@ -207,6 +213,12 @@ public function wasDetected(string $detectionClassId): bool
         return false;
     }
 
+    /**
+     * Returns an array containing ids of all detected detections of the given type
+     *
+     * @param string $type One of the SiteContentDetectionAbstract::TYPE_* constants
+     * @return array
+     */
     public function getDetectsByType(string $type): array
     {
         $detected = [];
@@ -217,7 +229,6 @@ public function getDetectsByType(string $type): array
             }
         }
 
-
         return $detected;
     }
 
@@ -308,7 +319,7 @@ private function saveToCache(string $cacheKey, int $cacheLife): void
      *
      * @return void
      */
-    private function detectionChecks($detectContent): void
+    private function detectionChecks(array $detectContent): void
     {
         $detections = $this->getSiteContentDetectionsByType();
 

diff --git a/plugins/Installation/Controller.php b/plugins/Installation/Controller.php
@@ -401,7 +401,7 @@ public function trackingCode()
 
         $trackingUrl = trim(SettingsPiwik::getPiwikUrl(), '/') . '/' . $javascriptGenerator->getPhpTrackerEndpoint();
 
-        $this->siteContentDetector->detectContent();
+        $this->siteContentDetector->detectContent([], $idSite);
 
         $emailTemplateData = [
             'jsTag' => $rawJsTag,

diff --git a/plugins/SitesManager/Controller.php b/plugins/SitesManager/Controller.php
@@ -208,7 +208,7 @@ public function siteWithoutDataTabs()
         Piwik::postEvent('SitesManager.showMatomoLinksInTrackingCodeEmail', [&$showMatomoLinks]);
 
         $googleAnalyticsImporterMessage = '';
-        if (Manager::getInstance()->isPluginLoaded('GoogleAnalyticsImporter')) {
+        if (!Manager::getInstance()->isPluginLoaded('GoogleAnalyticsImporter')) {
             $googleAnalyticsImporterMessage = '<h3>' . Piwik::translate('CoreAdminHome_ImportFromGoogleAnalytics') . '</h3>'
                 . '<p>' . Piwik::translate('CoreAdminHome_ImportFromGoogleAnalyticsDescription', ['<a href="https://plugins.matomo.org/GoogleAnalyticsImporter" rel="noopener noreferrer" target="_blank">', '</a>']) . '</p>'
                 . '<p></p>';
@@ -265,6 +265,7 @@ public function siteWithoutDataTabs()
                 $instructionUrl    = $obj->getInstructionUrl();
 
                 Piwik::postEvent('Template.siteWithoutDataTab.' . $obj::getId() . '.content', [&$tabContent]);
+                Piwik::postEvent('Template.siteWithoutDataTab.' . $obj::getId() . '.others', [&$othersInstruction]);
 
                 if (!empty($tabContent) && $obj->shouldShowInstructionTab($this->siteContentDetector)) {
                     $templateData['tabs'][] = [

diff --git a/plugins/SitesManager/SiteContentDetection/ConsentManagerDetectionAbstract.php b/plugins/SitesManager/SiteContentDetection/ConsentManagerDetectionAbstract.php
@@ -25,5 +25,4 @@ final public static function getContentType(): string
      * @return bool
      */
     abstract public function checkIsConnected(?string $data = null, ?array $headers = null): bool;
-
-}
+}
diff --git a/plugins/SitesManager/SiteContentDetection/GoogleAnalytics3.php b/plugins/SitesManager/SiteContentDetection/GoogleAnalytics3.php
@@ -44,5 +44,4 @@ public function detectByContent(?string $data = null, ?array $headers = null): b
         }
         return false;
     }
-
 }
diff --git a/plugins/SitesManager/SiteContentDetection/GoogleAnalytics4.php b/plugins/SitesManager/SiteContentDetection/GoogleAnalytics4.php
@@ -41,5 +41,4 @@ public function detectByContent(?string $data = null, ?array $headers = null): b
 
         return false;
     }
-
 }
diff --git a/plugins/SitesManager/SiteContentDetection/SiteContentDetectionAbstract.php b/plugins/SitesManager/SiteContentDetection/SiteContentDetectionAbstract.php
@@ -20,17 +20,15 @@ abstract class SiteContentDetectionAbstract
     public const TYPE_CONSENT_MANAGER = 4;
     public const TYPE_OTHER = 99;
 
-    /**
-     * Holds the detection state, once it was executed
-     *
-     * @var null|bool
-     */
-    protected $wasDetected = null;
-
     public function __construct()
     {
     }
 
+    /**
+     * Returns the ID of the current detection. Automatically built from the class name (without namespace)
+     *
+     * @return string
+     */
     public static function getId(): string
     {
         $classParts = explode('\\', static::class);
@@ -123,4 +121,4 @@ public function renderOthersInstruction(): ?string
     {
         return null;
     }
-}
+}
diff --git a/plugins/SitesManager/SitesManager.php b/plugins/SitesManager/SitesManager.php
@@ -446,8 +446,6 @@ public function getClientSideTranslationKeys(&$translationKeys)
         $translationKeys[] = "SitesManager_EmailInstructionsButton";
         $translationKeys[] = "SitesManager_EmailInstructionsSubject";
         $translationKeys[] = "SitesManager_JsTrackingTagHelp";
-        $translationKeys[] = "SitesManager_SiteWithoutDataSinglePageApplication";
-        $translationKeys[] = "SitesManager_SiteWithoutDataSinglePageApplicationDescription";
         $translationKeys[] = 'SitesManager_SiteWithoutDataTitle';
         $translationKeys[] = 'SitesManager_SiteWithoutDataDescription';
         $translationKeys[] = 'SitesManager_SiteWithoutDataMessageDisappears';

diff --git a/plugins/SitesManager/templates/_siteWithoutDataTabs.twig b/plugins/SitesManager/templates/_siteWithoutDataTabs.twig
@@ -22,8 +22,8 @@
     <div class="col s12 tabs-row">
         <ul class="tabs no-data-screen-ul-tabs">
 
-            <li class="tab col {{ columnClass }}"><a {% if cms|length and (consentManagerName == false) and (activeTab == '') %} class="active" {% endif %} href="#integrations">{{ 'SitesManager_Integrations'|translate }}</a></li>
-            <li class="tab col {{ columnClass }}"><a {% if (cms|length == 0 and activeTab == '') or activeTab == 'consentManager') %} class="active" {% endif %} href="#tracking-code">{{ 'CoreAdminHome_TrackingCode'|translate }}</a></li>
+            <li class="tab col {{ columnClass }}"><a {% if cms|length and consentManagerName == false and activeTab == '' %} class="active" {% endif %} href="#integrations">{{ 'SitesManager_Integrations'|translate }}</a></li>
+            <li class="tab col {{ columnClass }}"><a {% if (cms|length == 0 or consentManagerName) and activeTab == '' %} class="active" {% endif %} href="#tracking-code">{{ 'CoreAdminHome_TrackingCode'|translate }}</a></li>
 
             {% for tab in tabs %}
                 <li class="tab col {{ columnClass }}"><a href="#{{ tab.id|lower }}"{% if activeTab == tab.id %} class="active"{% endif %}>{{ tab.name }}</a></li>

diff --git a/plugins/SitesManager/templates/_trackingCodeEmail.twig b/plugins/SitesManager/templates/_trackingCodeEmail.twig
@@ -6,7 +6,7 @@
 {{ 'SitesManager_GADetectedEmail'|translate('Google Analytics 3', 'GA', 'https://matomo.org/faq/how-to/migrate-from-google-analytics-3-to-matomo/')|raw }}
 
 {% endif %}
-{% if 'GoogleAnalytics3' in trackers %}
+{% if 'GoogleAnalytics4' in trackers %}
 {{ 'SitesManager_GADetectedEmail'|translate('Google Analytics 4', 'GA', 'https://matomo.org/faq/how-to/migrate-from-google-analytics-4-to-matomo/')|raw }}
 
 {% endif %}

diff --git a/tests/PHPUnit/Fixtures/DisableSiteContentDetection.php b/tests/PHPUnit/Fixtures/DisableSiteContentDetection.php
@@ -7,7 +7,6 @@
  */
 namespace Piwik\Tests\Fixtures;
 
-use Piwik\Plugins\SitesManager\SitesManager;
 use Piwik\Tests\Framework\Fixture;
 use Piwik\SiteContentDetector;
 use Piwik\Tests\Framework\Mock\FakeSiteContentDetector;

diff --git a/tests/PHPUnit/Fixtures/EmptySiteWithSiteContentDetectionWordpress.php b/tests/PHPUnit/Fixtures/EmptySiteWithSiteContentDetectionWordpress.php
@@ -9,7 +9,6 @@
 
 use Piwik\Plugins\SitesManager\SiteContentDetection\Cloudflare;
 use Piwik\Plugins\SitesManager\SiteContentDetection\WordPress;
-use Piwik\Plugins\SitesManager\SitesManager;
 use Piwik\Tests\Framework\Fixture;
 use Piwik\SiteContentDetector;
 use Piwik\Tests\Framework\Mock\FakeSiteContentDetector;

diff --git a/tests/PHPUnit/Integration/SiteContentDetectorTest.php b/tests/PHPUnit/Integration/SiteContentDetectorTest.php
@@ -21,13 +21,19 @@
 */
 class SiteContentDetectorTest extends IntegrationTestCase
 {
-
-
     public function testSiteWithMultipleDetections()
     {
         $scd = new SiteContentDetector();
         $scd->detectContent([], null, [
-            'data' => "<html lang='en'><head><title>A site</title></head><script src='https://localhost.com/js/react.min.js'></script><script src='https://osano.com/uhs9879874hthg.js'></script><script>Osano.cm.addEventListener('osano-cm-consent-changed', (change) => { console.log('cm-change'); consentSet(change); });</script></><body>A site<img src='/wp-content/uploads/images.gif'</body></html>",
+            'data' => "<html lang='en'>
+                        <head>
+                            <title>A site</title>
+                            <script src='https://localhost.com/js/react.min.js'></script>
+                            <script src='https://osano.com/uhs9879874hthg.js'></script>
+                            <script>Osano.cm.addEventListener('osano-cm-consent-changed', (change) => { console.log('cm-change'); consentSet(change); });</script>
+                        </head>
+                        <body>A site<img src='/wp-content/uploads/images.gif'</body>
+                       </html>",
             'headers' => [
                 'CF-RAY' => 'test'
             ],
-Original file line number
+Diff line change
@@ Expand Up / @@ -25,5 +25,4 @@ final public static function getContentType(): string @@
          * @return bool
          */
         abstract public function checkIsConnected(?string $data = null, ?array $headers = null): bool;
-    }
+    }
Original file line number	Diff line number	Diff line change
Expand Up		@@ -41,5 +41,4 @@ public function detectByContent(?string $data = null, ?array $headers = null): b

		return false;
		}

		}