smtp.php ➔ smtp_read_response() - Code Metrics - etraxis/etraxis-obsolete - Measure and Improve Code Quality continuously with Scrutinizer

smtp.php ➔ smtp_read_response() A
last analyzed 2017-10-02 00:17 UTC

↳ Parent: Project

Complexity

Conditions	4
Paths	4

Size

Total Lines	20
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	9
nc	4
nop	1
dl	0
loc	20
rs	9.2
c	0
b	0
f	0

<?php

//------------------------------------------------------------------------------
//
//  eTraxis - Records tracking web-based system
//  Copyright (C) 2009  Artem Rodygin
//
//  This program is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
//
//------------------------------------------------------------------------------

/**
 * SMTP functions
 *
 * This module implements simple SMTP client.
 *
 * @package Engine
 */

/**#@+
 * Dependency.
 */
require_once('../engine/debug.php');
/**#@-*/

//------------------------------------------------------------------------------
//  Definitions.
//------------------------------------------------------------------------------

/**#@+
 * Supported SMTP clients.
 */
define('SMTP_CLIENT_PHP',       1);     // PHP MTA
define('SMTP_CLIENT_BUILDIN',   2);     // build-in client
/**#@-*/

//------------------------------------------------------------------------------
//  Functions.
//------------------------------------------------------------------------------

/**
 * Reads all response lines from opened SMTP session and returns SMTP response code.
 *
 * @param string $link Socket of active SMTP session.
 * @return int TRUE if code of SMTP server response means SUCCESS (2xx/3xx), FALSE otherwise.
 */
function smtp_read_response ($link)
{
    debug_write_log(DEBUG_TRACE, '[smtp_read_response]');

    stream_set_timeout($link, SMTP_SERVER_TIMEOUT);

    while (($response = fgets($link)) !== FALSE)
    {
        debug_write_log(DEBUG_DUMP, '[smtp_read_response] ' . trim($response));

        if (substr($response, 3, 1) === ' ')
        {
            $code = intval(substr($response, 0, 3));

            return $code >= 200 && $code < 400;
        }
    }

    return FALSE;
}

/**
 * Sends specified email via SMTP.
 *
 * @param string $to Email addresses of recipients (comma-separated).
 * @param string $subject Subject of the notification.
 * @param string $message Body of the notification.
 * @param string $headers Email headers.
 * @return bool TRUE if the mail was successfully accepted for delivery, FALSE otherwise.
 */
function smtp_send_mail ($to, $subject, $message, $headers)
{
    debug_write_log(DEBUG_TRACE, '[smtp_send_mail]');

    $link = fsockopen(SMTP_SERVER_NAME, SMTP_SERVER_PORT);

    if ($link === FALSE)
    {
        debug_write_log(DEBUG_WARNING, '[smtp_send_mail] Connection to SMTP server cannot be established.');
        return FALSE;
    }

    if (!smtp_read_response($link))
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    {
        debug_write_log(DEBUG_WARNING, '[smtp_send_mail] SMTP server replied a failure.');
        fclose($link);
        return FALSE;
    }

    $requests = array('EHLO ' . php_uname('n'));

    if (SMTP_USE_TLS)
    {
        array_push($requests, 'STARTTLS');
    }

    if (strlen(SMTP_USERNAME) != 0)
    {
        array_push($requests, 'AUTH LOGIN');
        array_push($requests, base64_encode(SMTP_USERNAME));
        array_push($requests, base64_encode(SMTP_PASSWORD));
    }

    array_push($requests, 'MAIL FROM:<' . SMTP_MAILFROM . '>');

    $recipients = explode(', ', $to);

    foreach ($recipients as $recipient)
    {
        array_push($requests, 'RCPT TO:<' . $recipient . '>');
    }

    foreach ($requests as $request)
    {
        debug_write_log(DEBUG_DUMP, '[smtp_send_mail] ' . $request);
        fwrite($link, $request . "\n");

        if (!smtp_read_response($link))
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        {
            debug_write_log(DEBUG_WARNING, '[smtp_send_mail] SMTP server replied a failure.');
            fclose($link);
            return FALSE;
        }

        if ($request == 'STARTTLS')
        {
            if (stream_socket_enable_crypto($link, TRUE, STREAM_CRYPTO_METHOD_TLS_CLIENT))
            {
                debug_write_log(DEBUG_NOTICE, '[smtp_send_mail] TLS encryption successfully initiated.');
            }
            else
            {
                debug_write_log(DEBUG_WARNING, '[smtp_send_mail] TLS encryption failed.');
                fclose($link);
                return FALSE;
            }
        }
    }

    debug_write_log(DEBUG_DUMP, '[smtp_send_mail] DATA');
    fwrite($link, "DATA\n");

    if (!smtp_read_response($link))
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    {
        debug_write_log(DEBUG_WARNING, '[smtp_send_mail] SMTP server replied a failure.');
        fclose($link);
        return FALSE;
    }

    debug_write_log(DEBUG_DUMP, '[smtp_send_mail] ' . $headers);
    debug_write_log(DEBUG_DUMP, '[smtp_send_mail] Subject: ' . $subject);
    debug_write_log(DEBUG_DUMP, '[smtp_send_mail] ' . $message);
    debug_write_log(DEBUG_DUMP, '[smtp_send_mail] .');

    fwrite($link, "{$headers}\r\n");
    fwrite($link, "Subject: {$subject}\r\n\r\n");
    fwrite($link, "{$message}\r\n");
    fwrite($link, ".\r\n");

    if (!smtp_read_response($link))
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    {
        debug_write_log(DEBUG_WARNING, '[smtp_send_mail] SMTP server replied a failure.');
        fclose($link);
        return FALSE;
    }

    debug_write_log(DEBUG_DUMP, '[smtp_send_mail] QUIT');
    fwrite($link, "QUIT\n");

    fclose($link);
    return TRUE;
}

