helm/http_getter/http_getter.ml

   1 (*
   2  *  Copyright (C) 2000, HELM Team.
   3  *
   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.
   7  *
   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.
  12  *
  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.
  17  *
  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,
  21  *  MA  02111-1307, USA.
  22  *
  23  *  For details, see the HELM World-Wide-Web page,
  24  *  http://cs.unibo.it/helm/.
  25  *)
  26
  27 (* TODO optimization: precompile almost all regexp *)
  28
  29 open Http_getter_common;;
  30 open Http_getter_types;;
  31 open Printf;;
  32
  33  (* debugging settings *)
  34 let debug = true;;
  35 let debug_print s = if debug then prerr_endline ("[HTTP-Getter] " ^ s);;
  36 let http_debug = false;;
  37 Http_common.debug := http_debug;;
  38
  39 let http_get url =
  40 (*   debug_print ("Downloading URL: " ^ url); *)
  41   try
  42     Some (Http_client.Convenience.http_get url)
  43   with Http_client.Http_error (code, _) -> None
  44 (*
  45     (debug_print
  46       (sprintf "Failed to download %s, HTTP response was %d" url code);
  47     None)
  48 *)
  49 ;;
  50
  51 let parse_enc (req: Http_types.request) =
  52   try
  53     (match req#param "format" with
  54     | "normal" -> Enc_normal
  55     | "gz" -> Enc_gzipped
  56     | s -> raise (Http_getter_bad_request ("Invalid format: " ^ s)))
  57   with Http_types.Param_not_found _ -> Enc_normal
  58 ;;
  59 let parse_patch_dtd (req: Http_types.request) =
  60   match req#param "patch_dtd" with
  61   | s when String.lowercase s = "yes" -> true
  62   | s when String.lowercase s = "no" -> false
  63   | s -> raise (Http_getter_bad_request ("Invalid patch_dtd value: " ^ s))
  64 ;;
  65 let parse_output_format (req: Http_types.request) =
  66   match req#param "format" with
  67   | s when String.lowercase s = "txt" -> Fmt_text
  68   | s when String.lowercase s = "xml" -> Fmt_xml
  69   | s -> raise (Http_getter_bad_request ("Invalid /ls format: " ^ s))
  70 ;;
  71 let parse_ls_uri (req: Http_types.request) =
  72   let baseuri = req#param "baseuri" in
  73   let subs =
  74     Pcre.extract ~pat:"^(\\w+):(.*)$" (Pcre.replace ~pat:"/+$"  baseuri)
  75   in
  76   match (subs.(1), subs.(2)) with
  77   | "cic", uri -> Cic uri
  78   | "theory", uri -> Theory uri
  79   | _ -> raise (Http_getter_bad_request ("Invalid /ls baseuri: " ^ baseuri))
  80 ;;
  81
  82 let xml_map = new Http_getter_map.map Http_getter_env.xml_dbm in
  83 let rdf_map = new Http_getter_map.map Http_getter_env.rdf_dbm in
  84 let xsl_map = new Http_getter_map.map Http_getter_env.xsl_dbm in
  85
  86 let map_of_uri = function
  87   | uri when is_xml_uri uri -> xml_map
  88   | uri when is_rdf_uri uri -> rdf_map
  89   | uri when is_xsl_uri uri -> xsl_map
  90   | uri -> raise (Http_getter_unresolvable_URI uri)
  91 in
  92 let resolve uri = (map_of_uri uri)#resolve uri in
  93 let register uri =  (map_of_uri uri )#add uri in
  94 let return_all_foo_uris map doctype filter outchan =
  95   Http_daemon.send_basic_headers ~code:200 outchan;
  96   Http_daemon.send_header "Content-Type" "text/xml" outchan;
  97   Http_daemon.send_CRLF outchan;
  98   output_string
  99     outchan
 100     (sprintf
 101 "<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>
 102 <!DOCTYPE %s SYSTEM \"%s/getdtd?uri=%s.dtd\">
 103
 104 <%s>
 105 "
 106       doctype
 107       Http_getter_env.my_own_url
 108       doctype
 109       doctype);
 110   map#iter
 111     (fun uri _ ->
 112       if filter uri then
 113         output_string outchan (sprintf "\t<uri value=\"%s\" />\n" uri));
 114   output_string outchan (sprintf "</%s>\n" doctype)
 115 in
 116 let return_all_xml_uris = return_all_foo_uris xml_map "alluris" in
 117 let return_all_rdf_uris = return_all_foo_uris rdf_map "allrdfuris" in
 118 let return_ls =
 119   let (++) (oldann, oldtypes, oldbody) (newann, newtypes, newbody) =
 120     ((if newann   > oldann    then newann   else oldann),
 121      (if newtypes > oldtypes  then newtypes else oldtypes),
 122      (if newbody > oldbody    then newbody  else oldbody))
 123    in
 124   let basepart_RE =
 125     Pcre.regexp "^([^.]*\\.[^.]*)((\\.body)|(\\.types))?(\\.ann)?"
 126   in
 127   let (types_RE, types_ann_RE, body_RE, body_ann_RE) =
 128     (Pcre.regexp "\\.types", Pcre.regexp "\\.types.ann",
 129      Pcre.regexp "\\.body", Pcre.regexp "\\.body.ann")
 130   in
 131   let (slash_RE, til_slash_RE, no_slashes_RE) =
 132     (Pcre.regexp "/", Pcre.regexp "^.*/", Pcre.regexp "^[^/]*$")
 133   in
 134   fun lsuri fmt outchan ->
 135     let pat =
 136       "^" ^
 137       (match lsuri with Cic p -> ("cic:" ^ p) | Theory p -> ("theory:" ^ p))
 138     in
 139     let (dir_RE, obj_RE) =
 140       (Pcre.regexp (pat ^ "/"), Pcre.regexp (pat ^ "(\\.|$)"))
 141     in
 142     let dirs = ref StringSet.empty in
 143     let objs = Hashtbl.create 17 in
 144     let store_dir d =
 145       dirs := StringSet.add (List.hd (Pcre.split ~rex:slash_RE d)) !dirs
 146     in
 147     let store_obj o =
 148       let basepart = Pcre.replace ~rex:basepart_RE ~templ:"$1" o in
 149       let oldflags =
 150         try
 151           Hashtbl.find objs basepart
 152         with Not_found -> (false, No, No) (* no ann, no types no body *)
 153       in
 154       let newflags =
 155         match o with
 156         | s when Pcre.pmatch ~rex:types_RE s     -> (false, Yes, No)
 157         | s when Pcre.pmatch ~rex:types_ann_RE s -> (true,  Ann, No)
 158         | s when Pcre.pmatch ~rex:body_RE s      -> (false, No,  Yes)
 159         | s when Pcre.pmatch ~rex:body_ann_RE s  -> (true,  No,  Ann)
 160         | s -> (false, No, No)
 161       in
 162       Hashtbl.replace objs basepart (oldflags ++ newflags)
 163     in
 164     xml_map#iter  (* BLEARGH Dbm module lacks support for fold-like functions *)
 165       (fun key _ ->
 166         match key with
 167         | uri when Pcre.pmatch ~rex:dir_RE uri ->  (* directory hit *)
 168             let localpart = Pcre.replace ~rex:dir_RE uri in
 169             if Pcre.pmatch ~rex:no_slashes_RE localpart then
 170               store_obj localpart
 171             else
 172               store_dir localpart
 173         | uri when Pcre.pmatch ~rex:obj_RE  uri ->  (* file hit *)
 174             store_obj (Pcre.replace ~rex:til_slash_RE uri)
 175         | uri -> () (* miss *));
 176     match fmt with
 177     | Fmt_text ->
 178         let body =
 179           (List.fold_left
 180             (fun s d -> sprintf "%sdir, %s\n" s d) ""
 181             (StringSet.elements !dirs)) ^
 182           (Http_getter_misc.hashtbl_sorted_fold
 183             (fun uri (annflag, typesflag, bodyflag) cont ->
 184               sprintf "%sobject, %s, <%s,%s,%s>\n"
 185                 cont uri (if annflag then "YES" else "NO")
 186                 (string_of_ls_flag typesflag) (string_of_ls_flag bodyflag))
 187             objs "")
 188         in
 189         Http_daemon.respond
 190           ~headers:["Content-Type", "text/plain"] ~body outchan
 191     | Fmt_xml ->
 192         let body =
 193           sprintf
 194 "<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>
 195 <!DOCTYPE ls SYSTEM \"%s/getdtd?uri=ls.dtd\">
 196
 197 <ls>
 198 %s
 199 </ls>
 200 "
 201             Http_getter_env.my_own_url
 202             ("\n" ^
 203             (String.concat
 204               "\n"
 205               (List.map
 206                 (fun d -> "<section>" ^ d ^ "</section>")
 207                 (StringSet.elements !dirs))) ^ "\n" ^
 208             (Http_getter_misc.hashtbl_sorted_fold
 209               (fun uri (annflag, typesflag, bodyflag) cont ->
 210                 sprintf
 211 "%s<object name=\"%s\">
 212 \t<ann value=\"%s\" />
 213 \t<types value=\"%s\" />
 214 \t<body value=\"%s\" />
 215 </object>
 216 "
 217                   cont uri (if annflag then "YES" else "NO")
 218                   (string_of_ls_flag typesflag)
 219                   (string_of_ls_flag bodyflag))
 220               objs ""))
 221         in
 222         Http_daemon.respond
 223           ~headers:["Content-Type", "text/xml"] ~body outchan
 224 in
 225 let update_from_server logmsg server_url = (* use global maps *)
 226   debug_print ("Updating information from " ^ server_url);
 227   let xml_url_of_uri = function
 228       (* TODO missing sanity checks on server_url, e.g. it can contains $1 *)
 229     | uri when (Pcre.pmatch ~pat:"^cic:" uri) ->
 230         Pcre.replace ~pat:"^cic:" ~templ:server_url uri
 231     | uri when (Pcre.pmatch ~pat:"^theory:" uri) ->
 232         Pcre.replace ~pat:"^theory:" ~templ:server_url uri
 233     | uri -> raise (Http_getter_invalid_URI uri)
 234   in
 235   let rdf_url_of_uri = function (* TODO as above *)
 236     | uri when (Pcre.pmatch ~pat:"^helm:rdf.*//cic:" uri) ->
 237         Pcre.replace ~pat:"^helm:rdf.*//cic:" ~templ:server_url uri
 238     | uri when (Pcre.pmatch ~pat:"^helm:rdf.*//theory:" uri) ->
 239         Pcre.replace ~pat:"^helm:rdf.*//theory:" ~templ:server_url uri
 240     | uri -> raise (Http_getter_invalid_URI uri)
 241   in
 242   let log = ref ("Processing server: " ^ server_url ^ "<br />\n") in
 243   let (xml_index, rdf_index, xsl_index) =
 244     (* TODO keeps index in memory, is better to keep them on temp files? *)
 245     (http_get (server_url ^ "/" ^ Http_getter_env.xml_index),
 246      http_get (server_url ^ "/" ^ Http_getter_env.rdf_index),
 247      http_get (server_url ^ "/" ^ Http_getter_env.xsl_index))
 248   in
 249   if (xml_index = None && rdf_index = None && xsl_index = None) then
 250     debug_print (sprintf "Warning: useless server %s" server_url);
 251   (match xml_index with
 252   | Some xml_index ->
 253       (log := !log ^ "Updating XML db ...<br />\n";
 254       List.iter
 255         (fun l ->
 256           try
 257             (match Pcre.split ~pat:"[ \\t]+" l with
 258             | [uri; "gz"] -> xml_map#add uri ((xml_url_of_uri uri) ^ ".xml.gz")
 259             | [uri] -> xml_map#add uri ((xml_url_of_uri uri) ^ ".xml")
 260             | _ -> log := !log ^ "Ignoring invalid line: " ^ l ^ "<br />\n")
 261           with Http_getter_invalid_URI uri ->
 262             log := !log ^ "Ignoring invalid XML URI: " ^ uri ^ "<br />\n")
 263         (Pcre.split ~pat:"\n+" xml_index)) (* xml_index lines *)
 264   | None -> ());
 265   (match rdf_index with
 266   | Some rdf_index ->
 267       (log := !log ^ "Updating RDF db ...<br />\n";
 268       List.iter
 269         (fun l ->
 270           try
 271             (match Pcre.split ~pat:"[ \\t]+" l with
 272             | [uri; "gz"] -> rdf_map#add uri ((rdf_url_of_uri uri) ^ ".xml.gz")
 273             | [uri] -> rdf_map#add uri ((rdf_url_of_uri uri) ^ ".xml")
 274             | _ -> log := !log ^ "Ignoring invalid line: " ^ l ^ "<br />\n")
 275           with Http_getter_invalid_URI uri ->
 276             log := !log ^ "Ignoring invalid RDF URI: " ^ uri ^ "<br />\n")
 277         (Pcre.split ~pat:"\n+" rdf_index)) (* rdf_index lines *)
 278   | None -> ());
 279   (match xsl_index with
 280   | Some xsl_index ->
 281       (log := !log ^ "Updating XSLT db ...<br />\n";
 282       List.iter
 283         (fun l -> xsl_map#add l (server_url ^ "/" ^ l))
 284         (Pcre.split ~pat:"\n+" xsl_index);
 285       log := !log ^ "All done!<br />\n")
 286   | None -> ());
 287   !log
 288 in
 289
 290   (* thread action *)
 291 let callback (req: Http_types.request) outchan =
 292   try
 293     debug_print ("Connection from " ^ req#clientAddr);
 294     debug_print ("Received request: " ^ req#path);
 295     (match req#path with
 296     | "/help" -> return_html_msg Http_getter_const.usage_string outchan
 297     | "/getxml" | "/getxslt" | "/getdtd" | "/resolve" | "/register" ->
 298         (let uri = req#param "uri" in  (* common parameter *)
 299         match req#path with
 300         | "/getxml" ->
 301             let enc = parse_enc req in
 302             let patch_dtd =
 303               try parse_patch_dtd req with Http_types.Param_not_found _ -> true
 304             in
 305             Http_getter_cache.respond_xml
 306               ~url:(resolve uri) ~uri ~enc ~patch_dtd outchan
 307         | "/getxslt" ->
 308             let patch_dtd =
 309               try parse_patch_dtd req with Http_types.Param_not_found _ -> true
 310             in
 311             Http_getter_cache.respond_xsl ~url:(resolve uri) ~patch_dtd outchan
 312         | "/getdtd" ->
 313             let patch_dtd =
 314               try parse_patch_dtd req with Http_types.Param_not_found _ -> true
 315             in
 316             Http_getter_cache.respond_dtd
 317               ~patch_dtd ~url:(Http_getter_env.dtd_dir ^ "/" ^ uri) outchan
 318         | "/resolve" ->
 319             (try
 320               return_xml_msg
 321                 (sprintf "<url value=\"%s\" />\n" (resolve uri))
 322                 outchan
 323             with Http_getter_unresolvable_URI uri ->
 324               return_xml_msg "<unresolved />\n" outchan)
 325         | "/register" ->
 326             let url = req#param "url" in
 327             register uri url;
 328             return_html_msg "Register done" outchan
 329         | _ -> assert false)
 330     | "/update" ->
 331         (xml_map#clear; rdf_map#clear; xsl_map#clear;
 332         let log =
 333           List.fold_left
 334             update_from_server
 335             ""  (* initial logmsg: empty *)
 336               (* reverse order: 1st server is the most important one *)
 337             (List.rev Http_getter_env.servers)
 338         in
 339         xml_map#sync; rdf_map#sync; xsl_map#sync;
 340         return_html_msg log outchan)
 341     | "/getalluris" ->
 342         return_all_xml_uris
 343           (fun uri ->
 344             (Pcre.pmatch ~pat:"^cic:" uri) &&
 345             not (Pcre.pmatch ~pat:"\\.types$" uri))
 346           outchan
 347     | "/getallrdfuris" ->
 348         (let classs = req#param "class" in
 349         try
 350           let filter =
 351             let base = "^helm:rdf:www\\.cs\\.unibo\\.it/helm/rdf/" in
 352             match classs with
 353             | ("forward" as c) | ("backward" as c) ->
 354                 (fun uri -> Pcre.pmatch ~pat:(base ^ c) uri)
 355             | c -> raise (Http_getter_invalid_RDF_class c)
 356           in
 357           return_all_rdf_uris filter outchan
 358         with Http_getter_invalid_RDF_class c ->
 359           raise (Http_getter_bad_request ("Invalid RDF class: " ^ c)))
 360     | "/ls" -> return_ls (parse_ls_uri req) (parse_output_format req) outchan
 361     | "/getempty" ->
 362         Http_daemon.respond ~body:Http_getter_const.empty_xml outchan
 363     | invalid_request ->
 364         Http_daemon.respond_error ~status:(`Client_error `Bad_request) outchan)
 365   with
 366   | Http_types.Param_not_found attr_name ->
 367       return_400 (sprintf "Parameter '%s' is missing" attr_name) outchan
 368   | Http_getter_bad_request msg -> return_html_error msg outchan
 369   | Http_getter_internal_error msg -> return_html_internal_error msg outchan
 370   | exc ->
 371       return_html_error
 372         ("Uncaught exception: " ^ (Printexc.to_string exc))
 373         outchan
 374 in
 375
 376   (* daemon initialization *)
 377 Http_getter_env.dump_env ();
 378 flush stdout;
 379 Unix.putenv "http_proxy" "";
 380 Http_daemon.start'
 381   ~timeout:None ~port:Http_getter_env.port ~mode:`Thread callback
 382