2011-12-12 21:38:46 +00:00
|
|
|
{- git-annex branch state management
|
|
|
|
-
|
|
|
|
- Runtime state about the git-annex branch, including a small read cache.
|
|
|
|
-
|
2012-01-14 18:31:16 +00:00
|
|
|
- Copyright 2011-2012 Joey Hess <joey@kitenet.net>
|
2011-12-12 21:38:46 +00:00
|
|
|
-
|
|
|
|
- Licensed under the GNU GPL version 3 or higher.
|
|
|
|
-}
|
|
|
|
|
|
|
|
module Annex.BranchState where
|
|
|
|
|
|
|
|
import Common.Annex
|
|
|
|
import Types.BranchState
|
|
|
|
import qualified Annex
|
|
|
|
|
|
|
|
getState :: Annex BranchState
|
|
|
|
getState = Annex.getState Annex.branchstate
|
|
|
|
|
|
|
|
setState :: BranchState -> Annex ()
|
|
|
|
setState state = Annex.changeState $ \s -> s { Annex.branchstate = state }
|
|
|
|
|
2012-01-14 18:31:16 +00:00
|
|
|
changeState :: (BranchState -> BranchState) -> Annex ()
|
|
|
|
changeState changer = setState =<< changer <$> getState
|
|
|
|
|
2011-12-12 21:38:46 +00:00
|
|
|
setCache :: FilePath -> String -> Annex ()
|
2012-01-14 18:31:16 +00:00
|
|
|
setCache file content = changeState $ \s -> s
|
|
|
|
{ cachedFile = Just file, cachedContent = content}
|
2011-12-12 21:38:46 +00:00
|
|
|
|
|
|
|
getCache :: FilePath -> Annex (Maybe String)
|
2012-01-14 18:31:16 +00:00
|
|
|
getCache file = from <$> getState
|
2011-12-12 21:38:46 +00:00
|
|
|
where
|
2012-01-14 18:31:16 +00:00
|
|
|
from state
|
2011-12-12 21:38:46 +00:00
|
|
|
| cachedFile state == Just file =
|
2012-01-14 18:31:16 +00:00
|
|
|
Just $ cachedContent state
|
|
|
|
| otherwise = Nothing
|
2011-12-12 21:38:46 +00:00
|
|
|
|
|
|
|
invalidateCache :: Annex ()
|
2012-01-14 18:31:16 +00:00
|
|
|
invalidateCache = changeState $ \s -> s
|
|
|
|
{ cachedFile = Nothing, cachedContent = "" }
|
2011-12-12 21:38:46 +00:00
|
|
|
|
2012-01-14 16:07:36 +00:00
|
|
|
{- Runs an action to check that the index file exists, if it's not been
|
|
|
|
- checked before in this run of git-annex. -}
|
|
|
|
checkIndexOnce :: Annex () -> Annex ()
|
|
|
|
checkIndexOnce a = unlessM (indexChecked <$> getState) $ do
|
|
|
|
a
|
2012-01-14 18:31:16 +00:00
|
|
|
changeState $ \s -> s { indexChecked = True }
|
2012-01-14 16:07:36 +00:00
|
|
|
|
2011-12-12 21:38:46 +00:00
|
|
|
{- Runs an action to update the branch, if it's not been updated before
|
|
|
|
- in this run of git-annex. -}
|
|
|
|
runUpdateOnce :: Annex () -> Annex ()
|
|
|
|
runUpdateOnce a = unlessM (branchUpdated <$> getState) $ do
|
|
|
|
a
|
|
|
|
disableUpdate
|
|
|
|
|
|
|
|
{- Avoids updating the branch. A useful optimisation when the branch
|
|
|
|
- is known to have not changed, or git-annex won't be relying on info
|
|
|
|
- from it. -}
|
|
|
|
disableUpdate :: Annex ()
|
2012-01-14 18:31:16 +00:00
|
|
|
disableUpdate = changeState $ \s -> s { branchUpdated = True }
|