1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
|
--------------------------------------------------------------------------------
{-# LANGUAGE DeriveDataTypeable #-}
module Hakyll.Core.Dependencies
( Dependency (..)
, DependencyFacts
, outOfDate
) where
--------------------------------------------------------------------------------
import Control.Monad (foldM, forM_, unless, when)
import Control.Monad.Reader (ask)
import Control.Monad.RWS (RWS, runRWS)
import qualified Control.Monad.State as State
import Control.Monad.Writer (tell)
import Data.Binary (Binary (..), getWord8,
putWord8)
import Data.List (find)
import Data.Map (Map)
import qualified Data.Map as M
import Data.Maybe (fromMaybe)
import Data.Set (Set)
import qualified Data.Set as S
import Data.Typeable (Typeable)
--------------------------------------------------------------------------------
import Hakyll.Core.Identifier
import Hakyll.Core.Identifier.Pattern
--------------------------------------------------------------------------------
data Dependency
= PatternDependency Pattern (Set Identifier)
| IdentifierDependency Identifier
| AlwaysOutOfDate
deriving (Show, Typeable)
--------------------------------------------------------------------------------
instance Binary Dependency where
put (PatternDependency p is) = putWord8 0 >> put p >> put is
put (IdentifierDependency i) = putWord8 1 >> put i
put AlwaysOutOfDate = putWord8 2
get = getWord8 >>= \t -> case t of
0 -> PatternDependency <$> get <*> get
1 -> IdentifierDependency <$> get
2 -> pure AlwaysOutOfDate
_ -> error "Data.Binary.get: Invalid Dependency"
--------------------------------------------------------------------------------
type DependencyFacts = Map Identifier [Dependency]
--------------------------------------------------------------------------------
outOfDate
:: [Identifier] -- ^ All known identifiers
-> Set Identifier -- ^ Initially out-of-date resources
-> DependencyFacts -- ^ Old dependency facts
-> (Set Identifier, DependencyFacts, [String])
outOfDate universe ood oldFacts =
let (_, state, logs) = runRWS rws universe (DependencyState oldFacts ood)
in (dependencyOod state, dependencyFacts state, logs)
where
rws = do
checkNew
checkChangedPatterns
bruteForce
--------------------------------------------------------------------------------
data DependencyState = DependencyState
{ dependencyFacts :: DependencyFacts
, dependencyOod :: Set Identifier
} deriving (Show)
--------------------------------------------------------------------------------
type DependencyM a = RWS [Identifier] [String] DependencyState a
--------------------------------------------------------------------------------
markOod :: Identifier -> DependencyM ()
markOod id' = State.modify $ \s ->
s {dependencyOod = S.insert id' $ dependencyOod s}
--------------------------------------------------------------------------------
-- | Collection of dependencies that should be checked to determine
-- if an identifier needs rebuilding.
data Dependencies
= DependsOn [Identifier]
| MustRebuild
deriving (Show)
instance Semigroup Dependencies where
DependsOn ids <> DependsOn moreIds = DependsOn (ids <> moreIds)
MustRebuild <> _ = MustRebuild
_ <> MustRebuild = MustRebuild
instance Monoid Dependencies where
mempty = DependsOn []
--------------------------------------------------------------------------------
dependenciesFor :: Identifier -> DependencyM Dependencies
dependenciesFor id' = do
facts <- dependencyFacts <$> State.get
return $ foldMap dependenciesFor' $ fromMaybe [] $ M.lookup id' facts
where
dependenciesFor' (IdentifierDependency i) = DependsOn [i]
dependenciesFor' (PatternDependency _ is) = DependsOn $ S.toList is
dependenciesFor' AlwaysOutOfDate = MustRebuild
--------------------------------------------------------------------------------
checkNew :: DependencyM ()
checkNew = do
universe <- ask
facts <- dependencyFacts <$> State.get
forM_ universe $ \id' -> unless (id' `M.member` facts) $ do
tell [show id' ++ " is out-of-date because it is new"]
markOod id'
--------------------------------------------------------------------------------
checkChangedPatterns :: DependencyM ()
checkChangedPatterns = do
facts <- M.toList . dependencyFacts <$> State.get
forM_ facts $ \(id', deps) -> do
deps' <- foldM (go id') [] deps
State.modify $ \s -> s
{dependencyFacts = M.insert id' deps' $ dependencyFacts s}
where
go _ ds (IdentifierDependency i) = return $ IdentifierDependency i : ds
go _ ds AlwaysOutOfDate = return $ AlwaysOutOfDate : ds
go id' ds (PatternDependency p ls) = do
universe <- ask
let ls' = S.fromList $ filterMatches p universe
if ls == ls'
then return $ PatternDependency p ls : ds
else do
tell [show id' ++ " is out-of-date because a pattern changed"]
markOod id'
return $ PatternDependency p ls' : ds
--------------------------------------------------------------------------------
bruteForce :: DependencyM ()
bruteForce = do
todo <- ask
go todo
where
go todo = do
(todo', changed) <- foldM check ([], False) todo
when changed (go todo')
check (todo, changed) id' = do
deps <- dependenciesFor id'
case deps of
DependsOn depList -> do
ood <- dependencyOod <$> State.get
case find (`S.member` ood) depList of
Nothing -> return (id' : todo, changed)
Just d -> do
tell [show id' ++ " is out-of-date because " ++
show d ++ " is out-of-date"]
markOod id'
return (todo, True)
MustRebuild -> do
tell [show id' ++ " will be forcibly rebuilt"]
markOod id'
return (todo, True)
|