Cabal-3.16.1.0: src/Distribution/Simple/SrcDist.hs
{-# LANGUAGE DataKinds #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE RankNTypes #-}
-----------------------------------------------------------------------------
-- NOTE: FIX: we don't have a great way of testing this module, since
-- we can't easily look inside a tarball once its created.
-- |
-- Module : Distribution.Simple.SrcDist
-- Copyright : Simon Marlow 2004
-- License : BSD3
--
-- Maintainer : cabal-devel@haskell.org
-- Portability : portable
--
-- This handles the @sdist@ command. The module exports an 'sdist' action but
-- also some of the phases that make it up so that other tools can use just the
-- bits they need. In particular the preparation of the tree of files to go
-- into the source tarball is separated from actually building the source
-- tarball.
--
-- The 'createArchive' action uses the external @tar@ program and assumes that
-- it accepts the @-z@ flag. Neither of these assumptions are valid on Windows.
-- The 'sdist' action now also does some distribution QA checks.
module Distribution.Simple.SrcDist
( -- * The top level action
sdist
-- ** Parts of 'sdist'
, printPackageProblems
, prepareTree
, createArchive
-- ** Snapshots
, prepareSnapshotTree
, snapshotPackage
, snapshotVersion
, dateToSnapshotNumber
-- * Extracting the source files
, listPackageSources
, listPackageSourcesWithDie
) where
import Distribution.Compat.Prelude
import Prelude ()
import Distribution.ModuleName
import Distribution.Package
import Distribution.PackageDescription
import Distribution.PackageDescription.Check hiding (doesFileExist)
import Distribution.Pretty
import Distribution.Simple.BuildPaths
import Distribution.Simple.Configure (findDistPrefOrDefault)
import Distribution.Simple.Errors
import Distribution.Simple.Flag
import Distribution.Simple.Glob (matchDirFileGlobWithDie)
import Distribution.Simple.PreProcess
import Distribution.Simple.Program
import Distribution.Simple.Setup.Common
import Distribution.Simple.Setup.SDist
import Distribution.Simple.Utils
import Distribution.Utils.Path
import Distribution.Verbosity
import Distribution.Version
import qualified Data.Map as Map
import Data.Time (UTCTime, getCurrentTime, toGregorian, utctDay)
import System.Directory (doesFileExist)
import System.IO (IOMode (WriteMode), hPutStrLn, withFile)
-- | Create a source distribution.
sdist
:: PackageDescription
-- ^ information from the tarball
-> SDistFlags
-- ^ verbosity & snapshot
-> (FilePath -> FilePath)
-- ^ build prefix (temp dir)
-> [PPSuffixHandler]
-- ^ extra preprocessors (includes suffixes)
-> IO ()
sdist pkg flags mkTmpDir pps = do
distPref <- findDistPrefOrDefault $ setupDistPref common
let targetPref = i distPref
tmpTargetDir = mkTmpDir (i distPref)
-- When given --list-sources, just output the list of sources to a file.
case sDistListSources flags of
Flag path -> withFile path WriteMode $ \outHandle -> do
ordinary <- listPackageSources verbosity mbWorkDir pkg pps
traverse_ (hPutStrLn outHandle . getSymbolicPath) ordinary
notice verbosity $ "List of package sources written to file '" ++ path ++ "'"
NoFlag -> do
-- do some QA
printPackageProblems verbosity pkg
date <- getCurrentTime
let pkg'
| snapshot = snapshotPackage date pkg
| otherwise = pkg
case flagToMaybe (sDistDirectory flags) of
Just targetDir -> do
generateSourceDir targetDir pkg'
info verbosity $ "Source directory created: " ++ targetDir
Nothing -> do
createDirectoryIfMissingVerbose verbosity True tmpTargetDir
withTempDirectory verbosity tmpTargetDir "sdist." $ \tmpDir -> do
let targetDir = tmpDir </> tarBallName pkg'
generateSourceDir targetDir pkg'
targzFile <- createArchive verbosity pkg' tmpDir targetPref
notice verbosity $ "Source tarball created: " ++ targzFile
where
generateSourceDir :: FilePath -> PackageDescription -> IO ()
generateSourceDir targetDir pkg' = do
setupMessage verbosity "Building source dist for" (packageId pkg')
prepareTree verbosity mbWorkDir pkg' targetDir pps
when snapshot $
overwriteSnapshotPackageDesc verbosity pkg' targetDir
common = sDistCommonFlags flags
verbosity = fromFlag $ setupVerbosity common
mbWorkDir = flagToMaybe $ setupWorkingDir common
i = interpretSymbolicPath mbWorkDir -- See Note [Symbolic paths] in Distribution.Utils.Path
snapshot = fromFlag (sDistSnapshot flags)
-- | List all source files of a package.
--
-- Since @Cabal-3.4@ returns a single list. There shouldn't be any
-- executable files, they are hardly portable.
listPackageSources
:: Verbosity
-- ^ verbosity
-> Maybe (SymbolicPath CWD (Dir Pkg))
-- ^ directory with cabal file
-> PackageDescription
-- ^ info from the cabal file
-> [PPSuffixHandler]
-- ^ extra preprocessors (include suffixes)
-> IO [SymbolicPath Pkg File]
listPackageSources verbosity cwd pkg_descr0 pps = do
-- Call helpers that actually do all work.
listPackageSources' verbosity dieWithException cwd pkg_descr pps
where
pkg_descr = filterAutogenModules pkg_descr0
-- | A variant of 'listPackageSources' with configurable 'die'.
--
-- /Note:/ may still 'die' directly. For example on missing include file.
--
-- Since @3.4.0.0
listPackageSourcesWithDie
:: Verbosity
-- ^ verbosity
-> (forall res. Verbosity -> CabalException -> IO [res])
-- ^ 'die'' alternative.
-- Since 'die'' prefixes the error message with 'errorPrefix',
-- whatever is passed in here and wants to die should do the same.
-- See issue #7331.
-> Maybe (SymbolicPath CWD (Dir Pkg))
-- ^ directory with cabal file
-> PackageDescription
-- ^ info from the cabal file
-> [PPSuffixHandler]
-- ^ extra preprocessors (include suffixes)
-> IO [SymbolicPath Pkg File]
listPackageSourcesWithDie verbosity rip cwd pkg_descr0 pps = do
-- Call helpers that actually do all work.
listPackageSources' verbosity rip cwd pkg_descr pps
where
pkg_descr = filterAutogenModules pkg_descr0
listPackageSources'
:: Verbosity
-- ^ verbosity
-> (forall res. Verbosity -> CabalException -> IO [res])
-- ^ 'die'' alternative.
-- Since 'die'' prefixes the error message with 'errorPrefix',
-- whatever is passed in here and wants to die should do the same.
-- See issue #7331.
-> Maybe (SymbolicPath CWD (Dir Pkg))
-- ^ directory with cabal file
-> PackageDescription
-- ^ info from the cabal file
-> [PPSuffixHandler]
-- ^ extra preprocessors (include suffixes)
-> IO [SymbolicPath Pkg File]
listPackageSources' verbosity rip mbWorkDir pkg_descr pps =
fmap concat . sequenceA $
[ -- Library sources.
fmap concat
. withAllLib
$ \Library
{ exposedModules = modules
, signatures = sigs
, libBuildInfo = libBi
} ->
allSourcesBuildInfo verbosity rip mbWorkDir libBi pps (modules ++ sigs)
, -- Executables sources.
fmap concat
. withAllExe
$ \Executable{modulePath = mainPath, buildInfo = exeBi} -> do
biSrcs <- allSourcesBuildInfo verbosity rip mbWorkDir exeBi pps []
mainSrc <- findMainExeFile verbosity mbWorkDir exeBi pps mainPath
return (mainSrc : biSrcs)
, -- Foreign library sources
fmap concat
. withAllFLib
$ \flib@(ForeignLib{foreignLibBuildInfo = flibBi}) -> do
biSrcs <- allSourcesBuildInfo verbosity rip mbWorkDir flibBi pps []
defFiles <-
traverse
(findModDefFile verbosity mbWorkDir flibBi pps)
(foreignLibModDefFile flib)
return (defFiles ++ biSrcs)
, -- Test suites sources.
fmap concat
. withAllTest
$ \t -> do
let bi = testBuildInfo t
case testInterface t of
TestSuiteExeV10 _ mainPath -> do
biSrcs <- allSourcesBuildInfo verbosity rip mbWorkDir bi pps []
srcMainFile <- findMainExeFile verbosity mbWorkDir bi pps mainPath
return (srcMainFile : biSrcs)
TestSuiteLibV09 _ m ->
allSourcesBuildInfo verbosity rip mbWorkDir bi pps [m]
TestSuiteUnsupported tp ->
rip verbosity $ UnsupportedTestSuite (show tp)
, -- Benchmarks sources.
fmap concat
. withAllBenchmark
$ \bm -> do
let bi = benchmarkBuildInfo bm
case benchmarkInterface bm of
BenchmarkExeV10 _ mainPath -> do
biSrcs <- allSourcesBuildInfo verbosity rip mbWorkDir bi pps []
srcMainFile <- findMainExeFile verbosity mbWorkDir bi pps mainPath
return (srcMainFile : biSrcs)
BenchmarkUnsupported tp ->
rip verbosity $ UnsupportedBenchMark (show tp)
, -- Data files.
fmap concat
. for (dataFiles pkg_descr)
$ \filename ->
do
let srcDataDirRaw = dataDir pkg_descr
srcDataFile :: SymbolicPath Pkg File
srcDataFile
| null (getSymbolicPath srcDataDirRaw) = sameDirectory </> filename
| otherwise = srcDataDirRaw </> filename
fmap coerceSymbolicPath
<$> matchDirFileGlobWithDie verbosity rip (specVersion pkg_descr) mbWorkDir srcDataFile
, -- Extra source files.
fmap concat . for (extraSrcFiles pkg_descr) $ \fpath ->
fmap relativeSymbolicPath
<$> matchDirFileGlobWithDie verbosity rip (specVersion pkg_descr) mbWorkDir fpath
, -- Extra doc files.
fmap concat
. for (extraDocFiles pkg_descr)
$ \filename ->
fmap (coerceSymbolicPath . relativeSymbolicPath)
<$> matchDirFileGlobWithDie verbosity rip (specVersion pkg_descr) mbWorkDir filename
, -- Extra files.
fmap concat . for (extraFiles pkg_descr) $ \fpath ->
fmap relativeSymbolicPath
<$> matchDirFileGlobWithDie verbosity rip (specVersion pkg_descr) mbWorkDir fpath
, -- License file(s).
return (map (relativeSymbolicPath . coerceSymbolicPath) $ licenseFiles pkg_descr)
, -- Install-include files, without autogen-include files
fmap concat
. withAllLib
$ \l -> do
let lbi = libBuildInfo l
incls = fmap getSymbolicPath $ filter (`notElem` autogenIncludes lbi) (installIncludes lbi)
relincdirs = fmap getSymbolicPath $ sameDirectory : mapMaybe symbolicPathRelative_maybe (includeDirs lbi)
traverse (fmap (makeSymbolicPath . snd) . findIncludeFile verbosity cwd relincdirs) incls
, -- Setup script, if it exists.
fmap (maybe [] (\f -> [makeSymbolicPath f])) $ findSetupFile cwd
, -- SetupHooks script, if it exists.
fmap (maybe [] (\f -> [makeSymbolicPath f])) $ findSetupHooksFile cwd
, -- The .cabal file itself.
fmap (\d -> [d]) (coerceSymbolicPath . relativeSymbolicPath <$> tryFindPackageDesc verbosity mbWorkDir)
]
where
cwd = maybe "." getSymbolicPath mbWorkDir
-- We have to deal with all libs and executables, so we have local
-- versions of these functions that ignore the 'buildable' attribute:
withAllLib action = traverse action (allLibraries pkg_descr)
withAllFLib action = traverse action (foreignLibs pkg_descr)
withAllExe action = traverse action (executables pkg_descr)
withAllTest action = traverse action (testSuites pkg_descr)
withAllBenchmark action = traverse action (benchmarks pkg_descr)
-- | Prepare a directory tree of source files.
prepareTree
:: Verbosity
-- ^ verbosity
-> Maybe (SymbolicPath CWD (Dir Pkg))
-- ^ working directory
-> PackageDescription
-- ^ info from the cabal file
-> FilePath
-- ^ source tree to populate
-> [PPSuffixHandler]
-- ^ extra preprocessors (includes suffixes)
-> IO ()
prepareTree verbosity mbWorkDir pkg_descr0 targetDir pps = do
ordinary <- listPackageSources verbosity mbWorkDir pkg_descr pps
installOrdinaryFiles verbosity targetDir (zip (repeat []) $ map i ordinary)
maybeCreateDefaultSetupScript targetDir
where
i = interpretSymbolicPath mbWorkDir -- See Note [Symbolic paths] in Distribution.Utils.Path
pkg_descr = filterAutogenModules pkg_descr0
-- | Find the setup script file, if it exists.
findSetupFile :: FilePath -> IO (Maybe FilePath)
findSetupFile targetDir = do
hsExists <- doesFileExist (targetDir </> setupHs)
lhsExists <- doesFileExist (targetDir </> setupLhs)
if hsExists
then return (Just setupHs)
else
if lhsExists
then return (Just setupLhs)
else return Nothing
where
setupHs = "Setup.hs"
setupLhs = "Setup.lhs"
-- | Find the setup hooks script file, if it exists.
findSetupHooksFile :: FilePath -> IO (Maybe FilePath)
findSetupHooksFile targetDir = do
hsExists <- doesFileExist (targetDir </> setupHs)
lhsExists <- doesFileExist (targetDir </> setupLhs)
if hsExists
then return (Just setupHs)
else
if lhsExists
then return (Just setupLhs)
else return Nothing
where
setupHs = "SetupHooks.hs"
setupLhs = "SetupHooks.lhs"
-- | Create a default setup script in the target directory, if it doesn't exist.
maybeCreateDefaultSetupScript :: FilePath -> IO ()
maybeCreateDefaultSetupScript targetDir = do
mSetupFile <- findSetupFile targetDir
case mSetupFile of
Just _setupFile -> return ()
Nothing -> do
writeUTF8File (targetDir </> "Setup.hs") $
unlines
[ "import Distribution.Simple"
, "main = defaultMain"
]
-- | Find the main executable file.
findMainExeFile
:: Verbosity
-> Maybe (SymbolicPath CWD (Dir Pkg))
-- ^ working directory
-> BuildInfo
-> [PPSuffixHandler]
-> RelativePath Source File
-- ^ main-is
-> IO (SymbolicPath Pkg File)
findMainExeFile verbosity cwd exeBi pps mainPath = do
ppFile <-
findFileCwdWithExtension
cwd
(ppSuffixes pps)
(hsSourceDirs exeBi)
(dropExtensionsSymbolicPath mainPath)
case ppFile of
Nothing -> findFileCwd verbosity cwd (hsSourceDirs exeBi) mainPath
Just pp -> return pp
-- | Find a module definition file
--
-- TODO: I don't know if this is right
findModDefFile
:: Verbosity
-> Maybe (SymbolicPath CWD (Dir Pkg))
-> BuildInfo
-> [PPSuffixHandler]
-> RelativePath Source File
-> IO (SymbolicPath Pkg File)
findModDefFile verbosity cwd flibBi _pps modDefPath =
findFileCwd verbosity cwd (sameDirectory : hsSourceDirs flibBi) modDefPath
-- | Given a list of include paths, try to find the include file named
-- @f@. Return the name of the file and the full path, or exit with error if
-- there's no such file.
findIncludeFile :: Verbosity -> FilePath -> [FilePath] -> String -> IO (String, FilePath)
findIncludeFile verbosity _ [] f = dieWithException verbosity $ NoIncludeFileFound f
findIncludeFile verbosity cwd (d : ds) f = do
let path = d </> f
b <- doesFileExist (cwd </> path)
if b then return (f, path) else findIncludeFile verbosity cwd ds f
-- | Remove the auto-generated modules (like 'Paths_*') from 'exposed-modules'
-- and 'other-modules'.
filterAutogenModules :: PackageDescription -> PackageDescription
filterAutogenModules pkg_descr0 =
mapLib filterAutogenModuleLib $
mapAllBuildInfo filterAutogenModuleBI pkg_descr0
where
mapLib f pkg =
pkg
{ library = fmap f (library pkg)
, subLibraries = map f (subLibraries pkg)
}
filterAutogenModuleLib lib =
lib
{ exposedModules = filter (filterFunction (libBuildInfo lib)) (exposedModules lib)
}
filterAutogenModuleBI bi =
bi
{ otherModules = filter (filterFunction bi) (otherModules bi)
}
pathsModule = autogenPathsModuleName pkg_descr0
packageInfoModule = autogenPackageInfoModuleName pkg_descr0
filterFunction bi = \mn ->
mn /= pathsModule
&& mn /= packageInfoModule
&& not (mn `elem` autogenModules bi)
-- | Prepare a directory tree of source files for a snapshot version.
-- It is expected that the appropriate snapshot version has already been set
-- in the package description, eg using 'snapshotPackage' or 'snapshotVersion'.
prepareSnapshotTree
:: Verbosity
-- ^ verbosity
-> Maybe (SymbolicPath CWD (Dir Pkg))
-- ^ working directory
-> PackageDescription
-- ^ info from the cabal file
-> FilePath
-- ^ source tree to populate
-> [PPSuffixHandler]
-- ^ extra preprocessors (includes suffixes)
-> IO ()
prepareSnapshotTree verbosity mbWorkDir pkg targetDir pps = do
prepareTree verbosity mbWorkDir pkg targetDir pps
overwriteSnapshotPackageDesc verbosity pkg targetDir
overwriteSnapshotPackageDesc
:: Verbosity
-- ^ verbosity
-> PackageDescription
-- ^ info from the cabal file
-> FilePath
-- ^ source tree
-> IO ()
overwriteSnapshotPackageDesc verbosity pkg targetDir = do
-- We could just writePackageDescription targetDescFile pkg_descr,
-- but that would lose comments and formatting.
descFile <- getSymbolicPath <$> defaultPackageDescCwd verbosity
withUTF8FileContents descFile $
writeUTF8File (targetDir </> descFile)
. unlines
. map (replaceVersion (packageVersion pkg))
. lines
where
replaceVersion :: Version -> String -> String
replaceVersion version line
| "version:" `isPrefixOf` map toLower line =
"version: " ++ prettyShow version
| otherwise = line
-- | Modifies a 'PackageDescription' by appending a snapshot number
-- corresponding to the given date.
snapshotPackage :: UTCTime -> PackageDescription -> PackageDescription
snapshotPackage date pkg =
pkg
{ package = pkgid{pkgVersion = snapshotVersion date (pkgVersion pkgid)}
}
where
pkgid = packageId pkg
-- | Modifies a 'Version' by appending a snapshot number corresponding
-- to the given date.
snapshotVersion :: UTCTime -> Version -> Version
snapshotVersion date = alterVersion (++ [dateToSnapshotNumber date])
-- | Given a date produce a corresponding integer representation.
-- For example given a date @18/03/2008@ produce the number @20080318@.
dateToSnapshotNumber :: UTCTime -> Int
dateToSnapshotNumber date = case toGregorian (utctDay date) of
(year, month, day) ->
fromIntegral year * 10000
+ month * 100
+ day
-- | Create an archive from a tree of source files, and clean up the tree.
createArchive
:: Verbosity
-- ^ verbosity
-> PackageDescription
-- ^ info from cabal file
-> FilePath
-- ^ source tree to archive
-> FilePath
-- ^ name of archive to create
-> IO FilePath
createArchive verbosity pkg_descr tmpDir targetPref = do
let tarBallFilePath = targetPref </> tarBallName pkg_descr <.> "tar.gz"
(tarProg, _) <- requireProgram verbosity tarProgram defaultProgramDb
let formatOptSupported =
maybe False (== "YES") $
Map.lookup
"Supports --format"
(programProperties tarProg)
runProgram verbosity tarProg $
-- Hmm: I could well be skating on thinner ice here by using the -C option
-- (=> seems to be supported at least by GNU and *BSD tar) [The
-- prev. solution used pipes and sub-command sequences to set up the paths
-- correctly, which is problematic in a Windows setting.]
["-czf", tarBallFilePath, "-C", tmpDir]
++ (if formatOptSupported then ["--format", "ustar"] else [])
++ [tarBallName pkg_descr]
return tarBallFilePath
-- | Given a buildinfo, return the names of all source files.
allSourcesBuildInfo
:: Verbosity
-> (Verbosity -> CabalException -> IO [SymbolicPath Pkg File])
-- ^ 'die'' alternative.
-- Since 'die'' prefixes the error message with 'errorPrefix',
-- whatever is passed in here and wants to die should do the same.
-- See issue #7331.
-> Maybe (SymbolicPath CWD (Dir Pkg))
-- ^ working directory
-> BuildInfo
-> [PPSuffixHandler]
-- ^ Extra preprocessors
-> [ModuleName]
-- ^ Exposed modules
-> IO [SymbolicPath Pkg File]
allSourcesBuildInfo verbosity rip mbWorkDir bi pps modules = do
let searchDirs = hsSourceDirs bi
sources <-
fmap concat $
sequenceA $
[ let file = moduleNameSymbolicPath module_
in -- NB: *Not* findFileWithExtension, because the same source
-- file may show up in multiple paths due to a conditional;
-- we need to package all of them. See #367.
findAllFilesCwdWithExtension mbWorkDir suffixes searchDirs file
>>= nonEmpty' (notFound module_) return
| module_ <- modules ++ otherModules bi
]
bootFiles <-
sequenceA
[ let file = moduleNameSymbolicPath module_
fileExts = builtinHaskellBootSuffixes
in findFileCwdWithExtension mbWorkDir fileExts (hsSourceDirs bi) file
| module_ <- modules ++ otherModules bi
]
return $
sources
++ catMaybes bootFiles
++ cSources bi
++ cxxSources bi
++ cmmSources bi
++ asmSources bi
++ jsSources bi
where
nonEmpty' :: b -> ([a] -> b) -> [a] -> b
nonEmpty' x _ [] = x
nonEmpty' _ f xs = f xs
suffixes = ppSuffixes pps ++ builtinHaskellSuffixes
notFound :: ModuleName -> IO [SymbolicPath Pkg File]
notFound m =
rip verbosity $ NoModuleFound m suffixes
-- | Note: must be called with the CWD set to the directory containing
-- the '.cabal' file.
printPackageProblems :: Verbosity -> PackageDescription -> IO ()
printPackageProblems verbosity pkg_descr = do
ioChecks <- checkPackageFiles verbosity pkg_descr "."
let pureChecks = checkConfiguredPackage pkg_descr
(errors, warnings) = partition isHackageDistError (pureChecks ++ ioChecks)
unless (null errors) $
notice verbosity $
"Distribution quality errors:\n"
++ unlines (map ppPackageCheck errors)
unless (null warnings) $
notice verbosity $
"Distribution quality warnings:\n"
++ unlines (map ppPackageCheck warnings)
unless (null errors) $
notice
verbosity
"Note: the public hackage server would reject this package."
------------------------------------------------------------
-- | The name of the tarball without extension
tarBallName :: PackageDescription -> String
tarBallName = prettyShow . packageId
mapAllBuildInfo
:: (BuildInfo -> BuildInfo)
-> (PackageDescription -> PackageDescription)
mapAllBuildInfo f pkg =
pkg
{ library = fmap mapLibBi (library pkg)
, subLibraries = fmap mapLibBi (subLibraries pkg)
, foreignLibs = fmap mapFLibBi (foreignLibs pkg)
, executables = fmap mapExeBi (executables pkg)
, testSuites = fmap mapTestBi (testSuites pkg)
, benchmarks = fmap mapBenchBi (benchmarks pkg)
}
where
mapLibBi lib = lib{libBuildInfo = f (libBuildInfo lib)}
mapFLibBi flib = flib{foreignLibBuildInfo = f (foreignLibBuildInfo flib)}
mapExeBi exe = exe{buildInfo = f (buildInfo exe)}
mapTestBi tst = tst{testBuildInfo = f (testBuildInfo tst)}
mapBenchBi bm = bm{benchmarkBuildInfo = f (benchmarkBuildInfo bm)}