Simplify setup process for a ssh remote.

Now it suffices to run git remote add, followed by git-annex sync. Now the
remote is automatically initialized for use by git-annex, where before the
git-annex branch had to manually be pushed before using git-annex sync.
Note that this involved changes to git-annex-shell, so if the remote is
using an old version, the manual push is still needed.

Implementation required git-annex-shell be changed, so configlist can
autoinit a repository even when no git-annex branch has been pushed yet.
Unfortunate because we'll have to wait for it to get deployed to servers
before being able to rely on this change in the documentation.

Did consider making git-annex sync push the git-annex branch to repos that
didn't have a uuid, but this seemed difficult to do without complicating it
in messy ways.

It would be cleaner to split a command out from configlist to handle
the initialization. But this is difficult without sacrificing backwards
compatability, for users of old git-annex versions which would not use the
new command.

CmdLine/GitAnnexShell.hs

@@ -34,7 +34,7 @@ import qualified Command.GCryptSetup
 
 cmds_readonly :: [Command]
 cmds_readonly =
-	[ gitAnnexShellCheck Command.ConfigList.cmd
+	[ Command.ConfigList.cmd
 	, gitAnnexShellCheck Command.InAnnex.cmd
 	, gitAnnexShellCheck Command.SendKey.cmd
 	, gitAnnexShellCheck Command.TransferInfo.cmd
@@ -146,6 +146,7 @@ checkField (field, val)
 	| field == fieldName remoteUUID = fieldCheck remoteUUID val
 	| field == fieldName associatedFile = fieldCheck associatedFile val
 	| field == fieldName direct = fieldCheck direct val
+	| field == fieldName autoInit = fieldCheck autoInit val
 	| otherwise = False
 
 failure :: IO ()

CmdLine/GitAnnexShell/Fields.hs

@@ -34,3 +34,6 @@ associatedFile = Field "associatedfile" $ \f ->
 
 direct :: Field
 direct = Field "direct" $ \f -> f == "1"
+
+autoInit :: Field
+autoInit = Field "autoinit" $ \f -> f == "1"

Command/ConfigList.hs

@@ -14,9 +14,10 @@ import Annex.Init
 import qualified Annex.Branch
 import qualified Git.Config
 import Remote.GCrypt (coreGCryptId)
+import qualified CmdLine.GitAnnexShell.Fields as Fields
 
 cmd :: Command
-cmd = noCommit $ 
+cmd = noCommit $ dontCheck repoExists $
 	command "configlist" SectionPlumbing 
 		"outputs relevant git configuration"
 		paramNothing (withParams seek)
@@ -34,13 +35,14 @@ start = do
 	showConfig k v = liftIO $ putStrLn $ k ++ "=" ++ v
 
 {- The repository may not yet have a UUID; automatically initialize it
- - when there's a git-annex branch available. -}
+ - when there's a git-annex branch available or if the autoinit field was
+ - set. -}
 findOrGenUUID :: Annex UUID
 findOrGenUUID = do
 	u <- getUUID
 	if u /= NoUUID
 		then return u
-		else ifM Annex.Branch.hasSibling
+		else ifM (Annex.Branch.hasSibling <||> (isJust <$> Fields.getField Fields.autoInit))
 			( do
 				initialize Nothing
 				getUUID

Command/Sync.hs

@@ -137,19 +137,24 @@ remoteBranch :: Remote -> Git.Ref -> Git.Ref
 remoteBranch remote = Git.Ref.underBase $ "refs/remotes/" ++ Remote.name remote
 
 syncRemotes :: [String] -> Annex [Remote]
-syncRemotes rs = ifM (Annex.getState Annex.fast) ( nub <$> pickfast , wanted )
+syncRemotes ps = do
+	-- Get remote list first, doing automatic initialization
+	-- of remotes when possible.
+	syncRemotes' ps =<< Remote.remoteList' True
+
+syncRemotes' :: [String] -> [Remote] -> Annex [Remote]
+syncRemotes' ps remotelist = ifM (Annex.getState Annex.fast) ( nub <$> pickfast , wanted )
   where
-	pickfast = (++) <$> listed <*> (filterM good =<< fastest <$> available)
+	pickfast = (++) <$> listed <*> (filterM good (fastest available))
 	
 	wanted
-		| null rs = filterM good =<< concat . Remote.byCost <$> available
+		| null ps = filterM good (concat $ Remote.byCost available)
 		| otherwise = listed
 	
-	listed = concat <$> mapM Remote.byNameOrGroup rs
+	listed = concat <$> mapM Remote.byNameOrGroup ps
 	
 	available = filter (remoteAnnexSync . Remote.gitconfig)
-		. filter (not . Remote.isXMPPRemote)
-		<$> Remote.remoteList
+		$ filter (not . Remote.isXMPPRemote) remotelist
 	
 	good r
 		| Remote.gitSyncableRemote r = Remote.Git.repoAvail $ Remote.repo r

Remote.hs

@@ -20,6 +20,7 @@ module Remote (
 
 	remoteTypes,
 	remoteList,
+	remoteList',
 	gitSyncableRemote,
 	remoteMap,
 	remoteMap',

Remote/BitTorrent.hs

@@ -43,8 +43,8 @@ remote = RemoteType {
 }
 
 -- There is only one bittorrent remote, and it always exists.
-list :: Annex [Git.Repo]
-list = do
+list :: Bool -> Annex [Git.Repo]
+list _autoinit = do
 	r <- liftIO $ Git.Construct.remoteNamed "bittorrent" (pure Git.Construct.fromUnknown)
 	return [r]
 

Remote/Bup.hs

@@ -36,7 +36,7 @@ type BupRepo = String
 remote :: RemoteType
 remote = RemoteType {
 	typename = "bup",
-	enumerate = findSpecialRemotes "buprepo",
+	enumerate = const (findSpecialRemotes "buprepo"),
 	generate = gen,
 	setup = bupSetup
 }

Remote/Ddar.hs

@@ -31,7 +31,7 @@ data DdarRepo = DdarRepo
 remote :: RemoteType
 remote = RemoteType {
 	typename = "ddar",
-	enumerate = findSpecialRemotes "ddarrepo",
+	enumerate = const (findSpecialRemotes "ddarrepo"),
 	generate = gen,
 	setup = ddarSetup
 }

Remote/Directory.hs

@@ -33,7 +33,7 @@ import Utility.Metered
 remote :: RemoteType
 remote = RemoteType {
 	typename = "directory",
-	enumerate = findSpecialRemotes "directory",
+	enumerate = const (findSpecialRemotes "directory"),
 	generate = gen,
 	setup = directorySetup
 }

Remote/External.hs

@@ -34,7 +34,7 @@ import qualified Data.Map as M
 remote :: RemoteType
 remote = RemoteType {
 	typename = "external",
-	enumerate = findSpecialRemotes "externaltype",
+	enumerate = const (findSpecialRemotes "externaltype"),
 	generate = gen,
 	setup = externalSetup
 }

Remote/GCrypt.hs

@@ -54,7 +54,7 @@ remote = RemoteType {
 	typename = "gcrypt",
 	-- Remote.Git takes care of enumerating gcrypt remotes too,
 	-- and will call our gen on them.
-	enumerate = return [],
+	enumerate = const (return []),
 	generate = gen,
 	setup = gCryptSetup
 }

Remote/Git.hs

@@ -67,11 +67,11 @@ remote = RemoteType {
 	setup = gitSetup
 }
 
-list :: Annex [Git.Repo]
-list = do
+list :: Bool -> Annex [Git.Repo]
+list autoinit = do
 	c <- fromRepo Git.config
 	rs <- mapM (tweakurl c) =<< fromRepo Git.remotes
-	mapM configRead rs
+	mapM (configRead autoinit) rs
   where
 	annexurl n = "remote." ++ n ++ ".annexurl"
 	tweakurl c r = do
@@ -116,14 +116,14 @@ gitSetup (Just u) _ c = do
  -
  - Conversely, the config of an URL remote is only read when there is no
  - cached UUID value. -}
-configRead :: Git.Repo -> Annex Git.Repo
-configRead r = do
+configRead :: Bool -> Git.Repo -> Annex Git.Repo
+configRead autoinit r = do
 	gc <- Annex.getRemoteGitConfig r
 	u <- getRepoUUID r
 	case (repoCheap r, remoteAnnexIgnore gc, u) of
 		(_, True, _) -> return r
-		(True, _, _) -> tryGitConfigRead r
-		(False, _, NoUUID) -> tryGitConfigRead r
+		(True, _, _) -> tryGitConfigRead autoinit r
+		(False, _, NoUUID) -> tryGitConfigRead autoinit r
 		_ -> return r
 
 gen :: Git.Repo -> UUID -> RemoteConfig -> RemoteGitConfig -> Annex (Maybe Remote)
@@ -196,11 +196,12 @@ repoAvail r
 
 {- Tries to read the config for a specified remote, updates state, and
  - returns the updated repo. -}
-tryGitConfigRead :: Git.Repo -> Annex Git.Repo
-tryGitConfigRead r 
+tryGitConfigRead :: Bool -> Git.Repo -> Annex Git.Repo
+tryGitConfigRead autoinit r 
 	| haveconfig r = return r -- already read
 	| Git.repoIsSsh r = store $ do
-		v <- Ssh.onRemote r (pipedconfig, return (Left $ error "configlist failed")) "configlist" [] []
+		liftIO $ print autoinit
+		v <- Ssh.onRemote r (pipedconfig, return (Left $ error "configlist failed")) "configlist" [] configlistfields
 		case v of
 			Right r'
 				| haveconfig r' -> return r'
@@ -302,6 +303,10 @@ tryGitConfigRead r
 			Annex.BranchState.disableUpdate
 			void $ tryNonAsync $ ensureInitialized
 			Annex.getState Annex.repo
+		
+	configlistfields = if autoinit
+		then [(Fields.autoInit, "1")]
+		else []
 
 {- Checks if a given remote has the content for a key in its annex. -}
 inAnnex :: Remote -> Key -> Annex Bool

Remote/Glacier.hs

@@ -31,7 +31,7 @@ type Archive = FilePath
 remote :: RemoteType
 remote = RemoteType {
 	typename = "glacier",
-	enumerate = findSpecialRemotes "glacier",
+	enumerate = const (findSpecialRemotes "glacier"),
 	generate = gen,
 	setup = glacierSetup
 }

Remote/Hook.hs

@@ -27,7 +27,7 @@ type HookName = String
 remote :: RemoteType
 remote = RemoteType {
 	typename = "hook",
-	enumerate = findSpecialRemotes "hooktype",
+	enumerate = const (findSpecialRemotes "hooktype"),
 	generate = gen,
 	setup = hookSetup
 }

Remote/List.hs

@@ -72,14 +72,19 @@ remoteList :: Annex [Remote]
 remoteList = do
 	rs <- Annex.getState Annex.remotes
 	if null rs
-		then do
-			m <- readRemoteLog
-			rs' <- concat <$> mapM (process m) remoteTypes
-			Annex.changeState $ \s -> s { Annex.remotes = rs' }
-			return rs'
+		then remoteList' False
 		else return rs
+
+remoteList' :: Bool -> Annex [Remote]
+remoteList' autoinit = do
+	m <- readRemoteLog
+	rs <- concat <$> mapM (process m) remoteTypes
+	Annex.changeState $ \s -> s { Annex.remotes = rs }
+	return rs
   where
-	process m t = enumerate t >>= mapM (remoteGen m t) >>= return . catMaybes
+	process m t = enumerate t autoinit 
+		>>= mapM (remoteGen m t) 
+		>>= return . catMaybes
 
 {- Forces the remoteList to be re-generated, re-reading the git config. -}
 remoteListRefresh :: Annex [Remote]
@@ -109,7 +114,7 @@ updateRemote remote = do
   where
 	updaterepo r
 		| Git.repoIsLocal r || Git.repoIsLocalUnknown r =
-			Remote.Git.configRead r
+			Remote.Git.configRead False r
 		| otherwise = return r
 
 {- Checks if a remote is syncable using git. -}

Remote/Rsync.hs

@@ -44,7 +44,7 @@ import qualified Data.Map as M
 remote :: RemoteType
 remote = RemoteType {
 	typename = "rsync",
-	enumerate = findSpecialRemotes "rsyncurl",
+	enumerate = const (findSpecialRemotes "rsyncurl"),
 	generate = gen,
 	setup = rsyncSetup
 }

Remote/S3.hs

@@ -54,7 +54,7 @@ type BucketName = String
 remote :: RemoteType
 remote = RemoteType {
 	typename = "S3",
-	enumerate = findSpecialRemotes "s3",
+	enumerate = const (findSpecialRemotes "s3"),
 	generate = gen,
 	setup = s3Setup
 }

Remote/Tahoe.hs

@@ -53,7 +53,7 @@ type Capability = String
 remote :: RemoteType
 remote = RemoteType {
 	typename = "tahoe",
-	enumerate = findSpecialRemotes "tahoe",
+	enumerate = const (findSpecialRemotes "tahoe"),
 	generate = gen,
 	setup = tahoeSetup
 }

Remote/Web.hs

@@ -36,8 +36,8 @@ remote = RemoteType {
 -- There is only one web remote, and it always exists.
 -- (If the web should cease to exist, remove this module and redistribute
 -- a new release to the survivors by carrier pigeon.)
-list :: Annex [Git.Repo]
-list = do
+list :: Bool -> Annex [Git.Repo]
+list _autoinit = do
 	r <- liftIO $ Git.Construct.remoteNamed "web" (pure Git.Construct.fromUnknown)
 	return [r]
 

Remote/WebDAV.hs

@@ -36,7 +36,7 @@ import Remote.WebDAV.DavLocation
 remote :: RemoteType
 remote = RemoteType {
 	typename = "webdav",
-	enumerate = findSpecialRemotes "webdav",
+	enumerate = const (findSpecialRemotes "webdav"),
 	generate = gen,
 	setup = webdavSetup
 }

Types/Remote.hs

@@ -40,7 +40,8 @@ data RemoteTypeA a = RemoteType {
 	-- human visible type name
 	typename :: String,
 	-- enumerates remotes of this type
-	enumerate :: a [Git.Repo],
+	-- The Bool is True if automatic initialization of remotes is desired
+	enumerate :: Bool -> a [Git.Repo],
 	-- generates a remote of this type
 	generate :: Git.Repo -> UUID -> RemoteConfig -> RemoteGitConfig -> a (Maybe (RemoteA a)),
 	-- initializes or changes a remote

debian/changelog

@@ -22,6 +22,12 @@ git-annex (5.20150732) UNRELEASED; urgency=medium
   * Linux standalone: Work around problem that prevented it from working
     properly if unpacked into a directory that contains ":" or ";" in its
     name.
+  * Simplify setup process for a ssh remote. Now it suffices to run git
+    remote add, followed by git-annex sync. Now the remote is automatically
+    initialized for use by git-annex, where before the git-annex branch had
+    to manually be pushed before using git-annex sync. Note that this
+    involved changes to git-annex-shell, so if the remote is using an old
+    version, the manual push is still needed.
 
  -- Joey Hess <id@joeyh.name>  Fri, 31 Jul 2015 12:31:39 -0400
 

doc/git-annex-shell.mdwn

@@ -31,7 +31,8 @@ first "/~/" or "/~user/" is expanded to the specified home directory.
 
   When run in a repository that does not yet have an annex.uuid, one
   will be created, as long as a git-annex branch has already been pushed to
-  the repository.
+  the repository, or if the autoinit= flag is used to indicate
+  initialization is desired.
 
 * inannex directory [key ...]
 
@@ -95,7 +96,7 @@ to git-annex-shell are:
   on new dashed options).
 
   Currently used fields include remoteuuid=, associatedfile=,
-  and direct=
+  direct=, and autoinit=
 
 # HOOK