git-annex/Command/GCryptSetup.hs

{- git-annex command
 -
 - Copyright 2013 Joey Hess <id@joeyh.name>
 -
 - Licensed under the GNU GPL version 3 or higher.
 -}

module Command.GCryptSetup where

import Command
import Annex.UUID
import qualified Remote.GCrypt
import qualified Git

cmd :: Command
cmd = dontCheck repoExists $ noCommit $
	command "gcryptsetup" SectionPlumbing 
		"sets up gcrypt repository"
		paramValue (withParams seek)

seek :: CmdParams -> CommandSeek
seek = withStrings start

start :: String -> CommandStart
start gcryptid = next $ next $ do
	u <- getUUID
	when (u /= NoUUID) $
		giveup "gcryptsetup refusing to run; this repository already has a git-annex uuid!"
	
	g <- gitRepo
	gu <- Remote.GCrypt.getGCryptUUID True g
	let newgu = genUUIDInNameSpace gCryptNameSpace gcryptid
	if isNothing gu || gu == Just newgu
		then if Git.repoIsLocalBare g
			then do
				void $ Remote.GCrypt.setupRepo gcryptid g
				return True
			else giveup "cannot use gcrypt in a non-bare repository"
		else giveup "gcryptsetup uuid mismatch"
-												git-annex-shell gcryptsetup command

This was the least-bad alternative to get dedicated key gcrypt repos
working in the assistant.

											
										
										
											2013-10-01 21:20:51 +00:00
+								{- git-annex command
 								 -
-												update my email address and homepage url

											
										
										
											2015-01-21 16:50:09 +00:00
+								 - Copyright 2013 Joey Hess <id@joeyh.name>
-												git-annex-shell gcryptsetup command

This was the least-bad alternative to get dedicated key gcrypt repos
working in the assistant.

											
										
										
											2013-10-01 21:20:51 +00:00
+								 -
 								 - Licensed under the GNU GPL version 3 or higher.
 								 -}
 								module Command.GCryptSetup where
 								import Command
 								import Annex.UUID
 								import qualified Remote.GCrypt
 								import qualified Git
-												started converting to use optparse-applicative

This is a work in progress. It compiles and is able to do basic command
dispatch, including git autocorrection, while using optparse-applicative
for the core commandline parsing.

* Many commands are temporarily disabled before conversion.
* Options are not wired in yet.
* cmdnorepo actions don't work yet.

Also, removed the [Command] list, which was only used in one place.

											
										
										
											2015-07-08 16:33:27 +00:00
+								cmd :: Command
 								cmd = dontCheck repoExists $ noCommit $
-												convert all commands to work with optparse-applicative

Still no options though.

											
										
										
											2015-07-08 19:08:02 +00:00
+									command "gcryptsetup" SectionPlumbing
 										"sets up gcrypt repository"
 										paramValue (withParams seek)
-												git-annex-shell gcryptsetup command

This was the least-bad alternative to get dedicated key gcrypt repos
working in the assistant.

											
										
										
											2013-10-01 21:20:51 +00:00
-												started converting to use optparse-applicative

This is a work in progress. It compiles and is able to do basic command
dispatch, including git autocorrection, while using optparse-applicative
for the core commandline parsing.

* Many commands are temporarily disabled before conversion.
* Options are not wired in yet.
* cmdnorepo actions don't work yet.

Also, removed the [Command] list, which was only used in one place.

											
										
										
											2015-07-08 16:33:27 +00:00
+								seek :: CmdParams -> CommandSeek
-												fix inversion of control in CommandSeek (no behavior changes)

I've been disliking how the command seek actions were written for some
time, with their inversion of control and ugly workarounds.

The last straw to fix it was sync --content, which didn't fit the
Annex [CommandStart] interface well at all. I have not yet made it take
advantage of the changed interface though.

The crucial change, and probably why I didn't do it this way from the
beginning, is to make each CommandStart action be run with exceptions
caught, and if it fails, increment a failure counter in annex state.
So I finally remove the very first code I wrote for git-annex, which
was before I had exception handling in the Annex monad, and so ran outside
that monad, passing state explicitly as it ran each CommandStart action.

This was a real slog from 1 to 5 am.

Test suite passes.

Memory usage is lower than before, sometimes by a couple of megabytes, and
remains constant, even when running in a large repo, and even when
repeatedly failing and incrementing the error counter. So no accidental
laziness space leaks.

Wall clock speed is identical, even in large repos.

This commit was sponsored by an anonymous bitcoiner.

											
										
										
											2014-01-20 08:11:42 +00:00
+								seek = withStrings start
-												git-annex-shell gcryptsetup command

This was the least-bad alternative to get dedicated key gcrypt repos
working in the assistant.

											
										
										
											2013-10-01 21:20:51 +00:00
 								start :: String -> CommandStart
 								start gcryptid = next $ next $ do
 									u <- getUUID
-												Fix enabling of gcrypt repository accessed over ssh; git-annex-shell gcryptsetup had a bug that caused it to fail with permission denied.

											
										
										
											2013-11-03 00:15:40 +00:00
+									when (u /= NoUUID) $
-												Avoid backtraces on expected failures when built with ghc 8; only use backtraces for unexpected errors.

ghc 8 added backtraces on uncaught errors. This is great, but git-annex was
using error in many places for a error message targeted at the user, in
some known problem case. A backtrace only confuses such a message, so omit it.

Notably, commands like git annex drop that failed due to eg, numcopies,
used to use error, so had a backtrace.

This commit was sponsored by Ethan Aubin.

											
										
										
											2016-11-16 01:29:54 +00:00
+										giveup "gcryptsetup refusing to run; this repository already has a git-annex uuid!"
-												Fix enabling of gcrypt repository accessed over ssh; git-annex-shell gcryptsetup had a bug that caused it to fail with permission denied.

											
										
										
											2013-11-03 00:15:40 +00:00
 									g <- gitRepo
-												git-annex-shell gcryptsetup command

This was the least-bad alternative to get dedicated key gcrypt repos
working in the assistant.

											
										
										
											2013-10-01 21:20:51 +00:00
+									gu <- Remote.GCrypt.getGCryptUUID True g
-												Fix enabling of gcrypt repository accessed over ssh; git-annex-shell gcryptsetup had a bug that caused it to fail with permission denied.

											
										
										
											2013-11-03 00:15:40 +00:00
+									let newgu = genUUIDInNameSpace gCryptNameSpace gcryptid
-												hlint

											
										
										
											2014-10-09 19:35:19 +00:00
+									if isNothing gu || gu == Just newgu
-												git-annex-shell gcryptsetup command

This was the least-bad alternative to get dedicated key gcrypt repos
working in the assistant.

											
										
										
											2013-10-01 21:20:51 +00:00
+										then if Git.repoIsLocalBare g
 											then do
 												void $ Remote.GCrypt.setupRepo gcryptid g
 												return True
-												Avoid backtraces on expected failures when built with ghc 8; only use backtraces for unexpected errors.

ghc 8 added backtraces on uncaught errors. This is great, but git-annex was
using error in many places for a error message targeted at the user, in
some known problem case. A backtrace only confuses such a message, so omit it.

Notably, commands like git annex drop that failed due to eg, numcopies,
used to use error, so had a backtrace.

This commit was sponsored by Ethan Aubin.

											
										
										
											2016-11-16 01:29:54 +00:00
+											else giveup "cannot use gcrypt in a non-bare repository"
 										else giveup "gcryptsetup uuid mismatch"