You are here

class soap_transport_http in Salesforce Suite 5

Same name in this branch
  1. 5 includes/nusoap.php \soap_transport_http
  2. 5 includes/nusoap.orig.php \soap_transport_http
Same name and namespace in other branches
  1. 5.2 includes/nusoap.php \soap_transport_http
  2. 5.2 includes/nusoap.orig.php \soap_transport_http

transport class for sending/receiving data via HTTP and HTTPS NOTE: PHP must be compiled with the CURL extension for HTTPS support

@author Dietrich Ayala <dietrich@ganx4.com> @access public

Hierarchy

Expanded class hierarchy of soap_transport_http

File

includes/nusoap.orig.php, line 2000

View source
class soap_transport_http extends nusoap_base {
  var $url = '';
  var $uri = '';
  var $digest_uri = '';
  var $scheme = '';
  var $host = '';
  var $port = '';
  var $path = '';
  var $request_method = 'POST';
  var $protocol_version = '1.0';
  var $encoding = '';
  var $outgoing_headers = [];
  var $incoming_headers = [];
  var $incoming_cookies = [];
  var $outgoing_payload = '';
  var $incoming_payload = '';
  var $useSOAPAction = true;
  var $persistentConnection = false;
  var $ch = false;

  // cURL handle
  var $username = '';
  var $password = '';
  var $authtype = '';
  var $digestRequest = [];
  var $certRequest = [];

  // keys must be cainfofile (optional), sslcertfile, sslkeyfile, passphrase, verifypeer (optional), verifyhost (optional)
  // cainfofile: certificate authority file, e.g. '$pathToPemFiles/rootca.pem'
  // sslcertfile: SSL certificate file, e.g. '$pathToPemFiles/mycert.pem'
  // sslkeyfile: SSL key file, e.g. '$pathToPemFiles/mykey.pem'
  // passphrase: SSL key password/passphrase
  // verifypeer: default is 1
  // verifyhost: default is 1

