IndexUtils.hs 23.2 KB
Newer Older
1
2
-----------------------------------------------------------------------------
-- |
3
-- Module      :  Distribution.Client.IndexUtils
4
5
6
-- Copyright   :  (c) Duncan Coutts 2008
-- License     :  BSD-like
--
Duncan Coutts's avatar
Duncan Coutts committed
7
-- Maintainer  :  duncan@community.haskell.org
8
9
10
11
12
-- Stability   :  provisional
-- Portability :  portable
--
-- Extra utils related to the package indexes.
-----------------------------------------------------------------------------
13
module Distribution.Client.IndexUtils (
14
  getInstalledPackages,
15
  getSourcePackages,
16
  getSourcePackagesStrict,
17
  convert,
18
19

  readPackageIndexFile,
20
21
22
  parsePackageIndex,
  readRepoIndex,
  updateRepoIndexCache,
23
24

  BuildTreeRefType(..), refTypeFromTypeCode, typeCodeFromRefType
25
26
  ) where

Duncan Coutts's avatar
Duncan Coutts committed
27
import qualified Distribution.Client.Tar as Tar
28
import Distribution.Client.Types
29

30
import Distribution.Package
31
         ( PackageId, PackageIdentifier(..), PackageName(..)
32
         , Package(..), packageVersion, packageName
33
34
         , Dependency(Dependency), InstalledPackageId(..) )
import Distribution.Client.PackageIndex (PackageIndex)
refold's avatar
refold committed
35
36
37
import qualified Distribution.Client.PackageIndex      as PackageIndex
import qualified Distribution.Simple.PackageIndex      as InstalledPackageIndex
import qualified Distribution.InstalledPackageInfo     as InstalledPackageInfo
38
import qualified Distribution.PackageDescription.Parse as PackageDesc.Parse
39
40
import Distribution.PackageDescription
         ( GenericPackageDescription )
41
import Distribution.PackageDescription.Parse
42
         ( parsePackageDescription )
43
44
45
46
47
48
import Distribution.Simple.Compiler
         ( Compiler, PackageDBStack )
import Distribution.Simple.Program
         ( ProgramConfiguration )
import qualified Distribution.Simple.Configure as Configure
         ( getInstalledPackages )
49
50
import Distribution.ParseUtils
         ( ParseResult(..) )
51
import Distribution.Version
52
         ( Version(Version), intersectVersionRanges )
53
import Distribution.Text
54
         ( display, simpleParse )
55
import Distribution.Verbosity
56
         ( Verbosity, normal, lessVerbose )
57
import Distribution.Simple.Utils
58
         ( die, warn, info, fromUTF8 )
59

60
import Data.Char   (isAlphaNum)
EyalLotem's avatar
EyalLotem committed
61
import Data.Maybe  (mapMaybe, fromMaybe)
62
import Data.List   (isPrefixOf)
63
import Data.Monoid (Monoid(..))
64
import qualified Data.Map as Map
65
import Control.Monad (MonadPlus(mplus), when, liftM)
66
import Control.Exception (evaluate)
67
68
import qualified Data.ByteString.Lazy as BS
import qualified Data.ByteString.Lazy.Char8 as BS.Char8
69
import qualified Data.ByteString.Char8 as BSS
70
import Data.ByteString.Lazy (ByteString)
71
import Distribution.Client.GZipUtils (maybeDecompress)
72
73
import Distribution.Client.Utils ( byteStringToFilePath
                                 , tryFindAddSourcePackageDesc )
74
import Distribution.Compat.Exception (catchIO)
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
75
import Distribution.Client.Compat.Time (getFileAge, getModTime)
76
import System.Directory (doesFileExist)
77
import System.FilePath ((</>), takeExtension, splitDirectories, normalise)
78
79
import System.FilePath.Posix as FilePath.Posix
         ( takeFileName )
80
import System.IO
81
import System.IO.Unsafe (unsafeInterleaveIO)
82
83
import System.IO.Error (isDoesNotExistError)

84

