3 OCaml HTTP - do it yourself (fully OCaml) HTTP daemon
5 Copyright (C) <2002> Stefano Zacchiroli <zack@cs.unibo.it>
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 exception Malformed_query of string
26 exception Malformed_query_binding of string * string
27 exception Unsupported_method of string
28 exception Unsupported_HTTP_version of string
29 exception Malformed_request_URI of string
30 exception Malformed_request of string
33 type url_syntax_option =
34 Url_part_not_recognized
38 * (1) scheme://user:password@host:port/path;params?query#fragment
41 let request_uri_syntax = {
42 url_enable_scheme = Url_part_not_recognized;
43 url_enable_user = Url_part_not_recognized;
44 url_enable_password = Url_part_not_recognized;
45 url_enable_host = Url_part_not_recognized;
46 url_enable_port = Url_part_not_recognized;
47 url_enable_path = Url_part_required;
48 url_enable_param = Url_part_not_recognized;
49 url_enable_query = Url_part_allowed;
50 url_enable_fragment = Url_part_not_recognized;
51 url_enable_other = Url_part_not_recognized;
52 url_accepts_8bits = false;
53 url_is_valid = (fun _ -> true);
56 (** given an HTTP like query string (e.g. "name1=value1&name2=value2&...")
57 @return a list of pairs [("name1", "value1"); ("name2", "value2")]
58 @raise Malformed_query if the string isn't a valid query string
59 @raise Malformed_query_binding if some piece of the query isn't valid
61 let split_query_params =
62 let (bindings_sep, binding_sep) = (Pcre.regexp "&", Pcre.regexp "=") in
63 let http_decode url = Netencoding.Url.decode ~plus:false url in
65 let bindings = Pcre.split ~rex:bindings_sep query in
66 if List.length bindings < 1 then
67 raise (Malformed_query query);
70 let pieces = Pcre.split ~rex:binding_sep binding in
71 if List.length pieces <> 2 then
72 raise (Malformed_query_binding (binding, query));
74 | [a; b] -> (http_decode a, http_decode b)
78 (** given an input channel and a separator
79 @return a line read from it (like Pervasives.input_line)
80 line is returned only after reading a separator string; separator string isn't
81 included in the returned value
82 FIXME what about efficiency?, input is performed char-by-char
84 let generic_input_line ~sep ~ic =
85 let sep_len = String.length sep in
87 failwith ("Separator '" ^ sep ^ "' is too short!")
88 else (* valid separator *)
90 let sep_pointer = ref 0 in
93 if !sep_pointer >= String.length sep then (* line completed *)
95 else begin (* incomplete line: need to read more *)
96 let ch = input_char ic in
97 if ch = String.get sep !sep_pointer then (* next piece of sep *)
99 else begin (* useful char *)
100 for i = 0 to !sep_pointer - 1 do
101 line := !line ^ (String.make 1 (String.get sep i))
104 line := !line ^ (String.make 1 ch)
108 assert false (* unreacheable statement *)
115 (** given an input channel, reads from it a GET HTTP request and
116 @return a pair <path, query_params> where path is a string representing the
117 requested path and query_params is a list of pairs <name, value> (the GET
121 let patch_empty_path s = (if s = "" then "/" else s) in
122 let pieces_sep = Pcre.regexp " " in
124 let request_line = generic_input_line ~sep:Http_common.crlf ~ic in
125 match Pcre.split ~rex:pieces_sep request_line with
126 | [meth; request_uri_raw; http_version] ->
127 if meth <> "GET" then
128 raise (Unsupported_method meth);
129 (match http_version with
130 | "HTTP/1.0" | "HTTP/1.1" -> ()
131 | _ -> raise (Unsupported_HTTP_version http_version));
134 url_of_string request_uri_syntax request_uri_raw
135 with Malformed_URL ->
136 raise (Malformed_request_URI request_uri_raw)
139 patch_empty_path (String.concat "/" (url_path request_uri))
142 try (* act on HTTP encoded URIs *)
143 split_query_params (url_query ~encoded:true request_uri)
146 Http_common.debug_print
148 "recevied request; path: %s; params: %s"
152 (List.map (fun (n, v) -> n ^ "=" ^ v) query_params)));
154 | _ -> raise (Malformed_request request_line)