Merge branch 'develop': release v1.0v1.0

13 files changed, 657 insertions, 275 deletions

diff --git a/compiler/app/Main.hs b/compiler/app/Main.hs
index 1a42abf..48e5644 100644
--- a/compiler/app/Main.hs
+++ b/compiler/app/Main.hs
@@ -18,20 +18,33 @@
 
 module Main where
 
+import GHC.Generics (Generic)
 import Paths_ldgallery_compiler (version, getDataFileName)
+import Control.Monad (when)
+import Data.Maybe (isJust)
 import Data.Version (showVersion)
+import Data.Aeson (ToJSON)
 import System.FilePath ((</>))
+import System.Directory (canonicalizePath, listDirectory)
 import System.Console.CmdArgs
 
 import Compiler
-import Files (readDirectory, copyTo)
+import Files (readDirectory, copyTo, remove)
+
+
+data ViewerConfig = ViewerConfig
+  { galleryRoot :: String
+  } deriving (Generic, Show, ToJSON)
 
 
 data Options = Options
-  { inputDir :: String
-  , outputDir :: String
+  { inputDir :: FilePath
+  , outputDir :: FilePath
+  , outputIndex :: FilePath
+  , galleryConfig :: FilePath
   , rebuilAll :: Bool
-  , withViewer :: Bool
+  , cleanOutput :: Bool
+  , withViewer :: Maybe FilePath
   } deriving (Show, Data, Typeable)
 
 options :: Options
@@ -48,16 +61,35 @@ options = Options
       &= name "output-dir"
       &= explicit
       &= help "Generated gallery output path (default=./out)"
+  , outputIndex = ""
+      &= typFile
+      &= name "x"
+      &= name "output-index"
+      &= explicit
+      &= help "Generated gallery index output path (default=<output-dir>/index.json)"
+  , galleryConfig = ""
+      &= typFile
+      &= name "g"
+      &= name "gallery-config"
+      &= explicit
+      &= help "Gallery configuration file (default=<input-dir>/gallery.yaml)"
   , rebuilAll = False
       &= name "r"
       &= name "rebuild-all"
       &= explicit
       &= help "Invalidate cache and recompile everything"
-  , withViewer = False
+  , cleanOutput = False
+      &= name "c"
+      &= name "clean-output"
+      &= explicit
+      &= help "Remove unnecessary files from the output directory"
+  , withViewer = Nothing
+      &= typDir
+      &= opt ("" :: FilePath)
       &= name "w"
       &= name "with-viewer"
       &= explicit
-      &= help "Include the static web viewer in the output"
+      &= help "Deploy either the bundled or the given static web viewer to the output directory"
   }
 
   &= summary ("ldgallery v" ++ (showVersion version) ++ " - a static web gallery generator with tags")
@@ -71,21 +103,62 @@ main :: IO ()
 main =
   do
     opts <- cmdArgs options
-    compileGallery (inputDir opts) (galleryOutputDir "gallery" opts) (rebuilAll opts)
-    if (withViewer opts) then copyViewer (outputDir opts) else noop
+    buildGallery opts
+
+    when (isJust $ withViewer opts) $ do
+      viewerDist <- viewerDistPath $ withViewer opts
+      deployViewer viewerDist opts
 
   where
