Add event to alter delete website confirmation (#22484)

* Adds event to alter delete website explanation, #PG-3574 * Refactor code to getDeleteExplantionText only when deleteAction is triggered * Ui test updated * Updated UI screenshot * Updated UI screenshot * Apply PR feedback * Updated UI screenshot * Apply PR feedbacks * Fixes failing tests * Removes TagManager dependent test * Changes for even space * Applied PR feedback --------- Co-authored-by: Michal Kleiner <[email protected]>
matomo-org · Sep 4, 2024 · 50477f7 · 50477f7
1 parent 7cbe3b4
commit 50477f7
Show file tree

Hide file tree

Showing 5 changed files with 115 additions and 33 deletions.
diff --git a/plugins/SitesManager/API.php b/plugins/SitesManager/API.php
@@ -394,6 +394,32 @@ public function getSitesWithAdminAccess($fetchAliasUrls = false, $pattern = fals
         return $sites;
     }
 
+    /**
+     * Returns the messages to warn users on site deletion.
+     *
+     * @param int $idSite
+     * @return array messages to warn users
+     * @throws Exception if the website ID doesn't exist or the user doesn't have super user access to it
+     * @internal
+     * @unsanitized
+     */
+    public function getMessagesToWarnOnSiteRemoval(int $idSite): array
+    {
+        $messages = [];
+        Piwik::checkUserHasSuperUserAccess();
+        /**
+         * Triggered before a modal to delete a measurable is displayed
+         *
+         * A plugin can listen to it and add additional information to be displayed in the measurable delete modal body
+         *
+         * @param array &$messages Additional messages to be shown in the delete measurable modal body
+         * @param int $idSite The idSite to be deleted
+         */
+        Piwik::postEvent('SitesManager.getMessagesToWarnOnSiteRemoval', [&$messages, $idSite]);
+
+        return $messages;
+    }
+
     /**
      * Returns the list of websites with the 'view' access for the current user.
      * For the superUser it doesn't return any result because the superUser has admin access on all the websites (use getSitesWithAtLeastViewAccess() instead).

diff --git a/plugins/SitesManager/tests/Integration/ApiTest.php b/plugins/SitesManager/tests/Integration/ApiTest.php
@@ -714,6 +714,25 @@ public function testGetSitesWithAdminAccessShouldApplyPatternAndLimit()
         $this->assertReturnedSitesContainsSiteIds([5, 15], $sites);
     }
 
+    public function testGetMessagesToWarnOnSiteRemovalShouldReturnDefaultValue()
+    {
+        $pluginManager = Plugin\Manager::getInstance();
+        if ($pluginManager->isPluginActivated('TagManager')) {
+            $pluginManager->deactivatePlugin('TagManager');
+        }
+        API::getInstance()->addSite("site1", ["http://piwik.net", "http://piwik.com"]);
+        API::getInstance()->addSite("site2", ["http://piwik.com", "http://piwik.net"]);
+        $this->assertEmpty(API::getInstance()->getMessagesToWarnOnSiteRemoval(1));
+        $this->assertEmpty(API::getInstance()->getMessagesToWarnOnSiteRemoval(2));
+    }
+
+    public function testGetMessagesToWarnOnSiteRemovalShouldThrowExceptionIfNotSuperUser()
+    {
+        $this->expectException(\Exception::class);
+        $this->createManySitesWithAdminAccess(1);
+        API::getInstance()->getMessagesToWarnOnSiteRemoval(1);
+    }
+
     private function createManySitesWithAdminAccess($numSites)
     {
         for ($i = 1; $i <= $numSites; $i++) {