forked from NetComposer/nklib
-
Notifications
You must be signed in to change notification settings - Fork 2
/
nklib_util.erl
1409 lines (1063 loc) · 36.1 KB
/
nklib_util.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
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
%% -------------------------------------------------------------------
%%
%% Copyright (c) 2019 Carlos Gonzalez Florido. All Rights Reserved.
%%
%% This file is provided to you under the Apache License,
%% Version 2.0 (the "License"); you may not use this file
%% except in compliance with the License. You may obtain
%% a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing,
%% software distributed under the License is distributed on an
%% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
%% KIND, either express or implied. See the License for the
%% specific language governing permissions and limitations
%% under the License.
%%
%% -------------------------------------------------------------------
%% @doc Common library utility functions
-module(nklib_util).
-author('Carlos Gonzalez <[email protected]>').
-export([ensure_all_started/2, call/2, call/3, call2/2, call2/3, apply/3, safe_call/3]).
-export([luid/0, lhash/1, uid/0, uuid_4122/0, hash/1, hash/3, hash36/1, sha/1]).
-export([get_hwaddr/0, timestamp/0, m_timestamp/0, l_timestamp/0, l_timestamp_to_float/1]).
-export([timestamp_to_local/1, timestamp_to_gmt/1]).
-export([local_to_timestamp/1, gmt_to_timestamp/1]).
-export([get_value/2, get_value/3, get_binary/2, get_binary/3, get_list/2, get_list/3]).
-export([get_integer/2, get_integer/3, keys/1]).
-export([store_value/2, store_value/3, store_values/2, filter_values/2, remove_values/2]).
-export([filtermap/2]).
-export([to_binary/1, to_list/1, to_map/1, to_integer/1, to_boolean/1, to_float/1]).
-export([to_atom/1, to_existing_atom/1, make_atom/2, to_ip/1, to_host/1, to_host/2]).
-export([to_lower/1, to_upper/1, to_capital/1, to_binlist/1, strip/1, unquote/1, is_string/1]).
-export([bjoin/1, bjoin/2, words/1, capitalize/1, append_max/3, randomize/1, get_randomized/1]).
-export([hex/1, extract/2, delete/2, defaults/2, bin_last/2, find_duplicated/1]).
-export([cancel_timer/1, reply/2, demonitor/1, msg/2]).
-export([add_id/2, add_id/3]).
-export([base64_decode/1, base64url_encode/1, base64url_encode_mime/1, base64url_decode/1]).
-export([map_merge/2, prefix/2, rand/2, consistent_reorder/2, add_to_list/3, floor/1, ceiling/1, lpad/3]).
-export([do_try/1, do_config_get/1, do_config_get/2, do_config_put/2, do_config_del/1]).
-export_type([optslist/0, timestamp/0, m_timestamp/0, l_timestamp/0]).
-include("nklib.hrl").
-compile({parse_transform, nklib_parse_trans_vsn}).
-compile(inline).
%% ===================================================================
%% Types
%% ===================================================================
%% Standard Proplist
-type optslist() :: [atom() | binary() | {atom()|binary(), term()}].
%% System timestamp
-type timestamp() :: non_neg_integer().
-type l_timestamp() :: non_neg_integer().
-type m_timestamp() :: non_neg_integer().
%% ===================================================================
%% Public
%% =================================================================
%% @doc Ensure that an application and all of its transitive
%% dependencies are started.
-spec ensure_all_started(atom(), permanent | transient | temporary) ->
{ok, [atom()]} | {error, term()}.
ensure_all_started(Application, Type) ->
case ensure_all_started(Application, Type, []) of
{ok, Started} ->
{ok, lists:reverse(Started)};
{error, Reason, Started} ->
[ application:stop(App) || App <- Started ],
{error, Reason}
end.
%% @private
ensure_all_started(Application, Type, Started) ->
case application:start(Application, Type) of
ok ->
{ok, [Application | Started]};
{error, {already_started, Application}} ->
{ok, Started};
{error, {not_started, Dependency}} ->
case ensure_all_started(Dependency, Type, Started) of
{ok, NewStarted} ->
ensure_all_started(Application, Type, NewStarted);
Error ->
Error
end;
{error, Reason} ->
{error, Reason, Started}
end.
%% @doc See call/3
-spec call(atom()|pid(), term()) ->
term() | {error, {exit|error|throw, {term(), list()}}}.
call(Dest, Msg) ->
call(Dest, Msg, 5000).
%% @doc Like gen_server:call/3 but traps exceptions
%% For timeouts: {error, {exit, {{timeout, _}, _}}}
-spec call(atom()|pid(), term(), timeout() | infinity) ->
term() | {error, {exit|error|throw, {term(), list()}}}.
call(Dest, Msg, Timeout) ->
Fun = fun() -> gen_server:call(Dest, Msg, Timeout) end,
case nklib_util:do_try(Fun) of
{exception, {Class, {Error, Trace}}} ->
{error, {Class, {Error, Trace}}};
Other ->
Other
end.
%% @doc Safe call, only for noproc and normal exited processes
call2(Dest, Msg) ->
call2(Dest, Msg, 5000).
%% @doc Safe call, only for noproc and normal exited processes
call2(Dest, Msg, Timeout) ->
case call(Dest, Msg, Timeout) of
{error, {exit, {{noproc, _Fun}, _Stack}}} ->
process_not_found;
{error, {exit, {{normal, _Fun}, _Stack}}} ->
process_not_found;
{error, {Class, {Reason, Stack}}} ->
erlang:raise(Class, Reason, Stack);
Other ->
Other
end.
%% @private
-spec apply(atom(), atom(), list()) ->
term() | not_exported | {error, {exit|error|throw, {term(), list()}}}.
apply(Mod, Fun, Args) ->
TryFun = fun() ->
case erlang:function_exported(Mod, Fun, length(Args)) of
false ->
not_exported;
true ->
erlang:apply(Mod, Fun, Args)
end
end,
case nklib_util:do_try(TryFun) of
{exception, {Class, {Error, Trace}}} ->
{error, {Class, {Error, Trace}}};
Other ->
Other
end.
%% @doc Safe gen_server:call/3
%% It will spawn helper process in order to be sure no spurious message arrives
-spec safe_call(atom()|pid(), term(), pos_integer()|infinity) ->
term().
safe_call(Dest, Msg, Timeout) ->
Master = self(),
Slave = spawn(
fun() ->
Reply = try
{ok, gen_server:call(Dest, Msg, Timeout)}
catch
error:E -> {error, E};
exit:E -> {exit, E}
end,
Master ! {self(), Reply}
end
),
receive
{Slave, {ok, Msg}} -> Msg;
{Slave, {error, Error}} -> error(Error);
{Slave, {exit, Exit}} -> exit(Exit)
end.
%% @doc Generates a new printable random UUID.
-spec luid() ->
binary().
luid() ->
lhash({make_ref(), os:timestamp()}).
%% @doc Generates a RFC4122 compatible uuid
-spec uuid_4122() ->
binary().
uuid_4122() ->
Rand = hex(crypto:strong_rand_bytes(4)),
<<A:16/bitstring, B:16/bitstring, C:16/bitstring>> =
<<(nklib_util:l_timestamp()):48>>,
{ok, Hw} = application:get_env(nklib, hw_addr),
<<Rand/binary, $-, (hex(A))/binary, $-, (hex(B))/binary, $-,
(hex(C))/binary, $-, Hw/binary>>.
%% @doc Generates a new printable SHA hash binary over `Base' (using 160 bits, 27 chars).
-spec lhash(term()) ->
binary().
lhash(Base) ->
<<I:160/integer>> = sha(term_to_binary(Base)),
case encode_integer(I) of
Hash when byte_size(Hash) == 27 -> Hash;
Hash -> <<(binary:copy(<<"a">>, 27-byte_size(Hash)))/binary, Hash/binary>>
end.
%% @private
sha(Term) -> crypto:hash(sha, Term).
%% @doc Generates a new random tag of 6 chars
-spec uid() ->
binary().
uid() ->
hash({make_ref(), os:timestamp()}).
%% @doc Generates a new tag of 6 chars based on a value.
-spec hash(term()) ->
binary().
hash(Base) ->
case encode_integer(erlang:phash2([Base], 4294967296)) of
Hash when byte_size(Hash)==6 -> Hash;
Hash -> <<(binary:copy(<<"a">>, 6-byte_size(Hash)))/binary, Hash/binary>>
end.
%% @doc Generates an integer hash Start =< X <= Stop
-spec hash(term(), integer(), integer()) ->
integer().
hash(Base, Start, Stop) when Start >= 0, Stop > Start ->
Hash = erlang:phash2([Base]),
Hash rem (Stop - Start + 1) + Start.
%% @doc Generates a new tag based on a value (only numbers and uppercase) of 7 chars
-spec hash36(term()) ->
binary().
hash36(Base) ->
case encode_integer_36(erlang:phash2([Base], 4294967296)) of
Hash when byte_size(Hash)==7 -> Hash;
Hash -> <<(binary:copy(<<"A">>, 7-byte_size(Hash)))/binary, Hash/binary>>
end.
%% @private Finds the MAC addr for enX or ethX, or a random one if none is found
get_hwaddr() ->
{ok, Addrs1} = inet:getifaddrs(),
Addrs2 = lists:filter(
fun
({"en"++_, _}) -> true;
({"eth"++_, _}) -> true;
(_) -> false
end,
Addrs1),
case get_hwaddrs(Addrs2) of
{ok, Hex} ->
Hex;
false ->
case get_hwaddrs(Addrs1) of
{ok, Hex} -> Hex;
false -> hex(crypto:strong_rand_bytes(6))
end
end.
%% @private
get_hwaddrs([{_Name, Data}|Rest]) ->
case nklib_util:get_value(hwaddr, Data) of
Hw when is_list(Hw), length(Hw)==6 -> {ok, hex(Hw)};
_ -> get_hwaddrs(Rest)
end;
get_hwaddrs([]) ->
false.
% calendar:datetime_to_gregorian_seconds({{1970,1,1},{0,0,0}}).
-define(SECONDS_FROM_GREGORIAN_BASE_TO_EPOCH, (1970*365+478)*24*60*60).
%% @doc Gets an second-resolution timestamp
-spec timestamp() -> timestamp().
timestamp() ->
{MegaSeconds, Seconds, _} = os:timestamp(),
MegaSeconds*1000000 + Seconds.
%% @doc Gets an microsecond-resolution timestamp
-spec l_timestamp() -> l_timestamp().
l_timestamp() ->
{N1, N2, N3} = os:timestamp(),
(N1 * 1000000 + N2) * 1000000 + N3.
%% @doc Gets an milisecond-resolution timestamp
-spec m_timestamp() -> m_timestamp().
m_timestamp() ->
l_timestamp() div 1000.
%% @doc Converts a `timestamp()' to a local `datetime()'.
-spec timestamp_to_local(timestamp()) ->
calendar:datetime().
timestamp_to_local(Secs) ->
calendar:now_to_local_time({0, Secs, 0}).
%% @doc Converts a `timestamp()' to a gmt `datetime()'.
-spec timestamp_to_gmt(timestamp()) ->
calendar:datetime().
timestamp_to_gmt(Secs) ->
calendar:now_to_universal_time({0, Secs, 0}).
%% @doc Generates a float representing `HHMMSS.MicroSecs' for a high resolution timer.
-spec l_timestamp_to_float(l_timestamp()) ->
float().
l_timestamp_to_float(LStamp) ->
Timestamp = trunc(LStamp/1000000),
{_, {H,Mi,S}} = nklib_util:timestamp_to_local(Timestamp),
Micro = LStamp-Timestamp*1000000,
H*10000+Mi*100+S+(Micro/1000000).
%% @doc Converts a local `datetime()' to a `timestamp()',
-spec gmt_to_timestamp(calendar:datetime()) ->
timestamp().
gmt_to_timestamp(DateTime) ->
calendar:datetime_to_gregorian_seconds(DateTime) - 62167219200.
%% @doc Converts a gmt `datetime()' to a `timestamp()'.
-spec local_to_timestamp(calendar:datetime()) ->
timestamp().
local_to_timestamp(DateTime) ->
case calendar:local_time_to_universal_time_dst(DateTime) of
[First, _] -> gmt_to_timestamp(First);
[Time] -> gmt_to_timestamp(Time);
[] -> 0
end.
%% @doc Equivalent to `proplists:get_value/2' but faster.
-spec get_value(term(), list()) ->
term().
get_value(Key, List) ->
get_value(Key, List, undefined).
%% @doc Requivalent to `proplists:get_value/3' but faster.
-spec get_value(term(), list(), term()) ->
term().
get_value(Key, List, Default) ->
case lists:keyfind(Key, 1, List) of
{_, Value} -> Value;
_ -> Default
end.
%% @doc Similar to `get_value(Key, List, <<>>)' but converting the result into
%% a `binary()'.
-spec get_binary(term(), list()) ->
binary().
get_binary(Key, List) ->
to_binary(get_value(Key, List, <<>>)).
%% @doc Similar to `get_value(Key, List, Default)' but converting the result into
%% a `binary()'.
-spec get_binary(term(), list(), term()) ->
binary().
get_binary(Key, List, Default) ->
to_binary(get_value(Key, List, Default)).
%% @doc Similar to `get_value(Key, List, [])' but converting the result into a `list()'.
-spec get_list(term(), list()) ->
list().
get_list(Key, List) ->
to_list(get_value(Key, List, [])).
%% @doc Similar to `get_value(Key, List, Default)' but converting the result
%% into a `list()'.
-spec get_list(term(), list(), term()) ->
list().
get_list(Key, List, Default) ->
to_list(get_value(Key, List, Default)).
%% @doc Similar to `get_value(Key, List, 0)' but converting the result into
%% an `integer()' or `error'.
-spec get_integer(term(), list()) ->
integer() | error.
get_integer(Key, List) ->
to_integer(get_value(Key, List, 0)).
%% @doc Similar to `get_value(Key, List, Default)' but converting the result into
%% a `integer()' or `error'.
-spec get_integer(term(), list(), term()) ->
integer() | error.
get_integer(Key, List, Default) ->
to_integer(get_value(Key, List, Default)).
%% @doc Get the keys of a map or list (the first element of any tuple,
%% or the element itself)
-spec keys(map()|list()) ->
[term()].
keys(Map) when is_map(Map) ->
maps:keys(Map);
keys(List) when is_list(List) ->
lists:map(
fun(Term) ->
case is_tuple(Term) of
true -> element(1, Term);
false -> Term
end
end,
List).
%% @doc Stores a value in a list
-spec store_value(term(), list()) ->
list().
store_value(Term, List) ->
case lists:member(Term, List) of
true -> List;
false -> [Term|List]
end.
%% @doc Stores a value in a proplist
-spec store_value(term(), term(), nklib:optslist()) ->
nklib:optslist().
store_value(Key, Val, List) ->
lists:keystore(Key, 1, List, {Key, Val}).
%% @doc Stores a set of values in a proplist
-spec store_values(list(), nklib:optslist()) ->
nklib:optslist().
store_values([{Key, Val}|Rest], List) ->
store_values(Rest, store_value(Key, Val, List));
store_values([Val|Rest], List) ->
store_values(Rest, store_value(Val, List));
store_values([], List) ->
List.
%% @doc Removes values from a list
-spec filter_values(list(), nklib:optslist()) ->
nklib:optslist().
filter_values(Values, List) ->
lists:filter(
fun(Term) ->
case is_tuple(Term) of
true -> lists:member(element(1, Term), Values);
false -> lists:member(Term, Values)
end
end,
List).
%% @doc Removes values from a list
-spec remove_values(list(), nklib:optslist()) ->
nklib:optslist().
remove_values(Values, List) ->
lists:filter(
fun(Term) ->
not case is_tuple(Term) of
true -> lists:member(element(1, Term), Values);
false -> lists:member(Term, Values)
end
end,
List).
-spec filtermap(Fun, List1) -> List2 when
Fun :: fun((Elem) -> boolean() | {'true', Value}),
List1 :: [Elem],
List2 :: [Elem | Value],
Elem :: term(),
Value :: term().
filtermap(F, [Hd|Tail]) ->
case F(Hd) of
true ->
[Hd|filtermap(F, Tail)];
{true,Val} ->
[Val|filtermap(F, Tail)];
false ->
filtermap(F, Tail)
end;
filtermap(F, []) when is_function(F, 1) ->
[].
%% @doc Converts anything into a `binary()'. Can convert ip addresses also.
-spec to_binary(term()) ->
binary().
to_binary(B) when is_binary(B) -> B;
to_binary([]) -> <<>>;
to_binary([Int|_]=L) when is_integer(Int) ->
case catch list_to_binary(L) of
{'EXIT', _} ->
case catch unicode:characters_to_binary(L) of
{'EXIT', _} -> msg("~s", [L]);
Bin -> Bin
end;
Bin ->
Bin
end;
to_binary(undefined) -> <<>>;
to_binary(A) when is_atom(A) -> atom_to_binary(A, latin1);
to_binary(I) when is_integer(I) -> list_to_binary(erlang:integer_to_list(I));
to_binary(#uri{}=Uri) -> nklib_unparse:uri(Uri);
to_binary(P) when is_pid(P) -> to_binary(to_list(P));
to_binary(N) -> msg("~p", [N]).
%% @doc Converts anything into a `string()'.
-spec to_list(string()|binary()|atom()|integer()|pid()|list()|map()) ->
string().
to_list(L) when is_list(L) -> L;
to_list(B) when is_binary(B) -> binary_to_list(B);
to_list(A) when is_atom(A) -> atom_to_list(A);
to_list(I) when is_integer(I) -> erlang:integer_to_list(I);
to_list(M) when is_map(M) -> maps:to_list(M);
to_list(P) when is_pid(P) -> pid_to_list(P).
%% @doc Converts anything into a `atom()'.
%% WARNING: Can create new atoms
-spec to_atom(string()|binary()|atom()|integer()) ->
atom().
to_atom(A) when is_atom(A) -> A;
to_atom(B) when is_binary(B) -> binary_to_atom(B, utf8);
to_atom(L) when is_list(L) -> list_to_atom(L);
to_atom(I) when is_integer(I) -> list_to_atom(integer_to_list(I)).
%% @doc Converts anything into an existing atom or throws an error
-spec to_existing_atom(string()|binary()|atom()|integer()) ->
atom().
to_existing_atom(A) when is_atom(A) -> A;
to_existing_atom(B) when is_binary(B) -> binary_to_existing_atom(B, utf8);
to_existing_atom(L) when is_list(L) -> list_to_existing_atom(L);
to_existing_atom(I) when is_integer(I) -> to_existing_atom(integer_to_list(I)).
%% @doc Generates an atom with a warning if it is new
-spec make_atom(term(), term()) ->
atom().
make_atom(_Id, Atom) when is_atom(Atom) ->
Atom;
make_atom(Id, Term) ->
Term2 = to_binary(Term),
case catch binary_to_existing_atom(Term2, utf8) of
{'EXIT', _} ->
lager:warning("NkLIB id '~p' created atom '~s'", [Id, Term2]),
binary_to_atom(Term2, utf8);
Atom ->
Atom
end.
-spec to_map(list()|map()) ->
map().
to_map(M) when is_map(M) ->
M;
to_map(L) when is_list(L) ->
L1 = lists:map(
fun(T) ->
case T of
{K, V} -> {K, V};
K -> {K, true}
end
end,
L),
maps:from_list(L1).
%% @doc Converts anything into a `integer()' or `error'.
-spec to_integer(integer()|binary()|string()) ->
integer() | error.
to_integer(I) when is_integer(I) ->
I;
to_integer(F) when is_float(F) ->
round(F);
to_integer(B) when is_binary(B) ->
to_integer(binary_to_list(B));
to_integer(L) when is_list(L) ->
case catch list_to_integer(L) of
I when is_integer(I) -> I;
_ -> error
end;
to_integer(_) ->
error.
%% @doc Converts anything into a `integer()' or `error'.
-spec to_float(integer()|binary()|string()|float()) ->
integer() | error.
to_float(F) when is_float(F) ->
F;
to_float(I) when is_integer(I) ->
I * 1.0;
to_float(L) when is_list(L) ->
case catch list_to_float(L) of
F when is_float(F) ->
F;
_ ->
case to_integer(L) of
I when is_integer(I) -> I * 1.0;
error -> error
end
end;
to_float(B) when is_binary(B) ->
to_float(binary_to_list(B));
to_float(_) ->
error.
%% @doc Converts anything into a `integer()' or `error'.
-spec to_boolean(integer()|binary()|string()|atom()) ->
true | false | error.
to_boolean(true) ->
true;
to_boolean(false) ->
false;
to_boolean(Term) ->
case catch to_lower(Term) of
<<"true">> -> true;
<<"false">> -> false;
_ -> error
end.
%% @doc Converts a `list()' or `binary()' into a `inet:ip_address()' or `error'.
-spec to_ip(string() | binary() | inet:ip_address()) ->
{ok, inet:ip_address()} | error.
to_ip({A, B, C, D}) when is_integer(A), is_integer(B), is_integer(C), is_integer(D) ->
{ok, {A, B, C, D}};
to_ip({A, B, C, D, E, F, G, H}) when is_integer(A), is_integer(B), is_integer(C),
is_integer(D), is_integer(E), is_integer(F),
is_integer(G), is_integer(H) ->
{ok, {A, B, C, D, E, F, G, H}};
to_ip(Address) when is_binary(Address) ->
to_ip(binary_to_list(Address));
% For IPv6
to_ip([$[ | Address1]) ->
case lists:reverse(Address1) of
[$] | Address2] -> to_ip(lists:reverse(Address2));
_ -> error
end;
to_ip(Address) when is_list(Address) ->
case inet_parse:address(Address) of
{ok, Ip} -> {ok, Ip};
_ -> error
end;
to_ip(_) ->
error.
%% @doc Converts an IP or host to a binary host value
-spec to_host(inet:ip_address() | string() | binary()) ->
binary().
to_host(IpOrHost) ->
to_host(IpOrHost, false).
%% @doc Converts an IP or host to a binary host value.
% If `IsUri' and it is an IPv6 address, it will be enclosed in `[' and `]'
-spec to_host(inet:ip_address() | string() | binary(), boolean()) ->
binary().
to_host({A,B,C,D}=Address, _IsUri)
when is_integer(A), is_integer(B), is_integer(C), is_integer(D) ->
list_to_binary(inet_parse:ntoa(Address));
to_host({A,B,C,D,E,F,G,H}=Address, IsUri)
when is_integer(A), is_integer(B), is_integer(C), is_integer(D),
is_integer(E), is_integer(F), is_integer(G), is_integer(H) ->
case IsUri of
true -> list_to_binary([$[, inet_parse:ntoa(Address), $]]);
false -> list_to_binary(inet_parse:ntoa(Address))
end;
to_host(Host, _IsUri) ->
to_binary(Host).
%% @doc converts a `string()' or `binary()' to a lower `binary()'.
-spec to_lower(string()|binary()|atom()) ->
binary().
to_lower(List) when is_list(List) ->
list_to_binary(string:to_lower(List));
to_lower(Other) ->
to_lower(to_list(Other)).
%% @doc converts a `string()' or `binary()' to an upper `binary()'.
-spec to_upper(string()|binary()|atom()) ->
binary().
to_upper(List) when is_list(List) ->
list_to_binary(string:to_upper(List));
to_upper(Other) ->
to_upper(to_list(Other)).
%% @doc converts a `string()' or `binary()' to an upper `binary()'.
-spec to_capital(string()|binary()|atom()) ->
binary().
to_capital(Text) ->
case to_binary(Text) of
<<First, Rest/binary>> when First >= $a, First =< $z ->
<<(First-32), Rest/binary>>;
Bin ->
Bin
end.
%% @doc Converts a binary(), string() or list() to a list of binaries
-spec to_binlist(term()|[term()]) ->
[binary()].
to_binlist([I|_]=String) when is_integer(I) -> [list_to_binary(String)];
to_binlist(List) when is_list(List) -> [to_binary(T) || T <- List];
to_binlist(Bin) when is_binary(Bin) -> [Bin];
to_binlist(Term) -> [to_binary(Term)].
%% @doc URI Strips trailing white space
-spec strip(list()|binary()) ->
list().
strip(Bin) when is_binary(Bin) -> strip(binary_to_list(Bin));
strip([32|Rest]) -> strip(Rest);
strip([13|Rest]) -> strip(Rest);
strip([10|Rest]) -> strip(Rest);
strip([9|Rest]) -> strip(Rest);
strip(Rest) -> Rest.
%% @doc Removes doble quotes
-spec unquote(list()|binary()) ->
list().
unquote(Bin) when is_binary(Bin) ->
unquote(binary_to_list(Bin));
unquote(List) ->
case strip(List) of
[$"|Rest] ->
case strip(lists:reverse(Rest)) of
[$"|Rest1] -> strip(lists:reverse(Rest1));
_ -> []
end;
Other ->
Other
end.
%% @doc Generates a printable string from a big number using base 62.
-spec encode_integer(integer()) ->
binary().
encode_integer(Int) ->
list_to_binary(integer_to_list(Int, 62, [])).
%% @doc Generates a printable string from a big number using base 36
%% (only numbers and uppercase)
-spec encode_integer_36(integer()) ->
binary().
encode_integer_36(Int) ->
list_to_binary(integer_to_list(Int, 36, [])).
%% @private
-spec integer_to_list(integer(), integer(), string()) ->
string().
integer_to_list(I0, Base, R0) ->
D = I0 rem Base,
I1 = I0 div Base,
R1 = if
D >= 36 -> [D-36+$a|R0];
D >= 10 -> [D-10+$A|R0];
true -> [D+$0|R0]
end,
if
I1 == 0 -> R1;
true -> integer_to_list(I1, Base, R1)
end.
%% @doc Extracts all elements in `Proplist' having key `KeyOrKeys' or having key in
%% `KeyOrKeys' if `KeyOrKeys' is a list.
-spec extract([term()], term() | [term()]) ->
[term()].
extract(PropList, KeyOrKeys) ->
Fun = fun(Term) ->
if
is_tuple(Term), is_list(KeyOrKeys) ->
lists:member(element(1, Term), KeyOrKeys);
is_tuple(Term) ->
element(1, Term) == KeyOrKeys;
is_list(KeyOrKeys) ->
lists:member(Term, KeyOrKeys);
Term == KeyOrKeys ->
true;
true ->
false
end
end,
lists:filter(Fun, PropList).
%% @doc Deletes all elements in `Proplist' having key `KeyOrKeys' or having key in
%% `KeyOrKeys' if `KeyOrKeys' is a list.
-spec delete([term()], term() | [term()]) ->
[term()].
delete(PropList, KeyOrKeys) ->
Fun = fun(Term) ->
if
is_tuple(Term), is_list(KeyOrKeys) ->
not lists:member(element(1, Term), KeyOrKeys);
is_tuple(Term) ->
element(1, Term) /= KeyOrKeys;
is_list(KeyOrKeys) ->
not lists:member(Term, KeyOrKeys);
Term /= KeyOrKeys ->
true;
true ->
false
end
end,
lists:filter(Fun, PropList).
%% @doc Inserts defaults in a proplist
-spec defaults(List::[{term(), term()}], Defaults::[{term(), term()}]) ->
[{term(), term()}].
defaults(List, []) ->
List;
defaults(List, [{Key, Val}|Rest]) ->
case lists:keymember(Key, 1, List) of
true -> defaults(List, Rest);
false -> defaults([{Key, Val}|List], Rest)
end.
%% @doc Checks if `Term' is a `string()' or `[]'.
-spec is_string(Term::term()) ->
boolean().
is_string([]) -> true;
is_string([F|R]) when is_integer(F) -> is_string(R);
is_string(_) -> false.
%% @doc Joins each element in `List' into a `binary()' using `<<",">>' as separator.
-spec bjoin(List::[term()]) ->
binary().
bjoin(List) ->
bjoin(List, <<",">>).
%% @doc Join each element in `List' into a `binary()', using the indicated `Separator'.
-spec bjoin(List::[term()], Separator::binary()) ->
binary().
bjoin(List, Sep) when is_integer(Sep) ->
bjoin(List, <<Sep>>);
bjoin([], _J) ->
<<>>;
bjoin([Term], _J) ->
to_binary(Term);
bjoin([First|Rest], J) ->
bjoin2(Rest, to_binary(First), J).
bjoin2([[]|Rest], Acc, J) ->
bjoin2(Rest, Acc, J);
bjoin2([Next|Rest], Acc, J) ->
bjoin2(Rest, <<Acc/binary, J/binary, (to_binary(Next))/binary>>, J);
bjoin2([], Acc, _J) ->
Acc.
%% @doc Splits a `string()' or `binary()' into a list of words
-spec words(string() | binary()) ->
[string()] | error.
words(Bin) when is_binary(Bin) ->
words(binary_to_list(Bin));
words(List) when is_list(List) ->
words(List, [], []);
words(_) ->
error.
%% @private
words([], [], Tokens) ->
lists:reverse(Tokens);
words([], Chs, Tokens) ->
lists:reverse([lists:reverse(Chs)|Tokens]);
words([Ch|Rest], Chs, Tokens) when Ch==32; Ch==9; Ch==13; Ch==10 ->
case Chs of
[] -> words(Rest, [], Tokens);
_ -> words(Rest, [], [lists:reverse(Chs)|Tokens])
end;
words([Ch|Rest], Chs, Tokens) ->
words(Rest, [Ch|Chs], Tokens).
% @dod
capitalize(Name) ->
capitalize(to_binary(Name), true, <<>>).
% @private
capitalize(<<>>, _, Acc) ->
Acc;
capitalize(<<$-, Rest/bits >>, _, Acc) ->