|
|
|
|
|
|
|
|
|
# psl
|
|
|
|
|
|
|
|
|
|
Extract Internet Domain Components Using the Public Suffix List
|
|
|
|
|
|
|
|
|
|
## Description
|
|
|
|
|
|
|
|
|
|
The ‘Public Suffix List’ (<https://publicsuffix.org/>) is a collection
|
|
|
|
|
of top-level domains (‘TLDs’) which include global top-level domainsa
|
|
|
|
|
(‘gTLDs’) such as ‘.com’ and ‘.net’; country top-level domains
|
|
|
|
|
(‘ccTLDs’) such as ‘.de’ and ‘.cn’; and, brand top-level domains such
|
|
|
|
|
as ‘.apple’ and ‘.google’. Tools are provided to extract internet domain
|
|
|
|
|
components using the public suffix list base data.
|
|
|
|
|
|
|
|
|
|
- `libpsl`: <https://github.com/rockdaboot/libpsl>
|
|
|
|
|
- Public Suffix List: <https://publicsuffix.org/>
|
|
|
|
|
|
|
|
|
|
## What’s Inside The Tin
|
|
|
|
|
|
|
|
|
|
The following functions are implemented:
|
|
|
|
|
|
|
|
|
|
- `apex_domain`: Return the apex/top-private domain from a vector of
|
|
|
|
|
domains
|
|
|
|
|
- `is_public_suffix`: Test whether a domain is a public suffix
|
|
|
|
|
- `public_suffix`: Return the public suffix from a vector of domains
|
|
|
|
|
- `suffix_extract`: Separate a domain into component parts
|
|
|
|
|
- `suffix_extract2`: Separate a domain into component parts (urltools
|
|
|
|
|
compatible output)
|
|
|
|
|
|
|
|
|
|
## PRE-Installation
|
|
|
|
|
|
|
|
|
|
You need a recent `libpsl`.
|
|
|
|
|
|
|
|
|
|
- macOS: `brew install libpsl`
|
|
|
|
|
- Debian/Ubuntu-ish: Many repos have old versions so it’s *highly*
|
|
|
|
|
suggested that you build from source and ensure the library & header
|
|
|
|
|
files are accessible
|
|
|
|
|
- Windows: Just use `urltools::suffix_extract()` until winlibs are
|
|
|
|
|
available for psl
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
``` r
|
|
|
|
|
devtools::install_github("hrbrmstr/psl")
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
``` r
|
|
|
|
|
library(psl)
|
|
|
|
|
library(tidyverse)
|
|
|
|
|
|
|
|
|
|
# current verison
|
|
|
|
|
packageVersion("psl")
|
|
|
|
|
## [1] '0.1.0'
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
``` r
|
|
|
|
|
doms <- c(
|
|
|
|
|
"", "com", "example.com", "www.example.com",
|
|
|
|
|
".com", ".example", ".example.com", ".example.example", "example",
|
|
|
|
|
"example.example", "b.example.example", "a.b.example.example",
|
|
|
|
|
"biz", "domain.biz", "b.domain.biz", "a.b.domain.biz", "com",
|
|
|
|
|
"example.com", "b.example.com", "a.b.example.com", "uk.com",
|
|
|
|
|
"example.uk.com", "b.example.uk.com", "a.b.example.uk.com", "test.ac",
|
|
|
|
|
"cy", "c.cy", "b.c.cy", "a.b.c.cy", "jp", "test.jp", "www.test.jp",
|
|
|
|
|
"ac.jp", "test.ac.jp", "www.test.ac.jp", "kyoto.jp", "test.kyoto.jp",
|
|
|
|
|
"ide.kyoto.jp", "b.ide.kyoto.jp", "a.b.ide.kyoto.jp", "c.kobe.jp",
|
|
|
|
|
"b.c.kobe.jp", "a.b.c.kobe.jp", "city.kobe.jp", "www.city.kobe.jp",
|
|
|
|
|
"ck", "test.ck", "b.test.ck", "a.b.test.ck", "www.ck", "www.www.ck",
|
|
|
|
|
"us", "test.us", "www.test.us", "ak.us", "test.ak.us", "www.test.ak.us",
|
|
|
|
|
"k12.ak.us", "test.k12.ak.us", "www.test.k12.ak.us"
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
apex_domain(doms)
|
|
|
|
|
## [1] NA NA "example.com" "example.com" NA NA
|
|
|
|
|
## [7] NA NA NA "example.example" "example.example" "example.example"
|
|
|
|
|
## [13] NA "domain.biz" "domain.biz" "domain.biz" NA "example.com"
|
|
|
|
|
## [19] "example.com" "example.com" NA "example.uk.com" "example.uk.com" "example.uk.com"
|
|
|
|
|
## [25] "test.ac" NA "c.cy" "c.cy" "c.cy" NA
|
|
|
|
|
## [31] "test.jp" "test.jp" NA "test.ac.jp" "test.ac.jp" NA
|
|
|
|
|
## [37] "test.kyoto.jp" NA "b.ide.kyoto.jp" "b.ide.kyoto.jp" NA "b.c.kobe.jp"
|
|
|
|
|
## [43] "b.c.kobe.jp" "city.kobe.jp" "city.kobe.jp" NA NA "b.test.ck"
|
|
|
|
|
## [49] "b.test.ck" "www.ck" "www.ck" NA "test.us" "test.us"
|
|
|
|
|
## [55] NA "test.ak.us" "test.ak.us" NA "test.k12.ak.us" "test.k12.ak.us"
|
|
|
|
|
|
|
|
|
|
public_suffix(doms)
|
|
|
|
|
## [1] "" "com" "com" "com" "com" "example" "com"
|
|
|
|
|
## [8] "example" "example" "example" "example" "example" "biz" "biz"
|
|
|
|
|
## [15] "biz" "biz" "com" "com" "com" "com" "uk.com"
|
|
|
|
|
## [22] "uk.com" "uk.com" "uk.com" "ac" "cy" "cy" "cy"
|
|
|
|
|
## [29] "cy" "jp" "jp" "jp" "ac.jp" "ac.jp" "ac.jp"
|
|
|
|
|
## [36] "kyoto.jp" "kyoto.jp" "ide.kyoto.jp" "ide.kyoto.jp" "ide.kyoto.jp" "c.kobe.jp" "c.kobe.jp"
|
|
|
|
|
## [43] "c.kobe.jp" "kobe.jp" "kobe.jp" "ck" "test.ck" "test.ck" "test.ck"
|
|
|
|
|
## [50] "ck" "ck" "us" "us" "us" "ak.us" "ak.us"
|
|
|
|
|
## [57] "ak.us" "k12.ak.us" "k12.ak.us" "k12.ak.us"
|
|
|
|
|
|
|
|
|
|
is_public_suffix(doms)
|
|
|
|
|
## [1] TRUE TRUE FALSE FALSE TRUE TRUE FALSE FALSE TRUE FALSE FALSE FALSE TRUE FALSE FALSE FALSE TRUE FALSE FALSE
|
|
|
|
|
## [20] FALSE TRUE FALSE FALSE FALSE FALSE TRUE FALSE FALSE FALSE TRUE FALSE FALSE TRUE FALSE FALSE TRUE FALSE TRUE
|
|
|
|
|
## [39] FALSE FALSE TRUE FALSE FALSE FALSE FALSE TRUE TRUE FALSE FALSE FALSE FALSE TRUE FALSE FALSE TRUE FALSE FALSE
|
|
|
|
|
## [58] TRUE FALSE FALSE
|
|
|
|
|
|
|
|
|
|
suffix_extract(doms)
|
|
|
|
|
## # A tibble: 60 x 6
|
|
|
|
|
## orig normalized subdomain apex domain suffix
|
|
|
|
|
## <chr> <chr> <chr> <chr> <chr> <chr>
|
|
|
|
|
## 1 "" "" <NA> <NA> <NA> ""
|
|
|
|
|
## 2 com com <NA> <NA> <NA> com
|
|
|
|
|
## 3 example.com example.com "" example.com example com
|
|
|
|
|
## 4 www.example.com www.example.com www example.com example com
|
|
|
|
|
## 5 .com .com <NA> <NA> <NA> com
|
|
|
|
|
## 6 .example .example <NA> <NA> <NA> example
|
|
|
|
|
## 7 .example.com .example.com <NA> <NA> <NA> com
|
|
|
|
|
## 8 .example.example .example.example <NA> <NA> <NA> example
|
|
|
|
|
## 9 example example <NA> <NA> <NA> example
|
|
|
|
|
## 10 example.example example.example "" example.example example example
|
|
|
|
|
## # ... with 50 more rows
|
|
|
|
|
|
|
|
|
|
str(suffix_extract2(doms)) # urltools compatible output
|
|
|
|
|
## 'data.frame': 60 obs. of 4 variables:
|
|
|
|
|
## $ host : chr "" "com" "example.com" "www.example.com" ...
|
|
|
|
|
## $ subdomain: chr NA NA "" "www" ...
|
|
|
|
|
## $ domain : chr NA NA "example" "example" ...
|
|
|
|
|
## $ suffix : chr "" "com" "com" "com" ...
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
``` r
|
|
|
|
|
library(microbenchmark)
|
|
|
|
|
|
|
|
|
|
microbenchmark(
|
|
|
|
|
urltools = urltools::suffix_extract(doms),
|
|
|
|
|
psl = psl::suffix_extract(doms), # returns more data
|
|
|
|
|
psl2 = psl::suffix_extract2(doms) # returns what urltools does
|
|
|
|
|
) -> mb
|
|
|
|
|
|
|
|
|
|
autoplot(mb)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
<img src="README_files/figure-gfm/bench-1.png" width="960" />
|
