539 lines
20 KiB
Haskell
539 lines
20 KiB
Haskell
{-# LANGUAGE CPP #-}
|
|
{-# LANGUAGE DataKinds #-}
|
|
{-# LANGUAGE TypeApplications #-}
|
|
{-# LANGUAGE FlexibleContexts #-}
|
|
{-# LANGUAGE TemplateHaskell #-}
|
|
{-# LANGUAGE QuasiQuotes #-}
|
|
{-# LANGUAGE OverloadedStrings #-}
|
|
{-# LANGUAGE DuplicateRecordFields #-}
|
|
{-# LANGUAGE ViewPatterns #-}
|
|
{-# LANGUAGE TypeOperators #-}
|
|
|
|
module GHCup.OptParse.Install where
|
|
|
|
|
|
|
|
|
|
import GHCup.OptParse.Common
|
|
|
|
import GHCup
|
|
import GHCup.Errors
|
|
import GHCup.Types
|
|
import GHCup.Utils.Dirs
|
|
import GHCup.Prelude
|
|
import GHCup.Prelude.Logger
|
|
import GHCup.Prelude.String.QQ
|
|
|
|
import Codec.Archive
|
|
#if !MIN_VERSION_base(4,13,0)
|
|
import Control.Monad.Fail ( MonadFail )
|
|
#endif
|
|
import Control.Monad.Reader
|
|
import Control.Monad.Trans.Resource
|
|
import Data.Either
|
|
import Data.Functor
|
|
import Data.Maybe
|
|
import Haskus.Utils.Variant.Excepts
|
|
import Options.Applicative hiding ( style )
|
|
import Options.Applicative.Help.Pretty ( text )
|
|
import Prelude hiding ( appendFile )
|
|
import System.Exit
|
|
import URI.ByteString hiding ( uriParser )
|
|
|
|
import qualified Data.Text as T
|
|
|
|
|
|
|
|
|
|
----------------
|
|
--[ Commands ]--
|
|
----------------
|
|
|
|
|
|
data InstallCommand = InstallGHC InstallOptions
|
|
| InstallCabal InstallOptions
|
|
| InstallHLS InstallOptions
|
|
| InstallStack InstallOptions
|
|
|
|
|
|
|
|
|
|
---------------
|
|
--[ Options ]--
|
|
---------------
|
|
|
|
|
|
data InstallOptions = InstallOptions
|
|
{ instVer :: Maybe ToolVersion
|
|
, instBindist :: Maybe URI
|
|
, instSet :: Bool
|
|
, isolateDir :: Maybe FilePath
|
|
, forceInstall :: Bool
|
|
, addConfArgs :: [T.Text]
|
|
}
|
|
|
|
|
|
|
|
---------------
|
|
--[ Footers ]--
|
|
---------------
|
|
|
|
installCabalFooter :: String
|
|
installCabalFooter = [s|Discussion:
|
|
Installs the specified cabal-install version (or a recommended default one)
|
|
into "~/.ghcup/bin", so it can be overwritten by later
|
|
"cabal install cabal-install", which installs into "~/.cabal/bin" by
|
|
default. Make sure to set up your PATH appropriately, so the cabal
|
|
installation takes precedence.|]
|
|
|
|
|
|
|
|
---------------
|
|
--[ Parsers ]--
|
|
---------------
|
|
|
|
installParser :: Parser (Either InstallCommand InstallOptions)
|
|
installParser =
|
|
(Left <$> subparser
|
|
( command
|
|
"ghc"
|
|
( InstallGHC
|
|
<$> info
|
|
(installOpts (Just GHC) <**> helper)
|
|
( progDesc "Install GHC"
|
|
<> footerDoc (Just $ text installGHCFooter)
|
|
)
|
|
)
|
|
<> command
|
|
"cabal"
|
|
( InstallCabal
|
|
<$> info
|
|
(installOpts (Just Cabal) <**> helper)
|
|
( progDesc "Install Cabal"
|
|
<> footerDoc (Just $ text installCabalFooter)
|
|
)
|
|
)
|
|
<> command
|
|
"hls"
|
|
( InstallHLS
|
|
<$> info
|
|
(installOpts (Just HLS) <**> helper)
|
|
( progDesc "Install haskell-language-server"
|
|
<> footerDoc (Just $ text installHLSFooter)
|
|
)
|
|
)
|
|
<> command
|
|
"stack"
|
|
( InstallStack
|
|
<$> info
|
|
(installOpts (Just Stack) <**> helper)
|
|
( progDesc "Install stack"
|
|
<> footerDoc (Just $ text installStackFooter)
|
|
)
|
|
)
|
|
)
|
|
)
|
|
<|> (Right <$> installOpts Nothing)
|
|
where
|
|
installHLSFooter :: String
|
|
installHLSFooter = [s|Discussion:
|
|
Installs haskell-language-server binaries and wrapper
|
|
into "~/.ghcup/bin"
|
|
|
|
Examples:
|
|
# install recommended HLS
|
|
ghcup install hls|]
|
|
|
|
installStackFooter :: String
|
|
installStackFooter = [s|Discussion:
|
|
Installs stack binaries into "~/.ghcup/bin"
|
|
|
|
Examples:
|
|
# install recommended Stack
|
|
ghcup install stack|]
|
|
|
|
installGHCFooter :: String
|
|
installGHCFooter = [s|Discussion:
|
|
Installs the specified GHC version (or a recommended default one) into
|
|
a self-contained "~/.ghcup/ghc/<ghcver>" directory
|
|
and symlinks the ghc binaries to "~/.ghcup/bin/<binary>-<ghcver>".
|
|
|
|
Examples:
|
|
# install recommended GHC
|
|
ghcup install ghc
|
|
|
|
# install latest GHC
|
|
ghcup install ghc latest
|
|
|
|
# install GHC 8.10.2
|
|
ghcup install ghc 8.10.2
|
|
|
|
# install GHC head fedora bindist
|
|
ghcup install ghc -u 'https://gitlab.haskell.org/ghc/ghc/-/jobs/artifacts/master/raw/ghc-x86_64-linux-fedora33-release.tar.xz?job=x86_64-linux-fedora33-release' head|]
|
|
|
|
|
|
installOpts :: Maybe Tool -> Parser InstallOptions
|
|
installOpts tool =
|
|
(\(u, v) b is f -> InstallOptions v u b is f)
|
|
<$> ( ( (,)
|
|
<$> optional
|
|
(option
|
|
(eitherReader uriParser)
|
|
(short 'u' <> long "url" <> metavar "BINDIST_URL" <> help
|
|
"Install the specified version from this bindist"
|
|
<> completer (toolDlCompleter (fromMaybe GHC tool))
|
|
)
|
|
)
|
|
<*> (Just <$> toolVersionTagArgument [] tool)
|
|
)
|
|
<|> pure (Nothing, Nothing)
|
|
)
|
|
<*> fmap (fromMaybe setDefault) (invertableSwitch "set" Nothing setDefault
|
|
(help $ if not setDefault then "Set as active version after install" else "Don't set as active version after install"))
|
|
<*> optional
|
|
(option
|
|
(eitherReader isolateParser)
|
|
( short 'i'
|
|
<> long "isolate"
|
|
<> metavar "DIR"
|
|
<> help "install in an isolated dir instead of the default one"
|
|
<> completer (bashCompleter "directory")
|
|
)
|
|
)
|
|
<*> switch
|
|
(short 'f' <> long "force" <> help "Force install (THIS IS UNSAFE, only use it in Dockerfiles or CI)")
|
|
<*> many (argument str (metavar "CONFIGURE_ARGS" <> help "Additional arguments to bindist configure, prefix with '-- ' (longopts)"))
|
|
where
|
|
setDefault = case tool of
|
|
Nothing -> False
|
|
Just GHC -> False
|
|
Just _ -> True
|
|
|
|
|
|
|
|
|
|
--------------
|
|
--[ Footer ]--
|
|
--------------
|
|
|
|
|
|
installToolFooter :: String
|
|
installToolFooter = [s|Discussion:
|
|
Installs GHC or cabal. When no command is given, installs GHC
|
|
with the specified version/tag.
|
|
It is recommended to always specify a subcommand (ghc/cabal/hls/stack).|]
|
|
|
|
|
|
|
|
|
|
---------------------------
|
|
--[ Effect interpreters ]--
|
|
---------------------------
|
|
|
|
type InstallEffects = '[ AlreadyInstalled
|
|
, UnknownArchive
|
|
, ArchiveResult
|
|
, FileDoesNotExistError
|
|
, CopyError
|
|
, NotInstalled
|
|
, DirNotEmpty
|
|
, NoDownload
|
|
, NotInstalled
|
|
, BuildFailed
|
|
, TagNotFound
|
|
, DayNotFound
|
|
, DigestError
|
|
, ContentLengthError
|
|
, GPGError
|
|
, DownloadFailed
|
|
, TarDirDoesNotExist
|
|
, NextVerNotFound
|
|
, NoToolVersionSet
|
|
, FileAlreadyExistsError
|
|
, ProcessError
|
|
, UninstallFailed
|
|
, MergeFileTreeError
|
|
, InstallSetError
|
|
]
|
|
|
|
|
|
runInstTool :: AppState
|
|
-> Excepts InstallEffects (ResourceT (ReaderT AppState IO)) a
|
|
-> IO (VEither InstallEffects a)
|
|
runInstTool appstate' =
|
|
flip runReaderT appstate'
|
|
. runResourceT
|
|
. runE
|
|
@InstallEffects
|
|
|
|
|
|
type InstallGHCEffects = '[ AlreadyInstalled
|
|
, ArchiveResult
|
|
, BuildFailed
|
|
, CopyError
|
|
, DigestError
|
|
, ContentLengthError
|
|
, DirNotEmpty
|
|
, DownloadFailed
|
|
, FileAlreadyExistsError
|
|
, FileDoesNotExistError
|
|
, GPGError
|
|
, MergeFileTreeError
|
|
, NextVerNotFound
|
|
, NoDownload
|
|
, NoToolVersionSet
|
|
, NotInstalled
|
|
, ProcessError
|
|
, TagNotFound
|
|
, DayNotFound
|
|
, TarDirDoesNotExist
|
|
, UninstallFailed
|
|
, UnknownArchive
|
|
, InstallSetError
|
|
]
|
|
|
|
runInstGHC :: AppState
|
|
-> Excepts InstallGHCEffects (ResourceT (ReaderT AppState IO)) a
|
|
-> IO (VEither InstallGHCEffects a)
|
|
runInstGHC appstate' =
|
|
flip runReaderT appstate'
|
|
. runResourceT
|
|
. runE
|
|
@InstallGHCEffects
|
|
|
|
|
|
-------------------
|
|
--[ Entrypoints ]--
|
|
-------------------
|
|
|
|
|
|
install :: Either InstallCommand InstallOptions -> Settings -> IO AppState -> (ReaderT LeanAppState IO () -> IO ()) -> IO ExitCode
|
|
install installCommand settings getAppState' runLogger = case installCommand of
|
|
(Right iopts) -> do
|
|
runLogger (logWarn "This is an old-style command for installing GHC. Use 'ghcup install ghc' instead.")
|
|
installGHC iopts
|
|
(Left (InstallGHC iopts)) -> installGHC iopts
|
|
(Left (InstallCabal iopts)) -> installCabal iopts
|
|
(Left (InstallHLS iopts)) -> installHLS iopts
|
|
(Left (InstallStack iopts)) -> installStack iopts
|
|
where
|
|
installGHC :: InstallOptions -> IO ExitCode
|
|
installGHC InstallOptions{..} = do
|
|
s'@AppState{ dirs = Dirs{ .. } } <- liftIO getAppState'
|
|
(case instBindist of
|
|
Nothing -> runInstGHC s' $ do
|
|
(v, vi) <- liftE $ fromVersion instVer GHC
|
|
liftE $ runBothE' (installGHCBin
|
|
(_tvVersion v)
|
|
(maybe GHCupInternal IsolateDir isolateDir)
|
|
forceInstall
|
|
addConfArgs
|
|
)
|
|
$ when instSet $ when (isNothing isolateDir) $ liftE $ void $ setGHC v SetGHCOnly Nothing
|
|
pure vi
|
|
Just uri -> do
|
|
runInstGHC s'{ settings = settings {noVerify = True}} $ do
|
|
(v, vi) <- liftE $ fromVersion instVer GHC
|
|
liftE $ runBothE' (installGHCBindist
|
|
(DownloadInfo uri (Just $ RegexDir "ghc-.*") "" Nothing)
|
|
(_tvVersion v)
|
|
(maybe GHCupInternal IsolateDir isolateDir)
|
|
forceInstall
|
|
addConfArgs
|
|
)
|
|
$ when instSet $ when (isNothing isolateDir) $ liftE $ void $ setGHC v SetGHCOnly Nothing
|
|
pure vi
|
|
)
|
|
>>= \case
|
|
VRight vi -> do
|
|
runLogger $ logInfo "GHC installation successful"
|
|
forM_ (_viPostInstall =<< vi) $ \msg ->
|
|
runLogger $ logInfo msg
|
|
pure ExitSuccess
|
|
|
|
VLeft e@(V (AlreadyInstalled _ _)) -> do
|
|
runLogger $ logWarn $ T.pack $ prettyHFError e
|
|
pure ExitSuccess
|
|
VLeft e@(V (AlreadyInstalled _ _)) -> do
|
|
runLogger $ logWarn $ T.pack $ prettyHFError e
|
|
pure ExitSuccess
|
|
|
|
VLeft (V (DirNotEmpty fp)) -> do
|
|
runLogger $ logError $
|
|
"Install directory " <> T.pack fp <> " is not empty."
|
|
pure $ ExitFailure 3
|
|
VLeft (V (DirNotEmpty fp)) -> do
|
|
runLogger $ logError $
|
|
"Install directory " <> T.pack fp <> " is not empty."
|
|
pure $ ExitFailure 3
|
|
|
|
VLeft err@(V (BuildFailed tmpdir _)) -> do
|
|
case keepDirs settings of
|
|
Never -> runLogger (logError $ T.pack $ prettyHFError err)
|
|
_ -> runLogger (logError $ T.pack (prettyHFError err) <> "\n" <>
|
|
"Check the logs at " <> T.pack (fromGHCupPath logsDir) <> " and the build directory " <> T.pack tmpdir <> " for more clues." <> "\n" <>
|
|
"Make sure to clean up " <> T.pack tmpdir <> " afterwards.")
|
|
pure $ ExitFailure 3
|
|
VLeft err@(V (BuildFailed tmpdir _)) -> do
|
|
case keepDirs settings of
|
|
Never -> runLogger (logError $ T.pack $ prettyHFError err)
|
|
_ -> runLogger (logError $ T.pack (prettyHFError err) <> "\n" <>
|
|
"Check the logs at " <> T.pack (fromGHCupPath logsDir) <> " and the build directory " <> T.pack tmpdir <> " for more clues." <> "\n" <>
|
|
"Make sure to clean up " <> T.pack tmpdir <> " afterwards.")
|
|
pure $ ExitFailure 3
|
|
|
|
VLeft e -> do
|
|
runLogger $ do
|
|
logError $ T.pack $ prettyHFError e
|
|
logError $ "Also check the logs in " <> T.pack (fromGHCupPath logsDir)
|
|
pure $ ExitFailure 3
|
|
|
|
|
|
installCabal :: InstallOptions -> IO ExitCode
|
|
installCabal InstallOptions{..} = do
|
|
s'@AppState{ dirs = Dirs{ .. } } <- liftIO getAppState'
|
|
(case instBindist of
|
|
Nothing -> runInstTool s' $ do
|
|
(_tvVersion -> v, vi) <- liftE $ fromVersion instVer Cabal
|
|
liftE $ runBothE' (installCabalBin
|
|
v
|
|
(maybe GHCupInternal IsolateDir isolateDir)
|
|
forceInstall
|
|
) $ when instSet $ when (isNothing isolateDir) $ liftE $ setCabal v
|
|
pure vi
|
|
Just uri -> do
|
|
runInstTool s'{ settings = settings { noVerify = True}} $ do
|
|
(_tvVersion -> v, vi) <- liftE $ fromVersion instVer Cabal
|
|
liftE $ runBothE' (installCabalBindist
|
|
(DownloadInfo uri Nothing "" Nothing)
|
|
v
|
|
(maybe GHCupInternal IsolateDir isolateDir)
|
|
forceInstall
|
|
) $ when instSet $ when (isNothing isolateDir) $ liftE $ setCabal v
|
|
pure vi
|
|
)
|
|
>>= \case
|
|
VRight vi -> do
|
|
runLogger $ logInfo "Cabal installation successful"
|
|
forM_ (_viPostInstall =<< vi) $ \msg ->
|
|
runLogger $ logInfo msg
|
|
pure ExitSuccess
|
|
VLeft e@(V (AlreadyInstalled _ _)) -> do
|
|
runLogger $ logWarn $ T.pack $ prettyHFError e
|
|
pure ExitSuccess
|
|
VLeft (V (FileAlreadyExistsError fp)) -> do
|
|
runLogger $ logWarn $
|
|
"File " <> T.pack fp <> " already exists. Use 'ghcup install cabal --isolate " <> T.pack fp <> " --force ..." <> "' if you want to overwrite."
|
|
pure $ ExitFailure 3
|
|
VLeft e@(V (AlreadyInstalled _ _)) -> do
|
|
runLogger $ logWarn $ T.pack $ prettyHFError e
|
|
pure ExitSuccess
|
|
VLeft (V (FileAlreadyExistsError fp)) -> do
|
|
runLogger $ logWarn $
|
|
"File " <> T.pack fp <> " already exists. Use 'ghcup install cabal --isolate " <> T.pack fp <> " --force ..." <> "' if you want to overwrite."
|
|
pure $ ExitFailure 3
|
|
VLeft e -> do
|
|
runLogger $ do
|
|
logError $ T.pack $ prettyHFError e
|
|
logError $ "Also check the logs in " <> T.pack (fromGHCupPath logsDir)
|
|
pure $ ExitFailure 4
|
|
|
|
installHLS :: InstallOptions -> IO ExitCode
|
|
installHLS InstallOptions{..} = do
|
|
s'@AppState{ dirs = Dirs{ .. } } <- liftIO getAppState'
|
|
(case instBindist of
|
|
Nothing -> runInstTool s' $ do
|
|
(_tvVersion -> v, vi) <- liftE $ fromVersion instVer HLS
|
|
liftE $ runBothE' (installHLSBin
|
|
v
|
|
(maybe GHCupInternal IsolateDir isolateDir)
|
|
forceInstall
|
|
) $ when instSet $ when (isNothing isolateDir) $ liftE $ setHLS v SetHLSOnly Nothing
|
|
pure vi
|
|
Just uri -> do
|
|
runInstTool s'{ settings = settings { noVerify = True}} $ do
|
|
(_tvVersion -> v, vi) <- liftE $ fromVersion instVer HLS
|
|
-- TODO: support legacy
|
|
liftE $ runBothE' (installHLSBindist
|
|
(DownloadInfo uri (if isWindows then Nothing else Just (RegexDir "haskell-language-server-*")) "" Nothing)
|
|
v
|
|
(maybe GHCupInternal IsolateDir isolateDir)
|
|
forceInstall
|
|
) $ when instSet $ when (isNothing isolateDir) $ liftE $ setHLS v SetHLSOnly Nothing
|
|
pure vi
|
|
)
|
|
>>= \case
|
|
VRight vi -> do
|
|
runLogger $ logInfo "HLS installation successful"
|
|
forM_ (_viPostInstall =<< vi) $ \msg ->
|
|
runLogger $ logInfo msg
|
|
pure ExitSuccess
|
|
VLeft e@(V (AlreadyInstalled _ _)) -> do
|
|
runLogger $ logWarn $ T.pack $ prettyHFError e
|
|
pure ExitSuccess
|
|
VLeft (V (FileAlreadyExistsError fp)) -> do
|
|
runLogger $ logWarn $
|
|
"File " <> T.pack fp <> " already exists. Use 'ghcup install hls --isolate " <> T.pack fp <> " --force ..." <> "' if you want to overwrite."
|
|
pure $ ExitFailure 3
|
|
VLeft e@(V (AlreadyInstalled _ _)) -> do
|
|
runLogger $ logWarn $ T.pack $ prettyHFError e
|
|
pure ExitSuccess
|
|
VLeft (V (FileAlreadyExistsError fp)) -> do
|
|
runLogger $ logWarn $
|
|
"File " <> T.pack fp <> " already exists. Use 'ghcup install hls --isolate " <> T.pack fp <> " --force ..." <> "' if you want to overwrite."
|
|
pure $ ExitFailure 3
|
|
VLeft e -> do
|
|
runLogger $ do
|
|
logError $ T.pack $ prettyHFError e
|
|
logError $ "Also check the logs in " <> T.pack (fromGHCupPath logsDir)
|
|
pure $ ExitFailure 4
|
|
|
|
installStack :: InstallOptions -> IO ExitCode
|
|
installStack InstallOptions{..} = do
|
|
s'@AppState{ dirs = Dirs{ .. } } <- liftIO getAppState'
|
|
(case instBindist of
|
|
Nothing -> runInstTool s' $ do
|
|
(_tvVersion -> v, vi) <- liftE $ fromVersion instVer Stack
|
|
liftE $ runBothE' (installStackBin
|
|
v
|
|
(maybe GHCupInternal IsolateDir isolateDir)
|
|
forceInstall
|
|
) $ when instSet $ when (isNothing isolateDir) $ liftE $ setStack v
|
|
pure vi
|
|
Just uri -> do
|
|
runInstTool s'{ settings = settings { noVerify = True}} $ do
|
|
(_tvVersion -> v, vi) <- liftE $ fromVersion instVer Stack
|
|
liftE $ runBothE' (installStackBindist
|
|
(DownloadInfo uri Nothing "" Nothing)
|
|
v
|
|
(maybe GHCupInternal IsolateDir isolateDir)
|
|
forceInstall
|
|
) $ when instSet $ when (isNothing isolateDir) $ liftE $ setStack v
|
|
pure vi
|
|
)
|
|
>>= \case
|
|
VRight vi -> do
|
|
runLogger $ logInfo "Stack installation successful"
|
|
forM_ (_viPostInstall =<< vi) $ \msg ->
|
|
runLogger $ logInfo msg
|
|
pure ExitSuccess
|
|
VLeft e@(V (AlreadyInstalled _ _)) -> do
|
|
runLogger $ logWarn $ T.pack $ prettyHFError e
|
|
pure ExitSuccess
|
|
VLeft (V (FileAlreadyExistsError fp)) -> do
|
|
runLogger $ logWarn $
|
|
"File " <> T.pack fp <> " already exists. Use 'ghcup install stack --isolate " <> T.pack fp <> " --force ..." <> "' if you want to overwrite."
|
|
pure $ ExitFailure 3
|
|
VLeft e@(V (AlreadyInstalled _ _)) -> do
|
|
runLogger $ logWarn $ T.pack $ prettyHFError e
|
|
pure ExitSuccess
|
|
VLeft (V (FileAlreadyExistsError fp)) -> do
|
|
runLogger $ logWarn $
|
|
"File " <> T.pack fp <> " already exists. Use 'ghcup install stack --isolate " <> T.pack fp <> " --force ..." <> "' if you want to overwrite."
|
|
pure $ ExitFailure 3
|
|
VLeft e -> do
|
|
runLogger $ do
|
|
logError $ T.pack $ prettyHFError e
|
|
logError $ "Also check the logs in " <> T.pack (fromGHCupPath logsDir)
|
|
pure $ ExitFailure 4
|