e6da7eb177
* Improved temp file handling. Transfers of content can now be resumed from temp files later; the resume does not have to be the immediate next git-annex run. * unused: Include partially transferred content in the list.
125 lines
3.8 KiB
Haskell
125 lines
3.8 KiB
Haskell
{- git-annex file locations
|
|
-
|
|
- Copyright 2010 Joey Hess <joey@kitenet.net>
|
|
-
|
|
- Licensed under the GNU GPL version 3 or higher.
|
|
-}
|
|
|
|
module Locations (
|
|
gitStateDir,
|
|
stateDir,
|
|
keyFile,
|
|
fileKey,
|
|
gitAnnexLocation,
|
|
annexLocation,
|
|
gitAnnexDir,
|
|
gitAnnexObjectDir,
|
|
gitAnnexTmpDir,
|
|
gitAnnexTmpLocation,
|
|
gitAnnexBadDir,
|
|
gitAnnexUnusedLog,
|
|
isLinkToAnnex,
|
|
|
|
prop_idempotent_fileKey
|
|
) where
|
|
|
|
import System.FilePath
|
|
import Data.String.Utils
|
|
import Data.List
|
|
|
|
import Types
|
|
import qualified GitRepo as Git
|
|
|
|
{- Conventions:
|
|
-
|
|
- Functions ending in "Dir" should always return values ending with a
|
|
- trailing path separator. Most code does not rely on that, but a few
|
|
- things do.
|
|
-
|
|
- Everything else should not end in a trailing path sepatator.
|
|
-
|
|
- Only functions (with names starting with "git") that build a path
|
|
- based on a git repository should return an absolute path.
|
|
- Everything else should use relative paths.
|
|
-}
|
|
|
|
{- Long-term, cross-repo state is stored in files inside the .git-annex
|
|
- directory, in the git repository's working tree. -}
|
|
stateDir :: FilePath
|
|
stateDir = addTrailingPathSeparator $ ".git-annex"
|
|
gitStateDir :: Git.Repo -> FilePath
|
|
gitStateDir repo = addTrailingPathSeparator $ Git.workTree repo </> stateDir
|
|
|
|
{- Annexed content is stored in .git/annex/objects; .git/annex is used
|
|
- for other temporary storage also. -}
|
|
annexDir :: FilePath
|
|
annexDir = addTrailingPathSeparator $ ".git/annex"
|
|
objectDir :: FilePath
|
|
objectDir = addTrailingPathSeparator $ annexDir </> "objects"
|
|
|
|
{- Annexed file's location relative to git's working tree.
|
|
-
|
|
- Note: Assumes repo is NOT bare.-}
|
|
annexLocation :: Key -> FilePath
|
|
annexLocation key = ".git/annex/objects" </> f </> f
|
|
where
|
|
f = keyFile key
|
|
|
|
{- Annexed file's absolute location in a repository. -}
|
|
gitAnnexLocation :: Git.Repo -> Key -> FilePath
|
|
gitAnnexLocation r key = Git.workTree r </> annexLocation key
|
|
|
|
{- The annex directory of a repository.
|
|
-
|
|
- Note: Assumes repo is NOT bare. -}
|
|
gitAnnexDir :: Git.Repo -> FilePath
|
|
gitAnnexDir r = addTrailingPathSeparator $ Git.workTree r </> annexDir
|
|
|
|
{- The part of the annex directory where file contents are stored.
|
|
-}
|
|
gitAnnexObjectDir :: Git.Repo -> FilePath
|
|
gitAnnexObjectDir r = addTrailingPathSeparator $ Git.workTree r </> objectDir
|
|
|
|
{- .git-annex/tmp/ is used for temp files -}
|
|
gitAnnexTmpDir :: Git.Repo -> FilePath
|
|
gitAnnexTmpDir r = addTrailingPathSeparator $ gitAnnexDir r </> "tmp"
|
|
|
|
{- The temp file to use for a given key. -}
|
|
gitAnnexTmpLocation :: Git.Repo -> Key -> FilePath
|
|
gitAnnexTmpLocation r key = gitAnnexTmpDir r </> keyFile key
|
|
|
|
{- .git-annex/bad/ is used for bad files found during fsck -}
|
|
gitAnnexBadDir :: Git.Repo -> FilePath
|
|
gitAnnexBadDir r = addTrailingPathSeparator $ gitAnnexDir r </> "bad"
|
|
|
|
{- .git/annex/unused is used to number possibly unused keys -}
|
|
gitAnnexUnusedLog :: Git.Repo -> FilePath
|
|
gitAnnexUnusedLog r = gitAnnexDir r </> "unused"
|
|
|
|
{- Checks a symlink target to see if it appears to point to annexed content. -}
|
|
isLinkToAnnex :: FilePath -> Bool
|
|
isLinkToAnnex s = ("/" ++ objectDir) `isInfixOf` s
|
|
|
|
{- Converts a key into a filename fragment.
|
|
-
|
|
- Escape "/" in the key name, to keep a flat tree of files and avoid
|
|
- issues with keys containing "/../" or ending with "/" etc.
|
|
-
|
|
- "/" is escaped to "%" because it's short and rarely used, and resembles
|
|
- a slash
|
|
- "%" is escaped to "&s", and "&" to "&a"; this ensures that the mapping
|
|
- is one to one.
|
|
- -}
|
|
keyFile :: Key -> FilePath
|
|
keyFile key = replace "/" "%" $ replace "%" "&s" $ replace "&" "&a" $ show key
|
|
|
|
{- Reverses keyFile, converting a filename fragment (ie, the basename of
|
|
- the symlink target) into a key. -}
|
|
fileKey :: FilePath -> Key
|
|
fileKey file = read $
|
|
replace "&a" "&" $ replace "&s" "%" $ replace "%" "/" file
|
|
|
|
{- for quickcheck -}
|
|
prop_idempotent_fileKey :: String -> Bool
|
|
prop_idempotent_fileKey s = k == fileKey (keyFile k)
|
|
where k = read $ "test:" ++ s
|