git-annex/Git/Index.hs
Joey Hess 2c8cf06e75
more RawFilePath conversion
Converted file mode setting to it, and follow-on changes.

Compiles up through 369/646.

This commit was sponsored by Ethan Aubin.
2020-11-05 18:45:37 -04:00

64 lines
1.8 KiB
Haskell

{- git index file stuff
-
- Copyright 2011-2018 Joey Hess <id@joeyh.name>
-
- Licensed under the GNU AGPL version 3 or higher.
-}
{-# LANGUAGE OverloadedStrings #-}
module Git.Index where
import Common
import Git
import Utility.Env
import Utility.Env.Set
import qualified System.FilePath.ByteString as P
indexEnv :: String
indexEnv = "GIT_INDEX_FILE"
{- Gets value to set GIT_INDEX_FILE to. Input should be absolute path,
- or relative to the CWD.
-
- When relative, GIT_INDEX_FILE is interpreted by git as being
- relative to the top of the work tree of the git repository,
- not to the CWD. Worse, other environment variables (GIT_WORK_TREE)
- or git options (--work-tree) or configuration (core.worktree)
- can change what the relative path is interpreted relative to.
-
- So, an absolute path is the only safe option for this to return.
-}
indexEnvVal :: RawFilePath -> IO String
indexEnvVal p = fromRawFilePath <$> absPath p
{- Forces git to use the specified index file.
-
- Returns an action that will reset back to the default
- index file.
-
- Warning: Not thread safe.
-}
override :: RawFilePath -> Repo -> IO (IO ())
override index _r = do
res <- getEnv var
val <- indexEnvVal index
setEnv var val True
return $ reset res
where
var = "GIT_INDEX_FILE"
reset (Just v) = setEnv indexEnv v True
reset _ = unsetEnv var
{- The normal index file. Does not check GIT_INDEX_FILE. -}
indexFile :: Repo -> RawFilePath
indexFile r = localGitDir r P.</> "index"
{- The index file git will currently use, checking GIT_INDEX_FILE. -}
currentIndexFile :: Repo -> IO RawFilePath
currentIndexFile r = maybe (indexFile r) toRawFilePath <$> getEnv indexEnv
{- Git locks the index by creating this file. -}
indexFileLock :: RawFilePath -> RawFilePath
indexFileLock f = f <> ".lock"