Introduce a new event to filter sites displayed on all websites dashb…

…oard (#22306) * Introduce a new event to filter sites displayed on all websites dashboard Co-authored-by: Michal Kleiner <[email protected]>
matomo-org · Jun 12, 2024 · 88be1b3 · 88be1b3
1 parent 3090b18
commit 88be1b3
Show file tree

Hide file tree

Showing 7 changed files with 1,174 additions and 17 deletions.
diff --git a/plugins/MultiSites/API.php b/plugins/MultiSites/API.php
@@ -91,18 +91,33 @@ public function getAll($period, $date, $segment = false, $_restrictSitesToLogin
     {
         Piwik::checkUserHasSomeViewAccess();
 
-        $sites = $this->getSitesIdFromPattern($pattern, $_restrictSitesToLogin);
+        $idSites = $this->getSitesIdFromPattern($pattern, $_restrictSitesToLogin);
+
+        /**
+         * This event can be used to manipulate the sites being displayed on all websites dashboard.
+         *
+         * **Example**
+         *
+         *     Piwik::addAction('MultiSites.filterSites', function (&$idSites) {
+         *         $idSites = array_filter($idSites, function($idSite) {
+         *             return $idSite !== 1
+         *         });
+         *     });
+         *
+         * @param array &$idSites List of idSites that the current user would be allowed to see in all websites dashboard.
+         */
+        Piwik::postEvent('MultiSites.filterSites', [&$idSites]);
 
         if (!empty($showColumns) && !is_array($showColumns)) {
             $showColumns = explode(',', $showColumns);
         }
 
-        if (empty($sites)) {
+        if (empty($idSites)) {
             return new DataTable();
         }
 
         return $this->buildDataTable(
-            $sites,
+            $idSites,
             $period,
             $date,
             $segment,
@@ -159,8 +174,12 @@ private function getSitesIdFromPattern($pattern, $_restrictSitesToLogin)
 
         // Both calls above have called Site::setSitesFromArray. We now get these sites:
         $sitesToProblablyAdd = Site::getSites();
+        $idSites = [];
+        foreach ($sitesToProblablyAdd as $site) {
+            $idSites[] = $site['idsite'];
+        }
 
-        return $sitesToProblablyAdd;
+        return $idSites;
     }
 
     /**
@@ -180,10 +199,14 @@ public function getOne($idSite, $period, $date, $segment = false, $_restrictSite
     {
         Piwik::checkUserHasViewAccess($idSite);
 
-        $sites = $this->getSiteFromId($idSite);
+        $site = $this->getSiteFromId($idSite);
+
+        if (empty($site)) {
+            return new DataTable();
+        }
 
         return $this->buildDataTable(
-            $sites,
+            [$idSite],
             $period,
             $date,
             $segment,
@@ -233,20 +256,11 @@ public function getAllWithGroups($period = null, $date = null, $segment = false,
     private function getSiteFromId($idSite)
     {
         $idSite = (int) $idSite;
-        $sites = array(APISitesManager::getInstance()->getSiteFromId($idSite));
-
-        return $sites;
+        return APISitesManager::getInstance()->getSiteFromId($idSite);
     }
 
-    private function buildDataTable($sitesToProblablyAdd, $period, $date, $segment, $_restrictSitesToLogin, $enhanced, $multipleWebsitesRequested, $showColumns)
+    private function buildDataTable($idSites, $period, $date, $segment, $_restrictSitesToLogin, $enhanced, $multipleWebsitesRequested, $showColumns)
     {
-        $idSites = array();
-        if (!empty($sitesToProblablyAdd)) {
-            foreach ($sitesToProblablyAdd as $site) {
-                $idSites[] = $site['idsite'];
-            }
-        }
-
         // build the archive type used to query archive data
         $archive = Archive::build(
             $idSites,

diff --git a/plugins/MultiSites/tests/System/ApiTest.php b/plugins/MultiSites/tests/System/ApiTest.php
@@ -9,6 +9,7 @@
 
 namespace Piwik\Plugins\MultiSites\tests\System;
 
+use Piwik\Piwik;
 use Piwik\Plugins\MultiSites\tests\Fixtures\ManySitesWithVisits;
 use Piwik\Tests\Framework\TestCase\SystemTestCase;
 
@@ -95,6 +96,22 @@ public function getApiForTesting()
         ];
     }
 
+    /**
+     * @dataProvider getApiForTesting
+     */
+    public function testApiFiltered($api, $params)
+    {
+        $params['testSuffix'] .= '_filtered';
+
+        Piwik::addAction('MultiSites.filterSites', function (&$idSites) {
+            $idSites = array_filter($idSites, function ($idSite) {
+                return $idSite != 2 && $idSite != 10;
+            });
+        });
+
+        $this->runApiTests($api, $params);
+    }
+
     public static function getOutputPrefix()
     {
         return '';