2012-12-13 19:44:56 +00:00
|
|
|
{- git-annex command
|
|
|
|
-
|
|
|
|
- Copyright 2012 Joey Hess <joey@kitenet.net>
|
|
|
|
-
|
|
|
|
- Licensed under the GNU GPL version 3 or higher.
|
|
|
|
-}
|
|
|
|
|
|
|
|
module Command.Indirect where
|
|
|
|
|
2013-09-25 19:29:56 +00:00
|
|
|
import Control.Exception.Extensible
|
2013-05-11 20:03:00 +00:00
|
|
|
|
2012-12-13 19:44:56 +00:00
|
|
|
import Common.Annex
|
|
|
|
import Command
|
|
|
|
import qualified Git
|
|
|
|
import qualified Git.Command
|
|
|
|
import qualified Git.LsFiles
|
2013-09-19 18:48:42 +00:00
|
|
|
import Git.FileMode
|
2012-12-13 19:44:56 +00:00
|
|
|
import Config
|
fully support core.symlinks=false in all relevant symlink handling code
Refactored annex link code into nice clean new library.
Audited and dealt with calls to createSymbolicLink.
Remaining calls are all safe, because:
Annex/Link.hs: ( liftIO $ createSymbolicLink linktarget file
only when core.symlinks=true
Assistant/WebApp/Configurators/Local.hs: createSymbolicLink link link
test if symlinks can be made
Command/Fix.hs: liftIO $ createSymbolicLink link file
command only works in indirect mode
Command/FromKey.hs: liftIO $ createSymbolicLink link file
command only works in indirect mode
Command/Indirect.hs: liftIO $ createSymbolicLink l f
refuses to run if core.symlinks=false
Init.hs: createSymbolicLink f f2
test if symlinks can be made
Remote/Directory.hs: go [file] = catchBoolIO $ createSymbolicLink file f >> return True
fast key linking; catches failure to make symlink and falls back to copy
Remote/Git.hs: liftIO $ catchBoolIO $ createSymbolicLink loc file >> return True
ditto
Upgrade/V1.hs: liftIO $ createSymbolicLink link f
v1 repos could not be on a filesystem w/o symlinks
Audited and dealt with calls to readSymbolicLink.
Remaining calls are all safe, because:
Annex/Link.hs: ( liftIO $ catchMaybeIO $ readSymbolicLink file
only when core.symlinks=true
Assistant/Threads/Watcher.hs: ifM ((==) (Just link) <$> liftIO (catchMaybeIO $ readSymbolicLink file))
code that fixes real symlinks when inotify sees them
It's ok to not fix psdueo-symlinks.
Assistant/Threads/Watcher.hs: mlink <- liftIO (catchMaybeIO $ readSymbolicLink file)
ditto
Command/Fix.hs: stopUnless ((/=) (Just link) <$> liftIO (catchMaybeIO $ readSymbolicLink file)) $ do
command only works in indirect mode
Upgrade/V1.hs: getsymlink = takeFileName <$> readSymbolicLink file
v1 repos could not be on a filesystem w/o symlinks
Audited and dealt with calls to isSymbolicLink.
(Typically used with getSymbolicLinkStatus, but that is just used because
getFileStatus is not as robust; it also works on pseudolinks.)
Remaining calls are all safe, because:
Assistant/Threads/SanityChecker.hs: | isSymbolicLink s -> addsymlink file ms
only handles staging of symlinks that were somehow not staged
(might need to be updated to support pseudolinks, but this is
only a belt-and-suspenders check anyway, and I've never seen the code run)
Command/Add.hs: if isSymbolicLink s || not (isRegularFile s)
avoids adding symlinks to the annex, so not relevant
Command/Indirect.hs: | isSymbolicLink s -> void $ flip whenAnnexed f $
only allowed on systems that support symlinks
Command/Indirect.hs: whenM (liftIO $ not . isSymbolicLink <$> getSymbolicLinkStatus f) $ do
ditto
Seek.hs:notSymlink f = liftIO $ not . isSymbolicLink <$> getSymbolicLinkStatus f
used to find unlocked files, only relevant in indirect mode
Utility/FSEvents.hs: | Files.isSymbolicLink s = runhook addSymlinkHook $ Just s
Utility/FSEvents.hs: | Files.isSymbolicLink s ->
Utility/INotify.hs: | Files.isSymbolicLink s ->
Utility/INotify.hs: checkfiletype Files.isSymbolicLink addSymlinkHook f
Utility/Kqueue.hs: | Files.isSymbolicLink s = callhook addSymlinkHook (Just s) change
all above are lower-level, not relevant
Audited and dealt with calls to isSymLink.
Remaining calls are all safe, because:
Annex/Direct.hs: | isSymLink (getmode item) =
This is looking at git diff-tree objects, not files on disk
Command/Unused.hs: | isSymLink (LsTree.mode l) = do
This is looking at git ls-tree, not file on disk
Utility/FileMode.hs:isSymLink :: FileMode -> Bool
Utility/FileMode.hs:isSymLink = checkMode symbolicLinkMode
low-level
Done!!
2013-02-17 19:05:55 +00:00
|
|
|
import qualified Annex
|
2012-12-13 19:44:56 +00:00
|
|
|
import Annex.Direct
|
|
|
|
import Annex.Content
|
2013-11-15 18:52:03 +00:00
|
|
|
import Annex.Content.Direct
|
2012-12-13 19:44:56 +00:00
|
|
|
import Annex.CatFile
|
2013-09-25 19:29:56 +00:00
|
|
|
import Annex.Exception
|
2014-01-26 20:36:31 +00:00
|
|
|
import Annex.Init
|
2013-09-25 19:29:56 +00:00
|
|
|
import qualified Command.Add
|
2012-12-13 19:44:56 +00:00
|
|
|
|
|
|
|
def :: [Command]
|
2013-04-22 20:41:46 +00:00
|
|
|
def = [notBareRepo $ noDaemonRunning $
|
|
|
|
command "indirect" paramNothing seek
|
|
|
|
SectionSetup "switch repository to indirect mode"]
|
2012-12-13 19:44:56 +00:00
|
|
|
|
fix inversion of control in CommandSeek (no behavior changes)
I've been disliking how the command seek actions were written for some
time, with their inversion of control and ugly workarounds.
The last straw to fix it was sync --content, which didn't fit the
Annex [CommandStart] interface well at all. I have not yet made it take
advantage of the changed interface though.
The crucial change, and probably why I didn't do it this way from the
beginning, is to make each CommandStart action be run with exceptions
caught, and if it fails, increment a failure counter in annex state.
So I finally remove the very first code I wrote for git-annex, which
was before I had exception handling in the Annex monad, and so ran outside
that monad, passing state explicitly as it ran each CommandStart action.
This was a real slog from 1 to 5 am.
Test suite passes.
Memory usage is lower than before, sometimes by a couple of megabytes, and
remains constant, even when running in a large repo, and even when
repeatedly failing and incrementing the error counter. So no accidental
laziness space leaks.
Wall clock speed is identical, even in large repos.
This commit was sponsored by an anonymous bitcoiner.
2014-01-20 08:11:42 +00:00
|
|
|
seek :: CommandSeek
|
|
|
|
seek = withNothing start
|
2012-12-13 19:44:56 +00:00
|
|
|
|
|
|
|
start :: CommandStart
|
2013-02-15 18:17:31 +00:00
|
|
|
start = ifM isDirect
|
fully support core.symlinks=false in all relevant symlink handling code
Refactored annex link code into nice clean new library.
Audited and dealt with calls to createSymbolicLink.
Remaining calls are all safe, because:
Annex/Link.hs: ( liftIO $ createSymbolicLink linktarget file
only when core.symlinks=true
Assistant/WebApp/Configurators/Local.hs: createSymbolicLink link link
test if symlinks can be made
Command/Fix.hs: liftIO $ createSymbolicLink link file
command only works in indirect mode
Command/FromKey.hs: liftIO $ createSymbolicLink link file
command only works in indirect mode
Command/Indirect.hs: liftIO $ createSymbolicLink l f
refuses to run if core.symlinks=false
Init.hs: createSymbolicLink f f2
test if symlinks can be made
Remote/Directory.hs: go [file] = catchBoolIO $ createSymbolicLink file f >> return True
fast key linking; catches failure to make symlink and falls back to copy
Remote/Git.hs: liftIO $ catchBoolIO $ createSymbolicLink loc file >> return True
ditto
Upgrade/V1.hs: liftIO $ createSymbolicLink link f
v1 repos could not be on a filesystem w/o symlinks
Audited and dealt with calls to readSymbolicLink.
Remaining calls are all safe, because:
Annex/Link.hs: ( liftIO $ catchMaybeIO $ readSymbolicLink file
only when core.symlinks=true
Assistant/Threads/Watcher.hs: ifM ((==) (Just link) <$> liftIO (catchMaybeIO $ readSymbolicLink file))
code that fixes real symlinks when inotify sees them
It's ok to not fix psdueo-symlinks.
Assistant/Threads/Watcher.hs: mlink <- liftIO (catchMaybeIO $ readSymbolicLink file)
ditto
Command/Fix.hs: stopUnless ((/=) (Just link) <$> liftIO (catchMaybeIO $ readSymbolicLink file)) $ do
command only works in indirect mode
Upgrade/V1.hs: getsymlink = takeFileName <$> readSymbolicLink file
v1 repos could not be on a filesystem w/o symlinks
Audited and dealt with calls to isSymbolicLink.
(Typically used with getSymbolicLinkStatus, but that is just used because
getFileStatus is not as robust; it also works on pseudolinks.)
Remaining calls are all safe, because:
Assistant/Threads/SanityChecker.hs: | isSymbolicLink s -> addsymlink file ms
only handles staging of symlinks that were somehow not staged
(might need to be updated to support pseudolinks, but this is
only a belt-and-suspenders check anyway, and I've never seen the code run)
Command/Add.hs: if isSymbolicLink s || not (isRegularFile s)
avoids adding symlinks to the annex, so not relevant
Command/Indirect.hs: | isSymbolicLink s -> void $ flip whenAnnexed f $
only allowed on systems that support symlinks
Command/Indirect.hs: whenM (liftIO $ not . isSymbolicLink <$> getSymbolicLinkStatus f) $ do
ditto
Seek.hs:notSymlink f = liftIO $ not . isSymbolicLink <$> getSymbolicLinkStatus f
used to find unlocked files, only relevant in indirect mode
Utility/FSEvents.hs: | Files.isSymbolicLink s = runhook addSymlinkHook $ Just s
Utility/FSEvents.hs: | Files.isSymbolicLink s ->
Utility/INotify.hs: | Files.isSymbolicLink s ->
Utility/INotify.hs: checkfiletype Files.isSymbolicLink addSymlinkHook f
Utility/Kqueue.hs: | Files.isSymbolicLink s = callhook addSymlinkHook (Just s) change
all above are lower-level, not relevant
Audited and dealt with calls to isSymLink.
Remaining calls are all safe, because:
Annex/Direct.hs: | isSymLink (getmode item) =
This is looking at git diff-tree objects, not files on disk
Command/Unused.hs: | isSymLink (LsTree.mode l) = do
This is looking at git ls-tree, not file on disk
Utility/FileMode.hs:isSymLink :: FileMode -> Bool
Utility/FileMode.hs:isSymLink = checkMode symbolicLinkMode
low-level
Done!!
2013-02-17 19:05:55 +00:00
|
|
|
( do
|
|
|
|
unlessM (coreSymlinks <$> Annex.getGitConfig) $
|
|
|
|
error "Git is configured to not use symlinks, so you must use direct mode."
|
|
|
|
whenM probeCrippledFileSystem $
|
|
|
|
error "This repository seems to be on a crippled filesystem, you must use direct mode."
|
|
|
|
next perform
|
2013-02-15 18:17:31 +00:00
|
|
|
, stop
|
|
|
|
)
|
2012-12-13 19:44:56 +00:00
|
|
|
|
|
|
|
perform :: CommandPerform
|
|
|
|
perform = do
|
|
|
|
showStart "commit" ""
|
2013-09-25 07:09:06 +00:00
|
|
|
whenM stageDirect $ do
|
2012-12-13 19:44:56 +00:00
|
|
|
showOutput
|
2013-03-03 17:39:07 +00:00
|
|
|
void $ inRepo $ Git.Command.runBool
|
|
|
|
[ Param "commit"
|
|
|
|
, Param "-m"
|
|
|
|
, Param "commit before switching to indirect mode"
|
|
|
|
]
|
2012-12-13 20:00:17 +00:00
|
|
|
showEndOk
|
2012-12-13 19:44:56 +00:00
|
|
|
|
|
|
|
-- Note that we set indirect mode early, so that we can use
|
|
|
|
-- moveAnnex in indirect mode.
|
|
|
|
setDirect False
|
|
|
|
|
|
|
|
top <- fromRepo Git.repoPath
|
2013-07-28 19:27:36 +00:00
|
|
|
(l, clean) <- inRepo $ Git.LsFiles.stagedOthersDetails [top]
|
2012-12-13 19:44:56 +00:00
|
|
|
forM_ l go
|
|
|
|
void $ liftIO clean
|
|
|
|
next cleanup
|
|
|
|
where
|
|
|
|
{- Walk tree from top and move all present direct mode files into
|
|
|
|
- the annex, replacing with symlinks. Also delete direct mode
|
|
|
|
- caches and mappings. -}
|
2013-09-19 18:48:42 +00:00
|
|
|
go (f, Just sha, Just mode) | isSymLink mode = do
|
2012-12-13 19:44:56 +00:00
|
|
|
r <- liftIO $ catchMaybeIO $ getSymbolicLinkStatus f
|
|
|
|
case r of
|
|
|
|
Just s
|
|
|
|
| isSymbolicLink s -> void $ flip whenAnnexed f $
|
|
|
|
\_ (k, _) -> do
|
2013-11-15 18:52:03 +00:00
|
|
|
removeInodeCache k
|
|
|
|
removeAssociatedFiles k
|
2012-12-13 19:44:56 +00:00
|
|
|
return Nothing
|
|
|
|
| otherwise ->
|
|
|
|
maybe noop (fromdirect f)
|
2013-09-19 20:30:37 +00:00
|
|
|
=<< catKey sha mode
|
2012-12-13 19:44:56 +00:00
|
|
|
_ -> noop
|
2013-09-19 18:48:42 +00:00
|
|
|
go _ = noop
|
2012-12-13 19:44:56 +00:00
|
|
|
|
|
|
|
fromdirect f k = do
|
|
|
|
showStart "indirect" f
|
2013-11-15 18:52:03 +00:00
|
|
|
removeInodeCache k
|
|
|
|
removeAssociatedFiles k
|
2012-12-13 19:44:56 +00:00
|
|
|
whenM (liftIO $ not . isSymbolicLink <$> getSymbolicLinkStatus f) $ do
|
2013-09-25 19:29:56 +00:00
|
|
|
v <-tryAnnexIO (moveAnnex k f)
|
|
|
|
case v of
|
|
|
|
Right _ -> do
|
|
|
|
l <- inRepo $ gitAnnexLink f k
|
|
|
|
liftIO $ createSymbolicLink l f
|
|
|
|
Left e -> catchAnnex (Command.Add.undo f k e)
|
|
|
|
warnlocked
|
2012-12-13 19:44:56 +00:00
|
|
|
showEndOk
|
|
|
|
|
2013-09-25 19:29:56 +00:00
|
|
|
warnlocked :: SomeException -> Annex ()
|
|
|
|
warnlocked e = do
|
|
|
|
warning $ show e
|
|
|
|
warning "leaving this file as-is; correct this problem and run git annex add on it"
|
|
|
|
|
2012-12-13 19:44:56 +00:00
|
|
|
cleanup :: CommandCleanup
|
2012-12-13 20:00:17 +00:00
|
|
|
cleanup = do
|
|
|
|
showStart "indirect" ""
|
|
|
|
showEndOk
|
|
|
|
return True
|