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
|
(* Js_of_ocaml library
* http://www.ocsigen.org/js_of_ocaml/
* Copyright (C) 2010 Raphaël Proust
* Laboratoire PPS - CNRS Université Paris Diderot
*
* 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.
*)
(** This module provides functions for tampering with Url. It's main goal is to
allow one to stay in the Ocaml realm without wandering into the
{!Dom_html.class-type-window}##.location object. *)
(** The first functions are mainly from and to string conversion functions for
the different parts of a url. *)
val urldecode : string -> string
(** [urldecode s] swaps percent encoding characters for their usual
representation. *)
val urlencode : ?with_plus:bool -> string -> string
(** [urlencode ?with_plus s] replace characters for their percent encoding
representation. Note that the '/' (slash) character is escaped as well. If
[with_plus] is [true] (default) then ['+']'s are escaped as ["%2B"]. If not,
['+']'s are left as is. *)
type http_url =
{ hu_host : string (** The host part of the url. *)
; hu_port : int (** The port for the connection if any. *)
; hu_path : string list (** The path split on ['/'] characters. *)
; hu_path_string : string (** The original entire path. *)
; hu_arguments : (string * string) list
(** Arguments as a field-value
association list.*)
; hu_fragment : string (** The fragment part (after the ['#'] character). *)
}
(** The type for HTTP(s) url. *)
type file_url =
{ fu_path : string list
; fu_path_string : string
; fu_arguments : (string * string) list
; fu_fragment : string
}
(** The type for local file urls. *)
(** The type for urls. *)
type url =
| Http of http_url (**Non secure HTTP urls*)
| Https of http_url (**Secure HTTPS urls*)
| File of file_url (**Local files*)
val default_http_port : int
(** The default port for [Http] communications (80). *)
val default_https_port : int
(** The default port for [Https] communications (443). *)
val path_of_path_string : string -> string list
(** [path_of_path_string s] splits [s] on each ["/"] character. *)
val encode_arguments : (string * string) list -> string
(** [encode_arguments a] expects a list of pair of values of the form
[(name,value)] were [name] is the name of an argument and [value] it's
associated value. *)
val decode_arguments : string -> (string * string) list
(** [decode_arguments s] parses [s] returning the sliced-diced
association list. [s] should be only the arguments part (after the '?')
not the whole url. *)
(** The following part allow one to handle Url object in a much higher level
than what a string provides. *)
val url_of_string : string -> url option
(** [url_of_string s] parses [s] and builds a value of type [url] if [s] is not
a valid url string, it returns [None]. *)
val string_of_url : url -> string
(** [string_of_url u] returns a valid string representation of [u]. Note that
* [string_of_url ((fun Some u -> u) (url_of_string s))] is NOT necessarily
* equal to [s]. However [url_of_string (string_of_url u) = u]. *)
(** This module can be used to handle the Url associated to the current
document. *)
module Current : sig
val host : string
(** The host part of the current url. *)
val port : int option
(** The port of the current url. *)
val protocol : string
(** The protocol of the current url. *)
val path_string : string
(** The path of the current url as one long string. *)
val path : string list
(** The path of the current url as a list of small string. *)
val arguments : (string * string) list
(** The arguments of the current url as an association list. *)
val get_fragment : unit -> string
(** Because the [fragment] of the Url for the current document can change
dynamically, we use a functional value here. *)
val set_fragment : string -> unit
(** [set_fragment s] replaces the current fragment by [s]. *)
val get : unit -> url option
(** [get ()] returns a value of type {!url} with fields reflecting the
state of the current Url. *)
val set : url -> unit
(** [set u] replaces the current Url for [u]. {b WARNING:} Causes the
document to change. *)
val as_string : string
(** [as_string] is the original string representation of the current Url. It
is NOT necessarily equals to [string_of_url (get ())] but
[url_of_string as_string = get ()] holds. *)
end
|
