3290a09a70
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
552 lines
16 KiB
Haskell
552 lines
16 KiB
Haskell
{- git-annex command-line option parsing
|
|
-
|
|
- Copyright 2010-2023 Joey Hess <id@joeyh.name>
|
|
-
|
|
- Licensed under the GNU AGPL version 3 or higher.
|
|
-}
|
|
|
|
{-# LANGUAGE TypeSynonymInstances, FlexibleInstances, OverloadedStrings #-}
|
|
|
|
module CmdLine.GitAnnex.Options where
|
|
|
|
import Control.Monad.Fail as Fail (MonadFail(..))
|
|
import Options.Applicative
|
|
import Data.Time.Clock.POSIX
|
|
import Control.Concurrent.STM
|
|
import qualified Data.Map as M
|
|
|
|
import Annex.Common
|
|
import qualified Git.Config
|
|
import qualified Git.Construct
|
|
import Git.Remote
|
|
import Git.Types
|
|
import Types.Key
|
|
import Types.TrustLevel
|
|
import Types.NumCopies
|
|
import Types.Messages
|
|
import Types.Command
|
|
import Types.DeferredParse
|
|
import Types.DesktopNotify
|
|
import Types.Concurrency
|
|
import qualified Annex
|
|
import qualified Remote
|
|
import qualified Limit
|
|
import qualified Limit.Wanted
|
|
import CmdLine.Option
|
|
import CmdLine.Usage
|
|
import CmdLine.AnnexSetter
|
|
import qualified Backend
|
|
import qualified Types.Backend as Backend
|
|
import Utility.HumanTime
|
|
import Utility.DataUnits
|
|
import Annex.Concurrent
|
|
|
|
-- Options that are accepted by all git-annex sub-commands,
|
|
-- although not always used.
|
|
gitAnnexCommonOptions :: [AnnexOption]
|
|
gitAnnexCommonOptions = commonOptions ++
|
|
[ annexOption setnumcopies $ option auto
|
|
( long "numcopies" <> short 'N' <> metavar paramNumber
|
|
<> help "override desired number of copies"
|
|
<> hidden
|
|
)
|
|
, annexOption setmincopies $ option auto
|
|
( long "mincopies" <> short 'N' <> metavar paramNumber
|
|
<> help "override minimum number of copies"
|
|
<> hidden
|
|
)
|
|
, annexOption (setAnnexState . Remote.forceTrust Trusted) $ strOption
|
|
( long "trust" <> metavar paramRemote
|
|
<> help "deprecated, does not override trust setting"
|
|
<> hidden
|
|
<> completeRemotes
|
|
)
|
|
, annexOption (setAnnexState . Remote.forceTrust SemiTrusted) $ strOption
|
|
( long "semitrust" <> metavar paramRemote
|
|
<> help "override trust setting back to default"
|
|
<> hidden
|
|
<> completeRemotes
|
|
)
|
|
, annexOption (setAnnexState . Remote.forceTrust UnTrusted) $ strOption
|
|
( long "untrust" <> metavar paramRemote
|
|
<> help "override trust setting to untrusted"
|
|
<> hidden
|
|
<> completeRemotes
|
|
)
|
|
, annexOption (setAnnexState . setgitconfig) $ strOption
|
|
( long "config" <> short 'c' <> metavar "NAME=VALUE"
|
|
<> help "override git configuration setting"
|
|
<> hidden
|
|
)
|
|
, annexOption setuseragent $ strOption
|
|
( long "user-agent" <> metavar paramName
|
|
<> help "override default User-Agent"
|
|
<> hidden
|
|
)
|
|
, annexFlag (setAnnexState $ toplevelWarning False "--trust-glacier no longer has any effect")
|
|
( long "trust-glacier"
|
|
<> help "deprecated, does not trust Amazon Glacier inventory"
|
|
<> hidden
|
|
)
|
|
, annexFlag (setdesktopnotify mkNotifyFinish)
|
|
( long "notify-finish"
|
|
<> help "show desktop notification after transfer finishes"
|
|
<> hidden
|
|
)
|
|
, annexFlag (setdesktopnotify mkNotifyStart)
|
|
( long "notify-start"
|
|
<> help "show desktop notification after transfer starts"
|
|
<> hidden
|
|
)
|
|
]
|
|
where
|
|
setnumcopies n = setAnnexRead $ \rd -> rd { Annex.forcenumcopies = Just $ configuredNumCopies n }
|
|
setmincopies n = setAnnexRead $ \rd -> rd { Annex.forcemincopies = Just $ configuredMinCopies n }
|
|
setuseragent v = setAnnexRead $ \rd -> rd { Annex.useragent = Just v }
|
|
setdesktopnotify v = setAnnexRead $ \rd -> rd { Annex.desktopnotify = Annex.desktopnotify rd <> v }
|
|
setgitconfig v = Annex.addGitConfigOverride v
|
|
|
|
{- Parser that accepts all non-option params. -}
|
|
cmdParams :: CmdParamsDesc -> Parser CmdParams
|
|
cmdParams paramdesc = many $ argument str
|
|
( metavar paramdesc
|
|
<> action "file"
|
|
)
|
|
|
|
parseAutoOption :: Parser Bool
|
|
parseAutoOption = switch
|
|
( long "auto" <> short 'a'
|
|
<> help "automatic mode"
|
|
)
|
|
|
|
mkParseRemoteOption :: RemoteName -> DeferredParse Remote
|
|
mkParseRemoteOption = DeferredParse
|
|
. (fromJust <$$> Remote.byNameWithUUID)
|
|
. Just
|
|
|
|
parseUUIDOption :: String -> DeferredParse UUID
|
|
parseUUIDOption = DeferredParse
|
|
. (Remote.nameToUUID)
|
|
|
|
parseDryRunOption :: Parser DryRun
|
|
parseDryRunOption = DryRun <$> switch
|
|
( long "dry-run"
|
|
<> help "don't make changes, but show what would be done"
|
|
)
|
|
|
|
-- | From or To a remote but not both.
|
|
data FromToOptions
|
|
= FromRemote (DeferredParse Remote)
|
|
| ToRemote (DeferredParse Remote)
|
|
|
|
instance DeferredParseClass FromToOptions where
|
|
finishParse (FromRemote v) = FromRemote <$> finishParse v
|
|
finishParse (ToRemote v) = ToRemote <$> finishParse v
|
|
|
|
parseFromToOptions :: Parser FromToOptions
|
|
parseFromToOptions =
|
|
(FromRemote . mkParseRemoteOption <$> parseFromOption)
|
|
<|> (ToRemote . mkParseRemoteOption <$> parseToOption)
|
|
|
|
parseFromOption :: Parser RemoteName
|
|
parseFromOption = strOption
|
|
( long "from" <> short 'f' <> metavar paramRemote
|
|
<> help "source remote"
|
|
<> completeRemotes
|
|
)
|
|
|
|
parseToOption :: Parser RemoteName
|
|
parseToOption = strOption
|
|
( long "to" <> short 't' <> metavar paramRemote
|
|
<> help "destination remote"
|
|
<> completeRemotes
|
|
)
|
|
|
|
parseRemoteOption :: Parser RemoteName
|
|
parseRemoteOption = strOption
|
|
( long "remote" <> metavar paramRemote
|
|
<> completeRemotes
|
|
)
|
|
|
|
-- | From or to a remote, or both, or a special --to=here
|
|
data FromToHereOptions
|
|
= FromOrToRemote FromToOptions
|
|
| ToHere
|
|
| FromRemoteToRemote (DeferredParse Remote) (DeferredParse Remote)
|
|
|
|
parseFromToHereOptions :: Parser (Maybe FromToHereOptions)
|
|
parseFromToHereOptions = go
|
|
<$> optional parseFromOption
|
|
<*> optional parseToOption
|
|
where
|
|
go (Just from) (Just to) = Just $ FromRemoteToRemote
|
|
(mkParseRemoteOption from)
|
|
(mkParseRemoteOption to)
|
|
go (Just from) Nothing = Just $ FromOrToRemote
|
|
(FromRemote $ mkParseRemoteOption from)
|
|
go Nothing (Just to) = Just $ case to of
|
|
"here" -> ToHere
|
|
"." -> ToHere
|
|
_ -> FromOrToRemote $ ToRemote $ mkParseRemoteOption to
|
|
go Nothing Nothing = Nothing
|
|
|
|
instance DeferredParseClass FromToHereOptions where
|
|
finishParse (FromOrToRemote v) = FromOrToRemote <$> finishParse v
|
|
finishParse ToHere = pure ToHere
|
|
finishParse (FromRemoteToRemote v1 v2) = FromRemoteToRemote
|
|
<$> finishParse v1
|
|
<*> finishParse v2
|
|
|
|
-- Options for acting on keys, rather than work tree files.
|
|
data KeyOptions
|
|
= WantAllKeys
|
|
| WantUnusedKeys
|
|
| WantFailedTransfers
|
|
| WantSpecificKey Key
|
|
| WantIncompleteKeys
|
|
| WantBranchKeys [Branch]
|
|
|
|
parseKeyOptions :: Parser KeyOptions
|
|
parseKeyOptions = parseAllOption
|
|
<|> parseBranchKeysOption
|
|
<|> parseUnusedKeysOption
|
|
<|> parseSpecificKeyOption
|
|
|
|
parseUnusedKeysOption :: Parser KeyOptions
|
|
parseUnusedKeysOption = flag' WantUnusedKeys
|
|
( long "unused" <> short 'U'
|
|
<> help "operate on files found by last run of git-annex unused"
|
|
)
|
|
|
|
parseSpecificKeyOption :: Parser KeyOptions
|
|
parseSpecificKeyOption = WantSpecificKey <$> option (str >>= parseKey)
|
|
( long "key" <> metavar paramKey
|
|
<> help "operate on specified key"
|
|
)
|
|
|
|
parseBranchKeysOption :: Parser KeyOptions
|
|
parseBranchKeysOption = WantBranchKeys <$> some (option (str >>= pure . Ref)
|
|
( long "branch" <> metavar paramRef
|
|
<> help "operate on files in the specified branch or treeish"
|
|
))
|
|
|
|
parseFailedTransfersOption :: Parser KeyOptions
|
|
parseFailedTransfersOption = flag' WantFailedTransfers
|
|
( long "failed"
|
|
<> help "operate on files that recently failed to be transferred"
|
|
)
|
|
|
|
parseIncompleteOption :: Parser KeyOptions
|
|
parseIncompleteOption = flag' WantIncompleteKeys
|
|
( long "incomplete"
|
|
<> help "resume previous downloads"
|
|
)
|
|
|
|
parseAllOption :: Parser KeyOptions
|
|
parseAllOption = flag' WantAllKeys
|
|
( long "all" <> short 'A'
|
|
<> help "operate on all versions of all files"
|
|
)
|
|
|
|
parseKey :: MonadFail m => String -> m Key
|
|
parseKey = maybe (Fail.fail "invalid key") return . deserializeKey
|
|
|
|
-- Options to match properties of annexed files.
|
|
annexedMatchingOptions :: [AnnexOption]
|
|
annexedMatchingOptions = concat
|
|
[ keyMatchingOptions'
|
|
, fileMatchingOptions' Limit.LimitAnnexFiles
|
|
, anythingNothingOptions
|
|
, combiningOptions
|
|
, timeLimitOption
|
|
, sizeLimitOption
|
|
]
|
|
|
|
-- Options to match properties of keys.
|
|
keyMatchingOptions :: [AnnexOption]
|
|
keyMatchingOptions = concat
|
|
[ keyMatchingOptions'
|
|
, anythingNothingOptions
|
|
, combiningOptions
|
|
, timeLimitOption
|
|
, sizeLimitOption
|
|
]
|
|
|
|
-- Matching options that can operate on keys as well as files.
|
|
keyMatchingOptions' :: [AnnexOption]
|
|
keyMatchingOptions' =
|
|
[ annexOption (setAnnexState . Limit.addIn) $ strOption
|
|
( long "in" <> short 'i' <> metavar paramRemote
|
|
<> help "match files present in a remote"
|
|
<> hidden
|
|
<> completeRemotes
|
|
)
|
|
, annexOption (setAnnexState . Limit.addCopies) $ strOption
|
|
( long "copies" <> short 'C' <> metavar paramRemote
|
|
<> help "skip files with fewer copies"
|
|
<> hidden
|
|
)
|
|
, annexOption (setAnnexState . Limit.addLackingCopies False) $ strOption
|
|
( long "lackingcopies" <> metavar paramNumber
|
|
<> help "match files that need more copies"
|
|
<> hidden
|
|
)
|
|
, annexOption (setAnnexState . Limit.addLackingCopies True) $ strOption
|
|
( long "approxlackingcopies" <> metavar paramNumber
|
|
<> help "match files that need more copies (faster)"
|
|
<> hidden
|
|
)
|
|
, annexOption (setAnnexState . Limit.addInBackend) $ strOption
|
|
( long "inbackend" <> short 'B' <> metavar paramName
|
|
<> help "match files using a key-value backend"
|
|
<> hidden
|
|
<> completeBackends
|
|
)
|
|
, annexFlag (setAnnexState Limit.addSecureHash)
|
|
( long "securehash"
|
|
<> help "match files using a cryptographically secure hash"
|
|
<> hidden
|
|
)
|
|
, annexOption (setAnnexState . Limit.addInAllGroup) $ strOption
|
|
( long "inallgroup" <> metavar paramGroup
|
|
<> help "match files present in all remotes in a group"
|
|
<> hidden
|
|
)
|
|
, annexOption (setAnnexState . Limit.addMetaData) $ strOption
|
|
( long "metadata" <> metavar "FIELD=VALUE"
|
|
<> help "match files with attached metadata"
|
|
<> hidden
|
|
)
|
|
, annexFlag (setAnnexState Limit.Wanted.addWantGet)
|
|
( long "want-get"
|
|
<> help "match files the local repository wants to get"
|
|
<> hidden
|
|
)
|
|
, annexOption (setAnnexState . Limit.Wanted.addWantGetBy) $ strOption
|
|
( long "want-get-by" <> metavar paramRemote
|
|
<> help "match files the specified repository wants to get"
|
|
<> hidden
|
|
<> completeRemotes
|
|
)
|
|
, annexFlag (setAnnexState Limit.Wanted.addWantDrop)
|
|
( long "want-drop"
|
|
<> help "match files the local repository wants to drop"
|
|
<> hidden
|
|
)
|
|
, annexOption (setAnnexState . Limit.Wanted.addWantDropBy) $ strOption
|
|
( long "want-drop-by" <> metavar paramRemote
|
|
<> help "match files the specified repository wants to drop"
|
|
<> hidden
|
|
)
|
|
, annexOption (setAnnexState . Limit.addAccessedWithin) $
|
|
option (eitherReader parseDuration)
|
|
( long "accessedwithin"
|
|
<> metavar paramTime
|
|
<> help "match files accessed within a time interval"
|
|
<> hidden
|
|
)
|
|
, annexOption (setAnnexState . Limit.addMimeType) $ strOption
|
|
( long "mimetype" <> metavar paramGlob
|
|
<> help "match files by mime type"
|
|
<> hidden
|
|
)
|
|
, annexOption (setAnnexState . Limit.addMimeEncoding) $ strOption
|
|
( long "mimeencoding" <> metavar paramGlob
|
|
<> help "match files by mime encoding"
|
|
<> hidden
|
|
)
|
|
, annexFlag (setAnnexState Limit.addUnlocked)
|
|
( long "unlocked"
|
|
<> help "match files that are unlocked"
|
|
<> hidden
|
|
)
|
|
, annexFlag (setAnnexState Limit.addLocked)
|
|
( long "locked"
|
|
<> help "match files that are locked"
|
|
<> hidden
|
|
)
|
|
]
|
|
|
|
-- Options to match files which may not yet be annexed.
|
|
fileMatchingOptions :: Limit.LimitBy -> [AnnexOption]
|
|
fileMatchingOptions lb = fileMatchingOptions' lb ++ combiningOptions ++ timeLimitOption
|
|
|
|
fileMatchingOptions' :: Limit.LimitBy -> [AnnexOption]
|
|
fileMatchingOptions' lb =
|
|
[ annexOption (setAnnexState . Limit.addExclude) $ strOption
|
|
( long "exclude" <> short 'x' <> metavar paramGlob
|
|
<> help "skip files matching the glob pattern"
|
|
<> hidden
|
|
)
|
|
, annexOption (setAnnexState . Limit.addInclude) $ strOption
|
|
( long "include" <> short 'I' <> metavar paramGlob
|
|
<> help "limit to files matching the glob pattern"
|
|
<> hidden
|
|
)
|
|
, annexOption (setAnnexState . Limit.addExcludeSameContent) $ strOption
|
|
( long "excludesamecontent" <> short 'x' <> metavar paramGlob
|
|
<> help "skip files whose content is the same as another file matching the glob pattern"
|
|
<> hidden
|
|
)
|
|
, annexOption (setAnnexState . Limit.addIncludeSameContent) $ strOption
|
|
( long "includesamecontent" <> short 'I' <> metavar paramGlob
|
|
<> help "limit to files whose content is the same as another file matching the glob pattern"
|
|
<> hidden
|
|
)
|
|
, annexOption (setAnnexState . Limit.addLargerThan lb) $ strOption
|
|
( long "largerthan" <> metavar paramSize
|
|
<> help "match files larger than a size"
|
|
<> hidden
|
|
)
|
|
, annexOption (setAnnexState . Limit.addSmallerThan lb) $ strOption
|
|
( long "smallerthan" <> metavar paramSize
|
|
<> help "match files smaller than a size"
|
|
<> hidden
|
|
)
|
|
]
|
|
|
|
anythingNothingOptions :: [AnnexOption]
|
|
anythingNothingOptions =
|
|
[ annexFlag (setAnnexState Limit.addAnything)
|
|
( long "anything"
|
|
<> help "match all files"
|
|
<> hidden
|
|
)
|
|
, annexFlag (setAnnexState Limit.addNothing)
|
|
( long "nothing"
|
|
<> help "don't match any files"
|
|
<> hidden
|
|
)
|
|
]
|
|
|
|
combiningOptions :: [AnnexOption]
|
|
combiningOptions =
|
|
[ longopt "not" "negate next option"
|
|
, longopt "and" "both previous and next option must match"
|
|
, longopt "or" "either previous or next option must match"
|
|
, shortopt '(' "open group of options"
|
|
, shortopt ')' "close group of options"
|
|
]
|
|
where
|
|
longopt o h = annexFlag (setAnnexState $ Limit.addSyntaxToken o)
|
|
( long o <> help h <> hidden )
|
|
shortopt o h = annexFlag (setAnnexState $ Limit.addSyntaxToken [o])
|
|
( short o <> help h <> hidden )
|
|
|
|
jsonOptions :: [AnnexOption]
|
|
jsonOptions =
|
|
[ annexFlag (setAnnexState $ Annex.setOutput (JSONOutput stdjsonoptions))
|
|
( long "json" <> short 'j'
|
|
<> help "enable JSON output"
|
|
<> hidden
|
|
)
|
|
, annexFlag (setAnnexState $ Annex.setOutput (JSONOutput jsonerrormessagesoptions))
|
|
( long "json-error-messages"
|
|
<> help "include error messages in JSON"
|
|
<> hidden
|
|
)
|
|
]
|
|
where
|
|
stdjsonoptions = JSONOptions
|
|
{ jsonProgress = False
|
|
, jsonErrorMessages = False
|
|
}
|
|
jsonerrormessagesoptions = stdjsonoptions { jsonErrorMessages = True }
|
|
|
|
jsonProgressOption :: [AnnexOption]
|
|
jsonProgressOption =
|
|
[ annexFlag (setAnnexState $ Annex.setOutput (JSONOutput jsonoptions))
|
|
( long "json-progress"
|
|
<> help "include progress in JSON output"
|
|
<> hidden
|
|
)
|
|
]
|
|
where
|
|
jsonoptions = JSONOptions
|
|
{ jsonProgress = True
|
|
, jsonErrorMessages = False
|
|
}
|
|
|
|
-- Note that a command that adds this option should wrap its seek
|
|
-- action in `allowConcurrentOutput`.
|
|
jobsOption :: [AnnexOption]
|
|
jobsOption =
|
|
[ annexOption (setAnnexState . setConcurrency . ConcurrencyCmdLine) $
|
|
option (maybeReader parseConcurrency)
|
|
( long "jobs" <> short 'J'
|
|
<> metavar (paramNumber `paramOr` "cpus")
|
|
<> help "enable concurrent jobs"
|
|
<> hidden
|
|
)
|
|
]
|
|
|
|
timeLimitOption :: [AnnexOption]
|
|
timeLimitOption =
|
|
[ annexOption settimelimit $ option (eitherReader parseDuration)
|
|
( long "time-limit" <> short 'T' <> metavar paramTime
|
|
<> help "stop after the specified amount of time"
|
|
<> hidden
|
|
)
|
|
]
|
|
where
|
|
settimelimit duration = setAnnexState $ do
|
|
start <- liftIO getPOSIXTime
|
|
let cutoff = start + durationToPOSIXTime duration
|
|
Annex.changeState $ \s -> s { Annex.timelimit = Just (duration, cutoff) }
|
|
|
|
sizeLimitOption :: [AnnexOption]
|
|
sizeLimitOption =
|
|
[ annexOption setsizelimit $ option (maybeReader (readSize dataUnits))
|
|
( long "size-limit" <> metavar paramSize
|
|
<> help "total size of annexed files to process"
|
|
<> hidden
|
|
)
|
|
]
|
|
where
|
|
setsizelimit n = setAnnexState $ do
|
|
v <- liftIO $ newTVarIO n
|
|
Annex.changeState $ \s -> s { Annex.sizelimit = Just v }
|
|
|
|
backendOption :: [AnnexOption]
|
|
backendOption =
|
|
[ annexOption setforcebackend $ strOption
|
|
( long "backend" <> short 'b' <> metavar paramName
|
|
<> help "specify key-value backend to use"
|
|
<> hidden
|
|
)
|
|
]
|
|
where
|
|
setforcebackend v = setAnnexRead $
|
|
\rd -> rd { Annex.forcebackend = Just v }
|
|
|
|
data DaemonOptions = DaemonOptions
|
|
{ foregroundDaemonOption :: Bool
|
|
, stopDaemonOption :: Bool
|
|
}
|
|
|
|
parseDaemonOptions :: Bool -> Parser DaemonOptions
|
|
parseDaemonOptions canstop
|
|
| canstop = DaemonOptions <$> foreground <*> stop
|
|
| otherwise = DaemonOptions <$> foreground <*> pure False
|
|
where
|
|
foreground = switch
|
|
( long "foreground"
|
|
<> help "do not daemonize"
|
|
)
|
|
stop = switch
|
|
( long "stop"
|
|
<> help "stop daemon"
|
|
)
|
|
|
|
completeRemotes :: HasCompleter f => Mod f a
|
|
completeRemotes = completer $ mkCompleter $ \input -> do
|
|
r <- maybe (pure Nothing) (Just <$$> Git.Config.read)
|
|
=<< Git.Construct.fromCwd
|
|
return $ filter (input `isPrefixOf`) $
|
|
mapMaybe remoteKeyToRemoteName $
|
|
filter isRemoteUrlKey $
|
|
maybe [] (M.keys . config) r
|
|
|
|
completeBackends :: HasCompleter f => Mod f a
|
|
completeBackends = completeWith $
|
|
map (decodeBS . formatKeyVariety . Backend.backendVariety) Backend.builtinList
|