Merge branch 'develop': release v2.1v2.1

GitHub: related to #315

13 files changed, 93 insertions, 47 deletions

diff --git a/compiler/.gitignore b/compiler/.gitignore
index 778e7ef..3415fc8 100644
--- a/compiler/.gitignore
+++ b/compiler/.gitignore
@@ -1,3 +1,4 @@
 .stack-work/
+dist/
 ldgallery-compiler.cabal
 *~
\ No newline at end of file
diff --git a/compiler/app/Main.hs b/compiler/app/Main.hs
index e71e0db..3e6f254 100644
--- a/compiler/app/Main.hs
+++ b/compiler/app/Main.hs
@@ -1,7 +1,7 @@
 -- ldgallery - A static generator which turns a collection of tagged
 --             pictures into a searchable web gallery.
 --
--- Copyright (C) 2019-2020  Pacien TRAN-GIRARD
+-- Copyright (C) 2019-2021  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
@@ -19,7 +19,7 @@
 module Main where
 
 import GHC.Generics (Generic)
-import Paths_ldgallery_compiler (version, getDataFileName)
+import Paths_ldgallery_compiler (version)
 import Control.Monad (when)
 import Data.Functor ((<&>))
 import Data.Maybe (isJust)
@@ -31,7 +31,7 @@ import System.Console.CmdArgs
 
 import Compiler
 import Files (readDirectory, copyTo, remove)
-
+import ViewerDist (viewerDistPath)
 
 newtype ViewerConfig = ViewerConfig
   { galleryRoot :: String
@@ -94,6 +94,7 @@ options = Options
   }
 
   &= summary ("ldgallery v" ++ showVersion version ++ " - a static web gallery generator with tags")
+  &= details ["This software is distributed under the terms of the GNU Affero General Public License v3.0."]
   &= program "ldgallery"
   &= help "Compile a gallery"
   &= helpArg [explicit, name "h", name "help"]
@@ -105,10 +106,7 @@ main =
   do
     opts <- cmdArgs options
     buildGallery opts
-
-    when (isJust $ withViewer opts) $ do
-      viewerDist <- viewerDistPath $ withViewer opts
-      deployViewer viewerDist opts
+    deployViewer opts
 
   where
     gallerySubdir :: String
@@ -117,11 +115,6 @@ main =
     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)
@@ -145,10 +138,11 @@ main =
           | isJust withViewer = outputDir </> gallerySubdir
           | otherwise = outputDir
 
-    deployViewer :: FilePath -> Options -> IO ()
-    deployViewer distPath Options{outputDir, cleanOutput} =
+    deployViewer :: Options -> IO ()
+    deployViewer Options{withViewer = Nothing} = pure ()
+    deployViewer Options{withViewer = Just viewerPath, outputDir, cleanOutput} =
       when cleanOutput (cleanViewerDir outputDir)
-      >> copyViewer distPath outputDir
+      >> viewerDistOr viewerPath >>= deployTo outputDir
       >> writeJSON (outputDir </> "config.json") viewerConfig
 
       where
@@ -158,8 +152,12 @@ main =
           <&> filter (/= gallerySubdir)
           >>= mapM_ (remove . (target </>))
 
-        copyViewer :: FilePath -> FilePath -> IO ()
-        copyViewer dist target =
+        viewerDistOr :: FilePath -> IO FilePath
+        viewerDistOr "" = viewerDistPath
+        viewerDistOr custom = pure custom
+
+        deployTo :: FilePath -> FilePath -> IO ()
+        deployTo target dist =
           putStrLn "Copying viewer webapp"
           >>  readDirectory dist
           >>= copyTo target
diff --git a/compiler/app/ViewerDist.hs b/compiler/app/ViewerDist.hs
new file mode 100644
index 0000000..2b80ffc
--- /dev/null
+++ b/compiler/app/ViewerDist.hs
@@ -0,0 +1,39 @@
+-- ldgallery - A static generator which turns a collection of tagged
+--             pictures into a searchable web gallery.
+--
+-- Copyright (C) 2021  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 CPP #-}
+
+module ViewerDist where
+
+#ifndef FLAG_PORTABLE
+
+import Paths_ldgallery_compiler (getDataFileName)
+
+viewerDistPath = getDataFileName "viewer"
+
+#else
+
+import Data.Functor ((<&>))
+import System.FilePath (takeDirectory, (</>))
+import System.Environment (getExecutablePath)
+
+viewerDistPath = fmap takeDirectory getExecutablePath <&> (</> "viewer")
+
+#endif
+
+viewerDistPath :: IO FilePath
diff --git a/compiler/ldgallery.1.md b/compiler/ldgallery.1.md
index eda6cc2..2e247cd 100644
--- a/compiler/ldgallery.1.md
+++ b/compiler/ldgallery.1.md
@@ -2,7 +2,7 @@
 pagetitle: Compiler user manual - ldgallery
 title: LDGALLERY(1) ldgallery
 author: Pacien TRAN-GIRARD, Guillaume FOUET
-date: 2020-09-19 (v2.0)
+date: 2022-09-04 (v2.1)
 ---
 
 
@@ -187,7 +187,7 @@ The ldgallery source code is available on <https://ldgallery.pacien.org>.
 
 # LICENSE
 
-Copyright (C) 2019-2020  Pacien TRAN-GIRARD and Guillaume FOUET.
+Copyright (C) 2019-2022  Pacien TRAN-GIRARD and 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.
 
diff --git a/compiler/package.yaml b/compiler/package.yaml
index faa2174..7bd86e9 100644
--- a/compiler/package.yaml
+++ b/compiler/package.yaml
@@ -1,11 +1,10 @@
 name:                ldgallery-compiler
-version:             2.0
+version:             2.1
 homepage:            https://ldgallery.pacien.org
 github:              "pacien/ldgallery"
 license:             AGPL-3
 author:              "Pacien TRAN-GIRARD, Guillaume FOUET"
-maintainer:          ""
-copyright:           "2019-2020 Pacien TRAN-GIRARD, Guillaume FOUET"
+copyright:           "2019-2021 Pacien TRAN-GIRARD, Guillaume FOUET"
 
 extra-source-files:
 - readme.md
@@ -54,6 +53,15 @@ data-files: ["**/*"]
 library:
   source-dirs: src
 
+flags:
+  portable:
+    description: >
+      Make the output binary portable.
+      It will look in its own runtime location for its assets instead of
+      absolute installation paths.
+    manual: true
+    default: false
+
 executables:
   ldgallery:
     main:                Main.hs
@@ -64,6 +72,9 @@ executables:
     - -with-rtsopts=-N
     dependencies:
     - ldgallery-compiler
+    when:
+    - condition: flag(portable)
+      cpp-options: -DFLAG_PORTABLE