85
86
getInstalledPackages :: Verbosity -> Compiler
                     -> PackageDBStack -> ProgramConfiguration
87
                     -> IO InstalledPackageIndex.PackageIndex
88
getInstalledPackages verbosity comp packageDbs conf =
89
    Configure.getInstalledPackages verbosity' comp packageDbs conf
90
  where
91
92
93
    --FIXME: make getInstalledPackages use sensible verbosity in the first place
    verbosity'  = lessVerbose verbosity

94
convert :: InstalledPackageIndex.PackageIndex -> PackageIndex InstalledPackage
95
convert index' = PackageIndex.fromList
96
    -- There can be multiple installed instances of each package version,
Ian D. Bollinger's avatar
Ian D. Bollinger committed
97
    -- like when the same package is installed in the global & user DBs.
98
99
100
101
102
103
    -- InstalledPackageIndex.allPackagesBySourcePackageId gives us the
    -- installed packages with the most preferred instances first, so by
    -- picking the first we should get the user one. This is almost but not
    -- quite the same as what ghc does.
    [ InstalledPackage ipkg (sourceDeps index' ipkg)
    | (_,ipkg:_) <- InstalledPackageIndex.allPackagesBySourcePackageId index' ]
104
105
106
107
108
109
110
111
112
  where
    -- The InstalledPackageInfo only lists dependencies by the
    -- InstalledPackageId, which means we do not directly know the corresponding
    -- source dependency. The only way to find out is to lookup the
    -- InstalledPackageId to get the InstalledPackageInfo and look at its
    -- source PackageId. But if the package is broken because it depends on
    -- other packages that do not exist then we have a problem we cannot find
    -- the original source package id. Instead we make up a bogus package id.
    -- This should have the same effect since it should be a dependency on a
Ian D. Bollinger's avatar
Ian D. Bollinger committed
113
    -- nonexistent package.
114
115
116
117
118
119
120
121
122
    sourceDeps index ipkg =
      [ maybe (brokenPackageId depid) packageId mdep
      | let depids = InstalledPackageInfo.depends ipkg
            getpkg = InstalledPackageIndex.lookupInstalledPackageId index
      , (depid, mdep) <- zip depids (map getpkg depids) ]

    brokenPackageId (InstalledPackageId str) =
      PackageIdentifier (PackageName (str ++ "-broken")) (Version [] [])

123
124
125
------------------------------------------------------------------------
-- Reading the source package index
--
126

127
128
129
-- | Read a repository index from disk, from the local files specified by
-- a list of 'Repo's.
--
130
-- All the 'SourcePackage's are marked as having come from the appropriate
131
132
133
134
-- 'Repo'.
--
-- This is a higher level wrapper used internally in cabal-install.
--
135
getSourcePackages :: Verbosity -> [Repo] -> IO SourcePackageDb
136
137
138
139
140
141
142
143
144
145
146
147
148
149
getSourcePackages verbosity repos = getSourcePackages' verbosity repos
                                    ReadPackageIndexLazyIO

-- | Like 'getSourcePackages', but reads the package index strictly. Useful if
-- you want to write to the package index after having read it.
getSourcePackagesStrict :: Verbosity -> [Repo] -> IO SourcePackageDb
getSourcePackagesStrict verbosity repos = getSourcePackages' verbosity repos
                                          ReadPackageIndexStrict

-- | Common implementation used by getSourcePackages and
-- getSourcePackagesStrict.
getSourcePackages' :: Verbosity -> [Repo] -> ReadPackageIndexMode
                      -> IO SourcePackageDb
getSourcePackages' verbosity [] _mode = do
150
151
  warn verbosity $ "No remote package servers have been specified. Usually "
                ++ "you would have one specified in the config file."
152
  return SourcePackageDb {
153
154
155
    packageIndex       = mempty,
    packagePreferences = mempty
  }
156
getSourcePackages' verbosity repos mode = do
157
  info verbosity "Reading available packages..."
158
  pkgss <- mapM (\r -> readRepoIndex verbosity r mode) repos
159
  let (pkgs, prefs) = mconcat pkgss
Duncan Coutts's avatar
Duncan Coutts committed
160
      prefs' = Map.fromListWith intersectVersionRanges
161
                 [ (name, range) | Dependency name range <- prefs ]
162
163
  _ <- evaluate pkgs
  _ <- evaluate prefs'
164
  return SourcePackageDb {
165
166
167
    packageIndex       = pkgs,
    packagePreferences = prefs'
  }
168

169
170
171
-- | Read a repository index from disk, from the local file specified by
-- the 'Repo'.
--
172
-- All the 'SourcePackage's are marked as having come from the given 'Repo'.
173
174
175
--
-- This is a higher level wrapper used internally in cabal-install.
--
176
readRepoIndex :: Verbosity -> Repo -> ReadPackageIndexMode
177
              -> IO (PackageIndex SourcePackage, [Dependency])
178
readRepoIndex verbosity repo mode =
179
  let indexFile = repoLocalDir repo </> "00-index.tar"
180
181
182
183
      cacheFile = repoLocalDir repo </> "00-index.cache"
  in handleNotFound $ do
    warnIfIndexIsOld indexFile
    whenCacheOutOfDate indexFile cacheFile $ do
EyalLotem's avatar
EyalLotem committed
184
      info verbosity "Updating the index cache file..."
185
      updatePackageIndexCacheFile indexFile cacheFile
186
    readPackageIndexCacheFile mkAvailablePackage indexFile cacheFile mode
Duncan Coutts's avatar
Duncan Coutts committed
187

188
  where
189
    mkAvailablePackage pkgEntry =
190
      SourcePackage {
191
        packageInfoId      = pkgid,
192
193
        packageDescription = packageDesc pkgEntry,
        packageSource      = case pkgEntry of
194
195
          NormalPackage _ _ _ _       -> RepoTarballPackage repo pkgid Nothing
          BuildTreeRef  _  _ _ path _ -> LocalUnpackedPackage path,
196
197
198
        packageDescrOverride = case pkgEntry of
          NormalPackage _ _ pkgtxt _ -> Just pkgtxt
          _                          -> Nothing
199
      }
200
201
      where
        pkgid = packageId pkgEntry
202

refold's avatar
refold committed
203
    handleNotFound action = catchIO action $ \e -> if isDoesNotExistError e
204
205
206
207
208
209
210
211
212
213
214
      then do
        case repoKind repo of
          Left  remoteRepo -> warn verbosity $
               "The package list for '" ++ remoteRepoName remoteRepo
            ++ "' does not exist. Run 'cabal update' to download it."
          Right _localRepo -> warn verbosity $
               "The package list for the local repo '" ++ repoLocalDir repo
            ++ "' is missing. The repo is invalid."
        return mempty
      else ioError e

215
216
    isOldThreshold = 15 --days
    warnIfIndexIsOld indexFile = do
217
218
      dt <- getFileAge indexFile
      when (dt >= isOldThreshold) $ case repoKind repo of
219
220
        Left  remoteRepo -> warn verbosity $
             "The package list for '" ++ remoteRepoName remoteRepo
221
          ++ "' is " ++ show dt ++ " days old.\nRun "
222
223
224
          ++ "'cabal update' to get the latest list of available packages."
        Right _localRepo -> return ()

225
226
227
228
229
230
-- | It is not necessary to call this, as the cache will be updated when the
-- index is read normally. However you can do the work earlier if you like.
--
updateRepoIndexCache :: Verbosity -> Repo -> IO ()
updateRepoIndexCache verbosity repo =
    whenCacheOutOfDate indexFile cacheFile $ do
EyalLotem's avatar
EyalLotem committed
231
      info verbosity "Updating the index cache file..."
232
233
234
235
236
      updatePackageIndexCacheFile indexFile cacheFile
  where
    indexFile = repoLocalDir repo </> "00-index.tar"
    cacheFile = repoLocalDir repo </> "00-index.cache"

237
whenCacheOutOfDate :: FilePath -> FilePath -> IO () -> IO ()
238
whenCacheOutOfDate origFile cacheFile action = do
239
240
241
242
243
244
245
  exists <- doesFileExist cacheFile
  if not exists
    then action
    else do
      origTime  <- getModTime origFile
      cacheTime <- getModTime cacheFile
      when (origTime >= cacheTime) action
246
247
248
249

------------------------------------------------------------------------
-- Reading the index file
--
250

251
-- | An index entry is either a normal package, or a local build tree reference.
refold's avatar
refold committed
252
253
data PackageEntry =
  NormalPackage  PackageId GenericPackageDescription ByteString BlockNo
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
  | BuildTreeRef BuildTreeRefType
                 PackageId GenericPackageDescription FilePath   BlockNo

-- | A build tree reference is either a link or a snapshot.
data BuildTreeRefType = SnapshotRef | LinkRef
                      deriving Eq

refTypeFromTypeCode :: Tar.TypeCode -> BuildTreeRefType
refTypeFromTypeCode t
  | t == Tar.buildTreeRefTypeCode      = LinkRef
  | t == Tar.buildTreeSnapshotTypeCode = SnapshotRef
  | otherwise                          =
    error "Distribution.Client.IndexUtils.refTypeFromTypeCode: unknown type code"

typeCodeFromRefType :: BuildTreeRefType -> Tar.TypeCode
typeCodeFromRefType LinkRef     = Tar.buildTreeRefTypeCode
typeCodeFromRefType SnapshotRef = Tar.buildTreeSnapshotTypeCode
271
272
273
274

type MkPackageEntry = IO PackageEntry

instance Package PackageEntry where
275
276
  packageId (NormalPackage  pkgid _ _ _) = pkgid
  packageId (BuildTreeRef _ pkgid _ _ _) = pkgid
277
278

packageDesc :: PackageEntry -> GenericPackageDescription
279
280
packageDesc (NormalPackage  _ descr _ _) = descr
packageDesc (BuildTreeRef _ _ descr _ _) = descr
281

282
283
284
-- | Read a compressed \"00-index.tar.gz\" file into a 'PackageIndex'.
--
-- This is supposed to be an \"all in one\" way to easily get at the info in
Ian D. Bollinger's avatar
Ian D. Bollinger committed
285
-- the Hackage package index.
286
287
288
289
290
291
--
-- It takes a function to map a 'GenericPackageDescription' into any more
-- specific instance of 'Package' that you might want to use. In the simple
-- case you can just use @\_ p -> p@ here.
--
readPackageIndexFile :: Package pkg
292
                     => (PackageEntry -> pkg)
293
294
                     -> FilePath
                     -> IO (PackageIndex pkg, [Dependency])
295
readPackageIndexFile mkPkg indexFile = do
296
297
298
299
  (mkPkgs, prefs) <- either fail return
                     . parsePackageIndex
                     . maybeDecompress
                     =<< BS.readFile indexFile
300

301
302
303
  pkgEntries  <- sequence mkPkgs
  pkgs <- evaluate $ PackageIndex.fromList (map mkPkg pkgEntries)
  return (pkgs, prefs)
304
305
306
307

-- | Parse an uncompressed \"00-index.tar\" repository index file represented
-- as a 'ByteString'.
--
308
parsePackageIndex :: ByteString
309
                  -> Either String ([MkPackageEntry], [Dependency])
310
311
312
313
314
315
316
317
parsePackageIndex = accum 0 [] [] . Tar.read
  where
    accum blockNo pkgs prefs es = case es of
      Tar.Fail err   -> Left  err
      Tar.Done       -> Right (reverse pkgs, reverse prefs)
      Tar.Next e es' -> accum blockNo' pkgs' prefs' es'
        where
          (pkgs', prefs') = extract blockNo pkgs prefs e
318
          blockNo'        = blockNo + Tar.entrySizeInBlocks e
319
320
321
322
323
324
325

    extract blockNo pkgs prefs entry =
       fromMaybe (pkgs, prefs) $
                 tryExtractPkg
         `mplus` tryExtractPrefs
      where
        tryExtractPkg = do
326
327
          mkPkgEntry <- extractPkg entry blockNo
          return (mkPkgEntry:pkgs, prefs)
328
329
330
331
332

        tryExtractPrefs = do
          prefs' <- extractPrefs entry
          return (pkgs, prefs'++prefs)

333
334
extractPkg :: Tar.Entry -> BlockNo -> Maybe MkPackageEntry
extractPkg entry blockNo = case Tar.entryContent entry of
335
336
337
338
  Tar.NormalFile content _
     | takeExtension fileName == ".cabal"
    -> case splitDirectories (normalise fileName) of
        [pkgname,vers,_] -> case simpleParse vers of
339
          Just ver -> Just $ return (NormalPackage pkgid descr content blockNo)
340
341
342
343
344
345
346
347
348
            where
              pkgid  = PackageIdentifier (PackageName pkgname) ver
              parsed = parsePackageDescription . fromUTF8 . BS.Char8.unpack
                                               $ content
              descr  = case parsed of
                ParseOk _ d -> d
                _           -> error $ "Couldn't read cabal file "
                                    ++ show fileName
          _ -> Nothing
349
        _ -> Nothing
350
351

  Tar.OtherEntryType typeCode content _
352
    | Tar.isBuildTreeRefTypeCode typeCode ->
353
354
      Just $ do
        let path   = byteStringToFilePath content
355
356
            err = "Error reading package index."
        cabalFile <- tryFindAddSourcePackageDesc path err
357
        descr     <- PackageDesc.Parse.readPackageDescription normal cabalFile
358
359
        return $ BuildTreeRef (refTypeFromTypeCode typeCode) (packageId descr)
                              descr path blockNo
360

361
  _ -> Nothing
362

363
  where
364
    fileName = Tar.entryPath entry
365

366
367
368
369
370
371
372
373
374
extractPrefs :: Tar.Entry -> Maybe [Dependency]
extractPrefs entry = case Tar.entryContent entry of
  Tar.NormalFile content _
     | takeFileName (Tar.entryPath entry) == "preferred-versions"
    -> Just . parsePreferredVersions
     . BS.Char8.unpack $ content
  _ -> Nothing

parsePreferredVersions :: String -> [Dependency]
EyalLotem's avatar
EyalLotem committed
375
parsePreferredVersions = mapMaybe simpleParse
376
377
378
379
380
381
382
383
384
                       . filter (not . isPrefixOf "--")
                       . lines

------------------------------------------------------------------------
-- Reading and updating the index cache
--

updatePackageIndexCacheFile :: FilePath -> FilePath -> IO ()
updatePackageIndexCacheFile indexFile cacheFile = do
385
386
387
388
389
390
    (mkPkgs, prefs) <- either fail return
                       . parsePackageIndex
                       . maybeDecompress
                       =<< BS.readFile indexFile
    pkgEntries <- sequence mkPkgs
    let cache = mkCache pkgEntries prefs
391
392
393
    writeFile cacheFile (showIndexCache cache)
  where
    mkCache pkgs prefs =
refold's avatar
refold committed
394
        [ CachePreference pref          | pref <- prefs ]
395
     ++ [ CachePackageId pkgid blockNo
396
        | (NormalPackage pkgid _ _ blockNo) <- pkgs ]
397
398
     ++ [ CacheBuildTreeRef refType blockNo
        | (BuildTreeRef refType _ _ _ blockNo) <- pkgs]
399

400
401
402
data ReadPackageIndexMode = ReadPackageIndexStrict
                          | ReadPackageIndexLazyIO

403
readPackageIndexCacheFile :: Package pkg
404
                          => (PackageEntry -> pkg)
405
406
                          -> FilePath
                          -> FilePath
407
                          -> ReadPackageIndexMode
408
                          -> IO (PackageIndex pkg, [Dependency])
409
readPackageIndexCacheFile mkPkg indexFile cacheFile mode = do
410
  cache    <- liftM readIndexCache (BSS.readFile cacheFile)
411
412
413
414
415
416
417
  myWithFile indexFile ReadMode $ \indexHnd ->
    packageIndexFromCache mkPkg indexHnd cache mode
  where
    myWithFile f m act = case mode of
      ReadPackageIndexStrict -> withFile f m act
      ReadPackageIndexLazyIO -> do indexHnd <- openFile f m
                                   act indexHnd
418
419
420


packageIndexFromCache :: Package pkg
421
                      => (PackageEntry -> pkg)
422
423
                      -> Handle
                      -> [IndexCacheEntry]
424
                      -> ReadPackageIndexMode
425
                      -> IO (PackageIndex pkg, [Dependency])
426
packageIndexFromCache mkPkg hnd entrs mode = accum mempty [] entrs
427
428
429
430
431
432
433
434
435
436
437
438
439
  where
    accum srcpkgs prefs [] = do
      -- Have to reverse entries, since in a tar file, later entries mask
      -- earlier ones, and PackageIndex.fromList does the same, but we
      -- accumulate the list of entries in reverse order, so need to reverse.
      pkgIndex <- evaluate $ PackageIndex.fromList (reverse srcpkgs)
      return (pkgIndex, prefs)

    accum srcpkgs prefs (CachePackageId pkgid blockno : entries) = do
      -- Given the cache entry, make a package index entry.
      -- The magic here is that we use lazy IO to read the .cabal file
      -- from the index tarball if it turns out that we need it.
      -- Most of the time we only need the package id.
440
441
442
443
      ~(pkg, pkgtxt) <- unsafeInterleaveIO $ do
        pkgtxt <- getEntryContent blockno
        pkg    <- readPackageDescription pkgtxt
        return (pkg, pkgtxt)
444
445
446
447
448
449
      let srcpkg = case mode of
            ReadPackageIndexLazyIO ->
              mkPkg (NormalPackage pkgid pkg pkgtxt blockno)
            ReadPackageIndexStrict ->
              pkg `seq` pkgtxt `seq` mkPkg (NormalPackage pkgid pkg
                                            pkgtxt blockno)
450
451
      accum (srcpkg:srcpkgs) prefs entries

452
    accum srcpkgs prefs (CacheBuildTreeRef refType blockno : entries) = do
453
454
455
      -- We have to read the .cabal file eagerly here because we can't cache the
      -- package id for build tree references - the user might edit the .cabal
      -- file after the reference was added to the index.
456
      path <- liftM byteStringToFilePath . getEntryContent $ blockno
457
458
459
      pkg  <- do let err = "Error reading package index from cache."
                 file <- tryFindAddSourcePackageDesc path err
                 PackageDesc.Parse.readPackageDescription normal file
460
      let srcpkg = mkPkg (BuildTreeRef refType (packageId pkg) pkg path blockno)
461
462
      accum (srcpkg:srcpkgs) prefs entries

refold's avatar
refold committed
463
    accum srcpkgs prefs (CachePreference pref : entries) =
464
465
      accum srcpkgs (pref:prefs) entries

466
467
    getEntryContent :: BlockNo -> IO ByteString
    getEntryContent blockno = do
468
469
470
      hSeek hnd AbsoluteSeek (fromIntegral (blockno * 512))
      header  <- BS.hGet hnd 512
      size    <- getEntrySize header
471
      BS.hGet hnd (fromIntegral size)
472

473
    getEntrySize :: ByteString -> IO Tar.FileSize
474
475
476
477
478
    getEntrySize header =
      case Tar.read header of
        Tar.Next e _ ->
          case Tar.entryContent e of
            Tar.NormalFile _ size -> return size
479
            Tar.OtherEntryType typecode _ size
480
              | Tar.isBuildTreeRefTypeCode typecode
481
                                  -> return size
482
483
484
            _                     -> interror "unexpected tar entry type"
        _ -> interror "could not read tar file entry"

485
    readPackageDescription :: ByteString -> IO GenericPackageDescription
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
    readPackageDescription content =
      case parsePackageDescription . fromUTF8 . BS.Char8.unpack $ content of
        ParseOk _ d -> return d
        _           -> interror "failed to parse .cabal file"

    interror msg = die $ "internal error when reading package index: " ++ msg
                      ++ "The package index or index cache is probably "
                      ++ "corrupt. Running cabal update might fix it."

------------------------------------------------------------------------
-- Index cache data structure
--

-- | Tar files are block structured with 512 byte blocks. Every header and file
-- content starts on a block boundary.
--
type BlockNo = Int

data IndexCacheEntry = CachePackageId PackageId BlockNo
505
                     | CacheBuildTreeRef BuildTreeRefType BlockNo
refold's avatar
refold committed
506
                     | CachePreference Dependency
507
  deriving (Eq)
508

509
510
511
512
513
514
packageKey, blocknoKey, buildTreeRefKey, preferredVersionKey :: String
packageKey = "pkg:"
blocknoKey = "b#"
buildTreeRefKey     = "build-tree-ref:"
preferredVersionKey = "pref-ver:"

515
516
517
518
readIndexCacheEntry :: BSS.ByteString -> Maybe IndexCacheEntry
readIndexCacheEntry = \line ->
  case BSS.words line of
    [key, pkgnamestr, pkgverstr, sep, blocknostr]
519
      | key == BSS.pack packageKey && sep == BSS.pack blocknoKey ->
refold's avatar
refold committed
520
521
      case (parseName pkgnamestr, parseVer pkgverstr [],
            parseBlockNo blocknostr) of
522
523
524
        (Just pkgname, Just pkgver, Just blockno)
          -> Just (CachePackageId (PackageIdentifier pkgname pkgver) blockno)
        _ -> Nothing
525
    [key, typecodestr, blocknostr] | key == BSS.pack buildTreeRefKey ->
526
527
528
529
530
      case (parseRefType typecodestr, parseBlockNo blocknostr) of
        (Just refType, Just blockno)
          -> Just (CacheBuildTreeRef refType blockno)
        _ -> Nothing

531
    (key: remainder) | key == BSS.pack preferredVersionKey ->
refold's avatar
refold committed
532
      fmap CachePreference (simpleParse (BSS.unpack (BSS.unwords remainder)))
533
    _  -> Nothing
534
  where
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
    parseName str
      | BSS.all (\c -> isAlphaNum c || c == '-') str
                  = Just (PackageName (BSS.unpack str))
      | otherwise = Nothing

    parseVer str vs =
      case BSS.readInt str of
        Nothing        -> Nothing
        Just (v, str') -> case BSS.uncons str' of
          Just ('.', str'') -> parseVer str'' (v:vs)
          Just _            -> Nothing
          Nothing           -> Just (Version (reverse (v:vs)) [])

    parseBlockNo str =
      case BSS.readInt str of
        Just (blockno, remainder) | BSS.null remainder -> Just blockno
        _                                              -> Nothing

553
554
555
556
557
558
559
    parseRefType str =
      case BSS.uncons str of
        Just (typeCode, remainder)
          | BSS.null remainder && Tar.isBuildTreeRefTypeCode typeCode
            -> Just (refTypeFromTypeCode typeCode)
        _   -> Nothing

560
showIndexCacheEntry :: IndexCacheEntry -> String
561
562
563
564
565
566
567
568
569
570
571
572
573
574
showIndexCacheEntry entry = unwords $ case entry of
   CachePackageId pkgid b -> [ packageKey
                             , display (packageName pkgid)
                             , display (packageVersion pkgid)
                             , blocknoKey
                             , show b
                             ]
   CacheBuildTreeRef t b  -> [ buildTreeRefKey
                             , [typeCodeFromRefType t]
                             , show b
                             ]
   CachePreference dep    -> [ preferredVersionKey
                             , display dep
                             ]
575
576

readIndexCache :: BSS.ByteString -> [IndexCacheEntry]
EyalLotem's avatar
EyalLotem committed
577
readIndexCache = mapMaybe readIndexCacheEntry . BSS.lines
578
579
580

showIndexCache :: [IndexCacheEntry] -> String
showIndexCache = unlines . map showIndexCacheEntry