two types of byName

Clean up from 9769235d6b.
In some cases, looking up a remote by name even though it has no UUID is
desirable. This includes git annex sync, which can operate on remotes
without an annex, and XMPP pairing, which runs addRemote (with calls
byName) before the UUID of the XMPP remote has been configured in git.
This commit is contained in:
Joey Hess 2013-03-05 15:39:42 -04:00
parent 9e75dce764
commit 921f29c004
10 changed files with 27 additions and 16 deletions

View file

@ -52,7 +52,8 @@ addRemote :: Annex String -> Annex Remote
addRemote a = do addRemote a = do
name <- a name <- a
void remoteListRefresh void remoteListRefresh
maybe (error "failed to add remote") return =<< Remote.byName (Just name) maybe (error "failed to add remote") return
=<< Remote.byName (Just name)
{- Inits a rsync special remote, and returns its name. -} {- Inits a rsync special remote, and returns its name. -}
makeRsyncRemote :: String -> String -> Annex String makeRsyncRemote :: String -> String -> Annex String

View file

@ -18,8 +18,8 @@ def = [withOptions Command.Move.options $ command "copy" paramPaths seek
"copy content of files to/from another repository"] "copy content of files to/from another repository"]
seek :: [CommandSeek] seek :: [CommandSeek]
seek = [withField Command.Move.toOption Remote.byName $ \to -> seek = [withField Command.Move.toOption Remote.byNameWithUUID $ \to ->
withField Command.Move.fromOption Remote.byName $ \from -> withField Command.Move.fromOption Remote.byNameWithUUID $ \from ->
withFilesInGit $ whenAnnexed $ start to from] withFilesInGit $ whenAnnexed $ start to from]
{- A copy is just a move that does not delete the source file. {- A copy is just a move that does not delete the source file.

View file

@ -27,7 +27,7 @@ fromOption :: Option
fromOption = Option.field ['f'] "from" paramRemote "drop content from a remote" fromOption = Option.field ['f'] "from" paramRemote "drop content from a remote"
seek :: [CommandSeek] seek :: [CommandSeek]
seek = [withField fromOption Remote.byName $ \from -> seek = [withField fromOption Remote.byNameWithUUID $ \from ->
withFilesInGit $ whenAnnexed $ start from] withFilesInGit $ whenAnnexed $ start from]
start :: Maybe Remote -> FilePath -> (Key, Backend) -> CommandStart start :: Maybe Remote -> FilePath -> (Key, Backend) -> CommandStart

View file

@ -28,7 +28,7 @@ start :: UnusedMaps -> Int -> CommandStart
start = startUnused "dropunused" perform (performOther gitAnnexBadLocation) (performOther gitAnnexTmpLocation) start = startUnused "dropunused" perform (performOther gitAnnexBadLocation) (performOther gitAnnexTmpLocation)
perform :: Key -> CommandPerform perform :: Key -> CommandPerform
perform key = maybe droplocal dropremote =<< Remote.byName =<< from perform key = maybe droplocal dropremote =<< Remote.byNameWithUUID =<< from
where where
dropremote r = do dropremote r = do
showAction $ "from " ++ Remote.name r showAction $ "from " ++ Remote.name r

View file

@ -61,7 +61,7 @@ options =
seek :: [CommandSeek] seek :: [CommandSeek]
seek = seek =
[ withField fromOption Remote.byName $ \from -> [ withField fromOption Remote.byNameWithUUID $ \from ->
withIncremental $ \i -> withFilesInGit $ whenAnnexed $ start from i withIncremental $ \i -> withFilesInGit $ whenAnnexed $ start from i
, withIncremental $ \i -> withBarePresentKeys $ startBare i , withIncremental $ \i -> withBarePresentKeys $ startBare i
] ]

View file

@ -20,7 +20,7 @@ def = [withOptions [Command.Move.fromOption] $ command "get" paramPaths seek
"make content of annexed files available"] "make content of annexed files available"]
seek :: [CommandSeek] seek :: [CommandSeek]
seek = [withField Command.Move.fromOption Remote.byName $ \from -> seek = [withField Command.Move.fromOption Remote.byNameWithUUID $ \from ->
withFilesInGit $ whenAnnexed $ start from] withFilesInGit $ whenAnnexed $ start from]
start :: Maybe Remote -> FilePath -> (Key, Backend) -> CommandStart start :: Maybe Remote -> FilePath -> (Key, Backend) -> CommandStart

View file

@ -32,8 +32,8 @@ options :: [Option]
options = [fromOption, toOption] options = [fromOption, toOption]
seek :: [CommandSeek] seek :: [CommandSeek]
seek = [withField toOption Remote.byName $ \to -> seek = [withField toOption Remote.byNameWithUUID $ \to ->
withField fromOption Remote.byName $ \from -> withField fromOption Remote.byNameWithUUID $ \from ->
withFilesInGit $ whenAnnexed $ start to from True] withFilesInGit $ whenAnnexed $ start to from True]
start :: Maybe Remote -> Maybe Remote -> Bool -> FilePath -> (Key, Backend) -> CommandStart start :: Maybe Remote -> Maybe Remote -> Bool -> FilePath -> (Key, Backend) -> CommandStart

View file

@ -29,8 +29,8 @@ fileOption :: Option
fileOption = Option.field [] "file" paramFile "the associated file" fileOption = Option.field [] "file" paramFile "the associated file"
seek :: [CommandSeek] seek :: [CommandSeek]
seek = [withField Command.Move.toOption Remote.byName $ \to -> seek = [withField Command.Move.toOption Remote.byNameWithUUID $ \to ->
withField Command.Move.fromOption Remote.byName $ \from -> withField Command.Move.fromOption Remote.byNameWithUUID $ \from ->
withField fileOption return $ \file -> withField fileOption return $ \file ->
withKeys $ start to from file] withKeys $ start to from file]

View file

@ -76,7 +76,7 @@ checkUnused = chain 0
chain v' as chain v' as
checkRemoteUnused :: String -> CommandPerform checkRemoteUnused :: String -> CommandPerform
checkRemoteUnused name = go =<< fromJust <$> Remote.byName (Just name) checkRemoteUnused name = go =<< fromJust <$> Remote.byNameWithUUID (Just name)
where where
go r = do go r = do
showAction "checking for unused data" showAction "checking for unused data"

View file

@ -24,6 +24,7 @@ module Remote (
remoteMap, remoteMap,
uuidDescriptions, uuidDescriptions,
byName, byName,
byNameWithUUID,
byCost, byCost,
prettyPrintUUIDs, prettyPrintUUIDs,
prettyListUUIDs, prettyListUUIDs,
@ -72,18 +73,27 @@ addName desc n
| otherwise = n ++ " (" ++ desc ++ ")" | otherwise = n ++ " (" ++ desc ++ ")"
{- When a name is specified, looks up the remote matching that name. {- When a name is specified, looks up the remote matching that name.
- (Or it can be a UUID.) Only finds currently configured git remotes. -} - (Or it can be a UUID.) -}
byName :: Maybe String -> Annex (Maybe Remote) byName :: Maybe String -> Annex (Maybe Remote)
byName Nothing = return Nothing byName Nothing = return Nothing
byName (Just n) = either error Just <$> byName' n byName (Just n) = either error Just <$> byName' n
{- Like byName, but the remote must have a configured UUID. -}
byNameWithUUID :: Maybe String -> Annex (Maybe Remote)
byNameWithUUID n = do
v <- byName n
return $ checkuuid <$> v
where
checkuuid r
| uuid r == NoUUID = error $ "cannot determine uuid for " ++ name r
| otherwise = r
byName' :: String -> Annex (Either String Remote) byName' :: String -> Annex (Either String Remote)
byName' "" = return $ Left "no remote specified" byName' "" = return $ Left "no remote specified"
byName' n = handle . filter matching <$> remoteList byName' n = handle . filter matching <$> remoteList
where where
handle [] = Left $ "there is no available git remote named \"" ++ n ++ "\"" handle [] = Left $ "there is no available git remote named \"" ++ n ++ "\""
handle (match:_) handle (match:_) = Right match
| uuid match == NoUUID = Left $ "cannot determine uuid for " ++ name match
| otherwise = Right match
matching r = n == name r || toUUID n == uuid r matching r = n == name r || toUUID n == uuid r
{- Looks up a remote by name (or by UUID, or even by description), {- Looks up a remote by name (or by UUID, or even by description),