348 lines
10 KiB
PHP
348 lines
10 KiB
PHP
<?php
|
|
/**
|
|
* Piwik - free/libre analytics platform
|
|
*
|
|
* @link http://piwik.org
|
|
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
|
*
|
|
*/
|
|
namespace Piwik\Plugins\Marketplace;
|
|
|
|
use Piwik\Date;
|
|
use Piwik\ProfessionalServices\Advertising;
|
|
use Piwik\Plugin\Dependency as PluginDependency;
|
|
use Piwik\Plugin;
|
|
use Piwik\Plugins\Marketplace\Input\PurchaseType;
|
|
use Piwik\Plugins\Marketplace\Input\Sort;
|
|
|
|
/**
|
|
*
|
|
*/
|
|
class Plugins
|
|
{
|
|
/**
|
|
* @var Api\Client
|
|
*/
|
|
private $marketplaceClient;
|
|
|
|
/**
|
|
* @var Consumer
|
|
*/
|
|
private $consumer;
|
|
|
|
/**
|
|
* @var Advertising
|
|
*/
|
|
private $advertising;
|
|
|
|
/**
|
|
* @var Plugin\Manager
|
|
*/
|
|
private $pluginManager;
|
|
|
|
/**
|
|
* @internal for tests only
|
|
* @var array
|
|
*/
|
|
private $activatedPluginNames = array();
|
|
|
|
private $pluginsHavingUpdateCache = null;
|
|
|
|
public function __construct(Api\Client $marketplaceClient, Consumer $consumer, Advertising $advertising)
|
|
{
|
|
$this->marketplaceClient = $marketplaceClient;
|
|
$this->consumer = $consumer;
|
|
$this->advertising = $advertising;
|
|
$this->pluginManager = Plugin\Manager::getInstance();
|
|
}
|
|
|
|
public function getPluginInfo($pluginName)
|
|
{
|
|
$plugin = $this->marketplaceClient->getPluginInfo($pluginName);
|
|
$plugin = $this->enrichPluginInformation($plugin);
|
|
|
|
return $plugin;
|
|
}
|
|
|
|
public function getLicenseValidInfo($pluginName)
|
|
{
|
|
$plugin = $this->marketplaceClient->getPluginInfo($pluginName);
|
|
$plugin = $this->enrichLicenseInformation($plugin);
|
|
|
|
return array(
|
|
'hasExceededLicense' => !empty($plugin['hasExceededLicense']),
|
|
'isMissingLicense' => !empty($plugin['isMissingLicense'])
|
|
);
|
|
}
|
|
|
|
public function getAvailablePluginNames($themesOnly)
|
|
{
|
|
if ($themesOnly) {
|
|
// we do not use getAllThemes() or getAllPlugins() since those methods would apply a whitelist
|
|
// github organization filter and here we actually want to get all plugin names.
|
|
$plugins = $this->marketplaceClient->searchForThemes('', '', Sort::DEFAULT_SORT, PurchaseType::TYPE_ALL);
|
|
} else {
|
|
$plugins = $this->marketplaceClient->searchForPlugins('', '', Sort::DEFAULT_SORT, PurchaseType::TYPE_ALL);
|
|
}
|
|
|
|
$names = array();
|
|
foreach ($plugins as $plugin) {
|
|
$names[] = $plugin['name'];
|
|
}
|
|
|
|
return $names;
|
|
}
|
|
|
|
public function getAllAvailablePluginNames()
|
|
{
|
|
return array_merge(
|
|
$this->getAvailablePluginNames(true),
|
|
$this->getAvailablePluginNames(false)
|
|
);
|
|
}
|
|
|
|
public function searchPlugins($query, $sort, $themesOnly, $purchaseType = '')
|
|
{
|
|
if ($themesOnly) {
|
|
$plugins = $this->marketplaceClient->searchForThemes('', $query, $sort, $purchaseType);
|
|
} else {
|
|
$plugins = $this->marketplaceClient->searchForPlugins('', $query, $sort, $purchaseType);
|
|
}
|
|
|
|
foreach ($plugins as $index => $plugin) {
|
|
$plugins[$index] = $this->enrichPluginInformation($plugin);
|
|
}
|
|
|
|
return array_values($plugins);
|
|
}
|
|
|
|
public function getAllPaidPlugins()
|
|
{
|
|
return $this->searchPlugins($query = '', Sort::DEFAULT_SORT, $themes = false, PurchaseType::TYPE_PAID);
|
|
}
|
|
|
|
public function getAllFreePlugins()
|
|
{
|
|
return $this->searchPlugins($query = '', Sort::DEFAULT_SORT, $themes = false, PurchaseType::TYPE_FREE);
|
|
}
|
|
|
|
public function getAllThemes()
|
|
{
|
|
return $this->searchPlugins($query = '', Sort::DEFAULT_SORT, $themes = true, PurchaseType::TYPE_ALL);
|
|
}
|
|
|
|
public function getAllPlugins()
|
|
{
|
|
return $this->searchPlugins($query = '', Sort::DEFAULT_SORT, $themes = false, PurchaseType::TYPE_ALL);
|
|
}
|
|
|
|
private function getPluginUpdateInformation($plugin)
|
|
{
|
|
if (empty($plugin['name'])) {
|
|
return;
|
|
}
|
|
|
|
if (!isset($this->pluginsHavingUpdateCache)) {
|
|
$this->pluginsHavingUpdateCache = $this->getPluginsHavingUpdate();
|
|
}
|
|
|
|
foreach ($this->pluginsHavingUpdateCache as $pluginHavingUpdate) {
|
|
if ($plugin['name'] == $pluginHavingUpdate['name']) {
|
|
return $pluginHavingUpdate;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* for tests only
|
|
* @internal
|
|
* @ignore
|
|
* @param $plugins
|
|
*/
|
|
public function setPluginsHavingUpdateCache($plugins)
|
|
{
|
|
$this->pluginsHavingUpdateCache = $plugins;
|
|
}
|
|
|
|
private function hasPluginUpdate($plugin)
|
|
{
|
|
$update = $this->getPluginUpdateInformation($plugin);
|
|
|
|
return !empty($update);
|
|
}
|
|
|
|
/**
|
|
* @param bool $themesOnly
|
|
* @return array
|
|
*/
|
|
public function getPluginsHavingUpdate()
|
|
{
|
|
$this->pluginManager->loadAllPluginsAndGetTheirInfo();
|
|
$loadedPlugins = $this->pluginManager->getLoadedPlugins();
|
|
|
|
try {
|
|
$pluginsHavingUpdate = $this->marketplaceClient->getInfoOfPluginsHavingUpdate($loadedPlugins);
|
|
} catch (\Exception $e) {
|
|
$pluginsHavingUpdate = array();
|
|
}
|
|
|
|
foreach ($pluginsHavingUpdate as $key => $updatePlugin) {
|
|
foreach ($loadedPlugins as $loadedPlugin) {
|
|
if (!empty($updatePlugin['name'])
|
|
&& $loadedPlugin->getPluginName() == $updatePlugin['name']
|
|
) {
|
|
$updatePlugin['currentVersion'] = $loadedPlugin->getVersion();
|
|
$updatePlugin['isActivated'] = $this->pluginManager->isPluginActivated($updatePlugin['name']);
|
|
$pluginsHavingUpdate[$key] = $this->addMissingRequirements($updatePlugin);
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
// remove plugins that have updates but for some reason are not loaded
|
|
foreach ($pluginsHavingUpdate as $key => $updatePlugin) {
|
|
if (empty($updatePlugin['currentVersion'])) {
|
|
unset($pluginsHavingUpdate[$key]);
|
|
}
|
|
}
|
|
|
|
return $pluginsHavingUpdate;
|
|
}
|
|
|
|
/**
|
|
* for tests only
|
|
* @param array $pluginNames
|
|
* @internal
|
|
* @ignore
|
|
*/
|
|
public function setActivatedPluginNames($pluginNames)
|
|
{
|
|
$this->activatedPluginNames = $pluginNames;
|
|
}
|
|
|
|
private function isPluginActivated($pluginName)
|
|
{
|
|
if (in_array($pluginName, $this->activatedPluginNames)) {
|
|
return true;
|
|
}
|
|
|
|
return $this->pluginManager->isPluginActivated($pluginName);
|
|
}
|
|
|
|
private function isPluginInstalled($pluginName)
|
|
{
|
|
if (in_array($pluginName, $this->activatedPluginNames)) {
|
|
return true;
|
|
}
|
|
|
|
return $this->pluginManager->isPluginInstalled($pluginName);
|
|
}
|
|
|
|
private function enrichPluginInformation($plugin)
|
|
{
|
|
if (empty($plugin)) {
|
|
return $plugin;
|
|
}
|
|
|
|
$plugin['isInstalled'] = $this->isPluginInstalled($plugin['name']);
|
|
$plugin['isActivated'] = $this->isPluginActivated($plugin['name']);
|
|
$plugin['isInvalid'] = $this->pluginManager->isPluginThirdPartyAndBogus($plugin['name']);
|
|
$plugin['canBeUpdated'] = $plugin['isInstalled'] && $this->hasPluginUpdate($plugin);
|
|
$plugin['lastUpdated'] = $this->toShortDate($plugin['lastUpdated']);
|
|
|
|
if ($plugin['isInstalled']) {
|
|
$plugin = $this->enrichLicenseInformation($plugin);
|
|
} else {
|
|
$plugin['hasExceededLicense'] = false;
|
|
$plugin['isMissingLicense'] = false;
|
|
}
|
|
|
|
if (!empty($plugin['owner'])
|
|
&& strtolower($plugin['owner']) === 'piwikpro'
|
|
&& !empty($plugin['homepage'])
|
|
&& strpos($plugin['homepage'], 'pk_campaign') === false) {
|
|
$plugin['homepage'] = $this->advertising->addPromoCampaignParametersToUrl($plugin['homepage'], Advertising::CAMPAIGN_NAME_PROFESSIONAL_SERVICES, 'Marketplace', $plugin['name']);
|
|
}
|
|
|
|
if ($plugin['canBeUpdated']) {
|
|
$pluginUpdate = $this->getPluginUpdateInformation($plugin);
|
|
$plugin['repositoryChangelogUrl'] = $pluginUpdate['repositoryChangelogUrl'];
|
|
$plugin['currentVersion'] = $pluginUpdate['currentVersion'];
|
|
}
|
|
|
|
if (!empty($plugin['activity']['lastCommitDate'])
|
|
&& false === strpos($plugin['activity']['lastCommitDate'], '0000')
|
|
&& false === strpos($plugin['activity']['lastCommitDate'], '1970')) {
|
|
$plugin['activity']['lastCommitDate'] = $this->toLongDate($plugin['activity']['lastCommitDate']);
|
|
} else {
|
|
$plugin['activity']['lastCommitDate'] = null;
|
|
}
|
|
|
|
if (!empty($plugin['versions'])) {
|
|
foreach ($plugin['versions'] as $index => $version) {
|
|
$plugin['versions'][$index]['release'] = $this->toLongDate($version['release']);
|
|
}
|
|
}
|
|
|
|
$plugin = $this->addMissingRequirements($plugin);
|
|
|
|
return $plugin;
|
|
}
|
|
|
|
private function enrichLicenseInformation($plugin)
|
|
{
|
|
if (empty($plugin)) {
|
|
return $plugin;
|
|
}
|
|
|
|
$isPremiumFeature = !empty($plugin['shop']) && empty($plugin['isFree']) && empty($plugin['isDownloadable']);
|
|
$plugin['hasExceededLicense'] = $isPremiumFeature && !empty($plugin['consumer']['license']['isValid']) && !empty($plugin['consumer']['license']['isExceeded']);
|
|
$plugin['isMissingLicense'] = $isPremiumFeature && (empty($plugin['consumer']['license']) || (!empty($plugin['consumer']['license']['status']) && $plugin['consumer']['license']['status'] === 'Cancelled'));
|
|
|
|
return $plugin;
|
|
}
|
|
|
|
private function toLongDate($date)
|
|
{
|
|
if (!empty($date)) {
|
|
$date = Date::factory($date)->getLocalized(Date::DATE_FORMAT_LONG);
|
|
}
|
|
|
|
return $date;
|
|
}
|
|
|
|
private function toShortDate($date)
|
|
{
|
|
if (!empty($date)) {
|
|
$date = Date::factory($date)->getLocalized(Date::DATE_FORMAT_SHORT);
|
|
}
|
|
|
|
return $date;
|
|
}
|
|
|
|
/**
|
|
* @param $plugin
|
|
*/
|
|
private function addMissingRequirements($plugin)
|
|
{
|
|
$plugin['missingRequirements'] = array();
|
|
|
|
if (empty($plugin['versions']) || !is_array($plugin['versions'])) {
|
|
return $plugin;
|
|
}
|
|
|
|
$latestVersion = $plugin['versions'][count($plugin['versions']) - 1];
|
|
|
|
if (empty($latestVersion['requires'])) {
|
|
return $plugin;
|
|
}
|
|
|
|
$requires = $latestVersion['requires'];
|
|
|
|
$dependency = new PluginDependency();
|
|
$plugin['missingRequirements'] = $dependency->getMissingDependencies($requires);
|
|
|
|
return $plugin;
|
|
}
|
|
}
|