  /**
   * constructor
   */
  function soap_transport_http($url) {
    parent::nusoap_base();
    $this
      ->setURL($url);
    ereg('\\$Revisio' . 'n: ([^ ]+)', $this->revision, $rev);
    $this->outgoing_headers['User-Agent'] = $this->title . '/' . $this->version . ' (' . $rev[1] . ')';
    $this
      ->debug('set User-Agent: ' . $this->outgoing_headers['User-Agent']);
  }
  function setURL($url) {
    $this->url = $url;
    $u = parse_url($url);
    foreach ($u as $k => $v) {
      $this
        ->debug("{$k} = {$v}");
      $this->{$k} = $v;
    }

    // add any GET params to path
    if (isset($u['query']) && $u['query'] != '') {
      $this->path .= '?' . $u['query'];
    }

    // set default port
    if (!isset($u['port'])) {
      if ($u['scheme'] == 'https') {
        $this->port = 443;
      }
      else {
        $this->port = 80;
      }
    }
    $this->uri = $this->path;
    $this->digest_uri = $this->uri;

    // build headers
    if (!isset($u['port'])) {
      $this->outgoing_headers['Host'] = $this->host;
    }
    else {
      $this->outgoing_headers['Host'] = $this->host . ':' . $this->port;
    }
    $this
      ->debug('set Host: ' . $this->outgoing_headers['Host']);
    if (isset($u['user']) && $u['user'] != '') {
      $this
        ->setCredentials(urldecode($u['user']), isset($u['pass']) ? urldecode($u['pass']) : '');
    }
  }
  function connect($connection_timeout = 0, $response_timeout = 30) {

    // For PHP 4.3 with OpenSSL, change https scheme to ssl, then treat like
    // "regular" socket.
    // TODO: disabled for now because OpenSSL must be *compiled* in (not just
    //       loaded), and until PHP5 stream_get_wrappers is not available.
    //	  	if ($this->scheme == 'https') {
    //		  	if (version_compare(phpversion(), '4.3.0') >= 0) {
    //		  		if (extension_loaded('openssl')) {
    //		  			$this->scheme = 'ssl';
    //		  			$this->debug('Using SSL over OpenSSL');
    //		  		}
    //		  	}
    //		}
    $this
      ->debug("connect connection_timeout {$connection_timeout}, response_timeout {$response_timeout}, scheme {$this->scheme}, host {$this->host}, port {$this->port}");
    if ($this->scheme == 'http' || $this->scheme == 'ssl') {

      // use persistent connection
      if ($this->persistentConnection && isset($this->fp) && is_resource($this->fp)) {
        if (!feof($this->fp)) {
          $this
            ->debug('Re-use persistent connection');
          return true;
        }
        fclose($this->fp);
        $this
          ->debug('Closed persistent connection at EOF');
      }

      // munge host if using OpenSSL
      if ($this->scheme == 'ssl') {
        $host = 'ssl://' . $this->host;
      }
      else {
        $host = $this->host;
      }
      $this
        ->debug('calling fsockopen with host ' . $host . ' connection_timeout ' . $connection_timeout);

      // open socket
      if ($connection_timeout > 0) {
        $this->fp = @fsockopen($host, $this->port, $this->errno, $this->error_str, $connection_timeout);
      }
      else {
        $this->fp = @fsockopen($host, $this->port, $this->errno, $this->error_str);
      }

      // test pointer
      if (!$this->fp) {
        $msg = 'Couldn\'t open socket connection to server ' . $this->url;
        if ($this->errno) {
          $msg .= ', Error (' . $this->errno . '): ' . $this->error_str;
        }
        else {
          $msg .= ' prior to connect().  This is often a problem looking up the host name.';
        }
        $this
          ->debug($msg);
        $this
          ->setError($msg);
        return false;
      }

      // set response timeout
      $this
        ->debug('set response timeout to ' . $response_timeout);
      socket_set_timeout($this->fp, $response_timeout);
      $this
        ->debug('socket connected');
      return true;
    }
    else {
      if ($this->scheme == 'https') {
        if (!extension_loaded('curl')) {
          $this
            ->setError('CURL Extension, or OpenSSL extension w/ PHP version >= 4.3 is required for HTTPS');
          return false;
        }
        $this
          ->debug('connect using https');

        // init CURL
        $this->ch = curl_init();

        // set url
        $hostURL = $this->port != '' ? "https://{$this->host}:{$this->port}" : "https://{$this->host}";

        // add path
        $hostURL .= $this->path;
        curl_setopt($this->ch, CURLOPT_URL, $hostURL);

        // follow location headers (re-directs)
        curl_setopt($this->ch, CURLOPT_FOLLOWLOCATION, 1);

        // ask for headers in the response output
        curl_setopt($this->ch, CURLOPT_HEADER, 1);

        // ask for the response output as the return value
        curl_setopt($this->ch, CURLOPT_RETURNTRANSFER, 1);

        // encode
        // We manage this ourselves through headers and encoding
        //		if(function_exists('gzuncompress')){
        //			curl_setopt($this->ch, CURLOPT_ENCODING, 'deflate');
        //		}
        // persistent connection
        if ($this->persistentConnection) {

          // The way we send data, we cannot use persistent connections, since
          // there will be some "junk" at the end of our request.

          //curl_setopt($this->ch, CURL_HTTP_VERSION_1_1, true);
          $this->persistentConnection = false;
          $this->outgoing_headers['Connection'] = 'close';
          $this
            ->debug('set Connection: ' . $this->outgoing_headers['Connection']);
        }

        // set timeout
        if ($connection_timeout != 0) {
          curl_setopt($this->ch, CURLOPT_TIMEOUT, $connection_timeout);
        }

        // TODO: cURL has added a connection timeout separate from the response timeout

        //if ($connection_timeout != 0) {

        //	curl_setopt($this->ch, CURLOPT_CONNECTIONTIMEOUT, $connection_timeout);

        //}

        //if ($response_timeout != 0) {

        //	curl_setopt($this->ch, CURLOPT_TIMEOUT, $response_timeout);

        //}

        // recent versions of cURL turn on peer/host checking by default,
        // while PHP binaries are not compiled with a default location for the
        // CA cert bundle, so disable peer/host checking.

        //curl_setopt($this->ch, CURLOPT_CAINFO, 'f:\php-4.3.2-win32\extensions\curl-ca-bundle.crt');
        curl_setopt($this->ch, CURLOPT_SSL_VERIFYPEER, 0);
        curl_setopt($this->ch, CURLOPT_SSL_VERIFYHOST, 0);

        // support client certificates (thanks Tobias Boes, Doug Anarino, Eryan Ariobowo)
        if ($this->authtype == 'certificate') {
          if (isset($this->certRequest['cainfofile'])) {
            curl_setopt($this->ch, CURLOPT_CAINFO, $this->certRequest['cainfofile']);
          }
          if (isset($this->certRequest['verifypeer'])) {
            curl_setopt($this->ch, CURLOPT_SSL_VERIFYPEER, $this->certRequest['verifypeer']);
          }
          else {
            curl_setopt($this->ch, CURLOPT_SSL_VERIFYPEER, 1);
          }
          if (isset($this->certRequest['verifyhost'])) {
            curl_setopt($this->ch, CURLOPT_SSL_VERIFYHOST, $this->certRequest['verifyhost']);
          }
          else {
            curl_setopt($this->ch, CURLOPT_SSL_VERIFYHOST, 1);
          }
          if (isset($this->certRequest['sslcertfile'])) {
            curl_setopt($this->ch, CURLOPT_SSLCERT, $this->certRequest['sslcertfile']);
          }
          if (isset($this->certRequest['sslkeyfile'])) {
            curl_setopt($this->ch, CURLOPT_SSLKEY, $this->certRequest['sslkeyfile']);
          }
          if (isset($this->certRequest['passphrase'])) {
            curl_setopt($this->ch, CURLOPT_SSLKEYPASSWD, $this->certRequest['passphrase']);
          }
        }
        $this
          ->debug('cURL connection set up');
        return true;
      }
      else {
        $this
          ->setError('Unknown scheme ' . $this->scheme);
        $this
          ->debug('Unknown scheme ' . $this->scheme);
        return false;
      }
    }
  }

  /**
   * send the SOAP message via HTTP
   *
   * @param    string $data message data
   * @param    integer $timeout set connection timeout in seconds
   * @param	integer $response_timeout set response timeout in seconds
   * @param	array $cookies cookies to send
   * @return	string data
   * @access   public
   */
  function send($data, $timeout = 0, $response_timeout = 30, $cookies = NULL) {
    $this
      ->debug('entered send() with data of length: ' . strlen($data));
    $this->tryagain = true;
    $tries = 0;
    while ($this->tryagain) {
      $this->tryagain = false;
      if ($tries++ < 2) {

        // make connnection
        if (!$this
          ->connect($timeout, $response_timeout)) {
          return false;
        }

        // send request
        if (!$this
          ->sendRequest($data, $cookies)) {
          return false;
        }

        // get response
        $respdata = $this
          ->getResponse();
      }
      else {
        $this
          ->setError('Too many tries to get an OK response');
      }
    }
    $this
      ->debug('end of send()');
    return $respdata;
  }

