Introduce NotifyEmailBuilder

include/enotify.php

@@ -15,7 +15,6 @@ use Friendica\Model\ItemContent;
 use Friendica\Model\Notify;
 use Friendica\Model\User;
 use Friendica\Model\UserItem;
-use Friendica\Object\Email;
 use Friendica\Protocol\Activity;
 
 /**
@@ -31,8 +30,6 @@ use Friendica\Protocol\Activity;
  */
 function notification($params)
 {
-	$a = DI::app();
-
 	// Temporary logging for finding the origin
 	if (!isset($params['uid'])) {
 		Logger::notice('Missing parameters "uid".', ['params' => $params, 'callstack' => System::callstack()]);
@@ -55,25 +52,14 @@ function notification($params)
 	// from here on everything is in the recipients language
 	$l10n = DI::l10n()->withLang($params['language']);
 
-	$banner = $l10n->t('Friendica Notification');
-	$product = FRIENDICA_PLATFORM;
 	$siteurl = DI::baseUrl()->get(true);
-	$thanks = $l10n->t('Thank You,');
 	$sitename = DI::config()->get('config', 'sitename');
-	if (DI::config()->get('config', 'admin_name')) {
-		$site_admin = $l10n->t('%1$s, %2$s Administrator', DI::config()->get('config', 'admin_name'), $sitename);
-	} else {
-		$site_admin = $l10n->t('%s Administrator', $sitename);
-	}
 
-	$sender_name = $sitename;
 	$hostname = DI::baseUrl()->getHostname();
 	if (strpos($hostname, ':')) {
 		$hostname = substr($hostname, 0, strpos($hostname, ':'));
 	}
 
-	$sender_email = DI::emailer()->getSiteEmailAddress();
-
 	$user = User::getById($params['uid'], ['nickname', 'page-flags']);
 
 	// There is no need to create notifications for forum accounts
@@ -87,14 +73,7 @@ function notification($params)
 	// default, if not specified: true
 	$show_in_notification_page = isset($params['show_in_notification_page']) ? $params['show_in_notification_page'] : true;
 
-	$additional_mail_header = "";
+	$additional_mail_header = "X-Friendica-Account: <".$nickname."@".$hostname.">\n";
-	$additional_mail_header .= "Precedence: list\n";
-	$additional_mail_header .= "X-Friendica-Host: ".$hostname."\n";
-	$additional_mail_header .= "X-Friendica-Account: <".$nickname."@".$hostname.">\n";
-	$additional_mail_header .= "X-Friendica-Platform: ".FRIENDICA_PLATFORM."\n";
-	$additional_mail_header .= "X-Friendica-Version: ".FRIENDICA_VERSION."\n";
-	$additional_mail_header .= "List-ID: <notification.".$hostname.">\n";
-	$additional_mail_header .= "List-Archive: <".DI::baseUrl()."/notifications/system>\n";
 
 	if (array_key_exists('item', $params)) {
 		$title = $params['item']['title'];
@@ -503,74 +482,43 @@ function notification($params)
 			}
 		}
 
-		$textversion = BBCode::toPlaintext($body);
+		$datarray = [
-		$htmlversion = BBCode::convert($body);
+			'preamble'     => $preamble,
-
+			'type'         => $params['type'],
-		$datarray                 = [];
+			'parent'       => $parent_id,
-		$datarray['banner']       = $banner;
+			'source_name'  => $params['source_name'] ?? null,
-		$datarray['product']      = $product;
+			'source_link'  => $params['source_link'] ?? null,
-		$datarray['preamble']     = $preamble;
+			'source_photo' => $params['source_photo'] ?? null,
-		$datarray['sitename']     = $sitename;
+			'uid'          => $params['uid'],
-		$datarray['siteurl']      = $siteurl;
+			'hsitelink'    => $hsitelink,
-		$datarray['type']         = $params['type'];
+			'tsitelink'    => $tsitelink,
-		$datarray['parent']       = $parent_id;
+			'itemlink'     => $itemlink,
-		$datarray['source_name']  = $params['source_name'] ?? '';
+			'title'        => $title,
-		$datarray['source_link']  = $params['source_link'] ?? '';
+			'body'         => $body,
-		$datarray['source_photo'] = $params['source_photo'] ?? '';
+			'subject'      => $subject,
-		$datarray['uid']          = $params['uid'];
+			'headers'      => $additional_mail_header,
-		$datarray['hsitelink']    = $hsitelink;
+		];
-		$datarray['tsitelink']    = $tsitelink;
-		$datarray['hitemlink']    = '<a href="' . $itemlink . '">' . $itemlink . '</a>';
-		$datarray['titemlink']    = $itemlink;
-		$datarray['thanks']       = $thanks;
-		$datarray['site_admin']   = $site_admin;
-		$datarray['title']        = stripslashes($title);
-		$datarray['htmlversion']  = $htmlversion;
-		$datarray['textversion']  = $textversion;
-		$datarray['subject']      = $subject;
-		$datarray['headers']      = $additional_mail_header;
 
 		Hook::callAll('enotify_mail', $datarray);
 
-		// check whether sending post content in email notifications is allowed
+		$builder = DI::emailer()
-		$content_allowed = (!DI::config()->get('system', 'enotify_no_content'));
+			->newNotifyMail($l10n)
+			->addHeaders($datarray['headers'])
+			->withRecipient($params['to_email'])
+			->forUser($datarray['uid'])
+			->withNotification($datarray['subject'], $datarray['preamble'], $datarray['title'], $datarray['body'])
+			->withSiteLink($datarray['tsitelink'], $datarray['hsitelink'])
+			->withItemLink($datarray['itemlink']);
 
-		// load the template for private message notifications
+		// If a photo is present, add it to the email
-		$tpl             = Renderer::getMarkupTemplate('email/notify/html.tpl');
+		if (!empty($datarray['source_photo'])) {
-		$email_html_body = Renderer::replaceMacros($tpl, [
+			$builder->withPhoto(
-			'$banner'          => $datarray['banner'],
+				$datarray['source_photo'],
-			'$product'         => $datarray['product'],
+				$datarray['source_link'] ?? $sitelink,
-			'$preamble'        => str_replace("\n", "<br>\n", $datarray['preamble']),
+				$datarray['source_name'] ?? $sitename);
-			'$sitename'        => $datarray['sitename'],
+		}
-			'$siteurl'         => $datarray['siteurl'],
-			'$source_name'     => $datarray['source_name'],
-			'$source_link'     => $datarray['source_link'],
-			'$source_photo'    => $datarray['source_photo'],
-			'$hsitelink'       => $datarray['hsitelink'],
-			'$hitemlink'       => $datarray['hitemlink'],
-			'$thanks'          => $datarray['thanks'],
-			'$site_admin'      => $datarray['site_admin'],
-			'$title'           => $datarray['title'],
-			'$htmlversion'     => $datarray['htmlversion'],
-			'$content_allowed' => $content_allowed,
-		]);
 
-		// load the template for private message notifications
+		$email = $builder->build();
-		$tpl             = Renderer::getMarkupTemplate('email/notify/text.tpl');
-		$email_text_body = Renderer::replaceMacros($tpl, [
-			'$preamble'        => $datarray['preamble'],
-			'$tsitelink'       => $datarray['tsitelink'],
-			'$titemlink'       => $datarray['titemlink'],
-			'$thanks'          => $datarray['thanks'],
-			'$site_admin'      => $datarray['site_admin'],
-			'$title'           => $datarray['title'],
-			'$textversion'     => $datarray['textversion'],
-			'$content_allowed' => $content_allowed,
-		]);
-
-		$email = new Email($sender_name, $sender_email, $sender_email, $params['to_email'],
-			$datarray['subject'], $email_html_body, $email_text_body,
-			$datarray['headers'], $params['uid']);
 
 		// use the Emailer class to send the message
 		return DI::emailer()->send($email);

src/Util/EMailer/MailBuilder.php

@@ -139,6 +139,20 @@ abstract class MailBuilder
 		return $this;
 	}
 
