PackageIndex.hs 21.5 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
-- An index of packages.
Duncan Coutts's avatar
Duncan Coutts committed
14
--
15 16
module Distribution.Simple.PackageIndex (
  -- * Package index data type
17
  InstalledPackageIndex,
18
  PackageIndex,
19

20
  -- * Creating an index
21 22
  fromList,

23
  -- * Updates
24
  merge,
Duncan Coutts's avatar
Duncan Coutts committed
25

26
  insert,
Duncan Coutts's avatar
Duncan Coutts committed
27 28 29

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

  -- * Queries

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

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

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

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

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

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

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

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

ttuegel's avatar
ttuegel committed
119 120 121
  deriving (Generic, Show, Read)

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

123 124 125 126 127
-- | 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
128
  mempty  = PackageIndex Map.empty Map.empty
129 130 131 132 133
  mappend = merge
  --save one mappend with empty in the common case:
  mconcat [] = mempty
  mconcat xs = foldr1 mappend xs

134
invariant :: PackageInstalled a => PackageIndex a -> Bool
Duncan Coutts's avatar
Duncan Coutts committed
135 136
invariant (PackageIndex pids pnames) =
     map installedPackageId (Map.elems pids)
137 138
  == sort
     [ assert pinstOk (installedPackageId pinst)
Duncan Coutts's avatar
Duncan Coutts committed
139 140 141 142 143 144 145 146 147 148 149
     | (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
     ]

150

151 152 153 154
--
-- * Internal helpers
--

155 156 157 158
mkPackageIndex :: PackageInstalled a
               => Map InstalledPackageId a
               -> Map PackageName (Map Version [a])
               -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
159 160
mkPackageIndex pids pnames = assert (invariant index) index
  where index = PackageIndex pids pnames
161

162 163 164

--
-- * Construction
165 166
--

167
-- | Build an index out of a bunch of packages.
168
--
Duncan Coutts's avatar
Duncan Coutts committed
169 170
-- If there are duplicates by 'InstalledPackageId' then later ones mask earlier
-- ones.
171
--
172
fromList :: PackageInstalled a => [a] -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
173
fromList pkgs = mkPackageIndex pids pnames
174
  where
Duncan Coutts's avatar
Duncan Coutts committed
175 176 177 178 179 180 181 182 183 184 185 186 187 188
    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
                ]
        ]
189

190 191 192 193
--
-- * Updates
--

194 195
-- | Merge two indexes.
--
Duncan Coutts's avatar
Duncan Coutts committed
196 197
-- Packages from the second mask packages from the first if they have the exact
-- same 'InstalledPackageId'.
198
--
Duncan Coutts's avatar
Duncan Coutts committed
199 200 201 202 203
-- 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.
--
204
merge :: PackageInstalled a => PackageIndex a -> PackageIndex a -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
205
merge (PackageIndex pids1 pnames1) (PackageIndex pids2 pnames2) =
206
  mkPackageIndex (Map.union pids1 pids2)
Duncan Coutts's avatar
Duncan Coutts committed
207 208 209 210 211 212
                 (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)
213

214

Duncan Coutts's avatar
Duncan Coutts committed
215
-- | Inserts a single package into the index.
216 217 218 219
--
-- This is equivalent to (but slightly quicker than) using 'mappend' or
-- 'merge' with a singleton index.
--
220
insert :: PackageInstalled a => a -> PackageIndex a -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
221 222 223
insert pkg (PackageIndex pids pnames) =
    mkPackageIndex pids' pnames'

224
  where
Duncan Coutts's avatar
Duncan Coutts committed
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
    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.
--
242
deleteInstalledPackageId :: PackageInstalled a => InstalledPackageId -> PackageIndex a -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
243 244 245 246 247 248
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
249
  where
Duncan Coutts's avatar
Duncan Coutts committed
250 251 252 253 254 255
    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
256

Duncan Coutts's avatar
Duncan Coutts committed
257 258 259 260 261 262
    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.
263
--
264
deleteSourcePackageId :: PackageInstalled a => PackageId -> PackageIndex a -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
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)

281 282 283

