SetCookieHeader::getFieldValue() - Code Metrics - Inspection of "v3.0.0" - sunrise-php/http-message - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#27)

by Anatoly
created 2022-12-31 00:02 UTC
SetCookieHeader::getFieldValue() B

↳ Parent: SetCookieHeader
Complexity

Conditions	9
Paths	64
Size

Total Lines	32
Code Lines	17
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	18
CRAP Score	9
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	9
eloc	17
c	1
b	0
f	0
nc	64
nop	0
dl	0
loc	32
ccs	18
cts	18
cp	1
crap	9
rs	8.0555
<?php declare(strict_types=1);

/**
 * It's free open-source software released under the MIT License.
 *
 * @author Anatoly Nekhay <[email protected]>
 * @copyright Copyright (c) 2018, Anatoly Nekhay
 * @license https://github.com/sunrise-php/http-message/blob/master/LICENSE
 * @link https://github.com/sunrise-php/http-message
 */

namespace Sunrise\Http\Message\Header;

/**
 * Import classes
 */
use DateTimeImmutable;
use DateTimeInterface;
use Sunrise\Http\Message\Exception\InvalidHeaderValueException;
use Sunrise\Http\Message\Header;

/**
 * Import functions
 */
use function max;
use function rawurlencode;
use function sprintf;
use function strpbrk;
use function time;

/**
 * @link https://tools.ietf.org/html/rfc6265#section-4.1
 * @link https://github.com/php/php-src/blob/master/ext/standard/head.c
 */
class SetCookieHeader extends Header
{

    /**
     * Cookies are not sent on normal cross-site subrequests, but
     * are sent when a user is navigating to the origin site.
     *
     * This is the default cookie value if SameSite has not been
     * explicitly specified in recent browser versions..
     *
     * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite#lax
     *
     * @var string
     */
    public const SAME_SITE_LAX = 'Lax';

    /**
     * Cookies will only be sent in a first-party context and not
     * be sent along with requests initiated by third party websites.
     *
     * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite#strict
     *
     * @var string
     */
    public const SAME_SITE_STRICT = 'Strict';

    /**
     * Cookies will be sent in all contexts, i.e. in responses to
     * both first-party and cross-site requests.
     *
     * If SameSite=None is set, the cookie Secure attribute must
     * also be set (or the cookie will be blocked).
     *
     * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite#none
     *
     * @var string
     */
    public const SAME_SITE_NONE = 'None';

    /**
     * Cookie option keys
     *
     * @var string
     */
    public const OPTION_KEY_PATH = 'path';
    public const OPTION_KEY_DOMAIN = 'domain';
    public const OPTION_KEY_SECURE = 'secure';
    public const OPTION_KEY_HTTP_ONLY = 'httpOnly';
    public const OPTION_KEY_SAMESITE = 'sameSite';

    /**
     * Default cookie options
     *
     * @var array{

     *        path?: ?string,
     *        domain?: ?string,
     *        secure?: ?bool,
     *        httpOnly?: ?bool,
     *        sameSite?: ?string
     *      }
     */
    protected static array $defaultOptions = [
        self::OPTION_KEY_PATH      => '/',
        self::OPTION_KEY_DOMAIN    => null,
        self::OPTION_KEY_SECURE    => null,
        self::OPTION_KEY_HTTP_ONLY => true,
        self::OPTION_KEY_SAMESITE  => self::SAME_SITE_LAX,
    ];

    /**
     * The cookie name
     *
     * @var string
     */
    private string $name;

    /**
     * The cookie value
     *
     * @var string
     */
    private string $value;

    /**
     * The cookie expiration date
     *
     * @var DateTimeInterface|null
     */
    private ?DateTimeInterface $expires;

    /**
     * The cookie options
     *
     * @var array{

     *        path?: ?string,
     *        domain?: ?string,
     *        secure?: ?bool,
     *        httpOnly?: ?bool,
     *        sameSite?: ?string
     *      }
     */
    private array $options;

