update phpMailer to 5.2.9

Signed-off-by: Michael Kaufmann (d00p) <d00p@froxlor.org>
2015-01-07 18:12:27 +01:00
parent c0f2745d30
commit bcd49186fb
2 changed files with 440 additions and 371 deletions
--- a/lib/classes/phpmailer/class.PHPMailer.php
+++ b/lib/classes/phpmailer/class.PHPMailer.php
--- a/lib/classes/phpmailer/class.SMTP.php
+++ b/lib/classes/phpmailer/class.SMTP.php
@@ -30,7 +30,7 @@ class SMTP
     * The PHPMailer SMTP version number.
     * @type string
     */
-    const VERSION = '5.2.8';
+    const VERSION = '5.2.9';

    /**
     * SMTP line break constant.
@@ -40,28 +40,53 @@ class SMTP

    /**
     * The SMTP port to use if one is not specified.
-     * @type int
+     * @type integer
     */
    const DEFAULT_SMTP_PORT = 25;

    /**
     * The maximum line length allowed by RFC 2822 section 2.1.1
-     * @type int
+     * @type integer
     */
    const MAX_LINE_LENGTH = 998;

+    /**
+     * Debug level for no output
+     */
+    const DEBUG_OFF = 0;
+
+    /**
+     * Debug level to show client -> server messages
+     */
+    const DEBUG_CLIENT = 1;
+
+    /**
+     * Debug level to show client -> server and server -> client messages
+     */
+    const DEBUG_SERVER = 2;
+
+    /**
+     * Debug level to show connection status, client -> server and server -> client messages
+     */
+    const DEBUG_CONNECTION = 3;
+
+    /**
+     * Debug level to show all messages
+     */
+    const DEBUG_LOWLEVEL = 4;
+
    /**
     * The PHPMailer SMTP Version number.
     * @type string
-     * @deprecated Use the constant instead
+     * @deprecated Use the `VERSION` constant instead
     * @see SMTP::VERSION
     */
-    public $Version = '5.2.8';
+    public $Version = '5.2.9';

    /**
     * SMTP server port number.
-     * @type int
-     * @deprecated This is only ever used as a default value, so use the constant instead
+     * @type integer
+     * @deprecated This is only ever used as a default value, so use the `DEFAULT_SMTP_PORT` constant instead
     * @see SMTP::DEFAULT_SMTP_PORT
     */
    public $SMTP_PORT = 25;
@@ -69,7 +94,7 @@ class SMTP
    /**
     * SMTP reply line ending.
     * @type string
-     * @deprecated Use the constant instead
+     * @deprecated Use the `CRLF` constant instead
     * @see SMTP::CRLF
     */
    public $CRLF = "\r\n";
@@ -77,22 +102,27 @@ class SMTP
    /**
     * Debug output level.
     * Options:
-     * * `0` No output
-     * * `1` Commands
-     * * `2` Data and commands
-     * * `3` As 2 plus connection status
-     * * `4` Low-level data output
-     * @type int
+     * * self::DEBUG_OFF (`0`) No debug output, default
+     * * self::DEBUG_CLIENT (`1`) Client commands
+     * * self::DEBUG_SERVER (`2`) Client commands and server responses
+     * * self::DEBUG_CONNECTION (`3`) As DEBUG_SERVER plus connection status
+     * * self::DEBUG_LOWLEVEL (`4`) Low-level data output, all messages
+     * @type integer
     */
-    public $do_debug = 0;
+    public $do_debug = self::DEBUG_OFF;

    /**
     * How to handle debug output.
     * Options:
     * * `echo` Output plain-text as-is, appropriate for CLI
-     * * `html` Output escaped, line breaks converted to <br>, appropriate for browser output
+     * * `html` Output escaped, line breaks converted to `<br>`, appropriate for browser output
     * * `error_log` Output to error log as configured in php.ini
-     * @type string
+     *
+     * Alternatively, you can provide a callable expecting two params: a message string and the debug level:
+     * <code>
+     * $smtp->Debugoutput = function($str, $level) {echo "debug level $level; message: $str";};
+     * </code>
+     * @type string|callable
     */
    public $Debugoutput = 'echo';

@@ -100,7 +130,7 @@ class SMTP
     * Whether to use VERP.
     * @link http://en.wikipedia.org/wiki/Variable_envelope_return_path
     * @link http://www.postfix.org/VERP_README.html Info on VERP
-     * @type bool
+     * @type boolean
     */
    public $do_verp = false;

