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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik;
use Piwik\Container\StaticContainer;
use Piwik\Email\ContentGenerator;
use Piwik\Plugins\CoreAdminHome\CustomLogo;
use Piwik\Translation\Translator;
use Piwik\View\HtmlReportEmailHeaderView;
use Zend_Mail;
/**
* Class for sending mails, for more information see:
* {@link http://framework.zend.com/manual/en/zend.mail.html}
*
* @see Zend_Mail, libs/Zend/Mail.php
* @api
*/
class Mail extends Zend_Mail
{
/**
* Constructor.
*
* @param string $charset charset, defaults to utf-8
*/
public function __construct($charset = 'utf-8')
{
parent::__construct($charset);
$this->initSmtpTransport();
}
public function setDefaultFromPiwik()
{
$customLogo = new CustomLogo();
/** @var Translator $translator */
$translator = StaticContainer::get('Piwik\Translation\Translator');
$fromEmailName = Config::getInstance()->General['noreply_email_name'];
if (empty($fromEmailName) && $customLogo->isEnabled()) {
$fromEmailName = $translator->translate('CoreHome_WebAnalyticsReports');
} elseif (empty($fromEmailName)) {
$fromEmailName = $translator->translate('TagManager_MatomoTagName');
}
$fromEmailAddress = Config::getInstance()->General['noreply_email_address'];
$this->setFrom($fromEmailAddress, $fromEmailName);
}
/**
* @param View|string $body
* @throws \DI\NotFoundException
*/
public function setWrappedHtmlBody($body)
{
$contentGenerator = StaticContainer::get(ContentGenerator::class);
$bodyHtml = $contentGenerator->generateHtmlContent($body);
$this->setBodyHtml($bodyHtml);
}
/**
* Sets the sender.
*
* @param string $email Email address of the sender.
* @param null|string $name Name of the sender.
* @return Zend_Mail
*/
public function setFrom($email, $name = null)
{
return parent::setFrom(
$this->parseDomainPlaceholderAsPiwikHostName($email),
$name
);
}
/**
* Set Reply-To Header
*
* @param string $email
* @param null|string $name
* @return Zend_Mail
*/
public function setReplyTo($email, $name = null)
{
return parent::setReplyTo(
$this->parseDomainPlaceholderAsPiwikHostName($email),
$name
);
}
/**
* @return void
*/
private function initSmtpTransport()
{
$tr = StaticContainer::get('Zend_Mail_Transport_Abstract');
if (empty($tr)) {
return;
}
Mail::setDefaultTransport($tr);
}
public function send($transport = null)
{
if (!$this->shouldSendMail()) {
return $this;
}
$mail = $this;
/**
* This event is posted right before an email is sent. You can use it to customize the email by, for example, replacing
* the subject/body, changing the from address, etc.
*
* @param Mail $this The Mail instance that is about to be sent.
*/
Piwik::postEvent('Mail.send', [$mail]);
if (defined('PIWIK_TEST_MODE')) { // hack
/**
* @ignore
* @deprecated
*/
Piwik::postTestEvent("Test.Mail.send", array($this));
} else {
return parent::send($transport);
}
}
public function createAttachment($body, $mimeType = null, $disposition = null, $encoding = null, $filename = null)
{
$filename = $this->sanitiseString($filename);
return parent::createAttachment($body, $mimeType, $disposition, $encoding, $filename);
}
public function setSubject($subject)
{
$subject = $this->sanitiseString($subject);
return parent::setSubject($subject);
}
public function getMailHost()
{
$hostname = Config::getInstance()->mail['defaultHostnameIfEmpty'];
$piwikHost = Url::getCurrentHost($hostname);
// If known Piwik URL, use it instead of "localhost"
$piwikUrl = SettingsPiwik::getPiwikUrl();
$url = parse_url($piwikUrl);
if ($this->isHostDefinedAndNotLocal($url)) {
$piwikHost = $url['host'];
}
return $piwikHost;
}
/**
* @param string $email
* @return string
*/
protected function parseDomainPlaceholderAsPiwikHostName($email)
{
$piwikHost = $this->getMailHost();
return str_replace('{DOMAIN}', $piwikHost, $email);
}
/**
* @param array $url
* @return bool
*/
protected function isHostDefinedAndNotLocal($url)
{
return isset($url['host']) && !Url::isLocalHost($url['host']);
}
/**
* Replaces characters known to appear incorrectly in some email clients
*
* @param $string
* @return mixed
*/
function sanitiseString($string)
{
$search = array('–', '’');
$replace = array('-', '\'');
$string = str_replace($search, $replace, $string);
return $string;
}
private function shouldSendMail()
{
$config = Config::getInstance();
$general = $config->General;
if (empty($general['emails_enabled'])) {
return false;
}
$shouldSendMail = true;
$mail = $this;
/**
* This event is posted before sending an email. You can use it to abort sending a specific email, if you want.
*
* @param bool &$shouldSendMail Whether to send this email or not. Set to false to skip sending.
* @param Mail $mail The Mail instance that will be sent.
*/
Piwik::postEvent('Mail.shouldSend', [&$shouldSendMail, $mail]);
return $shouldSendMail;
}
}
|
