package eliom

  1. Overview
  2. Docs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file eliom_parameter_base.ml

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
# 1 "src/lib/eliom_parameter_base.shared.ml"
(* Ocsigen
 * http://www.ocsigen.org
 * Copyright (C) 2007 Vincent Balat
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, with linking exception;
 * either version 2.1 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *)

open Eliom_lib

let section = Lwt_log.Section.make "eliom:parameter"

type params = (string * Eliommod_parameters.param) list
type params' = (string * string) list

type +'a param_name = string
(** Type of names in a form *)

type no_param_name
(** empty type used when it is not possible to use the parameter in a form *)

type ('a, 'b) binsum = Inj1 of 'a | Inj2 of 'b

type 'an listnames =
  {it : 'el 'a. ('an -> 'el -> 'a -> 'a) -> 'el list -> 'a -> 'a}

type coordinates = {abscissa : int; ordinate : int}
type 'a setoneradio = [`Set of 'a | `One of 'a | `Radio of 'a]
type 'a oneradio = [`One of 'a | `Radio of 'a]
type 'a setone = [`Set of 'a | `One of 'a]

type 'a to_and_of = 'a Eliom_common.to_and_of =
  {of_string : string -> 'a; to_string : 'a -> string}

type _ atom =
  | TFloat : float atom
  | TInt : int atom
  | TInt32 : int32 atom
  | TInt64 : int64 atom
  | TNativeint : nativeint atom
  | TBool : bool atom
  | TString : string atom

let string_of_atom (type a) (p : a atom) : a -> string =
  match p with
  | TFloat -> string_of_float
  | TInt -> string_of_int
  | TInt32 -> Int32.to_string
  | TInt64 -> Int64.to_string
  | TNativeint -> Nativeint.to_string
  | TBool -> string_of_bool
  | TString -> fun s -> s

let atom_of_string (type a) (p : a atom) : string -> a =
  match p with
  | TFloat -> float_of_string
  | TInt -> int_of_string
  | TInt32 -> Int32.of_string
  | TInt64 -> Int64.of_string
  | TNativeint -> Nativeint.of_string
  | TBool -> bool_of_string
  | TString -> fun s -> s

let to_from_of_atom x =
  {to_string = string_of_atom x; of_string = atom_of_string x}

