Merge pull request #268 from Julow/ocsigen_respond_file

Add Ocsigen_response.respond_file

Author: balat

src/extensions/staticmod.ml

@@ -142,8 +142,7 @@ let gen ~usermode ?cache dir = function
           | Ocsigen_local_files.RDir _ ->
               failwith "FIXME: staticmod dirs not implemented"
         in
-        Cohttp_lwt_unix.Server.respond_file ~fname () >>= fun answer ->
-        let answer = Ocsigen_response.of_cohttp answer in
+        Ocsigen_response.respond_file fname >>= fun answer ->
         let answer =
           if not status_filter
           then answer

src/server/ocsigen_response.ml

@@ -50,6 +50,63 @@ let respond_string ?headers ~status ~body () =
 let respond_error ?headers ?(status = `Internal_server_error) ~body () =
   respond_string ?headers ~status ~body:("Error: " ^ body) ()
 
+let respond_not_found ?uri () =
+  let body =
+    match uri with
+    | None -> "Not found"
+    | Some uri -> "Not found: " ^ Uri.to_string uri
+  in
+  respond_string ~status:`Not_found ~body ()
+
+let respond_file ?headers ?(status = `OK) fname =
+  let exception Isnt_a_file in
+  (* Copied from [cohttp-lwt-unix] and adapted to [Body]. *)
+  Lwt.catch
+    (fun () ->
+       (* Check this isn't a directory first *)
+       let* () =
+         let* s = Lwt_unix.stat fname in
+         if Unix.(s.st_kind <> S_REG)
+         then raise Isnt_a_file
+         else Lwt.return_unit
+       in
+       let count = 16384 in
+       let* ic =
+         Lwt_io.open_file ~buffer:(Lwt_bytes.create count) ~mode:Lwt_io.input
+           fname
+       in
+       let* len = Lwt_io.length ic in
+       let encoding = Http.Transfer.Fixed len in
+       let stream write =
+         let rec cat_loop () =
+           Lwt.bind (Lwt_io.read ~count ic) (function
+             | "" -> Lwt.return_unit
+             | buf -> Lwt.bind (write buf) cat_loop)
+         in
+         let* () =
+           Lwt.catch cat_loop (fun exn ->
+             Logs.warn (fun m ->
+               m "Error resolving file %s (%s)" fname (Printexc.to_string exn));
+             Lwt.return_unit)
+         in
+         Lwt.catch
+           (fun () -> Lwt_io.close ic)
+           (fun e ->
+              Logs.warn (fun f ->
+                f "Closing channel failed: %s" (Printexc.to_string e));
+              Lwt.return_unit)
+       in
+       let body = Body.make encoding stream in
+       let mime_type = Magic_mime.lookup fname in
+       let headers =
+         Http.Header.add_opt_unless_exists headers "content-type" mime_type
+       in
+       Lwt.return (respond ~headers ~status ~encoding ~body ()))
+    (function
+      | Unix.Unix_error (Unix.ENOENT, _, _) | Isnt_a_file ->
+          Lwt.return (respond_not_found ())
+      | exn -> Lwt.reraise exn)
+
 let update ?response ?body ?cookies {a_response; a_body; a_cookies} =
   let a_response =
     match response with Some response -> response | None -> a_response

src/server/ocsigen_response.mli

@@ -53,6 +53,14 @@ val respond_error :
 
     @deprecated Use [respond_string] with a [~status] argument instead. *)
 
+val respond_file :
+   ?headers:Cohttp.Header.t
+  -> ?status:Http.Status.t
+  -> string
+  -> t Lwt.t
+(** Respond with the content of a file. The content type is guessed using
+    [Magic_mime]. *)
+
 val update :
    ?response:Cohttp.Response.t
   -> ?body:Body.t

test/extensions/deflatemod.t/run.t

@@ -14,6 +14,16 @@
   ocsigen:local-file: [INFO] Testing "./index.html".
   ocsigen:local-file: [INFO] checking if file index.html can be sent
   ocsigen:local-file: [INFO] Returning "./index.html".
+  ocsigen:access:  connection for local-test from unix:// (): /empty_dir/
+  ocsigen:ext: [INFO] host found! local-test:0 matches .* 
+  ocsigen:ext:staticmod: [INFO] Is it a static file?
+  ocsigen:local-file: [INFO] Testing "./empty_dir/".
+  ocsigen:local-file: [INFO] Testing "./empty_dir/index.html" as possible index.
+  ocsigen:local-file: [INFO] No index and no listing
+  ocsigen:access:  connection for local-test from unix:// (): /doesnt_exists.html
+  ocsigen:ext: [INFO] host found! local-test:0 matches .* 
+  ocsigen:ext:staticmod: [INFO] Is it a static file?
+  ocsigen:local-file: [INFO] Testing "./doesnt_exists.html".
   application: [WARNING] Command received: shutdown
 
 First response is not compressed:
@@ -37,3 +47,19 @@ Second response is compressed:
   transfer-encoding: chunked
 
   Hello world
+
+Querying a directory or a non-existing file should give "Not found" without
+compression:
+
+  $ mkdir empty_dir && curl_ empty_dir/ --compressed
+  HTTP/1.1 404 Not Found
+  content-length: 16
+  server: Ocsigen
+  
+  Error: Not Found
+  $ curl_ doesnt_exists.html --compressed
+  HTTP/1.1 404 Not Found
+  content-length: 16
+  server: Ocsigen
+  
+  Error: Not Found