vervis/src/Vervis/Settings.hs

{- This file is part of Vervis.
 -
 - Written in 2016, 2018, 2019 by fr33domlover <fr33domlover@riseup.net>.
 -
 - ♡ Copying is an act of love. Please copy, reuse and share.
 -
 - The author(s) have dedicated all copyright and related and neighboring
 - rights to this software to the public domain worldwide. This software is
 - distributed without any warranty.
 -
 - You should have received a copy of the CC0 Public Domain Dedication along
 - with this software. If not, see
 - <http://creativecommons.org/publicdomain/zero/1.0/>.
 -}

{-# Language CPP #-}

-- | Settings are centralized, as much as possible, into this file. This
-- includes database connection settings, static file locations, etc.
-- In addition, you can configure a number of different aspects of Yesod
-- by overriding methods in the Yesod typeclass. That instance is
-- declared in the Foundation.hs file.
module Vervis.Settings where

import ClassyPrelude.Conduit hiding (throw)
import Yesod hiding (Header, parseTime)
import Yesod.Static
import Data.Default (Default (..))

import Control.Exception           (throw)
import Data.Aeson                  (Result (..), fromJSON, withObject, (.!=),
                                    (.:?))
import Data.FileEmbed              (embedFile)
import Data.Time.Interval (TimeInterval)
import Data.Time.Interval.Aeson (interval)
import Data.Yaml                   (decodeEither')
import Database.Persist.Postgresql (PostgresConf)
import Language.Haskell.TH.Syntax  (Exp, Name, Q)
import Network.Wai.Handler.Warp    (HostPreference)
import Yesod.Default.Config2       (applyEnvValue, configSettingsYml)
import Yesod.Default.Util          (WidgetFileSettings, widgetFileNoReload,
                                    widgetFileReload)
import Yesod.Mail.Send (MailSettings)

-- | Runtime settings to configure this application. These settings can be
-- loaded from various sources: defaults, environment variables, config files,
-- theoretically even a database.
data AppSettings = AppSettings
    { -- | Directory from which to serve static files.
      appStaticDir              :: String
      -- | Configuration settings for accessing the database.
    , appDatabaseConf           :: PostgresConf
      -- | Base for all generated URLs. If @Nothing@, determined from the
      -- request headers.
    , appRoot                   :: Maybe Text
      -- | Host/interface the server should bind to.
    , appHost                   :: HostPreference
      -- | Port to listen on
    , appPort                   :: Int
      -- | Get the IP address from the header when logging. Useful when sitting
      -- behind a reverse proxy.
    , appIpFromHeader           :: Bool

      -- | Path of session cookie encryption key file
    , appClientSessionKeyFile   :: FilePath
      -- | Idle timeout for session cookie expiration
    , appClientSessionTimeout   :: TimeInterval

      -- Maximal accepted difference between current time and Date header
    , appHttpSigTimeLimit       :: TimeInterval

      -- How often to generate a new actor key for making HTTP signatures
    , appActorKeyRotation       :: TimeInterval

      -- | Use detailed request logging system
    , appDetailedRequestLogging :: Bool
      -- | Should all log messages be displayed?
    , appShouldLogAll           :: Bool
      -- | Use the reload version of templates
    , appReloadTemplates        :: Bool
      -- | Assume that files in the static dir may change after compilation
    , appMutableStatic          :: Bool
      -- | Perform no stylesheet/script combining
    , appSkipCombining          :: Bool

      -- | Load SVG font file from the data file path of the @SVGFonts@
      -- library, instead of the app's production runtime data directory.
    , appLoadFontFromLibData    :: Bool

      -- | Path to the directory under which git repos are placed
    , appRepoDir                :: FilePath
      -- | Number of context lines to display around changes in commit diff
    , appDiffContextLines       :: Int
      -- | Port for the SSH server component to listen on
    , appSshPort                :: Int
      -- | Path to the server's SSH private key file
    , appSshKeyFile             :: FilePath
      -- | Whether new user accounts can be created.
    , appRegister               :: Bool
      -- | The maximal number of user accounts that can be registered.
    , appAccounts               :: Maybe Int
      -- | SMTP server details for sending email, and other email related
      -- details. If set to 'Nothing', no email will be sent.
    , appMail                   :: Maybe MailSettings
    }

instance FromJSON AppSettings where
    parseJSON = withObject "AppSettings" $ \ o -> do
        let defaultDev =
#if DEVELOPMENT
                True
#else
                False
#endif
        appStaticDir              <- o .: "static-dir"
        appDatabaseConf           <- o .: "database"
        appRoot                   <- o .:? "approot"
        appHost                   <- fromString <$> o .: "host"
        appPort                   <- o .: "http-port"
        appIpFromHeader           <- o .: "ip-from-header"

        appClientSessionKeyFile   <- o .: "client-session-key"
        appClientSessionTimeout   <- interval <$> o .: "client-session-timeout"

        appHttpSigTimeLimit       <- interval <$> o .: "request-time-limit"
        appActorKeyRotation       <- interval <$> o .: "actor-key-rotation"

        appDetailedRequestLogging <- o .:? "detailed-logging" .!= defaultDev
        appShouldLogAll           <- o .:? "should-log-all"   .!= defaultDev
        appReloadTemplates        <- o .:? "reload-templates" .!= defaultDev
        appMutableStatic          <- o .:? "mutable-static"   .!= defaultDev
        appSkipCombining          <- o .:? "skip-combining"   .!= defaultDev

        appLoadFontFromLibData    <- o .:? "load-font-from-lib-data" .!= defaultDev

        appRepoDir                <- o .: "repo-dir"
        appDiffContextLines       <- o .: "diff-context-lines"
        appSshPort                <- o .: "ssh-port"
        appSshKeyFile             <- o .: "ssh-key-file"
        appRegister               <- o .: "registration"
        appAccounts               <- o .: "max-accounts"
        appMail                   <- o .:? "mail"

        return AppSettings {..}

-- | Settings for 'widgetFile', such as which template languages to support and
-- default Hamlet settings.
--
-- For more information on modifying behavior, see:
--
-- https://github.com/yesodweb/yesod/wiki/Overriding-widgetFile
widgetFileSettings :: WidgetFileSettings
widgetFileSettings = def

-- | How static files should be combined.
combineSettings :: CombineSettings
combineSettings = def

-- The rest of this file contains settings which rarely need changing by a
-- user.

widgetFile :: String -> Q Exp
widgetFile =
    let wf =
            if appReloadTemplates compileTimeAppSettings
                then widgetFileReload
                else widgetFileNoReload
    in  wf widgetFileSettings

-- | Raw bytes at compile time of @config/settings.yml@
configSettingsYmlBS :: ByteString
configSettingsYmlBS = $(embedFile configSettingsYml)

-- | @config/settings.yml@, parsed to a @Value@.
configSettingsYmlValue :: Value
configSettingsYmlValue = either throw id $ decodeEither' configSettingsYmlBS

-- | A version of @AppSettings@ parsed at compile time from
-- @config/settings.yml@.
compileTimeAppSettings :: AppSettings
compileTimeAppSettings =
    case fromJSON $ applyEnvValue False mempty configSettingsYmlValue of
        Error e          -> error e
        Success settings -> settings

-- The following two functions can be used to combine multiple CSS or JS files
-- at compile time to decrease the number of http requests.
-- Sample usage (inside a Widget):
--
-- > $(combineStylesheets 'StaticR [style1_css, style2_css])

combineStylesheets :: Name -> [Route Static] -> Q Exp
combineStylesheets =
    combineStylesheets'
        (appSkipCombining compileTimeAppSettings)
        combineSettings

combineScripts :: Name -> [Route Static] -> Q Exp
combineScripts =
    combineScripts'
        (appSkipCombining compileTimeAppSettings)
        combineSettings