Configure.hs 19.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
-----------------------------------------------------------------------------
-- |
-- 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,
15
    configureSetupScript,
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
16
    chooseCabalVersion,
ttuegel's avatar
ttuegel committed
17 18 19 20 21
    checkConfigExFlags,
    -- * Saved configure flags
    readConfigFlagsFrom, readConfigFlags,
    cabalConfigFlagsFile,
    writeConfigFlagsTo, writeConfigFlags,
22 23
  ) where

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

27 28
import Distribution.Client.Dependency
import qualified Distribution.Client.InstallPlan as InstallPlan
29
import Distribution.Client.SolverInstallPlan (SolverInstallPlan)
30
import Distribution.Client.IndexUtils as IndexUtils
31
         ( getSourcePackages, getInstalledPackages )
32
import Distribution.Client.Setup
ttuegel's avatar
ttuegel committed
33 34
         ( ConfigExFlags(..), RepoContext(..)
         , configureCommand, configureExCommand, filterConfigureFlags )
35
import Distribution.Client.Types as Source
36 37
import Distribution.Client.SetupWrapper
         ( setupWrapper, SetupScriptOptions(..), defaultSetupScriptOptions )
38
import Distribution.Client.Targets
39
         ( userToPackageConstraint, userConstraintPackageName )
40 41
import Distribution.Package (PackageId)
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(..)
60
         , fromFlag, toFlag, flagToMaybe, fromFlagOrDefault )
61 62
import Distribution.Simple.PackageIndex
         ( InstalledPackageIndex, lookupPackageName )
63 64 65
import Distribution.Simple.Utils
         ( defaultPackageDesc )
import Distribution.Package
66 67 68
         ( Package(..), packageName )
import Distribution.Types.Dependency
         ( Dependency(..), thisPackageVersion )
69
import qualified Distribution.PackageDescription as PkgDesc
70 71 72
import Distribution.PackageDescription.Parse
         ( readPackageDescription )
import Distribution.PackageDescription.Configuration
73
         ( finalizePD )
74
import Distribution.Version
75 76
         ( Version, mkVersion, anyVersion, thisVersion
         , VersionRange, orLaterVersion )
77
import Distribution.Simple.Utils as Utils
78
         ( warn, notice, debug, die )
79
import Distribution.Simple.Setup
80
         ( isRelaxDeps )
81
import Distribution.System
82
         ( Platform )
83
import Distribution.Text ( display )
84 85 86
import Distribution.Verbosity as Verbosity
         ( Verbosity )

ttuegel's avatar
ttuegel committed
87
import System.FilePath ( (</>) )
88

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

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

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

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

124 125
  checkConfigExFlags verbosity installedPkgIndex
                     (packageIndex sourcePkgDb) configExFlags
126

127
  progress <- planLocalPackage verbosity comp platform configFlags configExFlags
128
                               installedPkgIndex sourcePkgDb pkgConfigDb
129 130

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

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

      _ -> die $ "internal error: configure install plan should have exactly "
              ++ "one local ready package."

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

175 176
    logMsg message rest = debug verbosity message >> rest

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

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

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

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
-- | 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 ++ ")"

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

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

314 315 316 317
      testsEnabled = fromFlagOrDefault False $ configTests configFlags
      benchmarksEnabled =
        fromFlagOrDefault False $ configBenchmarks configFlags

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

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

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

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

354 355 356 357 358
            -- 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)

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

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

369

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

  setupWrapper verbosity
    scriptOptions (Just pkg) configureCommand configureFlags extraArgs

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

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

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