]> matita.cs.unibo.it Git - helm.git/blob - helm/ocaml/getter/http_getter.ml
Added universes handling. The PRE_UNIVERSES tag may help ;)
[helm.git] / helm / ocaml / getter / http_getter.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
31 open Http_getter_common
32 open Http_getter_misc
33 open Http_getter_types
34
35 exception Not_implemented of string
36 exception UnexpectedGetterOutput
37
38 (* resolve_result is needed because it is not possible to raise *)
39 (* an exception in a pxp ever-processing callback. Too bad.     *)
40 type resolve_result =
41   | Unknown
42   | Exception of exn
43   | Resolved of string
44
45 type logger_callback = HelmLogger.html_tag -> unit
46
47 let stdout_logger tag =  print_string (HelmLogger.string_of_html_tag tag)
48
49 let not_implemented s = raise (Not_implemented ("Http_getter." ^ s))
50
51 let (index_line_sep_RE, index_sep_RE, trailing_types_RE,
52     heading_cic_RE, heading_theory_RE, heading_nuprl_RE,
53     heading_rdf_cic_RE, heading_rdf_theory_RE) =
54   (Pcre.regexp "[ \t]+", Pcre.regexp "\r\n|\r|\n",
55   Pcre.regexp "\\.types$",
56   Pcre.regexp "^cic:", Pcre.regexp "^theory:", Pcre.regexp "^nuprl:",
57   Pcre.regexp "^helm:rdf.*//cic:", Pcre.regexp "^helm:rdf.*//theory:")
58
59   (* global maps, shared by all threads *)
60
61 let cic_map =
62   lazy (new Http_getter_map.map (Lazy.force Http_getter_env.cic_dbm))
63 let nuprl_map =
64   lazy (new Http_getter_map.map (Lazy.force Http_getter_env.nuprl_dbm))
65 let rdf_map =
66   lazy (new Http_getter_map.map (Lazy.force Http_getter_env.rdf_dbm))
67 let xsl_map =
68   lazy (new Http_getter_map.map (Lazy.force Http_getter_env.xsl_dbm))
69
70 let maps = [ cic_map; nuprl_map; rdf_map; xsl_map ]
71 let close_maps () = List.iter (fun m -> (Lazy.force m) # close) maps
72 let clear_maps () = List.iter (fun m -> (Lazy.force m) # clear) maps
73 let sync_maps  () = List.iter (fun m -> (Lazy.force m) # sync) maps
74
75 let map_of_uri = function
76   | uri when is_cic_uri uri -> Lazy.force cic_map
77   | uri when is_nuprl_uri uri -> Lazy.force nuprl_map
78   | uri when is_rdf_uri uri -> Lazy.force rdf_map
79   | uri when is_xsl_uri uri -> Lazy.force xsl_map
80   | uri -> prerr_endline "BBBBB";raise (Unresolvable_URI uri)
81
82 let update_from_server logger server_url = (* use global maps *)
83   Http_getter_logger.log ("Updating information from " ^ server_url);
84   let xml_url_of_uri = function
85       (* TODO missing sanity checks on server_url, e.g. it can contains $1 *)
86     | uri when (Pcre.pmatch ~rex:heading_cic_RE uri) ->
87         Pcre.replace ~rex:heading_cic_RE ~templ:server_url uri
88     | uri when (Pcre.pmatch ~rex:heading_theory_RE uri) ->
89         Pcre.replace ~rex:heading_theory_RE ~templ:server_url uri
90     | uri when (Pcre.pmatch ~rex:heading_nuprl_RE uri) ->
91         Pcre.replace ~rex:heading_nuprl_RE ~templ:server_url uri
92     | uri -> raise (Invalid_URI uri)
93   in
94   let rdf_url_of_uri = function (* TODO as above *)
95     | uri when (Pcre.pmatch ~rex:heading_rdf_cic_RE uri) ->
96         Pcre.replace ~rex:heading_rdf_cic_RE ~templ:server_url uri
97     | uri when (Pcre.pmatch ~rex:heading_rdf_theory_RE uri) ->
98         Pcre.replace ~rex:heading_rdf_theory_RE ~templ:server_url uri
99     | uri -> raise (Invalid_URI uri)
100   in
101   logger (`T ("Processing server: " ^ server_url));
102   logger `BR;
103   let (xml_index, rdf_index, xsl_index) =
104     (* TODO keeps index in memory, is better to keep them on temp files? *)
105     (http_get (server_url ^ "/" ^ (Lazy.force Http_getter_env.xml_index)),
106      http_get (server_url ^ "/" ^ (Lazy.force Http_getter_env.rdf_index)),
107      http_get (server_url ^ "/" ^ (Lazy.force Http_getter_env.xsl_index)))
108   in
109   if (xml_index = None && rdf_index = None && xsl_index = None) then
110     Http_getter_logger.log (sprintf "Warning: useless server %s" server_url);
111   (match xml_index with
112   | Some xml_index ->
113       logger (`T "- Updating XML db ...");
114 (*       logger `BR; *)
115       List.iter
116         (function
117           | l when is_blank_line l -> ()  (* skip blank and commented lines *)
118           | l ->
119               (try
120                 (match Pcre.split ~rex:index_line_sep_RE l with
121                 | [uri; "gz"] ->
122                    assert (is_cic_uri uri || is_nuprl_uri uri) ;
123                    (map_of_uri uri)#replace
124                     uri ((xml_url_of_uri uri) ^ ".xml.gz")
125                 | [uri] ->
126                    assert (is_cic_uri uri || is_nuprl_uri uri) ;
127                    (map_of_uri uri)#replace
128                     uri ((xml_url_of_uri uri) ^ ".xml")
129                 | _ ->
130                     logger (`T ("Ignoring invalid line: '" ^ l));
131                     logger `BR)
132               with Invalid_URI uri ->
133                 logger (`T ("Ignoring invalid XML URI: '" ^ l));
134                 logger `BR))
135         (Pcre.split ~rex:index_sep_RE xml_index); (* xml_index lines *)
136       logger (`T "All done");
137       logger `BR
138   | None -> ());
139   (match rdf_index with
140   | Some rdf_index ->
141       logger (`T "- Updating RDF db ...");
142 (*       logger `BR; *)
143       List.iter
144         (fun l ->
145           try
146             (match Pcre.split ~rex:index_line_sep_RE l with
147             | [uri; "gz"] ->
148                 (Lazy.force rdf_map) # replace uri
149                   ((rdf_url_of_uri uri) ^ ".xml.gz")
150             | [uri] ->
151                 (Lazy.force rdf_map) # replace uri
152                   ((rdf_url_of_uri uri) ^ ".xml")
153             | _ ->
154                 logger (`T ("Ignoring invalid line: '" ^ l));
155                 logger `BR)
156           with Invalid_URI uri ->
157             logger (`T ("Ignoring invalid RDF URI: '" ^ l));
158             logger `BR)
159         (Pcre.split ~rex:index_sep_RE rdf_index); (* rdf_index lines *)
160       logger (`T "All done");
161       logger `BR
162   | None -> ());
163   (match xsl_index with
164   | Some xsl_index ->
165       logger (`T "- Updating XSLT db ...");
166 (*       logger `BR; *)
167       List.iter
168         (fun l -> (Lazy.force xsl_map) # replace l (server_url ^ "/" ^ l))
169         (Pcre.split ~rex:index_sep_RE xsl_index);
170       logger (`T "All done");
171       logger `BR
172   | None -> ());
173   Http_getter_logger.log "done with this server"
174
175 let update_from_all_servers logger () =  (* use global maps *)
176   clear_maps ();
177   List.iter
178     (update_from_server logger)
179       (* reverse order: 1st server is the most important one *)
180     (List.map snd (List.rev (Http_getter_env.servers ())));
181   sync_maps ()
182
183 let update_from_one_server ?(logger = fun _ -> ()) server_url =
184   update_from_server logger server_url
185
186 let temp_file_of_uri uri =
187   let flat_string s s' c =
188     let cs = String.copy s in
189     for i = 0 to (String.length s) - 1 do
190       if String.contains s' s.[i] then cs.[i] <- c
191     done;
192     cs
193   in
194   let user = try Unix.getlogin () with _ -> "" in
195   Filename.open_temp_file (user ^ flat_string uri ".-=:;!?/&" '_') ""
196
197   (* should we use a remote getter or not *)
198 let remote () =
199   try
200     Helm_registry.get "getter.mode" = "remote"
201   with Helm_registry.Key_not_found _ -> false
202 let getter_url () = Helm_registry.get "getter.url"
203
204 (* Remote interface: getter methods implemented using a remote getter *)
205
206   (* <TODO> *)
207 let getxslt_remote ~patch_dtd uri = not_implemented "getxslt_remote"
208 let getdtd_remote ~patch_dtd uri = not_implemented "getdtd_remote"
209 let clean_cache_remote () = not_implemented "clean_cache_remote"
210 let list_servers_remote () = not_implemented "list_servers_remote"
211 let add_server_remote ~logger ~position name =
212   not_implemented "add_server_remote"
213 let remove_server_remote ~logger position =
214   not_implemented "remove_server_remote"
215 let getalluris_remote () = not_implemented "getalluris_remote"
216 let getallrdfuris_remote () = not_implemented "getallrdfuris_remote"
217 let ls_remote lsuri = not_implemented "ls_remote"
218   (* </TODO> *)
219
220 let resolve_remote uri =
221   (* deliver resolve request to http_getter *)
222   let doc = ClientHTTP.get (sprintf "%sresolve?uri=%s" (getter_url ()) uri) in
223   let res = ref Unknown in
224    Pxp_ev_parser.process_entity PxpHelmConf.pxp_config (`Entry_content [])
225     (Pxp_ev_parser.create_entity_manager ~is_document:true
226       PxpHelmConf.pxp_config (Pxp_yacc.from_string doc))
227     (function
228       | Pxp_types.E_start_tag ("url",["value",url],_,_) -> res := Resolved url
229       | Pxp_types.E_start_tag ("unresolvable",[],_,_) ->
230           res := Exception (Unresolvable_URI uri)
231       | Pxp_types.E_start_tag ("not_found",[],_,_) ->
232           res := Exception (Key_not_found uri)
233       | Pxp_types.E_start_tag (x,_,_,_) -> 
234           prerr_endline ("UnexpectedGetterOutput: "^x);
235           res := Exception UnexpectedGetterOutput
236       | _ -> ());
237    match !res with
238    | Unknown -> 
239        prerr_endline ("UnexpectedGetterOutput: Unknown!");
240        raise UnexpectedGetterOutput
241    | Exception e -> 
242        prerr_endline ("Exception   : ??????");
243        raise e
244    | Resolved url -> url
245
246 let register_remote ~uri ~url =
247   ClientHTTP.send (sprintf "%sregister?uri=%s&url=%s" (getter_url ()) uri url)
248
249 let unregister_remote uri =
250   ClientHTTP.send (sprintf "%sunregister?uri=%s" (getter_url ()) uri)
251
252 let update_remote logger  () =
253   let answer = ClientHTTP.get (getter_url () ^ "update") in
254   logger (`T answer);
255   logger `BR
256
257 let getxml_remote ~format ~patch_dtd uri =
258   ClientHTTP.get_and_save_to_tmp
259     (sprintf "%sgetxml?uri=%s&format=%s&patch_dtd=%s"
260       (getter_url ()) uri
261       (match format with `Normal -> "normal" | `Gzipped -> "gzipped")
262       (match patch_dtd with true -> "yes" | false -> "no"))
263
264 (* API *)
265
266 let help () = Http_getter_const.usage_string (Http_getter_env.env_to_string ())
267
268 let resolve uri =
269   if remote () then
270     resolve_remote uri
271   else
272     
273     (**** FIXME ******)
274     if is_cic_uri uri && Pcre.pmatch ~pat:"\\.univ$" uri then
275       begin
276         prerr_endline "!!! E' in ~tassi !!!";
277         "file:///home/tassi/mylib" ^ 
278         (String.sub uri 4 ((String.length uri) - 4)) ^ ".xml.gz"
279       end
280     else
281       (map_of_uri uri)#resolve uri
282         
283 let register ~uri ~url =
284   if remote () then
285     register_remote ~uri ~url
286   else
287     (map_of_uri uri)#add uri url
288
289 let unregister uri =
290   if remote () then
291     unregister_remote uri
292   else
293     (map_of_uri uri)#remove uri
294
295 let update ?(logger = fun _ -> ()) () =
296   if remote () then
297     update_remote logger ()
298   else
299     update_from_all_servers logger ()
300
301 let getxml ?(format = `Normal) ?(patch_dtd = true) uri =
302   if remote () then
303     getxml_remote ~format ~patch_dtd uri
304   else begin
305 Http_getter_logger.log ("GETXML: " ^ uri);
306     let url = resolve uri in
307 Http_getter_logger.log ("RESOLVED_URI: " ^ url) ;
308     let (fname, outchan) = temp_file_of_uri uri in
309     Http_getter_cache.respond_xml ~via_http:false ~enc:format ~patch:patch_dtd
310       ~uri ~url outchan;
311     close_out outchan;
312     fname
313   end
314
315 let getxslt ?(patch_dtd = true) uri =
316   if remote () then
317     getxslt_remote ~patch_dtd uri
318   else begin
319     
320     let url = resolve uri in
321     let (fname, outchan) = temp_file_of_uri uri in
322     Http_getter_cache.respond_xsl ~via_http:false ~url ~patch:patch_dtd outchan;
323     close_out outchan;
324     fname
325   end
326
327 let getdtd ?(patch_dtd = true) uri =
328   if remote () then
329     getdtd_remote ~patch_dtd uri
330   else begin
331     let url = Lazy.force Http_getter_env.dtd_dir ^ "/" ^ uri in
332     let (fname, outchan) = temp_file_of_uri uri in
333     Http_getter_cache.respond_dtd ~via_http:false ~url ~patch:patch_dtd outchan;
334     close_out outchan;
335     fname
336   end
337
338 let clean_cache () =
339   if remote () then
340     clean_cache_remote ()
341   else
342     Http_getter_cache.clean ()
343
344 let list_servers () =
345   if remote () then
346     list_servers_remote ()
347   else
348     Http_getter_env.servers ()
349
350 let add_server ?(logger = fun _ -> ()) ?(position = 0) name =
351   if remote () then
352     add_server_remote ~logger ~position name
353   else begin
354     if position = 0 then begin
355       Http_getter_env.add_server ~position:0 name;
356       update_from_one_server ~logger name (* quick update (new server only) *)
357     end else if position > 0 then begin
358       Http_getter_env.add_server ~position name;
359       update ~logger ()
360     end else  (* already checked by parse_position *)
361       assert false
362   end
363
364 let has_server position = List.mem_assoc position (Http_getter_env.servers ())
365
366 let remove_server ?(logger = fun _ -> ()) position =
367   if remote () then
368     remove_server_remote ~logger ()
369   else begin
370     let server_name =
371       try
372         List.assoc position (Http_getter_env.servers ())
373       with Not_found ->
374         raise (Invalid_argument (sprintf "no server with position %d" position))
375     in
376     Http_getter_env.remove_server position;
377     update ~logger ()
378   end
379
380 let return_uris map filter =
381   let uris = ref [] in
382   map#iter (fun uri _ -> if filter uri then uris := uri :: !uris);
383   List.rev !uris
384
385 let getalluris () =
386   if remote () then
387     getalluris_remote ()
388   else
389     let filter uri =
390       (Pcre.pmatch ~rex:heading_cic_RE uri) &&
391       not (Pcre.pmatch ~rex:trailing_types_RE uri)
392     in
393     return_uris (Lazy.force cic_map) filter
394
395 let getallrdfuris classs =
396   if remote () then
397     getallrdfuris_remote ()
398   else
399     let filter =
400       let base = "^helm:rdf:www\\.cs\\.unibo\\.it/helm/rdf/" in
401       match classs with
402       | `Forward -> (fun uri -> Pcre.pmatch ~pat:(base ^ "forward") uri)
403       | `Backward -> (fun uri -> Pcre.pmatch ~pat:(base ^ "backward") uri)
404     in
405     return_uris (Lazy.force rdf_map) filter
406
407 let ls =
408   let (++) (oldann, oldtypes, oldbody, oldtree)
409            (newann, newtypes, newbody, newtree) =
410     ((if newann   > oldann    then newann   else oldann),
411      (if newtypes > oldtypes  then newtypes else oldtypes),
412      (if newbody  > oldbody   then newbody  else oldbody),
413      (if newtree  > oldtree   then newtree  else oldtree))
414   in
415   let basepart_RE =
416     Pcre.regexp
417       "^([^.]*\\.[^.]*)((\\.body)|(\\.proof_tree)|(\\.types))?(\\.ann)?$"
418   in
419   let (types_RE, types_ann_RE, body_RE, body_ann_RE,
420        proof_tree_RE, proof_tree_ann_RE, trailing_slash_RE, theory_RE) =
421     (Pcre.regexp "\\.types$", Pcre.regexp "\\.types\\.ann$",
422      Pcre.regexp "\\.body$", Pcre.regexp "\\.body\\.ann$",
423      Pcre.regexp "\\.proof_tree$", Pcre.regexp "\\.proof_tree\\.ann$",
424      Pcre.regexp "/$", Pcre.regexp "\\.theory$")
425   in
426   let (slash_RE, til_slash_RE, no_slashes_RE) =
427     (Pcre.regexp "/", Pcre.regexp "^.*/", Pcre.regexp "^[^/]*$")
428   in
429   fun regexp ->
430     if remote () then
431       ls_remote regexp
432     else begin
433       let looking_for_dir = Pcre.pmatch ~rex:trailing_slash_RE regexp in
434       let pat = Pcre.replace ~rex:trailing_slash_RE ("^" ^ regexp) in
435       let (dir_RE, dir_RE2, obj_RE, orig_theory_RE) =
436         Pcre.regexp (pat ^ "/"), Pcre.regexp (pat ^ "/[^/]*"),
437         Pcre.regexp (pat ^ "(\\.|$)"), Pcre.regexp (pat ^ ".theory$")
438       in
439       let dirs = ref StringSet.empty in
440       let objs = Hashtbl.create 17 in
441       let store_dir d =
442         dirs := StringSet.add (List.hd (Pcre.split ~rex:slash_RE d)) !dirs
443       in
444       let store_obj o =
445         let basepart = Pcre.replace ~rex:basepart_RE ~templ:"$1" o in
446         let no_flags = false, No, No, No in
447         let oldflags =
448           try
449             Hashtbl.find objs basepart
450           with Not_found -> (* no ann, no types, no body, no proof tree *)
451             no_flags
452         in
453         let newflags =
454           match o with
455           | s when Pcre.pmatch ~rex:types_RE s          -> (false, Yes, No, No)
456           | s when Pcre.pmatch ~rex:types_ann_RE s      -> (true,  Ann, No, No)
457           | s when Pcre.pmatch ~rex:body_RE s           -> (false, No, Yes, No)
458           | s when Pcre.pmatch ~rex:body_ann_RE s       -> (true,  No, Ann, No)
459           | s when Pcre.pmatch ~rex:proof_tree_RE s     -> (false, No, No, Yes)
460           | s when Pcre.pmatch ~rex:proof_tree_ann_RE s -> (true,  No, No, Ann)
461           | s -> no_flags
462         in
463         Hashtbl.replace objs basepart (oldflags ++ newflags)
464       in
465       (* Variables used in backward compatibility code to map
466          theory:/path/t.theory into theory:/path/t/index.theory
467          when cic:/path/t/ exists *)
468       let the_candidate_for_remapping =
469        (* CSC: Here I am making a strong assumption: the pattern
470           can be only of the form  [^:]*:/path where path is
471           NOT a regular expression *)
472        "theory:" ^ Pcre.replace ~rex:(Pcre.regexp "[^:]*:") pat
473       in
474       let index_not_generated_yet = ref true in
475       let valid_candidates = ref [] in
476       let candidates_found = ref [] in
477       (Lazy.force cic_map) # iter
478         (* BLEARGH Dbm module lacks support for fold-like functions *)
479         (fun key _ ->
480           match key with
481           | uri when looking_for_dir && Pcre.pmatch ~rex:dir_RE uri ->
482               (* directory hit *)
483               let localpart = Pcre.replace ~rex:dir_RE uri in
484               if Pcre.pmatch ~rex:no_slashes_RE localpart then
485                begin
486                 (* Backward compatibility code to map
487                    theory:/path/t.theory into theory:/path/t/index.theory
488                    when cic:/path/t/ exists *)
489                 if Pcre.pmatch ~rex:theory_RE localpart then
490                  candidates_found := (uri,localpart) :: !candidates_found
491                 else
492                  store_obj localpart
493
494                end
495               else
496                begin
497                 store_dir localpart ;
498                 if String.sub uri 0 3 = "cic" then
499                  let dir_found = ref "" in
500                  let _ =
501                   Pcre.substitute_first ~rex:dir_RE2
502                    ~subst:(fun s -> dir_found := s; "") uri in
503                  let dir =
504                   "theory" ^ String.sub !dir_found 3
505                    (String.length !dir_found - 3) ^ ".theory" in
506 (*
507 prerr_endline ("### " ^ uri ^ " ==> " ^ !dir_found ^ " ==> " ^ dir);
508 *)
509                  if not (List.mem dir !valid_candidates) then
510                  valid_candidates := dir::!valid_candidates
511                end
512           | uri when (not looking_for_dir) && Pcre.pmatch ~rex:obj_RE  uri ->
513               (* file hit *)
514               store_obj (Pcre.replace ~rex:til_slash_RE uri)
515           | uri -> (* miss *)
516              if !index_not_generated_yet &&
517                 Pcre.pmatch ~rex:orig_theory_RE uri
518              then
519               (index_not_generated_yet := false ;
520                store_obj "index.theory"));
521 (*
522 prerr_endline ("@@@ " ^ String.concat " " !valid_candidates);
523 prerr_endline ("!!! " ^ String.concat " " (List.map fst !candidates_found));
524 *)
525       List.iter
526        (fun (uri,localpart) ->
527          if not (List.mem uri !valid_candidates) then
528           store_obj localpart
529        ) !candidates_found ;
530       let ls_items = ref [] in
531       StringSet.iter (fun dir -> ls_items := Ls_section dir :: !ls_items) !dirs;
532       Http_getter_misc.hashtbl_sorted_iter
533         (fun uri (annflag, typesflag, bodyflag, treeflag) ->
534           ls_items :=
535             Ls_object {
536               uri = uri; ann = annflag;
537               types = typesflag; body = bodyflag; proof_tree = treeflag
538             } :: !ls_items)
539         objs;
540       List.rev !ls_items
541     end
542
543   (* Shorthands from now on *)
544
545 let getxml' uri = getxml (UriManager.string_of_uri uri)
546 let resolve' uri = resolve (UriManager.string_of_uri uri)
547 let register' uri url = register ~uri:(UriManager.string_of_uri uri) ~url
548