Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:126845
Content-Type: text/plain;
	charset=utf-8
Precedence: bulk
Mime-Version: 1.0 (Mac OS X Mail 16.0 \(3826.400.131.1.6\))
Subject: Re: [PHP-DEV] [RFC] [Discussion] Add WHATWG compliant URL parsing API
In-Reply-To: <CAH5C8xVGDhDgLp0QWabx6BudAvRAcF9sVt+gR0R0C-bF3E1hRw@mail.gmail.com>
Date: Wed, 19 Mar 2025 10:13:42 -0500
Cc: PHP Internals List <internals@lists.php.net>
Content-Transfer-Encoding: quoted-printable
Message-ID: <A465491B-0F03-46D4-AE10-550DF336FDE8@pmjones.io>
References: <CAH5C8xUb1O20ZDrOQNC=ckFxHUUWSK7sw_njQQzFBd0qgQqoww@mail.gmail.com>
 <dd61999c-1ebd-4765-9add-cd8065968965@gmail.com>
 <CAOV5rgYZ_s1of-igLFEK7oqqh6=3HeYv0=JvvKvvjkcp0F6Q9Q@mail.gmail.com>
 <CAH5C8xV67frqOBCvLt73RM7QO86_pu40sHP5h71_kDRbKPtA8Q@mail.gmail.com>
 <1BCB4144-231D-45EA-A914-98EE8F0F503A@automattic.com>
 <8E614C9C-BA85-45D8-9A4E-A30D69981C5D@automattic.com>
 <CAH5C8xV69pHnSKWJrVB8EQab7vPhcaXAwYezoG6z3Oj7ZkXBaQ@mail.gmail.com>
 <bc5472e39bc607e2c7accc9d2bd6f239@bastelstu.be>
 <9bf11a89-39d9-457b-b0ea-789fd07d7370@gmail.com>
 <CAH5C8xWnoytE=jm1sxr-HcSZFzmG8SrzghinmBZa-QyGqN4uUg@mail.gmail.com>
 <6430b9ed-638d-4247-9fa9-d1a9148c382b@gmail.com>
 <CAH5C8xX3tCS3B3z2YFbRudCXi=ZNHE0scrmoFO7cXxU773EfpA@mail.gmail.com>
 <1FD11284-D682-4CB7-893F-D74A1904610D@pmjones.io>
 <CAH5C8xVGDhDgLp0QWabx6BudAvRAcF9sVt+gR0R0C-bF3E1hRw@mail.gmail.com>
To: =?utf-8?B?TcOhdMOpIEtvY3Npcw==?= <kocsismate90@gmail.com>
From: pmjones@pmjones.io ("Paul M. Jones")

Hi Mat=C3=A9,

> On Mar 18, 2025, at 15:15, M=C3=A1t=C3=A9 Kocsis =
<kocsismate90@gmail.com> wrote:

>=20

> There's no way I would have written an implementation from scratch. =
I'm using the url module of the Lexbor C library =
(https://github.com/lexbor/lexbor/) for handling WHATWG URLs. It's =
already bundled in core, and it's also battle tested, and it has =
exceptional maintenance.

I did not mean to imply writing a parser from scratch; my apologies for =
phrasing it poorly.

> All I had to implement is the glue between userland and the C library.

That is more what I was getting at. Rowbot has a lot of what looks to be =
good design work on structures that come out of the parsing, in addition =
to a separate parser class.

The RFC might benefit from an explicit and intentional review of, and =
maybe incorporation of, some of the pre-existing Rowbot design work. At =
least one thing from Rowbot is absolutely not applicable to the RFC =
(e.g. the PSR-3 logging); maybe none of rest of it will be applicable =
either, but as prior art from someone acknowledged in the WHATWG-URL =
spec, I think it bears your close attention.

As an overview, the following is a brief comparison between Rowbot and =
the RFC; any missed or misrepresented functionality is unintentional.

* * *

## RFC

One non-final readonly Url class:

- 5 getRaw...() methods, 8 get...() methods, and one get...ForDisplay() =
method
- immutability via 8 with...() methods, broadly expecting =
properly-encoded arguments, and soft-erroring on invalid characters
- a static parse() method, with relative parsing capability and a place =
to capture errors
- equals() to compare two URLs
- toString() for machine-friendly string recomoposition
- toDisplayString() for human-friendly string recomposition
- resolve() to resolve a relative URL using the current URL as the base
- serialize/deserialize; "the serialized form only includes the =
recomposed URI itself exposed as the `__uri` field, but the individual =
properties or URI components are not present."
- no URLSearchParams implementation

## Rowbot

(None of the classes are readonly or final; these look to hew closely to =
the WHATWG-URL spec.)

A BasicURLParser class:

- affords relative parsing capability and an option parameter for the =
target URLRecord
- returns a URLRecord

A URLRecord class:

- public mutable properties for the URL components
- $scheme is a Scheme implementation with equals() and other is...() =
methods
- $host is a HostInterface (and implementations) with equals() and other =
is...() methods
- $path is a PathInterface (and PathList implementation) with =
PathSegment manipulation methods
- setUsername() and setPassword() mutators
- serializing
- getOrigin(), includesCredentials(), isEqual()

A URL class:

- Composed of a URLRecord and a URLSearchParams object
- Constructor takes a string, parses it to a URLRecord, and retains the =
URLRecord
- a static parse() method with relative parsing, as a convenience method
- __toString() and toString() return the serialized URLRecord
- Virtual properties for $href, $origin, $protocol, $username, =
$password, $host, $hostname, $port, $pathname, $search, $searchParams, =
$hash
- Mutability of virtual properties via magic __set()
- Readability of virtual properties via magic __get()

A URLSearchParams class:

- search params manipulation methods
- implements Countable, Iterator, Stringable
- composed of a QueryList implementation and (optionally) the =
originating URLRecord

* * *


-- pmj