helm/http_getter/http_getter_common.mli

   1 (*
   2  * Copyright (C) 2003:
   3  *    Stefano Zacchiroli <zack@cs.unibo.it>
   4  *    for the HELM Team http://helm.cs.unibo.it/
   5  *
   6  *  This file is part of HELM, an Hypertextual, Electronic
   7  *  Library of Mathematics, developed at the Computer Science
   8  *  Department, University of Bologna, Italy.
   9  *
  10  *  HELM is free software; you can redistribute it and/or
  11  *  modify it under the terms of the GNU General Public License
  12  *  as published by the Free Software Foundation; either version 2
  13  *  of the License, or (at your option) any later version.
  14  *
  15  *  HELM is distributed in the hope that it will be useful,
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  *  GNU General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU General Public License
  21  *  along with HELM; if not, write to the Free Software
  22  *  Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  23  *  MA  02111-1307, USA.
  24  *
  25  *  For details, see the HELM World-Wide-Web page,
  26  *  http://helm.cs.unibo.it/
  27  *)
  28
  29 open Http_getter_types;;
  30
  31 val string_of_ls_flag: http_getter_ls_flag -> string
  32 val string_of_encoding: http_getter_encoding -> string
  33
  34 val is_cic_uri: string -> bool
  35 val is_nuprl_uri: string -> bool
  36 val is_rdf_uri: string -> bool
  37 val is_xsl_uri: string -> bool
  38
  39 val http_getter_uri_of_string: string -> http_getter_uri
  40
  41 val patch_xml : string -> string
  42 val patch_xsl : string -> string
  43 val patch_dtd : string -> string
  44
  45 val return_html_error: string -> out_channel -> unit
  46 val return_html_internal_error: string -> out_channel -> unit
  47   (** return an HTML HTTP response from the given string, embedding it in an
  48   "H1" element of an HTML page; content-type is set to text/html *)
  49 val return_html_msg: string -> out_channel -> unit
  50   (** return an HTTP response using given string as content; content-type is set
  51   to text/html *)
  52 val return_html_raw: string -> out_channel -> unit
  53   (** return an HTTP response using given string as content; content-type is set
  54   to text/xml *)
  55 val return_xml_raw: string -> out_channel -> unit
  56  (** return a bad request http response *)
  57 val return_400: string -> out_channel -> unit
  58   (**
  59   @param fname name of the file to be sent
  60   @param contype Content-Type header value
  61   @param contenc Content-Enconding header value
  62   @param patch_fun function used to patch file contents
  63   @param gunzip is meaningful only if a patch function is provided. If gunzip
  64   is true patch_fun is applied to the uncompressed version of the file. The file
  65   is then compressed again and send to client
  66   @param outchan output channel over which sent file fname *)
  67 val return_file:
  68   fname:string ->
  69   ?contype:string -> ?contenc:string ->
  70   ?patch_fun:(string -> string) -> ?gunzip:bool ->
  71   out_channel ->
  72     unit
  73