2015-04-05 16:50:02 +00:00
|
|
|
{- git-annex command
|
|
|
|
-
|
|
|
|
- Copyright 2015 Joey Hess <id@joeyh.name>
|
|
|
|
-
|
2019-03-13 19:48:14 +00:00
|
|
|
- Licensed under the GNU AGPL version 3 or higher.
|
2015-04-05 16:50:02 +00:00
|
|
|
-}
|
|
|
|
|
|
|
|
module Command.Expire where
|
|
|
|
|
|
|
|
import Command
|
|
|
|
import Logs.Activity
|
|
|
|
import Logs.UUID
|
|
|
|
import Logs.MapLog
|
|
|
|
import Logs.Trust
|
|
|
|
import Annex.UUID
|
2017-08-14 17:55:38 +00:00
|
|
|
import Annex.VectorClock
|
2015-04-05 16:50:02 +00:00
|
|
|
import qualified Remote
|
|
|
|
import Utility.HumanTime
|
|
|
|
|
2020-02-28 16:57:55 +00:00
|
|
|
import Control.Monad.Fail as Fail (MonadFail(..))
|
2015-04-05 16:50:02 +00:00
|
|
|
import Data.Time.Clock.POSIX
|
|
|
|
import qualified Data.Map as M
|
|
|
|
|
2015-07-08 16:33:27 +00:00
|
|
|
cmd :: Command
|
expire, trust et al, dead, describe: Support --json and --json-error-messages
For expire, the normal output is unchanged, but the --json output includes the uuid
in machine parseable form. Which could be very useful for this somewhat obscure
command. That needed ActionItemUUID to be implemented, which seemed like a lot
of work, but then ---
I had been going to skip implementing them for trust, untrust, dead, semitrust,
and describe, but putting the uuid in the json is useful information, it tells
what uuid git-annex picked given the input. It was not hard to support
these once ActionItemUUID was implemented.
Sponsored-By: the NIH-funded NICEMAN (ReproNim TR&D3) project
2023-05-05 19:29:49 +00:00
|
|
|
cmd = withAnnexOptions [jsonOptions] $
|
|
|
|
command "expire" SectionMaintenance
|
|
|
|
"expire inactive repositories"
|
|
|
|
paramExpire (seek <$$> optParser)
|
2015-04-05 16:50:02 +00:00
|
|
|
|
|
|
|
paramExpire :: String
|
|
|
|
paramExpire = (paramRepeating $ paramOptional paramRemote ++ ":" ++ paramTime)
|
|
|
|
|
2015-07-10 20:26:23 +00:00
|
|
|
data ExpireOptions = ExpireOptions
|
|
|
|
{ expireParams :: CmdParams
|
|
|
|
, activityOption :: Maybe Activity
|
|
|
|
, noActOption :: Bool
|
|
|
|
}
|
2015-04-05 16:50:02 +00:00
|
|
|
|
2015-07-10 20:26:23 +00:00
|
|
|
optParser :: CmdParamsDesc -> Parser ExpireOptions
|
|
|
|
optParser desc = ExpireOptions
|
|
|
|
<$> cmdParams desc
|
|
|
|
<*> optional (option (str >>= parseActivity)
|
|
|
|
( long "activity" <> metavar paramName
|
|
|
|
<> help "specify activity that prevents expiry"
|
|
|
|
))
|
|
|
|
<*> switch
|
|
|
|
( long "no-act"
|
|
|
|
<> help "don't really do anything"
|
|
|
|
)
|
2015-04-05 19:02:55 +00:00
|
|
|
|
2015-07-10 20:26:23 +00:00
|
|
|
seek :: ExpireOptions -> CommandSeek
|
|
|
|
seek o = do
|
|
|
|
expire <- parseExpire (expireParams o)
|
|
|
|
actlog <- lastActivities (activityOption o)
|
2015-04-05 16:50:02 +00:00
|
|
|
u <- getUUID
|
2019-01-01 19:39:45 +00:00
|
|
|
us <- filter (/= u) . M.keys <$> uuidDescMap
|
|
|
|
descs <- uuidDescMap
|
2018-10-01 18:12:06 +00:00
|
|
|
commandActions $ map (start expire (noActOption o) actlog descs) us
|
2015-04-05 16:50:02 +00:00
|
|
|
|
2019-01-01 19:39:45 +00:00
|
|
|
start :: Expire -> Bool -> Log Activity -> UUIDDescMap -> UUID -> CommandStart
|
2015-04-05 19:02:55 +00:00
|
|
|
start (Expire expire) noact actlog descs u =
|
2015-04-05 16:50:02 +00:00
|
|
|
case lastact of
|
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
|
|
|
Just ent | notexpired ent -> checktrust (== DeadTrusted) $
|
2020-09-14 20:49:33 +00:00
|
|
|
starting "unexpire" ai si $ do
|
2023-04-10 21:03:41 +00:00
|
|
|
showNote . UnquotedString =<< whenactive
|
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
|
|
|
unless noact $
|
|
|
|
trustSet u SemiTrusted
|
|
|
|
next $ return True
|
|
|
|
_ -> checktrust (/= DeadTrusted) $
|
2020-09-14 20:49:33 +00:00
|
|
|
starting "expire" ai si $ do
|
2023-04-10 21:03:41 +00:00
|
|
|
showNote . UnquotedString =<< whenactive
|
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
|
|
|
unless noact $
|
|
|
|
trustSet u DeadTrusted
|
|
|
|
next $ return True
|
2015-04-05 16:50:02 +00:00
|
|
|
where
|
2023-11-13 18:16:55 +00:00
|
|
|
lastact = changed <$> M.lookup u (fromMapLog actlog)
|
2015-04-05 16:50:02 +00:00
|
|
|
whenactive = case lastact of
|
2017-08-14 17:55:38 +00:00
|
|
|
Just (VectorClock c) -> do
|
|
|
|
d <- liftIO $ durationSince $ posixSecondsToUTCTime c
|
2015-04-05 16:50:02 +00:00
|
|
|
return $ "last active: " ++ fromDuration d ++ " ago"
|
|
|
|
_ -> return "no activity"
|
2019-01-01 19:39:45 +00:00
|
|
|
desc = fromUUID u ++ " " ++ fromUUIDDesc (fromMaybe mempty (M.lookup u descs))
|
expire, trust et al, dead, describe: Support --json and --json-error-messages
For expire, the normal output is unchanged, but the --json output includes the uuid
in machine parseable form. Which could be very useful for this somewhat obscure
command. That needed ActionItemUUID to be implemented, which seemed like a lot
of work, but then ---
I had been going to skip implementing them for trust, untrust, dead, semitrust,
and describe, but putting the uuid in the json is useful information, it tells
what uuid git-annex picked given the input. It was not hard to support
these once ActionItemUUID was implemented.
Sponsored-By: the NIH-funded NICEMAN (ReproNim TR&D3) project
2023-05-05 19:29:49 +00:00
|
|
|
ai = ActionItemUUID u (UnquotedString desc)
|
2020-09-14 20:49:33 +00:00
|
|
|
si = SeekInput []
|
2015-04-05 16:50:02 +00:00
|
|
|
notexpired ent = case ent of
|
|
|
|
Unknown -> False
|
2017-08-14 17:55:38 +00:00
|
|
|
VectorClock c -> case lookupexpire of
|
|
|
|
Just (Just expiretime) -> c >= expiretime
|
2015-04-05 16:50:02 +00:00
|
|
|
_ -> True
|
|
|
|
lookupexpire = headMaybe $ catMaybes $
|
|
|
|
map (`M.lookup` expire) [Just u, Nothing]
|
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
|
|
|
checktrust want = stopUnless (want <$> lookupTrust u)
|
2015-04-05 16:50:02 +00:00
|
|
|
|
|
|
|
data Expire = Expire (M.Map (Maybe UUID) (Maybe POSIXTime))
|
|
|
|
|
|
|
|
parseExpire :: [String] -> Annex Expire
|
2016-11-16 01:29:54 +00:00
|
|
|
parseExpire [] = giveup "Specify an expire time."
|
2015-04-05 16:50:02 +00:00
|
|
|
parseExpire ps = do
|
|
|
|
now <- liftIO getPOSIXTime
|
|
|
|
Expire . M.fromList <$> mapM (parse now) ps
|
|
|
|
where
|
|
|
|
parse now s = case separate (== ':') s of
|
|
|
|
(t, []) -> return (Nothing, parsetime now t)
|
|
|
|
(n, t) -> do
|
|
|
|
r <- Remote.nameToUUID n
|
|
|
|
return (Just r, parsetime now t)
|
|
|
|
parsetime _ "never" = Nothing
|
|
|
|
parsetime now s = case parseDuration s of
|
2020-08-15 19:53:35 +00:00
|
|
|
Right d -> Just (now - durationToPOSIXTime d)
|
|
|
|
Left e -> giveup $ "bad expire time: " ++ e
|
2015-04-05 16:50:02 +00:00
|
|
|
|
2020-02-28 10:56:48 +00:00
|
|
|
parseActivity :: MonadFail m => String -> m Activity
|
2015-07-10 20:26:23 +00:00
|
|
|
parseActivity s = case readish s of
|
2020-02-28 10:56:48 +00:00
|
|
|
Nothing -> Fail.fail $ "Unknown activity. Choose from: " ++
|
2021-06-14 18:18:06 +00:00
|
|
|
unwords (map show allActivities)
|
2015-07-10 20:26:23 +00:00
|
|
|
Just v -> return v
|
2015-04-05 16:50:02 +00:00
|
|
|
|