    /**
     * Constructor of the class
     *
     * @param string $name
     * @param string $value
     * @param DateTimeInterface|null $expires
     * @param array{path?: ?string, domain?: ?string, secure?: ?bool, httpOnly?: ?bool, sameSite?: ?string} $options
     *
     * @throws InvalidHeaderValueException
     *         If one of the parameters isn't valid.
     */
    public function __construct(string $name, string $value, ?DateTimeInterface $expires = null, array $options = [])
    {
        $this->validateCookieName($name);

        if (isset($options[self::OPTION_KEY_PATH])) {
            $this->validateCookieOption(self::OPTION_KEY_PATH, $options[self::OPTION_KEY_PATH]);
        }

        if (isset($options[self::OPTION_KEY_DOMAIN])) {
            $this->validateCookieOption(self::OPTION_KEY_DOMAIN, $options[self::OPTION_KEY_DOMAIN]);
        }

        if (isset($options[self::OPTION_KEY_SAMESITE])) {
            $this->validateCookieOption(self::OPTION_KEY_SAMESITE, $options[self::OPTION_KEY_SAMESITE]);
        }

        if ($value === '') {
            $value = 'deleted';
            $expires = new DateTimeImmutable('1 year ago');
        }

        $options += static::$defaultOptions;

        $this->name = $name;
        $this->value = $value;
        $this->expires = $expires;
        $this->options = $options;
    }

    /**
     * {@inheritdoc}
     */
    public function getFieldName(): string
    {
        return 'Set-Cookie';
    }

    /**
     * {@inheritdoc}
     */
    public function getFieldValue(): string
    {
        $name = rawurlencode($this->name);
        $value = rawurlencode($this->value);
        $result = sprintf('%s=%s', $name, $value);

        if (isset($this->expires)) {
            $result .= '; Expires=' . $this->formatDateTime($this->expires);
            $result .= '; Expires=' . $this->formatDateTime(/** @scrutinizer ignore-type */ $this->expires);
            $result .= '; Max-Age=' . max($this->expires->getTimestamp() - time(), 0);
            $result .= '; Max-Age=' . max($this->expires->/** @scrutinizer ignore-call */ getTimestamp() - time(), 0);
        }

        if (isset($this->options[self::OPTION_KEY_PATH])) {
            $result .= '; Path=' . $this->options[self::OPTION_KEY_PATH];
        }

        if (isset($this->options[self::OPTION_KEY_DOMAIN])) {
            $result .= '; Domain=' . $this->options[self::OPTION_KEY_DOMAIN];
        }

        if (isset($this->options[self::OPTION_KEY_SECURE]) && $this->options[self::OPTION_KEY_SECURE]) {
            $result .= '; Secure';
        }

        if (isset($this->options[self::OPTION_KEY_HTTP_ONLY]) && $this->options[self::OPTION_KEY_HTTP_ONLY]) {
            $result .= '; HttpOnly';
        }

        if (isset($this->options[self::OPTION_KEY_SAMESITE])) {
            $result .= '; SameSite=' . $this->options[self::OPTION_KEY_SAMESITE];
        }

        return $result;
    }

    /**
     * Validates the given cookie name
     *
     * @param string $name
     *
     * @return void
     *
     * @throws InvalidHeaderValueException
     *         If the cookie name isn't valid.
     */
    private function validateCookieName(string $name): void
    {
        if ('' === $name) {
            throw new InvalidHeaderValueException('Cookie name cannot be empty');
        }

        // https://github.com/php/php-src/blob/02a5335b710aa36cd0c3108bfb9c6f7a57d40000/ext/standard/head.c#L93
        if (strpbrk($name, "=,; \t\r\n\013\014") !== false) {
            throw new InvalidHeaderValueException(sprintf(
                'The cookie name "%s" contains prohibited characters',
                $name
            ));
        }
    }

    /**
     * Validates the given cookie option
     *
     * @param string $validKey
     * @param mixed $value
     *
     * @return void
     *
     * @throws InvalidHeaderValueException
     *         If the cookie option isn't valid.
     */
    private function validateCookieOption(string $validKey, $value): void
    {
        if (!is_string($value)) {
            throw new InvalidHeaderValueException(sprintf(
                'The cookie option "%s" must be a string',
                $validKey
            ));
        }

        // https://github.com/php/php-src/blob/02a5335b710aa36cd0c3108bfb9c6f7a57d40000/ext/standard/head.c#L103
        // https://github.com/php/php-src/blob/02a5335b710aa36cd0c3108bfb9c6f7a57d40000/ext/standard/head.c#L108
        if (strpbrk($value, ",; \t\r\n\013\014") !== false) {
            throw new InvalidHeaderValueException(sprintf(
                'The cookie option "%s" contains prohibited characters',
                $validKey
            ));
        }
    }
}

sunrise-php / http-message

Pull Request — master (#27)

SetCookieHeader::getFieldValue() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
