Driver_SMTP::send() - Code Metrics - csphere-cms/cSphere - Measure and Improve Code Quality continuously with Scrutinizer

Driver_SMTP::send() A
last analyzed 2017-04-21 16:53 UTC

↳ Parent: Driver_SMTP

Complexity

Conditions	1
Paths	1

Size

Total Lines	14
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	6
nc	1
nop	2
dl	0
loc	14
rs	9.4285
c	0
b	0
f	0

<?php

/**
 * Provides mail functionality using a remote smtp connection
 *
 * PHP Version 5
 *
 * @category  Core
 * @package   Mail
 * @author    Hans-Joachim Piepereit <[email protected]>
 * @copyright 2013 cSphere Team
 * @license   http://opensource.org/licenses/bsd-license Simplified BSD License
 * @link      http://www.csphere.eu
 **/

namespace csphere\core\mail;

/**
 * Provides mail functionality using a remote smtp connection
 *
 * @category  Core
 * @package   Mail
 * @author    Hans-Joachim Piepereit <[email protected]>
 * @copyright 2013 cSphere Team
 * @license   http://opensource.org/licenses/bsd-license Simplified BSD License
 * @link      http://www.csphere.eu
 **/

class Driver_SMTP extends Base
{
    /**
     * Stores the server address
     **/
     private $_server = '';


    /**
     * Creates the mail handler object
     *
     * @param array $config Configuration details as an array
     *
     * @return \csphere\core\mail\Driver_SMTP
     **/


    public function __construct(array $config)
    {
        parent::__construct($config);

        // Get server address of this machine
        $this->_server = \csphere\core\http\Input::get('server', 'SERVER_ADDR');
    }

    /**
     * Prepares a command list for later usage
     *
     * @param string $email Email target
     *
     * @return array
     **/


    private function _commands($email)
    {
        // Prepare header data
        $headers   = [];
        $headers[] = 'To: ' . $email;
        $headers[] = 'Subject: ' . $this->content['subject_b64'];

        $headers = implode($this->config['eol'], $this->headers);

        // Combine content parts
        $data = $headers . $this->config['eol']
              . $this->content['message_b64'] . $this->config['eol'] . '.';

        // Create command list
        $commands = ['helo' => 'HELO ' . $this->_server,
                     'login' => 'AUTH LOGIN',
                     'user' => base64_encode($this->config['username']),
                     'pw' => base64_encode($this->config['password']),
                     'from' => 'MAIL FROM:' . $this->config['from'],
                     'to' => 'RCPT TO:' . $email,
                     'data' => 'DATA',
                     'response' => $data,
                     'quit' => 'QUIT'];

        return $commands;
    }

    /**
     * Execute the commands on smtp server
     *
     * @param array $commands Commands to work with
     *
     * @return boolean
     **/


    private function _remote(array $commands)
    {
        $result = false;

        $log = [];

        // Open connection to smtp server
        $remote = fsockopen($this->config['host'], (int)$this->config['port']);

        // On success proceed
        if (is_resource($remote)) {

            // Set timeout
            stream_set_timeout($remote, (int)$this->config['timeout']);

            foreach ($commands AS $com_name => $com_exec) {

                // Send command and get answer
                fwrite($remote, $com_exec . $this->config['eol']);

                $read = fread($remote, 2048);

                // Store communication in log
                $log[] = $com_name . ': ' . $read;

                // Stop on bad status code
                $code = (int) substr($read, 0, 3);

                if ($code >= 400) {

                    fclose($remote);

                    $this->_errorlog($code, (array)$log);

                    return false;
                }
            }

            // Tidy up and store success
            fclose($remote);

            $result = true;

        }

        return $result;
    }

    /**
     * Handle SMTP Server communication errors
     *
     * @param integer $code Status code
     * @param array   $log  Log as an array
     *
     * @throws \Exception
     *
     * @return void
     **/


    private function _errorlog($code, array $log)
    {
        $error = empty($code) ? 'Unknown' : 'Bad status code - ' . $code;

        // Append server communication
        $error .= "\n" . 'Communication:' . "\n" . implode("\n", $log);

        // Throw exception
        throw new \Exception($error);
    }

    /**
     * Prepares a mail by setting its content
     *
     * @param string $subject Subject to use in email
     * @param string $message Message to use in email
     * @param string $type    Defaults to text/plain
     *
     * @return boolean
     **/


    public function prepare($subject, $message, $type = 'text/plain')
    {
        // Run initial preparations
        parent::prepare($subject, $message, $type);

        // Set header data
        $headers = ['MIME-Version: 1.0',
                    'Content-Type: ' . $type . '; charset=UTF-8',
                    'Content-Transfer-Encoding: base64',
                    'X-Mailer: cSphere',
                    'From: ' . $this->config['from']];

        $this->headers = array_merge($this->headers, $headers);

        // Create encoded subject and content strings
        $this->encode();

        return true;
    }

    /**
     * Sends the prepared content to a given email
     *
     * @param string  $email Email target
     * @param boolean $clear Defaults to true which keeps mail data
     *
     * @return boolean
     **/


    public function send($email, $clear = true)
    {
        // Send mail
        $commands = $this->_commands($email);

        $send = $this->_remote($commands);

        // Log mail and handle clear status
        $this->log($email, $send);

        $this->clear($clear);

        return $send;
    }
}


