{-# LANGUAGE ConstraintKinds #-}

{-# LANGUAGE DeriveDataTypeable #-} -- ghc < 7.10

{-# LANGUAGE DeriveFunctor #-}

{-# LANGUAGE FlexibleContexts #-}

{-# LANGUAGE LambdaCase #-}

{-# LANGUAGE OverloadedStrings #-}

{-# LANGUAGE PackageImports #-}

{-# LANGUAGE ScopedTypeVariables #-}

{-# LANGUAGE TemplateHaskell #-}

{-# LANGUAGE ViewPatterns #-}

{-# LANGUAGE TypeFamilies #-}

{-# LANGUAGE MultiWayIf #-}

{-# LANGUAGE CPP #-}

module Stack.Setup

( setupEnv

, ensureCompiler

, ensureDockerStackExe

, getSystemCompiler

, SetupOpts (..)

, defaultSetupInfoYaml

, removeHaskellEnvVars

-- * Stack binary download

, StackReleaseInfo

, getDownloadVersion

, stackVersion

, preferredPlatforms

, downloadStackReleaseInfo

, downloadStackExe

) where

import qualified Codec.Archive.Tar as Tar

import Control.Applicative

import Control.Concurrent.Async.Lifted (Concurrently(..))

import Control.Exception.Safe (catchIO, tryAny)

import Control.Monad (liftM, when, join, void, unless, guard)

import Control.Monad.Catch

import Control.Monad.IO.Class (MonadIO, liftIO)

import Control.Monad.Logger

import Control.Monad.Reader (MonadReader, ReaderT (..))

import Control.Monad.State (get, put, modify)

import Control.Monad.Trans.Control

import "cryptonite" Crypto.Hash (SHA1(..))

import Data.Aeson.Extended

import qualified Data.ByteString as S

import qualified Data.ByteString.Char8 as S8

import qualified Data.ByteString.Lazy as LBS

import Data.Char (isSpace)

import Data.Conduit (Conduit, (=$), await, yield, awaitForever, (.|))

import Data.Conduit.Lazy (lazyConsume)

import Data.Conduit.Lift (evalStateC)

import qualified Data.Conduit.List as CL

import Data.Conduit.Zlib (ungzip)

import Data.Either

import Data.Foldable hiding (concatMap, or, maximum)

import qualified Data.HashMap.Strict as HashMap

import Data.IORef

import Data.IORef.RunOnce (runOnce)

import Data.List hiding (concat, elem, maximumBy, any)

import Data.Map (Map)

import qualified Data.Map as Map

import Data.Maybe

import Data.Monoid

import Data.Ord (comparing)

import Data.Set (Set)

import qualified Data.Set as Set

import Data.String

import Data.Text (Text)

import qualified Data.Text as T

import qualified Data.Text.Encoding as T

import qualified Data.Text.Encoding.Error as T

import Data.Time.Clock (NominalDiffTime, diffUTCTime, getCurrentTime)

import Data.Typeable (Typeable)

import qualified Data.Yaml as Yaml

import Distribution.System (OS (Linux), Arch (..), Platform (..))

import qualified Distribution.System as Cabal

import Distribution.Text (simpleParse)

import Lens.Micro (set)

import Network.HTTP.Simple (getResponseBody, httpLBS, withResponse, getResponseStatusCode)

import Network.HTTP.Download

import Path

import Path.Extra (toFilePathNoTrailingSep)

import Path.IO hiding (findExecutable)

import qualified Paths_stack as Meta

import Prelude hiding (concat, elem, any) -- Fix AMP warning

import Safe (headMay, readMay)

import Stack.Build (build)

import Stack.Config (loadConfig)

import Stack.Constants (distRelativeDir, stackProgName)

import Stack.Exec (defaultEnvSettings)

import Stack.Fetch

import Stack.GhcPkg (createDatabase, getCabalPkgVer, getGlobalDB, mkGhcPackagePath)

import Stack.PrettyPrint

import Stack.Setup.Installed

import Stack.Types.Build

import Stack.Types.Compiler

import Stack.Types.CompilerBuild

import Stack.Types.Config

import Stack.Types.Docker

import Stack.Types.PackageIdentifier

import Stack.Types.PackageName

import Stack.Types.StackT

import Stack.Types.Version

import qualified System.Directory as D

import System.Environment (getExecutablePath)

import System.Exit (ExitCode (..), exitFailure)

import System.FilePath (searchPathSeparator)

import qualified System.FilePath as FP

import System.Process (rawSystem)

import System.Process.Log (withProcessTimeLog)

import System.Process.Read

import System.Process.Run (runCmd, Cmd(..))

import Text.Printf (printf)

#if !WINDOWS

import System.Posix.Files (setFileMode)

#endif

-- | Default location of the stack-setup.yaml file

defaultSetupInfoYaml :: String

defaultSetupInfoYaml =

"https://raw.githubusercontent.com/fpco/stackage-content/master/stack/stack-setup-2.yaml"

data SetupOpts = SetupOpts

{ soptsInstallIfMissing :: !Bool

, soptsUseSystem :: !Bool

-- ^ Should we use a system compiler installation, if available?

, soptsWantedCompiler :: !CompilerVersion

, soptsCompilerCheck :: !VersionCheck

, soptsStackYaml :: !(Maybe (Path Abs File))

-- ^ If we got the desired GHC version from that file

, soptsForceReinstall :: !Bool

, soptsSanityCheck :: !Bool

-- ^ Run a sanity check on the selected GHC

, soptsSkipGhcCheck :: !Bool

-- ^ Don't check for a compatible GHC version/architecture

, soptsSkipMsys :: !Bool

-- ^ Do not use a custom msys installation on Windows

, soptsUpgradeCabal :: !Bool

-- ^ Upgrade the global Cabal library in the database to the newest

-- version. Only works reliably with a stack-managed installation.

, soptsResolveMissingGHC :: !(Maybe Text)

-- ^ Message shown to user for how to resolve the missing GHC

, soptsSetupInfoYaml :: !FilePath

-- ^ Location of the main stack-setup.yaml file

, soptsGHCBindistURL :: !(Maybe String)

-- ^ Alternate GHC binary distribution (requires custom GHCVariant)

}

deriving Show

data SetupException = UnsupportedSetupCombo OS Arch

| MissingDependencies [String]

| UnknownCompilerVersion Text CompilerVersion [CompilerVersion]

| UnknownOSKey Text

| GHCSanityCheckCompileFailed ReadProcessException (Path Abs File)

| WantedMustBeGHC

| RequireCustomGHCVariant

| ProblemWhileDecompressing (Path Abs File)

| SetupInfoMissingSevenz

| GHCJSRequiresStandardVariant

| GHCJSNotBooted

| DockerStackExeNotFound Version Text

deriving Typeable

instance Exception SetupException

instance Show SetupException where

show (UnsupportedSetupCombo os arch) = concat

[ "I don't know how to install GHC for "

, show (os, arch)

, ", please install manually"

]

show (MissingDependencies tools) =

"The following executables are missing and must be installed: " ++

intercalate ", " tools

show (UnknownCompilerVersion oskey wanted known) = concat

[ "No information found for "

, compilerVersionString wanted

, ".\nSupported versions for OS key '" ++ T.unpack oskey ++ "': "

, intercalate ", " (map show known)

]

show (UnknownOSKey oskey) =

"Unable to find installation URLs for OS key: " ++

T.unpack oskey

show (GHCSanityCheckCompileFailed e ghc) = concat

[ "The GHC located at "

, toFilePath ghc

, " failed to compile a sanity check. Please see:\n\n"

, " http://docs.haskellstack.org/en/stable/install_and_upgrade/\n\n"

, "for more information. Exception was:\n"

, show e

]

show WantedMustBeGHC =

"The wanted compiler must be GHC"

show RequireCustomGHCVariant =

"A custom --ghc-variant must be specified to use --ghc-bindist"

show (ProblemWhileDecompressing archive) =

"Problem while decompressing " ++ toFilePath archive

show SetupInfoMissingSevenz =

"SetupInfo missing Sevenz EXE/DLL"

show GHCJSRequiresStandardVariant =

"stack does not yet support using --ghc-variant with GHCJS"

show GHCJSNotBooted =

"GHCJS does not yet have its boot packages installed. Use \"stack setup\" to attempt to run ghcjs-boot."

show (DockerStackExeNotFound stackVersion' osKey) = concat

[ stackProgName

, "-"

, versionString stackVersion'

, " executable not found for "

, T.unpack osKey

, "\nUse the '"

, T.unpack dockerStackExeArgName

, "' option to specify a location"]

-- | Modify the environment variables (like PATH) appropriately, possibly doing installation too

setupEnv :: (StackM env m, HasBuildConfig env, HasGHCVariant env)

=> Maybe Text -- ^ Message to give user when necessary GHC is not available

-> m EnvConfig

setupEnv mResolveMissingGHC = do

config <- view configL

bconfig <- view buildConfigL

let stackYaml = bcStackYaml bconfig

platform <- view platformL

wcVersion <- view wantedCompilerVersionL

wc <- view $ wantedCompilerVersionL.whichCompilerL

let sopts = SetupOpts

{ soptsInstallIfMissing = configInstallGHC config

, soptsUseSystem = configSystemGHC config

, soptsWantedCompiler = wcVersion

, soptsCompilerCheck = configCompilerCheck config

, soptsStackYaml = Just stackYaml

, soptsForceReinstall = False

, soptsSanityCheck = False

, soptsSkipGhcCheck = configSkipGHCCheck config

, soptsSkipMsys = configSkipMsys config

, soptsUpgradeCabal = False

, soptsResolveMissingGHC = mResolveMissingGHC

, soptsSetupInfoYaml = defaultSetupInfoYaml

, soptsGHCBindistURL = Nothing

}

(mghcBin, compilerBuild, _) <- ensureCompiler sopts

-- Modify the initial environment to include the GHC path, if a local GHC

-- is being used

menv0 <- getMinimalEnvOverride

env <- removeHaskellEnvVars

<$> augmentPathMap (maybe [] edBins mghcBin) (unEnvOverride menv0)

menv <- mkEnvOverride platform env

(compilerVer, cabalVer, globaldb) <- runConcurrently $ (,,)

<$> Concurrently (getCompilerVersion menv wc)

<*> Concurrently (getCabalPkgVer menv wc)

<*> Concurrently (getGlobalDB menv wc)

$logDebug "Resolving package entries"

packagesRef <- liftIO $ newIORef Nothing

bc <- view buildConfigL

let envConfig0 = EnvConfig

{ envConfigBuildConfig = bc

, envConfigCabalVersion = cabalVer

, envConfigCompilerVersion = compilerVer

, envConfigCompilerBuild = compilerBuild

, envConfigPackagesRef = packagesRef

}

-- extra installation bin directories

mkDirs <- runReaderT extraBinDirs envConfig0

let mpath = Map.lookup "PATH" env

depsPath <- augmentPath (mkDirs False) mpath

localsPath <- augmentPath (mkDirs True) mpath

deps <- runReaderT packageDatabaseDeps envConfig0

createDatabase menv wc deps

localdb <- runReaderT packageDatabaseLocal envConfig0

createDatabase menv wc localdb

extras <- runReaderT packageDatabaseExtra envConfig0

let mkGPP locals = mkGhcPackagePath locals localdb deps extras globaldb

distDir <- runReaderT distRelativeDir envConfig0

executablePath <- liftIO getExecutablePath

utf8EnvVars <- getUtf8EnvVars menv compilerVer

envRef <- liftIO $ newIORef Map.empty

let getEnvOverride' es = do

m <- readIORef envRef

case Map.lookup es m of

Just eo -> return eo

Nothing -> do

eo <- mkEnvOverride platform

$ Map.insert "PATH" (if esIncludeLocals es then localsPath else depsPath)

$ (if esIncludeGhcPackagePath es

then Map.insert

(case wc of { Ghc -> "GHC_PACKAGE_PATH"; Ghcjs -> "GHCJS_PACKAGE_PATH" })

(mkGPP (esIncludeLocals es))

else id)

$ (if esStackExe es

then Map.insert "STACK_EXE" (T.pack executablePath)

else id)

$ (if esLocaleUtf8 es

then Map.union utf8EnvVars

else id)

$ case (soptsSkipMsys sopts, platform) of

(False, Platform Cabal.I386 Cabal.Windows)

-> Map.insert "MSYSTEM" "MINGW32"

(False, Platform Cabal.X86_64 Cabal.Windows)

-> Map.insert "MSYSTEM" "MINGW64"

_ -> id

-- For reasoning and duplication, see: https://github.com/fpco/stack/issues/70

$ Map.insert "HASKELL_PACKAGE_SANDBOX" (T.pack $ toFilePathNoTrailingSep deps)

$ Map.insert "HASKELL_PACKAGE_SANDBOXES"

(T.pack $ if esIncludeLocals es

then intercalate [searchPathSeparator]

[ toFilePathNoTrailingSep localdb

, toFilePathNoTrailingSep deps

, ""

]

else intercalate [searchPathSeparator]

[ toFilePathNoTrailingSep deps

, ""

])

$ Map.insert "HASKELL_DIST_DIR" (T.pack $ toFilePathNoTrailingSep distDir) env

() <- atomicModifyIORef envRef $ \m' ->

(Map.insert es eo m', ())

return eo

return EnvConfig

{ envConfigBuildConfig = bconfig

{ bcConfig = maybe id addIncludeLib mghcBin

(view configL bconfig)

{ configEnvOverride = getEnvOverride' }

}

, envConfigCabalVersion = cabalVer

, envConfigCompilerVersion = compilerVer

, envConfigCompilerBuild = compilerBuild

, envConfigPackagesRef = envConfigPackagesRef envConfig0

}

-- | Add the include and lib paths to the given Config

addIncludeLib :: ExtraDirs -> Config -> Config

addIncludeLib (ExtraDirs _bins includes libs) config = config

{ configExtraIncludeDirs = Set.union

(configExtraIncludeDirs config)

(Set.fromList includes)

, configExtraLibDirs = Set.union

(configExtraLibDirs config)

(Set.fromList libs)

}

-- | Ensure compiler (ghc or ghcjs) is installed and provide the PATHs to add if necessary

ensureCompiler :: (StackM env m, HasConfig env, HasGHCVariant env)

=> SetupOpts

-> m (Maybe ExtraDirs, CompilerBuild, Bool)

ensureCompiler sopts = do

let wc = whichCompiler (soptsWantedCompiler sopts)

when (getGhcVersion (soptsWantedCompiler sopts) < $(mkVersion "7.8")) $ do

$logWarn "stack will almost certainly fail with GHC below version 7.8"

$logWarn "Valiantly attempting to run anyway, but I know this is doomed"

$logWarn "For more information, see: https://github.com/commercialhaskell/stack/issues/648"

$logWarn ""

-- Check the available GHCs

menv0 <- getMinimalEnvOverride

msystem <-

if soptsUseSystem sopts

then do

$logDebug "Getting system compiler version"

getSystemCompiler menv0 wc

else return Nothing

Platform expectedArch _ <- view platformL

let canUseCompiler compilerVersion arch

| soptsSkipGhcCheck sopts = True

| otherwise = isWanted compilerVersion && arch == expectedArch

isWanted = isWantedCompiler (soptsCompilerCheck sopts) (soptsWantedCompiler sopts)

needLocal = not (any (uncurry canUseCompiler) msystem)

getSetupInfo' <- runOnce (getSetupInfo (soptsSetupInfoYaml sopts))

let getMmsys2Tool = do

platform <- view platformL

localPrograms <- view $ configL.to configLocalPrograms

installed <- listInstalled localPrograms

case platform of

Platform _ Cabal.Windows | not (soptsSkipMsys sopts) ->

case getInstalledTool installed $(mkPackageName "msys2") (const True) of

Just tool -> return (Just tool)

Nothing

| soptsInstallIfMissing sopts -> do

si <- getSetupInfo'

osKey <- getOSKey platform

config <- view configL

VersionedDownloadInfo version info <-

case Map.lookup osKey $ siMsys2 si of

Just x -> return x

Nothing -> error $ "MSYS2 not found for " ++ T.unpack osKey

let tool = Tool (PackageIdentifier $(mkPackageName "msys2") version)

Just <$> downloadAndInstallTool (configLocalPrograms config) si info tool (installMsys2Windows osKey)

| otherwise -> do

$logWarn "Continuing despite missing tool: msys2"

return Nothing

_ -> return Nothing

-- If we need to install a GHC or MSYS, try to do so

-- Return the additional directory paths of GHC & MSYS.

(mtools, compilerBuild) <- if needLocal

then do

-- Install GHC

ghcVariant <- view ghcVariantL

config <- view configL

let localPrograms = configLocalPrograms config

installed <- listInstalled localPrograms

(installedCompiler, compilerBuild) <-

case wc of

Ghc -> do

ghcBuild <- getGhcBuild menv0

ghcPkgName <- parsePackageNameFromString ("ghc" ++ ghcVariantSuffix ghcVariant ++ compilerBuildSuffix ghcBuild)

return (getInstalledTool installed ghcPkgName (isWanted . GhcVersion), ghcBuild)

Ghcjs -> return (getInstalledGhcjs installed isWanted, CompilerBuildStandard)

compilerTool <- case (installedCompiler, soptsForceReinstall sopts) of

(Just tool, False) -> return tool

_

| soptsInstallIfMissing sopts -> do

si <- getSetupInfo'

downloadAndInstallCompiler

compilerBuild

si

(soptsWantedCompiler sopts)

(soptsCompilerCheck sopts)

(soptsGHCBindistURL sopts)

| otherwise -> do

recommendSystemGhc <-

if soptsUseSystem sopts

then return False

else do

msystemGhc <- getSystemCompiler menv0 wc

return (any (uncurry canUseCompiler) msystemGhc)

let suggestion = fromMaybe

(mconcat

([ "To install the correct GHC into "

, T.pack (toFilePath (configLocalPrograms config))

, ", try running \"stack setup\" or use the \"--install-ghc\" flag."

] ++

[ " To use your system GHC installation, run \"stack config set system-ghc --global true\", or use the \"--system-ghc\" flag."

| recommendSystemGhc

]))

(soptsResolveMissingGHC sopts)

throwM $ CompilerVersionMismatch

msystem

(soptsWantedCompiler sopts, expectedArch)

ghcVariant

compilerBuild

(soptsCompilerCheck sopts)

(soptsStackYaml sopts)

suggestion

-- Install msys2 on windows, if necessary

mmsys2Tool <- getMmsys2Tool

return (Just (Just compilerTool, mmsys2Tool), compilerBuild)

-- Have the right ghc, may still need msys

else do

mmsys2Tool <- getMmsys2Tool

return (Just (Nothing, mmsys2Tool), CompilerBuildStandard)

mpaths <- case mtools of

Nothing -> return Nothing

Just (compilerTool, mmsys2Tool) -> do

-- Add GHC's and MSYS's paths to the config.

let idents = catMaybes [compilerTool, mmsys2Tool]

paths <- mapM extraDirs idents

return $ Just $ mconcat paths

menv <-

case mpaths of

Nothing -> return menv0

Just ed -> do

config <- view configL

m <- augmentPathMap (edBins ed) (unEnvOverride menv0)

mkEnvOverride (configPlatform config) (removeHaskellEnvVars m)

when (soptsUpgradeCabal sopts) $ do

unless needLocal $ do

$logWarn "Trying to upgrade Cabal library on a GHC not installed by stack."

$logWarn "This may fail, caveat emptor!"

upgradeCabal menv wc

case mtools of

Just (Just (ToolGhcjs cv), _) -> ensureGhcjsBooted menv cv (soptsInstallIfMissing sopts)

_ -> return ()

when (soptsSanityCheck sopts) $ sanityCheck menv wc

return (mpaths, compilerBuild, needLocal)

-- | Determine which GHC build to use depending on which shared libraries are available

-- on the system.

getGhcBuild

:: (StackM env m, HasConfig env)

=> EnvOverride -> m CompilerBuild

getGhcBuild menv = do

config <- view configL

case configGHCBuild config of

Just ghcBuild -> return ghcBuild

Nothing -> determineGhcBuild

where

determineGhcBuild = do

-- TODO: a more reliable, flexible, and data driven approach would be to actually download small

-- "test" executables (from setup-info) that link to the same gmp/tinfo versions

-- that GHC does (i.e. built in same environment as the GHC bindist). The algorithm would go

-- something like this:

--

-- check for previous 'uname -a'/`ldconfig -p` plus compiler version/variant in cache

-- if cached, then use that as suffix

-- otherwise:

-- download setup-info

-- go through all with right prefix for os/version/variant

-- first try "standard" (no extra suffix), then the rest

-- download "compatibility check" exe if not already downloaded

-- try running it

-- if successful, then choose that

-- cache compiler suffix with the uname -a and ldconfig -p output hash plus compiler version

--

-- Of course, could also try to make a static GHC bindist instead of all this rigamarole.

platform <- view platformL

case platform of

Platform _ Linux -> do

-- Some systems don't have ldconfig in the PATH, so make sure to look in /sbin and /usr/sbin as well

sbinEnv <- modifyEnvOverride menv $

Map.insert "PATH" $

"/sbin:/usr/sbin" <>

maybe "" (":" <>) (Map.lookup "PATH" (eoTextMap menv))

eldconfigOut <- tryProcessStdout Nothing sbinEnv "ldconfig" ["-p"]

egccErrOut <- tryProcessStderrStdout Nothing menv "gcc" ["-v"]

let firstWords = case eldconfigOut of

Right ldconfigOut -> mapMaybe (headMay . T.words) $

T.lines $ T.decodeUtf8With T.lenientDecode ldconfigOut

Left _ -> []

checkLib lib

| libT `elem` firstWords = do

$logDebug ("Found shared library " <> libT <> " in 'ldconfig -p' output")

return True

| otherwise = do

#ifdef WINDOWS

-- (mkAbsDir "/usr/lib") fails to compile on Windows, thus the CPP

return False

#else

-- This is a workaround for the fact that libtinfo.so.6 doesn't appear in

-- the 'ldconfig -p' output on Arch even when it exists.

-- There doesn't seem to be an easy way to get the true list of directories

-- to scan for shared libs, but this works for our particular case.

e <- doesFileExist ($(mkAbsDir "/usr/lib") </> lib)

if e

then $logDebug ("Found shared library " <> libT <> " in /usr/lib")

else $logDebug ("Did not find shared library " <> libT)

return e

#endif

where

libT = T.pack (toFilePath lib)

noPie = case egccErrOut of

Right (gccErr,gccOut) ->

"--enable-default-pie" `elem` S8.words gccOutput || "Gentoo Hardened" `S8.isInfixOf` gccOutput

where gccOutput = gccOut <> gccErr

Left _ -> False

$logDebug $ if noPie

then "PIE disabled"

else "PIE enabled"

hastinfo5 <- checkLib $(mkRelFile "libtinfo.so.5")

hastinfo6 <- checkLib $(mkRelFile "libtinfo.so.6")

hasncurses6 <- checkLib $(mkRelFile "libncursesw.so.6")

hasgmp5 <- checkLib $(mkRelFile "libgmp.so.10")

hasgmp4 <- checkLib $(mkRelFile "libgmp.so.3")

let libComponents =

if | hastinfo5 && hasgmp5 -> []

| hastinfo6 && hasgmp5 -> ["tinfo6"]

| hasncurses6 && hasgmp5 -> ["ncurses6"]

| hasgmp4 && hastinfo5 -> ["gmp4"]

| otherwise -> []

pieComponents =

if noPie

then ["nopie"]

else []

case libComponents ++ pieComponents of

[] -> useBuild CompilerBuildStandard

components -> useBuild (CompilerBuildSpecialized (intercalate "-" components))

_ -> useBuild CompilerBuildStandard

useBuild CompilerBuildStandard = do

$logDebug "Using standard GHC build"

return CompilerBuildStandard

useBuild (CompilerBuildSpecialized s) = do

$logDebug ("Using " <> T.pack s <> " GHC build")

return (CompilerBuildSpecialized s)

-- | Ensure Docker container-compatible 'stack' executable is downloaded

ensureDockerStackExe

:: (StackM env m, HasConfig env)

=> Platform -> m (Path Abs File)

ensureDockerStackExe containerPlatform = do

config <- view configL

containerPlatformDir <- runReaderT platformOnlyRelDir (containerPlatform,PlatformVariantNone)

let programsPath = configLocalProgramsBase config </> containerPlatformDir

tool = Tool (PackageIdentifier $(mkPackageName "stack") stackVersion)

stackExeDir <- installDir programsPath tool

let stackExePath = stackExeDir </> $(mkRelFile "stack")

stackExeExists <- doesFileExist stackExePath

unless stackExeExists $ do

$logInfo $ mconcat ["Downloading Docker-compatible ", T.pack stackProgName, " executable"]

sri <- downloadStackReleaseInfo Nothing Nothing (Just (versionString stackVersion))

let platforms = preferredPlatforms (containerPlatform, PlatformVariantNone)

downloadStackExe platforms sri stackExeDir (const $ return ())

return stackExePath

-- | Install the newest version of Cabal globally

upgradeCabal :: (StackM env m, HasConfig env, HasGHCVariant env)

=> EnvOverride

-> WhichCompiler

-> m ()

upgradeCabal menv wc = do

let name = $(mkPackageName "Cabal")

rmap <- resolvePackages menv Nothing Map.empty (Set.singleton name)

newest <-

case map rpIdent rmap of

[] -> error "No Cabal library found in index, cannot upgrade"

[PackageIdentifier name' version]

| name == name' -> return version

x -> error $ "Unexpected results for resolvePackages: " ++ show x

installed <- getCabalPkgVer menv wc

if installed >= newest

then $logInfo $ T.concat

[ "Currently installed Cabal is "

, T.pack $ versionString installed

, ", newest is "

, T.pack $ versionString newest

, ". I'm not upgrading Cabal."

]

else withSystemTempDir "stack-cabal-upgrade" $ \tmpdir -> do

$logInfo $ T.concat

[ "Installing Cabal-"

, T.pack $ versionString newest

, " to replace "

, T.pack $ versionString installed

]

let ident = PackageIdentifier name newest

-- Nothing below: use the newest .cabal file revision

m <- unpackPackageIdents menv tmpdir Nothing (Map.singleton ident Nothing)

compilerPath <- join $ findExecutable menv (compilerExeName wc)

newestDir <- parseRelDir $ versionString newest

let installRoot = toFilePath $ parent (parent compilerPath)

</> $(mkRelDir "new-cabal")

</> newestDir

dir <-

case Map.lookup ident m of

Nothing -> error "upgradeCabal: Invariant violated, dir missing"

Just dir -> return dir

runCmd (Cmd (Just dir) (compilerExeName wc) menv ["Setup.hs"]) Nothing

platform <- view platformL

let setupExe = toFilePath $ dir </>

(case platform of

Platform _ Cabal.Windows -> $(mkRelFile "Setup.exe")

_ -> $(mkRelFile "Setup"))

dirArgument name' = concat

[ "--"

, name'

, "dir="

, installRoot FP.</> name'

]

args = "configure" : map dirArgument (words "lib bin data doc")

runCmd (Cmd (Just dir) setupExe menv args) Nothing

runCmd (Cmd (Just dir) setupExe menv ["build"]) Nothing

runCmd (Cmd (Just dir) setupExe menv ["install"]) Nothing

$logInfo "New Cabal library installed"

-- | Get the version of the system compiler, if available

getSystemCompiler :: (MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m) => EnvOverride -> WhichCompiler -> m (Maybe (CompilerVersion, Arch))

getSystemCompiler menv wc = do

let exeName = case wc of

Ghc -> "ghc"

Ghcjs -> "ghcjs"

exists <- doesExecutableExist menv exeName

if exists

then do

eres <- tryProcessStdout Nothing menv exeName ["--info"]

let minfo = do

Right bs <- Just eres

pairs_ <- readMay $ S8.unpack bs :: Maybe [(String, String)]

version <- lookup "Project version" pairs_ >>= parseVersionFromString

arch <- lookup "Target platform" pairs_ >>= simpleParse . takeWhile (/= '-')

return (version, arch)

case (wc, minfo) of

(Ghc, Just (version, arch)) -> return (Just (GhcVersion version, arch))

(Ghcjs, Just (_, arch)) -> do

eversion <- tryAny $ getCompilerVersion menv Ghcjs

case eversion of

Left _ -> return Nothing

Right version -> return (Just (version, arch))

(_, Nothing) -> return Nothing

else return Nothing

-- | Download the most recent SetupInfo

getSetupInfo

:: (MonadIO m, MonadThrow m, MonadLogger m, MonadReader env m, HasConfig env)

=> String -> m SetupInfo

getSetupInfo stackSetupYaml = do

config <- view configL

setupInfos <-

mapM

loadSetupInfo

(SetupInfoFileOrURL stackSetupYaml :

configSetupInfoLocations config)

return (mconcat setupInfos)

where

loadSetupInfo (SetupInfoInline si) = return si

loadSetupInfo (SetupInfoFileOrURL urlOrFile) = do

bs <-

case parseUrlThrow urlOrFile of

Just req -> liftM (LBS.toStrict . getResponseBody) $ httpLBS req

Nothing -> liftIO $ S.readFile urlOrFile

WithJSONWarnings si warnings <- either throwM return (Yaml.decodeEither' bs)

when (urlOrFile /= defaultSetupInfoYaml) $

logJSONWarnings urlOrFile warnings

return si

getInstalledTool :: [Tool] -- ^ already installed

-> PackageName -- ^ package to find

-> (Version -> Bool) -- ^ which versions are acceptable

-> Maybe Tool

getInstalledTool installed name goodVersion =

if null available

then Nothing

else Just $ Tool $ maximumBy (comparing packageIdentifierVersion) available

where

available = mapMaybe goodPackage installed

goodPackage (Tool pi') =

if packageIdentifierName pi' == name &&

goodVersion (packageIdentifierVersion pi')

then Just pi'

else Nothing

goodPackage _ = Nothing

getInstalledGhcjs :: [Tool]

-> (CompilerVersion -> Bool)

-> Maybe Tool

getInstalledGhcjs installed goodVersion =

if null available

then Nothing

else Just $ ToolGhcjs $ maximum available

where

available = mapMaybe goodPackage installed

goodPackage (ToolGhcjs cv) = if goodVersion cv then Just cv else Nothing

goodPackage _ = Nothing

downloadAndInstallTool :: StackMiniM env m

=> Path Abs Dir

-> SetupInfo

-> DownloadInfo

-> Tool

-> (SetupInfo -> Path Abs File -> ArchiveType -> Path Abs Dir -> Path Abs Dir -> m ())

-> m Tool

downloadAndInstallTool programsDir si downloadInfo tool installer = do

ensureDir programsDir

(file, at) <- downloadFromInfo programsDir downloadInfo tool

dir <- installDir programsDir tool

tempDir <- tempInstallDir programsDir tool

ignoringAbsence (removeDirRecur tempDir)

ensureDir tempDir

unmarkInstalled programsDir tool

installer si file at tempDir dir

markInstalled programsDir tool

ignoringAbsence (removeDirRecur tempDir)

return tool

downloadAndInstallCompiler :: (StackM env m, HasConfig env, HasGHCVariant env)

=> CompilerBuild

-> SetupInfo

-> CompilerVersion

-> VersionCheck

-> Maybe String

-> m Tool

downloadAndInstallCompiler ghcBuild si wanted@GhcVersion{} versionCheck mbindistURL = do

ghcVariant <- view ghcVariantL

(selectedVersion, downloadInfo) <- case mbindistURL of

Just bindistURL -> do

case ghcVariant of

GHCCustom _ -> return ()

_ -> throwM RequireCustomGHCVariant

case wanted of

GhcVersion version ->

return (version, GHCDownloadInfo mempty mempty (DownloadInfo (T.pack bindistURL) Nothing Nothing))

_ ->

throwM WantedMustBeGHC

_ -> do

ghcKey <- getGhcKey ghcBuild

case Map.lookup ghcKey $ siGHCs si of

Nothing -> throwM $ UnknownOSKey ghcKey

Just pairs_ -> getWantedCompilerInfo ghcKey versionCheck wanted GhcVersion pairs_

config <- view configL

let installer =

case configPlatform config of

Platform _ Cabal.Windows -> installGHCWindows selectedVersion

_ -> installGHCPosix selectedVersion downloadInfo

$logInfo $

"Preparing to install GHC" <>

(case ghcVariant of

GHCStandard -> ""

v -> " (" <> T.pack (ghcVariantName v) <> ")") <>

(case ghcBuild of

CompilerBuildStandard -> ""

b -> " (" <> T.pack (compilerBuildName b) <> ")") <>

" to an isolated location."

$logInfo "This will not interfere with any system-level installation."

ghcPkgName <- parsePackageNameFromString ("ghc" ++ ghcVariantSuffix ghcVariant ++ compilerBuildSuffix ghcBuild)

let tool = Tool $ PackageIdentifier ghcPkgName selectedVersion

downloadAndInstallTool (configLocalPrograms config) si (gdiDownloadInfo downloadInfo) tool installer

downloadAndInstallCompiler compilerBuild si wanted versionCheck _mbindistUrl = do

config <- view configL

ghcVariant <- view ghcVariantL

case (ghcVariant, compilerBuild) of

(GHCStandard, CompilerBuildStandard) -> return ()

_ -> throwM GHCJSRequiresStandardVariant

(selectedVersion, downloadInfo) <- case Map.lookup "source" $ siGHCJSs si of

Nothing -> throwM $ UnknownOSKey "source"

Just pairs_ -> getWantedCompilerInfo "source" versionCheck wanted id pairs_

$logInfo "Preparing to install GHCJS to an isolated location."

$logInfo "This will not interfere with any system-level installation."

let tool = ToolGhcjs selectedVersion

downloadAndInstallTool (configLocalPrograms config) si downloadInfo tool installGHCJS

getWantedCompilerInfo :: (Ord k, MonadThrow m)

=> Text

-> VersionCheck

-> CompilerVersion

-> (k -> CompilerVersion)

-> Map k a

-> m (k, a)

getWantedCompilerInfo key versionCheck wanted toCV pairs_ =

case mpair of

Just pair -> return pair

Nothing -> throwM $ UnknownCompilerVersion key wanted (map toCV (Map.keys pairs_))

where

mpair =

listToMaybe $

sortBy (flip (comparing fst)) $

filter (isWantedCompiler versionCheck wanted . toCV . fst) (Map.toList pairs_)

getGhcKey :: (MonadReader env m, HasPlatform env, HasGHCVariant env, MonadCatch m)

=> CompilerBuild -> m Text

getGhcKey ghcBuild = do

ghcVariant <- view ghcVariantL

platform <- view platformL

osKey <- getOSKey platform

return $ osKey <> T.pack (ghcVariantSuffix ghcVariant) <> T.pack (compilerBuildSuffix ghcBuild)

getOSKey :: (MonadThrow m)

=> Platform -> m Text

getOSKey platform =

case platform of

Platform I386 Cabal.Linux -> return "linux32"

Platform X86_64 Cabal.Linux -> return "linux64"

Platform I386 Cabal.OSX -> return "macosx"

Platform X86_64 Cabal.OSX -> return "macosx"

Platform I386 Cabal.FreeBSD -> return "freebsd32"

Platform X86_64 Cabal.FreeBSD -> return "freebsd64"

Platform I386 Cabal.OpenBSD -> return "openbsd32"

Platform X86_64 Cabal.OpenBSD -> return "openbsd64"

Platform I386 Cabal.Windows -> return "windows32"

Platform X86_64 Cabal.Windows -> return "windows64"

Platform Arm Cabal.Linux -> return "linux-armv7"

Platform arch os -> throwM $ UnsupportedSetupCombo os arch

downloadFromInfo

:: StackMiniM env m

=> Path Abs Dir -> DownloadInfo -> Tool -> m (Path Abs File, ArchiveType)

downloadFromInfo programsDir downloadInfo tool = do

at <-

case extension of

".tar.xz" -> return TarXz

".tar.bz2" -> return TarBz2

".tar.gz" -> return TarGz

".7z.exe" -> return SevenZ

_ -> fail $ "Unknown extension for url: " ++ url

relfile <- parseRelFile $ toolString tool ++ extension

path <- case url of

(parseUrlThrow -> Just _) -> do

let path = programsDir </> relfile

ensureDir programsDir

chattyDownload (T.pack (toolString tool)) downloadInfo path

return path

(parseAbsFile -> Just path) -> do

let DownloadInfo{downloadInfoContentLength=contentLength, downloadInfoSha1=sha1} =

downloadInfo

when (isJust contentLength) $

$logWarn ("`content-length` in not checked \n" <>

"and should not be specified when `url` is a file path")

when (isJust sha1) $

$logWarn ("`sha1` is not checked and \n" <>

"should not be specified when `url` is a file path")

return path

_ ->

fail $ "`url` must be either an HTTP URL or absolute file path: " ++ url

return (path, at)

where

url = T.unpack $ downloadInfoUrl downloadInfo

extension = loop url

where

loop fp

| ext `elem` [".tar", ".bz2", ".xz", ".exe", ".7z", ".gz"] = loop fp' ++ ext

| otherwise = ""

where

(fp', ext) = FP.splitExtension fp

data ArchiveType

= TarBz2

| TarXz

| TarGz

| SevenZ

installGHCPosix :: (StackM env m, HasConfig env)

=> Version

-> GHCDownloadInfo

-> SetupInfo

-> Path Abs File

-> ArchiveType

-> Path Abs Dir

-> Path Abs Dir

-> m ()

installGHCPosix version downloadInfo _ archiveFile archiveType tempDir destDir = do

platform <- view platformL

menv0 <- getMinimalEnvOverride

menv <- mkEnvOverride platform (removeHaskellEnvVars (unEnvOverride menv0))

$logDebug $ "menv = " <> T.pack (show (unEnvOverride menv))

(zipTool', compOpt) <-

case archiveType of

TarXz -> return ("xz", 'J')

TarBz2 -> return ("bzip2", 'j')

TarGz -> return ("gzip", 'z')

SevenZ -> error "Don't know how to deal with .7z files on non-Windows"

-- Slight hack: OpenBSD's tar doesn't support xz.

-- https://github.com/commercialhaskell/stack/issues/2283#issuecomment-237980986

let tarDep =

case (platform, archiveType) of

(Platform _ Cabal.OpenBSD, TarXz) -> checkDependency "gtar"

_ -> checkDependency "tar"

(zipTool, makeTool, tarTool) <- checkDependencies $ (,,)

<$> checkDependency zipTool'

<*> (checkDependency "gmake" <|> checkDependency "make")

<*> tarDep

$logDebug $ "ziptool: " <> T.pack zipTool

$logDebug $ "make: " <> T.pack makeTool

$logDebug $ "tar: " <> T.pack tarTool

dir <-

liftM (tempDir </>) $

parseRelDir $

"ghc-" ++ versionString version

let runStep step wd env cmd args = do

menv' <- modifyEnvOverride menv (Map.union env)

result <- try (readProcessNull (Just wd) menv' cmd args)

case result of

Right _ -> return ()

Left ex -> do

$logError (T.pack (show (ex :: ReadProcessException)))

$prettyError $

hang 2

("Error encountered while" <+> step <+> "GHC with" <> line <>

shellMagenta (fromString (unwords (cmd : args))) <> line <>

-- TODO: Figure out how to insert \ in the appropriate spots

-- hang 2 (shellMagenta (fillSep (fromString cmd : map fromString args))) <> line <>

"run in " <> display wd) <> line <> line <>

"The following directories may now contain files, but won't be used by stack:" <> line <>

" -" <+> display tempDir <> line <>

" -" <+> display destDir <> line

liftIO exitFailure

$logSticky $ T.concat ["Unpacking GHC into ", T.pack . toFilePath $ tempDir, " ..."]

$logDebug $ "Unpacking " <> T.pack (toFilePath archiveFile)

runStep "unpacking" tempDir mempty tarTool [compOpt : "xf", toFilePath archiveFile]

$logSticky "Configuring GHC ..."

runStep "configuring" dir

(gdiConfigureEnv downloadInfo)

(toFilePath $ dir </> $(mkRelFile "configure"))

(("--prefix=" ++ toFilePath destDir) : map T.unpack (gdiConfigureOpts downloadInfo))