Uri.php

Go to the documentation of this file.

<?php
 
namespace PlanetTeamSpeak\TeamSpeak3Framework\Helper;
 
use PlanetTeamSpeak\TeamSpeak3Framework\Exception\HelperException;

class Uri
{
    protected StringHelper|string|null $scheme = null;

    protected ?StringHelper $user = null;

    protected ?StringHelper $pass = null;

    protected ?StringHelper $host = null;

    protected ?StringHelper $port = null;

    protected ?StringHelper $path = null;

    protected ?StringHelper $query = null;

    protected ?StringHelper $fragment = null;

    protected array $regex = [];

    public function __construct(string $uri)
    {
        if (!strlen($uri)) {
            throw new HelperException("no URI supplied");
        }
 
        /* grammar rules for validation */
        $this->regex["alphanum"] = "[^\W_]";
        $this->regex["escaped"] = "(?:%[\da-fA-F]{2})";
        $this->regex["mark"] = "[-_.!~*'()\[\]]";
        $this->regex["reserved"] = "[;\/?:@&=+$,]";
        $this->regex["unreserved"] = "(?:" . $this->regex["alphanum"] . "|" . $this->regex["mark"] . ")";
        $this->regex["segment"] = "(?:(?:" . $this->regex["unreserved"] . "|" . $this->regex["escaped"] . "|[:@&=+$,;])*)";
        $this->regex["path"] = "(?:\/" . $this->regex["segment"] . "?)+";
        $this->regex["uric"] = "(?:" . $this->regex["reserved"] . "|" . $this->regex["unreserved"] . "|" . $this->regex["escaped"] . ")";
 
        $this->parseUri($uri);
 
        if (!$this->isValid()) {
            throw new HelperException("invalid URI supplied");
        }
    }

    protected function parseUri(string $uriString = ''): void
    {
        $components = parse_url($uriString, -1);
 
        if ($components === false) {
            throw new HelperException("URI scheme-specific decomposition failed");
        }
 
        $this->scheme = StringHelper::factory(isset($components["scheme"]) ? $components["scheme"] : "");
 
        if (empty(trim($this->scheme)) or !ctype_alnum($this->scheme->toString())) {
            throw new HelperException("invalid URI scheme '" . $this->scheme . "' supplied");
        }
 
        $this->host = StringHelper::factory(isset($components["host"]) ? $components["host"] : "");
        $this->port = StringHelper::factory(isset($components["port"]) ? $components["port"] : "");
 
        $this->user = StringHelper::factory(isset($components["user"]) ? $components["user"] : "");
        $this->pass = StringHelper::factory(isset($components["pass"]) ? $components["pass"] : "");
 
        $this->path = StringHelper::factory((isset($components["path"])) ? $components["path"] : "");
        $this->query = StringHelper::factory((isset($components["query"])) ? $components["query"] : "");
        $this->fragment = StringHelper::factory((isset($components["fragment"])) ? $components["fragment"] : "");
 
        if (str_contains($this->fragment, "?")) {
            throw new HelperException("invalid URI fragment '" . $this->fragment . "' supplied (fragment must be after query)");
        }
    }

    public function isValid(): bool
    {
        return ($this->checkUser() && $this->checkPass() && $this->checkHost() && $this->checkPort() && $this->checkPath() && $this->checkQuery() && $this->checkFragment());
    }

    public static function check(StringHelper $uri): bool
    {
        try {
            $uri = new self(strval($uri));
        } catch (HelperException) {
            return false;
        }
 
        return $uri->isValid();
    }

    public function hasScheme(): bool
    {
        return (bool)strlen($this->scheme);
    }

    public function getScheme(mixed $default = null): ?StringHelper
    {
        return ($this->hasScheme()) ? new StringHelper($this->scheme) : $default;
    }

    public function checkUser(string $username = null): bool
    {
        if ($username === null) {
            $username = $this->user->toString();
        }
 
        if (strlen($username) == 0) {
            return true;
        }
 
        $pattern = "/^(" . $this->regex["alphanum"] . "|" . $this->regex["mark"] . "|" . $this->regex["escaped"] . "|" . "[;:&=+$,])+$/";
        $status = @preg_match($pattern, $username);
 
        if ($status === false) {
            throw new HelperException("URI username validation failed");
        }
 
        return ($status == 1);
    }

