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
|
<?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\CoreUpdater;
use Piwik\Config;
use Piwik\Mail;
use Piwik\Option;
use Piwik\Piwik;
use Piwik\Plugins\UsersManager\API as UsersManagerApi;
use Piwik\SettingsPiwik;
use Piwik\UpdateCheck;
use Piwik\Url;
use Piwik\Version;
use Piwik\View;
/**
* Class to check and notify users via email if there is a core update available.
*/
class UpdateCommunication
{
/**
* Checks whether update communication in general is enabled or not.
*
* @return bool
*/
public function isEnabled(): bool
{
$isEnabled = (bool) Config::getInstance()->General['enable_update_communication'];
if ($isEnabled === true && SettingsPiwik::isInternetEnabled() === true) {
return true;
}
return false;
}
/**
* Sends a notification email to all super users if there is a core update available but only if we haven't notfied
* them about a specific new version yet.
*/
public function sendNotificationIfUpdateAvailable(): void
{
if (!$this->isNewVersionAvailable()) {
return;
}
if ($this->hasNotificationAlreadyReceived()) {
return;
}
$this->setHasLatestUpdateNotificationReceived();
$this->sendNotifications();
}
protected function sendNotifications()
{
$latestVersion = $this->getLatestVersion();
$host = SettingsPiwik::getPiwikUrl();
$subject = Piwik::translate('CoreUpdater_NotificationSubjectAvailableCoreUpdate', $latestVersion);
$view = new View('@CoreUpdater/_updateCommunicationEmail.twig');
$view->latestVersion = $latestVersion;
$view->host = $host;
$version = new Version();
$view->isStableVersion = $version->isStableVersion($latestVersion);
$view->linkToChangeLog = $this->getLinkToChangeLog($latestVersion);
$this->sendEmailNotification($subject, $view);
}
private function getLinkToChangeLog($version)
{
$version = str_replace('.', '-', $version);
$link = Url::addCampaignParametersToMatomoLink(sprintf('https://matomo.org/changelog/matomo-%s/', $version));
return $link;
}
/**
* 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 isNewVersionAvailable()
{
UpdateCheck::check();
$hasUpdate = UpdateCheck::isNewestVersionAvailable();
if (!$hasUpdate) {
return false;
}
$latestVersion = self::getLatestVersion();
$version = new Version();
if (!$version->isVersionNumber($latestVersion)) {
return false;
}
return $hasUpdate;
}
protected function hasNotificationAlreadyReceived()
{
$latestVersion = $this->getLatestVersion();
$lastVersionSent = $this->getLatestVersionSent();
if (
!empty($lastVersionSent)
&& ($latestVersion == $lastVersionSent
|| version_compare($latestVersion, $lastVersionSent) == -1)
) {
return true;
}
return false;
}
private function getLatestVersion()
{
$version = UpdateCheck::getLatestVersion();
if (!empty($version)) {
$version = trim($version);
}
return $version;
}
private function getLatestVersionSent()
{
return Option::get($this->getNotificationSentOptionName());
}
private function setHasLatestUpdateNotificationReceived()
{
$latestVersion = $this->getLatestVersion();
Option::set($this->getNotificationSentOptionName(), $latestVersion);
}
private function getNotificationSentOptionName()
{
return 'last_update_communication_sent_core';
}
}
|
