1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
<?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(): bool
{
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 && 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;
}
}
|