  /**
   * send the SOAP message via HTTPS 1.0 using CURL
   *
   * @param    string $msg message data
   * @param    integer $timeout set connection timeout in seconds
   * @param	integer $response_timeout set response timeout in seconds
   * @param	array $cookies cookies to send
   * @return	string data
   * @access   public
   */
  function sendHTTPS($data, $timeout = 0, $response_timeout = 30, $cookies) {
    return $this
      ->send($data, $timeout, $response_timeout, $cookies);
  }

  /**
   * if authenticating, set user credentials here
   *
   * @param    string $username
   * @param    string $password
   * @param	string $authtype (basic, digest, certificate)
   * @param	array $digestRequest (keys must be nonce, nc, realm, qop)
   * @param	array $certRequest (keys must be cainfofile (optional), sslcertfile, sslkeyfile, passphrase, verifypeer (optional), verifyhost (optional): see corresponding options in cURL docs)
   * @access   public
   */
  function setCredentials($username, $password, $authtype = 'basic', $digestRequest = [], $certRequest = []) {
    $this
      ->debug("Set credentials for authtype {$authtype}");

    // cf. RFC 2617
    if ($authtype == 'basic') {
      $this->outgoing_headers['Authorization'] = 'Basic ' . base64_encode(str_replace(':', '', $username) . ':' . $password);
    }
    elseif ($authtype == 'digest') {
      if (isset($digestRequest['nonce'])) {
        $digestRequest['nc'] = isset($digestRequest['nc']) ? $digestRequest['nc']++ : 1;

        // calculate the Digest hashes (calculate code based on digest implementation found at: http://www.rassoc.com/gregr/weblog/stories/2002/07/09/webServicesSecurityHttpDigestAuthenticationWithoutActiveDirectory.html)
        // A1 = unq(username-value) ":" unq(realm-value) ":" passwd
        $A1 = $username . ':' . (isset($digestRequest['realm']) ? $digestRequest['realm'] : '') . ':' . $password;

        // H(A1) = MD5(A1)
        $HA1 = md5($A1);

        // A2 = Method ":" digest-uri-value
        $A2 = 'POST:' . $this->digest_uri;

        // H(A2)
        $HA2 = md5($A2);

        // KD(secret, data) = H(concat(secret, ":", data))
        // if qop == auth:
        // request-digest  = <"> < KD ( H(A1),     unq(nonce-value)
        //                              ":" nc-value
        //                              ":" unq(cnonce-value)
        //                              ":" unq(qop-value)
        //                              ":" H(A2)
        //                            ) <">
        // if qop is missing,
        // request-digest  = <"> < KD ( H(A1), unq(nonce-value) ":" H(A2) ) > <">
        $unhashedDigest = '';
        $nonce = isset($digestRequest['nonce']) ? $digestRequest['nonce'] : '';
        $cnonce = $nonce;
        if ($digestRequest['qop'] != '') {
          $unhashedDigest = $HA1 . ':' . $nonce . ':' . sprintf("%08d", $digestRequest['nc']) . ':' . $cnonce . ':' . $digestRequest['qop'] . ':' . $HA2;
        }
        else {
          $unhashedDigest = $HA1 . ':' . $nonce . ':' . $HA2;
        }
        $hashedDigest = md5($unhashedDigest);
        $this->outgoing_headers['Authorization'] = 'Digest username="' . $username . '", realm="' . $digestRequest['realm'] . '", nonce="' . $nonce . '", uri="' . $this->digest_uri . '", cnonce="' . $cnonce . '", nc=' . sprintf("%08x", $digestRequest['nc']) . ', qop="' . $digestRequest['qop'] . '", response="' . $hashedDigest . '"';
      }
    }
    elseif ($authtype == 'certificate') {
      $this->certRequest = $certRequest;
    }
    $this->username = $username;
    $this->password = $password;
    $this->authtype = $authtype;
    $this->digestRequest = $digestRequest;
    if (isset($this->outgoing_headers['Authorization'])) {
      $this
        ->debug('set Authorization: ' . substr($this->outgoing_headers['Authorization'], 0, 12) . '...');
    }
    else {
      $this
        ->debug('Authorization header not set');
    }
  }

  /**
   * set the soapaction value
   *
   * @param    string $soapaction
   * @access   public
   */
  function setSOAPAction($soapaction) {
    $this->outgoing_headers['SOAPAction'] = '"' . $soapaction . '"';
    $this
      ->debug('set SOAPAction: ' . $this->outgoing_headers['SOAPAction']);
  }

