-
Notifications
You must be signed in to change notification settings - Fork 24
/
http_dispatch.pl
1555 lines (1379 loc) · 50.6 KB
/
http_dispatch.pl
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
/* Part of SWI-Prolog
Author: Jan Wielemaker
E-mail: [email protected]
WWW: http://www.swi-prolog.org
Copyright (c) 2007-2020, University of Amsterdam
VU University Amsterdam
CWI, Amsterdam
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. 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.
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 OWNER 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(http_dispatch,
[ http_dispatch/1, % +Request
http_handler/3, % +Path, +Predicate, +Options
http_delete_handler/1, % +Path
http_request_expansion/2, % :Goal, +Rank
http_reply_file/3, % +File, +Options, +Request
http_redirect/3, % +How, +Path, +Request
http_404/2, % +Options, +Request
http_switch_protocol/2, % :Goal, +Options
http_current_handler/2, % ?Path, ?Pred
http_current_handler/3, % ?Path, ?Pred, -Options
http_location_by_id/2, % +ID, -Location
http_link_to_id/3, % +ID, +Parameters, -HREF
http_reload_with_parameters/3, % +Request, +Parameters, -HREF
http_safe_file/2 % +Spec, +Options
]).
:- use_module(library(lists),
[ select/3, append/3, append/2, same_length/2, member/2,
last/2, delete/3
]).
:- autoload(library(apply),
[partition/4,maplist/3,maplist/2,include/3,exclude/3]).
:- autoload(library(broadcast),[listen/2]).
:- autoload(library(error),
[ must_be/2,
domain_error/2,
type_error/2,
instantiation_error/1,
existence_error/2,
permission_error/3
]).
:- autoload(library(filesex),[directory_file_path/3]).
:- autoload(library(option),[option/3,option/2,merge_options/3]).
:- autoload(library(pairs),[pairs_values/2]).
:- if(exists_source(library(time))).
:- autoload(library(time),[call_with_time_limit/2]).
:- endif.
:- autoload(library(uri),
[ uri_encoded/3,
uri_data/3,
uri_components/2,
uri_query_components/2
]).
:- autoload(library(http/http_header),[http_timestamp/2]).
:- autoload(library(http/http_path),[http_absolute_location/3]).
:- autoload(library(http/mimetype),
[file_content_type/2,file_content_type/3]).
:- if(exists_source(library(http/thread_httpd))).
:- autoload(library(http/thread_httpd),[http_spawn/2]).
:- endif.
:- use_module(library(settings),[setting/4,setting/2]).
:- predicate_options(http_404/2, 1, [index(any)]).
:- predicate_options(http_reply_file/3, 2,
[ cache(boolean),
mime_type(any),
static_gzip(boolean),
cached_gzip(boolean),
pass_to(http_safe_file/2, 2),
headers(list)
]).
:- predicate_options(http_safe_file/2, 2, [unsafe(boolean)]).
:- predicate_options(http_switch_protocol/2, 2,
[ headers(list)
]).
/** <module> Dispatch requests in the HTTP server
Most code doesn't need to use this directly; instead use
library(http/http_server), which combines this library with the
typical HTTP libraries that most servers need.
This module can be placed between http_wrapper.pl and the application
code to associate HTTP _locations_ to predicates that serve the pages.
In addition, it associates parameters with locations that deal with
timeout handling and user authentication. The typical setup is:
==
server(Port, Options) :-
http_server(http_dispatch,
[ port(Port)
| Options
]).
:- http_handler('/index.html', write_index, []).
write_index(Request) :-
...
==
*/
:- setting(http:time_limit, nonneg, 300,
'Time limit handling a single query (0=infinite)').
%! http_handler(+Path, :Closure, +Options) is det.
%
% Register Closure as a handler for HTTP requests. Path is either an
% absolute path such as =|'/home.html'|= or a term Alias(Relative).
% Where Alias is associated with a concrete path using http:location/3
% and resolved using http_absolute_location/3. `Relative` can be a
% single atom or a term `Segment1/Segment2/...`, where each element is
% either an atom or a variable. If a segment is a variable it matches
% any segment and the binding may be passed to the closure. If the
% last segment is a variable it may match multiple segments. This
% allows registering REST paths, for example:
%
% ```
% :- http_handler(root(user/User), user(Method, User),
% [ method(Method),
% methods([get,post,put])
% ]).
%
% user(get, User, Request) :-
% ...
% user(post, User, Request) :-
% ...
% ```
%
% If an HTTP request arrives at the server that matches Path, Closure
% is called as below, where `Request` is the parsed HTTP request.
%
% call(Closure, Request)
%
% Options is a list containing the following options:
%
% - authentication(+Type)
% Demand authentication. Authentication methods are pluggable. The
% library http_authenticate.pl provides a plugin for user/password
% based =Basic= HTTP authentication.
%
% - chunked
% Use =|Transfer-encoding: chunked|= if the client allows for it.
%
% - condition(:Goal)
% If present, the handler is ignored if Goal does not succeed.
%
% - content_type(+Term)
% Specifies the content-type of the reply. This value is currently
% not used by this library. It enhances the reflexive capabilities
% of this library through http_current_handler/3.
%
% - id(+Atom)
% Identifier of the handler. The default identifier is the
% predicate name. Used by http_location_by_id/2 and
% http_link_to_id/3.
%
% - hide_children(+Bool)
% If =true= on a prefix-handler (see prefix), possible children
% are masked. This can be used to (temporary) overrule part of the
% tree.
%
% - method(+Method)
% Declare that the handler processes Method. This is equivalent to
% methods([Method]). Using method(*) allows for all methods.
%
% - methods(+ListOfMethods)
% Declare that the handler processes all of the given methods. If
% this option appears multiple times, the methods are combined.
%
% - prefix
% Call Pred on any location that is a specialisation of Path. If
% multiple handlers match, the one with the longest path is used.
% Options defined with a prefix handler are the default options
% for paths that start with this prefix. Note that the handler
% acts as a fallback handler for the tree below it:
%
% ==
% :- http_handler(/, http_404([index('index.html')]),
% [spawn(my_pool),prefix]).
% ==
%
% - priority(+Integer)
% If two handlers handle the same path, the one with the highest
% priority is used. If equal, the last registered is used. Please
% be aware that the order of clauses in multifile predicates can
% change due to reloading files. The default priority is 0 (zero).
%
% - spawn(+SpawnOptions)
% Run the handler in a separate thread. If SpawnOptions is an
% atom, it is interpreted as a thread pool name (see
% create_thread_pool/3). Otherwise the options are passed to
% http_spawn/2 and from there to thread_create/3. These options
% are typically used to set the stack limits.
%
% - time_limit(+Spec)
% One of =infinite=, =default= or a positive number (seconds). If
% =default=, the value from the setting =http:time_limit= is
% taken. The default of this setting is 300 (5 minutes). See
% setting/2.
%
% Note that http_handler/3 is normally invoked as a directive and
% processed using term-expansion. Using term-expansion ensures proper
% update through make/0 when the specification is modified.
%
% @error existence_error(http_location, Location)
% @error permission_error(http_method, Method, Location)
% @see http_reply_file/3 and http_redirect/3 are generic
% handlers to serve files and achieve redirects.
:- dynamic handler/4. % Path, Action, IsPrefix, Options
:- multifile handler/4.
:- dynamic generation/1.
:- meta_predicate
http_handler(+, :, +),
http_current_handler(?, :),
http_current_handler(?, :, ?),
http_request_expansion(3, +),
http_switch_protocol(2, +).
http_handler(Path, Pred, Options) :-
compile_handler(Path, Pred, Options, Clause),
next_generation,
assert(Clause).
:- multifile
system:term_expansion/2.
system:term_expansion((:- http_handler(Path, Pred, Options)), Clause) :-
\+ current_prolog_flag(xref, true),
prolog_load_context(module, M),
compile_handler(Path, M:Pred, Options, Clause),
next_generation.
%! http_delete_handler(+Spec) is det.
%
% Delete handler for Spec. Typically, this should only be used for
% handlers that are registered dynamically. Spec is one of:
%
% * id(Id)
% Delete a handler with the given id. The default id is the
% handler-predicate-name.
%
% * path(Path)
% Delete handler that serves the given path.
http_delete_handler(id(Id)) :-
!,
clause(handler(_Path, _:Pred, _, Options), true, Ref),
functor(Pred, DefID, _),
option(id(Id0), Options, DefID),
Id == Id0,
erase(Ref),
next_generation.
http_delete_handler(path(Path)) :-
!,
retractall(handler(Path, _Pred, _, _Options)),
next_generation.
http_delete_handler(Path) :-
http_delete_handler(path(Path)).
%! next_generation is det.
%! current_generation(-G) is det.
%
% Increment the generation count.
next_generation :-
retractall(id_location_cache(_,_,_,_)),
with_mutex(http_dispatch, next_generation_unlocked).
next_generation_unlocked :-
retract(generation(G0)),
!,
G is G0 + 1,
assert(generation(G)).
next_generation_unlocked :-
assert(generation(1)).
current_generation(G) :-
with_mutex(http_dispatch, generation(G)),
!.
current_generation(0).
%! compile_handler(+Path, :Pred, +Options, -Clause) is det.
%
% Compile a handler specification.
compile_handler(Path, Pred, Options0,
http_dispatch:handler(Path1, Pred, IsPrefix, Options)) :-
check_path(Path, Path1, PathOptions),
check_id(Options0),
( memberchk(segment_pattern(_), PathOptions)
-> IsPrefix = true,
Options1 = Options0
; select(prefix, Options0, Options1)
-> IsPrefix = true
; IsPrefix = false,
Options1 = Options0
),
partition(ground, Options1, Options2, QueryOptions),
Pred = M:_,
maplist(qualify_option(M), Options2, Options3),
combine_methods(Options3, Options4),
( QueryOptions == []
-> append(PathOptions, Options4, Options)
; append(PathOptions, ['$extract'(QueryOptions)|Options4], Options)
).
qualify_option(M, condition(Pred), condition(M:Pred)) :-
Pred \= _:_, !.
qualify_option(_, Option, Option).
%! combine_methods(+OptionsIn, -Options) is det.
%
% Combine method(M) and methods(MList) options into a single
% methods(MList) option.
combine_methods(Options0, Options) :-
collect_methods(Options0, Options1, Methods),
( Methods == []
-> Options = Options0
; append(Methods, Flat),
sort(Flat, Unique),
( memberchk('*', Unique)
-> Final = '*'
; Final = Unique
),
Options = [methods(Final)|Options1]
).
collect_methods([], [], []).
collect_methods([method(M)|T0], T, [[M]|TM]) :-
!,
( M == '*'
-> true
; must_be_method(M)
),
collect_methods(T0, T, TM).
collect_methods([methods(M)|T0], T, [M|TM]) :-
!,
must_be(list, M),
maplist(must_be_method, M),
collect_methods(T0, T, TM).
collect_methods([H|T0], [H|T], TM) :-
!,
collect_methods(T0, T, TM).
must_be_method(M) :-
must_be(atom, M),
( method(M)
-> true
; domain_error(http_method, M)
).
method(get).
method(put).
method(head).
method(post).
method(delete).
method(patch).
method(options).
method(trace).
%! check_path(+PathSpecIn, -PathSpecOut, -Options) is det.
%
% Validate the given path specification. We want one of
%
% - AbsoluteLocation
% - Alias(Relative)
%
% Similar to absolute_file_name/3, Relative can be a term
% ``Component/Component/...``. Relative may be a `/` separated list of
% path segments, some of which may be variables. A variable patches
% any segment and its binding can be passed to the handler. If such a
% pattern is found Options is unified with
% `[segment_pattern(SegmentList)]`.
%
% @error domain_error, type_error
% @see http_absolute_location/3
check_path(Path, Path, []) :-
atom(Path),
!,
( sub_atom(Path, 0, _, _, /)
-> true
; domain_error(absolute_http_location, Path)
).
check_path(Alias, AliasOut, Options) :-
compound(Alias),
Alias =.. [Name, Relative],
!,
local_path(Relative, Local, Options),
( sub_atom(Local, 0, _, _, /)
-> domain_error(relative_location, Relative)
; AliasOut =.. [Name, Local]
).
check_path(PathSpec, _, _) :-
type_error(path_or_alias, PathSpec).
local_path(Atom, Atom, []) :-
atom(Atom),
!.
local_path(Path, Atom, Options) :-
phrase(path_to_list(Path), Components),
!,
( maplist(atom, Components)
-> atomic_list_concat(Components, '/', Atom),
Options = []
; append(Pre, [Var|Rest], Components),
var(Var)
-> append(Pre, [''], PreSep),
atomic_list_concat(PreSep, '/', Atom),
Options = [segment_pattern([Var|Rest])]
).
local_path(Path, _, _) :-
ground(Path),
!,
type_error(relative_location, Path).
local_path(Path, _, _) :-
instantiation_error(Path).
path_to_list(Var) -->
{ var(Var) },
!,
[Var].
path_to_list(A/B) -->
!,
path_to_list(A),
path_to_list(B).
path_to_list(Atom) -->
{ atom(Atom) },
!,
[Atom].
path_to_list(Value) -->
{ must_be(atom, Value) }.
check_id(Options) :-
memberchk(id(Id), Options),
!,
must_be(atom, Id).
check_id(_).
%! http_dispatch(Request) is det.
%
% Dispatch a Request using http_handler/3 registrations. It performs
% the following steps:
%
% 1. Find a matching handler based on the `path` member of Request.
% If multiple handlers match due to the `prefix` option or
% variables in path segments (see http_handler/3), the longest
% specification is used. If multiple specifications of equal
% length match the one with the highest priority is used.
% 2. Check that the handler matches the `method` member of the
% Request or throw permission_error(http_method, Method, Location)
% 3. Expand the request using expansion hooks registered by
% http_request_expansion/3. This may add fields to the request,
% such the authenticated user, parsed parameters, etc. The
% hooks may also throw exceptions, notably using http_redirect/3
% or by throwing `http_reply(Term, ExtraHeader, Context)`
% exceptions.
% 4. Extract possible fields from the Request using e.g.
% method(Method) as one of the options.
% 5. Call the registered _closure_, optionally spawning the
% request to a new thread or enforcing a time limit.
http_dispatch(Request) :-
memberchk(path(Path), Request),
find_handler(Path, Closure, Options),
supports_method(Request, Options),
expand_request(Request, Request1, Options),
extract_from_request(Request1, Options),
action(Closure, Request1, Options).
extract_from_request(Request, Options) :-
memberchk('$extract'(Fields), Options),
!,
extract_fields(Fields, Request).
extract_from_request(_, _).
extract_fields([], _).
extract_fields([H|T], Request) :-
memberchk(H, Request),
extract_fields(T, Request).
%! http_request_expansion(:Goal, +Rank:number)
%
% Register Goal for expanding the HTTP request handler. Goal is called
% as below. If Goal fail the request is passed to the next expansion
% unmodified.
%
% call(Goal, Request0, Request, Options)
%
% If multiple goals are registered they expand the request in a
% pipeline starting with the expansion hook with the lowest rank.
%
% Besides rewriting the request, for example by validating the user
% identity based on HTTP authentication or cookies and adding this to
% the request, the hook may raise HTTP exceptions to indicate a bad
% request, permission error, etc. See http_status_reply/4.
%
% Initially, auth_expansion/3 is registered with rank `100` to deal
% with the older http:authenticate/3 hook.
http_request_expansion(Goal, Rank) :-
throw(error(context_error(nodirective, http_request_expansion(Goal, Rank)), _)).
:- multifile
request_expansion/2.
system:term_expansion((:- http_request_expansion(Goal, Rank)),
http_dispatch:request_expansion(M:Callable, Rank)) :-
must_be(number, Rank),
prolog_load_context(module, M0),
strip_module(M0:Goal, M, Callable),
must_be(callable, Callable).
request_expanders(Closures) :-
findall(Rank-Closure, request_expansion(Closure, Rank), Pairs),
keysort(Pairs, Sorted),
pairs_values(Sorted, Closures).
%! expand_request(+Request0, -Request, +Options)
%
% Expand an HTTP request. Options is a list of combined options
% provided with the handler registration (see http_handler/3).
expand_request(Request0, Request, Options) :-
request_expanders(Closures),
expand_request(Closures, Request0, Request, Options).
expand_request([], Request, Request, _).
expand_request([H|T], Request0, Request, Options) :-
expand_request1(H, Request0, Request1, Options),
expand_request(T, Request1, Request, Options).
expand_request1(Closure, Request0, Request, Options) :-
call(Closure, Request0, Request, Options),
!.
expand_request1(_, Request, Request, _).
%! http_current_handler(+Location, :Closure) is semidet.
%! http_current_handler(-Location, :Closure) is nondet.
%
% True if Location is handled by Closure.
http_current_handler(Path, Closure) :-
atom(Path),
!,
path_tree(Tree),
find_handler(Tree, Path, Closure, _).
http_current_handler(Path, M:C) :-
handler(Spec, M:C, _, _),
http_absolute_location(Spec, Path, []).
%! http_current_handler(+Location, :Closure, -Options) is semidet.
%! http_current_handler(?Location, :Closure, ?Options) is nondet.
%
% Resolve the current handler and options to execute it.
http_current_handler(Path, Closure, Options) :-
atom(Path),
!,
path_tree(Tree),
find_handler(Tree, Path, Closure, Options).
http_current_handler(Path, M:C, Options) :-
handler(Spec, M:C, _, _),
http_absolute_location(Spec, Path, []),
path_tree(Tree),
find_handler(Tree, Path, _, Options).
%! http_location_by_id(+ID, -Location) is det.
%
% True when Location represents the HTTP path to which the handler
% with identifier ID is bound. Handler identifiers are deduced from
% the http_handler/3 declaration as follows:
%
% $ Explicit id :
% If a term id(ID) appears in the option list of the handler, ID
% it is used and takes preference over using the predicate.
% $ Using the handler predicate :
% ID matches a handler if the predicate name matches ID. The
% ID may have a module qualification, e.g., `Module:Pred`
%
% If the handler is declared with a pattern, e.g., root(user/User),
% the location to access a particular _user_ may be accessed using
% e.g., user('Bob'). The number of arguments to the compound term must
% match the number of variables in the path pattern.
%
% A plain atom ID can be used to find a handler with a pattern. The
% returned location is the path up to the first variable, e.g.,
% =|/user/|= in the example above.
%
% User code is adviced to use http_link_to_id/3 which can also add
% query parameters to the URL. This predicate is a helper for
% http_link_to_id/3.
%
% @error existence_error(http_handler_id, Id).
% @see http_link_to_id/3 and the library(http/html_write) construct
% location_by_id(ID) or its abbreviation `#(ID)`
:- dynamic
id_location_cache/4. % Id, Argv, Location, Segments
http_location_by_id(ID, _) :-
\+ ground(ID),
!,
instantiation_error(ID).
http_location_by_id(M:ID, Location) :-
compound(ID),
!,
compound_name_arguments(ID, Name, Argv),
http_location_by_id(M:Name, Argv, Location).
http_location_by_id(M:ID, Location) :-
atom(ID),
must_be(atom, M),
!,
http_location_by_id(M:ID, -, Location).
http_location_by_id(ID, Location) :-
compound(ID),
!,
compound_name_arguments(ID, Name, Argv),
http_location_by_id(Name, Argv, Location).
http_location_by_id(ID, Location) :-
atom(ID),
!,
http_location_by_id(ID, -, Location).
http_location_by_id(ID, _) :-
type_error(location_id, ID).
http_location_by_id(ID, Argv, Location) :-
id_location_cache(ID, Argv, Segments, Path),
!,
add_segments(Path, Segments, Location).
http_location_by_id(ID, Argv, Location) :-
findall(t(Priority, ArgvP, Segments, Prefix),
location_by_id(ID, Argv, ArgvP, Segments, Prefix, Priority),
List),
sort(1, >=, List, Sorted),
( Sorted = [t(_,ArgvP,Segments,Path)]
-> assert(id_location_cache(ID,ArgvP,Segments,Path)),
Argv = ArgvP
; List == []
-> existence_error(http_handler_id, ID)
; List = [t(P0,ArgvP,Segments,Path),t(P1,_,_,_)|_]
-> ( P0 =:= P1
-> print_message(warning,
http_dispatch(ambiguous_id(ID, Sorted, Path)))
; true
),
assert(id_location_cache(ID,Argv,Segments,Path)),
Argv = ArgvP
),
add_segments(Path, Segments, Location).
add_segments(Path0, [], Path) :-
!,
Path = Path0.
add_segments(Path0, Segments, Path) :-
maplist(uri_encoded(path), Segments, Encoded),
atomic_list_concat(Encoded, '/', Rest),
atom_concat(Path0, Rest, Path).
location_by_id(ID, -, _, [], Location, Priority) :-
!,
location_by_id_raw(ID, L0, _Segments, Priority),
to_path(L0, Location).
location_by_id(ID, Argv, ArgvP, Segments, Location, Priority) :-
location_by_id_raw(ID, L0, Segments, Priority),
include(var, Segments, ArgvP),
same_length(Argv, ArgvP),
to_path(L0, Location).
to_path(prefix(Path0), Path) :- % old style prefix notation
!,
add_prefix(Path0, Path).
to_path(Path0, Path) :-
atomic(Path0), % old style notation
!,
add_prefix(Path0, Path).
to_path(Spec, Path) :- % new style notation
http_absolute_location(Spec, Path, []).
add_prefix(P0, P) :-
( catch(setting(http:prefix, Prefix), _, fail),
Prefix \== ''
-> atom_concat(Prefix, P0, P)
; P = P0
).
location_by_id_raw(ID, Location, Pattern, Priority) :-
handler(Location, _, _, Options),
option(id(ID), Options),
option(priority(P0), Options, 0),
option(segment_pattern(Pattern), Options, []),
Priority is P0+1000. % id(ID) takes preference over predicate
location_by_id_raw(ID, Location, Pattern, Priority) :-
handler(Location, M:C, _, Options),
option(priority(Priority), Options, 0),
functor(C, PN, _),
( ID = M:PN
-> true
; ID = PN
),
option(segment_pattern(Pattern), Options, []).
%! http_link_to_id(+HandleID, +Parameters, -HREF)
%
% HREF is a link on the local server to a handler with given ID,
% passing the given Parameters. This predicate is typically used
% to formulate a HREF that resolves to a handler implementing a
% particular predicate. The code below provides a typical example.
% The predicate user_details/1 returns a page with details about a
% user from a given id. This predicate is registered as a handler.
% The DCG user_link//1 renders a link to a user, displaying the
% name and calling user_details/1 when clicked. Note that the
% location (root(user_details)) is irrelevant in this equation and
% HTTP locations can thus be moved freely without breaking this
% code fragment.
%
% ```
% :- http_handler(root(user_details), user_details, []).
%
% user_details(Request) :-
% http_parameters(Request,
% [ user_id(ID)
% ]),
% ...
%
% user_link(ID) -->
% { user_name(ID, Name),
% http_link_to_id(user_details, [id(ID)], HREF)
% },
% html(a([class(user), href(HREF)], Name)).
% ```
%
% @arg HandleID is either an atom, possibly module qualified
% predicate or a compound term if the hander is defined using
% a pattern. See http_handler/3 and http_location_by_id/2.
%
% @arg Parameters is one of
%
% - path_postfix(File) to pass a single value as the last
% segment of the HTTP location (path). This way of
% passing a parameter is commonly used in REST APIs.
%
% New code should use a path pattern in the handler declaration
% and a term `HandleID(Arg, ...)`
%
% - A list of search parameters for a =GET= request.
%
% @see http_location_by_id/2 and http_handler/3 for defining and
% specifying handler IDs.
http_link_to_id(HandleID, path_postfix(File), HREF) :-
!,
http_location_by_id(HandleID, HandlerLocation),
uri_encoded(path, File, EncFile),
directory_file_path(HandlerLocation, EncFile, Location),
uri_data(path, Components, Location),
uri_components(HREF, Components).
http_link_to_id(HandleID, Parameters, HREF) :-
must_be(list, Parameters),
http_location_by_id(HandleID, Location),
( Parameters == []
-> HREF = Location
; uri_data(path, Components, Location),
uri_query_components(String, Parameters),
uri_data(search, Components, String),
uri_components(HREF, Components)
).
%! http_reload_with_parameters(+Request, +Parameters, -HREF) is det.
%
% Create a request on the current handler with replaced search
% parameters.
http_reload_with_parameters(Request, NewParams, HREF) :-
memberchk(path(Path), Request),
( memberchk(search(Params), Request)
-> true
; Params = []
),
merge_options(NewParams, Params, AllParams),
uri_query_components(Search, AllParams),
uri_data(path, Data, Path),
uri_data(search, Data, Search),
uri_components(HREF, Data).
% hook into html_write:attribute_value//1.
:- multifile
html_write:expand_attribute_value//1.
html_write:expand_attribute_value(location_by_id(ID)) -->
{ http_location_by_id(ID, Location) },
html_write:html_quoted_attribute(Location).
html_write:expand_attribute_value(#(ID)) -->
{ http_location_by_id(ID, Location) },
html_write:html_quoted_attribute(Location).
%! authentication(+Options, +Request, -Fields) is det.
%
% Verify authentication information. If authentication is
% requested through Options, demand it. The actual verification is
% done by the multifile predicate http:authenticate/3. The library
% http_authenticate.pl provides an implementation thereof.
%
% @error permission_error(access, http_location, Location)
% @deprecated This hook predates the extensible request
% expansion provided by http_request_expansion/2. New hooks should use
% http_request_expansion/2 instead of http:authenticate/3.
:- multifile
http:authenticate/3.
authentication([], _, []).
authentication([authentication(Type)|Options], Request, Fields) :-
!,
( http:authenticate(Type, Request, XFields)
-> append(XFields, More, Fields),
authentication(Options, Request, More)
; memberchk(path(Path), Request),
permission_error(access, http_location, Path)
).
authentication([_|Options], Request, Fields) :-
authentication(Options, Request, Fields).
:- http_request_expansion(auth_expansion, 100).
%! auth_expansion(+Request0, -Request, +Options) is semidet.
%
% Connect the HTTP authentication infrastructure by means of
% http_request_expansion/2.
%
% @see http:authenticate/3, http_digest.pl and http_authenticate.pl
auth_expansion(Request0, Request, Options) :-
authentication(Options, Request0, Extra),
append(Extra, Request0, Request).
%! find_handler(+Path, -Action, -Options) is det.
%
% Find the handler to call from Path. Rules:
%
% * If there is a matching handler, use this.
% * If there are multiple prefix(Path) handlers, use the
% longest.
%
% If there is a handler for =|/dir/|= and the requested path is
% =|/dir|=, find_handler/3 throws a http_reply exception, causing
% the wrapper to generate a 301 (Moved Permanently) reply.
%
% @error existence_error(http_location, Location)
% @throw http_reply(moved(Dir))
% @tbd Introduce automatic redirection to indexes here?
find_handler(Path, Action, Options) :-
path_tree(Tree),
( find_handler(Tree, Path, Action, Options),
eval_condition(Options)
-> true
; \+ sub_atom(Path, _, _, 0, /),
atom_concat(Path, /, Dir),
find_handler(Tree, Dir, Action, Options),
\+ memberchk(segment_pattern(_), Options) % Variables in pattern
-> throw(http_reply(moved(Dir)))
; throw(error(existence_error(http_location, Path), _))
).
find_handler([node(prefix(Prefix), PAction, POptions, Children)|_],
Path, Action, Options) :-
sub_atom(Path, 0, _, After, Prefix),
!,
( option(hide_children(false), POptions, false),
find_handler(Children, Path, Action, Options)
-> true
; member(segment_pattern(Pattern, PatAction, PatOptions), POptions),
copy_term(t(Pattern,PatAction,PatOptions), t(Pattern2,Action,Options)),
match_segments(After, Path, Pattern2)
-> true
; PAction \== nop
-> Action = PAction,
path_info(After, Path, POptions, Options)
).
find_handler([node(Path, Action, Options, _)|_], Path, Action, Options) :- !.
find_handler([_|Tree], Path, Action, Options) :-
find_handler(Tree, Path, Action, Options).
path_info(0, _, Options,
[prefix(true)|Options]) :- !.
path_info(After, Path, Options,
[path_info(PathInfo),prefix(true)|Options]) :-
sub_atom(Path, _, After, 0, PathInfo).
match_segments(After, Path, [Var]) :-
!,
sub_atom(Path, _, After, 0, Var).
match_segments(After, Path, Pattern) :-
sub_atom(Path, _, After, 0, PathInfo),
split_string(PathInfo, "/", "", Segments),
match_segment_pattern(Pattern, Segments).
match_segment_pattern([], []).
match_segment_pattern([Var], Segments) :-
!,
atomic_list_concat(Segments, '/', Var).
match_segment_pattern([H0|T0], [H|T]) :-
atom_string(H0, H),
match_segment_pattern(T0, T).
eval_condition(Options) :-
( memberchk(condition(Cond), Options)
-> catch(Cond, E, (print_message(warning, E), fail))
; true
).
%! supports_method(+Request, +Options) is det.
%
% Verify that the asked http method is supported by the handler.
% If not, raise an error that will be mapped to a 405 page by the
% http wrapper.
%
% @error permission_error(http_method, Method, Location).
supports_method(Request, Options) :-
( option(methods(Methods), Options)
-> ( Methods == '*'
-> true
; memberchk(method(Method), Request),
memberchk(Method, Methods)
)
; true
),
!.
supports_method(Request, _Options) :-
memberchk(path(Location), Request),
memberchk(method(Method), Request),
permission_error(http_method, Method, Location).
%! action(+Action, +Request, +Options) is det.
%
% Execute the action found. Here we take care of the options
% =time_limit=, =chunked= and =spawn=.
%
% @error goal_failed(Goal)
action(Action, Request, Options) :-
memberchk(chunked, Options),
!,
format('Transfer-encoding: chunked~n'),
spawn_action(Action, Request, Options).
action(Action, Request, Options) :-
spawn_action(Action, Request, Options).
:- if(current_predicate(http_spawn/2)).
spawn_action(Action, Request, Options) :-
option(spawn(Spawn), Options),
!,
spawn_options(Spawn, SpawnOption),
http_spawn(time_limit_action(Action, Request, Options), SpawnOption).