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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
-- ldgallery - A static generator which turns a collection of tagged
-- pictures into a searchable web gallery.
--
-- Copyright (C) 2019-2020 Pacien TRAN-GIRARD
--
-- 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 Resource
( ItemProcessor, ThumbnailProcessor
, GalleryItem(..), GalleryItemProps(..), Resolution(..)
, buildGalleryTree, galleryCleanupResourceDir
) where
import Control.Concurrent.ParallelIO.Global (parallel)
import Data.List ((\\), sortBy)
import Data.Ord (comparing)
import Data.Char (toLower)
import Data.Maybe (mapMaybe, fromMaybe)
import Data.Function ((&))
import qualified Data.Set as Set
import GHC.Generics (Generic)
import Data.Aeson (FromJSON, ToJSON, genericToJSON, genericToEncoding)
import qualified Data.Aeson as JSON
import Files
import Input (InputTree(..), Sidecar(..))
encodingOptions :: JSON.Options
encodingOptions = JSON.defaultOptions
{ JSON.fieldLabelModifier = map toLower
, JSON.constructorTagModifier = map toLower
, JSON.sumEncoding = JSON.defaultTaggedObject
{ JSON.tagFieldName = "type"
, JSON.contentsFieldName = "contents"
}
}
type Tag = String
data Resolution = Resolution
{ width :: Int
, height :: Int
} deriving (Generic, Show, FromJSON)
instance ToJSON Resolution where
toJSON = genericToJSON encodingOptions
toEncoding = genericToEncoding encodingOptions
data GalleryItemProps =
Directory { items :: [GalleryItem] }
| Picture { resource :: Path }
| Other { resource :: Path }
deriving (Generic, Show)
instance ToJSON GalleryItemProps where
toJSON = genericToJSON encodingOptions
toEncoding = genericToEncoding encodingOptions
data GalleryItem = GalleryItem
{ title :: String
, date :: String -- TODO: checked ISO8601 date
, description :: String
, tags :: [Tag]
, path :: Path
, thumbnail :: Maybe Path
, properties :: GalleryItemProps
} deriving (Generic, Show)
instance ToJSON GalleryItem where
toJSON = genericToJSON encodingOptions
toEncoding = genericToEncoding encodingOptions
type ItemProcessor = Path -> IO GalleryItemProps
type ThumbnailProcessor = Path -> IO (Maybe Path)
buildGalleryTree ::
ItemProcessor -> ThumbnailProcessor
-> Int -> String -> InputTree -> IO GalleryItem
buildGalleryTree processItem processThumbnail tagsFromDirectories galleryName inputTree =
mkGalleryItem (Just galleryName) (Path []) inputTree
where
mkGalleryItem :: Maybe String -> Path -> InputTree -> IO GalleryItem
mkGalleryItem _ parents InputFile{path, sidecar} =
do
properties <- processItem path
processedThumbnail <- processThumbnail path
return GalleryItem
{ title = itemTitle
, date = optMeta date "" -- TODO: check and normalise dates
, description = optMeta description ""
, tags = (optMeta tags []) ++ implicitParentTags parents
, path = parents </ itemTitle
, thumbnail = processedThumbnail
, properties = properties } -- TODO
where
itemTitle :: String
itemTitle = optMeta title $ fromMaybe "" $ fileName path
optMeta :: (Sidecar -> Maybe a) -> a -> a
optMeta get fallback = fromMaybe fallback $ get sidecar
mkGalleryItem rootTitle parents InputDir{path, dirThumbnailPath, items} =
do
processedThumbnail <- maybeThumbnail dirThumbnailPath
processedItems <- parallel $ map (mkGalleryItem Nothing itemPath) items
return GalleryItem
{ title = itemTitle
-- TODO: consider using the most recent item's date? what if empty?
, date = ""
-- TODO: consider allowing metadata sidecars for directories too
, description = ""
, tags = (aggregateChildTags processedItems) ++ implicitParentTags parents
, path = itemPath
, thumbnail = processedThumbnail
, properties = Directory processedItems }
where
itemTitle :: String
itemTitle = flip fromMaybe rootTitle (fromMaybe "" $ fileName path)
itemPath :: Path
itemPath = parents </ itemTitle
maybeThumbnail :: Maybe Path -> IO (Maybe Path)
maybeThumbnail Nothing = return Nothing
maybeThumbnail (Just thumbnailPath) = processThumbnail thumbnailPath
aggregateChildTags :: [GalleryItem] -> [Tag]
aggregateChildTags = unique . concatMap (\item -> tags (item::GalleryItem))
unique :: Ord a => [a] -> [a]
unique = Set.toList . Set.fromList
implicitParentTags :: Path -> [Tag]
implicitParentTags (Path elements) = take tagsFromDirectories elements
flattenGalleryTree :: GalleryItem -> [GalleryItem]
flattenGalleryTree dir@(GalleryItem _ _ _ _ _ _ (Directory items)) =
dir : concatMap flattenGalleryTree items
flattenGalleryTree simple = [simple]
galleryOutputDiff :: GalleryItem -> FSNode -> [Path]
galleryOutputDiff resources ref =
(filesystemPaths ref) \\ (compiledPaths $ flattenGalleryTree resources)
where
filesystemPaths :: FSNode -> [Path]
filesystemPaths = map Files.path . tail . flattenDir
compiledPaths :: [GalleryItem] -> [Path]
compiledPaths items =
resourcePaths items ++ thumbnailPaths items
& concatMap subPaths
resourcePaths :: [GalleryItem] -> [Path]
resourcePaths = mapMaybe (resourcePath . properties)
resourcePath :: GalleryItemProps -> Maybe Path
resourcePath Directory{} = Nothing
resourcePath resourceProps = Just $ resource resourceProps
thumbnailPaths :: [GalleryItem] -> [Path]
thumbnailPaths = mapMaybe thumbnail
galleryCleanupResourceDir :: GalleryItem -> FileName -> IO ()
galleryCleanupResourceDir resourceTree outputDir =
readDirectory outputDir
>>= return . galleryOutputDiff resourceTree . root
>>= return . sortBy (flip $ comparing pathLength) -- nested files before dirs
>>= return . map (localPath . (/>) outputDir)
>>= mapM_ remove
|