PackageIndex.hs 21.3 KB
Newer Older
1 2
-----------------------------------------------------------------------------
-- |
3
-- Module      :  Distribution.Simple.PackageIndex
4 5
-- Copyright   :  (c) David Himmelstrup 2005,
--                    Bjorn Bringert 2007,
Duncan Coutts's avatar
Duncan Coutts committed
6
--                    Duncan Coutts 2008-2009
7
--
Duncan Coutts's avatar
Duncan Coutts committed
8
-- Maintainer  :  cabal-devel@haskell.org
9 10
-- Portability :  portable
--
11
-- An index of packages.
Duncan Coutts's avatar
Duncan Coutts committed
12
--
13 14
module Distribution.Simple.PackageIndex (
  -- * Package index data type
15
  InstalledPackageIndex,
16
  PackageIndex,
17

18
  -- * Creating an index
19 20
  fromList,

21
  -- * Updates
22
  merge,
Duncan Coutts's avatar
Duncan Coutts committed
23

24
  insert,
Duncan Coutts's avatar
Duncan Coutts committed
25 26 27

  deleteInstalledPackageId,
  deleteSourcePackageId,
28
  deletePackageName,
Duncan Coutts's avatar
Duncan Coutts committed
29
--  deleteDependency,
30 31 32 33

  -- * Queries

  -- ** Precise lookups
Duncan Coutts's avatar
Duncan Coutts committed
34 35
  lookupInstalledPackageId,
  lookupSourcePackageId,
36
  lookupPackageId,
37
  lookupPackageName,
38 39 40 41 42 43 44 45 46 47
  lookupDependency,

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

  -- ** Bulk queries
  allPackages,
  allPackagesByName,
48
  allPackagesBySourcePackageId,
49 50 51 52 53 54 55 56 57 58

  -- ** Special queries
  brokenPackages,
  dependencyClosure,
  reverseDependencyClosure,
  topologicalOrder,
  reverseTopologicalOrder,
  dependencyInconsistencies,
  dependencyCycles,
  dependencyGraph,
Duncan Coutts's avatar
Duncan Coutts committed
59
  moduleNameIndex,
60 61 62 63 64 65
  ) where

import Prelude hiding (lookup)
import Control.Exception (assert)
import qualified Data.Map as Map
import Data.Map (Map)
66 67 68 69
import qualified Data.Tree  as Tree
import qualified Data.Graph as Graph
import qualified Data.Array as Array
import Data.Array ((!))
Duncan Coutts's avatar
Duncan Coutts committed
70
import Data.List as List
71
         ( null, foldl', sort
Duncan Coutts's avatar
Duncan Coutts committed
72
         , groupBy, sortBy, find, isInfixOf, nubBy, deleteBy, deleteFirstsBy )
73
import Data.Monoid (Monoid(..))
74
import Data.Maybe (isNothing, fromMaybe)
75

76
import Distribution.Package
Duncan Coutts's avatar
Duncan Coutts committed
77
         ( PackageName(..), PackageId
78
         , Package(..), packageName, packageVersion
Duncan Coutts's avatar
Duncan Coutts committed
79
         , Dependency(Dependency)--, --PackageFixedDeps(..)
80
         , InstalledPackageId(..), PackageInstalled(..) )
Duncan Coutts's avatar
Duncan Coutts committed
81 82
import Distribution.ModuleName
         ( ModuleName )
83
import Distribution.InstalledPackageInfo
84
         ( InstalledPackageInfo )
85
import qualified Distribution.InstalledPackageInfo as IPI
86
import Distribution.Version
87
         ( Version, withinRange )
Duncan Coutts's avatar
Duncan Coutts committed
88
import Distribution.Simple.Utils (lowercase, comparing, equating)
89 90

