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
174
175
176
|
{-# LANGUAGE DuplicateRecordFields, DeriveGeneric #-}
-- ldgallery - A static generator which turns a collection of tagged
-- pictures into a searchable web gallery.
--
-- Copyright (C) 2019 Pacien TRAN-GIRARD
-- 2019 Guillaume FOUET
--
-- This program is free software: you can redistribute it and/or modify
-- it under the terms of the GNU Affero General Public License as
-- published by the Free Software Foundation, either version 3 of the
-- License, or (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU Affero General Public License for more details.
--
-- You should have received a copy of the GNU Affero General Public License
-- along with this program. If not, see <https://www.gnu.org/licenses/>.
module Lib
( testRun
) where
import GHC.Generics
import Control.Monad.IO.Class (MonadIO, liftIO)
import Control.Exception (Exception, throwIO)
import Data.Function
import Data.Maybe (fromMaybe)
import Data.List (map)
import Data.Char (toLower)
import Data.Text (Text, empty, pack)
import Data.Yaml (ParseException, decodeFileEither)
import Data.Aeson
import System.FilePath
import System.Directory.Tree
import System.Directory
encodingOptions :: Options
encodingOptions = defaultOptions
{ fieldLabelModifier = map toLower
, constructorTagModifier = map toLower
, sumEncoding = defaultTaggedObject
{ tagFieldName = "type"
, contentsFieldName = "contents"
}
}
-- input structure
data SidecarItemMetadata = SidecarItemMetadata
{ title :: Maybe Text
, date :: Maybe Text
, description :: Maybe Text
, tags :: Maybe [Text]
} deriving Generic
instance FromJSON SidecarItemMetadata where
parseJSON = genericParseJSON encodingOptions
-- output structures
type ResourcePath = Text
type Tag = Text
type FileSizeKB = Int
data Resolution = Resolution
{ width :: Int
, height :: Int
} deriving Generic
instance ToJSON Resolution where
toJSON = genericToJSON encodingOptions
toEncoding = genericToEncoding encodingOptions
data ItemProperties =
Directory { items :: [Item] }
| Image { resolution :: Resolution, filesize :: FileSizeKB }
-- | Video { filesize :: FileSizeKB }
| Unknown
deriving Generic
instance ToJSON ItemProperties where
toJSON = genericToJSON encodingOptions
toEncoding = genericToEncoding encodingOptions
data Item = Item
{ title :: Text
, date :: Text -- TODO: checked ISO8601 date
, description :: Text
, tags :: [Tag]
, path :: ResourcePath
, thumbnail :: Maybe ResourcePath
, properties :: ItemProperties
} deriving Generic
instance ToJSON Item where
toJSON = genericToJSON encodingOptions
toEncoding = genericToEncoding encodingOptions
-- mapping
data LoadException = LoadException String ParseException deriving Show
instance Exception LoadException
decodeYamlFile :: (MonadIO m, FromJSON a) => FilePath -> m a
decodeYamlFile fpath =
liftIO $ Data.Yaml.decodeFileEither fpath
>>= either (throwIO . LoadException fpath) return
metadataDirTree :: DirTree FilePath -> IO (DirTree SidecarItemMetadata)
metadataDirTree (Failed _ ferr) = ioError ferr
metadataDirTree f@(File _ fpath) =
decodeYamlFile fpath
>>= \metadata -> return f { file = metadata }
metadataDirTree d@(Dir _ dcontents) =
filter canContainMetadata dcontents
& mapM metadataDirTree
>>= \contents -> return d { contents = contents }
where
canContainMetadata (Dir _ _) = True
canContainMetadata (File fname _) = isExtensionOf ".yaml" fname
toItemTree :: (MonadIO m) => [FileName] -> DirTree SidecarItemMetadata -> m Item
toItemTree pathTo d@(Dir dname dcontents) =
mapM (toItemTree path) dcontents
>>= \items -> return Item
{ title = pack dname
, date = empty -- TODO: would it make sense to take the date of child elements?
, description = empty
, tags = [] -- TODO: aggregate tags from childs
, path = pack $ joinPath $ "items":path -- FIXME: use URL path instead of system path sep
, thumbnail = Nothing
, properties = Directory { items = items }}
where
path = pathTo ++ [dname]
toItemTree pathTo f@(File fname metadata) =
return Item
{ title = optMeta title (pack fname)
, date = optMeta date empty -- TODO: check and normalise dates
, description = optMeta description empty
, tags = optMeta tags []
, path = pack $ joinPath $ "items":(pathTo ++ [fname]) -- FIXME: use URL path instead of system path sep
, thumbnail = Just $ pack $ joinPath $ "thumbnails":(pathTo ++ [fname]) -- FIXME: use URL path instead of system path sep
, properties = Unknown } -- TODO
where
optMeta get fallback = fromMaybe fallback $ get (metadata::SidecarItemMetadata)
process :: FilePath -> FilePath -> IO ()
process inputDir outputDir =
readDirectoryWith return inputDir
>>= metadataDirTree . dirTree
>>= toItemTree []
>>= return . show . toEncoding
>>= liftIO . putStrLn
testRun :: IO ()
testRun = process "../example" "../out"
|