Message.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Http;
 
use Psr\Http\Message\MessageInterface;
use Psr\Http\Message\StreamInterface;
 
class ‪Message implements MessageInterface
{
    protected string ‪$protocolVersion = '1.1';
 
    protected array ‪$headers = [];
 
    protected array ‪$lowercasedHeaderNames = [];
 
    protected ?StreamInterface ‪$body = null;
 
    public function ‪getProtocolVersion(): string
    {
        return ‪$this->protocolVersion;
    }
 
    public function ‪withProtocolVersion(string $version): MessageInterface
    {
        $clonedObject = clone $this;
        $clonedObject->protocolVersion = $version;
        return $clonedObject;
    }
 
    public function ‪getHeaders(): array
    {
        return ‪$this->headers;
    }
 
    public function ‪hasHeader(string $name): bool
    {
        return isset($this->lowercasedHeaderNames[strtolower($name)]);
    }
 
    public function ‪getHeader(string $name): array
    {
        if (!$this->‪hasHeader($name)) {
            return [];
        }
        $header = $this->lowercasedHeaderNames[strtolower($name)];
        $headerValue = $this->headers[$header];
        if (is_array($headerValue)) {
            return $headerValue;
        }
        return [$headerValue];
    }
 
    public function ‪getHeaderLine(string $name): string
    {
        $headerValue = $this->‪getHeader($name);
        if (empty($headerValue)) {
            return '';
        }
        return implode(',', $headerValue);
    }
 
    public function ‪withHeader(string $name, $value): MessageInterface
    {
        if (is_string($value)) {
            $value = [$value];
        }
 
        if (!is_array($value) || !$this->‪arrayContainsOnlyStrings($value)) {
            throw new \InvalidArgumentException('Invalid header value for header "' . $name . '". The value must be a string or an array of strings.', 1436717266);
        }
 
        $this->‪validateHeaderName($name);
        $this->‪validateHeaderValues($value);
        $lowercasedHeaderName = strtolower($name);
 
        $clonedObject = clone $this;
        $clonedObject->headers[$name] = $value;
        $clonedObject->lowercasedHeaderNames[$lowercasedHeaderName] = $name;
        return $clonedObject;
    }
 
    public function ‪withAddedHeader(string $name, $value): MessageInterface
    {
        if (is_string($value)) {
            $value = [$value];
        }
        if (!is_array($value) || !$this->‪arrayContainsOnlyStrings($value)) {
            throw new \InvalidArgumentException('Invalid header value for header "' . $name . '". The header value must be a string or array of strings', 1436717267);
        }
        $this->‪validateHeaderName($name);
        $this->‪validateHeaderValues($value);
        if (!$this->‪hasHeader($name)) {
            return $this->‪withHeader($name, $value);
        }
        $name = $this->lowercasedHeaderNames[strtolower($name)];
        $clonedObject = clone $this;
        $clonedObject->headers[$name] = array_merge($this->headers[$name], $value);
        return $clonedObject;
    }
 
    public function ‪withoutHeader(string $name): MessageInterface
    {
        if (!$this->‪hasHeader($name)) {
            return clone $this;
        }
        // fetch the original header from the lowercased version
        $lowercasedHeader = strtolower($name);
        $name = $this->lowercasedHeaderNames[$lowercasedHeader];
        $clonedObject = clone $this;
        unset($clonedObject->headers[$name], $clonedObject->lowercasedHeaderNames[$lowercasedHeader]);
        return $clonedObject;
    }
 
    public function ‪getBody(): StreamInterface
    {
        if ($this->body === null) {
            $this->body = new ‪Stream('php://temp', 'r+');
        }
        return ‪$this->body;
    }
 
    public function ‪withBody(StreamInterface ‪$body): MessageInterface
    {
        $clonedObject = clone $this;
        $clonedObject->body = ‪$body;
        return $clonedObject;
    }
 
    protected function ‪assertHeaders(array ‪$headers): void
    {
        foreach (‪$headers as $name => $headerValues) {
            $this->‪validateHeaderName($name);
            // check if all values are correct
            array_walk($headerValues, static function (string $value, string $key, ‪Message $messageObject): void {
                if (!$messageObject->‪isValidHeaderValue($value)) {
                    throw new \InvalidArgumentException('Invalid header value for header "' . $key . '"', 1436717268);
                }
            }, $this);
        }
    }
 
    protected function ‪filterHeaders(array $originalHeaders): array
    {
        $headerNames = ‪$headers = [];
        foreach ($originalHeaders as $header => $value) {
            if (!is_string($header) || (!is_array($value) && !is_scalar($value))) {
                continue;
            }
            if (!is_array($value)) {
                $value = [(string)$value];
            }
            $headerNames[strtolower($header)] = $header;
            ‪$headers[$header] = $value;
        }
        return [$headerNames, ‪$headers];
    }
 
    protected function ‪arrayContainsOnlyStrings(array $data): bool
    {
        return array_reduce($data, static function ($original, $item) {
            return is_string($item) ? $original : false;
        }, true);
    }
 
    protected function ‪validateHeaderValues(array $values): void
    {
        array_walk($values, static function (string $value, string $key, ‪Message $messageObject): void {
            if (!$messageObject->‪isValidHeaderValue($value)) {
                throw new \InvalidArgumentException('Invalid header value for header "' . $key . '"', 1436717269);
            }
        }, $this);
    }
 
    public function ‪filter(string $value): string
    {
        $length = strlen($value);
        $string = '';
        for ($i = 0; $i < $length; $i += 1) {
            $ascii = ord($value[$i]);
 
            // Detect continuation sequences
            if ($ascii === 13) {
                $lf = ord($value[$i + 1]);
                $ws = ord($value[$i + 2]);
                if ($lf === 10 && in_array($ws, [9, 32], true)) {
                    $string .= $value[$i] . $value[$i + 1];
                    $i += 1;
                }
                continue;
            }
 
            // Non-visible, non-whitespace characters
            // 9 === horizontal tab
            // 32-126, 128-254 === visible
            // 127 === DEL
            // 255 === null byte
            if (($ascii < 32 && $ascii !== 9) || $ascii === 127 || $ascii > 254) {
                continue;
            }
 
            $string .= $value[$i];
        }
 
        return $string;
    }
 
    public function ‪validateHeaderName(string $name): void
    {
        if (!preg_match('/^[a-zA-Z0-9\'`#$%&*+.^_|~!-]+$/', $name)) {
            throw new \InvalidArgumentException('Invalid header name, given "' . $name . '"', 1436717270);
        }
    }
 
    public function ‪isValidHeaderValue(string $value): bool
    {
        // Any occurrence of \r or \n is invalid
        if (strpbrk($value, "\r\n") !== false) {
            return false;
        }
 
        foreach (unpack('C*', $value) as $ascii) {
            // Non-visible, non-whitespace characters
            // 9 === horizontal tab
            // 32-126, 128-254 === visible
            // 127 === DEL
            // 255 === null byte
            if (($ascii < 32 && $ascii !== 9) || $ascii === 127 || $ascii > 254) {
                return false;
            }
        }
 
        return true;
    }
}