PHP 8.1 Support

swiftmailer · Oct 18, 2021 · ee8a1d9 · ee8a1d9
1 parent 2a7fb75
commit ee8a1d9
Show file tree

Hide file tree

Showing 29 changed files with 158 additions and 97 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -0,0 +1,55 @@
+name: tests
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  linux_tests:
+    runs-on: ubuntu-20.04
+
+    services:
+      mailcatcher:
+        image: dockage/mailcatcher:0.7.1
+        ports:
+          - 4456:1025
+
+    strategy:
+      fail-fast: true
+      matrix:
+        php: ['7.0', '7.1', '7.2', '7.3', '7.4', '8.0', '8.1']
+
+    name: PHP ${{ matrix.php }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: dom, curl, libxml, mbstring, zip, intl
+          tools: composer:v2
+          coverage: none
+
+      - name: Prepare test config files
+        run: |
+          cp tests/acceptance.conf.php.default tests/acceptance.conf.php
+          cp tests/smoke.conf.php.default tests/smoke.conf.php
+
+      - name: Require Symfony PHPUnit Bridge 5.4 for PHP 8.1
+        if: ${{ matrix.php >= 8.1 }}
+        run: composer require symfony/phpunit-bridge:^5.4 --dev --prefer-dist --no-interaction --no-progress
+
+      - name: Install dependencies
+        uses: nick-invision/retry@v1
+        with:
+          timeout_minutes: 5
+          max_attempts: 5
+          command: composer update --prefer-stable --prefer-dist --no-interaction --no-progress
+
+      - name: Execute tests
+        run: vendor/bin/simple-phpunit --verbose
+        env:
+          SYMFONY_PHPUNIT_REMOVE_RETURN_TYPEHINT: 1
diff --git a/.travis.yml b/.travis.yml
diff --git a/composer.json b/composer.json
@@ -23,7 +23,7 @@
     },
     "require-dev": {
         "mockery/mockery": "^1.0",
-        "symfony/phpunit-bridge": "^4.4|^5.0"
+        "symfony/phpunit-bridge": "^4.4|^5.4"
     },
     "suggest": {
         "ext-intl": "Needed to support internationalized email addresses"
@@ -38,5 +38,7 @@
         "branch-alias": {
             "dev-master": "6.2-dev"
         }
-    }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
 }
