Transform email header string to header array & replace it at various situations.

[friendica.git/.git] / src / Util / EMailer / MailBuilder.php

diff --git a/src/Util/EMailer/MailBuilder.php b/src/Util/EMailer/MailBuilder.php
index c2c2f75..6a7412f 100644 (file)
--- a/src/Util/EMailer/MailBuilder.php
+++ b/src/Util/EMailer/MailBuilder.php
@@ -1,4 +1,23 @@
 <?php
+/**
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
 
 namespace Friendica\Util\EMailer;
 
@@ -11,20 +30,26 @@ use Friendica\Model\User;
 use Friendica\Network\HTTPException\InternalServerErrorException;
 use Friendica\Object\Email;
 use Friendica\Object\EMail\IEmail;
+use Psr\Log\LoggerInterface;
 
 /**
  * A base class for building new emails
  */
 abstract class MailBuilder
 {
+       /** @var string The default email banner in case nothing else is defined */
+       const DEFAULT_EMAIL_BANNER = 'images/friendica-32.png';
+
        /** @var L10n */
        protected $l10n;
        /** @var IConfig */
        protected $config;
        /** @var BaseURL */
        protected $baseUrl;
+       /** @var LoggerInterface */
+       protected $logger;
 
-       /** @var string */
+       /** @var string[][] */
        protected $headers;
 
        /** @var string */
@@ -39,24 +64,26 @@ abstract class MailBuilder
        /** @var int */
        protected $recipientUid = null;
 
-       public function __construct(L10n $l10n, BaseURL $baseUrl, IConfig $config)
+       public function __construct(L10n $l10n, BaseURL $baseUrl, IConfig $config, LoggerInterface $logger)
        {
                $this->l10n    = $l10n;
                $this->baseUrl = $baseUrl;
                $this->config  = $config;
+               $this->logger  = $logger;
 
                $hostname = $baseUrl->getHostname();
                if (strpos($hostname, ':')) {
                        $hostname = substr($hostname, 0, strpos($hostname, ':'));
                }
 
-               $this->headers = "";
-               $this->headers .= "Precedence: list\n";
-               $this->headers .= "X-Friendica-Host: " . $hostname . "\n";
-               $this->headers .= "X-Friendica-Platform: " . FRIENDICA_PLATFORM . "\n";
-               $this->headers .= "X-Friendica-Version: " . FRIENDICA_VERSION . "\n";
-               $this->headers .= "List-ID: <notification." . $hostname . ">\n";
-               $this->headers .= "List-Archive: <" . $baseUrl->get() . "/notifications/system>\n";
+               $this->headers = [
+                       'Precedence'           => ['list'],
+                       'X-Friendica-Host'     => [$hostname],
+                       'X-Friendica-Platform' => [FRIENDICA_PLATFORM],
+                       'X-Friendica-Version'  => [FRIENDICA_VERSION],
+                       'List-ID'              => ['<notification.' . $hostname . '>'],
+                       'List-Archive'         => ['<' . $baseUrl->get() . '/notifications/system>'],
+               ];
        }
 
        /**
@@ -83,13 +110,19 @@ abstract class MailBuilder
        /**
         * Adds the User ID to the email in case the mail sending needs additional properties of this user
         *
-        * @param int $uid The User ID
+        * @param array $user The user entity/array, for which the email should be sent
         *
         * @return static
+        * @todo Once the user array is replaced with a user entity, replace this array parameter as well
         */
-       public function forUser(int $uid)
+       public function forUser(array $user)
        {
-               $this->recipientUid = $uid;
+               $this->recipientUid = $user['uid'] ?? 0;
+               try {
+                       $this->l10n = $user['language'] ? $this->l10n->withLang($user['language']) : $this->l10n;
+               } catch (Exception $e) {
+                       $this->logger->warning('cannot use language.', ['user' => $user, 'exception' => $e]);
+               }
 
                return $this;
        }
@@ -126,6 +159,37 @@ abstract class MailBuilder
                return $this;
        }
 
+       /**
+        * Adds a value to a header
+        *
+        * @param string $name The header name
+        * @param string $value The value of the header to add
+        *
+        * @return static
+        */
+       public function addHeader(string $name, string $value)
+       {
+               $this->headers[$name][] = $value;
+
+               return $this;
+       }
+
+       /**
+        * Sets a value to a header (overwrites existing values)
+        *
+        * @param string $name The header name
+        * @param string $value The value to set
+        *
+        * @return static
+        */
+       public function setHeader(string $name, string $value)
+       {
+               $this->headers[$name] = [];
+               $this->headers[$name][] = $value;
+
+               return $this;
+       }
+
        /**
         * Build a email based on the given attributes
         *
@@ -142,7 +206,7 @@ abstract class MailBuilder
                    !empty($this->recipientUid)) {
                        $user = User::getById($this->recipientUid, ['email']);
 
-                       if (!empty($user)) {
+                       if (!empty($user['email'])) {
                                $this->recipientAddress = $user['email'];
                        }
                }
@@ -163,11 +227,12 @@ abstract class MailBuilder
                        // load the template for private message notifications
                        $tpl     = Renderer::getMarkupTemplate('email/html.tpl');
                        $msgHtml = Renderer::replaceMacros($tpl, [
-                               '$banner'      => $this->l10n->t('Friendica Notification'),
+                               '$title'       => $this->l10n->t('Friendica Notification'),
                                '$product'     => FRIENDICA_PLATFORM,
                                '$htmlversion' => $msgHtml,
                                '$sitename'    => $this->config->get('config', 'sitename'),
-                               '$siteurl'     => $this->baseUrl->get(true),
+                               '$banner'      => $this->config->get('system', 'email_banner',
+                                       $this->baseUrl->get(true) . DIRECTORY_SEPARATOR . self::DEFAULT_EMAIL_BANNER),
                        ]);
                }