PackageIndex.hs 24 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 114 115 116 117 118
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

119
import Control.Exception (assert)
120
import Data.Array ((!))
ttuegel's avatar
ttuegel committed
121 122
import qualified Data.Array as Array
import qualified Data.Graph as Graph
Duncan Coutts's avatar
Duncan Coutts committed
123
import Data.List as List
124
         ( null, foldl', sort
125
         , groupBy, sortBy, find, nubBy, deleteBy, deleteFirstsBy )
ttuegel's avatar
ttuegel committed
126 127
import Data.Map (Map)
import qualified Data.Map as Map
128
import Data.Maybe (isNothing, fromMaybe)
ttuegel's avatar
ttuegel committed
129 130 131
import qualified Data.Tree  as Tree
import GHC.Generics (Generic)
import Prelude hiding (lookup)
132 133

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

Ian D. Bollinger's avatar
Ian D. Bollinger committed
145
  -- This auxiliary index maps package names (case-sensitively) to all the
Duncan Coutts's avatar
Duncan Coutts committed
146 147
  -- versions and instances of that package. This allows us to find all
  -- versions satisfying a dependency.
148
  --
Duncan Coutts's avatar
Duncan Coutts committed
149 150
  -- 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
151
  -- of the same package version. These are unique by UnitId
Duncan Coutts's avatar
Duncan Coutts committed
152
  -- and are kept in preference order.
153
  --
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
154 155
  -- FIXME: Clarify what "preference order" means. Check that this invariant is
  -- preserved. See #1463 for discussion.
156
  !(Map PackageName (Map Version [a]))
157

158
  deriving (Eq, Generic, Show, Read)
ttuegel's avatar
ttuegel committed
159 160

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

162 163
-- | The default package index which contains 'InstalledPackageInfo'.  Normally
-- use this.
164
type InstalledPackageIndex = PackageIndex IPI.InstalledPackageInfo
165

166
instance HasUnitId a => Monoid (PackageIndex a) where
Duncan Coutts's avatar
Duncan Coutts committed
167
  mempty  = PackageIndex Map.empty Map.empty
168
  mappend = (Semi.<>)
169
  --save one mappend with empty in the common case:
170
  mconcat [] = mempty
171 172
  mconcat xs = foldr1 mappend xs

173
instance HasUnitId a => Semigroup (PackageIndex a) where
174 175
  (<>) = merge

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

192

193 194 195 196
--
-- * Internal helpers
--

197 198
mkPackageIndex :: HasUnitId a
               => Map UnitId a
199 200
               -> Map PackageName (Map Version [a])
               -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
201 202
mkPackageIndex pids pnames = assert (invariant index) index
  where index = PackageIndex pids pnames
203

204 205 206

--
-- * Construction
207 208
--

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

232 233 234 235
--
-- * Updates
--

236 237
-- | Merge two indexes.
--
Duncan Coutts's avatar
Duncan Coutts committed
238
-- Packages from the second mask packages from the first if they have the exact
239
-- same 'UnitId'.
240
--
Duncan Coutts's avatar
Duncan Coutts committed
241 242 243 244 245
-- 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.
--
246
merge :: HasUnitId a => PackageIndex a -> PackageIndex a
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
247
      -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
248
merge (PackageIndex pids1 pnames1) (PackageIndex pids2 pnames2) =
249
  mkPackageIndex (Map.unionWith (\_ y -> y) pids1 pids2)
Duncan Coutts's avatar
Duncan Coutts committed
250 251 252 253 254
                 (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)
255
    (\\) = deleteFirstsBy (equating installedUnitId)
256

257

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

267
  where
268
    pids'   = Map.insert (installedUnitId pkg) pkg pids
Duncan Coutts's avatar
Duncan Coutts committed
269 270 271 272 273 274 275 276 277 278 279
    pnames' = insertPackageName pnames
    insertPackageName =
      Map.insertWith' (\_ -> insertPackageVersion)
                     (packageName pkg)
                     (Map.singleton (packageVersion pkg) [pkg])

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

    insertPackageInstance pkgs =
