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
|
-- | A Module that allows easy rendering of RSS feeds.
--
-- The main rendering functions (@renderRss@, @renderAtom@) all assume that
-- you pass the list of items so that the most recent entry in the feed is the
-- first item in the list.
--
-- Also note that the pages should have (at least) the following fields to
-- produce a correct feed:
--
-- - @$title@: Title of the item
--
-- - @$description@: Description to appear in the feed
--
-- - @$url@: URL to the item - this is usually set automatically.
--
-- In addition, the posts should be named according to the rules for
-- 'Hakyll.Page.Metadata.renderDateField'.
--
module Hakyll.Web.Feed
( FeedConfiguration (..)
, renderRss
, renderAtom
) where
import Prelude hiding (id)
import Control.Category (id)
import Control.Arrow ((>>>), arr, (&&&))
import Control.Monad ((<=<))
import Data.Maybe (fromMaybe, listToMaybe)
import Hakyll.Core.Compiler
import Hakyll.Web.Page
import Hakyll.Web.Page.Metadata
import Hakyll.Web.Template
import Hakyll.Web.Template.Read.Hakyll (readTemplate)
import Hakyll.Web.Util.Url
import Paths_hakyll
-- | This is a data structure to keep the configuration of a feed.
data FeedConfiguration = FeedConfiguration
{ -- | Title of the feed.
feedTitle :: String
, -- | Description of the feed.
feedDescription :: String
, -- | Name of the feed author.
feedAuthorName :: String
, -- | Absolute root URL of the feed site (e.g. @http://jaspervdj.be@)
feedRoot :: String
}
-- | This is an auxiliary function to create a listing that is, in fact, a feed.
-- The items should be sorted on date. The @$timestamp@ field should be set.
--
createFeed :: Template -- ^ Feed template
-> Template -- ^ Item template
-> String -- ^ URL of the feed
-> FeedConfiguration -- ^ Feed configuration
-> [Page String] -- ^ Items to include
-> String -- ^ Resulting feed
createFeed feedTemplate itemTemplate url configuration items =
pageBody $ applyTemplate feedTemplate
$ trySetField "timestamp" timestamp
$ trySetField "title" (feedTitle configuration)
$ trySetField "description" (feedDescription configuration)
$ trySetField "authorName" (feedDescription configuration)
$ trySetField "root" (feedRoot configuration)
$ trySetField "url" url
$ fromBody body
where
-- Preprocess items
items' = flip map items $ applyTemplate itemTemplate
. trySetField "root" (feedRoot configuration)
-- Body: concatenated items
body = concat $ map pageBody items'
-- Take the first timestamp, which should be the most recent
timestamp = fromMaybe "Unknown" $ do
p <- listToMaybe items
return $ getField "timestamp" p
-- | Abstract function to render any feed.
--
renderFeed :: FilePath -- ^ Feed template
-> FilePath -- ^ Item template
-> FeedConfiguration -- ^ Feed configuration
-> Compiler [Page String] String -- ^ Feed compiler
renderFeed feedTemplate itemTemplate configuration =
id &&& getRoute >>> renderFeed'
where
-- Arrow rendering the feed from the items and the URL
renderFeed' = unsafeCompiler $ \(items, url) -> do
feedTemplate' <- loadTemplate feedTemplate
itemTemplate' <- loadTemplate itemTemplate
let url' = toUrl $ fromMaybe noUrl url
return $ createFeed feedTemplate' itemTemplate' url' configuration items
-- Auxiliary: load a template from a datafile
loadTemplate = fmap readTemplate . readFile <=< getDataFileName
-- URL is required to have a valid field
noUrl = error "Hakyll.Web.Feed.renderFeed: no route specified"
-- | Render an RSS feed with a number of items.
--
renderRss :: FeedConfiguration -- ^ Feed configuration
-> Compiler [Page String] String -- ^ Feed compiler
renderRss configuration = arr (map renderDate)
>>> renderFeed "templates/rss.xml" "templates/rss-item.xml" configuration
where
renderDate = renderDateField "timestamp" "%a, %d %b %Y %H:%M:%S UT"
"No date found."
-- | Render an Atom feed with a number of items.
--
renderAtom :: FeedConfiguration -- ^ Feed configuration
-> Compiler [Page String] String -- ^ Feed compiler
renderAtom configuration = arr (map renderDate)
>>> renderFeed "templates/atom.xml" "templates/atom-item.xml" configuration
where
renderDate = renderDateField "timestamp" "%Y-%m-%dT%H:%M:%SZ"
"No date found."
|