  /**
   * use http encoding
   *
   * @param    string $enc encoding style. supported values: gzip, deflate, or both
   * @access   public
   */
  function setEncoding($enc = 'gzip, deflate') {
    if (function_exists('gzdeflate')) {
      $this->protocol_version = '1.1';
      $this->outgoing_headers['Accept-Encoding'] = $enc;
      $this
        ->debug('set Accept-Encoding: ' . $this->outgoing_headers['Accept-Encoding']);
      if (!isset($this->outgoing_headers['Connection'])) {
        $this->outgoing_headers['Connection'] = 'close';
        $this->persistentConnection = false;
        $this
          ->debug('set Connection: ' . $this->outgoing_headers['Connection']);
      }
      set_magic_quotes_runtime(0);

      // deprecated
      $this->encoding = $enc;
    }
  }

  /**
   * set proxy info here
   *
   * @param    string $proxyhost
   * @param    string $proxyport
   * @param	string $proxyusername
   * @param	string $proxypassword
   * @access   public
   */
  function setProxy($proxyhost, $proxyport, $proxyusername = '', $proxypassword = '') {
    $this->uri = $this->url;
    $this->host = $proxyhost;
    $this->port = $proxyport;
    if ($proxyusername != '' && $proxypassword != '') {
      $this->outgoing_headers['Proxy-Authorization'] = ' Basic ' . base64_encode($proxyusername . ':' . $proxypassword);
      $this
        ->debug('set Proxy-Authorization: ' . $this->outgoing_headers['Proxy-Authorization']);
    }
  }

  /**
   * decode a string that is encoded w/ "chunked' transfer encoding
   * as defined in RFC2068 19.4.6
   *
   * @param    string $buffer
   * @param    string $lb
   * @returns	string
   * @access   public
   * @deprecated
   */
  function decodeChunked($buffer, $lb) {

    // length := 0
    $length = 0;
    $new = '';

    // read chunk-size, chunk-extension (if any) and CRLF
    // get the position of the linebreak
    $chunkend = strpos($buffer, $lb);
    if ($chunkend == FALSE) {
      $this
        ->debug('no linebreak found in decodeChunked');
      return $new;
    }
    $temp = substr($buffer, 0, $chunkend);
    $chunk_size = hexdec(trim($temp));
    $chunkstart = $chunkend + strlen($lb);

    // while (chunk-size > 0) {
    while ($chunk_size > 0) {
      $this
        ->debug("chunkstart: {$chunkstart} chunk_size: {$chunk_size}");
      $chunkend = strpos($buffer, $lb, $chunkstart + $chunk_size);

      // Just in case we got a broken connection
      if ($chunkend == FALSE) {
        $chunk = substr($buffer, $chunkstart);

        // append chunk-data to entity-body
        $new .= $chunk;
        $length += strlen($chunk);
        break;
      }

      // read chunk-data and CRLF
      $chunk = substr($buffer, $chunkstart, $chunkend - $chunkstart);

      // append chunk-data to entity-body
      $new .= $chunk;

      // length := length + chunk-size
      $length += strlen($chunk);

      // read chunk-size and CRLF
      $chunkstart = $chunkend + strlen($lb);
      $chunkend = strpos($buffer, $lb, $chunkstart) + strlen($lb);
      if ($chunkend == FALSE) {
        break;

        //Just in case we got a broken connection
      }
      $temp = substr($buffer, $chunkstart, $chunkend - $chunkstart);
      $chunk_size = hexdec(trim($temp));
      $chunkstart = $chunkend;
    }
    return $new;
  }

