Dolibarr / dolibarr

htdocs/includes/swiftmailer/lib/classes/Swift/Signers/DKIMSigner.php

Indentation +664 added lines, -664 removed lines

@@ -15,668 +15,668 @@
  */
 class Swift_Signers_DKIMSigner implements Swift_Signers_HeaderSigner
 {
-    /**
-     * PrivateKey.
-     *
-     * @var string
-     */
-    protected $privateKey;
-
-    /**
-     * DomainName.
-     *
-     * @var string
-     */
-    protected $domainName;
-
-    /**
-     * Selector.
-     *
-     * @var string
-     */
-    protected $selector;
-
-    private $passphrase = '';
-
-    /**
-     * Hash algorithm used.
-     *
-     * @see RFC6376 3.3: Signers MUST implement and SHOULD sign using rsa-sha256.
-     *
-     * @var string
-     */
-    protected $hashAlgorithm = 'rsa-sha256';
-
-    /**
-     * Body canon method.
-     *
-     * @var string
-     */
-    protected $bodyCanon = 'simple';
-
-    /**
-     * Header canon method.
-     *
-     * @var string
-     */
-    protected $headerCanon = 'simple';
-
-    /**
-     * Headers not being signed.
-     *
-     * @var array
-     */
-    protected $ignoredHeaders = ['return-path' => true];
-
-    /**
-     * Signer identity.
-     *
-     * @var string
-     */
-    protected $signerIdentity;
-
-    /**
-     * BodyLength.
-     *
-     * @var int
-     */
-    protected $bodyLen = 0;
-
-    /**
-     * Maximum signedLen.
-     *
-     * @var int
-     */
-    protected $maxLen = PHP_INT_MAX;
-
-    /**
-     * Embbed bodyLen in signature.
-     *
-     * @var bool
-     */
-    protected $showLen = false;
-
-    /**
-     * When the signature has been applied (true means time()), false means not embedded.
-     *
-     * @var mixed
-     */
-    protected $signatureTimestamp = true;
-
-    /**
-     * When will the signature expires false means not embedded, if sigTimestamp is auto
-     * Expiration is relative, otherwise it's absolute.
-     *
-     * @var int
-     */
-    protected $signatureExpiration = false;
-
-    /**
-     * Must we embed signed headers?
-     *
-     * @var bool
-     */
-    protected $debugHeaders = false;
-
-    // work variables
-    /**
-     * Headers used to generate hash.
-     *
-     * @var array
-     */
-    protected $signedHeaders = [];
-
-    /**
-     * If debugHeaders is set store debugData here.
-     *
-     * @var string[]
-     */
-    private $debugHeadersData = [];
-
-    /**
-     * Stores the bodyHash.
-     *
-     * @var string
-     */
-    private $bodyHash = '';
-
-    /**
-     * Stores the signature header.
-     *
-     * @var Swift_Mime_Headers_ParameterizedHeader
-     */
-    protected $dkimHeader;
-
-    private $bodyHashHandler;
-
-    private $headerHash;
-
-    private $headerCanonData = '';
-
-    private $bodyCanonEmptyCounter = 0;
-
-    private $bodyCanonIgnoreStart = 2;
-
-    private $bodyCanonSpace = false;
-
-    private $bodyCanonLastChar = null;
-
-    private $bodyCanonLine = '';
-
-    private $bound = [];
-
-    /**
-     * Constructor.
-     *
-     * @param string $privateKey
-     * @param string $domainName
-     * @param string $selector
-     * @param string $passphrase
-     */
-    public function __construct($privateKey, $domainName, $selector, $passphrase = '')
-    {
-        $this->privateKey = $privateKey;
-        $this->domainName = $domainName;
-        $this->signerIdentity = '@'.$domainName;
-        $this->selector = $selector;
-        $this->passphrase = $passphrase;
-    }
-
-    /**
-     * Reset the Signer.
-     *
-     * @see Swift_Signer::reset()
-     */
-    public function reset()
-    {
-        $this->headerHash = null;
-        $this->signedHeaders = [];
-        $this->bodyHash = null;
-        $this->bodyHashHandler = null;
-        $this->bodyCanonIgnoreStart = 2;
-        $this->bodyCanonEmptyCounter = 0;
-        $this->bodyCanonLastChar = null;
-        $this->bodyCanonSpace = false;
-    }
-
-    /**
-     * Writes $bytes to the end of the stream.
-     *
-     * Writing may not happen immediately if the stream chooses to buffer.  If
-     * you want to write these bytes with immediate effect, call {@link commit()}
-     * after calling write().
-     *
-     * This method returns the sequence ID of the write (i.e. 1 for first, 2 for
-     * second, etc etc).
-     *
-     * @param string $bytes
-     *
-     * @return int
-     *
-     * @throws Swift_IoException
-     */
-    // TODO fix return
-    public function write($bytes)
-    {
-        $this->canonicalizeBody($bytes);
-        foreach ($this->bound as $is) {
-            $is->write($bytes);
-        }
-    }
-
-    /**
-     * For any bytes that are currently buffered inside the stream, force them
-     * off the buffer.
-     */
-    public function commit()
-    {
-        // Nothing to do
-        return;
-    }
-
-    /**
-     * Attach $is to this stream.
-     *
-     * The stream acts as an observer, receiving all data that is written.
-     * All {@link write()} and {@link flushBuffers()} operations will be mirrored.
-     */
-    public function bind(Swift_InputByteStream $is)
-    {
-        // Don't have to mirror anything
-        $this->bound[] = $is;
-
-        return;
-    }
-
-    /**
-     * Remove an already bound stream.
-     *
-     * If $is is not bound, no errors will be raised.
-     * If the stream currently has any buffered data it will be written to $is
-     * before unbinding occurs.
-     */
-    public function unbind(Swift_InputByteStream $is)
-    {
-        // Don't have to mirror anything
-        foreach ($this->bound as $k => $stream) {
-            if ($stream === $is) {
-                unset($this->bound[$k]);
-
-                return;
-            }
-        }
-    }
-
-    /**
-     * Flush the contents of the stream (empty it) and set the internal pointer
-     * to the beginning.
-     *
-     * @throws Swift_IoException
-     */
-    public function flushBuffers()
-    {
-        $this->reset();
-    }
-
-    /**
-     * Set hash_algorithm, must be one of rsa-sha256 | rsa-sha1.
-     *
-     * @param string $hash 'rsa-sha1' or 'rsa-sha256'
-     *
-     * @throws Swift_SwiftException
-     *
-     * @return $this
-     */
-    public function setHashAlgorithm($hash)
-    {
-        switch ($hash) {
-            case 'rsa-sha1':
-                $this->hashAlgorithm = 'rsa-sha1';
-                break;
-            case 'rsa-sha256':
-                $this->hashAlgorithm = 'rsa-sha256';
-                if (!\defined('OPENSSL_ALGO_SHA256')) {
-                    throw new Swift_SwiftException('Unable to set sha256 as it is not supported by OpenSSL.');
-                }
-                break;
-            default:
-                throw new Swift_SwiftException('Unable to set the hash algorithm, must be one of rsa-sha1 or rsa-sha256 (%s given).', $hash);
-        }
-
-        return $this;
-    }
-
-    /**
-     * Set the body canonicalization algorithm.
-     *
-     * @param string $canon
-     *
-     * @return $this
-     */
-    public function setBodyCanon($canon)
-    {
-        if ('relaxed' == $canon) {
-            $this->bodyCanon = 'relaxed';
-        } else {
-            $this->bodyCanon = 'simple';
-        }
-
-        return $this;
-    }
-
-    /**
-     * Set the header canonicalization algorithm.
-     *
-     * @param string $canon
-     *
-     * @return $this
-     */
-    public function setHeaderCanon($canon)
-    {
-        if ('relaxed' == $canon) {
-            $this->headerCanon = 'relaxed';
-        } else {
-            $this->headerCanon = 'simple';
-        }
-
-        return $this;
-    }
-
-    /**
-     * Set the signer identity.
-     *
-     * @param string $identity
-     *
-     * @return $this
-     */
-    public function setSignerIdentity($identity)
-    {
-        $this->signerIdentity = $identity;
-
-        return $this;
-    }
-
-    /**
-     * Set the length of the body to sign.
-     *
-     * @param mixed $len (bool or int)
-     *
-     * @return $this
-     */
-    public function setBodySignedLen($len)
-    {
-        if (true === $len) {
-            $this->showLen = true;
-            $this->maxLen = PHP_INT_MAX;
-        } elseif (false === $len) {
-            $this->showLen = false;
-            $this->maxLen = PHP_INT_MAX;
-        } else {
-            $this->showLen = true;
-            $this->maxLen = (int) $len;
-        }
-
-        return $this;
-    }
-
-    /**
-     * Set the signature timestamp.
-     *
-     * @param int $time A timestamp
-     *
-     * @return $this
-     */
-    public function setSignatureTimestamp($time)
-    {
-        $this->signatureTimestamp = $time;
-
-        return $this;
-    }
-
-    /**
-     * Set the signature expiration timestamp.
-     *
-     * @param int $time A timestamp
-     *
-     * @return $this
-     */
-    public function setSignatureExpiration($time)
-    {
-        $this->signatureExpiration = $time;
-
-        return $this;
-    }
-
-    /**
-     * Enable / disable the DebugHeaders.
-     *
-     * @param bool $debug
-     *
-     * @return Swift_Signers_DKIMSigner
-     */
-    public function setDebugHeaders($debug)
-    {
-        $this->debugHeaders = (bool) $debug;
-
-        return $this;
-    }
-
-    /**
-     * Start Body.
-     */
-    public function startBody()
-    {
-        // Init
-        switch ($this->hashAlgorithm) {
-            case 'rsa-sha256':
-                $this->bodyHashHandler = hash_init('sha256');
-                break;
-            case 'rsa-sha1':
-                $this->bodyHashHandler = hash_init('sha1');
-                break;
-        }
-        $this->bodyCanonLine = '';
-    }
-
-    /**
-     * End Body.
-     */
-    public function endBody()
-    {
-        $this->endOfBody();
-    }
-
-    /**
-     * Returns the list of Headers Tampered by this plugin.
-     *
-     * @return array
-     */
-    public function getAlteredHeaders()
-    {
-        if ($this->debugHeaders) {
-            return ['DKIM-Signature', 'X-DebugHash'];
-        } else {
-            return ['DKIM-Signature'];
-        }
-    }
-
-    /**
-     * Adds an ignored Header.
-     *
-     * @param string $header_name
-     *
-     * @return Swift_Signers_DKIMSigner
-     */
-    public function ignoreHeader($header_name)
-    {
-        $this->ignoredHeaders[strtolower($header_name ?? '')] = true;
-
-        return $this;
-    }
-
-    /**
-     * Set the headers to sign.
-     *
-     * @return Swift_Signers_DKIMSigner
-     */
-    public function setHeaders(Swift_Mime_SimpleHeaderSet $headers)
-    {
-        $this->headerCanonData = '';
-        // Loop through Headers
-        $listHeaders = $headers->listAll();
-        foreach ($listHeaders as $hName) {
-            // Check if we need to ignore Header
-            if (!isset($this->ignoredHeaders[strtolower($hName ?? '')])) {
-                if ($headers->has($hName)) {
-                    $tmp = $headers->getAll($hName);
-                    foreach ($tmp as $header) {
-                        if ('' != $header->getFieldBody()) {
-                            $this->addHeader($header->toString());
-                            $this->signedHeaders[] = $header->getFieldName();
-                        }
-                    }
-                }
-            }
-        }
-
-        return $this;
-    }
-
-    /**
-     * Add the signature to the given Headers.
-     *
-     * @return Swift_Signers_DKIMSigner
-     */
-    public function addSignature(Swift_Mime_SimpleHeaderSet $headers)
-    {
-        // Prepare the DKIM-Signature
-        $params = ['v' => '1', 'a' => $this->hashAlgorithm, 'bh' => base64_encode($this->bodyHash ?? ''), 'd' => $this->domainName, 'h' => implode(': ', $this->signedHeaders), 'i' => $this->signerIdentity, 's' => $this->selector];
-        if ('simple' != $this->bodyCanon) {
-            $params['c'] = $this->headerCanon.'/'.$this->bodyCanon;
-        } elseif ('simple' != $this->headerCanon) {
-            $params['c'] = $this->headerCanon;
-        }
-        if ($this->showLen) {
-            $params['l'] = $this->bodyLen;
-        }
-        if (true === $this->signatureTimestamp) {
-            $params['t'] = time();
-            if (false !== $this->signatureExpiration) {
-                $params['x'] = $params['t'] + $this->signatureExpiration;
-            }
-        } else {
-            if (false !== $this->signatureTimestamp) {
-                $params['t'] = $this->signatureTimestamp;
-            }
-            if (false !== $this->signatureExpiration) {
-                $params['x'] = $this->signatureExpiration;
-            }
-        }
-        if ($this->debugHeaders) {
-            $params['z'] = implode('|', $this->debugHeadersData);
-        }
-        $string = '';
-        foreach ($params as $k => $v) {
-            $string .= $k.'='.$v.'; ';
-        }
-        $string = trim($string);
-        $headers->addTextHeader('DKIM-Signature', $string);
-        // Add the last DKIM-Signature
-        $tmp = $headers->getAll('DKIM-Signature');
-        $this->dkimHeader = end($tmp);
-        $this->addHeader(trim($this->dkimHeader->toString() ?? '')."\r\n b=", true);
-        if ($this->debugHeaders) {
-            $headers->addTextHeader('X-DebugHash', base64_encode($this->headerHash ?? ''));
-        }
-        $this->dkimHeader->setValue($string.' b='.trim(chunk_split(base64_encode($this->getEncryptedHash() ?? ''), 73, ' ')));
-
-        return $this;
-    }
-
-    /* Private helpers */
-
-    protected function addHeader($header, $is_sig = false)
-    {
-        switch ($this->headerCanon) {
-            case 'relaxed':
-                // Prepare Header and cascade
-                $exploded = explode(':', $header, 2);
-                $name = strtolower(trim($exploded[0]));
-                $value = str_replace("\r\n", '', $exploded[1]);
-                $value = preg_replace("/[ \t][ \t]+/", ' ', $value);
-                $header = $name.':'.trim($value).($is_sig ? '' : "\r\n");
-                // no break
-            case 'simple':
-                // Nothing to do
-        }
-        $this->addToHeaderHash($header);
-    }
-
-    protected function canonicalizeBody($string)
-    {
-        $len = \strlen($string);
-        $canon = '';
-        $method = ('relaxed' == $this->bodyCanon);
-        for ($i = 0; $i < $len; ++$i) {
-            if ($this->bodyCanonIgnoreStart > 0) {
-                --$this->bodyCanonIgnoreStart;
-                continue;
-            }
-            switch ($string[$i]) {
-                case "\r":
-                    $this->bodyCanonLastChar = "\r";
-                    break;
-                case "\n":
-                    if ("\r" == $this->bodyCanonLastChar) {
-                        if ($method) {
-                            $this->bodyCanonSpace = false;
-                        }
-                        if ('' == $this->bodyCanonLine) {
-                            ++$this->bodyCanonEmptyCounter;
-                        } else {
-                            $this->bodyCanonLine = '';
-                            $canon .= "\r\n";
-                        }
-                    } else {
-                        // Wooops Error
-                        // todo handle it but should never happen
-                    }
-                    break;
-                case ' ':
-                case "\t":
-                    if ($method) {
-                        $this->bodyCanonSpace = true;
-                        break;
-                    }
-                    // no break
-                default:
-                    if ($this->bodyCanonEmptyCounter > 0) {
-                        $canon .= str_repeat("\r\n", $this->bodyCanonEmptyCounter);
-                        $this->bodyCanonEmptyCounter = 0;
-                    }
-                    if ($this->bodyCanonSpace) {
-                        $this->bodyCanonLine .= ' ';
-                        $canon .= ' ';
-                        $this->bodyCanonSpace = false;
-                    }
-                    $this->bodyCanonLine .= $string[$i];
-                    $canon .= $string[$i];
-            }
-        }
-        $this->addToBodyHash($canon);
-    }
-
-    protected function endOfBody()
-    {
-        // Add trailing Line return if last line is non empty
-        if (\strlen($this->bodyCanonLine) > 0) {
-            $this->addToBodyHash("\r\n");
-        }
-        $this->bodyHash = hash_final($this->bodyHashHandler, true);
-    }
-
-    private function addToBodyHash($string)
-    {
-        $len = \strlen($string);
-        if ($len > ($new_len = ($this->maxLen - $this->bodyLen))) {
-            $string = substr($string, 0, $new_len);
-            $len = $new_len;
-        }
-        hash_update($this->bodyHashHandler, $string);
-        $this->bodyLen += $len;
-    }
-
-    private function addToHeaderHash($header)
-    {
-        if ($this->debugHeaders) {
-            $this->debugHeadersData[] = trim($header ?? '');
-        }
-        $this->headerCanonData .= $header;
-    }
-
-    /**
-     * @throws Swift_SwiftException
-     *
-     * @return string
-     */
-    private function getEncryptedHash()
-    {
-        $signature = '';
-        switch ($this->hashAlgorithm) {
-            case 'rsa-sha1':
-                $algorithm = OPENSSL_ALGO_SHA1;
-                break;
-            case 'rsa-sha256':
-                $algorithm = OPENSSL_ALGO_SHA256;
-                break;
-        }
-        $pkeyId = openssl_get_privatekey($this->privateKey, $this->passphrase);
-        if (!$pkeyId) {
-            throw new Swift_SwiftException('Unable to load DKIM Private Key ['.openssl_error_string().']');
-        }
-        if (openssl_sign($this->headerCanonData, $signature, $pkeyId, $algorithm)) {
-            return $signature;
-        }
-        throw new Swift_SwiftException('Unable to sign DKIM Hash ['.openssl_error_string().']');
-    }
+	/**
+	 * PrivateKey.
+	 *
+	 * @var string
+	 */
+	protected $privateKey;
+
+	/**
+	 * DomainName.
+	 *
+	 * @var string
+	 */
+	protected $domainName;
+
+	/**
+	 * Selector.
+	 *
+	 * @var string
+	 */
+	protected $selector;
+
+	private $passphrase = '';
+
+	/**
+	 * Hash algorithm used.
+	 *
+	 * @see RFC6376 3.3: Signers MUST implement and SHOULD sign using rsa-sha256.
+	 *
+	 * @var string
+	 */
+	protected $hashAlgorithm = 'rsa-sha256';
+
+	/**
+	 * Body canon method.
+	 *
+	 * @var string
+	 */
+	protected $bodyCanon = 'simple';
+
+	/**
+	 * Header canon method.
+	 *
+	 * @var string
+	 */
+	protected $headerCanon = 'simple';
+
+	/**
+	 * Headers not being signed.
+	 *
+	 * @var array
+	 */
+	protected $ignoredHeaders = ['return-path' => true];
+
+	/**
+	 * Signer identity.
+	 *
+	 * @var string
+	 */
+	protected $signerIdentity;
+
+	/**
+	 * BodyLength.
+	 *
+	 * @var int
+	 */
+	protected $bodyLen = 0;
+
+	/**
+	 * Maximum signedLen.
+	 *
+	 * @var int
+	 */
+	protected $maxLen = PHP_INT_MAX;
+
+	/**
+	 * Embbed bodyLen in signature.
+	 *
+	 * @var bool
+	 */
+	protected $showLen = false;
+
+	/**
+	 * When the signature has been applied (true means time()), false means not embedded.
+	 *
+	 * @var mixed
+	 */
+	protected $signatureTimestamp = true;
+
+	/**
+	 * When will the signature expires false means not embedded, if sigTimestamp is auto
+	 * Expiration is relative, otherwise it's absolute.
+	 *
+	 * @var int
+	 */
+	protected $signatureExpiration = false;
+
+	/**
+	 * Must we embed signed headers?
+	 *
+	 * @var bool
+	 */
+	protected $debugHeaders = false;
+
+	// work variables
+	/**
+	 * Headers used to generate hash.
+	 *
+	 * @var array
+	 */
+	protected $signedHeaders = [];
+
+	/**
+	 * If debugHeaders is set store debugData here.
+	 *
+	 * @var string[]
+	 */
+	private $debugHeadersData = [];
+
+	/**
+	 * Stores the bodyHash.
+	 *
+	 * @var string
+	 */
+	private $bodyHash = '';
+
+	/**
+	 * Stores the signature header.
+	 *
+	 * @var Swift_Mime_Headers_ParameterizedHeader
+	 */
+	protected $dkimHeader;
+
+	private $bodyHashHandler;
+
+	private $headerHash;
+
+	private $headerCanonData = '';
+
+	private $bodyCanonEmptyCounter = 0;
+
+	private $bodyCanonIgnoreStart = 2;
+
+	private $bodyCanonSpace = false;
+
+	private $bodyCanonLastChar = null;
+
+	private $bodyCanonLine = '';
+
+	private $bound = [];
+
+	/**
+	 * Constructor.
+	 *
+	 * @param string $privateKey
+	 * @param string $domainName
+	 * @param string $selector
+	 * @param string $passphrase
+	 */
+	public function __construct($privateKey, $domainName, $selector, $passphrase = '')
+	{
+		$this->privateKey = $privateKey;
+		$this->domainName = $domainName;
+		$this->signerIdentity = '@'.$domainName;
+		$this->selector = $selector;
+		$this->passphrase = $passphrase;
+	}
+
+	/**
+	 * Reset the Signer.
+	 *
+	 * @see Swift_Signer::reset()
+	 */
+	public function reset()
+	{
+		$this->headerHash = null;
+		$this->signedHeaders = [];
+		$this->bodyHash = null;
+		$this->bodyHashHandler = null;
+		$this->bodyCanonIgnoreStart = 2;
+		$this->bodyCanonEmptyCounter = 0;
+		$this->bodyCanonLastChar = null;
+		$this->bodyCanonSpace = false;
+	}
+
+	/**
+	 * Writes $bytes to the end of the stream.
+	 *
+	 * Writing may not happen immediately if the stream chooses to buffer.  If
+	 * you want to write these bytes with immediate effect, call {@link commit()}
+	 * after calling write().
+	 *
+	 * This method returns the sequence ID of the write (i.e. 1 for first, 2 for
+	 * second, etc etc).
+	 *
+	 * @param string $bytes
+	 *
+	 * @return int
+	 *
+	 * @throws Swift_IoException
+	 */
+	// TODO fix return
+	public function write($bytes)
+	{
+		$this->canonicalizeBody($bytes);
+		foreach ($this->bound as $is) {
+			$is->write($bytes);
+		}
+	}
+
+	/**
+	 * For any bytes that are currently buffered inside the stream, force them
+	 * off the buffer.
+	 */
+	public function commit()
+	{
+		// Nothing to do
+		return;
+	}
+
+	/**
+	 * Attach $is to this stream.
+	 *
+	 * The stream acts as an observer, receiving all data that is written.
+	 * All {@link write()} and {@link flushBuffers()} operations will be mirrored.
+	 */
+	public function bind(Swift_InputByteStream $is)
+	{
+		// Don't have to mirror anything
+		$this->bound[] = $is;
+
+		return;
+	}
+
+	/**
+	 * Remove an already bound stream.
+	 *
+	 * If $is is not bound, no errors will be raised.
+	 * If the stream currently has any buffered data it will be written to $is
+	 * before unbinding occurs.
+	 */
+	public function unbind(Swift_InputByteStream $is)
+	{
+		// Don't have to mirror anything
+		foreach ($this->bound as $k => $stream) {
+			if ($stream === $is) {
+				unset($this->bound[$k]);
+
+				return;
+			}
+		}
+	}
+
+	/**
+	 * Flush the contents of the stream (empty it) and set the internal pointer
+	 * to the beginning.
+	 *
+	 * @throws Swift_IoException
+	 */
+	public function flushBuffers()
+	{
+		$this->reset();
+	}
+
+	/**
+	 * Set hash_algorithm, must be one of rsa-sha256 | rsa-sha1.
+	 *
+	 * @param string $hash 'rsa-sha1' or 'rsa-sha256'
+	 *
+	 * @throws Swift_SwiftException
+	 *
+	 * @return $this
+	 */
+	public function setHashAlgorithm($hash)
+	{
+		switch ($hash) {
+			case 'rsa-sha1':
+				$this->hashAlgorithm = 'rsa-sha1';
+				break;
+			case 'rsa-sha256':
+				$this->hashAlgorithm = 'rsa-sha256';
+				if (!\defined('OPENSSL_ALGO_SHA256')) {
+					throw new Swift_SwiftException('Unable to set sha256 as it is not supported by OpenSSL.');
+				}
+				break;
+			default:
+				throw new Swift_SwiftException('Unable to set the hash algorithm, must be one of rsa-sha1 or rsa-sha256 (%s given).', $hash);
+		}
+
+		return $this;
+	}
+
+	/**
+	 * Set the body canonicalization algorithm.
+	 *
+	 * @param string $canon
+	 *
+	 * @return $this
+	 */
+	public function setBodyCanon($canon)
+	{
+		if ('relaxed' == $canon) {
+			$this->bodyCanon = 'relaxed';
+		} else {
+			$this->bodyCanon = 'simple';
+		}
+
+		return $this;
+	}
+
+	/**
+	 * Set the header canonicalization algorithm.
+	 *
+	 * @param string $canon
+	 *
+	 * @return $this
+	 */
+	public function setHeaderCanon($canon)
+	{
+		if ('relaxed' == $canon) {
+			$this->headerCanon = 'relaxed';
+		} else {
+			$this->headerCanon = 'simple';
+		}
+
+		return $this;
+	}
+
+	/**
+	 * Set the signer identity.
+	 *
+	 * @param string $identity
+	 *
+	 * @return $this
+	 */
+	public function setSignerIdentity($identity)
+	{
+		$this->signerIdentity = $identity;
+
+		return $this;
+	}
+
+	/**
+	 * Set the length of the body to sign.
+	 *
+	 * @param mixed $len (bool or int)
+	 *
+	 * @return $this
+	 */
+	public function setBodySignedLen($len)
+	{
+		if (true === $len) {
+			$this->showLen = true;
+			$this->maxLen = PHP_INT_MAX;
+		} elseif (false === $len) {
+			$this->showLen = false;
+			$this->maxLen = PHP_INT_MAX;
+		} else {
+			$this->showLen = true;
+			$this->maxLen = (int) $len;
+		}
+
+		return $this;
+	}
+
+	/**
+	 * Set the signature timestamp.
+	 *
+	 * @param int $time A timestamp
+	 *
+	 * @return $this
+	 */
+	public function setSignatureTimestamp($time)
+	{
+		$this->signatureTimestamp = $time;
+
+		return $this;
+	}
+
+	/**
+	 * Set the signature expiration timestamp.
+	 *
+	 * @param int $time A timestamp
+	 *
+	 * @return $this
+	 */
+	public function setSignatureExpiration($time)
+	{
+		$this->signatureExpiration = $time;
+
+		return $this;
+	}
+
+	/**
+	 * Enable / disable the DebugHeaders.
+	 *
+	 * @param bool $debug
+	 *
+	 * @return Swift_Signers_DKIMSigner
+	 */
+	public function setDebugHeaders($debug)
+	{
+		$this->debugHeaders = (bool) $debug;
+
+		return $this;
+	}
+
+	/**
+	 * Start Body.
+	 */
+	public function startBody()
+	{
+		// Init
+		switch ($this->hashAlgorithm) {
+			case 'rsa-sha256':
+				$this->bodyHashHandler = hash_init('sha256');
+				break;
+			case 'rsa-sha1':
+				$this->bodyHashHandler = hash_init('sha1');
+				break;
+		}
+		$this->bodyCanonLine = '';
+	}
+
+	/**
+	 * End Body.
+	 */
+	public function endBody()
+	{
+		$this->endOfBody();
+	}
+
+	/**
+	 * Returns the list of Headers Tampered by this plugin.
+	 *
+	 * @return array
+	 */
+	public function getAlteredHeaders()
+	{
+		if ($this->debugHeaders) {
+			return ['DKIM-Signature', 'X-DebugHash'];
+		} else {
+			return ['DKIM-Signature'];
+		}
+	}
+
+	/**
+	 * Adds an ignored Header.
+	 *
+	 * @param string $header_name
+	 *
+	 * @return Swift_Signers_DKIMSigner
+	 */
+	public function ignoreHeader($header_name)
+	{
+		$this->ignoredHeaders[strtolower($header_name ?? '')] = true;
+
+		return $this;
+	}
+
+	/**
+	 * Set the headers to sign.
+	 *
+	 * @return Swift_Signers_DKIMSigner
+	 */
+	public function setHeaders(Swift_Mime_SimpleHeaderSet $headers)
+	{
+		$this->headerCanonData = '';
+		// Loop through Headers
+		$listHeaders = $headers->listAll();
+		foreach ($listHeaders as $hName) {
+			// Check if we need to ignore Header
+			if (!isset($this->ignoredHeaders[strtolower($hName ?? '')])) {
+				if ($headers->has($hName)) {
+					$tmp = $headers->getAll($hName);
+					foreach ($tmp as $header) {
+						if ('' != $header->getFieldBody()) {
+							$this->addHeader($header->toString());
+							$this->signedHeaders[] = $header->getFieldName();
+						}
+					}
+				}
+			}
+		}
+
+		return $this;
+	}
+
+	/**
+	 * Add the signature to the given Headers.
+	 *
+	 * @return Swift_Signers_DKIMSigner
+	 */
+	public function addSignature(Swift_Mime_SimpleHeaderSet $headers)
+	{
+		// Prepare the DKIM-Signature
+		$params = ['v' => '1', 'a' => $this->hashAlgorithm, 'bh' => base64_encode($this->bodyHash ?? ''), 'd' => $this->domainName, 'h' => implode(': ', $this->signedHeaders), 'i' => $this->signerIdentity, 's' => $this->selector];
+		if ('simple' != $this->bodyCanon) {
+			$params['c'] = $this->headerCanon.'/'.$this->bodyCanon;
+		} elseif ('simple' != $this->headerCanon) {
+			$params['c'] = $this->headerCanon;
+		}
+		if ($this->showLen) {
+			$params['l'] = $this->bodyLen;
+		}
+		if (true === $this->signatureTimestamp) {
+			$params['t'] = time();
+			if (false !== $this->signatureExpiration) {
+				$params['x'] = $params['t'] + $this->signatureExpiration;
+			}
+		} else {
+			if (false !== $this->signatureTimestamp) {
+				$params['t'] = $this->signatureTimestamp;
+			}
+			if (false !== $this->signatureExpiration) {
+				$params['x'] = $this->signatureExpiration;
+			}
+		}
+		if ($this->debugHeaders) {
+			$params['z'] = implode('|', $this->debugHeadersData);
+		}
+		$string = '';
+		foreach ($params as $k => $v) {
+			$string .= $k.'='.$v.'; ';
+		}
+		$string = trim($string);
+		$headers->addTextHeader('DKIM-Signature', $string);
+		// Add the last DKIM-Signature
+		$tmp = $headers->getAll('DKIM-Signature');
+		$this->dkimHeader = end($tmp);
+		$this->addHeader(trim($this->dkimHeader->toString() ?? '')."\r\n b=", true);
+		if ($this->debugHeaders) {
+			$headers->addTextHeader('X-DebugHash', base64_encode($this->headerHash ?? ''));
+		}
+		$this->dkimHeader->setValue($string.' b='.trim(chunk_split(base64_encode($this->getEncryptedHash() ?? ''), 73, ' ')));
+
+		return $this;
+	}
+
+	/* Private helpers */
+
+	protected function addHeader($header, $is_sig = false)
+	{
+		switch ($this->headerCanon) {
+			case 'relaxed':
+				// Prepare Header and cascade
+				$exploded = explode(':', $header, 2);
+				$name = strtolower(trim($exploded[0]));
+				$value = str_replace("\r\n", '', $exploded[1]);
+				$value = preg_replace("/[ \t][ \t]+/", ' ', $value);
+				$header = $name.':'.trim($value).($is_sig ? '' : "\r\n");
+				// no break
+			case 'simple':
+				// Nothing to do
+		}
+		$this->addToHeaderHash($header);
+	}
+
+	protected function canonicalizeBody($string)
+	{
+		$len = \strlen($string);
+		$canon = '';
+		$method = ('relaxed' == $this->bodyCanon);
+		for ($i = 0; $i < $len; ++$i) {
+			if ($this->bodyCanonIgnoreStart > 0) {
+				--$this->bodyCanonIgnoreStart;
+				continue;
+			}
+			switch ($string[$i]) {
+				case "\r":
+					$this->bodyCanonLastChar = "\r";
+					break;
+				case "\n":
+					if ("\r" == $this->bodyCanonLastChar) {
+						if ($method) {
+							$this->bodyCanonSpace = false;
+						}
+						if ('' == $this->bodyCanonLine) {
+							++$this->bodyCanonEmptyCounter;
+						} else {
+							$this->bodyCanonLine = '';
+							$canon .= "\r\n";
+						}
+					} else {
+						// Wooops Error
+						// todo handle it but should never happen
+					}
+					break;
+				case ' ':
+				case "\t":
+					if ($method) {
+						$this->bodyCanonSpace = true;
+						break;
+					}
+					// no break
+				default:
+					if ($this->bodyCanonEmptyCounter > 0) {
+						$canon .= str_repeat("\r\n", $this->bodyCanonEmptyCounter);
+						$this->bodyCanonEmptyCounter = 0;
+					}
+					if ($this->bodyCanonSpace) {
+						$this->bodyCanonLine .= ' ';
+						$canon .= ' ';
+						$this->bodyCanonSpace = false;
+					}
+					$this->bodyCanonLine .= $string[$i];
+					$canon .= $string[$i];
+			}
+		}
+		$this->addToBodyHash($canon);
+	}
+
+	protected function endOfBody()
+	{
+		// Add trailing Line return if last line is non empty
+		if (\strlen($this->bodyCanonLine) > 0) {
+			$this->addToBodyHash("\r\n");
+		}
+		$this->bodyHash = hash_final($this->bodyHashHandler, true);
+	}
+
+	private function addToBodyHash($string)
+	{
+		$len = \strlen($string);
+		if ($len > ($new_len = ($this->maxLen - $this->bodyLen))) {
+			$string = substr($string, 0, $new_len);
+			$len = $new_len;
+		}
+		hash_update($this->bodyHashHandler, $string);
+		$this->bodyLen += $len;
+	}
+
+	private function addToHeaderHash($header)
+	{
+		if ($this->debugHeaders) {
+			$this->debugHeadersData[] = trim($header ?? '');
+		}
+		$this->headerCanonData .= $header;
+	}
+
+	/**
+	 * @throws Swift_SwiftException
+	 *
+	 * @return string
+	 */
+	private function getEncryptedHash()
+	{
+		$signature = '';
+		switch ($this->hashAlgorithm) {
+			case 'rsa-sha1':
+				$algorithm = OPENSSL_ALGO_SHA1;
+				break;
+			case 'rsa-sha256':
+				$algorithm = OPENSSL_ALGO_SHA256;
+				break;
+		}
+		$pkeyId = openssl_get_privatekey($this->privateKey, $this->passphrase);
+		if (!$pkeyId) {
+			throw new Swift_SwiftException('Unable to load DKIM Private Key ['.openssl_error_string().']');
+		}
+		if (openssl_sign($this->headerCanonData, $signature, $pkeyId, $algorithm)) {
+			return $signature;
+		}
+		throw new Swift_SwiftException('Unable to sign DKIM Hash ['.openssl_error_string().']');
+	}
 }

