PackageIndex.hs 20.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
-- 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
  deleteUnitId,
Duncan Coutts's avatar
Duncan Coutts committed
29
  deleteSourcePackageId,
30
  deletePackageName,
Duncan Coutts's avatar
Duncan Coutts committed
31
--  deleteDependency,
32 33 34 35

  -- * Queries

  -- ** Precise lookups
36
  lookupUnitId,
Duncan Coutts's avatar
Duncan Coutts committed
37
  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
  ) where

64 65 66 67 68 69 70 71
import Distribution.Compat.Binary
import Distribution.Compat.Semigroup as Semi
import Distribution.Package
import Distribution.ModuleName
import qualified Distribution.InstalledPackageInfo as IPI
import Distribution.Version
import Distribution.Simple.Utils

72
import Control.Exception (assert)
73
import Data.Array ((!))
ttuegel's avatar
ttuegel committed
74 75
import qualified Data.Array as Array
import qualified Data.Graph as Graph
Duncan Coutts's avatar
Duncan Coutts committed
76
import Data.List as List
77
         ( null, foldl', sort
78
         , groupBy, sortBy, find, nubBy, deleteBy, deleteFirstsBy )
ttuegel's avatar
ttuegel committed
79 80
import Data.Map (Map)
import qualified Data.Map as Map
81
import Data.Maybe (isNothing, fromMaybe)
ttuegel's avatar
ttuegel committed
82 83 84
import qualified Data.Tree  as Tree
import GHC.Generics (Generic)
import Prelude hiding (lookup)
85 86

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

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

111
  deriving (Eq, Generic, Show, Read)
ttuegel's avatar
ttuegel committed
112 113

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

115 116
-- | The default package index which contains 'InstalledPackageInfo'.  Normally
-- use this.
117
type InstalledPackageIndex = PackageIndex IPI.InstalledPackageInfo
118

119
instance HasUnitId a => Monoid (PackageIndex a) where
Duncan Coutts's avatar
Duncan Coutts committed
120
  mempty  = PackageIndex Map.empty Map.empty
121
  mappend = (Semi.<>)
122
  --save one mappend with empty in the common case:
123
  mconcat [] = mempty
124 125
  mconcat xs = foldr1 mappend xs

126
instance HasUnitId a => Semigroup (PackageIndex a) where
127 128
  (<>) = merge

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

145

146 147 148 149
--
-- * Internal helpers
--

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

157 158 159

--
-- * Construction
160 161
--

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

185 186 187 188
--
-- * Updates
--

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

210

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

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

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

    insertPackageInstance pkgs =
233
      pkg : deleteBy (equating installedUnitId) pkg pkgs
Duncan Coutts's avatar
Duncan Coutts committed
234 235 236 237


-- | Removes a single installed package from the index.
--
238 239
deleteUnitId :: HasUnitId a
                         => UnitId -> PackageIndex a
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
240
                         -> PackageIndex a
241
deleteUnitId ipkgid original@(PackageIndex pids pnames) =
Duncan Coutts's avatar
Duncan Coutts committed
242 243 244 245 246
  case Map.updateLookupWithKey (\_ _ -> Nothing) ipkgid pids of
    (Nothing,     _)     -> original
    (Just spkgid, pids') -> mkPackageIndex pids'
                                          (deletePkgName spkgid pnames)

Duncan Coutts's avatar
Duncan Coutts committed
247
  where
Duncan Coutts's avatar
Duncan Coutts committed
248 249 250 251 252 253
    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
254

Duncan Coutts's avatar
Duncan Coutts committed
255 256
    deletePkgInstance =
        (\xs -> if List.null xs then Nothing else Just xs)
257
      . List.deleteBy (\_ pkg -> installedUnitId pkg == ipkgid) undefined
Duncan Coutts's avatar
Duncan Coutts committed
258 259 260


-- | Removes all packages with this source 'PackageId' from the index.
261
--
262
deleteSourcePackageId :: HasUnitId a => PackageId -> PackageIndex a
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
263
                      -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
264 265 266 267 268 269
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
270
                     (foldl' (flip (Map.delete . installedUnitId)) pids pkgs)
Duncan Coutts's avatar
Duncan Coutts committed
271 272 273 274 275 276 277 278 279
                     (deletePkgName pnames)
  where
    deletePkgName =
      Map.update deletePkgVersion (packageName pkgid)

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

280 281 282

-- | Removes all packages with this (case-sensitive) name from the index.
--
283
deletePackageName :: HasUnitId a => PackageName -> PackageIndex a
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
284
                  -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
285 286 287 288
deletePackageName name original@(PackageIndex pids pnames) =
  case Map.lookup name pnames of
    Nothing     -> original
    Just pvers  -> mkPackageIndex
289
                     (foldl' (flip (Map.delete . installedUnitId)) pids
Duncan Coutts's avatar
Duncan Coutts committed
290 291
                             (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 :: HasUnitId a => PackageIndex a
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
324
                             -> [(PackageId, [a])]
325 326 327 328
allPackagesBySourcePackageId (PackageIndex _ pnames) =
  [ (packageId ipkg, ipkgs)
  | pvers <- Map.elems pnames
  , ipkgs@(ipkg:_) <- Map.elems pvers ]
329 330 331 332 333

--
-- * Lookups
--

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

343

Duncan Coutts's avatar
Duncan Coutts committed
344 345 346
-- | Does a lookup by source package id (name & version).
--
-- There can be multiple installed packages with the same source 'PackageId'
347
-- but different 'UnitId'. They are returned in order of
Duncan Coutts's avatar
Duncan Coutts committed
348
-- preference, with the most preferred first.
349
--
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
350
lookupSourcePackageId :: PackageIndex a -> PackageId -> [a]
Duncan Coutts's avatar
Duncan Coutts committed
351 352 353 354 355 356
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
357

358 359
-- | Convenient alias of 'lookupSourcePackageId', but assuming only
-- one package per package ID.
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
360
lookupPackageId :: PackageIndex a -> PackageId -> Maybe a
361 362 363 364
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
365 366 367

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

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

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

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

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

--
-- * Special queries
--

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

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


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

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

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

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

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

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

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

    vertex_to_pkg vertex = pkgTable ! vertex
545 546 547 548 549

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

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

580
        reallyIsInconsistent :: PackageInstalled a => [a] -> Bool
581 582 583
        reallyIsInconsistent []       = False
        reallyIsInconsistent [_p]     = False
        reallyIsInconsistent [p1, p2] =
584 585
          let pid1 = installedUnitId p1
              pid2 = installedUnitId p2
586 587
          in pid1 `notElem` installedDepends p2
          && pid2 `notElem` installedDepends p1
588
        reallyIsInconsistent _ = True
Duncan Coutts's avatar
Duncan Coutts committed
589

Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
590 591 592 593
-- | 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@.
594
moduleNameIndex :: InstalledPackageIndex -> Map ModuleName [IPI.InstalledPackageInfo]
Duncan Coutts's avatar
Duncan Coutts committed
595
moduleNameIndex index =
596 597
  Map.fromListWith (++) $ do
    pkg <- allPackages index
598
    IPI.ExposedModule m reexport <- IPI.exposedModules pkg
599 600 601 602
    case reexport of
        Nothing -> return (m, [pkg])
        Just (IPI.OriginalModule _ m') | m == m'   -> []
                                       | otherwise -> return (m', [pkg])
603 604 605 606 607
        -- 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!