helm/ocaml/library/libraryClean.ml

   1 (* Copyright (C) 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_prerr = if debug then prerr_endline else ignore
  32
  33 module HGT = Http_getter_types;;
  34 module HG = Http_getter;;
  35 module UM = UriManager;;
  36
  37 let cache_of_processed_baseuri = Hashtbl.create 1024
  38
  39 let one_step_depend suri =
  40   let buri =
  41     try
  42       UM.buri_of_uri (UM.uri_of_string suri)
  43     with UM.IllFormedUri _ -> suri
  44   in
  45   if Hashtbl.mem cache_of_processed_baseuri buri then
  46     []
  47   else
  48     begin
  49       Hashtbl.add cache_of_processed_baseuri buri true;
  50       let query =
  51         let buri = buri ^ "/" in
  52         let buri = HMysql.escape buri in
  53         let obj_tbl = MetadataTypes.obj_tbl () in
  54         sprintf
  55         ("SELECT source, h_occurrence FROM %s WHERE " ^^
  56          "h_occurrence REGEXP '^%s[^/]*$'")
  57             obj_tbl buri
  58       in
  59       try
  60         let rc = HMysql.exec (LibraryDb.instance ()) query in
  61         let l = ref [] in
  62         HMysql.iter rc (
  63           fun row ->
  64             match row.(0), row.(1) with
  65             | Some uri, Some occ when Filename.dirname occ = buri ->
  66                 l := uri :: !l
  67             | _ -> ());
  68         let l = List.sort Pervasives.compare !l in
  69         HExtlib.list_uniq l
  70       with
  71         exn -> raise exn (* no errors should be accepted *)
  72     end
  73
  74 let safe_buri_of_suri suri =
  75   try
  76     UM.buri_of_uri (UM.uri_of_string suri)
  77   with
  78     UM.IllFormedUri _ -> suri
  79
  80 let close_uri_list uri_to_remove =
  81   (* to remove an uri you have to remove the whole script *)
  82   let buri_to_remove =
  83     HExtlib.list_uniq
  84       (List.fast_sort Pervasives.compare
  85         (List.map safe_buri_of_suri uri_to_remove))
  86   in
  87   (* cleand the already visided baseuris *)
  88   let buri_to_remove =
  89     List.filter
  90       (fun buri ->
  91         if Hashtbl.mem cache_of_processed_baseuri buri then false
  92         else true)
  93       buri_to_remove
  94   in
  95   (* now calculate the list of objects that belong to these baseuris *)
  96   let uri_to_remove =
  97     try
  98       List.fold_left
  99         (fun acc buri ->
 100           let inhabitants = HG.ls (buri ^ "/") in
 101           let inhabitants = List.filter
 102               (function HGT.Ls_object _ -> true | _ -> false)
 103             inhabitants
 104           in
 105           let inhabitants = List.map
 106               (function
 107                | HGT.Ls_object e -> buri ^ "/" ^ e.HGT.uri
 108                | _ -> assert false)
 109             inhabitants
 110           in
 111           inhabitants @ acc)
 112       [] buri_to_remove
 113     with HGT.Invalid_URI u ->
 114       HLog.error ("We were listing an invalid buri: " ^ u);
 115       exit 1
 116   in
 117   (* now we want the list of all uri that depend on them *)
 118   let depend =
 119     List.fold_left
 120     (fun acc u -> one_step_depend u @ acc) [] uri_to_remove
 121   in
 122   let depend =
 123     HExtlib.list_uniq (List.fast_sort Pervasives.compare depend)
 124   in
 125   uri_to_remove, depend
 126
 127 let rec close_db uris next =
 128   match next with
 129   | [] -> uris
 130   | l -> let uris, next = close_uri_list l in close_db uris next @ uris
 131
 132 let cleaned_no = ref 0;;
 133
 134   (** TODO repellent code ... *)
 135 let moo_root_dir = lazy (
 136   let url =
 137     List.assoc "cic:/matita/"
 138       (List.map
 139         (fun pair ->
 140           match
 141             Str.split (Str.regexp "[ \t\r\n]+") (HExtlib.trim_blanks pair)
 142           with
 143           | [a;b] -> a, b
 144           | _ -> assert false)
 145         (Helm_registry.get_list Helm_registry.string "getter.prefix"))
 146   in
 147   String.sub url 7 (String.length url - 7)  (* remove heading "file:///" *)
 148 )
 149
 150 let close_nodb ~basedir buris =
 151   let rev_deps = Hashtbl.create 97 in
 152   let all_metadata =
 153     HExtlib.find ~test:(fun name -> Filename.check_suffix name ".metadata")
 154       (Lazy.force moo_root_dir)
 155   in
 156   List.iter
 157     (fun path ->
 158       let metadata = LibraryNoDb.load_metadata ~fname:path in
 159       let baseuri_of_current_metadata =
 160        let dirname = Filename.dirname path in
 161        let basedirlen = String.length basedir in
 162         assert (String.sub dirname 0 basedirlen = basedir);
 163         "cic:" ^
 164         String.sub dirname basedirlen (String.length dirname - basedirlen) ^
 165          Filename.basename path
 166       in
 167       let deps =
 168         HExtlib.filter_map
 169           (function LibraryNoDb.Dependency buri -> Some buri)
 170         metadata
 171       in
 172       List.iter
 173         (fun buri -> Hashtbl.add rev_deps buri baseuri_of_current_metadata) deps)
 174     all_metadata;
 175   let buris_to_remove =
 176     HExtlib.list_uniq
 177       (List.fast_sort Pervasives.compare
 178         (List.flatten (List.map (Hashtbl.find_all rev_deps) buris)))
 179   in
 180   let objects_to_remove =
 181     let objs_of_buri buri =
 182       HExtlib.filter_map
 183         (function
 184         | Http_getter_types.Ls_object o ->
 185             Some (buri ^ "/" ^ o.Http_getter_types.uri)
 186         | _ -> None)
 187       (Http_getter.ls buri)
 188     in
 189     List.flatten (List.map objs_of_buri (buris @ buris_to_remove))
 190   in
 191   objects_to_remove
 192
 193 let clean_baseuris ?(verbose=true) ~basedir buris =
 194   Hashtbl.clear cache_of_processed_baseuri;
 195   let buris = List.map Http_getter_misc.strip_trailing_slash buris in
 196   debug_prerr "clean_baseuris called on:";
 197   if debug then
 198     List.iter debug_prerr buris;
 199   let l =
 200     if Helm_registry.get_bool "db.nodb" then
 201       close_nodb ~basedir buris
 202     else
 203       close_db [] buris
 204   in
 205   let l = HExtlib.list_uniq (List.fast_sort Pervasives.compare l) in
 206   let l = List.map UriManager.uri_of_string l in
 207   debug_prerr "clean_baseuri will remove:";
 208   if debug then
 209     List.iter (fun u -> debug_prerr (UriManager.string_of_uri u)) l;
 210   List.iter
 211    (fun buri ->
 212      HExtlib.safe_remove (LibraryMisc.obj_file_of_baseuri basedir buri);
 213      HExtlib.safe_remove (LibraryMisc.metadata_file_of_baseuri basedir buri);
 214      HExtlib.safe_remove (LibraryMisc.lexicon_file_of_baseuri basedir buri))
 215    (HExtlib.list_uniq (List.fast_sort Pervasives.compare
 216      (List.map (UriManager.buri_of_uri) l)));
 217   List.iter
 218    (let last_baseuri = ref "" in
 219     fun uri ->
 220      let buri = UriManager.buri_of_uri uri in
 221      if buri <> !last_baseuri then
 222       begin
 223        HLog.message ("Removing: " ^ buri ^ "/*");
 224        last_baseuri := buri
 225       end;
 226      LibrarySync.remove_obj uri
 227    ) l;
 228   cleaned_no := !cleaned_no + List.length l;
 229   if !cleaned_no > 30 then
 230    begin
 231     cleaned_no := 0;
 232     List.iter
 233      (function table ->
 234        ignore (HMysql.exec (LibraryDb.instance ()) ("OPTIMIZE TABLE " ^ table)))
 235      [MetadataTypes.name_tbl (); MetadataTypes.rel_tbl ();
 236       MetadataTypes.sort_tbl (); MetadataTypes.obj_tbl();
 237       MetadataTypes.count_tbl()]
 238    end