helm/ocaml/getter/getter.ml

   1 (* Copyright (C) 2000, 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 (******************************************************************************)
  27 (*                                                                            *)
  28 (*                               PROJECT HELM                                 *)
  29 (*                                                                            *)
  30 (*                Claudio Sacerdoti Coen <sacerdot@cs.unibo.it>               *)
  31 (*                                 24/01/2000                                 *)
  32 (*                                                                            *)
  33 (******************************************************************************)
  34
  35 let getter_url = ref Configuration.getter_url;;
  36
  37 let update () =
  38  (* deliver update request to http_getter *)
  39  ClientHTTP.send (!getter_url ^ "update")
  40 ;;
  41
  42 type format =
  43    Normal
  44  | GZipped
  45 ;;
  46
  47 let getxml ?(format=Normal) ?(patchdtd=true) uri =
  48  (* deliver getxml request to http_getter *)
  49  ClientHTTP.get_and_save_to_tmp
  50   (!getter_url ^ "getxml" ^
  51     "?uri=" ^ UriManager.string_of_uri uri ^
  52     "&format=" ^ (match format with Normal -> "normal" | GZipped -> "gzipped") ^
  53     "&patch_dtd=" ^ (match patchdtd with true -> "yes" | false -> "no")
  54   )
  55 ;;
  56
  57 let register uri url =
  58  (* deliver register request to http_getter *)
  59  ClientHTTP.send
  60   (!getter_url ^ "register" ^
  61     "?uri=" ^ (UriManager.string_of_uri uri) ^
  62     "&url=" ^ url)
  63 ;;
  64
  65 exception Unresolved;;
  66 exception UnexpectedGetterOutput;;
  67
  68 (* resolve_result is needed because it is not possible to raise *)
  69 (* an exception in a pxp even-processing callback. Too bad.     *)
  70 type resolve_result =
  71    Unknown
  72  | Exception of exn
  73  | Resolved of string
  74
  75 let resolve uri =
  76  (* deliver resolve request to http_getter *)
  77  let doc =
  78   ClientHTTP.get
  79    (!getter_url ^ "resolve" ^ "?uri=" ^ (UriManager.string_of_uri uri))
  80  in
  81   let res = ref Unknown in
  82    Pxp_yacc.process_entity Pxp_yacc.default_config (`Entry_content [])
  83     (Pxp_yacc.create_entity_manager ~is_document:true Pxp_yacc.default_config
  84      (Pxp_yacc.from_string doc))
  85     (function
  86         Pxp_yacc.E_start_tag ("url",["value",url],_) -> res := Resolved url
  87       | Pxp_yacc.E_start_tag ("unresolved",[],_) -> res := Exception Unresolved
  88       | Pxp_yacc.E_start_tag _ -> res := Exception UnexpectedGetterOutput
  89       | _ -> ()
  90     ) ;
  91    match !res with
  92       Unknown -> raise UnexpectedGetterOutput
  93     | Exception e -> raise e
  94     | Resolved url -> url
  95 ;;