2012-06-22 17:04:03 +00:00
|
|
|
{- git-annex assistant
|
|
|
|
-
|
2017-02-07 17:31:45 +00:00
|
|
|
- Copyright 2012-2017 Joey Hess <id@joeyh.name>
|
2012-06-22 17:04:03 +00:00
|
|
|
-
|
2019-03-13 19:48:14 +00:00
|
|
|
- Licensed under the GNU AGPL version 3 or higher.
|
2012-06-22 17:04:03 +00:00
|
|
|
-}
|
|
|
|
|
|
|
|
module Command.Assistant where
|
|
|
|
|
|
|
|
import Command
|
|
|
|
import qualified Command.Watch
|
2014-01-26 20:36:31 +00:00
|
|
|
import Annex.Init
|
2015-02-28 21:23:13 +00:00
|
|
|
import Annex.Path
|
2013-04-23 15:38:52 +00:00
|
|
|
import Config.Files
|
2020-11-04 18:20:37 +00:00
|
|
|
import Config.Files.AutoStart
|
2017-12-14 16:46:57 +00:00
|
|
|
import qualified BuildInfo
|
2013-10-26 16:42:58 +00:00
|
|
|
import Utility.HumanTime
|
2014-06-30 21:13:08 +00:00
|
|
|
import Assistant.Install
|
2022-09-09 18:43:43 +00:00
|
|
|
import Remote.List
|
remove dead nodes when loading the cluster log
This is to avoid inserting a cluster uuid into the location log when
only dead nodes in the cluster contain the content of a key.
One reason why this is necessary is Remote.keyLocations, which excludes
dead repositories from the list. But there are probably many more.
Implementing this was challenging, because Logs.Location importing
Logs.Cluster which imports Logs.Trust which imports Remote.List resulted
in an import cycle through several other modules.
Resorted to making Logs.Location not import Logs.Cluster, and instead
it assumes that Annex.clusters gets populated when necessary before it's
called.
That's done in Annex.Startup, which is run by the git-annex command
(but not other commands) at early startup in initialized repos. Or,
is run after initialization.
Note that is Remote.Git, it is unable to import Annex.Startup, because
Remote.Git importing Logs.Cluster leads the the same import cycle.
So ensureInitialized is not passed annexStartup in there.
Other commands, like git-annex-shell currently don't run annexStartup
either.
So there are cases where Logs.Location will not see clusters. So it won't add
any cluster UUIDs when loading the log. That's ok, the only reason to do
that is to make display of where objects are located include clusters,
and to make commands like git-annex get --from treat keys as being located
in a cluster. git-annex-shell certainly does not do anything like that,
and I'm pretty sure Remote.Git (and callers to Remote.Git.onLocalRepo)
don't either.
2024-06-16 18:35:07 +00:00
|
|
|
import Annex.Startup
|
2012-08-02 04:42:33 +00:00
|
|
|
|
2017-02-07 17:31:45 +00:00
|
|
|
import Control.Concurrent.Async
|
|
|
|
|
2015-07-08 16:33:27 +00:00
|
|
|
cmd :: Command
|
2015-07-13 15:42:42 +00:00
|
|
|
cmd = dontCheck repoExists $ notBareRepo $
|
|
|
|
noRepo (startNoRepo <$$> optParser) $
|
2015-07-08 19:39:05 +00:00
|
|
|
command "assistant" SectionCommon
|
git-annex assist
assist: New command, which is the same as git-annex sync but with
new files added and content transferred by default.
(Also this fixes another reversion in git-annex sync,
--commit --no-commit, and --message were not enabled, oops.)
See added comment for why git-annex assist does commit staged
changes elsewhere in the work tree, but only adds files under
the cwd.
Note that it does not support --no-commit, --no-push, --no-pull
like sync does. My thinking is, why should it? If you want that
level of control, use git commit, git annex push, git annex pull.
Sync only got those options because pull and push were not split
out.
Sponsored-by: k0ld on Patreon
2023-05-18 18:37:29 +00:00
|
|
|
"daemon to add files and automatically sync changes"
|
2015-07-13 15:42:42 +00:00
|
|
|
paramNothing (seek <$$> optParser)
|
2012-08-02 04:42:33 +00:00
|
|
|
|
2015-07-13 15:42:42 +00:00
|
|
|
data AssistantOptions = AssistantOptions
|
|
|
|
{ daemonOptions :: DaemonOptions
|
|
|
|
, autoStartOption :: Bool
|
|
|
|
, startDelayOption :: Maybe Duration
|
|
|
|
, autoStopOption :: Bool
|
|
|
|
}
|
2015-05-01 17:53:45 +00:00
|
|
|
|
2015-07-13 15:42:42 +00:00
|
|
|
optParser :: CmdParamsDesc -> Parser AssistantOptions
|
|
|
|
optParser _ = AssistantOptions
|
2019-09-30 18:40:46 +00:00
|
|
|
<$> parseDaemonOptions True
|
2015-07-13 15:42:42 +00:00
|
|
|
<*> switch
|
|
|
|
( long "autostart"
|
|
|
|
<> help "start in known repositories"
|
|
|
|
)
|
2020-08-15 19:53:35 +00:00
|
|
|
<*> optional (option (eitherReader parseDuration)
|
2015-07-13 15:42:42 +00:00
|
|
|
( long "startdelay" <> metavar paramNumber
|
|
|
|
<> help "delay before running startup scan"
|
|
|
|
))
|
|
|
|
<*> switch
|
|
|
|
( long "autostop"
|
|
|
|
<> help "stop in known repositories"
|
|
|
|
)
|
2013-10-26 16:42:58 +00:00
|
|
|
|
2015-07-13 15:42:42 +00:00
|
|
|
seek :: AssistantOptions -> CommandSeek
|
|
|
|
seek = commandAction . start
|
2012-08-02 04:42:33 +00:00
|
|
|
|
2015-07-13 15:42:42 +00:00
|
|
|
start :: AssistantOptions -> CommandStart
|
|
|
|
start o
|
|
|
|
| autoStartOption o = do
|
|
|
|
liftIO $ autoStart o
|
2012-08-02 04:42:33 +00:00
|
|
|
stop
|
2015-07-13 15:42:42 +00:00
|
|
|
| autoStopOption o = do
|
2015-05-01 17:53:45 +00:00
|
|
|
liftIO autoStop
|
|
|
|
stop
|
2012-08-02 04:42:33 +00:00
|
|
|
| otherwise = do
|
2014-06-30 21:13:08 +00:00
|
|
|
liftIO ensureInstalled
|
remove dead nodes when loading the cluster log
This is to avoid inserting a cluster uuid into the location log when
only dead nodes in the cluster contain the content of a key.
One reason why this is necessary is Remote.keyLocations, which excludes
dead repositories from the list. But there are probably many more.
Implementing this was challenging, because Logs.Location importing
Logs.Cluster which imports Logs.Trust which imports Remote.List resulted
in an import cycle through several other modules.
Resorted to making Logs.Location not import Logs.Cluster, and instead
it assumes that Annex.clusters gets populated when necessary before it's
called.
That's done in Annex.Startup, which is run by the git-annex command
(but not other commands) at early startup in initialized repos. Or,
is run after initialization.
Note that is Remote.Git, it is unable to import Annex.Startup, because
Remote.Git importing Logs.Cluster leads the the same import cycle.
So ensureInitialized is not passed annexStartup in there.
Other commands, like git-annex-shell currently don't run annexStartup
either.
So there are cases where Logs.Location will not see clusters. So it won't add
any cluster UUIDs when loading the log. That's ok, the only reason to do
that is to make display of where objects are located include clusters,
and to make commands like git-annex get --from treat keys as being located
in a cluster. git-annex-shell certainly does not do anything like that,
and I'm pretty sure Remote.Git (and callers to Remote.Git.onLocalRepo)
don't either.
2024-06-16 18:35:07 +00:00
|
|
|
ensureInitialized startupAnnex remoteList
|
2015-07-13 15:42:42 +00:00
|
|
|
Command.Watch.start True (daemonOptions o) (startDelayOption o)
|
2012-08-02 04:42:33 +00:00
|
|
|
|
2015-07-13 15:42:42 +00:00
|
|
|
startNoRepo :: AssistantOptions -> IO ()
|
|
|
|
startNoRepo o
|
|
|
|
| autoStartOption o = autoStart o
|
|
|
|
| autoStopOption o = autoStop
|
2016-11-16 01:29:54 +00:00
|
|
|
| otherwise = giveup "Not in a git repository."
|
2012-08-02 04:42:33 +00:00
|
|
|
|
2017-02-07 17:31:45 +00:00
|
|
|
-- Does not return
|
2015-07-13 15:42:42 +00:00
|
|
|
autoStart :: AssistantOptions -> IO ()
|
|
|
|
autoStart o = do
|
2013-03-03 21:07:27 +00:00
|
|
|
dirs <- liftIO readAutoStartFile
|
|
|
|
when (null dirs) $ do
|
|
|
|
f <- autoStartFile
|
2016-11-16 01:29:54 +00:00
|
|
|
giveup $ "Nothing listed in " ++ f
|
2015-02-28 21:23:13 +00:00
|
|
|
program <- programPath
|
2021-02-02 23:01:45 +00:00
|
|
|
haveionice <- pure BuildInfo.ionice <&&> inSearchPath "ionice"
|
2017-02-07 17:31:45 +00:00
|
|
|
pids <- forM dirs $ \d -> do
|
2013-03-03 21:07:27 +00:00
|
|
|
putStrLn $ "git-annex autostart in " ++ d
|
2017-02-07 17:31:45 +00:00
|
|
|
mpid <- catchMaybeIO $ go haveionice program d
|
|
|
|
if foregroundDaemonOption (daemonOptions o)
|
|
|
|
then return mpid
|
|
|
|
else do
|
|
|
|
case mpid of
|
|
|
|
Nothing -> putStrLn "failed"
|
|
|
|
Just pid -> ifM (checkSuccessProcess pid)
|
|
|
|
( putStrLn "ok"
|
|
|
|
, putStrLn "failed"
|
|
|
|
)
|
|
|
|
return Nothing
|
2023-03-14 02:39:16 +00:00
|
|
|
-- Wait for any foreground jobs to finish and propagate exit status.
|
2017-02-07 17:31:45 +00:00
|
|
|
ifM (all (== True) <$> mapConcurrently checkSuccessProcess (catMaybes pids))
|
|
|
|
( exitSuccess
|
|
|
|
, exitFailure
|
|
|
|
)
|
2012-11-12 05:05:04 +00:00
|
|
|
where
|
2013-06-21 17:23:20 +00:00
|
|
|
go haveionice program dir = do
|
2013-05-11 23:14:30 +00:00
|
|
|
setCurrentDirectory dir
|
2015-07-02 18:16:53 +00:00
|
|
|
-- First stop any old daemon running in this directory, which
|
|
|
|
-- might be a leftover from an old login session. Such a
|
|
|
|
-- leftover might be left in an environment where it is
|
2017-02-07 17:31:45 +00:00
|
|
|
-- unable to use the ssh agent or other login session
|
2015-07-02 18:16:53 +00:00
|
|
|
-- resources.
|
|
|
|
void $ boolSystem program [Param "assistant", Param "--stop"]
|
2017-02-07 17:31:45 +00:00
|
|
|
(Nothing, Nothing, Nothing, pid) <- createProcess p
|
|
|
|
return pid
|
2013-10-26 16:42:58 +00:00
|
|
|
where
|
2017-02-07 17:31:45 +00:00
|
|
|
p
|
|
|
|
| haveionice = proc "ionice"
|
|
|
|
(toCommand $ Param "-c3" : Param program : baseparams)
|
|
|
|
| otherwise = proc program
|
|
|
|
(toCommand baseparams)
|
|
|
|
baseparams = catMaybes
|
|
|
|
[ Just $ Param "assistant"
|
|
|
|
, Just $ Param $ "--startdelay=" ++ fromDuration (fromMaybe (Duration 5) (startDelayOption o))
|
|
|
|
, if foregroundDaemonOption (daemonOptions o)
|
|
|
|
then Just $ Param "--foreground"
|
|
|
|
else Nothing
|
2013-10-26 16:42:58 +00:00
|
|
|
]
|
2015-05-01 17:53:45 +00:00
|
|
|
|
|
|
|
autoStop :: IO ()
|
|
|
|
autoStop = do
|
|
|
|
dirs <- liftIO readAutoStartFile
|
|
|
|
program <- programPath
|
|
|
|
forM_ dirs $ \d -> do
|
|
|
|
putStrLn $ "git-annex autostop in " ++ d
|
2023-04-19 16:42:02 +00:00
|
|
|
tryIO (setCurrentDirectory d) >>= \case
|
|
|
|
Right () -> ifM (boolSystem program [Param "assistant", Param "--stop"])
|
|
|
|
( putStrLn "ok"
|
|
|
|
, putStrLn "failed"
|
|
|
|
)
|
|
|
|
Left e -> do
|
|
|
|
putStrLn (show e)
|
|
|
|
putStrLn "failed"
|