1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
<?php
/**
* Contains \JamesIArmes\PhpNtlm\NTLMSoapClient.
*/
namespace jamesiarmes\PhpNtlm;
/**
* Soap Client using Microsoft's NTLM Authentication.
*
* @package php-ntlm\Soap
*/
class SoapClient extends \SoapClient
{
/**
* cURL resource used to make the SOAP request
*
* @var resource
*/
protected $ch;
/**
* Options passed to the client constructor.
*
* @var array
*/
protected $options;
/**
* {@inheritdoc}
*
* Additional options:
* - user (string): The user to authenticate with.
* - password (string): The password to use when authenticating the user.
* - curlopts (array): Array of options to set on the curl handler when
* making the request.
* - strip_bad_chars (boolean, default true): Whether or not to strip
* invalid characters from the XML response. This can lead to content
* being returned differently than it actually is on the host service, but
* can also prevent the "looks like we got no XML document" SoapFault when
* the response includes invalid characters.
* - warn_on_bad_chars (boolean, default false): Trigger a warning if bad
* characters are stripped. This has no affect unless strip_bad_chars is
* true.
*/
public function __construct($wsdl, array $options = null)
{
// Set missing indexes to their default value.
$options += array(
'user' => null,
'password' => null,
'curlopts' => array(),
'strip_bad_chars' => true,
'warn_on_bad_chars' => false,
);
$this->options = $options;
// Verify that a user name and password were entered.
if (empty($options['user']) || empty($options['password'])) {
throw new \BadMethodCallException(
'A username and password is required.'
);
}
parent::__construct($wsdl, $options);
}
/**
* {@inheritdoc}
*/
public function __doRequest($request, $location, $action, $version, $one_way = 0)
{
$headers = $this->buildHeaders($action);
$this->__last_request = $request;
$this->__last_request_headers = $headers;
// Only reinitialize curl handle if the location is different.
if (!$this->ch
|| curl_getinfo($this->ch, CURLINFO_EFFECTIVE_URL) != $location) {
$this->ch = curl_init($location);
}
curl_setopt_array($this->ch, $this->curlOptions($action, $request));
$response = curl_exec($this->ch);
// TODO: Add some real error handling.
// If the response if false than there was an error and we should throw
// an exception.
if ($response === false) {
$this->__last_response = $this->__last_response_headers = false;
throw new \RuntimeException(
'Curl error: ' . curl_error($this->ch),
curl_errno($this->ch)
);
}
$this->parseResponse($response);
$this->cleanResponse();
return $this->__last_response;
}
/**
* {@inheritdoc}
*/
public function __getLastRequestHeaders()
{
return implode("\n", $this->__last_request_headers) . "\n";
}
/**
* Returns the response code from the last request
*
* @return integer
*
* @throws \BadMethodCallException
* If no cURL resource has been initialized.
*/
public function getResponseCode()
{
if (empty($this->ch)) {
throw new \BadMethodCallException('No cURL resource has been '
. 'initialized. This is probably because no request has not '
. 'been made.');
}
return curl_getinfo($this->ch, CURLINFO_HTTP_CODE);
}
/**
* Builds the headers for the request.
*
* @param string $action
* The SOAP action to be performed.
*/
protected function buildHeaders($action)
{
return array(
'Method: POST',
'Connection: Keep-Alive',
'User-Agent: PHP-SOAP-CURL',
'Content-Type: text/xml; charset=utf-8',
"SOAPAction: \"$action\"",
'Expect: 100-continue',
);
}
/**
* Cleans the response body by stripping bad characters if instructed to.
*/
protected function cleanResponse()
{
// If the option to strip bad characters is not set, then we shouldn't
// do anything here.
if (!$this->options['strip_bad_chars']) {
return;
}
// Strip invalid characters from the XML response body.
$count = 0;
$this->__last_response = preg_replace(
'/(?!�?(9|A|D))(&#x[0-1]?[0-9A-F];)/',
' ',
$this->__last_response,
-1,
$count
);
// If the option to warn on bad characters is set, and some characters
// were stripped, then trigger a warning.
if ($this->options['warn_on_bad_chars'] && $count > 0) {
trigger_error(
'Invalid characters were stripped from the XML SOAP response.',
E_USER_WARNING
);
}
}
/**
* Builds an array of curl options for the request
*
* @param string $action
* The SOAP action to be performed.
* @param string $request
* The XML SOAP request.
* @return array
* Array of curl options.
*/
protected function curlOptions($action, $request)
{
$options = $this->options['curlopts'] + array(
CURLOPT_SSL_VERIFYPEER => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => $this->buildHeaders($action),
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_HTTPAUTH => CURLAUTH_BASIC | CURLAUTH_NTLM,
CURLOPT_USERPWD => $this->options['user'] . ':'
. $this->options['password'],
);
// We shouldn't allow these options to be overridden.
$options[CURLOPT_HEADER] = true;
$options[CURLOPT_POST] = true;
$options[CURLOPT_POSTFIELDS] = $request;
return $options;
}
/**
* Pareses the response from a successful request.
*
* @param string $response
* The response from the cURL request, including headers and body.
*/
public function parseResponse($response)
{
// Parse the response and set the last response and headers.
$info = curl_getinfo($this->ch);
$this->__last_response_headers = substr(
$response,
0,
$info['header_size']
);
$this->__last_response = substr($response, $info['header_size']);
}
}
|
