Add code to check plugin license status and download link

plugins/Marketplace/Consumer.php

@@ -22,6 +22,11 @@ class Consumer
     private $consumer = false;
     private $isValid = null;
 
+    /**
+     * @var array
+     */
+    private $pluginLicenseStatus = null;
+
     public function __construct(Api\Client $marketplaceClient)
     {
         $this->marketplaceClient = $marketplaceClient;
@@ -65,4 +70,18 @@ public function isValidConsumer()
 
         return $this->isValid;
     }
+
+    public function getConsumerPluginLicenseStatus(): array
+    {
+        if (!$this->pluginLicenseStatus) {
+            $consumer = $this->getConsumer();
+            if (!empty($consumer['licenses'])) {
+                foreach ($consumer['licenses'] as $license) {
+                    $this->pluginLicenseStatus[$license['plugin']['name']] = ['licenseStatus' => $license['status']];
+                }
+            }
+        }
+
+        return $this->pluginLicenseStatus ?? [];
+    }
 }

plugins/Marketplace/Controller.php

@@ -472,16 +472,31 @@ private function createUpdateOrInstallView($template, $nonceName)
 
         $pluginInfos = [];
         foreach ($plugins as $pluginName) {
-            $pluginInfos[] = $this->plugins->getPluginInfo($pluginName);
+            $currentPluginInfo = $this->plugins->getPluginInfo($pluginName);
+            $pluginInfos[] = $currentPluginInfo;
 
             try {
                 $this->pluginInstaller->installOrUpdatePluginFromMarketplace($pluginName);
             } catch (\Exception $e) {
-                $notification = new Notification($e->getMessage());
+                $message = $e->getMessage();
+                $isRaw = false;
+                if (stripos($message, 'PCLZIP_ERR_BAD_FORMAT') !== false) {
+                    $faqLink = Url::addCampaignParametersToMatomoLink('https://matomo.org/faq/plugins/faq_21/');
+                    if (!empty($currentPluginInfo['isPaid'])) {
+                        $downloadLink = Url::addCampaignParametersToMatomoLink('https://shop.matomo.org/my-account/downloads');
+                        $translateKey = 'Marketplace_PluginDownloadLinkMissing';
+                    } else {
+                        $downloadLink = Url::addCampaignParametersToMatomoLink('https://plugins.matomo.org/' . $pluginName);
+                        $translateKey = 'Marketplace_PluginDownloadLinkMissingFree';
+                    }
+                    $message = Piwik::translate($translateKey, [$pluginName, "<a href='$downloadLink' target='_blank' rel='noreferrer noopener'>", '</a>', "<a href='$faqLink' target='_blank' rel='noreferrer noopener'>", '</a>']);
+                    $isRaw = true;
+                }
+                $notification = new Notification($message);
                 $notification->context = Notification::CONTEXT_ERROR;
                 $notification->type = Notification::TYPE_PERSISTENT;
                 $notification->flags = Notification::FLAG_CLEAR;
-                if (method_exists($e, 'isHtmlMessage') && $e->isHtmlMessage()) {
+                if ((method_exists($e, 'isHtmlMessage') && $e->isHtmlMessage()) || $isRaw) {
                     $notification->raw = true;
                 }
                 Notification\Manager::notify('CorePluginsAdmin_InstallPlugin', $notification);
@@ -538,7 +553,7 @@ private function canPluginBeInstalled($plugin)
             || $this->pluginManager->isPluginLoaded($pluginName)
             || $this->pluginManager->isPluginActivated($pluginName);
 
-        return !$isAlreadyInstalled;
+        return !$isAlreadyInstalled && $plugin['hasDownloadLink'];
     }
 
     protected function configureViewAndCheckPermission($template)

plugins/Marketplace/Marketplace.php

@@ -186,6 +186,11 @@ public function getClientSideTranslationKeys(&$translationKeys)
         $translationKeys[] = 'CorePluginsAdmin_Activity';
         $translationKeys[] = 'CorePluginsAdmin_Version';
         $translationKeys[] = 'CorePluginsAdmin_Websites';
+        $translationKeys[] = 'Marketplace_PluginLicenseStatusPending';
+        $translationKeys[] = 'Marketplace_PluginLicenseStatusCancelled';
+        $translationKeys[] = 'Marketplace_PluginDownloadLinkMissing';
+        $translationKeys[] = 'Marketplace_PluginDownloadLinkMissingFree';
+        $translationKeys[] = 'Marketplace_PluginDownloadLinkMissingDescription';
     }
 
     /**

plugins/Marketplace/Plugins.php

@@ -296,7 +296,15 @@ private function enrichPluginInformation($plugin)
             }
         }
 
+        $haDownloadLink = false;
+        if (!empty($plugin['versions'])) {
+            $latestVersion = array_pop($plugin['versions']);
+            $hasDownloadLink = !empty($latestVersion['download']);
+        }
+        $plugin['hasDownloadLink'] = $hasDownloadLink;
+
         $plugin = $this->addMissingRequirements($plugin);
+        $plugin = $this->addConsumerLicenseStatus($plugin);
 
         $plugin['isEligibleForFreeTrial'] =
             $plugin['canBePurchased']
@@ -444,4 +452,12 @@ private function prettifyNumberOfDownloads(&$plugin): void
 
         $plugin['numDownloadsPretty'] = $nice;
     }
+
+    private function addConsumerLicenseStatus($plugin): array
+    {
+        $consumerPluginLicenseInfo = $this->consumer->getConsumerPluginLicenseStatus();
+        $plugin['licenseStatus'] = $consumerPluginLicenseInfo[$plugin['name']] ?? '';
+
+        return $plugin;
+    }
 }

plugins/Marketplace/lang/en.json

@@ -147,6 +147,11 @@
         "AutoUpdateDisabledWarning": "You cannot install or update the plugin directly as automatic updates are disabled in the config. To enable automatic updates set %1$s in %2$s.",
         "ViewRepositoryChangelog": "View the changes",
         "Show": "Show",
-        "Sort": "Sort"
+        "Sort": "Sort",
+        "PluginLicenseStatusPending": "Your license key for %1$s is in pending state. To resolve this, please go to your %2$sMarketplace account%3$s and update your payment details.",
+        "PluginLicenseStatusCancelled": "Your license key for %1$s is cancelled. To continue using this plugin, go to your %2$sMarketplace%3$s account and start a new subscription for this plugin.",
+        "PluginDownloadLinkMissing": "The %1$s plugin could not be installed. Please check your license. If you have an active subscription for the %1$s plugin, try installing it manually using a zip file downloaded from your %2$sMarketplace account%3$s. %4$sLearn more%5$s.",
+        "PluginDownloadLinkMissingFree": "The %1$s plugin could not be installed, try installing it manually using a zip file from this %2$slink%3$s. %4$sLearn more%5$s.",
+        "PluginDownloadLinkMissingDescription": "Unable to fetch download link for %1$s plugin."
     }
 }

plugins/Marketplace/tests/Integration/Plugins/InvalidLicensesTest.php

@@ -114,7 +114,7 @@ public function testGetNamesOfExpiredPaidPluginsValidLicenses()
     {
         $expired = $this->buildWithValidLicense();
 
-        $expected = array('exceeded' => array(), 'expired' => array(), 'noLicense' => array());
+        $expected = array('exceeded' => array(), 'expired' => array(), 'noLicense' => array('PaidPlugin3'));
 
         $this->assertSame($expected, $expired->getPluginNamesOfInvalidLicenses());
     }
@@ -162,7 +162,7 @@ public function testGetNamesOfExpiredPaidPluginsShouldCacheAnyResult()
 
         $this->assertTrue($this->cache->contains($this->cacheKey));
 
-        $expected = array('exceeded' => array(), 'expired' => array(), 'noLicense' => array());
+        $expected = array('exceeded' => array(), 'expired' => array(), 'noLicense' => array('PaidPlugin3'));
 
         $this->assertSame($expected, $this->cache->fetch($this->cacheKey));
     }
@@ -214,7 +214,10 @@ public function testGetMessageExceededLicensesGetMessageExpiredLicensesValidLice
 
         $this->assertNull($expired->getMessageExceededLicenses());
         $this->assertNull($expired->getMessageExpiredLicenses());
-        $this->assertNull($expired->getMessageNoLicense());
+        $this->assertEquals(
+            'The following plugins have been deactivated because you are using them without a license: <strong>PaidPlugin3</strong>. <br/>To resolve this issue either update your license key, <strong><a href="https://shop.piwik.org/my-account" target="_blank" rel="noreferrer noopener">get a subscription now</a></strong> or deactivate the plugin. <br/><a href="?module=Marketplace&action=subscriptionOverview">View your plugin subscriptions.</a>',
+            $expired->getMessageNoLicense()
+        );
     }
 
     public function testGetMessageExceededLicensesGetMessageExpiredLicensesNoLicensesPaidPluginActivated()

plugins/Marketplace/tests/Integration/PluginsTest.php

@@ -311,6 +311,8 @@ public function testGetPluginInfoNotInstalledPluginShouldEnrichPluginInformation
             'isEligibleForFreeTrial' => false,
             'priceFrom' => null,
             'numDownloadsPretty' => 0,
+            'hasDownloadLink' => true,
+            'licenseStatus' => '',
             'category' => 'customisation',
         ];
         $this->assertEquals($expected, $plugin);

plugins/Marketplace/tests/UI/Marketplace_spec.js

@@ -138,6 +138,69 @@ describe("Marketplace", function () {
             await captureMarketplace('paid_plugins_with_license_' + mode);
         });
 
+        if (mode === 'superuser') {
+            it(mode + ' for a user with license key should be able to open install purchased plugins modal', async function () {
+                setEnvironment(mode, validLicense);
+
+                await page.goto('about:blank');
+                await page.goto(paidPluginsUrl);
+
+                const elem = await page.jQuery(
+                    '.installAllPaidPlugins button'
+                );
+
+                await elem.click();
+
+                // give it some time to fetch, animate, and render everything properly
+                await page.waitForNetworkIdle();
+                await page.waitForTimeout(500);
+
+                const selector = '.modal.open';
+                await page.screenshotSelector(selector);
+
+                expect(await page.screenshotSelector(selector)).to.matchImage('install_purchased_plugins_modal_' + mode);
+            });
+        }
+
+        it(mode + ' should open paid plugins modal for paid plugin 1', async function () {
+            setEnvironment(mode, validLicense);
+            await page.goto('about:blank');
+            await page.goto(paidPluginsUrl);
+            await loadPluginDetailPage('Paid Plugin 1', false);
+
+            await captureWithPluginDetails('paid_plugin1_plugin_details_' + mode);
+        });
+
+        it(mode + ' should open paid plugins modal for paid plugin 2', async function () {
+            setEnvironment(mode, validLicense);
+            await page.goto('about:blank');
+            await page.goto(paidPluginsUrl);
+            await loadPluginDetailPage('Paid Plugin 2', false);
+
+            await captureWithPluginDetails('paid_plugin2_plugin_details_' + mode);
+        });
+
+        it(mode + ' should open paid plugins modal for paid plugin 3', async function () {
+            setEnvironment(mode, validLicense);
+            await loadPluginDetailPage('Paid Plugin 3', false);
+
+            await captureWithPluginDetails('paid_plugin3_plugin_details_' + mode);
+        });
+
+        it(mode + ' should open paid plugins modal for paid plugin 4', async function () {
+            setEnvironment(mode, validLicense);
+            await loadPluginDetailPage('Paid Plugin 4', false);
+
+            await captureWithPluginDetails('paid_plugin4_plugin_details_' + mode);
+        });
+
+        it(mode + ' should open paid plugins modal for paid plugin 5', async function () {
+            setEnvironment(mode, validLicense);
+            await loadPluginDetailPage('Paid Plugin 5', false);
+
+            await captureWithPluginDetails('paid_plugin5_plugin_details_' + mode);
+        });
+
         it(mode + ' for a user with exceeded license key should be able to open paid plugins', async function() {
             setEnvironment(mode, exceededLicense);
             assumePaidPluginsActivated();