serp-spider/http-client-phantomjs

<?php
/**
 * @license see LICENSE
 */

namespace Serps\HttpClient;

use Psr\Http\Message\RequestInterface;
use Serps\Core\Cookie\CookieJarInterface;
use Serps\Core\Http\HttpClientInterface;
use Serps\Core\Http\ProxyInterface;
use Serps\Core\Http\SearchEngineResponse;
use Serps\Core\UrlArchive;
use Serps\Exception;
use Symfony\Component\Process\Exception\ProcessFailedException;
use Symfony\Component\Process\Process;

class PhantomJsClient implements HttpClientInterface
{

    protected $phantomJS;
    protected $phantomJsOptions = [];
    protected $customHeaders = [];

    public function __construct($phantomJsBinary = 'phantomjs')
    {
        $this->phantomJS = $phantomJsBinary;
    }

    /**
     * Set options for phantomjs command line
     *
     * example: ``$client->setPhantomJsOption('--ignore-ssl-errors=true');``
     *
     * @param string $option option to pass to the phantomjs command line
     */
    public function setPhantomJsOption($option)
    {
        $this->phantomJsOptions[] = $option;
    }

    public function getPhantomJsOptions()
    {
        return $this->phantomJsOptions;
    }

    /**
     * Set a custom HTTP request header for PhantomJS.
     *
     * example: ``$client->setPhantomJsHeader('Referer', 'referer_url');``
     *
     * @param string $key
     *    Header name.
     * @param string $value
     *    Header value.
     */
    public function setCustomHeader($key, $value)
    {
        $this->customHeaders[$key] = $value;
    }

    /**
     * Get custom HTTP request headers for PhantomJS.
     *
     * @return array
     *    Returns an associative array of the message's headers. Each key is
     *    a header name, and each value is a header value.
     */
    public function getCustomHeaders()
    {
        return $this->customHeaders;
    }

    public function sendRequest(
        RequestInterface $request,
        ProxyInterface $proxy = null,
        CookieJarInterface $cookieJar = null
    ) {

        $commandOptions = $this->phantomJsOptions;
        if ($proxy) {
            $proxyHost = $proxy->getHost() . ':' . $proxy->getPort();
            $commandOptions[]= '--proxy=' . $proxyHost;

            if ($user = $proxy->getUser()) {
                $proxyAuth = $user;
                if ($password = $proxy->getPassword()) {
                    $proxyAuth .= ':' . $password;
                }
                $commandOptions[]= '--proxy-auth=' . $proxyAuth;
            }

            if ($proxy->getType() == 'SOCKS5') {
                $commandOptions[]= '--proxy-type=socks5';
            } elseif ($proxy->getType() == 'SOCKS4') {
                throw new Exception('SOCKS4 proxy are not supported by phantomjs');
            }
        }

        $initialUrl = (string)$request->getUri();

        $commandArg = [
            'method'        => $request->getMethod(),
            'url'           => $initialUrl,
            'headers'       => [],
            // Additional HTTP request headers for PhantomJS.
            // @see http://phantomjs.org/api/webpage/property/custom-headers.html
            'customHeaders' => $this->customHeaders,
        ];

        foreach ($request->getHeaders() as $headerName => $headerValues) {
            $commandArg['headers'][$headerName] = implode(',', $headerValues);
        }

        $data = (string)$request->getBody();
        if ($data) {
            $commandArg['data'] = $data;
        }

        $scriptFile = __DIR__ . '/phantomjs.js';
        $commandOptions = implode(' ', $commandOptions);
        $commandArg = json_encode($commandArg);

        $process = new Process("$this->phantomJS $commandOptions $scriptFile '$commandArg'");
        $process->run();
        if (!$process->isSuccessful()) {
            throw new ProcessFailedException($process);
        }

        $dataResponse = json_decode($process->getOutput(), true);
        if (!$dataResponse) {
            throw new Exception('Unable to parse Phantomjs response: ' . json_last_error_msg());
        }

        $response = new SearchEngineResponse(
            $dataResponse['headers'],
            $dataResponse['status'],
            $dataResponse['content'],
            true,
            UrlArchive::fromString($initialUrl),
            UrlArchive::fromString($dataResponse['url']),
            $proxy
        );

        return $response;
    }
}