git-annex/Command/GCryptSetup.hs

{- git-annex command
 -
 - Copyright 2013 Joey Hess <id@joeyh.name>
 -
 - Licensed under the GNU AGPL 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 (commandAction . start)

start :: String -> CommandStart
start gcryptid = starting "gcryptsetup" (ActionItemOther Nothing) (SeekInput [gcryptid]) $ 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 (encodeBS gcryptid)
	if isNothing gu || gu == Just newgu
		then if Git.repoIsLocalBare g
			then do
				void $ Remote.GCrypt.setupRepo gcryptid g
				next $ 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
+								 -
-												update licenses from GPL to AGPL

This does not change the overall license of the git-annex program, which
was already AGPL due to a number of sources files being AGPL already.

Legally speaking, I'm adding a new license under which these files are
now available; I already released their current contents under the GPL
license. Now they're dual licensed GPL and AGPL. However, I intend
for all my future changes to these files to only be released under the
AGPL license, and I won't be tracking the dual licensing status, so I'm
simply changing the license statement to say it's AGPL.

(In some cases, others wrote parts of the code of a file and released it
under the GPL; but in all cases I have contributed a significant portion
of the code in each file and it's that code that is getting the AGPL
license; the GPL license of other contributors allows combining with
AGPL code.)

											
										
										
											2019-03-13 19:48:14 +00:00
+								 - Licensed under the GNU AGPL version 3 or higher.
-												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
+								 -}
 								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
-												move commandAction out of CmdLine.Seek

This is groundwork for nested seek loops, eg seeking over all files and
then performing commandActions on a list of remotes, which can be done
concurrently.

This commit was sponsored by Boyd Stephen Smith Jr. on Patreon.

											
										
										
											2018-10-01 18:12:06 +00:00
+								seek = withStrings (commandAction . 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
-												add SeekInput (not yet used)

No behavior changes (hopefully), just adding SeekInput and plumbing it
through to the JSON display code for later use.

Over the course of 2 grueling days.

withFilesNotInGit reimplemented in terms of seekHelper
should be the only possible behavior change. It seems to test as
behaving the same.

Note that seekHelper dummies up the SeekInput in the case where
segmentPaths' gives up on sorting the expanded paths because there are
too many input paths. When SeekInput later gets exposed as a json field,
that will result in it being a little bit wrong in the case where
100 or more paths are passed to a git-annex command. I think this is a
subtle enough problem to not matter. If it does turn out to be a
problem, fixing it would require splitting up the input
parameters into groups of < 100, which would make git ls-files run
perhaps more than is necessary. May want to revisit this, because that
fix seems fairly low-impact.

											
										
										
											2020-09-14 20:49:33 +00:00
+								start gcryptid = starting "gcryptsetup" (ActionItemOther Nothing) (SeekInput [gcryptid]) $ do
-												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
+									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
-												eliminate s2w8 and w82s

Note that the use of s2w8 in genUUIDInNameSpace made it truncate unicode
characters. Luckily, genUUIDInNameSpace is only ever used on ASCII
strings as far as I can determine. In particular, git-remote-gcrypt's
gcrypt-id is an ASCII string.

											
										
										
											2023-10-26 17:12:57 +00:00
+									let newgu = genUUIDInNameSpace gCryptNameSpace (encodeBS 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
-												make CommandStart return a StartMessage

The goal is to be able to run CommandStart in the main thread when -J is
used, rather than unncessarily passing it off to a worker thread, which
incurs overhead that is signficant when the CommandStart is going to
quickly decide to stop.

To do that, the message it displays needs to be displayed in the worker
thread, after the CommandStart has run.

Also, the change will mean that CommandStart will no longer necessarily
run with the same Annex state as CommandPerform. While its docs already
said it should avoid modifying Annex state, I audited all the
CommandStart code as part of the conversion. (Note that CommandSeek
already sometimes runs with a different Annex state, and that has not been
a source of any problems, so I am not too worried that this change will
lead to breakage going forward.)

The only modification of Annex state I found was it calling
allowMessages in some Commands that default to noMessages. Dealt with
that by adding a startCustomOutput and a startingUsualMessages.
This lets a command start with noMessages and then select the output it
wants for each CommandStart.

One bit of breakage: onlyActionOn has been removed from commands that used it.
The plan is that, since a StartMessage contains an ActionItem,
when a Key can be extracted from that, the parallel job runner can
run onlyActionOn' automatically. Then commands won't need to worry about
this detail. Future work.

Otherwise, this was a fairly straightforward process of making each
CommandStart compile again. Hopefully other behavior changes were mostly
avoided.

In a few cases, a command had a CommandStart that called a CommandPerform
that then called showStart multiple times. I have collapsed those
down to a single start action. The main command to perhaps suffer from it
is Command.Direct, which used to show a start for each file, and no
longer does.

Another minor behavior change is that some commands used showStart
before, but had an associated file and a Key available, so were changed
to ShowStart with an ActionItemAssociatedFile. That will not change the
normal output or behavior, but --json output will now include the key.
This should not break it for anyone using a real json parser.

											
										
										
											2019-06-06 19:42:30 +00:00
+												next $ 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"