git-annex/Command/AddUnused.hs

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

{-# LANGUAGE OverloadedStrings #-}

module Command.AddUnused where

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

cmd :: Command
cmd = withAnnexOptions [jsonOptions] $
	command "addunused" SectionMaintenance 
		"add back unused files"
		(paramRepeating paramNumRange) (withParams seek)

seek :: CmdParams -> CommandSeek
seek = withUnusedMaps start

start :: UnusedMaps -> Int -> CommandStart
start = startUnused go (other "bad") (other "tmp")
  where
	go n key = do
		let file = "unused." <> keyFile key
		starting "addunused"
			(ActionItemTreeFile file)
			(SeekInput [show n]) $
			next $ do
				logStatus key InfoPresent
				addSymlink file key Nothing
				return True

	{- 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. -}
	other n _ _ = giveup $ "cannot addunused " ++ n ++ "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
 								 -
-												addunused, dropunused: Support --json and --json-error-messages

This also changes addunused to display the names of the files that it adds.
That seems like a general usability improvement, and not displaying the input
number does not seem likely to be a problem to a user, since the filename
is based on the key. Displaying the filename was necessary to get it and the key
included in the json.

dropunused does not include the key in the json. It would be possible to
add, but would need more changes. And I doubt that dropunused --json
would be used in a situation where a program cared which keys were
dropped. Note that drop --unused does have the key in its json, so such
a program could just use it. Or could just dropkey --batch with the
specific keys it wants to drop if it cares about specific keys.

Sponsored-By: the NIH-funded NICEMAN (ReproNim TR&D3) project

											
										
										
											2023-05-05 18:01:40 +00:00
+								 - Copyright 2012-2023 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
+								 -}
-												more RawFilePath conversion

535/645

This commit was sponsored by Brett Eisenberg on Patreon.

											
										
										
											2020-11-03 14:11:04 +00:00
+								{-# LANGUAGE OverloadedStrings #-}
-												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
-												addunused, dropunused: Support --json and --json-error-messages

This also changes addunused to display the names of the files that it adds.
That seems like a general usability improvement, and not displaying the input
number does not seem likely to be a problem to a user, since the filename
is based on the key. Displaying the filename was necessary to get it and the key
included in the json.

dropunused does not include the key in the json. It would be possible to
add, but would need more changes. And I doubt that dropunused --json
would be used in a situation where a program cared which keys were
dropped. Note that drop --unused does have the key in its json, so such
a program could just use it. Or could just dropkey --batch with the
specific keys it wants to drop if it cares about specific keys.

Sponsored-By: the NIH-funded NICEMAN (ReproNim TR&D3) project

											
										
										
											2023-05-05 18:01:40 +00:00
+								cmd = withAnnexOptions [jsonOptions] $
 									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
-												addunused, dropunused: Support --json and --json-error-messages

This also changes addunused to display the names of the files that it adds.
That seems like a general usability improvement, and not displaying the input
number does not seem likely to be a problem to a user, since the filename
is based on the key. Displaying the filename was necessary to get it and the key
included in the json.

dropunused does not include the key in the json. It would be possible to
add, but would need more changes. And I doubt that dropunused --json
would be used in a situation where a program cared which keys were
dropped. Note that drop --unused does have the key in its json, so such
a program could just use it. Or could just dropkey --batch with the
specific keys it wants to drop if it cares about specific keys.

Sponsored-By: the NIH-funded NICEMAN (ReproNim TR&D3) project

											
										
										
											2023-05-05 18:01:40 +00:00
+								start = startUnused go (other "bad") (other "tmp")
-												where indentation

											
										
										
											2012-11-12 05:05:04 +00:00
+								  where
-												addunused, dropunused: Support --json and --json-error-messages

This also changes addunused to display the names of the files that it adds.
That seems like a general usability improvement, and not displaying the input
number does not seem likely to be a problem to a user, since the filename
is based on the key. Displaying the filename was necessary to get it and the key
included in the json.

dropunused does not include the key in the json. It would be possible to
add, but would need more changes. And I doubt that dropunused --json
would be used in a situation where a program cared which keys were
dropped. Note that drop --unused does have the key in its json, so such
a program could just use it. Or could just dropkey --batch with the
specific keys it wants to drop if it cares about specific keys.

Sponsored-By: the NIH-funded NICEMAN (ReproNim TR&D3) project

											
										
										
											2023-05-05 18:01:40 +00:00
+									go n key = do
 										let file = "unused." <> keyFile key
 										starting "addunused"
 											(ActionItemTreeFile file)
 											(SeekInput [show n]) $
 											next $ do
 												logStatus key InfoPresent
 												addSymlink file key Nothing
 												return True
 									{- 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. -}
 									other n _ _ = giveup $ "cannot addunused " ++ n ++ "content"
-												addunused: New command, the opposite of dropunused, it relinks unused content into the git repository.

											
										
										
											2012-05-02 18:59:05 +00:00