PackageIndex.hs 23.8 KB
Newer Older
ttuegel's avatar
ttuegel committed
1 2
{-# LANGUAGE DeriveGeneric #-}

3 4
-----------------------------------------------------------------------------
-- |
5
-- Module      :  Distribution.Simple.PackageIndex
6 7
-- Copyright   :  (c) David Himmelstrup 2005,
--                    Bjorn Bringert 2007,
Duncan Coutts's avatar
Duncan Coutts committed
8
--                    Duncan Coutts 2008-2009
9
--
Duncan Coutts's avatar
Duncan Coutts committed
10
-- Maintainer  :  cabal-devel@haskell.org
11 12
-- Portability :  portable
--
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
-- An index of packages whose primary key is 'UnitId'.  Public libraries
-- are additionally indexed by 'PackageName' and 'Version'.
-- Technically, these are an index of *units* (so we should eventually
-- rename it to 'UnitIndex'); but in the absence of internal libraries
-- or Backpack each unit is equivalent to a package.
--
-- 'PackageIndex' is parametric over what it actually records, and it
-- is used in two ways:
--
--      * The 'InstalledPackageIndex' (defined here) contains a graph of
--        'InstalledPackageInfo's representing the packages in a
--        package database stack.  It is used in a variety of ways:
--
--          * The primary use to let Cabal access the same installed
--            package database which is used by GHC during compilation.
--            For example, this data structure is used by 'ghc-pkg'
--            and 'Cabal' to do consistency checks on the database
--            (are the references closed).
--
--          * Given a set of dependencies, we can compute the transitive
--            closure of dependencies.  This is to check if the versions
--            of packages are consistent, and also needed by multiple
--            tools (Haddock must be explicitly told about the every
--            transitive package to do cross-package linking;
--            preprocessors must know about the include paths of all
--            transitive dependencies.)
--
--      * The 'PlanIndex' (defined in 'Distribution.Client.InstallPlan'),
--        contains a graph of 'GenericPlanPackage'.  Ignoring its type
--        parameters for a moment, a 'PlanIndex' is an extension of the
--        'InstalledPackageIndex' to also record nodes for packages
--        which are *planned* to be installed, but not actually
--        installed yet.  A 'PlanIndex' containing only 'PreExisting'
--        packages is essentially a 'PackageIndex'.
--
--        'PlanIndex'es actually require some auxiliary information, so
--        most users interact with a 'GenericInstallPlan'.  This type is
--        specialized as an 'ElaboratedInstallPlan' (for @cabal
--        new-build@) or an 'InstallPlan' (for @cabal install@).
--
-- This 'PackageIndex' is NOT to be confused with
-- 'Distribution.Client.PackageIndex', which indexes packages only by
-- 'PackageName' (this makes it suitable for indexing source packages,
-- for which we don't know 'UnitId's.)
Duncan Coutts's avatar
Duncan Coutts committed
57
--
58 59
module Distribution.Simple.PackageIndex (
  -- * Package index data type
60
  InstalledPackageIndex,
61
  PackageIndex,
62

63
  -- * Creating an index
64 65
  fromList,

66
  -- * Updates
67
  merge,
Duncan Coutts's avatar
Duncan Coutts committed
68

69
  insert,
Duncan Coutts's avatar
Duncan Coutts committed
70

71
  deleteUnitId,
Duncan Coutts's avatar
Duncan Coutts committed
72
  deleteSourcePackageId,
73
  deletePackageName,
Duncan Coutts's avatar
Duncan Coutts committed
74
--  deleteDependency,
75 76 77 78

  -- * Queries

  -- ** Precise lookups
79
  lookupUnitId,
Duncan Coutts's avatar
Duncan Coutts committed
80
  lookupSourcePackageId,
81
  lookupPackageId,
82
  lookupPackageName,
83 84 85 86 87 88 89 90 91 92
  lookupDependency,

  -- ** Case-insensitive searches
  searchByName,
  SearchResult(..),
  searchByNameSubstring,

  -- ** Bulk queries
  allPackages,
  allPackagesByName,
93
  allPackagesBySourcePackageId,
94 95 96 97 98 99 100 101 102 103

  -- ** Special queries
  brokenPackages,
  dependencyClosure,
  reverseDependencyClosure,
  topologicalOrder,
  reverseTopologicalOrder,
  dependencyInconsistencies,
  dependencyCycles,
  dependencyGraph,
Duncan Coutts's avatar
Duncan Coutts committed
104
  moduleNameIndex,
105 106 107 108

  -- * Backwards compatibility
  deleteInstalledPackageId,
  lookupInstalledPackageId,
109 110
  ) where

111 112 113
import Prelude ()
import Distribution.Compat.Prelude hiding (lookup)

114 115 116 117 118 119
import Distribution.Package
import Distribution.ModuleName
import qualified Distribution.InstalledPackageInfo as IPI
import Distribution.Version
import Distribution.Simple.Utils

120
import Control.Exception (assert)
121
import Data.Array ((!))
ttuegel's avatar
ttuegel committed
122 123
import qualified Data.Array as Array
import qualified Data.Graph as Graph
124
import Data.List as List ( groupBy,  deleteBy, deleteFirstsBy )
ttuegel's avatar
ttuegel committed
125 126
import qualified Data.Map as Map
import qualified Data.Tree  as Tree
127 128

-- | The collection of information about packages from one or more 'PackageDB's.
129
-- These packages generally should have an instance of 'PackageInstalled'
130
--
131
-- Packages are uniquely identified in by their 'UnitId', they can
Ian D. Bollinger's avatar
Ian D. Bollinger committed
132
-- also be efficiently looked up by package name or by name and version.
133
--
134
data PackageIndex a = PackageIndex
Duncan Coutts's avatar
Duncan Coutts committed
135
  -- The primary index. Each InstalledPackageInfo record is uniquely identified
136
  -- by its UnitId.
Duncan Coutts's avatar
Duncan Coutts committed
137
  --
138
  !(Map UnitId a)
Duncan Coutts's avatar
Duncan Coutts committed
139

Ian D. Bollinger's avatar
Ian D. Bollinger committed
140
  -- This auxiliary index maps package names (case-sensitively) to all the
Duncan Coutts's avatar
Duncan Coutts committed
141 142
  -- versions and instances of that package. This allows us to find all
  -- versions satisfying a dependency.
143
  --
Duncan Coutts's avatar
Duncan Coutts committed
144 145
  -- It is a three-level index. The first level is the package name,
  -- the second is the package version and the final level is instances
146
  -- of the same package version. These are unique by UnitId
Duncan Coutts's avatar
Duncan Coutts committed
147
  -- and are kept in preference order.
148
  --
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
149 150
  -- FIXME: Clarify what "preference order" means. Check that this invariant is
  -- preserved. See #1463 for discussion.
151
  !(Map PackageName (Map Version [a]))
152

153
  deriving (Eq, Generic, Show, Read)
ttuegel's avatar
ttuegel committed
154 155

instance Binary a => Binary (PackageIndex a)
Duncan Coutts's avatar
Duncan Coutts committed
156

157 158
-- | The default package index which contains 'InstalledPackageInfo'.  Normally
-- use this.
159
type InstalledPackageIndex = PackageIndex IPI.InstalledPackageInfo
160

161
instance HasUnitId a => Monoid (PackageIndex a) where
Duncan Coutts's avatar
Duncan Coutts committed
162
  mempty  = PackageIndex Map.empty Map.empty
163
  mappend = (<>)
164
  --save one mappend with empty in the common case:
165
  mconcat [] = mempty
166 167
  mconcat xs = foldr1 mappend xs

168
instance HasUnitId a => Semigroup (PackageIndex a) where
169 170
  (<>) = merge

171
invariant :: HasUnitId a => PackageIndex a -> Bool
Duncan Coutts's avatar
Duncan Coutts committed
172
invariant (PackageIndex pids pnames) =
173
     map installedUnitId (Map.elems pids)
174
  == sort
175
     [ assert pinstOk (installedUnitId pinst)
Duncan Coutts's avatar
Duncan Coutts committed
176 177 178
     | (pname, pvers)  <- Map.toList pnames
     , let pversOk = not (Map.null pvers)
     , (pver,  pinsts) <- assert pversOk $ Map.toList pvers
179
     , let pinsts'  = sortBy (comparing installedUnitId) pinsts
Duncan Coutts's avatar
Duncan Coutts committed
180
           pinstsOk = all (\g -> length g == 1)
181
                          (groupBy (equating installedUnitId) pinsts')
Duncan Coutts's avatar
Duncan Coutts committed
182 183 184 185 186
     , pinst           <- assert pinstsOk $ pinsts'
     , let pinstOk = packageName    pinst == pname
                  && packageVersion pinst == pver
     ]

187

188 189 190 191
--
-- * Internal helpers
--

192 193
mkPackageIndex :: HasUnitId a
               => Map UnitId a
194 195
               -> Map PackageName (Map Version [a])
               -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
196 197
mkPackageIndex pids pnames = assert (invariant index) index
  where index = PackageIndex pids pnames
198

199 200 201

--
-- * Construction
202 203
--

204
-- | Build an index out of a bunch of packages.
205
--
206
-- If there are duplicates by 'UnitId' then later ones mask earlier
Duncan Coutts's avatar
Duncan Coutts committed
207
-- ones.
208
--
209
fromList :: HasUnitId a => [a] -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
210
fromList pkgs = mkPackageIndex pids pnames
211
  where
212
    pids      = Map.fromList [ (installedUnitId pkg, pkg) | pkg <- pkgs ]
Duncan Coutts's avatar
Duncan Coutts committed
213 214 215 216 217 218 219 220 221
    pnames    =
      Map.fromList
        [ (packageName (head pkgsN), pvers)
        | pkgsN <- groupBy (equating  packageName)
                 . sortBy  (comparing packageId)
                 $ pkgs
        , let pvers =
                Map.fromList
                [ (packageVersion (head pkgsNV),
222
                   nubBy (equating installedUnitId) (reverse pkgsNV))
Duncan Coutts's avatar
Duncan Coutts committed
223 224 225
                | pkgsNV <- groupBy (equating packageVersion) pkgsN
                ]
        ]
226

227 228 229 230
--
-- * Updates
--

231 232
-- | Merge two indexes.
--
Duncan Coutts's avatar
Duncan Coutts committed
233
-- Packages from the second mask packages from the first if they have the exact
234
-- same 'UnitId'.
235
--
Duncan Coutts's avatar
Duncan Coutts committed
236 237 238 239 240
-- For packages with the same source 'PackageId', packages from the second are
-- \"preferred\" over those from the first. Being preferred means they are top
-- result when we do a lookup by source 'PackageId'. This is the mechanism we
-- use to prefer user packages over global packages.
--
241
merge :: HasUnitId a => PackageIndex a -> PackageIndex a
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
242
      -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
243
merge (PackageIndex pids1 pnames1) (PackageIndex pids2 pnames2) =
244
  mkPackageIndex (Map.unionWith (\_ y -> y) pids1 pids2)
Duncan Coutts's avatar
Duncan Coutts committed
245 246 247 248 249
                 (Map.unionWith (Map.unionWith mergeBuckets) pnames1 pnames2)
  where
    -- Packages in the second list mask those in the first, however preferred
    -- packages go first in the list.
    mergeBuckets xs ys = ys ++ (xs \\ ys)
250
    (\\) = deleteFirstsBy (equating installedUnitId)
251

252

Duncan Coutts's avatar
Duncan Coutts committed
253
-- | Inserts a single package into the index.
254 255 256 257
--
-- This is equivalent to (but slightly quicker than) using 'mappend' or
-- 'merge' with a singleton index.
--
258
insert :: HasUnitId a => a -> PackageIndex a -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
259 260 261
insert pkg (PackageIndex pids pnames) =
    mkPackageIndex pids' pnames'

262
  where
263
    pids'   = Map.insert (installedUnitId pkg) pkg pids
Duncan Coutts's avatar
Duncan Coutts committed
264 265 266 267 268 269 270 271 272 273 274
    pnames' = insertPackageName pnames
    insertPackageName =
      Map.insertWith' (\_ -> insertPackageVersion)
                     (packageName pkg)
                     (Map.singleton (packageVersion pkg) [pkg])

    insertPackageVersion =
      Map.insertWith' (\_ -> insertPackageInstance)
                     (packageVersion pkg) [pkg]

    insertPackageInstance pkgs =
275
      pkg : deleteBy (equating installedUnitId) pkg pkgs
Duncan Coutts's avatar
Duncan Coutts committed
276 277 278 279


-- | Removes a single installed package from the index.
--
280
deleteUnitId :: HasUnitId a
281 282
             => UnitId -> PackageIndex a
             -> PackageIndex a
283
deleteUnitId ipkgid original@(PackageIndex pids pnames) =
Duncan Coutts's avatar
Duncan Coutts committed
284 285 286 287 288
  case Map.updateLookupWithKey (\_ _ -> Nothing) ipkgid pids of
    (Nothing,     _)     -> original
    (Just spkgid, pids') -> mkPackageIndex pids'
                                          (deletePkgName spkgid pnames)

Duncan Coutts's avatar
Duncan Coutts committed
289
  where
Duncan Coutts's avatar
Duncan Coutts committed
290 291 292 293 294 295
    deletePkgName spkgid =
      Map.update (deletePkgVersion spkgid) (packageName spkgid)

    deletePkgVersion spkgid =
        (\m -> if Map.null m then Nothing else Just m)
      . Map.update deletePkgInstance (packageVersion spkgid)
Duncan Coutts's avatar
Duncan Coutts committed
296

Duncan Coutts's avatar
Duncan Coutts committed
297
    deletePkgInstance =
298
        (\xs -> if null xs then Nothing else Just xs)
299
      . List.deleteBy (\_ pkg -> installedUnitId pkg == ipkgid) undefined
Duncan Coutts's avatar
Duncan Coutts committed
300

Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
301
-- | Backwards compatibility wrapper for Cabal pre-1.24.
302 303 304 305 306
{-# DEPRECATED deleteInstalledPackageId "Use deleteUnitId instead" #-}
deleteInstalledPackageId :: HasUnitId a
                         => UnitId -> PackageIndex a
                         -> PackageIndex a
deleteInstalledPackageId = deleteUnitId
Duncan Coutts's avatar
Duncan Coutts committed
307 308

-- | Removes all packages with this source 'PackageId' from the index.
309
--
310
deleteSourcePackageId :: HasUnitId a => PackageId -> PackageIndex a
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
311
                      -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
312 313 314 315 316 317
deleteSourcePackageId pkgid original@(PackageIndex pids pnames) =
  case Map.lookup (packageName pkgid) pnames of
    Nothing     -> original
    Just pvers  -> case Map.lookup (packageVersion pkgid) pvers of
      Nothing   -> original
      Just pkgs -> mkPackageIndex
318
                     (foldl' (flip (Map.delete . installedUnitId)) pids pkgs)
Duncan Coutts's avatar
Duncan Coutts committed
319 320 321 322 323 324 325 326 327
                     (deletePkgName pnames)
  where
    deletePkgName =
      Map.update deletePkgVersion (packageName pkgid)

    deletePkgVersion =
        (\m -> if Map.null m then Nothing else Just m)
      . Map.delete (packageVersion pkgid)

328 329 330

-- | Removes all packages with this (case-sensitive) name from the index.
--
331
deletePackageName :: HasUnitId a => PackageName -> PackageIndex a
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
332
                  -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
333 334 335 336
deletePackageName name original@(PackageIndex pids pnames) =
  case Map.lookup name pnames of
    Nothing     -> original
    Just pvers  -> mkPackageIndex
337
                     (foldl' (flip (Map.delete . installedUnitId)) pids
Duncan Coutts's avatar
Duncan Coutts committed
338 339
                             (concat (Map.elems pvers)))
                     (Map.delete name pnames)
340

Duncan Coutts's avatar
Duncan Coutts committed
341
{-
342 343
-- | Removes all packages satisfying this dependency from the index.
--
Duncan Coutts's avatar
Duncan Coutts committed
344
deleteDependency :: Dependency -> PackageIndex -> PackageIndex
345
deleteDependency (Dependency name verstionRange) =
Duncan Coutts's avatar
Duncan Coutts committed
346 347
  delete' name (\pkg -> packageVersion pkg `withinRange` verstionRange)
-}
348

349 350 351 352
--
-- * Bulk queries
--

353 354
-- | Get all the packages from the index.
--
355
allPackages :: PackageIndex a -> [a]
Duncan Coutts's avatar
Duncan Coutts committed
356
allPackages (PackageIndex pids _) = Map.elems pids
357 358 359

-- | Get all the packages from the index.
--
360
-- They are grouped by package name (case-sensitively).
361
--
362
allPackagesByName :: PackageIndex a -> [(PackageName, [a])]
Duncan Coutts's avatar
Duncan Coutts committed
363
allPackagesByName (PackageIndex _ pnames) =
364 365 366 367 368 369 370
  [ (pkgname, concat (Map.elems pvers))
  | (pkgname, pvers) <- Map.toList pnames ]

-- | Get all the packages from the index.
--
-- They are grouped by source package id (package name and version).
--
371
allPackagesBySourcePackageId :: HasUnitId a => PackageIndex a
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
372
                             -> [(PackageId, [a])]
373 374 375 376
allPackagesBySourcePackageId (PackageIndex _ pnames) =
  [ (packageId ipkg, ipkgs)
  | pvers <- Map.elems pnames
  , ipkgs@(ipkg:_) <- Map.elems pvers ]
377 378 379 380 381

--
-- * Lookups
--

Duncan Coutts's avatar
Duncan Coutts committed
382
-- | Does a lookup by source package id (name & version).
383
--
384
-- Since multiple package DBs mask each other by 'UnitId',
385 386
-- then we get back at most one package.
--
387
lookupUnitId :: PackageIndex a -> UnitId
388
             -> Maybe a
389
lookupUnitId (PackageIndex pids _) pid = Map.lookup pid pids
Duncan Coutts's avatar
Duncan Coutts committed
390

Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
391
-- | Backwards compatibility for Cabal pre-1.24.
392 393 394 395 396
{-# DEPRECATED lookupInstalledPackageId "Use lookupUnitId instead" #-}
lookupInstalledPackageId :: PackageIndex a -> UnitId
                         -> Maybe a
lookupInstalledPackageId = lookupUnitId

397

Duncan Coutts's avatar
Duncan Coutts committed
398 399 400
-- | Does a lookup by source package id (name & version).
--
-- There can be multiple installed packages with the same source 'PackageId'
401
-- but different 'UnitId'. They are returned in order of
Duncan Coutts's avatar
Duncan Coutts committed
402
-- preference, with the most preferred first.
403
--
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
404
lookupSourcePackageId :: PackageIndex a -> PackageId -> [a]
Duncan Coutts's avatar
Duncan Coutts committed
405 406 407 408 409 410
lookupSourcePackageId (PackageIndex _ pnames) pkgid =
  case Map.lookup (packageName pkgid) pnames of
    Nothing     -> []
    Just pvers  -> case Map.lookup (packageVersion pkgid) pvers of
      Nothing   -> []
      Just pkgs -> pkgs -- in preference order
411

412 413
-- | Convenient alias of 'lookupSourcePackageId', but assuming only
-- one package per package ID.
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
414
lookupPackageId :: PackageIndex a -> PackageId -> Maybe a
415 416 417 418
lookupPackageId index pkgid = case lookupSourcePackageId index pkgid  of
    []    -> Nothing
    [pkg] -> Just pkg
    _     -> error "Distribution.Simple.PackageIndex: multiple matches found"
Duncan Coutts's avatar
Duncan Coutts committed
419 420 421

-- | Does a lookup by source package name.
--
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
422
lookupPackageName :: PackageIndex a -> PackageName
423
                  -> [(Version, [a])]
Duncan Coutts's avatar
Duncan Coutts committed
424 425 426 427 428 429 430
lookupPackageName (PackageIndex _ pnames) name =
  case Map.lookup name pnames of
    Nothing     -> []
    Just pvers  -> Map.toList pvers


-- | Does a lookup by source package name and a range of versions.
431 432 433 434
--
-- We get back any number of versions of the specified package name, all
-- satisfying the version range constraint.
--
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
435
lookupDependency :: PackageIndex a -> Dependency
436
                 -> [(Version, [a])]
Duncan Coutts's avatar
Duncan Coutts committed
437 438 439 440 441 442
lookupDependency (PackageIndex _ pnames) (Dependency name versionRange) =
  case Map.lookup name pnames of
    Nothing    -> []
    Just pvers -> [ entry
                  | entry@(ver, _) <- Map.toList pvers
                  , ver `withinRange` versionRange ]
443 444 445 446

--
-- * Case insensitive name lookups
--
447 448 449

-- | Does a case-insensitive search by package name.
--
Ian D. Bollinger's avatar
Ian D. Bollinger committed
450
-- If there is only one package that compares case-insensitively to this name
451
-- then the search is unambiguous and we get back all versions of that package.
Ian D. Bollinger's avatar
Ian D. Bollinger committed
452
-- If several match case-insensitively but one matches exactly then it is also
453 454
-- unambiguous.
--
Ian D. Bollinger's avatar
Ian D. Bollinger committed
455
-- If however several match case-insensitively and none match exactly then we
456 457 458 459
-- have an ambiguous result, and we get back all the versions of all the
-- packages. The list of ambiguous results is split by exact package name. So
-- it is a non-empty list of non-empty lists.
--
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
460
searchByName :: PackageIndex a -> String -> SearchResult [a]
Duncan Coutts's avatar
Duncan Coutts committed
461 462
searchByName (PackageIndex _ pnames) name =
  case [ pkgs | pkgs@(PackageName name',_) <- Map.toList pnames
463
              , lowercase name' == lname ] of
Duncan Coutts's avatar
Duncan Coutts committed
464 465 466 467 468
    []               -> None
    [(_,pvers)]      -> Unambiguous (concat (Map.elems pvers))
    pkgss            -> case find ((PackageName name==) . fst) pkgss of
      Just (_,pvers) -> Unambiguous (concat (Map.elems pvers))
      Nothing        -> Ambiguous (map (concat . Map.elems . snd) pkgss)
469
  where lname = lowercase name
470 471 472 473 474 475 476

data SearchResult a = None | Unambiguous a | Ambiguous [a]

-- | Does a case-insensitive substring search by package name.
--
-- That is, all packages that contain the given string in their name.
--
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
477
searchByNameSubstring :: PackageIndex a -> String -> [a]
Duncan Coutts's avatar
Duncan Coutts committed
478
searchByNameSubstring (PackageIndex _ pnames) searchterm =
479
  [ pkg
Duncan Coutts's avatar
Duncan Coutts committed
480
  | (PackageName name, pvers) <- Map.toList pnames
481
  , lsearchterm `isInfixOf` lowercase name
Duncan Coutts's avatar
Duncan Coutts committed
482
  , pkgs <- Map.elems pvers
483
  , pkg <- pkgs ]
484
  where lsearchterm = lowercase searchterm
485

Duncan Coutts's avatar
Duncan Coutts committed
486 487 488 489 490 491 492 493

--
-- * Special queries
--

-- None of the stuff below depends on the internal representation of the index.
--

494 495 496 497 498 499 500
-- | Find if there are any cycles in the dependency graph. If there are no
-- cycles the result is @[]@.
--
-- This actually computes the strongly connected components. So it gives us a
-- list of groups of packages where within each group they all depend on each
-- other, directly or indirectly.
--
501
dependencyCycles :: PackageInstalled a => PackageIndex a -> [[a]]
502
dependencyCycles index =
503 504
  [ vs | Graph.CyclicSCC vs <- Graph.stronglyConnComp adjacencyList ]
  where
505
    adjacencyList = [ (pkg, installedUnitId pkg, installedDepends pkg)
506 507 508
                    | pkg <- allPackages index ]


Duncan Coutts's avatar
Duncan Coutts committed
509
-- | All packages that have immediate dependencies that are not in the index.
510
--
511 512
-- Returns such packages along with the dependencies that they're missing.
--
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
513
brokenPackages :: PackageInstalled a => PackageIndex a
514
               -> [(a, [UnitId])]
515
brokenPackages index =
516
  [ (pkg, missing)
Duncan Coutts's avatar
Duncan Coutts committed
517
  | pkg  <- allPackages index
518
  , let missing = [ pkg' | pkg' <- installedDepends pkg
519
                         , isNothing (lookupUnitId index pkg') ]
520 521
  , not (null missing) ]

522
-- | Tries to take the transitive closure of the package dependencies.
523
--
524
-- If the transitive closure is complete then it returns that subset of the
525 526 527
-- index. Otherwise it returns the broken packages as in 'brokenPackages'.
--
-- * Note that if the result is @Right []@ it is because at least one of
Duncan Coutts's avatar
Duncan Coutts committed
528
-- the original given 'PackageId's do not occur in the index.
529
--
530
dependencyClosure :: PackageInstalled a => PackageIndex a
531
                  -> [UnitId]
532
                  -> Either (PackageIndex a)
533
                            [(a, [UnitId])]
534
dependencyClosure index pkgids0 = case closure mempty [] pkgids0 of
535 536
  (completed, []) -> Left completed
  (completed, _)  -> Right (brokenPackages completed)
537
 where
538
    closure completed failed []             = (completed, failed)
539
    closure completed failed (pkgid:pkgids) = case lookupUnitId index pkgid of
540
      Nothing   -> closure completed (pkgid:failed) pkgids
541
      Just pkg  -> case lookupUnitId completed (installedUnitId pkg) of
542 543
        Just _  -> closure completed  failed pkgids
        Nothing -> closure completed' failed pkgids'
Duncan Coutts's avatar
Duncan Coutts committed
544
          where completed' = insert pkg completed
545
                pkgids'    = installedDepends pkg ++ pkgids
546

547
-- | Takes the transitive closure of the packages reverse dependencies.
548
--
Duncan Coutts's avatar
Duncan Coutts committed
549
-- * The given 'PackageId's must be in the index.
550
--
551
reverseDependencyClosure :: PackageInstalled a => PackageIndex a
552
                         -> [UnitId]
553
                         -> [a]
554
reverseDependencyClosure index =
555 556 557 558
    map vertexToPkg
  . concatMap Tree.flatten
  . Graph.dfs reverseDepGraph
  . map (fromMaybe noSuchPkgId . pkgIdToVertex)
559

560
  where
561
    (depGraph, vertexToPkg, pkgIdToVertex) = dependencyGraph index
562 563 564
    reverseDepGraph = Graph.transposeG depGraph
    noSuchPkgId = error "reverseDependencyClosure: package is not in the graph"

565
topologicalOrder :: PackageInstalled a => PackageIndex a -> [a]
566 567 568 569 570
topologicalOrder index = map toPkgId
                       . Graph.topSort
                       $ graph
  where (graph, toPkgId, _) = dependencyGraph index

571
reverseTopologicalOrder :: PackageInstalled a => PackageIndex a -> [a]
572 573 574 575 576 577 578 579 580 581 582
reverseTopologicalOrder index = map toPkgId
                              . Graph.topSort
                              . Graph.transposeG
                              $ graph
  where (graph, toPkgId, _) = dependencyGraph index

-- | Builds a graph of the package dependencies.
--
-- Dependencies on other packages that are not in the index are discarded.
-- You can check if there are any such dependencies with 'brokenPackages'.
--
583
dependencyGraph :: PackageInstalled a => PackageIndex a
584
                -> (Graph.Graph,
585
                    Graph.Vertex -> a,
586
                    UnitId -> Maybe Graph.Vertex)
587
dependencyGraph index = (graph, vertex_to_pkg, id_to_vertex)
588 589
  where
    graph = Array.listArray bounds
590
              [ [ v | Just v <- map id_to_vertex (installedDepends pkg) ]
591
              | pkg <- pkgs ]
592

Duncan Coutts's avatar
Duncan Coutts committed
593
    pkgs             = sortBy (comparing packageId) (allPackages index)
594
    vertices         = zip (map installedUnitId pkgs) [0..]
595
    vertex_map       = Map.fromList vertices
596
    id_to_vertex pid = Map.lookup pid vertex_map
597 598

    vertex_to_pkg vertex = pkgTable ! vertex
599 600 601 602 603

    pkgTable   = Array.listArray bounds pkgs
    topBound = length pkgs - 1
    bounds = (0, topBound)

604 605 606 607 608 609 610 611 612 613
-- | Given a package index where we assume we want to use all the packages
-- (use 'dependencyClosure' if you need to get such a index subset) find out
-- if the dependencies within it use consistent versions of each package.
-- Return all cases where multiple packages depend on different versions of
-- some other package.
--
-- Each element in the result is a package name along with the packages that
-- depend on it and the versions they require. These are guaranteed to be
-- distinct.
--
614
dependencyInconsistencies :: PackageInstalled a => PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
615
                          -> [(PackageName, [(PackageId, Version)])]
616
dependencyInconsistencies index =
617 618 619 620 621 622 623 624 625 626 627 628
  [ (name, [ (pid,packageVersion dep) | (dep,pids) <- uses, pid <- pids])
  | (name, ipid_map) <- Map.toList inverseIndex
  , let uses = Map.elems ipid_map
  , reallyIsInconsistent (map fst uses) ]

  where -- for each PackageName,
        --   for each package with that name,
        --     the InstalledPackageInfo and the package Ids of packages
        --     that depend on it.
        inverseIndex = Map.fromListWith (Map.unionWith (\(a,b) (_,b') -> (a,b++b')))
          [ (packageName dep,
             Map.fromList [(ipid,(dep,[packageId pkg]))])
Duncan Coutts's avatar
Duncan Coutts committed
629
          | pkg <- allPackages index
630
          , ipid <- installedDepends pkg
631
          , Just dep <- [lookupUnitId index ipid]
632 633
          ]

634 635 636 637 638
        -- Added in 991e52a474e2b8280432257c1771dc474a320a30,
        -- this is a special case to handle the base 3 compatibility
        -- package which shipped with GHC 6.10 and GHC 6.12
        -- (it was removed in GHC 7.0).  Remove this when GHC 6.12
        -- goes out of our support window.
639
        reallyIsInconsistent :: PackageInstalled a => [a] -> Bool
640 641 642
        reallyIsInconsistent []       = False
        reallyIsInconsistent [_p]     = False
        reallyIsInconsistent [p1, p2] =
643 644
          let pid1 = installedUnitId p1
              pid2 = installedUnitId p2
645 646
          in pid1 `notElem` installedDepends p2
          && pid2 `notElem` installedDepends p1
647
        reallyIsInconsistent _ = True
Duncan Coutts's avatar
Duncan Coutts committed
648

Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
649 650 651 652
-- | A rough approximation of GHC's module finder, takes a
-- 'InstalledPackageIndex' and turns it into a map from module names to their
-- source packages.  It's used to initialize the @build-deps@ field in @cabal
-- init@.
653
moduleNameIndex :: InstalledPackageIndex -> Map ModuleName [IPI.InstalledPackageInfo]
Duncan Coutts's avatar
Duncan Coutts committed
654
moduleNameIndex index =
655 656
  Map.fromListWith (++) $ do
    pkg <- allPackages index
657
    IPI.ExposedModule m reexport <- IPI.exposedModules pkg
658 659
    case reexport of
        Nothing -> return (m, [pkg])
Edward Z. Yang's avatar
Edward Z. Yang committed
660 661
        Just (Module _ m') | m == m'   -> []
                           | otherwise -> return (m', [pkg])
662 663 664 665 666
        -- The heuristic is this: we want to prefer the original package
        -- which originally exported a module.  However, if a reexport
        -- also *renamed* the module (m /= m'), then we have to use the
        -- downstream package, since the upstream package has the wrong
        -- module name!