2013-04-22 21:18:53 +00:00
|
|
|
{- git-annex command
|
|
|
|
-
|
rmurl: remove all forms of an url, no matter what the downloader is set to
* rmurl: When youtube-dl was used for an url, it no longer needs to be
prefixed with "yt:" in order to be removed.
* rmurl: If an url is both used by the web and also claimed by another
special remote, fix a bug that caused the url to to not be removed.
The youtube-dl change is a consequence of how the bug fix is implemented.
But I also think it's the right thing to do. Consider that, before,
git-annex addurl $url followed by git-annex rmurl $url would not remove the
url in the case where youtube-dl was used. That was surprising behavior.
In the unlikely case where a special remote claims an url, and it's been
added using OtherDownloader, but it was also added already as a web url,
it seems better for rmurl to remove both than to arbitrarily remove only one.
And in the case the bug report was filed for, when an url was added as a
web url, but a special remote now claims it, that should not prevent rmurl
removing the web url.
Calling setUrlMissing lets other callers of it behave differently.
Probably the calls to it in eg, Remote.External and Remote.BitTorrent are
fine, since they don't mangle the url and just remove what was provided,
and the OtherDownloader form of a bittorrent url, respectively.
I suspect unregisterurl needs to have a similar change made to rmurl, for
similar reasons.
2021-03-22 16:09:15 +00:00
|
|
|
- Copyright 2013-2021 Joey Hess <id@joeyh.name>
|
2013-04-22 21:18:53 +00:00
|
|
|
-
|
2019-03-13 19:48:14 +00:00
|
|
|
- Licensed under the GNU AGPL version 3 or higher.
|
2013-04-22 21:18:53 +00:00
|
|
|
-}
|
|
|
|
|
|
|
|
module Command.RmUrl where
|
|
|
|
|
|
|
|
import Command
|
|
|
|
import Logs.Web
|
|
|
|
|
2015-07-08 16:33:27 +00:00
|
|
|
cmd :: Command
|
|
|
|
cmd = notBareRepo $
|
2015-07-08 19:08:02 +00:00
|
|
|
command "rmurl" SectionCommon
|
|
|
|
"record file is not available at url"
|
2016-12-05 16:10:07 +00:00
|
|
|
(paramRepeating (paramPair paramFile paramUrl))
|
|
|
|
(seek <$$> optParser)
|
2013-04-22 21:18:53 +00:00
|
|
|
|
2016-12-05 16:10:07 +00:00
|
|
|
data RmUrlOptions = RmUrlOptions
|
|
|
|
{ rmThese :: CmdParams
|
|
|
|
, batchOption :: BatchMode
|
|
|
|
}
|
2013-04-22 21:18:53 +00:00
|
|
|
|
2016-12-05 16:10:07 +00:00
|
|
|
optParser :: CmdParamsDesc -> Parser RmUrlOptions
|
|
|
|
optParser desc = RmUrlOptions
|
|
|
|
<$> cmdParams desc
|
|
|
|
<*> parseBatchOption
|
|
|
|
|
|
|
|
seek :: RmUrlOptions -> CommandSeek
|
|
|
|
seek o = case batchOption o of
|
2020-09-14 20:49:33 +00:00
|
|
|
Batch fmt -> batchInput fmt batchParser (batchCommandAction . start)
|
2018-10-01 18:12:06 +00:00
|
|
|
NoBatch -> withPairs (commandAction . start) (rmThese o)
|
2016-12-05 16:10:07 +00:00
|
|
|
|
|
|
|
-- Split on the last space, since a FilePath can contain whitespace,
|
|
|
|
-- but a url should not.
|
2020-04-15 20:04:05 +00:00
|
|
|
batchParser :: String -> Annex (Either String (FilePath, URLString))
|
2016-12-05 16:10:07 +00:00
|
|
|
batchParser s = case separate (== ' ') (reverse s) of
|
|
|
|
(ru, rf)
|
2020-04-15 20:04:05 +00:00
|
|
|
| null ru || null rf -> return $ Left "Expected: \"file url\""
|
|
|
|
| otherwise -> do
|
|
|
|
let f = reverse rf
|
2020-11-02 20:31:28 +00:00
|
|
|
f' <- liftIO $ fromRawFilePath
|
|
|
|
<$> relPathCwdToFile (toRawFilePath f)
|
2020-04-15 20:04:05 +00:00
|
|
|
return $ Right (f', reverse ru)
|
2016-12-05 16:10:07 +00:00
|
|
|
|
2020-09-14 20:49:33 +00:00
|
|
|
start :: (SeekInput, (FilePath, URLString)) -> CommandStart
|
|
|
|
start (si, (file, url)) = flip whenAnnexed file' $ \_ key -> do
|
|
|
|
let ai = mkActionItem (key, AssociatedFile (Just file'))
|
|
|
|
starting "rmurl" ai si $
|
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 $ cleanup url key
|
2019-12-05 18:36:43 +00:00
|
|
|
where
|
|
|
|
file' = toRawFilePath file
|
2013-04-22 21:18:53 +00:00
|
|
|
|
|
|
|
cleanup :: String -> Key -> CommandCleanup
|
|
|
|
cleanup url key = do
|
rmurl: remove all forms of an url, no matter what the downloader is set to
* rmurl: When youtube-dl was used for an url, it no longer needs to be
prefixed with "yt:" in order to be removed.
* rmurl: If an url is both used by the web and also claimed by another
special remote, fix a bug that caused the url to to not be removed.
The youtube-dl change is a consequence of how the bug fix is implemented.
But I also think it's the right thing to do. Consider that, before,
git-annex addurl $url followed by git-annex rmurl $url would not remove the
url in the case where youtube-dl was used. That was surprising behavior.
In the unlikely case where a special remote claims an url, and it's been
added using OtherDownloader, but it was also added already as a web url,
it seems better for rmurl to remove both than to arbitrarily remove only one.
And in the case the bug report was filed for, when an url was added as a
web url, but a special remote now claims it, that should not prevent rmurl
removing the web url.
Calling setUrlMissing lets other callers of it behave differently.
Probably the calls to it in eg, Remote.External and Remote.BitTorrent are
fine, since they don't mangle the url and just remove what was provided,
and the OtherDownloader form of a bittorrent url, respectively.
I suspect unregisterurl needs to have a similar change made to rmurl, for
similar reasons.
2021-03-22 16:09:15 +00:00
|
|
|
-- Remove the url, no matter what downloader.
|
|
|
|
forM_ [minBound..maxBound] $ \dl ->
|
|
|
|
setUrlMissing key (setDownloader url dl)
|
2013-04-22 21:18:53 +00:00
|
|
|
return True
|