{-# OPTIONS -XPatternGuards #-}
{- | Merge a package from hackage to an ebuild.
Merging a library
=================
Compile time:
ghc
cabal
build tools
deps (haskell dependencies)
extra-libs (c-libs)
Run time:
ghc
deps (haskell dependencies)
extra-libs (c-libs)
RDEPEND="ghc ${DEPS} ${EXTRALIBS}"
DEPEND="${RDEPEND} cabal ${BUILDTOOLS}"
Merging an executable
=====================
Packages with both executable and library must be treated as libraries, as it will impose a stricter DEPEND.
Compile time:
ghc
cabal
build tools
deps
extra-libs (c-libs)
Run time:
extra-libs (c-libs)
RDEPEND="${EXTRALIBS}"
DEPEND="${RDEPEND} ghc cabal ${DEPS} ${BUILDTOOLS}"
-}
module Merge
( merge ) where
import Control.Monad.Error
import Control.Exception
import Data.Maybe
import Data.List
import Distribution.Package
import Distribution.Compiler (CompilerId(..), CompilerFlavor(GHC))
import Distribution.PackageDescription ( PackageDescription(..)
, FlagName(..)
, libBuildInfo
, buildInfo
, buildable
, extraLibs
, buildTools
, hasLibs )
import Distribution.PackageDescription.Configuration
( finalizePackageDescription )
import Distribution.Text (display)
import System.Directory ( getCurrentDirectory
, setCurrentDirectory
, createDirectoryIfMissing
)
import System.Cmd (system)
import System.FilePath ((</>))
import qualified Cabal2Ebuild as E
import Cabal2Ebuild
import Error as E
import qualified Distribution.Package as Cabal
import qualified Distribution.Version as Cabal
import Distribution.System (buildPlatform)
import Distribution.Verbosity
import Distribution.Simple.Utils
import Network.URI
import Distribution.Client.IndexUtils ( getAvailablePackages )
import Distribution.Client.HttpUtils ( downloadURI )
import qualified Distribution.Client.PackageIndex as Index
import Distribution.Client.Types
import qualified Portage.PackageId as Portage
import qualified Portage.Version as Portage
import qualified Portage.Dependency as Portage
import qualified Portage.Host as Host
import qualified Portage.Overlay as Overlay
import qualified Portage.Resolve as Portage
import Debug.Trace ( trace )
(<->) :: String -> String -> String
a <-> b = a ++ '-':b
(<.>) :: String -> String -> String
a <.> b = a ++ '.':b
{-
Requested features:
* Copy the old keywords and ~arch them
* Add files to darcs?
* Print diff with the next latest version?
BUGS:
* Dependencies are always expected to be in dev-haskell
-}
readPackageString :: [String]
-> Either HackPortError ( Maybe Portage.Category
, Cabal.PackageName
, Maybe Portage.Version
)
readPackageString args = do
packageString <-
case args of
[] -> Left (ArgumentError "Need an argument, [category/]package[-version]")
[pkg] -> return pkg
_ -> Left (ArgumentError ("Too many arguments: " ++ unwords args))
case Portage.parseFriendlyPackage packageString of
Just v@(_,_,Nothing) -> return v
-- we only allow versions we can convert into cabal versions
Just v@(_,_,Just (Portage.Version _ Nothing [] 0)) -> return v
_ -> Left (ArgumentError ("Could not parse [category/]package[-version]: " ++ packageString))
-- | Given a list of available packages, and maybe a preferred version,
-- return the available package with that version. Latest version is chosen
-- if no preference.
resolveVersion :: [AvailablePackage] -> Maybe Cabal.Version -> Maybe AvailablePackage
resolveVersion avails Nothing = Just $ maximumBy (comparing packageInfoId) avails
resolveVersion avails (Just ver) = listToMaybe (filter match avails)
where
match avail = ver == pkgVersion (packageInfoId avail)
merge :: Verbosity -> Repo -> URI -> [String] -> FilePath -> IO ()
merge verbosity repo serverURI args overlayPath = do
(m_category, user_pName, m_version) <-
case readPackageString args of
Left err -> throwEx err
Right (c,p,m_v) ->
case m_v of
Nothing -> return (c,p,Nothing)
Just v -> case Portage.toCabalVersion v of
Nothing -> throwEx (ArgumentError "illegal version")
Just ver -> return (c,p,Just ver)
debug verbosity $ "Category: " ++ show m_category
debug verbosity $ "Package: " ++ show user_pName
debug verbosity $ "Version: " ++ show m_version
let (Cabal.PackageName user_pname_str) = user_pName
overlay <- Overlay.loadLazy overlayPath
portage_path <- Host.portage_dir `fmap` Host.getInfo
portage <- Overlay.loadLazy portage_path
index <- fmap packageIndex $ getAvailablePackages verbosity [ repo ]
-- find all packages that maches the user specified package name
availablePkgs <-
case Index.searchByName index user_pname_str of
Index.None -> throwEx (PackageNotFound user_pname_str)
Index.Ambiguous pkgs -> throwEx (ArgumentError ("Ambiguous name: " ++ unwords (map show pkgs)))
Index.Unambiguous pkg -> return pkg
-- select a single package taking into account the user specified version
selectedPkg <-
case resolveVersion availablePkgs m_version of
Nothing -> do
putStrLn "No such version for that package, available versions:"
forM_ availablePkgs $ \ avail ->
putStrLn (display . packageInfoId $ avail)
throwEx (ArgumentError "no such version for that package")
Just avail -> return avail
-- print some info
info verbosity "Selecting package:"
forM_ availablePkgs $ \ avail -> do
let match_text | packageInfoId avail == packageInfoId selectedPkg = "* "
| otherwise = "- "
info verbosity $ match_text ++ (display . packageInfoId $ avail)
let cabal_pkgId = packageInfoId selectedPkg
norm_pkgId = Portage.normalizeCabalPackageId cabal_pkgId
norm_pkgName = packageName norm_pkgId
cat <- Portage.resolveCategory verbosity overlay norm_pkgName
let pkgGenericDesc = packageDescription selectedPkg
Right (pkgDesc0, flags) =
finalizePackageDescription
[ -- XXX: common things we should enable/disable?
-- (FlagName "small_base", True) -- try to use small base
(FlagName "cocoa", False)
]
(\dep -> trace ("accepting dep(?): " ++ display dep) True)
-- (Nothing :: Maybe (Index.PackageIndex PackageIdentifier))
buildPlatform
(CompilerId GHC (Cabal.Version [6,10,4] []))
[] pkgGenericDesc
pkgDesc = let deps = [ Dependency pn (Cabal.simplifyVersionRange vr)
| Dependency pn vr <- buildDepends pkgDesc0
]
in pkgDesc0 { buildDepends = deps }
hasBuildableExes p =
any (buildable . buildInfo)
. executables $ p
treatAsLibrary = (not . hasBuildableExes) pkgDesc && hasLibs pkgDesc
-- calculate build tools
bt = [ pkg' -- TODO: currently ignoring version range
| Cabal.Dependency (Cabal.PackageName pkg ) _range <- buildToolsDeps pkgDesc
, Just pkg' <- return (lookup pkg buildToolsTable)
]
packageNameResolver s = do
(Portage.PackageName (Portage.Category p_cat) (Cabal.PackageName pn))
<- Portage.resolveFullPortageName portage (Cabal.PackageName s)
return $ E.AnyVersionOf (p_cat </> pn)
-- calculate extra-libs
extra <- findCLibs verbosity packageNameResolver pkgDesc
debug verbosity ("Selected flags: " ++ show flags)
debug verbosity ("extra-libs: ")
mapM_ (debug verbosity . show) extra
debug verbosity ("build-tools:")
mapM_ (debug verbosity . show) bt
-- debug verbosity ("Finalized package:\n" ++ showPackageDescription pkgDesc)
-- TODO: more fixes
-- * inherit keywords from previous ebuilds
let d e = if treatAsLibrary
then Portage.showDepend (cabal_dep e)
: "${RDEPEND}"
: [ "${BUILDTOOLS}" | not . null $ build_tools e ]
else Portage.showDepend (cabal_dep e)
: Portage.showDepend (ghc_dep e)
: "${RDEPEND}"
: [ "${BUILDTOOLS}" | not . null $ build_tools e ]
++ [ "${HASKELLDEPS}" | not . null $ haskell_deps e ]
rd e = if treatAsLibrary
then Portage.showDepend (ghc_dep e)
: [ "${HASKELLDEPS}" | not . null $ haskell_deps e ]
++ [ "${EXTRALIBS}" | not . null $ extra_libs e ]
else [ "${EXTRALIBS}" | not . null $ extra_libs e ]
let ebuild = fixSrc serverURI (packageId pkgDesc)
. (\e -> e { depend = d e } )
. (\e -> e { rdepend = rd e } )
. (\e -> e { extra_libs = extra_libs e ++ extra } )
. (\e -> e { build_tools = build_tools e ++ bt } )
$ E.cabal2ebuild pkgDesc
debug verbosity ("Treat as library: " ++ show treatAsLibrary)
mergeEbuild verbosity overlayPath (Portage.unCategory cat) ebuild
fetchAndDigest
verbosity
(overlayPath </> display cat </> display norm_pkgName)
(display cabal_pkgId <.> "tar.gz")
(mkUri cabal_pkgId)
findCLibs :: Verbosity -> (String -> Maybe E.Dependency) -> PackageDescription -> IO [E.Dependency]
findCLibs verbosity portageResolver (PackageDescription { library = lib, executables = exes }) = do
debug verbosity "Mapping extra-libraries into portage packages..."
-- for extra libs we don't find, maybe look into into installed packages?
when (not . null $ notFound) $
warn verbosity ("Could not find portage packages for extra-libraries: " ++ unwords notFound)
when (not . null $ found) $
debug verbosity ("Found c-libraries deps: " ++ show found)
return found
where
resolvers = [ staticTranslateExtraLib, portageResolver ]
resolved = [ chain p resolvers
| p <- libE ++ exeE
] :: [Either String E.Dependency]
notFound = [ p | Left p <- resolved ]
found = [ p | Right p <- resolved ]
chain v [] = Left v
chain v (f:fs) = case f v of
Nothing -> chain v fs
Just x -> Right x
libE = maybe [] (extraLibs.libBuildInfo) lib
exeE = concatMap (extraLibs.buildInfo) exes
staticTranslateExtraLib :: String -> Maybe E.Dependency
staticTranslateExtraLib lib = lookup lib m
where
m = [ ("z", E.AnyVersionOf "sys-libs/zlib")
, ("bz2", E.AnyVersionOf "sys-libs/bzlib")
, ("mysqlclient", E.LaterVersionOf (Portage.Version [4,0] Nothing [] 0) "virtual/mysql")
, ("pq", E.LaterVersionOf (Portage.Version [7] Nothing [] 0) "virtual/postgresql-base")
, ("ev", E.AnyVersionOf "dev-libs/libev")
]
buildToolsDeps :: PackageDescription -> [Cabal.Dependency]
buildToolsDeps (PackageDescription { library = lib, executables = exes }) = cabalDeps
where
cabalDeps = depL ++ depE
depL = maybe [] (buildTools.libBuildInfo) lib
depE = concatMap (buildTools.buildInfo) exes
buildToolsTable :: [(String, E.Dependency)]
buildToolsTable =
[ ("happy", E.AnyVersionOf "dev-haskell/happy")
, ("alex", E.AnyVersionOf "dev-haskell/alex")
, ("c2hs", E.AnyVersionOf "dev-haskell/c2hs")
]
mkUri :: Cabal.PackageIdentifier -> URI
mkUri pid =
-- example:
-- http://hackage.haskell.org/packages/archive/Cabal/1.4.0.2/Cabal-1.4.0.2.tar.gz
fromJust $ parseURI $
"http://hackage.haskell.org/packages/archive/"
</> p_name </> p_ver </> p_name <-> p_ver <.> "tar.gz"
where
p_ver = display (packageVersion pid)
p_name = display (packageName pid)
fetchAndDigest :: Verbosity
-> FilePath -- ^ directory of ebuild
-> String -- ^ tarball name
-> URI -- ^ tarball uri
-> IO ()
fetchAndDigest verbosity ebuildDir tarballName tarballURI =
withWorkingDirectory ebuildDir $ do
repo_info <- Host.getInfo
let tarDestination = (Host.distfiles_dir repo_info) </> tarballName
downloadURI verbosity tarballURI tarDestination
-- Just err -> throwEx (E.DownloadFailed (show tarballURI) (show err))
-- TODO: downloadURI will throw a non-hackport exception if the
-- download fails
notice verbosity $ "Saved to " ++ tarDestination
notice verbosity "Recalculating digests..."
_ <- system "repoman manifest"
return ()
withWorkingDirectory :: FilePath -> IO a -> IO a
withWorkingDirectory newDir action = do
oldDir <- getCurrentDirectory
bracket
(setCurrentDirectory newDir)
(\_ -> setCurrentDirectory oldDir)
(\_ -> action)
mergeEbuild :: Verbosity -> FilePath -> String -> EBuild -> IO ()
mergeEbuild verbosity target cat ebuild = do
let edir = target </> cat </> name ebuild
elocal = name ebuild ++"-"++ version ebuild <.> "ebuild"
epath = edir </> elocal
createDirectoryIfMissing True edir
info verbosity $ "Writing " ++ elocal
writeFile epath (showEBuild ebuild)
fixSrc :: URI -> PackageIdentifier -> EBuild -> EBuild
fixSrc serverURI p ebuild =
ebuild {
src_uri = show $ serverURI {
uriPath =
uriPath serverURI
</> display (pkgName p)
</> display (pkgVersion p)
</> display (pkgName p) ++ "-" ++ display (pkgVersion p)
<.> "tar.gz"
},
E.homepage = case E.homepage ebuild of
"" -> "http://hackage.haskell.org/cgi-bin/hackage-scripts/package/"
++ display (pkgName p)
x -> x
}