    public function hasUser(): bool
    {
        return (bool)strlen($this->user);
    }

    public function getUser(mixed $default = null): ?StringHelper
    {
        return ($this->hasUser()) ? new StringHelper(urldecode($this->user)) : $default;
    }

    public function checkPass(StringHelper|string $password = null): bool
    {
        if ($password === null) {
            $password = $this->pass->toString();
        }
 
        if (strlen($password) == 0) {
            return true;
        }
 
        $pattern = "/^(" . $this->regex["alphanum"] . "|" . $this->regex["mark"] . "|" . $this->regex["escaped"] . "|" . "[;:&=+$,])+$/";
        $status = @preg_match($pattern, $password);
 
        if ($status === false) {
            throw new HelperException("URI password validation failed");
        }
 
        return ($status == 1);
    }

    public function hasPass(): bool
    {
        return (bool)strlen($this->pass);
    }

    public function getPass(mixed $default = null): ?StringHelper
    {
        return ($this->hasPass()) ? new StringHelper(urldecode($this->pass)) : $default;
    }

    public function checkHost(string $host = null): bool
    {
        if ($host === null) {
            $host = $this->host;
        }
 
        switch ($host) {
            case filter_var($host, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4 | FILTER_FLAG_IPV6):
                // Valid IPv4 or IPv6 address
                break;
            case !preg_match("/^(([0-9]{1,3})\.){3}([0-9]{1,3})$/", $host) and preg_match("/^(([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])\.)*([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])$/i", $host):
                // Valid hostname as specified in RFC 1123 (IPv4 like strings are excluded)
                // `filter_var($host, FILTER_VALIDATE_DOMAIN, FILTER_FLAG_HOSTNAME)` unfortunately also reports invalid IP
                // addresses (e.g. `127.0.0.300`) as valid, so we can not use this filter here.
                // Regex reference: https://stackoverflow.com/questions/106179/regular-expression-to-match-dns-hostname-or-ip-address
                break;
            default:
                // Otherwise invalid host provided
                return false;
        }
 
        return true;
    }

    public function hasHost(): bool
    {
        return (bool)strlen($this->host);
    }

    public function getHost(mixed $default = null): ?StringHelper
    {
        return ($this->hasHost()) ? new StringHelper(rawurldecode($this->host)) : $default;
    }

    public function checkPort(int $port = null): bool
    {
        if ($port === null) {
            if ($this->port instanceof StringHelper) {
                $port = intval($this->port->toString());
            } else {
                $port = intval($this->port);
            }
        }
 
        switch ($port) {
            case str_starts_with($port, '-'):
            case $port < 0:
            case !is_int($port):
            case !filter_var($port, FILTER_VALIDATE_INT, ['options' => ['min_range' => 1, 'max_range' => 65535]]):
                return false;
        }
 
        return true;
    }

    public function hasPort(): bool
    {
        return (bool)strlen($this->port->toString());
    }

    public function getPort(mixed $default = null): int
    {
        return ($this->hasPort()) ? intval($this->port->toString()) : $default;
    }

    public function checkPath(string $path = null): bool
    {
        if ($path === null) {
            $path = $this->path->toString();
        }
 
        if (strlen($path) == 0) {
            return true;
        }
 
        $pattern = "/^" . $this->regex["path"] . "$/";
        $status = @preg_match($pattern, $path);
 
        if ($status === false) {
            throw new HelperException("URI path validation failed");
        }
 
        return ($status == 1);
    }

    public function hasPath(): bool
    {
        return (bool)strlen($this->path);
    }

    public function getPath(string $default = "/"): StringHelper
    {
        return ($this->hasPath()) ? new StringHelper(rawurldecode($this->path)) : new StringHelper($default);
    }

    public function checkQuery(string $query = null): bool
    {
        if ($query === null) {
            $query = $this->query;
        }
 
        if (strlen($query) == 0) {
            return true;
        }
 
        $pattern = "/^" . $this->regex["uric"] . "*$/";
        $status = @preg_match($pattern, $query);
 
        if ($status === false) {
            throw new HelperException("URI query string validation failed");
        }
 
        return ($status == 1);
    }