1			<?php
2
3			/**
4			* Provides mail functionality using a remote smtp connection
5			*
6			* PHP Version 5
7			*
8			* @category Core
9			* @package Mail
10			* @author Hans-Joachim Piepereit <[email protected]>
11			* @copyright 2013 cSphere Team
12			* @license http://opensource.org/licenses/bsd-license Simplified BSD License
13			* @link http://www.csphere.eu
14			**/
15
16			namespace csphere\core\mail;
17
18			/**
19			* Provides mail functionality using a remote smtp connection
20			*
21			* @category Core
22			* @package Mail
23			* @author Hans-Joachim Piepereit <[email protected]>
24			* @copyright 2013 cSphere Team
25			* @license http://opensource.org/licenses/bsd-license Simplified BSD License
26			* @link http://www.csphere.eu
27			**/
28
29			class Driver_SMTP extends Base
30			{
31			/**
32			* Stores the server address
33			**/
34			private $_server = '';
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 4 spaces, found 5 Loading history...
35
36			/**
37			* Creates the mail handler object
38			*
39			* @param array $config Configuration details as an array
40			*
41			* @return \csphere\core\mail\Driver_SMTP
42			**/
			0 ignored issues – show Comprehensibility Best Practice introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history... Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
43
44			public function __construct(array $config)
45			{
46			parent::__construct($config);
47
48			// Get server address of this machine
49			$this->_server = \csphere\core\http\Input::get('server', 'SERVER_ADDR');
50			}
51
52			/**
53			* Prepares a command list for later usage
54			*
55			* @param string $email Email target
56			*
57			* @return array
58			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
59
60			private function _commands($email)
61			{
62			// Prepare header data
63			$headers = [];
64			$headers[] = 'To: ' . $email;
65			$headers[] = 'Subject: ' . $this->content['subject_b64'];
66
67			$headers = implode($this->config['eol'], $this->headers);
68
69			// Combine content parts
70			$data = $headers . $this->config['eol']
71			. $this->content['message_b64'] . $this->config['eol'] . '.';
72
73			// Create command list
74			$commands = ['helo' => 'HELO ' . $this->_server,
75			'login' => 'AUTH LOGIN',
76			'user' => base64_encode($this->config['username']),
77			'pw' => base64_encode($this->config['password']),
78			'from' => 'MAIL FROM:' . $this->config['from'],
79			'to' => 'RCPT TO:' . $email,
80			'data' => 'DATA',
81			'response' => $data,
82			'quit' => 'QUIT'];
83
84			return $commands;
85			}
86
87			/**
88			* Execute the commands on smtp server
89			*
90			* @param array $commands Commands to work with
91			*
92			* @return boolean
93			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
94
95			private function _remote(array $commands)
96			{
97			$result = false;
98
99			$log = [];
100
101			// Open connection to smtp server
102			$remote = fsockopen($this->config['host'], (int)$this->config['port']);
103
104			// On success proceed
105			if (is_resource($remote)) {
106
107			// Set timeout
108			stream_set_timeout($remote, (int)$this->config['timeout']);
109
110			foreach ($commands AS $com_name => $com_exec) {
111
112			// Send command and get answer
113			fwrite($remote, $com_exec . $this->config['eol']);
114
115			$read = fread($remote, 2048);
116
117			// Store communication in log
118			$log[] = $com_name . ': ' . $read;
119
120			// Stop on bad status code
121			$code = (int) substr($read, 0, 3);
122
123			if ($code >= 400) {
124
125			fclose($remote);
126
127			$this->_errorlog($code, (array)$log);
128
129			return false;
130			}
131			}
132
133			// Tidy up and store success
134			fclose($remote);
135
136			$result = true;
137
138			}
139
140			return $result;
141			}
142
143			/**
144			* Handle SMTP Server communication errors
145			*
146			* @param integer $code Status code
147			* @param array $log Log as an array
148			*
149			* @throws \Exception
150			*
151			* @return void
152			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
153
154			private function _errorlog($code, array $log)
155			{
156			$error = empty($code) ? 'Unknown' : 'Bad status code - ' . $code;
157
158			// Append server communication
159			$error .= "\n" . 'Communication:' . "\n" . implode("\n", $log);
160
161			// Throw exception
162			throw new \Exception($error);
163			}
164
165			/**
166			* Prepares a mail by setting its content
167			*
168			* @param string $subject Subject to use in email
169			* @param string $message Message to use in email
170			* @param string $type Defaults to text/plain
171			*
172			* @return boolean
173			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
174
175			public function prepare($subject, $message, $type = 'text/plain')
176			{
177			// Run initial preparations
178			parent::prepare($subject, $message, $type);
179
180			// Set header data
181			$headers = ['MIME-Version: 1.0',
182			'Content-Type: ' . $type . '; charset=UTF-8',
183			'Content-Transfer-Encoding: base64',
184			'X-Mailer: cSphere',
185			'From: ' . $this->config['from']];
186
187			$this->headers = array_merge($this->headers, $headers);
188
189			// Create encoded subject and content strings
190			$this->encode();
191
192			return true;
193			}
194
195			/**
196			* Sends the prepared content to a given email
197			*
198			* @param string $email Email target
199			* @param boolean $clear Defaults to true which keeps mail data
200			*
201			* @return boolean
202			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
203
204			public function send($email, $clear = true)
205			{
206			// Send mail
207			$commands = $this->_commands($email);
208
209			$send = $this->_remote($commands);
210
211			// Log mail and handle clear status
212			$this->log($email, $send);
213
214			$this->clear($clear);
215
216			return $send;
217			}
218			}
219

csphere-cms / cSphere

Driver_SMTP::send() A last analyzed 2017-04-21 16:53 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Driver_SMTP::send() A
last analyzed 2017-04-21 16:53 UTC