2012-05-18 22:20:53 +00:00
|
|
|
{- The current git repository.
|
|
|
|
-
|
2020-10-28 19:40:50 +00:00
|
|
|
- Copyright 2012-2020 Joey Hess <id@joeyh.name>
|
2012-05-18 22:20:53 +00:00
|
|
|
-
|
2019-03-13 19:48:14 +00:00
|
|
|
- Licensed under the GNU AGPL version 3 or higher.
|
2012-05-18 22:20:53 +00:00
|
|
|
-}
|
|
|
|
|
2020-10-28 20:24:14 +00:00
|
|
|
{-# LANGUAGE OverloadedStrings #-}
|
|
|
|
|
2012-05-18 22:20:53 +00:00
|
|
|
module Git.CurrentRepo where
|
|
|
|
|
|
|
|
import Common
|
avoid making absolute git remote path relative
When a git remote is configured with an absolute path, use that path,
rather than making it relative. If it's configured with a relative path,
use that.
Git.Construct.fromPath changed to preserve the path as-is,
rather than making it absolute. And Annex.new changed to not
convert the path to relative. Instead, Git.CurrentRepo.get
generates a relative path.
A few things that used fromAbsPath unncessarily were changed in passing to
use fromPath instead. I'm seeing fromAbsPath as a security check,
while before it was being used in some cases when the path was
known absolute already. It may be that fromAbsPath is not really needed,
but only git-annex-shell uses it now, and I'm not 100% sure that there's
not some input that would cause a relative path to be used, opening a
security hole, without the security check. So left it as-is.
Test suite passes and strace shows the configured remote url is used
unchanged in the path into it. I can't be 100% sure there's not some code
somewhere that takes an absolute path to the repo and converts it to
relative and uses it, but it seems pretty unlikely that the code paths used
for a git remote would call such code. One place I know of is gitAnnexLink,
but I'm pretty sure that git remotes never deal with annex symlinks. If
that did get called, it generates a path relative to cwd, which would have
been wrong before this change as well, when operating on a remote.
2021-02-08 17:18:01 +00:00
|
|
|
import Git
|
2012-05-18 22:20:53 +00:00
|
|
|
import Git.Types
|
|
|
|
import Git.Construct
|
|
|
|
import qualified Git.Config
|
2013-05-11 22:23:41 +00:00
|
|
|
import Utility.Env
|
2017-12-31 20:08:31 +00:00
|
|
|
import Utility.Env.Set
|
2020-10-28 20:24:14 +00:00
|
|
|
import qualified Utility.RawFilePath as R
|
|
|
|
|
|
|
|
import qualified Data.ByteString as B
|
|
|
|
import qualified System.FilePath.ByteString as P
|
2012-05-18 22:20:53 +00:00
|
|
|
|
|
|
|
{- Gets the current git repository.
|
|
|
|
-
|
|
|
|
- Honors GIT_DIR and GIT_WORK_TREE.
|
|
|
|
- Both environment variables are unset, to avoid confusing other git
|
|
|
|
- commands that also look at them. Instead, the Git module passes
|
|
|
|
- --work-tree and --git-dir to git commands it runs.
|
|
|
|
-
|
|
|
|
- When GIT_WORK_TREE or core.worktree are set, changes the working
|
|
|
|
- directory if necessary to ensure it is within the repository's work
|
|
|
|
- tree. While not needed for git commands, this is useful for anything
|
|
|
|
- else that looks for files in the worktree.
|
2018-07-17 18:25:23 +00:00
|
|
|
-
|
|
|
|
- Also works around a git bug when running some hooks. It
|
|
|
|
- runs the hooks in the top of the repository, but if GIT_WORK_TREE
|
2018-09-11 19:53:48 +00:00
|
|
|
- was relative (but not "."), it then points to the wrong directory.
|
|
|
|
- In this situation GIT_PREFIX contains the directory that
|
|
|
|
- GIT_WORK_TREE is relative to.
|
2012-05-18 22:20:53 +00:00
|
|
|
-}
|
|
|
|
get :: IO Repo
|
|
|
|
get = do
|
2018-09-11 19:53:48 +00:00
|
|
|
gd <- getpathenv "GIT_DIR"
|
2012-10-17 18:28:05 +00:00
|
|
|
r <- configure gd =<< fromCwd
|
2018-09-11 19:53:48 +00:00
|
|
|
prefix <- getpathenv "GIT_PREFIX"
|
2020-10-28 20:24:14 +00:00
|
|
|
wt <- maybe (worktree (location r)) Just
|
2018-09-11 19:53:48 +00:00
|
|
|
<$> getpathenvprefix "GIT_WORK_TREE" prefix
|
2012-05-18 22:20:53 +00:00
|
|
|
case wt of
|
avoid making absolute git remote path relative
When a git remote is configured with an absolute path, use that path,
rather than making it relative. If it's configured with a relative path,
use that.
Git.Construct.fromPath changed to preserve the path as-is,
rather than making it absolute. And Annex.new changed to not
convert the path to relative. Instead, Git.CurrentRepo.get
generates a relative path.
A few things that used fromAbsPath unncessarily were changed in passing to
use fromPath instead. I'm seeing fromAbsPath as a security check,
while before it was being used in some cases when the path was
known absolute already. It may be that fromAbsPath is not really needed,
but only git-annex-shell uses it now, and I'm not 100% sure that there's
not some input that would cause a relative path to be used, opening a
security hole, without the security check. So left it as-is.
Test suite passes and strace shows the configured remote url is used
unchanged in the path into it. I can't be 100% sure there's not some code
somewhere that takes an absolute path to the repo and converts it to
relative and uses it, but it seems pretty unlikely that the code paths used
for a git remote would call such code. One place I know of is gitAnnexLink,
but I'm pretty sure that git remotes never deal with annex symlinks. If
that did get called, it generates a path relative to cwd, which would have
been wrong before this change as well, when operating on a remote.
2021-02-08 17:18:01 +00:00
|
|
|
Nothing -> relPath r
|
2012-05-18 22:20:53 +00:00
|
|
|
Just d -> do
|
2020-10-28 20:24:14 +00:00
|
|
|
curr <- R.getCurrentDirectory
|
2014-06-10 23:20:14 +00:00
|
|
|
unless (d `dirContains` curr) $
|
2020-10-28 20:24:14 +00:00
|
|
|
setCurrentDirectory (fromRawFilePath d)
|
avoid making absolute git remote path relative
When a git remote is configured with an absolute path, use that path,
rather than making it relative. If it's configured with a relative path,
use that.
Git.Construct.fromPath changed to preserve the path as-is,
rather than making it absolute. And Annex.new changed to not
convert the path to relative. Instead, Git.CurrentRepo.get
generates a relative path.
A few things that used fromAbsPath unncessarily were changed in passing to
use fromPath instead. I'm seeing fromAbsPath as a security check,
while before it was being used in some cases when the path was
known absolute already. It may be that fromAbsPath is not really needed,
but only git-annex-shell uses it now, and I'm not 100% sure that there's
not some input that would cause a relative path to be used, opening a
security hole, without the security check. So left it as-is.
Test suite passes and strace shows the configured remote url is used
unchanged in the path into it. I can't be 100% sure there's not some code
somewhere that takes an absolute path to the repo and converts it to
relative and uses it, but it seems pretty unlikely that the code paths used
for a git remote would call such code. One place I know of is gitAnnexLink,
but I'm pretty sure that git remotes never deal with annex symlinks. If
that did get called, it generates a path relative to cwd, which would have
been wrong before this change as well, when operating on a remote.
2021-02-08 17:18:01 +00:00
|
|
|
relPath $ addworktree wt r
|
2012-12-13 04:24:19 +00:00
|
|
|
where
|
2018-07-17 18:25:23 +00:00
|
|
|
getpathenv s = do
|
2012-12-13 04:24:19 +00:00
|
|
|
v <- getEnv s
|
|
|
|
case v of
|
|
|
|
Just d -> do
|
2014-10-16 00:33:52 +00:00
|
|
|
unsetEnv s
|
2020-10-28 20:24:14 +00:00
|
|
|
return (Just (toRawFilePath d))
|
2012-12-13 04:24:19 +00:00
|
|
|
Nothing -> return Nothing
|
2018-07-17 18:25:23 +00:00
|
|
|
|
2020-10-28 20:24:14 +00:00
|
|
|
getpathenvprefix s (Just prefix) | not (B.null prefix) =
|
2018-09-11 19:53:48 +00:00
|
|
|
getpathenv s >>= \case
|
|
|
|
Nothing -> return Nothing
|
|
|
|
Just d
|
|
|
|
| d == "." -> return (Just d)
|
2020-10-28 20:24:14 +00:00
|
|
|
| otherwise -> Just
|
|
|
|
<$> absPath (prefix P.</> d)
|
2018-09-11 19:53:48 +00:00
|
|
|
getpathenvprefix s _ = getpathenv s
|
Additional GIT_DIR support bugfixes. May actually work now.
Two fixes. First, and most importantly, relax the isLinkToAnnex check
to only look for /annex/objects/, not [^|/].git/annex/objects. If
GIT_DIR is used with a detached work tree, the git directory is
not necessarily named .git.
There are important caveats with doing that at all, since git-annex will
make symlinks that point at GIT_DIR, which means that the relative path
between GIT_DIR and GIT_WORK_TREE needs to remain stable across all clones
of the repository.
----
The other fix is just fixing crazy and wrong code that, when GIT_DIR is
set, expects to still find a git repository in the path below the work
tree, and uses some of its configuration, and some of GIT_DIR. What was I
thinking, and why can't I seem to get this code right?
2013-02-23 16:32:09 +00:00
|
|
|
|
|
|
|
configure Nothing (Just r) = Git.Config.read r
|
|
|
|
configure (Just d) _ = do
|
2020-10-28 20:24:14 +00:00
|
|
|
absd <- absPath d
|
|
|
|
curr <- R.getCurrentDirectory
|
2020-10-23 18:56:12 +00:00
|
|
|
loc <- adjustGitDirFile $ Local
|
2020-10-28 20:03:45 +00:00
|
|
|
{ gitdir = absd
|
2020-10-28 20:24:14 +00:00
|
|
|
, worktree = Just curr
|
2020-10-23 18:56:12 +00:00
|
|
|
}
|
|
|
|
r <- Git.Config.read $ newFrom loc
|
2019-11-21 17:16:42 +00:00
|
|
|
return $ if Git.Config.isBare r
|
|
|
|
then r { location = (location r) { worktree = Nothing } }
|
|
|
|
else r
|
2016-11-16 01:29:54 +00:00
|
|
|
configure Nothing Nothing = giveup "Not in a git repository."
|
Additional GIT_DIR support bugfixes. May actually work now.
Two fixes. First, and most importantly, relax the isLinkToAnnex check
to only look for /annex/objects/, not [^|/].git/annex/objects. If
GIT_DIR is used with a detached work tree, the git directory is
not necessarily named .git.
There are important caveats with doing that at all, since git-annex will
make symlinks that point at GIT_DIR, which means that the relative path
between GIT_DIR and GIT_WORK_TREE needs to remain stable across all clones
of the repository.
----
The other fix is just fixing crazy and wrong code that, when GIT_DIR is
set, expects to still find a git repository in the path below the work
tree, and uses some of its configuration, and some of GIT_DIR. What was I
thinking, and why can't I seem to get this code right?
2013-02-23 16:32:09 +00:00
|
|
|
|
2019-12-09 17:49:05 +00:00
|
|
|
addworktree w r = changelocation r $ Local
|
|
|
|
{ gitdir = gitdir (location r)
|
2020-10-28 20:24:14 +00:00
|
|
|
, worktree = w
|
2019-12-09 17:49:05 +00:00
|
|
|
}
|
2020-10-28 20:24:14 +00:00
|
|
|
|
2012-12-13 04:24:19 +00:00
|
|
|
changelocation r l = r { location = l }
|