@@ -109,13 +139,13 @@ class SMTP
     * Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2
     * This needs to be quite high to function correctly with hosts using greetdelay as an anti-spam measure.
     * @link http://tools.ietf.org/html/rfc2821#section-4.5.3.2
-     * @type int
+     * @type integer
     */
    public $Timeout = 300;

    /**
     * The SMTP timelimit value for reads, in seconds.
-     * @type int
+     * @type integer
     */
    public $Timelimit = 30;

@@ -127,15 +157,16 @@ class SMTP

    /**
     * Error message, if any, for the last call.
-     * @type string
+     * @type array
     */
-    protected $error = '';
+    protected $error = array();

    /**
     * The reply the server sent to us for HELO.
-     * @type string
+     * If null, no HELO string has yet been received.
+     * @type string|null
     */
-    protected $helo_rply = '';
+    protected $helo_rply = null;

    /**
     * The most recent reply received from the server.
@@ -143,25 +174,23 @@ class SMTP
     */
    protected $last_reply = '';

-    /**
-     * Constructor.
-     * @access public
-     */
-    public function __construct()
-    {
-        $this->smtp_conn = 0;
-        $this->error = null;
-        $this->helo_rply = null;
-        $this->do_debug = 0;
-    }
-
    /**
     * Output debugging info via a user-selected method.
+     * @see SMTP::$Debugoutput
+     * @see SMTP::$do_debug
     * @param string $str Debug string to output
+     * @param integer $level The debug level of this message; see DEBUG_* constants
     * @return void
     */
