(**************************************************************************) (* *) (* Copyright 2016-2020 OCamlPro *) (* *) (* All rights reserved. This file is distributed under the terms of the *) (* GNU Lesser General Public License version 2.1, with the special *) (* exception on linking described in the file LICENSE. *) (* *) (**************************************************************************) open OpamStd.Op let log ?level fmt = OpamConsole.log ?level "TRACK" fmt let slog = OpamConsole.slog module SM = OpamStd.String.Map type digest = string let digest_of_string dg = dg let string_of_digest dg = dg type change = | Added of digest | Removed | Contents_changed of digest | Perm_changed of digest | Kind_changed of digest type t = change SM.t let string_of_change ?(full=false) = let str s d = if not full then s else Printf.sprintf "%s %s" s (string_of_digest d) in function | Added d -> str "addition" d | Removed -> "removal" | Contents_changed d -> str "modifications" d | Perm_changed d -> str "permission change" d | Kind_changed d -> str "kind change" d let to_string t = OpamStd.Format.itemize (fun (f, change) -> Printf.sprintf "%s of %s" (String.capitalize_ascii (string_of_change change)) f) (SM.bindings t) let to_summary_string t = let freq_table = SM.fold (fun _ change -> SM.union (+) (SM.singleton (string_of_change ~full:false change) 1)) t SM.empty in let freq_list = OpamStd.List.concat_map ~left:" (" ~right:")" ~nil:"" "; " (fun (change, freq) -> Printf.sprintf "%s: %d" change freq) (SM.bindings freq_table) in Printf.sprintf "%d items%s" (SM.cardinal t) freq_list (** uid, gid, perm *) type perms = int * int * int type item_value = | File of string | Dir | Link of string | Special of (int * int) type item = perms * item_value let cached_digest = let item_cache = Hashtbl.create 749 in fun f size mtime -> try let csize, cmtime, digest = Hashtbl.find item_cache f in if csize = size && mtime = cmtime then Digest.to_hex digest else raise Not_found with Not_found -> let digest = Digest.file f in Hashtbl.replace item_cache f (size, mtime, digest); Digest.to_hex digest let quick_digest _f size mtime = Printf.sprintf "S%dT%s" size (string_of_float mtime) let get_digest ?(precise=OpamCoreConfig.(!r.precise_tracking)) f size mtime = if precise then cached_digest f size mtime else quick_digest f size mtime let item_of_filename ?precise f : item = let stats = Unix.lstat f in Unix.(stats.st_uid, stats.st_gid, stats.st_perm), match stats.Unix.st_kind with | Unix.S_REG -> File (get_digest ?precise f stats.Unix.st_size stats.Unix.st_mtime) | Unix.S_DIR -> Dir | Unix.S_LNK -> Link (Unix.readlink f) | Unix.S_CHR | Unix.S_BLK | Unix.S_FIFO | Unix.S_SOCK -> Special Unix.(stats.st_dev, stats.st_rdev) let item_of_filename_opt ?precise f = try Some (item_of_filename ?precise f) with Unix.Unix_error _ -> None let item_digest = function | _perms, File d -> "F:" ^ d | _perms, Dir -> "D" | _perms, Link l -> "L:" ^ l | _perms, Special (a,b) -> Printf.sprintf "S:%d:%d" a b let is_precise_digest d = not (OpamStd.String.starts_with ~prefix:"F:S" d) let check_digest file digest = let precise = is_precise_digest digest in let it = item_of_filename ~precise file in try if item_digest it = digest then `Unchanged else `Changed with Unix.Unix_error _ -> `Removed let check prefix changes = let str_pfx = OpamFilename.Dir.to_string prefix in SM.fold (fun fname op acc -> let f = Filename.concat str_pfx fname in match op with | Added dg | Kind_changed dg | Contents_changed dg -> (OpamFilename.of_string f, check_digest f dg) :: acc | Perm_changed _ | Removed -> acc) changes [] |> List.rev let revert ?title ?(verbose=OpamConsole.verbose()) ?(force=false) ?(dryrun=false) prefix changes = let title = match title with | None -> "" | Some t -> t ^ ": " in let rmdir d = if not dryrun then OpamFilename.rmdir d in let rmfile f = if not dryrun then OpamFilename.remove f in let changes = (* Reverse the list so that dirnames come after the files they contain *) List.rev (OpamStd.String.Map.bindings changes) in let already, modified, nonempty, cannot = List.fold_left (fun (already,modified,nonempty,cannot as acc) (fname,op) -> let f = Filename.concat (OpamFilename.Dir.to_string prefix) fname in match op with | Added dg | Kind_changed dg -> let cur_item_ct, cur_dg = try let precise = is_precise_digest dg in let item = item_of_filename ~precise f in Some (snd item), Some (item_digest item) with Unix.Unix_error _ -> None, None in if cur_dg = None then (fname::already, modified, nonempty, cannot) else if cur_dg <> Some dg && not force then (already, fname::modified, nonempty, cannot) else if cur_item_ct = Some Dir then let d = OpamFilename.Dir.of_string f in if OpamFilename.dir_is_empty d then (rmdir d; acc) else let nonempty = if List.exists (OpamStd.String.starts_with ~prefix:fname) nonempty then nonempty else fname::nonempty in (already, modified, nonempty, cannot) else let f = OpamFilename.of_string f in rmfile f; acc | Contents_changed dg -> if check_digest f dg = `Changed then (already, modified, nonempty, (op,fname)::cannot) else acc (* File has changed, assume the removal script reverted it *) | (Removed | Perm_changed _) -> (already, modified, nonempty, (op,fname)::cannot)) ([], [], [], []) changes in if already <> [] then log ~level:2 "%sfiles %s were already removed" title (String.concat ", " (List.rev already)); if modified <> [] then if OpamConsole.confirm ~default:false "%sthese files have been modified since installation:\n%s\ Remove them anyway?" title (OpamStd.Format.itemize (fun s -> s) (List.rev modified)) then List.iter (fun f -> OpamFilename.remove (OpamFilename.Op.(prefix // f))) modified; if nonempty <> [] && verbose then OpamConsole.note "%snot removing non-empty directories:\n%s" title (OpamStd.Format.itemize (fun s -> s) (List.rev nonempty)); if cannot <> [] && verbose then let cannot = let rem, modf, perm = List.fold_left (fun (rem, modf, perm as acc) (op,f) -> match op with | Removed -> (None, f)::rem, modf, perm | Contents_changed dg -> let precise = Some (is_precise_digest dg) in rem, (precise, f)::modf, perm | Perm_changed dg -> let precise = Some (is_precise_digest dg) in rem, modf, (precise, f)::perm | _ -> acc) ([],[],[]) cannot in (if rem = [] then [] else [Removed, rem]) @ (if modf = [] then [] else [Contents_changed "_", modf]) @ (if perm = [] then [] else [Perm_changed "_", perm]) in (OpamConsole.warning "%scannot revert:" title; OpamConsole.errmsg "%s" (OpamStd.Format.itemize (fun (op,lf) -> Printf.sprintf "%s of:\n%s" (string_of_change op) (OpamStd.Format.itemize (fun (pre,x) -> (OpamStd.Option.to_string (fun pr -> if pr then "[hash] " else "[tms] ") pre) ^ x) lf)) cannot)) let update prefix t = let removed = ref [] in let prefix = OpamFilename.Dir.to_string prefix in let update_digest file digest = match let filename = Filename.concat prefix file in let precise = is_precise_digest digest in item_digest ( item_of_filename ~precise filename ) with | exception Unix.Unix_error ( ENOENT, _, _) -> removed := file :: !removed; digest | exception _exn -> digest | digest -> digest in let t = SM.mapi (fun file change -> match change with | Added digest -> Added (update_digest file digest) | Removed -> Removed | Contents_changed digest -> Contents_changed (update_digest file digest) | Perm_changed digest -> Perm_changed (update_digest file digest) | Kind_changed digest -> Kind_changed (update_digest file digest) ) t in List.fold_left (fun t file -> SM.remove file t ) t !removed