?>



1		<?php
2
3		//------------------------------------------------------------------------------
4		//
5		// eTraxis - Records tracking web-based system
6		// Copyright (C) 2009 Artem Rodygin
7		//
8		// This program is free software: you can redistribute it and/or modify
9		// it under the terms of the GNU General Public License as published by
10		// the Free Software Foundation, either version 3 of the License, or
11		// (at your option) any later version.
12		//
13		// This program is distributed in the hope that it will be useful,
14		// but WITHOUT ANY WARRANTY; without even the implied warranty of
15		// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16		// GNU General Public License for more details.
17		//
18		// You should have received a copy of the GNU General Public License
19		// along with this program. If not, see <http://www.gnu.org/licenses/>.
20		//
21		//------------------------------------------------------------------------------
22
23		/**
24		* SMTP functions
25		*
26		* This module implements simple SMTP client.
27		*
28		* @package Engine
29		*/
30
31		/**#@+
32		* Dependency.
33		*/
34		require_once('../engine/debug.php');
35		/*#@-/
36
37		//------------------------------------------------------------------------------
38		// Definitions.
39		//------------------------------------------------------------------------------
40
41		/**#@+
42		* Supported SMTP clients.
43		*/
44		define('SMTP_CLIENT_PHP', 1); // PHP MTA
45		define('SMTP_CLIENT_BUILDIN', 2); // build-in client
46		/*#@-/
47
48		//------------------------------------------------------------------------------
49		// Functions.
50		//------------------------------------------------------------------------------
51
52		/**
53		* Reads all response lines from opened SMTP session and returns SMTP response code.
54		*
55		* @param string $link Socket of active SMTP session.
56		* @return int TRUE if code of SMTP server response means SUCCESS (2xx/3xx), FALSE otherwise.
57		*/
58		function smtp_read_response ($link)
59		{
60		debug_write_log(DEBUG_TRACE, '[smtp_read_response]');
61
62		stream_set_timeout($link, SMTP_SERVER_TIMEOUT);
63
64		while (($response = fgets($link)) !== FALSE)
65		{
66		debug_write_log(DEBUG_DUMP, '[smtp_read_response] ' . trim($response));
67
68		if (substr($response, 3, 1) === ' ')
69		{
70		$code = intval(substr($response, 0, 3));
71
72		return $code >= 200 && $code < 400;
73		}
74		}
75
76		return FALSE;
77		}
78
79		/**
80		* Sends specified email via SMTP.
81		*
82		* @param string $to Email addresses of recipients (comma-separated).
83		* @param string $subject Subject of the notification.
84		* @param string $message Body of the notification.
85		* @param string $headers Email headers.
86		* @return bool TRUE if the mail was successfully accepted for delivery, FALSE otherwise.
87		*/
88		function smtp_send_mail ($to, $subject, $message, $headers)
89		{
90		debug_write_log(DEBUG_TRACE, '[smtp_send_mail]');
91
92		$link = fsockopen(SMTP_SERVER_NAME, SMTP_SERVER_PORT);
93
94		if ($link === FALSE)
95		{
96		debug_write_log(DEBUG_WARNING, '[smtp_send_mail] Connection to SMTP server cannot be established.');
97		return FALSE;
98		}
99
100	View Code Duplication	if (!smtp_read_response($link))
		0 ignored issues – show Documentation introduced 2016-02-05 20:14 UTC by Report Bug Copy Issue Report `$link` is of type `resource`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Duplication introduced 2016-02-05 20:15 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
101		{
102		debug_write_log(DEBUG_WARNING, '[smtp_send_mail] SMTP server replied a failure.');
103		fclose($link);
104		return FALSE;
105		}
106
107		$requests = array('EHLO ' . php_uname('n'));
108
109		if (SMTP_USE_TLS)
110		{
111		array_push($requests, 'STARTTLS');
112		}
113
114		if (strlen(SMTP_USERNAME) != 0)
115		{
116		array_push($requests, 'AUTH LOGIN');
117		array_push($requests, base64_encode(SMTP_USERNAME));
118		array_push($requests, base64_encode(SMTP_PASSWORD));
119		}
120
121		array_push($requests, 'MAIL FROM:<' . SMTP_MAILFROM . '>');
122
123		$recipients = explode(', ', $to);
124
125		foreach ($recipients as $recipient)
126		{
127		array_push($requests, 'RCPT TO:<' . $recipient . '>');
128		}
129
130		foreach ($requests as $request)
131		{
132		debug_write_log(DEBUG_DUMP, '[smtp_send_mail] ' . $request);
133		fwrite($link, $request . "\n");
134
135	View Code Duplication	if (!smtp_read_response($link))
		0 ignored issues – show Documentation introduced 2016-02-05 20:14 UTC by Report Bug Copy Issue Report `$link` is of type `resource`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Duplication introduced 2016-02-05 20:15 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
136		{
137		debug_write_log(DEBUG_WARNING, '[smtp_send_mail] SMTP server replied a failure.');
138		fclose($link);
139		return FALSE;
140		}
141
142		if ($request == 'STARTTLS')
143		{
144		if (stream_socket_enable_crypto($link, TRUE, STREAM_CRYPTO_METHOD_TLS_CLIENT))
145		{
146		debug_write_log(DEBUG_NOTICE, '[smtp_send_mail] TLS encryption successfully initiated.');
147		}
148		else
149		{
150		debug_write_log(DEBUG_WARNING, '[smtp_send_mail] TLS encryption failed.');
151		fclose($link);
152		return FALSE;
153		}
154		}
155		}
156
157		debug_write_log(DEBUG_DUMP, '[smtp_send_mail] DATA');
158		fwrite($link, "DATA\n");
159
160	View Code Duplication	if (!smtp_read_response($link))
		0 ignored issues – show Documentation introduced 2016-02-05 20:14 UTC by Report Bug Copy Issue Report `$link` is of type `resource`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Duplication introduced 2016-02-05 20:15 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
161		{
162		debug_write_log(DEBUG_WARNING, '[smtp_send_mail] SMTP server replied a failure.');
163		fclose($link);
164		return FALSE;
165		}
166
167		debug_write_log(DEBUG_DUMP, '[smtp_send_mail] ' . $headers);
168		debug_write_log(DEBUG_DUMP, '[smtp_send_mail] Subject: ' . $subject);
169		debug_write_log(DEBUG_DUMP, '[smtp_send_mail] ' . $message);
170		debug_write_log(DEBUG_DUMP, '[smtp_send_mail] .');
171
172		fwrite($link, "{$headers}\r\n");
173		fwrite($link, "Subject: {$subject}\r\n\r\n");
174		fwrite($link, "{$message}\r\n");
175		fwrite($link, ".\r\n");
176
177	View Code Duplication	if (!smtp_read_response($link))
		0 ignored issues – show Documentation introduced 2016-02-05 20:14 UTC by Report Bug Copy Issue Report `$link` is of type `resource`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Duplication introduced 2016-02-05 20:15 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
178		{
179		debug_write_log(DEBUG_WARNING, '[smtp_send_mail] SMTP server replied a failure.');
180		fclose($link);
181		return FALSE;
182		}
183
184		debug_write_log(DEBUG_DUMP, '[smtp_send_mail] QUIT');
185		fwrite($link, "QUIT\n");
186
187		fclose($link);
188		return TRUE;
189		}
190
191		?>
		0 ignored issues – show Best Practice introduced 2016-02-05 20:14 UTC by Report Bug Copy Issue Report It is not recommended to use PHP's closing tag `?>` in files other than templates. Using a closing tag in PHP files that only contain PHP code is not recommended as you might accidentally add whitespace after the closing tag which would then be output by PHP. This can cause severe problems, for example headers cannot be sent anymore. A simple precaution is to leave off the closing tag as it is not required, and it also has no negative effects whatsoever. Loading history...
192

etraxis / etraxis-obsolete

smtp.php ➔ smtp_read_response() A last analyzed 2017-10-02 00:17 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

smtp.php ➔ smtp_read_response() A
last analyzed 2017-10-02 00:17 UTC