Configure.hs 19.3 KB
Newer Older
1
{-# LANGUAGE CPP #-}
2 3 4 5 6 7 8 9 10 11 12 13 14 15
-----------------------------------------------------------------------------
-- |
-- Module      :  Distribution.Client.Configure
-- Copyright   :  (c) David Himmelstrup 2005,
--                    Duncan Coutts 2005
-- License     :  BSD-like
--
-- Maintainer  :  cabal-devel@haskell.org
-- Portability :  portable
--
-- High level interface to configuring a package.
-----------------------------------------------------------------------------
module Distribution.Client.Configure (
    configure,
16
    configureSetupScript,
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
17
    chooseCabalVersion,
ttuegel's avatar
ttuegel committed
18 19 20 21 22
    checkConfigExFlags,
    -- * Saved configure flags
    readConfigFlagsFrom, readConfigFlags,
    cabalConfigFlagsFile,
    writeConfigFlagsTo, writeConfigFlags,
23 24
  ) where

25 26 27
import Prelude ()
import Distribution.Client.Compat.Prelude

28 29
import Distribution.Client.Dependency
import qualified Distribution.Client.InstallPlan as InstallPlan
30
import Distribution.Client.SolverInstallPlan (SolverInstallPlan)
31
import Distribution.Client.IndexUtils as IndexUtils
32
         ( getSourcePackages, getInstalledPackages )
33
import Distribution.Client.Setup
ttuegel's avatar
ttuegel committed
34 35
         ( ConfigExFlags(..), RepoContext(..)
         , configureCommand, configureExCommand, filterConfigureFlags )
36
import Distribution.Client.Types as Source
37 38
import Distribution.Client.SetupWrapper
         ( setupWrapper, SetupScriptOptions(..), defaultSetupScriptOptions )
39
import Distribution.Client.Targets
40
         ( userToPackageConstraint, userConstraintPackageName )
41
import Distribution.Client.JobControl (Lock)
42

43
import qualified Distribution.Solver.Types.ComponentDeps as CD
44
import           Distribution.Solver.Types.Settings
45
import           Distribution.Solver.Types.ConstraintSource
46
import           Distribution.Solver.Types.LabeledPackageConstraint
47 48 49 50 51 52 53
import           Distribution.Solver.Types.OptionalStanza
import           Distribution.Solver.Types.PackageIndex
                   ( PackageIndex, elemByPackageName )
import           Distribution.Solver.Types.PkgConfigDb
                   (PkgConfigDb, readPkgConfigDb)
import           Distribution.Solver.Types.SourcePackage

54
import Distribution.Simple.Compiler
55
         ( Compiler, CompilerInfo, compilerInfo, PackageDB(..), PackageDBStack )
ttuegel's avatar
ttuegel committed
56 57
import Distribution.Simple.Program (ProgramDb)
import Distribution.Client.SavedFlags ( readCommandFlags, writeCommandFlags )
58
import Distribution.Simple.Setup
59
         ( ConfigFlags(..), AllowNewer(..), AllowOlder(..), RelaxDeps(..)
Francesco Gazzetta's avatar
Francesco Gazzetta committed
60
         , fromFlag, toFlag, flagToMaybe, fromFlagOrDefault, isRelaxDeps )
61 62
import Distribution.Simple.PackageIndex
         ( InstalledPackageIndex, lookupPackageName )
63
import Distribution.Package
Francesco Gazzetta's avatar
Francesco Gazzetta committed
64
         ( Package(..), packageName, PackageId )
65 66
import Distribution.Types.Dependency
         ( Dependency(..), thisPackageVersion )
67
import qualified Distribution.PackageDescription as PkgDesc
68 69 70 71
#ifdef CABAL_PARSEC
import Distribution.PackageDescription.Parsec
         ( readGenericPackageDescription )
#else
72
import Distribution.PackageDescription.Parse
73 74
         ( readGenericPackageDescription )
#endif
75
import Distribution.PackageDescription.Configuration
76
         ( finalizePD )
77
import Distribution.Version
78 79
         ( Version, mkVersion, anyVersion, thisVersion
         , VersionRange, orLaterVersion )
80
import Distribution.Simple.Utils as Utils
Francesco Gazzetta's avatar
Francesco Gazzetta committed
81 82
         ( warn, notice, debug, die'
         , defaultPackageDesc )
83
import Distribution.System
84
         ( Platform )
85
import Distribution.Text ( display )
86 87 88
import Distribution.Verbosity as Verbosity
         ( Verbosity )

ttuegel's avatar
ttuegel committed
89
import System.FilePath ( (</>) )
90

Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
91 92
-- | Choose the Cabal version such that the setup scripts compiled against this
-- version will support the given command-line flags.
93 94
chooseCabalVersion :: ConfigFlags -> Maybe Version -> VersionRange
chooseCabalVersion configFlags maybeVersion =
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
95 96
  maybe defaultVersionRange thisVersion maybeVersion
  where
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
97 98
    -- Cabal < 1.19.2 doesn't support '--exact-configuration' which is needed
    -- for '--allow-newer' to work.
99 100
    allowNewer = isRelaxDeps
                 (maybe RelaxDepsNone unAllowNewer $ configAllowNewer configFlags)
101 102
    allowOlder = isRelaxDeps
                 (maybe RelaxDepsNone unAllowOlder $ configAllowOlder configFlags)
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
103

104
    defaultVersionRange = if allowOlder || allowNewer
105
                          then orLaterVersion (mkVersion [1,19,2])
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
106 107
                          else anyVersion

108 109
-- | Configure the package found in the local directory
configure :: Verbosity
110
          -> PackageDBStack
Edsko de Vries's avatar
Edsko de Vries committed
111
          -> RepoContext
112
          -> Compiler
113
          -> Platform
114
          -> ProgramDb
115
          -> ConfigFlags
116
          -> ConfigExFlags
117 118
          -> [String]
          -> IO ()
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
119
configure verbosity packageDBs repoCtxt comp platform progdb
120 121
  configFlags configExFlags extraArgs = do

Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
122
  installedPkgIndex <- getInstalledPackages verbosity comp packageDBs progdb
Edsko de Vries's avatar
Edsko de Vries committed
123
  sourcePkgDb       <- getSourcePackages    verbosity repoCtxt
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
124
  pkgConfigDb       <- readPkgConfigDb      verbosity progdb
125

126 127
  checkConfigExFlags verbosity installedPkgIndex
                     (packageIndex sourcePkgDb) configExFlags
128

129
  progress <- planLocalPackage verbosity comp platform configFlags configExFlags
130
                               installedPkgIndex sourcePkgDb pkgConfigDb
131 132

  notice verbosity "Resolving dependencies..."
133 134
  maybePlan <- foldProgress logMsg (return . Left) (return . Right)
                            progress
135
  case maybePlan of
136
    Left message -> do
137 138
      warn verbosity $
           "solver failed to find a solution:\n"
139 140
        ++ message
        ++ "Trying configure anyway."
141 142
      setupWrapper verbosity (setupScriptOptions installedPkgIndex Nothing)
        Nothing configureCommand (const configFlags) extraArgs
143

144
    Right installPlan0 ->
145
     let installPlan = InstallPlan.configureInstallPlan configFlags installPlan0
146
     in case fst (InstallPlan.ready installPlan) of
147
      [pkg@(ReadyPackage
Edward Z. Yang's avatar
Edward Z. Yang committed
148
              (ConfiguredPackage _ (SourcePackage _ _ (LocalUnpackedPackage _) _)
149
                                 _ _ _))] -> do
150
        configurePackage verbosity
151
          platform (compilerInfo comp)
152
          (setupScriptOptions installedPkgIndex (Just pkg))
153 154
          configFlags pkg extraArgs

155
      _ -> die' verbosity $ "internal error: configure install plan should have exactly "
156 157 158
              ++ "one local ready package."

  where
159
    setupScriptOptions :: InstalledPackageIndex
160
                       -> Maybe ReadyPackage
161
                       -> SetupScriptOptions
162 163 164 165 166
    setupScriptOptions =
      configureSetupScript
        packageDBs
        comp
        platform
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
167
        progdb
168 169 170 171
        (fromFlagOrDefault
           (useDistPref defaultSetupScriptOptions)
           (configDistPref configFlags))
        (chooseCabalVersion
172
           configFlags
173 174 175
           (flagToMaybe (configCabalVersion configExFlags)))
        Nothing
        False
176

177 178
    logMsg message rest = debug verbosity message >> rest

179 180 181
configureSetupScript :: PackageDBStack
                     -> Compiler
                     -> Platform
182
                     -> ProgramDb
183 184 185 186 187
                     -> FilePath
                     -> VersionRange
                     -> Maybe Lock
                     -> Bool
                     -> InstalledPackageIndex
188
                     -> Maybe ReadyPackage
189 190 191 192
                     -> SetupScriptOptions
configureSetupScript packageDBs
                     comp
                     platform
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
193
                     progdb
194 195 196 197 198 199 200
                     distPref
                     cabalVersion
                     lock
                     forceExternal
                     index
                     mpkg
  = SetupScriptOptions {
201 202 203 204 205 206
      useCabalVersion          = cabalVersion
    , useCabalSpecVersion      = Nothing
    , useCompiler              = Just comp
    , usePlatform              = Just platform
    , usePackageDB             = packageDBs'
    , usePackageIndex          = index'
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
207
    , useProgramDb             = progdb
208 209 210
    , useDistPref              = distPref
    , useLoggingHandle         = Nothing
    , useWorkingDir            = Nothing
211
    , useExtraPathEnv          = []
212 213
    , setupCacheLock           = lock
    , useWin32CleanHack        = False
214 215 216 217 218 219 220 221
    , forceExternalSetupMethod = forceExternal
      -- If we have explicit setup dependencies, list them; otherwise, we give
      -- the empty list of dependencies; ideally, we would fix the version of
      -- Cabal here, so that we no longer need the special case for that in
      -- `compileSetupExecutable` in `externalSetupMethod`, but we don't yet
      -- know the version of Cabal at this point, but only find this there.
      -- Therefore, for now, we just leave this blank.
    , useDependencies          = fromMaybe [] explicitSetupDeps
222 223
    , useDependenciesExclusive = not defaultSetupDeps && isJust explicitSetupDeps
    , useVersionMacros         = not defaultSetupDeps && isJust explicitSetupDeps
224
    , isInteractive            = False
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
    }
  where
    -- When we are compiling a legacy setup script without an explicit
    -- setup stanza, we typically want to allow the UserPackageDB for
    -- finding the Cabal lib when compiling any Setup.hs even if we're doing
    -- a global install. However we also allow looking in a specific package
    -- db.
    packageDBs' :: PackageDBStack
    index'      :: Maybe InstalledPackageIndex
    (packageDBs', index') =
      case packageDBs of
        (GlobalPackageDB:dbs) | UserPackageDB `notElem` dbs
                              , Nothing <- explicitSetupDeps
            -> (GlobalPackageDB:UserPackageDB:dbs, Nothing)
        -- but if the user is using an odd db stack, don't touch it
        _otherwise -> (packageDBs, Just index)

242 243
    maybeSetupBuildInfo :: Maybe PkgDesc.SetupBuildInfo
    maybeSetupBuildInfo = do
244
      ReadyPackage cpkg <- mpkg
245
      let gpkg = packageDescription (confPkgSource cpkg)
246 247 248 249 250 251 252 253
      PkgDesc.setupBuildInfo (PkgDesc.packageDescription gpkg)

    -- Was a default 'custom-setup' stanza added by 'cabal-install' itself? If
    -- so, 'setup-depends' must not be exclusive. See #3199.
    defaultSetupDeps :: Bool
    defaultSetupDeps = maybe False PkgDesc.defaultSetupDepends
                       maybeSetupBuildInfo

254
    explicitSetupDeps :: Maybe [(InstalledPackageId, PackageId)]
255 256 257
    explicitSetupDeps = do
      -- Check if there is an explicit setup stanza.
      _buildInfo <- maybeSetupBuildInfo
258
      -- Return the setup dependencies computed by the solver
259
      ReadyPackage cpkg <- mpkg
260
      return [ ( cid, srcid )
261
             | ConfiguredId srcid (Just PkgDesc.CLibName) cid <- CD.setupDeps (confPkgDeps cpkg)
262 263
             ]

264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
-- | Warn if any constraints or preferences name packages that are not in the
-- source package index or installed package index.
checkConfigExFlags :: Package pkg
                   => Verbosity
                   -> InstalledPackageIndex
                   -> PackageIndex pkg
                   -> ConfigExFlags
                   -> IO ()
checkConfigExFlags verbosity installedPkgIndex sourcePkgIndex flags = do
  unless (null unknownConstraints) $ warn verbosity $
             "Constraint refers to an unknown package: "
          ++ showConstraint (head unknownConstraints)
  unless (null unknownPreferences) $ warn verbosity $
             "Preference refers to an unknown package: "
          ++ display (head unknownPreferences)
  where
    unknownConstraints = filter (unknown . userConstraintPackageName . fst) $
                         configExConstraints flags
    unknownPreferences = filter (unknown . \(Dependency name _) -> name) $
                         configPreferences flags
    unknown pkg = null (lookupPackageName installedPkgIndex pkg)
               && not (elemByPackageName sourcePkgIndex pkg)
    showConstraint (uc, src) =
        display uc ++ " (" ++ showConstraintSource src ++ ")"

289 290 291 292
-- | Make an 'InstallPlan' for the unpacked package in the current directory,
-- and all its dependencies.
--
planLocalPackage :: Verbosity -> Compiler
293
                 -> Platform
294
                 -> ConfigFlags -> ConfigExFlags
295
                 -> InstalledPackageIndex
296
                 -> SourcePackageDb
297
                 -> PkgConfigDb
298
                 -> IO (Progress String String SolverInstallPlan)
299
planLocalPackage verbosity comp platform configFlags configExFlags
300
  installedPkgIndex (SourcePackageDb _ packagePrefs) pkgConfigDb = do
301
  pkg <- readGenericPackageDescription verbosity =<<
302 303 304
            case flagToMaybe (configCabalFilePath configFlags) of
                Nothing -> defaultPackageDesc verbosity
                Just fp -> return fp
305 306
  solver <- chooseSolver verbosity (fromFlag $ configSolver configExFlags)
            (compilerInfo comp)
307 308

  let -- We create a local package and ask to resolve a dependency on it
309 310
      localPkg = SourcePackage {
        packageInfoId             = packageId pkg,
311
        packageDescription        = pkg,
312 313
        packageSource             = LocalUnpackedPackage ".",
        packageDescrOverride      = Nothing
314
      }
315

316 317 318 319
      testsEnabled = fromFlagOrDefault False $ configTests configFlags
      benchmarksEnabled =
        fromFlagOrDefault False $ configBenchmarks configFlags

320
      resolverParams =
321 322 323 324
          removeLowerBounds
          (fromMaybe (AllowOlder RelaxDepsNone) $ configAllowOlder configFlags)
        . removeUpperBounds
          (fromMaybe (AllowNewer RelaxDepsNone) $ configAllowNewer configFlags)
325

326
        . addPreferences
327 328 329 330 331 332
            -- preferences from the config file or command line
            [ PackageVersionPreference name ver
            | Dependency name ver <- configPreferences configExFlags ]

        . addConstraints
            -- version constraints from the config file or command line
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
333 334
            -- TODO: should warn or error on constraints that are not on direct
            -- deps or flag constraints not on the package in question.
335
            [ LabeledPackageConstraint (userToPackageConstraint uc) src
336
            | (uc, src) <- configExConstraints configExFlags ]
337 338 339

        . addConstraints
            -- package flags from the config file or command line
340
            [ let pc = PackageConstraint
341
                       (scopeToplevel $ packageName pkg)
342
                       (PackagePropertyFlags $ configConfigurationsFlags configFlags)
343 344
              in LabeledPackageConstraint pc ConstraintSourceConfigFlagOrTarget
            ]
345

346 347
        . addConstraints
            -- '--enable-tests' and '--enable-benchmarks' constraints from
348
            -- the config file or command line
349
            [ let pc = PackageConstraint (scopeToplevel $ packageName pkg) .
350
                       PackagePropertyStanzas $
351 352
                       [ TestStanzas  | testsEnabled ] ++
                       [ BenchStanzas | benchmarksEnabled ]
353
              in LabeledPackageConstraint pc ConstraintSourceConfigFlagOrTarget
354 355
            ]

356 357 358 359 360
            -- Don't solve for executables, since we use an empty source
            -- package database and executables never show up in the
            -- installed package index
        . setSolveExecutables (SolveExecutables False)

361 362
        . setSolverVerbosity verbosity

363
        $ standardInstallPolicy
364
            installedPkgIndex
365 366 367
            -- NB: We pass in an *empty* source package database,
            -- because cabal configure assumes that all dependencies
            -- have already been installed
368
            (SourcePackageDb mempty packagePrefs)
369
            [SpecificSourcePackage localPkg]
370

371
  return (resolveDependencies platform (compilerInfo comp) pkgConfigDb solver resolverParams)
372

373

374
-- | Call an installer for an 'SourcePackage' but override the configure
375 376
-- flags with the ones given by the 'ReadyPackage'. In particular the
-- 'ReadyPackage' specifies an exact 'FlagAssignment' and exactly
377 378 379
-- versioned package dependencies. So we ignore any previous partial flag
-- assignment or dependency constraints and use the new ones.
--
380 381
-- NB: when updating this function, don't forget to also update
-- 'installReadyPackage' in D.C.Install.
382
configurePackage :: Verbosity
383
                 -> Platform -> CompilerInfo
384
                 -> SetupScriptOptions
385
                 -> ConfigFlags
386
                 -> ReadyPackage
387 388
                 -> [String]
                 -> IO ()
389
configurePackage verbosity platform comp scriptOptions configFlags
Edward Z. Yang's avatar
Edward Z. Yang committed
390
                 (ReadyPackage (ConfiguredPackage ipid spkg flags stanzas deps))
391
                 extraArgs =
392 393 394 395 396

  setupWrapper verbosity
    scriptOptions (Just pkg) configureCommand configureFlags extraArgs

  where
397
    gpkg = packageDescription spkg
398
    configureFlags   = filterConfigureFlags configFlags {
399 400 401 402
      configIPID = if isJust (flagToMaybe (configIPID configFlags))
                    -- Make sure cabal configure --ipid works.
                    then configIPID configFlags
                    else toFlag (display ipid),
403
      configConfigurationsFlags = flags,
404 405 406
      -- We generate the legacy constraints as well as the new style precise
      -- deps.  In the end only one set gets passed to Setup.hs configure,
      -- depending on the Cabal version we are talking to.
407
      configConstraints  = [ thisPackageVersion srcid
408
                           | ConfiguredId srcid (Just PkgDesc.CLibName) _uid <- CD.nonSetupDeps deps ],
409
      configDependencies = [ (packageName srcid, uid)
410
                           | ConfiguredId srcid (Just PkgDesc.CLibName) uid <- CD.nonSetupDeps deps ],
411 412
      -- Use '--exact-configuration' if supported.
      configExactConfiguration = toFlag True,
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
413
      configVerbosity          = toFlag verbosity,
414 415 416 417 418
      -- NB: if the user explicitly specified
      -- --enable-tests/--enable-benchmarks, always respect it.
      -- (But if they didn't, let solver decide.)
      configBenchmarks         = toFlag (BenchStanzas `elem` stanzas)
                                    `mappend` configBenchmarks configFlags,
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
419
      configTests              = toFlag (TestStanzas `elem` stanzas)
420
                                    `mappend` configTests configFlags
421 422
    }

423
    pkg = case finalizePD flags (enableStanzas stanzas)
424
           (const True)
425
           platform comp [] gpkg of
426
      Left _ -> error "finalizePD ReadyPackage failed"
427
      Right (desc, _) -> desc
ttuegel's avatar
ttuegel committed
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464

-- -----------------------------------------------------------------------------
-- * Saved configure environments and flags
-- -----------------------------------------------------------------------------

-- | Read saved configure flags and restore the saved environment from the
-- specified files.
readConfigFlagsFrom :: FilePath  -- ^ path to saved flags file
                    -> IO (ConfigFlags, ConfigExFlags)
readConfigFlagsFrom flags = do
  readCommandFlags flags configureExCommand

-- | The path (relative to @--build-dir@) where the arguments to @configure@
-- should be saved.
cabalConfigFlagsFile :: FilePath -> FilePath
cabalConfigFlagsFile dist = dist </> "cabal-config-flags"

-- | Read saved configure flags and restore the saved environment from the
-- usual location.
readConfigFlags :: FilePath  -- ^ @--build-dir@
                -> IO (ConfigFlags, ConfigExFlags)
readConfigFlags dist =
  readConfigFlagsFrom (cabalConfigFlagsFile dist)

-- | Save the configure flags and environment to the specified files.
writeConfigFlagsTo :: FilePath  -- ^ path to saved flags file
                   -> Verbosity -> (ConfigFlags, ConfigExFlags)
                   -> IO ()
writeConfigFlagsTo file verb flags = do
  writeCommandFlags verb file configureExCommand flags

-- | Save the build flags to the usual location.
writeConfigFlags :: Verbosity
                 -> FilePath  -- ^ @--build-dir@
                 -> (ConfigFlags, ConfigExFlags) -> IO ()
writeConfigFlags verb dist =
  writeConfigFlagsTo (cabalConfigFlagsFile dist) verb