Install.hs 55.2 KB
Newer Older
1
{-# LANGUAGE CPP #-}
2
3
-----------------------------------------------------------------------------
-- |
4
-- Module      :  Distribution.Client.Install
5
6
7
-- Copyright   :  (c) 2005 David Himmelstrup
--                    2007 Bjorn Bringert
--                    2007-2010 Duncan Coutts
8
9
-- License     :  BSD-like
--
10
-- Maintainer  :  cabal-devel@haskell.org
11
12
13
14
15
-- Stability   :  provisional
-- Portability :  portable
--
-- High level interface to package installation.
-----------------------------------------------------------------------------
16
module Distribution.Client.Install (
17
18
19
20
21
22
23
24
25
26
27
28
    -- * High-level interface
    install,

    -- * Lower-level interface that allows to manipulate the install plan
    makeInstallContext,
    makeInstallPlan,
    processInstallPlan,
    InstallArgs,
    InstallContext,

    -- * Prune certain packages from the install plan
    pruneInstallPlan
29
  ) where
30

31
import Data.List
32
         ( unfoldr, nub, sort, (\\) )
33
import qualified Data.Set as S
Duncan Coutts's avatar
Duncan Coutts committed
34
import Data.Maybe
35
         ( isJust, fromMaybe, maybeToList )
36
import Control.Exception as Exception
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
37
         ( Exception(toException), bracket, catches
38
         , Handler(Handler), handleJust, IOException, SomeException )
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
39
40
41
42
#ifndef mingw32_HOST_OS
import Control.Exception as Exception
         ( Exception(fromException) )
#endif
Duncan Coutts's avatar
Duncan Coutts committed
43
import System.Exit
44
         ( ExitCode(..) )
45
import Distribution.Compat.Exception
46
         ( catchIO, catchExit )
47
import Control.Monad
48
         ( when, unless )
49
import System.Directory
Duncan Coutts's avatar
Duncan Coutts committed
50
         ( getTemporaryDirectory, doesFileExist, createDirectoryIfMissing )
Duncan Coutts's avatar
Duncan Coutts committed
51
import System.FilePath
Duncan Coutts's avatar
Duncan Coutts committed
52
         ( (</>), (<.>), takeDirectory )
Duncan Coutts's avatar
Duncan Coutts committed
53
import System.IO
54
         ( openFile, IOMode(WriteMode), hClose )
55
56
import System.IO.Error
         ( isDoesNotExistError, ioeGetFileName )
bjorn@bringert.net's avatar
bjorn@bringert.net committed
57

58
import Distribution.Client.Targets
59
import Distribution.Client.Dependency
60
61
import Distribution.Client.Dependency.Types
         ( Solver(..) )
Duncan Coutts's avatar
Duncan Coutts committed
62
import Distribution.Client.FetchUtils
63
import qualified Distribution.Client.Haddock as Haddock (regenerateHaddockIndex)
64
import Distribution.Client.IndexUtils as IndexUtils
65
         ( getSourcePackages, getInstalledPackages )
66
67
68
import qualified Distribution.Client.InstallPlan as InstallPlan
import Distribution.Client.InstallPlan (InstallPlan)
import Distribution.Client.Setup
69
70
         ( GlobalFlags(..)
         , ConfigFlags(..), configureCommand, filterConfigureFlags
71
         , ConfigExFlags(..), InstallFlags(..) )
Duncan Coutts's avatar
Duncan Coutts committed
72
import Distribution.Client.Config
73
         ( defaultCabalDir, defaultUserInstall )
74
75
76
import Distribution.Client.Sandbox.Timestamp
         ( withUpdateTimestamps )
import Distribution.Client.Sandbox.Types
77
78
         ( SandboxPackageInfo(..), UseSandbox(..), isUseSandbox
         , whenUsingSandbox )
79
import Distribution.Client.Tar (extractTarGzFile)
80
import Distribution.Client.Types as Source
81
82
import Distribution.Client.BuildReports.Types
         ( ReportLevel(..) )
83
import Distribution.Client.SetupWrapper
Duncan Coutts's avatar
Duncan Coutts committed
84
         ( setupWrapper, SetupScriptOptions(..), defaultSetupScriptOptions )
David Himmelstrup's avatar
David Himmelstrup committed
85
import qualified Distribution.Client.BuildReports.Anonymous as BuildReports
Duncan Coutts's avatar
Duncan Coutts committed
86
87
import qualified Distribution.Client.BuildReports.Storage as BuildReports
         ( storeAnonymous, storeLocal, fromInstallPlan )
88
import qualified Distribution.Client.InstallSymlink as InstallSymlink
89
         ( symlinkBinaries )
90
import qualified Distribution.Client.PackageIndex as SourcePackageIndex
91
import qualified Distribution.Client.Win32SelfUpgrade as Win32SelfUpgrade
92
import qualified Distribution.Client.World as World
93
import qualified Distribution.InstalledPackageInfo as Installed
94
import Paths_cabal_install (getBinDir)
95
import Distribution.Client.JobControl
96

97
import Distribution.Simple.Compiler
98
         ( CompilerId(..), Compiler(compilerId), compilerFlavor
99
         , PackageDB(..), PackageDBStack )
refold's avatar
refold committed
100
101
import Distribution.Simple.Program (ProgramConfiguration,
                                    defaultProgramConfiguration)
102
import qualified Distribution.Simple.InstallDirs as InstallDirs
103
104
import qualified Distribution.Simple.PackageIndex as PackageIndex
import Distribution.Simple.PackageIndex (PackageIndex)
105
import Distribution.Simple.Setup
106
         ( haddockCommand, HaddockFlags(..)
107
108
109
         , buildCommand, BuildFlags(..), emptyBuildFlags
         , toFlag, fromFlag, fromFlagOrDefault, flagToMaybe )
import qualified Distribution.Simple.Setup as Cabal
TillmannRendel's avatar
TillmannRendel committed
110
         ( Flag(..)
111
112
         , copyCommand, CopyFlags(..), emptyCopyFlags
         , registerCommand, RegisterFlags(..), emptyRegisterFlags
TillmannRendel's avatar
TillmannRendel committed
113
         , testCommand, TestFlags(..), emptyTestFlags )
114
import Distribution.Simple.Utils
115
         ( rawSystemExit, comparing, writeFileAtomic )
116
117
import Distribution.Simple.InstallDirs as InstallDirs
         ( PathTemplate, fromPathTemplate, toPathTemplate, substPathTemplate
118
         , initialPathTemplateEnv, installDirsTemplateEnv )
119
import Distribution.Package
120
         ( PackageIdentifier, PackageId, packageName, packageVersion
121
         , Package(..), PackageFixedDeps(..)
122
         , Dependency(..), thisPackageVersion, InstalledPackageId )
123
124
import qualified Distribution.PackageDescription as PackageDescription
import Distribution.PackageDescription
125
126
         ( PackageDescription, GenericPackageDescription(..), Flag(..)
         , FlagName(..), FlagAssignment )
127
import Distribution.PackageDescription.Configuration
128
         ( finalizePackageDescription )
129
import Distribution.Version
130
         ( Version, anyVersion, thisVersion )
131
import Distribution.Simple.Utils as Utils
132
         ( notice, info, warn, debugNoWrap, die, intercalate, withTempDirectory )
133
import Distribution.Client.Utils
134
135
         ( numberOfProcessors, inDir, mergeBy, MergeResult(..)
         , tryCanonicalizePath )
136
import Distribution.System
137
         ( Platform, OS(Windows), buildOS )
138
139
import Distribution.Text
         ( display )
Duncan Coutts's avatar
Duncan Coutts committed
140
import Distribution.Verbosity as Verbosity
141
         ( Verbosity, showForCabal, normal, verbose )
142
import Distribution.Simple.BuildPaths ( exeExtension )
bjorn@bringert.net's avatar
bjorn@bringert.net committed
143

144
145
146
147
148
149
150
151
152
153
154
--TODO:
-- * assign flags to packages individually
--   * complain about flags that do not apply to any package given as target
--     so flags do not apply to dependencies, only listed, can use flag
--     constraints for dependencies
--   * only record applicable flags in world file
-- * allow flag constraints
-- * allow installed constraints
-- * allow flag and installed preferences
-- * change world file to use cabal section syntax
--   * allow persistent configure flags for each package individually
155

156
157
158
159
160
161
-- ------------------------------------------------------------
-- * Top level user actions
-- ------------------------------------------------------------

-- | Installs the packages needed to satisfy a list of dependencies.
--
162
install
163
  :: Verbosity
164
  -> PackageDBStack
165
166
  -> [Repo]
  -> Compiler
167
  -> Platform
168
  -> ProgramConfiguration
169
  -> UseSandbox
170
  -> Maybe SandboxPackageInfo
171
  -> GlobalFlags
172
  -> ConfigFlags
173
  -> ConfigExFlags
174
  -> InstallFlags
175
  -> HaddockFlags
176
  -> [UserTarget]
177
  -> IO ()
178
install verbosity packageDBs repos comp platform conf useSandbox mSandboxPkgInfo
refold's avatar
refold committed
179
180
  globalFlags configFlags configExFlags installFlags haddockFlags
  userTargets0 = do
181

182
    installContext <- makeInstallContext verbosity args (Just userTargets0)
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
183
    installPlan    <- foldProgress logMsg die' return =<<
184
185
186
187
188
                      makeInstallPlan verbosity args installContext

    processInstallPlan verbosity args installContext installPlan
  where
    args :: InstallArgs
189
    args = (packageDBs, repos, comp, platform, conf, useSandbox, mSandboxPkgInfo,
190
191
192
            globalFlags, configFlags, configExFlags, installFlags,
            haddockFlags)

Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
193
194
195
196
    die' message = die (message ++ if isUseSandbox useSandbox
                                   then installFailedInSandbox else [])
    -- TODO: use a better error message, remove duplication.
    installFailedInSandbox =