-- | The collection of information about packages from one or more 'PackageDB's.
91
-- These packages generally should have an instance of 'PackageInstalled'
92
--
Duncan Coutts's avatar
Duncan Coutts committed
93
-- Packages are uniquely identified in by their 'InstalledPackageId', they can
Ian D. Bollinger's avatar
Ian D. Bollinger committed
94
-- also be efficiently looked up by package name or by name and version.
95
--
96
data PackageIndex a = PackageIndex
Duncan Coutts's avatar
Duncan Coutts committed
97 98 99
  -- The primary index. Each InstalledPackageInfo record is uniquely identified
  -- by its InstalledPackageId.
  --
100
  !(Map InstalledPackageId a)
Duncan Coutts's avatar
Duncan Coutts committed
101

Ian D. Bollinger's avatar
Ian D. Bollinger committed
102
  -- This auxiliary index maps package names (case-sensitively) to all the
Duncan Coutts's avatar
Duncan Coutts committed
103 104
  -- versions and instances of that package. This allows us to find all
  -- versions satisfying a dependency.
105
  --
Duncan Coutts's avatar
Duncan Coutts committed
106 107 108 109
  -- 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
  -- of the same package version. These are unique by InstalledPackageId
  -- and are kept in preference order.
110
  --
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
111 112
  -- FIXME: Clarify what "preference order" means. Check that this invariant is
  -- preserved. See #1463 for discussion.
113
  !(Map PackageName (Map Version [a]))
114 115

  deriving (Show, Read)
Duncan Coutts's avatar
Duncan Coutts committed
116

117 118 119 120 121
-- | The default package index which contains 'InstalledPackageInfo'.  Normally
-- use this.
type InstalledPackageIndex = PackageIndex InstalledPackageInfo

instance PackageInstalled a => Monoid (PackageIndex a) where
Duncan Coutts's avatar
Duncan Coutts committed
122
  mempty  = PackageIndex Map.empty Map.empty
123 124 125 126 127
  mappend = merge
  --save one mappend with empty in the common case:
  mconcat [] = mempty
  mconcat xs = foldr1 mappend xs

128
invariant :: PackageInstalled a => PackageIndex a -> Bool
Duncan Coutts's avatar
Duncan Coutts committed
129 130
invariant (PackageIndex pids pnames) =
     map installedPackageId (Map.elems pids)
