Added GIT_ANNEX_VECTOR_CLOCK environment variable

Can be used to override the default timestamps used in log files in the
git-annex branch. This is a dangerous environment variable; use with
caution.

Note that this only affects writing to the logs on the git-annex branch.
It is not used for metadata in git commits (other env vars can be set for
that).

There are many other places where timestamps are still used, that don't
get committed to git, but do touch disk. Including regular timestamps
of files, and timestamps embedded in some files in .git/annex/, including
the last fsck timestamp and timestamps in transfer log files.

A good way to find such things in git-annex is to get for getPOSIXTime and
getCurrentTime, although some of the results are of course false positives
that never hit disk (unless git-annex gets swapped out..)

So this commit does NOT necessarily make git-annex comply with some HIPPA
privacy regulations; it's up to the user to determine if they can use it in
a way compliant with such regulations.

Benchmarking: It takes 0.00114 milliseconds to call getEnv
"GIT_ANNEX_VECTOR_CLOCK" when that env var is not set. So, 100 thousand log
files can be written with an added overhead of only 0.114 seconds. That
should be by far swamped by the actual overhead of writing the log files
and making the commit containing them.

This commit was supported by the NSF-funded DataLad project.

1 files changed, 18 insertions, 21 deletions

diff --git a/Logs/MapLog.hs b/Logs/MapLog.hs
index 097439ac5..7fe9e5782 100644
--- a/Logs/MapLog.hs
+++ b/Logs/MapLog.hs
@@ -11,20 +11,21 @@
  - Licensed under the GNU GPL version 3 or higher.
  -}
 
-module Logs.MapLog where
-
-import qualified Data.Map as M
-import Data.Time.Clock.POSIX
+module Logs.MapLog (
+	module Logs.MapLog,
+	VectorClock,
+	currentVectorClock,
+) where
 
 import Common
+import Annex.VectorClock
 import Logs.TimeStamp
 import Logs.Line
 
-data TimeStamp = Unknown | Date POSIXTime
-	deriving (Eq, Ord, Show)
+import qualified Data.Map as M
 
 data LogEntry v = LogEntry
-	{ changed :: TimeStamp
+	{ changed :: VectorClock
 	, value :: v
 	} deriving (Eq, Show)
 
@@ -33,8 +34,8 @@ type MapLog f v = M.Map f (LogEntry v)
 showMapLog :: (f -> String) -> (v -> String) -> MapLog f v -> String
 showMapLog fieldshower valueshower = unlines . map showpair . M.toList
   where
-	showpair (f, LogEntry (Date p) v) =
-		unwords [show p, fieldshower f, valueshower v]
+	showpair (f, LogEntry (VectorClock c) v) =
+		unwords [show c, fieldshower f, valueshower v]
 	showpair (f, LogEntry Unknown v) =
 		unwords ["0", fieldshower f, valueshower v]
 
@@ -44,14 +45,14 @@ parseMapLog fieldparser valueparser = M.fromListWith best . mapMaybe parse . spl
 	parse line = do
 		let (ts, rest) = splitword line
 		    (sf, sv) = splitword rest
-		date <- Date <$> parsePOSIXTime ts
+		c <- VectorClock <$> parsePOSIXTime ts
 		f <- fieldparser sf
 		v <- valueparser sv
-		Just (f, LogEntry date v)
+		Just (f, LogEntry c v)
 	splitword = separate (== ' ')
 
-changeMapLog :: Ord f => POSIXTime -> f -> v -> MapLog f v -> MapLog f v
-changeMapLog t f v = M.insert f $ LogEntry (Date t) v
+changeMapLog :: Ord f => VectorClock -> f -> v -> MapLog f v -> MapLog f v
+changeMapLog c f v = M.insert f $ LogEntry c v
 
 {- Only add an LogEntry if it's newer (or at least as new as) than any
  - existing LogEntry for a field. -}
@@ -69,15 +70,11 @@ best new old
 	| changed old > changed new = old
 	| otherwise = new
 
--- Unknown is oldest.
-prop_TimeStamp_sane :: Bool
-prop_TimeStamp_sane = Unknown < Date 1
-
 prop_addMapLog_sane :: Bool
 prop_addMapLog_sane = newWins && newestWins
   where
-	newWins = addMapLog ("foo") (LogEntry (Date 1) "new") l == l2
-	newestWins = addMapLog ("foo") (LogEntry (Date 1) "newest") l2 /= l2
+	newWins = addMapLog ("foo") (LogEntry (VectorClock 1) "new") l == l2
+	newestWins = addMapLog ("foo") (LogEntry (VectorClock 1) "newest") l2 /= l2
 
-	l = M.fromList [("foo", LogEntry (Date 0) "old")]
-	l2 = M.fromList [("foo", LogEntry (Date 1) "new")]
+	l = M.fromList [("foo", LogEntry (VectorClock 0) "old")]
+	l2 = M.fromList [("foo", LogEntry (VectorClock 1) "new")]