197
198
199
200
      "\nNote: when using a sandbox, all packages are required to have "
      ++ "consistent dependencies. "
      ++ "Try reinstalling/unregistering the offending packages or "
      ++ "recreating the sandbox."
201
202
    logMsg message rest = debugNoWrap verbosity message >> rest

refold's avatar
refold committed
203
-- TODO: Make InstallContext a proper datatype with documented fields.
204
205
206
207
-- | Common context for makeInstallPlan and processInstallPlan.
type InstallContext = ( PackageIndex, SourcePackageDb
                      , [UserTarget], [PackageSpecifier SourcePackage] )

refold's avatar
refold committed
208
209
-- TODO: Make InstallArgs a proper datatype with documented fields or just get
-- rid of it completely.
210
211
212
213
-- | Initial arguments given to 'install' or 'makeInstallContext'.
type InstallArgs = ( PackageDBStack
                   , [Repo]
                   , Compiler
214
                   , Platform
215
                   , ProgramConfiguration
216
                   , UseSandbox
217
                   , Maybe SandboxPackageInfo
218
219
220
221
222
223
224
                   , GlobalFlags
                   , ConfigFlags
                   , ConfigExFlags
                   , InstallFlags
                   , HaddockFlags )

-- | Make an install context given install arguments.
225
makeInstallContext :: Verbosity -> InstallArgs -> Maybe [UserTarget]
226
227
                      -> IO InstallContext
makeInstallContext verbosity
228
  (packageDBs, repos, comp, _, conf,_,_,
229
   globalFlags, _, _, _, _) mUserTargets = do
230

231
232
    installedPkgIndex <- getInstalledPackages verbosity comp packageDBs conf
    sourcePkgDb       <- getSourcePackages    verbosity repos
233

234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
    (userTargets, pkgSpecifiers) <- case mUserTargets of
      Nothing           ->
        -- We want to distinguish between the case where the user has given an
        -- empty list of targets on the command-line and the case where we
        -- specifically want to have an empty list of targets.
        return ([], [])
      Just userTargets0 -> do
        -- For install, if no target is given it means we use the current
        -- directory as the single target.
        let userTargets | null userTargets0 = [UserTargetLocalDir "."]
                        | otherwise         = userTargets0

        pkgSpecifiers <- resolveUserTargets verbosity
                         (fromFlag $ globalWorldFile globalFlags)
                         (packageIndex sourcePkgDb)
                         userTargets
        return (userTargets, pkgSpecifiers)
