Debugging stuff removed.

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

diff --git a/helm/http_getter/http_getter_common.mli b/helm/http_getter/http_getter_common.mli
index ea321159e1f093a9c77ff6677214a618fcbdc8a4..236644452d8f8fdd66d756c8dfd16978bc17613e 100644 (file)
--- a/helm/http_getter/http_getter_common.mli
+++ b/helm/http_getter/http_getter_common.mli
@@ -1,5 +1,7 @@
 (*
- *  Copyright (C) 2000, 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;;
@@ -29,7 +31,8 @@ open Http_getter_types;;
 val string_of_ls_flag: http_getter_ls_flag -> string
 val string_of_encoding: http_getter_encoding -> string
 
-val is_xml_uri: string -> bool
+val is_cic_uri: string -> bool
+val is_nuprl_uri: string -> bool
 val is_rdf_uri: string -> bool
 val is_xsl_uri: string -> bool
 
@@ -41,8 +44,15 @@ val patch_dtd : string -> string
 
 val return_html_error: string -> out_channel -> unit
 val return_html_internal_error: string -> out_channel -> unit
+  (** return an HTML HTTP response from the given string, embedding it in an
+  "H1" element of an HTML page; content-type is set to text/html *)
 val return_html_msg: string -> out_channel -> unit
-val return_xml_msg: string -> out_channel -> unit
+  (** return an HTTP response using given string as content; content-type is set
+  to text/html *)
+val return_html_raw: string -> out_channel -> unit
+  (** return an HTTP response using given string as content; content-type is set
+  to text/xml *)
+val return_xml_raw: string -> out_channel -> unit
  (** return a bad request http response *)
 val return_400: string -> out_channel -> unit
   (**
@@ -50,10 +60,14 @@ val return_400: string -> out_channel -> unit
   @param contype Content-Type header value
   @param contenc Content-Enconding header value
   @param patch_fun function used to patch file contents
+  @param gunzip is meaningful only if a patch function is provided. If gunzip
+  is true patch_fun is applied to the uncompressed version of the file. The file
+  is then compressed again and send to client
   @param outchan output channel over which sent file fname *)
 val return_file:
   fname:string ->
-  ?contype:string -> ?contenc:string -> ?patch_fun:(string -> string) ->
+  ?contype:string -> ?contenc:string ->
+  ?patch_fun:(string -> string) -> ?gunzip:bool ->
   out_channel ->
     unit