2010-11-02 23:04:24 +00:00
|
|
|
{- git-annex command
|
|
|
|
-
|
2016-03-06 16:45:57 +00:00
|
|
|
- Copyright 2010,2016 Joey Hess <id@joeyh.name>
|
2010-11-02 23:04:24 +00:00
|
|
|
-
|
|
|
|
- Licensed under the GNU GPL version 3 or higher.
|
|
|
|
-}
|
|
|
|
|
|
|
|
module Command.DropKey where
|
|
|
|
|
|
|
|
import Command
|
|
|
|
import qualified Annex
|
2011-10-15 20:21:08 +00:00
|
|
|
import Logs.Location
|
2011-10-04 04:40:47 +00:00
|
|
|
import Annex.Content
|
2010-11-02 23:04:24 +00:00
|
|
|
|
2015-07-08 16:33:27 +00:00
|
|
|
cmd :: Command
|
2018-02-19 18:28:17 +00:00
|
|
|
cmd = noCommit $ withGlobalOptions [jsonOptions] $
|
2015-07-08 19:08:02 +00:00
|
|
|
command "dropkey" SectionPlumbing
|
|
|
|
"drops annexed content for specified keys"
|
|
|
|
(paramRepeating paramKey)
|
2016-03-06 16:45:57 +00:00
|
|
|
(seek <$$> optParser)
|
2010-12-30 19:06:26 +00:00
|
|
|
|
2016-03-06 16:45:57 +00:00
|
|
|
data DropKeyOptions = DropKeyOptions
|
|
|
|
{ toDrop :: [String]
|
|
|
|
, batchOption :: BatchMode
|
|
|
|
}
|
2010-11-11 22:54:52 +00:00
|
|
|
|
2016-03-06 16:45:57 +00:00
|
|
|
optParser :: CmdParamsDesc -> Parser DropKeyOptions
|
|
|
|
optParser desc = DropKeyOptions
|
|
|
|
<$> cmdParams desc
|
|
|
|
<*> parseBatchOption
|
|
|
|
|
|
|
|
seek :: DropKeyOptions -> CommandSeek
|
|
|
|
seek o = do
|
2011-12-09 16:23:45 +00:00
|
|
|
unlessM (Annex.getState Annex.force) $
|
2016-11-16 01:29:54 +00:00
|
|
|
giveup "dropkey can cause data loss; use --force if you're sure you want to do this"
|
2018-10-01 18:12:06 +00:00
|
|
|
withKeys (commandAction . start) (toDrop o)
|
2016-03-06 16:45:57 +00:00
|
|
|
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 parsekey $ batchCommandAction . start
|
2016-03-06 16:45:57 +00:00
|
|
|
NoBatch -> noop
|
|
|
|
where
|
2019-01-14 17:17:47 +00:00
|
|
|
parsekey = maybe (Left "bad key") Right . deserializeKey
|
2016-03-06 16:45:57 +00:00
|
|
|
|
|
|
|
start :: Key -> CommandStart
|
|
|
|
start key = do
|
2017-11-28 18:40:26 +00:00
|
|
|
showStartKey "dropkey" key (mkActionItem key)
|
2011-12-09 16:23:45 +00:00
|
|
|
next $ perform key
|
2010-11-02 23:04:24 +00:00
|
|
|
|
2010-12-30 18:19:16 +00:00
|
|
|
perform :: Key -> CommandPerform
|
2016-03-06 16:45:57 +00:00
|
|
|
perform key = ifM (inAnnex key)
|
|
|
|
( lockContentForRemoval key $ \contentlock -> do
|
|
|
|
removeAnnex contentlock
|
|
|
|
next $ cleanup key
|
|
|
|
, next $ return True
|
|
|
|
)
|
2010-11-02 23:04:24 +00:00
|
|
|
|
2010-12-30 18:19:16 +00:00
|
|
|
cleanup :: Key -> CommandCleanup
|
2010-11-02 23:04:24 +00:00
|
|
|
cleanup key = do
|
2011-07-01 19:24:07 +00:00
|
|
|
logStatus key InfoMissing
|
2010-11-02 23:04:24 +00:00
|
|
|
return True
|