2016-05-05 13:05:03 +00:00
|
|
|
<?php
|
|
|
|
|
|
2022-11-01 22:01:23 +00:00
|
|
|
namespace MediaWiki\Extension\Notifications\Formatters;
|
|
|
|
|
|
2023-12-11 15:33:08 +00:00
|
|
|
use MediaWiki\Html\Html;
|
2024-10-19 22:55:03 +00:00
|
|
|
use MediaWiki\Language\Language;
|
2023-12-11 15:33:08 +00:00
|
|
|
use MediaWiki\Parser\Sanitizer;
|
|
|
|
|
use MediaWiki\SpecialPage\SpecialPage;
|
|
|
|
|
use MediaWiki\User\User;
|
2022-11-01 22:01:23 +00:00
|
|
|
|
2016-05-05 13:05:03 +00:00
|
|
|
class EchoHtmlDigestEmailFormatter extends EchoEventDigestFormatter {
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @var string 'daily' or 'weekly'
|
|
|
|
|
*/
|
|
|
|
|
protected $digestMode;
|
|
|
|
|
|
|
|
|
|
public function __construct( User $user, Language $language, $digestMode ) {
|
|
|
|
|
parent::__construct( $user, $language );
|
|
|
|
|
$this->digestMode = $digestMode;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @param EchoEventPresentationModel[] $models
|
2018-08-13 07:25:22 +00:00
|
|
|
* @return string[] Array of the following format:
|
2016-05-05 13:05:03 +00:00
|
|
|
* [ 'body' => formatted email body,
|
|
|
|
|
* 'subject' => formatted email subject ]
|
|
|
|
|
*/
|
|
|
|
|
protected function formatModels( array $models ) {
|
|
|
|
|
// echo-email-batch-body-intro-daily
|
|
|
|
|
// echo-email-batch-body-intro-weekly
|
|
|
|
|
$intro = $this->msg( 'echo-email-batch-body-intro-' . $this->digestMode )
|
|
|
|
|
->params( $this->user->getName() )
|
|
|
|
|
->parse();
|
|
|
|
|
$intro = nl2br( $intro );
|
|
|
|
|
|
|
|
|
|
$eventsByCategory = $this->groupByCategory( $models );
|
|
|
|
|
ksort( $eventsByCategory );
|
|
|
|
|
$digestList = $this->renderDigestList( $eventsByCategory );
|
|
|
|
|
|
|
|
|
|
$htmlFormatter = new EchoHtmlEmailFormatter( $this->user, $this->language );
|
|
|
|
|
|
|
|
|
|
$body = $this->renderBody(
|
|
|
|
|
$this->language,
|
|
|
|
|
$intro,
|
|
|
|
|
$digestList,
|
|
|
|
|
$this->renderAction(),
|
|
|
|
|
$htmlFormatter->getFooter()
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
// echo-email-batch-subject-daily
|
|
|
|
|
// echo-email-batch-subject-weekly
|
|
|
|
|
$subject = $this->msg( 'echo-email-batch-subject-' . $this->digestMode )
|
|
|
|
|
->numParams( count( $models ), count( $models ) )
|
|
|
|
|
->text();
|
|
|
|
|
|
2016-12-05 18:51:07 +00:00
|
|
|
return [
|
2016-05-05 13:05:03 +00:00
|
|
|
'subject' => $subject,
|
|
|
|
|
'body' => $body,
|
2016-12-05 18:51:07 +00:00
|
|
|
];
|
2016-05-05 13:05:03 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private function renderBody( Language $language, $intro, $digestList, $action, $footer ) {
|
|
|
|
|
$alignStart = $language->alignStart();
|
2017-11-09 10:43:16 +00:00
|
|
|
$langCode = $language->getHtmlCode();
|
2016-05-05 13:05:03 +00:00
|
|
|
$langDir = $language->getDir();
|
|
|
|
|
|
2018-08-25 10:51:14 +00:00
|
|
|
// phpcs:disable Generic.Files.LineLength
|
2016-05-05 13:05:03 +00:00
|
|
|
return <<< EOF
|
|
|
|
|
<html><head>
|
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
2022-11-01 22:01:23 +00:00
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
2016-05-05 13:05:03 +00:00
|
|
|
<style>
|
|
|
|
|
@media only screen and (max-width: 480px){
|
|
|
|
|
table[id="email-container"]{max-width:600px !important; width:100% !important;}
|
|
|
|
|
}
|
|
|
|
|
</style>
|
|
|
|
|
</head><body>
|
|
|
|
|
<table cellspacing="0" cellpadding="0" border="0" width="100%" align="center" lang="$langCode" dir="$langDir">
|
|
|
|
|
<tr>
|
2016-11-25 19:24:12 +00:00
|
|
|
<td bgcolor="#EAECF0"><center>
|
2016-05-05 13:05:03 +00:00
|
|
|
<br /><br />
|
|
|
|
|
<table cellspacing="0" cellpadding="0" border="0" width="600" id="email-container">
|
|
|
|
|
<tr>
|
|
|
|
|
<td bgcolor="#FFFFFF" width="5%"> </td>
|
|
|
|
|
<td bgcolor="#FFFFFF" width="6%"> </td>
|
|
|
|
|
<td bgcolor="#FFFFFF" width="79%" style="line-height:40px;"> </td>
|
|
|
|
|
<td bgcolor="#FFFFFF" width="10%"> </td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td bgcolor="#FFFFFF" rowspan="2"> </td>
|
|
|
|
|
<td bgcolor="#FFFFFF" rowspan="2"> </td>
|
2016-11-25 19:24:12 +00:00
|
|
|
<td bgcolor="#FFFFFF" align="center" style="font-family: Arial, Helvetica, sans-serif; font-size:13px; line-height:20px; color:#72777D; text-align: center;">$intro</td>
|
2016-05-05 13:05:03 +00:00
|
|
|
<td bgcolor="#FFFFFF" rowspan="2"> </td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td bgcolor="#FFFFFF" align="$alignStart" style="font-family: Arial, Helvetica, sans-serif; line-height: 20px; font-weight: 600;">
|
|
|
|
|
<table cellspacing="0" cellpadding="0" border="0" width="100%">
|
|
|
|
|
<tr>
|
2016-11-25 19:24:12 +00:00
|
|
|
<td bgcolor="#FFFFFF" align="$alignStart" style="font-family: Arial, Helvetica, sans-serif; font-size:13px; color: #54595D; padding-top: 25px;">
|
2016-05-05 13:05:03 +00:00
|
|
|
$digestList
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
<br /><br />
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td bgcolor="#FFFFFF"> </td>
|
|
|
|
|
<td bgcolor="#FFFFFF"> </td>
|
|
|
|
|
<td bgcolor="#FFFFFF" style="line-height:60px;" align="center">$action</td>
|
|
|
|
|
<td bgcolor="#FFFFFF"> </td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td bgcolor="#FFFFFF"> </td>
|
|
|
|
|
<td bgcolor="#FFFFFF"> </td>
|
|
|
|
|
<td bgcolor="#FFFFFF" style="line-height:40px;"> </td>
|
|
|
|
|
<td bgcolor="#FFFFFF"> </td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td> </td>
|
|
|
|
|
<td> </td>
|
2016-11-25 19:24:12 +00:00
|
|
|
<td align="$alignStart" style="font-family: Arial, Helvetica, sans-serif; font-size:10px; line-height:13px; color:#72777D; padding: 10px 20px;"><br />
|
2016-05-05 13:05:03 +00:00
|
|
|
$footer
|
|
|
|
|
<br /><br />
|
|
|
|
|
</td>
|
|
|
|
|
<td> </td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td colspan="4"> </td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
<br><br></center>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
</body></html>
|
|
|
|
|
EOF;
|
2018-08-25 10:51:14 +00:00
|
|
|
// phpcs:enable Generic.Files.LineLength
|
2016-05-05 13:05:03 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @param string $type Notification type
|
|
|
|
|
* @param int $count Number of notifications in this type's section
|
|
|
|
|
* @return string Formatted category section title
|
|
|
|
|
*/
|
|
|
|
|
private function getCategoryTitle( $type, $count ) {
|
|
|
|
|
return $this->msg( "echo-category-title-$type" )
|
|
|
|
|
->numParams( $count )
|
|
|
|
|
->parse();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @param EchoEventPresentationModel[] $models
|
2024-03-15 08:27:36 +00:00
|
|
|
* @return array<string,EchoEventPresentationModel[]> [ 'category name' => EchoEventPresentationModel[] ]
|
2016-05-05 13:05:03 +00:00
|
|
|
*/
|
2024-03-15 08:27:36 +00:00
|
|
|
private function groupByCategory( array $models ): array {
|
2016-12-05 18:51:07 +00:00
|
|
|
$eventsByCategory = [];
|
2016-05-05 13:05:03 +00:00
|
|
|
foreach ( $models as $model ) {
|
|
|
|
|
$eventsByCategory[$model->getCategory()][] = $model;
|
|
|
|
|
}
|
|
|
|
|
return $eventsByCategory;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Apply style to notification category header
|
2017-08-09 15:20:55 +00:00
|
|
|
* @param string $category Can contain HTML. Is included as-is in HTML template, is not escaped.
|
2016-05-05 13:05:03 +00:00
|
|
|
* @return string
|
|
|
|
|
*/
|
|
|
|
|
protected function applyStyleToCategory( $category ) {
|
|
|
|
|
return <<< EOF
|
|
|
|
|
<tr>
|
2016-11-25 19:24:12 +00:00
|
|
|
<td colspan="2" style="color: #72777D; font-weight: normal; font-size: 13px; padding-top: 15px;">
|
2016-05-05 13:05:03 +00:00
|
|
|
$category <br />
|
2016-11-25 19:24:12 +00:00
|
|
|
<hr style="background-color:#FFFFFF; color:#FFFFFF; border: 1px solid #EAECF0;" />
|
2016-05-05 13:05:03 +00:00
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
EOF;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Apply style to individual notification event
|
|
|
|
|
* @param EchoEventPresentationModel $model
|
|
|
|
|
* @return string
|
|
|
|
|
*/
|
|
|
|
|
protected function applyStyleToEvent( EchoEventPresentationModel $model ) {
|
2019-04-17 00:30:17 +00:00
|
|
|
$iconUrl = wfExpandUrl(
|
|
|
|
|
EchoIcon::getRasterizedUrl( $model->getIconType(), $this->language->getCode() ),
|
|
|
|
|
PROTO_CANONICAL
|
|
|
|
|
);
|
2016-08-11 19:22:27 +00:00
|
|
|
|
2016-05-05 13:05:03 +00:00
|
|
|
$imgSrc = Sanitizer::encodeAttribute( $iconUrl );
|
|
|
|
|
|
|
|
|
|
// notification text
|
|
|
|
|
$text = $model->getHeaderMessage()->parse();
|
|
|
|
|
|
|
|
|
|
return <<< EOF
|
|
|
|
|
<tr>
|
|
|
|
|
<td width="30">
|
|
|
|
|
<img src="$imgSrc" width="30" height="30" style="vertical-align:middle;">
|
|
|
|
|
</td>
|
2016-11-25 19:24:12 +00:00
|
|
|
<td style="font-family: Arial, Helvetica, sans-serif; font-size:13px; color: #54595D;">
|
2016-05-05 13:05:03 +00:00
|
|
|
$text
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
EOF;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private function renderDigestList( $eventsByCategory ) {
|
2016-12-05 18:51:07 +00:00
|
|
|
$result = [];
|
2016-05-05 13:05:03 +00:00
|
|
|
// build the html section for each category
|
|
|
|
|
foreach ( $eventsByCategory as $category => $models ) {
|
|
|
|
|
$output = $this->applyStyleToCategory(
|
|
|
|
|
$this->getCategoryTitle( $category, count( $models ) )
|
|
|
|
|
);
|
|
|
|
|
foreach ( $models as $model ) {
|
|
|
|
|
$output .= "\n" . $this->applyStyleToEvent( $model );
|
|
|
|
|
}
|
|
|
|
|
$result[] = '<table border="0" width="100%">' . $output . '</table>';
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return trim( implode( "\n", $result ) );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private function renderAction() {
|
|
|
|
|
return Html::element(
|
|
|
|
|
'a',
|
2016-12-05 18:51:07 +00:00
|
|
|
[
|
2018-08-25 10:51:14 +00:00
|
|
|
'href' => SpecialPage::getTitleFor( 'Notifications' )
|
|
|
|
|
->getFullURL( '', false, PROTO_CANONICAL ),
|
2016-05-05 13:05:03 +00:00
|
|
|
'style' => EchoHtmlEmailFormatter::PRIMARY_LINK_STYLE,
|
2016-12-05 18:51:07 +00:00
|
|
|
],
|
2016-05-05 13:05:03 +00:00
|
|
|
$this->msg( 'echo-email-batch-link-text-view-all-notifications' )->text()
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
}
|
