259 lines
8.4 KiB
Haskell
259 lines
8.4 KiB
Haskell
{- git-annex remote repositories -}
|
|
|
|
module Remotes (
|
|
list,
|
|
keyPossibilities,
|
|
tryGitConfigRead,
|
|
inAnnex,
|
|
commandLineRemote,
|
|
copyFromRemote,
|
|
copyToRemote,
|
|
removeRemoteFile,
|
|
updateRemoteLogStatus
|
|
) where
|
|
|
|
import Control.Exception
|
|
import Control.Monad.State (liftIO)
|
|
import Control.Monad (filterM)
|
|
import qualified Data.Map as Map
|
|
import Data.String.Utils
|
|
import Data.Either.Utils
|
|
import System.Cmd.Utils
|
|
import System.Directory
|
|
import List
|
|
import Maybe
|
|
import IO (hPutStrLn)
|
|
|
|
import Types
|
|
import qualified GitRepo as Git
|
|
import qualified Annex
|
|
import qualified Backend
|
|
import qualified Core
|
|
import LocationLog
|
|
import Locations
|
|
import UUID
|
|
import Utility
|
|
|
|
{- Human visible list of remotes. -}
|
|
list :: [Git.Repo] -> String
|
|
list remotes = join ", " $ map Git.repoDescribe remotes
|
|
|
|
{- Cost ordered list of remotes that the LocationLog indicate may have a key. -}
|
|
keyPossibilities :: Key -> Annex [Git.Repo]
|
|
keyPossibilities key = do
|
|
g <- Annex.gitRepo
|
|
uuids <- liftIO $ keyLocations g key
|
|
allremotes <- remotesByCost
|
|
-- To determine if a remote has a key, its UUID needs to be known.
|
|
-- The locally cached UIIDs of remotes can fall out of date if
|
|
-- eg, a different drive is mounted at the same location.
|
|
-- But, reading the config of remotes can be expensive, so make
|
|
-- sure we only do it once per git-annex run.
|
|
remotesread <- Annex.flagIsSet "remotesread"
|
|
if (remotesread)
|
|
then reposByUUID allremotes uuids
|
|
else do
|
|
-- We assume that it's cheap to read the config
|
|
-- of non-URL remotes, so that is done each time.
|
|
-- But reading the config of an URL remote is
|
|
-- only done when there is no cached UUID value.
|
|
let cheap = filter (not . Git.repoIsUrl) allremotes
|
|
let expensive = filter Git.repoIsUrl allremotes
|
|
doexpensive <- filterM cachedUUID expensive
|
|
if (not $ null doexpensive)
|
|
then Core.showNote $ "getting UUIDs for " ++ (list doexpensive) ++ "..."
|
|
else return ()
|
|
let todo = cheap ++ doexpensive
|
|
if (not $ null todo)
|
|
then do
|
|
e <- mapM tryGitConfigRead todo
|
|
Annex.flagChange "remotesread" $ FlagBool True
|
|
keyPossibilities key
|
|
else reposByUUID allremotes uuids
|
|
where
|
|
cachedUUID r = do
|
|
u <- getUUID r
|
|
return $ null u
|
|
|
|
{- Checks if a given remote has the content for a key inAnnex.
|
|
- If the remote cannot be accessed, returns a Left error.
|
|
-}
|
|
inAnnex :: Git.Repo -> Key -> Annex (Either IOException Bool)
|
|
inAnnex remote key = do
|
|
-- the check needs to run in an Annex monad using the remote
|
|
liftIO $ ((try $ check)::IO (Either IOException Bool))
|
|
where
|
|
check = do
|
|
a <- Annex.new remote []
|
|
(result, _) <- Annex.run a (Core.inAnnex key)
|
|
return result
|
|
|
|
{- Cost Ordered list of remotes. -}
|
|
remotesByCost :: Annex [Git.Repo]
|
|
remotesByCost = do
|
|
g <- Annex.gitRepo
|
|
reposByCost $ Git.remotes g
|
|
|
|
{- Orders a list of git repos by cost. Throws out ignored ones. -}
|
|
reposByCost :: [Git.Repo] -> Annex [Git.Repo]
|
|
reposByCost l = do
|
|
notignored <- filterM repoNotIgnored l
|
|
costpairs <- mapM costpair notignored
|
|
return $ fst $ unzip $ sortBy bycost $ costpairs
|
|
where
|
|
costpair r = do
|
|
cost <- repoCost r
|
|
return (r, cost)
|
|
bycost (_, c1) (_, c2) = compare c1 c2
|
|
|
|
{- Calculates cost for a repo.
|
|
-
|
|
- The default cost is 100 for local repositories, and 200 for remote
|
|
- repositories; it can also be configured by remote.<name>.annex-cost
|
|
-}
|
|
repoCost :: Git.Repo -> Annex Int
|
|
repoCost r = do
|
|
g <- Annex.gitRepo
|
|
if (not $ null $ config g r)
|
|
then return $ read $ config g r
|
|
else if (Git.repoIsUrl r)
|
|
then return 200
|
|
else return 100
|
|
where
|
|
config g r = Git.configGet g (configkey r) ""
|
|
configkey r = "remote." ++ (Git.repoRemoteName r) ++ ".annex-cost"
|
|
|
|
{- Checks if a repo should be ignored, based either on annex-ignore
|
|
- setting, or on command-line options. Allows command-line to override
|
|
- annex-ignore. -}
|
|
repoNotIgnored :: Git.Repo -> Annex Bool
|
|
repoNotIgnored r = do
|
|
g <- Annex.gitRepo
|
|
fromName <- Annex.flagGet "fromrepository"
|
|
toName <- Annex.flagGet "torepository"
|
|
let name = if (not $ null fromName) then fromName else toName
|
|
if (not $ null name)
|
|
then return $ match name
|
|
else return $ notignored g
|
|
where
|
|
match name = name == Git.repoRemoteName r
|
|
notignored g = "true" /= config g
|
|
config g = Git.configGet g configkey ""
|
|
configkey = "remote." ++ (Git.repoRemoteName r) ++ ".annex-ignore"
|
|
|
|
{- Returns the remote specified by --from or --to, may fail with error. -}
|
|
commandLineRemote :: Annex Git.Repo
|
|
commandLineRemote = do
|
|
fromName <- Annex.flagGet "fromrepository"
|
|
toName <- Annex.flagGet "torepository"
|
|
let name = if (not $ null fromName) then fromName else toName
|
|
if (null name)
|
|
then error "no remote specified"
|
|
else do
|
|
g <- Annex.gitRepo
|
|
let match = filter (\r -> name == Git.repoRemoteName r) $
|
|
Git.remotes g
|
|
if (null match)
|
|
then error $ "there is no git remote named \"" ++ name ++ "\""
|
|
else return $ match !! 0
|
|
|
|
{- The git configs for the git repo's remotes is not read on startup
|
|
- because reading it may be expensive. This function tries to read the
|
|
- config for a specified remote, and updates state. If successful, it
|
|
- returns the updated git repo. -}
|
|
tryGitConfigRead :: Git.Repo -> Annex (Either Git.Repo Git.Repo)
|
|
tryGitConfigRead r = do
|
|
if (Map.null $ Git.configMap r)
|
|
then do
|
|
-- configRead can fail due to IO error or
|
|
-- for other reasons; catch all possible exceptions
|
|
result <- liftIO $ (try (Git.configRead r)::IO (Either SomeException (Git.Repo)))
|
|
case (result) of
|
|
Left e -> return $ Left r
|
|
Right r' -> do
|
|
g <- Annex.gitRepo
|
|
let l = Git.remotes g
|
|
let g' = Git.remotesAdd g $
|
|
exchange l r'
|
|
Annex.gitRepoChange g'
|
|
return $ Right r'
|
|
else return $ Right r -- config already read
|
|
where
|
|
exchange [] new = []
|
|
exchange (old:ls) new =
|
|
if ((Git.repoRemoteName old) == (Git.repoRemoteName new))
|
|
then new:(exchange ls new)
|
|
else old:(exchange ls new)
|
|
|
|
{- Tries to copy a key's content from a remote to a file. -}
|
|
copyFromRemote :: Git.Repo -> Key -> FilePath -> Annex Bool
|
|
copyFromRemote r key file = do
|
|
Core.showNote $ "copying from " ++ (Git.repoDescribe r) ++ "..."
|
|
if (not $ Git.repoIsUrl r)
|
|
then getlocal
|
|
else if (Git.repoIsSsh r)
|
|
then getssh
|
|
else error "copying from non-ssh repo not supported"
|
|
where
|
|
getlocal = liftIO $ boolSystem "cp" ["-a", location, file]
|
|
getssh = do
|
|
liftIO $ putStrLn "" -- make way for scp progress bar
|
|
liftIO $ boolSystem "scp" [sshlocation, file]
|
|
location = annexLocation r key
|
|
sshlocation = (Git.urlHost r) ++ ":" ++ location
|
|
|
|
{- Tries to copy a key's content to a remote. -}
|
|
copyToRemote :: Git.Repo -> Key -> Annex Bool
|
|
copyToRemote r key = do
|
|
g <- Annex.gitRepo
|
|
Core.showNote $ "copying to " ++ (Git.repoDescribe r) ++ "..."
|
|
if (not $ Git.repoIsUrl r)
|
|
then sendlocal g
|
|
else if (Git.repoIsSsh r)
|
|
then sendssh g
|
|
else error "copying to non-ssh repo not supported"
|
|
where
|
|
sendlocal g = liftIO $ boolSystem "cp" ["-a", location g, file]
|
|
sendssh g = do
|
|
liftIO $ putStrLn "" -- make way for scp progress bar
|
|
liftIO $ boolSystem "scp" [location g, sshlocation]
|
|
location g = annexLocation g key
|
|
sshlocation = (Git.urlHost r) ++ ":" ++ file
|
|
file = error "TODO"
|
|
|
|
{- Removes a file from a remote. -}
|
|
removeRemoteFile :: Git.Repo -> FilePath -> Annex ()
|
|
removeRemoteFile r file = do
|
|
if (not $ Git.repoIsUrl r)
|
|
then liftIO $ removeFile file
|
|
else if (Git.repoIsSsh r)
|
|
then do
|
|
ok <- liftIO $ boolSystem "ssh"
|
|
[Git.urlHost r, "rm -f " ++
|
|
(shellEscape file)]
|
|
if (ok)
|
|
then return ()
|
|
else error "failed to remove file from remote"
|
|
else error "removing file from non-ssh repo not supported"
|
|
|
|
{- Update's a remote's location log for a key, by merging the local
|
|
- location log into it. -}
|
|
updateRemoteLogStatus :: Git.Repo -> Key -> Annex ()
|
|
updateRemoteLogStatus r key = do
|
|
-- To merge, just append data to the remote's
|
|
-- log. Since the log is timestamped, the presumably newer
|
|
-- information from the local will superscede the older
|
|
-- information in the remote's log.
|
|
-- TODO: remote log locking
|
|
let mergecmd = "cat >> " ++ (shellEscape $ logFile r key) ++ " && " ++
|
|
"cd " ++ (shellEscape $ Git.workTree r) ++ " && " ++
|
|
"git add " ++ (shellEscape $ stateLoc)
|
|
let shellcmd = if (not $ Git.repoIsUrl r)
|
|
then pOpen WriteToPipe "sh" ["-c", mergecmd]
|
|
else if (Git.repoIsSsh r)
|
|
then pOpen WriteToPipe "ssh" [Git.urlHost r, mergecmd]
|
|
else error "updating non-ssh repo not supported"
|
|
g <- Annex.gitRepo
|
|
liftIO $ shellcmd $ \h -> do
|
|
lines <- readLog $ logFile g key
|
|
hPutStrLn h $ unlines $ map show lines
|