chillerlan / php-curl

src/Request.php

<?php
/**
 * Class Request
 *
 * @filesource   Request.php
 * @created      13.02.2016
 * @package      chillerlan\TinyCurl
 * @author       Smiley <smiley@chillerlan.net>
 * @copyright    2016 Smiley
 * @license      MIT
 */

namespace chillerlan\TinyCurl;

use chillerlan\Traits\ContainerInterface;

/**
 *
 */
class Request{

	/**
	 * The cURL connection
	 *
	 * @var resource
	 */
	protected $curl;

	/**
	 * @var \chillerlan\TinyCurl\RequestOptions
	 */
	protected $options;

	/**
	 * Request constructor.
	 *
	 * @param \chillerlan\Traits\ContainerInterface $options
	 */
	public function __construct(ContainerInterface $options = null){
		$this->setOptions($options ?: new RequestOptions);
	}

	/**
	 * @param \chillerlan\Traits\ContainerInterface $options
	 *
	 * @return \chillerlan\TinyCurl\Request
	 */
	public function setOptions(ContainerInterface $options):Request {
		$this->options = $options;

$options is of type object<chillerlan\Traits\ContainerInterface>, but the property $options was declared to be of type object<chillerlan\TinyCurl\RequestOptions>. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

		return $this;
	}

	/**
	 * @return \chillerlan\Traits\ContainerInterface
	 */
	public function getOptions():ContainerInterface{
		return $this->options;
	}

	/**
	 * @param string $url
	 *
	 * @return \chillerlan\TinyCurl\ResponseInterface
	 */
	protected function getResponse(string $url):ResponseInterface {
		curl_setopt($this->curl, CURLOPT_URL, $url);

		return new Response($this->curl);
	}

	/**
	 * @return void
	 */
	protected function initCurl(){
		$this->curl = curl_init();

		curl_setopt_array($this->curl, [
			CURLOPT_HEADER         => false,
			CURLOPT_RETURNTRANSFER => true,
			CURLOPT_USERAGENT      => $this->options->user_agent,
			CURLOPT_PROTOCOLS      => CURLPROTO_HTTP|CURLPROTO_HTTPS,
			CURLOPT_SSL_VERIFYPEER => true,
			CURLOPT_SSL_VERIFYHOST => 2, // Support for value 1 removed in cURL 7.28.1
			CURLOPT_CAINFO         => is_file($this->options->ca_info) ? $this->options->ca_info : null,
			CURLOPT_TIMEOUT        => $this->options->timeout,
		]);

		curl_setopt_array($this->curl, $this->options->curl_options ?? []);
	}

	/**
	 * @param \chillerlan\TinyCurl\URL $url
	 * @param array|null               $curl_options
	 *
	 * @return \chillerlan\TinyCurl\ResponseInterface
	 */
	public function fetch(URL $url, array $curl_options = []):ResponseInterface {
		$this->initCurl();

		$method  = strtoupper($url->method);
		$headers = $this->normalizeHeaders($url->headers);

		if(in_array($method, ['PATCH', 'POST', 'PUT', 'DELETE'])){

			$curl_options += in_array($method, ['PATCH', 'PUT', 'DELETE'])
				? [CURLOPT_CUSTOMREQUEST => $method]
				: [CURLOPT_POST => true];

			$body = $url->body;

			if(!isset($headers['Content-type']) && $method === 'POST' && is_array($body)){
				$headers += ['Content-type: application/x-www-form-urlencoded'];
				$body = http_build_query($body, '', '&', PHP_QUERY_RFC1738);
			}

			$curl_options += [CURLOPT_POSTFIELDS => $body];
		}
		else{
			$curl_options += [CURLOPT_CUSTOMREQUEST => $method];
		}

		$headers += [
			'Host: '.$url->host,
			'Connection: close',
		];

		if($this->options->max_redirects > 0){
			$curl_options += [
				CURLOPT_FOLLOWLOCATION => true,
				CURLOPT_MAXREDIRS      => $this->options->max_redirects,
			];
		}

		$curl_options += [CURLOPT_HTTPHEADER => $headers];

		curl_setopt_array($this->curl, $curl_options);

		return $this->getResponse((string)$url);
	}

	/**
	 * @param array $headers
	 *
	 * @return array
	 */
	public function normalizeHeaders(array $headers):array {
		$normalized_headers = [];

		foreach($headers as $key => $val){

			if(is_numeric($key)){
				$header = explode(':', $val, 2);

				if(count($header) === 2){
					$key = $header[0];
					$val = $header[1];
				}
				else{
					continue;
				}
			}

			$key = ucfirst(strtolower($key));

			$normalized_headers[$key] = trim($key).': '.trim($val);
		}

		return $normalized_headers;
	}

	/**
	 * @param string $url
	 *
	 * @return array<string>
	 */
	public function extractShortUrl(string $url):array {
		$urls = [$url];

		while($url = $this->extract($url)){
			$urls[] = $url;
		}

		return $urls;
	}

	/**
	 * @param string $url
	 *
	 * @return string
	 * @link http://www.internoetics.com/2012/11/12/resolve-short-urls-to-their-destination-url-php-api/
	 */
	protected function extract(string $url):string {
		$this->initCurl();

		curl_setopt_array($this->curl, [
			CURLOPT_FOLLOWLOCATION => false
		]);

		$response = $this->getResponse($url);

		if(!$response instanceof ResponseInterface){
			return ''; // @codeCoverageIgnore
		}

		$info    = $response->info;
		$headers = $response->headers;

		// check curl_info()
		if(in_array($info->http_code, range(300, 308), true) && isset($info->redirect_url) && !empty($info->redirect_url)){
			return $info->redirect_url;
		}
		// look for a location header
		elseif(isset($headers->location) && !empty($headers->location)){
			return $headers->location; // @codeCoverageIgnore
		}

		return '';
	}

}