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
32 prerr_endline ("DEBUG: " ^ str);
36 let default_addr = "0.0.0.0"
38 let default_timeout = 300
39 let default_mode = `Fork
41 (** send raw data on outchan, flushing it afterwards *)
42 let send_raw ~data outchan =
43 output_string outchan data;
46 let send_CRLF = send_raw ~data:crlf
48 let send_header ~header ~value =
49 Http_parser_sanity.heal_header (header, value);
50 send_raw ~data:(header ^ ": " ^ value ^ crlf)
52 let send_headers ~headers outchan =
53 List.iter (fun (header, value) -> send_header ~header ~value outchan) headers
55 (** internal: parse a code argument from a function which have two optional
56 arguments "code" and "status" *)
57 let get_code_argument func_name =
59 (match code, status with
61 | None, Some s -> code_of_status s
62 | Some _, Some _ -> (* TODO use some static type checking *)
63 failwith (func_name ^ " you must give 'code' or 'status', not both")
64 | None, None -> (* TODO use some static type checking *)
65 failwith (func_name ^ " you must give 'code' or 'status', not none"))
67 (** internal: low level for send_status_line *)
68 let send_status_line' ~version ~code =
72 [ string_of_version version;
74 Http_misc.reason_phrase_of_code code ]
76 send_raw ~data:(status_line ^ crlf)
78 let send_status_line ?(version = http_version) ?code ?status outchan =
81 ~code:(get_code_argument "Daemon.send_status_line" ~code ~status)
84 (* FIXME duplication of code between this and response#addBasicHeaders *)
85 let send_basic_headers ?(version = http_version) ?code ?status outchan =
87 ~version ~code:(get_code_argument "Daemon.send_basic_headers" ~code ~status)
90 ~headers:["Date", Http_misc.date_822 (); "Server", server_string]
93 (** internal: given a status code and an additional body return a string
94 representing an HTML document that explains the meaning of given status code.
95 Additional data can be added to the body via 'body' argument *)
96 let foo_body code body =
97 let reason_phrase = Http_misc.reason_phrase_of_code code in
99 "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">
105 code reason_phrase code reason_phrase body
107 (** internal: send a fooish body explaining in HTML form the 'reason phrase'
108 of an HTTP response; body, if given, will be appended to the body *)
109 let send_foo_body code body = send_raw ~data:(foo_body code body)
112 (* Warning: keep default values in sync with Http_response.response class *)
113 ?(body = "") ?(headers = [])
114 ?(version = http_version) ?(code = 200) ?status outchan
119 | Some s -> code_of_status s
121 send_basic_headers ~version ~code outchan;
122 send_headers ~headers outchan;
123 send_header "Content-Length" (string_of_int (String.length body)) outchan;
125 send_raw ~data:body outchan
127 (** internal: low level for respond_redirect, respond_error, ...
128 This function send a status line corresponding to a given code, some basic
129 headers, the additional headers (if given) and an HTML page containing the
130 reason phrase; if body is given it will be included in the body of the HTML
132 let send_empty_response
133 func_name ?(is_valid_status = fun _ -> true) ?(headers = []) ~body () =
134 fun ?(version = http_version) ?code ?status outchan ->
135 let code = get_code_argument func_name ~code ~status in
136 if not (is_valid_status code) then
138 (sprintf "'%d' isn't a valid status code for %s" code func_name)
139 else begin (* status code suitable for answering *)
142 "Connection", "close";
143 "Content-Type", "text/html; charset=iso-8859-1"
146 let body = (foo_body code body) ^ body in
147 respond ~version ~code ~headers ~body outchan
149 (* OLD VERSION, now use 'respond' function *)
150 send_basic_headers ~version ~code outchan;
151 send_header ~header:"Connection" ~value:"close" outchan;
153 ~header:"Content-Type"
154 ~value:"text/html; charset=iso-8859-1"
156 send_headers ~headers outchan;
158 send_foo_body ~code ~body outchan
163 ~location ?(body = "") ?(version = http_version) ?(code = 301) ?status outchan
168 | Some (s: Http_types.redirection_status) -> code_of_status s
171 "Daemon.respond_redirect" ~is_valid_status:is_redirection
172 ~headers:["Location", location] ~body ()
173 ~version ~code outchan
176 ?(body = "") ?(version = http_version) ?(code = 400) ?status outchan =
180 | Some s -> code_of_status s
183 "Daemon.respond_error" ~is_valid_status:is_error ~body ()
184 ~version ~code outchan
186 let respond_not_found ~url ?(version = http_version) outchan =
188 "Daemon.respond_not_found" ~body:"" () ~version ~code:404 outchan
190 let respond_forbidden ~url ?(version = http_version) outchan =
192 "Daemon.respond_permission_denied" ~body:"" () ~version ~code:403 outchan
194 let send_file ?name ?file outchan =
196 let buf = String.make buflen ' ' in
197 let (file, cleanup) =
198 (match (name, file) with
199 | Some n, None -> (* if we open the file, we close it before returning *)
201 f, (fun () -> close_in f)
202 | None, Some f -> (f, (fun () -> ()))
203 | _ -> (* TODO use some static type checking *)
204 failwith "Daemon.send_file: either name or file must be given")
208 let bytes = input file buf 0 buflen in
212 output outchan buf 0 bytes
221 (* TODO interface is too ugly to advertise this function in .mli *)
222 (** create a minimal HTML directory listing of a given directory and send it
223 over an out_channel, directory is passed as a dir_handle; name is the
224 directory name, used for pretty printing purposes; path is the opened dir
225 path, used to test its contents with stat *)
226 let send_dir_listing ~dir ~name ~path outchan =
227 fprintf outchan "<html>\n<head><title>%s</title></head>\n<body>\n" name;
229 List.partition (fun e -> Http_misc.is_directory (path ^ e)) (Http_misc.ls dir)
232 (fun d -> fprintf outchan "<a href=\"%s/\">%s/</a><br />\n" d d)
233 (List.sort compare dirs);
235 (fun f -> fprintf outchan "<a href=\"%s\">%s</a><br />\n" f f)
236 (List.sort compare files);
237 fprintf outchan "</body>\n</html>";
240 let respond_file ~fname ?(version = http_version) outchan =
241 (** ASSUMPTION: 'fname' doesn't begin with a "/"; it's relative to the current
242 document root (usually the daemon's cwd) *)
243 let droot = Sys.getcwd () in (* document root *)
244 let path = droot ^ "/" ^ fname in (* full path to the desired file *)
245 if not (Sys.file_exists path) then (* file not found *)
246 respond_not_found ~url:fname outchan
249 if Http_misc.is_directory path then begin (* file found, is a dir *)
250 let dir = Unix.opendir path in
251 send_basic_headers ~version ~code:200 outchan;
252 send_header "Content-Type" "text/html" outchan;
254 send_dir_listing ~dir ~name:fname ~path outchan;
256 end else begin (* file found, is something else *)
257 let file = open_in fname in
258 send_basic_headers ~version ~code:200 outchan;
260 ~header:"Content-Length"
261 ~value:(string_of_int (Http_misc.filesize fname))
264 send_file ~file outchan;
268 | Unix.Unix_error (Unix.EACCES, s, _) when (s = fname) ->
269 respond_forbidden ~url:fname ~version outchan
271 (Pcre.pmatch ~rex:(Pcre.regexp (fname ^ ": Permission denied")) s) ->
272 respond_forbidden ~url:fname ~version outchan
275 let respond_with (res: Http_types.response) outchan =
276 res#serialize outchan;
279 (** internal: this exception is raised after a malformed request has been read
280 by a serving process to signal main server (or itself if mode = `Single) to
281 skip to next request *)
284 (* given a Http_parser.parse_request like function, wrap it in a function that
285 do the same and additionally catch parsing exception sending HTTP error
286 messages back to client as needed. Returned function raises Again when it
287 encounter a parse error (name 'Again' is intended for future versions that
288 will support http keep alive signaling that a new request has to be parsed
290 let rec wrap_parse_request_w_safety parse_function inchan outchan =
293 parse_function inchan
296 respond_error ~code:400 ~body:"Unexpected End Of File" outchan;
298 | Malformed_request req ->
302 "request 1st line format should be: '<method> <url> <version>'" ^
303 "<br />\nwhile received request 1st line was:<br />\n" ^ req)
306 | Unsupported_method meth ->
309 ~body:("Method '" ^ meth ^ "' isn't supported (yet)")
312 | Malformed_request_URI uri ->
313 respond_error ~code:400 ~body:("Malformed URL: '" ^ uri ^ "'") outchan;
315 | Unsupported_HTTP_version version ->
318 ~body:("HTTP version '" ^ version ^ "' isn't supported (yet)")
321 | Malformed_query query ->
323 ~code:400 ~body:(sprintf "Malformed query string '%s'" query) outchan;
325 | Malformed_query_part (binding, query) ->
329 sprintf "Malformed query part '%s' in query '%s'" binding query)
332 (* (* preliminary support for HTTP keep alive connections ... *)
334 wrap_parse_request_w_safety parse_function inchan outchan
337 (* wrapper around Http_parser.parse_request which catch parsing exceptions and
338 return error messages to client as needed
339 @param inchan in_channel from which read incoming requests
340 @param outchan out_channl on which respond with error messages if needed
342 let safe_parse_request = wrap_parse_request_w_safety parse_request
344 (* as above but for OO version (Http_parser.parse_request') *)
345 let safe_parse_request' = wrap_parse_request_w_safety (new Http_request.request)
347 let chdir_to_document_root = function (* chdir to document root *)
348 | Some dir -> Sys.chdir dir
351 let server_of_mode = function
352 | `Single -> Http_tcp_server.simple
353 | `Fork -> Http_tcp_server.ocaml_builtin
354 | `Thread -> Http_tcp_server.thread
356 (* TODO support also chroot to 'root', not only chdir *)
357 (* curried request *)
359 ?(addr = default_addr) ?(port = default_port)
360 ?(timeout = Some default_timeout) ?(mode = default_mode) ?root callback
362 chdir_to_document_root root;
363 let sockaddr = Http_misc.build_sockaddr (addr, port) in
364 let daemon_callback inchan outchan =
366 let (path, parameters) = safe_parse_request inchan outchan in
367 callback path parameters outchan;
372 (server_of_mode mode) ~sockaddr ~timeout daemon_callback
377 ?(addr = default_addr) ?(port = default_port)
378 ?(timeout = Some default_timeout) ?(mode = default_mode) ?root callback
380 chdir_to_document_root root;
381 let sockaddr = Http_misc.build_sockaddr (addr, port) in
382 let daemon_callback inchan outchan =
384 let req = safe_parse_request' inchan outchan in
385 callback req outchan;
390 (server_of_mode mode) ~sockaddr ~timeout daemon_callback
395 let callback path _ outchan =
396 if not (Pcre.pmatch ~rex:(Pcre.regexp "^/") path) then
397 respond_error ~code:400 outchan
399 respond_file ~fname:(Http_misc.strip_heading_slash path) outchan
400 let start ?(addr = default_addr) ?(port = default_port) () =
401 start ~addr ~port callback
404 (* @param inchan input channel connected to client
405 @param outchan output channel connected to client
406 @param sockaddr client socket address *)
407 class connection inchan outchan sockaddr =
408 (* ASSUMPTION: inchan and outchan are channels built on top of the same
409 Unix.file_descr thus closing one of them will close also the other *)
410 let close' o = o#close in
413 initializer Gc.finalise close' self
415 val mutable closed = false
417 method private assertNotClosed =
419 failwith "Http_daemon.connection: connection is closed"
422 self#assertNotClosed;
424 Some (safe_parse_request' inchan outchan)
427 method respond_with res =
428 self#assertNotClosed;
429 respond_with res outchan
432 self#assertNotClosed;
433 close_in inchan; (* this close also outchan *)
438 class daemon ?(addr = "0.0.0.0") ?(port = 80) () =
442 Http_tcp_server.init_socket (Http_misc.build_sockaddr (addr, port))
445 let (cli_suck, cli_sockaddr) = Unix.accept suck in (* may block *)
446 let (inchan, outchan) =
447 (Unix.in_channel_of_descr cli_suck, Unix.out_channel_of_descr cli_suck)
449 new connection inchan outchan cli_sockaddr
452 let conn = self#accept in
453 match conn#getRequest with
457 | Some req -> (req, conn)