library/Zend/Mail/Protocol/Abstract.php

   1 <?php
   2
   3 /**
   4  * Zend Framework
   5  *
   6  * LICENSE
   7  *
   8  * This source file is subject to the new BSD license that is bundled
   9  * with this package in the file LICENSE.txt.
  10  * It is also available through the world-wide-web at this URL:
  11  * http://framework.zend.com/license/new-bsd
  12  * If you did not receive a copy of the license and are unable to
  13  * obtain it through the world-wide-web, please send an email
  14  * to license@zend.com so we can send you a copy immediately.
  15  *
  16  * @category   Zend
  17  * @package    Zend_Mail
  18  * @subpackage Protocol
  19  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  20  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  21  * @version    $Id: Abstract.php 16219 2009-06-21 19:45:39Z thomas $
  22  */
  23
  24
  25 /**
  26  * @see Zend_Validate
  27  */
  28 require_once 'Zend/Validate.php';
  29
  30
  31 /**
  32  * @see Zend_Validate_Hostname
  33  */
  34 require_once 'Zend/Validate/Hostname.php';
  35
  36
  37 /**
  38  * Zend_Mail_Protocol_Abstract
  39  *
  40  * Provides low-level methods for concrete adapters to communicate with a remote mail server and track requests and responses.
  41  *
  42  * @category   Zend
  43  * @package    Zend_Mail
  44  * @subpackage Protocol
  45  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  46  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  47  * @version    $Id: Abstract.php 16219 2009-06-21 19:45:39Z thomas $
  48  * @todo Implement proxy settings
  49  */
  50 abstract class Zend_Mail_Protocol_Abstract
  51 {
  52     /**
  53      * Mail default EOL string
  54      */
  55     const EOL = "\r\n";
  56
  57
  58     /**
  59      * Default timeout in seconds for initiating session
  60      */
  61     const TIMEOUT_CONNECTION = 30;
  62
  63
  64     /**
  65      * Hostname or IP address of remote server
  66      * @var string
  67      */
  68     protected $_host;
  69
  70
  71     /**
  72      * Port number of connection
  73      * @var integer
  74      */
  75     protected $_port;
  76
  77
  78     /**
  79      * Instance of Zend_Validate to check hostnames
  80      * @var Zend_Validate
  81      */
  82     protected $_validHost;
  83
  84
  85     /**
  86      * Socket connection resource
  87      * @var resource
  88      */
  89     protected $_socket;
  90
  91
  92     /**
  93      * Last request sent to server
  94      * @var string
  95      */
  96     protected $_request;
  97
  98
  99     /**
 100      * Array of server responses to last request
 101      * @var array
 102      */
 103     protected $_response;
 104
 105
 106     /**
 107      * String template for parsing server responses using sscanf (default: 3 digit code and response string)
 108      * @var resource
 109      */
 110     protected $_template = '%d%s';
 111
 112
 113     /**
 114      * Log of mail requests and server responses for a session
 115      * @var string
 116      */
 117     private $_log;
 118
 119
 120     /**
 121      * Constructor.
 122      *
 123      * @param  string  $host OPTIONAL Hostname of remote connection (default: 127.0.0.1)
 124      * @param  integer $port OPTIONAL Port number (default: null)
 125      * @throws Zend_Mail_Protocol_Exception
 126      * @return void
 127      */
 128     public function __construct($host = '127.0.0.1', $port = null)
 129     {
 130         $this->_validHost = new Zend_Validate();
 131         $this->_validHost->addValidator(new Zend_Validate_Hostname(Zend_Validate_Hostname::ALLOW_ALL));
 132
 133         if (!$this->_validHost->isValid($host)) {
 134             /**
 135              * @see Zend_Mail_Protocol_Exception
 136              */
 137             require_once 'Zend/Mail/Protocol/Exception.php';
 138             throw new Zend_Mail_Protocol_Exception(join(', ', $this->_validHost->getMessages()));
 139         }
 140
 141         $this->_host = $host;
 142         $this->_port = $port;
 143     }
 144
 145
 146     /**
 147      * Class destructor to cleanup open resources
 148      *
 149      * @return void
 150      */
 151     public function __destruct()
 152     {
 153         $this->_disconnect();
 154     }
 155
 156
 157     /**
 158      * Create a connection to the remote host
 159      *
 160      * Concrete adapters for this class will implement their own unique connect scripts, using the _connect() method to create the socket resource.
 161      */
 162     abstract public function connect();
 163
 164
 165     /**
 166      * Retrieve the last client request
 167      *
 168      * @return string
 169      */
 170     public function getRequest()
 171     {
 172         return $this->_request;
 173     }
 174
 175
 176     /**
 177      * Retrieve the last server response
 178      *
 179      * @return array
 180      */
 181     public function getResponse()
 182     {
 183         return $this->_response;
 184     }
 185
 186
 187     /**
 188      * Retrieve the transaction log
 189      *
 190      * @return string
 191      */
 192     public function getLog()
 193     {
 194         return $this->_log;
 195     }
 196
 197
 198     /**
 199      * Reset the transaction log
 200      *
 201      * @return void
 202      */
 203     public function resetLog()
 204     {
 205         $this->_log = '';
 206     }
 207
 208
 209     /**
 210      * Connect to the server using the supplied transport and target
 211      *
 212      * An example $remote string may be 'tcp://mail.example.com:25' or 'ssh://hostname.com:2222'
 213      *
 214      * @param  string $remote Remote
 215      * @throws Zend_Mail_Protocol_Exception
 216      * @return boolean
 217      */
 218     protected function _connect($remote)
 219     {
 220         $errorNum = 0;
 221         $errorStr = '';
 222
 223         // open connection
 224         $this->_socket = @stream_socket_client($remote, $errorNum, $errorStr, self::TIMEOUT_CONNECTION);
 225
 226         if ($this->_socket === false) {
 227             if ($errorNum == 0) {
 228                 $errorStr = 'Could not open socket';
 229             }
 230             /**
 231              * @see Zend_Mail_Protocol_Exception
 232              */
 233             require_once 'Zend/Mail/Protocol/Exception.php';
 234             throw new Zend_Mail_Protocol_Exception($errorStr);
 235         }
 236
 237         if (($result = stream_set_timeout($this->_socket, self::TIMEOUT_CONNECTION)) === false) {
 238             /**
 239              * @see Zend_Mail_Protocol_Exception
 240              */
 241             require_once 'Zend/Mail/Protocol/Exception.php';
 242             throw new Zend_Mail_Protocol_Exception('Could not set stream timeout');
 243         }
 244
 245         return $result;
 246     }
 247
 248
 249     /**
 250      * Disconnect from remote host and free resource
 251      *
 252      * @return void
 253      */
 254     protected function _disconnect()
 255     {
 256         if (is_resource($this->_socket)) {
 257             fclose($this->_socket);
 258         }
 259     }
 260
 261
 262     /**
 263      * Send the given request followed by a LINEEND to the server.
 264      *
 265      * @param  string $request
 266      * @throws Zend_Mail_Protocol_Exception
 267      * @return integer|boolean Number of bytes written to remote host
 268      */
 269     protected function _send($request)
 270     {
 271         if (!is_resource($this->_socket)) {
 272             /**
 273              * @see Zend_Mail_Protocol_Exception
 274              */
 275             require_once 'Zend/Mail/Protocol/Exception.php';
 276             throw new Zend_Mail_Protocol_Exception('No connection has been established to ' . $this->_host);
 277         }
 278
 279         $this->_request = $request;
 280
 281         $result = fwrite($this->_socket, $request . self::EOL);
 282
 283         // Save request to internal log
 284         $this->_log .= $request . self::EOL;
 285
 286         if ($result === false) {
 287             /**
 288              * @see Zend_Mail_Protocol_Exception
 289              */
 290             require_once 'Zend/Mail/Protocol/Exception.php';
 291             throw new Zend_Mail_Protocol_Exception('Could not send request to ' . $this->_host);
 292         }
 293
 294         return $result;
 295     }
 296
 297
 298     /**
 299      * Get a line from the stream.
 300      *
 301      * @var    integer $timeout Per-request timeout value if applicable
 302      * @throws Zend_Mail_Protocol_Exception
 303      * @return string
 304      */
 305     protected function _receive($timeout = null)
 306     {
 307         if (!is_resource($this->_socket)) {
 308             /**
 309              * @see Zend_Mail_Protocol_Exception
 310              */
 311             require_once 'Zend/Mail/Protocol/Exception.php';
 312             throw new Zend_Mail_Protocol_Exception('No connection has been established to ' . $this->_host);
 313         }
 314
 315         // Adapters may wish to supply per-commend timeouts according to appropriate RFC
 316         if ($timeout !== null) {
 317            stream_set_timeout($this->_socket, $timeout);
 318         }
 319
 320         // Retrieve response
 321         $reponse = fgets($this->_socket, 1024);
 322
 323         // Save request to internal log
 324         $this->_log .= $reponse;
 325
 326         // Check meta data to ensure connection is still valid
 327         $info = stream_get_meta_data($this->_socket);
 328
 329         if (!empty($info['timed_out'])) {
 330             /**
 331              * @see Zend_Mail_Protocol_Exception
 332              */
 333             require_once 'Zend/Mail/Protocol/Exception.php';
 334             throw new Zend_Mail_Protocol_Exception($this->_host . ' has timed out');
 335         }
 336
 337         if ($reponse === false) {
 338             /**
 339              * @see Zend_Mail_Protocol_Exception
 340              */
 341             require_once 'Zend/Mail/Protocol/Exception.php';
 342             throw new Zend_Mail_Protocol_Exception('Could not read from ' . $this->_host);
 343         }
 344
 345         return $reponse;
 346     }
 347
 348
 349     /**
 350      * Parse server response for successful codes
 351      *
 352      * Read the response from the stream and check for expected return code.
 353      * Throws a Zend_Mail_Protocol_Exception if an unexpected code is returned.
 354      *
 355      * @param  string|array $code One or more codes that indicate a successful response
 356      * @throws Zend_Mail_Protocol_Exception
 357      * @return string Last line of response string
 358      */
 359     protected function _expect($code, $timeout = null)
 360     {
 361         $this->_response = array();
 362         $cmd = '';
 363         $msg = '';
 364
 365         if (!is_array($code)) {
 366             $code = array($code);
 367         }
 368
 369         do {
 370             $this->_response[] = $result = $this->_receive($timeout);
 371             sscanf($result, $this->_template, $cmd, $msg);
 372
 373             if ($cmd === null || !in_array($cmd, $code)) {
 374                 /**
 375                  * @see Zend_Mail_Protocol_Exception
 376                  */
 377                 require_once 'Zend/Mail/Protocol/Exception.php';
 378                 throw new Zend_Mail_Protocol_Exception($result);
 379             }
 380
 381         } while (strpos($msg, '-') === 0); // The '-' message prefix indicates an information string instead of a response string.
 382
 383         return $msg;
 384     }
 385 }