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
|
-- 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/>.
{-# LANGUAGE
DuplicateRecordFields
, DeriveGeneric
, DeriveAnyClass
, NamedFieldPuns
#-}
module Resource
( DirProcessor, ItemProcessor, ThumbnailProcessor
, GalleryItem(..), GalleryItemProps(..), Resolution(..)
, buildGalleryTree, galleryCleanupResourceDir
) where
import Control.Concurrent.ParallelIO.Global (parallel)
import Data.Function ((&))
import Data.List ((\\), subsequences, sortBy)
import Data.Ord (comparing)
import Data.Char (toLower)
import Data.Maybe (mapMaybe, fromMaybe)
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
type FileSizeKB = Int
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
| Other
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 DirProcessor = Path -> IO Path
type ItemProcessor = Path -> IO (Path, GalleryItemProps)
type ThumbnailProcessor = Path -> IO (Maybe Path)
buildGalleryTree ::
DirProcessor -> ItemProcessor -> ThumbnailProcessor
-> Bool -> String -> InputTree -> IO GalleryItem
buildGalleryTree processDir processItem processThumbnail addDirTag galleryName inputTree =
mkGalleryItem Nothing inputTree >>= return . named galleryName
where
named :: String -> GalleryItem -> GalleryItem
named name item = item { title = name }
mkGalleryItem :: Maybe String -> InputTree -> IO GalleryItem
mkGalleryItem parent InputFile{path, sidecar} =
do
(processedItemPath, properties) <- processItem path
processedThumbnail <- processThumbnail path
return GalleryItem
{ title = optMeta title $ fromMaybe "" $ fileName path
, date = optMeta date "" -- TODO: check and normalise dates
, description = optMeta description ""
, tags = (optMeta tags []) ++ implicitParentTag parent
, path = processedItemPath
, thumbnail = processedThumbnail
, properties = properties } -- TODO
where
optMeta :: (Sidecar -> Maybe a) -> a -> a
optMeta get fallback = fromMaybe fallback $ get sidecar
mkGalleryItem parent InputDir{path, dirThumbnailPath, items} =
do
processedDir <- processDir path
processedThumbnail <- maybeThumbnail dirThumbnailPath
processedItems <- parallel $ map (mkGalleryItem $ fileName path) items
return GalleryItem
{ title = fromMaybe "" $ fileName path
-- 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) ++ implicitParentTag parent
, path = processedDir
, thumbnail = processedThumbnail
, properties = Directory processedItems }
where
maybeThumbnail :: Maybe Path -> IO (Maybe Path)
maybeThumbnail Nothing = return Nothing
maybeThumbnail (Just path) = processThumbnail path
aggregateChildTags :: [GalleryItem] -> [Tag]
aggregateChildTags = unique . concatMap (\item -> tags (item::GalleryItem))
unique :: Ord a => [a] -> [a]
unique = Set.toList . Set.fromList
implicitParentTag :: Maybe String -> [Tag]
implicitParentTag Nothing = []
implicitParentTag (Just parent) = if addDirTag then [parent] else []
flattenGalleryTree :: GalleryItem -> [GalleryItem]
flattenGalleryTree dir@(GalleryItem _ _ _ _ _ _ (Directory items)) =
dir : concatMap flattenGalleryTree items
flattenGalleryTree simple = [simple]
galleryOutputDiff :: GalleryItem -> FSNode -> [Path]
galleryOutputDiff resources ref =
(fsPaths ref) \\ (resPaths $ flattenGalleryTree resources)
where
resPaths :: [GalleryItem] -> [Path]
resPaths resList = map (path::(GalleryItem->Path)) resList ++ thumbnailPaths resList
thumbnailPaths :: [GalleryItem] -> [Path]
thumbnailPaths = (concatMap subPaths) . (mapMaybe thumbnail)
fsPaths :: FSNode -> [Path]
fsPaths = map Files.path . tail . flattenDir
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
|