  /*
   *	Writes payload, including HTTP headers, to $this->outgoing_payload.
   */
  function buildPayload($data, $cookie_str = '') {

    // add content-length header
    $this->outgoing_headers['Content-Length'] = strlen($data);
    $this
      ->debug('set Content-Length: ' . $this->outgoing_headers['Content-Length']);

    // start building outgoing payload:
    $req = "{$this->request_method} {$this->uri} HTTP/{$this->protocol_version}";
    $this
      ->debug("HTTP request: {$req}");
    $this->outgoing_payload = "{$req}\r\n";

    // loop thru headers, serializing
    foreach ($this->outgoing_headers as $k => $v) {
      $hdr = $k . ': ' . $v;
      $this
        ->debug("HTTP header: {$hdr}");
      $this->outgoing_payload .= "{$hdr}\r\n";
    }

    // add any cookies
    if ($cookie_str != '') {
      $hdr = 'Cookie: ' . $cookie_str;
      $this
        ->debug("HTTP header: {$hdr}");
      $this->outgoing_payload .= "{$hdr}\r\n";
    }

    // header/body separator
    $this->outgoing_payload .= "\r\n";

    // add data
    $this->outgoing_payload .= $data;
  }
  function sendRequest($data, $cookies = NULL) {

    // build cookie string
    $cookie_str = $this
      ->getCookiesForRequest($cookies, $this->scheme == 'ssl' || $this->scheme == 'https');

    // build payload
    $this
      ->buildPayload($data, $cookie_str);
    if ($this->scheme == 'http' || $this->scheme == 'ssl') {

      // send payload
      if (!fputs($this->fp, $this->outgoing_payload, strlen($this->outgoing_payload))) {
        $this
          ->setError('couldn\'t write message data to socket');
        $this
          ->debug('couldn\'t write message data to socket');
        return false;
      }
      $this
        ->debug('wrote data to socket, length = ' . strlen($this->outgoing_payload));
      return true;
    }
    else {
      if ($this->scheme == 'https') {

        // set payload
        // TODO: cURL does say this should only be the verb, and in fact it
        // turns out that the URI and HTTP version are appended to this, which
        // some servers refuse to work with

        //curl_setopt($this->ch, CURLOPT_CUSTOMREQUEST, $this->outgoing_payload);
        foreach ($this->outgoing_headers as $k => $v) {
          $curl_headers[] = "{$k}: {$v}";
        }
        if ($cookie_str != '') {
          $curl_headers[] = 'Cookie: ' . $cookie_str;
        }
        curl_setopt($this->ch, CURLOPT_HTTPHEADER, $curl_headers);
        if ($this->request_method == "POST") {
          curl_setopt($this->ch, CURLOPT_POST, 1);
          curl_setopt($this->ch, CURLOPT_POSTFIELDS, $data);
        }
        else {
        }
        $this
          ->debug('set cURL payload');
        return true;
      }
    }
  }
  function getResponse() {
    $this->incoming_payload = '';
    if ($this->scheme == 'http' || $this->scheme == 'ssl') {

      // loop until headers have been retrieved
      $data = '';
      while (!isset($lb)) {

        // We might EOF during header read.
        if (feof($this->fp)) {
          $this->incoming_payload = $data;
          $this
            ->debug('found no headers before EOF after length ' . strlen($data));
          $this
            ->debug("received before EOF:\n" . $data);
          $this
            ->setError('server failed to send headers');
          return false;
        }
        $tmp = fgets($this->fp, 256);
        $tmplen = strlen($tmp);
        $this
          ->debug("read line of {$tmplen} bytes: " . trim($tmp));
        if ($tmplen == 0) {
          $this->incoming_payload = $data;
          $this
            ->debug('socket read of headers timed out after length ' . strlen($data));
          $this
            ->debug("read before timeout: " . $data);
          $this
            ->setError('socket read of headers timed out');
          return false;
        }
        $data .= $tmp;
        $pos = strpos($data, "\r\n\r\n");
        if ($pos > 1) {
          $lb = "\r\n";
        }
        else {
          $pos = strpos($data, "\n\n");
          if ($pos > 1) {
            $lb = "\n";
          }
        }

        // remove 100 header
        if (isset($lb) && ereg('^HTTP/1.1 100', $data)) {
          unset($lb);
          $data = '';
        }

        //
      }

      // store header data
      $this->incoming_payload .= $data;
      $this
        ->debug('found end of headers after length ' . strlen($data));

      // process headers
      $header_data = trim(substr($data, 0, $pos));
      $header_array = explode($lb, $header_data);
      $this->incoming_headers = array();
      $this->incoming_cookies = array();
      foreach ($header_array as $header_line) {
        $arr = explode(':', $header_line, 2);
        if (count($arr) > 1) {
          $header_name = strtolower(trim($arr[0]));
          $this->incoming_headers[$header_name] = trim($arr[1]);
          if ($header_name == 'set-cookie') {

            // TODO: allow multiple cookies from parseCookie
            $cookie = $this
              ->parseCookie(trim($arr[1]));
            if ($cookie) {
              $this->incoming_cookies[] = $cookie;
              $this
                ->debug('found cookie: ' . $cookie['name'] . ' = ' . $cookie['value']);
            }
            else {
              $this
                ->debug('did not find cookie in ' . trim($arr[1]));
            }
          }
        }
        else {
          if (isset($header_name)) {

            // append continuation line to previous header
            $this->incoming_headers[$header_name] .= $lb . ' ' . $header_line;
          }
        }
      }

      // loop until msg has been received
      if (isset($this->incoming_headers['transfer-encoding']) && strtolower($this->incoming_headers['transfer-encoding']) == 'chunked') {
        $content_length = 2147483647;

        // ignore any content-length header
        $chunked = true;
        $this
          ->debug("want to read chunked content");
      }
      elseif (isset($this->incoming_headers['content-length'])) {
        $content_length = $this->incoming_headers['content-length'];
        $chunked = false;
        $this
          ->debug("want to read content of length {$content_length}");
      }
      else {
        $content_length = 2147483647;
        $chunked = false;
        $this
          ->debug("want to read content to EOF");
      }
      $data = '';
      do {
        if ($chunked) {
          $tmp = fgets($this->fp, 256);
          $tmplen = strlen($tmp);
          $this
            ->debug("read chunk line of {$tmplen} bytes");
          if ($tmplen == 0) {
            $this->incoming_payload = $data;
            $this
              ->debug('socket read of chunk length timed out after length ' . strlen($data));
            $this
              ->debug("read before timeout:\n" . $data);
            $this
              ->setError('socket read of chunk length timed out');
            return false;
          }
          $content_length = hexdec(trim($tmp));
          $this
            ->debug("chunk length {$content_length}");
        }
        $strlen = 0;
        while ($strlen < $content_length && !feof($this->fp)) {
          $readlen = min(8192, $content_length - $strlen);
          $tmp = fread($this->fp, $readlen);
          $tmplen = strlen($tmp);
          $this
            ->debug("read buffer of {$tmplen} bytes");
          if ($tmplen == 0 && !feof($this->fp)) {
            $this->incoming_payload = $data;
            $this
              ->debug('socket read of body timed out after length ' . strlen($data));
            $this
              ->debug("read before timeout:\n" . $data);
            $this
              ->setError('socket read of body timed out');
            return false;
          }
          $strlen += $tmplen;
          $data .= $tmp;
        }
        if ($chunked && $content_length > 0) {
          $tmp = fgets($this->fp, 256);
          $tmplen = strlen($tmp);
          $this
            ->debug("read chunk terminator of {$tmplen} bytes");
          if ($tmplen == 0) {
            $this->incoming_payload = $data;
            $this
              ->debug('socket read of chunk terminator timed out after length ' . strlen($data));
            $this
              ->debug("read before timeout:\n" . $data);
            $this
              ->setError('socket read of chunk terminator timed out');
            return false;
          }
        }
      } while ($chunked && $content_length > 0 && !feof($this->fp));
      if (feof($this->fp)) {
        $this
          ->debug('read to EOF');
      }
      $this
        ->debug('read body of length ' . strlen($data));
      $this->incoming_payload .= $data;
      $this
        ->debug('received a total of ' . strlen($this->incoming_payload) . ' bytes of data from server');

      // close filepointer
      if (isset($this->incoming_headers['connection']) && strtolower($this->incoming_headers['connection']) == 'close' || !$this->persistentConnection || feof($this->fp)) {
        fclose($this->fp);
        $this->fp = false;
        $this
          ->debug('closed socket');
      }

      // connection was closed unexpectedly
      if ($this->incoming_payload == '') {
        $this
          ->setError('no response from server');
        return false;
      }

      // decode transfer-encoding
      //		if(isset($this->incoming_headers['transfer-encoding']) && strtolower($this->incoming_headers['transfer-encoding']) == 'chunked'){
      //			if(!$data = $this->decodeChunked($data, $lb)){
      //				$this->setError('Decoding of chunked data failed');
      //				return false;
      //			}

      //print "<pre>\nde-chunked:\n---------------\n$data\n\n---------------\n</pre>";

      // set decoded payload
      //			$this->incoming_payload = $header_data.$lb.$lb.$data;
      //		}
    }
    else {
      if ($this->scheme == 'https') {

        // send and receive
        $this
          ->debug('send and receive with cURL');
        $this->incoming_payload = curl_exec($this->ch);
        $data = $this->incoming_payload;
        $cErr = curl_error($this->ch);
        if ($cErr != '') {
          $err = 'cURL ERROR: ' . curl_errno($this->ch) . ': ' . $cErr . '<br>';

          // TODO: there is a PHP bug that can cause this to SEGV for CURLINFO_CONTENT_TYPE
          foreach (curl_getinfo($this->ch) as $k => $v) {
            $err .= "{$k}: {$v}<br>";
          }
          $this
            ->debug($err);
          $this
            ->setError($err);
          curl_close($this->ch);
          return false;
        }
        else {

          //echo '<pre>';

          //var_dump(curl_getinfo($this->ch));

          //echo '</pre>';
        }

        // close curl
        $this
          ->debug('No cURL error, closing cURL');
        curl_close($this->ch);

        // remove 100 header(s)
        while (ereg('^HTTP/1.1 100', $data)) {
          if ($pos = strpos($data, "\r\n\r\n")) {
            $data = ltrim(substr($data, $pos));
          }
          elseif ($pos = strpos($data, "\n\n")) {
            $data = ltrim(substr($data, $pos));
          }
        }

        // separate content from HTTP headers
        if ($pos = strpos($data, "\r\n\r\n")) {
          $lb = "\r\n";
        }
        elseif ($pos = strpos($data, "\n\n")) {
          $lb = "\n";
        }
        else {
          $this
            ->debug('no proper separation of headers and document');
          $this
            ->setError('no proper separation of headers and document');
          return false;
        }
        $header_data = trim(substr($data, 0, $pos));
        $header_array = explode($lb, $header_data);
        $data = ltrim(substr($data, $pos));
        $this
          ->debug('found proper separation of headers and document');
        $this
          ->debug('cleaned data, stringlen: ' . strlen($data));

        // clean headers
        foreach ($header_array as $header_line) {
          $arr = explode(':', $header_line, 2);
          if (count($arr) > 1) {
            $header_name = strtolower(trim($arr[0]));
            $this->incoming_headers[$header_name] = trim($arr[1]);
            if ($header_name == 'set-cookie') {

              // TODO: allow multiple cookies from parseCookie
              $cookie = $this
                ->parseCookie(trim($arr[1]));
              if ($cookie) {
                $this->incoming_cookies[] = $cookie;
                $this
                  ->debug('found cookie: ' . $cookie['name'] . ' = ' . $cookie['value']);
              }
              else {
                $this
                  ->debug('did not find cookie in ' . trim($arr[1]));
              }
            }
          }
          else {
            if (isset($header_name)) {

              // append continuation line to previous header
              $this->incoming_headers[$header_name] .= $lb . ' ' . $header_line;
            }
          }
        }
      }
    }
    $arr = explode(' ', $header_array[0], 3);
    $http_version = $arr[0];
    $http_status = intval($arr[1]);
    $http_reason = count($arr) > 2 ? $arr[2] : '';

    // see if we need to resend the request with http digest authentication
    if (isset($this->incoming_headers['location']) && $http_status == 301) {
      $this
        ->debug("Got 301 {$http_reason} with Location: " . $this->incoming_headers['location']);
      $this
        ->setURL($this->incoming_headers['location']);
      $this->tryagain = true;
      return false;
    }

    // see if we need to resend the request with http digest authentication
    if (isset($this->incoming_headers['www-authenticate']) && $http_status == 401) {
      $this
        ->debug("Got 401 {$http_reason} with WWW-Authenticate: " . $this->incoming_headers['www-authenticate']);
      if (strstr($this->incoming_headers['www-authenticate'], "Digest ")) {
        $this
          ->debug('Server wants digest authentication');

        // remove "Digest " from our elements
        $digestString = str_replace('Digest ', '', $this->incoming_headers['www-authenticate']);

        // parse elements into array
        $digestElements = explode(',', $digestString);
        foreach ($digestElements as $val) {
          $tempElement = explode('=', trim($val), 2);
          $digestRequest[$tempElement[0]] = str_replace("\"", '', $tempElement[1]);
        }

        // should have (at least) qop, realm, nonce
        if (isset($digestRequest['nonce'])) {
          $this
            ->setCredentials($this->username, $this->password, 'digest', $digestRequest);
          $this->tryagain = true;
          return false;
        }
      }
      $this
        ->debug('HTTP authentication failed');
      $this
        ->setError('HTTP authentication failed');
      return false;
    }
    if ($http_status >= 300 && $http_status <= 307 || $http_status >= 400 && $http_status <= 417 || $http_status >= 501 && $http_status <= 505) {
      $this
        ->setError("Unsupported HTTP response status {$http_status} {$http_reason} (soapclient->response has contents of the response)");
      return false;
    }

    // decode content-encoding
    if (isset($this->incoming_headers['content-encoding']) && $this->incoming_headers['content-encoding'] != '') {
      if (strtolower($this->incoming_headers['content-encoding']) == 'deflate' || strtolower($this->incoming_headers['content-encoding']) == 'gzip') {

        // if decoding works, use it. else assume data wasn't gzencoded
        if (function_exists('gzinflate')) {

          //$timer->setMarker('starting decoding of gzip/deflated content');

          // IIS 5 requires gzinflate instead of gzuncompress (similar to IE 5 and gzdeflate v. gzcompress)
          // this means there are no Zlib headers, although there should be
          $this
            ->debug('The gzinflate function exists');
          $datalen = strlen($data);
          if ($this->incoming_headers['content-encoding'] == 'deflate') {
            if ($degzdata = @gzinflate($data)) {
              $data = $degzdata;
              $this
                ->debug('The payload has been inflated to ' . strlen($data) . ' bytes');
              if (strlen($data) < $datalen) {

                // test for the case that the payload has been compressed twice
                $this
                  ->debug('The inflated payload is smaller than the gzipped one; try again');
                if ($degzdata = @gzinflate($data)) {
                  $data = $degzdata;
                  $this
                    ->debug('The payload has been inflated again to ' . strlen($data) . ' bytes');
                }
              }
            }
            else {
              $this
                ->debug('Error using gzinflate to inflate the payload');
              $this
                ->setError('Error using gzinflate to inflate the payload');
            }
          }
          elseif ($this->incoming_headers['content-encoding'] == 'gzip') {
            if ($degzdata = @gzinflate(substr($data, 10))) {

              // do our best
              $data = $degzdata;
              $this
                ->debug('The payload has been un-gzipped to ' . strlen($data) . ' bytes');
              if (strlen($data) < $datalen) {

                // test for the case that the payload has been compressed twice
                $this
                  ->debug('The un-gzipped payload is smaller than the gzipped one; try again');
                if ($degzdata = @gzinflate(substr($data, 10))) {
                  $data = $degzdata;
                  $this
                    ->debug('The payload has been un-gzipped again to ' . strlen($data) . ' bytes');
                }
              }
            }
            else {
              $this
                ->debug('Error using gzinflate to un-gzip the payload');
              $this
                ->setError('Error using gzinflate to un-gzip the payload');
            }
          }

          //$timer->setMarker('finished decoding of gzip/deflated content');

          //print "<xmp>\nde-inflated:\n---------------\n$data\n-------------\n</xmp>";

          // set decoded payload
          $this->incoming_payload = $header_data . $lb . $lb . $data;
        }
        else {
          $this
            ->debug('The server sent compressed data. Your php install must have the Zlib extension compiled in to support this.');
          $this
            ->setError('The server sent compressed data. Your php install must have the Zlib extension compiled in to support this.');
        }
      }
      else {
        $this
          ->debug('Unsupported Content-Encoding ' . $this->incoming_headers['content-encoding']);
        $this
          ->setError('Unsupported Content-Encoding ' . $this->incoming_headers['content-encoding']);
      }
    }
    else {
      $this
        ->debug('No Content-Encoding header');
    }
    if (strlen($data) == 0) {
      $this
        ->debug('no data after headers!');
      $this
        ->setError('no data present after HTTP headers');
      return false;
    }
    return $data;
  }
  function setContentType($type, $charset = false) {
    $this->outgoing_headers['Content-Type'] = $type . ($charset ? '; charset=' . $charset : '');
    $this
      ->debug('set Content-Type: ' . $this->outgoing_headers['Content-Type']);
  }
  function usePersistentConnection() {
    if (isset($this->outgoing_headers['Accept-Encoding'])) {
      return false;
    }
    $this->protocol_version = '1.1';
    $this->persistentConnection = true;
    $this->outgoing_headers['Connection'] = 'Keep-Alive';
    $this
      ->debug('set Connection: ' . $this->outgoing_headers['Connection']);
    return true;
  }

