mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
git-annex/Config.hs

102 lines
3.1 KiB
Haskell
Raw Normal View History

some reorg and further remote generalization
2011-03-28 01:43:25 +00:00
{- Git configuration
-
added an optional cost= configuration to all special remotes Note that when this is specified and an older git-annex is used to enableremote such a special remote, it will simply ignore the cost= field and use whatever the default cost is. In passing, fixed adb to support the remote.name.cost and remote.name.cost-command configs. Sponsored-by: Dartmouth College's DANDI project
2023-01-12 17:42:28 +00:00
- Copyright 2011-2023 Joey Hess <id@joeyh.name>
some reorg and further remote generalization
2011-03-28 01:43:25 +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.
some reorg and further remote generalization
2011-03-28 01:43:25 +00:00
-}
use ByteString for git config The parser and looking up config keys in the map should both be faster due to using ByteString. I had hoped this would speed up startup time, but any improvement to that was too small to measure. Seems worth keeping though. Note that the parser breaks up the ByteString, but a config map ends up pointing to the config as read, which is retained in memory until every value from it is no longer used. This can change memory usage patterns marginally, but won't affect git-annex.
2019-11-27 20:54:11 +00:00
{-# LANGUAGE OverloadedStrings #-}
fix build on windows Annex.GitOverlay was using a module that needs posix to build.
2020-07-01 15:21:10 +00:00
{-# LANGUAGE CPP #-}
refactor
2015-08-17 15:21:13 +00:00
git-annex config: guard against non-repo-global configs git-annex config: Only allow configs be set that are ones git-annex actually supports reading from repo-global config, to avoid confused users trying to set other configs with this.
2020-03-02 19:50:40 +00:00
module Config (
module Config,
annexConfig,
remoteAnnexConfig,
remoteConfig,
) where
some reorg and further remote generalization
2011-03-28 01:43:25 +00:00
remove 163 lines of code without changing anything except imports
2016-01-20 20:36:33 +00:00
import Annex.Common
renamed GitRepo to Git It was always imported qualified as Git anyway
2011-06-30 17:16:57 +00:00
import qualified Git
split out three modules from Git Constructors and configuration make sense in separate modules. A separate Git.Types is needed to avoid cycles.
2011-12-13 19:05:07 +00:00
import qualified Git.Config
split out Git/Command.hs
2011-12-14 19:56:11 +00:00
import qualified Git.Command
some reorg and further remote generalization
2011-03-28 01:43:25 +00:00
import qualified Annex
split cost out into its own module Added a function to insert a new cost into a list, which could be used to asjust costs after a drag and drop.
2013-03-13 20:16:01 +00:00
import Config.Cost
use DynamicConfig to handle cost-command This commit was sponsored by Jake Vosloo on Patreon.
2017-08-17 18:04:29 +00:00
import Config.DynamicConfig
add GETAVAILABILITY to external special remote protocol And some reworking of types, and added an annex-availability git config setting.
2014-01-13 18:41:10 +00:00
import Types.Availability
git-annex config: guard against non-repo-global configs git-annex config: Only allow configs be set that are ones git-annex actually supports reading from repo-global config, to avoid confused users trying to set other configs with this.
2020-03-02 19:50:40 +00:00
import Types.GitConfig
added an optional cost= configuration to all special remotes Note that when this is specified and an older git-annex is used to enableremote such a special remote, it will simply ignore the cost= field and use whatever the default cost is. In passing, fixed adb to support the remote.name.cost and remote.name.cost-command configs. Sponsored-by: Dartmouth College's DANDI project
2023-01-12 17:42:28 +00:00
import Types.RemoteConfig
refactor
2015-08-17 15:21:13 +00:00
import Git.Types
added an optional cost= configuration to all special remotes Note that when this is specified and an older git-annex is used to enableremote such a special remote, it will simply ignore the cost= field and use whatever the default cost is. In passing, fixed adb to support the remote.name.cost and remote.name.cost-command configs. Sponsored-by: Dartmouth College's DANDI project
2023-01-12 17:42:28 +00:00
import Annex.SpecialRemote.Config
use ByteString for git config The parser and looking up config keys in the map should both be faster due to using ByteString. I had hoped this would speed up startup time, but any improvement to that was too small to measure. Seems worth keeping though. Note that the parser breaks up the ByteString, but a config map ends up pointing to the config as read, which is retained in memory until every value from it is no longer used. This can change memory usage patterns marginally, but won't affect git-annex.
2019-11-27 20:54:11 +00:00
annex.autocommit can be configured via git-annex config ... to control the default behavior in all clones of a repository. This includes a new Configurable data type, so the GitConfig type indicates which values can be configured this way. The implementation should be quite efficient; the config log is only read once, and only when a Configurable value has not already been set by git-config. Indeed, it would be nice in the future to extend this, so that git-config is itself only read on demand. Some commands may not need to look at the git configuration at all. This commit was sponsored by Trenton Cronholm on Patreon.
2017-02-03 17:40:14 +00:00
{- Looks up a setting in git config. This is not as efficient as using the
- GitConfig type. -}
all commands building except for assistant also, changed ConfigValue to a newtype, and moved it into Git.Config.
2019-12-05 18:36:43 +00:00
getConfig :: ConfigKey -> ConfigValue -> Annex ConfigValue
include git-annex-shell back in Also pushed ConfigKey down into the Git modules, which is the bulk of the changes.
2019-12-02 14:57:09 +00:00
getConfig key d = fromRepo $ Git.Config.get key d
type based git config handling for remotes Still a couple of places that use git config ad-hoc, but this is most of it done.
2013-01-01 17:52:47 +00:00
all commands building except for assistant also, changed ConfigValue to a newtype, and moved it into Git.Config.
2019-12-05 18:36:43 +00:00
getConfigMaybe :: ConfigKey -> Annex (Maybe ConfigValue)
include git-annex-shell back in Also pushed ConfigKey down into the Git modules, which is the bulk of the changes.
2019-12-02 14:57:09 +00:00
getConfigMaybe key = fromRepo $ Git.Config.getMaybe key
ignore gcrypt remotes w/o an annex-uuid
2013-09-08 19:19:14 +00:00
some reorg and further remote generalization
2011-03-28 01:43:25 +00:00
{- Changes a git config setting in both internal state and .git/config -}
setConfig :: ConfigKey -> String -> Annex ()
Fix use of several config settings annex.ssh-options, annex.rsync-options, annex.bup-split-options. And adjust types to avoid the bugs that broke several config settings recently. Now "annex." prefixing is enforced at the type level.
2012-05-06 00:15:32 +00:00
setConfig (ConfigKey key) value = do
use ByteString for git config The parser and looking up config keys in the map should both be faster due to using ByteString. I had hoped this would speed up startup time, but any improvement to that was too small to measure. Seems worth keeping though. Note that the parser breaks up the ByteString, but a config map ends up pointing to the config as read, which is retained in memory until every value from it is no longer used. This can change memory usage patterns marginally, but won't affect git-annex.
2019-11-27 20:54:11 +00:00
inRepo $ Git.Command.run
[ Param "config"
simplify and speed up Utility.FileSystemEncoding This eliminates the distinction between decodeBS and decodeBS', encodeBS and encodeBS', etc. The old implementation truncated at NUL, and the primed versions had to do extra work to avoid that problem. The new implementation does not truncate at NUL, and is also a lot faster. (Benchmarked at 2x faster for decodeBS and 3x for encodeBS; more for the primed versions.) Note that filepath-bytestring 1.4.2.1.8 contains the same optimisation, and upgrading to it will speed up to/fromRawFilePath. AFAIK, nothing relied on the old behavior of truncating at NUL. Some code used the faster versions in places where I was sure there would not be a NUL. So this change is unlikely to break anything. Also, moved s2w8 and w82s out of the module, as they do not involve filesystem encoding really. Sponsored-by: Shae Erisson on Patreon
2021-08-11 00:45:02 +00:00
, Param (decodeBS key)
use ByteString for git config The parser and looking up config keys in the map should both be faster due to using ByteString. I had hoped this would speed up startup time, but any improvement to that was too small to measure. Seems worth keeping though. Note that the parser breaks up the ByteString, but a config map ends up pointing to the config as read, which is retained in memory until every value from it is no longer used. This can change memory usage patterns marginally, but won't affect git-annex.
2019-11-27 20:54:11 +00:00
, Param value
]
cleaned up AnnexState handling in transports
2014-04-08 17:41:36 +00:00
reloadConfig
reloadConfig :: Annex ()
reloadConfig = Annex.changeGitRepo =<< inRepo Git.Config.reRead
some reorg and further remote generalization
2011-03-28 01:43:25 +00:00
Submodules are now supported by git-annex! Seems to work, but still experimental until it's been tested more. When repositories are on filesystems not supporting symlinks, the .git dir symlink trick cannot be used. Since we're going to be in direct mode anyway, the .git dir symlink is not strictly needed. However, I have not fixed the code that creates new annex symlinks to handle this case -- the committed symlinks will be wrong. git annex sync happens to currently fail in a submodule using direct mode, because there's no HEAD ref. That also needs to be dealt with to get this fully working in crippled filesystems. Leaving http://github.com/datalad/datalad/issues/44 open until these issues are dealt with.
2015-03-02 20:43:44 +00:00
{- Unsets a git config setting. (Leaves it in state.) -}
Fix use of several config settings annex.ssh-options, annex.rsync-options, annex.bup-split-options. And adjust types to avoid the bugs that broke several config settings recently. Now "annex." prefixing is enforced at the type level.
2012-05-06 00:15:32 +00:00
unsetConfig :: ConfigKey -> Annex ()
include git-annex-shell back in Also pushed ConfigKey down into the Git modules, which is the bulk of the changes.
2019-12-02 14:57:09 +00:00
unsetConfig key = void $ inRepo $ Git.Config.unset key
Fix use of several config settings annex.ssh-options, annex.rsync-options, annex.bup-split-options. And adjust types to avoid the bugs that broke several config settings recently. Now "annex." prefixing is enforced at the type level.
2012-05-06 00:15:32 +00:00
added an optional cost= configuration to all special remotes Note that when this is specified and an older git-annex is used to enableremote such a special remote, it will simply ignore the cost= field and use whatever the default cost is. In passing, fixed adb to support the remote.name.cost and remote.name.cost-command configs. Sponsored-by: Dartmouth College's DANDI project
2023-01-12 17:42:28 +00:00
{- Gets cost for a remote. As configured by
- remote.<name>.annex-cost, or if remote.<name>.annex-cost-command
- is set and prints a number, that is used. If neither is set,
- using the cost field from the ParsedRemoteConfig, and if it is not set,
- the specified default. -}
remoteCost :: RemoteGitConfig -> ParsedRemoteConfig -> Cost -> Annex Cost
remoteCost gc pc d = fromMaybe d <$> remoteCost' gc pc
external special remotes mostly implemented (untested) This has not been tested at all. It compiles! The only known missing things are support for encryption, and for get/set of special remote configuration, and of key state. (The latter needs separate work to add a new per-key log file to store that state.) Only thing I don't much like is that initremote needs to be passed both type=external and externaltype=foo. It would be better to have just type=foo Most of this is quite straightforward code, that largely wrote itself given the types. The only tricky parts were: * Need to lock the remote when using it to eg make a request, because in theory git-annex could have multiple threads that each try to use a remote at the same time. I don't think that git-annex ever does that currently, but better safe than sorry. * Rather than starting up every external special remote program when git-annex starts, they are started only on demand, when first used. This will avoid slowdown, especially when running fast git-annex query commands. Once started, they keep running until git-annex stops, currently, which may not be ideal, but it's hard to know a better time to stop them. * Bit of a chicken and egg problem with caching the cost of the remote, because setting annex-cost in the git config needs the remote to already be set up. Managed to finesse that. This commit was sponsored by Lukas Anzinger.
2013-12-26 22:23:13 +00:00
added an optional cost= configuration to all special remotes Note that when this is specified and an older git-annex is used to enableremote such a special remote, it will simply ignore the cost= field and use whatever the default cost is. In passing, fixed adb to support the remote.name.cost and remote.name.cost-command configs. Sponsored-by: Dartmouth College's DANDI project
2023-01-12 17:42:28 +00:00
remoteCost' :: RemoteGitConfig -> ParsedRemoteConfig -> Annex (Maybe Cost)
remoteCost' gc pc = maybe (getRemoteConfigValue costField pc) Just
<$> liftIO (getDynamicConfig $ remoteAnnexCost gc)
cost bugfixes
2011-03-30 19:15:46 +00:00
external special remotes mostly implemented (untested) This has not been tested at all. It compiles! The only known missing things are support for encryption, and for get/set of special remote configuration, and of key state. (The latter needs separate work to add a new per-key log file to store that state.) Only thing I don't much like is that initremote needs to be passed both type=external and externaltype=foo. It would be better to have just type=foo Most of this is quite straightforward code, that largely wrote itself given the types. The only tricky parts were: * Need to lock the remote when using it to eg make a request, because in theory git-annex could have multiple threads that each try to use a remote at the same time. I don't think that git-annex ever does that currently, but better safe than sorry. * Rather than starting up every external special remote program when git-annex starts, they are started only on demand, when first used. This will avoid slowdown, especially when running fast git-annex query commands. Once started, they keep running until git-annex stops, currently, which may not be ideal, but it's hard to know a better time to stop them. * Bit of a chicken and egg problem with caching the cost of the remote, because setting annex-cost in the git config needs the remote to already be set up. Managed to finesse that. This commit was sponsored by Lukas Anzinger.
2013-12-26 22:23:13 +00:00
setRemoteCost :: Git.Repo -> Cost -> Annex ()
remoteConfig rework remoteAnnexConfig will avoid bugs like a3a674d15be01a2ee9d27339e9eeb88b21f559dc Use now more generic remoteConfig in a couple places that built non-annex config settings manually before.
2020-02-19 17:45:11 +00:00
setRemoteCost r c = setConfig (remoteAnnexConfig r "cost") (show c)
webapp: Set locally paired repositories to a lower cost than other network remotes.
2013-03-13 18:10:29 +00:00
add GETAVAILABILITY to external special remote protocol And some reworking of types, and added an annex-availability git config setting.
2014-01-13 18:41:10 +00:00
setRemoteAvailability :: Git.Repo -> Availability -> Annex ()
remoteConfig rework remoteAnnexConfig will avoid bugs like a3a674d15be01a2ee9d27339e9eeb88b21f559dc Use now more generic remoteConfig in a couple places that built non-annex config settings manually before.
2020-02-19 17:45:11 +00:00
setRemoteAvailability r c = setConfig (remoteAnnexConfig r "availability") (show c)
add GETAVAILABILITY to external special remote protocol And some reworking of types, and added an annex-availability git config setting.
2014-01-13 18:41:10 +00:00
enableremote: Remove annex-ignore configuration from a remote.
2016-05-24 19:48:22 +00:00
setRemoteIgnore :: Git.Repo -> Bool -> Annex ()
remoteConfig rework remoteAnnexConfig will avoid bugs like a3a674d15be01a2ee9d27339e9eeb88b21f559dc Use now more generic remoteConfig in a couple places that built non-annex config settings manually before.
2020-02-19 17:45:11 +00:00
setRemoteIgnore r b = setConfig (remoteAnnexConfig r "ignore") (Git.Config.boolConfig b)
enableremote: Remove annex-ignore configuration from a remote.
2016-05-24 19:48:22 +00:00
setRemoteBare :: Git.Repo -> Bool -> Annex ()
remoteConfig rework remoteAnnexConfig will avoid bugs like a3a674d15be01a2ee9d27339e9eeb88b21f559dc Use now more generic remoteConfig in a couple places that built non-annex config settings manually before.
2020-02-19 17:45:11 +00:00
setRemoteBare r b = setConfig (remoteAnnexConfig r "bare") (Git.Config.boolConfig b)
enableremote: Remove annex-ignore configuration from a remote.
2016-05-24 19:48:22 +00:00
refactor isBareRepo
2016-06-02 20:59:15 +00:00
isBareRepo :: Annex Bool
isBareRepo = fromRepo Git.repoIsLocalBare
support for storing files in direct mode
2012-12-07 18:40:31 +00:00
isDirect :: Annex Bool
type based git config handling for remotes Still a couple of places that use git config ad-hoc, but this is most of it done.
2013-01-01 17:52:47 +00:00
isDirect = annexDirect <$> Annex.getGitConfig
annex.direct config setting
2012-12-07 17:17:13 +00:00
crippled filesystem support, probing and initial support git annex init probes for crippled filesystems, and sets direct mode, as well as `annex.crippledfilesystem`. Avoid manipulating permissions of files on crippled filesystems. That would likely cause an exception to be thrown. Very basic support in Command.Add for cripped filesystems; avoids the lock down entirely since doing it needs both permissions and hard links. Will make this better soon.
2013-02-14 18:10:36 +00:00
crippledFileSystem :: Annex Bool
crippledFileSystem = annexCrippledFileSystem <$> Annex.getGitConfig
setCrippledFileSystem :: Bool -> Annex ()
rename changeGitConfig to overrideGitConfig and avoid unncessary calls It's important that it be clear that it overrides a config, such that reloading the git config won't change it, and in particular, setConfig won't change it. Most of the calls to changeGitConfig were actually after setConfig, which was redundant and unncessary. So removed those. The only remaining one, besides --debug, is in the handling of repository-global config values. That one's ok, because the way mergeGitConfig is implemented, it does not override any value that is set in git config. If a value with a repo-global setting was passed to setConfig, it would set it in the git config, reload the git config, re-apply mergeGitConfig, and use the newly set value, which is the right thing.
2020-02-27 05:06:35 +00:00
setCrippledFileSystem b =
crippled filesystem support, probing and initial support git annex init probes for crippled filesystems, and sets direct mode, as well as `annex.crippledfilesystem`. Avoid manipulating permissions of files on crippled filesystems. That would likely cause an exception to be thrown. Very basic support in Command.Add for cripped filesystems; avoids the lock down entirely since doing it needs both permissions and hard links. Will make this better soon.
2013-02-14 18:10:36 +00:00
setConfig (annexConfig "crippledfilesystem") (Git.Config.boolConfig b)
fix build on windows Annex.GitOverlay was using a module that needs posix to build.
2020-07-01 15:21:10 +00:00
more RawFilePath conversion nukeFile replaced with removeWhenExistsWith removeLink, which allows using RawFilePath. Utility.Directory cannot use RawFilePath since setup does not depend on posix. This commit was sponsored by Graham Spencer on Patreon.
2020-10-29 14:33:12 +00:00
pidLockFile :: Annex (Maybe RawFilePath)
fix build on windows Annex.GitOverlay was using a module that needs posix to build.
2020-07-01 15:21:10 +00:00
#ifndef mingw32_HOST_OS
pidLockFile = ifM (annexPidLock <$> Annex.getGitConfig)
( Just <$> Annex.fromRepo gitAnnexPidLockFile
, pure Nothing
)
#else
pidLockFile = pure Nothing
#endif
Reference in a new issue Copy permalink