251
252

    return (installedPkgIndex, sourcePkgDb, userTargets, pkgSpecifiers)
253

254
255
256
257
-- | Make an install plan given install context and install arguments.
makeInstallPlan :: Verbosity -> InstallArgs -> InstallContext
                -> IO (Progress String String InstallPlan)
makeInstallPlan verbosity
258
  (_, _, comp, platform, _, _, mSandboxPkgInfo,
259
260
261
262
263
264
265
   _, configFlags, configExFlags, installFlags,
   _)
  (installedPkgIndex, sourcePkgDb,
   _, pkgSpecifiers) = do

    solver <- chooseSolver verbosity (fromFlag (configSolver configExFlags))
              (compilerId comp)
266
    notice verbosity "Resolving dependencies..."
267
268
269
    return $ planPackages comp platform mSandboxPkgInfo solver
      configFlags configExFlags installFlags
      installedPkgIndex sourcePkgDb pkgSpecifiers
270

271
272
273
274
275
-- | Given an install plan, perform the actual installations.
processInstallPlan :: Verbosity -> InstallArgs -> InstallContext
                   -> InstallPlan
                   -> IO ()
processInstallPlan verbosity
276
  args@(_,_, _, _, _, _, _, _, _, _, installFlags, _)
277
278
  (installedPkgIndex, sourcePkgDb,
   userTargets, pkgSpecifiers) installPlan = do
279
280
    checkPrintPlan verbosity installedPkgIndex installPlan sourcePkgDb
      installFlags pkgSpecifiers
281

282
283
    unless dryRun $ do
      installPlan' <- performInstallations verbosity
284
285
                      args installedPkgIndex installPlan
      postInstallActions verbosity args userTargets installPlan'
286
  where
287
    dryRun = fromFlag (installDryRun installFlags)
288

289
290
291
-- ------------------------------------------------------------
-- * Installation planning
-- ------------------------------------------------------------
292

293
planPackages :: Compiler
294
             -> Platform
295
             -> Maybe SandboxPackageInfo
296
             -> Solver
297
298
299
             -> ConfigFlags
             -> ConfigExFlags
             -> InstallFlags
300
             -> PackageIndex
301
302
             -> SourcePackageDb
             -> [PackageSpecifier SourcePackage]
303
             -> Progress String String InstallPlan
304
305
planPackages comp platform mSandboxPkgInfo solver
             configFlags configExFlags installFlags
306
             installedPkgIndex sourcePkgDb pkgSpecifiers =
307

308
        resolveDependencies
309
          platform (compilerId comp)
310
          solver
311
          resolverParams
312

313
    >>= if onlyDeps then pruneInstallPlan pkgSpecifiers else return
314

315
316
317
  where
    resolverParams =

Andres Löh's avatar
Andres Löh committed
318
319
320
        setMaxBackjumps (if maxBackjumps < 0 then Nothing
                                             else Just maxBackjumps)

321
322
      . setIndependentGoals independentGoals

Andres Löh's avatar
Andres Löh committed
323
      . setReorderGoals reorderGoals
Andres Löh's avatar
Andres Löh committed
324
325

      . setAvoidReinstalls avoidReinstalls
326

327
328
      . setShadowPkgs shadowPkgs

329
      . setPreferenceDefault (if upgradeDeps then PreferAllLatest
330
331
332
333
334
335
336
337
338
                                             else PreferLatestForSelected)

      . addPreferences
          -- 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
339
            (map userToPackageConstraint (configExConstraints configExFlags))
340
341
342
343

      . addConstraints
          --FIXME: this just applies all flags to all targets which
          -- is silly. We should check if the flags are appropriate
344
          [ PackageConstraintFlags (pkgSpecifierTarget pkgSpecifier) flags
345
346
          | let flags = configConfigurationsFlags configFlags
          , not (null flags)
347
348
349
350
351
          , pkgSpecifier <- pkgSpecifiers ]

      . addConstraints
          [ PackageConstraintStanzas (pkgSpecifierTarget pkgSpecifier) stanzas
          | pkgSpecifier <- pkgSpecifiers ]
352

353
354
      . maybe id applySandboxInstallPolicy mSandboxPkgInfo

355
356
      . (if reinstall then reinstallTargets else id)

357
      $ standardInstallPolicy
358
        installedPkgIndex sourcePkgDb pkgSpecifiers
359

360
361
362
363
    stanzas = concat
        [ if testsEnabled then [TestStanzas] else []
        , if benchmarksEnabled then [BenchStanzas] else []
        ]
364
    testsEnabled = fromFlagOrDefault False $ configTests configFlags
365
    benchmarksEnabled = fromFlagOrDefault False $ configBenchmarks configFlags
366

367
368
369
370
    reinstall        = fromFlag (installReinstall        installFlags)
    reorderGoals     = fromFlag (installReorderGoals     installFlags)
    independentGoals = fromFlag (installIndependentGoals installFlags)
    avoidReinstalls  = fromFlag (installAvoidReinstalls  installFlags)
371
    shadowPkgs       = fromFlag (installShadowPkgs       installFlags)
372
373
374
    maxBackjumps     = fromFlag (installMaxBackjumps     installFlags)
    upgradeDeps      = fromFlag (installUpgradeDeps      installFlags)
    onlyDeps         = fromFlag (installOnlyDeps         installFlags)
375

376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
-- | Remove the provided targets from the install plan.
pruneInstallPlan :: Package pkg => [PackageSpecifier pkg] -> InstallPlan
                    -> Progress String String InstallPlan
pruneInstallPlan pkgSpecifiers =
  -- TODO: this is a general feature and should be moved to D.C.Dependency
  -- Also, the InstallPlan.remove should return info more precise to the
  -- problem, rather than the very general PlanProblem type.
  either (Fail . explain) Done
  . InstallPlan.remove (\pkg -> packageName pkg `elem` targetnames)
  where
    explain :: [InstallPlan.PlanProblem] -> String
    explain problems =
      "Cannot select only the dependencies (as requested by the "
      ++ "'--only-dependencies' flag), "
      ++ (case pkgids of
             [pkgid] -> "the package " ++ display pkgid ++ " is "
             _       -> "the packages "
                        ++ intercalate ", " (map display pkgids) ++ " are ")
      ++ "required by a dependency of one of the other targets."
      where
        pkgids =
          nub [ depid
              | InstallPlan.PackageMissingDeps _ depids <- problems
              , depid <- depids
              , packageName depid `elem` targetnames ]

    targetnames  = map pkgSpecifierTarget pkgSpecifiers

