Install.hs 57.3 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
116
         ( rawSystemExit, comparing, writeFileAtomic
         , withTempFile , withFileContents )
117
118
import Distribution.Simple.InstallDirs as InstallDirs
         ( PathTemplate, fromPathTemplate, toPathTemplate, substPathTemplate
119
         , initialPathTemplateEnv, installDirsTemplateEnv )
120
import Distribution.Package
121
         ( PackageIdentifier, PackageId, packageName, packageVersion
122
         , Package(..), PackageFixedDeps(..)
123
         , Dependency(..), thisPackageVersion, InstalledPackageId )
124
125
import qualified Distribution.PackageDescription as PackageDescription
import Distribution.PackageDescription
126
127
         ( PackageDescription, GenericPackageDescription(..), Flag(..)
         , FlagName(..), FlagAssignment )
128
import Distribution.PackageDescription.Configuration
129
         ( finalizePackageDescription )
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
130
131
import Distribution.ParseUtils
         ( showPWarning )
132
import Distribution.Version
133
         ( Version, anyVersion, thisVersion )
134
import Distribution.Simple.Utils as Utils
135
         ( notice, info, warn, debugNoWrap, die, intercalate, withTempDirectory )
136
import Distribution.Client.Utils
137
138
         ( numberOfProcessors, inDir, mergeBy, MergeResult(..)
         , tryCanonicalizePath )
139
import Distribution.System
140
         ( Platform, OS(Windows), buildOS )
141
142
import Distribution.Text
         ( display )
Duncan Coutts's avatar
Duncan Coutts committed
143
import Distribution.Verbosity as Verbosity
144
         ( Verbosity, showForCabal, normal, verbose )
145
import Distribution.Simple.BuildPaths ( exeExtension )
bjorn@bringert.net's avatar
bjorn@bringert.net committed
146

147
148
149
150
151
152
153
154
155
156
157
--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
158

159
160
161
162
163
164
-- ------------------------------------------------------------
-- * Top level user actions
-- ------------------------------------------------------------

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

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

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

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

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

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

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

234
235
    installedPkgIndex <- getInstalledPackages verbosity comp packageDBs conf
    sourcePkgDb       <- getSourcePackages    verbosity repos
236

237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
    (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)
254
255

    return (installedPkgIndex, sourcePkgDb, userTargets, pkgSpecifiers)
256

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

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

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

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

292
293
294
-- ------------------------------------------------------------
-- * Installation planning
-- ------------------------------------------------------------
295

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

311
        resolveDependencies
312
          platform (compilerId comp)
313
          solver
314
          resolverParams
315

316
    >>= if onlyDeps then pruneInstallPlan pkgSpecifiers else return
317

318
319
320
  where
    resolverParams =

Andres Löh's avatar
Andres Löh committed
321
322
323
        setMaxBackjumps (if maxBackjumps < 0 then Nothing
                                             else Just maxBackjumps)

324
325
      . setIndependentGoals independentGoals

Andres Löh's avatar
Andres Löh committed
326
      . setReorderGoals reorderGoals
Andres Löh's avatar
Andres Löh committed
327
328

      . setAvoidReinstalls avoidReinstalls
329

330
331
      . setShadowPkgs shadowPkgs

332
      . setPreferenceDefault (if upgradeDeps then PreferAllLatest
333
334
335
336
337
338
339
340
341
                                             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
342
            (map userToPackageConstraint (configExConstraints configExFlags))
343
344
345
346

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

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

356
357
      . maybe id applySandboxInstallPolicy mSandboxPkgInfo

358
359
      . (if reinstall then reinstallTargets else id)

360
      $ standardInstallPolicy
361
        installedPkgIndex sourcePkgDb pkgSpecifiers
362

363
364
365
366
    stanzas = concat
        [ if testsEnabled then [TestStanzas] else []
        , if benchmarksEnabled then [BenchStanzas] else []
        ]
367
    testsEnabled = fromFlagOrDefault False $ configTests configFlags
368
    benchmarksEnabled = fromFlagOrDefault False $ configBenchmarks configFlags
369

370
371
372
373
    reinstall        = fromFlag (installReinstall        installFlags)
    reorderGoals     = fromFlag (installReorderGoals     installFlags)
    independentGoals = fromFlag (installIndependentGoals installFlags)
    avoidReinstalls  = fromFlag (installAvoidReinstalls  installFlags)
374
    shadowPkgs       = fromFlag (installShadowPkgs       installFlags)
375
376
377
    maxBackjumps     = fromFlag (installMaxBackjumps     installFlags)
    upgradeDeps      = fromFlag (installUpgradeDeps      installFlags)
    onlyDeps         = fromFlag (installOnlyDeps         installFlags)
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
404
405
406
-- | 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

407
408
409
410
-- ------------------------------------------------------------
-- * Informational messages
-- ------------------------------------------------------------

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

423
424
425
426
427
428
429
430
  -- 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.
431
  when nothingToInstall $
432
433
434
435
    notice verbosity $ unlines $
         "All the requested packages are already installed:"
       : map (display . packageId) preExistingTargets
      ++ ["Use --reinstall if you want to reinstall anyway."]
436

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

  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) $