280
      pkg : deleteBy (equating installedUnitId) pkg pkgs
Duncan Coutts's avatar
Duncan Coutts committed
281 282 283 284


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

Duncan Coutts's avatar
Duncan Coutts committed
294
  where
Duncan Coutts's avatar
Duncan Coutts committed
295 296 297 298 299 300
    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
301

Duncan Coutts's avatar
Duncan Coutts committed
302 303
    deletePkgInstance =
        (\xs -> if List.null xs then Nothing else Just xs)
304
      . List.deleteBy (\_ pkg -> installedUnitId pkg == ipkgid) undefined
Duncan Coutts's avatar
Duncan Coutts committed
305

Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
306
-- | Backwards compatibility wrapper for Cabal pre-1.24.
307 308 309 310 311
{-# DEPRECATED deleteInstalledPackageId "Use deleteUnitId instead" #-}
deleteInstalledPackageId :: HasUnitId a
                         => UnitId -> PackageIndex a
                         -> PackageIndex a
deleteInstalledPackageId = deleteUnitId
Duncan Coutts's avatar
Duncan Coutts committed
312 313

-- | Removes all packages with this source 'PackageId' from the index.
314
--
315
deleteSourcePackageId :: HasUnitId a => PackageId -> PackageIndex a
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
316
                      -> PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
317 318 319 320 321 322
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
323
                     (foldl' (flip (Map.delete . installedUnitId)) pids pkgs)
Duncan Coutts's avatar
Duncan Coutts committed
324 325 326 327 328 329 330 331 332
                     (deletePkgName pnames)
  where
    deletePkgName =
      Map.update deletePkgVersion (packageName pkgid)

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

333 334 335

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

Duncan Coutts's avatar
Duncan Coutts committed
346
{-
347 348
-- | Removes all packages satisfying this dependency from the index.
--
Duncan Coutts's avatar
Duncan Coutts committed
349
deleteDependency :: Dependency -> PackageIndex -> PackageIndex
350
deleteDependency (Dependency name verstionRange) =
Duncan Coutts's avatar
Duncan Coutts committed
351 352
  delete' name (\pkg -> packageVersion pkg `withinRange` verstionRange)
-}
353

354 355 356 357
--
-- * Bulk queries
--

358 359
-- | Get all the packages from the index.
--
360
allPackages :: PackageIndex a -> [a]
Duncan Coutts's avatar
Duncan Coutts committed
361
allPackages (PackageIndex pids _) = Map.elems pids
362 363 364

-- | Get all the packages from the index.
--
365
-- They are grouped by package name (case-sensitively).
366
--
367
allPackagesByName :: PackageIndex a -> [(PackageName, [a])]
Duncan Coutts's avatar
Duncan Coutts committed
368
allPackagesByName (PackageIndex _ pnames) =
369 370 371 372 373 374 375
  [ (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).
--
376
allPackagesBySourcePackageId :: HasUnitId a => PackageIndex a
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
377
                             -> [(PackageId, [a])]
378 379 380 381
allPackagesBySourcePackageId (PackageIndex _ pnames) =
  [ (packageId ipkg, ipkgs)
  | pvers <- Map.elems pnames
  , ipkgs@(ipkg:_) <- Map.elems pvers ]
382 383 384 385 386

--
-- * Lookups
--

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

Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
396
-- | Backwards compatibility for Cabal pre-1.24.
397 398 399 400 401
{-# DEPRECATED lookupInstalledPackageId "Use lookupUnitId instead" #-}
lookupInstalledPackageId :: PackageIndex a -> UnitId
                         -> Maybe a
lookupInstalledPackageId = lookupUnitId

402

Duncan Coutts's avatar
Duncan Coutts committed
403 404 405
-- | Does a lookup by source package id (name & version).
--
-- There can be multiple installed packages with the same source 'PackageId'
406
-- but different 'UnitId'. They are returned in order of
Duncan Coutts's avatar
Duncan Coutts committed
407
-- preference, with the most preferred first.
408
--
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
409
lookupSourcePackageId :: PackageIndex a -> PackageId -> [a]
Duncan Coutts's avatar
Duncan Coutts committed
410 411 412 413 414 415
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
416

417 418
-- | Convenient alias of 'lookupSourcePackageId', but assuming only
-- one package per package ID.
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
419
lookupPackageId :: PackageIndex a -> PackageId -> Maybe a
420 421 422 423
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
424 425 426

-- | Does a lookup by source package name.
--
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
427
lookupPackageName :: PackageIndex a -> PackageName
428
                  -> [(Version, [a])]
Duncan Coutts's avatar
Duncan Coutts committed
429 430 431 432 433 434 435
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.
436 437 438 439
--
-- 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
440
lookupDependency :: PackageIndex a -> Dependency
441
                 -> [(Version, [a])]
Duncan Coutts's avatar
Duncan Coutts committed
442 443 444 445 446 447
lookupDependency (PackageIndex _ pnames) (Dependency name versionRange) =
  case Map.lookup name pnames of
    Nothing    -> []
    Just pvers -> [ entry
                  | entry@(ver, _) <- Map.toList pvers
                  , ver `withinRange` versionRange ]
448 449 450 451

--
-- * Case insensitive name lookups
--
452 453 454

-- | Does a case-insensitive search by package name.
--
Ian D. Bollinger's avatar
Ian D. Bollinger committed
455
-- If there is only one package that compares case-insensitively to this name
456
-- then the search is unambiguous and we get back all versions of that package.
Ian D. Bollinger's avatar
Ian D. Bollinger committed
457
-- If several match case-insensitively but one matches exactly then it is also
458 459
-- unambiguous.
--
Ian D. Bollinger's avatar
Ian D. Bollinger committed
460
-- If however several match case-insensitively and none match exactly then we
461 462 463 464
-- 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
465
searchByName :: PackageIndex a -> String -> SearchResult [a]
Duncan Coutts's avatar
Duncan Coutts committed
466 467
searchByName (PackageIndex _ pnames) name =
  case [ pkgs | pkgs@(PackageName name',_) <- Map.toList pnames
468
              , lowercase name' == lname ] of
Duncan Coutts's avatar
Duncan Coutts committed
469 470 471 472 473
    []               -> 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)
474
  where lname = lowercase name
475 476 477 478 479 480 481

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
482
searchByNameSubstring :: PackageIndex a -> String -> [a]
Duncan Coutts's avatar
Duncan Coutts committed
483
searchByNameSubstring (PackageIndex _ pnames) searchterm =
484
  [ pkg
Duncan Coutts's avatar
Duncan Coutts committed
485
  | (PackageName name, pvers) <- Map.toList pnames
486
  , lsearchterm `isInfixOf` lowercase name
Duncan Coutts's avatar
Duncan Coutts committed
487
  , pkgs <- Map.elems pvers
488
  , pkg <- pkgs ]
489
  where lsearchterm = lowercase searchterm
490

Duncan Coutts's avatar
Duncan Coutts committed
491 492 493 494 495 496 497 498

--
-- * Special queries
--

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

499 500 501 502 503 504 505
-- | 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.
--
506
dependencyCycles :: PackageInstalled a => PackageIndex a -> [[a]]
507
dependencyCycles index =
508 509
  [ vs | Graph.CyclicSCC vs <- Graph.stronglyConnComp adjacencyList ]
  where
510
    adjacencyList = [ (pkg, installedUnitId pkg, installedDepends pkg)
511 512 513
                    | pkg <- allPackages index ]


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

527
-- | Tries to take the transitive closure of the package dependencies.
528
--
529
-- If the transitive closure is complete then it returns that subset of the
530 531 532
-- 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
533
-- the original given 'PackageId's do not occur in the index.
534
--
535
dependencyClosure :: PackageInstalled a => PackageIndex a
536
                  -> [UnitId]
537
                  -> Either (PackageIndex a)
538
                            [(a, [UnitId])]
539
dependencyClosure index pkgids0 = case closure mempty [] pkgids0 of
540 541
  (completed, []) -> Left completed
  (completed, _)  -> Right (brokenPackages completed)
542
 where
543
    closure completed failed []             = (completed, failed)
544
    closure completed failed (pkgid:pkgids) = case lookupUnitId index pkgid of
545
      Nothing   -> closure completed (pkgid:failed) pkgids
546
      Just pkg  -> case lookupUnitId completed (installedUnitId pkg) of
547 548
        Just _  -> closure completed  failed pkgids
        Nothing -> closure completed' failed pkgids'
Duncan Coutts's avatar
Duncan Coutts committed
549
          where completed' = insert pkg completed
550
                pkgids'    = installedDepends pkg ++ pkgids
551

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

565
  where
566
    (depGraph, vertexToPkg, pkgIdToVertex) = dependencyGraph index
567 568 569
    reverseDepGraph = Graph.transposeG depGraph
    noSuchPkgId = error "reverseDependencyClosure: package is not in the graph"

570
topologicalOrder :: PackageInstalled a => PackageIndex a -> [a]
571 572 573 574 575
topologicalOrder index = map toPkgId
                       . Graph.topSort
                       $ graph
  where (graph, toPkgId, _) = dependencyGraph index

576
reverseTopologicalOrder :: PackageInstalled a => PackageIndex a -> [a]
577 578 579 580 581 582 583 584 585 586 587
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'.
--
588
dependencyGraph :: PackageInstalled a => PackageIndex a
589
                -> (Graph.Graph,
590
                    Graph.Vertex -> a,
591
                    UnitId -> Maybe Graph.Vertex)
592
dependencyGraph index = (graph, vertex_to_pkg, id_to_vertex)
593 594
  where
    graph = Array.listArray bounds
595
              [ [ v | Just v <- map id_to_vertex (installedDepends pkg) ]
596
              | pkg <- pkgs ]
597

Duncan Coutts's avatar
Duncan Coutts committed
598
    pkgs             = sortBy (comparing packageId) (allPackages index)
599
    vertices         = zip (map installedUnitId pkgs) [0..]
600
    vertex_map       = Map.fromList vertices
601
    id_to_vertex pid = Map.lookup pid vertex_map
602 603

    vertex_to_pkg vertex = pkgTable ! vertex
604 605 606 607 608

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

609 610 611 612 613 614 615 616 617 618
-- | 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.
--
619
dependencyInconsistencies :: PackageInstalled a => PackageIndex a
Duncan Coutts's avatar
Duncan Coutts committed
620
                          -> [(PackageName, [(PackageId, Version)])]
621
dependencyInconsistencies index =
622 623 624 625 626 627 628 629 630 631 632 633
  [ (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
634
          | pkg <- allPackages index
635
          , ipid <- installedDepends pkg
636
          , Just dep <- [lookupUnitId index ipid]
637 638
          ]

639 640 641 642 643
        -- 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.
644
        reallyIsInconsistent :: PackageInstalled a => [a] -> Bool
645 646 647
        reallyIsInconsistent []       = False
        reallyIsInconsistent [_p]     = False
        reallyIsInconsistent [p1, p2] =
648 649
          let pid1 = installedUnitId p1
              pid2 = installedUnitId p2
650 651
          in pid1 `notElem` installedDepends p2
          && pid2 `notElem` installedDepends p1
652
        reallyIsInconsistent _ = True
Duncan Coutts's avatar
Duncan Coutts committed
653

Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
654 655 656 657
-- | 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@.
658
moduleNameIndex :: InstalledPackageIndex -> Map ModuleName [IPI.InstalledPackageInfo]
Duncan Coutts's avatar
Duncan Coutts committed
659
moduleNameIndex index =
660 661
  Map.fromListWith (++) $ do
    pkg <- allPackages index
662
    IPI.ExposedModule m reexport <- IPI.exposedModules pkg
663 664
    case reexport of
        Nothing -> return (m, [pkg])
Edward Z. Yang's avatar
Edward Z. Yang committed
665 666
        Just (Module _ m') | m == m'   -> []
                           | otherwise -> return (m', [pkg])
667 668 669 670 671
        -- 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!