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

4 5
-----------------------------------------------------------------------------
-- |
6
-- Module      :  Distribution.Simple.PackageIndex
7 8
-- Copyright   :  (c) David Himmelstrup 2005,
--                    Bjorn Bringert 2007,
Duncan Coutts's avatar
Duncan Coutts committed
9
--                    Duncan Coutts 2008-2009
10
--
Duncan Coutts's avatar
Duncan Coutts committed
11
-- Maintainer  :  cabal-devel@haskell.org
12 13
-- Portability :  portable
--
14 15 16 17 18 19
-- 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.
--
Edward Z. Yang's avatar
Edward Z. Yang committed
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
-- While 'PackageIndex' is parametric over what it actually records,
-- it is in fact only ever instantiated with a single element:
-- 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.)
39 40 41 42 43
--
-- 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
44
--
45 46
module Distribution.Simple.PackageIndex (
  -- * Package index data type
47
  InstalledPackageIndex,
48
  PackageIndex,
49

50
  -- * Creating an index
51 52
  fromList,

53
  -- * Updates
54
  merge,
Duncan Coutts's avatar
Duncan Coutts committed
55

56
  insert,
Duncan Coutts's avatar
Duncan Coutts committed
57

58
  deleteUnitId,
Duncan Coutts's avatar
Duncan Coutts committed
59
  deleteSourcePackageId,
60
  deletePackageName,
Duncan Coutts's avatar
Duncan Coutts committed
61
--  deleteDependency,
62 63 64 65

  -- * Queries

  -- ** Precise lookups
66
  lookupUnitId,
67
  lookupComponentId,
Duncan Coutts's avatar
Duncan Coutts committed
68
  lookupSourcePackageId,
69
  lookupPackageId,
70
  lookupPackageName,
71
  lookupDependency,
72
  lookupInternalDependency,
73 74 75 76 77 78 79 80 81

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

  -- ** Bulk queries
  allPackages,
  allPackagesByName,
82
  allPackagesBySourcePackageId,
83
  allPackagesBySourcePackageIdAndLibName,
84 85 86 87 88 89 90 91 92 93

  -- ** Special queries
  brokenPackages,
  dependencyClosure,
  reverseDependencyClosure,
  topologicalOrder,
  reverseTopologicalOrder,
  dependencyInconsistencies,
  dependencyCycles,
  dependencyGraph,
Duncan Coutts's avatar
Duncan Coutts committed
94
  moduleNameIndex,
95 96 97 98

  -- * Backwards compatibility
  deleteInstalledPackageId,
  lookupInstalledPackageId,
99 100
  ) where

101 102
import Prelude ()
import Distribution.Compat.Prelude hiding (lookup)
103
import qualified Distribution.Compat.Map.Strict as Map
104

105
import Distribution.Package
106
import Distribution.Backpack
107 108 109 110
import Distribution.ModuleName
import qualified Distribution.InstalledPackageInfo as IPI
import Distribution.Version
import Distribution.Simple.Utils
111
import Distribution.Types.Dependency
112
import Distribution.Types.UnqualComponentName
113

114
import Control.Exception (assert)
115
import Data.Array ((!))
ttuegel's avatar
ttuegel committed
116 117
import qualified Data.Array as Array
import qualified Data.Graph as Graph
118
import Data.List as List ( groupBy,  deleteBy, deleteFirstsBy )
ttuegel's avatar
ttuegel committed
119
import qualified Data.Tree  as Tree
120
import Control.Monad
121 122

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

Ian D. Bollinger's avatar
Ian D. Bollinger committed
134
  -- This auxiliary index maps package names (case-sensitively) to all the
Duncan Coutts's avatar
Duncan Coutts committed
135 136
  -- versions and instances of that package. This allows us to find all
  -- versions satisfying a dependency.
137
  --
Duncan Coutts's avatar
Duncan Coutts committed
138 139
  -- 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
140
  -- of the same package version. These are unique by UnitId
Duncan Coutts's avatar
Duncan Coutts committed
141
  -- and are kept in preference order.
