Chris@0: Chris@0: * Chris@0: * For the full copyright and license information, please view the LICENSE Chris@0: * file that was distributed with this source code. Chris@0: */ Chris@0: Chris@0: namespace Symfony\Component\BrowserKit; Chris@0: Chris@0: use Symfony\Component\DomCrawler\Crawler; Chris@17: use Symfony\Component\DomCrawler\Form; Chris@0: use Symfony\Component\DomCrawler\Link; Chris@0: use Symfony\Component\Process\PhpProcess; Chris@0: Chris@0: /** Chris@0: * Client simulates a browser. Chris@0: * Chris@0: * To make the actual request, you need to implement the doRequest() method. Chris@0: * Chris@0: * If you want to be able to run requests in their own process (insulated flag), Chris@0: * you need to also implement the getScript() method. Chris@0: * Chris@0: * @author Fabien Potencier Chris@0: */ Chris@0: abstract class Client Chris@0: { Chris@0: protected $history; Chris@0: protected $cookieJar; Chris@17: protected $server = []; Chris@0: protected $internalRequest; Chris@0: protected $request; Chris@0: protected $internalResponse; Chris@0: protected $response; Chris@0: protected $crawler; Chris@0: protected $insulated = false; Chris@0: protected $redirect; Chris@0: protected $followRedirects = true; Chris@0: Chris@0: private $maxRedirects = -1; Chris@0: private $redirectCount = 0; Chris@17: private $redirects = []; Chris@0: private $isMainRequest = true; Chris@0: Chris@0: /** Chris@0: * @param array $server The server parameters (equivalent of $_SERVER) Chris@0: * @param History $history A History instance to store the browser history Chris@0: * @param CookieJar $cookieJar A CookieJar instance to store the cookies Chris@0: */ Chris@17: public function __construct(array $server = [], History $history = null, CookieJar $cookieJar = null) Chris@0: { Chris@0: $this->setServerParameters($server); Chris@0: $this->history = $history ?: new History(); Chris@0: $this->cookieJar = $cookieJar ?: new CookieJar(); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Sets whether to automatically follow redirects or not. Chris@0: * Chris@0: * @param bool $followRedirect Whether to follow redirects Chris@0: */ Chris@0: public function followRedirects($followRedirect = true) Chris@0: { Chris@0: $this->followRedirects = (bool) $followRedirect; Chris@0: } Chris@0: Chris@0: /** Chris@0: * Returns whether client automatically follows redirects or not. Chris@0: * Chris@0: * @return bool Chris@0: */ Chris@0: public function isFollowingRedirects() Chris@0: { Chris@0: return $this->followRedirects; Chris@0: } Chris@0: Chris@0: /** Chris@13: * Sets the maximum number of redirects that crawler can follow. Chris@0: * Chris@0: * @param int $maxRedirects Chris@0: */ Chris@0: public function setMaxRedirects($maxRedirects) Chris@0: { Chris@0: $this->maxRedirects = $maxRedirects < 0 ? -1 : $maxRedirects; Chris@0: $this->followRedirects = -1 != $this->maxRedirects; Chris@0: } Chris@0: Chris@0: /** Chris@13: * Returns the maximum number of redirects that crawler can follow. Chris@0: * Chris@0: * @return int Chris@0: */ Chris@0: public function getMaxRedirects() Chris@0: { Chris@0: return $this->maxRedirects; Chris@0: } Chris@0: Chris@0: /** Chris@0: * Sets the insulated flag. Chris@0: * Chris@0: * @param bool $insulated Whether to insulate the requests or not Chris@0: * Chris@0: * @throws \RuntimeException When Symfony Process Component is not installed Chris@0: */ Chris@0: public function insulate($insulated = true) Chris@0: { Chris@0: if ($insulated && !class_exists('Symfony\\Component\\Process\\Process')) { Chris@0: throw new \RuntimeException('Unable to isolate requests as the Symfony Process Component is not installed.'); Chris@0: } Chris@0: Chris@0: $this->insulated = (bool) $insulated; Chris@0: } Chris@0: Chris@0: /** Chris@0: * Sets server parameters. Chris@0: * Chris@0: * @param array $server An array of server parameters Chris@0: */ Chris@0: public function setServerParameters(array $server) Chris@0: { Chris@17: $this->server = array_merge([ Chris@0: 'HTTP_USER_AGENT' => 'Symfony BrowserKit', Chris@17: ], $server); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Sets single server parameter. Chris@0: * Chris@0: * @param string $key A key of the parameter Chris@0: * @param string $value A value of the parameter Chris@0: */ Chris@0: public function setServerParameter($key, $value) Chris@0: { Chris@0: $this->server[$key] = $value; Chris@0: } Chris@0: Chris@0: /** Chris@0: * Gets single server parameter for specified key. Chris@0: * Chris@0: * @param string $key A key of the parameter to get Chris@0: * @param string $default A default value when key is undefined Chris@0: * Chris@0: * @return string A value of the parameter Chris@0: */ Chris@0: public function getServerParameter($key, $default = '') Chris@0: { Chris@0: return isset($this->server[$key]) ? $this->server[$key] : $default; Chris@0: } Chris@0: Chris@0: /** Chris@0: * Returns the History instance. Chris@0: * Chris@0: * @return History A History instance Chris@0: */ Chris@0: public function getHistory() Chris@0: { Chris@0: return $this->history; Chris@0: } Chris@0: Chris@0: /** Chris@0: * Returns the CookieJar instance. Chris@0: * Chris@0: * @return CookieJar A CookieJar instance Chris@0: */ Chris@0: public function getCookieJar() Chris@0: { Chris@0: return $this->cookieJar; Chris@0: } Chris@0: Chris@0: /** Chris@0: * Returns the current Crawler instance. Chris@0: * Chris@0: * @return Crawler|null A Crawler instance Chris@0: */ Chris@0: public function getCrawler() Chris@0: { Chris@0: return $this->crawler; Chris@0: } Chris@0: Chris@0: /** Chris@0: * Returns the current BrowserKit Response instance. Chris@0: * Chris@0: * @return Response|null A BrowserKit Response instance Chris@0: */ Chris@0: public function getInternalResponse() Chris@0: { Chris@0: return $this->internalResponse; Chris@0: } Chris@0: Chris@0: /** Chris@0: * Returns the current origin response instance. Chris@0: * Chris@0: * The origin response is the response instance that is returned Chris@0: * by the code that handles requests. Chris@0: * Chris@0: * @return object|null A response instance Chris@0: * Chris@0: * @see doRequest() Chris@0: */ Chris@0: public function getResponse() Chris@0: { Chris@0: return $this->response; Chris@0: } Chris@0: Chris@0: /** Chris@0: * Returns the current BrowserKit Request instance. Chris@0: * Chris@0: * @return Request|null A BrowserKit Request instance Chris@0: */ Chris@0: public function getInternalRequest() Chris@0: { Chris@0: return $this->internalRequest; Chris@0: } Chris@0: Chris@0: /** Chris@0: * Returns the current origin Request instance. Chris@0: * Chris@0: * The origin request is the request instance that is sent Chris@0: * to the code that handles requests. Chris@0: * Chris@0: * @return object|null A Request instance Chris@0: * Chris@0: * @see doRequest() Chris@0: */ Chris@0: public function getRequest() Chris@0: { Chris@0: return $this->request; Chris@0: } Chris@0: Chris@0: /** Chris@0: * Clicks on a given link. Chris@0: * Chris@0: * @return Crawler Chris@0: */ Chris@0: public function click(Link $link) Chris@0: { Chris@0: if ($link instanceof Form) { Chris@0: return $this->submit($link); Chris@0: } Chris@0: Chris@0: return $this->request($link->getMethod(), $link->getUri()); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Submits a form. Chris@0: * Chris@0: * @param Form $form A Form instance Chris@0: * @param array $values An array of form field values Chris@0: * Chris@0: * @return Crawler Chris@0: */ Chris@17: public function submit(Form $form, array $values = []) Chris@0: { Chris@0: $form->setValues($values); Chris@0: Chris@0: return $this->request($form->getMethod(), $form->getUri(), $form->getPhpValues(), $form->getPhpFiles()); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Calls a URI. Chris@0: * Chris@0: * @param string $method The request method Chris@0: * @param string $uri The URI to fetch Chris@0: * @param array $parameters The Request parameters Chris@0: * @param array $files The files Chris@0: * @param array $server The server parameters (HTTP headers are referenced with a HTTP_ prefix as PHP does) Chris@0: * @param string $content The raw body data Chris@0: * @param bool $changeHistory Whether to update the history or not (only used internally for back(), forward(), and reload()) Chris@0: * Chris@0: * @return Crawler Chris@0: */ Chris@17: public function request($method, $uri, array $parameters = [], array $files = [], array $server = [], $content = null, $changeHistory = true) Chris@0: { Chris@0: if ($this->isMainRequest) { Chris@0: $this->redirectCount = 0; Chris@0: } else { Chris@0: ++$this->redirectCount; Chris@0: } Chris@0: Chris@17: $originalUri = $uri; Chris@17: Chris@0: $uri = $this->getAbsoluteUri($uri); Chris@0: Chris@0: $server = array_merge($this->server, $server); Chris@0: Chris@17: if (!empty($server['HTTP_HOST']) && null === parse_url($originalUri, PHP_URL_HOST)) { Chris@17: $uri = preg_replace('{^(https?\://)'.preg_quote($this->extractHost($uri)).'}', '${1}'.$server['HTTP_HOST'], $uri); Chris@17: } Chris@17: Chris@17: if (isset($server['HTTPS']) && null === parse_url($originalUri, PHP_URL_SCHEME)) { Chris@0: $uri = preg_replace('{^'.parse_url($uri, PHP_URL_SCHEME).'}', $server['HTTPS'] ? 'https' : 'http', $uri); Chris@0: } Chris@0: Chris@0: if (!$this->history->isEmpty()) { Chris@0: $server['HTTP_REFERER'] = $this->history->current()->getUri(); Chris@0: } Chris@0: Chris@0: if (empty($server['HTTP_HOST'])) { Chris@0: $server['HTTP_HOST'] = $this->extractHost($uri); Chris@0: } Chris@0: Chris@0: $server['HTTPS'] = 'https' == parse_url($uri, PHP_URL_SCHEME); Chris@0: Chris@0: $this->internalRequest = new Request($uri, $method, $parameters, $files, $this->cookieJar->allValues($uri), $server, $content); Chris@0: Chris@0: $this->request = $this->filterRequest($this->internalRequest); Chris@0: Chris@0: if (true === $changeHistory) { Chris@0: $this->history->add($this->internalRequest); Chris@0: } Chris@0: Chris@0: if ($this->insulated) { Chris@0: $this->response = $this->doRequestInProcess($this->request); Chris@0: } else { Chris@0: $this->response = $this->doRequest($this->request); Chris@0: } Chris@0: Chris@0: $this->internalResponse = $this->filterResponse($this->response); Chris@0: Chris@0: $this->cookieJar->updateFromResponse($this->internalResponse, $uri); Chris@0: Chris@0: $status = $this->internalResponse->getStatus(); Chris@0: Chris@0: if ($status >= 300 && $status < 400) { Chris@0: $this->redirect = $this->internalResponse->getHeader('Location'); Chris@0: } else { Chris@0: $this->redirect = null; Chris@0: } Chris@0: Chris@0: if ($this->followRedirects && $this->redirect) { Chris@12: $this->redirects[serialize($this->history->current())] = true; Chris@12: Chris@0: return $this->crawler = $this->followRedirect(); Chris@0: } Chris@0: Chris@0: return $this->crawler = $this->createCrawlerFromContent($this->internalRequest->getUri(), $this->internalResponse->getContent(), $this->internalResponse->getHeader('Content-Type')); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Makes a request in another process. Chris@0: * Chris@0: * @param object $request An origin request instance Chris@0: * Chris@0: * @return object An origin response instance Chris@0: * Chris@0: * @throws \RuntimeException When processing returns exit code Chris@0: */ Chris@0: protected function doRequestInProcess($request) Chris@0: { Chris@12: $deprecationsFile = tempnam(sys_get_temp_dir(), 'deprec'); Chris@12: putenv('SYMFONY_DEPRECATIONS_SERIALIZE='.$deprecationsFile); Chris@12: $_ENV['SYMFONY_DEPRECATIONS_SERIALIZE'] = $deprecationsFile; Chris@0: $process = new PhpProcess($this->getScript($request), null, null); Chris@0: $process->run(); Chris@0: Chris@12: if (file_exists($deprecationsFile)) { Chris@12: $deprecations = file_get_contents($deprecationsFile); Chris@12: unlink($deprecationsFile); Chris@17: foreach ($deprecations ? unserialize($deprecations) : [] as $deprecation) { Chris@12: if ($deprecation[0]) { Chris@17: @trigger_error($deprecation[1], E_USER_DEPRECATED); Chris@12: } else { Chris@12: @trigger_error($deprecation[1], E_USER_DEPRECATED); Chris@12: } Chris@12: } Chris@12: } Chris@12: Chris@0: if (!$process->isSuccessful() || !preg_match('/^O\:\d+\:/', $process->getOutput())) { Chris@0: throw new \RuntimeException(sprintf('OUTPUT: %s ERROR OUTPUT: %s', $process->getOutput(), $process->getErrorOutput())); Chris@0: } Chris@0: Chris@0: return unserialize($process->getOutput()); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Makes a request. Chris@0: * Chris@0: * @param object $request An origin request instance Chris@0: * Chris@0: * @return object An origin response instance Chris@0: */ Chris@0: abstract protected function doRequest($request); Chris@0: Chris@0: /** Chris@0: * Returns the script to execute when the request must be insulated. Chris@0: * Chris@0: * @param object $request An origin request instance Chris@0: * Chris@0: * @throws \LogicException When this abstract class is not implemented Chris@0: */ Chris@0: protected function getScript($request) Chris@0: { Chris@0: throw new \LogicException('To insulate requests, you need to override the getScript() method.'); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Filters the BrowserKit request to the origin one. Chris@0: * Chris@0: * @param Request $request The BrowserKit Request to filter Chris@0: * Chris@0: * @return object An origin request instance Chris@0: */ Chris@0: protected function filterRequest(Request $request) Chris@0: { Chris@0: return $request; Chris@0: } Chris@0: Chris@0: /** Chris@0: * Filters the origin response to the BrowserKit one. Chris@0: * Chris@0: * @param object $response The origin response to filter Chris@0: * Chris@0: * @return Response An BrowserKit Response instance Chris@0: */ Chris@0: protected function filterResponse($response) Chris@0: { Chris@0: return $response; Chris@0: } Chris@0: Chris@0: /** Chris@0: * Creates a crawler. Chris@0: * Chris@0: * This method returns null if the DomCrawler component is not available. Chris@0: * Chris@0: * @param string $uri A URI Chris@0: * @param string $content Content for the crawler to use Chris@0: * @param string $type Content type Chris@0: * Chris@0: * @return Crawler|null Chris@0: */ Chris@0: protected function createCrawlerFromContent($uri, $content, $type) Chris@0: { Chris@0: if (!class_exists('Symfony\Component\DomCrawler\Crawler')) { Chris@0: return; Chris@0: } Chris@0: Chris@0: $crawler = new Crawler(null, $uri); Chris@0: $crawler->addContent($content, $type); Chris@0: Chris@0: return $crawler; Chris@0: } Chris@0: Chris@0: /** Chris@0: * Goes back in the browser history. Chris@0: * Chris@0: * @return Crawler Chris@0: */ Chris@0: public function back() Chris@0: { Chris@12: do { Chris@12: $request = $this->history->back(); Chris@18: } while (\array_key_exists(serialize($request), $this->redirects)); Chris@12: Chris@12: return $this->requestFromRequest($request, false); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Goes forward in the browser history. Chris@0: * Chris@0: * @return Crawler Chris@0: */ Chris@0: public function forward() Chris@0: { Chris@12: do { Chris@12: $request = $this->history->forward(); Chris@18: } while (\array_key_exists(serialize($request), $this->redirects)); Chris@12: Chris@12: return $this->requestFromRequest($request, false); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Reloads the current browser. Chris@0: * Chris@0: * @return Crawler Chris@0: */ Chris@0: public function reload() Chris@0: { Chris@0: return $this->requestFromRequest($this->history->current(), false); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Follow redirects? Chris@0: * Chris@0: * @return Crawler Chris@0: * Chris@0: * @throws \LogicException If request was not a redirect Chris@0: */ Chris@0: public function followRedirect() Chris@0: { Chris@0: if (empty($this->redirect)) { Chris@0: throw new \LogicException('The request was not redirected.'); Chris@0: } Chris@0: Chris@0: if (-1 !== $this->maxRedirects) { Chris@0: if ($this->redirectCount > $this->maxRedirects) { Chris@12: $this->redirectCount = 0; Chris@0: throw new \LogicException(sprintf('The maximum number (%d) of redirections was reached.', $this->maxRedirects)); Chris@0: } Chris@0: } Chris@0: Chris@0: $request = $this->internalRequest; Chris@0: Chris@17: if (\in_array($this->internalResponse->getStatus(), [301, 302, 303])) { Chris@0: $method = 'GET'; Chris@17: $files = []; Chris@0: $content = null; Chris@0: } else { Chris@0: $method = $request->getMethod(); Chris@0: $files = $request->getFiles(); Chris@0: $content = $request->getContent(); Chris@0: } Chris@0: Chris@0: if ('GET' === strtoupper($method)) { Chris@0: // Don't forward parameters for GET request as it should reach the redirection URI Chris@17: $parameters = []; Chris@0: } else { Chris@0: $parameters = $request->getParameters(); Chris@0: } Chris@0: Chris@0: $server = $request->getServer(); Chris@0: $server = $this->updateServerFromUri($server, $this->redirect); Chris@0: Chris@0: $this->isMainRequest = false; Chris@0: Chris@0: $response = $this->request($method, $this->redirect, $parameters, $files, $server, $content); Chris@0: Chris@0: $this->isMainRequest = true; Chris@0: Chris@0: return $response; Chris@0: } Chris@0: Chris@0: /** Chris@0: * Restarts the client. Chris@0: * Chris@0: * It flushes history and all cookies. Chris@0: */ Chris@0: public function restart() Chris@0: { Chris@0: $this->cookieJar->clear(); Chris@0: $this->history->clear(); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Takes a URI and converts it to absolute if it is not already absolute. Chris@0: * Chris@0: * @param string $uri A URI Chris@0: * Chris@0: * @return string An absolute URI Chris@0: */ Chris@0: protected function getAbsoluteUri($uri) Chris@0: { Chris@0: // already absolute? Chris@0: if (0 === strpos($uri, 'http://') || 0 === strpos($uri, 'https://')) { Chris@0: return $uri; Chris@0: } Chris@0: Chris@0: if (!$this->history->isEmpty()) { Chris@0: $currentUri = $this->history->current()->getUri(); Chris@0: } else { Chris@0: $currentUri = sprintf('http%s://%s/', Chris@0: isset($this->server['HTTPS']) ? 's' : '', Chris@0: isset($this->server['HTTP_HOST']) ? $this->server['HTTP_HOST'] : 'localhost' Chris@0: ); Chris@0: } Chris@0: Chris@0: // protocol relative URL Chris@0: if (0 === strpos($uri, '//')) { Chris@0: return parse_url($currentUri, PHP_URL_SCHEME).':'.$uri; Chris@0: } Chris@0: Chris@0: // anchor or query string parameters? Chris@0: if (!$uri || '#' == $uri[0] || '?' == $uri[0]) { Chris@0: return preg_replace('/[#?].*?$/', '', $currentUri).$uri; Chris@0: } Chris@0: Chris@0: if ('/' !== $uri[0]) { Chris@0: $path = parse_url($currentUri, PHP_URL_PATH); Chris@0: Chris@0: if ('/' !== substr($path, -1)) { Chris@0: $path = substr($path, 0, strrpos($path, '/') + 1); Chris@0: } Chris@0: Chris@0: $uri = $path.$uri; Chris@0: } Chris@0: Chris@0: return preg_replace('#^(.*?//[^/]+)\/.*$#', '$1', $currentUri).$uri; Chris@0: } Chris@0: Chris@0: /** Chris@0: * Makes a request from a Request object directly. Chris@0: * Chris@0: * @param Request $request A Request instance Chris@0: * @param bool $changeHistory Whether to update the history or not (only used internally for back(), forward(), and reload()) Chris@0: * Chris@0: * @return Crawler Chris@0: */ Chris@0: protected function requestFromRequest(Request $request, $changeHistory = true) Chris@0: { Chris@0: return $this->request($request->getMethod(), $request->getUri(), $request->getParameters(), $request->getFiles(), $request->getServer(), $request->getContent(), $changeHistory); Chris@0: } Chris@0: Chris@0: private function updateServerFromUri($server, $uri) Chris@0: { Chris@0: $server['HTTP_HOST'] = $this->extractHost($uri); Chris@0: $scheme = parse_url($uri, PHP_URL_SCHEME); Chris@0: $server['HTTPS'] = null === $scheme ? $server['HTTPS'] : 'https' == $scheme; Chris@0: unset($server['HTTP_IF_NONE_MATCH'], $server['HTTP_IF_MODIFIED_SINCE']); Chris@0: Chris@0: return $server; Chris@0: } Chris@0: Chris@0: private function extractHost($uri) Chris@0: { Chris@0: $host = parse_url($uri, PHP_URL_HOST); Chris@0: Chris@0: if ($port = parse_url($uri, PHP_URL_PORT)) { Chris@0: return $host.':'.$port; Chris@0: } Chris@0: Chris@0: return $host; Chris@0: } Chris@0: }