git-annex/Annex/Version.hs

{- git-annex repository versioning
 -
 - Copyright 2010 Joey Hess <joey@kitenet.net>
 -
 - Licensed under the GNU GPL version 3 or higher.
 -}

module Annex.Version where

import Common.Annex
import Config

type Version = String

defaultVersion :: Version
defaultVersion = "3"

supportedVersions :: [Version]
supportedVersions = [defaultVersion]

upgradableVersions :: [Version]
upgradableVersions = ["0", "1", "2"]

versionField :: ConfigKey
versionField = annexConfig "version"

getVersion :: Annex (Maybe Version)
getVersion = handle <$> getConfig versionField ""
	where
		handle [] = Nothing
		handle v = Just v

setVersion :: Annex ()
setVersion = setConfig versionField defaultVersion

removeVersion :: Annex ()
removeVersion = unsetConfig versionField

checkVersion :: Version -> Annex ()
checkVersion v
	| v `elem` supportedVersions = noop
	| v `elem` upgradableVersions = err "Upgrade this repository: git-annex upgrade"
	| otherwise = err "Upgrade git-annex."
	where
		err msg = error $ "Repository version " ++ v ++
			" is not supported. " ++ msg
add 2010-11-08 20:40:42 +00:00			`{- git-annex repository versioning`
			`-`
			`- Copyright 2010 Joey Hess <joey@kitenet.net>`
			`-`
			`- Licensed under the GNU GPL version 3 or higher.`
			`-}`

rename 2011-10-04 04:40:47 +00:00			`module Annex.Version where`
add 2010-11-08 20:40:42 +00:00
rename 2011-10-05 20:02:51 +00:00			`import Common.Annex`
some reorg and further remote generalization 2011-03-28 01:43:25 +00:00			`import Config`
add 2010-11-08 20:40:42 +00:00
Add version command to show git-annex version as well as repository version information. 2011-03-19 18:33:24 +00:00			`type Version = String`

			`defaultVersion :: Version`
start v3 2011-06-21 18:34:08 +00:00			`defaultVersion = "3"`
Add version command to show git-annex version as well as repository version information. 2011-03-19 18:33:24 +00:00
			`supportedVersions :: [Version]`
			`supportedVersions = [defaultVersion]`
add 2010-11-08 20:40:42 +00:00
No longer auto-upgrade to repository format 2, to avoid accidental upgrades, etc. Use git-annex upgrade when you're ready to run this version. 2011-03-19 22:33:39 +00:00			`upgradableVersions :: [Version]`
start v3 2011-06-21 18:34:08 +00:00			`upgradableVersions = ["0", "1", "2"]`
No longer auto-upgrade to repository format 2, to avoid accidental upgrades, etc. Use git-annex upgrade when you're ready to run this version. 2011-03-19 22:33:39 +00:00
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			`versionField :: ConfigKey`
			`versionField = annexConfig "version"`
add 2010-11-08 20:40:42 +00:00
improve version checking for v3 Do not set annex.version whenever any command is run. Just do it in init. This ensures that, if a repo has annex.version=3, it has a git-annex branch, so we don't have to run a command every time to check for the branch. Remove the old ad-hoc logic for v0 and v1, to simplify version checking. 2011-06-22 22:07:45 +00:00			`getVersion :: Annex (Maybe Version)`
use new getConfig 2012-03-22 04:23:15 +00:00			`getVersion = handle <$> getConfig versionField ""`
reorder repo parameters last Many functions took the repo as their first parameter. Changing it consistently to be the last parameter allows doing some useful things with currying, that reduce boilerplate. In particular, g <- gitRepo is almost never needed now, instead use inRepo to run an IO action in the repo, and fromRepo to get a value from the repo. This also provides more opportunities to use monadic and applicative combinators. 2011-11-08 19:34:10 +00:00			`where`
			`handle [] = Nothing`
			`handle v = Just v`
add 2010-11-08 20:40:42 +00:00
			`setVersion :: Annex ()`
some reorg and further remote generalization 2011-03-28 01:43:25 +00:00			`setVersion = setConfig versionField defaultVersion`
No longer auto-upgrade to repository format 2, to avoid accidental upgrades, etc. Use git-annex upgrade when you're ready to run this version. 2011-03-19 22:33:39 +00:00
uninit: Unset annex.version. Closes: #689852 2012-10-07 20:04:03 +00:00			`removeVersion :: Annex ()`
			`removeVersion = unsetConfig versionField`

optimise initialized check Avoid running external command if annex.version is set. 2011-08-17 22:38:26 +00:00			`checkVersion :: Version -> Annex ()`
			`checkVersion v`
noop 2012-04-22 03:32:33 +00:00			\| v `elem` supportedVersions = noop
optimise initialized check Avoid running external command if annex.version is set. 2011-08-17 22:38:26 +00:00			\| v `elem` upgradableVersions = err "Upgrade this repository: git-annex upgrade"
			`\| otherwise = err "Upgrade git-annex."`
No longer auto-upgrade to repository format 2, to avoid accidental upgrades, etc. Use git-annex upgrade when you're ready to run this version. 2011-03-19 22:33:39 +00:00			`where`
optimise initialized check Avoid running external command if annex.version is set. 2011-08-17 22:38:26 +00:00			`err msg = error $ "Repository version " ++ v ++`
			`" is not supported. " ++ msg`