1 (* Copyright (C) 2002, HELM Team.
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.
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.
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.
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,
22 * For details, see the HELM World-Wide-Web page,
23 * http://cs.unibo.it/helm/.
28 module G = MQueryGenerator
34 let debug_print s = if debug then prerr_endline s;;
35 Http_common.debug := true;;
36 (* Http_common.debug := true;; *)
38 (** accepted HTTP servers for ask_uwobo method forwarding *)
40 [ "mowgli.cs.unibo.it:58080" ; "mowgli.cs.unibo.it" ; "localhost:58080" ];;
42 let mqi_flags = [] (* default MathQL interpreter options *)
46 let daemon_name = "Search Engine";;
47 let default_port = 58085;;
48 let port_env_var = "SEARCH_ENGINE_PORT";;
52 Sys.getenv "SEARCH_ENGINE_HTML_DIR"
53 with Not_found -> "html" (* relative to searchEngine's document root *)
55 let interactive_user_uri_choice_TPL = pages_dir ^ "/templateambigpdq1.html";;
56 let interactive_interpretation_choice_TPL =
57 pages_dir ^ "/templateambigpdq2.html";;
58 let constraints_choice_TPL = pages_dir ^ "/constraints_choice_template.html";;
59 let final_results_TPL = pages_dir ^ "/templateambigpdq3.html";;
61 exception Chat_unfinished
63 (* build a bool from a 1-character-string *)
64 let bool_of_string' = function
67 | s -> failwith ("Can't parse a boolean from string: " ^ s)
70 (* build an int option from a string *)
71 let int_of_string' = function
75 Some (int_of_string s)
76 with Failure "int_of_string" ->
77 failwith ("Can't parse an int option from string: " ^ s)
80 (* HTML pretty printers for mquery_generator types *)
82 let html_of_r_obj (pos, uri) =
84 "<tr><td><input type='checkbox' name='constr_obj' checked='on'/></td><td>%s</td><td>%s</td><td>%s</td></tr>"
85 uri (U.text_of_position pos)
86 (if U.is_main_position pos then
87 sprintf "<input name='obj_depth' size='2' type='text' value='%s' />"
88 (U.text_of_depth pos "")
90 "<input type=\"hidden\" name=\"obj_depth\" />")
93 let html_of_r_rel pos =
95 "<tr><td><input type='checkbox' name='constr_rel' checked='on'/></td><td>%s</td><td><input name='rel_depth' size='2' type='text' value='%s' /></td></tr>"
96 (U.text_of_position (pos:>T.full_position)) (U.text_of_depth (pos:>T.full_position) "")
99 let html_of_r_sort (pos, sort) =
101 "<tr><td><input type='checkbox' name='constr_sort' checked='on'/></td><td>%s</td><td>%s</td><td><input name='sort_depth' size='2' type='text' value='%s'/></td></tr>"
102 (U.text_of_sort sort) (U.text_of_position (pos:>T.full_position)) (U.text_of_depth (pos:>T.full_position) "")
105 (** pretty print a MathQL query result to an HELM theory file *)
106 let theory_of_result result =
107 let results_no = List.length result in
108 if results_no > 0 then
109 let mode = if results_no > 10 then "linkonly" else "typeonly" in
111 let idx = ref (results_no + 1) in
113 (fun (uri,attrs) i ->
115 "<tr><td valign=\"top\">" ^ string_of_int !idx ^ ".</td><td><ht:OBJECT uri=\"" ^ uri ^ "\" mode=\"" ^ mode ^ "\"/></td></tr>" ^ i
118 "<h1>Query Results:</h1><table xmlns:ht=\"http://www.cs.unibo.it/helm/namespaces/helm-theory\">" ^ results ^ "</table>"
120 "<h1>Query Results:</h1><p>No results found!</p>"
123 let pp_result result =
124 "<html xmlns:ht=\"http://www.cs.unibo.it/helm/namespaces/helm-theory\">\n<head><title>Query Results</title><style> A { text-decoration: none } </style></head>\n<body>" ^ theory_of_result result ^ "</body></html>"
127 (** chain application of Pcre substitutions *)
128 let rec apply_substs substs line =
131 | (rex, templ) :: rest -> apply_substs rest (Pcre.replace ~rex ~templ line)
132 (** fold like function on files *)
133 let fold_file f init fname =
134 let inchan = open_in fname in
135 let rec fold_lines' value =
137 let line = input_line inchan in
138 fold_lines' (f value line)
139 with End_of_file -> value
141 let res = (try fold_lines' init with e -> (close_in inchan; raise e)) in
144 (** iter like function on files *)
145 let iter_file f = fold_file (fun _ line -> f line) ()
147 let (title_tag_RE, choices_tag_RE, msg_tag_RE, id_to_uris_RE, id_RE,
148 interpretations_RE, interpretations_labels_RE, results_RE, new_aliases_RE,
149 form_RE, variables_initialization_RE)
151 (Pcre.regexp "@TITLE@", Pcre.regexp "@CHOICES@", Pcre.regexp "@MSG@",
152 Pcre.regexp "@ID_TO_URIS@", Pcre.regexp "@ID@",
153 Pcre.regexp "@INTERPRETATIONS@", Pcre.regexp "@INTERPRETATIONS_LABELS@",
154 Pcre.regexp "@RESULTS@", Pcre.regexp "@NEW_ALIASES@", Pcre.regexp "@FORM@",
155 Pcre.regexp "@VARIABLES_INITIALIZATION@")
156 let server_and_port_url_RE = Pcre.regexp "^http://([^/]+)/.*$"
158 exception NotAnInductiveDefinition
162 int_of_string (Sys.getenv port_env_var)
164 | Not_found -> default_port
165 | Failure "int_of_string" ->
166 prerr_endline "Warning: invalid port, reverting to default";
170 let pp_error = sprintf "<html><body><h1>Error: %s</h1></body></html>";;
172 let bad_request body outchan =
173 Http_daemon.respond_error ~status:(`Client_error `Bad_request) ~body outchan
176 let contype = "Content-Type", "text/html";;
178 (* SEARCH ENGINE functions *)
180 let refine_constraints ((constr_obj:T.r_obj list), (constr_rel:T.r_rel list), (constr_sort:T.r_sort list)) =
183 U.universe_for_search_pattern,
184 (constr_obj, constr_rel, constr_sort),
185 (Some constr_obj, Some constr_rel, Some constr_sort)
186 | "/matchConclusion" ->
189 (function (pos, uri) -> U.set_full_position pos None, uri)
191 (function (pos, _) -> U.is_conclusion pos)
194 U.universe_for_match_conclusion,
195 (*CSC: we must select the must constraints here!!! *)
196 (constr_obj',[],[]),(Some constr_obj', None, None)
200 let get_constraints term =
202 "/locateInductivePrinciple" ->
205 Cic.MutInd (uri,t,_) -> MQueryUtil.string_of_uriref (uri,[t])
206 | _ -> raise NotAnInductiveDefinition
209 [(`InHypothesis, uri); (`MainHypothesis (Some 0), uri)]
211 let constr_rel = [`MainConclusion None] in
212 let constr_sort = [(`MainHypothesis (Some 1), T.Prop)] in
213 U.universe_for_search_pattern,
214 (constr_obj, constr_rel, constr_sort), (None,None,None)
216 let must = MQueryLevels2.get_constraints term in
217 refine_constraints must req_path
222 <must_obj> ':' <must_rel> ':' <must_sort> ':' <only_obj> ':' <only_rel> ':' <only_sort>
224 <must_*> ::= ('0'|'1') ('_'|<int>) (',' ('0'|'1') ('_'|<int>))*
227 let add_user_constraints ~constraints
228 ((obj, rel, sort), (only_obj, only_rel, only_sort))
231 let l = Pcre.split ~pat:"," s in
235 let subs = Pcre.extract ~pat:"^(.)(\\d+|_)$" s in
236 (bool_of_string' subs.(1), int_of_string' subs.(2)))
239 Not_found -> failwith ("Can't parse constraint string: " ^ constraints)
242 (* to be used on "obj" *)
243 let add_user_must33 user_must must =
245 (fun (b, i) (p, u) -> U.set_full_position p (if b then i else None), u)
248 (* to be used on "rel" *)
249 let add_user_must22 user_must must =
251 (fun (b, i) p -> U.set_main_position p (if b then i else None))
254 (* to be used on "sort" *)
255 let add_user_must32 user_must must =
257 (fun (b, i) (p, s) -> U.set_main_position p (if b then i else None), s)
260 match Pcre.split ~pat:":" constraints with
261 | [user_obj;user_rel;user_sort;user_only_obj;user_only_rel;user_only_sort] ->
263 (user_obj,user_rel,user_sort,user_only_obj,user_only_rel,user_only_sort)
265 (parse_must user_obj,
267 parse_must user_sort,
268 bool_of_string' user_only_obj,
269 bool_of_string' user_only_rel,
270 bool_of_string' user_only_sort)
273 (if user_only_obj then only_obj else None),
274 (if user_only_rel then only_rel else None),
275 (if user_only_sort then only_sort else None)
278 add_user_must33 user_obj obj,
279 add_user_must22 user_rel rel,
280 add_user_must32 user_sort sort
283 | _ -> failwith ("Can't parse constraint string: " ^ constraints)
286 (* HTTP DAEMON CALLBACK *)
288 let callback (req: Http_types.request) outchan =
290 debug_print (sprintf "Received request: %s" req#path);
293 let mqi_handle = C.init mqi_flags debug_print in
294 let query_string = req#param "query" in
295 let lexbuf = Lexing.from_string query_string in
296 let query = MQueryUtil.query_of_text lexbuf in
297 let result = MQueryInterpreter.execute mqi_handle query in
298 let result_string = pp_result result in
300 Http_daemon.respond ~body:result_string ~headers:[contype] outchan
302 let mqi_handle = C.init mqi_flags debug_print in
303 let id = req#param "id" in
304 let query = G.locate id in
305 let result = MQueryInterpreter.execute mqi_handle query in
307 Http_daemon.respond ~headers:[contype] ~body:(pp_result result) outchan
309 (* TODO implement "is_permitted" *)
310 (let is_permitted _ = true in
311 let remove_fragment uri = Pcre.replace ~pat:"#.*" uri in
312 let page = remove_fragment (req#param "url") in
315 bool_of_string (req#param "preprocess")
316 with Invalid_argument _ | Http_types.Param_not_found _ -> false)
319 | page when is_permitted page ->
320 (let fname = sprintf "%s/%s" pages_dir (remove_fragment page) in
321 Http_daemon.send_basic_headers ~code:200 outchan;
322 Http_daemon.send_header "Content-Type" "text/html" outchan;
323 Http_daemon.send_CRLF outchan;
324 if preprocess then begin
327 output_string outchan
330 (function (key,value) ->
332 (Pcre.extract ~pat:"param\\.(.*)" key).(1)
334 Pcre.regexp ("@" ^ key' ^ "@"), value
337 (fun (key,_) as p-> Pcre.pmatch ~pat:"^param\\." key)
344 Http_daemon.send_file ~src:(FileSrc fname) outchan)
345 | page -> Http_daemon.respond_forbidden ~url:page outchan))
347 let url = req#param "url" in
348 let server_and_port =
349 (Pcre.extract ~rex:server_and_port_url_RE url).(1)
351 if List.mem server_and_port valid_servers then
353 ~headers:["Content-Type", "text/html"]
354 ~body:(Http_client.Convenience.http_get url)
358 ~body:(pp_error ("Untrusted UWOBO server: " ^ server_and_port))
362 | "/locateInductivePrinciple" ->
363 let mqi_handle = C.init mqi_flags debug_print in
364 let term_string = req#param "term" in
365 let lexbuf = Lexing.from_string term_string in
366 let (context, metasenv) = ([], []) in
367 let (dom, mk_metasenv_and_expr) =
368 CicTextualParserContext.main
369 ~context ~metasenv CicTextualLexer.token lexbuf
371 let id_to_uris_raw = req#param "aliases" in
372 let tokens = Pcre.split ~pat:"\\s" id_to_uris_raw in
373 let rec parse_tokens keys lookup = function (* TODO spostarla fuori *)
375 | "alias" :: key :: value :: rest ->
376 let key' = CicTextualParser0.Id key in
382 (CicTextualParser0.Uri (MQueryMisc.cic_textual_parser_uri_of_string value))
385 | _ -> failwith "Can't parse aliases"
387 let parse_choices choices_raw =
388 let choices = Pcre.split ~pat:";" choices_raw in
391 match Pcre.split ~pat:"\\s" x with
393 | id::tail when id<>"" ->
395 prerr_endline ("#### " ^ id ^ " :=");
396 List.iter (fun u -> prerr_endline ("<" ^ Netencoding.Url.decode u ^ ">")) tail;
398 Some (List.map (fun u -> Netencoding.Url.decode u) tail)
401 | _ -> failwith "Can't parse choices")
405 let (id_to_uris : Disambiguate.domain_and_interpretation) =
406 parse_tokens [] (fun _ -> None) tokens in
409 let choices_raw = req#param "choices" in
410 parse_choices choices_raw
411 with Http_types.Param_not_found _ -> (fun _ -> None)
413 let module Chat: Disambiguate.Callbacks =
416 let get_metasenv () =
417 !CicTextualParser0.metasenv
419 let set_metasenv metasenv =
420 CicTextualParser0.metasenv := metasenv
422 let output_html = prerr_endline
424 let interactive_user_uri_choice
426 ?enable_button_for_non_vars ~(title: string) ~(msg: string)
427 ~(id: string) (choices: string list)
429 (match id_to_choices id with
430 | Some choices -> choices
432 let msg = Pcre.replace ~pat:"\'" ~templ:"\\\'" msg in
433 (match selection_mode with
434 | `SINGLE -> assert false
436 Http_daemon.send_basic_headers ~code:200 outchan ;
437 Http_daemon.send_CRLF outchan ;
440 let formatted_choices =
442 (List.map (fun uri -> sprintf "\'%s\'" uri) choices)
446 [title_tag_RE, title;
447 choices_tag_RE, formatted_choices;
449 id_to_uris_RE, id_to_uris_raw;
453 output_string outchan (processed_line ^ "\n"))
454 interactive_user_uri_choice_TPL;
455 raise Chat_unfinished))
457 let interactive_interpretation_choice interpretations =
458 let html_interpretations_labels =
463 (String.concat "<br />"
466 (sprintf "alias %s %s" id value))
471 let html_interpretations =
479 (sprintf "alias %s %s"
481 (MQueryMisc.wrong_xpointer_format_from_wrong_xpointer_format'
487 Http_daemon.send_basic_headers ~code:200 outchan ;
488 Http_daemon.send_CRLF outchan ;
493 [interpretations_RE, html_interpretations;
494 interpretations_labels_RE, html_interpretations_labels]
497 output_string outchan (processed_line ^ "\n"))
498 interactive_interpretation_choice_TPL;
499 raise Chat_unfinished
501 let input_or_locate_uri ~title =
502 UriManager.uri_of_string "cic:/Coq/Init/DataTypes/nat_ind.con"
506 let module Disambiguate' = Disambiguate.Make (Chat) in
507 let (id_to_uris', metasenv', term') =
508 Disambiguate'.disambiguate_input mqi_handle
509 context metasenv dom mk_metasenv_and_expr id_to_uris
511 (match metasenv' with
514 ((must_obj, must_rel, must_sort) as must'),
515 ((only_obj, only_rel, only_sort) as only) =
516 get_constraints term' req#path
521 ~constraints:(req#param "constraints")
523 with Http_types.Param_not_found _ ->
525 "var aliases = '" ^ id_to_uris_raw ^ "';\n" ^
526 "var constr_obj_len = " ^
527 string_of_int (List.length must_obj) ^ ";\n" ^
528 "var constr_rel_len = " ^
529 string_of_int (List.length must_rel) ^ ";\n" ^
530 "var constr_sort_len = " ^
531 string_of_int (List.length must_sort) ^ ";\n" in
533 (if must_obj = [] then "" else
534 "<h4>Obj constraints</h4>" ^
536 (String.concat "\n" (List.map html_of_r_obj must_obj)) ^
538 (* The following three lines to make Javascript create *)
539 (* the constr_obj[] and obj_depth[] arrays even if we *)
540 (* have only one real entry. *)
541 "<input type=\"hidden\" name=\"constr_obj\" />" ^
542 "<input type=\"hidden\" name=\"obj_depth\" />") ^
543 (if must_rel = [] then "" else
544 "<h4>Rel constraints</h4>" ^
546 (String.concat "\n" (List.map html_of_r_rel must_rel)) ^
548 (* The following two lines to make Javascript create *)
549 (* the constr_rel[] and rel_depth[] arrays even if *)
550 (* we have only one real entry. *)
551 "<input type=\"hidden\" name=\"constr_rel\" />" ^
552 "<input type=\"hidden\" name=\"rel_depth\" />") ^
553 (if must_sort = [] then "" else
554 "<h4>Sort constraints</h4>" ^
556 (String.concat "\n" (List.map html_of_r_sort must_sort)) ^
558 (* The following two lines to make Javascript create *)
559 (* the constr_sort[] and sort_depth[] arrays even if *)
560 (* we have only one real entry. *)
561 "<input type=\"hidden\" name=\"constr_sort\" />" ^
562 "<input type=\"hidden\" name=\"sort_depth\" />") ^
563 "<h4>Only constraints</h4>" ^
564 "Enforce Only constraints for objects: " ^
565 "<input type='checkbox' name='only_obj'" ^
566 (if only_obj = None then "" else " checked='yes'") ^ " /><br />" ^
567 "Enforce Rel constraints for objects: " ^
568 "<input type='checkbox' name='only_rel'" ^
569 (if only_rel = None then "" else " checked='yes'") ^ " /><br />" ^
570 "Enforce Sort constraints for objects: " ^
571 "<input type='checkbox' name='only_sort'" ^
572 (if only_sort = None then "" else " checked='yes'") ^ " /><br />"
574 Http_daemon.send_basic_headers ~code:200 outchan ;
575 Http_daemon.send_CRLF outchan ;
581 variables_initialization_RE, variables] line
583 output_string outchan (processed_line ^ "\n"))
584 constraints_choice_TPL;
585 raise Chat_unfinished)
588 G.query_of_constraints (Some universe) must'' only'
590 let results = MQueryInterpreter.execute mqi_handle query in
591 Http_daemon.send_basic_headers ~code:200 outchan ;
592 Http_daemon.send_CRLF outchan ;
596 match id_to_uris' with
601 sprintf "\'alias %s cic:%s\'"
603 CicTextualParser0.Id name -> name
604 | _ -> assert false (*CSC: completare *))
606 | None -> assert false
607 | Some (CicTextualParser0.Uri t) ->
608 MQueryMisc.string_of_cic_textual_parser_uri
610 | _ -> assert false (*CSC: completare *)))
615 [results_RE, theory_of_result results ;
616 new_aliases_RE, new_aliases]
619 output_string outchan (processed_line ^ "\n"))
621 | _ -> (* unable to instantiate some implicit variable *)
624 ~body:"some implicit variables are still unistantiated :-("
628 Http_daemon.respond_error ~status:(`Client_error `Bad_request) outchan);
629 debug_print (sprintf "%s done!" req#path)
631 | Chat_unfinished -> prerr_endline "Chat unfinished, Try again!"
632 | Http_types.Param_not_found attr_name ->
633 bad_request (sprintf "Parameter '%s' is missing" attr_name) outchan
636 ~body:(pp_error ("Uncaught exception: " ^ (Printexc.to_string exc)))
639 printf "%s started and listening on port %d\n" daemon_name port;
640 printf "Current directory is %s\n" (Sys.getcwd ());
641 printf "HTML directory is %s\n" pages_dir;
643 Unix.putenv "http_proxy" "";
644 Http_daemon.start' ~port callback;
645 printf "%s is terminating, bye!\n" daemon_name