helm/matita/matitaSync.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 open Printf
  27
  28 open MatitaTypes
  29
  30 let alias_diff ~from status =
  31   let module Map = DisambiguateTypes.Environment in
  32   Map.fold
  33     (fun domain_item (description1,_ as codomain_item) acc ->
  34       try
  35        let description2,_ = Map.find domain_item from.aliases in
  36         if description1 <> description2 then
  37          (domain_item,codomain_item)::acc
  38         else
  39           acc
  40       with
  41        Not_found ->
  42          (domain_item,codomain_item)::acc)
  43     status.aliases []
  44
  45 let alias_diff =
  46  let profiler = CicUtil.profile "alias_diff (conteggiato anche in include)" in
  47  fun ~from status -> profiler.CicUtil.profile (alias_diff ~from) status
  48
  49 let set_proof_aliases status new_aliases =
  50  let aliases =
  51   List.fold_left (fun acc (d,c) -> DisambiguateTypes.Environment.add d c acc)
  52    status.aliases new_aliases in
  53  let multi_aliases =
  54   List.fold_left (fun acc (d,c) -> DisambiguateTypes.Environment.cons d c acc)
  55    status.multi_aliases new_aliases in
  56  let new_status =
  57    { status with multi_aliases = multi_aliases ; aliases = aliases}
  58  in
  59  if new_aliases = [] then
  60    new_status
  61  else
  62    add_moo_content
  63     (DisambiguatePp.commands_of_domain_and_codomain_items_list new_aliases)
  64     new_status
  65
  66 (** given a uri and a type list (the contructors types) builds a list of pairs
  67  *  (name,uri) that is used to generate authomatic aliases **)
  68 let extract_alias types uri =
  69   fst(List.fold_left (
  70     fun (acc,i) (name, _, _, cl) ->
  71       (name, UriManager.string_of_uri (UriManager.uri_of_uriref uri i None))
  72       ::
  73       (fst(List.fold_left (
  74         fun (acc,j) (name,_) ->
  75           (((name,UriManager.string_of_uri (UriManager.uri_of_uriref uri i
  76           (Some j))) :: acc) , j+1)
  77         ) (acc,1) cl)),i+1
  78   ) ([],0) types)
  79
  80 let build_aliases =
  81  List.map
  82   (fun (name,suri) ->
  83     DisambiguateTypes.Id name,
  84      (suri, fun _ _ _ -> CicUtil.term_of_uri (UriManager.uri_of_string suri)))
  85
  86 let add_aliases_for_inductive_def status types suri =
  87   let uri = UriManager.uri_of_string suri in
  88   let aliases = build_aliases (extract_alias types uri) in
  89    set_proof_aliases status aliases
  90
  91 let add_alias_for_constant status suri =
  92  let uri = UriManager.uri_of_string suri in
  93  let name = UriManager.name_of_uri uri in
  94  let new_env = build_aliases [(name,suri)] in
  95  set_proof_aliases status new_env
  96
  97 let add_aliases_for_object status suri =
  98  function
  99     Cic.InductiveDefinition (types,_,_,_) ->
 100      add_aliases_for_inductive_def status types suri
 101   | Cic.Constant _ -> add_alias_for_constant status suri
 102   | Cic.Variable _
 103   | Cic.CurrentProof _ -> assert false
 104
 105 let paths_and_uris_of_obj uri status =
 106   let basedir = get_string_option status "basedir" ^ "/xml" in
 107   let innertypesuri = UriManager.innertypesuri_of_uri uri in
 108   let bodyuri = UriManager.bodyuri_of_uri uri in
 109   let innertypesfilename = Str.replace_first (Str.regexp "^cic:") ""
 110         (UriManager.string_of_uri innertypesuri) ^ ".xml.gz" in
 111   let innertypespath = basedir ^ "/" ^ innertypesfilename in
 112   let xmlfilename = Str.replace_first (Str.regexp "^cic:/") ""
 113         (UriManager.string_of_uri uri) ^ ".xml.gz" in
 114   let xmlpath = basedir ^ "/" ^ xmlfilename in
 115   let xmlbodyfilename = Str.replace_first (Str.regexp "^cic:/") ""
 116         (UriManager.string_of_uri uri) ^ ".body.xml.gz" in
 117   let xmlbodypath = basedir ^ "/" ^  xmlbodyfilename in
 118   xmlpath, xmlbodypath, innertypespath, bodyuri, innertypesuri
 119
 120 let save_object_to_disk status uri obj =
 121   let ensure_path_exists path =
 122     let dir = Filename.dirname path in
 123     MatitaMisc.mkdir dir
 124   in
 125   (* generate annobj, ids_to_inner_sorts and ids_to_inner_types *)
 126   let annobj = Cic2acic.plain_acic_object_of_cic_object obj in
 127   (* prepare XML *)
 128   let xml, bodyxml =
 129    Cic2Xml.print_object
 130     uri ?ids_to_inner_sorts:None ~ask_dtd_to_the_getter:false annobj
 131   in
 132   let xmlpath, xmlbodypath, innertypespath, bodyuri, innertypesuri =
 133     paths_and_uris_of_obj uri status
 134   in
 135   let path_scheme_of path = "file://" ^ path in
 136   List.iter MatitaMisc.mkdir
 137     (List.map Filename.dirname [innertypespath; xmlpath]);
 138   (* now write to disk *)
 139   ensure_path_exists xmlpath;
 140   Xml.pp ~gzip:true xml (Some xmlpath) ;
 141   (* we return a list of uri,path we registered/created *)
 142   (uri,xmlpath) ::
 143     (* now the optional body, both write and register *)
 144     (match bodyxml,bodyuri with
 145        None,None -> []
 146      | Some bodyxml,Some bodyuri->
 147          ensure_path_exists xmlbodypath;
 148          Xml.pp ~gzip:true bodyxml (Some xmlbodypath);
 149          [bodyuri, xmlbodypath]
 150      | _-> assert false)
 151
 152 let typecheck_obj =
 153  let profiler = CicUtil.profile "add_obj.typecheck_obj" in
 154   fun uri obj -> profiler.CicUtil.profile (CicTypeChecker.typecheck_obj uri) obj
 155
 156 let index_obj =
 157  let profiler = CicUtil.profile "add_obj.index_obj" in
 158   fun ~dbd ~uri ->
 159    profiler.CicUtil.profile (fun uri -> MetadataDb.index_obj ~dbd ~uri) uri
 160
 161 let save_object_to_disk =
 162  let profiler = CicUtil.profile "add_obj.save_object_to_disk" in
 163   fun status uri obj ->
 164    profiler.CicUtil.profile (save_object_to_disk status uri) obj
 165
 166 let add_obj uri obj status =
 167   let dbd = MatitaDb.instance () in
 168   let suri = UriManager.string_of_uri uri in
 169   if CicEnvironment.in_library uri then
 170     command_error (sprintf "%s already defined" suri)
 171   else begin
 172     typecheck_obj uri obj; (* 1 *)
 173     try
 174       index_obj ~dbd ~uri; (* 2 must be in the env *)
 175       try
 176         let new_stuff = save_object_to_disk status uri obj in (* 3 *)
 177         try
 178           MatitaLog.message (sprintf "%s defined" suri);
 179           let status = add_aliases_for_object status suri obj in
 180           { status with objects = new_stuff @ status.objects;
 181                         proof_status = No_proof }
 182         with exc ->
 183           List.iter MatitaMisc.safe_remove (List.map snd new_stuff); (* -3 *)
 184           raise exc
 185       with exc ->
 186         ignore(MatitaDb.remove_uri uri); (* -2 *)
 187         raise exc
 188     with exc ->
 189       CicEnvironment.remove_obj uri; (* -1 *)
 190       raise exc
 191   end
 192
 193 let add_obj =
 194  let profiler = CicUtil.profile "add_obj" in
 195   fun uri obj status -> profiler.CicUtil.profile (add_obj uri obj) status
 196
 197 module OrderedUri =
 198 struct
 199   type t = UriManager.uri * string
 200   let compare (u1, _) (u2, _) = UriManager.compare u1 u2
 201 end
 202
 203 module OrderedId =
 204 struct
 205   type t = CicNotation.notation_id
 206   let compare = Pervasives.compare
 207 end
 208
 209 module UriSet = Set.Make (OrderedUri)
 210 module IdSet  = Set.Make (OrderedId)
 211
 212   (** @return l2 \ l1 *)
 213 let uri_list_diff l2 l1 =
 214   let module S = UriSet in
 215   let s1 = List.fold_left (fun set uri -> S.add uri set) S.empty l1 in
 216   let s2 = List.fold_left (fun set uri -> S.add uri set) S.empty l2 in
 217   let diff = S.diff s2 s1 in
 218   S.fold (fun uri uris -> uri :: uris) diff []
 219
 220   (** @return l2 \ l1 *)
 221 let id_list_diff l2 l1 =
 222   let module S = IdSet in
 223   let s1 = List.fold_left (fun set uri -> S.add uri set) S.empty l1 in
 224   let s2 = List.fold_left (fun set uri -> S.add uri set) S.empty l2 in
 225   let diff = S.diff s2 s1 in
 226   S.fold (fun uri uris -> uri :: uris) diff []
 227
 228 let remove_coercion uri =
 229   CoercDb.remove_coercion (fun (_,_,u) -> UriManager.eq u uri)
 230
 231 let time_travel ~present ~past =
 232   let objs_to_remove = uri_list_diff present.objects past.objects in
 233   let notation_to_remove =
 234     id_list_diff present.notation_ids past.notation_ids
 235   in
 236   let debug_list = ref [] in
 237   List.iter
 238     (fun (uri,p) ->
 239       MatitaMisc.safe_remove p;
 240       remove_coercion uri;
 241       (try
 242         CicEnvironment.remove_obj uri
 243       with CicEnvironment.Object_not_found _ ->
 244         MatitaLog.debug
 245           (sprintf "time_travel removes from cache %s that is not in"
 246             (UriManager.string_of_uri uri)));
 247       let l = MatitaDb.remove_uri uri in
 248       debug_list := UriManager.string_of_uri uri :: !debug_list @ l)
 249     objs_to_remove;
 250   List.iter CicNotation.remove_notation notation_to_remove
 251   (*
 252   (* this is debug code
 253   * idea: debug_list is the list of objects to be removed as computed from the
 254   * db, while list_of_objs_to_remove is the same list but computer from the
 255   * differences between statuses *)
 256   let l1 = List.sort Pervasives.compare !debug_list in
 257   let l2 = List.sort Pervasives.compare
 258     (List.map (fun (x,_) -> UriManager.string_of_uri x) list_of_objs_to_remove)
 259   in
 260   let rec uniq = function
 261     | [] -> []
 262     | h::[] -> [h]
 263     | h1::h2::tl when h1 = h2 -> uniq (h2 :: tl)
 264     | h1::tl (* when h1 <> h2 *) -> h1 :: uniq tl
 265   in
 266   let l1 =  uniq l1 in
 267   let l2 =  uniq l2 in
 268   try
 269     List.iter2 (fun x y -> if x <> y then raise Exit) l1 l2
 270   with
 271   | Invalid_argument _ | Exit ->
 272       MatitaLog.debug "It seems you garbaged something...";
 273       MatitaLog.debug "l1:";
 274       List.iter MatitaLog.debug l1;
 275       MatitaLog.debug "l2:";
 276       List.iter MatitaLog.debug l2
 277       *)
 278
 279 let remove ~verbose uri =
 280   let derived_uris_of_uri uri =
 281     UriManager.innertypesuri_of_uri uri ::
 282     (match UriManager.bodyuri_of_uri uri with
 283     | None -> []
 284     | Some u -> [u])
 285   in
 286   let to_remove =
 287     uri ::
 288     (if UriManager.uri_is_ind uri then MatitaDb.xpointers_of_ind uri else []) @
 289     derived_uris_of_uri uri
 290   in
 291   List.iter
 292     (fun uri ->
 293       (try
 294         if verbose then
 295          MatitaLog.debug ("Removing: " ^ UriManager.string_of_uri uri);
 296         MatitaMisc.safe_remove (Http_getter.resolve' uri)
 297       with Http_getter_types.Key_not_found _ -> ());
 298       remove_coercion uri;
 299       ignore (MatitaDb.remove_uri uri);
 300       CicEnvironment.remove_obj uri)
 301   to_remove