404
405
406
407
-- ------------------------------------------------------------
-- * Informational messages
-- ------------------------------------------------------------

408
409
-- | Perform post-solver checks of the install plan and print it if
-- either requested or needed.
410
411
412
checkPrintPlan :: Verbosity
               -> PackageIndex
               -> InstallPlan
413
               -> SourcePackageDb
414
               -> InstallFlags
415
               -> [PackageSpecifier SourcePackage]
416
               -> IO ()
417
418
checkPrintPlan verbosity installed installPlan sourcePkgDb
  installFlags pkgSpecifiers = do
419

420
421
422
423
424
425
426
427
  -- User targets that are already installed.
  let preExistingTargets =
        [ p | let tgts = map pkgSpecifierTarget pkgSpecifiers,
              InstallPlan.PreExisting p <- InstallPlan.toList installPlan,
              packageName p `elem` tgts ]

  -- If there's nothing to install, we print the already existing
  -- target packages as an explanation.
428
  when nothingToInstall $
429
430
431
432
    notice verbosity $ unlines $
         "All the requested packages are already installed:"
       : map (display . packageId) preExistingTargets
      ++ ["Use --reinstall if you want to reinstall anyway."]
433

434
  let lPlan = linearizeInstallPlan installed installPlan
435
436
  -- Are any packages classified as reinstalls?
  let reinstalledPkgs = concatMap (extractReinstalls . snd) lPlan
437
438
439
440
441
442
443
444
  -- Packages that are already broken.
  let oldBrokenPkgs =
          map Installed.installedPackageId
        . PackageIndex.reverseDependencyClosure installed
        . map (Installed.installedPackageId . fst)
        . PackageIndex.brokenPackages
        $ installed
  let excluded = reinstalledPkgs ++ oldBrokenPkgs
445
  -- Packages that are reverse dependencies of replaced packages are very
446
447
448
  -- likely to be broken. We exclude packages that are already broken.
  let newBrokenPkgs =
        filter (\ p -> not (Installed.installedPackageId p `elem` excluded))
449
450
               (PackageIndex.reverseDependencyClosure installed reinstalledPkgs)
  let containsReinstalls = not (null reinstalledPkgs)
451
  let breaksPkgs         = not (null newBrokenPkgs)
452
453
454
455
456
457
458
459

  let adaptedVerbosity
        | containsReinstalls && not overrideReinstall = verbosity `max` verbose
        | otherwise                                   = verbosity

  -- We print the install plan if we are in a dry-run or if we are confronted
  -- with a dangerous install plan.
  when (dryRun || containsReinstalls && not overrideReinstall) $
460
461
    printPlan (dryRun || breaksPkgs && not overrideReinstall)
      adaptedVerbosity lPlan sourcePkgDb
462

463
464
465
466
467
468
469
470
  -- If the install plan is dangerous, we print various warning messages. In
  -- particular, if we can see that packages are likely to be broken, we even
  -- bail out (unless installation has been forced with --force-reinstalls).
  when containsReinstalls $ do
    if breaksPkgs
      then do
        (if dryRun || overrideReinstall then warn verbosity else die) $ unlines $
            "The following packages are likely to be broken by the reinstalls:"
471
          : map (display . Installed.sourcePackageId) newBrokenPkgs
472
473
474
475
476
477
478
          ++ if overrideReinstall
               then if dryRun then [] else
                 ["Continuing even though the plan contains dangerous reinstalls."]
               else
                 ["Use --force-reinstalls if you want to install anyway."]
      else unless dryRun $ warn verbosity
             "Note that reinstalls are always dangerous. Continuing anyway..."
479
480
481

  where
    nothingToInstall = null (InstallPlan.ready installPlan)
482
483

    dryRun            = fromFlag (installDryRun            installFlags)
484
    overrideReinstall = fromFlag (installOverrideReinstall installFlags)
485

486
487
488
linearizeInstallPlan :: PackageIndex
                     -> InstallPlan
                     -> [(ConfiguredPackage, PackageStatus)]
489
490
linearizeInstallPlan installedPkgIndex plan =
    unfoldr next plan
491
492
493
  where
    next plan' = case InstallPlan.ready plan' of
      []      -> Nothing
