HttpMessage.php

Go to the documentation of this file.

<?php

namespace ILIAS\LTI\ToolProvider\Http;

use ILIAS\LTI\ToolProvider\Util;

class HttpMessage
{
    public bool $ok = false;

    //UK:added
    public object $responseJson;

    public ?string $request = null;

    public $requestHeaders = '';

    public ?string $response = null;

    public $responseHeaders = '';

    public array $relativeLinks = array();

    public int $status = 0;

    public string $error = '';

    private ?string $url = null;

    private ?string $method = null;

    private static ?ClientInterface $httpClient = null; //changed ...= null

    public function __construct(string $url, string $method = 'GET', $params = null, string $header = null)
    {
        $this->url = $url;
        $this->method = strtoupper($method);
        if (is_array($params)) {
            $this->request = http_build_query($params);
        } else {
            $this->request = $params;
        }
        if (!empty($header)) {
            $this->requestHeaders = explode("\n", $header);
        }
    }

    public function getUrl(): ?string
    {
        return $this->url;
    }

    public function getMethod(): ?string
    {
        return $this->method;
    }

    public static function setHttpClient(ClientInterface $httpClient = null)
    {
        self::$httpClient = $httpClient;
        Util::logDebug('HttpClient set to \'' . get_class(self::$httpClient) . '\'');
    }

    public static function getHttpClient()
    {
        if (!self::$httpClient) {
            if (function_exists('curl_init')) {
                self::$httpClient = new CurlClient();
            } elseif (ini_get('allow_url_fopen')) {
                self::$httpClient = new StreamClient();
            }
            if (self::$httpClient) {
                Util::logDebug('HttpClient set to \'' . get_class(self::$httpClient) . '\'');
            }
        }

        return self::$httpClient;
    }

    public function send(): bool
    {
        $client = self::getHttpClient();
        $this->relativeLinks = array();
        if (empty($client)) {
            $this->ok = false;
            $message = 'No HTTP client interface is available';
            $this->error = $message;
            Util::logError($message, true);
        } elseif (empty($this->url)) {
            $this->ok = false;
            $message = 'No URL provided for HTTP request';
            $this->error = $message;
            Util::logError($message, true);
        } else {
            $this->ok = $client->send($this);
            $this->parseRelativeLinks();
            if (Util::$logLevel > Util::LOGLEVEL_NONE) {
                $message = "Http\\HttpMessage->send {$this->method} request to '{$this->url}'";
                if (!empty($this->requestHeaders)) {
                    $message .= "\n{$this->requestHeaders}";
                }
                if (!empty($this->request)) {
                    $message .= "\n\n{$this->request}";
                }
                $message .= "\nResponse:";
                if (!empty($this->responseHeaders)) {
                    $message .= "\n{$this->responseHeaders}";
                }
                if (!empty($this->response)) {
                    $message .= "\n\n{$this->response}";
                }
                if ($this->ok) {
                    Util::logInfo($message);
                } else {
                    if (!empty($this->error)) {
                        $message .= "\nError: {$this->error}";
                    }
                    Util::logError($message);
                }
            }
        }

        return $this->ok;
    }

    public function hasRelativeLink(string $rel): bool
    {
        return array_key_exists($rel, $this->relativeLinks);
    }

    public function getRelativeLink(string $rel): ?string
    {
        $url = null;
        if ($this->hasRelativeLink($rel)) {
            $url = $this->relativeLinks[$rel];
        }

        return $url;
    }

    public function getRelativeLinks(): array
    {
        return $this->relativeLinks;
    }

    ###
    ###  PRIVATE METHOD
    ###

    private function parseRelativeLinks()
    {
        $matched = preg_match_all('/^(Link|link): *(.*)$/m', $this->responseHeaders, $matches);
        if ($matched) {
            for ($i = 0; $i < $matched; $i++) {
                $links = explode(',', $matches[2][$i]);
                foreach ($links as $link) {
                    if (preg_match('/^<([^>]+)>; *rel=([^ ]+)$/', trim($link), $match)) {
                        $rel = strtolower(utf8_decode($match[2]));
                        if ((strpos($rel, '"') === 0) || (strpos($rel, '?') === 0)) {
                            $rel = substr($rel, 1, strlen($rel) - 2);
                        }
                        if ($rel === 'previous') {
                            $rel = 'prev';
                        }
                        $this->relativeLinks[$rel] = $match[1];
                    }
                }
            }
        }
    }
}