Make feature gates individually dismissible per user (4 Backport)

plugins/CoreVue/types/index.d.ts

@@ -91,6 +91,8 @@ declare global {
     sendContentAsDownload(filename: string, content: any, mimeType?: string): void;
     showVisitorProfilePopup(visitorId: string, idSite: string|number): void;
     hideAjaxError(): void;
+    showAjaxLoading(loadingDivID?: string): void;
+    hideAjaxLoading(loadingDivID?: string): void;
     refreshAfter(timeoutPeriod: number): void;
   }
 

plugins/ProfessionalServices/API.php

@@ -0,0 +1,49 @@
+<?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\ProfessionalServices;
+
+use Piwik\Piwik;
+use Piwik\Plugins\ProfessionalServices\Widgets\DismissibleWidget;
+
+class API extends \Piwik\Plugin\API
+{
+    /**
+     * @var PromoWidgetDismissal
+     */
+    private $promoWidgetDismissal;
+
+    public function __construct(PromoWidgetDismissal $promoWidgetDismissal)
+    {
+        $this->promoWidgetDismissal = $promoWidgetDismissal;
+    }
+
+    /**
+     * Dismisses a promo widget to no longer be shown in the menu
+     *
+     * @internal
+     *
+     * @param string $widgetName
+     * @return bool
+     * @throws \Piwik\NoAccessException
+     */
+    public function dismissWidget(string $widgetName): bool
+    {
+        Piwik::checkUserIsNotAnonymous();
+
+        if (!DismissibleWidget::exists($widgetName)) {
+            throw new \Exception('Can\'t dismiss unknown widget ' . $widgetName);
+        }
+
+        $this->promoWidgetDismissal->dismissPromoWidget($widgetName);
+
+        return true;
+    }
+}

plugins/ProfessionalServices/ProfessionalServices.php

@@ -34,6 +34,7 @@ public function registerEvents()
             'Template.afterVisitorProfileOverview' => 'getSessionRecordingPromo',
             'Template.afterPagePerformanceReport' => 'getSeoWebVitalsPromo',
             'Template.afterSearchEngines' => 'getSeoWebVitalsPromo',
+            'Translate.getClientSideTranslationKeys' => 'getClientSideTranslationKeys',
         );
     }
 
@@ -43,6 +44,19 @@ public function getStylesheetFiles(&$stylesheets)
         $stylesheets[] = 'plugins/ProfessionalServices/stylesheets/widget.less';
     }
 
+    public function getClientSideTranslationKeys(&$translationKeys)
+    {
+        $translationKeys[] = 'ProfessionalServices_DismissedNotification';
+        $translationKeys[] = 'ProfessionalServices_PromoFunnels';
+        $translationKeys[] = 'ProfessionalServices_PromoFormAnalytics';
+        $translationKeys[] = 'ProfessionalServices_PromoMediaAnalytics';
+        $translationKeys[] = 'ProfessionalServices_PromoAbTesting';
+        $translationKeys[] = 'ProfessionalServices_PromoHeatmaps';
+        $translationKeys[] = 'ProfessionalServices_PromoSessionRecording';
+        $translationKeys[] = 'ProfessionalServices_PromoCustomReports';
+        $translationKeys[] = 'ProfessionalServices_PromoCrashAnalytics';
+    }
+
     public function isRequestForDashboardWidget()
     {
         $isWidget = Common::getRequestVar('widget', 0, 'int');
@@ -157,5 +171,4 @@ public function getSeoWebVitalsPromo(&$out)
             $out .= $view->render();
         }
     }
-
 }

plugins/ProfessionalServices/PromoWidgetApplicable.php

@@ -24,13 +24,19 @@ class PromoWidgetApplicable
      */
     private $config;
 
-    public function __construct(Manager $manager, Config $config)
+    /**
+     * @var PromoWidgetDismissal
+     */
+    private $promoWidgetDismissal;
+
+    public function __construct(Manager $manager, Config $config, PromoWidgetDismissal $promoWidgetDismissal)
     {
         $this->manager = $manager;
         $this->config = $config;
+        $this->promoWidgetDismissal = $promoWidgetDismissal;
     }
 