463
464
    printPlan (dryRun || breaksPkgs && not overrideReinstall)
      adaptedVerbosity lPlan sourcePkgDb
465

466
467
468
469
470
471
472
473
  -- 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:"
474
          : map (display . Installed.sourcePackageId) newBrokenPkgs
475
476
477
478
479
480
481
          ++ 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..."
482
483
484

  where
    nothingToInstall = null (InstallPlan.ready installPlan)
485
486

    dryRun            = fromFlag (installDryRun            installFlags)
487
    overrideReinstall = fromFlag (installOverrideReinstall installFlags)
488

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

508
509
data PackageStatus = NewPackage
                   | NewVersion [Version]
510
                   | Reinstall  [InstalledPackageId] [PackageChange]
511
512
513

type PackageChange = MergeResult PackageIdentifier PackageIdentifier

514
515
516
extractReinstalls :: PackageStatus -> [InstalledPackageId]
extractReinstalls (Reinstall ipids _) = ipids
extractReinstalls _                   = []
517
518
519
520
521
522

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

  where

    changes :: Installed.InstalledPackageInfo
            -> ConfiguredPackage
            -> [MergeResult PackageIdentifier PackageIdentifier]
refold's avatar
refold committed
534
535
536
537
538
539
540
541
542
543
544
    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')
545
546
547
548

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

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

568
569
570
    showPkg (pkg, _) = display (packageId pkg) ++
                       showLatest (pkg)

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

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

598
599
600
601
    toFlagAssignment :: [Flag] -> FlagAssignment
    toFlagAssignment = map (\ f -> (flagName f, flagDefault f))

    nonDefaultFlags :: ConfiguredPackage -> FlagAssignment
602
    nonDefaultFlags (ConfiguredPackage spkg fa _ _) =
603
604
605
606
607
      let defaultAssignment =
            toFlagAssignment
             (genPackageFlags (Source.packageDescription spkg))
      in  fa \\ defaultAssignment

608
609
610
611
612
613
614
615
    stanzas :: ConfiguredPackage -> [OptionalStanza]
    stanzas (ConfiguredPackage _ _ sts _) = sts

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

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

