-- Copyright (C) 2015,2017 Daniel Gröber -- -- 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 . {-# LANGUAGE RecordWildCards, FlexibleContexts, NamedFieldPuns, DeriveFunctor, GADTs #-} {-| Module : CabalHelper.Compiletime.Compile Description : Runtime compilation machinery License : AGPL-3 -} module CabalHelper.Compiletime.Compile where import Control.Applicative import Control.Arrow import Control.Exception as E import Control.Monad import Control.Monad.Trans.Maybe import Control.Monad.IO.Class import Data.Char import Data.List import Data.Maybe import Data.String import Data.Version import GHC.IO.Exception (IOErrorType(OtherError)) import Text.Printf import Text.Read import System.Directory import System.FilePath import System.Process import System.Exit import System.Environment import System.IO import System.IO.Error import System.IO.Temp import Prelude import Distribution.System (buildPlatform) import Distribution.Text (display) import Paths_cabal_helper (version) import CabalHelper.Compiletime.Data import CabalHelper.Compiletime.Log import CabalHelper.Compiletime.Types import CabalHelper.Shared.Common import CabalHelper.Shared.Sandbox (getSandboxPkgDb) data Compile = CompileWithCabalSource { compCabalSourceDir :: CabalSourceDir , compCabalSourceVersion :: Version } | CompileWithCabalPackage { compPackageDb :: Maybe PackageDbDir , compCabalVersion :: CabalVersion , compPackageDeps :: [String] , compProductTarget :: CompilationProductScope } data CompPaths = CompPaths { compSrcDir :: FilePath , compOutDir :: FilePath , compExePath :: FilePath } -- | The Helper executable we produce as a compilation product can either be -- placed in a per-project location, or a per-user/global location in the user's -- home directory. This type controls where the compilation process places the -- executable. data CompilationProductScope = CPSGlobal | CPSProject compileHelper :: Options -> Version -> FilePath -> FilePath -> IO (Either ExitCode FilePath) compileHelper opts hdrCabalVersion projdir distdir = do Just (prepare, comp) <- runMaybeT $ msum $ case oCabalPkgDb opts of Nothing -> [ compileCabalSource , compileSandbox , compileGlobal , MaybeT $ Just <$> compileWithCabalInPrivatePkgDb ] Just db -> [ return $ (return (), compileWithPkg (Just db) hdrCabalVersion CPSProject) ] appdir <- appCacheDir let cp@CompPaths {compExePath} = compPaths appdir distdir comp exists <- doesFileExist compExePath if exists then do vLog opts $ "helper already compiled, using exe: "++compExePath return (Right compExePath) else do vLog opts $ "helper exe does not exist, compiling"++compExePath prepare >> compile comp cp opts where logMsg = "using helper compiled with Cabal from " -- for relaxed deps: find (sameMajorVersionAs hdrCabalVersion) . reverse . sort -- | Check if this version is globally available compileGlobal :: MaybeT IO (IO (), Compile) compileGlobal = do ver <- MaybeT $ find (== hdrCabalVersion) <$> listCabalVersions opts vLog opts $ logMsg ++ "user/global package-db" return $ (return (), compileWithPkg Nothing ver CPSGlobal) -- | Check if this version is available in the project sandbox compileSandbox :: MaybeT IO (IO (), Compile) compileSandbox = do let ghcVer = ghcVersion opts mdb_path = getSandboxPkgDb projdir (display buildPlatform) =<< ghcVer sandbox <- PackageDbDir <$> MaybeT mdb_path ver <- MaybeT $ logIOError opts "compileSandbox" $ find (== hdrCabalVersion) <$> listCabalVersions' opts (Just sandbox) vLog opts $ logMsg ++ "sandbox package-db" return $ (return (), compileWithPkg (Just sandbox) ver CPSProject) -- | Compile the requested Cabal version into an isolated package-db if it's -- not there already compileWithCabalInPrivatePkgDb :: IO (IO (), Compile) compileWithCabalInPrivatePkgDb = do db@(PackageDbDir db_path) <- getPrivateCabalPkgDb opts (CabalVersion hdrCabalVersion) vLog opts $ logMsg ++ "private package-db in " ++ db_path return (prepare db, compileWithPkg (Just db) hdrCabalVersion CPSGlobal) where prepare db = do db_exists <- liftIO $ cabalVersionExistsInPkgDb opts hdrCabalVersion db when (not db_exists) $ void $ installCabal opts (Right hdrCabalVersion) `E.catch` \(SomeException _) -> errorInstallCabal hdrCabalVersion distdir -- | See if we're in a cabal source tree compileCabalSource :: MaybeT IO (IO (), Compile) compileCabalSource = do let cabalFile = projdir "Cabal.cabal" cabalSrc <- liftIO $ doesFileExist cabalFile let projdir' = CabalSourceDir projdir case cabalSrc of False -> mzero True -> do vLog opts $ "projdir looks like Cabal source tree (Cabal.cabal exists)" cf <- liftIO $ readFile cabalFile let buildType = cabalFileBuildType cf ver = cabalFileVersion cf case buildType of "simple" -> do vLog opts $ "Cabal source tree is build-type:simple, moving on" mzero "custom" -> do vLog opts $ "compiling helper with local Cabal source tree" return $ (return (), compileWithCabalSource projdir' ver) _ -> error $ "compileCabalSource: unknown build-type: '"++buildType++"'" compileWithCabalSource srcDir ver = CompileWithCabalSource { compCabalSourceDir = srcDir , compCabalSourceVersion = ver } compileWithPkg mdb ver target = CompileWithCabalPackage { compPackageDb = mdb , compCabalVersion = CabalVersion ver , compPackageDeps = [cabalPkgId ver] , compProductTarget = target } cabalPkgId v = "Cabal-" ++ showVersion v compile :: Compile -> CompPaths -> Options -> IO (Either ExitCode FilePath) compile comp paths@CompPaths {..} opts@Options {..} = do createDirectoryIfMissing True compOutDir createHelperSources compSrcDir vLog opts $ "compSrcDir: " ++ compSrcDir vLog opts $ "compOutDir: " ++ compOutDir vLog opts $ "compExePath: " ++ compExePath invokeGhc opts $ compGhcInvocation comp paths compPaths :: FilePath -> FilePath -> Compile -> CompPaths compPaths appdir distdir c = case c of CompileWithCabalPackage {compProductTarget=CPSGlobal,..} -> CompPaths {..} where compSrcDir = appdir exeName compCabalVersion <.> "build" compOutDir = compSrcDir compExePath = appdir exeName compCabalVersion CompileWithCabalPackage {compProductTarget=CPSProject,..} -> distdirPaths CompileWithCabalSource {..} -> distdirPaths where distdirPaths = CompPaths {..} where compSrcDir = distdir "cabal-helper" compOutDir = compSrcDir compExePath = compOutDir "cabal-helper" data GhcInvocation = GhcInvocation { giOutDir :: FilePath , giOutput :: FilePath , giCPPOptions :: [String] , giPackageDBs :: [PackageDbDir] , giIncludeDirs :: [FilePath] , giHideAllPackages :: Bool , giPackages :: [String] , giWarningFlags :: [String] , giInputs :: [String] } compGhcInvocation :: Compile -> CompPaths -> GhcInvocation compGhcInvocation comp CompPaths {..} = case comp of CompileWithCabalSource {..} -> GhcInvocation { giIncludeDirs = [compSrcDir, unCabalSourceDir compCabalSourceDir] , giPackageDBs = [] , giHideAllPackages = False , giPackages = [] , giCPPOptions = cppOptions compCabalSourceVersion ++ [cabalVersionMacro compCabalSourceVersion] , .. } CompileWithCabalPackage {..} -> GhcInvocation { giIncludeDirs = [compSrcDir] , giPackageDBs = maybeToList compPackageDb , giHideAllPackages = True , giPackages = [ "base" , "containers" , "directory" , "filepath" , "process" , "bytestring" , "ghc-prim" ] ++ compPackageDeps , giCPPOptions = cppOptions (unCabalVersion compCabalVersion) , .. } where unCabalVersion (CabalVersion ver) = ver unCabalVersion (CabalHEAD _) = Version [10000000, 0, 0] [] cppOptions cabalVer = [ "-DCABAL_HELPER=1" , cabalMinVersionMacro cabalVer ] giOutDir = compOutDir giOutput = compExePath giWarningFlags = [ "-w" ] -- no point in bothering end users with warnings giInputs = [compSrcDir"CabalHelper""Runtime""Main.hs"] cabalVersionMacro :: Version -> String cabalVersionMacro (Version vs _) = "-DCABAL_VERSION="++intercalate "," (map show vs) cabalMinVersionMacro :: Version -> String cabalMinVersionMacro (Version (mj1:mj2:mi:_) _) = "-DCH_MIN_VERSION_Cabal(major1,major2,minor)=\ \( (major1) < "++show mj1++" \ \|| (major1) == "++show mj1++" && (major2) < "++show mj2++" \ \|| (major1) == "++show mj1++" && (major2) == "++show mj2++" && (minor) <= "++show mi++ ")" cabalMinVersionMacro _ = error "cabalMinVersionMacro: Version must have at least 3 components" invokeGhc :: Options -> GhcInvocation -> IO (Either ExitCode FilePath) invokeGhc opts@Options {..} GhcInvocation {..} = do rv <- callProcessStderr' opts Nothing oGhcProgram $ concat [ [ "-outputdir", giOutDir , "-o", giOutput ] , map ("-optP"++) giCPPOptions , map ("-package-conf="++) $ unPackageDbDir <$> giPackageDBs , map ("-i"++) $ nub $ "" : giIncludeDirs , if giHideAllPackages then ["-hide-all-packages"] else [] , concatMap (\p -> ["-package", p]) giPackages , giWarningFlags , ["--make"] , giInputs ] return $ case rv of ExitSuccess -> Right giOutput e@(ExitFailure _) -> Left e -- | Cabal library version we're compiling the helper exe against. data CabalVersion = CabalHEAD { cvCommitId :: CommitId } | CabalVersion { cabalVersion :: Version } newtype CommitId = CommitId { unCommitId :: String } exeName :: CabalVersion -> String exeName (CabalHEAD commitid) = intercalate "-" [ "cabal-helper" ++ showVersion version , "CabalHEAD" ++ unCommitId commitid ] exeName CabalVersion {cabalVersion} = intercalate "-" [ "cabal-helper" ++ showVersion version , "Cabal" ++ showVersion cabalVersion ] callProcessStderr' :: Options -> Maybe FilePath -> FilePath -> [String] -> IO ExitCode callProcessStderr' opts mwd exe args = do let cd = case mwd of Nothing -> []; Just wd -> [ "cd", formatProcessArg wd++";" ] vLog opts $ intercalate " " $ cd ++ map formatProcessArg (exe:args) (_, _, _, h) <- createProcess (proc exe args) { std_out = UseHandle stderr , cwd = mwd } waitForProcess h callProcessStderr :: Options -> Maybe FilePath -> FilePath -> [String] -> IO () callProcessStderr opts mwd exe args = do rv <- callProcessStderr' opts mwd exe args case rv of ExitSuccess -> return () ExitFailure v -> processFailedException "callProcessStderr" exe args v processFailedException :: String -> String -> [String] -> Int -> IO a processFailedException fn exe args rv = ioError $ mkIOError OtherError msg Nothing Nothing where msg = concat [ fn, ": ", exe, " " , intercalate " " (map formatProcessArg args) , " (exit " ++ show rv ++ ")" ] formatProcessArg :: String -> String formatProcessArg xs | any isSpace xs = "'"++ xs ++"'" | otherwise = xs data HEAD = HEAD deriving (Eq, Show) installCabal :: Options -> Either HEAD Version -> IO (PackageDbDir, CabalVersion) installCabal opts ever = do appdir <- appCacheDir let message ver = do let sver = showVersion ver hPutStr stderr $ printf "\ \cabal-helper-wrapper: Installing a private copy of Cabal because we couldn't\n\ \find the right version in your global/user package-db, this might take a\n\ \while but will only happen once per Cabal version you're using.\n\ \\n\ \If anything goes horribly wrong just delete this directory and try again:\n\ \ %s\n\ \\n\ \If you want to avoid this automatic installation altogether install\n\ \version %s of Cabal manually (into your user or global package-db):\n\ \ $ cabal install Cabal --constraint \"Cabal == %s\"\n\ \\n\ \Installing Cabal %s ...\n" appdir sver sver sver withSystemTempDirectory "cabal-helper-Cabal-source" $ \tmpdir -> do (srcdir, cabalVer) <- case ever of Left HEAD -> do second CabalHEAD <$> unpackCabalHEAD tmpdir Right ver -> do message ver let patch = fromMaybe nopCabalPatchDescription $ find ((ver`elem`) . cpdVersions) patchyCabalVersions (,) <$> unpackPatchedCabal opts ver tmpdir patch <*> pure (CabalVersion ver) db <- createPkgDb opts cabalVer runCabalInstall opts db srcdir ever return (db, cabalVer) {- TODO: If the Cabal version we want to install is less than or equal to one we have available, either through act-as-setup or in a package-db we should be able to use act-as-setup or build a default Setup.hs exe and patch the Cabal source to say build-type:simple. This will sidestep bugs in c-i>=1.24 See conversation in https://github.com/haskell/cabal/commit/e2bf243300957321497353a2f85517e464f764ab Otherwise we might be able to use the shipped Setup.hs -} runCabalInstall :: Options -> PackageDbDir -> CabalSourceDir -> Either HEAD Version-> IO () runCabalInstall opts (PackageDbDir db) (CabalSourceDir srcdir) ever = do civ@CabalInstallVersion {..} <- cabalInstallVersion opts cabal_opts <- return $ concat [ [ "--package-db=clear" , "--package-db=global" , "--package-db=" ++ db , "--prefix=" ++ db "prefix" ] , withGHCProgramOptions opts , if cabalInstallVer >= Version [1,20,0,0] [] then ["--no-require-sandbox"] else [] , [ "install", srcdir ] , if oVerbose opts then ["-v"] else [] , [ "--only-dependencies" ] ] callProcessStderr opts (Just "/") (oCabalProgram opts) cabal_opts runSetupHs opts db srcdir ever civ hPutStrLn stderr "done" withGHCProgramOptions :: Options -> [String] withGHCProgramOptions opts = concat [ [ "--with-ghc=" ++ oGhcProgram opts ] , if oGhcPkgProgram opts /= oGhcPkgProgram defaultOptions then [ "--with-ghc-pkg=" ++ oGhcPkgProgram opts ] else [] ] runSetupHs :: Options -> FilePath -> FilePath -> Either HEAD Version -> CabalInstallVersion -> IO () runSetupHs opts@Options {..} db srcdir ever CabalInstallVersion {..} | cabalInstallVer >= parseVer "1.24" = do go $ \args -> callProcessStderr opts (Just srcdir) oCabalProgram $ [ "act-as-setup", "--" ] ++ args | otherwise = do SetupProgram {..} <- compileSetupHs opts db srcdir go $ callProcessStderr opts (Just srcdir) setupProgram where parmake_opt :: Maybe Int -> [String] parmake_opt nproc' | Left _ <- ever = ["-j"++nproc] | Right ver <- ever, ver >= Version [1,20] [] = ["-j"++nproc] | otherwise = [] where nproc = fromMaybe "" $ show <$> nproc' go :: ([String] -> IO ()) -> IO () go run = do run $ [ "configure", "--package-db", db, "--prefix", db "prefix" ] ++ withGHCProgramOptions opts mnproc <- join . fmap readMaybe <$> lookupEnv "NPROC" run $ [ "build" ] ++ parmake_opt mnproc run [ "copy" ] run [ "register" ] newtype SetupProgram = SetupProgram { setupProgram :: FilePath } compileSetupHs :: Options -> FilePath -> FilePath -> IO SetupProgram compileSetupHs opts db srcdir = do ver <- ghcVersion opts let no_version_macros | ver >= Version [8] [] = [ "-fno-version-macros" ] | otherwise = [] file = srcdir "Setup" callProcessStderr opts (Just srcdir) (oGhcProgram opts) $ concat [ [ "--make" , "-package-conf", db ] , no_version_macros , [ file <.> "hs" , "-o", file ] ] return $ SetupProgram file data CabalPatchDescription = CabalPatchDescription { cpdVersions :: [Version], cpdUnpackVariant :: UnpackCabalVariant, cpdPatchFn :: FilePath -> IO () } nopCabalPatchDescription :: CabalPatchDescription nopCabalPatchDescription = CabalPatchDescription [] LatestRevision (const (return ())) patchyCabalVersions :: [CabalPatchDescription] patchyCabalVersions = [ let versions = [ Version [1,18,1] [] ] variant = Pristine patch = fixArrayConstraint in CabalPatchDescription versions variant patch, let versions = [ Version [1,18,0] [] ] variant = Pristine patch dir = do fixArrayConstraint dir fixOrphanInstance dir in CabalPatchDescription versions variant patch, let versions = [ Version [1,24,1,0] [] ] variant = Pristine patch _ = return () in CabalPatchDescription versions variant patch ] where fixArrayConstraint dir = do let cabalFile = dir "Cabal.cabal" cabalFileTmp = cabalFile ++ ".tmp" cf <- readFile cabalFile writeFile cabalFileTmp $ replace "&& < 0.5" "&& < 0.6" cf renameFile cabalFileTmp cabalFile fixOrphanInstance dir = do let versionFile = dir "Distribution/Version.hs" versionFileTmp = versionFile ++ ".tmp" let languagePragma = "{-# LANGUAGE DeriveDataTypeable, StandaloneDeriving #-}" languagePragmaCPP = "{-# LANGUAGE CPP, DeriveDataTypeable, StandaloneDeriving #-}" derivingDataVersion = "deriving instance Data Version" derivingDataVersionCPP = unlines [ "#if __GLASGOW_HASKELL__ < 707", derivingDataVersion, "#endif" ] vf <- readFile versionFile writeFile versionFileTmp $ replace derivingDataVersion derivingDataVersionCPP $ replace languagePragma languagePragmaCPP vf renameFile versionFileTmp versionFile unpackPatchedCabal :: Options -> Version -> FilePath -> CabalPatchDescription -> IO CabalSourceDir unpackPatchedCabal opts cabalVer tmpdir (CabalPatchDescription _ variant patch) = do res@(CabalSourceDir dir) <- unpackCabal opts cabalVer tmpdir variant patch dir return res data UnpackCabalVariant = Pristine | LatestRevision newtype CabalSourceDir = CabalSourceDir { unCabalSourceDir :: FilePath } unpackCabal :: Options -> Version -> FilePath -> UnpackCabalVariant -> IO CabalSourceDir unpackCabal opts cabalVer tmpdir variant = do let cabal = "Cabal-" ++ showVersion cabalVer dir = tmpdir cabal variant_opts = case variant of Pristine -> [ "--pristine" ]; _ -> [] args = [ "get", cabal ] ++ variant_opts callProcessStderr opts (Just tmpdir) (oCabalProgram opts) args return $ CabalSourceDir dir unpackCabalHEAD :: FilePath -> IO (CabalSourceDir, CommitId) unpackCabalHEAD tmpdir = do let dir = tmpdir "cabal-head.git" url = "https://github.com/haskell/cabal.git" ExitSuccess <- rawSystem "git" [ "clone", "--depth=1", url, dir] commit <- withDirectory_ dir $ trim <$> readProcess "git" ["rev-parse", "HEAD"] "" return (CabalSourceDir $ dir "Cabal", CommitId commit) where withDirectory_ :: FilePath -> IO a -> IO a withDirectory_ dir action = bracket (liftIO getCurrentDirectory) (liftIO . setCurrentDirectory) (\_ -> liftIO (setCurrentDirectory dir) >> action) errorInstallCabal :: Version -> FilePath -> IO a errorInstallCabal cabalVer _distdir = panicIO $ printf "\ \Installing Cabal version %s failed.\n\ \\n\ \You have the following choices to fix this:\n\ \\n\ \- The easiest way to try and fix this is just reconfigure the project and try\n\ \ again:\n\ \ $ cabal clean && cabal configure\n\ \\n\ \- If that fails you can try to install the version of Cabal mentioned above\n\ \ into your global/user package-db somehow, you'll probably have to fix\n\ \ something otherwise it wouldn't have failed above:\n\ \ $ cabal install Cabal --constraint 'Cabal == %s'\n\ \\n\ \- If you're using `Build-Type: Simple`:\n\ \ - You can see if you can reinstall your cabal-install executable while\n\ \ having it linked to a version of Cabal that's available in you\n\ \ package-dbs or can be built automatically:\n\ \ $ ghc-pkg list | grep Cabal # find an available Cabal version\n\ \ Cabal-W.X.Y.Z\n\ \ $ cabal install cabal-install --constraint 'Cabal == W.X.*'\n\ \ Afterwards you'll have to reconfigure your project:\n\ \ $ cabal clean && cabal configure\n\ \\n\ \- If you're using `Build-Type: Custom`:\n\ \ - Have cabal-install rebuild your Setup.hs executable with a version of the\n\ \ Cabal library that you have available in your global/user package-db:\n\ \ $ cabal clean && cabal configure\n\ \ You might also have to install some version of the Cabal to do this:\n\ \ $ cabal install Cabal\n\ \\n" sver sver where sver = showVersion cabalVer listCabalVersions :: Options -> IO [Version] listCabalVersions opts = listCabalVersions' opts Nothing -- TODO: Include sandbox? Probably only relevant for build-type:custom projects. listCabalVersions' :: Options -> Maybe PackageDbDir -> IO [Version] listCabalVersions' Options {..} mdb = do let mdbopt = ("--package-conf="++) <$> unPackageDbDir <$> mdb opts = ["list", "--simple-output", "Cabal"] ++ maybeToList mdbopt catMaybes . map (fmap snd . parsePkgId . fromString) . words <$> readProcess oGhcPkgProgram opts "" cabalVersionExistsInPkgDb :: Options -> Version -> PackageDbDir -> IO Bool cabalVersionExistsInPkgDb opts cabalVer db@(PackageDbDir db_path) = do exists <- doesDirectoryExist db_path case exists of False -> return False True -> do vers <- listCabalVersions' opts (Just db) return $ cabalVer `elem` vers ghcVersion :: Options -> IO Version ghcVersion Options {..} = do parseVer . trim <$> readProcess oGhcProgram ["--numeric-version"] "" ghcPkgVersion :: Options -> IO Version ghcPkgVersion Options {..} = do parseVer . trim . dropWhile (not . isDigit) <$> readProcess oGhcPkgProgram ["--version"] "" newtype CabalInstallVersion = CabalInstallVersion { cabalInstallVer :: Version } cabalInstallVersion :: Options -> IO CabalInstallVersion cabalInstallVersion Options {..} = do CabalInstallVersion . parseVer . trim <$> readProcess oCabalProgram ["--numeric-version"] "" createPkgDb :: Options -> CabalVersion -> IO PackageDbDir createPkgDb opts@Options {..} cabalVer = do db@(PackageDbDir db_path) <- getPrivateCabalPkgDb opts cabalVer exists <- doesDirectoryExist db_path when (not exists) $ callProcessStderr opts Nothing oGhcPkgProgram ["init", db_path] return db getPrivateCabalPkgDb :: Options -> CabalVersion -> IO PackageDbDir getPrivateCabalPkgDb opts cabalVer = do appdir <- appCacheDir ghcVer <- ghcVersion opts let db_path = appdir exeName cabalVer ++ "-ghc" ++ showVersion ghcVer ++ ".package-db" return $ PackageDbDir db_path -- "Cabal" ++ ver ++ "-ghc" ++ showVersion ghcVer -- | Find @version: XXX@ delcaration in a cabal file cabalFileVersion :: String -> Version cabalFileVersion = parseVer . cabalFileTopField "version" -- | Find @build-type: XXX@ delcaration in a cabal file cabalFileBuildType :: String -> String cabalFileBuildType = cabalFileTopField "build-type" cabalFileTopField :: String -> String -> String cabalFileTopField field cabalFile = value where Just value = extract <$> find ((field++":") `isPrefixOf`) ls ls = map (map toLower) $ lines cabalFile extract = dropWhile (/=':') >>> drop 1 >>> dropWhile isSpace >>> takeWhile (not . isSpace)