-    public function check(string $pluginName): bool
+    public function check(string $pluginName, string $widgetName): bool
     {
         if (Advertising::isAdsEnabledInConfig($this->config->General) === false) {
             return false;
@@ -44,6 +50,10 @@ public function check(string $pluginName): bool
             return false;
         }
 
+        if ($this->promoWidgetDismissal->isPromoWidgetDismissedForCurrentUser($widgetName)) {
+            return false;
+        }
+
         return $this->manager->isPluginActivated($pluginName) === false;
     }
 }

plugins/ProfessionalServices/PromoWidgetDismissal.php

@@ -0,0 +1,44 @@
+<?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\ProfessionalServices;
+
+use Piwik\Option;
+use Piwik\Piwik;
+
+class PromoWidgetDismissal
+{
+    private const DISMISSED_WIDGET_OPTION_NAME = 'ProfessionalServices.DismissedWidget.%s.%s';
+
+    public function dismissPromoWidget(string $widgetName): void
+    {
+        Option::set($this->getDismissedWidgetOptionName($widgetName), time());
+    }
+
+    public function isPromoWidgetDismissedForCurrentUser(string $widgetName): bool
+    {
+        $isAnonUser = Piwik::isUserIsAnonymous();
+
+        if ($isAnonUser) {
+            return false;
+        }
+
+        return $this->isPromoWidgetDismissed($widgetName);
+    }
+
+    private function isPromoWidgetDismissed(string $widgetName): bool
+    {
+        return Option::get($this->getDismissedWidgetOptionName($widgetName)) > 0;
+    }
+
+    private function getDismissedWidgetOptionName(string $widgetName): string
+    {
+        return sprintf(self::DISMISSED_WIDGET_OPTION_NAME, $widgetName, Piwik::getCurrentUserLogin());
+    }
+}

plugins/ProfessionalServices/Widgets/DismissibleWidget.php

@@ -0,0 +1,24 @@
+<?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\ProfessionalServices\Widgets;
+
+use Piwik\Widget\Widget;
+
+abstract class DismissibleWidget extends Widget
+{
+    public static function getDismissibleWidgetName(): string
+    {
+        return substr(strrchr(static::class, "\\"), 1);
+    }
+
+    public static function exists(string $widgetName): bool
+    {
+        return class_exists(substr(__CLASS__, 0, strrpos(__CLASS__, "\\")) . "\\" . $widgetName);
+    }
+}

plugins/ProfessionalServices/Widgets/PromoAbTesting.php

@@ -11,22 +11,22 @@
 use Piwik\Container\StaticContainer;
 use Piwik\Piwik;
 use Piwik\View;
-use Piwik\Widget\Widget;
 use Piwik\Widget\WidgetConfig;
 
