module Darcs.UI.Commands.Clone
( get
, put
, clone
, makeRepoName
, cloneToSSH
) where
import Prelude ()
import Darcs.Prelude
import System.Directory ( doesDirectoryExist, doesFileExist
, setCurrentDirectory )
import System.Exit ( ExitCode(..) )
import Control.Exception ( catch, SomeException )
import Control.Monad ( when, unless )
import Data.Maybe ( listToMaybe )
import Darcs.UI.Commands ( DarcsCommand(..), withStdOpts
, nodefaults
, commandStub
, commandAlias
, putInfo
)
import Darcs.UI.Completion ( noArgs )
import Darcs.UI.Flags( DarcsFlag( NewRepo
, UpToPattern
, UpToPatch
, UpToHash
, OnePattern
, OnePatch
, OneHash
)
, matchAny, useCache, umask, remoteRepos
, setDefault, quiet, usePacks
, remoteDarcs, cloneKind, verbosity, setScriptsExecutable
, withWorkingDir, patchIndexNo )
import Darcs.UI.Options ( (^), odesc, ocheck, onormalise, defaultFlags, (?) )
import qualified Darcs.UI.Options.All as O
import Darcs.UI.Commands.Util ( getUniqueRepositoryName )
import Darcs.Repository ( cloneRepository )
import Darcs.Repository.Format ( identifyRepoFormat
, RepoProperty ( HashedInventory
, RebaseInProgress
)
, formatHas
)
import Darcs.Util.Lock ( withTempDir )
import Darcs.Util.Ssh ( getSSH, SSHCmd(SCP) )
import Darcs.Repository.Flags
( CloneKind(CompleteClone), SetDefault(NoSetDefault), ForgetParent(..) )
import Darcs.Patch.Bundle ( scanContextFile )
import Darcs.Patch.Dummy ( DummyPatch )
import Darcs.Patch.Set ( PatchSet, Origin )
import Darcs.Repository.Prefs ( showMotd )
import Darcs.Util.Progress ( debugMessage )
import Darcs.Util.Printer ( text, ($$) )
import Darcs.Util.Path ( toFilePath, toPath, ioAbsoluteOrRemote, AbsolutePath )
import Darcs.Util.Workaround ( getCurrentDirectory )
import Darcs.Util.URL ( isSshUrl )
import Darcs.Util.Exec ( exec, Redirect(..), )
cloneDescription :: String
cloneDescription = "Make a copy of an existing repository."
cloneHelp :: String
cloneHelp =
unlines
[ "Clone creates a copy of a repository. The optional second"
, "argument specifies a destination directory for the new copy;"
, "if omitted, it is inferred from the source location."
, ""
, "By default Darcs will copy every patch from the original repository."
, "If you expect the original repository to remain accessible, you can"
, "use `--lazy` to avoid copying patches until they are needed ('copy on"
, "demand'). This is particularly useful when copying a remote"
, "repository with a long history that you don't care about."
, ""
, "When cloning locally, Darcs automatically uses hard linking where"
, "possible. As well as saving time and space, this enables to move or"
, "delete the original repository without affecting the copy."
, "Hard linking requires that the copy be on the same filesystem as the"
, "original repository, and that the filesystem support hard linking."
, "This includes NTFS, HFS+ and all general-purpose Unix filesystems"
, "(such as ext, UFS and ZFS). FAT does not support hard links."
, ""
, "When cloning from a remote location, Darcs will look for and attempt"
, "to use packs created by `darcs optimize http` in the remote repository."
, "Packs are single big files that can be downloaded faster than many"
, "little files."
, ""
, "Darcs clone will not copy unrecorded changes to the source repository's"
, "working tree."
, ""
, "You can copy a repository to a ssh url, in which case the new repository"
, "will always be complete."
, ""
] ++ cloneHelpTag
++ cloneHelpSSE
clone :: DarcsCommand [DarcsFlag]
clone = DarcsCommand
{ commandProgramName = "darcs"
, commandName = "clone"
, commandHelp = cloneHelp
, commandDescription = cloneDescription
, commandExtraArgs = -1
, commandExtraArgHelp = ["<REPOSITORY>", "[<DIRECTORY>]"]
, commandCommand = cloneCmd
, commandPrereq = validContextFile
, commandCompleteArgs = noArgs
, commandArgdefaults = nodefaults
, commandAdvancedOptions = odesc cloneAdvancedOpts
, commandBasicOptions = odesc cloneBasicOpts
, commandDefaults = defaultFlags cloneOpts
, commandCheckOptions = ocheck cloneOpts
, commandParseOptions = onormalise cloneOpts
}
where
cloneBasicOpts
= O.reponame
^ O.cloneKind
^ O.matchOneContext
^ O.setDefault
^ O.setScriptsExecutable
^ O.withWorkingDir
cloneAdvancedOpts = O.usePacks ^ O.patchIndexNo ^ O.network
cloneOpts = cloneBasicOpts `withStdOpts` cloneAdvancedOpts
get :: DarcsCommand [DarcsFlag]
get = commandAlias "get" Nothing clone
putDescription :: String
putDescription = "Deprecated command, replaced by clone."
putHelp :: String
putHelp = unlines
[ "This command is deprecated."
, ""
, "To clone the current repository to a ssh destination,"
, "use the syntax `darcs clone . user@server:path` ."
]
put :: DarcsCommand [DarcsFlag]
put = commandStub "put" putHelp putDescription clone
cloneCmd :: (AbsolutePath, AbsolutePath) -> [DarcsFlag] -> [String] -> IO ()
cloneCmd fps opts [inrepodir, outname] = cloneCmd fps (NewRepo outname:opts) [inrepodir]
cloneCmd _ opts [inrepodir] = do
debugMessage "Starting work on clone..."
typed_repodir <- ioAbsoluteOrRemote inrepodir
let repodir = toPath typed_repodir
unless (quiet opts) $ showMotd repodir
rfsource <- identifyRepoFormat repodir
debugMessage $ "Found the format of "++repodir++"..."
when (formatHas RebaseInProgress rfsource) $
fail "Can't clone a repository with a rebase in progress"
unless (formatHas HashedInventory rfsource) $ putInfo opts $
text "***********************************************************************"
$$ text " _______ Sorry for the wait! The repository you are cloning is"
$$ text " | | using the DEPRECATED 'old-fashioned' format. I'm doing a"
$$ text " | O O | hashed copy instead, but this may take a while."
$$ text " | ___ |"
$$ text " | / \\ | We recommend that the maintainer upgrade the remote copy"
$$ text " |_______| as well. See http://wiki.darcs.net/OF for more information."
$$ text ""
$$ text "***********************************************************************"
case cloneToSSH opts of
Just repo -> do
withTempDir "clone" $ \_ -> do
putInfo opts $ text "Creating local clone..."
currentDir <- getCurrentDirectory
mysimplename <- makeRepoName True [] repodir
cloneRepository repodir mysimplename (verbosity ? opts) (useCache ? opts)
CompleteClone (umask ? opts) (remoteDarcs opts)
(setScriptsExecutable ? opts)
(remoteRepos ? opts) (NoSetDefault True)
(matchAny ? map convertUpToToOne opts)
rfsource
(withWorkingDir ? opts)
(patchIndexNo ? opts)
(usePacks ? opts)
YesForgetParent
setCurrentDirectory currentDir
(scp, args) <- getSSH SCP
putInfo opts $ text $ "Transferring clone using " ++ scp ++ "..."
r <- exec scp (args ++ ["-r", mysimplename ++ "/", repo]) (AsIs,AsIs,AsIs)
when (r /= ExitSuccess) $ fail $ "Problem during " ++ scp ++ " transfer."
putInfo opts $ text "Cloning and transferring successful."
Nothing -> do
mysimplename <- makeRepoName True opts repodir
cloneRepository repodir mysimplename (verbosity ? opts) (useCache ? opts)
(cloneKind ? opts) (umask ? opts) (remoteDarcs opts)
(setScriptsExecutable ? opts)
(remoteRepos ? opts) (setDefault True opts)
(matchAny ? map convertUpToToOne opts)
rfsource
(withWorkingDir ? opts)
(patchIndexNo ? opts)
(usePacks ? opts)
NoForgetParent
putInfo opts $ text "Finished cloning."
cloneCmd _ _ _ = fail "You must provide 'clone' with either one or two arguments."
cloneToSSH :: [DarcsFlag] -> Maybe String
cloneToSSH fs = case O.reponame ? fs of
Nothing -> Nothing
Just r -> if isSshUrl r then Just r else Nothing
makeRepoName :: Bool -> [DarcsFlag] -> FilePath -> IO String
makeRepoName talkative fs d =
case O.reponame ? fs of
Just n -> do
exists <- doesDirectoryExist n
file_exists <- doesFileExist n
if exists || file_exists
then fail $ "Directory or file named '" ++ n ++ "' already exists."
else return n
Nothing ->
case mkName d of
"" -> getUniqueRepositoryName talkative "anonymous_repo"
base@('/':_) -> getUniqueRepositoryName talkative base
base
-> do
cwd <- getCurrentDirectory
getUniqueRepositoryName talkative (cwd ++ "/" ++ base)
where mkName = dropWhile (== '.') . reverse .
takeWhile (not . (`elem` "/:")) . dropWhile (== '/') . reverse
cloneHelpTag :: String
cloneHelpTag =
unlines
[ "It is often desirable to make a copy of a repository that excludes"
, "some patches. For example, if releases are tagged then `darcs clone"
, "--tag .` would make a copy of the repository as at the latest release."
, ""
, "An untagged repository state can still be identified unambiguously by"
, "a context file, as generated by `darcs log --context`. Given the"
, "name of such a file, the `--context` option will create a repository"
, "that includes only the patches from that context. When a user reports"
, "a bug in an unreleased version of your project, the recommended way to"
, "find out exactly what version they were running is to have them"
, "include a context file in the bug report."
, ""
, "You can also make a copy of an untagged state using the `--to-patch` or"
, "`--to-match` options, which exclude patches *after* the first matching"
, "patch. Because these options treat the set of patches as an ordered"
, "sequence, you may get different results after reordering with `darcs"
, "optimize reorder`."
, ""
]
cloneHelpSSE :: String
cloneHelpSSE =
unlines
[ "The `--set-scripts-executable` option causes scripts to be made"
, "executable in the working tree. A script is any file that starts"
, "with a shebang (\"#!\")."
]
validContextFile :: [DarcsFlag] -> IO (Either String ())
validContextFile opts =
case getContext opts of
Nothing -> return $ Right ()
Just ctxAbsolutePath -> do
let ctxFilePath = toFilePath ctxAbsolutePath
exists <- doesFileExist ctxFilePath
if exists
then do
(ps :: PatchSet rt DummyPatch Origin wX) <-
scanContextFile ctxFilePath
(ps `seq` return $ Right ()) `catch` \(_ :: SomeException) ->
return . Left $ "File " ++ ctxFilePath
++ " is not a valid context file"
else return . Left $
"Context file " ++ ctxFilePath ++ " does not exist"
getContext :: [DarcsFlag] -> Maybe AbsolutePath
getContext fs = listToMaybe [ f | O.Context f <- O.context ? fs ]
convertUpToToOne :: DarcsFlag -> DarcsFlag
convertUpToToOne (UpToPattern p) = OnePattern p
convertUpToToOne (UpToPatch p) = OnePatch p
convertUpToToOne (UpToHash p) = OneHash p
convertUpToToOne f = f