142
  --
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
143 144
  -- FIXME: Clarify what "preference order" means. Check that this invariant is
  -- preserved. See #1463 for discussion.
145
  packageIdIndex :: !(Map (PackageName, Maybe UnqualComponentName) (Map Version [a]))
146

147
  } deriving (Eq, Generic, Show, Read)
ttuegel's avatar
ttuegel committed
148 149

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

151 152
-- | The default package index which contains 'InstalledPackageInfo'.  Normally
-- use this.
153
type InstalledPackageIndex = PackageIndex IPI.InstalledPackageInfo
154

155
instance Monoid (PackageIndex IPI.InstalledPackageInfo) where
Duncan Coutts's avatar
Duncan Coutts committed
156
  mempty  = PackageIndex Map.empty Map.empty
157
  mappend = (<>)
158
  --save one mappend with empty in the common case:
159
  mconcat [] = mempty
160 161
  mconcat xs = foldr1 mappend xs

162
instance Semigroup (PackageIndex IPI.InstalledPackageInfo) where
163 164
  (<>) = merge

165
invariant :: InstalledPackageIndex -> Bool
Duncan Coutts's avatar
Duncan Coutts committed
166
invariant (PackageIndex pids pnames) =
167
     map installedUnitId (Map.elems pids)
168
  == sort
