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