  /**
   * parse an incoming Cookie into it's parts
   *
   * @param	string $cookie_str content of cookie
   * @return	array with data of that cookie
   * @access	private
   */

  /*
   * TODO: allow a Set-Cookie string to be parsed into multiple cookies
   */
  function parseCookie($cookie_str) {
    $cookie_str = str_replace('; ', ';', $cookie_str) . ';';
    $data = split(';', $cookie_str);
    $value_str = $data[0];
    $cookie_param = 'domain=';
    $start = strpos($cookie_str, $cookie_param);
    if ($start > 0) {
      $domain = substr($cookie_str, $start + strlen($cookie_param));
      $domain = substr($domain, 0, strpos($domain, ';'));
    }
    else {
      $domain = '';
    }
    $cookie_param = 'expires=';
    $start = strpos($cookie_str, $cookie_param);
    if ($start > 0) {
      $expires = substr($cookie_str, $start + strlen($cookie_param));
      $expires = substr($expires, 0, strpos($expires, ';'));
    }
    else {
      $expires = '';
    }
    $cookie_param = 'path=';
    $start = strpos($cookie_str, $cookie_param);
    if ($start > 0) {
      $path = substr($cookie_str, $start + strlen($cookie_param));
      $path = substr($path, 0, strpos($path, ';'));
    }
    else {
      $path = '/';
    }
    $cookie_param = ';secure;';
    if (strpos($cookie_str, $cookie_param) !== FALSE) {
      $secure = true;
    }
    else {
      $secure = false;
    }
    $sep_pos = strpos($value_str, '=');
    if ($sep_pos) {
      $name = substr($value_str, 0, $sep_pos);
      $value = substr($value_str, $sep_pos + 1);
      $cookie = array(
        'name' => $name,
        'value' => $value,
        'domain' => $domain,
        'path' => $path,
        'expires' => $expires,
        'secure' => $secure,
      );
      return $cookie;
    }
    return false;
  }

