2015-03-20 15:44:46 +00:00
|
|
|
{- git-annex command
|
|
|
|
-
|
2016-02-12 20:43:51 +00:00
|
|
|
- Copyright 2015-2016 Joey Hess <id@joeyh.name>
|
2015-03-20 15:44:46 +00:00
|
|
|
-
|
2019-03-13 19:48:14 +00:00
|
|
|
- Licensed under the GNU AGPL version 3 or higher.
|
2015-03-20 15:44:46 +00:00
|
|
|
-}
|
|
|
|
|
|
|
|
module Command.CheckPresentKey where
|
|
|
|
|
|
|
|
import Command
|
|
|
|
import qualified Remote
|
2020-06-16 17:54:26 +00:00
|
|
|
import Remote.List
|
2023-04-11 18:27:22 +00:00
|
|
|
import Utility.SafeOutput
|
2015-03-20 15:44:46 +00:00
|
|
|
|
2015-07-08 16:33:27 +00:00
|
|
|
cmd :: Command
|
2016-02-12 20:43:51 +00:00
|
|
|
cmd = noCommit $ noMessages $
|
2015-07-08 19:08:02 +00:00
|
|
|
command "checkpresentkey" SectionPlumbing
|
|
|
|
"check if key is present in remote"
|
2016-02-12 20:43:51 +00:00
|
|
|
(paramPair paramKey (paramOptional paramRemote))
|
|
|
|
(seek <$$> optParser)
|
2015-03-20 15:44:46 +00:00
|
|
|
|
2016-02-12 20:43:51 +00:00
|
|
|
data CheckPresentKeyOptions = CheckPresentKeyOptions
|
|
|
|
{ params :: CmdParams
|
|
|
|
, batchOption :: BatchMode
|
|
|
|
}
|
2015-03-20 15:44:46 +00:00
|
|
|
|
2016-02-12 20:43:51 +00:00
|
|
|
optParser :: CmdParamsDesc -> Parser CheckPresentKeyOptions
|
|
|
|
optParser desc = CheckPresentKeyOptions
|
|
|
|
<$> cmdParams desc
|
2021-08-25 18:20:33 +00:00
|
|
|
<*> parseBatchOption False
|
2016-02-12 20:43:51 +00:00
|
|
|
|
|
|
|
seek :: CheckPresentKeyOptions -> CommandSeek
|
|
|
|
seek o = case batchOption o of
|
|
|
|
NoBatch -> case params o of
|
|
|
|
(ks:rn:[]) -> toRemote rn >>= (check ks . Just) >>= exitResult
|
|
|
|
(ks:[]) -> check ks Nothing >>= exitResult
|
|
|
|
_ -> wrongnumparams
|
added -z
Added -z option to git-annex commands that use --batch, useful for
supporting filenames containing newlines.
It only controls input to --batch, the output will still be line delimited
unless --json or etc is used to get some other output. While git often
makes -z affect both input and output, I don't like trying them together,
and making it affect output would have been a significant complication,
and also git-annex output is generally not intended to be machine parsed,
unless using --json or a format option.
Commands that take pairs like "file key" still separate them with a space
in --batch mode. All such commands take care to support filenames with
spaces when parsing that, so there was no need to change it, and it would
have needed significant changes to the batch machinery to separate tose
with a null.
To make fromkey and registerurl support -z, I had to give them a --batch
option. The implicit batch mode they enter when not provided with input
parameters does not support -z as that would have complicated option
parsing. Seemed better to move these toward using the same --batch as
everything else, though the implicit batch mode can still be used.
This commit was sponsored by Ole-Morten Duesund on Patreon.
2018-09-20 20:09:21 +00:00
|
|
|
Batch fmt -> do
|
2016-02-12 20:43:51 +00:00
|
|
|
checker <- case params o of
|
|
|
|
(rn:[]) -> toRemote rn >>= \r -> return (flip check (Just r))
|
|
|
|
[] -> return (flip check Nothing)
|
|
|
|
_ -> wrongnumparams
|
2020-09-14 20:49:33 +00:00
|
|
|
batchInput fmt (pure . Right) $
|
|
|
|
checker . snd >=> batchResult
|
2016-02-12 20:43:51 +00:00
|
|
|
where
|
2016-11-16 01:29:54 +00:00
|
|
|
wrongnumparams = giveup "Wrong number of parameters"
|
2016-02-12 20:43:51 +00:00
|
|
|
|
|
|
|
data Result = Present | NotPresent | CheckFailure String
|
|
|
|
|
|
|
|
check :: String -> Maybe Remote -> Annex Result
|
|
|
|
check ks mr = case mr of
|
|
|
|
Just r -> go Nothing [r]
|
2020-06-16 17:54:26 +00:00
|
|
|
Nothing -> do
|
2023-11-30 19:11:57 +00:00
|
|
|
mostlikely <- Remote.keyPossibilities (Remote.IncludeIgnored False) k
|
2020-06-16 17:54:26 +00:00
|
|
|
otherremotes <- flip Remote.remotesWithoutUUID
|
|
|
|
(map Remote.uuid mostlikely)
|
|
|
|
<$> remoteList
|
|
|
|
go Nothing (mostlikely ++ otherremotes)
|
2015-03-20 15:44:46 +00:00
|
|
|
where
|
2016-02-12 20:43:51 +00:00
|
|
|
k = toKey ks
|
|
|
|
go Nothing [] = return NotPresent
|
|
|
|
go (Just e) [] = return $ CheckFailure e
|
2017-12-05 19:00:50 +00:00
|
|
|
go olderr (r:rs) = Remote.hasKey r k >>= \case
|
|
|
|
Right True -> return Present
|
|
|
|
Right False -> go olderr rs
|
|
|
|
Left e -> go (Just e) rs
|
2016-02-12 20:43:51 +00:00
|
|
|
|
|
|
|
exitResult :: Result -> Annex a
|
|
|
|
exitResult Present = liftIO exitSuccess
|
|
|
|
exitResult NotPresent = liftIO exitFailure
|
|
|
|
exitResult (CheckFailure msg) = liftIO $ do
|
2023-04-11 18:27:22 +00:00
|
|
|
hPutStrLn stderr (safeOutput msg)
|
2016-02-12 20:43:51 +00:00
|
|
|
exitWith $ ExitFailure 100
|
|
|
|
|
|
|
|
batchResult :: Result -> Annex ()
|
|
|
|
batchResult Present = liftIO $ putStrLn "1"
|
2016-02-12 20:48:03 +00:00
|
|
|
batchResult _ = liftIO $ putStrLn "0"
|
2016-02-12 20:43:51 +00:00
|
|
|
|
|
|
|
toKey :: String -> Key
|
2019-01-14 17:17:47 +00:00
|
|
|
toKey = fromMaybe (giveup "Bad key") . deserializeKey
|
2016-02-12 20:43:51 +00:00
|
|
|
|
|
|
|
toRemote :: String -> Annex Remote
|
2016-11-16 01:29:54 +00:00
|
|
|
toRemote rn = maybe (giveup "Unknown remote") return
|
2016-02-12 20:43:51 +00:00
|
|
|
=<< Remote.byNameWithUUID (Just rn)
|