helm/ocaml/getter/http_getter.ml

   1 (* Copyright (C) 2005, HELM Team.
   2  *
   3  * This file is part of HELM, an Hypertextual, Electronic
   4  * Library of Mathematics, developed at the Computer Science
   5  * Department, University of Bologna, Italy.
   6  *
   7  * HELM is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * HELM is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with HELM; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20  * MA  02111-1307, USA.
  21  *
  22  * For details, see the HELM World-Wide-Web page,
  23  * http://helm.cs.unibo.it/
  24  *)
  25
  26 open Printf
  27
  28 open Http_getter_common
  29 open Http_getter_misc
  30 open Http_getter_types
  31
  32 exception Not_implemented of string
  33 exception UnexpectedGetterOutput
  34
  35 type resolve_result =
  36   | Unknown
  37   | Exception of exn
  38   | Resolved of string
  39
  40 type logger_callback = HelmLogger.html_tag -> unit
  41
  42 let stdout_logger tag = print_string (HelmLogger.string_of_html_tag tag)
  43
  44 let not_implemented s = raise (Not_implemented ("Http_getter." ^ s))
  45
  46 let index_line_sep_RE     = Pcre.regexp "[ \t]+"
  47 let index_sep_RE          = Pcre.regexp "\r\n|\r|\n"
  48 let trailing_types_RE     = Pcre.regexp "\\.types$"
  49 let heading_cic_RE        = Pcre.regexp "^cic:"
  50 let heading_theory_RE     = Pcre.regexp "^theory:"
  51 let heading_nuprl_RE      = Pcre.regexp "^nuprl:"
  52 let types_RE              = Pcre.regexp "\\.types$"
  53 let types_ann_RE          = Pcre.regexp "\\.types\\.ann$"
  54 let body_RE               = Pcre.regexp "\\.body$"
  55 let body_ann_RE           = Pcre.regexp "\\.body\\.ann$"
  56 let proof_tree_RE         = Pcre.regexp "\\.proof_tree$"
  57 let proof_tree_ann_RE     = Pcre.regexp "\\.proof_tree\\.ann$"
  58 let theory_RE             = Pcre.regexp "\\.theory$"
  59 let basepart_RE           = Pcre.regexp
  60   "^([^.]*\\.[^.]*)((\\.body)|(\\.proof_tree)|(\\.types))?(\\.ann)?$"
  61 let slash_RE              = Pcre.regexp "/"
  62 let pipe_RE               = Pcre.regexp "\\|"
  63 let til_slash_RE          = Pcre.regexp "^.*/"
  64 let no_slashes_RE         = Pcre.regexp "^[^/]*$"
  65 let fix_regexp_RE         = Pcre.regexp ("^" ^ (Pcre.quote "(cic|theory)"))
  66 let showable_file_RE      =
  67   Pcre.regexp "(\\.con|\\.ind|\\.var|\\.body|\\.types|\\.proof_tree)$"
  68
  69 let xml_suffix = ".xml"
  70 let theory_suffix = ".theory" ^ xml_suffix
  71
  72   (* global maps, shared by all threads *)
  73
  74 let ends_with_slash s =
  75   try
  76     s.[String.length s - 1] = '/'
  77   with Invalid_argument _ -> false
  78
  79   (* should we use a remote getter or not *)
  80 let remote () =
  81   try
  82     Helm_registry.get "getter.mode" = "remote"
  83   with Helm_registry.Key_not_found _ -> false
  84
  85 let getter_url () = Helm_registry.get "getter.url"
  86
  87 (* Remote interface: getter methods implemented using a remote getter *)
  88
  89   (* <TODO> *)
  90 let getxml_remote uri = not_implemented "getxml_remote"
  91 let getxslt_remote uri = not_implemented "getxslt_remote"
  92 let getdtd_remote uri = not_implemented "getdtd_remote"
  93 let clean_cache_remote () = not_implemented "clean_cache_remote"
  94 let list_servers_remote () = not_implemented "list_servers_remote"
  95 let add_server_remote ~logger ~position name =
  96   not_implemented "add_server_remote"
  97 let remove_server_remote ~logger position =
  98   not_implemented "remove_server_remote"
  99 let getalluris_remote () = not_implemented "getalluris_remote"
 100 let ls_remote lsuri = not_implemented "ls_remote"
 101 let exists_remote uri = not_implemented "exists_remote"
 102   (* </TODO> *)
 103
 104 let resolve_remote uri =
 105   (* deliver resolve request to http_getter *)
 106   let doc =
 107     Http_getter_wget.get (sprintf "%sresolve?uri=%s" (getter_url ()) uri)
 108   in
 109   let res = ref Unknown in
 110   let start_element tag attrs =
 111     match tag with
 112     | "url" ->
 113         (try
 114           res := Resolved (List.assoc "value" attrs)
 115         with Not_found -> ())
 116     | "unresolvable" -> res := Exception (Unresolvable_URI uri)
 117     | "not_found" -> res := Exception (Key_not_found uri)
 118     | _ -> ()
 119   in
 120   let callbacks = {
 121     XmlPushParser.default_callbacks with
 122       XmlPushParser.start_element = Some start_element
 123   } in
 124   let xml_parser = XmlPushParser.create_parser callbacks in
 125   XmlPushParser.parse xml_parser (`String doc);
 126   XmlPushParser.final xml_parser;
 127   match !res with
 128   | Unknown -> raise UnexpectedGetterOutput
 129   | Exception e -> raise e
 130   | Resolved url -> url
 131
 132 (* API *)
 133
 134 let help () = Http_getter_const.usage_string (Http_getter_env.env_to_string ())
 135
 136 let exists uri =
 137   if remote () then
 138     exists_remote uri
 139   else
 140     Http_getter_storage.exists (uri ^ xml_suffix)
 141
 142 let resolve uri =
 143   if remote () then
 144     resolve_remote uri
 145   else
 146     try
 147       Http_getter_storage.resolve (uri ^ xml_suffix)
 148     with Http_getter_storage.Resource_not_found _ -> raise (Key_not_found uri)
 149
 150 let getxml uri =
 151   if remote () then getxml_remote uri
 152   else begin
 153     try
 154       Http_getter_storage.filename (uri ^ xml_suffix)
 155     with Http_getter_storage.Resource_not_found _ -> raise (Key_not_found uri)
 156   end
 157
 158 let getxslt uri =
 159   if remote () then getxslt_remote uri
 160   else Http_getter_storage.filename ~find:true ("xslt:/" ^ uri)
 161
 162 let getdtd uri =
 163   if remote () then
 164     getdtd_remote uri
 165   else begin
 166     let fname = Lazy.force Http_getter_env.dtd_dir ^ "/" ^ uri in
 167     if not (Sys.file_exists fname) then raise (Dtd_not_found uri);
 168     fname
 169   end
 170
 171 let clean_cache () =
 172   if remote () then
 173     clean_cache_remote ()
 174   else
 175     Http_getter_storage.clean_cache ()
 176
 177 let (++) (oldann, oldtypes, oldbody, oldtree)
 178          (newann, newtypes, newbody, newtree) =
 179   ((if newann   > oldann    then newann   else oldann),
 180    (if newtypes > oldtypes  then newtypes else oldtypes),
 181    (if newbody  > oldbody   then newbody  else oldbody),
 182    (if newtree  > oldtree   then newtree  else oldtree))
 183
 184 let store_obj tbl o =
 185 (*   prerr_endline ("Http_getter.store_obj " ^ o); *)
 186   if Pcre.pmatch ~rex:showable_file_RE o then begin
 187     let basepart = Pcre.replace ~rex:basepart_RE ~templ:"$1" o in
 188     let no_flags = false, No, No, No in
 189     let oldflags =
 190       try
 191         Hashtbl.find tbl basepart
 192       with Not_found -> (* no ann, no types, no body, no proof tree *)
 193         no_flags
 194     in
 195     let newflags =
 196       match o with
 197       | s when Pcre.pmatch ~rex:types_RE s          -> (false, Yes, No, No)
 198       | s when Pcre.pmatch ~rex:types_ann_RE s      -> (true,  Ann, No, No)
 199       | s when Pcre.pmatch ~rex:body_RE s           -> (false, No, Yes, No)
 200       | s when Pcre.pmatch ~rex:body_ann_RE s       -> (true,  No, Ann, No)
 201       | s when Pcre.pmatch ~rex:proof_tree_RE s     -> (false, No, No, Yes)
 202       | s when Pcre.pmatch ~rex:proof_tree_ann_RE s -> (true,  No, No, Ann)
 203       | s -> no_flags
 204     in
 205     Hashtbl.replace tbl basepart (oldflags ++ newflags)
 206   end
 207
 208 let store_dir set_ref d =
 209   set_ref := StringSet.add (List.hd (Pcre.split ~rex:slash_RE d)) !set_ref
 210
 211 let collect_ls_items dirs_set objs_tbl =
 212   let items = ref [] in
 213   StringSet.iter (fun dir -> items := Ls_section dir :: !items) dirs_set;
 214   Http_getter_misc.hashtbl_sorted_iter
 215     (fun uri (annflag, typesflag, bodyflag, treeflag) ->
 216       items :=
 217         Ls_object {
 218           uri = uri; ann = annflag;
 219           types = typesflag; body = bodyflag; proof_tree = treeflag
 220         } :: !items)
 221     objs_tbl;
 222   List.rev !items
 223
 224   (** non regexp-aware version of ls *)
 225 let dumb_ls uri_prefix =
 226 (*   prerr_endline ("Http_getter.dumb_ls " ^ uri_prefix); *)
 227   if is_cic_obj_uri uri_prefix then begin
 228     let dirs = ref StringSet.empty in
 229     let objs = Hashtbl.create 17 in
 230     List.iter
 231       (fun fname ->
 232         if ends_with_slash fname then
 233           store_dir dirs fname
 234         else
 235           try
 236             store_obj objs (strip_suffix ~suffix:xml_suffix fname)
 237           with Invalid_argument _ -> ())
 238       (Http_getter_storage.ls uri_prefix);
 239     collect_ls_items !dirs objs
 240   end else if is_theory_uri uri_prefix then begin
 241     let items = ref [] in
 242     List.iter
 243       (fun fname ->
 244         if ends_with_slash fname then
 245           items := Ls_section (strip_trailing_slash fname) :: !items
 246         else
 247           try
 248             let obj =
 249               { uri = strip_suffix theory_suffix fname;
 250                 ann = false; types = No; body = No; proof_tree = No }
 251             in
 252             items := Ls_object obj :: !items
 253           with Invalid_argument _ -> ())
 254       (Http_getter_storage.ls uri_prefix);
 255     !items
 256   end else
 257     raise (Invalid_URI uri_prefix)
 258
 259   (* handle simple regular expressions of the form "...(..|..|..)..." on cic
 260    * uris, not meant to be a real implementation of regexp. The only we use is
 261    * "(cic|theory):/..." *)
 262 let explode_ls_regexp regexp =
 263   try
 264     let len = String.length regexp in
 265     let lparen_idx = String.index regexp '(' in
 266     let rparen_idx = String.index_from regexp lparen_idx ')' in
 267     let choices_str = (* substring between parens, parens excluded *)
 268       String.sub regexp (lparen_idx + 1) (rparen_idx - lparen_idx - 1)
 269     in
 270     let choices = Pcre.split ~rex:pipe_RE choices_str in
 271     let prefix = String.sub regexp 0 lparen_idx in
 272     let suffix = String.sub regexp (rparen_idx + 1) (len - (rparen_idx + 1)) in
 273     List.map (fun choice -> prefix ^ choice ^ suffix) choices
 274   with Not_found -> [regexp]
 275
 276 let merge_results results =
 277   let rec aux objects_acc dirs_acc = function
 278     | [] -> dirs_acc @ objects_acc
 279     | Ls_object _ as obj :: tl -> aux (obj :: objects_acc) dirs_acc tl
 280     | Ls_section _ as dir :: tl ->
 281         if List.mem dir dirs_acc then (* filters out dir duplicates *)
 282           aux objects_acc dirs_acc tl
 283         else
 284           aux objects_acc (dir :: dirs_acc) tl
 285   in
 286   aux [] [] (List.concat results)
 287
 288 let ls regexp =
 289   if remote () then
 290     ls_remote regexp
 291   else
 292     let prefixes = explode_ls_regexp regexp in
 293     merge_results (List.map dumb_ls prefixes)
 294
 295 let getalluris () =
 296   let rec aux acc = function
 297     | [] -> acc
 298     | dir :: todo ->
 299         let acc', todo' =
 300           List.fold_left
 301             (fun (acc, subdirs) result ->
 302               match result with
 303               | Ls_object obj -> (dir ^ obj.uri) :: acc, subdirs
 304               | Ls_section sect -> acc, (dir ^ sect ^ "/") :: subdirs)
 305             (acc, todo)
 306             (dumb_ls dir)
 307         in
 308         aux acc' todo'
 309   in
 310   aux [] ["cic:/"] (* trailing slash required *)
 311
 312 (* Shorthands from now on *)
 313
 314 let getxml' uri = getxml (UriManager.string_of_uri uri)
 315 let resolve' uri = resolve (UriManager.string_of_uri uri)
 316 let exists' uri = exists (UriManager.string_of_uri uri)
 317
 318 let init () =
 319   Http_getter_logger.set_log_level
 320     (Helm_registry.get_opt_default Helm_registry.int ~default:1
 321       "getter.log_level");
 322   Http_getter_logger.set_log_file
 323     (Helm_registry.get_opt Helm_registry.string "getter.log_file")
 324