fixed typo in ocamldoc comment

[helm.git] / helm / http_getter / http_getter_common.ml

diff --git a/helm/http_getter/http_getter_common.ml b/helm/http_getter/http_getter_common.ml
index 12a2e2ea914f7fd4550eebb2ad4709a860eb2e75..ad549330b0c8dd1ade0d54ea3b448c01f21529cd 100644 (file)
--- a/helm/http_getter/http_getter_common.ml
+++ b/helm/http_getter/http_getter_common.ml
@@ -1,5 +1,7 @@
 (*
- *  Copyright (C) 2003, HELM Team.
+ * Copyright (C) 2003:
+ *    Stefano Zacchiroli <zack@cs.unibo.it>
+ *    for the HELM Team http://helm.cs.unibo.it/
  *
  *  This file is part of HELM, an Hypertextual, Electronic
  *  Library of Mathematics, developed at the Computer Science
@@ -21,7 +23,7 @@
  *  MA  02111-1307, USA.
  *
  *  For details, see the HELM World-Wide-Web page,
- *  http://cs.unibo.it/helm/.
+ *  http://helm.cs.unibo.it/
  *)
 
 open Http_getter_types;;
@@ -32,9 +34,10 @@ let string_of_encoding = function
   | Enc_normal -> "Normal"
   | Enc_gzipped -> "GZipped"
 
-let is_cic_uri uri = Pcre.pmatch ~pat:"^cic:" uri
+let is_cic_obj_uri uri = Pcre.pmatch ~pat:"^cic:" uri
 let is_theory_uri uri = Pcre.pmatch ~pat:"^theory:" uri
-let is_xml_uri uri = is_cic_uri uri || is_theory_uri uri
+let is_cic_uri uri = is_cic_obj_uri uri || is_theory_uri uri
+let is_nuprl_uri uri = Pcre.pmatch ~pat:"^nuprl:" uri
 let is_rdf_uri uri = Pcre.pmatch ~pat:"^helm:rdf(.*):(.*)//(.*)" uri
 let is_xsl_uri uri = Pcre.pmatch ~pat:"^\\w+\\.xsl" uri
 
@@ -44,14 +47,15 @@ let rec http_getter_uri_of_string = function
       | [ prefix; uri ] ->
           let rest =
             match http_getter_uri_of_string uri with
-            | Xml_uri xmluri -> xmluri
+            | Cic_uri xmluri -> xmluri
             | _ -> raise (Http_getter_invalid_URI uri)
           in
           Rdf_uri (prefix, rest)
       | _ -> raise (Http_getter_invalid_URI uri))
-  | uri when is_cic_uri uri -> Xml_uri (Cic (Pcre.replace ~pat:"^cic:" uri))
+  | uri when is_cic_uri uri -> Cic_uri (Cic (Pcre.replace ~pat:"^cic:" uri))
+  | uri when is_nuprl_uri uri -> Nuprl_uri (Pcre.replace ~pat:"^nuprl:" uri)
   | uri when is_theory_uri uri ->
-      Xml_uri (Theory (Pcre.replace ~pat:"^theory:" uri))
+      Cic_uri (Theory (Pcre.replace ~pat:"^theory:" uri))
   | uri -> raise (Http_getter_invalid_URI uri)
 
 let patch_xml line =
@@ -93,8 +97,11 @@ let mk_return_fun pp_fun contype msg outchan =
 let return_html_error = mk_return_fun pp_error "text/html"
 let return_html_internal_error = mk_return_fun pp_internal_error "text/html"
 let return_html_msg = mk_return_fun pp_msg "text/html"
-let return_xml_msg = mk_return_fun null_pp "text/xml"
-let return_file ~fname ?contype ?contenc ?(patch_fun = fun x -> x) outchan =
+let return_html_raw = mk_return_fun null_pp "text/html"
+let return_xml_raw = mk_return_fun null_pp "text/xml"
+let return_file
+  ~fname ?contype ?contenc ?(patch_fun = fun x -> x) ?(gunzip = false) outchan
+  =
   let headers =
     match (contype, contenc) with
     | (Some t, Some e) -> ["Content-Encoding", e; "Content-Type", t]
@@ -105,8 +112,26 @@ let return_file ~fname ?contype ?contenc ?(patch_fun = fun x -> x) outchan =
   Http_daemon.send_basic_headers ~code:200 outchan;
   Http_daemon.send_headers headers outchan;
   Http_daemon.send_CRLF outchan;
-  Http_getter_misc.iter_file
-    (fun line -> output_string outchan (patch_fun line ^ "\n"))
-    fname
+  if gunzip then begin  (* gunzip needed, uncompress file, apply patch_fun to
+                        it, compress the result and sent it to client *)
+    let (tmp1, tmp2) =
+      (Http_getter_misc.tempfile (), Http_getter_misc.tempfile ())
+    in
+    Http_getter_misc.gunzip ~keep:true ~output:tmp1 fname;  (* gunzip to tmp1 *)
+    let new_file = open_out tmp2 in
+    Http_getter_misc.iter_file  (* tmp2 = patch(tmp1) *)
+      (fun line -> output_string new_file (patch_fun line ^ "\n"))
+      tmp1;
+    close_out new_file;
+    Http_getter_misc.gzip ~output:tmp1 tmp2;  (* tmp1 = gzip(tmp2); rm tmp2 *)
+    Http_getter_misc.iter_file  (* send tmp1 to client as is*)
+      (fun line -> output_string outchan (line ^ "\n"))
+      tmp1;
+    Sys.remove tmp1       (* rm tmp1 *)
+  end else  (* no need to gunzip, apply patch_fun directly to file *)
+    Http_getter_misc.iter_file
+      (fun line -> output_string outchan (patch_fun line ^ "\n"))
+      fname
+;;
 let return_400 body outchan = Http_daemon.respond_error ~code:400 ~body outchan