xref: /template/strap/ComboStrap/Web/Url.php (revision 5b0932ef22f2e064613880e6bde517ef4aa415b2)
104fd306cSNickeau<?php
204fd306cSNickeau
304fd306cSNickeau
404fd306cSNickeaunamespace ComboStrap\Web;
504fd306cSNickeau
604fd306cSNickeauuse ComboStrap\ArrayCaseInsensitive;
704fd306cSNickeauuse ComboStrap\DataType;
8e346390aSgerardnicouse ComboStrap\DokuwikiId;
904fd306cSNickeauuse ComboStrap\ExceptionBadArgument;
1004fd306cSNickeauuse ComboStrap\ExceptionBadSyntax;
1104fd306cSNickeauuse ComboStrap\ExceptionCompile;
1204fd306cSNickeauuse ComboStrap\ExceptionNotEquals;
1304fd306cSNickeauuse ComboStrap\ExceptionNotFound;
1404fd306cSNickeauuse ComboStrap\ExceptionRuntimeInternal;
1504fd306cSNickeauuse ComboStrap\FetcherRawLocalPath;
1604fd306cSNickeauuse ComboStrap\FetcherSystem;
1704fd306cSNickeauuse ComboStrap\LocalFileSystem;
1804fd306cSNickeauuse ComboStrap\LogUtility;
1970bbd7f1Sgerardnicouse ComboStrap\MediaMarkup;
2004fd306cSNickeauuse ComboStrap\Path;
2104fd306cSNickeauuse ComboStrap\PathAbs;
2204fd306cSNickeauuse ComboStrap\Site;
2304fd306cSNickeauuse ComboStrap\WikiPath;
24*5b0932efSgerardnicouse dokuwiki\Input\Input;
2504fd306cSNickeau
2604fd306cSNickeau/**
2704fd306cSNickeau * Class Url
2804fd306cSNickeau * @package ComboStrap
2904fd306cSNickeau * There is no URL class in php
3004fd306cSNickeau * Only function
3104fd306cSNickeau * https://www.php.net/manual/en/ref.url.php
3204fd306cSNickeau */
3304fd306cSNickeauclass Url extends PathAbs
3404fd306cSNickeau{
3504fd306cSNickeau
3604fd306cSNickeau
3704fd306cSNickeau    public const PATH_SEP = "/";
3804fd306cSNickeau    /**
3904fd306cSNickeau     * In HTML (not in css)
4004fd306cSNickeau     *
4104fd306cSNickeau     * Because ampersands are used to denote HTML entities,
4204fd306cSNickeau     * if you want to use them as literal characters, you must escape them as entities,
4304fd306cSNickeau     * e.g.  &amp;.
4404fd306cSNickeau     *
4504fd306cSNickeau     * In HTML, Browser will do the translation for you if you give an URL
4604fd306cSNickeau     * not encoded but testing library may not and refuse them
4704fd306cSNickeau     *
4804fd306cSNickeau     * This URL encoding is mandatory for the {@link ml} function
4904fd306cSNickeau     * when there is a width and use them not otherwise
5004fd306cSNickeau     *
5104fd306cSNickeau     * Thus, if you want to link to:
5204fd306cSNickeau     * http://images.google.com/images?num=30&q=larry+bird
5304fd306cSNickeau     * you need to encode (ie pass this parameter to the {@link ml} function:
5404fd306cSNickeau     * http://images.google.com/images?num=30&amp;q=larry+bird
5504fd306cSNickeau     *
5604fd306cSNickeau     * https://daringfireball.net/projects/markdown/syntax#autoescape
5704fd306cSNickeau     *
5804fd306cSNickeau     */
5904fd306cSNickeau    public const AMPERSAND_URL_ENCODED_FOR_HTML = '&amp;';
6004fd306cSNickeau    /**
6104fd306cSNickeau     * Used in dokuwiki syntax & in CSS attribute
6204fd306cSNickeau     * (Css attribute value are then HTML encoded as value of the attribute)
6304fd306cSNickeau     */
6404fd306cSNickeau    public const AMPERSAND_CHARACTER = "&";
6504fd306cSNickeau
6604fd306cSNickeau    const CANONICAL = "url";
6704fd306cSNickeau    /**
6804fd306cSNickeau     * The schemes that are relative (normallu only URL ? ie http, https)
6904fd306cSNickeau     * This class is much more an URI
7004fd306cSNickeau     */
7104fd306cSNickeau    const RELATIVE_URL_SCHEMES = ["http", "https"];
7204fd306cSNickeau
7304fd306cSNickeau
7404fd306cSNickeau    private ArrayCaseInsensitive $query;
7504fd306cSNickeau    private ?string $path = null;
7604fd306cSNickeau    private ?string $scheme = null;
7704fd306cSNickeau    private ?string $host = null;
7804fd306cSNickeau    private ?string $fragment = null;
7904fd306cSNickeau    /**
8004fd306cSNickeau     * @var string - original url string
8104fd306cSNickeau     */
8204fd306cSNickeau    private $url;
8304fd306cSNickeau    private ?int $port = null;
8404fd306cSNickeau    /**
8504fd306cSNickeau     * @var bool - does the URL rewrite occurs
8604fd306cSNickeau     */
8704fd306cSNickeau    private bool $withRewrite = true;
8804fd306cSNickeau
8904fd306cSNickeau
9004fd306cSNickeau    /**
9104fd306cSNickeau     * UrlUtility constructor.
9204fd306cSNickeau     * @throws ExceptionBadSyntax
9304fd306cSNickeau     * @throws ExceptionBadArgument
9404fd306cSNickeau     */
9504fd306cSNickeau    public function __construct(string $url = null)
9604fd306cSNickeau    {
9704fd306cSNickeau
9804fd306cSNickeau        $this->url = $url;
9904fd306cSNickeau        $this->query = new ArrayCaseInsensitive();
10004fd306cSNickeau        if ($this->url !== null) {
10104fd306cSNickeau            /**
10204fd306cSNickeau             *
10304fd306cSNickeau             * @var false
10404fd306cSNickeau             *
10504fd306cSNickeau             * Note: Url validation is hard with regexp
10604fd306cSNickeau             * for instance:
10704fd306cSNickeau             *  - http://example.lan/utility/a-combostrap-component-to-render-web-code-in-a-web-page-javascript-html-...-u8fe6ahw
10804fd306cSNickeau             *  - does not pass return preg_match('|^http(s)?://[a-z0-9-]+(.[a-z0-9-]+)*(:[0-9]+)?(/.*)?$|i', $url);
10904fd306cSNickeau             * of preg_match('/^https?:\/\//',$url) ? from redirect plugin
11004fd306cSNickeau             *
11104fd306cSNickeau             * We try to create the object, the object use the {@link parse_url()}
11204fd306cSNickeau             * method to validate or send an exception if it can be parsed
11304fd306cSNickeau             */
11404fd306cSNickeau            $urlComponents = parse_url($url);
11504fd306cSNickeau            if ($urlComponents === false) {
11604fd306cSNickeau                throw new ExceptionBadSyntax("The url ($url) is not valid");
11704fd306cSNickeau            }
11894bd6462Sgerardnico            $queryKeys = [];
11994bd6462Sgerardnico            $queryString = $urlComponents['query'] ?? null;
12094bd6462Sgerardnico            if ($queryString !== null) {
12194bd6462Sgerardnico                parse_str($queryString, $queryKeys);
12294bd6462Sgerardnico            }
12304fd306cSNickeau            $this->query = new ArrayCaseInsensitive($queryKeys);
124be61a7dfSgerardnico            $this->scheme = $urlComponents["scheme"] ?? null;
125be61a7dfSgerardnico            $this->host = $urlComponents["host"] ?? null;
126be61a7dfSgerardnico            $port = $urlComponents["port"] ?? null;
12704fd306cSNickeau            try {
12804fd306cSNickeau                if ($port !== null) {
12904fd306cSNickeau                    $this->port = DataType::toInteger($port);
13004fd306cSNickeau                }
13104fd306cSNickeau            } catch (ExceptionBadArgument $e) {
13204fd306cSNickeau                throw new ExceptionBadArgument("The port ($port) in ($url) is not an integer. Error: {$e->getMessage()}");
13304fd306cSNickeau            }
134be61a7dfSgerardnico            $pathUrlComponent = $urlComponents["path"] ?? null;
13504fd306cSNickeau            if ($pathUrlComponent !== null) {
13604fd306cSNickeau                $this->setPath($pathUrlComponent);
13704fd306cSNickeau            }
138be61a7dfSgerardnico            $this->fragment = $urlComponents["fragment"] ?? null;
13904fd306cSNickeau        }
14004fd306cSNickeau    }
14104fd306cSNickeau
14204fd306cSNickeau
14304fd306cSNickeau    const RESERVED_WORDS = [':', '!', '#', '$', '&', '\'', '(', ')', '*', '+', ',', '/', ';', '=', '?', '@', '[', ']'];
14404fd306cSNickeau
14504fd306cSNickeau    /**
14604fd306cSNickeau     * A text to an encoded url
14704fd306cSNickeau     * @param $string -  a string
14804fd306cSNickeau     * @param string $separator - the path separator in the string
14904fd306cSNickeau     */
15004fd306cSNickeau    public static function encodeToUrlPath($string, string $separator = WikiPath::NAMESPACE_SEPARATOR_DOUBLE_POINT): string
15104fd306cSNickeau    {
15204fd306cSNickeau        $parts = explode($separator, $string);
15304fd306cSNickeau        $encodedParts = array_map(function ($e) {
15404fd306cSNickeau            return urlencode($e);
15504fd306cSNickeau        }, $parts);
15604fd306cSNickeau        return implode("/", $encodedParts);
15704fd306cSNickeau    }
15804fd306cSNickeau
15904fd306cSNickeau    public static function createEmpty(): Url
16004fd306cSNickeau    {
16104fd306cSNickeau        return new Url();
16204fd306cSNickeau    }
16304fd306cSNickeau
16404fd306cSNickeau    /**
16504fd306cSNickeau     *
16604fd306cSNickeau     */
16704fd306cSNickeau    public static function createFromGetOrPostGlobalVariable(): Url
16804fd306cSNickeau    {
16904fd306cSNickeau        /**
17004fd306cSNickeau         * $_REQUEST is a merge between get and post property
17104fd306cSNickeau         * Shared check between post and get HTTP method
172*5b0932efSgerardnico         * managed and encapsultaed by {@link Input}.
173*5b0932efSgerardnico         * They add users and other
17404fd306cSNickeau         * {@link \TestRequest} is using it
17504fd306cSNickeau         */
17604fd306cSNickeau        $url = Url::createEmpty();
17704fd306cSNickeau        foreach ($_REQUEST as $key => $value) {
17804fd306cSNickeau            if (is_array($value)) {
17904fd306cSNickeau                foreach ($value as $subkey => $subval) {
18004fd306cSNickeau                    if (is_array($subval)) {
18104fd306cSNickeau                        if ($key !== "config") {
18204fd306cSNickeau                            // dokuwiki things
18304fd306cSNickeau                            LogUtility::warning("The key ($key) is an array of an array and was not taken into account in the request url.");
18404fd306cSNickeau                        }
18504fd306cSNickeau                        continue;
18604fd306cSNickeau                    }
187*5b0932efSgerardnico
18804fd306cSNickeau                    if ($key == "do") {
18904fd306cSNickeau                        // for whatever reason, dokuwiki puts the value in the key
19004fd306cSNickeau                        $url->addQueryParameter($key, $subkey);
19104fd306cSNickeau                        continue;
19204fd306cSNickeau                    }
19304fd306cSNickeau                    $url->addQueryParameter($key, $subval);
19404fd306cSNickeau
19504fd306cSNickeau                }
19604fd306cSNickeau            } else {
19704fd306cSNickeau                /**
19804fd306cSNickeau                 * Bad URL format test
19904fd306cSNickeau                 * In the `src` attribute of `script`, the url should not be encoded
20004fd306cSNickeau                 * with {@link Url::AMPERSAND_URL_ENCODED_FOR_HTML}
20104fd306cSNickeau                 * otherwise we get `amp;` as prefix
20204fd306cSNickeau                 * in Chrome
20304fd306cSNickeau                 */
20404fd306cSNickeau                if (strpos($key, "amp;") === 0) {
20504fd306cSNickeau                    /**
20604fd306cSNickeau                     * We don't advertise this error, it should not happen
20704fd306cSNickeau                     * and there is nothing to do to get back on its feet
20804fd306cSNickeau                     */
20904fd306cSNickeau                    $message = "The url in src has a bad encoding (the attribute have a amp; prefix. Infinite cache will not work.";
21004fd306cSNickeau                    throw new ExceptionRuntimeInternal($message);
21104fd306cSNickeau                }
212*5b0932efSgerardnico                /**
213*5b0932efSgerardnico                 * Added in {@link auth_setup}
214*5b0932efSgerardnico                 * Used by dokuwiki
215*5b0932efSgerardnico                 */
216*5b0932efSgerardnico                if (in_array($key, ['u', 'p', 'http_credentials', 'r'])) {
217*5b0932efSgerardnico                    continue;
218*5b0932efSgerardnico                }
21904fd306cSNickeau                $url->addQueryParameter($key, $value);
22004fd306cSNickeau            }
22104fd306cSNickeau        }
22204fd306cSNickeau        return $url;
22304fd306cSNickeau    }
22404fd306cSNickeau
22504fd306cSNickeau    /**
22604fd306cSNickeau     * Utility class to transform windows separator to url path separator
22704fd306cSNickeau     * @param string $pathString
22804fd306cSNickeau     * @return array|string|string[]
22904fd306cSNickeau     */
23004fd306cSNickeau    public static function toUrlSeparator(string $pathString)
23104fd306cSNickeau    {
23204fd306cSNickeau        return str_replace('\\', '/', $pathString);
23304fd306cSNickeau    }
23404fd306cSNickeau
23504fd306cSNickeau
23604fd306cSNickeau    function getQueryProperties(): array
23704fd306cSNickeau    {
23804fd306cSNickeau        return $this->query->getOriginalArray();
23904fd306cSNickeau    }
24004fd306cSNickeau
24104fd306cSNickeau    /**
24204fd306cSNickeau     * @throws ExceptionNotFound
24304fd306cSNickeau     */
24404fd306cSNickeau    function getQueryPropertyValue($key)
24504fd306cSNickeau    {
24604fd306cSNickeau        $value = $this->query[$key];
24704fd306cSNickeau        if ($value === null) {
24804fd306cSNickeau            throw new ExceptionNotFound("The key ($key) was not found");
24904fd306cSNickeau        }
25004fd306cSNickeau        return $value;
25104fd306cSNickeau    }
25204fd306cSNickeau
25304fd306cSNickeau    /**
25404fd306cSNickeau     * Extract the value of a property
25504fd306cSNickeau     * @param $propertyName
25604fd306cSNickeau     * @return string - the value of the property
25704fd306cSNickeau     * @throws ExceptionNotFound
25804fd306cSNickeau     */
25904fd306cSNickeau    public function getPropertyValue($propertyName): string
26004fd306cSNickeau    {
26104fd306cSNickeau        if (!isset($this->query[$propertyName])) {
26204fd306cSNickeau            throw new ExceptionNotFound("The property ($propertyName) was not found", self::CANONICAL);
26304fd306cSNickeau        }
26404fd306cSNickeau        return $this->query[$propertyName];
26504fd306cSNickeau    }
26604fd306cSNickeau
26704fd306cSNickeau
26804fd306cSNickeau    /**
26904fd306cSNickeau     * @throws ExceptionBadSyntax|ExceptionBadArgument
27004fd306cSNickeau     */
27104fd306cSNickeau    public static function createFromString(string $url): Url
27204fd306cSNickeau    {
27304fd306cSNickeau        return new Url($url);
27404fd306cSNickeau    }
27504fd306cSNickeau
27604fd306cSNickeau    /**
27704fd306cSNickeau     * @throws ExceptionNotFound
27804fd306cSNickeau     */
27904fd306cSNickeau    public function getScheme(): string
28004fd306cSNickeau    {
28104fd306cSNickeau        if ($this->scheme === null) {
28204fd306cSNickeau            throw new ExceptionNotFound("The scheme was not found");
28304fd306cSNickeau        }
28404fd306cSNickeau        return $this->scheme;
28504fd306cSNickeau    }
28604fd306cSNickeau
28704fd306cSNickeau    /**
28804fd306cSNickeau     * @param string $path
28904fd306cSNickeau     * @return $this
29004fd306cSNickeau     * in a https scheme: Not the path has a leading `/` that makes the path absolute
29104fd306cSNickeau     * in a email scheme: the path is the email (without /) then
29204fd306cSNickeau     */
29304fd306cSNickeau    public function setPath(string $path): Url
29404fd306cSNickeau    {
29504fd306cSNickeau
29604fd306cSNickeau        /**
29704fd306cSNickeau         * Normalization hack
29804fd306cSNickeau         */
29904fd306cSNickeau        if (strpos($path, "/./") === 0) {
30004fd306cSNickeau            $path = substr($path, 2);
30104fd306cSNickeau        }
30204fd306cSNickeau        $this->path = $path;
30304fd306cSNickeau        return $this;
30404fd306cSNickeau    }
30504fd306cSNickeau
30604fd306cSNickeau    /**
30704fd306cSNickeau     * @return bool - true if http, https scheme
30804fd306cSNickeau     */
30904fd306cSNickeau    public function isHttpUrl(): bool
31004fd306cSNickeau    {
31104fd306cSNickeau        try {
31204fd306cSNickeau            return in_array($this->getScheme(), ["http", "https"]);
31304fd306cSNickeau        } catch (ExceptionNotFound $e) {
31404fd306cSNickeau            return false;
31504fd306cSNickeau        }
31604fd306cSNickeau    }
31704fd306cSNickeau
31804fd306cSNickeau    /**
31904fd306cSNickeau     * Multiple parameter can be set to form an array
32004fd306cSNickeau     *
32104fd306cSNickeau     * Example: s=word1&s=word2
32204fd306cSNickeau     *
32304fd306cSNickeau     * https://stackoverflow.com/questions/24059773/correct-way-to-pass-multiple-values-for-same-parameter-name-in-get-request
32404fd306cSNickeau     */
32504fd306cSNickeau    public function addQueryParameter(string $key, ?string $value = null): Url
32604fd306cSNickeau    {
32704fd306cSNickeau        /**
32804fd306cSNickeau         * Php Array syntax
32904fd306cSNickeau         */
33004fd306cSNickeau        if (substr($key, -2) === "[]") {
33104fd306cSNickeau            $key = substr($key, 0, -2);
33204fd306cSNickeau            $actualValue = $this->query[$key];
33304fd306cSNickeau            if ($actualValue === null || is_array($actualValue)) {
33404fd306cSNickeau                $this->query[$key] = [$value];
33504fd306cSNickeau            } else {
33604fd306cSNickeau                $actualValue[] = $value;
33704fd306cSNickeau                $this->query[$key] = $actualValue;
33804fd306cSNickeau            }
33904fd306cSNickeau            return $this;
34004fd306cSNickeau        }
34104fd306cSNickeau        if (isset($this->query[$key])) {
34204fd306cSNickeau            $actualValue = $this->query[$key];
34304fd306cSNickeau            if (is_array($actualValue)) {
34404fd306cSNickeau                $this->query[$key][] = $value;
34504fd306cSNickeau            } else {
34604fd306cSNickeau                $this->query[$key] = [$actualValue, $value];
34704fd306cSNickeau            }
34804fd306cSNickeau        } else {
34904fd306cSNickeau            $this->query[$key] = $value;
35004fd306cSNickeau        }
35104fd306cSNickeau        return $this;
35204fd306cSNickeau    }
35304fd306cSNickeau
35404fd306cSNickeau
35504fd306cSNickeau    public function hasProperty(string $key): bool
35604fd306cSNickeau    {
35704fd306cSNickeau        if (isset($this->query[$key])) {
35804fd306cSNickeau            return true;
35904fd306cSNickeau        }
36004fd306cSNickeau        return false;
36104fd306cSNickeau    }
36204fd306cSNickeau
36304fd306cSNickeau    /**
36404fd306cSNickeau     * @return Url - add the scheme and the host based on the request if not present
36504fd306cSNickeau     */
36604fd306cSNickeau    public function toAbsoluteUrl(): Url
36704fd306cSNickeau    {
368e346390aSgerardnico        /**
369e346390aSgerardnico         * Do we have a path information
37070bbd7f1Sgerardnico         * If not, this is a local url (ie #id)
37170bbd7f1Sgerardnico         * We don't make it absolute
372e346390aSgerardnico         */
373e346390aSgerardnico        if ($this->isLocal()) {
374e346390aSgerardnico            return $this;
375e346390aSgerardnico        }
37604fd306cSNickeau        try {
37704fd306cSNickeau            $this->getScheme();
37804fd306cSNickeau        } catch (ExceptionNotFound $e) {
37904fd306cSNickeau            /**
38004fd306cSNickeau             * See {@link getBaseURL()}
38104fd306cSNickeau             */
38270bbd7f1Sgerardnico            $https = $_SERVER['HTTPS'] ?? null;
38304fd306cSNickeau            if (empty($https)) {
38404fd306cSNickeau                $this->setScheme("http");
38504fd306cSNickeau            } else {
38604fd306cSNickeau                $this->setScheme("https");
38704fd306cSNickeau            }
38804fd306cSNickeau        }
38904fd306cSNickeau        try {
39004fd306cSNickeau            $this->getHost();
39104fd306cSNickeau        } catch (ExceptionNotFound $e) {
39204fd306cSNickeau            $remoteHost = Site::getServerHost();
39304fd306cSNickeau            $this->setHost($remoteHost);
39404fd306cSNickeau
39504fd306cSNickeau        }
39604fd306cSNickeau        return $this;
39704fd306cSNickeau    }
39804fd306cSNickeau
39904fd306cSNickeau    /**
40004fd306cSNickeau     * @return string - utility function that call {@link Url::toAbsoluteUrl()} absolute and {@link Url::toString()}
40104fd306cSNickeau     */
40204fd306cSNickeau    public function toAbsoluteUrlString(): string
40304fd306cSNickeau    {
40404fd306cSNickeau        $this->toAbsoluteUrl();
40504fd306cSNickeau        return $this->toString();
40604fd306cSNickeau    }
40704fd306cSNickeau
40804fd306cSNickeau    /**
40904fd306cSNickeau     * @throws ExceptionNotFound
41004fd306cSNickeau     */
41104fd306cSNickeau    public function getHost(): string
41204fd306cSNickeau    {
41304fd306cSNickeau        if ($this->host === null) {
41404fd306cSNickeau            throw new ExceptionNotFound("No host");
41504fd306cSNickeau        }
41604fd306cSNickeau        return $this->host;
41704fd306cSNickeau    }
41804fd306cSNickeau
41904fd306cSNickeau    /**
42004fd306cSNickeau     * @throws ExceptionNotFound
42104fd306cSNickeau     */
42204fd306cSNickeau    public function getPath(): string
42304fd306cSNickeau    {
42465e00826Sgerardnico        if ($this->path === null || $this->path === '/') {
42504fd306cSNickeau            throw new ExceptionNotFound("The path was not found");
42604fd306cSNickeau        }
42704fd306cSNickeau        return $this->path;
42804fd306cSNickeau    }
42904fd306cSNickeau
43004fd306cSNickeau    /**
43104fd306cSNickeau     * @throws ExceptionNotFound
43204fd306cSNickeau     */
43304fd306cSNickeau    public function getFragment(): string
43404fd306cSNickeau    {
43504fd306cSNickeau        if ($this->fragment === null) {
43604fd306cSNickeau            throw new ExceptionNotFound("The fragment was not set");
43704fd306cSNickeau        }
43804fd306cSNickeau        return $this->fragment;
43904fd306cSNickeau    }
44004fd306cSNickeau
44104fd306cSNickeau
44204fd306cSNickeau    public function __toString()
44304fd306cSNickeau    {
44404fd306cSNickeau        return $this->toString();
44504fd306cSNickeau    }
44604fd306cSNickeau
44704fd306cSNickeau    public function getQueryPropertyValueOrDefault(string $key, string $defaultIfNull)
44804fd306cSNickeau    {
44904fd306cSNickeau        try {
45004fd306cSNickeau            return $this->getQueryPropertyValue($key);
45104fd306cSNickeau        } catch (ExceptionNotFound $e) {
45204fd306cSNickeau            return $defaultIfNull;
45304fd306cSNickeau        }
45404fd306cSNickeau    }
45504fd306cSNickeau
45604fd306cSNickeau    /**
45704fd306cSNickeau     * Actual vs expected
45804fd306cSNickeau     *
45904fd306cSNickeau     * We use this vocabulary (actual/expected) and not (internal/external or left/right) because this function
46004fd306cSNickeau     * is mostly used in a test framework.
46104fd306cSNickeau     *
46204fd306cSNickeau     * @throws ExceptionNotEquals
46304fd306cSNickeau     */
46404fd306cSNickeau    public function equals(Url $expectedUrl)
46504fd306cSNickeau    {
46604fd306cSNickeau        /**
46704fd306cSNickeau         * Scheme
46804fd306cSNickeau         */
46904fd306cSNickeau        try {
47004fd306cSNickeau            $actualScheme = $this->getScheme();
47104fd306cSNickeau        } catch (ExceptionNotFound $e) {
47204fd306cSNickeau            $actualScheme = "";
47304fd306cSNickeau        }
47404fd306cSNickeau        try {
47504fd306cSNickeau            $expectedScheme = $expectedUrl->getScheme();
47604fd306cSNickeau        } catch (ExceptionNotFound $e) {
47704fd306cSNickeau            $expectedScheme = "";
47804fd306cSNickeau        }
47904fd306cSNickeau        if ($actualScheme !== $expectedScheme) {
48004fd306cSNickeau            throw new ExceptionNotEquals("The scheme are not equals ($actualScheme vs $expectedScheme)");
48104fd306cSNickeau        }
48204fd306cSNickeau        /**
48304fd306cSNickeau         * Host
48404fd306cSNickeau         */
48504fd306cSNickeau        try {
48604fd306cSNickeau            $actualHost = $this->getHost();
48704fd306cSNickeau        } catch (ExceptionNotFound $e) {
48804fd306cSNickeau            $actualHost = "";
48904fd306cSNickeau        }
49004fd306cSNickeau        try {
49104fd306cSNickeau            $expectedHost = $expectedUrl->getHost();
49204fd306cSNickeau        } catch (ExceptionNotFound $e) {
49304fd306cSNickeau            $expectedHost = "";
49404fd306cSNickeau        }
49504fd306cSNickeau        if ($actualHost !== $expectedHost) {
49604fd306cSNickeau            throw new ExceptionNotEquals("The host are not equals ($actualHost vs $expectedHost)");
49704fd306cSNickeau        }
49804fd306cSNickeau        /**
49904fd306cSNickeau         * Query
50004fd306cSNickeau         */
50104fd306cSNickeau        $actualQuery = $this->getQueryProperties();
50204fd306cSNickeau        $expectedQuery = $expectedUrl->getQueryProperties();
50304fd306cSNickeau        foreach ($actualQuery as $key => $value) {
50404fd306cSNickeau            $expectedValue = $expectedQuery[$key];
50504fd306cSNickeau            if ($expectedValue === null) {
50604fd306cSNickeau                throw new ExceptionNotEquals("The expected url does not have the $key property");
50704fd306cSNickeau            }
50804fd306cSNickeau            if ($expectedValue !== $value) {
50904fd306cSNickeau                throw new ExceptionNotEquals("The $key property does not have the same value ($value vs $expectedValue)");
51004fd306cSNickeau            }
51104fd306cSNickeau            unset($expectedQuery[$key]);
51204fd306cSNickeau        }
51304fd306cSNickeau        foreach ($expectedQuery as $key => $value) {
51404fd306cSNickeau            throw new ExceptionNotEquals("The expected URL has an extra property ($key=$value)");
51504fd306cSNickeau        }
51604fd306cSNickeau
51704fd306cSNickeau        /**
51804fd306cSNickeau         * Fragment
51904fd306cSNickeau         */
52004fd306cSNickeau        try {
52104fd306cSNickeau            $actualFragment = $this->getFragment();
52204fd306cSNickeau        } catch (ExceptionNotFound $e) {
52304fd306cSNickeau            $actualFragment = "";
52404fd306cSNickeau        }
52504fd306cSNickeau        try {
52604fd306cSNickeau            $expectedFragment = $expectedUrl->getFragment();
52704fd306cSNickeau        } catch (ExceptionNotFound $e) {
52804fd306cSNickeau            $expectedFragment = "";
52904fd306cSNickeau        }
53004fd306cSNickeau        if ($actualFragment !== $expectedFragment) {
53104fd306cSNickeau            throw new ExceptionNotEquals("The fragment are not equals ($actualFragment vs $expectedFragment)");
53204fd306cSNickeau        }
53304fd306cSNickeau
53404fd306cSNickeau    }
53504fd306cSNickeau
53604fd306cSNickeau    public function setScheme(string $scheme): Url
53704fd306cSNickeau    {
53804fd306cSNickeau        $this->scheme = $scheme;
53904fd306cSNickeau        return $this;
54004fd306cSNickeau    }
54104fd306cSNickeau
54204fd306cSNickeau    public function setHost($host): Url
54304fd306cSNickeau    {
54404fd306cSNickeau        $this->host = $host;
54504fd306cSNickeau        return $this;
54604fd306cSNickeau    }
54704fd306cSNickeau
54862e890e0Sgerardnico    /**
54962e890e0Sgerardnico     * @param string $fragment
55062e890e0Sgerardnico     * @return $this
55162e890e0Sgerardnico     * Example `#step:11:24728`, this fragment is valid!
55262e890e0Sgerardnico     */
55304fd306cSNickeau    public function setFragment(string $fragment): Url
55404fd306cSNickeau    {
55504fd306cSNickeau        $this->fragment = $fragment;
55604fd306cSNickeau        return $this;
55704fd306cSNickeau    }
55804fd306cSNickeau
55904fd306cSNickeau    /**
56004fd306cSNickeau     * @throws ExceptionNotFound
56104fd306cSNickeau     */
56204fd306cSNickeau    public function getQueryString($ampersand = Url::AMPERSAND_CHARACTER): string
56304fd306cSNickeau    {
56404fd306cSNickeau        if (sizeof($this->query) === 0) {
56504fd306cSNickeau            throw new ExceptionNotFound("No Query string");
56604fd306cSNickeau        }
56704fd306cSNickeau        /**
56804fd306cSNickeau         * To be able to diff them
56904fd306cSNickeau         */
57004fd306cSNickeau        $originalArray = $this->query->getOriginalArray();
57104fd306cSNickeau        ksort($originalArray);
57204fd306cSNickeau
57304fd306cSNickeau        /**
57404fd306cSNickeau         * We don't use {@link http_build_query} because:
57504fd306cSNickeau         *   * it does not the follow the array format (ie s[]=searchword1+seachword2)
57604fd306cSNickeau         *   * it output 'key=' instead of `key` when the value is null
57704fd306cSNickeau         */
57804fd306cSNickeau        $queryString = null;
57904fd306cSNickeau        foreach ($originalArray as $key => $value) {
58004fd306cSNickeau            if ($queryString !== null) {
58104fd306cSNickeau                /**
58204fd306cSNickeau                 * HTML encoding (ie {@link self::AMPERSAND_URL_ENCODED_FOR_HTML}
58304fd306cSNickeau                 * happens only when outputing to HTML
58404fd306cSNickeau                 * The url may also be used elsewhere where &amp; is unknown or not wanted such as css ...
58504fd306cSNickeau                 *
58604fd306cSNickeau                 * In test, we may ask the url HTML encoded
58704fd306cSNickeau                 */
58804fd306cSNickeau                $queryString .= $ampersand;
58904fd306cSNickeau            }
59004fd306cSNickeau            if ($value === null) {
59104fd306cSNickeau                $queryString .= urlencode($key);
59204fd306cSNickeau            } else {
59304fd306cSNickeau                if (is_array($value)) {
59404fd306cSNickeau                    for ($i = 0; $i < sizeof($value); $i++) {
59504fd306cSNickeau                        $val = $value[$i];
59604fd306cSNickeau                        if ($i > 0) {
59704fd306cSNickeau                            $queryString .= self::AMPERSAND_CHARACTER;
59804fd306cSNickeau                        }
59904fd306cSNickeau                        $queryString .= urlencode($key) . "[]=" . urlencode($val);
60004fd306cSNickeau                    }
60104fd306cSNickeau                } else {
60204fd306cSNickeau                    $queryString .= urlencode($key) . "=" . urlencode($value);
60304fd306cSNickeau                }
60404fd306cSNickeau            }
60504fd306cSNickeau        }
60604fd306cSNickeau        return $queryString;
60704fd306cSNickeau
60804fd306cSNickeau
60904fd306cSNickeau    }
61004fd306cSNickeau
61104fd306cSNickeau    /**
61204fd306cSNickeau     * @throws ExceptionNotFound
61304fd306cSNickeau     */
61404fd306cSNickeau    public function getQueryPropertyValueAndRemoveIfPresent(string $key)
61504fd306cSNickeau    {
61604fd306cSNickeau        $value = $this->getQueryPropertyValue($key);
61704fd306cSNickeau        unset($this->query[$key]);
61804fd306cSNickeau        return $value;
61904fd306cSNickeau    }
62004fd306cSNickeau
62104fd306cSNickeau
62204fd306cSNickeau    /**
62304fd306cSNickeau     * @throws ExceptionNotFound
62404fd306cSNickeau     */
62504fd306cSNickeau    function getLastName(): string
62604fd306cSNickeau    {
62704fd306cSNickeau        $names = $this->getNames();
62804fd306cSNickeau        $namesCount = count($names);
62904fd306cSNickeau        if ($namesCount === 0) {
63004fd306cSNickeau            throw new ExceptionNotFound("No last name");
63104fd306cSNickeau        }
63204fd306cSNickeau        return $names[$namesCount - 1];
63304fd306cSNickeau
63404fd306cSNickeau    }
63504fd306cSNickeau
63604fd306cSNickeau    /**
63704fd306cSNickeau     * @return string
63804fd306cSNickeau     * @throws ExceptionNotFound
63904fd306cSNickeau     */
64004fd306cSNickeau    public function getExtension(): string
64104fd306cSNickeau    {
64270bbd7f1Sgerardnico        if ($this->hasProperty(MediaMarkup::$MEDIA_QUERY_PARAMETER)) {
64304fd306cSNickeau
64404fd306cSNickeau            try {
64504fd306cSNickeau                return FetcherSystem::createPathFetcherFromUrl($this)->getMime()->getExtension();
64604fd306cSNickeau            } catch (ExceptionCompile $e) {
64704fd306cSNickeau                LogUtility::internalError("Build error from a Media Fetch URL. We were unable to get the mime. Error: {$e->getMessage()}");
64804fd306cSNickeau            }
64904fd306cSNickeau
65004fd306cSNickeau        }
65104fd306cSNickeau        return parent::getExtension();
65204fd306cSNickeau    }
65304fd306cSNickeau
65404fd306cSNickeau
65504fd306cSNickeau    function getNames()
65604fd306cSNickeau    {
65704fd306cSNickeau
65804fd306cSNickeau        try {
65904fd306cSNickeau            $names = explode(self::PATH_SEP, $this->getPath());
66004fd306cSNickeau            return array_slice($names, 1);
66104fd306cSNickeau        } catch (ExceptionNotFound $e) {
66204fd306cSNickeau            return [];
66304fd306cSNickeau        }
66404fd306cSNickeau
66504fd306cSNickeau    }
66604fd306cSNickeau
66704fd306cSNickeau    /**
66804fd306cSNickeau     * @throws ExceptionNotFound
66904fd306cSNickeau     */
67004fd306cSNickeau    function getParent(): Url
67104fd306cSNickeau    {
67204fd306cSNickeau        $names = $this->getNames();
67304fd306cSNickeau        $count = count($names);
67404fd306cSNickeau        if ($count === 0) {
67504fd306cSNickeau            throw new ExceptionNotFound("No Parent");
67604fd306cSNickeau        }
67704fd306cSNickeau        $parentPath = implode(self::PATH_SEP, array_splice($names, 0, $count - 1));
67804fd306cSNickeau        return $this->setPath($parentPath);
67904fd306cSNickeau    }
68004fd306cSNickeau
68104fd306cSNickeau    function toAbsoluteId(): string
68204fd306cSNickeau    {
68304fd306cSNickeau        try {
68404fd306cSNickeau            return $this->getPath();
68504fd306cSNickeau        } catch (ExceptionNotFound $e) {
68604fd306cSNickeau            return "";
68704fd306cSNickeau        }
68804fd306cSNickeau    }
68904fd306cSNickeau
69004fd306cSNickeau    function toAbsolutePath(): Url
69104fd306cSNickeau    {
69204fd306cSNickeau        return $this->toAbsoluteUrl();
69304fd306cSNickeau    }
69404fd306cSNickeau
69504fd306cSNickeau    function resolve(string $name): Url
69604fd306cSNickeau    {
69704fd306cSNickeau        try {
69804fd306cSNickeau            $path = $this->getPath();
69904fd306cSNickeau            if ($this->path[strlen($path) - 1] === URL::PATH_SEP) {
70004fd306cSNickeau                $this->path .= $name;
70104fd306cSNickeau            } else {
70204fd306cSNickeau                $this->path .= URL::PATH_SEP . $name;
70304fd306cSNickeau            }
70404fd306cSNickeau            return $this;
70504fd306cSNickeau        } catch (ExceptionNotFound $e) {
70604fd306cSNickeau            $this->setPath($name);
70704fd306cSNickeau            return $this;
70804fd306cSNickeau        }
70904fd306cSNickeau
71004fd306cSNickeau    }
71104fd306cSNickeau
71204fd306cSNickeau    /**
71304fd306cSNickeau     * @param string $ampersand
71404fd306cSNickeau     * @return string
71504fd306cSNickeau     */
71604fd306cSNickeau    public function toString(string $ampersand = Url::AMPERSAND_CHARACTER): string
71704fd306cSNickeau    {
71804fd306cSNickeau
71904fd306cSNickeau        try {
72004fd306cSNickeau            $scheme = $this->getScheme();
72104fd306cSNickeau        } catch (ExceptionNotFound $e) {
72204fd306cSNickeau            $scheme = null;
72304fd306cSNickeau        }
72404fd306cSNickeau
72504fd306cSNickeau
72604fd306cSNickeau        switch ($scheme) {
72704fd306cSNickeau            case LocalFileSystem::SCHEME:
72804fd306cSNickeau                /**
72904fd306cSNickeau                 * file://host/path
73004fd306cSNickeau                 */
73104fd306cSNickeau                $base = "$scheme://";
73204fd306cSNickeau                try {
73304fd306cSNickeau                    $base = "$base{$this->getHost()}";
73404fd306cSNickeau                } catch (ExceptionNotFound $e) {
73504fd306cSNickeau                    // no host
73604fd306cSNickeau                }
73704fd306cSNickeau                try {
73804fd306cSNickeau                    $path = $this->getAbsolutePath();
73904fd306cSNickeau                    // linux, network share (file://host/path)
74004fd306cSNickeau                    $base = "$base{$path}";
74104fd306cSNickeau                } catch (ExceptionNotFound $e) {
74204fd306cSNickeau                    // no path
74304fd306cSNickeau                }
74404fd306cSNickeau                return $base;
74504fd306cSNickeau            case "mailto":
74604fd306cSNickeau            case "whatsapp":
74704fd306cSNickeau            case "skype":
74804fd306cSNickeau                /**
74904fd306cSNickeau                 * Skype. Example: skype:echo123?call
75004fd306cSNickeau                 * https://docs.microsoft.com/en-us/skype-sdk/skypeuris/skypeuris
75104fd306cSNickeau                 * Mailto: Example: mailto:java-net@java.sun.com?subject=yolo
75204fd306cSNickeau                 * https://datacadamia.com/marketing/email/mailto
75304fd306cSNickeau                 */
75404fd306cSNickeau                $base = "$scheme:";
75504fd306cSNickeau                try {
75604fd306cSNickeau                    $base = "$base{$this->getPath()}";
75704fd306cSNickeau                } catch (ExceptionNotFound $e) {
75804fd306cSNickeau                    // no path
75904fd306cSNickeau                }
76004fd306cSNickeau                try {
76104fd306cSNickeau                    $base = "$base?{$this->getQueryString()}";
76204fd306cSNickeau                } catch (ExceptionNotFound $e) {
76304fd306cSNickeau                    // no query string
76404fd306cSNickeau                }
76504fd306cSNickeau                try {
76604fd306cSNickeau                    $base = "$base#{$this->getFragment()}";
76704fd306cSNickeau                } catch (ExceptionNotFound $e) {
76804fd306cSNickeau                    // no fragment
76904fd306cSNickeau                }
77004fd306cSNickeau                return $base;
77104fd306cSNickeau            case "http":
77204fd306cSNickeau            case "https":
77304fd306cSNickeau            case "ftp":
77404fd306cSNickeau            default:
77504fd306cSNickeau                /**
77604fd306cSNickeau                 * Url Rewrite
77704fd306cSNickeau                 * Absolute vs Relative, __media, ...
77804fd306cSNickeau                 */
77904fd306cSNickeau                if ($this->withRewrite) {
78004fd306cSNickeau                    UrlRewrite::rewrite($this);
78104fd306cSNickeau                }
78204fd306cSNickeau                /**
78304fd306cSNickeau                 * Rewrite may have set a default scheme
78404fd306cSNickeau                 * We read it again
78504fd306cSNickeau                 */
78604fd306cSNickeau                try {
78704fd306cSNickeau                    $scheme = $this->getScheme();
78804fd306cSNickeau                } catch (ExceptionNotFound $e) {
78904fd306cSNickeau                    $scheme = null;
79004fd306cSNickeau                }
79104fd306cSNickeau                try {
79204fd306cSNickeau                    $host = $this->getHost();
79304fd306cSNickeau                } catch (ExceptionNotFound $e) {
79404fd306cSNickeau                    $host = null;
79504fd306cSNickeau                }
79604fd306cSNickeau                /**
79704fd306cSNickeau                 * Absolute/Relative Uri
79804fd306cSNickeau                 */
79904fd306cSNickeau                $base = "";
80004fd306cSNickeau                if ($host !== null) {
80104fd306cSNickeau                    if ($scheme !== null) {
80204fd306cSNickeau                        $base = "{$scheme}://";
80304fd306cSNickeau                    }
80404fd306cSNickeau                    $base = "$base{$host}";
80504fd306cSNickeau                    try {
80604fd306cSNickeau                        $base = "$base:{$this->getPort()}";
80704fd306cSNickeau                    } catch (ExceptionNotFound $e) {
80804fd306cSNickeau                        // no port
80904fd306cSNickeau                    }
81004fd306cSNickeau                } else {
81104fd306cSNickeau                    if (!in_array($scheme, self::RELATIVE_URL_SCHEMES) && $scheme !== null) {
81204fd306cSNickeau                        $base = "{$scheme}:";
81304fd306cSNickeau                    }
81404fd306cSNickeau                }
81504fd306cSNickeau
81604fd306cSNickeau                try {
81704fd306cSNickeau                    $base = "$base{$this->getAbsolutePath()}";
81804fd306cSNickeau                } catch (ExceptionNotFound $e) {
81904fd306cSNickeau                    // ok
82004fd306cSNickeau                }
82104fd306cSNickeau
82204fd306cSNickeau                try {
82304fd306cSNickeau                    $base = "$base?{$this->getQueryString($ampersand)}";
82404fd306cSNickeau                } catch (ExceptionNotFound $e) {
82504fd306cSNickeau                    // ok
82604fd306cSNickeau                }
82704fd306cSNickeau
82804fd306cSNickeau                try {
82904fd306cSNickeau                    $base = "$base#{$this->getFragment()}";
83004fd306cSNickeau                } catch (ExceptionNotFound $e) {
83104fd306cSNickeau                    // ok
83204fd306cSNickeau                }
83304fd306cSNickeau                return $base;
83404fd306cSNickeau        }
83504fd306cSNickeau
83604fd306cSNickeau
83704fd306cSNickeau    }
83804fd306cSNickeau
83904fd306cSNickeau    /**
84004fd306cSNickeau     * Query parameter can have several values
84104fd306cSNickeau     * This function makes sure that there is only one value for one key
84204fd306cSNickeau     * if the value are different, the value will be added
84304fd306cSNickeau     * @param string $key
84404fd306cSNickeau     * @param string $value
84504fd306cSNickeau     * @return Url
84604fd306cSNickeau     */
84704fd306cSNickeau    public function addQueryParameterIfNotActualSameValue(string $key, string $value): Url
84804fd306cSNickeau    {
84904fd306cSNickeau        try {
85004fd306cSNickeau            $actualValue = $this->getQueryPropertyValue($key);
85104fd306cSNickeau            if ($actualValue !== $value) {
85204fd306cSNickeau                $this->addQueryParameter($key, $value);
85304fd306cSNickeau            }
85404fd306cSNickeau        } catch (ExceptionNotFound $e) {
85504fd306cSNickeau            $this->addQueryParameter($key, $value);
85604fd306cSNickeau        }
85704fd306cSNickeau
85804fd306cSNickeau        return $this;
85904fd306cSNickeau
86004fd306cSNickeau    }
86104fd306cSNickeau
86204fd306cSNickeau    function getUrl(): Url
86304fd306cSNickeau    {
86404fd306cSNickeau        return $this;
86504fd306cSNickeau    }
86604fd306cSNickeau
86704fd306cSNickeau    public function toHtmlString(): string
86804fd306cSNickeau    {
86904fd306cSNickeau        return $this->toString(Url::AMPERSAND_URL_ENCODED_FOR_HTML);
87004fd306cSNickeau    }
87104fd306cSNickeau
87204fd306cSNickeau    /**
87304fd306cSNickeau     * @throws ExceptionNotFound
87404fd306cSNickeau     */
87504fd306cSNickeau    private function getPort(): int
87604fd306cSNickeau    {
87704fd306cSNickeau        if ($this->port === null) {
87804fd306cSNickeau            throw new ExceptionNotFound("No port specified");
87904fd306cSNickeau        }
88004fd306cSNickeau        return $this->port;
88104fd306cSNickeau    }
88204fd306cSNickeau
88304fd306cSNickeau    public function addQueryParameterIfNotPresent(string $key, string $value)
88404fd306cSNickeau    {
88504fd306cSNickeau        if (!$this->hasProperty($key)) {
88604fd306cSNickeau            $this->addQueryParameterIfNotActualSameValue($key, $value);
88704fd306cSNickeau        }
88804fd306cSNickeau    }
88904fd306cSNickeau
89004fd306cSNickeau    /**
89104fd306cSNickeau     * Set/replace a query parameter with the new value
89204fd306cSNickeau     * @param string $key
89304fd306cSNickeau     * @param string $value
89404fd306cSNickeau     * @return Url
89504fd306cSNickeau     */
89604fd306cSNickeau    public function setQueryParameter(string $key, string $value): Url
89704fd306cSNickeau    {
89804fd306cSNickeau        $this->deleteQueryParameter($key);
89904fd306cSNickeau        $this->addQueryParameter($key, $value);
90004fd306cSNickeau        return $this;
90104fd306cSNickeau    }
90204fd306cSNickeau
90304fd306cSNickeau    public function deleteQueryParameter(string $key)
90404fd306cSNickeau    {
90504fd306cSNickeau        unset($this->query[$key]);
90604fd306cSNickeau    }
90704fd306cSNickeau
90804fd306cSNickeau    /**
90904fd306cSNickeau     * @return string - An url in the DOM use the ampersand character
91004fd306cSNickeau     * If you want to check the value of a DOM attribute, you need to check it with this value
91104fd306cSNickeau     */
91204fd306cSNickeau    public function toDomString(): string
91304fd306cSNickeau    {
91404fd306cSNickeau        // ampersand for dom string
91504fd306cSNickeau        return $this->toString();
91604fd306cSNickeau    }
91704fd306cSNickeau
91804fd306cSNickeau    public function toCssString(): string
91904fd306cSNickeau    {
92004fd306cSNickeau        // ampersand for css
92104fd306cSNickeau        return $this->toString();
92204fd306cSNickeau    }
92304fd306cSNickeau
92404fd306cSNickeau    /**
92504fd306cSNickeau     * @return bool - if the url points to the same website than the host
92604fd306cSNickeau     */
92704fd306cSNickeau    public function isExternal(): bool
92804fd306cSNickeau    {
92904fd306cSNickeau        try {
93070bbd7f1Sgerardnico            // We set the path, otherwise it's seen as a local url
93170bbd7f1Sgerardnico            $localHost = Url::createEmpty()->setPath("/")->toAbsoluteUrl()->getHost();
93204fd306cSNickeau            return $localHost !== $this->getHost();
93304fd306cSNickeau        } catch (ExceptionNotFound $e) {
93404fd306cSNickeau            // no host meaning that the url is relative and then local
93504fd306cSNickeau            return false;
93604fd306cSNickeau        }
93704fd306cSNickeau    }
93804fd306cSNickeau
93904fd306cSNickeau    /**
94004fd306cSNickeau     * In a url, in a case, the path should be absolute
94104fd306cSNickeau     * This function makes it absolute if not.
94204fd306cSNickeau     * In case of messaging scheme (mailto, whatsapp, ...), this is not the case
94304fd306cSNickeau     * @throws ExceptionNotFound
94404fd306cSNickeau     */
94504fd306cSNickeau    private function getAbsolutePath(): string
94604fd306cSNickeau    {
94704fd306cSNickeau        $pathString = $this->getPath();
94804fd306cSNickeau        if ($pathString[0] !== "/") {
94904fd306cSNickeau            return "/{$pathString}";
95004fd306cSNickeau        }
95104fd306cSNickeau        return $pathString;
95204fd306cSNickeau    }
95304fd306cSNickeau
95404fd306cSNickeau
95504fd306cSNickeau    /**
95604fd306cSNickeau     * @throws ExceptionBadSyntax
95704fd306cSNickeau     * @throws ExceptionBadArgument
95804fd306cSNickeau     */
95904fd306cSNickeau    public static function createFromUri(string $uri): Path
96004fd306cSNickeau    {
96104fd306cSNickeau        return new Url($uri);
96204fd306cSNickeau    }
96304fd306cSNickeau
96404fd306cSNickeau    public function deleteQueryProperties(): Url
96504fd306cSNickeau    {
96604fd306cSNickeau        $this->query = new ArrayCaseInsensitive();;
96704fd306cSNickeau        return $this;
96804fd306cSNickeau    }
96904fd306cSNickeau
97004fd306cSNickeau    public function withoutRewrite(): Url
97104fd306cSNickeau    {
97204fd306cSNickeau        $this->withRewrite = false;
97304fd306cSNickeau        return $this;
97404fd306cSNickeau    }
97504fd306cSNickeau
976e346390aSgerardnico    /**
977e346390aSgerardnico     * Dokuwiki utility to check if the URL is local
97870bbd7f1Sgerardnico     * (ie has not path, only a fragment such as #id)
979e346390aSgerardnico     * @return bool
980e346390aSgerardnico     */
981e346390aSgerardnico    public function isLocal(): bool
982e346390aSgerardnico    {
983e346390aSgerardnico        if ($this->path !== null) {
984e346390aSgerardnico            return false;
985e346390aSgerardnico        }
986e346390aSgerardnico        /**
987e346390aSgerardnico         * The path paramater of Dokuwiki
988e346390aSgerardnico         */
989e346390aSgerardnico        if ($this->hasProperty(DokuwikiId::DOKUWIKI_ID_ATTRIBUTE)) {
990e346390aSgerardnico            return false;
991e346390aSgerardnico        }
99270bbd7f1Sgerardnico        if ($this->hasProperty(MediaMarkup::$MEDIA_QUERY_PARAMETER)) {
993e346390aSgerardnico            return false;
994e346390aSgerardnico        }
995e346390aSgerardnico        if ($this->hasProperty(FetcherRawLocalPath::SRC_QUERY_PARAMETER)) {
996e346390aSgerardnico            return false;
997e346390aSgerardnico        }
998e346390aSgerardnico        return true;
999e346390aSgerardnico    }
1000e346390aSgerardnico
1001e346390aSgerardnico
100204fd306cSNickeau}
1003