diff --git a/lib/classes/Swift/CharacterReaderFactory/SimpleCharacterReaderFactory.php b/lib/classes/Swift/CharacterReaderFactory/SimpleCharacterReaderFactory.php
@@ -103,7 +103,7 @@ public function init()
      */
     public function getReaderFor($charset)
     {
-        $charset = strtolower(trim($charset));
+        $charset = strtolower(trim($charset ?? ''));
         foreach (self::$map as $pattern => $spec) {
             $re = '/^'.$pattern.'$/D';
             if (preg_match($re, $charset)) {

diff --git a/lib/classes/Swift/Encoder/Base64Encoder.php b/lib/classes/Swift/Encoder/Base64Encoder.php
@@ -34,7 +34,7 @@ public function encodeString($string, $firstLineOffset = 0, $maxLineLength = 0)
             $maxLineLength = 76;
         }
 
-        $encodedString = base64_encode($string);
+        $encodedString = base64_encode($string ?? '');
         $firstLine = '';
 
         if (0 != $firstLineOffset) {

diff --git a/lib/classes/Swift/Message.php b/lib/classes/Swift/Message.php
@@ -224,7 +224,7 @@ protected function saveMessage()
     protected function saveHeaders(array $altered)
     {
         foreach ($altered as $head) {
-            $lc = strtolower($head);
+            $lc = strtolower($head ?? '');
 
             if (!isset($this->savedMessage['headers'][$lc])) {
                 $this->savedMessage['headers'][$lc] = $this->getHeaders()->getAll($head);

diff --git a/lib/classes/Swift/Mime/ContentEncoder/Base64ContentEncoder.php b/lib/classes/Swift/Mime/ContentEncoder/Base64ContentEncoder.php
@@ -27,7 +27,7 @@ public function encodeByteStream(Swift_OutputByteStream $os, Swift_InputByteStre
         }
 
         $remainder = 0;
-        $base64ReadBufferRemainderBytes = null;
+        $base64ReadBufferRemainderBytes = '';
 
         // To reduce memory usage, the output buffer is streamed to the input buffer like so:
         //   Output Stream => base64encode => wrap line length => Input Stream
@@ -45,7 +45,7 @@ public function encodeByteStream(Swift_OutputByteStream $os, Swift_InputByteStre
             } else {
                 $streamTheseBytes = $base64ReadBufferRemainderBytes.$readBytes;
             }
-            $base64ReadBufferRemainderBytes = null;
+            $base64ReadBufferRemainderBytes = '';
             $bytesLength = \strlen($streamTheseBytes);
 
             if (0 === $bytesLength) { // no data left to encode

diff --git a/lib/classes/Swift/Mime/HeaderEncoder/Base64HeaderEncoder.php b/lib/classes/Swift/Mime/HeaderEncoder/Base64HeaderEncoder.php
@@ -41,7 +41,7 @@ public function getName()
      */
     public function encodeString($string, $firstLineOffset = 0, $maxLineLength = 0, $charset = 'utf-8')
     {
-        if ('iso-2022-jp' === strtolower($charset)) {
+        if ('iso-2022-jp' === strtolower($charset ?? '')) {
             $old = mb_internal_encoding();
             mb_internal_encoding('utf-8');
             $newstring = mb_encode_mimeheader($string, $charset, $this->getName(), "\r\n");

diff --git a/lib/classes/Swift/Mime/Headers/AbstractHeader.php b/lib/classes/Swift/Mime/Headers/AbstractHeader.php
@@ -309,7 +309,7 @@ protected function getEncodableWordTokens($string)
 
         $encodedToken = '';
         // Split at all whitespace boundaries
-        foreach (preg_split('~(?=[\t ])~', $string) as $token) {
+        foreach (preg_split('~(?=[\t ])~', $string ?? '') as $token) {
             if ($this->tokenNeedsEncoding($token)) {
                 $encodedToken .= $token;
             } else {
@@ -354,10 +354,10 @@ protected function getTokenAsEncodedWord($token, $firstLineOffset = 0)
         $encodedTextLines = explode("\r\n",
             $this->encoder->encodeString(
                 $token, $firstLineOffset, 75 - $encodingWrapperLength, $this->charset
-                )
+            ) ?? ''
         );
 
-        if ('iso-2022-jp' !== strtolower($this->charset)) {
+        if ('iso-2022-jp' !== strtolower($this->charset ?? '')) {
             // special encoding for iso-2022-jp using mb_encode_mimeheader
             foreach ($encodedTextLines as $lineNum => $line) {
                 $encodedTextLines[$lineNum] = '=?'.$charsetDecl.
@@ -378,7 +378,7 @@ protected function getTokenAsEncodedWord($token, $firstLineOffset = 0)
      */
     protected function generateTokenLines($token)
     {
-        return preg_split('~(\r\n)~', $token, -1, PREG_SPLIT_DELIM_CAPTURE);
+        return preg_split('~(\r\n)~', $token ?? '', -1, PREG_SPLIT_DELIM_CAPTURE);
     }
 
     /**
@@ -429,7 +429,7 @@ protected function toTokens($string = null)
         $tokens = [];
 
         // Generate atoms; split at all invisible boundaries followed by WSP
-        foreach (preg_split('~(?=[ \t])~', $string) as $token) {
+        foreach (preg_split('~(?=[ \t])~', $string ?? '') as $token) {
             $newTokens = $this->generateTokenLines($token);
             foreach ($newTokens as $newToken) {
                 $tokens[] = $newToken;
@@ -473,4 +473,14 @@ private function tokensToString(array $tokens)
         // Implode with FWS (RFC 2822, 2.2.3)
         return implode("\r\n", $headerLines)."\r\n";
     }
+
+    /**
+     * Make a deep copy of object.
+     */
+    public function __clone()
+    {
+        if ($this->encoder) {
+            $this->encoder = clone $this->encoder;
+        }
+    }
 }
diff --git a/lib/classes/Swift/Mime/MimePart.php b/lib/classes/Swift/Mime/MimePart.php
@@ -189,7 +189,7 @@ protected function setNestingLevel($level)
     /** Encode charset when charset is not utf-8 */
     protected function convertString($string)
     {
-        $charset = strtolower($this->getCharset());
+        $charset = strtolower($this->getCharset() ?? '');
         if (!\in_array($charset, ['utf-8', 'iso-8859-1', 'iso-8859-15', ''])) {
             return mb_convert_encoding($string, $charset, 'utf-8');
         }

diff --git a/lib/classes/Swift/Mime/SimpleHeaderFactory.php b/lib/classes/Swift/Mime/SimpleHeaderFactory.php
@@ -113,7 +113,7 @@ public function createTextHeader($name, $value = null)
      */
     public function createParameterizedHeader($name, $value = null, $params = [])
     {
-        $header = new Swift_Mime_Headers_ParameterizedHeader($name, $this->encoder, ('content-disposition' == strtolower($name)) ? $this->paramEncoder : null);
+        $header = new Swift_Mime_Headers_ParameterizedHeader($name, $this->encoder, ('content-disposition' == strtolower($name ?? '')) ? $this->paramEncoder : null);
         if (isset($value)) {
             $header->setFieldBodyModel($value);
         }
@@ -182,6 +182,7 @@ public function __clone()
     {
         $this->encoder = clone $this->encoder;
         $this->paramEncoder = clone $this->paramEncoder;
+        $this->addressEncoder = clone $this->addressEncoder;
     }
 
     /** Apply the charset to the Header */

diff --git a/lib/classes/Swift/Mime/SimpleHeaderSet.php b/lib/classes/Swift/Mime/SimpleHeaderSet.php
@@ -138,7 +138,7 @@ public function addPathHeader($name, $path = null)
      */
     public function has($name, $index = 0)
     {
-        $lowerName = strtolower($name);
+        $lowerName = strtolower($name ?? '');
 
         if (!\array_key_exists($lowerName, $this->headers)) {
             return false;
@@ -181,7 +181,7 @@ public function set(Swift_Mime_Header $header, $index = 0)
      */
     public function get($name, $index = 0)
     {
-        $name = strtolower($name);
+        $name = strtolower($name ?? '');
 
         if (\func_num_args() < 2) {
             if ($this->has($name)) {
@@ -214,7 +214,7 @@ public function getAll($name = null)
             return $headers;
         }
 
-        $lowerName = strtolower($name);
+        $lowerName = strtolower($name ?? '');
         if (!\array_key_exists($lowerName, $this->headers)) {
             return [];
         }
@@ -247,7 +247,7 @@ public function listAll()
      */
     public function remove($name, $index = 0)
     {
-        $lowerName = strtolower($name);
+        $lowerName = strtolower($name ?? '');
         unset($this->headers[$lowerName][$index]);
     }
 
@@ -258,7 +258,7 @@ public function remove($name, $index = 0)
      */
     public function removeAll($name)
     {
-        $lowerName = strtolower($name);
+        $lowerName = strtolower($name ?? '');
         unset($this->headers[$lowerName]);
     }
 
@@ -330,13 +330,13 @@ public function __toString()
     /** Save a Header to the internal collection */
     private function storeHeader($name, Swift_Mime_Header $header, $offset = null)
     {
-        if (!isset($this->headers[strtolower($name)])) {
-            $this->headers[strtolower($name)] = [];
+        if (!isset($this->headers[strtolower($name ?? '')])) {
+            $this->headers[strtolower($name ?? '')] = [];
         }
         if (!isset($offset)) {
-            $this->headers[strtolower($name)][] = $header;
+            $this->headers[strtolower($name ?? '')][] = $header;
         } else {
-            $this->headers[strtolower($name)][$offset] = $header;
+            $this->headers[strtolower($name ?? '')][$offset] = $header;
         }
     }
 
@@ -349,8 +349,8 @@ private function canSort()
     /** uksort() algorithm for Header ordering */
     private function sortHeaders($a, $b)
     {
-        $lowerA = strtolower($a);
-        $lowerB = strtolower($b);
+        $lowerA = strtolower($a ?? '');
+        $lowerB = strtolower($b ?? '');
         $aPos = \array_key_exists($lowerA, $this->order) ? $this->order[$lowerA] : -1;
         $bPos = \array_key_exists($lowerB, $this->order) ? $this->order[$lowerB] : -1;
 
@@ -371,7 +371,7 @@ private function sortHeaders($a, $b)
     /** Test if the given Header is always displayed */
     private function isDisplayed(Swift_Mime_Header $header)
     {
-        return \array_key_exists(strtolower($header->getFieldName()), $this->required);
+        return \array_key_exists(strtolower($header->getFieldName() ?? ''), $this->required);
     }
 
     /** Notify all Headers of the new charset */

diff --git a/lib/classes/Swift/Mime/SimpleMimeEntity.php b/lib/classes/Swift/Mime/SimpleMimeEntity.php
@@ -731,7 +731,7 @@ private function getNeededChildLevel($child, $compoundLevel)
         }
 
         $realLevel = $child->getNestingLevel();
-        $lowercaseType = strtolower($child->getContentType());
+        $lowercaseType = strtolower($child->getContentType() ?? '');
 
         if (isset($filter[$realLevel]) && isset($filter[$realLevel][$lowercaseType])) {
             return $filter[$realLevel][$lowercaseType];

diff --git a/lib/classes/Swift/Plugins/PopBeforeSmtpPlugin.php b/lib/classes/Swift/Plugins/PopBeforeSmtpPlugin.php
@@ -137,7 +137,7 @@ public function connect()
                 $this->socket = $socket;
 
                 if (false === $greeting = fgets($this->socket)) {
-                    throw new Swift_Plugins_Pop_Pop3Exception(sprintf('Failed to connect to POP3 host [%s]', trim($greeting)));
+                    throw new Swift_Plugins_Pop_Pop3Exception(sprintf('Failed to connect to POP3 host [%s]', trim($greeting ?? '')));
                 }
 
                 $this->assertOk($greeting);
@@ -205,11 +205,11 @@ public function transportStopped(Swift_Events_TransportChangeEvent $evt)
     private function command($command)
     {
         if (!fwrite($this->socket, $command)) {
-            throw new Swift_Plugins_Pop_Pop3Exception(sprintf('Failed to write command [%s] to POP3 host', trim($command)));
+            throw new Swift_Plugins_Pop_Pop3Exception(sprintf('Failed to write command [%s] to POP3 host', trim($command ?? '')));
         }
 
         if (false === $response = fgets($this->socket)) {
-            throw new Swift_Plugins_Pop_Pop3Exception(sprintf('Failed to read from POP3 host after command [%s]', trim($command)));
+            throw new Swift_Plugins_Pop_Pop3Exception(sprintf('Failed to read from POP3 host after command [%s]', trim($command ?? '')));
         }
 
         $this->assertOk($response);
@@ -220,14 +220,14 @@ private function command($command)
     private function assertOk($response)
     {
         if ('+OK' != substr($response, 0, 3)) {
-            throw new Swift_Plugins_Pop_Pop3Exception(sprintf('POP3 command failed [%s]', trim($response)));
+            throw new Swift_Plugins_Pop_Pop3Exception(sprintf('POP3 command failed [%s]', trim($response ?? '')));
         }
     }
 
     private function getHostString()
     {
         $host = $this->host;
-        switch (strtolower($this->crypto)) {
+        switch (strtolower($this->crypto ?? '')) {
             case 'ssl':
                 $host = 'ssl://'.$host;
                 break;