helm/software/components/registry/helm_registry.ml

   1 (* Copyright (C) 2004-2005, 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://helm.cs.unibo.it/
  24  *)
  25
  26 (* $Id$ *)
  27
  28 open Printf
  29
  30 let debug = false
  31 let debug_print s =
  32   if debug then prerr_endline ("Helm_registry debugging: " ^ (Lazy.force s))
  33
  34   (** <helpers> *)
  35
  36 let list_uniq l =
  37   let rec aux last_element = function
  38     | [] -> []
  39     | hd :: tl ->
  40         (match last_element with
  41         | Some elt when elt = hd -> aux last_element tl
  42         | _ -> hd :: aux (Some hd) tl)
  43   in
  44   aux None l
  45
  46 let starts_with prefix =
  47 (*
  48   let rex = Str.regexp (Str.quote prefix) in
  49   fun s -> Str.string_match rex s 0
  50 *)
  51   let prefix_len = String.length prefix in
  52   fun s ->
  53     try
  54       String.sub s 0 prefix_len = prefix
  55     with Invalid_argument _ -> false
  56
  57 let hashtbl_keys tbl = Hashtbl.fold (fun k _ acc -> k :: acc) tbl []
  58 let hashtbl_pairs tbl = Hashtbl.fold (fun k v acc -> (k,v) :: acc) tbl []
  59
  60   (** </helpers> *)
  61
  62 exception Malformed_key of string
  63 exception Key_not_found of string
  64 exception Cyclic_definition of string
  65 exception Type_error of string (* expected type, value, msg *)
  66 exception Parse_error of string * int * int * string  (* file, line, col, msg *)
  67
  68   (* root XML tag: used by save_to, ignored by load_from *)
  69 let root_tag = "helm_registry"
  70
  71 let magic_size = 127
  72
  73 let backup_registry registry = Hashtbl.copy registry
  74 let restore_registry backup registry =
  75   Hashtbl.clear registry;
  76   Hashtbl.iter (fun key value -> Hashtbl.add registry key value) backup
  77
  78   (* as \\w but:
  79    * - no sequences of '_' longer than 1 are permitted
  80    *)
  81 let valid_step_rex_raw = "[a-zA-Z0-9]+\\(_[a-z0A-Z-9]+\\)*"
  82 let valid_key_rex_raw =
  83   sprintf "%s\\(\\.%s\\)*" valid_step_rex_raw valid_step_rex_raw
  84 let valid_key_rex = Str.regexp ("^" ^ valid_key_rex_raw ^ "$")
  85 let interpolated_key_rex = Str.regexp ("\\$(" ^ valid_key_rex_raw ^ ")")
  86 let dot_rex = Str.regexp "\\."
  87 let spaces_rex = Str.regexp "[ \t\n\r]+"
  88 let heading_spaces_rex = Str.regexp "^[ \t\n\r]+"
  89 let margin_blanks_rex =
  90   Str.regexp "^\\([ \t\n\r]*\\)\\([^ \t\n\r]*\\)\\([ \t\n\r]*\\)$"
  91
  92 let strip_blanks s = Str.global_replace margin_blanks_rex "\\2" s
  93
  94 let split s =
  95   (* trailing blanks are removed per default by split *)
  96   Str.split spaces_rex (Str.global_replace heading_spaces_rex "" s)
  97 let merge l = String.concat " " l
  98
  99 let handle_type_error f x =
 100   try f x with exn -> raise (Type_error (Printexc.to_string exn))
 101
 102   (** marshallers/unmarshallers *)
 103 let string x = x
 104 let int = handle_type_error int_of_string
 105 let float = handle_type_error float_of_string
 106 let bool = handle_type_error bool_of_string
 107 let of_string x = x
 108 let of_int = handle_type_error string_of_int
 109 let of_float = handle_type_error string_of_float
 110 let of_bool = handle_type_error string_of_bool
 111
 112 (* FG *)
 113 let pair fst_unmarshaller snd_unmarshaller v =
 114   match Str.split spaces_rex v with
 115   | [fst; snd] -> fst_unmarshaller fst, snd_unmarshaller snd
 116   | _ -> raise (Type_error "not a pair")
 117
 118   (* escapes for xml configuration file *)
 119 let (escape, unescape) =
 120   let (in_enc, out_enc) = (`Enc_utf8, `Enc_utf8) in
 121   (Netencoding.Html.encode ~in_enc ~out_enc (),
 122    Netencoding.Html.decode ~in_enc ~out_enc ~entity_base:`Xml ())
 123
 124 let key_is_valid key =
 125   if not (Str.string_match valid_key_rex key 0) then
 126     raise (Malformed_key key)
 127
 128 let set' ?(replace=false) registry ~key ~value =
 129   debug_print (lazy(sprintf "Setting (replace: %b) %s = %s" replace key value));
 130   key_is_valid key;
 131   let add_fun = if replace then Hashtbl.replace else Hashtbl.add in
 132   add_fun registry key value
 133
 134 let unset registry = Hashtbl.remove registry
 135
 136 let env_var_of_key s = String.uppercase (Str.global_replace dot_rex "_" s)
 137
 138 let singleton = function
 139   | [] ->
 140       raise (Type_error ("empty list value found where singleton was expected"))
 141   | hd :: _ -> hd
 142
 143 let get registry key =
 144   let rec aux stack key =
 145     key_is_valid key;
 146     if List.mem key stack then begin
 147       let msg = (String.concat " -> " (List.rev stack)) ^ " -> " ^ key in
 148       raise (Cyclic_definition msg)
 149     end;
 150       (* internal value *)
 151     let registry_values = List.rev (Hashtbl.find_all registry key) in
 152     let env_value = (* environment value *)
 153       try
 154         Some (Sys.getenv (env_var_of_key key))
 155       with Not_found -> None
 156     in
 157     let values = (* resulting value *)
 158       match registry_values, env_value with
 159       | _, Some env -> [env]
 160       | [], None ->
 161           (try
 162             [ Sys.getenv key ]
 163           with Not_found -> raise (Key_not_found key))
 164       | values, None -> values
 165     in
 166     List.map (interpolate (key :: stack)) values
 167   and interpolate stack value =
 168     Str.global_substitute interpolated_key_rex
 169       (fun s ->
 170         let matched = Str.matched_string s in
 171           (* "$(var)" -> "var" *)
 172         let key = String.sub matched 2 (String.length matched - 3) in
 173         singleton (aux stack key))
 174       value
 175   in
 176   List.map strip_blanks (aux [] key)
 177
 178 let has registry key = Hashtbl.mem registry key
 179
 180 let get_typed registry unmarshaller key =
 181   let value = singleton (get registry key) in
 182   unmarshaller value
 183
 184 let set_typed registry marshaller ~key ~value =
 185   set' ~replace:true registry ~key ~value:(marshaller value)
 186
 187 let get_opt registry unmarshaller key =
 188   try
 189     Some (unmarshaller (singleton (get registry key)))
 190   with Key_not_found _ -> None
 191
 192 let get_opt_default registry unmarshaller ~default key =
 193   match get_opt registry unmarshaller key with
 194   | None -> default
 195   | Some v -> v
 196
 197 let set_opt registry marshaller ~key ~value =
 198   match value with
 199   | None -> unset registry key
 200   | Some value -> set' ~replace:true registry ~key ~value:(marshaller value)
 201
 202 let get_list registry unmarshaller key =
 203   try
 204     List.map unmarshaller (get registry key)
 205   with Key_not_found _ -> []
 206
 207 (* FG *)
 208 let get_pair registry fst_unmarshaller snd_unmarshaller =
 209   get_typed registry (pair fst_unmarshaller snd_unmarshaller)
 210
 211 let set_list registry marshaller ~key ~value =
 212   Hashtbl.remove registry key;
 213   List.iter
 214     (fun v -> set' ~replace:false registry ~key ~value:(marshaller v))
 215     value
 216
 217 type xml_tree =
 218   | Cdata of string
 219   | Element of string * (string * string) list * xml_tree list
 220
 221 let dot_RE = Str.regexp "\\."
 222
 223 let xml_tree_of_registry registry =
 224   let has_child name elements =
 225     List.exists
 226       (function
 227         | Element (_, ["name", name'], _) when name = name' -> true
 228         | _ -> false)
 229       elements
 230   in
 231   let rec get_child name = function
 232     | [] -> assert false
 233     | (Element (_, ["name", name'], _) as child) :: tl when name = name' ->
 234         child, tl
 235     | hd :: tl ->
 236         let child, rest = get_child name tl in
 237         child, hd :: rest
 238   in
 239   let rec add_key path value tree =
 240     match path, tree with
 241     | [key], Element (name, attrs, children) ->
 242         Element (name, attrs,
 243           Element ("key", ["name", key],
 244             [Cdata (strip_blanks value)]) :: children)
 245     | dir :: path, Element (name, attrs, children) ->
 246         if has_child dir children then
 247           let child, rest = get_child dir children in
 248           Element (name, attrs, add_key path value child :: rest)
 249         else
 250           Element (name, attrs,
 251             ((add_key path value (Element ("section", ["name", dir], [])))
 252               :: children))
 253     | _ -> assert false
 254   in
 255   Hashtbl.fold
 256     (fun k v tree -> add_key ((Str.split dot_RE k)) v tree)
 257     registry
 258     (Element (root_tag, [], []))
 259
 260 let rec stream_of_xml_tree = function
 261   | Cdata s -> Xml.xml_cdata s
 262   | Element (name, attrs, children) ->
 263       Xml.xml_nempty name
 264         (List.map (fun (n, v) -> (None, n, v)) attrs)
 265         (stream_of_xml_trees children)
 266 and stream_of_xml_trees = function
 267   | [] -> [< >]
 268   | hd :: tl -> [< stream_of_xml_tree hd; stream_of_xml_trees tl >]
 269
 270 let save_to registry fname =
 271   let token_stream = stream_of_xml_tree (xml_tree_of_registry registry) in
 272   let oc = open_out fname in
 273   Xml.pp_to_outchan token_stream oc;
 274   close_out oc
 275
 276 let rec load_from_absolute ?path registry fname =
 277   let _path = ref (match path with None -> [] | Some p -> p)in
 278     (* <section> elements entered so far *)
 279   let in_key = ref false in (* have we entered a <key> element? *)
 280   let cdata = ref "" in     (* collected cdata (inside <key> *)
 281   let push_path name = _path := name :: !_path in
 282   let pop_path () = _path := List.tl !_path in
 283   let start_element tag attrs =
 284     match tag, attrs with
 285     | "section", ["name", name] -> push_path name
 286     | "key", ["name", name] -> in_key := true; push_path name
 287     | "helm_registry", _ -> ()
 288     | "include", ["href", fname] ->
 289         debug_print (lazy ("including file " ^ fname));
 290         load_from_absolute ~path:!_path registry fname
 291     | tag, _ ->
 292         raise (Parse_error (fname, ~-1, ~-1,
 293           (sprintf "unexpected element <%s> or wrong attribute set" tag)))
 294   in
 295   let end_element tag =
 296     match tag with
 297     | "section" -> pop_path ()
 298     | "key" ->
 299         let key = String.concat "." (List.rev !_path) in
 300         set' registry ~key ~value:!cdata;
 301         cdata := "";
 302         in_key := false;
 303         pop_path ()
 304     | "include" | "helm_registry" -> ()
 305     | _ -> assert false
 306   in
 307   let character_data text =
 308     if !in_key then cdata := !cdata ^ text
 309   in
 310   let callbacks = {
 311     XmlPushParser.default_callbacks with
 312       XmlPushParser.start_element = Some start_element;
 313       XmlPushParser.end_element = Some end_element;
 314       XmlPushParser.character_data = Some character_data;
 315   } in
 316   let xml_parser = XmlPushParser.create_parser callbacks in
 317   let backup = backup_registry registry in
 318 (*   if path = None then Hashtbl.clear registry; *)
 319   try
 320     XmlPushParser.parse xml_parser (`File fname)
 321   with exn ->
 322     restore_registry backup registry;
 323     raise exn
 324
 325 let load_from registry ?path fname =
 326   if Filename.is_relative fname then begin
 327     let no_file_found = ref true in
 328     let path =
 329       match path with
 330       | Some path -> path (* path given as argument *)
 331       | None -> [ Sys.getcwd () ] (* no path given, try with cwd *)
 332     in
 333     List.iter
 334       (fun dir ->
 335         let conffile = dir ^ "/" ^ fname in
 336         if Sys.file_exists conffile then begin
 337           no_file_found := false;
 338           load_from_absolute registry conffile
 339         end)
 340        path;
 341     if !no_file_found then
 342       failwith (sprintf
 343         "Helm_registry.init: no configuration file named %s in [ %s ]"
 344         fname (String.concat "; " path))
 345   end else
 346     load_from_absolute registry fname
 347
 348 let fold registry ?prefix ?(interpolate = true) f init =
 349   let value_of k v =
 350     if interpolate then singleton (get registry k) else strip_blanks v
 351   in
 352   match prefix with
 353   | None -> Hashtbl.fold (fun k v acc -> f acc k (value_of k v)) registry init
 354   | Some s ->
 355       let key_matches = starts_with (s ^ ".") in
 356       let rec fold_filter acc = function
 357         | [] -> acc
 358         | (k,v) :: tl when key_matches k ->
 359             fold_filter (f acc k (value_of k v)) tl
 360         | _ :: tl -> fold_filter acc tl
 361       in
 362       fold_filter init (hashtbl_pairs registry)
 363
 364 let iter registry ?prefix ?interpolate f =
 365   fold registry ?prefix ?interpolate (fun _ k v -> f k v) ()
 366 let to_list registry ?prefix ?interpolate () =
 367   fold registry ?prefix ?interpolate (fun acc k v -> (k, v) :: acc) []
 368
 369 let ls registry prefix =
 370   let prefix = prefix ^ "." in
 371   let prefix_len = String.length prefix in
 372   let key_matches = starts_with prefix in
 373   let matching_keys = (* collect matching keys' _postfixes_ *)
 374     fold registry
 375       (fun acc key _ ->
 376         if key_matches key then
 377           String.sub key prefix_len (String.length key - prefix_len) :: acc
 378         else
 379           acc)
 380       []
 381   in
 382   let (sections, keys) =
 383     List.fold_left
 384       (fun (sections, keys) postfix ->
 385         match Str.split dot_rex postfix with
 386         | [key] -> (sections, key :: keys)
 387         | hd_key :: _ ->  (* length > 1 => nested section found *)
 388             (hd_key :: sections, keys)
 389         | _ -> assert false)
 390       ([], []) matching_keys
 391   in
 392   (list_uniq (List.sort Pervasives.compare sections), keys)
 393
 394 (** {2 API implementation}
 395  * functional methods above are wrapped so that they work on a default
 396  * (imperative) registry*)
 397
 398 let default_registry = Hashtbl.create magic_size
 399
 400 let get key = singleton (get default_registry key)
 401 let set = set' ~replace:true default_registry
 402 let has = has default_registry
 403 let fold ?prefix ?interpolate f init =
 404   fold default_registry ?prefix ?interpolate f init
 405 let iter = iter default_registry
 406 let to_list = to_list default_registry
 407 let ls = ls default_registry
 408 let get_typed unmarshaller = get_typed default_registry unmarshaller
 409 let get_opt unmarshaller = get_opt default_registry unmarshaller
 410 let get_opt_default unmarshaller = get_opt_default default_registry unmarshaller
 411 let get_list unmarshaller = get_list default_registry unmarshaller
 412 let get_pair unmarshaller = get_pair default_registry unmarshaller
 413 let set_typed marshaller = set_typed default_registry marshaller
 414 let set_opt unmarshaller = set_opt default_registry unmarshaller
 415 let set_list marshaller = set_list default_registry marshaller
 416 let unset = unset default_registry
 417 let save_to = save_to default_registry
 418 let load_from = load_from default_registry
 419 let clear () = Hashtbl.clear default_registry
 420
 421 let get_string = get_typed string
 422 let get_int = get_typed int
 423 let get_float = get_typed float
 424 let get_bool = get_typed bool
 425 let set_string = set_typed of_string
 426 let set_int = set_typed of_int
 427 let set_float = set_typed of_float
 428 let set_bool = set_typed of_bool
 429