/
misultin_utility.erl
470 lines (449 loc) · 16.4 KB
/
misultin_utility.erl
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
% ==========================================================================================================
% MISULTIN - Various Utilities
%
% >-|-|-(°>
%
% Copyright (C) 2011, Roberto Ostinelli <roberto@ostinelli.net>,
% Bob Ippolito <bob@mochimedia.com> for Mochi Media, Inc.
% All rights reserved.
%
% BSD License
%
% Redistribution and use in source and binary forms, with or without modification, are permitted provided
% that the following conditions are met:
%
% * Redistributions of source code must retain the above copyright notice, this list of conditions and the
% following disclaimer.
% * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
% the following disclaimer in the documentation and/or other materials provided with the distribution.
% * Neither the name of the authors nor the names of its contributors may be used to endorse or promote
% products derived from this software without specific prior written permission.
%
% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
% WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
% PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
% ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
% TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
% HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
% NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
% POSSIBILITY OF SUCH DAMAGE.
% ==========================================================================================================
-module(misultin_utility).
-vsn("0.8").
% API
-export([get_http_status_code/1, get_content_type/1, get_key_value/2, header_get_value/2]).
-export([parse_qs/1, parse_qs/2, unquote/1, quote_plus/1]).
% macros
-define(PERCENT, 37). % $\%
-define(FULLSTOP, 46). % $\.
-define(IS_HEX(C), (
(C >= $0 andalso C =< $9) orelse
(C >= $a andalso C =< $f) orelse
(C >= $A andalso C =< $F)
)).
-define(QS_SAFE(C), (
(C >= $a andalso C =< $z) orelse
(C >= $A andalso C =< $Z) orelse
(C >= $0 andalso C =< $9) orelse
(C =:= ?FULLSTOP orelse C =:= $- orelse C =:= $~ orelse C =:= $_)
)).
% includes
-include("../include/misultin.hrl").
% ============================ \/ API ======================================================================
% Returns a complete HTTP header. Most common first
-spec get_http_status_code(HttpStatus::non_neg_integer()) -> string().
get_http_status_code(200) ->
"HTTP/1.1 200 OK\r\n";
get_http_status_code(100) ->
"HTTP/1.1 100 Continue\r\n";
get_http_status_code(101) ->
"HTTP/1.1 101 Switching Protocols\r\n";
get_http_status_code(301) ->
"HTTP/1.1 301 Moved Permanently\r\n";
get_http_status_code(400) ->
"HTTP/1.1 400 Bad Request\r\n";
get_http_status_code(401) ->
"HTTP/1.1 401 Unauthorized\r\n";
get_http_status_code(403) ->
"HTTP/1.1 403 Forbidden\r\n";
get_http_status_code(404) ->
"HTTP/1.1 404 Not Found\r\n";
get_http_status_code(408) ->
"HTTP/1.1 408 Request Timeout\r\n";
get_http_status_code(500) ->
"HTTP/1.1 500 Internal Server Error\r\n";
get_http_status_code(501) ->
"HTTP/1.1 501 Not Implemented\r\n";
% less common last
get_http_status_code(201) ->
"HTTP/1.1 201 Created\r\n";
get_http_status_code(202) ->
"HTTP/1.1 202 Accepted\r\n";
get_http_status_code(203) ->
"HTTP/1.1 203 Non-Authoritative Information\r\n";
get_http_status_code(204) ->
"HTTP/1.1 204 No Content\r\n";
get_http_status_code(205) ->
"HTTP/1.1 205 Reset Content\r\n";
get_http_status_code(206) ->
"HTTP/1.1 206 Partial Content\r\n";
get_http_status_code(300) ->
"HTTP/1.1 300 Multiple Choices\r\n";
get_http_status_code(302) ->
"HTTP/1.1 302 Found\r\n";
get_http_status_code(303) ->
"HTTP/1.1 303 See Other\r\n";
get_http_status_code(304) ->
"HTTP/1.1 304 Not Modified\r\n";
get_http_status_code(305) ->
"HTTP/1.1 305 Use Proxy\r\n";
get_http_status_code(307) ->
"HTTP/1.1 307 Temporary Redirect\r\n";
get_http_status_code(402) ->
"HTTP/1.1 402 Payment Required\r\n";
get_http_status_code(405) ->
"HTTP/1.1 405 Method Not Allowed\r\n";
get_http_status_code(406) ->
"HTTP/1.1 406 Not Acceptable\r\n";
get_http_status_code(407) ->
"HTTP/1.1 407 Proxy Authentication Required\r\n";
get_http_status_code(409) ->
"HTTP/1.1 409 Conflict\r\n";
get_http_status_code(410) ->
"HTTP/1.1 410 Gone\r\n";
get_http_status_code(411) ->
"HTTP/1.1 411 Length Required\r\n";
get_http_status_code(412) ->
"HTTP/1.1 412 Precondition Failed\r\n";
get_http_status_code(413) ->
"HTTP/1.1 413 Request Entity Too Large\r\n";
get_http_status_code(414) ->
"HTTP/1.1 414 Request-URI Too Long\r\n";
get_http_status_code(415) ->
"HTTP/1.1 415 Unsupported Media Type\r\n";
get_http_status_code(416) ->
"HTTP/1.1 416 Requested Range Not Satisfiable\r\n";
get_http_status_code(417) ->
"HTTP/1.1 417 Expectation Failed\r\n";
get_http_status_code(502) ->
"HTTP/1.1 502 Bad Gateway\r\n";
get_http_status_code(503) ->
"HTTP/1.1 503 Service Unavailable\r\n";
get_http_status_code(504) ->
"HTTP/1.1 504 Gateway Timeout\r\n";
get_http_status_code(505) ->
"HTTP/1.1 505 HTTP Version Not Supported\r\n";
get_http_status_code(Other) ->
lists:flatten(io_lib:format("HTTP/1.1 ~p \r\n", [Other])).
% get content type
-spec get_content_type(FileName::string()) -> string().
get_content_type(FileName) ->
case filename:extension(FileName) of
% most common first
".doc" -> "application/msword";
".exe" -> "application/octet-stream";
".pdf" -> "application/pdf";
".rtf" -> "application/rtf";
".ppt" -> "application/vnd.ms-powerpoint";
".tgz" -> "application/x-compressed";
".tar" -> "application/x-tar";
".zip" -> "application/zip";
".mp3" -> "audio/mpeg";
".wav" -> "audio/x-wav";
".bmp" -> "image/bmp";
".ram" -> "audio/x-pn-realaudio";
".gif" -> "image/gif";
".jpe" -> "image/jpeg";
".jpeg" -> "image/jpeg";
".jpg" -> "image/jpeg";
".tif" -> "image/tiff";
".tiff" -> "image/tiff";
".png" -> "image/png";
".htm" -> "text/html";
".html" -> "text/html";
".txt" -> "text/plain";
".mp2" -> "video/mpeg";
".mpa" -> "video/mpeg";
".mpe" -> "video/mpeg";
".mpeg" -> "video/mpeg";
".mpg" -> "video/mpeg";
".mov" -> "video/quicktime";
".avi" -> "video/x-msvideo";
% less common last
".evy" -> "application/envoy";
".fif" -> "application/fractals";
".spl" -> "application/futuresplash";
".hta" -> "application/hta";
".acx" -> "application/internet-property-stream";
".hqx" -> "application/mac-binhex40";
".dot" -> "application/msword";
".bin" -> "application/octet-stream";
".class" -> "application/octet-stream";
".dms" -> "application/octet-stream";
".lha" -> "application/octet-stream";
".lzh" -> "application/octet-stream";
".oda" -> "application/oda";
".axs" -> "application/olescript";
".prf" -> "application/pics-rules";
".p10" -> "application/pkcs10";
".crl" -> "application/pkix-crl";
".ai" -> "application/postscript";
".eps" -> "application/postscript";
".ps" -> "application/postscript";
".setpay" -> "application/set-payment-initiation";
".setreg" -> "application/set-registration-initiation";
".xla" -> "application/vnd.ms-excel";
".xlc" -> "application/vnd.ms-excel";
".xlm" -> "application/vnd.ms-excel";
".xls" -> "application/vnd.ms-excel";
".xlt" -> "application/vnd.ms-excel";
".xlw" -> "application/vnd.ms-excel";
".msg" -> "application/vnd.ms-outlook";
".sst" -> "application/vnd.ms-pkicertstore";
".cat" -> "application/vnd.ms-pkiseccat";
".stl" -> "application/vnd.ms-pkistl";
".pot" -> "application/vnd.ms-powerpoint";
".pps" -> "application/vnd.ms-powerpoint";
".mpp" -> "application/vnd.ms-project";
".wcm" -> "application/vnd.ms-works";
".wdb" -> "application/vnd.ms-works";
".wks" -> "application/vnd.ms-works";
".wps" -> "application/vnd.ms-works";
".hlp" -> "application/winhlp";
".bcpio" -> "application/x-bcpio";
".cdf" -> "application/x-cdf";
".z" -> "application/x-compress";
".cpio" -> "application/x-cpio";
".csh" -> "application/x-csh";
".dcr" -> "application/x-director";
".dir" -> "application/x-director";
".dxr" -> "application/x-director";
".dvi" -> "application/x-dvi";
".gtar" -> "application/x-gtar";
".gz" -> "application/x-gzip";
".hdf" -> "application/x-hdf";
".ins" -> "application/x-internet-signup";
".isp" -> "application/x-internet-signup";
".iii" -> "application/x-iphone";
".js" -> "application/x-javascript";
".latex" -> "application/x-latex";
".mdb" -> "application/x-msaccess";
".crd" -> "application/x-mscardfile";
".clp" -> "application/x-msclip";
".dll" -> "application/x-msdownload";
".m13" -> "application/x-msmediaview";
".m14" -> "application/x-msmediaview";
".mvb" -> "application/x-msmediaview";
".wmf" -> "application/x-msmetafile";
".mny" -> "application/x-msmoney";
".pub" -> "application/x-mspublisher";
".scd" -> "application/x-msschedule";
".trm" -> "application/x-msterminal";
".wri" -> "application/x-mswrite";
".nc" -> "application/x-netcdf";
".pma" -> "application/x-perfmon";
".pmc" -> "application/x-perfmon";
".pml" -> "application/x-perfmon";
".pmr" -> "application/x-perfmon";
".pmw" -> "application/x-perfmon";
".p12" -> "application/x-pkcs12";
".pfx" -> "application/x-pkcs12";
".p7b" -> "application/x-pkcs7-certificates";
".spc" -> "application/x-pkcs7-certificates";
".p7r" -> "application/x-pkcs7-certreqresp";
".p7c" -> "application/x-pkcs7-mime";
".p7m" -> "application/x-pkcs7-mime";
".p7s" -> "application/x-pkcs7-signature";
".sh" -> "application/x-sh";
".shar" -> "application/x-shar";
".swf" -> "application/x-shockwave-flash";
".sit" -> "application/x-stuffit";
".sv4cpio" -> "application/x-sv4cpio";
".sv4crc" -> "application/x-sv4crc";
".tcl" -> "application/x-tcl";
".tex" -> "application/x-tex";
".texi" -> "application/x-texinfo";
".texinfo" -> "application/x-texinfo";
".roff" -> "application/x-troff";
".t" -> "application/x-troff";
".tr" -> "application/x-troff";
".man" -> "application/x-troff-man";
".me" -> "application/x-troff-me";
".ms" -> "application/x-troff-ms";
".ustar" -> "application/x-ustar";
".src" -> "application/x-wais-source";
".cer" -> "application/x-x509-ca-cert";
".crt" -> "application/x-x509-ca-cert";
".der" -> "application/x-x509-ca-cert";
".pko" -> "application/ynd.ms-pkipko";
".au" -> "audio/basic";
".snd" -> "audio/basic";
".mid" -> "audio/mid";
".rmi" -> "audio/mid";
".aif" -> "audio/x-aiff";
".aifc" -> "audio/x-aiff";
".aiff" -> "audio/x-aiff";
".m3u" -> "audio/x-mpegurl";
".ra" -> "audio/x-pn-realaudio";
".cod" -> "image/cis-cod";
".ief" -> "image/ief";
".jfif" -> "image/pipeg";
".svg" -> "image/svg+xml";
".ras" -> "image/x-cmu-raster";
".cmx" -> "image/x-cmx";
".ico" -> "image/x-icon";
".pnm" -> "image/x-portable-anymap";
".pbm" -> "image/x-portable-bitmap";
".pgm" -> "image/x-portable-graymap";
".ppm" -> "image/x-portable-pixmap";
".rgb" -> "image/x-rgb";
".xbm" -> "image/x-xbitmap";
".xpm" -> "image/x-xpixmap";
".xwd" -> "image/x-xwindowdump";
".mht" -> "message/rfc822";
".mhtml" -> "message/rfc822";
".nws" -> "message/rfc822";
".css" -> "text/css";
".323" -> "text/h323";
".stm" -> "text/html";
".uls" -> "text/iuls";
".bas" -> "text/plain";
".c" -> "text/plain";
".h" -> "text/plain";
".rtx" -> "text/richtext";
".sct" -> "text/scriptlet";
".tsv" -> "text/tab-separated-values";
".htt" -> "text/webviewhtml";
".htc" -> "text/x-component";
".etx" -> "text/x-setext";
".vcf" -> "text/x-vcard";
".mpv2" -> "video/mpeg";
".qt" -> "video/quicktime";
".lsf" -> "video/x-la-asf";
".lsx" -> "video/x-la-asf";
".asf" -> "video/x-ms-asf";
".asr" -> "video/x-ms-asf";
".asx" -> "video/x-ms-asf";
".movie" -> "video/x-sgi-movie";
".flr" -> "x-world/x-vrml";
".vrml" -> "x-world/x-vrml";
".wrl" -> "x-world/x-vrml";
".wrz" -> "x-world/x-vrml";
".xaf" -> "x-world/x-vrml";
".xof" -> "x-world/x-vrml";
_ -> "application/octet-stream"
end.
% faster than proplists:get_value
-spec get_key_value(Key::term(), List::[{term(), term()}]) -> undefined | term().
get_key_value(Key, List) ->
case lists:keyfind(Key, 1, List) of
false-> undefined;
{_K, Value}-> Value
end.
% Find atom Tag in Headers, Headers being both atoms [for known headers] and strings. Comparison on string Header Tags is case insensitive.
-spec header_get_value(Tag::atom(), Headers::http_headers()) -> false | string() | false.
header_get_value(Tag, Headers) when is_atom(Tag) ->
case lists:keyfind(Tag, 1, Headers) of
false ->
% header not found, test also conversion to string -> convert all string tags to lowercase (HTTP tags are case insensitive)
F = fun({HTag, HValue}) ->
case is_atom(HTag) of
true -> {HTag, HValue};
false -> {string:to_lower(HTag), HValue}
end
end,
HeadersStr = lists:map(F, Headers),
% test
case lists:keyfind(string:to_lower(atom_to_list(Tag)), 1, HeadersStr) of
false -> false;
{_, Value} -> Value
end;
{_, Value} -> Value
end.
%% @spec parse_qs(string() | binary()) -> [{Key, Value}]
%% @doc Parse a query string or application/x-www-form-urlencoded.
-spec parse_qs(string() | binary()) -> [{Key::string(), Value::string()}].
parse_qs(Binary) when is_binary(Binary) ->
parse_qs(binary_to_list(Binary));
parse_qs(String) ->
parse_qs(String, []).
parse_qs([], Acc) ->
lists:reverse(Acc);
parse_qs(String, Acc) ->
{Key, Rest} = parse_qs_key(String),
{Value, Rest1} = parse_qs_value(Rest),
parse_qs(Rest1, [{Key, Value} | Acc]).
% unquote
-spec unquote(binary() | string()) -> string().
unquote(Binary) when is_binary(Binary) ->
unquote(binary_to_list(Binary));
unquote(String) ->
qs_revdecode(lists:reverse(String)).
%% @spec quote_plus(atom() | integer() | float() | string() | binary()) -> string()
%% @doc URL safe encoding of the given term.
-spec quote_plus(atom() | integer() | float() | string() | binary()) -> string().
quote_plus(Atom) when is_atom(Atom) ->
quote_plus(atom_to_list(Atom));
quote_plus(Int) when is_integer(Int) ->
quote_plus(integer_to_list(Int));
quote_plus(Binary) when is_binary(Binary) ->
quote_plus(binary_to_list(Binary));
quote_plus(String) ->
quote_plus(String, []).
% ============================ /\ API ======================================================================
% ============================ \/ INTERNAL FUNCTIONS =======================================================
% parse querystring & post
-spec parse_qs_key(String::string()) -> {Key::string(), Rest::string()}.
parse_qs_key(String) ->
parse_qs_key(String, []).
parse_qs_key([], Acc) ->
{qs_revdecode(Acc), ""};
parse_qs_key([$= | Rest], Acc) ->
{qs_revdecode(Acc), Rest};
parse_qs_key(Rest=[$; | _], Acc) ->
{qs_revdecode(Acc), Rest};
parse_qs_key(Rest=[$& | _], Acc) ->
{qs_revdecode(Acc), Rest};
parse_qs_key([C | Rest], Acc) ->
parse_qs_key(Rest, [C | Acc]).
parse_qs_value(String) ->
parse_qs_value(String, []).
parse_qs_value([], Acc) ->
{qs_revdecode(Acc), ""};
parse_qs_value([$; | Rest], Acc) ->
{qs_revdecode(Acc), Rest};
parse_qs_value([$& | Rest], Acc) ->
{qs_revdecode(Acc), Rest};
parse_qs_value([C | Rest], Acc) ->
parse_qs_value(Rest, [C | Acc]).
% revdecode
-spec qs_revdecode(string()) -> string().
qs_revdecode(S) ->
qs_revdecode(S, []).
qs_revdecode([], Acc) ->
Acc;
qs_revdecode([$+ | Rest], Acc) ->
qs_revdecode(Rest, [$\s | Acc]);
qs_revdecode([Lo, Hi, ?PERCENT | Rest], Acc) when ?IS_HEX(Lo), ?IS_HEX(Hi) ->
qs_revdecode(Rest, [(unhexdigit(Lo) bor (unhexdigit(Hi) bsl 4)) | Acc]);
qs_revdecode([C | Rest], Acc) ->
qs_revdecode(Rest, [C | Acc]).
% unexdigit
-spec unhexdigit(char()) -> char().
unhexdigit(C) when C >= $0, C =< $9 -> C - $0;
unhexdigit(C) when C >= $a, C =< $f -> C - $a + 10;
unhexdigit(C) when C >= $A, C =< $F -> C - $A + 10.
hexdigit(C) when C < 10 -> $0 + C;
hexdigit(C) when C < 16 -> $A + (C - 10).
% quote
-spec quote_plus(string(), string()) -> string().
quote_plus([], Acc) ->
lists:reverse(Acc);
quote_plus([C | Rest], Acc) when ?QS_SAFE(C) ->
quote_plus(Rest, [C | Acc]);
quote_plus([$\s | Rest], Acc) ->
quote_plus(Rest, [$+ | Acc]);
quote_plus([C | Rest], Acc) ->
<<Hi:4, Lo:4>> = <<C>>,
quote_plus(Rest, [hexdigit(Lo), hexdigit(Hi), ?PERCENT | Acc]).
% ============================ /\ INTERNAL FUNCTIONS =======================================================