  /**
   * sort out cookies for the current request
   *
   * @param	array $cookies array with all cookies
   * @param	boolean $secure is the send-content secure or not?
   * @return	string for Cookie-HTTP-Header
   * @access	private
   */
  function getCookiesForRequest($cookies, $secure = false) {
    $cookie_str = '';
    if (!is_null($cookies) && is_array($cookies)) {
      foreach ($cookies as $cookie) {
        if (!is_array($cookie)) {
          continue;
        }
        $this
          ->debug("check cookie for validity: " . $cookie['name'] . '=' . $cookie['value']);
        if (isset($cookie['expires']) && !empty($cookie['expires'])) {
          if (strtotime($cookie['expires']) <= time()) {
            $this
              ->debug('cookie has expired');
            continue;
          }
        }
        if (isset($cookie['domain']) && !empty($cookie['domain'])) {
          $domain = preg_quote($cookie['domain']);
          if (!preg_match("'.*{$domain}\$'i", $this->host)) {
            $this
              ->debug('cookie has different domain');
            continue;
          }
        }
        if (isset($cookie['path']) && !empty($cookie['path'])) {
          $path = preg_quote($cookie['path']);
          if (!preg_match("'^{$path}.*'i", $this->path)) {
            $this
              ->debug('cookie is for a different path');
            continue;
          }
        }
        if (!$secure && isset($cookie['secure']) && $cookie['secure']) {
          $this
            ->debug('cookie is secure, transport is not');
          continue;
        }
        $cookie_str .= $cookie['name'] . '=' . $cookie['value'] . '; ';
        $this
          ->debug('add cookie to Cookie-String: ' . $cookie['name'] . '=' . $cookie['value']);
      }
    }
    return $cookie_str;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
soap_transport_http::$authtype property
soap_transport_http::$certRequest property
soap_transport_http::$ch property
soap_transport_http::$digestRequest property
soap_transport_http::$digest_uri property
soap_transport_http::$encoding property
soap_transport_http::$host property
soap_transport_http::$incoming_cookies property
soap_transport_http::$incoming_headers property
soap_transport_http::$incoming_payload property
soap_transport_http::$outgoing_headers property
soap_transport_http::$outgoing_payload property
soap_transport_http::$password property
soap_transport_http::$path property
soap_transport_http::$persistentConnection property
soap_transport_http::$port property
soap_transport_http::$protocol_version property
soap_transport_http::$request_method property
soap_transport_http::$scheme property
soap_transport_http::$uri property
soap_transport_http::$url property
soap_transport_http::$username property
soap_transport_http::$useSOAPAction property
soap_transport_http::buildPayload function
soap_transport_http::connect function
soap_transport_http::decodeChunked function * decode a string that is encoded w/ "chunked' transfer encoding * as defined in RFC2068 19.4.6 * *
soap_transport_http::getCookiesForRequest function * sort out cookies for the current request * *
soap_transport_http::getResponse function
soap_transport_http::parseCookie function
soap_transport_http::send function * send the SOAP message via HTTP * *
soap_transport_http::sendHTTPS function * send the SOAP message via HTTPS 1.0 using CURL * *
soap_transport_http::sendRequest function
soap_transport_http::setContentType function
soap_transport_http::setCredentials function * if authenticating, set user credentials here * *
soap_transport_http::setEncoding function * use http encoding * *
soap_transport_http::setProxy function * set proxy info here * *
soap_transport_http::setSOAPAction function * set the soapaction value * *
soap_transport_http::setURL function
soap_transport_http::soap_transport_http function * constructor
soap_transport_http::usePersistentConnection function