{- git-annex command
-
- - Copyright 2013 Joey Hess <id@joeyh.name>
+ - Copyright 2013-2020 Joey Hess <id@joeyh.name>
-
- Licensed under the GNU AGPL version 3 or higher.
-}
import qualified Utility.Format
import Command.Find (parseFormatOption, showFormatted, keyVars)
import Annex.Link
+import Backend
+import Types.Backend
+import Types.Key
+
+import Data.Char
+import qualified Data.ByteString as B
cmd :: Command
cmd = noCommit $ noMessages $ dontCheck repoExists $
command "examinekey" SectionPlumbing
"prints information from a key"
(paramRepeating paramKey)
- (batchable run (optional parseFormatOption))
+ (batchable run optParser)
+
+data ExamineOptions = ExamineOptions
+ { format :: Maybe Utility.Format.Format
+ , migrateToBackend :: Maybe (DeferredParse Backend)
+ , associatedFile :: AssociatedFile
+ }
-run :: Maybe Utility.Format.Format -> SeekInput -> String -> Annex Bool
-run format _ p = do
- let k = fromMaybe (giveup "bad key") $ deserializeKey p
+optParser :: Parser ExamineOptions
+optParser = ExamineOptions
+ <$> optional parseFormatOption
+ <*> (fmap (DeferredParse . tobackend) <$> migrateopt)
+ <*> (AssociatedFile <$> fileopt)
+ where
+ fileopt = optional $ strOption
+ ( long "filename" <> metavar paramFile
+ <> help "file associated with the key"
+ )
+ migrateopt = optional $ strOption
+ ( long "migrate-to-backend" <> metavar paramName
+ <> help "migrate key to other backend when possible"
+ )
+ tobackend = lookupBackendVariety . parseKeyVariety . encodeBS
+
+run :: ExamineOptions -> SeekInput -> String -> Annex Bool
+run o _ input = do
+ k <- getkey
+
objectpath <- calcRepo $ gitAnnexLocation k
let objectpointer = formatPointer k
- showFormatted format (serializeKey' k) $
+ showFormatted (format o) (serializeKey' k) $
[ ("objectpath", fromRawFilePath objectpath)
, ("objectpointer", fromRawFilePath objectpointer)
] ++ keyVars k
return True
+ where
+ -- Parse the input, which is either a key, or in batch mode
+ -- can be "key filename"
+ (ikb, ifb) = B.break (== (fromIntegral (ord ' '))) (toRawFilePath input)
+ ifb' = B.drop 1 ifb
+ ik = fromMaybe (giveup "bad key") (deserializeKey' ikb)
+ af = if B.null ifb'
+ then associatedFile o
+ else AssociatedFile (Just ifb')
+
+ getkey = case migrateToBackend o of
+ Nothing -> pure ik
+ Just v -> getParsed v >>= \b ->
+ maybeLookupBackendVariety (fromKey keyVariety ik) >>= \case
+ Just ib -> case fastMigrate ib of
+ Just fm -> fromMaybe ik <$> fm ik b af
+ Nothing -> pure ik
+ Nothing -> pure ik
Messages that would normally be output to standard error are included in
the json instead.
+* `--migrate-to-backend=backend`
+
+ Attempt to migrate the input key to the new backend specified. If
+ successful, outputs information about the migrated key. Otherwise,
+ outputs information about the input key.
+
+ This only does fast migrations; it will not re-hash the content of a key
+ or similar expensive operation.
+
+ One way to use it is to add an extension to a key.
+
+ git-annex examinekey SHA256--xxx --migrate-to-backend=SHA256E --filename=foo.tar.gz
+
+ Or to remove the extension from a key:
+
+ git-annex examinekey SHA256E-xxx.tar.gz --migrate-to-backend=SHA256
+
+* `--filename=name`
+
+ The name of a file associated with the key, eg a work tree file.
+ It does not need to exist. This is needed when using `--migrate-to-backend`
+ to add an extension to the key.
+
* `--batch`
Enable batch mode, in which a line containing a key is read from stdin,
the information about it is output to stdout, and repeat.
+ In order to also provide the name of a file associated with the key, the
+ line can be in the format "$key $file"
+
# SEE ALSO
[[git-annex]](1)
projects / git-annex.git / commitdiff