SW-26872 - Consider hostname config for 'Message-Id' header

Author: mitelg

engine/Library/Zend/Mail.php

@@ -36,6 +36,7 @@
  * @see Zend_Mime_Part
  */
 
+use Shopware\Components\Random;
 
 /**
  * Class for sending an email.
@@ -119,7 +120,7 @@ class Zend_Mail extends Zend_Mime_Message
 
     /**
      * Subject: header
-     * @var string
+     * @var string|null
      */
     protected $_subject = null;
 
@@ -167,6 +168,7 @@ class Zend_Mail extends Zend_Mime_Message
      */
     public $hasAttachments = false;
 
+    private ?string $messageIdHostName;
 
     /**
      * Sets the default mail transport for all following uses of
@@ -201,17 +203,12 @@ public static function clearDefaultTransport()
         self::$_defaultTransport = null;
     }
 
-    /**
-     * Public constructor
-     *
-     * @param  string $charset
-     * @return void
-     */
-    public function __construct($charset = null)
+    public function __construct(?string $charset = null, ?string $messageIdHostName = null)
     {
-        if ($charset != null) {
+        if ($charset !== null) {
             $this->_charset = $charset;
         }
+        $this->messageIdHostName = $messageIdHostName;
     }
 
     /**
@@ -926,7 +923,7 @@ public function setSubject($subject)
     /**
      * Returns the encoded subject of the message
      *
-     * @return string
+     * @return string|null
      */
     public function getSubject()
     {
@@ -1087,17 +1084,19 @@ public function createMessageId() {
             $user = getmypid();
         }
 
-        $rand = Shopware\Components\Random::getInteger(0, PHP_INT_MAX);
+        $rand = Random::getInteger(0, PHP_INT_MAX);
 
         if ($this->_recipients !== array()) {
             $recipient = array_rand($this->_recipients);
         } else {
             $recipient = 'unknown';
         }
 
-        if (isset($_SERVER["SERVER_NAME"])) {
-            $hostName = $_SERVER["SERVER_NAME"];
-        } else {
+        $hostName = $this->messageIdHostName;
+        if (!$hostName) {
+            $hostName = (string) ($_SERVER['SERVER_NAME'] ?? '');
+        }
+        if (!$hostName) {
             $hostName = php_uname('n');
         }
 

engine/Shopware/Bundle/MailBundle/DependencyInjection/services.xml

@@ -41,6 +41,7 @@
                  class="Shopware\Bundle\MailBundle\Service\LogEntryMailBuilder">
             <argument type="service" id="shopware.filesystem.private" />
             <argument type="service" id="Shopware\Bundle\MediaBundle\MediaServiceInterface" />
+            <argument type="service" id="mail"/>
         </service>
 
         <service id="Shopware\Bundle\MailBundle\Service\LogServiceInterface"

engine/Shopware/Bundle/MailBundle/Service/LogEntryBuilder.php

@@ -70,7 +70,7 @@ public function build(Enlight_Components_Mail $mail): Log
     {
         $logEntry = new Log();
 
-        $logEntry->setSubject((string) iconv_mime_decode($mail->getSubject()));
+        $logEntry->setSubject((string) iconv_mime_decode((string) $mail->getSubject()));
         $logEntry->setSender($mail->getFrom());
         $logEntry->setSentAt(new DateTime((string) $mail->getDate()));
         $logEntry->setContentText($mail->getPlainBodyText());

engine/Shopware/Bundle/MailBundle/Service/LogEntryMailBuilder.php

@@ -29,34 +29,30 @@
 use RuntimeException;
 use Shopware\Bundle\MediaBundle\MediaServiceInterface;
 use Shopware\Models\Mail\Log;
-use Shopware\Models\Order\Document\Document;
 
 class LogEntryMailBuilder implements LogEntryMailBuilderInterface
 {
     public const INVALID_SENDER_REPLACEMENT_ADDRESS = '[email protected]';
 
-    /**
-     * @var FilesystemInterface
-     */
-    private $filesystem;
+    private FilesystemInterface $filesystem;
 
-    /**
-     * @var MediaServiceInterface
-     */
-    private $mediaService;
+    private MediaServiceInterface $mediaService;
+
+    private Enlight_Components_Mail $mail;
 
-    public function __construct(FilesystemInterface $filesystem, MediaServiceInterface $mediaService)
+    public function __construct(FilesystemInterface $filesystem, MediaServiceInterface $mediaService, Enlight_Components_Mail $mail)
     {
         $this->filesystem = $filesystem;
         $this->mediaService = $mediaService;
+        $this->mail = $mail;
     }
 
     /**
      * {@inheritdoc}
      */
     public function build(Log $entry): Enlight_Components_Mail
     {
-        $mail = new Enlight_Components_Mail('UTF-8');
+        $mail = clone $this->mail;
 
         try {
             $mail->setFrom($entry->getSender());
@@ -104,7 +100,6 @@ protected function assignOrderDocuments(Log $logEntry, Enlight_Components_Mail $
             return;
         }
 
-        /** @var Document $document */
         foreach ($logEntry->getDocuments() as $document) {
             $filePath = sprintf('documents/%s.pdf', $document->getHash());
             $fileName = sprintf('%s.pdf', $document->getType()->getName());

engine/Shopware/Components/DependencyInjection/Bridge/Mail.php

@@ -41,12 +41,12 @@ public function factory(Container $container, Shopware_Components_Config $config
 
         if (isset($options['charset'])) {
             $defaultCharSet = $options['charset'];
-        } elseif (!empty($config->CharSet)) {
-            $defaultCharSet = $config->CharSet;
+        } elseif (!empty($config->get('CharSet'))) {
+            $defaultCharSet = $config->get('CharSet');
         } else {
             $defaultCharSet = null;
         }
 
-        return new Enlight_Components_Mail($defaultCharSet);
+        return new Enlight_Components_Mail($defaultCharSet, $config->get('mailer_hostname') ?: null);
     }
 }

tests/Functional/Bundle/MailBundle/LogEntryMailBuilderTest.php

@@ -53,7 +53,8 @@ protected function setUp(): void
         $this->entryBuilder = new LogEntryBuilder($this->getContainer()->get(ModelManager::class));
         $this->mailBuilder = new LogEntryMailBuilder(
             $this->getContainer()->get('shopware.filesystem.private'),
-            $this->getContainer()->get(MediaServiceInterface::class)
+            $this->getContainer()->get(MediaServiceInterface::class),
+            $this->getContainer()->get('mail')
         );
     }
 

tests/Functional/Bundle/MailBundle/LogRepositoryTest.php

@@ -134,6 +134,7 @@ public function testUniqueConstraintIsCaseSensitive(): void
         $firstMail = $this->createSimpleMail();
         $secondMail = new Enlight_Components_Mail('UTF-8');
 
+        static::assertIsString($firstMail->getSubject());
         $secondMail->setSubject($firstMail->getSubject());
         $secondMail->setFrom(ucfirst($firstMail->getFrom()));
         $secondMail->setBodyText($firstMail->getBodyText()->getRawContent());

tests/Functional/Components/MailTest.php

@@ -36,7 +36,7 @@ public function testMessageId(): void
     {
         $mailTransport = $this->getContainer()->get('mailtransport');
 
-        $mail = new Enlight_Components_Mail();
+        $mail = new Enlight_Components_Mail(null, 'test.com');
         $mail->setBodyText('Test Hello');
         $mail->addTo('[email protected]');
 
@@ -46,7 +46,7 @@ public function testMessageId(): void
         static::assertArrayHasKey('Message-Id', $headers);
         $messageId = $headers['Message-Id'][0];
         static::assertIsString($messageId);
-        static::assertStringContainsString('@', $messageId);
+        static::assertStringContainsString('@test.com', $messageId);
         static::assertStringStartsWith('<', $messageId);
         static::assertStringEndsWith('>', $messageId);
     }