components/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 (* $Id$ *)
  27
  28 open Printf
  29
  30 open Http_getter_common
  31 open Http_getter_misc
  32 open Http_getter_types
  33
  34 exception Not_implemented of string
  35 exception UnexpectedGetterOutput
  36
  37 type resolve_result =
  38   | Unknown
  39   | Exception of exn
  40   | Resolved of string
  41
  42 type logger_callback = HelmLogger.html_tag -> unit
  43
  44 let stdout_logger tag = print_string (HelmLogger.string_of_html_tag tag)
  45
  46 let not_implemented s = raise (Not_implemented ("Http_getter." ^ s))
  47
  48 let index_line_sep_RE     = Pcre.regexp "[ \t]+"
  49 let index_sep_RE          = Pcre.regexp "\r\n|\r|\n"
  50 let trailing_types_RE     = Pcre.regexp "\\.types$"
  51 let heading_cic_RE        = Pcre.regexp "^cic:"
  52 let heading_theory_RE     = Pcre.regexp "^theory:"
  53 let heading_nuprl_RE      = Pcre.regexp "^nuprl:"
  54 let types_RE              = Pcre.regexp "\\.types$"
  55 let types_ann_RE          = Pcre.regexp "\\.types\\.ann$"
  56 let body_RE               = Pcre.regexp "\\.body$"
  57 let body_ann_RE           = Pcre.regexp "\\.body\\.ann$"
  58 let proof_tree_RE         = Pcre.regexp "\\.proof_tree$"
  59 let proof_tree_ann_RE     = Pcre.regexp "\\.proof_tree\\.ann$"
  60 let theory_RE             = Pcre.regexp "\\.theory$"
  61 let basepart_RE           = Pcre.regexp
  62   "^([^.]*\\.[^.]*)((\\.body)|(\\.proof_tree)|(\\.types))?(\\.ann)?$"
  63 let slash_RE              = Pcre.regexp "/"
  64 let pipe_RE               = Pcre.regexp "\\|"
  65 let til_slash_RE          = Pcre.regexp "^.*/"
  66 let no_slashes_RE         = Pcre.regexp "^[^/]*$"
  67 let fix_regexp_RE         = Pcre.regexp ("^" ^ (Pcre.quote "(cic|theory)"))
  68 let showable_file_RE      =
  69   Pcre.regexp "(\\.con|\\.ind|\\.var|\\.body|\\.types|\\.proof_tree)$"
  70
  71 let xml_suffix = ".xml"
  72 let theory_suffix = ".theory"
  73
  74   (* global maps, shared by all threads *)
  75
  76 let ends_with_slash s =
  77   try
  78     s.[String.length s - 1] = '/'
  79   with Invalid_argument _ -> false
  80
  81   (* should we use a remote getter or not *)
  82 let remote () =
  83   try
  84     Helm_registry.get "getter.mode" = "remote"
  85   with Helm_registry.Key_not_found _ -> false
  86
  87 let getter_url () = Helm_registry.get "getter.url"
  88
  89 (* Remote interface: getter methods implemented using a remote getter *)
  90
  91   (* <TODO> *)
  92 let getxml_remote uri = not_implemented "getxml_remote"
  93 let getxslt_remote uri = not_implemented "getxslt_remote"
  94 let getdtd_remote uri = not_implemented "getdtd_remote"
  95 let clean_cache_remote () = not_implemented "clean_cache_remote"
  96 let list_servers_remote () = not_implemented "list_servers_remote"
  97 let add_server_remote ~logger ~position name =
  98   not_implemented "add_server_remote"
  99 let remove_server_remote ~logger position =
 100   not_implemented "remove_server_remote"
 101 let getalluris_remote () = not_implemented "getalluris_remote"
 102 let ls_remote lsuri = not_implemented "ls_remote"
 103 let exists_remote uri = not_implemented "exists_remote"
 104   (* </TODO> *)
 105
 106 let resolve_remote ~writable uri =
 107   (* deliver resolve request to http_getter *)
 108   let doc =
 109     Http_getter_wget.get (sprintf "%sresolve?uri=%s&writable=%b" (getter_url ())
 110       uri writable)
 111   in
 112   let res = ref Unknown in
 113   let start_element tag attrs =
 114     match tag with
 115     | "url" ->
 116         (try
 117           res := Resolved (List.assoc "value" attrs)
 118         with Not_found -> ())
 119     | "unresolvable" -> res := Exception (Unresolvable_URI uri)
 120     | "not_found" -> res := Exception (Key_not_found uri)
 121     | _ -> ()
 122   in
 123   let callbacks = {
 124     XmlPushParser.default_callbacks with
 125       XmlPushParser.start_element = Some start_element
 126   } in
 127   let xml_parser = XmlPushParser.create_parser callbacks in
 128   XmlPushParser.parse xml_parser (`String doc);
 129   XmlPushParser.final xml_parser;
 130   match !res with
 131   | Unknown -> raise UnexpectedGetterOutput
 132   | Exception e -> raise e
 133   | Resolved url -> url
 134
 135 let deref_index_theory uri =
 136  if Http_getter_storage.exists (uri ^ xml_suffix) then uri
 137  else if is_theory_uri uri && Filename.basename uri = "index.theory" then
 138     strip_trailing_slash (Filename.dirname uri) ^ theory_suffix
 139  else
 140     uri
 141
 142 (* API *)
 143
 144 let help () = Http_getter_const.usage_string (Http_getter_env.env_to_string ())
 145
 146 let exists uri =
 147 (*   prerr_endline ("Http_getter.exists " ^ uri); *)
 148   if remote () then
 149     exists_remote uri
 150   else
 151    let uri = deref_index_theory uri in
 152     Http_getter_storage.exists (uri ^ xml_suffix)
 153
 154 let resolve ~writable uri =
 155   if remote () then
 156     resolve_remote ~writable uri
 157   else
 158    let uri = deref_index_theory uri in
 159     try
 160       Http_getter_storage.resolve ~writable (uri ^ xml_suffix)
 161     with Http_getter_storage.Resource_not_found _ -> raise (Key_not_found uri)
 162
 163 let filename ~writable uri =
 164   if remote () then
 165     raise (Key_not_found uri)
 166   else
 167    let uri = deref_index_theory uri in
 168     try
 169       Http_getter_storage.resolve
 170         ~must_exists:false ~writable uri
 171     with Http_getter_storage.Resource_not_found _ -> raise (Key_not_found uri)
 172
 173 let getxml uri =
 174   if remote () then getxml_remote uri
 175   else begin
 176     let uri' = deref_index_theory uri in
 177     (try
 178       Http_getter_storage.filename (uri' ^ xml_suffix)
 179     with Http_getter_storage.Resource_not_found _ -> raise (Key_not_found uri))
 180   end
 181
 182 let getxslt uri =
 183   if remote () then getxslt_remote uri
 184   else Http_getter_storage.filename ~find:true ("xslt:/" ^ uri)
 185
 186 let getdtd uri =
 187   if remote () then
 188     getdtd_remote uri
 189   else begin
 190     let fname = Http_getter_env.get_dtd_dir () ^ "/" ^ uri in
 191     if not (Sys.file_exists fname) then raise (Dtd_not_found uri);
 192     fname
 193   end
 194
 195 let clean_cache () =
 196   if remote () then
 197     clean_cache_remote ()
 198   else
 199     Http_getter_storage.clean_cache ()
 200
 201 let (++) (oldann, oldtypes, oldbody, oldtree)
 202          (newann, newtypes, newbody, newtree) =
 203   ((if newann   > oldann    then newann   else oldann),
 204    (if newtypes > oldtypes  then newtypes else oldtypes),
 205    (if newbody  > oldbody   then newbody  else oldbody),
 206    (if newtree  > oldtree   then newtree  else oldtree))
 207
 208 let store_obj tbl o =
 209 (*   prerr_endline ("Http_getter.store_obj " ^ o); *)
 210   if Pcre.pmatch ~rex:showable_file_RE o then begin
 211     let basepart = Pcre.replace ~rex:basepart_RE ~templ:"$1" o in
 212     let no_flags = false, No, No, No in
 213     let oldflags =
 214       try
 215         Hashtbl.find tbl basepart
 216       with Not_found -> (* no ann, no types, no body, no proof tree *)
 217         no_flags
 218     in
 219     let newflags =
 220       match o with
 221       | s when Pcre.pmatch ~rex:types_RE s          -> (false, Yes, No, No)
 222       | s when Pcre.pmatch ~rex:types_ann_RE s      -> (true,  Ann, No, No)
 223       | s when Pcre.pmatch ~rex:body_RE s           -> (false, No, Yes, No)
 224       | s when Pcre.pmatch ~rex:body_ann_RE s       -> (true,  No, Ann, No)
 225       | s when Pcre.pmatch ~rex:proof_tree_RE s     -> (false, No, No, Yes)
 226       | s when Pcre.pmatch ~rex:proof_tree_ann_RE s -> (true,  No, No, Ann)
 227       | s -> no_flags
 228     in
 229     Hashtbl.replace tbl basepart (oldflags ++ newflags)
 230   end
 231
 232 let store_dir set_ref d =
 233   set_ref := StringSet.add (List.hd (Pcre.split ~rex:slash_RE d)) !set_ref
 234
 235 let collect_ls_items dirs_set objs_tbl =
 236   let items = ref [] in
 237   StringSet.iter (fun dir -> items := Ls_section dir :: !items) dirs_set;
 238   Http_getter_misc.hashtbl_sorted_iter
 239     (fun uri (annflag, typesflag, bodyflag, treeflag) ->
 240       items :=
 241         Ls_object {
 242           uri = uri; ann = annflag;
 243           types = typesflag; body = bodyflag; proof_tree = treeflag
 244         } :: !items)
 245     objs_tbl;
 246   List.rev !items
 247
 248 let contains_object = (<>) []
 249
 250   (** non regexp-aware version of ls *)
 251 let rec dumb_ls uri_prefix =
 252 (*   prerr_endline ("Http_getter.dumb_ls " ^ uri_prefix); *)
 253   if is_cic_obj_uri uri_prefix then begin
 254     let dirs = ref StringSet.empty in
 255     let objs = Hashtbl.create 17 in
 256     List.iter
 257       (fun fname ->
 258         if ends_with_slash fname then
 259           store_dir dirs fname
 260         else
 261           try
 262             store_obj objs (strip_suffix ~suffix:xml_suffix fname)
 263           with Invalid_argument _ -> ())
 264       (Http_getter_storage.ls uri_prefix);
 265     collect_ls_items !dirs objs
 266   end else if is_theory_uri uri_prefix then begin
 267     let items = ref [] in
 268     let add_theory fname =
 269       items :=
 270         Ls_object {
 271           uri = fname; ann = false; types = No; body = No; proof_tree = No }
 272         :: !items
 273     in
 274     let cic_uri_prefix =
 275       Pcre.replace_first ~rex:heading_theory_RE ~templ:"cic:" uri_prefix
 276     in
 277     List.iter
 278       (fun fname ->
 279         if ends_with_slash fname then
 280           items := Ls_section (strip_trailing_slash fname) :: !items
 281         else
 282           try
 283             let fname = strip_suffix ~suffix:xml_suffix fname in
 284             let theory_name = strip_suffix ~suffix:theory_suffix fname in
 285             let sub_theory = normalize_dir cic_uri_prefix ^ theory_name ^ "/" in
 286             if is_empty_theory sub_theory then add_theory fname
 287           with Invalid_argument _ -> ())
 288       (Http_getter_storage.ls uri_prefix);
 289     (try
 290       if contains_object (dumb_ls cic_uri_prefix)
 291         && exists (strip_trailing_slash uri_prefix ^ theory_suffix)
 292       then
 293         add_theory "index.theory";
 294     with Unresolvable_URI _ -> ());
 295     !items
 296   end else
 297     raise (Invalid_URI uri_prefix)
 298
 299 and is_empty_theory uri_prefix =
 300 (*   prerr_endline ("is_empty_theory " ^ uri_prefix); *)
 301   not (contains_object (dumb_ls uri_prefix))
 302
 303   (* handle simple regular expressions of the form "...(..|..|..)..." on cic
 304    * uris, not meant to be a real implementation of regexp. The only we use is
 305    * "(cic|theory):/..." *)
 306 let explode_ls_regexp regexp =
 307   try
 308     let len = String.length regexp in
 309     let lparen_idx = String.index regexp '(' in
 310     let rparen_idx = String.index_from regexp lparen_idx ')' in
 311     let choices_str = (* substring between parens, parens excluded *)
 312       String.sub regexp (lparen_idx + 1) (rparen_idx - lparen_idx - 1)
 313     in
 314     let choices = Pcre.split ~rex:pipe_RE choices_str in
 315     let prefix = String.sub regexp 0 lparen_idx in
 316     let suffix = String.sub regexp (rparen_idx + 1) (len - (rparen_idx + 1)) in
 317     List.map (fun choice -> prefix ^ choice ^ suffix) choices
 318   with Not_found -> [regexp]
 319
 320 let merge_results results =
 321   let rec aux objects_acc dirs_acc = function
 322     | [] -> dirs_acc @ objects_acc
 323     | Ls_object _ as obj :: tl -> aux (obj :: objects_acc) dirs_acc tl
 324     | Ls_section _ as dir :: tl ->
 325         if List.mem dir dirs_acc then (* filters out dir duplicates *)
 326           aux objects_acc dirs_acc tl
 327         else
 328           aux objects_acc (dir :: dirs_acc) tl
 329   in
 330   aux [] [] (List.concat results)
 331
 332 let ls regexp =
 333   if remote () then
 334     ls_remote regexp
 335   else
 336     let prefixes = explode_ls_regexp regexp in
 337     merge_results (List.map dumb_ls prefixes)
 338
 339 let getalluris () =
 340   let rec aux acc = function
 341     | [] -> acc
 342     | dir :: todo ->
 343         let acc', todo' =
 344           List.fold_left
 345             (fun (acc, subdirs) result ->
 346               match result with
 347               | Ls_object obj -> (dir ^ obj.uri) :: acc, subdirs
 348               | Ls_section sect -> acc, (dir ^ sect ^ "/") :: subdirs)
 349             (acc, todo)
 350             (dumb_ls dir)
 351         in
 352         aux acc' todo'
 353   in
 354   aux [] ["cic:/"] (* trailing slash required *)
 355
 356 (* Shorthands from now on *)
 357
 358 let getxml' uri = getxml (UriManager.string_of_uri uri)
 359 let resolve' ~writable uri = resolve ~writable (UriManager.string_of_uri uri)
 360 let exists' uri = exists (UriManager.string_of_uri uri)
 361 let filename' ~writable uri = filename  ~writable (UriManager.string_of_uri uri)
 362
 363 let tilde_expand_key k =
 364   try
 365     Helm_registry.set k (HExtlib.tilde_expand (Helm_registry.get k))
 366   with Helm_registry.Key_not_found _ -> ()
 367
 368 let init () =
 369   List.iter tilde_expand_key ["getter.cache_dir"; "getter.dtd_dir"];
 370   Http_getter_logger.set_log_level
 371     (Helm_registry.get_opt_default Helm_registry.int ~default:1
 372       "getter.log_level");
 373   Http_getter_logger.set_log_file
 374     (Helm_registry.get_opt Helm_registry.string "getter.log_file")
 375