zytzagoo / smtp-validate-email

smtp-validate-email.php

Indentation +127 added lines, -127 removed lines

@@ -86,18 +86,18 @@ 
     public $connect_port = 25;
 
     /**
-    * Are 'catch-all' accounts considered valid or not?
-    * If not, the class checks for a "catch-all" and if it determines the box
-    * has a "catch-all", sets all the emails on that domain as invalid.
-    */
+     * Are 'catch-all' accounts considered valid or not?
+     * If not, the class checks for a "catch-all" and if it determines the box
+     * has a "catch-all", sets all the emails on that domain as invalid.
+     */
     public $catchall_is_valid = true;
     public $catchall_test = false; // Set to true to perform a catchall test
 
     /**
-    * Being unable to communicate with the remote MTA could mean an address
-    * is invalid, but it might not, depending on your use case, set the
-    * value appropriately.
-    */
+     * Being unable to communicate with the remote MTA could mean an address
+     * is invalid, but it might not, depending on your use case, set the
+     * value appropriately.
+     */
     public $no_comm_is_valid = false;
 
     /**
@@ -111,18 +111,18 @@ 
     public $greylisted_considered_valid = true;
 
     /**
-    * If on Windows (or other places that don't have getmxrr()), this is the
-    * nameserver that will be used for MX querying.
-    * Set as empty to use the DNS specified via your current network connection.
-    * @see getmxrr()
-    */
+     * If on Windows (or other places that don't have getmxrr()), this is the
+     * nameserver that will be used for MX querying.
+     * Set as empty to use the DNS specified via your current network connection.
+     * @see getmxrr()
+     */
     // protected $mx_query_ns = 'dns1.t-com.hr';
     protected $mx_query_ns = '';
 
     /**
-    * Timeout values for various commands (in seconds) per RFC 2821
-    * @see expect()
-    */
+     * Timeout values for various commands (in seconds) per RFC 2821
+     * @see expect()
+     */
     protected $command_timeouts = array(
         'ehlo' => 120,
         'helo' => 120,
@@ -176,10 +176,10 @@ 
     );
 
     /**
-    * Constructor.
-    * @param $emails array  [optional] Array of emails to validate
-    * @param $sender string [optional] Email address of the sender/validator
-    */
+     * Constructor.
+     * @param $emails array  [optional] Array of emails to validate
+     * @param $sender string [optional] Email address of the sender/validator
+     */
     function __construct($emails = array(), $sender = '') {
         if (!empty($emails)) {
             $this->set_emails($emails);
@@ -190,9 +190,9 @@ 
     }
 
     /**
-    * Disconnects from the SMTP server if needed.
-    * @return void
-    */
+     * Disconnects from the SMTP server if needed.
+     * @return void
+     */
     public function __destruct() {
         $this->disconnect(false);
     }
@@ -220,11 +220,11 @@ 
     }
 
     /**
-    * Performs validation of specified email addresses.
-    * @param array $emails  Emails to validate (recipient emails)
-    * @param string $sender Sender email address
-    * @return array         List of emails and their results
-    */
+     * Performs validation of specified email addresses.
+     * @param array $emails  Emails to validate (recipient emails)
+     * @param string $sender Sender email address
+     * @return array         List of emails and their results
+     */
     public function validate($emails = array(), $sender = '') {
 
         $this->results = array();
@@ -290,10 +290,10 @@ 
                         }
 
                         /**
-                        * if we're still connected, proceed (cause we might get
-                        * disconnected, or banned, or greylisted temporarily etc.)
-                        * see mail() for more
-                        */
+                         * if we're still connected, proceed (cause we might get
+                         * disconnected, or banned, or greylisted temporarily etc.)
+                         * see mail() for more
+                         */
                         if ($this->connected()) {
 
                             $this->noop();
@@ -368,11 +368,11 @@ 
     }
 
     /**
-    * Helper to set results for all the users on a domain to a specific value
-    * @param array $users   Array of users (usernames)
-    * @param string $domain The domain
-    * @param bool $val      Value to set
-    */
+     * Helper to set results for all the users on a domain to a specific value
+     * @param array $users   Array of users (usernames)
+     * @param string $domain The domain
+     * @param bool $val      Value to set
+     */
     private function set_domain_results($users, $domain, $val) {
         if (!is_array($users)) {
             $users = (array) $users;
@@ -383,20 +383,20 @@ 
     }
 
     /**
-    * Returns true if we're connected to an MTA
-    * @return bool
-    */
+     * Returns true if we're connected to an MTA
+     * @return bool
+     */
     protected function connected() {
         return is_resource($this->socket);
     }
 
     /**
-    * Tries to connect to the specified host on the pre-configured port.
-    * @param string $host   The host to connect to
-    * @return void
-    * @throws SMTP_Validate_Email_Exception_No_Connection
-    * @throws SMTP_Validate_Email_Exception_No_Timeout
-    */
+     * Tries to connect to the specified host on the pre-configured port.
+     * @param string $host   The host to connect to
+     * @return void
+     * @throws SMTP_Validate_Email_Exception_No_Connection
+     * @throws SMTP_Validate_Email_Exception_No_Timeout
+     */
     protected function connect($host) {
         $remote_socket = $host . ':' . $this->connect_port;
         $errnum = 0;
@@ -426,10 +426,10 @@ 
     }
 
     /**
-    * Disconnects the currently connected MTA.
-    * @param bool $quit Issue QUIT before closing the socket on our end.
-    * @return void
-    */
+     * Disconnects the currently connected MTA.
+     * @param bool $quit Issue QUIT before closing the socket on our end.
+     * @return void
+     */
     protected function disconnect($quit = true) {
         if ($quit) {
             $this->quit();
@@ -443,8 +443,8 @@ 
     }
 
     /**
-    * Resets internal state flags to defaults
-    */
+     * Resets internal state flags to defaults
+     */
     private function reset_state() {
         $this->state['helo'] = false;
         $this->state['mail'] = false;
@@ -452,10 +452,10 @@ 
     }
 
     /**
-    * Sends a HELO/EHLO sequence
-    * @todo Implement TLS
-    * @return bool|null  True if successful, false otherwise
-    */
+     * Sends a HELO/EHLO sequence
+     * @todo Implement TLS
+     * @return bool|null  True if successful, false otherwise
+     */
     protected function helo() {
         // don't try if it was already done
         if ($this->state['helo']) {
@@ -489,9 +489,9 @@ 
     }
 
     /**
-    * Send EHLO or HELO, depending on what's supported by the remote host.
-    * @return void
-    */
+     * Send EHLO or HELO, depending on what's supported by the remote host.
+     * @return void
+     */
     protected function ehlo() {
         try {
             // modern
@@ -505,11 +505,11 @@ 
     }
 
     /**
-    * Sends a MAIL FROM command to indicate the sender.
-    * @param string $from   The "From:" address
-    * @return bool          If MAIL FROM command was accepted or not
-    * @throws SMTP_Validate_Email_Exception_No_Helo
-    */
+     * Sends a MAIL FROM command to indicate the sender.
+     * @param string $from   The "From:" address
+     * @return bool          If MAIL FROM command was accepted or not
+     * @throws SMTP_Validate_Email_Exception_No_Helo
+     */
     protected function mail($from) {
         if (!$this->state['helo']) {
             throw new SMTP_Validate_Email_Exception_No_Helo('Need HELO before MAIL FROM');
@@ -533,11 +533,11 @@ 
     }
 
     /**
-    * Sends a RCPT TO command to indicate a recipient.
-    * @param string $to Recipient's email address
-    * @return bool      Is the recipient accepted
-    * @throws SMTP_Validate_Email_Exception_No_Mail_From
-    */
+     * Sends a RCPT TO command to indicate a recipient.
+     * @param string $to Recipient's email address
+     * @return bool      Is the recipient accepted
+     * @throws SMTP_Validate_Email_Exception_No_Mail_From
+     */
     protected function rcpt($to) {
         // need to have issued MAIL FROM first
         if (!$this->state['mail']) {
@@ -569,9 +569,9 @@ 
     }
 
     /**
-    * Sends a RSET command and resets our internal state.
-    * @return void
-    */
+     * Sends a RSET command and resets our internal state.
+     * @return void
+     */
     protected function rset() {
         $this->send('RSET');
         // MS ESMTP doesn't follow RFC according to ZF tracker, see [ZF-1377]
@@ -588,9 +588,9 @@ 
     }
 
     /**
-    * Sends a QUIT command.
-    * @return void
-    */
+     * Sends a QUIT command.
+     * @return void
+     */
     protected function quit() {
         // although RFC says QUIT can be issued at any time, we won't
         if ($this->state['helo']) {
@@ -600,9 +600,9 @@ 
     }
 
     /**
-    * Sends a NOOP command.
-    * @return void
-    */
+     * Sends a NOOP command.
+     * @return void
+     */
     protected function noop() {
         $this->send('NOOP');
         // erg... "SMTP" code fix some bad RFC implementations
@@ -620,12 +620,12 @@ 
     }
 
     /**
-    * Sends a command to the remote host.
-    * @param string $cmd    The cmd to send
-    * @return int|bool      Number of bytes written to the stream
-    * @throws SMTP_Validate_Email_Exception_No_Connection
-    * @throws SMTP_Validate_Email_Exception_Send_Failed
-    */
+     * Sends a command to the remote host.
+     * @param string $cmd    The cmd to send
+     * @return int|bool      Number of bytes written to the stream
+     * @throws SMTP_Validate_Email_Exception_No_Connection
+     * @throws SMTP_Validate_Email_Exception_Send_Failed
+     */
     protected function send($cmd) {
         // must be connected
         if (!$this->connected()) {
@@ -643,13 +643,13 @@ 
     }
 
     /**
-    * Receives a response line from the remote host.
-    * @param int $timeout Timeout in seconds
-    * @return string
-    * @throws SMTP_Validate_Email_Exception_No_Connection
-    * @throws SMTP_Validate_Email_Exception_Timeout
-    * @throws SMTP_Validate_Email_Exception_No_Response
-    */
+     * Receives a response line from the remote host.
+     * @param int $timeout Timeout in seconds
+     * @return string
+     * @throws SMTP_Validate_Email_Exception_No_Connection
+     * @throws SMTP_Validate_Email_Exception_Timeout
+     * @throws SMTP_Validate_Email_Exception_No_Response
+     */
     protected function recv($timeout = null) {
         if (!$this->connected()) {
             throw new SMTP_Validate_Email_Exception_No_Connection('No connection');
@@ -674,13 +674,13 @@ 
     }
 
     /**
-    * Receives lines from the remote host and looks for expected response codes.
-    * @param int|int[] $codes A list of one or more expected response codes
-    * @param int $timeout The timeout for this individual command, if any
-    * @param bool $empty_response_allowed When true, empty responses are allowed
-    * @return string The last text message received
-    * @throws SMTP_Validate_Email_Exception_Unexpected_Response
-    */
+     * Receives lines from the remote host and looks for expected response codes.
+     * @param int|int[] $codes A list of one or more expected response codes
+     * @param int $timeout The timeout for this individual command, if any
+     * @param bool $empty_response_allowed When true, empty responses are allowed
+     * @return string The last text message received
+     * @throws SMTP_Validate_Email_Exception_Unexpected_Response
+     */
     protected function expect($codes, $timeout = null, $empty_response_allowed = false) {
         if (!is_array($codes)) {
             $codes = (array) $codes;
@@ -712,11 +712,11 @@ 
     }
 
     /**
-    * Parses an email string into respective user and domain parts and
-    * returns those as an array.
-    * @param string $email 'user@domain'
-    * @return array        ['user', 'domain']
-    */
+     * Parses an email string into respective user and domain parts and
+     * returns those as an array.
+     * @param string $email 'user@domain'
+     * @return array        ['user', 'domain']
+     */
     protected function parse_email($email) {
         $parts = explode('@', $email);
         $domain = array_pop($parts);
@@ -725,10 +725,10 @@ 
     }
 
     /**
-    * Sets the email addresses that should be validated.
-    * @param array $emails  Array of emails to validate
-    * @return void
-    */
+     * Sets the email addresses that should be validated.
+     * @param array $emails  Array of emails to validate
+     * @return void
+     */
     public function set_emails($emails) {
         if (!is_array($emails)) {
             $emails = (array) $emails;
@@ -744,10 +744,10 @@ 
     }
 
     /**
-    * Sets the email address to use as the sender/validator.
-    * @param string $email
-    * @return void
-    */
+     * Sets the email address to use as the sender/validator.
+     * @param string $email
+     * @return void
+     */
     public function set_sender($email) {
         $parts = $this->parse_email($email);
         $this->from_user = $parts[0];
@@ -755,10 +755,10 @@ 
     }
 
     /**
-    * Queries the DNS server for MX entries of a certain domain.
-    * @param string $domain The domain for which to retrieve MX records
-    * @return array         MX hosts and their weights
-    */
+     * Queries the DNS server for MX entries of a certain domain.
+     * @param string $domain The domain for which to retrieve MX records
+     * @return array         MX hosts and their weights
+     */
     protected function mx_query($domain) {
         $hosts = array();
         $weight = array();
@@ -813,11 +813,11 @@ 
     }
 
     /**
-    * Debug helper. If run in a CLI env, it just dumps $str on a new line,
-    * else it prints stuff using <pre>.
-    * @param string $str    The debug message
-    * @return void
-    */
+     * Debug helper. If run in a CLI env, it just dumps $str on a new line,
+     * else it prints stuff using <pre>.
+     * @param string $str    The debug message
+     * @return void
+     */
     private function debug($str) {
         $str = $this->stamp($str);
         $this->log($str);
@@ -830,9 +830,9 @@ 
     }
 
     /**
-    * Adds a message to the log array
-    * @param string $msg The message to add
-    */
+     * Adds a message to the log array
+     * @param string $msg The message to add
+     */
     private function log($msg) {
         $this->log[] = $msg;
     }
@@ -852,15 +852,15 @@ 
     }
 
     /**
-    * Returns the log array
-    */
+     * Returns the log array
+     */
     public function get_log() {
         return $this->log;
     }
 
     /**
-    * Truncates the log array
-    */
+     * Truncates the log array
+     */
     public function clear_log() {
         $this->log = array();
     }

Spacing +37 added lines, -37 removed lines

@@ -201,8 +201,8 @@ 
         if (!$this->catchall_test) {
             return false;
         }
-        $test = 'catch-all-test-' . time();
-        $accepted = $this->rcpt($test . '@' . $domain);
+        $test = 'catch-all-test-'.time();
+        $accepted = $this->rcpt($test.'@'.$domain);
         if ($accepted) {
             // success on a non-existing address is a "catch-all"
             $this->domains_info[$domain]['catchall'] = true;
@@ -212,7 +212,7 @@ 
         // while trying to perform a catchall detect
         $this->noop();
         if (!($this->connected())) {
-            $this->debug('Disconnected after trying a non-existing recipient on ' . $domain);
+            $this->debug('Disconnected after trying a non-existing recipient on '.$domain);
         }
         // nb: disconnects are considered as a non-catch-all case this way
         // this might not be true always
@@ -257,7 +257,7 @@ 
             // add the hostname itself with 0 weight (RFC 2821)
             $mxs[$domain] = 0;
 
-            $this->debug('MX records (' . $domain . '): ' . print_r($mxs, true));
+            $this->debug('MX records ('.$domain.'): '.print_r($mxs, true));
             $this->domains_info[$domain] = array();
             $this->domains_info[$domain]['users'] = $users;
             $this->domains_info[$domain]['mxs'] = $mxs;
@@ -272,8 +272,8 @@ 
                     }
                 } catch (SMTP_Validate_Email_Exception_No_Connection $e) {
                     // unable to connect to host, so these addresses are invalid?
-                    $this->debug('Unable to connect. Exception caught: ' . $e->getMessage());
-                    $this->set_domain_results($users, $domain, $this->no_conn_is_valid );
+                    $this->debug('Unable to connect. Exception caught: '.$e->getMessage());
+                    $this->set_domain_results($users, $domain, $this->no_conn_is_valid);
                 }
             }
 
@@ -284,7 +284,7 @@ 
                     if ($this->helo()) {
 
                         // try issuing MAIL FROM
-                        if (!($this->mail($this->from_user . '@' . $this->from_domain))) {
+                        if (!($this->mail($this->from_user.'@'.$this->from_domain))) {
                             // MAIL FROM not accepted, we can't talk
                             $this->set_domain_results($users, $domain, $this->no_comm_is_valid);
                         }
@@ -316,7 +316,7 @@ 
                                 $this->noop();
                                 // rcpt to for each user
                                 foreach ($users as $user) {
-                                    $address = $user . '@' . $domain;
+                                    $address = $user.'@'.$domain;
                                     $this->results[$address] = $this->rcpt($address);
                                     $this->noop();
                                 }
@@ -378,7 +378,7 @@ 
             $users = (array) $users;
         }
         foreach ($users as $user) {
-            $this->results[$user . '@' . $domain] = $val;
+            $this->results[$user.'@'.$domain] = $val;
         }
     }
 
@@ -398,12 +398,12 @@ 
     * @throws SMTP_Validate_Email_Exception_No_Timeout
     */
     protected function connect($host) {
-        $remote_socket = $host . ':' . $this->connect_port;
+        $remote_socket = $host.':'.$this->connect_port;
         $errnum = 0;
         $errstr = '';
         $this->host = $remote_socket;
         // open connection
-        $this->debug('Connecting to ' . $this->host);
+        $this->debug('Connecting to '.$this->host);
         $this->socket = @stream_socket_client(
             $this->host,
             $errnum,
@@ -414,15 +414,15 @@ 
         );
         // connected?
         if (!$this->connected()) {
-            $this->debug('Connect failed: ' . $errstr . ', error number: ' . $errnum . ', host: ' . $this->host);
-            throw new SMTP_Validate_Email_Exception_No_Connection('Cannot ' .
-            'open a connection to remote host (' . $this->host . ')');
+            $this->debug('Connect failed: '.$errstr.', error number: '.$errnum.', host: '.$this->host);
+            throw new SMTP_Validate_Email_Exception_No_Connection('Cannot '.
+            'open a connection to remote host ('.$this->host.')');
         }
         $result = stream_set_timeout($this->socket, $this->connect_timeout);
         if (!$result) {
             throw new SMTP_Validate_Email_Exception_No_Timeout('Cannot set timeout');
         }
-        $this->debug('Connected to ' . $this->host . ' successfully');
+        $this->debug('Connected to '.$this->host.' successfully');
     }
 
     /**
@@ -435,7 +435,7 @@ 
             $this->quit();
         }
         if ($this->connected()) {
-            $this->debug('Closing socket to ' . $this->host);
+            $this->debug('Closing socket to '.$this->host);
             fclose($this->socket);
         }
         $this->host = null;
@@ -482,7 +482,7 @@ 
             return true;
         } catch (SMTP_Validate_Email_Exception_Unexpected_Response $e) {
             // connected, but recieved an unexpected response, so disconnect
-            $this->debug('Unexpected response after connecting: ' . $e->getMessage());
+            $this->debug('Unexpected response after connecting: '.$e->getMessage());
             $this->disconnect(false);
             return false;
         }
@@ -495,11 +495,11 @@ 
     protected function ehlo() {
         try {
             // modern
-            $this->send('EHLO ' . $this->from_domain);
+            $this->send('EHLO '.$this->from_domain);
             $this->expect(self::SMTP_GENERIC_SUCCESS, $this->command_timeouts['ehlo']);
         } catch (SMTP_Validate_Email_Exception_Unexpected_Response $e) {
             // legacy
-            $this->send('HELO ' . $this->from_domain);
+            $this->send('HELO '.$this->from_domain);
             $this->expect(self::SMTP_GENERIC_SUCCESS, $this->command_timeouts['helo']);
         }
     }
@@ -515,7 +515,7 @@ 
             throw new SMTP_Validate_Email_Exception_No_Helo('Need HELO before MAIL FROM');
         }
         // issue MAIL FROM, 5 minute timeout
-        $this->send('MAIL FROM:<' . $from . '>');
+        $this->send('MAIL FROM:<'.$from.'>');
         try {
             $this->expect(self::SMTP_GENERIC_SUCCESS, $this->command_timeouts['mail']);
             // set state flags
@@ -524,7 +524,7 @@ 
             return true;
         } catch (SMTP_Validate_Email_Exception_Unexpected_Response $e) {
             // got something unexpected in response to MAIL FROM
-            $this->debug("Unexpected response to MAIL FROM\n:" . $e->getMessage());
+            $this->debug("Unexpected response to MAIL FROM\n:".$e->getMessage());
             // hotmail has been known to do this + was closing the connection
             // forcibly on their end, so we're killing the socket here too
             $this->disconnect(false);
@@ -553,17 +553,17 @@ 
         }
         // issue RCPT TO, 5 minute timeout
         try {
-            $this->send('RCPT TO:<' . $to . '>');
+            $this->send('RCPT TO:<'.$to.'>');
             // process the response
             try {
                 $this->expect($expected_codes, $this->command_timeouts['rcpt']);
                 $this->state['rcpt'] = true;
                 $is_valid = true;
             } catch (SMTP_Validate_Email_Exception_Unexpected_Response $e) {
-                $this->debug('Unexpected response to RCPT TO: ' . $e->getMessage());
+                $this->debug('Unexpected response to RCPT TO: '.$e->getMessage());
             }
         } catch (SMTP_Validate_Email_Exception $e) {
-            $this->debug('Sending RCPT TO failed: ' . $e->getMessage());
+            $this->debug('Sending RCPT TO failed: '.$e->getMessage());
         }
         return $is_valid;
     }
@@ -595,7 +595,7 @@ 
         // although RFC says QUIT can be issued at any time, we won't
         if ($this->state['helo']) {
             $this->send('QUIT');
-            $this->expect(array(self::SMTP_GENERIC_SUCCESS,self::SMTP_QUIT_SUCCESS), $this->command_timeouts['quit'], true);
+            $this->expect(array(self::SMTP_GENERIC_SUCCESS, self::SMTP_QUIT_SUCCESS), $this->command_timeouts['quit'], true);
         }
     }
 
@@ -631,13 +631,13 @@ 
         if (!$this->connected()) {
             throw new SMTP_Validate_Email_Exception_No_Connection('No connection');
         }
-        $this->debug('send>>>: ' . $cmd);
+        $this->debug('send>>>: '.$cmd);
         // write the cmd to the connection stream
-        $result = fwrite($this->socket, $cmd . self::CRLF);
+        $result = fwrite($this->socket, $cmd.self::CRLF);
         // did the send work?
         if ($result === false) {
-            throw new SMTP_Validate_Email_Exception_Send_Failed('Send failed ' .
-            'on: ' . $this->host);
+            throw new SMTP_Validate_Email_Exception_Send_Failed('Send failed '.
+            'on: '.$this->host);
         }
         return $result;
     }
@@ -660,7 +660,7 @@ 
         }
         // retrieve response
         $line = fgets($this->socket, 1024);
-        $this->debug('<<<recv: ' . $line);
+        $this->debug('<<<recv: '.$line);
         // have we timed out?
         $info = stream_get_meta_data($this->socket);
         if (!empty($info['timed_out'])) {
@@ -704,7 +704,7 @@ 
             // no response in expect() probably means that the
             // remote server forcibly closed the connection so
             // lets clean up on our end as well?
-            $this->debug('No response in expect(): ' . $e->getMessage());
+            $this->debug('No response in expect(): '.$e->getMessage());
             $this->disconnect(false);
 
         }
@@ -720,7 +720,7 @@ 
     protected function parse_email($email) {
         $parts = explode('@', $email);
         $domain = array_pop($parts);
-        $user= implode('@', $parts);
+        $user = implode('@', $parts);
         return array($user, $domain);
     }
 
@@ -789,9 +789,9 @@ 
         if (empty($hostname)) {
             return null;
         }
-        $cmd = 'nslookup -type=MX ' . escapeshellarg($hostname);
+        $cmd = 'nslookup -type=MX '.escapeshellarg($hostname);
         if (!empty($this->mx_query_ns)) {
-            $cmd .= ' ' . escapeshellarg($this->mx_query_ns);
+            $cmd .= ' '.escapeshellarg($this->mx_query_ns);
         }
         exec($cmd, $output);
         if (empty($output)) {
@@ -823,9 +823,9 @@ 
         $this->log($str);
         if ($this->debug == true) {
             if (PHP_SAPI != 'cli') {
-                $str = '<br/><pre>' . htmlspecialchars($str) . '</pre>';
+                $str = '<br/><pre>'.htmlspecialchars($str).'</pre>';
             }
-            echo "\n" . $str;
+            echo "\n".$str;
         }
     }
 
@@ -846,7 +846,7 @@ 
      */
     private function stamp($msg) {
         $date = \DateTime::createFromFormat('U.u', sprintf('%.f', microtime(true)))->format('Y-m-d\TH:i:s.uO');
-        $line = '[' . $date . '] ' . $msg;
+        $line = '['.$date.'] '.$msg;
 
         return $line;
     }