git-annex/Command/AddUnused.hs

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

module Command.AddUnused where

import Logs.Location
import Command
import Annex.Ingest
import Command.Unused (withUnusedMaps, UnusedMaps(..), startUnused)

cmd :: Command
cmd = notDirect $ 
	command "addunused" SectionMaintenance 
		"add back unused files"
		(paramRepeating paramNumRange) (withParams seek)

seek :: CmdParams -> CommandSeek
seek = withUnusedMaps start

start :: UnusedMaps -> Int -> CommandStart
start = startUnused "addunused" perform
	(performOther "bad")
	(performOther "tmp")

perform :: Key -> CommandPerform
perform key = next $ do
	logStatus key InfoPresent
	addLink file key Nothing
	return True
  where
	file = "unused." ++ keyFile key

{- The content is not in the annex, but in another directory, and
 - it seems better to error out, rather than moving bad/tmp content into
 - the annex. -}
performOther :: String -> Key -> CommandPerform
performOther other _ = giveup $ "cannot addunused " ++ other ++ "content"
-												addunused: New command, the opposite of dropunused, it relinks unused content into the git repository.

											
										
										
											2012-05-02 18:59:05 +00:00
+								{- git-annex command
 								 -
-												update my email address and homepage url

											
										
										
											2015-01-21 16:50:09 +00:00
+								 - Copyright 2012 Joey Hess <id@joeyh.name>
-												addunused: New command, the opposite of dropunused, it relinks unused content into the git repository.

											
										
										
											2012-05-02 18:59:05 +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.
-												addunused: New command, the opposite of dropunused, it relinks unused content into the git repository.

											
										
										
											2012-05-02 18:59:05 +00:00
+								 -}
 								module Command.AddUnused where
-												addurl: Bugfix: Did not properly add file in direct mode.

											
										
										
											2013-04-11 17:35:52 +00:00
+								import Logs.Location
-												addunused: New command, the opposite of dropunused, it relinks unused content into the git repository.

											
										
										
											2012-05-02 18:59:05 +00:00
+								import Command
-												refactoring

no behavior changes

											
										
										
											2015-12-22 17:23:33 +00:00
+								import Annex.Ingest
-												--unused: New switch that makes git-annex operate on all data found by the last run of git annex unused. Supported by fsck, get, move, copy.

											
										
										
											2013-07-03 19:26:59 +00:00
+								import Command.Unused (withUnusedMaps, UnusedMaps(..), startUnused)
-												addunused: New command, the opposite of dropunused, it relinks unused content into the git repository.

											
										
										
											2012-05-02 18:59:05 +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
+								cmd :: Command
-												convert all commands to work with optparse-applicative

Still no options though.

											
										
										
											2015-07-08 19:08:02 +00:00
+								cmd = notDirect $
 									command "addunused" SectionMaintenance
 										"add back unused files"
 										(paramRepeating paramNumRange) (withParams seek)
-												addunused: New command, the opposite of dropunused, it relinks unused content into the git repository.

											
										
										
											2012-05-02 18:59:05 +00:00
-												convert all commands to work with optparse-applicative

Still no options though.

											
										
										
											2015-07-08 19:08:02 +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 = withUnusedMaps start
-												addunused: New command, the opposite of dropunused, it relinks unused content into the git repository.

											
										
										
											2012-05-02 18:59:05 +00:00
 								start :: UnusedMaps -> Int -> CommandStart
-												block all commands that don't work in direct mode

I left status working in direct mode, although it doesn't show correct
stats for known annex keys.

											
										
										
											2012-12-29 18:28:19 +00:00
+								start = startUnused "addunused" perform
 									(performOther "bad")
 									(performOther "tmp")
-												addunused: New command, the opposite of dropunused, it relinks unused content into the git repository.

											
										
										
											2012-05-02 18:59:05 +00:00
 								perform :: Key -> CommandPerform
-												addurl: Bugfix: Did not properly add file in direct mode.

											
										
										
											2013-04-11 17:35:52 +00:00
+								perform key = next $ do
 									logStatus key InfoPresent
-												refactoring

no behavior changes

											
										
										
											2015-12-22 17:23:33 +00:00
+									addLink file key Nothing
-												addurl: Bugfix: Did not properly add file in direct mode.

											
										
										
											2013-04-11 17:35:52 +00:00
+									return True
-												where indentation

											
										
										
											2012-11-12 05:05:04 +00:00
+								  where
-												avoid creating work tree files in subdirectories in an edge case

A keyName could contain "/", though this is unlikely and certianly only
ever could happen with WORM keys.

The change to addunused to escape that is no problem at all.

The change to VariantFile to escape it means that different versions of
git-annex could resolve a merge conflict differently in this case, which
is unfortunate. There would be different .variant files used, so the two
resolutions would themselves merge together without additional
conflicts, but the user would have to clean up the extra .variant
files.

											
										
										
											2019-01-14 17:07:18 +00:00
+									file = "unused." ++ keyFile key
-												addunused: New command, the opposite of dropunused, it relinks unused content into the git repository.

											
										
										
											2012-05-02 18:59:05 +00:00
 								{- The content is not in the annex, but in another directory, and
 								 - it seems better to error out, rather than moving bad/tmp content into
 								 - the annex. -}
 								performOther :: String -> Key -> CommandPerform
-												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
+								performOther other _ = giveup $ "cannot addunused " ++ other ++ "content"