<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://code.haskell.org/~malcolm/hscolour/ -->
<title>src/full/Agda/Packaging/Database.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Agda</span><span class='hs-varop'>.</span><span class='hs-conid'>Packaging</span><span class='hs-varop'>.</span><span class='hs-conid'>Database</span> <span class='hs-keyword'>where</span>
<a name="line-2"></a><span class='hs-comment'>-- FIXME: proper exports</span>
<a name="line-3"></a><span class='hs-comment'>{-
<a name="line-4"></a>-- Standard Library Imports
<a name="line-5"></a>import Control.Applicative
<a name="line-6"></a>import qualified Control.Exception
<a name="line-7"></a>import Control.Monad.Cont
<a name="line-8"></a>import Control.Monad.Error
<a name="line-9"></a>import Data.List
<a name="line-10"></a> ( foldl'
<a name="line-11"></a> , intersperse
<a name="line-12"></a> , isSuffixOf
<a name="line-13"></a> , partition )
<a name="line-14"></a>import Data.Maybe
<a name="line-15"></a> ( fromJust )
<a name="line-16"></a>import System.Directory
<a name="line-17"></a> ( createDirectoryIfMissing
<a name="line-18"></a> , getAppUserDataDirectory
<a name="line-19"></a> , getDirectoryContents
<a name="line-20"></a> , removeFile )
<a name="line-21"></a>import System.FilePath
<a name="line-22"></a>import System.IO
<a name="line-23"></a> ( IOMode (ReadMode)
<a name="line-24"></a> , hGetContents
<a name="line-25"></a> , hSetEncoding
<a name="line-26"></a> , openFile
<a name="line-27"></a> , utf8 )
<a name="line-28"></a>import System.IO.Error
<a name="line-29"></a> ( isPermissionError
<a name="line-30"></a> , try )
<a name="line-31"></a>
<a name="line-32"></a>-- External Library Imports
<a name="line-33"></a>import qualified Distribution.InstalledPackageInfo
<a name="line-34"></a> as Cabal
<a name="line-35"></a> ( InstalledPackageInfo
<a name="line-36"></a> , exposed
<a name="line-37"></a> , exposedModules
<a name="line-38"></a> , depends
<a name="line-39"></a> , hiddenModules
<a name="line-40"></a> , installedPackageId
<a name="line-41"></a> , parseInstalledPackageInfo
<a name="line-42"></a> , showInstalledPackageInfo )
<a name="line-43"></a>import qualified Distribution.Package
<a name="line-44"></a> as Cabal
<a name="line-45"></a> ( PackageIdentifier
<a name="line-46"></a> , packageId )
<a name="line-47"></a>import qualified Distribution.ParseUtils
<a name="line-48"></a> as Cabal
<a name="line-49"></a> ( ParseResult (..)
<a name="line-50"></a> , locatedErrorMsg )
<a name="line-51"></a>import qualified Distribution.Simple.Utils
<a name="line-52"></a> as Cabal
<a name="line-53"></a> ( die
<a name="line-54"></a> , writeUTF8File )
<a name="line-55"></a>import qualified Distribution.Text
<a name="line-56"></a> as Cabal
<a name="line-57"></a> ( display
<a name="line-58"></a> , simpleParse )
<a name="line-59"></a>
<a name="line-60"></a>-- Local Imports
<a name="line-61"></a>import Agda.Packaging.Config
<a name="line-62"></a>import Agda.Packaging.Monad
<a name="line-63"></a>import Agda.Packaging.Types
<a name="line-64"></a>import Paths_Agda
<a name="line-65"></a> ( getDataDir )
<a name="line-66"></a>
<a name="line-67"></a>-------------------------------------------------------------------------------
<a name="line-68"></a>
<a name="line-69"></a>--------------------------
<a name="line-70"></a>-- Getting the DB paths --
<a name="line-71"></a>--------------------------
<a name="line-72"></a>
<a name="line-73"></a>getPkgDBPathGlobal :: IO FilePath
<a name="line-74"></a>getPkgDBPathGlobal = do
<a name="line-75"></a> result <- try action
<a name="line-76"></a> case result of
<a name="line-77"></a> Left ioErr -> Cabal.die $ show ioErr
<a name="line-78"></a> Right filePath -> return filePath
<a name="line-79"></a> where
<a name="line-80"></a> action = pure (</>)
<a name="line-81"></a> <*> getDataDir
<a name="line-82"></a> <*> pure "package.conf.d"
<a name="line-83"></a>
<a name="line-84"></a>getPkgDBPathUser :: IO FilePath
<a name="line-85"></a>getPkgDBPathUser = do
<a name="line-86"></a> result <- try action
<a name="line-87"></a> case result of
<a name="line-88"></a> Left ioErr -> Cabal.die $ show ioErr
<a name="line-89"></a> Right filePath -> return filePath
<a name="line-90"></a> where
<a name="line-91"></a> action = pure (</>)
<a name="line-92"></a> <*> getAppUserDataDirectory "Agda"
<a name="line-93"></a> <*> pure "package.conf.d"
<a name="line-94"></a>
<a name="line-95"></a>
<a name="line-96"></a>
<a name="line-97"></a>---------------------------------
<a name="line-98"></a>-- Loading the DBs into memory --
<a name="line-99"></a>---------------------------------
<a name="line-100"></a>
<a name="line-101"></a>getPkgDBs :: [FilePath] -> IO PackageDBStack
<a name="line-102"></a>getPkgDBs givenPkgDBNames = do
<a name="line-103"></a> pkgDBNames <-
<a name="line-104"></a> -- If no package databases are specified, default to getting the
<a name="line-105"></a> -- global and user packages.
<a name="line-106"></a> if null givenPkgDBNames
<a name="line-107"></a> then
<a name="line-108"></a> pure (\ db1 db2 -> db1 : db2 : [])
<a name="line-109"></a> <*> getPkgDBPathGlobal
<a name="line-110"></a> <*> getPkgDBPathUser
<a name="line-111"></a> else
<a name="line-112"></a> return givenPkgDBNames
<a name="line-113"></a> mapM readParsePkgDB pkgDBNames
<a name="line-114"></a>
<a name="line-115"></a>readParsePkgDB :: PackageDBName -> IO NamedPackageDB
<a name="line-116"></a>readParsePkgDB dbName = do
<a name="line-117"></a> result <- try $ getDirectoryContents dbName
<a name="line-118"></a> case result of
<a name="line-119"></a> Left ioErr -> Cabal.die $ show ioErr
<a name="line-120"></a> Right filePaths -> do
<a name="line-121"></a> pkgInfos <- mapM parseSingletonPkgConf $ map (dbName </>) dbEntries
<a name="line-122"></a> return $ NamedPackageDB
<a name="line-123"></a> { dbName = dbName
<a name="line-124"></a> , db = pkgInfos }
<a name="line-125"></a> where
<a name="line-126"></a> dbEntries = filter (".conf" `isSuffixOf`) filePaths
<a name="line-127"></a>
<a name="line-128"></a>parseSingletonPkgConf :: FilePath -> IO Cabal.InstalledPackageInfo
<a name="line-129"></a>parseSingletonPkgConf = (parsePkgInfo =<<) . readUTF8File
<a name="line-130"></a> where
<a name="line-131"></a> readUTF8File :: FilePath -> IO String
<a name="line-132"></a> readUTF8File file = do
<a name="line-133"></a> handle <- openFile file ReadMode
<a name="line-134"></a> hSetEncoding handle utf8
<a name="line-135"></a> hGetContents handle
<a name="line-136"></a>
<a name="line-137"></a>parsePkgInfo :: String -> IO Cabal.InstalledPackageInfo
<a name="line-138"></a>parsePkgInfo pkgInfoStr =
<a name="line-139"></a> case Cabal.parseInstalledPackageInfo pkgInfoStr of
<a name="line-140"></a> Cabal.ParseOk warnings pkgInfo ->
<a name="line-141"></a> return pkgInfo
<a name="line-142"></a> Cabal.ParseFailed err ->
<a name="line-143"></a> case Cabal.locatedErrorMsg err of
<a name="line-144"></a> (Nothing , msg) -> Cabal.die msg
<a name="line-145"></a> (Just lineNo, msg) -> Cabal.die (show lineNo ++ ": " ++ msg)
<a name="line-146"></a>
<a name="line-147"></a>
<a name="line-148"></a>-------------------
<a name="line-149"></a>-- DB operations --
<a name="line-150"></a>-------------------
<a name="line-151"></a>
<a name="line-152"></a>data DBOp
<a name="line-153"></a> = PkgAdd Cabal.InstalledPackageInfo
<a name="line-154"></a> | PkgModify Cabal.InstalledPackageInfo
<a name="line-155"></a> | PkgRemove Cabal.InstalledPackageInfo
<a name="line-156"></a>
<a name="line-157"></a>
<a name="line-158"></a>----------------------------------
<a name="line-159"></a>-- Processing the DBs in memory --
<a name="line-160"></a>----------------------------------
<a name="line-161"></a>
<a name="line-162"></a>brokenPkgs :: PackageDB -> PackageDB
<a name="line-163"></a>brokenPkgs = snd . transClos []
<a name="line-164"></a> where
<a name="line-165"></a> -- Calculate the transitive closure of 'ok' packages, i.e.,
<a name="line-166"></a> -- packages with all of their dependencies available.
<a name="line-167"></a> transClos :: PackageDB -> PackageDB -> (PackageDB, PackageDB)
<a name="line-168"></a> transClos okPkgs pkgs =
<a name="line-169"></a> case partition (ok okPkgs) pkgs of
<a name="line-170"></a> ([] , pkgs') -> (okPkgs, pkgs')
<a name="line-171"></a> (okPkgs', pkgs') -> transClos (okPkgs' ++ okPkgs) pkgs'
<a name="line-172"></a> where
<a name="line-173"></a> -- A package is 'ok' with respect to a package database if the
<a name="line-174"></a> -- packages dependencies are available in the database.
<a name="line-175"></a> ok :: PackageDB -> Cabal.InstalledPackageInfo -> Bool
<a name="line-176"></a> ok okPkgs pkg = null dangling
<a name="line-177"></a> where
<a name="line-178"></a> dangling = filter (`notElem` pkgIds) (Cabal.depends pkg)
<a name="line-179"></a> pkgIds = map Cabal.installedPackageId okPkgs
<a name="line-180"></a>
<a name="line-181"></a>flattenPkgDBs :: PackageDBStack -> PackageDB
<a name="line-182"></a>flattenPkgDBs = concatMap db
<a name="line-183"></a>
<a name="line-184"></a>modifyDBWithOps :: PackageDB -> [DBOp] -> PackageDB
<a name="line-185"></a>modifyDBWithOps pkgDB dbOps = foldl' applyOp pkgDB dbOps
<a name="line-186"></a> where
<a name="line-187"></a> applyOp :: PackageDB -> DBOp -> PackageDB
<a name="line-188"></a> applyOp pkgInfos (PkgAdd pkgInfo) = pkgInfo : pkgInfos
<a name="line-189"></a> applyOp pkgInfos (PkgModify pkgInfo) = applyOp pkgDB' $ PkgAdd pkgInfo
<a name="line-190"></a> where
<a name="line-191"></a> pkgDB' = applyOp pkgInfos $ PkgRemove pkgInfo
<a name="line-192"></a> applyOp pkgInfos (PkgRemove pkgInfo) = filter fpred pkgInfos
<a name="line-193"></a> where
<a name="line-194"></a> fpred = (Cabal.installedPackageId pkgInfo /=)
<a name="line-195"></a> . Cabal.installedPackageId
<a name="line-196"></a>
<a name="line-197"></a>
<a name="line-198"></a>-------------------------------
<a name="line-199"></a>-- Modifying the DBs on disk --
<a name="line-200"></a>-------------------------------
<a name="line-201"></a>
<a name="line-202"></a>modifyAndWriteDBWithOps :: NamedPackageDB -> [DBOp] -> IO ()
<a name="line-203"></a>modifyAndWriteDBWithOps npkgDB dbOps = do
<a name="line-204"></a> createDirectoryIfMissing True $ dbName npkgDB
<a name="line-205"></a> writeDBWithOps npkgDB{ db = db' } dbOps
<a name="line-206"></a> where
<a name="line-207"></a> db' = db npkgDB `modifyDBWithOps` dbOps
<a name="line-208"></a>
<a name="line-209"></a>writeDBWithOps :: NamedPackageDB -> [DBOp] -> IO ()
<a name="line-210"></a>writeDBWithOps npkgDB = mapM_ doOp
<a name="line-211"></a> where
<a name="line-212"></a> fileNameOf pkgInfo = dbName npkgDB
<a name="line-213"></a> </> Cabal.display (Cabal.installedPackageId pkgInfo)
<a name="line-214"></a> <.> "conf"
<a name="line-215"></a>
<a name="line-216"></a> doOp (PkgAdd pkgInfo) = Cabal.writeUTF8File (fileNameOf pkgInfo)
<a name="line-217"></a> $ Cabal.showInstalledPackageInfo pkgInfo
<a name="line-218"></a> doOp (PkgModify pkgInfo) = doOp $ PkgAdd pkgInfo
<a name="line-219"></a> doOp (PkgRemove pkgInfo) = removeFile (fileNameOf pkgInfo)
<a name="line-220"></a>
<a name="line-221"></a>modifyPkgInfoAndWriteDBWithFun :: Cabal.PackageIdentifier
<a name="line-222"></a> -> (Cabal.InstalledPackageInfo -> DBOp)
<a name="line-223"></a> -> AgdaPkg opt ()
<a name="line-224"></a>modifyPkgInfoAndWriteDBWithFun pkgId funToOp = asksM (rec . configPkgDBStack)
<a name="line-225"></a> where
<a name="line-226"></a> rec :: PackageDBStack -> AgdaPkg opt ()
<a name="line-227"></a> rec = liftIO . mapM_ (\ npkgDB -> modifyAndWriteDBWithOps npkgDB (generateOps $ db npkgDB))
<a name="line-228"></a> where
<a name="line-229"></a> generateOps :: PackageDB -> [DBOp]
<a name="line-230"></a> generateOps [] = []
<a name="line-231"></a> generateOps (pkgInfo:pkgInfos)
<a name="line-232"></a> | Cabal.packageId pkgInfo == pkgId = funToOp pkgInfo : generateOps pkgInfos
<a name="line-233"></a> | otherwise = generateOps pkgInfos
<a name="line-234"></a>-}</span>
</pre></body>
</html>