-    galleryOutputDir :: FilePath -> Options -> FilePath
-    galleryOutputDir gallerySubdir opts =
-      if withViewer opts then outputBase </> gallerySubdir else outputBase
-      where outputBase = outputDir opts
-
-    copyViewer :: FilePath -> IO ()
-    copyViewer target =
-      putStrLn "Copying viewer webapp"
-      >>  getDataFileName "viewer"
-      >>= readDirectory
-      >>= copyTo target
-
-    noop :: IO ()
-    noop = return ()
+    gallerySubdir :: String
+    gallerySubdir = "gallery"
+
+    viewerConfig :: ViewerConfig
+    viewerConfig = ViewerConfig (gallerySubdir ++ "/")
+
+    viewerDistPath :: Maybe FilePath -> IO FilePath
+    viewerDistPath (Just "") = getDataFileName "viewer"
+    viewerDistPath (Just dist) = return dist
+    viewerDistPath Nothing = fail "No viewer distribution"
+
+    buildGallery :: Options -> IO ()
+    buildGallery opts =
+      checkDistinctPaths (inputDir opts) (outputDir opts)
+      >>  compileGallery
+            (galleryConfig opts)
+            (inputDir opts)
+            (galleryOutputDir opts)
+            (outputIndex opts)
+            [outputDir opts]
+            (rebuilAll opts)
+            (cleanOutput opts)
+      where
+        checkDistinctPaths :: FilePath -> FilePath -> IO ()
+        checkDistinctPaths a b = do
+          canonicalA <- canonicalizePath a
+          canonicalB <- canonicalizePath b
+          when (canonicalA == canonicalB) $ error "Input and output paths refer to the same location."
+
+        galleryOutputDir :: Options -> FilePath
+        galleryOutputDir Options{withViewer, outputDir}
+          | isJust withViewer = outputDir </> gallerySubdir
+          | otherwise = outputDir
+
+    deployViewer :: FilePath -> Options -> IO ()
+    deployViewer distPath Options{outputDir, cleanOutput} =
+      (when cleanOutput $ cleanViewerDir outputDir)
+      >> copyViewer distPath outputDir
+      >> writeJSON (outputDir </> "config.json") viewerConfig
+
+      where
+        cleanViewerDir :: FilePath -> IO ()
+        cleanViewerDir target =
+          listDirectory target
+          >>= return . filter (/= gallerySubdir)
+          >>= mapM_ remove . map (target </>)
+
+        copyViewer :: FilePath -> FilePath -> IO ()
+        copyViewer dist target =
+          putStrLn "Copying viewer webapp"
+          >>  readDirectory dist
+          >>= copyTo target
diff --git a/compiler/ldgallery.1.md b/compiler/ldgallery.1.md
new file mode 100644
index 0000000..a60a3b1
--- /dev/null
+++ b/compiler/ldgallery.1.md
@@ -0,0 +1,191 @@
+---
+pagetitle: Compiler user manual - ldgallery
+title: LDGALLERY(1) ldgallery
+author: Pacien TRAN-GIRARD, Guillaume FOUET
+date: 2020-04-30 (v1.0)
+---
+
+
+# NAME
+
+ldgallery - a static web gallery generator with tags
+
+
+# DESCRIPTION
+
+ldgallery is a static gallery generator which turns a collection of tagged pictures into a searchable web gallery.
+
+The ldgallery compiler program processes pictures and aggregates metadata from plain text sidecar files to generate an indexed version of the gallery.
+It can optionally output a static web viewer along, which allows the content to be presented and searched through from a JavaScript-enabled web browser.
+This client-side web application does not require any special software on the server's side.
+
+
+# COMMAND
+
+ldgallery [\--input-dir _./_] [\--output-dir _./out_] [\--with-viewer]
+
+Available options are:
+
+-i, \--input-dir _DIR_
+: Gallery source directory.
+  Defaults to the current directory.
+
+-o, \--output-dir _DIR_
+: Generated gallery output path.
+  Must be distinct from the source directory.
+  Defaults to ./out.
+
+-x, \--output-index _FILE_
+: Generated gallery index output path.
+  Defaults to \<output-dir\>/index.json.
+
+-g, \--gallery-config _FILE_
+: Gallery configuration file.
+  Defaults to \<input-dir\>/gallery.yaml.
+
+-r, \--rebuild-all
+: Invalidate cache and recompile everything.
+
+-c, \--clean-output
+: Remove unnecessary files from the output directory.
+
+-w, \--with-viewer[=_DIR_]
+: Deploy either the bundled or the given static web viewer to the output directory.
+  The compiled gallery itself is then placed in \<output-dir\>/gallery.
+
+-h, \--help
+: Display help message.
+
+\--version
+: Print version information.
+
+\--numeric-version
+: Print just the version number.