/
Client.php
383 lines (332 loc) · 11.1 KB
/
Client.php
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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
<?php
namespace Symfony\Components\BrowserKit;
use Symfony\Components\DomCrawler\Crawler;
use Symfony\Components\DomCrawler\Link;
use Symfony\Components\DomCrawler\Form;
use Symfony\Components\Process\PhpProcess;
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien.potencier@symfony-project.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
/**
* Client simulates a browser.
*
* To make the actual request, you need to implement the doRequest() method.
*
* If you want to be able to run requests in their own process (insulated flag),
* you need to also implement the getScript() method.
*
* @package Symfony
* @subpackage Components_BrowserKit
* @author Fabien Potencier <fabien.potencier@symfony-project.com>
*/
abstract class Client
{
protected $history;
protected $cookieJar;
protected $server;
protected $request;
protected $response;
protected $crawler;
protected $insulated;
protected $redirect;
protected $followRedirects;
/**
* Constructor.
*
* @param array $server The server parameters (equivalent of $_SERVER)
* @param Symfony\Components\BrowserKit\History $history A History instance to store the browser history
* @param Symfony\Components\BrowserKit\CookieJar $cookieJar A CookieJar instance to store the cookies
*/
public function __construct(array $server = array(), History $history = null, CookieJar $cookieJar = null)
{
$this->setServerParameters($server);
$this->history = null === $history ? new History() : $history;
$this->cookieJar = null === $cookieJar ? new CookieJar() : $cookieJar;
$this->insulated = false;
$this->followRedirects = true;
}
/**
* Sets whether to automatically follow redirects or not.
*
* @param Boolean $followRedirect Whether to follow redirects
*/
public function followRedirects($followRedirect = true)
{
$this->followRedirects = (Boolean) $followRedirect;
}
/**
* Sets the insulated flag.
*
* @param Boolean $insulated Whether to insulate the requests or not
*
* @throws \RuntimeException When Symfony Process Component is not installed
*/
public function insulate($insulated = true)
{
if (!class_exists('Symfony\\Components\\Process\\Process')) {
// @codeCoverageIgnoreStart
throw new \RuntimeException('Unable to isolate requests as the Symfony Process Component is not installed.');
// @codeCoverageIgnoreEnd
}
$this->insulated = (Boolean) $insulated;
}
/**
* Sets server parameters.
*
* @param array $server An array of server parameters
*/
public function setServerParameters(array $server)
{
$this->server = array_merge(array(
'HTTP_HOST' => 'localhost',
'HTTP_USER_AGENT' => 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.2.3) Gecko/20100401 Firefox/3.6.3',
), $server);
}
/**
* Returns the History instance.
*
* @return Symfony\Components\BrowserKit\History A History instance
*/
public function getHistory()
{
return $this->history;
}
/**
* Returns the CookieJar instance.
*
* @return Symfony\Components\BrowserKit\CookieJar A CookieJar instance
*/
public function getCookieJar()
{
return $this->cookieJar;
}
/**
* Returns the current Crawler instance.
*
* @return Symfony\Components\DomCrawler\Crawler A Crawler instance
*/
public function getCrawler()
{
return $this->crawler;
}
/**
* Returns the current Response instance.
*
* @return Symfony\Components\BrowserKit\Response A Response instance
*/
public function getResponse()
{
return $this->response;
}
/**
* Returns the current Request instance.
*
* @return Symfony\Components\BrowserKit\Request A Request instance
*/
public function getRequest()
{
return $this->request;
}
/**
* Clicks on a given link.
*
* @param Symfony\Components\BrowserKit\Link $link A Link instance
*/
public function click(Link $link)
{
return $this->request($link->getMethod(), $link->getUri());
}
/**
* Submits a form.
*
* @param Symfony\Components\BrowserKit\Form $form A Form instance
* @param array $values An array of form field values
*/
public function submit(Form $form, array $values = array())
{
$form->setValues($values);
return $this->request($form->getMethod(), $form->getUri(), $form->getPhpValues(), array(), $form->getPhpFiles());
}
/**
* Calls a URI.
*
* @param string $method The request method
* @param string $uri The URI to fetch
* @param array $parameters The Request parameters
* @param array $headers The headers
* @param array $files The files
* @param array $server The server parameters
* @param Boolean $changeHistory Whether to update the history or not (only used internally for back(), forward(), and reload())
*
* @return Symfony\Components\DomCrawler\Crawler
*/
public function request($method, $uri, $parameters = array(), $headers = array(), $files = array(), $server = array(), $changeHistory = true)
{
$uri = $this->getAbsoluteUri($uri);
$server = array_merge($this->server, $server);
if (!$this->history->isEmpty()) {
$server['HTTP_REFERER'] = $this->history->current()->getUri();
}
$server['HTTP_HOST'] = parse_url($uri, PHP_URL_HOST);
$server['HTTPS'] = 'https' == parse_url($uri, PHP_URL_SCHEME);
$request = new Request($uri, $method, $parameters, $files, $this->cookieJar->getValues($uri), $server);
$this->request = $this->filterRequest($request);
if (true === $changeHistory) {
$this->history->add($request);
}
if ($this->insulated) {
$this->response = $this->doRequestInProcess($this->request);
} else {
$this->response = $this->doRequest($this->request);
}
$response = $this->filterResponse($this->response);
$this->cookieJar->updateFromResponse($response);
$this->redirect = $response->getHeader('Location');
if ($this->followRedirects && $this->redirect) {
return $this->crawler = $this->followRedirect();
}
return $this->crawler = $this->createCrawlerFromContent($request->getUri(), $response->getContent(), $response->getHeader('Content-Type'));
}
/**
* Makes a request in another process.
*
* @param Request $request A Request instance
*
* @return Response A Response instance
*
* @throws \RuntimeException When processing returns exit code
*/
protected function doRequestInProcess($request)
{
$process = new PhpProcess($this->getScript($request));
$process->run();
if ($process->getExitCode() > 0) {
throw new \RuntimeException($process->getErrorOutput());
}
return unserialize($process->getOutput());
}
/**
* Makes a request.
*
* @param Request $request A Request instance
*
* @return Response A Response instance
*/
abstract protected function doRequest($request);
/**
* Returns the script to execute when the request must be insulated.
*
* @param Request $request A Request instance
*
* @throws \LogicException When this abstract class is not implemented
*/
protected function getScript($request)
{
// @codeCoverageIgnoreStart
throw new \LogicException('To insulate requests, you need to override the getScript() method.');
// @codeCoverageIgnoreEnd
}
protected function filterRequest(Request $request)
{
return $request;
}
protected function filterResponse($response)
{
return $response;
}
protected function createCrawlerFromContent($uri, $content, $type)
{
$crawler = new Crawler(null, $uri);
$crawler->addContent($content, $type);
return $crawler;
}
/**
* Goes back in the browser history.
*/
public function back()
{
return $this->requestFromRequest($this->history->back(), false);
}
/**
* Goes forward in the browser history.
*/
public function forward()
{
return $this->requestFromRequest($this->history->forward(), false);
}
/**
* Reloads the current browser.
*/
public function reload()
{
return $this->requestFromRequest($this->history->current(), false);
}
/**
* Follow redirects?
*
* @return Symfony\Components\BrowserKit\Client
*
* @throws \LogicException If request was not a redirect
*/
public function followRedirect()
{
if (empty($this->redirect)) {
throw new \LogicException('The request was not redirected.');
}
return $this->request('get', $this->redirect);
}
/**
* Restarts the client.
*
* It flushes all cookies.
*/
public function restart()
{
$this->cookieJar->clear();
$this->history->clear();
}
protected function getAbsoluteUri($uri)
{
// already absolute?
if ('http' === substr($uri, 0, 4)) {
return $uri;
}
if (!$this->history->isEmpty()) {
$currentUri = $this->history->current()->getUri();
} else {
$currentUri = sprintf('http%s://%s/',
isset($this->server['HTTPS']) ? 's' : '',
isset($this->server['HTTP_HOST']) ? $this->server['HTTP_HOST'] : 'localhost'
);
}
// anchor?
if (!$uri || '#' == $uri[0]) {
return preg_replace('/#.*?$/', '', $currentUri).$uri;
}
if ('/' !== $uri[0]) {
$path = parse_url($currentUri, PHP_URL_PATH);
if ('/' !== substr($path, -1)) {
$path = substr($path, 0, strrpos($path, '/') + 1);
}
$uri = $path.$uri;
}
return preg_replace('#^(.*?//[^/]+)\/.*$#', '$1', $currentUri).$uri;
}
/**
* Makes a request from a Request object directly.
*
* @param Symfony\Components\BrowserKit\Request $request A Request instance
* @param Boolean $changeHistory Whether to update the history or not (only used internally for back(), forward(), and reload())
*
* @return Symfony\Components\DomCrawler\Crawler
*/
protected function requestFromRequest(Request $request, $changeHistory = true)
{
return $this->request($request->getMethod(), $request->getUri(), $request->getParameters(), $request->getFiles(), array(), $request->getServer(), $changeHistory);
}
}