jeremykendall/php-domain-parser

Public Suffix List based URL parsing implemented in PHP.

Installs: 146 226

Dependents: 11

Stars: 279

Watchers: 21

Forks: 29

Open Issues: 6

Language: PHP

3.0.0 2015-03-30 12:49 UTC

README

PHP Domain Parser is a Public Suffix List based domain parser implemented in PHP.

Build Status Total Downloads Latest Stable Version

Motivation

While there are plenty of excellent URL parsers and builders available, there are very few projects that can accurately parse a url into its component subdomain, registerable domain, and public suffix parts.

Consider the domain www.pref.okinawa.jp. In this domain, the public suffix portion is okinawa.jp, the registerable domain is pref.okinawa.jp, and the subdomain is www. You can't regex that.

Other similar libraries focus primarily on URL building, parsing, and manipulation and additionally include public suffix domain parsing. PHP Domain Parser was built around accurate Public Suffix List based parsing from the very beginning, adding a URL object simply for the sake of completeness.

Installation

The only (currently) supported method of installation is via Composer.

Create a composer.json file in the root of your project:

{
    "require": {
        "jeremykendall/php-domain-parser": "~2.0"
    }
}

And then run: composer install

Add the autoloader to your project:

<?php

require_once 'vendor/autoload.php'

You're now ready to begin using the PHP Domain Parser.

Usage

Parsing URLs

Parsing URLs into their component parts is as simple as the example you see below.

<?php

require_once '../vendor/autoload.php';

$pslManager = new Pdp\PublicSuffixListManager();
$parser = new Pdp\Parser($pslManager->getList());
$host = 'http://user:pass@www.pref.okinawa.jp:8080/path/to/page.html?query=string#fragment';
$url = $parser->parseUrl($host);
var_dump($url);

The above will output:

class Pdp\Uri\Url#6 (8) {
    private $scheme =>
    string(4) "http"
    private $host =>
    class Pdp\Uri\Url\Host#5 (3) {
        private $subdomain =>
        string(3) "www"
        private $registerableDomain =>
        string(15) "pref.okinawa.jp"
        private $publicSuffix =>
        string(10) "okinawa.jp"
    }
    private $port =>
    int(8080)
    private $user =>
    string(4) "user"
    private $pass =>
    string(4) "pass"
    private $path =>
    string(18) "/path/to/page.html"
    private $query =>
    string(12) "query=string"
    private $fragment =>
    string(8) "fragment"
}

Convenience Methods

A magic __get() method is provided to access the above object properties. Obtaining the public suffix for a parsed domain is as simple as:

<?php

$host = 'waxaudio.com.au';
$url = $parser->parseUrl($host);
$publicSuffix = $url->host->publicSuffix;

// $publicSuffix = 'com.au'

IDNA Support

IDN (Internationalized Domain Name) support was added in version 1.4.0. Both unicode domains and their ASCII equivalents are supported.

IMPORTANT:

Unicode

Parsing IDNA hosts is no different that parsing standard hosts. Setting $host = 'Яндекс.РФ'; (Russian-Cyrillic) in the Parsing URLs example would return:

class Pdp\Uri\Url#6 (8) {
  private $scheme =>
  string(0) ""
  private $host =>
  class Pdp\Uri\Url\Host#5 (4) {
    private $subdomain =>
    NULL
    private $registerableDomain =>
    string(17) "яндекс.рф"
    private $publicSuffix =>
    string(4) "рф"
    private $host =>
    string(17) "яндекс.рф"
  }
  private $port =>
  NULL
  private $user =>
  NULL
  private $pass =>
  NULL
  private $path =>
  NULL
  private $query =>
  NULL
  private $fragment =>
  NULL
}
ASCII (Punycode)

If you choose to provide the ASCII equivalent of the unicode domain name ($host = 'http://xn--d1acpjx3f.xn--p1ai'; in the case of the Parsing URLs example), the ASCII equivalent will be returned by the parser:

class Pdp\Uri\Url#6 (8) {
  private $scheme =>
  string(4) "http"
  private $host =>
  class Pdp\Uri\Url\Host#5 (4) {
    private $subdomain =>
    NULL
    private $registerableDomain =>
    string(22) "xn--d1acpjx3f.xn--p1ai"
    private $publicSuffix =>
    string(8) "xn--p1ai"
    private $host =>
    string(22) "xn--d1acpjx3f.xn--p1ai"
  }
  private $port =>
  NULL
  private $user =>
  NULL
  private $pass =>
  NULL
  private $path =>
  NULL
  private $query =>
  NULL
  private $fragment =>
  NULL
}

IPv6 Support

Parsing IPv6 hosts is no different that parsing standard hosts. Setting $host = 'http://[2001:db8:85a3:8d3:1319:8a2e:370:7348]:8080/'; in the Parsing URLs example would return:

