Merge pull request #34 from pacien/develop

first working prototype

6 files changed, 899 insertions, 0 deletions

diff --git a/compiler/src/Compiler.hs b/compiler/src/Compiler.hs
new file mode 100644
index 0000000..a347433
--- /dev/null
+++ b/compiler/src/Compiler.hs
@@ -0,0 +1,131 @@
+-- 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 Compiler
+  ( compileGallery
+  ) where
+
+
+import Control.Monad (liftM2)
+import Data.List (any)
+import System.FilePath ((</>))
+import qualified System.FilePath.Glob as Glob
+
+import Data.Aeson (ToJSON)
+import qualified Data.Aeson as JSON
+
+import Config
+import Input (readInputTree)
+import Resource (buildGalleryTree, galleryCleanupResourceDir)
+import Files
+  ( FileName
+  , FSNode(..)
+  , readDirectory
+  , isHidden
+  , nodeName
+  , filterDir
+  , ensureParentDir )
+import Processors
+  ( itemFileProcessor, thumbnailFileProcessor
+  , skipCached, withCached )
+
+
+galleryConf :: String
+galleryConf = "gallery.yaml"
+
+indexFile :: String
+indexFile = "index.json"
+
+viewerMainFile :: String
+viewerMainFile = "index.html"
+
+viewerConfFile :: String
+viewerConfFile = "viewer.json"
+
+itemsDir :: String
+itemsDir = "items"
+
+thumbnailsDir :: String
+thumbnailsDir = "thumbnails"
+
+
+writeJSON :: ToJSON a => FileName -> a -> IO ()
+writeJSON outputPath object =
+  do
+    putStrLn $ "Generating:\t" ++ outputPath
+    ensureParentDir JSON.encodeFile outputPath object
+
+
+galleryDirFilter :: ([Glob.Pattern], [Glob.Pattern]) -> FSNode -> Bool
+galleryDirFilter (inclusionPatterns, exclusionPatterns) =
+      (not . isHidden)
+  &&& (matchName True $ anyPattern inclusionPatterns)
+  &&& (not . isConfigFile)
+  &&& (not . containsOutputGallery)
+  &&& (not . (matchName False $ anyPattern exclusionPatterns))
+
+  where
+    (&&&) = liftM2 (&&)
+    (|||) = liftM2 (||)
+
+    matchName :: Bool -> (FileName -> Bool) -> FSNode -> Bool
+    matchName matchDir _ Dir{} = matchDir
+    matchName _ cond file@File{} = maybe False cond $ nodeName file
+
+    anyPattern :: [Glob.Pattern] -> FileName -> Bool
+    anyPattern patterns filename = any (flip Glob.match filename) patterns
+
+    isConfigFile = matchName False (== galleryConf)
+    isGalleryIndex = matchName False (== indexFile)
+    isViewerIndex = matchName False (== viewerMainFile)
+    containsOutputGallery File{} = False
+    containsOutputGallery Dir{items} = any (isGalleryIndex ||| isViewerIndex) items
+
+
+compileGallery :: FilePath -> FilePath -> Bool -> IO ()
+compileGallery inputDirPath outputDirPath rebuildAll =
+  do
+    fullConfig <- readConfig inputGalleryConf
+    let config = compiler fullConfig
+
+    inputDir <- readDirectory inputDirPath
+    let inclusionPatterns = map Glob.compile $ includeFiles config
+    let exclusionPatterns = map Glob.compile $ excludeFiles config
+    let sourceFilter = galleryDirFilter (inclusionPatterns, exclusionPatterns)
+    let sourceTree = filterDir sourceFilter inputDir
+    inputTree <- readInputTree sourceTree
+
+    let cache = if rebuildAll then skipCached else withCached
+    let itemProc = itemProcessor (pictureMaxResolution config) cache
+    let thumbnailProc = thumbnailProcessor (thumbnailMaxResolution config) cache
+    let galleryBuilder = buildGalleryTree itemProc thumbnailProc (tagsFromDirectories config)
+    resources <- galleryBuilder (galleryName config) inputTree
+
+    galleryCleanupResourceDir resources outputDirPath
+    writeJSON outputIndex resources
+    writeJSON outputViewerConf $ viewer fullConfig
+
+  where
+    inputGalleryConf = inputDirPath </> galleryConf
+    outputIndex = outputDirPath </> indexFile
+    outputViewerConf = outputDirPath </> viewerConfFile
+
+    itemProcessor maxRes cache =
+      itemFileProcessor maxRes cache inputDirPath outputDirPath itemsDir
+    thumbnailProcessor thumbRes cache =
+      thumbnailFileProcessor thumbRes cache inputDirPath outputDirPath thumbnailsDir
diff --git a/compiler/src/Config.hs b/compiler/src/Config.hs
new file mode 100644
index 0000000..53333a5
--- /dev/null
+++ b/compiler/src/Config.hs
@@ -0,0 +1,60 @@
+-- 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 Config
+  ( GalleryConfig(..)
+  , CompilerConfig(..)
+  , readConfig
+  ) where
+
+
+import GHC.Generics (Generic)
+import Data.Aeson (FromJSON, withObject, (.:?), (.!=))
+import qualified Data.Aeson as JSON
+
+import Files (FileName)
+import Input (decodeYamlFile)
+import Resource (Resolution(..))
+
+
+data CompilerConfig = CompilerConfig
+  { galleryName :: String
+  , includeFiles :: [String]
+  , excludeFiles :: [String]
+  , tagsFromDirectories :: Int
+  , thumbnailMaxResolution :: Resolution
+  , pictureMaxResolution :: Maybe Resolution
+  } deriving (Generic, Show)
+
+instance FromJSON CompilerConfig where
+  parseJSON = withObject "CompilerConfig" $ \v -> CompilerConfig
+    <$> v .:? "galleryName" .!= "Gallery"
+    <*> v .:? "includeFiles" .!= ["*"]
+    <*> v .:? "excludeFiles" .!= []
+    <*> v .:? "tagsFromDirectories" .!= 0
+    <*> v .:? "thumbnailMaxResolution" .!= (Resolution 400 400)
+    <*> v .:? "pictureMaxResolution"
+
+
+data GalleryConfig = GalleryConfig
+  { compiler :: CompilerConfig
+  , viewer :: JSON.Object
+  } deriving (Generic, FromJSON, Show)
+
+readConfig :: FileName -> IO GalleryConfig
+readConfig = decodeYamlFile
diff --git a/compiler/src/Files.hs b/compiler/src/Files.hs
new file mode 100644
index 0000000..41fc5a8
--- /dev/null
+++ b/compiler/src/Files.hs
@@ -0,0 +1,183 @@
+-- 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 Files
+  ( FileName, LocalPath, WebPath, Path(..)
+  , (</>), (</), (/>), (<.>)
+  , fileName, subPaths, pathLength
+  , localPath, webPath
+  , FSNode(..), AnchoredFSNode(..)
+  , nodeName, isHidden, flattenDir, filterDir
+  , readDirectory, copyTo
+  , ensureParentDir, remove, isOutdated
+  ) where
+
+
+import Control.Monad (mapM)
+import Data.Bool (bool)
+import Data.List (isPrefixOf, length, subsequences)
+import Data.Function ((&))
+import Data.Text (pack)