htdocs/includes/swiftmailer/lib/classes/Swift/Signers/OpenDKIMSigner.php

Indentation +162 added lines, -162 removed lines

@@ -18,166 +18,166 @@
  */
 class Swift_Signers_OpenDKIMSigner extends Swift_Signers_DKIMSigner
 {
-    private $peclLoaded = false;
-
-    private $dkimHandler = null;
-
-    private $dropFirstLF = true;
-
-    const CANON_RELAXED = 1;
-    const CANON_SIMPLE = 2;
-    const SIG_RSA_SHA1 = 3;
-    const SIG_RSA_SHA256 = 4;
-
-    public function __construct($privateKey, $domainName, $selector)
-    {
-        if (!\extension_loaded('opendkim')) {
-            throw new Swift_SwiftException('php-opendkim extension not found');
-        }
-
-        $this->peclLoaded = true;
-
-        parent::__construct($privateKey, $domainName, $selector);
-    }
-
-    public function addSignature(Swift_Mime_SimpleHeaderSet $headers)
-    {
-        $header = new Swift_Mime_Headers_OpenDKIMHeader('DKIM-Signature');
-        $headerVal = $this->dkimHandler->getSignatureHeader();
-        if (false === $headerVal || \is_int($headerVal)) {
-            throw new Swift_SwiftException('OpenDKIM Error: '.$this->dkimHandler->getError());
-        }
-        $header->setValue($headerVal);
-        $headers->set($header);
-
-        return $this;
-    }
-
-    public function setHeaders(Swift_Mime_SimpleHeaderSet $headers)
-    {
-        $hash = 'rsa-sha1' == $this->hashAlgorithm ? OpenDKIMSign::ALG_RSASHA1 : OpenDKIMSign::ALG_RSASHA256;
-        $bodyCanon = 'simple' == $this->bodyCanon ? OpenDKIMSign::CANON_SIMPLE : OpenDKIMSign::CANON_RELAXED;
-        $headerCanon = 'simple' == $this->headerCanon ? OpenDKIMSign::CANON_SIMPLE : OpenDKIMSign::CANON_RELAXED;
-        $this->dkimHandler = new OpenDKIMSign($this->privateKey, $this->selector, $this->domainName, $headerCanon, $bodyCanon, $hash, -1);
-        // Hardcode signature Margin for now
-        $this->dkimHandler->setMargin(78);
-
-        if (!is_numeric($this->signatureTimestamp)) {
-            OpenDKIM::setOption(OpenDKIM::OPTS_FIXEDTIME, time());
-        } else {
-            if (!OpenDKIM::setOption(OpenDKIM::OPTS_FIXEDTIME, $this->signatureTimestamp)) {
-                throw new Swift_SwiftException('Unable to force signature timestamp ['.openssl_error_string().']');
-            }
-        }
-        if (isset($this->signerIdentity)) {
-            $this->dkimHandler->setSigner($this->signerIdentity);
-        }
-        $listHeaders = $headers->listAll();
-        foreach ($listHeaders as $hName) {
-            // Check if we need to ignore Header
-            if (!isset($this->ignoredHeaders[strtolower($hName ?? '')])) {
-                $tmp = $headers->getAll($hName);
-                if ($headers->has($hName)) {
-                    foreach ($tmp as $header) {
-                        if ('' != $header->getFieldBody()) {
-                            $htosign = $header->toString();
-                            $this->dkimHandler->header($htosign);
-                            $this->signedHeaders[] = $header->getFieldName();
-                        }
-                    }
-                }
-            }
-        }
-
-        return $this;
-    }
-
-    public function startBody()
-    {
-        if (!$this->peclLoaded) {
-            return parent::startBody();
-        }
-        $this->dropFirstLF = true;
-        $this->dkimHandler->eoh();
-
-        return $this;
-    }
-
-    public function endBody()
-    {
-        if (!$this->peclLoaded) {
-            return parent::endBody();
-        }
-        $this->dkimHandler->eom();
-
-        return $this;
-    }
-
-    public function reset()
-    {
-        $this->dkimHandler = null;
-        parent::reset();
-
-        return $this;
-    }
-
-    /**
-     * Set the signature timestamp.
-     *
-     * @param int $time
-     *
-     * @return $this
-     */
-    public function setSignatureTimestamp($time)
-    {
-        $this->signatureTimestamp = $time;
-
-        return $this;
-    }
-
-    /**
-     * Set the signature expiration timestamp.
-     *
-     * @param int $time
-     *
-     * @return $this
-     */
-    public function setSignatureExpiration($time)
-    {
-        $this->signatureExpiration = $time;
-
-        return $this;
-    }
-
-    /**
-     * Enable / disable the DebugHeaders.
-     *
-     * @param bool $debug
-     *
-     * @return $this
-     */
-    public function setDebugHeaders($debug)
-    {
-        $this->debugHeaders = (bool) $debug;
-
-        return $this;
-    }
-
-    // Protected
-
-    protected function canonicalizeBody($string)
-    {
-        if (!$this->peclLoaded) {
-            return parent::canonicalizeBody($string);
-        }
-        if (true === $this->dropFirstLF) {
-            if ("\r" == $string[0] && "\n" == $string[1]) {
-                $string = substr($string, 2);
-            }
-        }
-        $this->dropFirstLF = false;
-        if (\strlen($string)) {
-            $this->dkimHandler->body($string);
-        }
-    }
+	private $peclLoaded = false;
+
+	private $dkimHandler = null;
+
+	private $dropFirstLF = true;
+
+	const CANON_RELAXED = 1;
+	const CANON_SIMPLE = 2;
+	const SIG_RSA_SHA1 = 3;
+	const SIG_RSA_SHA256 = 4;
+
+	public function __construct($privateKey, $domainName, $selector)
+	{
+		if (!\extension_loaded('opendkim')) {
+			throw new Swift_SwiftException('php-opendkim extension not found');
+		}
+
+		$this->peclLoaded = true;
+
+		parent::__construct($privateKey, $domainName, $selector);
+	}
+
+	public function addSignature(Swift_Mime_SimpleHeaderSet $headers)
+	{
+		$header = new Swift_Mime_Headers_OpenDKIMHeader('DKIM-Signature');
+		$headerVal = $this->dkimHandler->getSignatureHeader();
+		if (false === $headerVal || \is_int($headerVal)) {
+			throw new Swift_SwiftException('OpenDKIM Error: '.$this->dkimHandler->getError());
+		}
+		$header->setValue($headerVal);
+		$headers->set($header);
+
+		return $this;
+	}
+
+	public function setHeaders(Swift_Mime_SimpleHeaderSet $headers)
+	{
+		$hash = 'rsa-sha1' == $this->hashAlgorithm ? OpenDKIMSign::ALG_RSASHA1 : OpenDKIMSign::ALG_RSASHA256;
+		$bodyCanon = 'simple' == $this->bodyCanon ? OpenDKIMSign::CANON_SIMPLE : OpenDKIMSign::CANON_RELAXED;
+		$headerCanon = 'simple' == $this->headerCanon ? OpenDKIMSign::CANON_SIMPLE : OpenDKIMSign::CANON_RELAXED;
+		$this->dkimHandler = new OpenDKIMSign($this->privateKey, $this->selector, $this->domainName, $headerCanon, $bodyCanon, $hash, -1);
+		// Hardcode signature Margin for now
+		$this->dkimHandler->setMargin(78);
+
+		if (!is_numeric($this->signatureTimestamp)) {
+			OpenDKIM::setOption(OpenDKIM::OPTS_FIXEDTIME, time());
+		} else {
+			if (!OpenDKIM::setOption(OpenDKIM::OPTS_FIXEDTIME, $this->signatureTimestamp)) {
+				throw new Swift_SwiftException('Unable to force signature timestamp ['.openssl_error_string().']');
+			}
+		}
+		if (isset($this->signerIdentity)) {
+			$this->dkimHandler->setSigner($this->signerIdentity);
+		}
+		$listHeaders = $headers->listAll();
+		foreach ($listHeaders as $hName) {
+			// Check if we need to ignore Header
+			if (!isset($this->ignoredHeaders[strtolower($hName ?? '')])) {
+				$tmp = $headers->getAll($hName);
+				if ($headers->has($hName)) {
+					foreach ($tmp as $header) {
+						if ('' != $header->getFieldBody()) {
+							$htosign = $header->toString();
+							$this->dkimHandler->header($htosign);
+							$this->signedHeaders[] = $header->getFieldName();
+						}
+					}
+				}
+			}
+		}
+
+		return $this;
+	}
+
+	public function startBody()
+	{
+		if (!$this->peclLoaded) {
+			return parent::startBody();
+		}
+		$this->dropFirstLF = true;
+		$this->dkimHandler->eoh();
+
+		return $this;
+	}
+
+	public function endBody()
+	{
+		if (!$this->peclLoaded) {
+			return parent::endBody();
+		}
+		$this->dkimHandler->eom();
+
+		return $this;
+	}
+
+	public function reset()
+	{
+		$this->dkimHandler = null;
+		parent::reset();
+
+		return $this;
+	}
+
+	/**
+	 * Set the signature timestamp.
+	 *
+	 * @param int $time
+	 *
+	 * @return $this
+	 */
+	public function setSignatureTimestamp($time)
+	{
+		$this->signatureTimestamp = $time;
+
+		return $this;
+	}
+
+	/**
+	 * Set the signature expiration timestamp.
+	 *
+	 * @param int $time
+	 *
+	 * @return $this
+	 */
+	public function setSignatureExpiration($time)
+	{
+		$this->signatureExpiration = $time;
+
+		return $this;
+	}
+
+	/**
+	 * Enable / disable the DebugHeaders.
+	 *
+	 * @param bool $debug
+	 *
+	 * @return $this
+	 */
+	public function setDebugHeaders($debug)
+	{
+		$this->debugHeaders = (bool) $debug;
+
+		return $this;
+	}
+
+	// Protected
+
+	protected function canonicalizeBody($string)
+	{
+		if (!$this->peclLoaded) {
+			return parent::canonicalizeBody($string);
+		}
+		if (true === $this->dropFirstLF) {
+			if ("\r" == $string[0] && "\n" == $string[1]) {
+				$string = substr($string, 2);
+			}
+		}
+		$this->dropFirstLF = false;
+		if (\strlen($string)) {
+			$this->dkimHandler->body($string);
+		}
+	}
 }

