Configure.hs 19.1 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 60
         ( ConfigFlags(..)
         , fromFlag, toFlag, flagToMaybe, fromFlagOrDefault )
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
import Distribution.PackageDescription.Parsec
         ( readGenericPackageDescription )
70
import Distribution.PackageDescription.Configuration
71
         ( finalizePD )
72
import Distribution.Version
73 74
         ( Version, mkVersion, anyVersion, thisVersion
         , VersionRange, orLaterVersion )
75
import Distribution.Simple.Utils as Utils
Francesco Gazzetta's avatar
Francesco Gazzetta committed
76 77
         ( warn, notice, debug, die'
         , defaultPackageDesc )
78
import Distribution.System
79
         ( Platform )
80
import Distribution.Text ( display )
81 82 83
import Distribution.Verbosity as Verbosity
         ( Verbosity )

ttuegel's avatar
ttuegel committed
84
import System.FilePath ( (</>) )
85

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

99
    defaultVersionRange = if allowOlder || allowNewer
100
                          then orLaterVersion (mkVersion [1,19,2])
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
101 102
                          else anyVersion

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

Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
117
  installedPkgIndex <- getInstalledPackages verbosity comp packageDBs progdb
Edsko de Vries's avatar
Edsko de Vries committed
118
  sourcePkgDb       <- getSourcePackages    verbosity repoCtxt
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
119
  pkgConfigDb       <- readPkgConfigDb      verbosity progdb
120

121 122
  checkConfigExFlags verbosity installedPkgIndex
                     (packageIndex sourcePkgDb) configExFlags
123

124
  progress <- planLocalPackage verbosity comp platform configFlags configExFlags
125
                               installedPkgIndex sourcePkgDb pkgConfigDb
126 127

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

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

150
      _ -> die' verbosity $ "internal error: configure install plan should have exactly "
151 152 153
              ++ "one local ready package."

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

172 173
    logMsg message rest = debug verbosity message >> rest

174 175 176
configureSetupScript :: PackageDBStack
                     -> Compiler
                     -> Platform
177
                     -> ProgramDb
178 179 180 181 182
                     -> FilePath
                     -> VersionRange
                     -> Maybe Lock
                     -> Bool
                     -> InstalledPackageIndex
183
                     -> Maybe ReadyPackage
184 185 186 187
                     -> SetupScriptOptions
configureSetupScript packageDBs
                     comp
                     platform
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
188
                     progdb
189 190 191 192 193 194 195
                     distPref
                     cabalVersion
                     lock
                     forceExternal
                     index
                     mpkg
  = SetupScriptOptions {
196 197 198 199 200 201
      useCabalVersion          = cabalVersion
    , useCabalSpecVersion      = Nothing
    , useCompiler              = Just comp
    , usePlatform              = Just platform
    , usePackageDB             = packageDBs'
    , usePackageIndex          = index'
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
202
    , useProgramDb             = progdb
203 204 205
    , useDistPref              = distPref
    , useLoggingHandle         = Nothing
    , useWorkingDir            = Nothing
206
    , useExtraPathEnv          = []
207 208
    , setupCacheLock           = lock
    , useWin32CleanHack        = False
209 210 211 212 213 214 215 216
    , 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
217 218
    , useDependenciesExclusive = not defaultSetupDeps && isJust explicitSetupDeps
    , useVersionMacros         = not defaultSetupDeps && isJust explicitSetupDeps
219
    , isInteractive            = False
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
    }
  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)

237 238
    maybeSetupBuildInfo :: Maybe PkgDesc.SetupBuildInfo
    maybeSetupBuildInfo = do
239
      ReadyPackage cpkg <- mpkg
240
      let gpkg = packageDescription (confPkgSource cpkg)
241 242 243 244 245 246 247 248
      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

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

259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
-- | 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 ++ ")"

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

  let -- We create a local package and ask to resolve a dependency on it
304 305
      localPkg = SourcePackage {
        packageInfoId             = packageId pkg,
306
        packageDescription        = pkg,
307 308
        packageSource             = LocalUnpackedPackage ".",
        packageDescrOverride      = Nothing
309
      }
310

311 312 313 314
      testsEnabled = fromFlagOrDefault False $ configTests configFlags
      benchmarksEnabled =
        fromFlagOrDefault False $ configBenchmarks configFlags

315
      resolverParams =
316
          removeLowerBounds
317
          (fromMaybe (AllowOlder mempty) $ configAllowOlder configExFlags)
318
        . removeUpperBounds
319
          (fromMaybe (AllowNewer mempty) $ configAllowNewer configExFlags)
320

321
        . addPreferences
322 323 324 325 326 327
            -- 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
328 329
            -- TODO: should warn or error on constraints that are not on direct
            -- deps or flag constraints not on the package in question.
330
            [ LabeledPackageConstraint (userToPackageConstraint uc) src
331
            | (uc, src) <- configExConstraints configExFlags ]
332 333 334

        . addConstraints
            -- package flags from the config file or command line
335
            [ let pc = PackageConstraint
336
                       (scopeToplevel $ packageName pkg)
337
                       (PackagePropertyFlags $ configConfigurationsFlags configFlags)
338 339
              in LabeledPackageConstraint pc ConstraintSourceConfigFlagOrTarget
            ]
340

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

351 352 353 354 355
            -- 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)

356 357
        . setSolverVerbosity verbosity

358
        $ standardInstallPolicy
359
            installedPkgIndex
360 361 362
            -- NB: We pass in an *empty* source package database,
            -- because cabal configure assumes that all dependencies
            -- have already been installed
363
            (SourcePackageDb mempty packagePrefs)
364
            [SpecificSourcePackage localPkg]
365

366
  return (resolveDependencies platform (compilerInfo comp) pkgConfigDb solver resolverParams)
367

368

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

  setupWrapper verbosity
    scriptOptions (Just pkg) configureCommand configureFlags extraArgs

  where
392
    gpkg = packageDescription spkg
393
    configureFlags   = filterConfigureFlags configFlags {
394 395 396 397
      configIPID = if isJust (flagToMaybe (configIPID configFlags))
                    -- Make sure cabal configure --ipid works.
                    then configIPID configFlags
                    else toFlag (display ipid),
398
      configConfigurationsFlags = flags,
399 400 401
      -- 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.
402
      configConstraints  = [ thisPackageVersion srcid
403
                           | ConfiguredId srcid (Just PkgDesc.CLibName) _uid <- CD.nonSetupDeps deps ],
404
      configDependencies = [ (packageName srcid, uid)
405
                           | ConfiguredId srcid (Just PkgDesc.CLibName) uid <- CD.nonSetupDeps deps ],
406 407
      -- Use '--exact-configuration' if supported.
      configExactConfiguration = toFlag True,
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
408
      configVerbosity          = toFlag verbosity,
409 410 411 412 413
      -- 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
414
      configTests              = toFlag (TestStanzas `elem` stanzas)
415
                                    `mappend` configTests configFlags
416 417
    }

418
    pkg = case finalizePD flags (enableStanzas stanzas)
419
           (const True)
420
           platform comp [] gpkg of
421
      Left _ -> error "finalizePD ReadyPackage failed"
422
      Right (desc, _) -> desc
ttuegel's avatar
ttuegel committed
423 424 425 426 427 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

-- -----------------------------------------------------------------------------
-- * 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