9.5/core_2_classes_2_http_2_message_8php_source.html

<?php

namespace ‪TYPO3\CMS\Core\Http;


/*

 * 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!

 */


use Psr\Http\Message\MessageInterface;

use Psr\Http\Message\StreamInterface;


class ‪Message implements MessageInterface

{

    protected ‪$protocolVersion = '1.1';


    protected ‪$headers = [];


    protected ‪$lowercasedHeaderNames = [];


    protected ‪$body;


    public function ‪getProtocolVersion()

    {

        return ‪$this->protocolVersion;

    }


    public function ‪withProtocolVersion($version)

    {

        $clonedObject = clone $this;

        $clonedObject->protocolVersion = $version;

        return $clonedObject;

    }


    public function ‪getHeaders()

    {

        return ‪$this->headers;

    }


    public function ‪hasHeader($name)

    {

        return isset($this->lowercasedHeaderNames[strtolower($name)]);

    }


    public function ‪getHeader($name)

    {

        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($name)

    {

        $headerValue = $this->‪getHeader($name);

        if (empty($headerValue)) {

            return '';

        }

        return implode(',', $headerValue);

    }


    public function ‪withHeader($name, $value)

    {

        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($name, $value)

    {

        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($name)

    {

        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()

    {

        return ‪$this->body;

    }


    public function ‪withBody(StreamInterface ‪$body)

    {

        $clonedObject = clone $this;

        $clonedObject->body = ‪$body;

        return $clonedObject;

    }


    protected function ‪assertHeaders(array ‪$headers)

    {

        foreach (‪$headers as $name => $headerValues) {

            $this->‪validateHeaderName($name);

            // check if all values are correct

            array_walk($headerValues, function ($value, $key, ‪Message $messageObject) {

                if (!$messageObject->‪isValidHeaderValue($value)) {

                    throw new \InvalidArgumentException('Invalid header value for header "' . $key . '"', 1436717268);

                }

            }, $this);

        }

    }


    protected function ‪filterHeaders(array $originalHeaders)

    {

        $headerNames = ‪$headers = [];

        foreach ($originalHeaders as $header => $value) {

            if (!is_string($header) || (!is_array($value) && !is_string($value))) {

                continue;

            }

            if (!is_array($value)) {

                $value = [$value];

            }

            $headerNames[strtolower($header)] = $header;

            ‪$headers[$header] = $value;

        }

        return [$headerNames, ‪$headers];

    }


    protected function ‪arrayContainsOnlyStrings(array $data)

    {

        return array_reduce($data, function ($original, $item) {

            return is_string($item) ? $original : false;

        }, true);

    }


    protected function ‪validateHeaderValues(array $values)

    {

        array_walk($values, function ($value, $key, ‪Message $messageObject) {

            if (!$messageObject->‪isValidHeaderValue($value)) {

                throw new \InvalidArgumentException('Invalid header value for header "' . $key . '"', 1436717269);

            }

        }, $this);

    }


    public function ‪filter($value)

    {

        $value  = (string)$value;

        $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($name)

    {

        if (!preg_match('/^[a-zA-Z0-9\'`#$%&*+.^_|~!-]+$/', $name)) {

            throw new \InvalidArgumentException('Invalid header name, given "' . $name . '"', 1436717270);

        }

    }


    public function ‪isValidHeaderValue($value)

    {

        $value = (string)$value;


        // Any occurrence of \r or \n is invalid

        if (strpbrk($value, "\r\n") !== false) {

            return false;

        }


        $length = strlen($value);

        for ($i = 0; $i < $length; $i += 1) {

            $ascii = ord($value[$i]);


            // Non-visible, non-whitespace characters

            // 9 === horizontal tab

            // 10 === line feed

            // 13 === carriage return

            // 32-126, 128-254 === visible

            // 127 === DEL

            // 255 === null byte

            if (($ascii < 32 && !in_array($ascii, [9, 10, 13], true)) || $ascii === 127 || $ascii > 254) {

                return false;

            }

        }


        return true;

    }

}