169
     [ assert pinstOk (installedUnitId pinst)
170
     | ((pname, plib), pvers)  <- Map.toList pnames
Duncan Coutts's avatar
Duncan Coutts committed
171 172
     , let pversOk = not (Map.null pvers)
     , (pver,  pinsts) <- assert pversOk $ Map.toList pvers
173
     , let pinsts'  = sortBy (comparing installedUnitId) pinsts
Duncan Coutts's avatar
Duncan Coutts committed
174
           pinstsOk = all (\g -> length g == 1)
175
                          (groupBy (equating installedUnitId) pinsts')
Duncan Coutts's avatar
Duncan Coutts committed
176 177 178
     , pinst           <- assert pinstsOk $ pinsts'
     , let pinstOk = packageName    pinst == pname
                  && packageVersion pinst == pver
179
                  && IPI.sourceLibName  pinst == plib
Duncan Coutts's avatar
Duncan Coutts committed
180
     ]
181 182 183 184 185
  -- If you see this invariant failing (ie the assert in mkPackageIndex below)
  -- then one thing to check is if it is happening in fromList. Check if the
  -- second list above (the sort [...] bit) is ending up with duplicates. This
  -- has been observed in practice once due to a messed up ghc-pkg db. How/why
  -- it became messed up was not discovered.
Duncan Coutts's avatar
Duncan Coutts committed
186

187

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

192 193 194 195
mkPackageIndex :: Map UnitId IPI.InstalledPackageInfo
               -> Map (PackageName, Maybe UnqualComponentName)
                      (Map Version [IPI.InstalledPackageInfo])
               -> InstalledPackageIndex
Duncan Coutts's avatar
Duncan Coutts committed
196 197
mkPackageIndex pids pnames = assert (invariant index) index
  where index = PackageIndex pids pnames
198

199 200 201

--
-- * Construction
202 203
--

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

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

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

252

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

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

    insertPackageVersion =
271
      Map.insertWith (\_ -> insertPackageInstance)
Duncan Coutts's avatar
Duncan Coutts committed
272 273 274
                     (packageVersion pkg) [pkg]

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


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

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

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

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

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

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

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

327 328 329

-- | Removes all packages with this (case-sensitive) name from the index.
--
330 331 332 333
-- NB: Does NOT delete internal libraries from this package.
--
deletePackageName :: PackageName -> InstalledPackageIndex
                  -> InstalledPackageIndex
Duncan Coutts's avatar
Duncan Coutts committed
334
deletePackageName name original@(PackageIndex pids pnames) =
335
  case Map.lookup (name, Nothing) pnames of
Duncan Coutts's avatar
Duncan Coutts committed
336 337
    Nothing     -> original
    Just pvers  -> mkPackageIndex
338
                     (foldl' (flip (Map.delete . installedUnitId)) pids
Duncan Coutts's avatar
Duncan Coutts committed
339
                             (concat (Map.elems pvers)))
340
                     (Map.delete (name, Nothing) pnames)
341

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

350 351 352 353
--
-- * Bulk queries
--

354 355
-- | Get all the packages from the index.
--
356
allPackages :: PackageIndex a -> [a]
357
allPackages = Map.elems . unitIdIndex
358 359 360

-- | Get all the packages from the index.
--
361
-- They are grouped by package name (case-sensitively).
362
--
363 364
-- (Doesn't include private libraries.)
--
365
allPackagesByName :: PackageIndex a -> [(PackageName, [a])]
366
allPackagesByName index =
367
  [ (pkgname, concat (Map.elems pvers))
368
  | ((pkgname, Nothing), pvers) <- Map.toList (packageIdIndex index) ]
369 370 371 372 373

-- | Get all the packages from the index.
--
-- They are grouped by source package id (package name and version).
--
374 375
-- (Doesn't include private libraries)
--
376
allPackagesBySourcePackageId :: HasUnitId a => PackageIndex a
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
377
                             -> [(PackageId, [a])]
378
allPackagesBySourcePackageId index =
379
  [ (packageId ipkg, ipkgs)
380 381 382 383 384 385 386 387 388 389 390 391 392
  | ((_, Nothing), pvers) <- Map.toList (packageIdIndex index)
  , ipkgs@(ipkg:_) <- Map.elems pvers ]

-- | Get all the packages from the index.
--
-- They are grouped by source package id and library name.
--
-- This DOES include internal libraries.
allPackagesBySourcePackageIdAndLibName :: HasUnitId a => PackageIndex a
                             -> [((PackageId, Maybe UnqualComponentName), [a])]
allPackagesBySourcePackageIdAndLibName index =
  [ ((packageId ipkg, ln), ipkgs)
  | ((_, ln), pvers) <- Map.toList (packageIdIndex index)
393
  , ipkgs@(ipkg:_) <- Map.elems pvers ]
394 395 396 397 398

--
-- * Lookups
--

399
-- | Does a lookup by unit identifier.
400
--
401
-- Since multiple package DBs mask each other by 'UnitId',
402 403
-- then we get back at most one package.
--
404
lookupUnitId :: PackageIndex a -> UnitId
405
             -> Maybe a
406
lookupUnitId index uid = Map.lookup uid (unitIdIndex index)
407 408 409 410 411 412

-- | Does a lookup by component identifier.  In the absence
-- of Backpack, this is just a 'lookupUnitId'.
--
lookupComponentId :: PackageIndex a -> ComponentId
                  -> Maybe a
413 414
lookupComponentId index cid =
    Map.lookup (newSimpleUnitId cid) (unitIdIndex index)
Duncan Coutts's avatar
Duncan Coutts committed
415

Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
416
-- | Backwards compatibility for Cabal pre-1.24.
417 418 419 420 421
{-# DEPRECATED lookupInstalledPackageId "Use lookupUnitId instead" #-}
lookupInstalledPackageId :: PackageIndex a -> UnitId
                         -> Maybe a
lookupInstalledPackageId = lookupUnitId

422

Duncan Coutts's avatar
Duncan Coutts committed
423 424 425
-- | Does a lookup by source package id (name & version).
--
-- There can be multiple installed packages with the same source 'PackageId'
426
-- but different 'UnitId'. They are returned in order of
Duncan Coutts's avatar
Duncan Coutts committed
427
-- preference, with the most preferred first.
428
--
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
429
lookupSourcePackageId :: PackageIndex a -> PackageId -> [a]
430
lookupSourcePackageId index pkgid =
431 432
  -- Do not lookup internal libraries
  case Map.lookup (packageName pkgid, Nothing) (packageIdIndex index) of
Duncan Coutts's avatar
Duncan Coutts committed
433 434 435 436
    Nothing     -> []
    Just pvers  -> case Map.lookup (packageVersion pkgid) pvers of
      Nothing   -> []
      Just pkgs -> pkgs -- in preference order
437

438 439
-- | Convenient alias of 'lookupSourcePackageId', but assuming only
-- one package per package ID.
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
440
lookupPackageId :: PackageIndex a -> PackageId -> Maybe a
441 442 443 444
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
445 446 447

-- | Does a lookup by source package name.
--
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
448
lookupPackageName :: PackageIndex a -> PackageName
449
                  -> [(Version, [a])]
450
lookupPackageName index name =
451 452
  -- Do not match internal libraries
  case Map.lookup (name, Nothing) (packageIdIndex index) of
Duncan Coutts's avatar
Duncan Coutts committed
453 454 455 456 457
    Nothing     -> []
    Just pvers  -> Map.toList pvers


-- | Does a lookup by source package name and a range of versions.
458 459 460 461
--
-- We get back any number of versions of the specified package name, all
-- satisfying the version range constraint.
--
462 463 464
-- This does NOT work for internal dependencies, DO NOT use this
-- function on those; use 'lookupInternalDependency' instead.
--
465 466 467 468
-- INVARIANT: List of eligible 'IPI.InstalledPackageInfo' is non-empty.
--
lookupDependency :: InstalledPackageIndex -> Dependency
                 -> [(Version, [IPI.InstalledPackageInfo])]
469
lookupDependency index (Dependency name versionRange) =
470
  case Map.lookup (name, Nothing) (packageIdIndex index) of
Duncan Coutts's avatar
Duncan Coutts committed
471
    Nothing    -> []
472 473 474 475 476 477 478 479 480 481 482 483 484
    Just pvers -> [ (ver, pkgs')
                  | (ver, pkgs) <- Map.toList pvers
                  , ver `withinRange` versionRange
                  , let pkgs' = filter eligible pkgs
                  -- Enforce the invariant
                  , not (null pkgs')
                  ]
 where
  -- When we select for dependencies, we ONLY want to pick up indefinite
  -- packages, or packages with no instantiations.  We'll do mix-in
  -- linking to improve any such package into an instantiated one
  -- later.
  eligible pkg = IPI.indefinite pkg || null (IPI.instantiatedWith pkg)
485

486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
-- | Does a lookup by source package name and a range of versions.
--
-- We get back any number of versions of the specified package name, all
-- satisfying the version range constraint.
--
-- INVARIANT: List of eligible 'IPI.InstalledPackageInfo' is non-empty.
--
lookupInternalDependency :: InstalledPackageIndex -> Dependency
                 -> Maybe UnqualComponentName
                 -> [(Version, [IPI.InstalledPackageInfo])]
lookupInternalDependency index (Dependency name versionRange) libn =
  case Map.lookup (name, libn) (packageIdIndex index) of
    Nothing    -> []
    Just pvers -> [ (ver, pkgs')
                  | (ver, pkgs) <- Map.toList pvers
                  , ver `withinRange` versionRange
                  , let pkgs' = filter eligible pkgs
                  -- Enforce the invariant
                  , not (null pkgs')
                  ]
 where
  -- When we select for dependencies, we ONLY want to pick up indefinite
  -- packages, or packages with no instantiations.  We'll do mix-in
  -- linking to improve any such package into an instantiated one
  -- later.
  eligible pkg = IPI.indefinite pkg || null (IPI.instantiatedWith pkg)


514 515 516
--
-- * Case insensitive name lookups
--
517 518 519

-- | Does a case-insensitive search by package name.
--
Ian D. Bollinger's avatar
Ian D. Bollinger committed
520
-- If there is only one package that compares case-insensitively to this name
521
-- then the search is unambiguous and we get back all versions of that package.
Ian D. Bollinger's avatar
Ian D. Bollinger committed
522
-- If several match case-insensitively but one matches exactly then it is also
523 524
-- unambiguous.
--
Ian D. Bollinger's avatar
Ian D. Bollinger committed
525
-- If however several match case-insensitively and none match exactly then we
526 527 528 529
-- 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
530
searchByName :: PackageIndex a -> String -> SearchResult [a]
531
searchByName index name =
532 533
  -- Don't match internal packages
  case [ pkgs | pkgs@((pname, Nothing),_) <- Map.toList (packageIdIndex index)
534
              , lowercase (unPackageName pname) == lname ] of
Duncan Coutts's avatar
Duncan Coutts committed
535 536
    []               -> None
    [(_,pvers)]      -> Unambiguous (concat (Map.elems pvers))
537
    pkgss            -> case find ((mkPackageName name ==) . fst . fst) pkgss of
Duncan Coutts's avatar
Duncan Coutts committed
538 539
      Just (_,pvers) -> Unambiguous (concat (Map.elems pvers))
      Nothing        -> Ambiguous (map (concat . Map.elems . snd) pkgss)
540
  where lname = lowercase name
541 542 543 544 545 546 547

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
548
searchByNameSubstring :: PackageIndex a -> String -> [a]
549
searchByNameSubstring index searchterm =
550
  [ pkg
551 552
  -- Don't match internal packages
  | ((pname, Nothing), pvers) <- Map.toList (packageIdIndex index)
553
  , lsearchterm `isInfixOf` lowercase (unPackageName pname)
Duncan Coutts's avatar
Duncan Coutts committed
554
  , pkgs <- Map.elems pvers
555
  , pkg <- pkgs ]
556
  where lsearchterm = lowercase searchterm
557

Duncan Coutts's avatar
Duncan Coutts committed
558 559 560 561 562 563 564 565

--
-- * Special queries
--

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

566 567 568 569 570 571 572
-- | 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.
--
573
dependencyCycles :: PackageInstalled a => PackageIndex a -> [[a]]
574
dependencyCycles index =
575 576
  [ vs | Graph.CyclicSCC vs <- Graph.stronglyConnComp adjacencyList ]
  where
577
    adjacencyList = [ (pkg, installedUnitId pkg, installedDepends pkg)
578 579 580
                    | pkg <- allPackages index ]


Duncan Coutts's avatar
Duncan Coutts committed
581
-- | All packages that have immediate dependencies that are not in the index.
582
--
583 584
-- Returns such packages along with the dependencies that they're missing.
--
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
585
brokenPackages :: PackageInstalled a => PackageIndex a
586
               -> [(a, [UnitId])]
587
brokenPackages index =
588
  [ (pkg, missing)
Duncan Coutts's avatar
Duncan Coutts committed
589
  | pkg  <- allPackages index
590
  , let missing = [ pkg' | pkg' <- installedDepends pkg
591
                         , isNothing (lookupUnitId index pkg') ]
592 593
  , not (null missing) ]

594
-- | Tries to take the transitive closure of the package dependencies.
595
--
596
-- If the transitive closure is complete then it returns that subset of the
597 598 599
-- 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
600
-- the original given 'PackageId's do not occur in the index.
601
--
602
dependencyClosure :: InstalledPackageIndex
603
                  -> [UnitId]
604 605
                  -> Either (InstalledPackageIndex)
                            [(IPI.InstalledPackageInfo, [UnitId])]
606
dependencyClosure index pkgids0 = case closure mempty [] pkgids0 of
607 608
  (completed, []) -> Left completed
  (completed, _)  -> Right (brokenPackages completed)
609
 where
610
    closure completed failed []             = (completed, failed)
611
    closure completed failed (pkgid:pkgids) = case lookupUnitId index pkgid of
612
      Nothing   -> closure completed (pkgid:failed) pkgids
613
      Just pkg  -> case lookupUnitId completed (installedUnitId pkg) of
614 615
        Just _  -> closure completed  failed pkgids
        Nothing -> closure completed' failed pkgids'
Duncan Coutts's avatar
Duncan Coutts committed
616
          where completed' = insert pkg completed
617
                pkgids'    = installedDepends pkg ++ pkgids
618

619
-- | Takes the transitive closure of the packages reverse dependencies.
620
--
Duncan Coutts's avatar
Duncan Coutts committed
621
-- * The given 'PackageId's must be in the index.
622
--
623
reverseDependencyClosure :: PackageInstalled a => PackageIndex a
624
                         -> [UnitId]
625
                         -> [a]
626
reverseDependencyClosure index =
627 628 629 630
    map vertexToPkg
  . concatMap Tree.flatten
  . Graph.dfs reverseDepGraph
  . map (fromMaybe noSuchPkgId . pkgIdToVertex)
631

632
  where
633
    (depGraph, vertexToPkg, pkgIdToVertex) = dependencyGraph index
634 635 636
    reverseDepGraph = Graph.transposeG depGraph
    noSuchPkgId = error "reverseDependencyClosure: package is not in the graph"

637
topologicalOrder :: PackageInstalled a => PackageIndex a -> [a]
638 639 640 641 642
topologicalOrder index = map toPkgId
                       . Graph.topSort
                       $ graph
  where (graph, toPkgId, _) = dependencyGraph index

643
reverseTopologicalOrder :: PackageInstalled a => PackageIndex a -> [a]
644 645 646 647 648 649 650 651 652 653 654
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'.
--
655
dependencyGraph :: PackageInstalled a => PackageIndex a
656
                -> (Graph.Graph,
657
                    Graph.Vertex -> a,
658
                    UnitId -> Maybe Graph.Vertex)
659
dependencyGraph index = (graph, vertex_to_pkg, id_to_vertex)
660 661
  where
    graph = Array.listArray bounds
662
              [ [ v | Just v <- map id_to_vertex (installedDepends pkg) ]
663
              | pkg <- pkgs ]
664

Duncan Coutts's avatar
Duncan Coutts committed
665
    pkgs             = sortBy (comparing packageId) (allPackages index)
666
    vertices         = zip (map installedUnitId pkgs) [0..]
667
    vertex_map       = Map.fromList vertices
668
    id_to_vertex pid = Map.lookup pid vertex_map
669 670

    vertex_to_pkg vertex = pkgTable ! vertex
671 672 673 674 675

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

676 677
-- | We maintain the invariant that, for any 'DepUniqueKey', there
-- is only one instance of the package in our database.
678
type DepUniqueKey = (PackageName, Maybe UnqualComponentName, Map ModuleName OpenModule)
679

680 681 682 683 684 685 686 687 688 689
-- | 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.
--
690
dependencyInconsistencies :: InstalledPackageIndex
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
                             -- At DepUniqueKey...
                          -> [(DepUniqueKey,
                               -- There were multiple packages (BAD!)
                               [(UnitId,
                                 -- And here are the packages which
                                 -- immediately depended on it
                                 [IPI.InstalledPackageInfo])])]
dependencyInconsistencies index = do
    (dep_key, insts_map) <- Map.toList inverseIndex
    let insts = Map.toList insts_map
    guard (length insts >= 2)
    return (dep_key, insts)
  where
    inverseIndex :: Map DepUniqueKey (Map UnitId [IPI.InstalledPackageInfo])
    inverseIndex = Map.fromListWith (Map.unionWith (++)) $ do
        pkg <- allPackages index
        dep_ipid <- installedDepends pkg
        Just dep <- [lookupUnitId index dep_ipid]
709 710
        let dep_key = (packageName dep, IPI.sourceLibName dep,
                       Map.fromList (IPI.instantiatedWith dep))
711
        return (dep_key, Map.singleton dep_ipid [pkg])
Duncan Coutts's avatar
Duncan Coutts committed
712

Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
713 714 715 716
-- | 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@.
717
moduleNameIndex :: InstalledPackageIndex -> Map ModuleName [IPI.InstalledPackageInfo]
Duncan Coutts's avatar
Duncan Coutts committed
718
moduleNameIndex index =
719 720
  Map.fromListWith (++) $ do
    pkg <- allPackages index
721
    IPI.ExposedModule m reexport <- IPI.exposedModules pkg
722 723
    case reexport of
        Nothing -> return (m, [pkg])
724 725
        Just (OpenModuleVar _) -> []
        Just (OpenModule _ m') | m == m'   -> []
726
                                | otherwise -> return (m', [pkg])
727 728 729 730 731
        -- 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!