1d1054faa6
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.
117 lines
3.6 KiB
Haskell
117 lines
3.6 KiB
Haskell
{- git-annex command
|
|
-
|
|
- Copyright 2010, 2013 Joey Hess <id@joeyh.name>
|
|
-
|
|
- Licensed under the GNU GPL version 3 or higher.
|
|
-}
|
|
|
|
module Command.Get where
|
|
|
|
import Command
|
|
import qualified Remote
|
|
import Annex.Content
|
|
import Annex.Transfer
|
|
import Annex.NumCopies
|
|
import Annex.Wanted
|
|
import qualified Command.Move
|
|
|
|
cmd :: Command
|
|
cmd = withGlobalOptions [jobsOption, jsonOptions, jsonProgressOption, annexedMatchingOptions] $
|
|
command "get" SectionCommon
|
|
"make content of annexed files available"
|
|
paramPaths (seek <$$> optParser)
|
|
|
|
data GetOptions = GetOptions
|
|
{ getFiles :: CmdParams
|
|
, getFrom :: Maybe (DeferredParse Remote)
|
|
, autoMode :: Bool
|
|
, keyOptions :: Maybe KeyOptions
|
|
, batchOption :: BatchMode
|
|
}
|
|
|
|
optParser :: CmdParamsDesc -> Parser GetOptions
|
|
optParser desc = GetOptions
|
|
<$> cmdParams desc
|
|
<*> optional (parseRemoteOption <$> parseFromOption)
|
|
<*> parseAutoOption
|
|
<*> optional (parseIncompleteOption <|> parseKeyOptions <|> parseFailedTransfersOption)
|
|
<*> parseBatchOption
|
|
|
|
seek :: GetOptions -> CommandSeek
|
|
seek o = allowConcurrentOutput $ do
|
|
from <- maybe (pure Nothing) (Just <$$> getParsed) (getFrom o)
|
|
let go = whenAnnexed $ start o from
|
|
case batchOption o of
|
|
Batch fmt -> batchFilesMatching fmt go
|
|
NoBatch -> withKeyOptions (keyOptions o) (autoMode o)
|
|
(startKeys from)
|
|
(withFilesInGit go)
|
|
=<< workTreeItems (getFiles o)
|
|
|
|
start :: GetOptions -> Maybe Remote -> FilePath -> Key -> CommandStart
|
|
start o from file key = start' expensivecheck from key afile (mkActionItem afile)
|
|
where
|
|
afile = AssociatedFile (Just file)
|
|
expensivecheck
|
|
| autoMode o = numCopiesCheck file key (<)
|
|
<||> wantGet False (Just key) afile
|
|
| otherwise = return True
|
|
|
|
startKeys :: Maybe Remote -> Key -> ActionItem -> CommandStart
|
|
startKeys from key ai = checkFailedTransferDirection ai Download $
|
|
start' (return True) from key (AssociatedFile Nothing) ai
|
|
|
|
start' :: Annex Bool -> Maybe Remote -> Key -> AssociatedFile -> ActionItem -> CommandStart
|
|
start' expensivecheck from key afile ai = onlyActionOn key $
|
|
stopUnless (not <$> inAnnex key) $ stopUnless expensivecheck $
|
|
case from of
|
|
Nothing -> go $ perform key afile
|
|
Just src ->
|
|
stopUnless (Command.Move.fromOk src key) $
|
|
go $ Command.Move.fromPerform src Command.Move.RemoveNever key afile
|
|
where
|
|
go a = do
|
|
showStartKey "get" key ai
|
|
next a
|
|
|
|
perform :: Key -> AssociatedFile -> CommandPerform
|
|
perform key afile = stopUnless (getKey key afile) $
|
|
next $ return True -- no cleanup needed
|
|
|
|
{- Try to find a copy of the file in one of the remotes,
|
|
- and copy it to here. -}
|
|
getKey :: Key -> AssociatedFile -> Annex Bool
|
|
getKey key afile = getKey' key afile =<< Remote.keyPossibilities key
|
|
|
|
getKey' :: Key -> AssociatedFile -> [Remote] -> Annex Bool
|
|
getKey' key afile = dispatch
|
|
where
|
|
dispatch [] = do
|
|
showNote "not available"
|
|
showlocs
|
|
return False
|
|
dispatch remotes = notifyTransfer Download afile $ \witness -> do
|
|
ok <- pickRemote remotes $ \r -> ifM (probablyPresent r)
|
|
( docopy r witness
|
|
, return False
|
|
)
|
|
if ok
|
|
then return ok
|
|
else do
|
|
Remote.showTriedRemotes remotes
|
|
showlocs
|
|
return False
|
|
showlocs = Remote.showLocations False key []
|
|
"No other repository is known to contain the file."
|
|
-- This check is to avoid an ugly message if a remote is a
|
|
-- drive that is not mounted.
|
|
probablyPresent r
|
|
| Remote.hasKeyCheap r =
|
|
either (const False) id <$> Remote.hasKey r key
|
|
| otherwise = return True
|
|
docopy r witness = getViaTmp (Remote.retrievalSecurityPolicy r) (RemoteVerify r) key $ \dest ->
|
|
download (Remote.uuid r) key afile stdRetry
|
|
(\p -> do
|
|
showAction $ "from " ++ Remote.name r
|
|
Remote.retrieveKeyFile r key afile dest p
|
|
) witness
|