-- | Removes all packages with this (case-sensitive) name from the index.
--
284
deletePackageName :: PackageInstalled a => PackageName -> PackageIndex a -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
285 286 287 288 289 290 291
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)
292

Duncan Coutts's avatar
Duncan Coutts committed
293
{-
294 295
-- | Removes all packages satisfying this dependency from the index.
--
Duncan Coutts's avatar
Duncan Coutts committed
296
deleteDependency :: Dependency -> PackageIndex -> PackageIndex
297
deleteDependency (Dependency name verstionRange) =
Duncan Coutts's avatar
Duncan Coutts committed
298 299
  delete' name (\pkg -> packageVersion pkg `withinRange` verstionRange)
-}
300

301 302 303 304
--
-- * Bulk queries
--

305 306
-- | Get all the packages from the index.
--
307
allPackages :: PackageIndex a -> [a]
Duncan Coutts's avatar
Duncan Coutts committed
308
allPackages (PackageIndex pids _) = Map.elems pids
309 310 311

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

--
-- * Lookups
--

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

342

Duncan Coutts's avatar
Duncan Coutts committed
343 344 345 346 347
-- | 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.
348
--
349
lookupSourcePackageId :: PackageInstalled a => PackageIndex a -> PackageId -> [a]
Duncan Coutts's avatar
Duncan Coutts committed
350 351 352 353 354 355
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
356

357 358 359 360 361 362 363
-- | 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
364 365 366

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

--
-- * Case insensitive name lookups
--
392 393 394

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

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.
--
422
searchByNameSubstring :: PackageInstalled a => PackageIndex a -> String -> [a]
Duncan Coutts's avatar
Duncan Coutts committed
423
searchByNameSubstring (PackageIndex _ pnames) searchterm =
424
  [ pkg
Duncan Coutts's avatar
Duncan Coutts committed
425
  | (PackageName name, pvers) <- Map.toList pnames
426
  , lsearchterm `isInfixOf` lowercase name
Duncan Coutts's avatar
Duncan Coutts committed
427
  , pkgs <- Map.elems pvers
428
  , pkg <- pkgs ]
429
  where lsearchterm = lowercase searchterm
430

Duncan Coutts's avatar
Duncan Coutts committed
431 432 433 434 435 436 437 438

--
-- * Special queries
--

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

439 440 441 442 443 444 445
-- | 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.
--
446
dependencyCycles :: PackageInstalled a => PackageIndex a -> [[a]]
447
dependencyCycles index =
448 449
  [ vs | Graph.CyclicSCC vs <- Graph.stronglyConnComp adjacencyList ]
  where
450
    adjacencyList = [ (pkg, installedPackageId pkg, installedDepends pkg)
451 452 453
                    | pkg <- allPackages index ]


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

466

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

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

505
  where
506
    (depGraph, vertexToPkg, pkgIdToVertex) = dependencyGraph index
507 508 509
    reverseDepGraph = Graph.transposeG depGraph
    noSuchPkgId = error "reverseDependencyClosure: package is not in the graph"

510
topologicalOrder :: PackageInstalled a => PackageIndex a -> [a]
511 512 513 514 515
topologicalOrder index = map toPkgId
                       . Graph.topSort
                       $ graph
  where (graph, toPkgId, _) = dependencyGraph index

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

Duncan Coutts's avatar
Duncan Coutts committed
538
    pkgs             = sortBy (comparing packageId) (allPackages index)
539 540
    vertices         = zip (map installedPackageId pkgs) [0..]
    vertex_map       = Map.fromList vertices
541
    id_to_vertex pid = Map.lookup pid vertex_map
542 543

    vertex_to_pkg vertex = pkgTable ! vertex
544 545 546 547 548

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

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

579
        reallyIsInconsistent :: PackageInstalled a => [a] -> Bool
580 581 582
        reallyIsInconsistent []       = False
        reallyIsInconsistent [_p]     = False
        reallyIsInconsistent [p1, p2] =
583 584
             installedPackageId p1 `notElem` installedDepends p2
          && installedPackageId p2 `notElem` installedDepends p1
585
        reallyIsInconsistent _ = True
Duncan Coutts's avatar
Duncan Coutts committed
586 587


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