-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #80 from vaclavsvejcar/feature/78
[#78] Check for Headroom updates
- Loading branch information
Showing
29 changed files
with
1,308 additions
and
130 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| * @vaclavsvejcar |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| ## This is the global configuration file for Headroom. | ||
| ## See https://github.com/vaclavsvejcar/headroom for more details. | ||
|
|
||
| ## Configuration for Headroom Updater. | ||
| updates: | ||
|
|
||
| ## Whether Headroom should automatically check for available updates. | ||
| check-for-updates: true | ||
|
|
||
| ## How often (in days) should Headroom check for updates. | ||
| update-interval-days: 1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| {-# LANGUAGE FlexibleContexts #-} | ||
| {-# LANGUAGE LambdaCase #-} | ||
| {-# LANGUAGE NoImplicitPrelude #-} | ||
| {-# LANGUAGE OverloadedStrings #-} | ||
| {-# LANGUAGE QuasiQuotes #-} | ||
| {-# LANGUAGE RecordWildCards #-} | ||
| {-# LANGUAGE StrictData #-} | ||
|
|
||
| {-| | ||
| Module : Headroom.Command.Bootstrap | ||
| Description : Logic for bootstrapping Headroom | ||
| Copyright : (c) 2019-2021 Vaclav Svejcar | ||
| License : BSD-3-Clause | ||
| Maintainer : [email protected] | ||
| Stability : experimental | ||
| Portability : POSIX | ||
| Logic for running shared code and bootstrapping all /Headroom/ command /RIO/ | ||
| applications. | ||
| -} | ||
|
|
||
| module Headroom.Command.Bootstrap | ||
| ( BootstrapEnv(..) | ||
| , bootstrap | ||
| , runRIO' | ||
| , globalKVStore | ||
| ) | ||
| where | ||
|
|
||
| import Data.String.Interpolate ( iii ) | ||
| import Headroom.Configuration.GlobalConfig ( GlobalConfig(..) | ||
| , globalConfigPath | ||
| , initGlobalConfigIfNeeded | ||
| , loadGlobalConfig | ||
| ) | ||
| import Headroom.Data.Has ( Has(..) | ||
| , HasRIO | ||
| ) | ||
| import Headroom.IO.FileSystem ( FileSystem(..) ) | ||
| import Headroom.IO.KVStore ( KVStore | ||
| , StorePath(..) | ||
| , sqliteKVStore | ||
| ) | ||
| import Headroom.IO.Network ( Network ) | ||
| import Headroom.Meta ( cacheFileName | ||
| , globalConfigDirName | ||
| , productInfo | ||
| , webRepo | ||
| ) | ||
| import Headroom.Meta.Version ( Version | ||
| , printVersionP | ||
| ) | ||
| import Headroom.UI.Message ( messageInfo ) | ||
| import Headroom.Updater ( checkUpdates ) | ||
| import RIO | ||
| import RIO.FilePath ( (</>) ) | ||
| import qualified RIO.Text as T | ||
|
|
||
|
|
||
| -- | Bootstrap environment, containing pieces shared between all commands. | ||
| data BootstrapEnv = BootstrapEnv | ||
| { beGlobalConfig :: GlobalConfig -- ^ loaded global configuration | ||
| } | ||
|
|
||
|
|
||
| -- | Runs /RIO/ application using provided environment data and flag | ||
| -- whether to run in debug mode. | ||
| runRIO' :: (LogFunc -> IO env) | ||
| -- ^ function returning environment data | ||
| -> Bool | ||
| -- ^ whether to run in debug mode | ||
| -> RIO env a | ||
| -- ^ /RIO/ application to execute | ||
| -> IO a | ||
| -- ^ execution result | ||
| runRIO' enfFn isDebug logic = do | ||
| defLogOptions <- logOptionsHandle stderr isDebug | ||
| withLogFunc (setLogUseLoc False defLogOptions) $ \logFunc -> do | ||
| env <- liftIO $ enfFn logFunc | ||
| runRIO env logic | ||
|
|
||
|
|
||
| -- | Executes the initialization logic that should be performed before any other | ||
| -- code is executed. During this bootstrap, for example /global configuration/ | ||
| -- is initialized and loaded, welcome message is printed to console and updates | ||
| -- are checked. | ||
| bootstrap :: ( HasRIO FileSystem env | ||
| , HasRIO KVStore env | ||
| , HasRIO Network env | ||
| , HasLogFunc env | ||
| ) | ||
| => RIO env BootstrapEnv | ||
| bootstrap = do | ||
| welcomeMessage | ||
| initGlobalConfigIfNeeded | ||
| globalConfig@GlobalConfig {..} <- loadGlobalConfig | ||
| checkUpdates gcUpdates >>= \case | ||
| Nothing -> pure () | ||
| Just newVersion -> displayUpdate newVersion | ||
| pure BootstrapEnv { beGlobalConfig = globalConfig } | ||
|
|
||
|
|
||
| -- | Shared /SQLite/-based 'KVStore'. | ||
| globalKVStore :: (HasRIO FileSystem env) => RIO env (KVStore (RIO env)) | ||
| globalKVStore = do | ||
| FileSystem {..} <- viewL | ||
| userDir <- fsGetUserDirectory | ||
| pure | ||
| . sqliteKVStore | ||
| . StorePath | ||
| . T.pack | ||
| $ userDir | ||
| </> globalConfigDirName | ||
| </> cacheFileName | ||
|
|
||
|
|
||
| ------------------------------ PRIVATE FUNCTIONS ----------------------------- | ||
|
|
||
| welcomeMessage :: HasLogFunc env => RIO env () | ||
| welcomeMessage = logInfo . display $ productInfo | ||
|
|
||
|
|
||
| displayUpdate :: (HasRIO FileSystem env, HasLogFunc env) | ||
| => Version | ||
| -> RIO env () | ||
| displayUpdate version = do | ||
| configPath <- globalConfigPath | ||
| logInfo . display . messageInfo $ message configPath | ||
| where | ||
| message configPath = [iii| | ||
| New version #{printVersionP version} is available for download, you can | ||
| get it from #{webRepo}.\n\t | ||
| Tired of seeing this message? You can change the behaviour in global | ||
| config file here:\n\t | ||
| #{configPath} | ||
| |] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.