WebServCo\Framework\Helpers\RequestHelper

Complexity

Total Complexity

20

Size/Duplication

Total Lines	152
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	explode()	0	10	3
A	removeSuffix()	0	13	4
A	getRemoteAddress()	0	11	3
A	format()	0	15	4
A	parse()	0	17	3
A	split()	0	5	1
A	sanitizeString()	0	44	1
A	transform()	0	4	1

<?php

declare(strict_types=1);

namespace WebServCo\Framework\Helpers;

final class RequestHelper
{
    /**
    * @return array<int,string>
    */
    public static function explode(string $string): array
    {
        if (false !== \strpos($string, '?')) {
            return \explode('?', $string, 2);
        }

        if (false !== \strpos($string, '&')) {
            return \explode('&', $string, 2);
        }
        return [$string, ''];
    }

    /**
    * @return array<string, string|null>
    */
    public static function format(string $string): array
    {
        $data = [];
        $parts = self::split($string);
        $num = \count($parts);
        for ($position = 0; $position < $num; $position += 2) {
            if (!\array_key_exists($position, $parts)) {
                // Prevents "Notice: Undefined offset: 2." in request like "&lang=/'/"
                continue;
            }
            $data[$parts[$position]] = $position === $num - 1
                ? null
                : $parts[$position + 1];
        }
        return $data;
    }

    public static function getRemoteAddress(): string
    {
        if (PhpHelper::isCli()) {
            return \gethostbyname(\php_uname('n'));
        }

        if (\array_key_exists('REMOTE_ADDR', $_SERVER)) {
            return self::sanitizeString($_SERVER['REMOTE_ADDR']);
        }

        return '';
    }

    /**
    * @param array<int,string> $suffixes
    * @return array<int,string>
    */
    public static function parse(string $string, string $path, string $filename, array $suffixes): array
    {
        $pathLen = \strlen($path);
        if (0 === \strncasecmp($path, $string, $pathLen)) {
            $string = \substr($string, $pathLen);
        }
        $filenameLen = \strlen($filename);
        if (0 === \strncasecmp($filename, $string, $filenameLen)) {
            $string = \substr($string, $filenameLen);
        }
        [$target, $query] = self::explode($string);
        [$target, $suffix] = self::removeSuffix(
            self::transform($target),
            $suffixes,
        );
        $query = self::transform($query);
        return [$target, $query, $suffix];
    }

    /**
    * @param array<int,string> $suffixes
    * @return array<int,string>
    */
    public static function removeSuffix(string $string, array $suffixes = []): array
    {
        if ($suffixes) {
            $stringRev = \strrev($string);
            foreach ($suffixes as $suffix) {
                $suffixRev = \strrev($suffix);
                $suffixLen = \strlen($suffix);
                if (0 === \strncasecmp($suffixRev, $stringRev, $suffixLen)) {
                    return [\strrev(\substr($stringRev, $suffixLen)), $suffix];
                }
            }
        }
        return [$string, ''];
    }

    public static function sanitizeString(string $string): string
    {
        // Strip tags, optionally strip or encode special characters.
        /**
         * FILTER_SANITIZE_STRING is deprecated since PHP 8.1.
         *
         * $string = \filter_var($string, \FILTER_SANITIZE_STRING);
         * Use a polyfill instead.
         * Source: https://stackoverflow.com/a/69207369
         */
        $string = \preg_replace('/\x00|<[^>]*>?/', '', $string);
        $string = \str_replace(["'", '"'], ['&#39;', '&#34;'], $string);

        $unwanted = [
            "`",
            //"'",
            //'"',
            "\b",
            "\n",
            "\r",
            "\t",
            //"?",
            //"!",
            //"~",
            //"#",
            //"^",
            //"&",
            //"*",
            //"=",
            //"[",
            //"]",
            //":",
            //";",
            //",",
            //"|",
            "\\",
            //"{",
            //"}",
            //"(",
            //")",
            "\$",
        ];
        $string = \str_replace($unwanted, '', (string) $string);
        return $string;
    }

    /**
    * @return array<int,string>
    */
    public static function split(string $string): array
    {
        $parts = \explode('/', $string);
        $parts = \array_map('urldecode', $parts);
        return \array_diff($parts, ['']);
    }

    public static function transform(string $string): string
    {
        $string = \str_replace(['?', '&', '=', '//'], ['', '/', '/', '/0/'], $string);
        return \trim($string, ' /');
    }
}