+	/**
+	 * Adds new headers to the default headers
+	 *
+	 * @param string $headers New headers
+	 *
+	 * @return static
+	 */
+	public function addHeaders(string $headers)
+	{
+		$this->headers .= $headers;
+
+		return $this;
+	}
+
 	/**
 	 * Build a email based on the given attributes
 	 *

src/Util/EMailer/NotifyMailBuilder.php

@@ -0,0 +1,178 @@
+<?php
+
+namespace Friendica\Util\EMailer;
+
+use Exception;
+use Friendica\App\BaseURL;
+use Friendica\Content\Text\BBCode;
+use Friendica\Core\Config\IConfig;
+use Friendica\Core\L10n;
+use Friendica\Core\Renderer;
+use Friendica\Network\HTTPException\InternalServerErrorException;
+
+/**
+ * Builder for notification emails (notification, source, links, ...)
+ */
+class NotifyMailBuilder extends SystemMailBuilder
+{
+	/** @var bool */
+	private $contentAllowed = true;
+	/** @var string */
+	private $title = '';
+	/** @var array Details to print a photo:
+	 * - image
+	 * - link
+	 * - name
+	 */
+	private $photo = [
+		'image' => null,
+		'link'  => null,
+		'name'  => null,
+	];
+	/** @var array HTML/Plain version of the Site Link:
+	 * - html
+	 * - text
+	 */
+	private $siteLink = [
+		'html' => '',
+		'text' => '',
+	];
+	/** @var string The item link */
+	private $itemLink = '';
+
+	public function __construct(L10n $l10n, BaseURL $baseUrl, IConfig $config, string $siteEmailAddress, string $siteName)
+	{
+		parent::__construct($l10n, $baseUrl, $config, $siteEmailAddress, $siteName);
+
+		// check whether sending post content in email notifications is allowed
+		$this->contentAllowed = $this->config->get('system', 'enotify_no_content');
+	}
+
+	/**
+	 * Adds a notification (in fact a more detailed message)
+	 *
+	 * @param string      $subject
+	 * @param string      $preamble
+	 * @param string      $title
+	 * @param string|null $body
+	 *
+	 * @return static
+	 */
+	public function withNotification(string $subject, string $preamble, string $title, string $body = null)
+	{
+		$this->title = stripslashes($title);
+
+		return $this->withMessage($subject, $preamble, $body);
+	}
+
+	/**
+	 * Adds a photo of the source of the notify
+	 *
+	 * @param string $image The image link to the photo
+	 * @param string $link  The link to the source
+	 * @param string $name  The name of the source
+	 *
+	 * @return static
+	 */
+	public function withPhoto(string $image, string $link, string $name)
+	{
+		$this->photo = [
+			'image' => $image ?? '',
+			'link'  => $link ?? '',
+			'name'  => $name ?? '',
+		];
+
+		return $this;
+	}
+
+	/**
+	 * Adds a sitelink to the notification
+	 *
+	 * @param string $text The text version of the site link
+	 * @param string $html The html version of the site link
+	 *
+	 * @return static
+	 */
+	public function withSiteLink(string $text, string $html = '')
+	{
+		$this->siteLink = [
+			'text' => $text,
+			'html' => $html,
+		];
+
+		return $this;
+	}
+
+	/**
+	 * Adds a link to the item of the notification
+	 *
+	 * @param string $link The text version of the item link
+	 *
+	 * @return static
+	 */
+	public function withItemLink(string $link)
+	{
+		$this->itemLink = $link;
+
+		return $this;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 */
+	protected function getSubject()
+	{
+		return $this->subject;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 *
+	 * @throws InternalServerErrorException
+	 * @throws Exception
+	 */
+	protected function getHtmlMessage()
+	{
+		$htmlVersion = BBCode::convert($this->body);
+
+		// load the template for private message notifications
+		$tpl = Renderer::getMarkupTemplate('email/notify/html.tpl');
+		return Renderer::replaceMacros($tpl, [
+			'$preamble'        => str_replace("\n", "<br>\n", $this->preamble),
+			'$source_name'     => $this->photo['name'],
+			'$source_link'     => $this->photo['link'],
+			'$source_photo'    => $this->photo['image'],
+			'$hsitelink'       => $this->siteLink['html'],
+			'$hitemlink'       => sprintf('<a href="%s">%s</a>', $this->itemLink, $this->itemLink),
+			'$thanks'          => $this->l10n->t('thanks'),
+			'$site_admin'      => $this->siteAdmin,
+			'$title'           => $this->title,
+			'$htmlversion'     => $htmlVersion,
+			'$content_allowed' => $this->contentAllowed,
+		]);
+
+	}
+
+	/**
+	 * {@inheritDoc}
+	 *
+	 * @throws Exception
+	 */
+	protected function getPlaintextMessage()
+	{
+		$textVersion = BBCode::toPlaintext($this->body);
+
+		// load the template for private message notifications
+		$tpl = Renderer::getMarkupTemplate('email/notify/text.tpl');
+		return Renderer::replaceMacros($tpl, [
+			'$preamble'        => $this->preamble,
+			'$tsitelink'       => $this->siteLink['text'],
+			'$titemlink'       => $this->itemLink,
+			'$thanks'          => $this->l10n->t('thanks'),
+			'$site_admin'      => $this->siteAdmin,
+			'$title'           => $this->title,
+			'$textversion'     => $textVersion,
+			'$content_allowed' => $this->contentAllowed,
+		]);
+	}
+}

src/Util/Emailer.php

@@ -9,9 +9,11 @@ use Friendica\Core\Config\IConfig;
 use Friendica\Core\Hook;
 use Friendica\Core\L10n;
 use Friendica\Core\PConfig\IPConfig;
+use Friendica\Model\Notify;
 use Friendica\Network\HTTPException\InternalServerErrorException;
 use Friendica\Object\EMail\IEmail;
 use Friendica\Protocol\Email;
+use Friendica\Util\EMailer\NotifyMailBuilder;
 use Friendica\Util\EMailer\SystemMailBuilder;
 use Psr\Log\LoggerInterface;
 
@@ -89,6 +91,21 @@ class Emailer
 			$this->getSiteEmailAddress(), $this->getSiteEmailName());
 	}
 