494
495
496
497
498
499
500
501
502
      (pkg:_) -> Just ((pkg, status), plan'')
        where
          pkgid  = packageId pkg
          status = packageStatus installedPkgIndex pkg
          plan'' = InstallPlan.completed pkgid
                     (BuildOk DocsNotTried TestsNotTried)
                     (InstallPlan.processing [pkg] plan')
          --FIXME: This is a bit of a hack,
          -- pretending that each package is installed
503

504
505
data PackageStatus = NewPackage
                   | NewVersion [Version]
506
                   | Reinstall  [InstalledPackageId] [PackageChange]
507
508
509

type PackageChange = MergeResult PackageIdentifier PackageIdentifier

510
511
512
extractReinstalls :: PackageStatus -> [InstalledPackageId]
extractReinstalls (Reinstall ipids _) = ipids
extractReinstalls _                   = []
513
514
515
516
517
518

packageStatus :: PackageIndex -> ConfiguredPackage -> PackageStatus
packageStatus installedPkgIndex cpkg =
  case PackageIndex.lookupPackageName installedPkgIndex
                                      (packageName cpkg) of
    [] -> NewPackage
refold's avatar
refold committed
519
520
    ps ->  case filter ((==packageId cpkg)
                        . Installed.sourcePackageId) (concatMap snd ps) of
521
522
523
      []           -> NewVersion (map fst ps)
      pkgs@(pkg:_) -> Reinstall (map Installed.installedPackageId pkgs)
                                (changes pkg cpkg)
524
525
526
527
528
529

  where

    changes :: Installed.InstalledPackageInfo
            -> ConfiguredPackage
            -> [MergeResult PackageIdentifier PackageIdentifier]
refold's avatar
refold committed
530
531
532
533
534
535
536
537
538
539
540
    changes pkg pkg' =
      filter changed
      $ mergeBy (comparing packageName)
        -- get dependencies of installed package (convert to source pkg ids via
        -- index)
        (nub . sort . concatMap
         (maybeToList . fmap Installed.sourcePackageId .
          PackageIndex.lookupInstalledPackageId installedPkgIndex) .
         Installed.depends $ pkg)
        -- get dependencies of configured package
        (nub . sort . depends $ pkg')
541
542
543
544

    changed (InBoth    pkgid pkgid') = pkgid /= pkgid'
    changed _                        = True

545
546
547
printPlan :: Bool -- is dry run
          -> Verbosity
          -> [(ConfiguredPackage, PackageStatus)]
548
          -> SourcePackageDb
549
          -> IO ()
550
printPlan dryRun verbosity plan sourcePkgDb = case plan of
551
552
553
  []   -> return ()
  pkgs
    | verbosity >= Verbosity.verbose -> notice verbosity $ unlines $
554
        ("In order, the following " ++ wouldWill ++ " be installed:")
555
556
      : map showPkgAndReason pkgs
    | otherwise -> notice verbosity $ unlines $
refold's avatar
refold committed
557
558
        ("In order, the following " ++ wouldWill
         ++ " be installed (use -v for more details):")
559
      : map showPkg pkgs
560
  where
561
562
563
    wouldWill | dryRun    = "would"
              | otherwise = "will"

564
565
566
    showPkg (pkg, _) = display (packageId pkg) ++
                       showLatest (pkg)

567
    showPkgAndReason (pkg', pr) = display (packageId pkg') ++
568
          showLatest pkg' ++
569
570
          showFlagAssignment (nonDefaultFlags pkg') ++
          showStanzas (stanzas pkg') ++ " " ++
571
          case pr of
572
573
574
            NewPackage     -> "(new package)"
            NewVersion _   -> "(new version)"
            Reinstall _ cs -> "(reinstall)" ++ case cs of
575
576
577
                []   -> ""
                diff -> " changes: "  ++ intercalate ", " (map change diff)

578
    showLatest :: ConfiguredPackage -> String
579
580
    showLatest pkg = case mLatestVersion of
        Just latestVersion ->
581
            if pkgVersion < latestVersion
582
583
584
            then (" (latest: " ++ display latestVersion ++ ")")
            else ""
        Nothing -> ""
585
586
      where
        pkgVersion    = packageVersion pkg
587
588
589
590
591
592
        mLatestVersion :: Maybe Version
        mLatestVersion = case SourcePackageIndex.lookupPackageName
                                (packageIndex sourcePkgDb)
                                (packageName pkg) of
            [] -> Nothing
            x -> Just $ packageVersion $ last x
593

594
595
596
597
    toFlagAssignment :: [Flag] -> FlagAssignment
    toFlagAssignment = map (\ f -> (flagName f, flagDefault f))

    nonDefaultFlags :: ConfiguredPackage -> FlagAssignment
598
    nonDefaultFlags (ConfiguredPackage spkg fa _ _) =
599
600
601
602
603
      let defaultAssignment =
            toFlagAssignment
             (genPackageFlags (Source.packageDescription spkg))
      in  fa \\ defaultAssignment

604
605
606
607
608
609
610
611
    stanzas :: ConfiguredPackage -> [OptionalStanza]
    stanzas (ConfiguredPackage _ _ sts _) = sts

    showStanzas :: [OptionalStanza] -> String
    showStanzas = concatMap ((' ' :) . showStanza)
    showStanza TestStanzas  = "*test"
    showStanza BenchStanzas = "*bench"

612
    -- FIXME: this should be a proper function in a proper place
613
    showFlagAssignment :: FlagAssignment -> String
614
615
616
617
618
    showFlagAssignment = concatMap ((' ' :) . showFlagValue)
    showFlagValue (f, True)   = '+' : showFlagName f
    showFlagValue (f, False)  = '-' : showFlagName f
    showFlagName (FlagName f) = f

619
620
621
622
623
    change (OnlyInLeft pkgid)        = display pkgid ++ " removed"
    change (InBoth     pkgid pkgid') = display pkgid ++ " -> "
                                    ++ display (packageVersion pkgid')
    change (OnlyInRight      pkgid') = display pkgid' ++ " added"

624
625
626
627
628
629
630
631
632
633
-- ------------------------------------------------------------
-- * Post installation stuff
-- ------------------------------------------------------------

-- | Various stuff we do after successful or unsuccessfully installing a bunch
-- of packages. This includes:
--
--  * build reporting, local and remote
--  * symlinking binaries
--  * updating indexes
634
--  * updating world file
635
636
637
--  * error reporting
--
postInstallActions :: Verbosity
638
                   -> InstallArgs
639
                   -> [UserTarget]
640
641
642
                   -> InstallPlan
                   -> IO ()
postInstallActions verbosity
643
644
  (packageDBs, _, comp, platform, conf, useSandbox, mSandboxPkgInfo
  ,globalFlags, configFlags, _, installFlags, _)
645
  targets installPlan = do
646

647
  unless oneShot $
648
    World.insert verbosity worldFile
649
650
651
      --FIXME: does not handle flags
      [ World.WorldPkgInfo dep []
      | UserTargetNamed dep <- targets ]
652

653
  let buildReports = BuildReports.fromInstallPlan installPlan
refold's avatar
refold committed
654
655
  BuildReports.storeLocal (installSummaryFile installFlags) buildReports
    (InstallPlan.planPlatform installPlan)
656
657
658
659
660
  when (reportingLevel >= AnonymousReports) $
    BuildReports.storeAnonymous buildReports
  when (reportingLevel == DetailedReports) $
    storeDetailedBuildReports verbosity logsDir buildReports

661
  regenerateHaddockIndex verbosity packageDBs comp platform conf
662
663
664
665
666
667
                         configFlags installFlags installPlan

  symlinkBinaries verbosity configFlags installFlags installPlan

  printBuildFailures installPlan

668
669
670
  updateSandboxTimestampsFile useSandbox mSandboxPkgInfo
                              comp platform installPlan

671
672
  where
    reportingLevel = fromFlag (installBuildReports installFlags)
673
    logsDir        = fromFlag (globalLogsDir globalFlags)
674
675
    oneShot        = fromFlag (installOneShot installFlags)
    worldFile      = fromFlag $ globalWorldFile globalFlags
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712

storeDetailedBuildReports :: Verbosity -> FilePath
                          -> [(BuildReports.BuildReport, Repo)] -> IO ()
storeDetailedBuildReports verbosity logsDir reports = sequence_
  [ do dotCabal <- defaultCabalDir
       let logFileName = display (BuildReports.package report) <.> "log"
           logFile     = logsDir </> logFileName
           reportsDir  = dotCabal </> "reports" </> remoteRepoName remoteRepo
           reportFile  = reportsDir </> logFileName

       handleMissingLogFile $ do
         buildLog <- readFile logFile
         createDirectoryIfMissing True reportsDir -- FIXME
         writeFile reportFile (show (BuildReports.show report, buildLog))

  | (report, Repo { repoKind = Left remoteRepo }) <- reports
  , isLikelyToHaveLogFile (BuildReports.installOutcome report) ]

  where
    isLikelyToHaveLogFile BuildReports.ConfigureFailed {} = True
    isLikelyToHaveLogFile BuildReports.BuildFailed     {} = True
    isLikelyToHaveLogFile BuildReports.InstallFailed   {} = True
    isLikelyToHaveLogFile BuildReports.InstallOk       {} = True
    isLikelyToHaveLogFile _                               = False

    handleMissingLogFile = Exception.handleJust missingFile $ \ioe ->
      warn verbosity $ "Missing log file for build report: "
                    ++ fromMaybe ""  (ioeGetFileName ioe)

    missingFile ioe
      | isDoesNotExistError ioe  = Just ioe
    missingFile _                = Nothing


regenerateHaddockIndex :: Verbosity
                       -> [PackageDB]
                       -> Compiler
713
                       -> Platform
714
715
716
717
718
                       -> ProgramConfiguration
                       -> ConfigFlags
                       -> InstallFlags
                       -> InstallPlan
                       -> IO ()
719
regenerateHaddockIndex verbosity packageDBs comp platform conf
720
721
722
723
724
725
726
727
728
729
730
731
732
733
                       configFlags installFlags installPlan
  | haddockIndexFileIsRequested && shouldRegenerateHaddockIndex = do

  defaultDirs <- InstallDirs.defaultInstallDirs
                   (compilerFlavor comp)
                   (fromFlag (configUserInstall configFlags))
                   True
  let indexFileTemplate = fromFlag (installHaddockIndex installFlags)
      indexFile = substHaddockIndexFileName defaultDirs indexFileTemplate

  notice verbosity $
     "Updating documentation index " ++ indexFile

  --TODO: might be nice if the install plan gave us the new InstalledPackageInfo
734
735
  installedPkgIndex <- getInstalledPackages verbosity comp packageDBs conf
  Haddock.regenerateHaddockIndex verbosity installedPkgIndex conf indexFile
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762

  | otherwise = return ()
  where
    haddockIndexFileIsRequested =
         fromFlag (installDocumentation installFlags)
      && isJust (flagToMaybe (installHaddockIndex installFlags))

    -- We want to regenerate the index if some new documentation was actually
    -- installed. Since the index is per-user, we don't do it for global
    -- installs or special cases where we're installing into a specific db.
    shouldRegenerateHaddockIndex = normalUserInstall
                                && someDocsWereInstalled installPlan
      where
        someDocsWereInstalled = any installedDocs . InstallPlan.toList
        normalUserInstall     = (UserPackageDB `elem` packageDBs)
                             && all (not . isSpecificPackageDB) packageDBs

        installedDocs (InstallPlan.Installed _ (BuildOk DocsOk _)) = True
        installedDocs _                                            = False
        isSpecificPackageDB (SpecificPackageDB _) = True
        isSpecificPackageDB _                     = False

    substHaddockIndexFileName defaultDirs = fromPathTemplate
                                          . substPathTemplate env
      where
        env  = env0 ++ installDirsTemplateEnv absoluteDirs
        env0 = InstallDirs.compilerTemplateEnv (compilerId comp)
763
            ++ InstallDirs.platformTemplateEnv platform
764
765
766
767
768
769
        absoluteDirs = InstallDirs.substituteInstallDirTemplates
                         env0 templateDirs
        templateDirs = InstallDirs.combineInstallDirs fromFlagOrDefault
                         defaultDirs (configInstallDirs configFlags)


770
symlinkBinaries :: Verbosity
771
                -> ConfigFlags
772
                -> InstallFlags
773
                -> InstallPlan -> IO ()
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
symlinkBinaries verbosity configFlags installFlags plan = do
  failed <- InstallSymlink.symlinkBinaries configFlags installFlags plan
  case failed of
    [] -> return ()
    [(_, exe, path)] ->
      warn verbosity $
           "could not create a symlink in " ++ bindir ++ " for "
        ++ exe ++ " because the file exists there already but is not "
        ++ "managed by cabal. You can create a symlink for this executable "
        ++ "manually if you wish. The executable file has been installed at "
        ++ path
    exes ->
      warn verbosity $
           "could not create symlinks in " ++ bindir ++ " for "
        ++ intercalate ", " [ exe | (_, exe, _) <- exes ]
        ++ " because the files exist there already and are not "
        ++ "managed by cabal. You can create symlinks for these executables "
        ++ "manually if you wish. The executable files have been installed at "
        ++ intercalate ", " [ path | (_, _, path) <- exes ]
  where
794
    bindir = fromFlag (installSymlinkBinDir installFlags)
795

796

797
printBuildFailures :: InstallPlan -> IO ()
798
799
800
801
802
803
804
805
806
807
808
809
printBuildFailures plan =
  case [ (pkg, reason)
       | InstallPlan.Failed pkg reason <- InstallPlan.toList plan ] of
    []     -> return ()
    failed -> die . unlines
            $ "Error: some packages failed to install:"
            : [ display (packageId pkg) ++ printFailureReason reason
              | (pkg, reason) <- failed ]
  where
    printFailureReason reason = case reason of
      DependentFailed pkgid -> " depends on " ++ display pkgid
                            ++ " which failed to install."
810
      DownloadFailed  e -> " failed while downloading the package."
811
                        ++ showException e
812
      UnpackFailed    e -> " failed while unpacking the package."
813
                        ++ showException e
814
      ConfigureFailed e -> " failed during the configure step."
815
                        ++ showException e
816
      BuildFailed     e -> " failed during the building phase."
817
                        ++ showException e
818
      TestsFailed     e -> " failed during the tests phase."
819
                        ++ showException e
820
      InstallFailed   e -> " failed during the final install step."
821
822
823
824
825
826
827
828
829
830
831
832
                        ++ showException e

    showException e   =  " The exception was:\n  " ++ show e ++ maybeOOM e
#ifdef mingw32_HOST_OS
    maybeOOM _        = ""
#else
    maybeOOM e                    = maybe "" onExitFailure (fromException e)
    onExitFailure (ExitFailure 9) =
      "\nThis may be due to an out-of-memory condition."
    onExitFailure _               = ""
#endif

833

834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
-- | If we're working inside a sandbox and some add-source deps were installed,
-- update the timestamps of those deps.
updateSandboxTimestampsFile :: UseSandbox -> Maybe SandboxPackageInfo
                        -> Compiler -> Platform -> InstallPlan
                        -> IO ()
updateSandboxTimestampsFile (UseSandbox sandboxDir)
                            (Just (SandboxPackageInfo _ _ _ allAddSourceDeps))
                            comp platform installPlan =
  withUpdateTimestamps sandboxDir (compilerId comp) platform $ \_ -> do
    let allInstalled = [ pkg | InstallPlan.Installed pkg _
                            <- InstallPlan.toList installPlan ]
        allSrcPkgs   = [ pkg | ConfiguredPackage pkg _ _ _ <- allInstalled ]
        allPaths     = [ pth | LocalUnpackedPackage pth
                            <- map packageSource allSrcPkgs]
    allPathsCanonical <- mapM tryCanonicalizePath allPaths
    return $! filter (`S.member` allAddSourceDeps) allPathsCanonical

updateSandboxTimestampsFile _ _ _ _ _ = return ()
852
853
854
855
856
857
858
859
860
861

-- ------------------------------------------------------------
-- * Actually do the installations
-- ------------------------------------------------------------

data InstallMisc = InstallMisc {
    rootCmd    :: Maybe FilePath,
    libVersion :: Maybe Version
  }

refold's avatar
refold committed
862
863
864
865
-- | If logging is enabled, contains location of the log file and the verbosity
-- level for logging.
type UseLogFile = Maybe (PackageIdentifier -> FilePath, Verbosity)

866
performInstallations :: Verbosity
867
                     -> InstallArgs
868
                     -> PackageIndex
869
870
871
                     -> InstallPlan
                     -> IO InstallPlan
performInstallations verbosity
872
  (packageDBs, _, comp, _, conf, useSandbox, _,
873
   globalFlags, configFlags, configExFlags, installFlags, haddockFlags)
874
  installedPkgIndex installPlan = do
875

876
877
878
879
880
881
  -- With 'install -j' it can be a bit hard to tell whether a sandbox is used.
  whenUsingSandbox useSandbox $ \sandboxDir ->
    when parallelBuild $
      notice verbosity $ "Notice: installing into a sandbox located at "
                         ++ sandboxDir

882
883
884
885
  jobControl   <- if parallelBuild then newParallelJobControl
                                   else newSerialJobControl
  buildLimit   <- newJobLimit numJobs
  fetchLimit   <- newJobLimit (min numJobs numFetchJobs)
refold's avatar
refold committed
886
887
  installLock  <- newLock -- serialise installation
  cacheLock    <- newLock -- serialise access to setup exe cache
888

refold's avatar
refold committed
889
  executeInstallPlan verbosity jobControl useLogFile installPlan $ \cpkg ->
890
    installConfiguredPackage platform compid configFlags
891
                             cpkg $ \configFlags' src pkg pkgoverride ->
892
893
      fetchSourcePackage verbosity fetchLimit src $ \src' ->
        installLocalPackage verbosity buildLimit (packageId pkg) src' $ \mpath ->
refold's avatar
refold committed
894
          installUnpackedPackage verbosity buildLimit installLock numJobs
refold's avatar
refold committed
895
                                 (setupScriptOptions installedPkgIndex cacheLock)
896
                                 miscOptions configFlags' installFlags haddockFlags
897
                                 compid platform pkg pkgoverride mpath useLogFile
898
899
900
901
902

  where
    platform = InstallPlan.planPlatform installPlan
    compid   = InstallPlan.planCompiler installPlan

903
904
905
906
    numJobs  = case installNumJobs installFlags of
      Cabal.NoFlag        -> 1
      Cabal.Flag Nothing  -> numberOfProcessors
      Cabal.Flag (Just n) -> n
refold's avatar
refold committed
907
    numFetchJobs  = 2
908
909
    parallelBuild = numJobs >= 2

refold's avatar
refold committed
910
    setupScriptOptions index lock = SetupScriptOptions {
911
912
      useCabalVersion  = maybe anyVersion thisVersion (libVersion miscOptions),
      useCompiler      = Just comp,
913
      usePlatform      = Just platform,
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
      -- Hack: 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.
      usePackageDB     = if UserPackageDB `elem` packageDBs
                           then packageDBs
                           else let (db@GlobalPackageDB:dbs) = packageDBs
                                 in db : UserPackageDB : dbs,
                                --TODO: use Ord instance:
                                -- insert UserPackageDB packageDBs
      usePackageIndex  = if UserPackageDB `elem` packageDBs
                           then Just index
                           else Nothing,
      useProgramConfig = conf,
      useDistPref      = fromFlagOrDefault
                           (useDistPref defaultSetupScriptOptions)
                           (configDistPref configFlags),
      useLoggingHandle = Nothing,
931
      useWorkingDir    = Nothing,
refold's avatar
refold committed
932
      forceExternalSetupMethod = parallelBuild,
refold's avatar
refold committed
933
      setupCacheLock   = Just lock
934
935
    }
    reportingLevel = fromFlag (installBuildReports installFlags)
936
    logsDir        = fromFlag (globalLogsDir globalFlags)
refold's avatar
refold committed
937
938
939
940
941

    -- Should the build output be written to a log file instead of stdout?
    useLogFile :: UseLogFile
    useLogFile = fmap ((\f -> (f, loggingVerbosity)) . substLogFileName)
                 logFileTemplate
942
      where
refold's avatar
refold committed
943
944
945
946
947
948
949
        installLogFile' = flagToMaybe $ installLogFile installFlags
        defaultTemplate = toPathTemplate $ logsDir </> "$pkgid" <.> "log"

        -- If the user has specified --remote-build-reporting=detailed, use the
        -- default log file location. If the --build-log option is set, use the
        -- provided location. Otherwise don't use logging, unless building in
        -- parallel (in which case the default location is used).
950
        logFileTemplate :: Maybe PathTemplate
refold's avatar
refold committed
951
952
953
954
955
956
957
958
959
960
961
962
963
964
        logFileTemplate
          | useDefaultTemplate = Just defaultTemplate
          | otherwise          = installLogFile'

        -- If the user has specified --remote-build-reporting=detailed or
        -- --build-log, use more verbose logging.
        loggingVerbosity :: Verbosity
        loggingVerbosity | overrideVerbosity = max Verbosity.verbose verbosity
                         | otherwise         = verbosity

        useDefaultTemplate :: Bool
        useDefaultTemplate
          | reportingLevel == DetailedReports = True
          | isJust installLogFile'            = False
965
          | parallelBuild                     = True
refold's avatar
refold committed
966
967
968
969
970
971
          | otherwise                         = False

        overrideVerbosity :: Bool
        overrideVerbosity
          | reportingLevel == DetailedReports = True
          | isJust installLogFile'            = True
972
          | parallelBuild                     = False
refold's avatar
refold committed
973
          | otherwise                         = False
974
975

    substLogFileName :: PathTemplate -> PackageIdentifier -> FilePath
976
977
978
    substLogFileName template pkg = fromPathTemplate
                                  . substPathTemplate env
                                  $ template
refold's avatar
refold committed
979
980
      where env = initialPathTemplateEnv (packageId pkg)
                  (compilerId comp) platform
refold's avatar
refold committed
981

982
983
    miscOptions  = InstallMisc {
      rootCmd    = if fromFlag (configUserInstall configFlags)
984
                      || (isUseSandbox useSandbox)
985
986
                     then Nothing      -- ignore --root-cmd if --user
                                       -- or working inside a sandbox.
987
988
989
990
991
                     else flagToMaybe (installRootCmd installFlags),
      libVersion = flagToMaybe (configCabalVersion configExFlags)
    }


992
993
executeInstallPlan :: Verbosity
                   -> JobControl IO (PackageId, BuildResult)
refold's avatar
refold committed
994
                   -> UseLogFile
995
996
997
                   -> InstallPlan
                   -> (ConfiguredPackage -> IO BuildResult)
                   -> IO InstallPlan
refold's avatar
refold committed
998
executeInstallPlan verbosity jobCtl useLogFile plan0 installPkg =
999
    tryNewTasks 0 plan0
1000
  where
1001
1002
1003
1004
1005
1006
    tryNewTasks taskCount plan = do
      case InstallPlan.ready plan of
        [] | taskCount == 0 -> return plan
           | otherwise      -> waitForTasks taskCount plan
        pkgs                -> do
          sequence_
refold's avatar
refold committed
1007
            [ do info verbosity $ "Ready to install " ++ display pkgid
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
                 spawnJob jobCtl $ do
                   buildResult <- installPkg pkg
                   return (packageId pkg, buildResult)
            | pkg <- pkgs
            , let pkgid = packageId pkg]

          let taskCount' = taskCount + length pkgs
              plan'      = InstallPlan.processing pkgs plan
          waitForTasks taskCount' plan'

    waitForTasks taskCount plan = do
refold's avatar
refold committed
1019
      info verbosity $ "Waiting for install task to finish..."
1020
      (pkgid, buildResult) <- collectJob jobCtl
refold's avatar
refold committed
1021
      printBuildResult pkgid buildResult
1022
1023
1024
1025
      let taskCount' = taskCount-1
          plan'      = updatePlan pkgid buildResult plan
      tryNewTasks taskCount' plan'

refold's avatar
refold committed
1026
    updatePlan :: PackageIdentifier -> BuildResult -> InstallPlan -> InstallPlan
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
    updatePlan pkgid (Right buildSuccess) =
      InstallPlan.completed pkgid buildSuccess

    updatePlan pkgid (Left buildFailure) =
      InstallPlan.failed    pkgid buildFailure depsFailure
      where
        depsFailure = DependentFailed pkgid
        -- So this first pkgid failed for whatever reason (buildFailure).
        -- All the other packages that depended on this pkgid, which we
        -- now cannot build, we mark as failing due to 'DependentFailed'
        -- which kind of means it was not their fault.
1038

refold's avatar
refold committed
1039
1040
1041
1042
1043
1044
1045
    -- Print last 10 lines of the build log if something went wrong, and
    -- 'Installed $PKGID' otherwise.
    printBuildResult :: PackageId -> BuildResult -> IO ()
    printBuildResult pkgid buildResult = case buildResult of
        (Right _) -> notice verbosity $ "Installed " ++ display pkgid
        (Left _)  -> do
          notice verbosity $ "Failed to install " ++ display pkgid
1046
1047
1048
1049
          when (verbosity >= normal) $
            case useLogFile of
              Nothing                 -> return ()
              Just (mkLogFileName, _) -> do
1050
1051
                let logName = mkLogFileName pkgid
                    n       = 10
1052
                putStr $ "Last " ++ (show n)
1053
                  ++ " lines of the build log ( " ++ logName ++ " ):\n"