-class PromoAbTesting extends Widget
+class PromoAbTesting extends DismissibleWidget
 {
     private const PROMO_PLUGIN_NAME = 'AbTesting';
 
     public static function configure(WidgetConfig $config)
     {
+        parent::configure($config);
         $config->setCategoryId('ProfessionalServices_PromoAbTesting');
         $config->setSubcategoryId('ProfessionalServices_PromoOverview');
         $config->setIsNotWidgetizable();
 
         $promoWidgetApplicable = StaticContainer::get('Piwik\Plugins\ProfessionalServices\PromoWidgetApplicable');
 
-        $isEnabled = $promoWidgetApplicable->check(self::PROMO_PLUGIN_NAME);
+        $isEnabled = $promoWidgetApplicable->check(self::PROMO_PLUGIN_NAME, self::getDismissibleWidgetName());
         $config->setIsEnabled($isEnabled);
     }
 
@@ -37,6 +37,8 @@ public function render()
 
         $view = new View('@ProfessionalServices/pluginAdvertising');
         $view->plugin = $pluginInfo;
+        $view->widgetName = self::getDismissibleWidgetName();
+        $view->userCanDismiss = Piwik::isUserIsAnonymous() === false;
 
         $view->title  = Piwik::translate('ProfessionalServices_PromoUnlockPowerOf', $pluginInfo['displayName']);
         $view->listOfFeatures = [

plugins/ProfessionalServices/Widgets/PromoCrashAnalytics.php

@@ -11,10 +11,9 @@
 use Piwik\Container\StaticContainer;
 use Piwik\Piwik;
 use Piwik\View;
-use Piwik\Widget\Widget;
 use Piwik\Widget\WidgetConfig;
 
-class PromoCrashAnalytics extends Widget
+class PromoCrashAnalytics extends DismissibleWidget
 {
     private const PROMO_PLUGIN_NAME = 'CrashAnalytics';
 
@@ -26,7 +25,7 @@ public static function configure(WidgetConfig $config)
 
         $promoWidgetApplicable = StaticContainer::get('Piwik\Plugins\ProfessionalServices\PromoWidgetApplicable');
 
-        $isEnabled = $promoWidgetApplicable->check(self::PROMO_PLUGIN_NAME);
+        $isEnabled = $promoWidgetApplicable->check(self::PROMO_PLUGIN_NAME, self::getDismissibleWidgetName());
         $config->setIsEnabled($isEnabled);
     }
 
@@ -37,6 +36,8 @@ public function render()
 
         $view = new View('@ProfessionalServices/pluginAdvertising');
         $view->plugin = $pluginInfo;
+        $view->widgetName = self::getDismissibleWidgetName();
+        $view->userCanDismiss = Piwik::isUserIsAnonymous() === false;
 
         $view->title  = Piwik::translate('ProfessionalServices_PromoUnlockPowerOf', $pluginInfo['displayName']);
         $view->listOfFeatures = [

plugins/ProfessionalServices/Widgets/PromoCustomReports.php

@@ -11,10 +11,9 @@
 use Piwik\Container\StaticContainer;
 use Piwik\Piwik;
 use Piwik\View;
-use Piwik\Widget\Widget;
 use Piwik\Widget\WidgetConfig;
 
-class PromoCustomReports extends Widget
+class PromoCustomReports extends DismissibleWidget
 {
     private const PROMO_PLUGIN_NAME = 'CustomReports';
 
@@ -26,7 +25,7 @@ public static function configure(WidgetConfig $config)
 
         $promoWidgetApplicable = StaticContainer::get('Piwik\Plugins\ProfessionalServices\PromoWidgetApplicable');
 
-        $isEnabled = $promoWidgetApplicable->check(self::PROMO_PLUGIN_NAME);
+        $isEnabled = $promoWidgetApplicable->check(self::PROMO_PLUGIN_NAME, self::getDismissibleWidgetName());
         $config->setIsEnabled($isEnabled);
     }
 
@@ -37,6 +36,8 @@ public function render()
 
         $view = new View('@ProfessionalServices/pluginAdvertising');
         $view->plugin = $pluginInfo;
+        $view->widgetName = self::getDismissibleWidgetName();
+        $view->userCanDismiss = Piwik::isUserIsAnonymous() === false;
 
         $view->title  = Piwik::translate('ProfessionalServices_PromoUnlockPowerOf', $pluginInfo['displayName']);
         $view->listOfFeatures = [

plugins/ProfessionalServices/Widgets/PromoFormAnalytics.php

@@ -11,10 +11,9 @@
 use Piwik\Container\StaticContainer;
 use Piwik\Piwik;
 use Piwik\View;
-use Piwik\Widget\Widget;
 use Piwik\Widget\WidgetConfig;
 
-class PromoFormAnalytics extends Widget
+class PromoFormAnalytics extends DismissibleWidget
 {
     private const PROMO_PLUGIN_NAME = 'FormAnalytics';
 
@@ -26,7 +25,7 @@ public static function configure(WidgetConfig $config)
 
         $promoWidgetApplicable = StaticContainer::get('Piwik\Plugins\ProfessionalServices\PromoWidgetApplicable');
 
-        $isEnabled = $promoWidgetApplicable->check(self::PROMO_PLUGIN_NAME);
+        $isEnabled = $promoWidgetApplicable->check(self::PROMO_PLUGIN_NAME, self::getDismissibleWidgetName());
         $config->setIsEnabled($isEnabled);
     }
 
@@ -37,6 +36,8 @@ public function render()
 
         $view = new View('@ProfessionalServices/pluginAdvertising');
         $view->plugin = $pluginInfo;
+        $view->widgetName = self::getDismissibleWidgetName();
+        $view->userCanDismiss = Piwik::isUserIsAnonymous() === false;
 
         $view->title  = Piwik::translate('ProfessionalServices_PromoUnlockPowerOf', $pluginInfo['displayName']);
         $view->listOfFeatures = [

plugins/ProfessionalServices/Widgets/PromoFunnels.php

@@ -11,10 +11,9 @@
 use Piwik\Container\StaticContainer;
 use Piwik\Piwik;
 use Piwik\View;
-use Piwik\Widget\Widget;
 use Piwik\Widget\WidgetConfig;
 
-class PromoFunnels extends Widget
+class PromoFunnels extends DismissibleWidget
 {
     private const PROMO_PLUGIN_NAME = 'Funnels';
 
@@ -26,7 +25,7 @@ public static function configure(WidgetConfig $config)
 
         $promoWidgetApplicable = StaticContainer::get('Piwik\Plugins\ProfessionalServices\PromoWidgetApplicable');
 
-        $isEnabled = $promoWidgetApplicable->check(self::PROMO_PLUGIN_NAME);
+        $isEnabled = $promoWidgetApplicable->check(self::PROMO_PLUGIN_NAME, self::getDismissibleWidgetName());
         $config->setIsEnabled($isEnabled);
     }
 
@@ -37,6 +36,8 @@ public function render()
 
         $view = new View('@ProfessionalServices/pluginAdvertising');
         $view->plugin = $pluginInfo;
+        $view->widgetName = self::getDismissibleWidgetName();
+        $view->userCanDismiss = Piwik::isUserIsAnonymous() === false;
 
         $view->title  = Piwik::translate('ProfessionalServices_PromoUnlockPowerOf', $pluginInfo['displayName']);
         $view->listOfFeatures = [

plugins/ProfessionalServices/Widgets/PromoHeatmaps.php

@@ -11,10 +11,9 @@
 use Piwik\Container\StaticContainer;
 use Piwik\Piwik;
 use Piwik\View;
-use Piwik\Widget\Widget;
 use Piwik\Widget\WidgetConfig;
 
-class PromoHeatmaps extends Widget
+class PromoHeatmaps extends DismissibleWidget
 {
     private const PROMO_PLUGIN_NAME = 'HeatmapSessionRecording';
 
@@ -26,7 +25,7 @@ public static function configure(WidgetConfig $config)
 
         $promoWidgetApplicable = StaticContainer::get('Piwik\Plugins\ProfessionalServices\PromoWidgetApplicable');
 
-        $isEnabled = $promoWidgetApplicable->check(self::PROMO_PLUGIN_NAME);
+        $isEnabled = $promoWidgetApplicable->check(self::PROMO_PLUGIN_NAME, self::getDismissibleWidgetName());
         $config->setIsEnabled($isEnabled);
     }
 
@@ -37,6 +36,8 @@ public function render()
 
         $view = new View('@ProfessionalServices/pluginAdvertising');
         $view->plugin = $pluginInfo;
+        $view->widgetName = self::getDismissibleWidgetName();
+        $view->userCanDismiss = Piwik::isUserIsAnonymous() === false;
 
         $view->title  = Piwik::translate('ProfessionalServices_PromoUnlockPowerOf', 'Heatmaps');
         $view->imageName = 'ad-heatmaps.png';