-    protected function edebug($str)
+    protected function edebug($str, $level = 0)
    {
+        if ($level > $this->do_debug) {
+            return;
+        }
+        if (is_callable($this->Debugoutput)) {
+            call_user_func($this->Debugoutput, $str, $this->do_debug);
+            return;
+        }
        switch ($this->Debugoutput) {
            case 'error_log':
                //Don't output, just log
@@ -178,23 +207,35 @@ class SMTP
                break;
            case 'echo':
            default:
-                echo gmdate('Y-m-d H:i:s')."\t".trim($str)."\n";
+                //Normalize line breaks
+                $str = preg_replace('/(\r\n|\r|\n)/ms', "\n", $str);
+                echo gmdate('Y-m-d H:i:s') . "\t" . str_replace(
+                    "\n",
+                    "\n                   \t                  ",
+                    trim($str)
+                )."\n";
        }
    }

    /**
     * Connect to an SMTP server.
     * @param string $host SMTP server IP or host name
-     * @param int $port The port number to connect to
-     * @param int $timeout How long to wait for the connection to open
+     * @param integer $port The port number to connect to
+     * @param integer $timeout How long to wait for the connection to open
     * @param array $options An array of options for stream_context_create()
     * @access public
-     * @return bool
+     * @return boolean
     */
    public function connect($host, $port = null, $timeout = 30, $options = array())
    {
+        static $streamok;
+        //This is enabled by default since 5.0.0 but some providers disable it
+        //Check this once and cache the result
+        if (is_null($streamok)) {
+            $streamok = function_exists('stream_socket_client');
+        }
        // Clear errors to avoid confusion
-        $this->error = null;
+        $this->error = array();
        // Make sure we are __not__ connected
        if ($this->connected()) {
            // Already connected, generate error
@@ -205,11 +246,13 @@ class SMTP
            $port = self::DEFAULT_SMTP_PORT;
        }
        // Connect to the SMTP server
-        if ($this->do_debug >= 3) {
-            $this->edebug('Connection: opening');
-        }
+        $this->edebug(
+            "Connection: opening to $host:$port, t=$timeout, opt=".var_export($options, true),
+            self::DEBUG_CONNECTION
+        );
        $errno = 0;
        $errstr = '';
+        if ($streamok) {
            $socket_context = stream_context_create($options);
            //Suppress errors; connection failures are handled at a higher level
            $this->smtp_conn = @stream_socket_client(
@@ -220,24 +263,35 @@ class SMTP
                STREAM_CLIENT_CONNECT,
                $socket_context
            );
+        } else {
+            //Fall back to fsockopen which should work in more places, but is missing some features
+            $this->edebug(
+                "Connection: stream_socket_client not available, falling back to fsockopen",
+                self::DEBUG_CONNECTION
+            );
+            $this->smtp_conn = fsockopen(
+                $host,
+                $port,
+                $errno,
+                $errstr,
+                $timeout
+            );
+        }
        // Verify we connected properly
-        if (empty($this->smtp_conn)) {
+        if (!is_resource($this->smtp_conn)) {
            $this->error = array(
                'error' => 'Failed to connect to server',
                'errno' => $errno,
                'errstr' => $errstr
            );
-            if ($this->do_debug >= 1) {
            $this->edebug(
                'SMTP ERROR: ' . $this->error['error']
-                    . ": $errstr ($errno)"
+                . ": $errstr ($errno)",
+                self::DEBUG_CLIENT
            );
-            }
            return false;
        }
-        if ($this->do_debug >= 3) {
-            $this->edebug('Connection: opened');
-        }
+        $this->edebug('Connection: opened', self::DEBUG_CONNECTION);
        // SMTP server can take longer to respond, give longer timeout for first read
        // Windows does not have support for this timeout function
        if (substr(PHP_OS, 0, 3) != 'WIN') {
@@ -249,16 +303,14 @@ class SMTP
        }
        // Get any announcement
        $announce = $this->get_lines();
-        if ($this->do_debug >= 2) {
-            $this->edebug('SERVER -> CLIENT: ' . $announce);
-        }
+        $this->edebug('SERVER -> CLIENT: ' . $announce, self::DEBUG_SERVER);
        return true;
    }

    /**
     * Initiate a TLS (encrypted) session.
     * @access public
-     * @return bool
+     * @return boolean
     */
    public function startTLS()
    {
@@ -286,7 +338,7 @@ class SMTP
     * @param string $realm       The auth realm for NTLM
     * @param string $workstation The auth workstation for NTLM
     * @access public
-     * @return bool True if successfully authenticated.
+     * @return boolean True if successfully authenticated.
     */
    public function authenticate(
        $username,
@@ -341,12 +393,11 @@ class SMTP
                //Check that functions are available
                if (!$ntlm_client->Initialize($temp)) {
                    $this->error = array('error' => $temp->error);
-                    if ($this->do_debug >= 1) {
                    $this->edebug(
                        'You need to enable some modules in your php.ini file: '
-                            . $this->error['error']
+                        . $this->error['error'],
+                        self::DEBUG_CLIENT
                    );
-                    }
                    return false;
                }
                //msg1
@@ -377,7 +428,6 @@ class SMTP
                );
                // send encoded username
                return $this->sendCommand('Username', base64_encode($msg3), 235);
-                break;
            case 'CRAM-MD5':
                // Start authentication
                if (!$this->sendCommand('AUTH CRAM-MD5', 'AUTH CRAM-MD5', 334)) {
@@ -391,7 +441,6 @@ class SMTP

                // send encoded credentials
                return $this->sendCommand('Username', base64_encode($response), 235);
-                break;
        }
        return true;
    }
@@ -417,7 +466,7 @@ class SMTP
        // RFC 2104 HMAC implementation for php.
        // Creates an md5 HMAC.
        // Eliminates the need to install mhash to compute a HMAC
-        // Hacked by Lance Rushing
+        // by Lance Rushing

        $bytelen = 64; // byte length for md5
        if (strlen($key) > $bytelen) {
@@ -435,19 +484,18 @@ class SMTP
    /**
     * Check connection state.
     * @access public
-     * @return bool True if connected.
+     * @return boolean True if connected.
     */
    public function connected()
    {
-        if (!empty($this->smtp_conn)) {
+        if (is_resource($this->smtp_conn)) {
            $sock_status = stream_get_meta_data($this->smtp_conn);
            if ($sock_status['eof']) {
-                // the socket is valid but we are not connected
-                if ($this->do_debug >= 1) {
+                // The socket is valid but we are not connected
                $this->edebug(
-                        'SMTP NOTICE: EOF caught while checking if connected'
+                    'SMTP NOTICE: EOF caught while checking if connected',
+                    self::DEBUG_CLIENT
                );
-                }
                $this->close();
                return false;
            }
@@ -465,15 +513,13 @@ class SMTP
     */
    public function close()
    {
-        $this->error = null; // so there is no confusion
+        $this->error = array();
        $this->helo_rply = null;
-        if (!empty($this->smtp_conn)) {
+        if (is_resource($this->smtp_conn)) {
            // close the connection and cleanup
            fclose($this->smtp_conn);
-            if ($this->do_debug >= 3) {
-                $this->edebug('Connection: closed');
-            }
-            $this->smtp_conn = 0;
+            $this->smtp_conn = null; //Makes for cleaner serialization
+            $this->edebug('Connection: closed', self::DEBUG_CONNECTION);
        }
    }

@@ -487,7 +533,7 @@ class SMTP
     * Implements rfc 821: DATA <CRLF>
     * @param string $msg_data Message data to send
     * @access public
-     * @return bool
+     * @return boolean
     */
    public function data($msg_data)
    {
@@ -569,12 +615,12 @@ class SMTP
     * and RFC 2821 EHLO.
     * @param string $host The host name or IP to connect to
     * @access public
-     * @return bool
+     * @return boolean
     */
    public function hello($host = '')
    {
        // Try extended hello first (RFC 2821)
-        return (bool)($this->sendHello('EHLO', $host) or $this->sendHello('HELO', $host));
+        return (boolean)($this->sendHello('EHLO', $host) or $this->sendHello('HELO', $host));
    }

    /**
@@ -584,7 +630,7 @@ class SMTP
     * @param string $hello The HELO string
     * @param string $host The hostname to say we are
     * @access protected
-     * @return bool
+     * @return boolean
     */
    protected function sendHello($hello, $host)
    {
@@ -602,7 +648,7 @@ class SMTP
     * Implements rfc 821: MAIL <SP> FROM:<reverse-path> <CRLF>
     * @param string $from Source address of this message
     * @access public
-     * @return bool
+     * @return boolean
     */
    public function mail($from)
    {
@@ -618,9 +664,9 @@ class SMTP
     * Send an SMTP QUIT command.
     * Closes the socket if there is no error or the $close_on_error argument is true.
     * Implements from rfc 821: QUIT <CRLF>
-     * @param bool $close_on_error Should the connection close if an error occurs?
+     * @param boolean $close_on_error Should the connection close if an error occurs?
     * @access public
-     * @return bool
+     * @return boolean
     */
    public function quit($close_on_error = true)
    {
@@ -640,7 +686,7 @@ class SMTP
     * Implements from rfc 821: RCPT <SP> TO:<forward-path> <CRLF>
     * @param string $toaddr The address the message is being sent to
     * @access public
-     * @return bool
+     * @return boolean
     */
    public function recipient($toaddr)
    {
@@ -656,7 +702,7 @@ class SMTP
     * Abort any transaction that is currently in progress.
     * Implements rfc 821: RSET <CRLF>
     * @access public
-     * @return bool True on success.
+     * @return boolean True on success.
     */
    public function reset()
    {
@@ -667,9 +713,9 @@ class SMTP
     * Send a command to an SMTP server and check its return code.
     * @param string $command       The command name - not sent to the server
     * @param string $commandstring The actual command to send
-     * @param int|array $expect     One or more expected integer success codes
+     * @param integer|array $expect     One or more expected integer success codes
     * @access protected
-     * @return bool True on success.
+     * @return boolean True on success.
     */
    protected function sendCommand($command, $commandstring, $expect)
    {
@@ -681,30 +727,25 @@ class SMTP
        }
        $this->client_send($commandstring . self::CRLF);

-        $reply = $this->get_lines();
-        $code = substr($reply, 0, 3);
+        $this->last_reply = $this->get_lines();
+        $code = substr($this->last_reply, 0, 3);

-        if ($this->do_debug >= 2) {
-            $this->edebug('SERVER -> CLIENT: ' . $reply);
-        }
+        $this->edebug('SERVER -> CLIENT: ' . $this->last_reply, self::DEBUG_SERVER);

        if (!in_array($code, (array)$expect)) {
-            $this->last_reply = null;
            $this->error = array(
                'error' => "$command command failed",
                'smtp_code' => $code,
-                'detail' => substr($reply, 4)
+                'detail' => substr($this->last_reply, 4)
            );
-            if ($this->do_debug >= 1) {
            $this->edebug(
-                    'SMTP ERROR: ' . $this->error['error'] . ': ' . $reply
+                'SMTP ERROR: ' . $this->error['error'] . ': ' . $this->last_reply,
+                self::DEBUG_CLIENT
            );
-            }
            return false;
        }

-        $this->last_reply = $reply;
-        $this->error = null;
+        $this->error = array();
        return true;
    }

@@ -719,7 +760,7 @@ class SMTP
     * Implements rfc 821: SAML <SP> FROM:<reverse-path> <CRLF>
     * @param string $from The address the message is from
     * @access public
-     * @return bool
+     * @return boolean
     */
    public function sendAndMail($from)
    {
@@ -730,7 +771,7 @@ class SMTP
     * Send an SMTP VRFY command.
     * @param string $name The name to verify
     * @access public
-     * @return bool
+     * @return boolean
     */
    public function verify($name)
    {
@@ -741,7 +782,7 @@ class SMTP
     * Send an SMTP NOOP command.
     * Used to keep keep-alives alive, doesn't actually do anything
     * @access public
-     * @return bool
+     * @return boolean
     */
    public function noop()
    {
@@ -755,16 +796,14 @@ class SMTP
     * and _may_ be implemented in future
     * Implements from rfc 821: TURN <CRLF>
     * @access public
-     * @return bool
+     * @return boolean
     */
    public function turn()
    {
        $this->error = array(
            'error' => 'The SMTP TURN command is not implemented'
        );
-        if ($this->do_debug >= 1) {
-            $this->edebug('SMTP NOTICE: ' . $this->error['error']);
-        }
+        $this->edebug('SMTP NOTICE: ' . $this->error['error'], self::DEBUG_CLIENT);
        return false;
    }

@@ -772,13 +811,11 @@ class SMTP
     * Send raw data to the server.
     * @param string $data The data to send
     * @access public
-     * @return int|bool The number of bytes sent to the server or false on error
+     * @return integer|boolean The number of bytes sent to the server or false on error
     */
    public function client_send($data)
    {
-        if ($this->do_debug >= 1) {
-            $this->edebug("CLIENT -> SERVER: $data");
-        }
+        $this->edebug("CLIENT -> SERVER: $data", self::DEBUG_CLIENT);
        return fwrite($this->smtp_conn, $data);
    }

@@ -825,14 +862,10 @@ class SMTP
        }
        while (is_resource($this->smtp_conn) && !feof($this->smtp_conn)) {
            $str = @fgets($this->smtp_conn, 515);
-            if ($this->do_debug >= 4) {
-                $this->edebug("SMTP -> get_lines(): \$data was \"$data\"");
-                $this->edebug("SMTP -> get_lines(): \$str is \"$str\"");
-            }
+            $this->edebug("SMTP -> get_lines(): \$data was \"$data\"", self::DEBUG_LOWLEVEL);
+            $this->edebug("SMTP -> get_lines(): \$str is \"$str\"", self::DEBUG_LOWLEVEL);
            $data .= $str;
-            if ($this->do_debug >= 4) {
-                $this->edebug("SMTP -> get_lines(): \$data is \"$data\"");
-            }
+            $this->edebug("SMTP -> get_lines(): \$data is \"$data\"", self::DEBUG_LOWLEVEL);
            // If 4th character is a space, we are done reading, break the loop, micro-optimisation over strlen
            if ((isset($str[3]) and $str[3] == ' ')) {
                break;
@@ -840,21 +873,19 @@ class SMTP
            // Timed-out? Log and break
            $info = stream_get_meta_data($this->smtp_conn);
            if ($info['timed_out']) {
-                if ($this->do_debug >= 4) {
                $this->edebug(
-                        'SMTP -> get_lines(): timed-out (' . $this->Timeout . ' sec)'
+                    'SMTP -> get_lines(): timed-out (' . $this->Timeout . ' sec)',
+                    self::DEBUG_LOWLEVEL
                );
-                }
                break;
            }
            // Now check if reads took too long
            if ($endtime and time() > $endtime) {
-                if ($this->do_debug >= 4) {
                $this->edebug(
                    'SMTP -> get_lines(): timelimit reached ('.
-                        $this->Timelimit . ' sec)'
+                    $this->Timelimit . ' sec)',
+                    self::DEBUG_LOWLEVEL
                );
-                }
                break;
            }
        }
@@ -863,7 +894,7 @@ class SMTP

    /**
     * Enable or disable VERP address generation.
-     * @param bool $enabled
+     * @param boolean $enabled
     */
    public function setVerp($enabled = false)
    {
@@ -872,7 +903,7 @@ class SMTP

    /**
     * Get VERP address generation mode.
-     * @return bool
+     * @return boolean
     */
    public function getVerp()
    {
@@ -899,7 +930,7 @@ class SMTP

    /**
     * Set debug output level.
-     * @param int $level
+     * @param integer $level
     */
    public function setDebugLevel($level = 0)
    {
@@ -908,7 +939,7 @@ class SMTP

    /**
     * Get debug output level.
-     * @return int
+     * @return integer
     */
    public function getDebugLevel()
    {
@@ -917,7 +948,7 @@ class SMTP

    /**
     * Set SMTP timeout.
-     * @param int $timeout
+     * @param integer $timeout
     */
    public function setTimeout($timeout = 0)
    {
@@ -926,7 +957,7 @@ class SMTP

    /**
     * Get SMTP timeout.
-     * @return int
+     * @return integer
     */
    public function getTimeout()
    {