Inheritance diagram for ilBMFTransport_HTTP:
Collaboration diagram for ilBMFTransport_HTTP:
Public Member Functions | |
| ilBMFTransport_HTTP ($URL, $encoding=SOAP_DEFAULT_ENCODING) | |
| ilBMFTransport_HTTP Constructor | |
| & | send (&$msg, $options=null) |
| send and receive soap data | |
| setCredentials ($username, $password) | |
| set data for http authentication creates Authorization header | |
| addCookie ($name, $value) | |
| Add a cookie. | |
| _genCookieHeader () | |
| Generates the correct headers for the cookies. | |
| _validateUrl () | |
| validate url data passed to constructor | |
| _parseEncoding ($headers) | |
| Finds out what is the encoding. | |
| _parseHeaders ($headers) | |
| Parses the headers. | |
| _parseResponse () | |
| Remove http headers from response. | |
| & | _getRequest (&$msg, $options) |
| Create http request, including headers, for outgoing request. | |
| & | _sendHTTP (&$msg, $options) |
| Send outgoing request, and read/parse response. | |
| & | _sendHTTPS (&$msg, $options) |
| Send outgoing request, and read/parse response, via HTTPS. | |
Data Fields | |
| $headers = array() | |
| $cookies | |
| $timeout = 4 | |
| $urlparts = NULL | |
| $url = '' | |
| $incoming_payload = '' | |
| $_userAgent = SOAP_LIBRARY_NAME | |
| $encoding = SOAP_DEFAULT_ENCODING | |
| $result_encoding = 'UTF-8' | |
| $result_content_type | |
| HTTP-Response Content-Type. | |
| $result_headers = array() | |
| $result_cookies = array() | |
Detailed Description
Definition at line 42 of file class.ilBMFTransport_HTTP.php.
Member Function Documentation
| ilBMFTransport_HTTP::_genCookieHeader | ( | ) |
Generates the correct headers for the cookies.
private
- Returns:
- void
Definition at line 196 of file class.ilBMFTransport_HTTP.php.
References $cookies.
Referenced by _getRequest().
{
foreach ($this->cookies as $name=>$value) {
$cookies = (isset($cookies) ? $cookies. '; ' : '') .
urlencode($name) . '=' . urlencode($value);
}
return $cookies;
}
Here is the caller graph for this function:
| & ilBMFTransport_HTTP::_getRequest | ( | &$ | msg, | |
| $ | options | |||
| ) |
Create http request, including headers, for outgoing request.
- Parameters:
-
string &$msg outgoing SOAP package $options
- Returns:
- string outgoing_payload private
Definition at line 425 of file class.ilBMFTransport_HTTP.php.
References $headers, _genCookieHeader(), and setCredentials().
Referenced by _sendHTTP(), and _sendHTTPS().
{
$action = isset($options['soapaction'])?$options['soapaction']:'';
$fullpath = $this->urlparts['path'].
(isset($this->urlparts['query'])?'?'.$this->urlparts['query']:'').
(isset($this->urlparts['fragment'])?'#'.$this->urlparts['fragment']:'');
if (isset($options['proxy_host'])) {
$fullpath = 'http://' . $this->urlparts['host'] . ':' . $this->urlparts['port'] . $fullpath;
}
if (isset($options['proxy_user'])) {
$this->headers['Proxy-Authorization'] = 'Basic ' . base64_encode($options['proxy_user'].":".$options['proxy_pass']);
}
if (isset($options['user'])) {
$this->setCredentials($options['user'], $options['pass']);
}
$this->headers['User-Agent'] = $this->_userAgent;
$this->headers['Host'] = $this->urlparts['host'];
$this->headers['Content-Type'] = "text/xml; charset=$this->encoding";
$this->headers['Content-Length'] = strlen($msg);
$this->headers['SOAPAction'] = "\"$action\"";
if (isset($options['headers'])) {
$this->headers = array_merge($this->headers, $options['headers']);
}
$this->cookies = array();
if (!isset($options['nocookies']) || !$options['nocookies']) {
// add the cookies we got from the last request
if (isset($this->result_cookies)) {
foreach ($this->result_cookies as $cookie) {
if ($cookie['domain'] == $this->urlparts['host'])
$this->cookies[$cookie['name']]=$cookie['value'];
}
}
}
// add cookies the user wants to set
if (isset($options['cookies'])) {
foreach ($options['cookies'] as $cookie) {
if ($cookie['domain'] == $this->urlparts['host'])
$this->cookies[$cookie['name']]=$cookie['value'];
}
}
if (count($this->cookies)) {
$this->headers['Cookie'] = $this->_genCookieHeader();
}
$headers = '';
foreach ($this->headers as $k => $v) {
$headers .= "$k: $v\r\n";
}
$this->outgoing_payload =
"POST $fullpath HTTP/1.0\r\n".
$headers."\r\n".
$msg;
return $this->outgoing_payload;
}
Here is the call graph for this function:
Here is the caller graph for this function:
| ilBMFTransport_HTTP::_parseEncoding | ( | $ | headers | ) |
Finds out what is the encoding.
Sets the object property accordingly.
private
- Parameters:
-
array $headers headers
- Returns:
- void
Definition at line 247 of file class.ilBMFTransport_HTTP.php.
References $headers.
Referenced by _parseResponse().
{
$h = stristr($headers, 'Content-Type');
preg_match_all('/^Content-Type:\s*(.*)$/im', $h, $ct, PREG_SET_ORDER);
$n = count($ct);
$ct = $ct[$n - 1];
$this->result_content_type = str_replace("\r", '', $ct[1]);
if (preg_match('/(.*?)(?:;\s?charset=)(.*)/i', $this->result_content_type, $m)) {
// strip the string of \r
$this->result_content_type = $m[1];
if (count($m) > 2) {
$enc = strtoupper(str_replace('"', '', $m[2]));
if (in_array($enc, $this->_encodings)) {
$this->result_encoding = $enc;
}
}
}
// deal with broken servers that don't set content type on faults
if (!$this->result_content_type) $this->result_content_type = 'text/xml';
}
Here is the caller graph for this function:
| ilBMFTransport_HTTP::_parseHeaders | ( | $ | headers | ) |
Parses the headers.
- Parameters:
-
array $headers the headers
- Returns:
- void
Definition at line 274 of file class.ilBMFTransport_HTTP.php.
References $headers.
Referenced by _parseResponse().
{
/* largely borrowed from HTTP_Request */
$this->result_headers = array();
$headers = split("\r?\n", $headers);
foreach ($headers as $value) {
if (strpos($value,':') === false) {
$this->result_headers[0]=$value;
continue;
}
list($name,$value) = split(':',$value);
$headername = strtolower($name);
$headervalue = trim($value);
$this->result_headers[$headername]=$headervalue;
if ($headername == 'set-cookie') {
// Parse a SetCookie header to fill _cookies array
$cookie = array(
'expires' => null,
'domain' => $this->urlparts['host'],
'path' => null,
'secure' => false
);
// Only a name=value pair
if (!strpos($headervalue, ';')) {
list($cookie['name'], $cookie['value']) = array_map('trim', explode('=', $headervalue));
$cookie['name'] = urldecode($cookie['name']);
$cookie['value'] = urldecode($cookie['value']);
// Some optional parameters are supplied
} else {
$elements = explode(';', $headervalue);
list($cookie['name'], $cookie['value']) = array_map('trim', explode('=', $elements[0]));
$cookie['name'] = urldecode($cookie['name']);
$cookie['value'] = urldecode($cookie['value']);
for ($i = 1; $i < count($elements);$i++) {
if (strpos($elements[$i], '=') > 0) {
list ($elName, $elValue) = array_map('trim', explode('=', $elements[$i]));
} else {
$elName = $elements[$i];
$elValue = NULL;
}
if ('secure' == $elName) {
$cookie['secure'] = true;
} elseif ('expires' == $elName) {
$cookie['expires'] = str_replace('"', '', $elValue);
} elseif ('path' == $elName OR 'domain' == $elName) {
$cookie[$elName] = urldecode($elValue);
} else {
$cookie[$elName] = $elValue;
}
}
}
$this->result_cookies[] = $cookie;
}
}
}
Here is the caller graph for this function:
| ilBMFTransport_HTTP::_parseResponse | ( | ) |
Remove http headers from response.
- Returns:
- boolean private
Definition at line 341 of file class.ilBMFTransport_HTTP.php.
References ilBMFBase::_decodeDIMEMessage(), ilBMFBase::_decodeMimeMessage(), _parseEncoding(), _parseHeaders(), and ilBMFBase_Object::_raiseSoapFault().
Referenced by _sendHTTP(), and _sendHTTPS().
{
if (preg_match("/^(.*?)\r?\n\r?\n(.*)/s", $this->incoming_payload, $match)) {
#$this->response = preg_replace("/[\r|\n]/", '', $match[2]);
$this->response =& $match[2];
// find the response error, some servers response with 500 for soap faults
$this->_parseHeaders($match[1]);
list($protocol, $code, $msg) = sscanf($this->result_headers[0], '%s %s %s');
unset($this->result_headers[0]);
switch($code) {
case 100: // Continue
$this->incoming_payload = $match[2];
return $this->_parseResponse();
case 400:
$this->_raiseSoapFault("HTTP Response $code Bad Request");
return false;
break;
case 401:
$this->_raiseSoapFault("HTTP Response $code Authentication Failed");
return false;
break;
case 403:
$this->_raiseSoapFault("HTTP Response $code Forbidden");
return false;
break;
case 404:
$this->_raiseSoapFault("HTTP Response $code Not Found");
return false;
break;
case 407:
$this->_raiseSoapFault("HTTP Response $code Proxy Authentication Required");
return false;
break;
case 408:
$this->_raiseSoapFault("HTTP Response $code Request Timeout");
return false;
break;
case 410:
$this->_raiseSoapFault("HTTP Response $code Gone");
return false;
break;
default:
if ($code >= 400 && $code < 500) {
$this->_raiseSoapFault("HTTP Response $code Not Found, Server message: $msg");
return false;
}
}
$this->_parseEncoding($match[1]);
if ($this->result_content_type == 'application/dime') {
// XXX quick hack insertion of DIME
if (PEAR::isError($this->_decodeDIMEMessage($this->response,$this->headers,$this->attachments))) {
// _decodeDIMEMessage already raised $this->fault
return false;
}
$this->result_content_type = $this->headers['content-type'];
} else if (stristr($this->result_content_type,'multipart/related')) {
$this->response = $this->incoming_payload;
if (PEAR::isError($this->_decodeMimeMessage($this->response,$this->headers,$this->attachments))) {
// _decodeMimeMessage already raised $this->fault
return false;
}
} else if ($this->result_content_type != 'text/xml') {
$this->_raiseSoapFault($this->response);
return false;
}
// if no content, return false
return strlen($this->response) > 0;
}
$this->_raiseSoapFault('Invalid HTTP Response');
return false;
}
Here is the call graph for this function:
Here is the caller graph for this function:
| & ilBMFTransport_HTTP::_sendHTTP | ( | &$ | msg, | |
| $ | options | |||
| ) |
Send outgoing request, and read/parse response.
- Returns:
- string &$response response data, minus http headers private
Definition at line 492 of file class.ilBMFTransport_HTTP.php.
References $data, $host, _getRequest(), _parseResponse(), and ilBMFBase_Object::_raiseSoapFault().
Referenced by send().
{
$this->incoming_payload = '';
$this->_getRequest($msg, $options);
$host = $this->urlparts['host'];
$port = $this->urlparts['port'];
if (isset($options['proxy_host'])) {
$host = $options['proxy_host'];
$port = isset($options['proxy_port']) ? $options['proxy_port'] : 8080;
}
// send
if ($this->timeout > 0) {
$fp = @fsockopen($host, $port, $this->errno, $this->errmsg, $this->timeout);
} else {
$fp = @fsockopen($host, $port, $this->errno, $this->errmsg);
}
if (!$fp) {
return $this->_raiseSoapFault("Connect Error to $host:$port");
}
if ($this->timeout > 0) {
// some builds of php do not support this, silence
// the warning
@socket_set_timeout($fp, $this->timeout);
}
if (!fputs($fp, $this->outgoing_payload, strlen($this->outgoing_payload))) {
return $this->_raiseSoapFault("Error POSTing Data to $host");
}
// get reponse
// XXX time consumer
do {
$data = fread($fp, 4096);
$_tmp_status = socket_get_status($fp);
if ($_tmp_status['timed_out']) {
return $this->_raiseSoapFault("Timed out read from $host");
} else {
$this->incoming_payload .= $data;
}
} while (!$_tmp_status['eof']);
fclose($fp);
if (!$this->_parseResponse()) {
return $this->fault;
}
return $this->response;
}
Here is the call graph for this function:
Here is the caller graph for this function:
| & ilBMFTransport_HTTP::_sendHTTPS | ( | &$ | msg, | |
| $ | options | |||
| ) |
Send outgoing request, and read/parse response, via HTTPS.
- Returns:
- string &$response response data, minus http headers private
Definition at line 548 of file class.ilBMFTransport_HTTP.php.
References $host, $key, _getRequest(), _parseResponse(), and ilBMFBase_Object::_raiseSoapFault().
Referenced by send().
{
/* NOTE This function uses the CURL functions
* Your php must be compiled with CURL
*/
if (!extension_loaded('curl')) {
return $this->_raiseSoapFault('CURL Extension is required for HTTPS');
}
$this->_getRequest($msg, $options);
$ch = curl_init();
// XXX don't know if this proxy stuff is right for CURL
// Arnaud: apparently it is, we have a proxy and it works
// with these lines.
if (isset($options['proxy_host'])) {
// $options['http_proxy'] == 'hostname:port'
$host = $options['proxy_host'];
$port = isset($options['proxy_port']) ? $options['proxy_port'] : 8080;
curl_setopt($ch, CURLOPT_PROXY, $host . ":" . $port);
}
if (isset($options['proxy_user'])) {
// $options['http_proxy_userpw'] == 'username:password'
curl_setopt($ch, CURLOPT_PROXYUSERPWD, $options['proxy_user'] . ':' . $options['proxy_pass']);
}
if (isset($options['user'])) {
curl_setopt($ch, CURLOPT_USERPWD, $options['user'] . ':' . $options['pass']);
}
if (!isset($options['soapaction'])) {
$options['soapaction'] = '';
}
curl_setopt($ch, CURLOPT_HTTPHEADER , array('Content-Type: text/xml;charset=' . $this->encoding, 'SOAPAction: "'.$options['soapaction'].'"'));
curl_setopt($ch, CURLOPT_USERAGENT , $this->_userAgent);
if ($this->timeout) {
curl_setopt($ch, CURLOPT_TIMEOUT, $this->timeout); //times out after 4s
}
curl_setopt($ch, CURLOPT_POSTFIELDS, $msg);
curl_setopt($ch, CURLOPT_URL, $this->url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_FAILONERROR, 1);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HEADER, 1);
curl_setopt($ch, CURLOPT_HTTP_VERSION, 1);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_VERBOSE, 1);
if (isset($options['curl'])) {
reset($options['curl']);
while (list($key, $val) = each ($options['curl'])) {
curl_setopt($ch, $key, $val);
}
}
$this->incoming_payload = curl_exec($ch);
if (! $this->incoming_payload ) {
$m = 'curl_exec error ' . curl_errno($ch) . ' ' . curl_error($ch);
curl_close($ch);
return $this->_raiseSoapFault($m);
}
curl_close($ch);
if (!$this->_parseResponse()) {
return $this->fault;
}
return $this->response;
}
Here is the call graph for this function:
Here is the caller graph for this function:
| ilBMFTransport_HTTP::_validateUrl | ( | ) |
validate url data passed to constructor
private
- Returns:
- boolean
Definition at line 211 of file class.ilBMFTransport_HTTP.php.
References ilBMFBase_Object::_raiseSoapFault(), and setCredentials().
Referenced by send().
{
if ( ! is_array($this->urlparts) ) {
$this->_raiseSoapFault("Unable to parse URL " . $this->url);
return false;
}
if (!isset($this->urlparts['host'])) {
$this->_raiseSoapFault("No host in URL " . $this->url);
return false;
}
if (!isset($this->urlparts['port'])) {
if (strcasecmp($this->urlparts['scheme'], 'HTTP') == 0)
$this->urlparts['port'] = 80;
else if (strcasecmp($this->urlparts['scheme'], 'HTTPS') == 0)
$this->urlparts['port'] = 443;
}
if (isset($this->urlparts['user'])) {
$this->setCredentials(urldecode($this->urlparts['user']),
urldecode($this->urlparts['pass']));
}
if (!isset($this->urlparts['path']) || !$this->urlparts['path'])
$this->urlparts['path'] = '/';
return true;
}
Here is the call graph for this function:
Here is the caller graph for this function:
| ilBMFTransport_HTTP::addCookie | ( | $ | name, | |
| $ | value | |||
| ) |
Add a cookie.
public
- Parameters:
-
string $name cookie name mixed $value cookie value
- Returns:
- void
Definition at line 183 of file class.ilBMFTransport_HTTP.php.
{
$this->cookies[$name]=$value;
}
| ilBMFTransport_HTTP::ilBMFTransport_HTTP | ( | $ | URL, | |
| $ | encoding = SOAP_DEFAULT_ENCODING | |||
| ) |
ilBMFTransport_HTTP Constructor
- Parameters:
-
string $URL http url to soap endpoint
public
- Parameters:
-
string $URI string $encoding encoding to use
Definition at line 125 of file class.ilBMFTransport_HTTP.php.
References $encoding, and ilBMFBase::ilBMFBase().
{
parent::ilBMFBase('HTTP');
$this->urlparts = @parse_url($URL);
$this->url = $URL;
$this->encoding = $encoding;
}
Here is the call graph for this function:
| & ilBMFTransport_HTTP::send | ( | &$ | msg, | |
| $ | options = null | |||
| ) |
send and receive soap data
- Parameters:
-
string outgoing post data array options
- Returns:
- string|fault response public
Definition at line 142 of file class.ilBMFTransport_HTTP.php.
References ilBMFBase_Object::_raiseSoapFault(), _sendHTTP(), _sendHTTPS(), and _validateUrl().
{
if (!$this->_validateUrl()) {
return $this->fault;
}
if (isset($options['timeout']))
$this->timeout = (int)$options['timeout'];
if (strcasecmp($this->urlparts['scheme'], 'HTTP') == 0) {
return $this->_sendHTTP($msg, $options);
} else if (strcasecmp($this->urlparts['scheme'], 'HTTPS') == 0) {
return $this->_sendHTTPS($msg, $options);
}
return $this->_raiseSoapFault('Invalid url scheme '.$this->url);
}
Here is the call graph for this function:
| ilBMFTransport_HTTP::setCredentials | ( | $ | username, | |
| $ | password | |||
| ) |
set data for http authentication creates Authorization header
- Parameters:
-
string $username username string $password response data, minus http headers
- Returns:
- none public
Definition at line 170 of file class.ilBMFTransport_HTTP.php.
Referenced by _getRequest(), and _validateUrl().
{
$this->headers['Authorization'] = 'Basic ' . base64_encode($username . ':' . $password);
}
Here is the caller graph for this function:
Field Documentation
| ilBMFTransport_HTTP::$_userAgent = SOAP_LIBRARY_NAME |
Definition at line 90 of file class.ilBMFTransport_HTTP.php.
| ilBMFTransport_HTTP::$cookies |
Definition at line 56 of file class.ilBMFTransport_HTTP.php.
Referenced by _genCookieHeader().
| ilBMFTransport_HTTP::$encoding = SOAP_DEFAULT_ENCODING |
Definition at line 97 of file class.ilBMFTransport_HTTP.php.
Referenced by ilBMFTransport_HTTP().
| ilBMFTransport_HTTP::$headers = array() |
Definition at line 49 of file class.ilBMFTransport_HTTP.php.
Referenced by _getRequest(), _parseEncoding(), and _parseHeaders().
| ilBMFTransport_HTTP::$incoming_payload = '' |
Definition at line 83 of file class.ilBMFTransport_HTTP.php.
| ilBMFTransport_HTTP::$result_content_type |
HTTP-Response Content-Type.
Definition at line 110 of file class.ilBMFTransport_HTTP.php.
| ilBMFTransport_HTTP::$result_cookies = array() |
Definition at line 114 of file class.ilBMFTransport_HTTP.php.
| ilBMFTransport_HTTP::$result_encoding = 'UTF-8' |
Definition at line 105 of file class.ilBMFTransport_HTTP.php.
| ilBMFTransport_HTTP::$result_headers = array() |
Definition at line 112 of file class.ilBMFTransport_HTTP.php.
| ilBMFTransport_HTTP::$timeout = 4 |
Definition at line 62 of file class.ilBMFTransport_HTTP.php.
| ilBMFTransport_HTTP::$url = '' |
Definition at line 76 of file class.ilBMFTransport_HTTP.php.
| ilBMFTransport_HTTP::$urlparts = NULL |
Definition at line 69 of file class.ilBMFTransport_HTTP.php.
The documentation for this class was generated from the following file:
- payment/bmf/lib/SOAP/Transport/class.ilBMFTransport_HTTP.php
