helm/ocaml/getter/http_getter_env.ml

   1 (*
   2  * Copyright (C) 2003-2004:
   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 Printf
  30 open Pxp_document
  31 open Pxp_types
  32 open Pxp_yacc
  33
  34 open Http_getter_types
  35
  36 let version = Http_getter_const.version
  37
  38 let servers_file    = lazy (Helm_registry.get "getter.servers_file")
  39 let cic_dbm         = lazy (Helm_registry.get "getter.cic_dbm")
  40 let nuprl_dbm       = lazy (Helm_registry.get "getter.nuprl_dbm")
  41 let rdf_dbm         = lazy (Helm_registry.get "getter.rdf_dbm")
  42 let xsl_dbm         = lazy (Helm_registry.get "getter.xsl_dbm")
  43 let xml_index       = lazy (Helm_registry.get "getter.xml_indexname")
  44 let rdf_index       = lazy (Helm_registry.get "getter.rdf_indexname")
  45 let xsl_index       = lazy (Helm_registry.get "getter.xsl_indexname")
  46 let cic_dir         = lazy (Helm_registry.get "getter.cic_dir")
  47 let nuprl_dir       = lazy (Helm_registry.get "getter.nuprl_dir")
  48 let rdf_dir         = lazy (Helm_registry.get "getter.rdf_dir")
  49 let dtd_dir         = lazy (Helm_registry.get "getter.dtd_dir")
  50 let dtd_base_urls   = lazy (Helm_registry.get_string_list
  51                               "getter.dtd_base_urls")
  52 let port            = lazy (Helm_registry.get_int "getter.port")
  53
  54 let _servers = ref None
  55
  56 let servers =
  57  function () ->
  58     (match !_servers with
  59     | None -> failwith "Getter not yet initialized: servers not available"
  60     | Some servers -> servers)
  61
  62 let load_servers () =
  63   let pos = ref (-1) in
  64   List.rev (Http_getter_misc.fold_file
  65     (fun line servers ->
  66       if Http_getter_misc.is_blank_line line then
  67         servers
  68       else
  69         (incr pos; (!pos, line) :: servers))
  70     []
  71     (Lazy.force servers_file))
  72
  73 let reload_servers () = _servers := Some (load_servers ())
  74
  75 let save_servers () =
  76   let oc = open_out (Lazy.force servers_file) in
  77   List.iter (fun (_,server) -> output_string oc (server ^ "\n"))
  78     (servers ());
  79   close_out oc
  80
  81 let host =
  82   lazy
  83     (let buf = Buffer.create 20 in
  84     Shell.call ~stdout:(Shell.to_buffer buf) [Shell.cmd "hostname" ["-f"]];
  85     Pcre.replace ~pat:"\n+$" (Buffer.contents buf))
  86
  87 let my_own_url =
  88   lazy
  89     (let (host, port) = (Lazy.force host, Lazy.force port) in
  90     sprintf "http://%s%s" (* without trailing '/' *)
  91     host (if port = 80 then "" else (sprintf ":%d" port)))
  92
  93 let cache_mode =
  94   lazy
  95     (match String.lowercase (Helm_registry.get "getter.cache_mode") with
  96     | "normal" -> `Normal
  97     | "gz" -> `Gzipped
  98     | mode -> failwith ("Invalid cache mode: " ^ mode))
  99
 100 let reload () = reload_servers ()
 101
 102 let env_to_string () =
 103   sprintf
 104 "HTTP Getter %s (the OCaml one!)
 105
 106 cic_dbm:\t%s
 107 nuprl_dbm:\t%s
 108 rdf_dbm:\t%s
 109 xsl_dbm:\t%s
 110 xml_index:\t%s
 111 rdf_index:\t%s
 112 xsl_index:\t%s
 113 cic_dir:\t%s
 114 nuprl_dir:\t%s
 115 rdf_dir:\t%s
 116 dtd_dir:\t%s
 117 servers_file:\t%s
 118 host:\t\t%s
 119 port:\t\t%d
 120 my_own_url:\t%s
 121 dtd_base_urls:\t%s
 122 cache_mode:\t%s
 123 servers:
 124 \t%s
 125 log_file:\t%s
 126 log_level:\t%d
 127 "
 128     version (Lazy.force cic_dbm) (Lazy.force nuprl_dbm) (Lazy.force rdf_dbm)
 129     (Lazy.force xsl_dbm) (Lazy.force xml_index)
 130     (Lazy.force rdf_index) (Lazy.force xsl_index) (Lazy.force cic_dir)
 131     (Lazy.force nuprl_dir) (Lazy.force rdf_dir)
 132     (Lazy.force dtd_dir) (Lazy.force servers_file) (Lazy.force host)
 133     (Lazy.force port) (Lazy.force my_own_url)
 134     (String.concat " " (Lazy.force dtd_base_urls))
 135     (match Lazy.force cache_mode with
 136     | `Normal -> "Normal"
 137     | `Gzipped -> "GZipped")
 138     (String.concat "\n\t" (* (position * server) list *)
 139       (List.map (fun (pos, server) -> sprintf "%3d: %s" pos server)
 140         (servers ())))
 141     (match Http_getter_logger.get_log_file () with None -> "None" | Some f -> f)
 142     (Http_getter_logger.get_log_level ())
 143
 144 let add_server ?position url =
 145   let new_servers =
 146     let servers = servers () in
 147     match position with
 148     | None -> servers @ [-1, url];
 149     | Some p when p > 0 ->
 150         let rec add_after pos = function
 151           | [] -> [-1, url]
 152           | hd :: tl when p = 1 -> hd :: (-1, url) :: tl
 153           | hd :: tl (* when p > 1 *) -> hd :: (add_after (pos - 1) tl)
 154         in
 155         add_after p servers
 156     | Some 0 -> (-1, url)::servers
 157     | Some _ -> assert false
 158   in
 159   _servers := Some new_servers;
 160   save_servers ();
 161   reload_servers ()
 162
 163 let remove_server position =
 164   _servers := Some (List.remove_assoc position (servers ()));
 165   save_servers ();
 166   reload_servers ()
 167