2011-07-06 00:16:57 +00:00
|
|
|
{- git-annex remote log
|
|
|
|
-
|
2020-09-22 17:52:26 +00:00
|
|
|
- Copyright 2011-2020 Joey Hess <id@joeyh.name>
|
2011-07-06 00:16:57 +00:00
|
|
|
-
|
2019-03-13 19:48:14 +00:00
|
|
|
- Licensed under the GNU AGPL version 3 or higher.
|
2011-07-06 00:16:57 +00:00
|
|
|
-}
|
|
|
|
|
2011-10-15 20:21:08 +00:00
|
|
|
module Logs.Remote (
|
add ConfigMonitor thread
Monitors git-annex branch for changes, which are noticed by the Merger
thread whenever the branch ref is changed (either due to an incoming push,
or a local change), and refreshes cached config values for modified config
files.
Rate limited to run no more often than once per minute. This is important
because frequent git-annex branch changes happen when files are being
added, or transferred, etc.
A primary use case is that, when preferred content changes are made,
and get pushed to remotes, the remotes start honoring those settings.
Other use cases include propigating repository description and trust
changes to remotes, and learning when a remote has added a new special
remote, so the webapp can present the GUI to enable that special remote
locally.
Also added a uuid.log cache. All other config files already had caches.
2012-10-20 20:37:06 +00:00
|
|
|
remoteLog,
|
2020-09-22 17:52:26 +00:00
|
|
|
remoteConfigMap,
|
2011-07-06 00:16:57 +00:00
|
|
|
readRemoteLog,
|
|
|
|
configSet,
|
|
|
|
keyValToConfig,
|
|
|
|
configToKeyVal,
|
2012-12-20 04:02:33 +00:00
|
|
|
showConfig,
|
2011-07-06 00:16:57 +00:00
|
|
|
|
2015-11-16 18:37:31 +00:00
|
|
|
prop_isomorphic_configEscape,
|
2012-12-20 04:02:33 +00:00
|
|
|
prop_parse_show_Config,
|
2011-07-06 00:16:57 +00:00
|
|
|
) where
|
|
|
|
|
2016-01-20 20:36:33 +00:00
|
|
|
import Annex.Common
|
2020-09-22 17:52:26 +00:00
|
|
|
import qualified Annex
|
2011-10-04 04:40:47 +00:00
|
|
|
import qualified Annex.Branch
|
2011-07-06 00:16:57 +00:00
|
|
|
import Types.Remote
|
2013-08-29 22:51:22 +00:00
|
|
|
import Logs
|
2011-10-15 20:21:08 +00:00
|
|
|
import Logs.UUIDBased
|
2019-10-14 19:38:07 +00:00
|
|
|
import Logs.Remote.Pure
|
2019-10-10 19:46:12 +00:00
|
|
|
import Annex.SpecialRemote.Config
|
2011-07-06 00:16:57 +00:00
|
|
|
|
2017-08-14 17:55:38 +00:00
|
|
|
import qualified Data.Map as M
|
|
|
|
|
2011-07-06 00:16:57 +00:00
|
|
|
{- Adds or updates a remote's config in the log. -}
|
|
|
|
configSet :: UUID -> RemoteConfig -> Annex ()
|
2017-08-14 17:55:38 +00:00
|
|
|
configSet u cfg = do
|
2020-12-23 19:21:33 +00:00
|
|
|
c <- currentVectorClock
|
2011-10-06 20:07:51 +00:00
|
|
|
Annex.Branch.change remoteLog $
|
2019-10-15 15:33:33 +00:00
|
|
|
buildRemoteConfigLog
|
2019-10-10 19:46:12 +00:00
|
|
|
. changeLog c u (removeSameasInherited cfg)
|
2019-10-15 15:33:33 +00:00
|
|
|
. parseRemoteConfigLog
|
2020-09-22 17:52:26 +00:00
|
|
|
Annex.changeState $ \s -> s { Annex.remoteconfigmap = Nothing }
|
|
|
|
|
|
|
|
{- Map of remotes by uuid containing key/value config maps.
|
|
|
|
- Cached for speed. -}
|
|
|
|
remoteConfigMap :: Annex (M.Map UUID RemoteConfig)
|
|
|
|
remoteConfigMap = maybe remoteConfigMapLoad return
|
|
|
|
=<< Annex.getState Annex.remoteconfigmap
|
|
|
|
|
|
|
|
remoteConfigMapLoad :: Annex (M.Map UUID RemoteConfig)
|
|
|
|
remoteConfigMapLoad = do
|
|
|
|
m <- readRemoteLog
|
|
|
|
Annex.changeState $ \s -> s { Annex.remoteconfigmap = Just m }
|
|
|
|
return m
|
2011-07-06 00:16:57 +00:00
|
|
|
|
|
|
|
readRemoteLog :: Annex (M.Map UUID RemoteConfig)
|
2019-10-14 19:38:07 +00:00
|
|
|
readRemoteLog = calcRemoteConfigMap
|
convert old uuid-based log parsers to attoparsec
This preserves the workaround for the old bug that caused NoUUID items
to be stored in the log, prefixing log lines with " ". It's now handled
implicitly, by using takeWhile1 (/= ' ') to get the uuid.
There is a behavior change from the old parser, which split the value
into words and then recombined it. That meant that "foo bar" and "foo\tbar"
came out as "foo bar". That behavior was not documented, and seems
surprising; it meant that after a git-annex describe here "foo bar",
you wouldn't get that same string back out when git-annex displayed repo
descriptions.
Otoh, some other parsers relied on the old behavior, and the attoparsec
rewrites had to deal with the issue themselves...
For group.log, there are some edge cases around the user providing a
group name with a leading or trailing space. The old parser would ignore
such excess whitespace. The new parser does too, because the alternative
is to refuse to parse something like " group1 group2 " due to excess
whitespace, which would be even more confusing behavior.
The only git-annex branch log file that is not converted to attoparsec
and bytestring-builder now is transitions.log.
2019-01-10 18:39:36 +00:00
|
|
|
<$> Annex.Branch.get remoteLog
|