status: In local mode, displays information about variance from configured numcopies levels.

4 files changed, 50 insertions, 9 deletions

diff --git a/Command.hs b/Command.hs
index fec733f72..2c157304f 100644
--- a/Command.hs
+++ b/Command.hs
@@ -111,7 +111,7 @@ numCopies file = do
 		Just n -> return $ Just n
 		Nothing -> readish <$> checkAttr "annex.numcopies" file
 
-numCopiesCheck :: FilePath -> Key -> (Int -> Int -> Bool) -> Annex Bool
+numCopiesCheck :: FilePath -> Key -> (Int -> Int -> v) -> Annex v
 numCopiesCheck file key vs = do
 	numcopiesattr <- numCopies file
 	needed <- getNumCopies numcopiesattr
diff --git a/Command/Status.hs b/Command/Status.hs
index af85fcc2a..4f18f8b8e 100644
--- a/Command/Status.hs
+++ b/Command/Status.hs
@@ -13,6 +13,7 @@ import "mtl" Control.Monad.State.Strict
 import qualified Data.Map as M
 import Text.JSON
 import Data.Tuple
+import Data.Ord
 import System.PosixCompat.Files
 
 import Common.Annex
@@ -49,10 +50,24 @@ data KeyData = KeyData
 	, backendsKeys :: M.Map String Integer
 	}
 
+data NumCopiesStats = NumCopiesStats
+	{ numCopiesVarianceMap :: M.Map Variance Integer
+	}
+
+newtype Variance = Variance Int
+	deriving (Eq, Ord)
+
+instance Show Variance where
+	show (Variance n)
+		| n == 0 = "numcopies satisfied"
+		| n > 0 = "numcopies +" ++ show n
+		| otherwise = "numcopies " ++ show n
+
 -- cached info that multiple Stats use
 data StatInfo = StatInfo
 	{ presentData :: Maybe KeyData
 	, referencedData :: Maybe KeyData
+	, numCopiesStats :: Maybe NumCopiesStats
 	}
 
 -- a state monad for running Stats in
@@ -82,7 +97,7 @@ globalStatus = do
 		then global_fast_stats
 		else global_fast_stats ++ global_slow_stats
 	showCustom "status" $ do
-		evalStateT (mapM_ showStat stats) (StatInfo Nothing Nothing)
+		evalStateT (mapM_ showStat stats) (StatInfo Nothing Nothing Nothing)
 		return True
 
 localStatus :: FilePath -> Annex ()
@@ -123,6 +138,7 @@ local_stats =
 	, const local_annex_size
 	, const known_annex_keys
 	, const known_annex_size
+	, const numcopies_stats
 	]
 
 stat :: String -> (String -> StatState String) -> Stat
@@ -255,6 +271,14 @@ backend_usage = stat "backend usage" $ nojson $
 		reverse $ sort $ map swap $ M.toList $
 		M.unionWith (+) x y
 
+numcopies_stats :: Stat
+numcopies_stats = stat "numcopies stats" $ nojson $
+	calc <$> (maybe M.empty numCopiesVarianceMap <$> cachedNumCopiesStats)
+  where
+	calc = multiLine
+		. map (\(variance, count) -> show variance ++ ": " ++ show count)
+		. reverse . sortBy (comparing snd) . M.toList
+
 cachedPresentData :: StatState KeyData
 cachedPresentData = do
 	s <- get
@@ -276,29 +300,37 @@ cachedReferencedData = do
 			put s { referencedData = Just v }
 			return v
 
+-- currently only available for local status
+cachedNumCopiesStats :: StatState (Maybe NumCopiesStats)
+cachedNumCopiesStats = numCopiesStats <$> get
+
 getLocalStatInfo :: FilePath -> Annex StatInfo
 getLocalStatInfo dir = do
 	matcher <- Limit.getMatcher
-	(presentdata, referenceddata) <-
+	(presentdata, referenceddata, numcopiesstats) <-
 		Command.Unused.withKeysFilesReferencedIn dir initial
 			(update matcher)
-	return $ StatInfo (Just presentdata) (Just referenceddata)
+	return $ StatInfo (Just presentdata) (Just referenceddata) (Just numcopiesstats)
   where
-	initial = (emptyKeyData, emptyKeyData)
-	update matcher key file vs@(presentdata, referenceddata) =
+	initial = (emptyKeyData, emptyKeyData, emptyNumCopiesStats)
+	update matcher key file vs@(presentdata, referenceddata, numcopiesstats) =
 		ifM (matcher $ FileInfo file file)
-			( (,)
+			( (,,)
 				<$> ifM (inAnnex key)
 					( return $ addKey key presentdata
 					, return presentdata
 					)
 				<*> pure (addKey key referenceddata)
+				<*> updateNumCopiesStats key file numcopiesstats
 			, return vs
 			)
 
 emptyKeyData :: KeyData
 emptyKeyData = KeyData 0 0 0 M.empty
 
+emptyNumCopiesStats :: NumCopiesStats
+emptyNumCopiesStats = NumCopiesStats $ M.empty
+
 foldKeys :: [Key] -> KeyData
 foldKeys = foldl' (flip addKey) emptyKeyData
 
@@ -314,6 +346,13 @@ addKey key (KeyData count size unknownsize backends) =
 	!unknownsize' = maybe (unknownsize + 1) (const unknownsize) ks
 	ks = keySize key
 
+updateNumCopiesStats :: Key -> FilePath -> NumCopiesStats -> Annex NumCopiesStats
+updateNumCopiesStats key file stats = do
+	variance <- Variance <$> numCopiesCheck file key (-)
+	return $ stats { numCopiesVarianceMap = update (numCopiesVarianceMap stats) variance }
+  where
+  	update m variance = M.insertWith' (+) variance 1 m
+
 showSizeKeys :: KeyData -> String
 showSizeKeys d = total ++ missingnote
   where
diff --git a/debian/changelog b/debian/changelog
index 26ee074ba..e186f23aa 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -11,6 +11,8 @@ git-annex (4.20130912) UNRELEASED; urgency=low
   * sync: Don't fail if the directory it is run in gets removed by the
     sync.
   * addurl: Fix quvi audodetection, broken in last release.
+  * status: In local mode, displays information about variance from configured
+    numcopies levels.
 
  -- Joey Hess <joeyh@debian.org>  Thu, 12 Sep 2013 12:14:46 -0400
 
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index 3ce7b37f7..8eb633f75 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -577,7 +577,7 @@ subdirectories).
 
   To only show the data that can be gathered quickly, use `--fast`.
 
-  When a directory is specified, shows only an abbreviated status
+  When a directory is specified, shows a differently formatted status
   display for that directory. In this mode, all of the file matching
   options can be used to filter the files that will be included in
   the status.
@@ -586,7 +586,7 @@ subdirectories).
   would first like to see how much disk space that will use.
   Then run:
 
-        	git annex status . --not --in here
+        	git annex status --fast . --not --in here
 
 * `map`