class Pdp\Uri\Url#6 (8) {
  private $scheme =>
  string(4) "http"
  private $host =>
  class Pdp\Uri\Url\Host#5 (4) {
    private $subdomain =>
    NULL
    private $registerableDomain =>
    NULL
    private $publicSuffix =>
    NULL
    private $host =>
    string(38) "[2001:db8:85a3:8d3:1319:8a2e:370:7348]"
  }
  private $port =>
  string(4) "8080"
  private $user =>
  NULL
  private $pass =>
  NULL
  private $path =>
  string(1) "/"
  private $query =>
  NULL
  private $fragment =>
  NULL
}

IMPORTANT: IPv6 url host names must be enclosed in square brackets. They will not be parsed properly otherwise.

Hat tip to @geekwright for adding IPv6 support in a bugfix pull request.

Parsing Domains

If you'd like to parse the domain (or host) portion only, you can use Parser::parseHost().

<?php

$host = $parser->parseHost('a.b.c.cy');
var_dump($host);

The above will output:

class Pdp\Uri\Url\Host#7 (3) {
    private $subdomain =>
    string(1) "a"
    private $registerableDomain =>
    string(6) "b.c.cy"
    private $publicSuffix =>
    string(4) "c.cy"
}

Validation of Public Suffixes

Public Suffix validation is available by calling Parser::isSuffixValid():

var_dump($parser->isSuffixValid('www.example.faketld');
// false

var_dump($parser->isSuffixValid('www.example.com.au');
// true

A suffix is considered invalid if it is not contained in the Public Suffix List.

Huge thanks to @SmellyFish for submitting Add a way to validate TLDs to add public suffix validation to the project.

Retrieving Domain Components Only

If you're only interested in a domain component, you can use the parser to retrieve only the component you're interested in

<?php

var_dump($parser->getSubdomain('www.scottwills.co.uk'));
var_dump($parser->getRegisterableDomain('www.scottwills.co.uk'));
var_dump($parser->getPublicSuffix('www.scottwills.co.uk'));

The above will output:

string(3) "www"
string(16) "scottwills.co.uk"
string(5) "co.uk"

Sanity Check

You can quickly parse a url from the command line with the provided parse vendor binary. From the root of your project, simply call:

$ ./vendor/bin/parse <url>

If you pass a url to parse, that url will be parsed and the output printed to screen.

If you do not pass a url, http://user:pass@www.pref.okinawa.jp:8080/path/to/page.html?query=string#fragment will be parsed and the output printed to screen.

Example:

$ ./vendor/bin/parse http://www.waxaudio.com.au/

Array
(
    [scheme] => http
    [user] =>
    [pass] =>
    [host] => www.waxaudio.com.au
    [subdomain] => www
    [registerableDomain] => waxaudio.com.au
    [publicSuffix] => com.au
    [port] =>
    [path] => /
    [query] =>
    [fragment] =>
)
Host: http://www.waxaudio.com.au/

Example Script

For more information on using the PHP Domain Parser, please see the provided example script.

Refreshing the Public Suffix List

While a cached PHP copy of the Public Suffix List is provided for you in the data directory, that copy may or may not be up to date (Mozilla provides an Atom change feed to keep up with changes to the list). Please use the provided vendor binary to refresh your cached copy of the Public Suffix List.

From the root of your project, simply call:

$ ./vendor/bin/update-psl

You may verify the update by checking the timestamp on the files located in the data directory.

Important: The vendor binary update-psl depends on an internet connection to update the cached Public Suffix List.

Possible Unexpected Behavior

PHP Domain Parser is built around PHP's parse_url() function and, as such, exhibits most of the same behaviors of that function. Just like parse_url(), this library is not meant to validate URLs, but rather to break a URL into its component parts.

One specific, counterintuitive behavior is that PHP Domain Parser will happily parse a URL with spaces in the host part.

Contributing

Pull requests are always welcome! Please review the CONTRIBUTING.md document before submitting pull requests.

Heads up: BC Break In All 1.4 Versions

The 1.4 series introduced a backwards incompatible change by adding PHP's ext-mbstring and ext-intl as dependencies. This should have resulted in a major version bump. Instead I bumped the minor version from 1.3.1 to 1.4.

I highly recommend reverting to 1.3.1 if you're running into extension issues and do not want to or cannot install ext-mbstring and ext-intl. You will lose IDNA and IPv6 support, however. Those are only available in versions >= 1.4.

I apologize for any issues you may have encountered due my semver error.

Attribution

The HTTP adapter interface and the cURL HTTP adapter were inspired by (er, lifted from) Will Durand's excellent Geocoder project. His MIT license and copyright notice are below.

Copyright (c) 2011-2013 William Durand <william.durand1@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Portions of the PublicSuffixListManager and the DomainParser are derivative works of the PHP registered-domain-libs. Those parts of this codebase are heavily commented, and I've included a copy of the Apache Software Foundation License 2.0 in this project.