623
624
625
626
627
    change (OnlyInLeft pkgid)        = display pkgid ++ " removed"
    change (InBoth     pkgid pkgid') = display pkgid ++ " -> "
                                    ++ display (packageVersion pkgid')
    change (OnlyInRight      pkgid') = display pkgid' ++ " added"

628
629
630
631
632
633
634
635
636
637
-- ------------------------------------------------------------
-- * 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
638
--  * updating world file
639
640
641
--  * error reporting
--
postInstallActions :: Verbosity
642
                   -> InstallArgs
643
                   -> [UserTarget]
644
645
646
                   -> InstallPlan
                   -> IO ()
postInstallActions verbosity
647
648
  (packageDBs, _, comp, platform, conf, useSandbox, mSandboxPkgInfo
  ,globalFlags, configFlags, _, installFlags, _)
649
  targets installPlan = do
650

651
  unless oneShot $
652
    World.insert verbosity worldFile
653
654
655
      --FIXME: does not handle flags
      [ World.WorldPkgInfo dep []
      | UserTargetNamed dep <- targets ]
656

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

665
  regenerateHaddockIndex verbosity packageDBs comp platform conf
666
667
668
669
670
671
                         configFlags installFlags installPlan

  symlinkBinaries verbosity configFlags installFlags installPlan

  printBuildFailures installPlan

672
673
674
  updateSandboxTimestampsFile useSandbox mSandboxPkgInfo
                              comp platform installPlan

675
676
  where
    reportingLevel = fromFlag (installBuildReports installFlags)
677
    logsDir        = fromFlag (globalLogsDir globalFlags)
678
679
    oneShot        = fromFlag (installOneShot installFlags)
    worldFile      = fromFlag $ globalWorldFile globalFlags
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
713
714
715
716

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
717
                       -> Platform
718
719
720
721
722
                       -> ProgramConfiguration
                       -> ConfigFlags
                       -> InstallFlags
                       -> InstallPlan
                       -> IO ()
723
regenerateHaddockIndex verbosity packageDBs comp platform conf
724
725
726
727
728
729
730
731
732
733
734
735
736
737
                       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
738
739
  installedPkgIndex <- getInstalledPackages verbosity comp packageDBs conf
  Haddock.regenerateHaddockIndex verbosity installedPkgIndex conf indexFile
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756

  | 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

757
        installedDocs (InstallPlan.Installed _ (BuildOk DocsOk _ _)) = True
758
759
760
761
762
763
764
765
766
        installedDocs _                                            = False
        isSpecificPackageDB (SpecificPackageDB _) = True
        isSpecificPackageDB _                     = False

    substHaddockIndexFileName defaultDirs = fromPathTemplate
                                          . substPathTemplate env
      where
        env  = env0 ++ installDirsTemplateEnv absoluteDirs
        env0 = InstallDirs.compilerTemplateEnv (compilerId comp)
767
            ++ InstallDirs.platformTemplateEnv platform
768
769
770
771
772
773
        absoluteDirs = InstallDirs.substituteInstallDirTemplates
                         env0 templateDirs
        templateDirs = InstallDirs.combineInstallDirs fromFlagOrDefault
                         defaultDirs (configInstallDirs configFlags)


774
symlinkBinaries :: Verbosity
775
                -> ConfigFlags
776
                -> InstallFlags
777
                -> InstallPlan -> IO ()
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
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
798
    bindir = fromFlag (installSymlinkBinDir installFlags)
799

800

801
printBuildFailures :: InstallPlan -> IO ()
802
803
804
805
806
807
808
809
810
811
812
813
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."
814
      DownloadFailed  e -> " failed while downloading the package."
815
                        ++ showException e
816
      UnpackFailed    e -> " failed while unpacking the package."
817
                        ++ showException e
818
      ConfigureFailed e -> " failed during the configure step."
819
                        ++ showException e
820
      BuildFailed     e -> " failed during the building phase."
821
                        ++ showException e
822
      TestsFailed     e -> " failed during the tests phase."
823
                        ++ showException e
824
      InstallFailed   e -> " failed during the final install step."
825
826
827
828
829
830
831
832
833
834
835
836
                        ++ 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

837

838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
-- | 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 ()
856
857
858
859
860
861
862
863
864
865

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

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

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

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

880
881
882
883
884
885
  -- 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

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

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

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

907
908
909
910
    numJobs  = case installNumJobs installFlags of
      Cabal.NoFlag        -> 1
      Cabal.Flag Nothing  -> numberOfProcessors
      Cabal.Flag (Just n) -> n
refold's avatar
refold committed
911
    numFetchJobs  = 2
912
913
    parallelBuild = numJobs >= 2

refold's avatar
refold committed
914
    setupScriptOptions index lock = SetupScriptOptions {
915
916
      useCabalVersion  = maybe anyVersion thisVersion (libVersion miscOptions),
      useCompiler      = Just comp,
917
      usePlatform      = Just platform,
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
      -- 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,
935
      useWorkingDir    = Nothing,
refold's avatar
refold committed
936
      forceExternalSetupMethod = parallelBuild,
refold's avatar
refold committed
937
      setupCacheLock   = Just lock
938
939
    }
    reportingLevel = fromFlag (installBuildReports installFlags)
940
    logsDir        = fromFlag (globalLogsDir globalFlags)
refold's avatar
refold committed
941
942
943
944
945

    -- Should the build output be written to a log file instead of stdout?
    useLogFile :: UseLogFile
    useLogFile = fmap ((\f -> (f, loggingVerbosity)) . substLogFileName)
                 logFileTemplate
946
      where
refold's avatar
refold committed
947
948
949
950
951
952
953
        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).
954
        logFileTemplate :: Maybe PathTemplate
refold's avatar
refold committed
955
956
957
958
959
960
961
962
963
964
965
966
967
968
        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
969
          | parallelBuild                     = True
refold's avatar
refold committed
970
971
972
973
974
975
          | otherwise                         = False

        overrideVerbosity :: Bool
        overrideVerbosity
          | reportingLevel == DetailedReports = True
          | isJust installLogFile'            = True
976
          | parallelBuild                     = False
refold's avatar
refold committed
977
          | otherwise                         = False
978
979

    substLogFileName :: PathTemplate -> PackageIdentifier -> FilePath
980
981
982
    substLogFileName template pkg = fromPathTemplate
                                  . substPathTemplate env
                                  $ template
refold's avatar
refold committed
983
984
      where env = initialPathTemplateEnv (packageId pkg)
                  (compilerId comp) platform
refold's avatar
refold committed
985

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


996
997
executeInstallPlan :: Verbosity
                   -> JobControl IO (PackageId, BuildResult)
refold's avatar
refold committed
998
                   -> UseLogFile
999
                   -> InstallPlan
1000
                   -> (ConfiguredPackage -> [Installed.InstalledPackageInfo]
For faster browsing, not all history is shown. View entire blame