type 'a filter = ('a -> unit) option
type raw = Eliom_request_info.raw_post_data
type 'a ocaml = string (* marshaled values of type 'a *)
type suff = [`WithoutSuffix | `WithSuffix | `Endsuffix]

type (_, _) params_type_ =
  | TProd :
      (('a, 'an) params_type_ * ('b, 'bn) params_type_)
      -> ('a * 'b, 'an * 'bn) params_type_
  | TOption : (('a, 'an) params_type_ * bool) -> ('a option, 'an) params_type_
  | TList :
      (string * ('a, 'an) params_type_)
      -> ('a list, 'an listnames) params_type_
  | TSet :
      ('a, [`One of 'an] param_name) params_type_
      -> ('a list, [`Set of 'an] param_name) params_type_
  | TSum :
      (('a, 'an) params_type_ * ('b, 'bn) params_type_)
      -> (('a, 'b) binsum, 'an * 'bn) params_type_
  | TAtom : (string * 'a atom) -> ('a, [`One of 'a] param_name) params_type_
  | TCoord :
      string
      -> (coordinates, [`One of coordinates] param_name) params_type_
  | TFile : string -> (file_info, [`One of file_info] param_name) params_type_
  | TUserType :
      (string * 'a Eliom_common.To_and_of_shared.t)
      -> ('a, [`One of 'a] param_name) params_type_
  | TTypeFilter : (('a, 'an) params_type_ * 'a filter) -> ('a, 'an) params_type_
  (* remove TCoord *)
  | TESuffix :
      string
      -> (string list, [`One of string list] param_name) params_type_
  | TESuffixs : string -> (string, [`One of string] param_name) params_type_
  | TESuffixu :
      (string * 'a Eliom_common.To_and_of_shared.t)
      -> ('a, [`One of 'a] param_name) params_type_
  | TSuffix : (bool * ('s, 'sn) params_type_) -> ('s, 'sn) params_type_
    (* bool = redirect the version without suffix to the suffix version *)
  | TUnit : (unit, unit) params_type_
  | TAny : ((string * string) list, unit) params_type_
  | TConst : string -> (unit, [`One of unit] param_name) params_type_
  | TNLParams : ('a, 'names) non_localized_params_ -> ('a, 'names) params_type_
  | TJson :
      (string * 'a Deriving_Json.t option)
      -> ('a, [`One of 'a ocaml] param_name) params_type_
  (* custom *)
  | TRaw_post_data : (raw, no_param_name) params_type_

and ('a, 'names) non_localized_params_ =
  { name : string
  ; persistent : bool
  ; get : 'a option Polytables.key
  ; post : 'a option Polytables.key
  ; param : ('a, 'names) params_type_ }

type ('a, +'suff, 'an) non_localized_params = ('a, 'an) non_localized_params_
  constraint 'suff = [< suff]

type ('a, +'suff, 'an) params_type = ('a, 'an) params_type_
  constraint 'suff = [< suff]

let int (n : string) = TAtom (n, TInt)
let int32 (n : string) = TAtom (n, TInt32)
let int64 (n : string) = TAtom (n, TInt64)
let float (n : string) = TAtom (n, TFloat)
let bool (n : string) = TAtom (n, TBool)
let string (n : string) = TAtom (n, TString)
let file (n : string) = TFile n
let unit = TUnit
let coordinates n = TCoord n
let type_checker check t = TTypeFilter (t, Some check)
let sum t1 t2 = TSum (t1, t2)
let prod t1 t2 = TProd (t1, t2)
let ( ** ) = prod
let opt t = TOption (t, false)
let neopt t = TOption (t, true)
let radio f (n : string) = TOption (f n, false)
let list (n : string) t = TList (n, t)
let set f (n : string) = TSet (f n)
let any = TAny
let suffix_const (v : string) = TConst v
let all_suffix (n : string) = TESuffix n
let all_suffix_string (n : string) = TESuffixs n

let suffix ?(redirect_if_not_suffix = true) s =
  TSuffix (redirect_if_not_suffix, s)

let suffix_prod ?(redirect_if_not_suffix = true)
    (s : ('s, [< `WithoutSuffix | `Endsuffix], 'sn) params_type)
    (t : ('a, [`WithoutSuffix], 'an) params_type) :
    ('s * 'a, [`WithSuffix], 'sn * 'an) params_type
  =
  TProd (TSuffix (redirect_if_not_suffix, s), t)

let ocaml (n : string) typ = TJson (n, Some typ)
let raw_post_data = TRaw_post_data

(******************************************************************)
let make_list_suffix i = "[" ^ string_of_int i ^ "]"

let rec make_suffix : type a c. (a, 'b, c) params_type -> a -> string list =
 fun typ params ->
  match typ with
  | TNLParams {param; _} -> make_suffix param params
  | TProd (t1, t2) -> make_suffix t1 (fst params) @ make_suffix t2 (snd params)
  | TAtom (_, a) -> [string_of_atom a params]
  | TCoord _ ->
      make_suffix (TAtom ("", TInt)) params.abscissa
      @ make_suffix (TAtom ("", TInt)) params.ordinate
  | TUnit -> [""]
  | TConst v -> [v]
  | TOption (t, _) -> (
    match params with None -> [""] | Some v -> make_suffix t v)
  | TList (_, t) -> (
    match params with
    | [] -> [""]
    | a :: l -> make_suffix t a @ make_suffix typ l)
  | TSet t -> (
    match params with
    | [] -> [""]
    | a :: l -> make_suffix t a @ make_suffix typ l)
  | TUserType (_, tao) -> [Eliom_common.To_and_of_shared.to_string tao params]
  | TTypeFilter (t, _check) -> make_suffix t params
  | TSum (t1, t2) -> (
    match params with Inj1 p -> make_suffix t1 p | Inj2 p -> make_suffix t2 p)
  | TESuffixs _ -> [params]
  (* | TAny ->       (match params with [] -> [""] | p -> p) *)
  | TESuffix _ -> ( match params with [] -> [""] | p -> p)
  | TESuffixu (_, tao) -> [Eliom_common.To_and_of_shared.to_string tao params]
  | TJson (_, typ) ->
      (* server or client side *)
      [to_json ?typ params]
  | _ -> raise (Eliom_Internal_Error "Bad parameter type in suffix")

let rec aux :
    type a c.
    (a, 'b, c) params_type
    -> string list option
    -> 'y
    -> a
    -> string
    -> string
    -> 'z
    -> 'x * 'y * (string * Eliommod_parameters.field) list
  =
 fun typ psuff nlp params pref suff l ->
  let open Eliommod_parameters in
  match typ with
  | TNLParams {name; param = t; _} ->
      let psuff, nlp, nl = aux t psuff nlp params pref suff [] in
      psuff, String.Table.add name nl nlp, l
  | TProd (t1, t2) ->
      let psuff, nlp, l1 = aux t1 psuff nlp (fst params) pref suff l in
      aux t2 psuff nlp (snd params) pref suff l1
  | TOption (t, _) -> (
    match params with
    | None -> psuff, nlp, l
    | Some v -> aux t psuff nlp v pref suff l)
  | TList (list_name, t) ->
      let pref2 = pref ^ list_name ^ suff ^ "." in
      fst
        (List.fold_left
           (fun ((psuff, nlp, s), i) p ->
              aux t psuff nlp p pref2 (make_list_suffix i) s, i + 1)
           ((psuff, nlp, l), 0)
           params)
  | TSet t ->
      List.fold_left
        (fun (psuff, nlp, l) v -> aux t psuff nlp v pref suff l)
        (psuff, nlp, l) params
  | TAtom (name, TBool) ->
      ( psuff
      , nlp
      , if params then (pref ^ name ^ suff, insert_string "on") :: l else l )
  | TAtom (name, a) ->
      ( psuff
      , nlp
      , (pref ^ name ^ suff, insert_string (string_of_atom a params)) :: l )
  | TCoord name ->
      ( psuff
      , nlp
      , let coord = params in
        (pref ^ name ^ suff ^ ".x", insert_string (string_of_int coord.abscissa))
        :: ( pref ^ name ^ suff ^ ".y"
           , insert_string (string_of_int coord.ordinate) )
        :: l )
  | TSum (t1, t2) -> (
    match params with
    | Inj1 v -> aux t1 psuff nlp v pref suff l
    | Inj2 v -> aux t2 psuff nlp v pref suff l)
  | TFile name -> psuff, nlp, (pref ^ name ^ suff, insert_file params) :: l
  | TUserType (name, tao) ->
      ( psuff
      , nlp
      , ( pref ^ name ^ suff
        , insert_string (Eliom_common.To_and_of_shared.to_string tao params) )
        :: l )
  | TTypeFilter (t, _check) -> aux t psuff nlp params pref suff l
  | TUnit -> psuff, nlp, l
  | TAny -> psuff, nlp, l @ List.map (fun (x, v) -> x, insert_string v) params
  | TConst _ -> psuff, nlp, l
  | TESuffix _ -> raise (Eliom_Internal_Error "Bad use of suffix")
  | TESuffixs _ -> raise (Eliom_Internal_Error "Bad use of suffix")
  | TESuffixu _ -> raise (Eliom_Internal_Error "Bad use of suffix")
  | TSuffix (_, s) -> Some (make_suffix s params), nlp, l
  | TJson (name, typ) ->
      (* server or client side *)
      psuff, nlp, (pref ^ name ^ suff, insert_string (to_json ?typ params)) :: l
  | TRaw_post_data ->
      failwith "Constructing an URL with raw POST data not possible"

(******************************************************************)
(* The following function takes a 'a params_type and a 'a and
   constructs the list of parameters (GET or POST)
   (This is a marshalling function towards HTTP parameters format) *)
let construct_params_list_raw nlp typ params = aux typ None nlp params "" "" []

(** Given a parameter type, get the two functions
    that converts from and to strings. You should
    only use this function on
    - options ;
    - basic types : int, int32, int64, float, string
    - marshal
    - unit
    - string
    - bool
 *)
let rec get_to_and_of : type a c. (a, 'b, c) params_type -> a to_and_of
  = function
  | TOption (o, _) ->
      let {to_string; of_string} = get_to_and_of o in
      { of_string = (fun s -> try Some (of_string s) with _ -> None)
      ; to_string = (function Some alpha -> to_string alpha | None -> "") }
  | TUserType (_, tao) -> Eliom_common.To_and_of_shared.to_and_of tao
  | TESuffixu (_, tao) -> Eliom_common.To_and_of_shared.to_and_of tao
  | TAtom (_, a) -> to_from_of_atom a
  | TJson (_, typ) ->
      (* server or client side *)
      { of_string = (fun s -> of_json ?typ s)
      ; to_string = (fun d -> to_json ?typ d) }
  | TUnit -> {of_string = (fun _ -> ()); to_string = (fun () -> "")}
  | _ -> failwith "get_to_and_of: not implemented"

(** Walk the parameter tree to search for a parameter, given its name *)
let rec walk_parameter_tree :
    type a c. string -> (a, 'b, c) params_type -> a to_and_of option
  =
 fun name x ->
  let get name' = if name = name' then Some (get_to_and_of x) else None in
  match x with
  | TUserType (name', _) -> get name'
  | TCoord name' -> get name'
  | TAtom (name', _) -> get name'
  | TFile name' -> get name'
  | TConst name' -> get name'
  | TESuffix name' -> get name'
  | TESuffixs name' -> get name'
  | TJson (name', _) -> get name'
  | TESuffixu (name', _) -> get name'
  | TTypeFilter (t, _) -> walk_parameter_tree name t
  | TSuffix (_, o) -> walk_parameter_tree name o
  | TAny -> None
  | TNLParams _ -> None
  | TUnit -> None
  | TOption (_, _) -> failwith "walk_parameter_tree with option"
  | TSet _ -> failwith "walk_parameter_tree with set"
  | TList (_, _) -> failwith "walk_parameter_tree with list"
  | TProd (_, _) -> failwith "walk_parameter_tree with tuple"
  | TSum (_, _) -> failwith "walk_parameter_tree with sum"
  | TRaw_post_data -> failwith "walk_parameter_tree with raw post data"

(* construct the string of parameters (& separated) for GET and POST *)
let construct_params_string l =
  Url.make_encoded_parameters (Eliommod_parameters.get_param_list l)

let construct_params_list nonlocparams typ p =
  let suff, nonlocparams, pl = construct_params_list_raw nonlocparams typ p in
  let nlp = String.Table.fold (fun _ l s -> l @ s) nonlocparams [] in
  let pl = pl @ nlp in
  (* pl at beginning *)
  suff, pl

let construct_params nonlocparams typ p =
  let suff, pl = construct_params_list nonlocparams typ p in
  suff, construct_params_string pl

let make_params_names params =
  let rec aux :
      type a c. bool -> string -> string -> (a, 'b, c) params_type -> bool * c
    =
   fun issuffix prefix suffix x ->
    match x with
    | TNLParams {param = t; _} -> aux issuffix prefix suffix t
    | TProd (t1, t2) ->
        let issuffix, a = aux issuffix prefix suffix t1 in
        let issuffix, b = aux issuffix prefix suffix t2 in
        issuffix, (a, b)
    | TAtom (name, _) -> issuffix, prefix ^ name ^ suffix
    | TCoord name -> issuffix, prefix ^ name ^ suffix
    | TFile name -> issuffix, prefix ^ name ^ suffix
    | TUserType (name, _) -> issuffix, prefix ^ name ^ suffix
    | TJson (name, _) -> issuffix, prefix ^ name ^ suffix
    | TUnit -> issuffix, ()
    | TAny -> issuffix, ()
    | TConst _ -> issuffix, ""
    | TSet t -> aux issuffix prefix suffix t
    | TESuffix n -> issuffix, n
    | TESuffixs n -> issuffix, n
    | TESuffixu (n, _) -> issuffix, n
    | TSuffix (_, t) -> aux true prefix suffix t
    | TOption (t, _) -> aux issuffix prefix suffix t
    | TSum (t1, t2) ->
        let _, a = aux issuffix prefix suffix t1 in
        let _, b = aux issuffix prefix suffix t2 in
        issuffix, (a, b)
    (* TSuffix cannot be inside TSum *)
    | TList (name, t1) ->
        ( issuffix
        , { it =
              (fun f l init ->
                let length = List.length l in
                snd
                  (List.fold_right
                     (fun el (i, l2) ->
                        let i' = i - 1 in
                        ( i'
                        , f
                            (snd
                               (aux issuffix
                                  (prefix ^ name ^ suffix ^ ".")
                                  (make_list_suffix i') t1))
                            el l2 ))
                     l (length, init))) } )
    (* TSuffix cannot be inside TList *)
    | TTypeFilter (t, _) -> aux issuffix prefix suffix t
    | TRaw_post_data -> failwith "Not possible with raw post data"
  in
  aux false "" "" params

let string_of_param_name = id

(* Add a prefix to parameters *)
let rec add_pref_params :
    type a c. string -> (a, 'b, c) params_type -> (a, 'b, c) params_type
  =
 fun pref x ->
  match x with
  | TNLParams t -> TNLParams {t with param = add_pref_params pref t.param}
  | TProd (t1, t2) -> TProd (add_pref_params pref t1, add_pref_params pref t2)
  | TOption (t, b) -> TOption (add_pref_params pref t, b)
  | TAtom (name, a) -> TAtom (pref ^ name, a)
  | TList (list_name, t) -> TList (pref ^ list_name, t)
  | TSet t -> TSet (add_pref_params pref t)
  | TSum (t1, t2) -> TSum (add_pref_params pref t1, add_pref_params pref t2)
  | TFile name -> TFile (pref ^ name)
  | TUserType (name, to_of) -> TUserType (pref ^ name, to_of)
  | TCoord name -> TCoord (pref ^ name)
  | TUnit -> TUnit
  | TAny -> TAny
  | TConst v -> TConst v (* ??? no recursive call ??? *)
  | TESuffix n -> TESuffix n
  | TESuffixs n -> TESuffixs n
  | TESuffixu a -> TESuffixu a
  | TSuffix s -> TSuffix s
  | TJson (name, typ) -> TJson (pref ^ name, typ)
  | TTypeFilter a -> TTypeFilter a (* ??? no recursive call ??? *)
  | TRaw_post_data ->
      failwith
        "Eliom_parameters: add_pref_params not possible with raw post data"

(*****************************************************************************)
(* Non localized parameters *)

let nl_prod (t : ('a, 'su, 'an) params_type)
    (s : ('s, [`WithoutSuffix], 'sn) non_localized_params) :
    ('a * 's, 'su, 'an * 'sn) params_type
  =
  TProd (t, TNLParams s)

(* removes from nlp set the nlp parameters that are present in param
   specification *)
let rec remove_from_nlp : type a c. 's -> (a, 'b, c) params_type -> 's =
 fun nlp x ->
  match x with
  | TNLParams {name = n; _} -> String.Table.remove n nlp
  | TProd (t1, t2) ->
      let nlp = remove_from_nlp nlp t1 in
      remove_from_nlp nlp t2
  | _ -> nlp

type nl_params_set = (string * Eliommod_parameters.param) list String.Table.t

let empty_nl_params_set = String.Table.empty

let add_nl_parameter (s : nl_params_set) t v =
  (fun (_, a, _) -> a) (construct_params_list_raw s (TNLParams t) v)

let table_of_nl_params_set = id
let list_of_nl_params_set nlp = snd (construct_params_list nlp unit ())

let string_of_nl_params_set nlp =
  Url.make_encoded_parameters
    (Eliommod_parameters.get_param_list (list_of_nl_params_set nlp))

let get_nl_params_names t = snd (make_params_names (TNLParams t))

let make_nlp_name persistent prefix name =
  let pr = if persistent then "p_" else "n_" in
  pr ^ prefix ^ "-" ^ name

let make_non_localized_parameters ~prefix ~name ?(persistent = false)
    (p : ('a, [`WithoutSuffix], 'b) params_type) :
    ('a, [`WithoutSuffix], 'b) non_localized_params
  =
  let name = make_nlp_name persistent prefix name in
  if String.contains name '.'
  then failwith "Non localized parameters names cannot contain dots."
  else
    { name
    ; persistent
    ; get = Polytables.make_key ()
    ; post = Polytables.make_key ()
    ; param = add_pref_params (Eliom_common.nl_param_prefix ^ name ^ ".") p }

(*****************************************************************************)
let rec contains_suffix : type a c. (a, 'b, c) params_type -> bool option
  = function
  | TProd (a, b) -> (
    match contains_suffix a with None -> contains_suffix b | c -> c)
  | TSuffix (b, _) -> Some b
  | _ -> None

(*****************************************************************************)

let rec wrap_param_type :
    type a c. (a, 'b, c) params_type -> (a, 'b, c) params_type
  = function
  | TNLParams t -> TNLParams {t with param = wrap_param_type t.param}
  | TProd (t1, t2) -> TProd (wrap_param_type t1, wrap_param_type t2)
  | TOption (t, b) -> TOption (wrap_param_type t, b)
  | TList (list_name, t) -> TList (list_name, t)
  | TSet t -> TSet (wrap_param_type t)
  | TSum (t1, t2) -> TSum (wrap_param_type t1, wrap_param_type t2)
  | TUserType (name, tao) ->
      (* Eliom_common.To_and_of_shared.wrapper will take care of tao *)
      TUserType (name, tao)
  (* We remove the type information here: not possible to send a
     closure.  marshaling is just basic json marshaling on client
     side. *)
  | TJson (name, _) -> TJson (name, None)
  (* the filter is only on server side (at least for now) *)
  | TTypeFilter (t, _) -> TTypeFilter (t, None)
  | t -> t

type _ is_unit = U_not : _ is_unit | U_yes : unit is_unit

let is_unit : type a c. (a, _, c) params_type -> a is_unit = function
  | TUnit -> U_yes
  | _ -> U_not

type anon_params_type = int

let anonymise_params_type (t : ('a, 'b, 'c) params_type) : anon_params_type =
  Hashtbl.hash_param 1000 1000 t

type files = (string * file_info) list

type +'a res_reconstr_param =
  | Res_ of 'a * params' * files
  | Errors_ of ((string * string * exn) list * params' * files)

let end_of_list lp pref =
  let f (a, _) =
    try String.(sub a 0 (length pref)) = pref with Invalid_argument _ -> false
  in
  not (List.exists f lp)

(* The following function reconstructs the value of parameters from
   expected type and GET or POST parameters *)
let reconstruct_params_ typ params files nosuffixversion urlsuffix : 'a =
  let rec parse_suffix :
      type a c. (a, 'b, c) params_type -> string list -> a * string list
    =
   fun typ suff ->
    match typ, suff with
    | TESuffix _, l -> l, [] (*VVV encode=false? *)
    | TESuffixs _, l -> Url.string_of_url_path ~encode:false l, []
    | TESuffixu (_, tao), l -> (
      try
        (*VVV encode=false? *)
        ( Eliom_common.To_and_of_shared.of_string tao
            (Url.string_of_url_path ~encode:false l)
        , [] )
      with e -> raise (Eliom_common.Eliom_Typing_Error ["<suffix>", e]))
    | TOption (_, _), [] -> None, []
    | TOption (_, _), "" :: l -> None, l
    | TOption (t, _), l ->
        let r, ll = parse_suffix t l in
        Some r, ll
    | TList _, [] -> [], []
    | TList (_, t), l -> (
        let b, l = parse_suffix t l in
        match l with
        | [] -> raise Eliom_common.Eliom_Wrong_parameter
        | [""] -> [b], []
        | _ ->
            let c, l = parse_suffix typ l in
            b :: c, l)
    | TSet (TAtom (_, TBool) as y), l ->
        let b, l = parse_suffix y l in
        [b], l
    | TSet t, l -> (
        let b, l = parse_suffix t l in
        match l with
        | [] -> raise Eliom_common.Eliom_Wrong_parameter
        | [""] -> [b], []
        | _ ->
            let c, l = parse_suffix typ l in
            b :: c, l)
    | TProd (TList _, _), _ ->
        failwith "Lists or sets in suffixes must be last parameters"
    | TProd (TSet _, _), _ ->
        failwith "Lists or sets in suffixes must be last parameters"
    | TProd (t1, t2), l -> (
      match parse_suffix t1 l with
      | _, [] -> raise Eliom_common.Eliom_Wrong_parameter
      | r, l ->
          let rr, ll = parse_suffix t2 l in
          (r, rr), ll)
    | TAtom (_name, t), v :: l -> (
      try atom_of_string t v, l
      with e -> raise (Eliom_common.Eliom_Typing_Error ["<suffix>", e]))
    | TUserType (_name, tao), v :: l -> (
      try Eliom_common.To_and_of_shared.of_string tao v, l
      with e -> raise (Eliom_common.Eliom_Typing_Error ["<suffix>", e]))
    | TTypeFilter (_, None), _ -> failwith "Type filter without filter"
    | TTypeFilter (t, Some check), l ->
        let ((v, _) as a) = parse_suffix t l in
        check v; a
    | TConst value, v :: l ->
        if v = value then (), l else raise Eliom_common.Eliom_Wrong_parameter
    | TSum (t1, t2), l -> (
      try
        let x, l = parse_suffix t1 l in
        Inj1 x, l
      with Eliom_common.Eliom_Wrong_parameter ->
        let x, l = parse_suffix t2 l in
        Inj2 x, l)
    | TCoord _, l -> (
      match parse_suffix (TAtom ("", TInt)) l with
      | _, [] -> raise Eliom_common.Eliom_Wrong_parameter
      | r, l ->
          let rr, ll = parse_suffix (TAtom ("", TInt)) l in
          {abscissa = r; ordinate = rr}, ll)
    | TNLParams _, _ ->
        failwith "It is not possible to have non localized parameters in suffix"
    | TJson (_, Some typ), v :: l -> Deriving_Json.from_string typ v, l
    | TJson (_, None), _ :: _ -> assert false (* client side only *)
    | TAny, _ ->
        failwith
          "It is not possible to use any in suffix. May be try with all_suffix ?"
    | TFile _, _ -> assert false
    | TRaw_post_data, _ -> assert false
    | TUnit, _ -> failwith "It is not possible to use TUnit in suffix."
    | TSuffix _, _ -> failwith "It is not possible to use TSuffix in suffix."
    | _, [] -> raise Eliom_common.Eliom_Wrong_parameter
  in
  let rec aux_list :
      type a c.
      (a, 'b, c) params_type
      -> params'
      -> files
      -> string
      -> string
      -> string
      -> a list res_reconstr_param
    =
   fun t params files name pref suff ->
    let rec loop_list i lp fl pref =
      if match t with
         | TFile _ -> end_of_list fl pref
         | _ -> end_of_list lp pref
      then Res_ ([], lp, fl)
      else
        match aux t lp fl pref (make_list_suffix i) with
        | Res_ (v, lp2, f) -> (
          match loop_list (i + 1) lp2 f pref with
          | Res_ (v2, lp3, f2) -> Res_ (v :: v2, lp3, f2)
          | err -> err)
        | Errors_ errs -> Errors_ errs
    in
    loop_list 0 params files (pref ^ name ^ suff ^ ".")
  and aux :
      type a c.
      (a, 'b, c) params_type
      -> params'
      -> files
      -> string
      -> string
      -> a res_reconstr_param
    =
   fun typ params files pref suff ->
    match typ with
    | TNLParams {param = t; _} -> aux t params files pref suff
    | TProd (t1, t2) -> (
      match aux t1 params files pref suff with
      | Res_ (v1, l1, f) -> (
        match aux t2 l1 f pref suff with
        | Res_ (v2, l2, f2) -> Res_ ((v1, v2), l2, f2)
        | Errors_ (err, params, files) -> Errors_ (err, params, files))
      | Errors_ (errs, l, f) -> (
        match aux t2 l f pref suff with
        | Res_ (_, ll, ff) -> Errors_ (errs, ll, ff)
        | Errors_ (errs2, ll, ff) -> Errors_ (errs2 @ errs, ll, ff)))
    | TOption ((TAtom (_, TString) as t), b) -> (
      try
        match aux t params files pref suff with
        | Res_ (v, l, f) ->
            if b && String.length v = 0 (* Is the value an empty string? *)
            then Res_ (None, l, f)
            else Res_ (Some v, l, f)
        | Errors_ (errs, ll, ff)
          when List.for_all (fun (_, s, _) -> s = "") errs ->
            Res_ (None, ll, ff)
        | Errors_ err -> Errors_ err
      with Not_found -> Res_ (None, params, files))
    | TOption (t, _) -> (
      try
        match aux t params files pref suff with
        | Res_ (v, l, f) -> Res_ (Some v, l, f)
        | Errors_ (errs, ll, ff)
          when List.for_all (fun (_, s, _) -> s = "") errs ->
            Res_ (None, ll, ff)
        | Errors_ err -> Errors_ err
      with Not_found -> Res_ (None, params, files))
    | TList (n, t) -> aux_list t params files n pref suff
    | TSet (TAtom (_, TBool) as y) -> (
      match aux y params files pref suff with
      | Res_ (vv, ll, ff) -> Res_ ([vv], ll, ff)
      | Errors_ (err, ll, ff) -> Errors_ (err, ll, ff))
    | TSet t ->
        let rec aux_set params files =
          try
            match aux t params files pref suff with
            | Res_ (vv, ll, ff) -> (
              match aux_set ll ff with
              | Res_ (vv2, ll2, ff2) -> Res_ (vv :: vv2, ll2, ff2)
              | err -> err)
            | Errors_ (_errs, ll, ff) when ll = params && ff = files ->
                Res_ ([], params, files)
            | Errors_ (errs, ll, ff) -> (
              match aux_set ll ff with
              | Res_ (_, ll2, ff2) -> Errors_ (errs, ll2, ff2)
              | Errors_ (errs2, ll2, ff2) -> Errors_ (errs @ errs2, ll2, ff2))
          with Not_found -> Res_ ([], params, files)
        in
        aux_set params files
    | TSum (t1, t2) -> (
      (* We try to decode both cases, if both succeed,
               we choose the one that consumes parameters
               (or the 1st one if none consumes) *)
      try
        match aux t1 params files pref suff with
        | Res_ (v1, l1, files1) ->
            if l1 = params
            then
              try
                match aux t2 params files pref suff with
                | Res_ (v2, l2, files2) when l2 <> params ->
                    Res_ (Inj2 v2, l2, files2)
                | _ -> Res_ (Inj1 v1, l1, files1)
              with Not_found -> Res_ (Inj1 v1, l1, files1)
            else Res_ (Inj1 v1, l1, files1)
        | Errors_ err -> Errors_ err
      with Not_found -> (
        match aux t2 params files pref suff with
        | Res_ (v, l, files) -> Res_ (Inj2 v, l, files)
        | Errors_ err -> Errors_ err))
    | TAtom (name, TBool) -> (
      try
        let _, l = List.assoc_remove (pref ^ name ^ suff) params in
        Res_ (true, l, files)
      with Not_found -> Res_ (false, params, files))
    | TAtom (name, a) -> (
        let v, l = List.assoc_remove (pref ^ name ^ suff) params in
        try Res_ (atom_of_string a v, l, files)
        with e -> Errors_ ([pref ^ name ^ suff, v, e], l, files))
    | TFile name -> (
      try
        let v, f = List.assoc_remove (pref ^ name ^ suff) files in
        Res_ (v, params, f)
      with e -> Errors_ ([pref ^ name ^ suff, "", e], [], files))
    | TCoord name -> (
        let r1 =
          let v, l = List.assoc_remove (pref ^ name ^ suff ^ ".x") params in
          try Res_ (int_of_string v, l, files)
          with e -> Errors_ ([pref ^ name ^ suff ^ ".x", v, e], l, files)
        in
        match r1 with
        | Res_ (x1, l1, f) -> (
            let v, l = List.assoc_remove (pref ^ name ^ suff ^ ".y") l1 in
            try Res_ ({abscissa = x1; ordinate = int_of_string v}, l, f)
            with e -> Errors_ ([pref ^ name ^ suff ^ ".y", v, e], l, f))
        | Errors_ (errs, l1, f) -> (
            let v, l = List.assoc_remove (pref ^ name ^ suff ^ ".y") l1 in
            try
              ignore (int_of_string v);
              Errors_ (errs, l, f)
            with e -> Errors_ ((pref ^ name ^ suff ^ ".y", v, e) :: errs, l, f))
        )
    | TUserType (name, tao) -> (
        let v, l = List.assoc_remove (pref ^ name ^ suff) params in
        try Res_ (Eliom_common.To_and_of_shared.of_string tao v, l, files)
        with e -> Errors_ ([pref ^ name ^ suff, v, e], l, files))
    | TTypeFilter (_, None) -> failwith "Type filter without filter"
    | TTypeFilter (t, Some check) -> (
      match aux t params files pref suff with
      | Res_ (v, l, files) as a -> (
        try check v; a with e -> Errors_ (["<type_check>", "<>", e], l, files))
      | a -> a)
    | TUnit -> Res_ ((), params, files)
    | TAny -> Res_ (params, [], files)
    | TConst _ -> Res_ ((), params, files)
    | TESuffix n ->
        let v, l = List.assoc_remove n params in
        (* cannot have prefix or suffix *)
        Res_ (Eliom_lib.Url.split_path v, l, files)
    | TESuffixs n ->
        let v, l = List.assoc_remove n params in
        (* cannot have prefix or suffix *)
        Res_ (v, l, files)
    | TESuffixu (n, tao) -> (
        let v, l = List.assoc_remove n params in
        (* cannot have prefix or suffix *)
        try Res_ (Eliom_common.To_and_of_shared.of_string tao v, l, files)
        with e -> Errors_ ([pref ^ n ^ suff, v, e], l, files))
    | TSuffix (_, s) -> (
      match urlsuffix with
      | None ->
          if nosuffixversion (* the special page name "nosuffix" is present *)
          then aux s params files pref suff
          else raise Eliom_common.Eliom_Wrong_parameter
      | Some urlsuffix -> (
        match parse_suffix s urlsuffix with
        | p, [] -> Res_ (p, params, files)
        | _ -> raise Eliom_common.Eliom_Wrong_parameter))
    | TJson (name, Some typ) ->
        let v, l = List.assoc_remove (pref ^ name ^ suff) params in
        Res_ (of_json ~typ v, l, files)
    | TJson (_name, None) -> assert false
    (* Never unmarshal server side without type! *)
    | TRaw_post_data -> raise Eliom_common.Eliom_Wrong_parameter
  in
  try
    match aux typ params files "" "" with
    | Res_ (v, l, files) ->
        if (l, files) = ([], [])
        then v
        else (
          if l <> []
          then
            Lwt_log.ign_debug_f ~section
              "Eliom_Wrong_parameter: params non-empty (ERROR): %a"
              (fun () l ->
                 String.concat ", " (List.map (fun (x, k) -> x ^ "=" ^ k) l))
              l;
          if files <> []
          then
            Lwt_log.ign_debug_f ~section
              "Eliom_Wrong_parameter: files non-empty (ERROR): %a"
              (fun () files ->
                 String.concat ", " (List.map (fun (x, _) -> x) files))
              files;
          raise Eliom_common.Eliom_Wrong_parameter)
    | Errors_ (errs, l, files) ->
        if (l, files) = ([], [])
        then
          raise
            (Eliom_common.Eliom_Typing_Error
               (List.map (fun (v, _, e) -> v, e) errs))
        else raise Eliom_common.Eliom_Wrong_parameter
  with Not_found -> raise Eliom_common.Eliom_Wrong_parameter

let reconstruct_params ~sp (type a c) (typ : (a, 'b, c) params_type) params
    files nosuffixversion urlsuffix : a Lwt.t
  =
  match typ, params, files with
  (* FIXME *)
  | TRaw_post_data, None, None -> Eliom_request_info.raw_post_data sp
  | typ, None, None -> (
    try Lwt.return (reconstruct_params_ typ [] [] nosuffixversion urlsuffix)
    with e -> Lwt.fail e)
  | typ, _, _ -> (
      let%lwt params =
        match params with Some params -> params | None -> Lwt.return_nil
      in
      let%lwt files =
        match files with Some files -> files | None -> Lwt.return_nil
      in
      try
        Lwt.return
          (reconstruct_params_ typ params files nosuffixversion urlsuffix)
      with e -> Lwt.fail e)
OCaml

Innovation. Community. Security.