131 132
  == sort
     [ assert pinstOk (installedPackageId pinst)
Duncan Coutts's avatar
Duncan Coutts committed
133 134 135 136 137 138 139 140 141 142 143
     | (pname, pvers)  <- Map.toList pnames
     , let pversOk = not (Map.null pvers)
     , (pver,  pinsts) <- assert pversOk $ Map.toList pvers
     , let pinsts'  = sortBy (comparing installedPackageId) pinsts
           pinstsOk = all (\g -> length g == 1)
                          (groupBy (equating installedPackageId) pinsts')
     , pinst           <- assert pinstsOk $ pinsts'
     , let pinstOk = packageName    pinst == pname
                  && packageVersion pinst == pver
     ]

144

145 146 147 148
--
-- * Internal helpers
--

149 150 151 152
mkPackageIndex :: PackageInstalled a
               => Map InstalledPackageId a
               -> Map PackageName (Map Version [a])
               -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
153 154
mkPackageIndex pids pnames = assert (invariant index) index
  where index = PackageIndex pids pnames
155

156 157 158

--
-- * Construction
159 160
--

161
-- | Build an index out of a bunch of packages.
162
--
Duncan Coutts's avatar
Duncan Coutts committed
163 164
-- If there are duplicates by 'InstalledPackageId' then later ones mask earlier
-- ones.
165
--
166
fromList :: PackageInstalled a => [a] -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
167
fromList pkgs = mkPackageIndex pids pnames
168
  where
Duncan Coutts's avatar
Duncan Coutts committed
169 170 171 172 173 174 175 176 177 178 179 180 181 182
    pids      = Map.fromList [ (installedPackageId pkg, pkg) | pkg <- pkgs ]
    pnames    =
      Map.fromList
        [ (packageName (head pkgsN), pvers)
        | pkgsN <- groupBy (equating  packageName)
                 . sortBy  (comparing packageId)
                 $ pkgs
        , let pvers =
                Map.fromList
                [ (packageVersion (head pkgsNV),
                   nubBy (equating installedPackageId) (reverse pkgsNV))
                | pkgsNV <- groupBy (equating packageVersion) pkgsN
                ]
        ]
183

184 185 186 187
--
-- * Updates
--

188 189
-- | Merge two indexes.
--
Duncan Coutts's avatar
Duncan Coutts committed
190 191
-- Packages from the second mask packages from the first if they have the exact
-- same 'InstalledPackageId'.
192
--
Duncan Coutts's avatar
Duncan Coutts committed
193 194 195 196 197
-- 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.
--
198
merge :: PackageInstalled a => PackageIndex a -> PackageIndex a -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
199 200 201 202 203 204 205 206
merge (PackageIndex pids1 pnames1) (PackageIndex pids2 pnames2) =
  mkPackageIndex (Map.union pids1 pids2)
                 (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)
    (\\) = deleteFirstsBy (equating installedPackageId)
207

208

Duncan Coutts's avatar
Duncan Coutts committed
209
-- | Inserts a single package into the index.
210 211 212 213
--
-- This is equivalent to (but slightly quicker than) using 'mappend' or
-- 'merge' with a singleton index.
--
214
insert :: PackageInstalled a => a -> PackageIndex a -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
215 216 217
insert pkg (PackageIndex pids pnames) =
    mkPackageIndex pids' pnames'

218
  where
Duncan Coutts's avatar
Duncan Coutts committed
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
    pids'   = Map.insert (installedPackageId pkg) pkg pids
    pnames' = insertPackageName pnames
    insertPackageName =
      Map.insertWith' (\_ -> insertPackageVersion)
                     (packageName pkg)
                     (Map.singleton (packageVersion pkg) [pkg])

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

    insertPackageInstance pkgs =
      pkg : deleteBy (equating installedPackageId) pkg pkgs


-- | Removes a single installed package from the index.
--
236
deleteInstalledPackageId :: PackageInstalled a => InstalledPackageId -> PackageIndex a -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
237 238 239 240 241 242
deleteInstalledPackageId ipkgid original@(PackageIndex pids pnames) =
  case Map.updateLookupWithKey (\_ _ -> Nothing) ipkgid pids of
    (Nothing,     _)     -> original
    (Just spkgid, pids') -> mkPackageIndex pids'
                                          (deletePkgName spkgid pnames)

Duncan Coutts's avatar
Duncan Coutts committed
243
  where
Duncan Coutts's avatar
Duncan Coutts committed
244 245 246 247 248 249
    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
250

Duncan Coutts's avatar
Duncan Coutts committed
251 252 253 254 255 256
    deletePkgInstance =
        (\xs -> if List.null xs then Nothing else Just xs)
      . List.deleteBy (\_ pkg -> installedPackageId pkg == ipkgid) undefined


-- | Removes all packages with this source 'PackageId' from the index.
257
--
258
deleteSourcePackageId :: PackageInstalled a => PackageId -> PackageIndex a -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
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
                     (foldl' (flip (Map.delete . installedPackageId)) pids pkgs)
                     (deletePkgName pnames)
  where
    deletePkgName =
      Map.update deletePkgVersion (packageName pkgid)

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

275 276 277

-- | Removes all packages with this (case-sensitive) name from the index.
--
278
deletePackageName :: PackageInstalled a => PackageName -> PackageIndex a -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
279 280 281 282 283 284 285
deletePackageName name original@(PackageIndex pids pnames) =
  case Map.lookup name pnames of
    Nothing     -> original
    Just pvers  -> mkPackageIndex
                     (foldl' (flip (Map.delete . installedPackageId)) pids
                             (concat (Map.elems pvers)))
                     (Map.delete name pnames)
286

Duncan Coutts's avatar
Duncan Coutts committed
287
{-
288 289
-- | Removes all packages satisfying this dependency from the index.
--
Duncan Coutts's avatar
Duncan Coutts committed
290
deleteDependency :: Dependency -> PackageIndex -> PackageIndex
291
deleteDependency (Dependency name verstionRange) =
Duncan Coutts's avatar
Duncan Coutts committed
292 293
  delete' name (\pkg -> packageVersion pkg `withinRange` verstionRange)
-}
294

295 296 297 298
--
-- * Bulk queries
--

299 300
-- | Get all the packages from the index.
--
301
allPackages :: PackageIndex a -> [a]
Duncan Coutts's avatar
Duncan Coutts committed
302
allPackages (PackageIndex pids _) = Map.elems pids
303 304 305

-- | Get all the packages from the index.
--
306
-- They are grouped by package name (case-sensitively).
307
--
308
allPackagesByName :: PackageIndex a -> [(PackageName, [a])]
Duncan Coutts's avatar
Duncan Coutts committed
309
allPackagesByName (PackageIndex _ pnames) =
310 311 312 313 314 315 316
  [ (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).
--
317
allPackagesBySourcePackageId :: PackageInstalled a => PackageIndex a -> [(PackageId, [a])]
318 319 320 321
allPackagesBySourcePackageId (PackageIndex _ pnames) =
  [ (packageId ipkg, ipkgs)
  | pvers <- Map.elems pnames
  , ipkgs@(ipkg:_) <- Map.elems pvers ]
322 323 324 325 326

--
-- * Lookups
--

Duncan Coutts's avatar
Duncan Coutts committed
327
-- | Does a lookup by source package id (name & version).
328
--
Duncan Coutts's avatar
Duncan Coutts committed
329
-- Since multiple package DBs mask each other by 'InstalledPackageId',
330 331
-- then we get back at most one package.
--
332 333
lookupInstalledPackageId :: PackageInstalled a => PackageIndex a -> InstalledPackageId
                         -> Maybe a
Duncan Coutts's avatar
Duncan Coutts committed
334 335
lookupInstalledPackageId (PackageIndex pids _) pid = Map.lookup pid pids

336

Duncan Coutts's avatar
Duncan Coutts committed
337 338 339 340 341
-- | Does a lookup by source package id (name & version).
--
-- There can be multiple installed packages with the same source 'PackageId'
-- but different 'InstalledPackageId'. They are returned in order of
-- preference, with the most preferred first.
342
--
343
lookupSourcePackageId :: PackageInstalled a => PackageIndex a -> PackageId -> [a]
Duncan Coutts's avatar
Duncan Coutts committed
344 345 346 347 348 349
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
350

351 352 353 354 355 356 357
-- | Convenient alias of 'lookupSourcePackageId', but assuming only
-- one package per package ID.
lookupPackageId :: PackageInstalled a => PackageIndex a -> PackageId -> Maybe a
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
358 359 360

-- | Does a lookup by source package name.
--
361 362
lookupPackageName :: PackageInstalled a => PackageIndex a -> PackageName
                  -> [(Version, [a])]
Duncan Coutts's avatar
Duncan Coutts committed
363 364 365 366 367 368 369
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.
370 371 372 373
--
-- We get back any number of versions of the specified package name, all
-- satisfying the version range constraint.
--
374 375
lookupDependency :: PackageInstalled a => PackageIndex a -> Dependency
                 -> [(Version, [a])]
Duncan Coutts's avatar
Duncan Coutts committed
376 377 378 379 380 381
lookupDependency (PackageIndex _ pnames) (Dependency name versionRange) =
  case Map.lookup name pnames of
    Nothing    -> []
    Just pvers -> [ entry
                  | entry@(ver, _) <- Map.toList pvers
                  , ver `withinRange` versionRange ]
382 383 384 385

--
-- * Case insensitive name lookups
--
386 387 388

-- | Does a case-insensitive search by package name.
--
Ian D. Bollinger's avatar
Ian D. Bollinger committed
389
-- If there is only one package that compares case-insensitively to this name
390
-- then the search is unambiguous and we get back all versions of that package.
Ian D. Bollinger's avatar
Ian D. Bollinger committed
391
-- If several match case-insensitively but one matches exactly then it is also
392 393
-- unambiguous.
--
Ian D. Bollinger's avatar
Ian D. Bollinger committed
394
-- If however several match case-insensitively and none match exactly then we
395 396 397 398
-- 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.
--
399
searchByName :: PackageInstalled a => PackageIndex a -> String -> SearchResult [a]
Duncan Coutts's avatar
Duncan Coutts committed
400 401
searchByName (PackageIndex _ pnames) name =
  case [ pkgs | pkgs@(PackageName name',_) <- Map.toList pnames
402
              , lowercase name' == lname ] of
Duncan Coutts's avatar
Duncan Coutts committed
403 404 405 406 407
    []               -> 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)
408
  where lname = lowercase name
409 410 411 412 413 414 415

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.
--
416
searchByNameSubstring :: PackageInstalled a => PackageIndex a -> String -> [a]
Duncan Coutts's avatar
Duncan Coutts committed
417
searchByNameSubstring (PackageIndex _ pnames) searchterm =
418
  [ pkg
Duncan Coutts's avatar
Duncan Coutts committed
419
  | (PackageName name, pvers) <- Map.toList pnames
420
  , lsearchterm `isInfixOf` lowercase name
Duncan Coutts's avatar
Duncan Coutts committed
421
  , pkgs <- Map.elems pvers
422
  , pkg <- pkgs ]
423
  where lsearchterm = lowercase searchterm
424

Duncan Coutts's avatar
Duncan Coutts committed
425 426 427 428 429 430 431 432

--
-- * Special queries
--

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

433 434 435 436 437 438 439
-- | 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.
--
440
dependencyCycles :: PackageInstalled a => PackageIndex a -> [[a]]
441 442 443
dependencyCycles index =
  [ vs | Graph.CyclicSCC vs <- Graph.stronglyConnComp adjacencyList ]
  where
444
    adjacencyList = [ (pkg, installedPackageId pkg, installedDepends pkg)
445 446 447
                    | pkg <- allPackages index ]


Duncan Coutts's avatar
Duncan Coutts committed
448
-- | All packages that have immediate dependencies that are not in the index.
449
--
450 451
-- Returns such packages along with the dependencies that they're missing.
--
452
brokenPackages :: PackageInstalled a => PackageIndex a -> [(a, [InstalledPackageId])]
453 454
brokenPackages index =
  [ (pkg, missing)
Duncan Coutts's avatar
Duncan Coutts committed
455
  | pkg  <- allPackages index
456
  , let missing = [ pkg' | pkg' <- installedDepends pkg
Duncan Coutts's avatar
Duncan Coutts committed
457
                         , isNothing (lookupInstalledPackageId index pkg') ]
458 459
  , not (null missing) ]

460

461
-- | Tries to take the transitive closure of the package dependencies.
462
--
463
-- If the transitive closure is complete then it returns that subset of the
464 465 466
-- 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
467
-- the original given 'PackageId's do not occur in the index.
468
--
469
dependencyClosure :: PackageInstalled a => PackageIndex a
470
                  -> [InstalledPackageId]
471 472
                  -> Either (PackageIndex a)
                            [(a, [InstalledPackageId])]
473 474 475
dependencyClosure index pkgids0 = case closure mempty [] pkgids0 of
  (completed, []) -> Left completed
  (completed, _)  -> Right (brokenPackages completed)
476
 where
477
    closure completed failed []             = (completed, failed)
Duncan Coutts's avatar
Duncan Coutts committed
478
    closure completed failed (pkgid:pkgids) = case lookupInstalledPackageId index pkgid of
479
      Nothing   -> closure completed (pkgid:failed) pkgids
Duncan Coutts's avatar
Duncan Coutts committed
480
      Just pkg  -> case lookupInstalledPackageId completed (installedPackageId pkg) of
481 482
        Just _  -> closure completed  failed pkgids
        Nothing -> closure completed' failed pkgids'
Duncan Coutts's avatar
Duncan Coutts committed
483
          where completed' = insert pkg completed
484
                pkgids'    = installedDepends pkg ++ pkgids
485

486
-- | Takes the transitive closure of the packages reverse dependencies.
487
--
Duncan Coutts's avatar
Duncan Coutts committed
488
-- * The given 'PackageId's must be in the index.
489
--
490
reverseDependencyClosure :: PackageInstalled a => PackageIndex a
491
                         -> [InstalledPackageId]
492
                         -> [a]
493 494 495 496 497
reverseDependencyClosure index =
    map vertexToPkg
  . concatMap Tree.flatten
  . Graph.dfs reverseDepGraph
  . map (fromMaybe noSuchPkgId . pkgIdToVertex)
498

499 500 501 502 503
  where
    (depGraph, vertexToPkg, pkgIdToVertex) = dependencyGraph index
    reverseDepGraph = Graph.transposeG depGraph
    noSuchPkgId = error "reverseDependencyClosure: package is not in the graph"

504
topologicalOrder :: PackageInstalled a => PackageIndex a -> [a]
505 506 507 508 509
topologicalOrder index = map toPkgId
                       . Graph.topSort
                       $ graph
  where (graph, toPkgId, _) = dependencyGraph index

510
reverseTopologicalOrder :: PackageInstalled a => PackageIndex a -> [a]
511 512 513 514 515 516 517 518 519 520 521
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'.
--
522
dependencyGraph :: PackageInstalled a => PackageIndex a
523
                -> (Graph.Graph,
524
                    Graph.Vertex -> a,
525 526
                    InstalledPackageId -> Maybe Graph.Vertex)
dependencyGraph index = (graph, vertex_to_pkg, id_to_vertex)
527 528
  where
    graph = Array.listArray bounds
529
              [ [ v | Just v <- map id_to_vertex (installedDepends pkg) ]
530
              | pkg <- pkgs ]
531

Duncan Coutts's avatar
Duncan Coutts committed
532
    pkgs             = sortBy (comparing packageId) (allPackages index)
533 534 535 536 537
    vertices         = zip (map installedPackageId pkgs) [0..]
    vertex_map       = Map.fromList vertices
    id_to_vertex pid = Map.lookup pid vertex_map

    vertex_to_pkg vertex = pkgTable ! vertex
538 539 540 541 542

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

543 544 545 546 547 548 549 550 551 552
-- | 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.
--
553
dependencyInconsistencies :: PackageInstalled a => PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
554
                          -> [(PackageName, [(PackageId, Version)])]
555 556 557 558 559 560 561 562 563 564 565 566 567
dependencyInconsistencies index =
  [ (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
568
          | pkg <- allPackages index
569
          , ipid <- installedDepends pkg
Duncan Coutts's avatar
Duncan Coutts committed
570
          , Just dep <- [lookupInstalledPackageId index ipid]
571 572
          ]

573
        reallyIsInconsistent :: PackageInstalled a => [a] -> Bool
574 575 576
        reallyIsInconsistent []       = False
        reallyIsInconsistent [_p]     = False
        reallyIsInconsistent [p1, p2] =
577 578
             installedPackageId p1 `notElem` installedDepends p2
          && installedPackageId p2 `notElem` installedDepends p1
579
        reallyIsInconsistent _ = True
Duncan Coutts's avatar
Duncan Coutts committed
580 581


582
-- | A rough approximation of GHC's module finder, takes a 'InstalledPackageIndex' and
583 584
-- turns it into a map from module names to their source packages.  It's used to
-- initialize the @build-deps@ field in @cabal init@.
585
moduleNameIndex :: InstalledPackageIndex -> Map ModuleName [InstalledPackageInfo]
Duncan Coutts's avatar
Duncan Coutts committed
586
moduleNameIndex index =
587 588
  Map.fromListWith (++) . concat $
    [ [(m,  [pkg]) | m <- IPI.exposedModules pkg ] ++
589 590 591 592
      [(m', [pkg]) | IPI.ModuleReexport {
                       IPI.moduleReexportDefiningName = m,
                       IPI.moduleReexportName         = m'
                     } <- IPI.reexportedModules pkg
593 594 595 596 597 598 599
                   , m /= m' ]
        -- 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!
    | pkg        <- allPackages index ]