2 * Copyright (C) 2000, HELM Team.
4 * This file is part of HELM, an Hypertextual, Electronic
5 * Library of Mathematics, developed at the Computer Science
6 * Department, University of Bologna, Italy.
8 * HELM is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
13 * HELM is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with HELM; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
23 * For details, see the HELM World-Wide-Web page,
24 * http://cs.unibo.it/helm/.
27 (* TODO optimization: precompile regexps *)
29 open Http_getter_common;;
30 open Http_getter_misc;;
31 open Http_getter_types;;
32 open Http_getter_debugger;;
35 (* HTTP queries argument parsing *)
37 let parse_enc (req: Http_types.request) =
39 (match req#param "format" with
40 | "normal" -> Enc_normal
42 | s -> raise (Http_getter_bad_request ("Invalid format: " ^ s)))
43 with Http_types.Param_not_found _ -> Enc_normal
45 let parse_patch_dtd (req: Http_types.request) =
46 match req#param "patch_dtd" with
47 | s when String.lowercase s = "yes" -> true
48 | s when String.lowercase s = "no" -> false
49 | s -> raise (Http_getter_bad_request ("Invalid patch_dtd value: " ^ s))
51 let parse_output_format (req: Http_types.request) =
52 match req#param "format" with
53 | s when String.lowercase s = "txt" -> Fmt_text
54 | s when String.lowercase s = "xml" -> Fmt_xml
55 | s -> raise (Http_getter_bad_request ("Invalid /ls format: " ^ s))
57 let parse_ls_uri (req: Http_types.request) =
58 let baseuri = req#param "baseuri" in
60 Pcre.extract ~pat:"^(\\w+):(.*)$" (Pcre.replace ~pat:"/+$" baseuri)
62 match (subs.(1), subs.(2)) with
63 | "cic", uri -> Cic uri
64 | "theory", uri -> Theory uri
65 | _ -> raise (Http_getter_bad_request ("Invalid /ls baseuri: " ^ baseuri))
68 (* global maps, shared by all threads *)
70 let xml_map = new Http_getter_map.map Http_getter_env.xml_dbm in
71 let rdf_map = new Http_getter_map.map Http_getter_env.rdf_dbm in
72 let xsl_map = new Http_getter_map.map Http_getter_env.xsl_dbm in
74 let save_maps () = xml_map#close; rdf_map#close; xsl_map#close in
75 let map_of_uri = function
76 | uri when is_xml_uri uri -> xml_map
77 | uri when is_rdf_uri uri -> rdf_map
78 | uri when is_xsl_uri uri -> xsl_map
79 | uri -> raise (Http_getter_unresolvable_URI uri)
81 let resolve uri = (map_of_uri uri)#resolve uri in
82 let register uri = (map_of_uri uri )#add uri in
83 let return_all_foo_uris map doctype filter outchan =
84 Http_daemon.send_basic_headers ~code:200 outchan;
85 Http_daemon.send_header "Content-Type" "text/xml" outchan;
86 Http_daemon.send_CRLF outchan;
90 "<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>
91 <!DOCTYPE %s SYSTEM \"%s/getdtd?uri=%s.dtd\">
96 Http_getter_env.my_own_url
102 output_string outchan (sprintf "\t<uri value=\"%s\" />\n" uri));
103 output_string outchan (sprintf "</%s>\n" doctype)
105 let return_all_xml_uris = return_all_foo_uris xml_map "alluris" in
106 let return_all_rdf_uris = return_all_foo_uris rdf_map "allrdfuris" in
108 let (++) (oldann, oldtypes, oldbody) (newann, newtypes, newbody) =
109 ((if newann > oldann then newann else oldann),
110 (if newtypes > oldtypes then newtypes else oldtypes),
111 (if newbody > oldbody then newbody else oldbody))
114 Pcre.regexp "^([^.]*\\.[^.]*)((\\.body)|(\\.types))?(\\.ann)?"
116 let (types_RE, types_ann_RE, body_RE, body_ann_RE) =
117 (Pcre.regexp "\\.types", Pcre.regexp "\\.types.ann",
118 Pcre.regexp "\\.body", Pcre.regexp "\\.body.ann")
120 let (slash_RE, til_slash_RE, no_slashes_RE) =
121 (Pcre.regexp "/", Pcre.regexp "^.*/", Pcre.regexp "^[^/]*$")
123 fun lsuri fmt outchan ->
126 (match lsuri with Cic p -> ("cic:" ^ p) | Theory p -> ("theory:" ^ p))
128 let (dir_RE, obj_RE) =
129 (Pcre.regexp (pat ^ "/"), Pcre.regexp (pat ^ "(\\.|$)"))
131 let dirs = ref StringSet.empty in
132 let objs = Hashtbl.create 17 in
134 dirs := StringSet.add (List.hd (Pcre.split ~rex:slash_RE d)) !dirs
137 let basepart = Pcre.replace ~rex:basepart_RE ~templ:"$1" o in
140 Hashtbl.find objs basepart
141 with Not_found -> (false, No, No) (* no ann, no types no body *)
145 | s when Pcre.pmatch ~rex:types_RE s -> (false, Yes, No)
146 | s when Pcre.pmatch ~rex:types_ann_RE s -> (true, Ann, No)
147 | s when Pcre.pmatch ~rex:body_RE s -> (false, No, Yes)
148 | s when Pcre.pmatch ~rex:body_ann_RE s -> (true, No, Ann)
149 | s -> (false, No, No)
151 Hashtbl.replace objs basepart (oldflags ++ newflags)
153 xml_map#iter (* BLEARGH Dbm module lacks support for fold-like functions *)
156 | uri when Pcre.pmatch ~rex:dir_RE uri -> (* directory hit *)
157 let localpart = Pcre.replace ~rex:dir_RE uri in
158 if Pcre.pmatch ~rex:no_slashes_RE localpart then
162 | uri when Pcre.pmatch ~rex:obj_RE uri -> (* file hit *)
163 store_obj (Pcre.replace ~rex:til_slash_RE uri)
164 | uri -> () (* miss *));
169 (fun s d -> sprintf "%sdir, %s\n" s d) ""
170 (StringSet.elements !dirs)) ^
171 (Http_getter_misc.hashtbl_sorted_fold
172 (fun uri (annflag, typesflag, bodyflag) cont ->
173 sprintf "%sobject, %s, <%s,%s,%s>\n"
174 cont uri (if annflag then "YES" else "NO")
175 (string_of_ls_flag typesflag) (string_of_ls_flag bodyflag))
179 ~headers:["Content-Type", "text/plain"] ~body outchan
183 "<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>
184 <!DOCTYPE ls SYSTEM \"%s/getdtd?uri=ls.dtd\">
190 Http_getter_env.my_own_url
195 (fun d -> "<section>" ^ d ^ "</section>")
196 (StringSet.elements !dirs))) ^ "\n" ^
197 (Http_getter_misc.hashtbl_sorted_fold
198 (fun uri (annflag, typesflag, bodyflag) cont ->
200 "%s<object name=\"%s\">
201 \t<ann value=\"%s\" />
202 \t<types value=\"%s\" />
203 \t<body value=\"%s\" />
206 cont uri (if annflag then "YES" else "NO")
207 (string_of_ls_flag typesflag)
208 (string_of_ls_flag bodyflag))
212 ~headers:["Content-Type", "text/xml"] ~body outchan
214 let (index_line_sep_RE, index_sep_RE) =
215 (Pcre.regexp "[ \t]+", Pcre.regexp "\n+")
217 let update_from_server logmsg server_url = (* use global maps *)
218 debug_print ("Updating information from " ^ server_url);
219 let xml_url_of_uri = function
220 (* TODO missing sanity checks on server_url, e.g. it can contains $1 *)
221 | uri when (Pcre.pmatch ~pat:"^cic:" uri) ->
222 Pcre.replace ~pat:"^cic:" ~templ:server_url uri
223 | uri when (Pcre.pmatch ~pat:"^theory:" uri) ->
224 Pcre.replace ~pat:"^theory:" ~templ:server_url uri
225 | uri -> raise (Http_getter_invalid_URI uri)
227 let rdf_url_of_uri = function (* TODO as above *)
228 | uri when (Pcre.pmatch ~pat:"^helm:rdf.*//cic:" uri) ->
229 Pcre.replace ~pat:"^helm:rdf.*//cic:" ~templ:server_url uri
230 | uri when (Pcre.pmatch ~pat:"^helm:rdf.*//theory:" uri) ->
231 Pcre.replace ~pat:"^helm:rdf.*//theory:" ~templ:server_url uri
232 | uri -> raise (Http_getter_invalid_URI uri)
234 let log = ref (logmsg ^ "Processing server: " ^ server_url ^ "<br />\n") in
235 let (xml_index, rdf_index, xsl_index) =
236 (* TODO keeps index in memory, is better to keep them on temp files? *)
237 (http_get (server_url ^ "/" ^ Http_getter_env.xml_index),
238 http_get (server_url ^ "/" ^ Http_getter_env.rdf_index),
239 http_get (server_url ^ "/" ^ Http_getter_env.xsl_index))
241 if (xml_index = None && rdf_index = None && xsl_index = None) then
242 debug_print (sprintf "Warning: useless server %s" server_url);
243 (match xml_index with
245 (log := !log ^ "Updating XML db ...<br />\n";
249 (match Pcre.split ~rex:index_line_sep_RE l with
250 | [uri; "gz"] -> xml_map#add uri ((xml_url_of_uri uri) ^ ".xml.gz")
251 | [uri] -> xml_map#add uri ((xml_url_of_uri uri) ^ ".xml")
252 | _ -> log := !log ^ "Ignoring invalid line: " ^ l ^ "<br />\n")
253 with Http_getter_invalid_URI uri ->
254 log := !log ^ "Ignoring invalid XML URI: " ^ uri ^ "<br />\n")
255 (Pcre.split ~rex:index_sep_RE xml_index)) (* xml_index lines *)
257 (match rdf_index with
259 (log := !log ^ "Updating RDF db ...<br />\n";
263 (match Pcre.split ~rex:index_line_sep_RE l with
264 | [uri; "gz"] -> rdf_map#add uri ((rdf_url_of_uri uri) ^ ".xml.gz")
265 | [uri] -> rdf_map#add uri ((rdf_url_of_uri uri) ^ ".xml")
266 | _ -> log := !log ^ "Ignoring invalid line: " ^ l ^ "<br />\n")
267 with Http_getter_invalid_URI uri ->
268 log := !log ^ "Ignoring invalid RDF URI: " ^ uri ^ "<br />\n")
269 (Pcre.split ~rex:index_sep_RE rdf_index)) (* rdf_index lines *)
271 (match xsl_index with
273 (log := !log ^ "Updating XSLT db ...<br />\n";
275 (fun l -> xsl_map#add l (server_url ^ "/" ^ l))
276 (Pcre.split ~rex:index_sep_RE xsl_index);
277 log := !log ^ "All done!<br />\n")
279 debug_print "done with this server";
285 let callback (req: Http_types.request) outchan =
287 debug_print ("Connection from " ^ req#clientAddr);
288 debug_print ("Received request: " ^ req#path);
290 | "/help" -> return_html_msg Http_getter_const.usage_string outchan
291 | "/getxml" | "/getxslt" | "/getdtd" | "/resolve" | "/register" ->
292 (let uri = req#param "uri" in (* common parameter *)
295 let enc = parse_enc req in
297 try parse_patch_dtd req with Http_types.Param_not_found _ -> true
299 Http_getter_cache.respond_xml
300 ~url:(resolve uri) ~uri ~enc ~patch_dtd outchan
303 try parse_patch_dtd req with Http_types.Param_not_found _ -> true
305 Http_getter_cache.respond_xsl ~url:(resolve uri) ~patch_dtd outchan
308 try parse_patch_dtd req with Http_types.Param_not_found _ -> true
310 Http_getter_cache.respond_dtd
311 ~patch_dtd ~url:(Http_getter_env.dtd_dir ^ "/" ^ uri) outchan
315 (sprintf "<url value=\"%s\" />\n" (resolve uri))
317 with Http_getter_unresolvable_URI uri ->
318 return_xml_msg "<unresolved />\n" outchan)
320 let url = req#param "url" in
322 return_html_msg "Register done" outchan
325 (xml_map#clear; rdf_map#clear; xsl_map#clear;
329 "" (* initial logmsg: empty *)
330 (* reverse order: 1st server is the most important one *)
331 (List.rev Http_getter_env.servers)
333 xml_map#sync; rdf_map#sync; xsl_map#sync;
334 return_html_msg log outchan)
338 (Pcre.pmatch ~pat:"^cic:" uri) &&
339 not (Pcre.pmatch ~pat:"\\.types$" uri))
341 | "/getallrdfuris" ->
342 (let classs = req#param "class" in
345 let base = "^helm:rdf:www\\.cs\\.unibo\\.it/helm/rdf/" in
347 | ("forward" as c) | ("backward" as c) ->
348 (fun uri -> Pcre.pmatch ~pat:(base ^ c) uri)
349 | c -> raise (Http_getter_invalid_RDF_class c)
351 return_all_rdf_uris filter outchan
352 with Http_getter_invalid_RDF_class c ->
353 raise (Http_getter_bad_request ("Invalid RDF class: " ^ c)))
354 | "/ls" -> return_ls (parse_ls_uri req) (parse_output_format req) outchan
356 Http_daemon.respond ~body:Http_getter_const.empty_xml outchan
358 Http_daemon.respond_error ~status:(`Client_error `Bad_request) outchan);
359 debug_print "Done!\n"
361 | Http_types.Param_not_found attr_name ->
362 return_400 (sprintf "Parameter '%s' is missing" attr_name) outchan
363 | Http_getter_bad_request msg -> return_html_error msg outchan
364 | Http_getter_internal_error msg -> return_html_internal_error msg outchan
365 | Shell.Subprocess_error l ->
366 return_html_internal_error
367 (String.concat "<br />\n"
370 sprintf "Command '%s' returned %s"
371 cmd (string_of_proc_status code))
376 ("Uncaught exception: " ^ (Printexc.to_string exc))
380 (* daemon initialization *)
383 Http_getter_env.dump_env ();
384 Unix.putenv "http_proxy" "";
386 Sys.catch_break true;
389 ~timeout:(Some 600) ~port:Http_getter_env.port ~mode:`Thread callback
390 with Sys.Break -> () (* 'save_maps' already registered with 'at_exit' *)