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

228 lines
8.4 KiB
Haskell
Raw Normal View History

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
{- git-annex configuration
-
pid locking configuration and abstraction layer for git-annex (not actually used anywhere yet)
2015-11-12 21:47:31 +00:00
- Copyright 2012-2015 Joey Hess <id@joeyh.name>
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
-
- Licensed under the GNU GPL version 3 or higher.
-}
module Types.GitConfig (
GitConfig(..),
extractGitConfig,
RemoteGitConfig(..),
extractRemoteGitConfig,
) where
import Common
import qualified Git
import qualified Git.Config
The ssh-options git config is now used by gcrypt, rsync, and ddar special remotes that use ssh as a transport.
2015-02-12 19:44:10 +00:00
import qualified Git.Construct
better memoize core.sharedrepository handling It was memoized, but that was not used consistently. Move it to Types.GitConfig so it will auto-memoize.
2015-05-19 19:04:24 +00:00
import Git.SharedRepository
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
import Utility.DataUnits
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
optimise getUUID This avoids a Map lookup each time it's called, instead the GitConfig field lazily looks it up once and then caches.
2016-01-20 20:55:06 +00:00
import Types.UUID
annex.autoupgrade setting
2013-11-22 20:04:20 +00:00
import Types.Distribution
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
numcopies cleanup, part 2 This includes several bug fixes.
2014-01-21 21:08:49 +00:00
import Types.NumCopies
Repository tuning parameters can now be passed when initializing a repository for the first time. * init: Repository tuning parameters can now be passed when initializing a repository for the first time. For details, see http://git-annex.branchable.com/tuning/ * merge: Refuse to merge changes from a git-annex branch of a repo that has been tuned in incompatable ways.
2015-01-27 21:38:06 +00:00
import Types.Difference
add annex.used-refspec
2015-05-14 19:44:08 +00:00
import Types.RefSpec
assistant unused file handling Make sanity checker run git annex unused daily, and queue up transfers of unused files to any remotes that will have them. The transfer retrying code works for us here, so eg when a backup disk remote is plugged in, any transfers to it are done. Once the unused files reach a remote, they'll be removed locally as unwanted. If the setup does not cause unused files to go to a remote, they'll pile up, and the sanity checker detects this using some heuristics that are pretty good -- 1000 unused files, or 10% of disk used by unused files, or more disk wasted by unused files than is left free. Once it detects this, it pops up an alert in the webapp, with a button to take action. TODO: Webapp UI to configure this, and also the ability to launch an immediate cleanup of all unused files. This commit was sponsored by Simon Michael.
2014-01-23 02:48:56 +00:00
import Utility.HumanTime
support gpg.program When gpg.program is configured, it's used to get the command to run for gpg. Useful on systems that have only a gpg2 command or want to use it instead of the gpg command.
2015-09-09 22:06:49 +00:00
import Utility.Gpg (GpgCmd, mkGpgCmd)
pid locking configuration and abstraction layer for git-annex (not actually used anywhere yet)
2015-11-12 21:47:31 +00:00
import Utility.ThreadScheduler (Seconds(..))
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
{- Main git-annex settings. Each setting corresponds to a git-config key
- such as annex.foo -}
data GitConfig = GitConfig
{ annexVersion :: Maybe String
optimise getUUID This avoids a Map lookup each time it's called, instead the GitConfig field lazily looks it up once and then caches.
2016-01-20 20:55:06 +00:00
, annexUUID :: UUID
numcopies cleanup, part 2 This includes several bug fixes.
2014-01-21 21:08:49 +00:00
, annexNumCopies :: Maybe NumCopies
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
, annexDiskReserve :: Integer
, annexDirect :: Bool
, annexBackends :: [String]
, annexQueueSize :: Maybe Int
, annexBloomCapacity :: Maybe Int
, annexBloomAccuracy :: Maybe Int
, annexSshCaching :: Maybe Bool
, annexAlwaysCommit :: Bool
, annexDelayAdd :: Maybe Int
, annexHttpHeaders :: [String]
, annexHttpHeadersCommand :: Maybe String
annex.autocommit New setting, can be used to disable autocommit of changed files by the assistant, while it still does data syncing and other tasks. Also wired into webapp UI
2013-01-27 11:43:05 +00:00
, annexAutoCommit :: Bool
annex.debug can now be set to enable debug logging by default. The webapp's debugging check box does this.
2013-06-18 00:41:17 +00:00
, annexDebug :: Bool
add another setting to GitConfig
2013-01-27 13:33:19 +00:00
, annexWebOptions :: [String]
Youtube support! (And 53 other video hosts) When quvi is installed, git-annex addurl automatically uses it to detect when an page is a video, and downloads the video file. web special remote: Also support using quvi, for getting files, or checking if files exist in the web. This commit was sponsored by Mark Hepburn. Thanks!
2013-08-22 22:25:21 +00:00
, annexQuviOptions :: [String]
Added bittorrent special remote addurl behavior change: When downloading an url ending in .torrent, it will download files from bittorrent, instead of the old behavior of adding the torrent file to the repository. Added Recommends on aria2 and bittornado | bittorrent. This commit was sponsored by Asbjørn Sloth Tønnesen.
2014-12-17 03:22:46 +00:00
, annexAriaTorrentOptions :: [String]
Added annex.web-download-command setting.
2013-04-09 03:34:05 +00:00
, annexWebDownloadCommand :: Maybe String
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
, annexCrippledFileSystem :: Bool
New annex.largefiles setting, which configures which files `git annex add` and the assistant add to the annex. I would have sort of liked to put this in .gitattributes, but it seems it does not support multi-word attribute values. Also, making this a single config setting makes it easy to only parse the expression once. A natural next step would be to make the assistant `git add` files that are not annex.largefiles. OTOH, I don't think `git annex add` should `git add` such files, because git-annex command line tools are not in the business of wrapping git command line tools.
2013-03-29 20:17:13 +00:00
, annexLargeFiles :: Maybe String
annex.addsmallfiles: New option controlling what is done when adding files not matching annex.largefiles.
2016-01-28 18:04:32 +00:00
, annexAddSmallFiles :: Bool
webapp: remind user when using repositories that lack consistency checks When starting up the assistant, it'll remind about the current repository, if it doesn't have checks. And when a removable drive is plugged in, it will remind if a repository on it lacks checks. Since that might be annoying, the reminders can be turned off. This commit was sponsored by Nedialko Andreev.
2013-10-29 20:48:06 +00:00
, annexFsckNudge :: Bool
annex.autoupgrade setting
2013-11-22 20:04:20 +00:00
, annexAutoUpgrade :: AutoUpgrade
allow annex.expireunused to be set to false, as well as to a duration
2014-01-23 03:10:51 +00:00
, annexExpireUnused :: Maybe (Maybe Duration)
added annex.secure-erase-command config option.
2014-01-24 16:58:52 +00:00
, annexSecureEraseCommand :: Maybe String
annex.genmetadata can be set to make git-annex automatically set metadata (year and month) when adding files
2014-02-23 04:08:29 +00:00
, annexGenMetaData :: Bool
annex.listen can be configured, instead of using --listen
2014-03-01 04:31:17 +00:00
, annexListen :: Maybe String
annex.startupscan can be set to false to disable the assistant's startup scan.
2014-03-05 21:44:14 +00:00
, annexStartupScan :: Bool
New annex.hardlink setting. Closes: #758593 * New annex.hardlink setting. Closes: #758593 * init: Automatically detect when a repository was cloned with --shared, and set annex.hardlink=true, as well as marking the repository as untrusted. Had to reorganize Logs.Trust a bit to avoid a cycle between it and Annex.Init.
2014-09-05 17:44:09 +00:00
, annexHardLink :: Bool
annex.thin Decided it's too scary to make v6 unlocked files have 1 copy by default, but that should be available to those who need it. This is consistent with git-annex not dropping unused content without --force, etc. * Added annex.thin setting, which makes unlocked files in v6 repositories be hard linked to their content, instead of a copy. This saves disk space but means any modification of an unlocked file will lose the local (and possibly only) copy of the old version. * Enable annex.thin by default on upgrade from direct mode to v6, since direct mode made the same tradeoff. * fix: Adjusts unlocked files as configured by annex.thin.
2015-12-27 19:59:59 +00:00
, annexThin :: Bool
support gpg.program When gpg.program is configured, it's used to get the command to run for gpg. Useful on systems that have only a gpg2 command or want to use it instead of the gpg command.
2015-09-09 22:06:49 +00:00
, annexDifferences :: Differences
, annexUsedRefSpec :: Maybe RefSpec
Do verification of checksums of annex objects downloaded from remotes. * When annex objects are received into git repositories, their checksums are verified then too. * To get the old, faster, behavior of not verifying checksums, set annex.verify=false, or remote.<name>.annex-verify=false. * setkey, rekey: These commands also now verify that the provided file matches the key, unless annex.verify=false. * reinject: Already verified content; this can now be disabled by setting annex.verify=false. recvkey and reinject already did verification, so removed now duplicate code from them. fsck still does its own verification, which is ok since it does not use getViaTmp, so verification doesn't happen twice when using fsck --from.
2015-10-01 19:54:37 +00:00
, annexVerify :: Bool
pid locking configuration and abstraction layer for git-annex (not actually used anywhere yet)
2015-11-12 21:47:31 +00:00
, annexPidLock :: Bool
, annexPidLockTimeout :: Seconds
annex.addunlocked * add, addurl, import, importfeed: When in a v6 repository on a crippled filesystem, add files unlocked. * annex.addunlocked: New configuration setting, makes files always be added unlocked. (v6 only)
2016-02-16 18:43:43 +00:00
, annexAddUnlocked :: Bool
start to support core.symlinks=false Utility functions to handle no symlink mode, and converted Annex.Content to use them; still many other places to convert.
2013-02-15 20:02:35 +00:00
, coreSymlinks :: Bool
better memoize core.sharedrepository handling It was memoized, but that was not used consistently. Move it to Types.GitConfig so it will auto-memoize.
2015-05-19 19:04:24 +00:00
, coreSharedRepository :: SharedRepository
git-annex-shell: Added support for operating inside gcrypt repositories. * Note that the layout of gcrypt repositories has changed, and if you created one you must manually upgrade it. See http://git-annex.branchable.com/upgrades/gcrypt/
2013-09-24 21:25:47 +00:00
, gcryptId :: Maybe String
support gpg.program When gpg.program is configured, it's used to get the command to run for gpg. Useful on systems that have only a gpg2 command or want to use it instead of the gpg command.
2015-09-09 22:06:49 +00:00
, gpgCmd :: GpgCmd
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
}
extractGitConfig :: Git.Repo -> GitConfig
extractGitConfig r = GitConfig
start to support core.symlinks=false Utility functions to handle no symlink mode, and converted Annex.Content to use them; still many other places to convert.
2013-02-15 20:02:35 +00:00
{ annexVersion = notempty $ getmaybe (annex "version")
optimise getUUID This avoids a Map lookup each time it's called, instead the GitConfig field lazily looks it up once and then caches.
2016-01-20 20:55:06 +00:00
, annexUUID = maybe NoUUID toUUID $ getmaybe (annex "uuid")
numcopies cleanup, part 2 This includes several bug fixes.
2014-01-21 21:08:49 +00:00
, annexNumCopies = NumCopies <$> getmayberead (annex "numcopies")
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
, annexDiskReserve = fromMaybe onemegabyte $
start to support core.symlinks=false Utility functions to handle no symlink mode, and converted Annex.Content to use them; still many other places to convert.
2013-02-15 20:02:35 +00:00
readSize dataUnits =<< getmaybe (annex "diskreserve")
, annexDirect = getbool (annex "direct") False
, annexBackends = getwords (annex "backends")
, annexQueueSize = getmayberead (annex "queuesize")
, annexBloomCapacity = getmayberead (annex "bloomcapacity")
, annexBloomAccuracy = getmayberead (annex "bloomaccuracy")
, annexSshCaching = getmaybebool (annex "sshcaching")
, annexAlwaysCommit = getbool (annex "alwayscommit") True
, annexDelayAdd = getmayberead (annex "delayadd")
, annexHttpHeaders = getlist (annex "http-headers")
, annexHttpHeadersCommand = getmaybe (annex "http-headers-command")
, annexAutoCommit = getbool (annex "autocommit") True
annex.debug can now be set to enable debug logging by default. The webapp's debugging check box does this.
2013-06-18 00:41:17 +00:00
, annexDebug = getbool (annex "debug") False
start to support core.symlinks=false Utility functions to handle no symlink mode, and converted Annex.Content to use them; still many other places to convert.
2013-02-15 20:02:35 +00:00
, annexWebOptions = getwords (annex "web-options")
Youtube support! (And 53 other video hosts) When quvi is installed, git-annex addurl automatically uses it to detect when an page is a video, and downloads the video file. web special remote: Also support using quvi, for getting files, or checking if files exist in the web. This commit was sponsored by Mark Hepburn. Thanks!
2013-08-22 22:25:21 +00:00
, annexQuviOptions = getwords (annex "quvi-options")
Added bittorrent special remote addurl behavior change: When downloading an url ending in .torrent, it will download files from bittorrent, instead of the old behavior of adding the torrent file to the repository. Added Recommends on aria2 and bittornado | bittorrent. This commit was sponsored by Asbjørn Sloth Tønnesen.
2014-12-17 03:22:46 +00:00
, annexAriaTorrentOptions = getwords (annex "aria-torrent-options")
Added annex.web-download-command setting.
2013-04-09 03:34:05 +00:00
, annexWebDownloadCommand = getmaybe (annex "web-download-command")
start to support core.symlinks=false Utility functions to handle no symlink mode, and converted Annex.Content to use them; still many other places to convert.
2013-02-15 20:02:35 +00:00
, annexCrippledFileSystem = getbool (annex "crippledfilesystem") False
New annex.largefiles setting, which configures which files `git annex add` and the assistant add to the annex. I would have sort of liked to put this in .gitattributes, but it seems it does not support multi-word attribute values. Also, making this a single config setting makes it easy to only parse the expression once. A natural next step would be to make the assistant `git add` files that are not annex.largefiles. OTOH, I don't think `git annex add` should `git add` such files, because git-annex command line tools are not in the business of wrapping git command line tools.
2013-03-29 20:17:13 +00:00
, annexLargeFiles = getmaybe (annex "largefiles")
annex.addsmallfiles: New option controlling what is done when adding files not matching annex.largefiles.
2016-01-28 18:04:32 +00:00
, annexAddSmallFiles = getbool (annex "addsmallfiles") True
webapp: remind user when using repositories that lack consistency checks When starting up the assistant, it'll remind about the current repository, if it doesn't have checks. And when a removable drive is plugged in, it will remind if a repository on it lacks checks. Since that might be annoying, the reminders can be turned off. This commit was sponsored by Nedialko Andreev.
2013-10-29 20:48:06 +00:00
, annexFsckNudge = getbool (annex "fscknudge") True
annex.autoupgrade setting
2013-11-22 20:04:20 +00:00
, annexAutoUpgrade = toAutoUpgrade $ getmaybe (annex "autoupgrade")
allow annex.expireunused to be set to false, as well as to a duration
2014-01-23 03:10:51 +00:00
, annexExpireUnused = maybe Nothing Just . parseDuration
<$> getmaybe (annex "expireunused")
added annex.secure-erase-command config option.
2014-01-24 16:58:52 +00:00
, annexSecureEraseCommand = getmaybe (annex "secure-erase-command")
annex.genmetadata can be set to make git-annex automatically set metadata (year and month) when adding files
2014-02-23 04:08:29 +00:00
, annexGenMetaData = getbool (annex "genmetadata") False
annex.listen can be configured, instead of using --listen
2014-03-01 04:31:17 +00:00
, annexListen = getmaybe (annex "listen")
annex.startupscan can be set to false to disable the assistant's startup scan.
2014-03-05 21:44:14 +00:00
, annexStartupScan = getbool (annex "startupscan") True
New annex.hardlink setting. Closes: #758593 * New annex.hardlink setting. Closes: #758593 * init: Automatically detect when a repository was cloned with --shared, and set annex.hardlink=true, as well as marking the repository as untrusted. Had to reorganize Logs.Trust a bit to avoid a cycle between it and Annex.Init.
2014-09-05 17:44:09 +00:00
, annexHardLink = getbool (annex "hardlink") False
annex.thin Decided it's too scary to make v6 unlocked files have 1 copy by default, but that should be available to those who need it. This is consistent with git-annex not dropping unused content without --force, etc. * Added annex.thin setting, which makes unlocked files in v6 repositories be hard linked to their content, instead of a copy. This saves disk space but means any modification of an unlocked file will lose the local (and possibly only) copy of the old version. * Enable annex.thin by default on upgrade from direct mode to v6, since direct mode made the same tradeoff. * fix: Adjusts unlocked files as configured by annex.thin.
2015-12-27 19:59:59 +00:00
, annexThin = getbool (annex "thin") False
Repository tuning parameters can now be passed when initializing a repository for the first time. * init: Repository tuning parameters can now be passed when initializing a repository for the first time. For details, see http://git-annex.branchable.com/tuning/ * merge: Refuse to merge changes from a git-annex branch of a repo that has been tuned in incompatable ways.
2015-01-27 21:38:06 +00:00
, annexDifferences = getDifferences r
add annex.used-refspec
2015-05-14 19:44:08 +00:00
, annexUsedRefSpec = either (const Nothing) Just . parseRefSpec
=<< getmaybe (annex "used-refspec")
Do verification of checksums of annex objects downloaded from remotes. * When annex objects are received into git repositories, their checksums are verified then too. * To get the old, faster, behavior of not verifying checksums, set annex.verify=false, or remote.<name>.annex-verify=false. * setkey, rekey: These commands also now verify that the provided file matches the key, unless annex.verify=false. * reinject: Already verified content; this can now be disabled by setting annex.verify=false. recvkey and reinject already did verification, so removed now duplicate code from them. fsck still does its own verification, which is ok since it does not use getViaTmp, so verification doesn't happen twice when using fsck --from.
2015-10-01 19:54:37 +00:00
, annexVerify = getbool (annex "verify") True
pid locking configuration and abstraction layer for git-annex (not actually used anywhere yet)
2015-11-12 21:47:31 +00:00
, annexPidLock = getbool (annex "pidlock") False
, annexPidLockTimeout = Seconds $ fromMaybe 300 $
getmayberead (annex "pidlocktimeout")
annex.addunlocked * add, addurl, import, importfeed: When in a v6 repository on a crippled filesystem, add files unlocked. * annex.addunlocked: New configuration setting, makes files always be added unlocked. (v6 only)
2016-02-16 18:43:43 +00:00
, annexAddUnlocked = getbool (annex "addunlocked") False
support gpg.program When gpg.program is configured, it's used to get the command to run for gpg. Useful on systems that have only a gpg2 command or want to use it instead of the gpg command.
2015-09-09 22:06:49 +00:00
, coreSymlinks = getbool "core.symlinks" True
, coreSharedRepository = getSharedRepository r
, gcryptId = getmaybe "core.gcrypt-id"
, gpgCmd = mkGpgCmd (getmaybe "gpg.program")
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
}
where
import Data.Default in Common
2015-01-28 20:11:28 +00:00
getbool k d = fromMaybe d $ getmaybebool k
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
getmaybebool k = Git.Config.isTrue =<< getmaybe k
getmayberead k = readish =<< getmaybe k
start to support core.symlinks=false Utility functions to handle no symlink mode, and converted Annex.Content to use them; still many other places to convert.
2013-02-15 20:02:35 +00:00
getmaybe k = Git.Config.getMaybe k r
getlist k = Git.Config.getList k r
add another setting to GitConfig
2013-01-27 13:33:19 +00:00
getwords k = fromMaybe [] $ words <$> getmaybe k
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
start to support core.symlinks=false Utility functions to handle no symlink mode, and converted Annex.Content to use them; still many other places to convert.
2013-02-15 20:02:35 +00:00
annex k = "annex." ++ k
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
onemegabyte = 1000000
{- Per-remote git-annex settings. Each setting corresponds to a git-config
- key such as <remote>.annex-foo, or if that is not set, a default from
- annex.foo -}
data RemoteGitConfig = RemoteGitConfig
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
{ remoteAnnexCost :: Maybe Cost
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
, remoteAnnexCostCommand :: Maybe String
, remoteAnnexIgnore :: Bool
, remoteAnnexSync :: Bool
Remotes can now be made read-only, by setting remote.<name>.annex-readonly
2014-01-02 17:12:32 +00:00
, remoteAnnexReadOnly :: Bool
Do verification of checksums of annex objects downloaded from remotes. * When annex objects are received into git repositories, their checksums are verified then too. * To get the old, faster, behavior of not verifying checksums, set annex.verify=false, or remote.<name>.annex-verify=false. * setkey, rekey: These commands also now verify that the provided file matches the key, unless annex.verify=false. * reinject: Already verified content; this can now be disabled by setting annex.verify=false. recvkey and reinject already did verification, so removed now duplicate code from them. fsck still does its own verification, which is ok since it does not use getViaTmp, so verification doesn't happen twice when using fsck --from.
2015-10-01 19:54:37 +00:00
, remoteAnnexVerify :: 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
, remoteAnnexTrustLevel :: Maybe String
, remoteAnnexStartCommand :: Maybe String
, remoteAnnexStopCommand :: Maybe String
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
, remoteAnnexAvailability :: Maybe Availability
Optimise non-bare http remotes; no longer does a 404 to the wrong url every time before trying the right url. Needs annex-bare to be set to false, which is done when initially probing the uuid of a http remote.
2014-01-26 17:03:25 +00:00
, remoteAnnexBare :: Maybe 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
Use lower case hash directories for storing files on crippled filesystems, same as is already done for bare repositories. * since this is a crippled filesystem anyway, git-annex doesn't use symlinks on it * so there's no reason to use the mixed case hash directories that we're stuck using to avoid breaking everyone's symlinks to the content * so we can do what is already done for all bare repos, and make non-bare repos on crippled filesystems use the all-lower case hash directories * which are, happily, all 3 letters long, so they cannot conflict with mixed case hash directories * so I was able to 100% fix this and even resuming `git annex add` in the test case will recover and it will all just work.
2013-04-04 19:46:33 +00:00
{- These settings are specific to particular types of remotes
- including special remotes. -}
execute remote.<name>.annex-shell on remote, if set It is useful to be able to specify an alternative git-annex-shell program to execute on the remote, e.g., to run a version not on the PATH. Use remote.<name>.annex-shell if specified, instead of the default "git-annex-shell" i.e., first so-named executable on the PATH.
2014-05-16 11:34:43 +00:00
, remoteAnnexShell :: Maybe String
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
, remoteAnnexSshOptions :: [String]
, remoteAnnexRsyncOptions :: [String]
Added ways to configure rsync options to be used only when uploading or downloading from a remote. Useful to eg limit upload bandwidth.
2014-02-02 20:06:34 +00:00
, remoteAnnexRsyncUploadOptions :: [String]
, remoteAnnexRsyncDownloadOptions :: [String]
Allow rsync to use other remote shells. Introduced a new per-remote option 'annex-rsync-transport' to specify the remote shell that it to be used with rsync. In case the value is 'ssh', connections are cached unless 'sshcaching' is unset.
2013-04-13 22:10:49 +00:00
, remoteAnnexRsyncTransport :: [String]
GnuPG options for symmetric encryption.
2013-03-11 01:33:13 +00:00
, remoteAnnexGnupgOptions :: [String]
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
, remoteAnnexRsyncUrl :: Maybe String
, remoteAnnexBupRepo :: Maybe String
Added tahoe special remote. Known problems: 1. Tries to tahoe start when daemon is already running. 2. If multiple tahoe remotes are set up on the same computer, they will have the same node.url configured by default, and this confuses tahoe commands. This commit was sponsored by LeastAuthority.com
2014-01-08 20:14:37 +00:00
, remoteAnnexTahoe :: Maybe FilePath
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
, remoteAnnexBupSplitOptions :: [String]
, remoteAnnexDirectory :: Maybe FilePath
git-annex-shell: Added support for operating inside gcrypt repositories. * Note that the layout of gcrypt repositories has changed, and if you created one you must manually upgrade it. See http://git-annex.branchable.com/upgrades/gcrypt/
2013-09-24 21:25:47 +00:00
, remoteAnnexGCrypt :: Maybe String
ddar special remote
2014-05-15 18:44:00 +00:00
, remoteAnnexDdarRepo :: Maybe String
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
, remoteAnnexHookType :: Maybe String
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
, remoteAnnexExternalType :: Maybe String
Use lower case hash directories for storing files on crippled filesystems, same as is already done for bare repositories. * since this is a crippled filesystem anyway, git-annex doesn't use symlinks on it * so there's no reason to use the mixed case hash directories that we're stuck using to avoid breaking everyone's symlinks to the content * so we can do what is already done for all bare repos, and make non-bare repos on crippled filesystems use the all-lower case hash directories * which are, happily, all 3 letters long, so they cannot conflict with mixed case hash directories * so I was able to 100% fix this and even resuming `git annex add` in the test case will recover and it will all just work.
2013-04-04 19:46:33 +00:00
{- A regular git remote's git repository config. -}
, remoteGitConfig :: Maybe GitConfig
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
}
extractRemoteGitConfig :: Git.Repo -> String -> RemoteGitConfig
extractRemoteGitConfig r remotename = RemoteGitConfig
{ remoteAnnexCost = getmayberead "cost"
, remoteAnnexCostCommand = notempty $ getmaybe "cost-command"
, remoteAnnexIgnore = getbool "ignore" False
, remoteAnnexSync = getbool "sync" True
Remotes can now be made read-only, by setting remote.<name>.annex-readonly
2014-01-02 17:12:32 +00:00
, remoteAnnexReadOnly = getbool "readonly" False
Do verification of checksums of annex objects downloaded from remotes. * When annex objects are received into git repositories, their checksums are verified then too. * To get the old, faster, behavior of not verifying checksums, set annex.verify=false, or remote.<name>.annex-verify=false. * setkey, rekey: These commands also now verify that the provided file matches the key, unless annex.verify=false. * reinject: Already verified content; this can now be disabled by setting annex.verify=false. recvkey and reinject already did verification, so removed now duplicate code from them. fsck still does its own verification, which is ok since it does not use getViaTmp, so verification doesn't happen twice when using fsck --from.
2015-10-01 19:54:37 +00:00
, remoteAnnexVerify = getbool "verify" True
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
, remoteAnnexTrustLevel = notempty $ getmaybe "trustlevel"
, remoteAnnexStartCommand = notempty $ getmaybe "start-command"
, remoteAnnexStopCommand = notempty $ getmaybe "stop-command"
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
, remoteAnnexAvailability = getmayberead "availability"
Optimise non-bare http remotes; no longer does a 404 to the wrong url every time before trying the right url. Needs annex-bare to be set to false, which is done when initially probing the uuid of a http remote.
2014-01-26 17:03:25 +00:00
, remoteAnnexBare = getmaybebool "bare"
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
execute remote.<name>.annex-shell on remote, if set It is useful to be able to specify an alternative git-annex-shell program to execute on the remote, e.g., to run a version not on the PATH. Use remote.<name>.annex-shell if specified, instead of the default "git-annex-shell" i.e., first so-named executable on the PATH.
2014-05-16 11:34:43 +00:00
, remoteAnnexShell = getmaybe "shell"
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
, remoteAnnexSshOptions = getoptions "ssh-options"
, remoteAnnexRsyncOptions = getoptions "rsync-options"
Added ways to configure rsync options to be used only when uploading or downloading from a remote. Useful to eg limit upload bandwidth.
2014-02-02 20:06:34 +00:00
, remoteAnnexRsyncDownloadOptions = getoptions "rsync-download-options"
, remoteAnnexRsyncUploadOptions = getoptions "rsync-upload-options"
Allow rsync to use other remote shells. Introduced a new per-remote option 'annex-rsync-transport' to specify the remote shell that it to be used with rsync. In case the value is 'ssh', connections are cached unless 'sshcaching' is unset.
2013-04-13 22:10:49 +00:00
, remoteAnnexRsyncTransport = getoptions "rsync-transport"
GnuPG options for symmetric encryption.
2013-03-11 01:33:13 +00:00
, remoteAnnexGnupgOptions = getoptions "gnupg-options"
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
, remoteAnnexRsyncUrl = notempty $ getmaybe "rsyncurl"
, remoteAnnexBupRepo = getmaybe "buprepo"
Added tahoe special remote. Known problems: 1. Tries to tahoe start when daemon is already running. 2. If multiple tahoe remotes are set up on the same computer, they will have the same node.url configured by default, and this confuses tahoe commands. This commit was sponsored by LeastAuthority.com
2014-01-08 20:14:37 +00:00
, remoteAnnexTahoe = getmaybe "tahoe"
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
, remoteAnnexBupSplitOptions = getoptions "bup-split-options"
, remoteAnnexDirectory = notempty $ getmaybe "directory"
git-annex-shell: Added support for operating inside gcrypt repositories. * Note that the layout of gcrypt repositories has changed, and if you created one you must manually upgrade it. See http://git-annex.branchable.com/upgrades/gcrypt/
2013-09-24 21:25:47 +00:00
, remoteAnnexGCrypt = notempty $ getmaybe "gcrypt"
ddar special remote
2014-05-15 18:44:00 +00:00
, remoteAnnexDdarRepo = getmaybe "ddarrepo"
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
, remoteAnnexHookType = notempty $ getmaybe "hooktype"
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
, remoteAnnexExternalType = notempty $ getmaybe "externaltype"
Use lower case hash directories for storing files on crippled filesystems, same as is already done for bare repositories. * since this is a crippled filesystem anyway, git-annex doesn't use symlinks on it * so there's no reason to use the mixed case hash directories that we're stuck using to avoid breaking everyone's symlinks to the content * so we can do what is already done for all bare repos, and make non-bare repos on crippled filesystems use the all-lower case hash directories * which are, happily, all 3 letters long, so they cannot conflict with mixed case hash directories * so I was able to 100% fix this and even resuming `git annex add` in the test case will recover and it will all just work.
2013-04-04 19:46:33 +00:00
, remoteGitConfig = Nothing
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
}
where
import Data.Default in Common
2015-01-28 20:11:28 +00:00
getbool k d = fromMaybe d $ getmaybebool k
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
getmaybebool k = Git.Config.isTrue =<< getmaybe k
getmayberead k = readish =<< getmaybe k
hlint
2013-04-03 07:52:41 +00:00
getmaybe k = mplus (Git.Config.getMaybe (key k) r)
(Git.Config.getMaybe (remotekey k) r)
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
getoptions k = fromMaybe [] $ words <$> getmaybe k
key k = "annex." ++ k
remotekey k = "remote." ++ remotename ++ ".annex-" ++ k
notempty :: Maybe String -> Maybe String
notempty Nothing = Nothing
notempty (Just "") = Nothing
notempty (Just s) = Just s
The ssh-options git config is now used by gcrypt, rsync, and ddar special remotes that use ssh as a transport.
2015-02-12 19:44:10 +00:00
instance Default RemoteGitConfig where
def = extractRemoteGitConfig Git.Construct.fromUnknown "dummy"
Reference in a new issue Copy permalink