    public function hasQuery(): bool
    {
        return (bool)strlen($this->query);
    }

    public function getQuery(array $default = []): array
    {
        if (!$this->hasQuery()) {
            return $default;
        }
 
        parse_str(rawurldecode($this->query), $queryArray);
 
        return $queryArray;
    }

    public function hasQueryVar($key): bool
    {
        if (!$this->hasQuery()) {
            return false;
        }
 
        parse_str($this->query, $queryArray);
 
        return array_key_exists($key, $queryArray);
    }

    public function getQueryVar(string $key, mixed $default = null): mixed
    {
        if (!$this->hasQuery()) {
            return $default;
        }
 
        parse_str(rawurldecode($this->query), $queryArray);
 
        if (array_key_exists($key, $queryArray)) {
            $val = $queryArray[$key];
 
            if (ctype_digit($val)) {
                return intval($val);
            } elseif (is_string($val)) {
                return new StringHelper($val);
            } else {
                return $val;
            }
        }
 
        return $default;
    }

    public function checkFragment(string $fragment = null): bool
    {
        if ($fragment === null) {
            $fragment = $this->fragment;
        }
 
        if (strlen($fragment) == 0) {
            return true;
        }
 
        $pattern = "/^" . $this->regex["uric"] . "*$/";
        $status = @preg_match($pattern, $fragment);
 
        if ($status === false) {
            throw new HelperException("URI fragment validation failed");
        }
 
        return ($status == 1);
    }

    public function hasFragment(): bool
    {
        return (bool)strlen($this->fragment);
    }

    public function getFragment(mixed $default = null): ?StringHelper
    {
        return ($this->hasFragment()) ? new StringHelper(rawurldecode($this->fragment)) : $default;
    }

    public static function getUserParam(string $key, mixed $default = null): mixed
    {
        return (array_key_exists($key, $_REQUEST) && !empty($_REQUEST[$key])) ? self::stripslashesRecursive($_REQUEST[$key]) : $default;
    }

    public static function getHostParam(string $key, mixed $default = null): mixed
    {
        return (array_key_exists($key, $_SERVER) && !empty($_SERVER[$key])) ? $_SERVER[$key] : $default;
    }

    public static function getSessParam(string $key, mixed $default = null): mixed
    {
        return (array_key_exists($key, $_SESSION) && !empty($_SESSION[$key])) ? $_SESSION[$key] : $default;
    }

    public static function getFQDNParts(string $hostname): array
    {
        if (!preg_match("/^([a-z0-9][a-z0-9-]{0,62}\.)*([a-z0-9][a-z0-9-]{0,62}\.)+([a-z]{2,6})$/i", $hostname, $matches)) {
            return [];
        }
 
        $parts["tld"] = $matches[3];
        $parts["2nd"] = $matches[2];
        $parts["3rd"] = $matches[1];
 
        return $parts;
    }

    public static function getHostUri(): StringHelper
    {
        $sheme = (self::getHostParam("HTTPS") == "on") ? "https" : "http";
 
        $serverName = new StringHelper(self::getHostParam("HTTP_HOST"));
        $serverPort = self::getHostParam("SERVER_PORT");
        $serverPort = ($serverPort != 80 && $serverPort != 443) ? ":" . $serverPort : "";
 
        if ($serverName->endsWith($serverPort)) {
            $serverName = $serverName->replace($serverPort, "");
        }
 
        return new StringHelper($sheme . "://" . $serverName . $serverPort);
    }

    public static function getBaseUri(): StringHelper
    {
        $scriptPath = new StringHelper(dirname(self::getHostParam("SCRIPT_NAME")));
 
        return self::getHostUri()->append(($scriptPath == DIRECTORY_SEPARATOR ? "" : $scriptPath) . "/");
    }

    protected static function stripslashesRecursive(mixed $var): string|array
    {
        if (!is_array($var)) {
            return stripslashes(strval($var));
        }
 
        foreach ($var as $key => $val) {
            $var[$key] = (is_array($val)) ? self::stripslashesRecursive($val) : stripslashes(strval($val));
        }
 
        return $var;
    }
}