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
|
module Text.Hakyll.Page
( Page,
fromContext,
getValue,
copyValueWith,
getBody,
readPage,
writePage
) where
import qualified Data.Map as M
import qualified Data.List as L
import qualified Data.ByteString.Lazy.Char8 as B
import Data.Maybe
import Control.Monad
import System.FilePath
import System.IO
import Text.Hakyll.File
import Text.Hakyll.Util
import Text.Hakyll.Renderable
import Text.Pandoc
-- | A Page is basically key-value mapping. Certain keys have special
-- meanings, like for example url, body and title.
data Page = Page (M.Map B.ByteString B.ByteString)
-- | Create a Page from a key-value mapping.
fromContext :: (M.Map B.ByteString B.ByteString) -> Page
fromContext = Page
-- | Obtain a value from a page. Will resturn an empty string when nothing is
-- found.
getValue :: String -> Page -> B.ByteString
getValue str (Page page) = fromMaybe B.empty $ M.lookup (B.pack str) page
-- | Do something with a value of the page.
copyValueWith :: String -- ^ Key of which the value should be copied.
-> String -- ^ Key the value should be copied to.
-> (B.ByteString -> B.ByteString) -- ^ Function to apply on the value.
-> Page -- ^ Page on which to apply this modification.
-> Page -- ^ Result.
copyValueWith src dst f p@(Page page) = case M.lookup (B.pack src) page of
Nothing -> p
(Just value) -> Page $ M.insert (B.pack dst) (f value) page
-- | Auxiliary function to pack a pair.
packPair :: (String, String) -> (B.ByteString, B.ByteString)
packPair (a, b) = (B.pack a, B.pack b)
-- | Get the URL for a certain page. This should always be defined. If
-- not, it will error.
getPageURL :: Page -> String
getPageURL (Page page) = B.unpack $ fromMaybe (error "No page url") $ M.lookup (B.pack "url") page
-- | Get the original page path.
getPagePath :: Page -> String
getPagePath (Page page) = B.unpack $ fromMaybe (error "No page path") $ M.lookup (B.pack "path") page
-- | Get the body for a certain page. When not defined, the body will be
-- empty.
getBody :: Page -> B.ByteString
getBody (Page page) = fromMaybe B.empty $ M.lookup (B.pack "body") page
-- | The default writer options for pandoc rendering.
writerOptions :: WriterOptions
writerOptions = defaultWriterOptions
-- | Get a render function for a given extension.
renderFunction :: String -> (String -> String)
renderFunction ".html" = id
renderFunction ext = writeHtmlString writerOptions .
readFunction ext defaultParserState
where readFunction ".markdown" = readMarkdown
readFunction ".md" = readMarkdown
readFunction ".tex" = readLaTeX
readFunction _ = readMarkdown
-- | Read metadata header from a file handle.
readMetaData :: Handle -> IO [(String, String)]
readMetaData handle = do
line <- hGetLine handle
if isDelimiter line then return []
else do others <- readMetaData handle
return $ (trimPair . break (== ':')) line : others
where trimPair (key, value) = (trim key, trim $ tail value)
-- | Check if the given string is a metadata delimiter.
isDelimiter :: String -> Bool
isDelimiter = L.isPrefixOf "---"
-- | Used for caching of files.
cachePage :: Page -> IO ()
cachePage page@(Page mapping) = do
let destination = toCache $ getURL page
makeDirectories destination
handle <- openFile destination WriteMode
hPutStrLn handle "---"
mapM_ (writePair handle) $ M.toList $ M.delete (B.pack "body") mapping
hPutStrLn handle "---"
B.hPut handle $ getBody page
hClose handle
where writePair h (k, v) = B.hPut h k >>
B.hPut h (B.pack ": ") >>
B.hPut h v >>
hPutStrLn h ""
-- | Read a page from a file. Metadata is supported, and if the filename
-- has a .markdown extension, it will be rendered using pandoc. Note that
-- pages are not templates, so they should not contain $identifiers.
readPage :: FilePath -> IO Page
readPage pagePath = do
-- Check cache.
getFromCache <- isCacheValid cacheFile [pagePath]
let path = if getFromCache then cacheFile else pagePath
-- Read file.
handle <- openFile path ReadMode
line <- hGetLine handle
(context, body) <- if isDelimiter line
then do md <- readMetaData handle
c <- hGetContents handle
return (md, c)
else hGetContents handle >>= \b -> return ([], line ++ b)
-- Render file
let rendered = B.pack $ (renderFunction $ takeExtension path) body
seq rendered $ hClose handle
let page = fromContext $ M.fromList $
[ (B.pack "body", rendered)
, packPair ("url", url)
, packPair ("path", pagePath)
] ++ map packPair context
-- Cache if needed
if getFromCache then return () else cachePage page
return page
where url = toURL pagePath
cacheFile = toCache url
-- | Write a page to the site destination.
writePage :: Page -> IO ()
writePage page = do
let destination = toDestination $ getURL page
makeDirectories destination
B.writeFile destination (getBody page)
-- Make pages renderable.
instance Renderable Page where
getDependencies = (:[]) . getPagePath
getURL = getPageURL
toContext (Page page) = return page
|