htdocs/includes/swiftmailer/lib/classes/Swift/Signers/DomainKeySigner.php

Indentation +486 added lines, -486 removed lines

@@ -15,490 +15,490 @@
  */
 class Swift_Signers_DomainKeySigner implements Swift_Signers_HeaderSigner
 {
-    /**
-     * PrivateKey.
-     *
-     * @var string
-     */
-    protected $privateKey;
-
-    /**
-     * DomainName.
-     *
-     * @var string
-     */
-    protected $domainName;
-
-    /**
-     * Selector.
-     *
-     * @var string
-     */
-    protected $selector;
-
-    /**
-     * Hash algorithm used.
-     *
-     * @var string
-     */
-    protected $hashAlgorithm = 'rsa-sha1';
-
-    /**
-     * Canonisation method.
-     *
-     * @var string
-     */
-    protected $canon = 'simple';
-
-    /**
-     * Headers not being signed.
-     *
-     * @var array
-     */
-    protected $ignoredHeaders = [];
-
-    /**
-     * Signer identity.
-     *
-     * @var string
-     */
-    protected $signerIdentity;
-
-    /**
-     * Must we embed signed headers?
-     *
-     * @var bool
-     */
-    protected $debugHeaders = false;
-
-    // work variables
-    /**
-     * Headers used to generate hash.
-     *
-     * @var array
-     */
-    private $signedHeaders = [];
-
-    /**
-     * Stores the signature header.
-     *
-     * @var Swift_Mime_Headers_ParameterizedHeader
-     */
-    protected $domainKeyHeader;
-
-    /**
-     * Hash Handler.
-     *
-     * @var resource|null
-     */
-    private $hashHandler;
-
-    private $canonData = '';
-
-    private $bodyCanonEmptyCounter = 0;
-
-    private $bodyCanonIgnoreStart = 2;
-
-    private $bodyCanonSpace = false;
-
-    private $bodyCanonLastChar = null;
-
-    private $bodyCanonLine = '';
-
-    private $bound = [];
-
-    /**
-     * Constructor.
-     *
-     * @param string $privateKey
-     * @param string $domainName
-     * @param string $selector
-     */
-    public function __construct($privateKey, $domainName, $selector)
-    {
-        $this->privateKey = $privateKey;
-        $this->domainName = $domainName;
-        $this->signerIdentity = '@'.$domainName;
-        $this->selector = $selector;
-    }
-
-    /**
-     * Resets internal states.
-     *
-     * @return $this
-     */
-    public function reset()
-    {
-        $this->hashHandler = null;
-        $this->bodyCanonIgnoreStart = 2;
-        $this->bodyCanonEmptyCounter = 0;
-        $this->bodyCanonLastChar = null;
-        $this->bodyCanonSpace = false;
-
-        return $this;
-    }
-
-    /**
-     * Writes $bytes to the end of the stream.
-     *
-     * Writing may not happen immediately if the stream chooses to buffer.  If
-     * you want to write these bytes with immediate effect, call {@link commit()}
-     * after calling write().
-     *
-     * This method returns the sequence ID of the write (i.e. 1 for first, 2 for
-     * second, etc etc).
-     *
-     * @param string $bytes
-     *
-     * @return int
-     *
-     * @throws Swift_IoException
-     *
-     * @return $this
-     */
-    public function write($bytes)
-    {
-        $this->canonicalizeBody($bytes);
-        foreach ($this->bound as $is) {
-            $is->write($bytes);
-        }
-
-        return $this;
-    }
-
-    /**
-     * For any bytes that are currently buffered inside the stream, force them
-     * off the buffer.
-     *
-     * @throws Swift_IoException
-     *
-     * @return $this
-     */
-    public function commit()
-    {
-        // Nothing to do
-        return $this;
-    }
-
-    /**
-     * Attach $is to this stream.
-     *
-     * The stream acts as an observer, receiving all data that is written.
-     * All {@link write()} and {@link flushBuffers()} operations will be mirrored.
-     *
-     * @return $this
-     */
-    public function bind(Swift_InputByteStream $is)
-    {
-        // Don't have to mirror anything
-        $this->bound[] = $is;
-
-        return $this;
-    }
-
-    /**
-     * Remove an already bound stream.
-     *
-     * If $is is not bound, no errors will be raised.
-     * If the stream currently has any buffered data it will be written to $is
-     * before unbinding occurs.
-     *
-     * @return $this
-     */
-    public function unbind(Swift_InputByteStream $is)
-    {
-        // Don't have to mirror anything
-        foreach ($this->bound as $k => $stream) {
-            if ($stream === $is) {
-                unset($this->bound[$k]);
-
-                break;
-            }
-        }
-
-        return $this;
-    }
-
-    /**
-     * Flush the contents of the stream (empty it) and set the internal pointer
-     * to the beginning.
-     *
-     * @throws Swift_IoException
-     *
-     * @return $this
-     */
-    public function flushBuffers()
-    {
-        $this->reset();
-
-        return $this;
-    }
-
-    /**
-     * Set hash_algorithm, must be one of rsa-sha256 | rsa-sha1 defaults to rsa-sha256.
-     *
-     * @param string $hash
-     *
-     * @return $this
-     */
-    public function setHashAlgorithm($hash)
-    {
-        $this->hashAlgorithm = 'rsa-sha1';
-
-        return $this;
-    }
-
-    /**
-     * Set the canonicalization algorithm.
-     *
-     * @param string $canon simple | nofws defaults to simple
-     *
-     * @return $this
-     */
-    public function setCanon($canon)
-    {
-        if ('nofws' == $canon) {
-            $this->canon = 'nofws';
-        } else {
-            $this->canon = 'simple';
-        }
-
-        return $this;
-    }
-
-    /**
-     * Set the signer identity.
-     *
-     * @param string $identity
-     *
-     * @return $this
-     */
-    public function setSignerIdentity($identity)
-    {
-        $this->signerIdentity = $identity;
-
-        return $this;
-    }
-
-    /**
-     * Enable / disable the DebugHeaders.
-     *
-     * @param bool $debug
-     *
-     * @return $this
-     */
-    public function setDebugHeaders($debug)
-    {
-        $this->debugHeaders = (bool) $debug;
-
-        return $this;
-    }
-
-    /**
-     * Start Body.
-     */
-    public function startBody()
-    {
-    }
-
-    /**
-     * End Body.
-     */
-    public function endBody()
-    {
-        $this->endOfBody();
-    }
-
-    /**
-     * Returns the list of Headers Tampered by this plugin.
-     *
-     * @return array
-     */
-    public function getAlteredHeaders()
-    {
-        if ($this->debugHeaders) {
-            return ['DomainKey-Signature', 'X-DebugHash'];
-        }
-
-        return ['DomainKey-Signature'];
-    }
-
-    /**
-     * Adds an ignored Header.
-     *
-     * @param string $header_name
-     *
-     * @return $this
-     */
-    public function ignoreHeader($header_name)
-    {
-        $this->ignoredHeaders[strtolower($header_name ?? '')] = true;
-
-        return $this;
-    }
-
-    /**
-     * Set the headers to sign.
-     *
-     * @return $this
-     */
-    public function setHeaders(Swift_Mime_SimpleHeaderSet $headers)
-    {
-        $this->startHash();
-        $this->canonData = '';
-        // Loop through Headers
-        $listHeaders = $headers->listAll();
-        foreach ($listHeaders as $hName) {
-            // Check if we need to ignore Header
-            if (!isset($this->ignoredHeaders[strtolower($hName ?? '')])) {
-                if ($headers->has($hName)) {
-                    $tmp = $headers->getAll($hName);
-                    foreach ($tmp as $header) {
-                        if ('' != $header->getFieldBody()) {
-                            $this->addHeader($header->toString());
-                            $this->signedHeaders[] = $header->getFieldName();
-                        }
-                    }
-                }
-            }
-        }
-        $this->endOfHeaders();
-
-        return $this;
-    }
-
-    /**
-     * Add the signature to the given Headers.
-     *
-     * @return $this
-     */
-    public function addSignature(Swift_Mime_SimpleHeaderSet $headers)
-    {
-        // Prepare the DomainKey-Signature Header
-        $params = ['a' => $this->hashAlgorithm, 'b' => chunk_split(base64_encode($this->getEncryptedHash() ?? ''), 73, ' '), 'c' => $this->canon, 'd' => $this->domainName, 'h' => implode(': ', $this->signedHeaders), 'q' => 'dns', 's' => $this->selector];
-        $string = '';
-        foreach ($params as $k => $v) {
-            $string .= $k.'='.$v.'; ';
-        }
-        $string = trim($string);
-        $headers->addTextHeader('DomainKey-Signature', $string);
-
-        return $this;
-    }
-
-    /* Private helpers */
-
-    protected function addHeader($header)
-    {
-        switch ($this->canon) {
-            case 'nofws':
-                // Prepare Header and cascade
-                $exploded = explode(':', $header, 2);
-                $name = strtolower(trim($exploded[0]));
-                $value = str_replace("\r\n", '', $exploded[1]);
-                $value = preg_replace("/[ \t][ \t]+/", ' ', $value);
-                $header = $name.':'.trim($value)."\r\n";
-                // no break
-            case 'simple':
-                // Nothing to do
-        }
-        $this->addToHash($header);
-    }
-
-    protected function endOfHeaders()
-    {
-        $this->bodyCanonEmptyCounter = 1;
-    }
-
-    protected function canonicalizeBody($string)
-    {
-        $len = \strlen($string);
-        $canon = '';
-        $nofws = ('nofws' == $this->canon);
-        for ($i = 0; $i < $len; ++$i) {
-            if ($this->bodyCanonIgnoreStart > 0) {
-                --$this->bodyCanonIgnoreStart;
-                continue;
-            }
-            switch ($string[$i]) {
-                case "\r":
-                    $this->bodyCanonLastChar = "\r";
-                    break;
-                case "\n":
-                    if ("\r" == $this->bodyCanonLastChar) {
-                        if ($nofws) {
-                            $this->bodyCanonSpace = false;
-                        }
-                        if ('' == $this->bodyCanonLine) {
-                            ++$this->bodyCanonEmptyCounter;
-                        } else {
-                            $this->bodyCanonLine = '';
-                            $canon .= "\r\n";
-                        }
-                    } else {
-                        // Wooops Error
-                        throw new Swift_SwiftException('Invalid new line sequence in mail found \n without preceding \r');
-                    }
-                    break;
-                case ' ':
-                case "\t":
-                case "\x09": //HTAB
-                    if ($nofws) {
-                        $this->bodyCanonSpace = true;
-                        break;
-                    }
-                    // no break
-                default:
-                    if ($this->bodyCanonEmptyCounter > 0) {
-                        $canon .= str_repeat("\r\n", $this->bodyCanonEmptyCounter);
-                        $this->bodyCanonEmptyCounter = 0;
-                    }
-                    $this->bodyCanonLine .= $string[$i];
-                    $canon .= $string[$i];
-            }
-        }
-        $this->addToHash($canon);
-    }
-
-    protected function endOfBody()
-    {
-        if (\strlen($this->bodyCanonLine) > 0) {
-            $this->addToHash("\r\n");
-        }
-    }
-
-    private function addToHash($string)
-    {
-        $this->canonData .= $string;
-        hash_update($this->hashHandler, $string);
-    }
-
-    private function startHash()
-    {
-        // Init
-        switch ($this->hashAlgorithm) {
-            case 'rsa-sha1':
-                $this->hashHandler = hash_init('sha1');
-                break;
-        }
-        $this->bodyCanonLine = '';
-    }
-
-    /**
-     * @throws Swift_SwiftException
-     *
-     * @return string
-     */
-    private function getEncryptedHash()
-    {
-        $signature = '';
-        $pkeyId = openssl_get_privatekey($this->privateKey);
-        if (!$pkeyId) {
-            throw new Swift_SwiftException('Unable to load DomainKey Private Key ['.openssl_error_string().']');
-        }
-        if (openssl_sign($this->canonData, $signature, $pkeyId, OPENSSL_ALGO_SHA1)) {
-            return $signature;
-        }
-        throw new Swift_SwiftException('Unable to sign DomainKey Hash  ['.openssl_error_string().']');
-    }
+	/**
+	 * PrivateKey.
+	 *
+	 * @var string
+	 */
+	protected $privateKey;
+
+	/**
+	 * DomainName.
+	 *
+	 * @var string
+	 */
+	protected $domainName;
+
+	/**
+	 * Selector.
+	 *
+	 * @var string
+	 */
+	protected $selector;
+
+	/**
+	 * Hash algorithm used.
+	 *
+	 * @var string
+	 */
+	protected $hashAlgorithm = 'rsa-sha1';
+
+	/**
+	 * Canonisation method.
+	 *
+	 * @var string
+	 */
+	protected $canon = 'simple';
+
+	/**
+	 * Headers not being signed.
+	 *
+	 * @var array
+	 */
+	protected $ignoredHeaders = [];
+
+	/**
+	 * Signer identity.
+	 *
+	 * @var string
+	 */
+	protected $signerIdentity;
+
+	/**
+	 * Must we embed signed headers?
+	 *
+	 * @var bool
+	 */
+	protected $debugHeaders = false;
+
+	// work variables
+	/**
+	 * Headers used to generate hash.
+	 *
+	 * @var array
+	 */
+	private $signedHeaders = [];
+
+	/**
+	 * Stores the signature header.
+	 *
+	 * @var Swift_Mime_Headers_ParameterizedHeader
+	 */
+	protected $domainKeyHeader;
+
+	/**
+	 * Hash Handler.
+	 *
+	 * @var resource|null
+	 */
+	private $hashHandler;
+
+	private $canonData = '';
+
+	private $bodyCanonEmptyCounter = 0;
+
+	private $bodyCanonIgnoreStart = 2;
+
+	private $bodyCanonSpace = false;
+
+	private $bodyCanonLastChar = null;
+
+	private $bodyCanonLine = '';
+
+	private $bound = [];
+
+	/**
+	 * Constructor.
+	 *
+	 * @param string $privateKey
+	 * @param string $domainName
+	 * @param string $selector
+	 */
+	public function __construct($privateKey, $domainName, $selector)
+	{
+		$this->privateKey = $privateKey;
+		$this->domainName = $domainName;
+		$this->signerIdentity = '@'.$domainName;
+		$this->selector = $selector;
+	}
+
+	/**
+	 * Resets internal states.
+	 *
+	 * @return $this
+	 */
+	public function reset()
+	{
+		$this->hashHandler = null;
+		$this->bodyCanonIgnoreStart = 2;
+		$this->bodyCanonEmptyCounter = 0;
+		$this->bodyCanonLastChar = null;
+		$this->bodyCanonSpace = false;
+
+		return $this;
+	}
+
+	/**
+	 * Writes $bytes to the end of the stream.
+	 *
+	 * Writing may not happen immediately if the stream chooses to buffer.  If
+	 * you want to write these bytes with immediate effect, call {@link commit()}
+	 * after calling write().
+	 *
+	 * This method returns the sequence ID of the write (i.e. 1 for first, 2 for
+	 * second, etc etc).
+	 *
+	 * @param string $bytes
+	 *
+	 * @return int
+	 *
+	 * @throws Swift_IoException
+	 *
+	 * @return $this
+	 */
+	public function write($bytes)
+	{
+		$this->canonicalizeBody($bytes);
+		foreach ($this->bound as $is) {
+			$is->write($bytes);
+		}
+
+		return $this;
+	}
+
+	/**
+	 * For any bytes that are currently buffered inside the stream, force them
+	 * off the buffer.
+	 *
+	 * @throws Swift_IoException
+	 *
+	 * @return $this
+	 */
+	public function commit()
+	{
+		// Nothing to do
+		return $this;
+	}
+
+	/**
+	 * Attach $is to this stream.
+	 *
+	 * The stream acts as an observer, receiving all data that is written.
+	 * All {@link write()} and {@link flushBuffers()} operations will be mirrored.
+	 *
+	 * @return $this
+	 */
+	public function bind(Swift_InputByteStream $is)
+	{
+		// Don't have to mirror anything
+		$this->bound[] = $is;
+
+		return $this;
+	}
+
+	/**
+	 * Remove an already bound stream.
+	 *
+	 * If $is is not bound, no errors will be raised.
+	 * If the stream currently has any buffered data it will be written to $is
+	 * before unbinding occurs.
+	 *
+	 * @return $this
+	 */
+	public function unbind(Swift_InputByteStream $is)
+	{
+		// Don't have to mirror anything
+		foreach ($this->bound as $k => $stream) {
+			if ($stream === $is) {
+				unset($this->bound[$k]);
+
+				break;
+			}
+		}
+
+		return $this;
+	}
+
+	/**
+	 * Flush the contents of the stream (empty it) and set the internal pointer
+	 * to the beginning.
+	 *
+	 * @throws Swift_IoException
+	 *
+	 * @return $this
+	 */
+	public function flushBuffers()
+	{
+		$this->reset();
+
+		return $this;
+	}
+
+	/**
+	 * Set hash_algorithm, must be one of rsa-sha256 | rsa-sha1 defaults to rsa-sha256.
+	 *
+	 * @param string $hash
+	 *
+	 * @return $this
+	 */
+	public function setHashAlgorithm($hash)
+	{
+		$this->hashAlgorithm = 'rsa-sha1';
+
+		return $this;
+	}
+
+	/**
+	 * Set the canonicalization algorithm.
+	 *
+	 * @param string $canon simple | nofws defaults to simple
+	 *
+	 * @return $this
+	 */
+	public function setCanon($canon)
+	{
+		if ('nofws' == $canon) {
+			$this->canon = 'nofws';
+		} else {
+			$this->canon = 'simple';
+		}
+
+		return $this;
+	}
+
+	/**
+	 * Set the signer identity.
+	 *
+	 * @param string $identity
+	 *
+	 * @return $this
+	 */
+	public function setSignerIdentity($identity)
+	{
+		$this->signerIdentity = $identity;
+
+		return $this;
+	}
+
+	/**
+	 * Enable / disable the DebugHeaders.
+	 *
+	 * @param bool $debug
+	 *
+	 * @return $this
+	 */
+	public function setDebugHeaders($debug)
+	{
+		$this->debugHeaders = (bool) $debug;
+
+		return $this;
+	}
+
+	/**
+	 * Start Body.
+	 */
+	public function startBody()
+	{
+	}
+
+	/**
+	 * End Body.
+	 */
+	public function endBody()
+	{
+		$this->endOfBody();
+	}
+
+	/**
+	 * Returns the list of Headers Tampered by this plugin.
+	 *
+	 * @return array
+	 */
+	public function getAlteredHeaders()
+	{
+		if ($this->debugHeaders) {
+			return ['DomainKey-Signature', 'X-DebugHash'];
+		}
+
+		return ['DomainKey-Signature'];
+	}
+
+	/**
+	 * Adds an ignored Header.
+	 *
+	 * @param string $header_name
+	 *
+	 * @return $this
+	 */
+	public function ignoreHeader($header_name)
+	{
+		$this->ignoredHeaders[strtolower($header_name ?? '')] = true;
+
+		return $this;
+	}
+
+	/**
+	 * Set the headers to sign.
+	 *
+	 * @return $this
+	 */
+	public function setHeaders(Swift_Mime_SimpleHeaderSet $headers)
+	{
+		$this->startHash();
+		$this->canonData = '';
+		// Loop through Headers
+		$listHeaders = $headers->listAll();
+		foreach ($listHeaders as $hName) {
+			// Check if we need to ignore Header
+			if (!isset($this->ignoredHeaders[strtolower($hName ?? '')])) {
+				if ($headers->has($hName)) {
+					$tmp = $headers->getAll($hName);
+					foreach ($tmp as $header) {
+						if ('' != $header->getFieldBody()) {
+							$this->addHeader($header->toString());
+							$this->signedHeaders[] = $header->getFieldName();
+						}
+					}
+				}
+			}
+		}
+		$this->endOfHeaders();
+
+		return $this;
+	}
+
+	/**
+	 * Add the signature to the given Headers.
+	 *
+	 * @return $this
+	 */
+	public function addSignature(Swift_Mime_SimpleHeaderSet $headers)
+	{
+		// Prepare the DomainKey-Signature Header
+		$params = ['a' => $this->hashAlgorithm, 'b' => chunk_split(base64_encode($this->getEncryptedHash() ?? ''), 73, ' '), 'c' => $this->canon, 'd' => $this->domainName, 'h' => implode(': ', $this->signedHeaders), 'q' => 'dns', 's' => $this->selector];
+		$string = '';
+		foreach ($params as $k => $v) {
+			$string .= $k.'='.$v.'; ';
+		}
+		$string = trim($string);
+		$headers->addTextHeader('DomainKey-Signature', $string);
+
+		return $this;
+	}
+
+	/* Private helpers */
+
+	protected function addHeader($header)
+	{
+		switch ($this->canon) {
+			case 'nofws':
+				// Prepare Header and cascade
+				$exploded = explode(':', $header, 2);
+				$name = strtolower(trim($exploded[0]));
+				$value = str_replace("\r\n", '', $exploded[1]);
+				$value = preg_replace("/[ \t][ \t]+/", ' ', $value);
+				$header = $name.':'.trim($value)."\r\n";
+				// no break
+			case 'simple':
+				// Nothing to do
+		}
+		$this->addToHash($header);
+	}
+
+	protected function endOfHeaders()
+	{
+		$this->bodyCanonEmptyCounter = 1;
+	}
+
+	protected function canonicalizeBody($string)
+	{
+		$len = \strlen($string);
+		$canon = '';
+		$nofws = ('nofws' == $this->canon);
+		for ($i = 0; $i < $len; ++$i) {
+			if ($this->bodyCanonIgnoreStart > 0) {
+				--$this->bodyCanonIgnoreStart;
+				continue;
+			}
+			switch ($string[$i]) {
+				case "\r":
+					$this->bodyCanonLastChar = "\r";
+					break;
+				case "\n":
+					if ("\r" == $this->bodyCanonLastChar) {
+						if ($nofws) {
+							$this->bodyCanonSpace = false;
+						}
+						if ('' == $this->bodyCanonLine) {
+							++$this->bodyCanonEmptyCounter;
+						} else {
+							$this->bodyCanonLine = '';
+							$canon .= "\r\n";
+						}
+					} else {
+						// Wooops Error
+						throw new Swift_SwiftException('Invalid new line sequence in mail found \n without preceding \r');
+					}
+					break;
+				case ' ':
+				case "\t":
+				case "\x09": //HTAB
+					if ($nofws) {
+						$this->bodyCanonSpace = true;
+						break;
+					}
+					// no break
+				default:
+					if ($this->bodyCanonEmptyCounter > 0) {
+						$canon .= str_repeat("\r\n", $this->bodyCanonEmptyCounter);
+						$this->bodyCanonEmptyCounter = 0;
+					}
+					$this->bodyCanonLine .= $string[$i];
+					$canon .= $string[$i];
+			}
+		}
+		$this->addToHash($canon);
+	}
+
+	protected function endOfBody()
+	{
+		if (\strlen($this->bodyCanonLine) > 0) {
+			$this->addToHash("\r\n");
+		}
+	}
+
+	private function addToHash($string)
+	{
+		$this->canonData .= $string;
+		hash_update($this->hashHandler, $string);
+	}
+
+	private function startHash()
+	{
+		// Init
+		switch ($this->hashAlgorithm) {
+			case 'rsa-sha1':
+				$this->hashHandler = hash_init('sha1');
+				break;
+		}
+		$this->bodyCanonLine = '';
+	}
+
+	/**
+	 * @throws Swift_SwiftException
+	 *
+	 * @return string
+	 */
+	private function getEncryptedHash()
+	{
+		$signature = '';
+		$pkeyId = openssl_get_privatekey($this->privateKey);
+		if (!$pkeyId) {
+			throw new Swift_SwiftException('Unable to load DomainKey Private Key ['.openssl_error_string().']');
+		}
+		if (openssl_sign($this->canonData, $signature, $pkeyId, OPENSSL_ALGO_SHA1)) {
+			return $signature;
+		}
+		throw new Swift_SwiftException('Unable to sign DomainKey Hash  ['.openssl_error_string().']');
+	}
 }

