TrackManiaControl/core/Files/AsyncHttpRequest.php

<?php

namespace ManiaControl\Files;

use cURL\Event;
use cURL\Request;
use ManiaControl\General\UsageInformationAble;
use ManiaControl\General\UsageInformationTrait;
use ManiaControl\ManiaControl;

/**
 * Asynchronous Http Request Class
 *
 * @author    ManiaControl Team <mail@maniacontrol.com>
 * @copyright 2014-2020 ManiaControl Team
 * @license   http://www.gnu.org/licenses/ GNU General Public License, Version 3
 */
class AsyncHttpRequest implements UsageInformationAble {
	use UsageInformationTrait;
	/*
	 * Constants
	 */
	const CONTENT_TYPE_JSON = 'application/json';
	const CONTENT_TYPE_UTF8 = 'UTF-8';

	/*
	 * Private properties
	 */
	/** @var  ManiaControl $maniaControl */
	private $maniaControl;

	private $url;
	private $function;
	private $content;
	private $compression = false;
	private $contentType = 'text/xml; charset=UTF-8;';
	private $timeout     = 60;
	private $headers     = array();

	public function __construct($maniaControl, $url) {
		$this->maniaControl = $maniaControl;
		$this->url          = $url;
	}

	/**
	 * Create a new cURL Request for the given URL
	 *
	 * @param string $url
	 * @param int    $timeout
	 * @return \cURL\Request
	 */
	private function newRequest($url, $timeout) {
		$request = new Request($url);
		$request->getOptions()->set(CURLOPT_TIMEOUT, $timeout)->set(CURLOPT_HEADER, false)// don't display response header
		        ->set(CURLOPT_CRLF, true)// linux line feed
		        ->set(CURLOPT_ENCODING, '')// accept encoding
		        ->set(CURLOPT_USERAGENT, 'ManiaControl v' . ManiaControl::VERSION)// user-agent
		        ->set(CURLOPT_RETURNTRANSFER, true)//
		        ->set(CURLOPT_FOLLOWLOCATION, true)// support redirect
		        ->set(CURLOPT_SSL_VERIFYPEER, false)
				->set(CURLOPT_HEADER, true);
		return $request;
	}

	/**
	 * Carry out a GetData Request
	 *
	 * @param int $keepAlive
	 */
	public function getData($keepAlive = 0) {
		array_push($this->headers, 'Content-Type: ' . $this->contentType);
		if ($keepAlive) {
			array_push($this->headers, 'Keep-Alive: ' . $keepAlive);
			array_push($this->headers, 'Connection: Keep-Alive');
		}
		array_push($this->headers, 'Accept-Charset: utf-8');

		$request = $this->newRequest($this->url, $this->timeout);
		$request->getOptions()->set(CURLOPT_AUTOREFERER, true)// accept link reference
		        ->set(CURLOPT_HTTPHEADER, $this->headers); // headers

		$this->processRequest($request);
	}


	/**
	 * Carry out a PostData Request
	 */
	public function postData() {
		array_push($this->headers, 'Content-Type: ' . $this->contentType);
		array_push($this->headers, 'Keep-Alive: timeout=600, max=2000');
		array_push($this->headers, 'Connection: Keep-Alive');
		array_push($this->headers, 'Expect:');
		array_push($this->headers, 'Accept-Charset: utf-8');

		$content = $this->content;
		if ($this->compression) {
			$content = gzencode($this->content);
			array_push($this->headers, 'Content-Encoding: gzip');
		}


		$request = $this->newRequest($this->url, $this->timeout);
		$request->getOptions()->set(CURLOPT_POST, true)// post method
		        ->set(CURLOPT_POSTFIELDS, $content)// post content field
		        ->set(CURLOPT_HTTPHEADER, $this->headers) // headers
		;

		$this->processRequest($request);
	}


