JezK

Edit File: UpdateCommunication.php

<?php

/**
 * Matomo - free/libre analytics platform
 *
 * @link    https://matomo.org
 * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */
namespace Piwik\Plugins\Marketplace;

use Piwik\Config;
use Piwik\Container\StaticContainer;
use Piwik\Mail;
use Piwik\Option;
use Piwik\Piwik;
use Piwik\Plugins\CoreUpdater\SystemSettings;
use Piwik\Plugins\UsersManager\API as UsersManagerApi;
use Piwik\SettingsPiwik;
use Piwik\View;
/**
 * Class to check and notify users via email if there are plugin updates available.
 */
class UpdateCommunication
{
    /**
     * @var SystemSettings
     */
    private $updaterSettings;
    public function __construct(SystemSettings $settings)
    {
        $this->updaterSettings = $settings;
    }
    /**
     * Checks whether plugin update notification is enabled or not. If the marketplace is disabled or if update
     * communication is disabled in general, it will return false as well.
     *
     * @return bool
     */
    public function isEnabled()
    {
        if (!self::canBeEnabled()) {
            return \false;
        }
        return $this->updaterSettings->sendPluginUpdateEmail->getValue();
    }
    /**
     * Checks whether a plugin update notification can be enabled or not. It cannot be enabled if for instance the
     * Marketplace is disabled or if update notifications are disabled in general.
     *
     * @return bool
     */
    public static function canBeEnabled()
    {
        $isEnabled = (bool) Config::getInstance()->General['enable_update_communication'];
        if ($isEnabled === \true && \Piwik\Plugins\Marketplace\Marketplace::isMarketplaceEnabled() === \true && SettingsPiwik::isInternetEnabled() === \true) {
            return \true;
        }
        return \false;
    }
    /**
     * Sends an email to all super users if there is an update available for any plugins from the Marketplace.
     * For each update we send an email only once.
     */
    public function sendNotificationIfUpdatesAvailable()
    {
        $pluginsHavingUpdate = $this->getPluginsHavingUpdate();
        if (empty($pluginsHavingUpdate)) {
            return;
        }
        $pluginsToBeNotified = array();
        foreach ($pluginsHavingUpdate as $plugin) {
            if ($this->hasNotificationAlreadyReceived($plugin)) {
                continue;
            }
            $this->setHasLatestUpdateNotificationReceived($plugin);
            $pluginsToBeNotified[] = $plugin;
        }
        if (!empty($pluginsToBeNotified)) {
            $this->sendNotifications($pluginsToBeNotified);
        }
    }
    protected function sendNotifications($pluginsToBeNotified)
    {
        $hasThemeUpdate = \false;
        $hasPluginUpdate = \false;
        foreach ($pluginsToBeNotified as $plugin) {
            $hasThemeUpdate = $hasThemeUpdate || $plugin['isTheme'];
            $hasPluginUpdate = $hasPluginUpdate || !$plugin['isTheme'];
        }
        $subject = Piwik::translate('CoreUpdater_NotificationSubjectAvailablePluginUpdate');
        $message = $this->buildNotificationMessage($pluginsToBeNotified, $hasThemeUpdate, $hasPluginUpdate);
        $this->sendEmailNotification($subject, $message);
    }
    /**
     * Send an email notification to all super users.
     *
     * @param $subject
     * @param $message
     */
    protected function sendEmailNotification($subject, $message)
    {
        $superUsers = UsersManagerApi::getInstance()->getUsersHavingSuperUserAccess();
        foreach ($superUsers as $superUser) {
            $mail = new Mail();
            $mail->setDefaultFromPiwik();
            $mail->addTo($superUser['email']);
            $mail->setSubject($subject);
            $mail->setWrappedHtmlBody($message);
            $mail->send();
        }
    }
    protected function setHasLatestUpdateNotificationReceived($plugin)
    {
        $latestVersion = $this->getLatestVersion($plugin);
        Option::set($this->getNotificationSentOptionName($plugin), $latestVersion);
    }
    protected function getLatestVersionSent($plugin)
    {
        return Option::get($this->getNotificationSentOptionName($plugin));
    }
    protected function getLatestVersion($plugin)
    {
        return $plugin['latestVersion'];
    }
    protected function hasNotificationAlreadyReceived($plugin)
    {
        $latestVersion = $this->getLatestVersion($plugin);
        $lastVersionSent = $this->getLatestVersionSent($plugin);
        if (!empty($lastVersionSent) && ($latestVersion == $lastVersionSent || version_compare($latestVersion, $lastVersionSent) == -1)) {
            return \true;
        }
        return \false;
    }
    protected function getNotificationSentOptionName($plugin)
    {
        return 'last_update_communication_sent_plugin_' . $plugin['name'];
    }
    protected function getPluginsHavingUpdate()
    {
        $marketplace = StaticContainer::get('Piwik\\Plugins\\Marketplace\\Plugins');
        $pluginsHavingUpdate = $marketplace->getPluginsHavingUpdate();
        return $pluginsHavingUpdate;
    }
    protected function buildNotificationMessage($pluginsToBeNotified, $hasThemeUpdate, $hasPluginUpdate)
    {
        $view = new View('@Marketplace/_updateCommunicationEmail.twig');
        $view->pluginsToBeNotified = $pluginsToBeNotified;
        $view->host = SettingsPiwik::getPiwikUrl();
        $view->hasThemeUpdate = $hasThemeUpdate;
        $view->hasPluginUpdate = $hasPluginUpdate;
        return $view;
    }
}