htdocs/includes/swiftmailer/lib/classes/Swift/Signers/BodySigner.php

Indentation +12 added lines, -12 removed lines

@@ -15,17 +15,17 @@
  */
 interface Swift_Signers_BodySigner extends Swift_Signer
 {
-    /**
-     * Change the Swift_Signed_Message to apply the singing.
-     *
-     * @return self
-     */
-    public function signMessage(Swift_Message $message);
+	/**
+	 * Change the Swift_Signed_Message to apply the singing.
+	 *
+	 * @return self
+	 */
+	public function signMessage(Swift_Message $message);
 
-    /**
-     * Return the list of header a signer might tamper.
-     *
-     * @return array
-     */
-    public function getAlteredHeaders();
+	/**
+	 * Return the list of header a signer might tamper.
+	 *
+	 * @return array
+	 */
+	public function getAlteredHeaders();
 }

htdocs/includes/swiftmailer/lib/classes/Swift/Signers/HeaderSigner.php

Indentation +38 added lines, -38 removed lines

@@ -15,47 +15,47 @@
  */
 interface Swift_Signers_HeaderSigner extends Swift_Signer, Swift_InputByteStream
 {
-    /**
-     * Exclude an header from the signed headers.
-     *
-     * @param string $header_name
-     *
-     * @return self
-     */
-    public function ignoreHeader($header_name);
+	/**
+	 * Exclude an header from the signed headers.
+	 *
+	 * @param string $header_name
+	 *
+	 * @return self
+	 */
+	public function ignoreHeader($header_name);
 
-    /**
-     * Prepare the Signer to get a new Body.
-     *
-     * @return self
-     */
-    public function startBody();
+	/**
+	 * Prepare the Signer to get a new Body.
+	 *
+	 * @return self
+	 */
+	public function startBody();
 
-    /**
-     * Give the signal that the body has finished streaming.
-     *
-     * @return self
-     */
-    public function endBody();
+	/**
+	 * Give the signal that the body has finished streaming.
+	 *
+	 * @return self
+	 */
+	public function endBody();
 
-    /**
-     * Give the headers already given.
-     *
-     * @return self
-     */
-    public function setHeaders(Swift_Mime_SimpleHeaderSet $headers);
+	/**
+	 * Give the headers already given.
+	 *
+	 * @return self
+	 */
+	public function setHeaders(Swift_Mime_SimpleHeaderSet $headers);
 
-    /**
-     * Add the header(s) to the headerSet.
-     *
-     * @return self
-     */
-    public function addSignature(Swift_Mime_SimpleHeaderSet $headers);
+	/**
+	 * Add the header(s) to the headerSet.
+	 *
+	 * @return self
+	 */
+	public function addSignature(Swift_Mime_SimpleHeaderSet $headers);
 
-    /**
-     * Return the list of header a signer might tamper.
-     *
-     * @return array
-     */
-    public function getAlteredHeaders();
+	/**
+	 * Return the list of header a signer might tamper.
+	 *
+	 * @return array
+	 */
+	public function getAlteredHeaders();
 }