	/**
	 * Carry out a PatchData Request
	 */
	public function patchData() {
		array_push($this->headers, 'Content-Type: ' . $this->contentType);
		array_push($this->headers, 'Keep-Alive: timeout=600, max=2000');
		array_push($this->headers, 'Connection: Keep-Alive');
		array_push($this->headers, 'Expect:');
		array_push($this->headers, 'Accept-Charset: utf-8');

		$content = $this->content;
		if ($this->compression) {
			$content = gzencode($this->content);
			array_push($this->headers, 'Content-Encoding: gzip');
		}


		$request = $this->newRequest($this->url, $this->timeout);
		$request->getOptions()->set(CURLOPT_CUSTOMREQUEST, 'PATCH')// patch method
		        ->set(CURLOPT_POSTFIELDS, $content)// post content field
		        ->set(CURLOPT_HTTPHEADER, $this->headers) // headers
		;

		$this->processRequest($request);
	}

	/**
	 * Carry out a PutData Request
	 */
	public function putData() {
		array_push($this->headers, 'Content-Type: ' . $this->contentType);
		array_push($this->headers, 'Keep-Alive: timeout=600, max=2000');
		array_push($this->headers, 'Connection: Keep-Alive');
		array_push($this->headers, 'Expect:');
		array_push($this->headers, 'Accept-Charset: utf-8');

		$content = $this->content;
		if ($this->compression) {
			$content = gzencode($this->content);
			array_push($this->headers, 'Content-Encoding: gzip');
		}


		$request = $this->newRequest($this->url, $this->timeout);
		$request->getOptions()->set(CURLOPT_CUSTOMREQUEST, 'PUT')// patch method
		        ->set(CURLOPT_POSTFIELDS, $content)// put content field
		        ->set(CURLOPT_HTTPHEADER, $this->headers) // headers
		;

		$this->processRequest($request);
	}

	/**
	 * Processes the Request
	 *
	 * @param Request $request
	 */
	private function processRequest(Request $request) {
		$request->addListener('complete', function (Event $event) {
			$error   = null;
			$content = null;
			$headers = null;
			if ($event->response->hasError()) {
				$error = $event->response->getError()->getMessage();
			} else {
				$content = $event->response->getContent();
				$headers = $event->response->getHeaders();
			}
			call_user_func($this->function, $content, $error, $headers);
		});

		$fileReader = $this->maniaControl->getFileReader();
		$fileReader->addRequest($request);
	}

	/**
	 * @param $url
	 * @return $this
	 */
	public function setURL($url) {
		$this->url = $url;
		return $this;
	}

	/**
	 * @param callable $function
	 * @return $this
	 */
	public function setCallable($function) {
		$this->function = $function;
		return $this;
	}


	/**
	 * @return mixed
	 */
	public function getContent() {
		return $this->content;
	}

	/**
	 * @param mixed $content
	 * @return $this
	 */
	public function setContent($content) {
		$this->content = $content;
		return $this;
	}

	/**
	 * @return boolean
	 */
	public function getCompression() {
		return $this->compression;
	}

	/**
	 * @param boolean $compression
	 * @return $this
	 */
	public function setCompression($compression) {
		$this->compression = $compression;
		return $this;
	}

	/**
	 * @return array
	 */
	public function getHeaders() {
		return $this->headers;
	}

	/**
	 * @param array $headers
	 * @return $this
	 */
	public function setHeaders($headers) {
		if (is_array($headers)) {
			$this->headers = $headers;
		}
		return $this;
	}

	/**
	 * @return string
	 */
	public function getContentType() {
		return $this->contentType;
	}

	/**
	 * @param string $contentType
	 * @return $this
	 */
	public function setContentType($contentType) {
		$this->contentType = $contentType;
		return $this;
	}

	/**
	 * Gets the Timeout Time
	 *
	 * @return int
	 */
	public function getTimeout() {
		return $this->timeout;
	}

	/**
	 * Sets the Timeout Time
	 *
	 * @param int $timeout
	 */
	public function setTimeout($timeout) {
		$this->timeout = $timeout;
	}
}