2013-12-19 20:48:55 +00:00
|
|
|
{- git-annex plumbing command (for use by old assistant, and users)
|
2012-08-24 21:23:58 +00:00
|
|
|
-
|
2015-01-21 16:50:09 +00:00
|
|
|
- Copyright 2012 Joey Hess <id@joeyh.name>
|
2012-08-24 21:23:58 +00:00
|
|
|
-
|
2019-03-13 19:48:14 +00:00
|
|
|
- Licensed under the GNU AGPL version 3 or higher.
|
2012-08-24 21:23:58 +00:00
|
|
|
-}
|
|
|
|
|
|
|
|
module Command.TransferKey where
|
|
|
|
|
|
|
|
import Command
|
|
|
|
import Annex.Content
|
|
|
|
import Logs.Location
|
2014-03-22 14:42:38 +00:00
|
|
|
import Annex.Transfer
|
2012-08-24 21:23:58 +00:00
|
|
|
import qualified Remote
|
|
|
|
import Types.Remote
|
|
|
|
|
2015-07-08 16:33:27 +00:00
|
|
|
cmd :: Command
|
2015-07-09 20:05:45 +00:00
|
|
|
cmd = noCommit $
|
2015-07-08 19:08:02 +00:00
|
|
|
command "transferkey" SectionPlumbing
|
2015-07-08 16:33:27 +00:00
|
|
|
"transfers a key from or to a remote"
|
2015-07-09 20:05:45 +00:00
|
|
|
paramKey (seek <--< optParser)
|
|
|
|
|
|
|
|
data TransferKeyOptions = TransferKeyOptions
|
|
|
|
{ keyOptions :: CmdParams
|
|
|
|
, fromToOptions :: FromToOptions
|
|
|
|
, fileOption :: AssociatedFile
|
|
|
|
}
|
|
|
|
|
|
|
|
optParser :: CmdParamsDesc -> Parser TransferKeyOptions
|
|
|
|
optParser desc = TransferKeyOptions
|
|
|
|
<$> cmdParams desc
|
|
|
|
<*> parseFromToOptions
|
2017-03-10 17:12:24 +00:00
|
|
|
<*> (AssociatedFile <$> optional (strOption
|
2015-07-09 20:05:45 +00:00
|
|
|
( long "file" <> metavar paramFile
|
|
|
|
<> help "the associated file"
|
2017-03-10 17:12:24 +00:00
|
|
|
)))
|
2015-07-09 20:05:45 +00:00
|
|
|
|
|
|
|
instance DeferredParseClass TransferKeyOptions where
|
|
|
|
finishParse v = TransferKeyOptions
|
|
|
|
<$> pure (keyOptions v)
|
|
|
|
<*> finishParse (fromToOptions v)
|
|
|
|
<*> pure (fileOption v)
|
|
|
|
|
|
|
|
seek :: TransferKeyOptions -> CommandSeek
|
2018-10-01 18:12:06 +00:00
|
|
|
seek o = withKeys (commandAction . start o) (keyOptions o)
|
2015-07-09 20:05:45 +00:00
|
|
|
|
2020-09-14 20:49:33 +00:00
|
|
|
start :: TransferKeyOptions -> (SeekInput, Key) -> CommandStart
|
|
|
|
start o (_, key) = startingCustomOutput key $ case fromToOptions o of
|
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
|
|
|
ToRemote dest -> toPerform key (fileOption o) =<< getParsed dest
|
|
|
|
FromRemote src -> fromPerform key (fileOption o) =<< getParsed src
|
2015-07-09 20:05:45 +00:00
|
|
|
|
|
|
|
toPerform :: Key -> AssociatedFile -> Remote -> CommandPerform
|
2024-07-01 14:42:27 +00:00
|
|
|
toPerform key af remote = go Upload af $
|
|
|
|
upload' (uuid remote) key af Nothing stdRetry $ \p -> do
|
|
|
|
tryNonAsync (Remote.storeKey remote key af Nothing p) >>= \case
|
2020-05-13 18:03:00 +00:00
|
|
|
Right () -> do
|
2024-08-23 20:35:12 +00:00
|
|
|
Remote.logStatus NoLiveUpdate remote key InfoPresent
|
2020-05-13 18:03:00 +00:00
|
|
|
return True
|
2020-05-13 21:05:56 +00:00
|
|
|
Left e -> do
|
filter out control characters in warning messages
Converted warning and similar to use StringContainingQuotedPath. Most
warnings are static strings, some do refer to filepaths that need to be
quoted, and others don't need quoting.
Note that, since quote filters out control characters of even
UnquotedString, this makes all warnings safe, even when an attacker
sneaks in a control character in some other way.
When json is being output, no quoting is done, since json gets its own
quoting.
This does, as a side effect, make warning messages in json output not
be indented. The indentation is only needed to offset warning messages
underneath the display of the file they apply to, so that's ok.
Sponsored-by: Brett Eisenberg on Patreon
2023-04-10 18:47:32 +00:00
|
|
|
warning (UnquotedString (show e))
|
2020-05-13 21:05:56 +00:00
|
|
|
return False
|
2012-08-24 21:23:58 +00:00
|
|
|
|
2015-07-09 20:05:45 +00:00
|
|
|
fromPerform :: Key -> AssociatedFile -> Remote -> CommandPerform
|
2024-07-01 14:42:27 +00:00
|
|
|
fromPerform key af remote = go Upload af $
|
|
|
|
download' (uuid remote) key af Nothing stdRetry $ \p ->
|
2024-08-23 20:35:12 +00:00
|
|
|
logStatusAfter NoLiveUpdate key $ getViaTmp (retrievalSecurityPolicy remote) vc key af Nothing $ \t ->
|
2024-07-01 14:42:27 +00:00
|
|
|
tryNonAsync (Remote.retrieveKeyFile remote key af (fromRawFilePath t) p vc) >>= \case
|
2020-05-13 21:05:56 +00:00
|
|
|
Right v -> return (True, v)
|
|
|
|
Left e -> do
|
filter out control characters in warning messages
Converted warning and similar to use StringContainingQuotedPath. Most
warnings are static strings, some do refer to filepaths that need to be
quoted, and others don't need quoting.
Note that, since quote filters out control characters of even
UnquotedString, this makes all warnings safe, even when an attacker
sneaks in a control character in some other way.
When json is being output, no quoting is done, since json gets its own
quoting.
This does, as a side effect, make warning messages in json output not
be indented. The indentation is only needed to offset warning messages
underneath the display of the file they apply to, so that's ok.
Sponsored-by: Brett Eisenberg on Patreon
2023-04-10 18:47:32 +00:00
|
|
|
warning (UnquotedString (show e))
|
2020-05-13 21:05:56 +00:00
|
|
|
return (False, UnVerified)
|
2021-08-17 16:41:36 +00:00
|
|
|
where
|
|
|
|
vc = RemoteVerify remote
|
2012-09-24 17:36:05 +00:00
|
|
|
|
2014-03-22 14:42:38 +00:00
|
|
|
go :: Direction -> AssociatedFile -> (NotifyWitness -> Annex Bool) -> CommandPerform
|
|
|
|
go direction file a = notifyTransfer direction file a >>= liftIO . exitBool
|