htdocs/includes/swiftmailer/lib/classes/Swift/IoException.php

Indentation +10 added lines, -10 removed lines

@@ -15,14 +15,14 @@
  */
 class Swift_IoException extends Swift_SwiftException
 {
-    /**
-     * Create a new IoException with $message.
-     *
-     * @param string $message
-     * @param int    $code
-     */
-    public function __construct($message, $code = 0, Exception $previous = null)
-    {
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * Create a new IoException with $message.
+	 *
+	 * @param string $message
+	 * @param int    $code
+	 */
+	public function __construct($message, $code = 0, Exception $previous = null)
+	{
+		parent::__construct($message, $code, $previous);
+	}
 }

htdocs/includes/swiftmailer/lib/classes/Swift/FileSpool.php

Indentation +189 added lines, -189 removed lines

@@ -16,193 +16,193 @@
  */
 class Swift_FileSpool extends Swift_ConfigurableSpool
 {
-    /** The spool directory */
-    private $path;
-
-    /**
-     * File WriteRetry Limit.
-     *
-     * @var int
-     */
-    private $retryLimit = 10;
-
-    /**
-     * Create a new FileSpool.
-     *
-     * @param string $path
-     *
-     * @throws Swift_IoException
-     */
-    public function __construct($path)
-    {
-        $this->path = $path;
-
-        if (!file_exists($this->path)) {
-            if (!mkdir($this->path, 0777, true)) {
-                throw new Swift_IoException(sprintf('Unable to create path "%s".', $this->path));
-            }
-        }
-    }
-
-    /**
-     * Tests if this Spool mechanism has started.
-     *
-     * @return bool
-     */
-    public function isStarted()
-    {
-        return true;
-    }
-
-    /**
-     * Starts this Spool mechanism.
-     */
-    public function start()
-    {
-    }
-
-    /**
-     * Stops this Spool mechanism.
-     */
-    public function stop()
-    {
-    }
-
-    /**
-     * Allow to manage the enqueuing retry limit.
-     *
-     * Default, is ten and allows over 64^20 different fileNames
-     *
-     * @param int $limit
-     */
-    public function setRetryLimit($limit)
-    {
-        $this->retryLimit = $limit;
-    }
-
-    /**
-     * Queues a message.
-     *
-     * @param Swift_Mime_SimpleMessage $message The message to store
-     *
-     * @throws Swift_IoException
-     *
-     * @return bool
-     */
-    public function queueMessage(Swift_Mime_SimpleMessage $message)
-    {
-        $ser = serialize($message);
-        $fileName = $this->path.'/'.$this->getRandomString(10);
-        for ($i = 0; $i < $this->retryLimit; ++$i) {
-            /* We try an exclusive creation of the file. This is an atomic operation, it avoid locking mechanism */
-            $fp = @fopen($fileName.'.message', 'xb');
-            if (false !== $fp) {
-                if (false === fwrite($fp, $ser)) {
-                    return false;
-                }
-
-                return fclose($fp);
-            } else {
-                /* The file already exists, we try a longer fileName */
-                $fileName .= $this->getRandomString(1);
-            }
-        }
-
-        throw new Swift_IoException(sprintf('Unable to create a file for enqueuing Message in "%s".', $this->path));
-    }
-
-    /**
-     * Execute a recovery if for any reason a process is sending for too long.
-     *
-     * @param int $timeout in second Defaults is for very slow smtp responses
-     */
-    public function recover($timeout = 900)
-    {
-        foreach (new DirectoryIterator($this->path) as $file) {
-            $file = $file->getRealPath();
-
-            if ('.message.sending' == substr($file, -16)) {
-                $lockedtime = filectime($file);
-                if ((time() - $lockedtime) > $timeout) {
-                    rename($file, substr($file, 0, -8));
-                }
-            }
-        }
-    }
-
-    /**
-     * Sends messages using the given transport instance.
-     *
-     * @param Swift_Transport $transport        A transport instance
-     * @param string[]        $failedRecipients An array of failures by-reference
-     *
-     * @return int The number of sent e-mail's
-     */
-    public function flushQueue(Swift_Transport $transport, &$failedRecipients = null)
-    {
-        $directoryIterator = new DirectoryIterator($this->path);
-
-        /* Start the transport only if there are queued files to send */
-        if (!$transport->isStarted()) {
-            foreach ($directoryIterator as $file) {
-                if ('.message' == substr($file->getRealPath(), -8)) {
-                    $transport->start();
-                    break;
-                }
-            }
-        }
-
-        $failedRecipients = (array) $failedRecipients;
-        $count = 0;
-        $time = time();
-        foreach ($directoryIterator as $file) {
-            $file = $file->getRealPath();
-
-            if ('.message' != substr($file, -8)) {
-                continue;
-            }
-
-            /* We try a rename, it's an atomic operation, and avoid locking the file */
-            if (rename($file, $file.'.sending')) {
-                $message = unserialize(file_get_contents($file.'.sending'));
-
-                $count += $transport->send($message, $failedRecipients);
-
-                unlink($file.'.sending');
-            } else {
-                /* This message has just been catched by another process */
-                continue;
-            }
-
-            if ($this->getMessageLimit() && $count >= $this->getMessageLimit()) {
-                break;
-            }
-
-            if ($this->getTimeLimit() && (time() - $time) >= $this->getTimeLimit()) {
-                break;
-            }
-        }
-
-        return $count;
-    }
-
-    /**
-     * Returns a random string needed to generate a fileName for the queue.
-     *
-     * @param int $count
-     *
-     * @return string
-     */
-    protected function getRandomString($count)
-    {
-        // This string MUST stay FS safe, avoid special chars
-        $base = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_-';
-        $ret = '';
-        $strlen = \strlen($base);
-        for ($i = 0; $i < $count; ++$i) {
-            $ret .= $base[random_int(0, $strlen - 1)];
-        }
-
-        return $ret;
-    }
+	/** The spool directory */
+	private $path;
+
+	/**
+	 * File WriteRetry Limit.
+	 *
+	 * @var int
+	 */
+	private $retryLimit = 10;
+
+	/**
+	 * Create a new FileSpool.
+	 *
+	 * @param string $path
+	 *
+	 * @throws Swift_IoException
+	 */
+	public function __construct($path)
+	{
+		$this->path = $path;
+
+		if (!file_exists($this->path)) {
+			if (!mkdir($this->path, 0777, true)) {
+				throw new Swift_IoException(sprintf('Unable to create path "%s".', $this->path));
+			}
+		}
+	}
+
+	/**
+	 * Tests if this Spool mechanism has started.
+	 *
+	 * @return bool
+	 */
+	public function isStarted()
+	{
+		return true;
+	}
+
+	/**
+	 * Starts this Spool mechanism.
+	 */
+	public function start()
+	{
+	}
+
+	/**
+	 * Stops this Spool mechanism.
+	 */
+	public function stop()
+	{
+	}
+
+	/**
+	 * Allow to manage the enqueuing retry limit.
+	 *
+	 * Default, is ten and allows over 64^20 different fileNames
+	 *
+	 * @param int $limit
+	 */
+	public function setRetryLimit($limit)
+	{
+		$this->retryLimit = $limit;
+	}
+
+	/**
+	 * Queues a message.
+	 *
+	 * @param Swift_Mime_SimpleMessage $message The message to store
+	 *
+	 * @throws Swift_IoException
+	 *
+	 * @return bool
+	 */
+	public function queueMessage(Swift_Mime_SimpleMessage $message)
+	{
+		$ser = serialize($message);
+		$fileName = $this->path.'/'.$this->getRandomString(10);
+		for ($i = 0; $i < $this->retryLimit; ++$i) {
+			/* We try an exclusive creation of the file. This is an atomic operation, it avoid locking mechanism */
+			$fp = @fopen($fileName.'.message', 'xb');
+			if (false !== $fp) {
+				if (false === fwrite($fp, $ser)) {
+					return false;
+				}
+
+				return fclose($fp);
+			} else {
+				/* The file already exists, we try a longer fileName */
+				$fileName .= $this->getRandomString(1);
+			}
+		}
+
+		throw new Swift_IoException(sprintf('Unable to create a file for enqueuing Message in "%s".', $this->path));
+	}
+
+	/**
+	 * Execute a recovery if for any reason a process is sending for too long.
+	 *
+	 * @param int $timeout in second Defaults is for very slow smtp responses
+	 */
+	public function recover($timeout = 900)
+	{
+		foreach (new DirectoryIterator($this->path) as $file) {
+			$file = $file->getRealPath();
+
+			if ('.message.sending' == substr($file, -16)) {
+				$lockedtime = filectime($file);
+				if ((time() - $lockedtime) > $timeout) {
+					rename($file, substr($file, 0, -8));
+				}
+			}
+		}
+	}
+
+	/**
+	 * Sends messages using the given transport instance.
+	 *
+	 * @param Swift_Transport $transport        A transport instance
+	 * @param string[]        $failedRecipients An array of failures by-reference
+	 *
+	 * @return int The number of sent e-mail's
+	 */
+	public function flushQueue(Swift_Transport $transport, &$failedRecipients = null)
+	{
+		$directoryIterator = new DirectoryIterator($this->path);
+
+		/* Start the transport only if there are queued files to send */
+		if (!$transport->isStarted()) {
+			foreach ($directoryIterator as $file) {
+				if ('.message' == substr($file->getRealPath(), -8)) {
+					$transport->start();
+					break;
+				}
+			}
+		}
+
+		$failedRecipients = (array) $failedRecipients;
+		$count = 0;
+		$time = time();
+		foreach ($directoryIterator as $file) {
+			$file = $file->getRealPath();
+
+			if ('.message' != substr($file, -8)) {
+				continue;
+			}
+
+			/* We try a rename, it's an atomic operation, and avoid locking the file */
+			if (rename($file, $file.'.sending')) {
+				$message = unserialize(file_get_contents($file.'.sending'));
+
+				$count += $transport->send($message, $failedRecipients);
+
+				unlink($file.'.sending');
+			} else {
+				/* This message has just been catched by another process */
+				continue;
+			}
+
+			if ($this->getMessageLimit() && $count >= $this->getMessageLimit()) {
+				break;
+			}
+
+			if ($this->getTimeLimit() && (time() - $time) >= $this->getTimeLimit()) {
+				break;
+			}
+		}
+
+		return $count;
+	}
+
+	/**
+	 * Returns a random string needed to generate a fileName for the queue.
+	 *
+	 * @param int $count
+	 *
+	 * @return string
+	 */
+	protected function getRandomString($count)
+	{
+		// This string MUST stay FS safe, avoid special chars
+		$base = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_-';
+		$ret = '';
+		$strlen = \strlen($base);
+		for ($i = 0; $i < $count; ++$i) {
+			$ret .= $base[random_int(0, $strlen - 1)];
+		}
+
+		return $ret;
+	}
 }

htdocs/includes/swiftmailer/lib/classes/Swift/CharacterStream/NgCharacterStream.php

Indentation +220 added lines, -220 removed lines

@@ -15,248 +15,248 @@
  */
 class Swift_CharacterStream_NgCharacterStream implements Swift_CharacterStream
 {
-    /**
-     * The char reader (lazy-loaded) for the current charset.
-     *
-     * @var Swift_CharacterReader
-     */
-    private $charReader;
+	/**
+	 * The char reader (lazy-loaded) for the current charset.
+	 *
+	 * @var Swift_CharacterReader
+	 */
+	private $charReader;
 
-    /**
-     * A factory for creating CharacterReader instances.
-     *
-     * @var Swift_CharacterReaderFactory
-     */
-    private $charReaderFactory;
+	/**
+	 * A factory for creating CharacterReader instances.
+	 *
+	 * @var Swift_CharacterReaderFactory
+	 */
+	private $charReaderFactory;
 
-    /**
-     * The character set this stream is using.
-     *
-     * @var string
-     */
-    private $charset;
+	/**
+	 * The character set this stream is using.
+	 *
+	 * @var string
+	 */
+	private $charset;
 
-    /**
-     * The data's stored as-is.
-     *
-     * @var string
-     */
-    private $datas = '';
+	/**
+	 * The data's stored as-is.
+	 *
+	 * @var string
+	 */
+	private $datas = '';
 
-    /**
-     * Number of bytes in the stream.
-     *
-     * @var int
-     */
-    private $datasSize = 0;
+	/**
+	 * Number of bytes in the stream.
+	 *
+	 * @var int
+	 */
+	private $datasSize = 0;
 
-    /**
-     * Map.
-     *
-     * @var mixed
-     */
-    private $map;
+	/**
+	 * Map.
+	 *
+	 * @var mixed
+	 */
+	private $map;
 
-    /**
-     * Map Type.
-     *
-     * @var int
-     */
-    private $mapType = 0;
+	/**
+	 * Map Type.
+	 *
+	 * @var int
+	 */
+	private $mapType = 0;
 
-    /**
-     * Number of characters in the stream.
-     *
-     * @var int
-     */
-    private $charCount = 0;
+	/**
+	 * Number of characters in the stream.
+	 *
+	 * @var int
+	 */
+	private $charCount = 0;
 
-    /**
-     * Position in the stream.
-     *
-     * @var int
-     */
-    private $currentPos = 0;
+	/**
+	 * Position in the stream.
+	 *
+	 * @var int
+	 */
+	private $currentPos = 0;
 
-    /**
-     * Constructor.
-     *
-     * @param string $charset
-     */
-    public function __construct(Swift_CharacterReaderFactory $factory, $charset)
-    {
-        $this->setCharacterReaderFactory($factory);
-        $this->setCharacterSet($charset);
-    }
+	/**
+	 * Constructor.
+	 *
+	 * @param string $charset
+	 */
+	public function __construct(Swift_CharacterReaderFactory $factory, $charset)
+	{
+		$this->setCharacterReaderFactory($factory);
+		$this->setCharacterSet($charset);
+	}
 
-    /* -- Changing parameters of the stream -- */
+	/* -- Changing parameters of the stream -- */
 
-    /**
-     * Set the character set used in this CharacterStream.
-     *
-     * @param string $charset
-     */
-    public function setCharacterSet($charset)
-    {
-        $this->charset = $charset;
-        $this->charReader = null;
-        $this->mapType = 0;
-    }
+	/**
+	 * Set the character set used in this CharacterStream.
+	 *
+	 * @param string $charset
+	 */
+	public function setCharacterSet($charset)
+	{
+		$this->charset = $charset;
+		$this->charReader = null;
+		$this->mapType = 0;
+	}
 
-    /**
-     * Set the CharacterReaderFactory for multi charset support.
-     */
-    public function setCharacterReaderFactory(Swift_CharacterReaderFactory $factory)
-    {
-        $this->charReaderFactory = $factory;
-    }
+	/**
+	 * Set the CharacterReaderFactory for multi charset support.
+	 */
+	public function setCharacterReaderFactory(Swift_CharacterReaderFactory $factory)
+	{
+		$this->charReaderFactory = $factory;
+	}
 
-    /**
-     * @see Swift_CharacterStream::flushContents()
-     */
-    public function flushContents()
-    {
-        $this->datas = null;
-        $this->map = null;
-        $this->charCount = 0;
-        $this->currentPos = 0;
-        $this->datasSize = 0;
-    }
+	/**
+	 * @see Swift_CharacterStream::flushContents()
+	 */
+	public function flushContents()
+	{
+		$this->datas = null;
+		$this->map = null;
+		$this->charCount = 0;
+		$this->currentPos = 0;
+		$this->datasSize = 0;
+	}
 
-    /**
-     * @see Swift_CharacterStream::importByteStream()
-     */
-    public function importByteStream(Swift_OutputByteStream $os)
-    {
-        $this->flushContents();
-        $blocks = 512;
-        $os->setReadPointer(0);
-        while (false !== ($read = $os->read($blocks))) {
-            $this->write($read);
-        }
-    }
+	/**
+	 * @see Swift_CharacterStream::importByteStream()
+	 */
+	public function importByteStream(Swift_OutputByteStream $os)
+	{
+		$this->flushContents();
+		$blocks = 512;
+		$os->setReadPointer(0);
+		while (false !== ($read = $os->read($blocks))) {
+			$this->write($read);
+		}
+	}
 
-    /**
-     * @see Swift_CharacterStream::importString()
-     *
-     * @param string $string
-     */
-    public function importString($string)
-    {
-        $this->flushContents();
-        $this->write($string);
-    }
+	/**
+	 * @see Swift_CharacterStream::importString()
+	 *
+	 * @param string $string
+	 */
+	public function importString($string)
+	{
+		$this->flushContents();
+		$this->write($string);
+	}
 
-    /**
-     * @see Swift_CharacterStream::read()
-     *
-     * @param int $length
-     *
-     * @return string
-     */
-    public function read($length)
-    {
-        if ($this->currentPos >= $this->charCount) {
-            return false;
-        }
-        $ret = false;
-        $length = ($this->currentPos + $length > $this->charCount) ? $this->charCount - $this->currentPos : $length;
-        switch ($this->mapType) {
-            case Swift_CharacterReader::MAP_TYPE_FIXED_LEN:
-                $len = $length * $this->map;
-                $ret = substr($this->datas,
-                        $this->currentPos * $this->map,
-                        $len);
-                $this->currentPos += $length;
-                break;
+	/**
+	 * @see Swift_CharacterStream::read()
+	 *
+	 * @param int $length
+	 *
+	 * @return string
+	 */
+	public function read($length)
+	{
+		if ($this->currentPos >= $this->charCount) {
+			return false;
+		}
+		$ret = false;
+		$length = ($this->currentPos + $length > $this->charCount) ? $this->charCount - $this->currentPos : $length;
+		switch ($this->mapType) {
+			case Swift_CharacterReader::MAP_TYPE_FIXED_LEN:
+				$len = $length * $this->map;
+				$ret = substr($this->datas,
+						$this->currentPos * $this->map,
+						$len);
+				$this->currentPos += $length;
+				break;
 
-            case Swift_CharacterReader::MAP_TYPE_INVALID:
-                $ret = '';
-                for (; $this->currentPos < $length; ++$this->currentPos) {
-                    if (isset($this->map[$this->currentPos])) {
-                        $ret .= '?';
-                    } else {
-                        $ret .= $this->datas[$this->currentPos];
-                    }
-                }
-                break;
+			case Swift_CharacterReader::MAP_TYPE_INVALID:
+				$ret = '';
+				for (; $this->currentPos < $length; ++$this->currentPos) {
+					if (isset($this->map[$this->currentPos])) {
+						$ret .= '?';
+					} else {
+						$ret .= $this->datas[$this->currentPos];
+					}
+				}
+				break;
 
-            case Swift_CharacterReader::MAP_TYPE_POSITIONS:
-                $end = $this->currentPos + $length;
-                $end = $end > $this->charCount ? $this->charCount : $end;
-                $ret = '';
-                $start = 0;
-                if ($this->currentPos > 0) {
-                    $start = $this->map['p'][$this->currentPos - 1];
-                }
-                $to = $start;
-                for (; $this->currentPos < $end; ++$this->currentPos) {
-                    if (isset($this->map['i'][$this->currentPos])) {
-                        $ret .= substr($this->datas, $start, $to - $start).'?';
-                        $start = $this->map['p'][$this->currentPos];
-                    } else {
-                        $to = $this->map['p'][$this->currentPos];
-                    }
-                }
-                $ret .= substr($this->datas, $start, $to - $start);
-                break;
-        }
+			case Swift_CharacterReader::MAP_TYPE_POSITIONS:
+				$end = $this->currentPos + $length;
+				$end = $end > $this->charCount ? $this->charCount : $end;
+				$ret = '';
+				$start = 0;
+				if ($this->currentPos > 0) {
+					$start = $this->map['p'][$this->currentPos - 1];
+				}
+				$to = $start;
+				for (; $this->currentPos < $end; ++$this->currentPos) {
+					if (isset($this->map['i'][$this->currentPos])) {
+						$ret .= substr($this->datas, $start, $to - $start).'?';
+						$start = $this->map['p'][$this->currentPos];
+					} else {
+						$to = $this->map['p'][$this->currentPos];
+					}
+				}
+				$ret .= substr($this->datas, $start, $to - $start);
+				break;
+		}
 
-        return $ret;
-    }
+		return $ret;
+	}
 
-    /**
-     * @see Swift_CharacterStream::readBytes()
-     *
-     * @param int $length
-     *
-     * @return int[]
-     */
-    public function readBytes($length)
-    {
-        $read = $this->read($length);
-        if (false !== $read) {
-            $ret = array_map('ord', str_split($read, 1));
+	/**
+	 * @see Swift_CharacterStream::readBytes()
+	 *
+	 * @param int $length
+	 *
+	 * @return int[]
+	 */
+	public function readBytes($length)
+	{
+		$read = $this->read($length);
+		if (false !== $read) {
+			$ret = array_map('ord', str_split($read, 1));
 
-            return $ret;
-        }
+			return $ret;
+		}
 
-        return false;
-    }
+		return false;
+	}
 
-    /**
-     * @see Swift_CharacterStream::setPointer()
-     *
-     * @param int $charOffset
-     */
-    public function setPointer($charOffset)
-    {
-        if ($this->charCount < $charOffset) {
-            $charOffset = $this->charCount;
-        }
-        $this->currentPos = $charOffset;
-    }
+	/**
+	 * @see Swift_CharacterStream::setPointer()
+	 *
+	 * @param int $charOffset
+	 */
+	public function setPointer($charOffset)
+	{
+		if ($this->charCount < $charOffset) {
+			$charOffset = $this->charCount;
+		}
+		$this->currentPos = $charOffset;
+	}
 
-    /**
-     * @see Swift_CharacterStream::write()
-     *
-     * @param string $chars
-     */
-    public function write($chars)
-    {
-        if (!isset($this->charReader)) {
-            $this->charReader = $this->charReaderFactory->getReaderFor(
-                $this->charset);
-            $this->map = [];
-            $this->mapType = $this->charReader->getMapType();
-        }
-        $ignored = '';
-        $this->datas .= $chars;
-        $this->charCount += $this->charReader->getCharPositions(substr($this->datas, $this->datasSize), $this->datasSize, $this->map, $ignored);
-        if (false !== $ignored) {
-            $this->datasSize = \strlen($this->datas) - \strlen($ignored);
-        } else {
-            $this->datasSize = \strlen($this->datas);
-        }
-    }
+	/**
+	 * @see Swift_CharacterStream::write()
+	 *
+	 * @param string $chars
+	 */
+	public function write($chars)
+	{
+		if (!isset($this->charReader)) {
+			$this->charReader = $this->charReaderFactory->getReaderFor(
+				$this->charset);
+			$this->map = [];
+			$this->mapType = $this->charReader->getMapType();
+		}
+		$ignored = '';
+		$this->datas .= $chars;
+		$this->charCount += $this->charReader->getCharPositions(substr($this->datas, $this->datasSize), $this->datasSize, $this->map, $ignored);
+		if (false !== $ignored) {
+			$this->datasSize = \strlen($this->datas) - \strlen($ignored);
+		} else {
+			$this->datasSize = \strlen($this->datas);
+		}
+	}
 }

htdocs/includes/swiftmailer/lib/classes/Swift/CharacterStream/ArrayCharacterStream.php

Indentation +273 added lines, -273 removed lines

@@ -15,277 +15,277 @@
  */
 class Swift_CharacterStream_ArrayCharacterStream implements Swift_CharacterStream
 {
-    /** A map of byte values and their respective characters */
-    private static $charMap;
-
-    /** A map of characters and their derivative byte values */
-    private static $byteMap;
-
-    /** The char reader (lazy-loaded) for the current charset */
-    private $charReader;
-
-    /** A factory for creating CharacterReader instances */
-    private $charReaderFactory;
-
-    /** The character set this stream is using */
-    private $charset;
-
-    /** Array of characters */
-    private $array = [];
-
-    /** Size of the array of character */
-    private $array_size = [];
-
-    /** The current character offset in the stream */
-    private $offset = 0;
-
-    /**
-     * Create a new CharacterStream with the given $chars, if set.
-     *
-     * @param Swift_CharacterReaderFactory $factory for loading validators
-     * @param string                       $charset used in the stream
-     */
-    public function __construct(Swift_CharacterReaderFactory $factory, $charset)
-    {
-        self::initializeMaps();
-        $this->setCharacterReaderFactory($factory);
-        $this->setCharacterSet($charset);
-    }
-
-    /**
-     * Set the character set used in this CharacterStream.
-     *
-     * @param string $charset
-     */
-    public function setCharacterSet($charset)
-    {
-        $this->charset = $charset;
-        $this->charReader = null;
-    }
-
-    /**
-     * Set the CharacterReaderFactory for multi charset support.
-     */
-    public function setCharacterReaderFactory(Swift_CharacterReaderFactory $factory)
-    {
-        $this->charReaderFactory = $factory;
-    }
-
-    /**
-     * Overwrite this character stream using the byte sequence in the byte stream.
-     *
-     * @param Swift_OutputByteStream $os output stream to read from
-     */
-    public function importByteStream(Swift_OutputByteStream $os)
-    {
-        if (!isset($this->charReader)) {
-            $this->charReader = $this->charReaderFactory
-                ->getReaderFor($this->charset);
-        }
-
-        $startLength = $this->charReader->getInitialByteSize();
-        while (false !== $bytes = $os->read($startLength)) {
-            $c = [];
-            for ($i = 0, $len = \strlen($bytes); $i < $len; ++$i) {
-                $c[] = self::$byteMap[$bytes[$i]];
-            }
-            $size = \count($c);
-            $need = $this->charReader
-                ->validateByteSequence($c, $size);
-            if ($need > 0 &&
-                false !== $bytes = $os->read($need)) {
-                for ($i = 0, $len = \strlen($bytes); $i < $len; ++$i) {
-                    $c[] = self::$byteMap[$bytes[$i]];
-                }
-            }
-            $this->array[] = $c;
-            ++$this->array_size;
-        }
-    }
-
-    /**
-     * Import a string a bytes into this CharacterStream, overwriting any existing
-     * data in the stream.
-     *
-     * @param string $string
-     */
-    public function importString($string)
-    {
-        $this->flushContents();
-        $this->write($string);
-    }
-
-    /**
-     * Read $length characters from the stream and move the internal pointer
-     * $length further into the stream.
-     *
-     * @param int $length
-     *
-     * @return string
-     */
-    public function read($length)
-    {
-        if ($this->offset == $this->array_size) {
-            return false;
-        }
-
-        // Don't use array slice
-        $arrays = [];
-        $end = $length + $this->offset;
-        for ($i = $this->offset; $i < $end; ++$i) {
-            if (!isset($this->array[$i])) {
-                break;
-            }
-            $arrays[] = $this->array[$i];
-        }
-        $this->offset += $i - $this->offset; // Limit function calls
-        $chars = false;
-        foreach ($arrays as $array) {
-            $chars .= implode('', array_map('chr', $array));
-        }
-
-        return $chars;
-    }
-
-    /**
-     * Read $length characters from the stream and return a 1-dimensional array
-     * containing there octet values.
-     *
-     * @param int $length
-     *
-     * @return int[]
-     */
-    public function readBytes($length)
-    {
-        if ($this->offset == $this->array_size) {
-            return false;
-        }
-        $arrays = [];
-        $end = $length + $this->offset;
-        for ($i = $this->offset; $i < $end; ++$i) {
-            if (!isset($this->array[$i])) {
-                break;
-            }
-            $arrays[] = $this->array[$i];
-        }
-        $this->offset += ($i - $this->offset); // Limit function calls
-
-        return array_merge(...$arrays);
-    }
-
-    /**
-     * Write $chars to the end of the stream.
-     *
-     * @param string $chars
-     */
-    public function write($chars)
-    {
-        if (!isset($this->charReader)) {
-            $this->charReader = $this->charReaderFactory->getReaderFor(
-                $this->charset);
-        }
-
-        $startLength = $this->charReader->getInitialByteSize();
-
-        $fp = fopen('php://memory', 'w+b');
-        fwrite($fp, $chars);
-        unset($chars);
-        fseek($fp, 0, SEEK_SET);
-
-        $buffer = [0];
-        $buf_pos = 1;
-        $buf_len = 1;
-        $has_datas = true;
-        do {
-            $bytes = [];
-            // Buffer Filing
-            if ($buf_len - $buf_pos < $startLength) {
-                $buf = array_splice($buffer, $buf_pos);
-                $new = $this->reloadBuffer($fp, 100);
-                if ($new) {
-                    $buffer = array_merge($buf, $new);
-                    $buf_len = \count($buffer);
-                    $buf_pos = 0;
-                } else {
-                    $has_datas = false;
-                }
-            }
-            if ($buf_len - $buf_pos > 0) {
-                $size = 0;
-                for ($i = 0; $i < $startLength && isset($buffer[$buf_pos]); ++$i) {
-                    ++$size;
-                    $bytes[] = $buffer[$buf_pos++];
-                }
-                $need = $this->charReader->validateByteSequence(
-                    $bytes, $size);
-                if ($need > 0) {
-                    if ($buf_len - $buf_pos < $need) {
-                        $new = $this->reloadBuffer($fp, $need);
-
-                        if ($new) {
-                            $buffer = array_merge($buffer, $new);
-                            $buf_len = \count($buffer);
-                        }
-                    }
-                    for ($i = 0; $i < $need && isset($buffer[$buf_pos]); ++$i) {
-                        $bytes[] = $buffer[$buf_pos++];
-                    }
-                }
-                $this->array[] = $bytes;
-                ++$this->array_size;
-            }
-        } while ($has_datas);
-
-        fclose($fp);
-    }
-
-    /**
-     * Move the internal pointer to $charOffset in the stream.
-     *
-     * @param int $charOffset
-     */
-    public function setPointer($charOffset)
-    {
-        if ($charOffset > $this->array_size) {
-            $charOffset = $this->array_size;
-        } elseif ($charOffset < 0) {
-            $charOffset = 0;
-        }
-        $this->offset = $charOffset;
-    }
-
-    /**
-     * Empty the stream and reset the internal pointer.
-     */
-    public function flushContents()
-    {
-        $this->offset = 0;
-        $this->array = [];
-        $this->array_size = 0;
-    }
-
-    private function reloadBuffer($fp, $len)
-    {
-        if (!feof($fp) && false !== ($bytes = fread($fp, $len))) {
-            $buf = [];
-            for ($i = 0, $len = \strlen($bytes); $i < $len; ++$i) {
-                $buf[] = self::$byteMap[$bytes[$i]];
-            }
-
-            return $buf;
-        }
-
-        return false;
-    }
-
-    private static function initializeMaps()
-    {
-        if (!isset(self::$charMap)) {
-            self::$charMap = [];
-            for ($byte = 0; $byte < 256; ++$byte) {
-                self::$charMap[$byte] = \chr($byte);
-            }
-            self::$byteMap = array_flip(self::$charMap);
-        }
-    }
+	/** A map of byte values and their respective characters */
+	private static $charMap;
+
+	/** A map of characters and their derivative byte values */
+	private static $byteMap;
+
+	/** The char reader (lazy-loaded) for the current charset */
+	private $charReader;
+
+	/** A factory for creating CharacterReader instances */
+	private $charReaderFactory;
+
+	/** The character set this stream is using */
+	private $charset;
+
+	/** Array of characters */
+	private $array = [];
+
+	/** Size of the array of character */
+	private $array_size = [];
+
+	/** The current character offset in the stream */
+	private $offset = 0;
+
+	/**
+	 * Create a new CharacterStream with the given $chars, if set.
+	 *
+	 * @param Swift_CharacterReaderFactory $factory for loading validators
+	 * @param string                       $charset used in the stream
+	 */
+	public function __construct(Swift_CharacterReaderFactory $factory, $charset)
+	{
+		self::initializeMaps();
+		$this->setCharacterReaderFactory($factory);
+		$this->setCharacterSet($charset);
+	}
+
+	/**
+	 * Set the character set used in this CharacterStream.
+	 *
+	 * @param string $charset
+	 */
+	public function setCharacterSet($charset)
+	{
+		$this->charset = $charset;
+		$this->charReader = null;
+	}
+
+	/**
+	 * Set the CharacterReaderFactory for multi charset support.
+	 */
+	public function setCharacterReaderFactory(Swift_CharacterReaderFactory $factory)
+	{
+		$this->charReaderFactory = $factory;
+	}
+
+	/**
+	 * Overwrite this character stream using the byte sequence in the byte stream.
+	 *
+	 * @param Swift_OutputByteStream $os output stream to read from
+	 */
+	public function importByteStream(Swift_OutputByteStream $os)
+	{
+		if (!isset($this->charReader)) {
+			$this->charReader = $this->charReaderFactory
+				->getReaderFor($this->charset);
+		}
+
+		$startLength = $this->charReader->getInitialByteSize();
+		while (false !== $bytes = $os->read($startLength)) {
+			$c = [];
+			for ($i = 0, $len = \strlen($bytes); $i < $len; ++$i) {
+				$c[] = self::$byteMap[$bytes[$i]];
+			}
+			$size = \count($c);
+			$need = $this->charReader
+				->validateByteSequence($c, $size);
+			if ($need > 0 &&
+				false !== $bytes = $os->read($need)) {
+				for ($i = 0, $len = \strlen($bytes); $i < $len; ++$i) {
+					$c[] = self::$byteMap[$bytes[$i]];
+				}
+			}
+			$this->array[] = $c;
+			++$this->array_size;
+		}
+	}
+
+	/**
+	 * Import a string a bytes into this CharacterStream, overwriting any existing
+	 * data in the stream.
+	 *
+	 * @param string $string
+	 */
+	public function importString($string)
+	{
+		$this->flushContents();
+		$this->write($string);
+	}
+
+	/**
+	 * Read $length characters from the stream and move the internal pointer
+	 * $length further into the stream.
+	 *
+	 * @param int $length
+	 *
+	 * @return string
+	 */
+	public function read($length)
+	{
+		if ($this->offset == $this->array_size) {
+			return false;
+		}
+
+		// Don't use array slice
+		$arrays = [];
+		$end = $length + $this->offset;
+		for ($i = $this->offset; $i < $end; ++$i) {
+			if (!isset($this->array[$i])) {
+				break;
+			}
+			$arrays[] = $this->array[$i];
+		}
+		$this->offset += $i - $this->offset; // Limit function calls
+		$chars = false;
+		foreach ($arrays as $array) {
+			$chars .= implode('', array_map('chr', $array));
+		}
+
+		return $chars;
+	}
+
+	/**
+	 * Read $length characters from the stream and return a 1-dimensional array
+	 * containing there octet values.
+	 *
+	 * @param int $length
+	 *
+	 * @return int[]
+	 */
+	public function readBytes($length)
+	{
+		if ($this->offset == $this->array_size) {
+			return false;
+		}
+		$arrays = [];
+		$end = $length + $this->offset;
+		for ($i = $this->offset; $i < $end; ++$i) {
+			if (!isset($this->array[$i])) {
+				break;
+			}
+			$arrays[] = $this->array[$i];
+		}
+		$this->offset += ($i - $this->offset); // Limit function calls
+
+		return array_merge(...$arrays);
+	}
+
+	/**
+	 * Write $chars to the end of the stream.
+	 *
+	 * @param string $chars
+	 */
+	public function write($chars)
+	{
+		if (!isset($this->charReader)) {
+			$this->charReader = $this->charReaderFactory->getReaderFor(
+				$this->charset);
+		}
+
+		$startLength = $this->charReader->getInitialByteSize();
+
+		$fp = fopen('php://memory', 'w+b');
+		fwrite($fp, $chars);
+		unset($chars);
+		fseek($fp, 0, SEEK_SET);
+
+		$buffer = [0];
+		$buf_pos = 1;
+		$buf_len = 1;
+		$has_datas = true;
+		do {
+			$bytes = [];
+			// Buffer Filing
+			if ($buf_len - $buf_pos < $startLength) {
+				$buf = array_splice($buffer, $buf_pos);
+				$new = $this->reloadBuffer($fp, 100);
+				if ($new) {
+					$buffer = array_merge($buf, $new);
+					$buf_len = \count($buffer);
+					$buf_pos = 0;
+				} else {
+					$has_datas = false;
+				}
+			}
+			if ($buf_len - $buf_pos > 0) {
+				$size = 0;
+				for ($i = 0; $i < $startLength && isset($buffer[$buf_pos]); ++$i) {
+					++$size;
+					$bytes[] = $buffer[$buf_pos++];
+				}
+				$need = $this->charReader->validateByteSequence(
+					$bytes, $size);
+				if ($need > 0) {
+					if ($buf_len - $buf_pos < $need) {
+						$new = $this->reloadBuffer($fp, $need);
+
+						if ($new) {
+							$buffer = array_merge($buffer, $new);
+							$buf_len = \count($buffer);
+						}
+					}
+					for ($i = 0; $i < $need && isset($buffer[$buf_pos]); ++$i) {
+						$bytes[] = $buffer[$buf_pos++];
+					}
+				}
+				$this->array[] = $bytes;
+				++$this->array_size;
+			}
+		} while ($has_datas);
+
+		fclose($fp);
+	}
+
+	/**
+	 * Move the internal pointer to $charOffset in the stream.
+	 *
+	 * @param int $charOffset
+	 */
+	public function setPointer($charOffset)
+	{
+		if ($charOffset > $this->array_size) {
+			$charOffset = $this->array_size;
+		} elseif ($charOffset < 0) {
+			$charOffset = 0;
+		}
+		$this->offset = $charOffset;
+	}
+
+	/**
+	 * Empty the stream and reset the internal pointer.
+	 */
+	public function flushContents()
+	{
+		$this->offset = 0;
+		$this->array = [];
+		$this->array_size = 0;
+	}
+
+	private function reloadBuffer($fp, $len)
+	{
+		if (!feof($fp) && false !== ($bytes = fread($fp, $len))) {
+			$buf = [];
+			for ($i = 0, $len = \strlen($bytes); $i < $len; ++$i) {
+				$buf[] = self::$byteMap[$bytes[$i]];
+			}
+
+			return $buf;
+		}
+
+		return false;
+	}
+
+	private static function initializeMaps()
+	{
+		if (!isset(self::$charMap)) {
+			self::$charMap = [];
+			for ($byte = 0; $byte < 256; ++$byte) {
+				self::$charMap[$byte] = \chr($byte);
+			}
+			self::$byteMap = array_flip(self::$charMap);
+		}
+	}
 }