2014-12-29 19:16:40 +00:00
|
|
|
{- git-annex command
|
|
|
|
-
|
2015-01-21 16:50:09 +00:00
|
|
|
- Copyright 2014 Joey Hess <id@joeyh.name>
|
2014-12-29 19:16:40 +00:00
|
|
|
-
|
2019-03-13 19:48:14 +00:00
|
|
|
- Licensed under the GNU AGPL version 3 or higher.
|
2014-12-29 19:16:40 +00:00
|
|
|
-}
|
|
|
|
|
|
|
|
module Command.SetPresentKey where
|
|
|
|
|
|
|
|
import Command
|
|
|
|
import Logs.Location
|
|
|
|
import Logs.Presence.Pure
|
|
|
|
|
2015-07-08 16:33:27 +00:00
|
|
|
cmd :: Command
|
2015-07-08 19:08:02 +00:00
|
|
|
cmd = noCommit $
|
|
|
|
command "setpresentkey" SectionPlumbing
|
|
|
|
"change records of where key is present"
|
|
|
|
(paramPair paramKey (paramPair paramUUID "[1|0]"))
|
2018-05-27 18:56:14 +00:00
|
|
|
(seek <$$> optParser)
|
2014-12-29 19:16:40 +00:00
|
|
|
|
2018-05-27 18:56:14 +00:00
|
|
|
data SetPresentKeyOptions = SetPresentKeyOptions
|
|
|
|
{ params :: CmdParams
|
|
|
|
, batchOption :: BatchMode
|
|
|
|
}
|
2014-12-29 19:16:40 +00:00
|
|
|
|
2018-05-27 18:56:14 +00:00
|
|
|
optParser :: CmdParamsDesc -> Parser SetPresentKeyOptions
|
|
|
|
optParser desc = SetPresentKeyOptions
|
|
|
|
<$> cmdParams desc
|
|
|
|
<*> parseBatchOption
|
|
|
|
|
|
|
|
seek :: SetPresentKeyOptions -> CommandSeek
|
|
|
|
seek o = case batchOption o of
|
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 -> batchInput fmt
|
2018-05-27 18:56:14 +00:00
|
|
|
(parseKeyStatus . words)
|
|
|
|
(batchCommandAction . start)
|
|
|
|
NoBatch -> either giveup (commandAction . start)
|
|
|
|
(parseKeyStatus $ params o)
|
|
|
|
|
|
|
|
data KeyStatus = KeyStatus Key UUID LogStatus
|
|
|
|
|
|
|
|
parseKeyStatus :: [String] -> Either String KeyStatus
|
|
|
|
parseKeyStatus (ks:us:vs:[]) = do
|
2019-01-14 17:17:47 +00:00
|
|
|
k <- maybe (Left "bad key") Right (deserializeKey ks)
|
2018-05-27 18:56:14 +00:00
|
|
|
let u = toUUID us
|
|
|
|
s <- maybe (Left "bad value") Right (parseStatus vs)
|
|
|
|
return $ KeyStatus k u s
|
|
|
|
parseKeyStatus _ = Left "Bad input. Expected: key uuid value"
|
|
|
|
|
|
|
|
start :: KeyStatus -> CommandStart
|
make CommandStart return a StartMessage
The goal is to be able to run CommandStart in the main thread when -J is
used, rather than unncessarily passing it off to a worker thread, which
incurs overhead that is signficant when the CommandStart is going to
quickly decide to stop.
To do that, the message it displays needs to be displayed in the worker
thread, after the CommandStart has run.
Also, the change will mean that CommandStart will no longer necessarily
run with the same Annex state as CommandPerform. While its docs already
said it should avoid modifying Annex state, I audited all the
CommandStart code as part of the conversion. (Note that CommandSeek
already sometimes runs with a different Annex state, and that has not been
a source of any problems, so I am not too worried that this change will
lead to breakage going forward.)
The only modification of Annex state I found was it calling
allowMessages in some Commands that default to noMessages. Dealt with
that by adding a startCustomOutput and a startingUsualMessages.
This lets a command start with noMessages and then select the output it
wants for each CommandStart.
One bit of breakage: onlyActionOn has been removed from commands that used it.
The plan is that, since a StartMessage contains an ActionItem,
when a Key can be extracted from that, the parallel job runner can
run onlyActionOn' automatically. Then commands won't need to worry about
this detail. Future work.
Otherwise, this was a fairly straightforward process of making each
CommandStart compile again. Hopefully other behavior changes were mostly
avoided.
In a few cases, a command had a CommandStart that called a CommandPerform
that then called showStart multiple times. I have collapsed those
down to a single start action. The main command to perhaps suffer from it
is Command.Direct, which used to show a start for each file, and no
longer does.
Another minor behavior change is that some commands used showStart
before, but had an associated file and a Key available, so were changed
to ShowStart with an ActionItemAssociatedFile. That will not change the
normal output or behavior, but --json output will now include the key.
This should not break it for anyone using a real json parser.
2019-06-06 19:42:30 +00:00
|
|
|
start (KeyStatus k u s) = starting "setpresentkey" (mkActionItem k) $
|
|
|
|
perform k u s
|
2014-12-29 19:16:40 +00:00
|
|
|
|
|
|
|
perform :: Key -> UUID -> LogStatus -> CommandPerform
|
2014-12-29 19:35:14 +00:00
|
|
|
perform k u s = next $ do
|
|
|
|
logChange k u s
|
2014-12-29 19:16:40 +00:00
|
|
|
return True
|