helm/searchEngine/searchEngine.ml

   1 (* Copyright (C) 2002, 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://cs.unibo.it/helm/.
  24  *)
  25
  26 open Http_types ;;
  27
  28 let debug = true;;
  29 let debug_print s = if debug then prerr_endline s;;
  30 Http_common.debug := true;;
  31 (* Http_common.debug := true;; *)
  32
  33   (** accepted HTTP servers for ask_uwobo method forwarding *)
  34 let valid_servers = [ "mowgli.cs.unibo.it:58080" ; "mowgli.cs.unibo.it" ; "localhost:58080" ] ;;
  35
  36 open Printf;;
  37
  38 let postgresConnectionString =
  39  try
  40   Sys.getenv "POSTGRESQL_CONNECTION_STRING"
  41  with
  42   Not_found -> "host=mowgli.cs.unibo.it dbname=helm_mowgli_new_schema user=helm"
  43 ;;
  44
  45 let daemon_name = "Search Engine";;
  46 let default_port = 58085;;
  47 let port_env_var = "SEARCH_ENGINE_PORT";;
  48
  49 let pages_dir =
  50   try
  51     Sys.getenv "SEARCH_ENGINE_HTML_DIR"
  52   with Not_found -> "html"  (* relative to searchEngine's document root *)
  53 ;;
  54 let interactive_user_uri_choice_TPL = pages_dir ^ "/templateambigpdq1.html";;
  55 let interactive_interpretation_choice_TPL = pages_dir ^ "/templateambigpdq2.html";;
  56 let final_results_TPL = pages_dir ^ "/templateambigpdq3.html";;
  57
  58 exception Chat_unfinished
  59
  60   (** pretty print a MathQL query result to an HELM theory file *)
  61 let theory_of_result result =
  62  let results_no = List.length result in
  63   if results_no > 0 then
  64    let mode = if results_no > 10 then "linkonly" else "typeonly" in
  65    let results =
  66     let idx = ref (results_no + 1) in
  67      List.fold_right
  68       (fun (uri,attrs) i ->
  69         decr idx ;
  70         "<tr><td valign=\"top\">" ^ string_of_int !idx ^ ".</td><td><ht:OBJECT uri=\"" ^ uri ^ "\" mode=\"" ^ mode ^ "\"/></td></tr>" ^  i
  71       ) result ""
  72    in
  73     "<h1>Query Results:</h1><table xmlns:ht=\"http://www.cs.unibo.it/helm/namespaces/helm-theory\">" ^ results ^ "</table>"
  74   else
  75     "<h1>Query Results:</h1><p>No results found!</p>"
  76 ;;
  77
  78 let pp_result result =
  79  "<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>"
  80 ;;
  81
  82   (** chain application of Pcre substitutions *)
  83 let rec apply_substs substs line =
  84   match substs with
  85   | [] -> line
  86   | (rex, templ) :: rest -> apply_substs rest (Pcre.replace ~rex ~templ line)
  87   (** fold like function on files *)
  88 let fold_file f init fname =
  89   let inchan = open_in fname in
  90   let rec fold_lines' value =
  91     try
  92       let line = input_line inchan in
  93       fold_lines' (f value line)
  94     with End_of_file -> value
  95   in
  96   let res = (try fold_lines' init with e -> (close_in inchan; raise e)) in
  97   close_in inchan;
  98   res
  99   (** iter like function on files *)
 100 let iter_file f = fold_file (fun _ line -> f line) ()
 101
 102 let (title_tag_RE, choices_tag_RE, msg_tag_RE, id_to_uris_RE, id_RE,
 103     interpretations_RE, interpretations_labels_RE, results_RE, new_aliases_RE)
 104   =
 105   (Pcre.regexp "@TITLE@", Pcre.regexp "@CHOICES@", Pcre.regexp "@MSG@",
 106   Pcre.regexp "@ID_TO_URIS@", Pcre.regexp "@ID@",
 107   Pcre.regexp "@INTERPRETATIONS@", Pcre.regexp "@INTERPRETATIONS_LABELS@",
 108   Pcre.regexp "@RESULTS@", Pcre.regexp "@NEW_ALIASES@")
 109 let server_and_port_url_RE = Pcre.regexp "^http://([^/]+)/.*$"
 110
 111 let port =
 112   try
 113     int_of_string (Sys.getenv port_env_var)
 114   with
 115   | Not_found -> default_port
 116   | Failure "int_of_string" ->
 117       prerr_endline "Warning: invalid port, reverting to default";
 118       default_port
 119 in
 120 let pp_error = sprintf "<html><body><h1>Error: %s</h1></body></html>" in
 121 let bad_request body outchan =
 122   Http_daemon.respond_error ~status:(`Client_error `Bad_request) ~body outchan
 123 in
 124 let contype = "Content-Type", "text/html" in
 125
 126 (* SEARCH ENGINE functions *)
 127
 128 let refine_constraints (x, y, z) = (x, y, z), (Some x, Some y, Some z) in
 129
 130 (* HTTP DAEMON CALLBACK *)
 131
 132 let callback (req: Http_types.request) outchan =
 133   try
 134     debug_print (sprintf "Received request: %s" req#path);
 135     if req#path <> "/getpage" then
 136       Mqint.init postgresConnectionString;
 137     (match req#path with
 138     | "/execute" ->
 139         let query_string = req#param "query" in
 140         let lexbuf = Lexing.from_string query_string in
 141         let query = MQueryUtil.query_of_text lexbuf in
 142         let result = MQueryGenerator.execute_query query in
 143         let result_string = pp_result result in
 144         Http_daemon.respond ~body:result_string ~headers:[contype] outchan
 145     | "/locate" ->
 146         let id = req#param "id" in
 147         let result = MQueryGenerator.locate id in
 148         Http_daemon.respond ~headers:[contype] ~body:(pp_result result) outchan
 149     | "/getpage" ->
 150         (* TODO implement "is_permitted" *)
 151         (let is_permitted _ = true in
 152         let remove_fragment uri = Pcre.replace ~pat:"#.*" uri in
 153         let page = remove_fragment (req#param "url") in
 154         let preprocess =
 155           (try
 156             bool_of_string (req#param "preprocess")
 157           with Invalid_argument _ | Http_types.Param_not_found _ -> false)
 158         in
 159         (match page with
 160         | page when is_permitted page ->
 161             (let fname = sprintf "%s/%s" pages_dir (remove_fragment page) in
 162             Http_daemon.send_basic_headers ~code:200 outchan;
 163             Http_daemon.send_header "Content-Type" "text/html" outchan;
 164             Http_daemon.send_CRLF outchan;
 165             if preprocess then begin
 166               iter_file
 167                 (fun line ->
 168                   output_string outchan
 169                     ((apply_substs
 170                        (List.map
 171                          (function (key,value) ->
 172                            let key' =
 173                             (Pcre.extract ~pat:"param\\.(.*)" key).(1)
 174                            in
 175                             Pcre.regexp ("@" ^ key' ^ "@"), value
 176                          )
 177                          (List.filter
 178                            (fun (key,_) as p-> Pcre.pmatch ~pat:"^param\\." key)
 179                            req#params)
 180                        )
 181                        line) ^
 182                     "\n"))
 183                 fname
 184             end else
 185               Http_daemon.send_file ~src:(FileSrc fname) outchan)
 186         | page -> Http_daemon.respond_forbidden ~url:page outchan))
 187     | "/ask_uwobo" ->
 188       let url = req#param "url" in
 189       let server_and_port =
 190         (Pcre.extract ~rex:server_and_port_url_RE url).(1)
 191       in
 192       if List.mem server_and_port valid_servers then
 193         Http_daemon.respond
 194           ~headers:["Content-Type", "text/html"]
 195           ~body:(Http_client.Convenience.http_get url)
 196           outchan
 197       else
 198         Http_daemon.respond
 199           ~body:(pp_error ("Untrusted UWOBO server: " ^ server_and_port))
 200           outchan
 201     | "/searchPattern" ->
 202         let term_string = req#param "term" in
 203         let lexbuf = Lexing.from_string term_string in
 204         let (context, metasenv) = ([], []) in
 205         let (dom, mk_metasenv_and_expr) =
 206           CicTextualParserContext.main
 207             ~context ~metasenv CicTextualLexer.token lexbuf
 208         in
 209         let id_to_uris_raw = req#param "aliases" in
 210         let tokens = Pcre.split ~pat:"\\s" id_to_uris_raw in
 211         let rec parse_tokens keys lookup = function (* TODO spostarla fuori *)
 212           | [] -> keys, lookup
 213           | "alias" :: key :: value :: rest ->
 214               let key' = CicTextualParser0.Id key in
 215                parse_tokens
 216                  (key'::keys)
 217                  (fun id ->
 218                    if id = key' then
 219                      Some
 220                       (CicTextualParser0.Uri (MQueryMisc.cic_textual_parser_uri_of_string value))
 221                    else lookup id)
 222                  rest
 223           | _ -> failwith "Can't parse aliases"
 224         in
 225         let parse_choices choices_raw =
 226           let choices = Pcre.split ~pat:";" choices_raw in
 227           List.fold_left
 228             (fun f x ->
 229               match Pcre.split ~pat:"\\s" x with
 230               | ""::id::tail
 231               | id::tail when id<>"" ->
 232                   (fun id' ->
 233 prerr_endline ("#### " ^ id ^ " :=");
 234 List.iter (fun u -> prerr_endline ("<" ^ Netencoding.Url.decode u ^ ">")) tail;
 235                     if id = id' then
 236                       Some (List.map (fun u -> Netencoding.Url.decode u) tail)
 237                     else
 238                       f id')
 239               | _ -> failwith "Can't parse choices")
 240             (fun _ -> None)
 241             choices
 242         in
 243         let (id_to_uris : Disambiguate.domain_and_interpretation) =
 244          parse_tokens [] (fun _ -> None) tokens in
 245         let id_to_choices =
 246           try
 247             let choices_raw = req#param "choices" in
 248             parse_choices choices_raw
 249           with Http_types.Param_not_found _ -> (fun _ -> None)
 250         in
 251         let module Chat: Disambiguate.Callbacks =
 252           struct
 253
 254             let get_metasenv () =
 255              !CicTextualParser0.metasenv
 256
 257             let set_metasenv metasenv =
 258               CicTextualParser0.metasenv := metasenv
 259
 260             let output_html = prerr_endline
 261
 262             let interactive_user_uri_choice
 263               ~selection_mode ?ok
 264               ?enable_button_for_non_vars ~(title: string) ~(msg: string)
 265               ~(id: string) (choices: string list)
 266               =
 267                 (match id_to_choices id with
 268                 | Some choices -> choices
 269                 | None ->
 270                   let msg = Pcre.replace ~pat:"\"" ~templ:"\\\"" msg in
 271                   (match selection_mode with
 272                   | `SINGLE -> assert false
 273                   | `EXTENDED ->
 274                       Http_daemon.send_basic_headers ~code:200 outchan ;
 275                       Http_daemon.send_CRLF outchan ;
 276                       iter_file
 277                         (fun line ->
 278                           let formatted_choices =
 279                             String.concat ","
 280                               (List.map (fun uri -> sprintf "\"%s\"" uri) choices)
 281                           in
 282                           let processed_line =
 283                             apply_substs
 284                               [title_tag_RE, title;
 285                                choices_tag_RE, formatted_choices;
 286                                msg_tag_RE, msg;
 287                                id_to_uris_RE, id_to_uris_raw;
 288                                id_RE, id]
 289                               line
 290                           in
 291                           output_string outchan (processed_line ^ "\n"))
 292                         interactive_user_uri_choice_TPL;
 293                       raise Chat_unfinished))
 294
 295             let interactive_interpretation_choice interpretations =
 296               let html_interpretations_labels =
 297                 String.concat ", "
 298                   (List.map
 299                     (fun l ->
 300                       "\"" ^
 301                       (String.concat "<br />"
 302                         (List.map
 303                           (fun (id, value) ->
 304                             (sprintf "alias %s %s" id value))
 305                           l)) ^
 306                       "\"")
 307                   interpretations)
 308               in
 309               let html_interpretations =
 310                 String.concat ", "
 311                   (List.map
 312                     (fun l ->
 313                       "\"" ^
 314                       (String.concat " "
 315                         (List.map
 316                           (fun (id, value) ->
 317                             (sprintf "alias %s %s"
 318                               id
 319                               (MQueryMisc.wrong_xpointer_format_from_wrong_xpointer_format'
 320                                 value)))
 321                           l)) ^
 322                       "\"")
 323                     interpretations)
 324               in
 325               Http_daemon.send_basic_headers ~code:200 outchan ;
 326               Http_daemon.send_CRLF outchan ;
 327               iter_file
 328                 (fun line ->
 329                   let processed_line =
 330                     apply_substs
 331                       [interpretations_RE, html_interpretations;
 332                        interpretations_labels_RE, html_interpretations_labels]
 333                       line
 334                   in
 335                   output_string outchan (processed_line ^ "\n"))
 336                 interactive_interpretation_choice_TPL;
 337               raise Chat_unfinished
 338
 339             let input_or_locate_uri ~title =
 340               UriManager.uri_of_string "cic:/Coq/Init/DataTypes/nat_ind.con"
 341
 342           end
 343         in
 344         let module Disambiguate' = Disambiguate.Make (Chat) in
 345         let (id_to_uris', metasenv', term') =
 346           Disambiguate'.disambiguate_input
 347             context metasenv dom mk_metasenv_and_expr id_to_uris
 348         in
 349         (match metasenv' with
 350         | [] ->
 351             let must = MQueryLevels2.get_constraints term' in
 352             let must',only = refine_constraints must in
 353             let results = MQueryGenerator.searchPattern must' only in
 354             Http_daemon.send_basic_headers ~code:200 outchan ;
 355             Http_daemon.send_CRLF outchan ;
 356             iter_file
 357               (fun line ->
 358                 let new_aliases =
 359                   match id_to_uris' with
 360                   | (domain, f) ->
 361                       String.concat ", "
 362                         (List.map
 363                           (fun name ->
 364                             sprintf "\"alias %s cic:%s\""
 365                               (match name with
 366                                   CicTextualParser0.Id name -> name
 367                                 | _ -> assert false (*CSC: completare *))
 368                               (match f name with
 369                               | None -> assert false
 370                               | Some (CicTextualParser0.Uri t) ->
 371                                   MQueryMisc.string_of_cic_textual_parser_uri
 372                                     t
 373                               | _ -> assert false (*CSC: completare *)))
 374                           domain)
 375                 in
 376                 let processed_line =
 377                   apply_substs
 378                     [results_RE, theory_of_result results ;
 379                      new_aliases_RE, new_aliases]
 380                     line
 381                 in
 382                 output_string outchan (processed_line ^ "\n"))
 383               final_results_TPL
 384         | _ -> (* unable to instantiate some implicit variable *)
 385             Http_daemon.respond
 386               ~headers:[contype]
 387               ~body:"some implicit variables are still unistantiated :-("
 388               outchan)
 389
 390     | invalid_request ->
 391         Http_daemon.respond_error ~status:(`Client_error `Bad_request) outchan);
 392     if req#path <> "/getpage" then
 393       Mqint.close ();
 394     debug_print (sprintf "%s done!" req#path)
 395   with
 396   | Chat_unfinished -> prerr_endline "Chat unfinished, Try again!"
 397   | Http_types.Param_not_found attr_name ->
 398       bad_request (sprintf "Parameter '%s' is missing" attr_name) outchan
 399   | exc ->
 400       Http_daemon.respond
 401         ~body:(pp_error ("Uncaught exception: " ^ (Printexc.to_string exc)))
 402         outchan
 403 in
 404 printf "%s started and listening on port %d\n" daemon_name port;
 405 printf "Current directory is %s\n" (Sys.getcwd ());
 406 printf "HTML directory is %s\n" pages_dir;
 407 flush stdout;
 408 Unix.putenv "http_proxy" "";
 409 Mqint.set_database Mqint.postgres_db;
 410 Http_daemon.start' ~port callback;
 411 printf "%s is terminating, bye!\n" daemon_name
 412