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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
<?php
/**
* Copyright 2007-2014 Horde LLC (http://www.horde.org/)
*
* @author Chuck Hagenbuch <chuck@horde.org>
* @license http://www.horde.org/licenses/bsd BSD
* @category Horde
* @package Http
*/
/**
* An HTTP client.
*
* @author Chuck Hagenbuch <chuck@horde.org>
* @license http://www.horde.org/licenses/bsd BSD
* @category Horde
* @package Http
*/
class Horde_Http_Client
{
/**
* The current HTTP request.
*
* @var Horde_Http_Request_Base
*/
protected $_request;
/**
* The previous HTTP request.
*
* @var Horde_Http_Request_Base
*/
protected $_lastRequest;
/**
* The most recent HTTP response.
*
* @var Horde_Http_Response_Base
*/
protected $_lastResponse;
/**
* Use POST instead of PUT and DELETE, sending X-HTTP-Method-Override with
* the intended method name instead.
*
* @var boolean
*/
protected $_httpMethodOverride = false;
/**
* Horde_Http_Client constructor.
*
* @param array $args Any Http_Client settings to initialize in the
* constructor. Available settings are:
* - client.httpMethodOverride: (boolean) @see
* $_httpMethodOverride
* - request: (array) See below for possible hash keys.
* - request.uri (string) Default URI if not specified
* for individual requests.
* - request.headers: (array) Hash with additional
* request headers.
* - request.method: (string) Default request method if
* not specified for individual requests.
* - request.data: (array|string) POST data fields or
* POST/PUT data body.
* - request.username: (string) Authentication user name.
* - request.password: (string) Authentication password.
* - request.authenticationScheme: (string)
* Authentication method, one of the
* Horde_Http::AUTH_* constants.
* - request.proxyServer: (string) Host name of a proxy
* server.
* - request.proxyPort: (integer) Port number of a proxy
* server.
* - request.proxyType: (integer) Proxy server type, one
* of the Horde_Http::PROXY_* constants.
* - request.proxyUsername: (string) Proxy authentication
* user name.
* - request.proxyPassword: (string) Proxy authentication
* password.
* - request.proxyAuthenticationScheme: (string) Proxy
* authentication method, one of the
* Horde_Http::AUTH_* constants.
* - request.redirects: (integer) Maximum number of
* redirects to follow.
* - request.timeout: (integer) Timeout in seconds.
* - request.verifyPeer: (boolean) Verify SSL peer
* certificates?
*/
public function __construct($args = array())
{
// Set or create request object
if (isset($args['request'])) {
$this->_request = $args['request'];
unset($args['request']);
} else {
$requestFactory = new Horde_Http_Request_Factory();
$this->_request = $requestFactory->create();
}
foreach ($args as $key => $val) {
$this->$key = $val;
}
}
/**
* Sends a GET request.
*
* @param string $uri Request URI.
* @param array $headers Additional request headers.
*
* @throws Horde_Http_Exception
* @return Horde_Http_Response_Base
*/
public function get($uri = null, $headers = array())
{
return $this->request('GET', $uri, null, $headers);
}
/**
* Sends a POST request.
*
* @param string $uri Request URI.
* @param array|string $data Data fields or data body.
* @param array $headers Additional request headers.
*
* @throws Horde_Http_Exception
* @return Horde_Http_Response_Base
*/
public function post($uri = null, $data = null, $headers = array())
{
return $this->request('POST', $uri, $data, $headers);
}
/**
* Sends a PUT request.
*
* @param string $uri Request URI.
* @param string $data Data body.
* @param array $headers Additional request headers.
*
* @throws Horde_Http_Exception
* @return Horde_Http_Response_Base
*/
public function put($uri = null, $data = null, $headers = array())
{
if ($this->_httpMethodOverride) {
$headers = array_merge(array('X-HTTP-Method-Override' => 'PUT'), $headers);
return $this->post($uri, $data, $headers);
}
return $this->request('PUT', $uri, $data, $headers);
}
/**
* Sends a DELETE request.
*
* @param string $uri Request URI.
* @param array $headers Additional request headers.
*
* @throws Horde_Http_Exception
* @return Horde_Http_Response_Base
*/
public function delete($uri = null, $headers = array())
{
if ($this->_httpMethodOverride) {
$headers = array_merge(array('X-HTTP-Method-Override' => 'DELETE'), $headers);
return $this->post($uri, null, $headers);
}
return $this->request('DELETE', $uri, null, $headers);
}
/**
* Sends a HEAD request.
*
* @param string $uri Request URI.
* @param array $headers Additional request headers.
*
* @throws Horde_Http_Exception
* @return Horde_Http_Response_Base
*/
public function head($uri = null, $headers = array())
{
return $this->request('HEAD', $uri, null, $headers);
}
/**
* Sends an HTTP request.
*
* @param string $method HTTP request method (GET, PUT, etc.)
* @param string $uri URI to request, if different from $this->uri
* @param mixed $data Request data. Can be an array of form data that
* will be encoded automatically, or a raw string.
* @param array $headers Any headers specific to this request. They will
* be combined with $this->_headers, and override
* headers of the same name for this request only.
*
* @throws Horde_Http_Exception
* @return Horde_Http_Response_Base
*/
public function request($method, $uri = null, $data = null, $headers = array())
{
if ($method !== null) {
$this->request->method = $method;
}
if ($uri !== null) {
$this->request->uri = $uri;
}
if ($data !== null) {
$this->request->data = $data;
}
if (count($headers)) {
$this->request->setHeaders($headers);
}
$this->_lastRequest = $this->_request;
$this->_lastResponse = $this->_request->send();
return $this->_lastResponse;
}
/**
* Returns a client parameter.
*
* @param string $name The parameter to return.
*
* @return mixed The parameter value.
*/
public function __get($name)
{
return isset($this->{'_' . $name}) ? $this->{'_' . $name} : null;
}
/**
* Sets a client parameter.
*
* @param string $name The parameter to set.
* @param mixed $value The parameter value.
*/
public function __set($name, $value)
{
if ((strpos($name, '.') === false)) {
if (isset($this->{'_' . $name})) {
$this->{'_' . $name} = $value;
return true;
} else {
throw new Horde_Http_Exception('unknown parameter: "' . $name . '"');
}
}
list($object, $objectkey) = explode('.', $name, 2);
if ($object == 'request') {
$this->$object->$objectkey = $value;
return true;
} elseif ($object == 'client') {
$objectKey = '_' . $objectKey;
$this->$objectKey = $value;
return true;
}
throw new Horde_Http_Exception('unknown parameter: "' . $name . '"');
}
}
|
