helm/software/components/library/librarian.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 let debug = ref false
  27
  28 let time_stamp =
  29    let old = ref 0.0 in
  30    fun msg ->
  31       if !debug then begin
  32          let times = Unix.times () in
  33          let stamp = times.Unix.tms_utime +. times.Unix.tms_stime in
  34          let lap = stamp -. !old in
  35          Printf.eprintf "TIME STAMP (%s): %f\n" msg lap; flush stderr;
  36          old := stamp
  37       end
  38
  39 exception NoRootFor of string
  40
  41 let absolutize path =
  42  let path =
  43    if String.length path > 0 && path.[0] <> '/' then
  44      Sys.getcwd () ^ "/" ^ path
  45    else
  46      path
  47  in
  48    HExtlib.normalize_path path
  49 ;;
  50
  51
  52 let find_root path =
  53   let path = absolutize path in
  54   let paths = List.rev (Str.split (Str.regexp "/") path) in
  55   let rec build = function
  56     | he::tl as l -> ("/" ^ String.concat "/" (List.rev l) ^ "/") :: build tl
  57     | [] -> ["/"]
  58   in
  59   let paths = List.map HExtlib.normalize_path (build paths) in
  60   try HExtlib.find_in paths "root"
  61   with Failure "find_in" ->
  62     raise (NoRootFor (path ^ " (" ^ String.concat ", " paths ^ ")"))
  63 ;;
  64
  65 let ensure_trailing_slash s =
  66   if s = "" then "/" else
  67   if s.[String.length s-1] <> '/' then s^"/" else s
  68 ;;
  69
  70 let remove_trailing_slash s =
  71   if s = "" then "" else
  72   let len = String.length s in
  73   if s.[len-1] = '/' then String.sub s 0 (len-1) else s
  74 ;;
  75
  76 let load_root_file rootpath =
  77   let data = HExtlib.input_file rootpath in
  78   let lines = Str.split (Str.regexp "\n") data in
  79   let clean s =
  80     Pcre.replace ~pat:"[ \t]+" ~templ:" "
  81       (Pcre.replace ~pat:"^ *" (Pcre.replace ~pat:" *$" s))
  82   in
  83   List.map
  84     (fun l ->
  85       match Str.split (Str.regexp "=") l with
  86       | [k;v] -> clean k, Http_getter_misc.strip_trailing_slash (clean v)
  87       | _ -> raise (Failure ("Malformed root file: " ^ rootpath)))
  88     lines
  89 ;;
  90
  91 let rec find_root_for ~include_paths file =
  92  let include_paths = "" :: Sys.getcwd () :: include_paths in
  93  try
  94    let path = HExtlib.find_in include_paths file in
  95    let path = absolutize path in
  96 (*     HLog.debug ("file "^file^" resolved as "^path);  *)
  97    let rootpath, root, buri =
  98      try
  99        let mburi = Helm_registry.get "matita.baseuri" in
 100        match Str.split (Str.regexp " ") mburi with
 101        | [root; buri] when HExtlib.is_prefix_of root path ->
 102            ":registry:", root, buri
 103        | _ -> raise (Helm_registry.Key_not_found "matita.baseuri")
 104      with Helm_registry.Key_not_found "matita.baseuri" ->
 105        let rootpath = find_root path in
 106        let buri = List.assoc "baseuri" (load_root_file rootpath) in
 107        rootpath, Filename.dirname rootpath, buri
 108    in
 109 (*     HLog.debug ("file "^file^" rooted by "^rootpath^"");  *)
 110    let uri = Http_getter_misc.strip_trailing_slash buri in
 111    if String.length uri < 5 || String.sub uri 0 5 <> "cic:/" then
 112      HLog.error (rootpath ^ " sets an incorrect baseuri: " ^ buri);
 113    ensure_trailing_slash root, remove_trailing_slash uri, path
 114  with Failure "find_in" ->
 115    if Filename.check_suffix file ".ma" then begin
 116       let mma = Filename.chop_suffix file ".ma" ^ ".mma" in
 117       HLog.warn ("We look for: " ^ mma);
 118       find_root_for ~include_paths mma
 119    end else begin
 120       HLog.error ("We are in: " ^ Sys.getcwd ());
 121       HLog.error ("Unable to find: "^file^"\nPaths explored:");
 122       List.iter (fun x -> HLog.error (" - "^x)) include_paths;
 123       raise (NoRootFor file)
 124    end
 125 ;;
 126
 127 let mk_baseuri root extra =
 128   let chop name =
 129     assert(Filename.check_suffix name ".ma" ||
 130       Filename.check_suffix name ".mma");
 131     try Filename.chop_extension name
 132     with Invalid_argument "Filename.chop_extension" -> name
 133   in
 134    remove_trailing_slash (HExtlib.normalize_path (root ^ "/" ^ chop extra))
 135 ;;
 136
 137 let baseuri_of_script ~include_paths file =
 138   let root, buri, path = find_root_for ~include_paths file in
 139   let path = HExtlib.normalize_path path in
 140   let root = HExtlib.normalize_path root in
 141   let lpath = Str.split (Str.regexp "/") path in
 142   let lroot = Str.split (Str.regexp "/") root in
 143   let rec substract l1 l2 =
 144     match l1, l2 with
 145     | h1::tl1,h2::tl2 when h1 = h2 -> substract tl1 tl2
 146     | l,[] -> l
 147     | _ -> raise (NoRootFor (file ^" "^path^" "^root))
 148   in
 149   let extra_buri = substract lpath lroot in
 150   let extra = String.concat "/" extra_buri in
 151    root,
 152    mk_baseuri buri extra,
 153    path,
 154    extra
 155 ;;
 156
 157 let find_roots_in_dir dir =
 158   HExtlib.find ~test:(fun f ->
 159     Filename.basename f = "root" &&
 160     try (Unix.stat f).Unix.st_kind = Unix.S_REG
 161     with Unix.Unix_error _ -> false)
 162     dir
 163 ;;
 164
 165 (* make *)
 166 let load_deps_file f =
 167   let deps = ref [] in
 168   let ic = open_in f in
 169   try
 170     while true do
 171       begin
 172         let l = input_line ic in
 173         match Str.split (Str.regexp " ") l with
 174         | [] ->
 175             HLog.error ("Malformed deps file: " ^ f);
 176             raise (Failure ("Malformed deps file: " ^ f))
 177         | he::tl -> deps := (he,tl) :: !deps
 178       end
 179     done; !deps
 180     with End_of_file -> !deps
 181 ;;
 182
 183 type options = (string * string) list
 184
 185 module type Format =
 186   sig
 187     type source_object
 188     type target_object
 189     val load_deps_file: string -> (source_object * source_object list) list
 190     val string_of_source_object: source_object -> string
 191     val string_of_target_object: target_object -> string
 192     val build: options -> source_object -> bool
 193     val root_and_target_of:
 194           options -> source_object -> string option * target_object
 195     val mtime_of_source_object: source_object -> float option
 196     val mtime_of_target_object: target_object -> float option
 197     val is_readonly_buri_of: options -> source_object -> bool
 198   end
 199
 200 module Make = functor (F:Format) -> struct
 201
 202   type status = Done of bool
 203               | Ready of bool
 204
 205   let say s = if !debug then prerr_endline ("make: "^s);;
 206
 207   let unopt_or_call x f y = match x with Some _ -> x | None -> f y;;
 208
 209   let fst4 = function (x,_,_,_) -> x;;
 210
 211   let modified_before_s_t (_,cs, ct, _, _) a b =
 212 (*
 213     time_stamp ("L s_t: a " ^ F.string_of_source_object a);
 214     time_stamp ("L s_t: b " ^ F.string_of_target_object b);
 215 *)
 216     let a = try Hashtbl.find cs a with Not_found -> assert false in
 217     let b =
 218       try
 219         match Hashtbl.find ct b with
 220         | Some _ as x -> x
 221         | None ->
 222            match F.mtime_of_target_object b with
 223            | Some t as x ->
 224                Hashtbl.remove ct b;
 225                Hashtbl.add ct b x; x
 226            | x -> x
 227       with Not_found -> assert false
 228     in
 229     let r = match a, b with
 230        | Some a, Some b -> a <= b
 231        | _ -> false
 232     in
 233 (*
 234     time_stamp ("L s_t: " ^ string_of_bool r);
 235 *)
 236     r
 237
 238   let modified_before_t_t (_,_,ct, _, _) a b =
 239 (*
 240     time_stamp ("L t_t: a " ^ F.string_of_target_object a);
 241     time_stamp ("L t_t: b " ^ F.string_of_target_object b);
 242 *)
 243     let a =
 244       try
 245         match Hashtbl.find ct a with
 246         | Some _ as x -> x
 247         | None ->
 248            match F.mtime_of_target_object a with
 249            | Some t as x ->
 250                Hashtbl.remove ct a;
 251                Hashtbl.add ct a x; x
 252            | x -> x
 253       with Not_found -> assert false
 254     in
 255     let b =
 256       try
 257         match Hashtbl.find ct b with
 258         | Some _ as x -> x
 259         | None ->
 260            match F.mtime_of_target_object b with
 261            | Some t as x ->
 262                Hashtbl.remove ct b;
 263                Hashtbl.add ct b x; x
 264            | x -> x
 265       with Not_found -> assert false
 266     in
 267     let r = match a, b with
 268        | Some a, Some b ->
 269 (*
 270        time_stamp ("tt: a " ^ string_of_float a);
 271        time_stamp ("tt: b " ^ string_of_float b);
 272 *)
 273           a <= b
 274        | _ -> false
 275     in
 276 (*
 277     time_stamp ("L t_t: " ^ string_of_bool r);
 278 *)
 279     r
 280
 281   let rec purge_unwanted_roots wanted deps =
 282     let roots, rest =
 283        List.partition
 284          (fun (t,d,_,_) ->
 285            not (List.exists (fun (_,d1,_,_) -> List.mem t d1) deps))
 286          deps
 287     in
 288     let newroots = List.filter (fun (t,_,_,_) -> List.mem t wanted) roots in
 289     if newroots = roots then
 290       deps
 291     else
 292       purge_unwanted_roots wanted (newroots @ rest)
 293   ;;
 294
 295   let is_not_ro (opts,_,_,_,_) (f,_,r,_) =
 296     match r with
 297     | Some root -> not (F.is_readonly_buri_of opts f)
 298     | None -> assert false
 299   ;;
 300 (* FG: Old sorting algorithm ************************************************)
 301 (*
 302   let rec get_status opts what =
 303      let _, _, _, cc, cd = opts in
 304      let t, dependencies, root, tgt = what in
 305      try Done (Hashtbl.find cc t)
 306 (* say "already built" *)
 307      with Not_found ->
 308         let map st d = match st with
 309            | Done false  -> st
 310            | Ready false -> st
 311            | _           ->
 312               let whatd = Hashtbl.find cd d in
 313               let _, _, _, tgtd = whatd in
 314               begin match st, get_status opts whatd with
 315                  | _, Done false         -> Hashtbl.add cc t false; Done false
 316                  | Done true, Done true  ->
 317                     if modified_before_t_t opts tgt tgtd then Ready true else Done true
 318 (* say (F.string_of_source_object t^" depends on "^F.string_of_target_object unsat^" and "^F.string_of_source_object t^".o is younger than "^ F.string_of_target_object unsat^", thus needs to be built") *)
 319                  | Done true, Ready _    -> Ready false
 320                  | Ready true, Ready _   -> Ready false
 321 (* say (F.string_of_source_object t^" depends on "^ F.string_of_source_object (fst4 unsat)^ " that is not built, thus is not ready") *)
 322                  | Ready true, Done true -> Ready true
 323                  | _                     -> st
 324               end
 325         in
 326         let st = if modified_before_s_t opts t tgt then Done true else Ready true in
 327         match List.fold_left map st dependencies with
 328            | Done true -> Hashtbl.add cc t true; Done true
 329 (* say(F.string_of_source_object t^" is built" *)
 330            | st     -> st
 331
 332   let list_partition_filter_rev filter l =
 333      let rec aux l1 l2 = function
 334         | []       -> l1, l2
 335         | hd :: tl ->
 336            begin match filter hd with
 337               | None       -> aux l1 l2 tl
 338               | Some true  -> aux (hd :: l1) l2 tl
 339               | Some false -> aux l1 (hd :: l2) tl
 340            end
 341      in
 342      aux [] [] l
 343
 344   let rec make_aux root (lo,_,ct, cc, _ as opts) ok deps =
 345     time_stamp "filter get_status: begin";
 346     let map what = match get_status opts what with
 347        | Done _  -> None
 348        | Ready b -> Some b
 349     in
 350     let todo, deps = list_partition_filter_rev map deps in
 351     time_stamp "filter get_status: end";
 352     let todo =
 353       let local, remote =
 354         List.partition (fun (_,_,froot,_) -> froot = Some root) todo
 355       in
 356       let local, skipped = List.partition (is_not_ro opts) local in
 357       List.iter
 358        (fun x ->
 359         HLog.warn("Read only baseuri for: "^F.string_of_source_object(fst4 x)))
 360        skipped;
 361       remote @ local
 362     in
 363     if todo <> [] then begin
 364        let ok = List.fold_left
 365           (fun ok (file,_,froot,tgt) ->
 366             let rc =
 367               match froot with
 368               | Some froot when froot = root ->
 369                   Hashtbl.remove ct tgt;
 370                   Hashtbl.add ct tgt None;
 371                   time_stamp "building";
 372                   let r = F.build lo file in
 373                   time_stamp "done"; r
 374               | Some froot -> make froot [file]
 375               | None ->
 376                   HLog.error ("No root for: "^F.string_of_source_object file);
 377                   false
 378             in
 379             Hashtbl.add cc file rc;
 380             ok && rc
 381           )
 382           ok (List.rev todo)
 383        in
 384       make_aux root opts ok (List.rev deps)
 385     end
 386     else
 387       ok
 388 *)
 389 (* FG: new sorting algorithm ************************************************)
 390
 391   let rec make_aux root opts ok deps =
 392     List.fold_left (make_one root opts) ok deps
 393
 394   and make_one root opts ok what =
 395     let lo, _, ct, cc, cd = opts in
 396     let t, deps, froot, tgt = what in
 397     let str = F.string_of_source_object t in
 398     let map (okd, okt) d =
 399        let (_, _, _, tgtd) as whatd = (Hashtbl.find cd d) in
 400        let r = make_one root opts okd whatd in
 401        r, okt && modified_before_t_t opts tgtd tgt
 402     in
 403     time_stamp ("L : processing " ^ str);
 404     try
 405        let r = Hashtbl.find cc t in
 406        time_stamp ("L : " ^ string_of_bool r ^ " " ^ str);
 407        ok && r
 408 (* say "already built" *)
 409     with Not_found ->
 410        let okd, okt = List.fold_left map (true, modified_before_s_t opts t tgt) deps in
 411        let res =
 412           if okd then
 413           if okt then true else
 414           match froot with
 415              | Some froot when froot = root ->
 416                 if is_not_ro opts what then begin
 417                    Hashtbl.remove ct tgt;
 418                    Hashtbl.add ct tgt None;
 419                    time_stamp ("L : BUILDING " ^ str);
 420                    let res = F.build lo t in
 421                    time_stamp ("L : DONE     " ^ str); res
 422                 end else begin
 423                    Hashtbl.remove ct tgt;
 424                    Hashtbl.add ct tgt None;
 425                    HLog.warn("Read only baseuri for: "^ str^
 426                      ", assuming it is aleary built."); true
 427                 end
 428              | Some froot -> make froot [t]
 429              | None ->
 430                 HLog.error ("No root for: " ^ str); false
 431           else false
 432        in
 433        time_stamp ("L : " ^ string_of_bool res ^ " " ^ str);
 434        Hashtbl.add cc t res; ok && res
 435
 436 (****************************************************************************)
 437
 438   and make root targets =
 439     time_stamp "L : ENTERING";
 440     HLog.debug ("Entering directory '"^root^"'");
 441     let old_root = Sys.getcwd () in
 442     Sys.chdir root;
 443     let deps = F.load_deps_file (root^"/depends") in
 444     let local_options = load_root_file (root^"/root") in
 445     let caches,cachet,cachec,cached =
 446        Hashtbl.create 73, Hashtbl.create 73, Hashtbl.create 73, Hashtbl.create 73
 447     in
 448     (* deps are enriched with these informations to sped up things later *)
 449     let deps =
 450       List.map
 451         (fun (file,d) ->
 452           let r,tgt = F.root_and_target_of local_options file in
 453           Hashtbl.add caches file (F.mtime_of_source_object file);
 454           Hashtbl.add cachet tgt (F.mtime_of_target_object tgt);
 455           Hashtbl.add cached file (file, d, r, tgt);
 456           (file, d, r, tgt)
 457         )
 458         deps
 459     in
 460     let opts = local_options, caches, cachet, cachec, cached in
 461     let ok =
 462       if targets = [] then
 463         make_aux root opts true deps
 464       else
 465         make_aux root opts true
 466           (purge_unwanted_roots targets deps)
 467     in
 468     HLog.debug ("Leaving directory '"^root^"'");
 469     Sys.chdir old_root;
 470     time_stamp "L : LEAVING";
 471     ok
 472   ;;
 473
 474 end
 475
 476 let write_deps_file where deps = match where with
 477    | Some root ->
 478       let oc = open_out (root ^ "/depends") in
 479       let map (t, d) = output_string oc (t^" "^String.concat " " d^"\n") in
 480       List.iter map deps; close_out oc;
 481       HLog.message ("Generated: " ^ root ^ "/depends")
 482    | None ->
 483       print_endline (String.concat " " (List.flatten (List.map snd deps)))
 484
 485 (* FG ***********************************************************************)
 486
 487 (* scheme uri part as defined in URI Generic Syntax (RFC 3986) *)
 488 let uri_scheme_rex = Pcre.regexp "^[[:alpha:]][[:alnum:]\-+.]*:"
 489
 490 let is_uri str =
 491    Pcre.pmatch ~rex:uri_scheme_rex str