helm/DEVEL/ocaml-http/http_daemon.ml

   1
   2 (*
   3   OCaml HTTP - do it yourself (fully OCaml) HTTP daemon
   4
   5   Copyright (C) <2002-2004> Stefano Zacchiroli <zack@cs.unibo.it>
   6
   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.
  11
  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.
  16
  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
  20 *)
  21
  22 open Printf;;
  23
  24 open Http_common;;
  25 open Http_types;;
  26 open Http_constants;;
  27 open Http_parser;;
  28
  29   (** send raw data on outchan, flushing it afterwards *)
  30 let send_raw ~data outchan =
  31   output_string outchan data;
  32   flush outchan
  33
  34 let send_CRLF = send_raw ~data:crlf
  35
  36 let send_header ~header ~value =
  37   Http_parser_sanity.heal_header (header, value);
  38   send_raw ~data:(header ^ ": " ^ value ^ crlf)
  39
  40 let send_headers ~headers outchan =
  41   List.iter (fun (header, value) -> send_header ~header ~value outchan) headers
  42
  43   (** internal: low level for send_status_line *)
  44 let send_status_line' ~version code =
  45   let status_line =
  46     String.concat
  47       " "
  48       [ string_of_version version;
  49       string_of_int code;
  50       Http_misc.reason_phrase_of_code code ]
  51   in
  52   send_raw ~data:(status_line ^ crlf)
  53
  54 let int_of_code = function
  55   | `Code code -> code
  56   | `Status status -> code_of_status status
  57
  58 let send_status_line ?(version = http_version) ~(code: status_code) outchan =
  59   send_status_line' ~version (int_of_code code) outchan
  60
  61   (* FIXME duplication of code between this and response#addBasicHeaders *)
  62 let send_basic_headers ?(version = http_version) ~(code: status_code) outchan =
  63   send_status_line' ~version (int_of_code code) outchan;
  64   send_headers
  65     ~headers:["Date", Http_misc.date_822 (); "Server", server_string]
  66     outchan
  67
  68   (** internal: given a status code and an additional body return a string
  69   representing an HTML document that explains the meaning of given status code.
  70   Additional data can be added to the body via 'body' argument *)
  71 let foo_body code body =
  72   let reason_phrase = Http_misc.reason_phrase_of_code code in
  73   sprintf
  74 "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">
  75 <HTML><HEAD>
  76 <TITLE>%d %s</TITLE>
  77 </HEAD><BODY>
  78 <H1>%d - %s</H1>%s
  79 </BODY></HTML>"
  80     code reason_phrase code reason_phrase body
  81
  82   (** internal: send a fooish body explaining in HTML form the 'reason phrase'
  83   of an HTTP response; body, if given, will be appended to the body *)
  84 let send_foo_body code body = send_raw ~data:(foo_body code body)
  85
  86   (* Warning: keep default values in sync with Http_response.response class *)
  87 let respond ?(body = "") ?(headers = []) ?version ?(code = `Code 200) outchan =
  88   send_basic_headers ?version ~code outchan;
  89   send_headers ~headers outchan;
  90   send_header "Content-Length" (string_of_int (String.length body)) outchan;
  91   send_CRLF outchan;
  92   send_raw ~data:body outchan
  93
  94   (** internal: low level for respond_redirect, respond_error, ...
  95   This function send a status line corresponding to a given code, some basic
  96   headers, the additional headers (if given) and an HTML page containing the
  97   reason phrase; if body is given it will be included in the body of the HTML
  98   page *)
  99 let send_empty_response
 100   func_name ?(is_valid_status = fun _ -> true) ?(headers=[]) ?(body="") () =
 101     fun ?version code outchan ->
 102       if not (is_valid_status (int_of_code code)) then
 103         failwith
 104           (sprintf "'%d' isn't a valid status code for %s"
 105             (int_of_code code) func_name)
 106       else begin  (* status code suitable for answering *)
 107         let headers =
 108           [ "Connection", "close";
 109             "Content-Type", "text/html; charset=iso-8859-1" ] @ headers
 110         in
 111         let body = (foo_body (int_of_code code) body) ^ body in
 112         respond ?version ~code ~headers ~body outchan
 113       end
 114
 115 let respond_redirect
 116   ~location ?body ?version ?(code = `Code 301) outchan
 117   =
 118   send_empty_response "Daemon.respond_redirect" ~is_valid_status:is_redirection
 119     ~headers:["Location", location] ?body () ?version code outchan
 120
 121 let respond_error ?body ?version ?(code = `Code 400) outchan =
 122   send_empty_response "Daemon.respond_error" ~is_valid_status:is_error
 123     ?body () ?version code outchan
 124
 125 let respond_not_found ~url ?version outchan =
 126   send_empty_response "Daemon.respond_not_found" () ?version (`Code 404) outchan
 127
 128 let respond_forbidden ~url ?version outchan =
 129   send_empty_response "Daemon.respond_permission_denied" () ?version
 130   (`Code 403) outchan
 131
 132 let respond_unauthorized ?version ?(realm = server_string) outchan =
 133   respond ~headers:["WWW-Authenticate", sprintf "Basic realm=\"%s\"" realm]
 134     ~code:(`Code 401) outchan
 135
 136 let send_file ~src outchan =
 137   let buflen = 1024 in
 138   let buf = String.make buflen ' ' in
 139
 140   let (file, cleanup) =
 141     match src with
 142     | FileSrc fname -> (* if we open the file, we close it before returning *)
 143         let f = open_in fname in
 144         f, (fun () -> close_in f)
 145     | InChanSrc inchan -> inchan, ignore
 146   in
 147   try
 148     while true do
 149       let bytes = input file buf 0 buflen in
 150       if bytes = 0 then
 151         raise End_of_file
 152       else
 153         output outchan buf 0 bytes
 154     done;
 155     assert false
 156   with End_of_file ->
 157     begin
 158       flush outchan;
 159       cleanup ()
 160     end
 161
 162   (* TODO interface is too ugly to advertise this function in .mli *)
 163   (** create a minimal HTML directory listing of a given directory and send it
 164   over an out_channel, directory is passed as a dir_handle; name is the
 165   directory name, used for pretty printing purposes; path is the opened dir
 166   path, used to test its contents with stat *)
 167 let send_dir_listing ~dir ~name ~path outchan =
 168   fprintf outchan "<html>\n<head><title>%s</title></head>\n<body>\n" name;
 169   let (dirs, files) =
 170     List.partition (fun e -> Http_misc.is_directory (path ^ e)) (Http_misc.ls dir)
 171   in
 172   List.iter
 173     (fun d -> fprintf outchan "<a href=\"%s/\">%s/</a><br />\n" d d)
 174     (List.sort compare dirs);
 175   List.iter
 176     (fun f -> fprintf outchan "<a href=\"%s\">%s</a><br />\n" f f)
 177     (List.sort compare files);
 178   fprintf outchan "</body>\n</html>";
 179   flush outchan
 180
 181 let respond_file ~fname ?(version = http_version) outchan =
 182   (** ASSUMPTION: 'fname' doesn't begin with a "/"; it's relative to the current
 183   document root (usually the daemon's cwd) *)
 184   let droot = Sys.getcwd () in  (* document root *)
 185   let path = droot ^ "/" ^ fname in (* full path to the desired file *)
 186   if not (Sys.file_exists path) then (* file not found *)
 187     respond_not_found ~url:fname outchan
 188   else begin
 189     try
 190       if Http_misc.is_directory path then begin (* file found, is a dir *)
 191         let dir = Unix.opendir path in
 192         send_basic_headers ~version ~code:(`Code 200) outchan;
 193         send_header "Content-Type" "text/html" outchan;
 194         send_CRLF outchan;
 195         send_dir_listing ~dir ~name:fname ~path outchan;
 196         Unix.closedir dir
 197       end else begin  (* file found, is something else *)
 198         let file = open_in fname in
 199         send_basic_headers ~version ~code:(`Code 200) outchan;
 200         send_header
 201           ~header:"Content-Length"
 202           ~value:(string_of_int (Http_misc.filesize fname))
 203           outchan;
 204         send_CRLF outchan;
 205         send_file ~src:(InChanSrc file) outchan;
 206         close_in file
 207       end
 208     with
 209     | Unix.Unix_error (Unix.EACCES, s, _) when (s = fname) ->
 210         respond_forbidden ~url:fname ~version outchan
 211     | Sys_error s when
 212         (Pcre.pmatch ~rex:(Pcre.regexp (fname ^ ": Permission denied")) s) ->
 213           respond_forbidden ~url:fname ~version outchan
 214   end
 215
 216 let respond_with (res: Http_types.response) outchan =
 217   res#serialize outchan;
 218   flush outchan
 219
 220   (** internal: this exception is raised after a malformed request has been read
 221   by a serving process to signal main server (or itself if mode = `Single) to
 222   skip to next request *)
 223 exception Again;;
 224
 225 let pp_parse_exc e =
 226   sprintf "HTTP request parse error: %s" (Printexc.to_string e)
 227
 228   (* given a Http_parser.parse_request like function, wrap it in a function that
 229   do the same and additionally catch parsing exception sending HTTP error
 230   messages back to client as needed. Returned function raises Again when it
 231   encounter a parse error (name 'Again' is intended for future versions that
 232   will support http keep alive signaling that a new request has to be parsed
 233   from client) *)
 234 let rec wrap_parse_request_w_safety parse_function inchan outchan =
 235 (*   try *)
 236   (try
 237     parse_function inchan
 238   with
 239   | (End_of_file) as e ->
 240       debug_print (pp_parse_exc e);
 241       respond_error ~code:(`Code 400) ~body:"Unexpected End Of File" outchan;
 242       raise Again
 243   | (Malformed_request req) as e ->
 244       debug_print (pp_parse_exc e);
 245       respond_error ~code:(`Code 400)
 246         ~body:("request 1st line format should be: '<method> <url> <version>'" ^
 247           "<br />\nwhile received request 1st line was:<br />\n" ^ req)
 248         outchan;
 249       raise Again
 250   | (Invalid_HTTP_method meth) as e ->
 251       debug_print (pp_parse_exc e);
 252       respond_error ~code:(`Code 501)
 253         ~body:("Method '" ^ meth ^ "' isn't supported (yet)")
 254         outchan;
 255       raise Again
 256   | (Malformed_request_URI uri) as e ->
 257       debug_print (pp_parse_exc e);
 258       respond_error ~code:(`Code 400) ~body:("Malformed URL: '" ^ uri ^ "'")
 259         outchan;
 260       raise Again
 261   | (Invalid_HTTP_version version) as e ->
 262       debug_print (pp_parse_exc e);
 263       respond_error ~code:(`Code 505)
 264         ~body:("HTTP version '" ^ version ^ "' isn't supported (yet)")
 265         outchan;
 266       raise Again
 267   | (Malformed_query query) as e ->
 268       debug_print (pp_parse_exc e);
 269       respond_error ~code:(`Code 400)
 270         ~body:(sprintf "Malformed query string '%s'" query) outchan;
 271       raise Again
 272   | (Malformed_query_part (binding, query)) as e ->
 273       debug_print (pp_parse_exc e);
 274       respond_error ~code:(`Code 400)
 275         ~body:(sprintf "Malformed query part '%s' in query '%s'" binding query)
 276         outchan;
 277       raise Again)
 278 (*  (* preliminary support for HTTP keep alive connections ... *)
 279   with Again ->
 280     wrap_parse_request_w_safety parse_function inchan outchan
 281 *)
 282
 283   (* wrapper around Http_parser.parse_request which catch parsing exceptions and
 284   return error messages to client as needed
 285   @param inchan in_channel from which read incoming requests
 286   @param outchan out_channl on which respond with error messages if needed
 287   *)
 288 let safe_parse_request = wrap_parse_request_w_safety parse_request
 289
 290   (* as above but for OO version (Http_parser.parse_request') *)
 291 let safe_parse_request' = wrap_parse_request_w_safety (new Http_request.request)
 292
 293 let chdir_to_document_root = function (* chdir to document root *)
 294   | Some dir -> Sys.chdir dir
 295   | None -> ()
 296
 297 let server_of_mode = function
 298   | `Single -> Http_tcp_server.simple
 299   | `Fork   -> Http_tcp_server.fork
 300   | `Thread -> Http_tcp_server.thread
 301
 302   (* TODO what happens when a Quit exception is raised by a callback? Do other
 303   callbacks keep on living until the end or are them all killed immediatly?
 304   The right semantics should obviously be the first one *)
 305
 306   (* TODO support also chroot to 'root', not only chdir *)
 307   (* curried request *)
 308 let start
 309   ?(addr = default_addr) ?(port = default_port)
 310   ?(timeout = Some default_timeout) ?(mode = default_mode) ?root callback
 311   =
 312   chdir_to_document_root root;
 313   let sockaddr = Http_misc.build_sockaddr (addr, port) in
 314   let daemon_callback inchan outchan =
 315     try
 316       let (path, parameters) = safe_parse_request inchan outchan in
 317       callback path parameters outchan;
 318       flush outchan
 319     with
 320     | Unauthorized realm -> respond_unauthorized ~realm outchan
 321     | Again -> ()
 322   in
 323   try
 324     (server_of_mode mode) ~sockaddr ~timeout daemon_callback
 325   with Quit -> ()
 326
 327   (* OO request *)
 328 let start'
 329   ?(addr = default_addr) ?(port = default_port)
 330   ?(timeout = Some default_timeout) ?(mode = default_mode) ?root callback
 331   =
 332   chdir_to_document_root root;
 333   let sockaddr = Http_misc.build_sockaddr (addr, port) in
 334   let daemon_callback inchan outchan =
 335     try
 336       let req = safe_parse_request' inchan outchan in
 337       callback req outchan;
 338       flush outchan
 339     with
 340     | Unauthorized realm -> respond_unauthorized ~realm outchan
 341     | Again -> ()
 342   in
 343   try
 344     (server_of_mode mode) ~sockaddr ~timeout daemon_callback
 345   with Quit -> ()
 346
 347 module Trivial =
 348   struct
 349     let callback path _ outchan =
 350       if not (Pcre.pmatch ~rex:(Pcre.regexp "^/") path) then
 351         respond_error ~code:(`Code 400) outchan
 352       else
 353         respond_file ~fname:(Http_misc.strip_heading_slash path) outchan
 354     let start ?(addr = default_addr) ?(port = default_port) () =
 355       start ~addr ~port callback
 356   end
 357
 358   (* @param inchan input channel connected to client
 359      @param outchan output channel connected to client
 360      @param sockaddr client socket address *)
 361 class connection inchan outchan sockaddr =
 362   (* ASSUMPTION: inchan and outchan are channels built on top of the same
 363   Unix.file_descr thus closing one of them will close also the other *)
 364   let close' o = o#close in
 365   object (self)
 366
 367     initializer Gc.finalise close' self
 368
 369     val mutable closed = false
 370
 371     method private assertNotClosed =
 372       if closed then
 373         failwith "Http_daemon.connection: connection is closed"
 374
 375     method getRequest =
 376       self#assertNotClosed;
 377       try
 378         Some (safe_parse_request' inchan outchan)
 379       with Again -> None
 380
 381     method respond_with res =
 382       self#assertNotClosed;
 383       respond_with res outchan
 384
 385     method close =
 386       self#assertNotClosed;
 387       close_in inchan;  (* this close also outchan *)
 388       closed <- true
 389
 390   end
 391
 392 class daemon ?(addr = "0.0.0.0") ?(port = 80) () =
 393   object (self)
 394
 395     val suck =
 396       Http_tcp_server.init_socket (Http_misc.build_sockaddr (addr, port))
 397
 398     method accept =
 399       let (cli_suck, cli_sockaddr) = Unix.accept suck in  (* may block *)
 400       let (inchan, outchan) =
 401         (Unix.in_channel_of_descr cli_suck, Unix.out_channel_of_descr cli_suck)
 402       in
 403       new connection inchan outchan cli_sockaddr
 404
 405     method getRequest =
 406       let conn = self#accept in
 407       match conn#getRequest with
 408       | None ->
 409           conn#close;
 410           self#getRequest
 411       | Some req -> (req, conn)
 412
 413   end
 414