1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
# Url
## Normalize {#normalize}
* `Url::Normalize(String) -> String?`
Normalizes the URL in a robot-friendly way: converts the hostname into lowercase, strips out certain fragments, and so on.
The normalization result only depends on the URL itself. The normalization **DOES NOT** include operations depending on the external data: transformation based on duplicates, mirrors, etc.
Returned value:
* Normalized URL.
* `NULL`, if the passed string argument can't be parsed as a URL.
#### Examples
```yql
SELECT Url::Normalize("hTTp://wWw.yDb.TECH/"); -- "http://www.ydb.tech/"
SELECT Url::Normalize("http://ydb.tech#foo"); -- "http://ydb.tech/"
```
## NormalizeWithDefaultHttpScheme {#normalizewithdefaulthttpscheme}
* `Url::NormalizeWithDefaultHttpScheme(String?) -> String?`
Normalizes similarly to `Url::Normalize`, but inserts the `http://` schema in case there is no schema.
Returned value:
* Normalized URL.
* Source URL, if the normalization has failed.
#### Examples
```yql
SELECT Url::NormalizeWithDefaultHttpScheme("wWw.yDb.TECH"); -- "http://www.ydb.tech/"
SELECT Url::NormalizeWithDefaultHttpScheme("http://ydb.tech#foo"); -- "http://ydb.tech/"
```
## Encode / Decode {#encode}
Encode a UTF-8 string to the urlencoded format (`Url::Encode`) and back (`Url::Decode`).
#### List of functions
* `Url::Encode(String?) -> String?`
* `Url::Decode(String?) -> String?`
#### Examples
```yql
SELECT Url::Decode("http://ydb.tech/%D1%81%D1%82%D1%80%D0%B0%D0%BD%D0%B8%D1%86%D0%B0");
-- "http://ydb.tech/page"
SELECT Url::Encode("http://ydb.tech/page");
-- "http://ydb.tech/%D1%81%D1%82%D1%80%D0%B0%D0%BD%D0%B8%D1%86%D0%B0"
```
## Parse {#parse}
Parses the URL into parts.
```yql
Url::Parse(Parse{Flags:AutoMap}) -> Struct< Frag: String?, Host: String?, ParseError: String?, Pass: String?, Path: String?, Port: String?, Query: String?, Scheme: String?, User: String? >
```
#### Examples
```yql
SELECT Url::Parse(
"https://en.wikipedia.org/wiki/Isambard_Kingdom_Brunel?s=24&g=h-24#Great_Western_Railway");
/*
(
"Frag": "Great_Western_Railway",
"Host": "en.wikipedia.org",
"ParseError": null,
"Pass": null,
"Path": "/wiki/Isambard_Kingdom_Brunel",
"Port": null,
"Query": "s=24&g=h-24",
"Scheme": "https",
"User": null
)
*/
```
## Get... {#get}
Get a component of the URL.
#### List of functions
* `Url::GetScheme(String{Flags:AutoMap}) -> String`
* `Url::GetHost(String?) -> String?`
* `Url::GetHostPort(String?) -> String?`
* `Url::GetSchemeHost(String?) -> String?`
* `Url::GetSchemeHostPort(String?) -> String?`
* `Url::GetPort(String?) -> String?`
* `Url::GetTail(String?) -> String?` -- everything following the host: path + query + fragment
* `Url::GetPath(String?) -> String?`
* `Url::GetFragment(String?) -> String?`
* `Url::GetCGIParam(String?, String) -> String?` -- The second parameter is the name of the intended CGI parameter.
* `Url::GetDomain(String?, Uint8) -> String?` -- The second parameter is the required domain level.
* `Url::GetTLD(String{Flags:AutoMap}) -> String`
* `Url::IsKnownTLD(String{Flags:AutoMap}) -> Bool` -- Registered on [iana.org](http://www.iana.org/).
* `Url::IsWellKnownTLD(String{Flags:AutoMap}) -> Bool` -- Belongs to a small whitelist of com, net, org, ru, and so on.
* `Url::GetDomainLevel(String{Flags:AutoMap}) -> Uint64`
* `Url::GetSignificantDomain(String{Flags:AutoMap}, [List<String>?]) -> String`
Returns a second-level domain in most cases and a third-level domain for the hostnames like: `***.XXX.YY`, where `XXX` is com, net, org, co, gov, or edu. You can redefine this list using an optional second argument
* `Url::GetOwner(String{Flags:AutoMap}) -> String`
Returns the domain that's most likely owned by an individual or organization. Unlike `Url::GetSignificantDomain`, it uses a special whitelist. Besides the `***.co.uk` domains, it can return a third-level domain used by free hosting sites and blogs (for example: something.livejournal.com)
#### Examples
```yql
SELECT Url::GetScheme("https://ydb.tech"); -- "https://"
SELECT Url::GetDomain("http://www.ydb.tech", 2); -- "ydb.tech"
```
## Cut... {#cut}
* `Url::CutScheme(String?) -> String?`
Returns the passed URL without the schema (`http://`, `https://`, etc.).
* `Url::CutWWW(String?) -> String?`
Returns the passed domain without the "www." prefix (if any).
* `Url::CutWWW2(String?) -> String?`
Returns the passed domain without the prefixes like "www.", "www2.", "wwww777." (if any).
* `Url::CutQueryStringAndFragment(String{Flags:AutoMap}) -> String`
Returns a copy of the passed URL, stripping out all the CGI parameters and fragments ("?foo=bar" and/or "#baz").
#### Examples
```yql
SELECT Url::CutScheme("http://www.ydb.tech"); -- "www.ydb.tech"
SELECT Url::CutWWW("www.ydb.tech"); -- "ydb.tech"
```
## ...Punycode... {#punycode}
[Punycode](https://en.wikipedia.org/wiki/Punycode) transformations.
#### List of functions
* `Url::HostNameToPunycode(String{Flag:AutoMap}) -> String?`
* `Url::ForceHostNameToPunycode(String{Flag:AutoMap}) -> String`
* `Url::PunycodeToHostName(String{Flag:AutoMap}) -> String?`
* `Url::ForcePunycodeToHostName(String{Flag:AutoMap}) -> String`
* `Url::CanBePunycodeHostName(String{Flag:AutoMap}) -> Bool`
#### Examples
```yql
SELECT Url::PunycodeToHostName("xn--80aniges7g.xn--j1aef"); -- "example.com"
```
## ...Query... {#query}
[Query](https://docs.python.org/3/library/urllib.parse.html) transformations.
#### List of functions
```yql
Url::QueryStringToList(String{Flag:AutoMap}, [
KeepBlankValues:Bool?, -- Empty values in percent-encoded queries are interpreted as empty strings, defaults to false.
Strict:Bool?, -- If false, parsing errors are ignored and incorrect fields are skipped, defaults to true.
MaxFields:Uint32?, -- The maximum number of fields. If exceeded, an exception is thrown. Defaults to Max<Uint32>.
Separator:String? -- A key-value pair separator, defaults to '&'.
]) -> List<Tuple<String, String>>
Url::QueryStringToDict(String{Flag:AutoMap}, [
KeepBlankValues:Bool?, -- Empty values in percent-encoded queries are interpreted as empty strings, defaults to false.
Strict:Bool?, -- If false, parsing errors are ignored and incorrect fields are skipped, defaults to true.
MaxFields:Uint32?, -- The maximum number of fields. If exceeded, an exception is thrown. Defaults to Max<Uint32>.
Separator:String? -- A key-value pair separator, defaults to '&'.
]) -> Dict<String, List<String>>
Url::BuildQueryString(Dict<String, List<String?>>{Flag:AutoMap}, [
Separator:String? -- A key-value pair separator, defaults to '&'.
]) -> String
Url::BuildQueryString(Dict<String, String?>{Flag:AutoMap}, [
Separator:String? -- A key-value pair separator, defaults to '&'.
]) -> String
Url::BuildQueryString(List<Tuple<String, String?>>{Flag:AutoMap}, [
Separator:String? -- A key-value pair separator, defaults to '&'.
]) -> String
```
#### Examples
```yql
SELECT Url::QueryStringToList("a=1&b=2&a=3"); -- [("a", "1"), ("b", "2"), ("a", "3")]
SELECT Url::QueryStringToDict("a=1&b=2&a=3"); -- {"b" : ["2"], "a" : ["1", "3"]}
SELECT Url::BuildQueryString([("a", "1"), ("a", "3"), ("b", "2")]); -- "a=1&a=3&b=2"
SELECT Url::BuildQueryString({"a" : "1", "b" : "2"}); -- "b=2&a=1"
SELECT Url::BuildQueryString({"a" : ["1", "3"], "b" : ["2", "4"]}); -- "b=2&b=4&a=1&a=3"
```
|