+	/**
+	 * Creates a new mail for notifications
+	 *
+	 * @see Notify
+	 *
+	 * @param L10n $l10n The chosen language for the new email
+	 *
+	 * @return NotifyMailBuilder
+	 */
+	public function newNotifyMail(L10n $l10n)
+	{
+		return new NotifyMailBuilder($l10n, $this->baseUrl, $this->config,
+			$this->getSiteEmailAddress(), $this->getSiteEmailName());
+	}
+
 	/**
 	 * Send a multipart/alternative message with Text and HTML versions
 	 *

view/templates/email/notify/html.tpl

@@ -1,20 +1,5 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional //EN">
+	<table>
-<html>
-<head>
-	<title>{{$banner}}</title>
-	<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
-</head>
-<body>
-	<table style="border:1px solid #ccc">
 	<tbody>
-		<tr>
-			<td colspan="2" style="background:#084769; color:#FFFFFF; font-weight:bold; font-family:'lucida grande', tahoma, verdana,arial, sans-serif; padding: 4px 8px; vertical-align: middle; font-size:16px; letter-spacing: -0.03em; text-align: left;">
-				<img style="width:32px;height:32px; float:left;" src='{{$siteurl}}/images/friendica-32.png'>
-				<div style="padding:7px; margin-left: 5px; float:left; font-size:18px;letter-spacing:1px;">{{$product}}</div>
-				<div style="clear: both;"></div>
-			</td>
-		</tr>
-
 		<tr><td colspan="2" style="padding-top:22px;">{{$preamble nofilter}}</td></tr>
 
 {{if $content_allowed}}
@@ -32,6 +17,4 @@
 		<tr><td></td><td>{{$thanks}}</td></tr>
 		<tr><td></td><td>{{$site_admin}}</td></tr>
 	</tbody>
-	</table>
+	</table>
-</body>
-</html>