Register.hs 17.5 KB
Newer Older
1 2
-----------------------------------------------------------------------------
-- |
ijones's avatar
ijones committed
3
-- Module      :  Distribution.Simple.Register
4
-- Copyright   :  Isaac Jones 2003-2004
5
--
Duncan Coutts's avatar
Duncan Coutts committed
6
-- Maintainer  :  cabal-devel@haskell.org
ijones's avatar
ijones committed
7
-- Portability :  portable
8
--
Duncan Coutts's avatar
Duncan Coutts committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
-- This module deals with registering and unregistering packages. There are a
-- couple ways it can do this, one is to do it directly. Another is to generate
-- a script that can be run later to do it. The idea here being that the user
-- is shielded from the details of what command to use for package registration
-- for a particular compiler. In practice this aspect was not especially
-- popular so we also provide a way to simply generate the package registration
-- file which then must be manually passed to @ghc-pkg@. It is possible to
-- generate registration information for where the package is to be installed,
-- or alternatively to register the package inplace in the build tree. The
-- latter is occasionally handy, and will become more important when we try to
-- build multi-package systems.
--
-- This module does not delegate anything to the per-compiler modules but just
-- mixes it all in in this module, which is rather unsatisfactory. The script
-- generation and the unregister feature are not well used or tested.
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

{- Copyright (c) 2003-2004, Isaac Jones
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.

    * Redistributions in binary form must reproduce the above
      copyright notice, this list of conditions and the following
      disclaimer in the documentation and/or other materials provided
      with the distribution.

    * Neither the name of Isaac Jones nor the names of other
      contributors may be used to endorse or promote products derived
      from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -}

56
module Distribution.Simple.Register (
Duncan Coutts's avatar
Duncan Coutts committed
57 58 59
    register,
    unregister,

60
    initPackageDB,
Duncan Coutts's avatar
Duncan Coutts committed
61
    registerPackage,
62
    generateRegistrationInfo,
Duncan Coutts's avatar
Duncan Coutts committed
63 64 65
    inplaceInstalledPackageInfo,
    absoluteInstalledPackageInfo,
    generalInstalledPackageInfo,
66
  ) where
67

68 69
import Distribution.Simple.LocalBuildInfo
         ( LocalBuildInfo(..), ComponentLocalBuildInfo(..)
70
         , ComponentName(..), getComponentLocalBuildInfo
71
         , LibraryName(..)
72
         , InstallDirs(..), absoluteInstallDirs )
73
import Distribution.Simple.BuildPaths (haddockName)
74 75 76
import qualified Distribution.Simple.GHC  as GHC
import qualified Distribution.Simple.LHC  as LHC
import qualified Distribution.Simple.Hugs as Hugs
77
import qualified Distribution.Simple.UHC  as UHC
78
import Distribution.Simple.Compiler
79
         ( compilerVersion, Compiler, CompilerFlavor(..), compilerFlavor
80
         , PackageDBStack, registrationPackageDB )
Duncan Coutts's avatar
Duncan Coutts committed
81
import Distribution.Simple.Program
82 83 84
         ( ProgramConfiguration, ConfiguredProgram
         , runProgramInvocation, requireProgram, lookupProgram
         , ghcPkgProgram, lhcPkgProgram )
Duncan Coutts's avatar
Duncan Coutts committed
85 86 87
import Distribution.Simple.Program.Script
         ( invocationAsSystemScript )
import qualified Distribution.Simple.Program.HcPkg as HcPkg
88 89 90
import Distribution.Simple.Setup
         ( RegisterFlags(..), CopyDest(..)
         , fromFlag, fromFlagOrDefault, flagToMaybe )
Duncan Coutts's avatar
Duncan Coutts committed
91 92
import Distribution.PackageDescription
         ( PackageDescription(..), Library(..), BuildInfo(..), hcOptions )
93
import Distribution.Package
94
         ( Package(..), packageName, InstalledPackageId(..) )
95
import Distribution.InstalledPackageInfo
96 97
         ( InstalledPackageInfo, InstalledPackageInfo_(InstalledPackageInfo)
         , showInstalledPackageInfo )
98
import qualified Distribution.InstalledPackageInfo as IPI
99
import Distribution.Simple.Utils
100
         ( writeUTF8File, writeFileAtomic, setFileExecutable
Duncan Coutts's avatar
Duncan Coutts committed
101
         , die, notice, setupMessage )
102
import Distribution.System
103
         ( OS(..), buildOS )
104 105
import Distribution.Text
         ( display )
106
import Distribution.Version ( Version(..) )
Duncan Coutts's avatar
Duncan Coutts committed
107 108
import Distribution.Verbosity as Verbosity
         ( Verbosity, normal )
109 110
import Distribution.Compat.Exception
         ( tryIO )
111

112
import System.FilePath ((</>), (<.>), isAbsolute)
Duncan Coutts's avatar
Duncan Coutts committed
113 114
import System.Directory
         ( getCurrentDirectory, removeDirectoryRecursive )
ijones's avatar
ijones committed
115

Duncan Coutts's avatar
Duncan Coutts committed
116
import Data.Maybe
117
         ( isJust, fromMaybe, maybeToList )
Duncan Coutts's avatar
Duncan Coutts committed
118 119
import Data.List
         ( partition, nub )
120
import qualified Data.ByteString.Lazy.Char8 as BS.Char8
121

simonmar's avatar
simonmar committed
122 123 124
-- -----------------------------------------------------------------------------
-- Registration

ijones's avatar
ijones committed
125
register :: PackageDescription -> LocalBuildInfo
ijones's avatar
ijones committed
126
         -> RegisterFlags -- ^Install in the user's database?; verbose
ijones's avatar
ijones committed
127
         -> IO ()
128
register pkg@PackageDescription { library       = Just lib  } lbi regFlags
129
  = do
130
    let clbi = getComponentLocalBuildInfo lbi CLibName
131 132 133 134 135 136 137 138
    installedPkgInfo <- generateRegistrationInfo
                           verbosity pkg lib lbi clbi inplace distPref

     -- Three different modes:
    case () of
     _ | modeGenerateRegFile   -> writeRegistrationFile installedPkgInfo
       | modeGenerateRegScript -> writeRegisterScript   installedPkgInfo
       | otherwise             -> registerPackage verbosity
139
                                    installedPkgInfo pkg lbi inplace packageDbs
Duncan Coutts's avatar
Duncan Coutts committed
140 141 142 143 144 145 146 147 148

  where
    modeGenerateRegFile = isJust (flagToMaybe (regGenPkgConf regFlags))
    regFile             = fromMaybe (display (packageId pkg) <.> "conf")
                                    (fromFlag (regGenPkgConf regFlags))

    modeGenerateRegScript = fromFlag (regGenScript regFlags)

    inplace   = fromFlag (regInPlace regFlags)
Duncan Coutts's avatar
Duncan Coutts committed
149 150 151 152 153
    -- FIXME: there's really no guarantee this will work.
    -- registering into a totally different db stack can
    -- fail if dependencies cannot be satisfied.
    packageDbs = nub $ withPackageDB lbi
                    ++ maybeToList (flagToMaybe  (regPackageDB regFlags))
Duncan Coutts's avatar
Duncan Coutts committed
154 155 156
    distPref  = fromFlag (regDistPref regFlags)
    verbosity = fromFlag (regVerbosity regFlags)

157
    writeRegistrationFile installedPkgInfo = do
Duncan Coutts's avatar
Duncan Coutts committed
158
      notice verbosity ("Creating package registration file: " ++ regFile)
159
      writeUTF8File regFile (showInstalledPackageInfo installedPkgInfo)
Duncan Coutts's avatar
Duncan Coutts committed
160

161
    writeRegisterScript installedPkgInfo =
Duncan Coutts's avatar
Duncan Coutts committed
162 163
      case compilerFlavor (compiler lbi) of
        GHC  -> do (ghcPkg, _) <- requireProgram verbosity ghcPkgProgram (withPrograms lbi)
164
                   writeHcPkgRegisterScript verbosity installedPkgInfo ghcPkg packageDbs
Duncan Coutts's avatar
Duncan Coutts committed
165
        LHC  -> do (lhcPkg, _) <- requireProgram verbosity lhcPkgProgram (withPrograms lbi)
166
                   writeHcPkgRegisterScript verbosity installedPkgInfo lhcPkg packageDbs
Duncan Coutts's avatar
Duncan Coutts committed
167 168 169
        Hugs -> notice verbosity "Registration scripts not needed for hugs"
        JHC  -> notice verbosity "Registration scripts not needed for jhc"
        NHC  -> notice verbosity "Registration scripts not needed for nhc98"
170
        UHC  -> notice verbosity "Registration scripts not needed for uhc"
Duncan Coutts's avatar
Duncan Coutts committed
171 172 173 174 175 176 177
        _    -> die "Registration scripts are not implemented for this compiler"

register _ _ regFlags = notice verbosity "No package to register"
  where
    verbosity = fromFlag (regVerbosity regFlags)


178 179
generateRegistrationInfo :: Verbosity
                         -> PackageDescription
Duncan Coutts's avatar
Duncan Coutts committed
180 181 182 183 184 185
                         -> Library
                         -> LocalBuildInfo
                         -> ComponentLocalBuildInfo
                         -> Bool
                         -> FilePath
                         -> IO InstalledPackageInfo
186
generateRegistrationInfo verbosity pkg lib lbi clbi inplace distPref = do
Duncan Coutts's avatar
Duncan Coutts committed
187 188
  --TODO: eliminate pwd!
  pwd <- getCurrentDirectory
189

190 191
  --TODO: the method of setting the InstalledPackageId is compiler specific
  --      this aspect should be delegated to a per-compiler helper.
192
  let comp = compiler lbi
193 194 195 196 197 198 199
  ipid <-
    case compilerFlavor comp of
     GHC | compilerVersion comp >= Version [6,11] [] -> do
            s <- GHC.libAbiHash verbosity pkg lbi lib clbi
            return (InstalledPackageId (display (packageId pkg) ++ '-':s))
     _other -> do
            return (InstalledPackageId (display (packageId pkg)))
200

Duncan Coutts's avatar
Duncan Coutts committed
201 202 203 204 205
  let installedPkgInfo
        | inplace   = inplaceInstalledPackageInfo pwd distPref
                        pkg lib lbi clbi
        | otherwise = absoluteInstalledPackageInfo
                        pkg lib lbi clbi
206

207 208 209
  return installedPkgInfo{ IPI.installedPackageId = ipid }


210 211 212 213 214 215 216 217
-- | Create an empty package DB at the specified location.
initPackageDB :: Verbosity -> Compiler -> ProgramConfiguration -> FilePath
                 -> IO ()
initPackageDB verbosity comp conf dbPath =
  case (compilerFlavor comp) of
    GHC -> GHC.initPackageDB verbosity conf dbPath
    _   -> die "initPackageDB is not implemented for this compiler"

Duncan Coutts's avatar
Duncan Coutts committed
218
registerPackage :: Verbosity
219
                -> InstalledPackageInfo
Duncan Coutts's avatar
Duncan Coutts committed
220 221 222
                -> PackageDescription
                -> LocalBuildInfo
                -> Bool
223
                -> PackageDBStack
Duncan Coutts's avatar
Duncan Coutts committed
224
                -> IO ()
225
registerPackage verbosity installedPkgInfo pkg lbi inplace packageDbs = do
refold's avatar
refold committed
226 227 228 229
  let msg = if inplace
            then "In-place registering"
            else "Registering"
  setupMessage verbosity msg (packageId pkg)
Duncan Coutts's avatar
Duncan Coutts committed
230
  case compilerFlavor (compiler lbi) of
231 232 233
    GHC  -> GHC.registerPackage  verbosity installedPkgInfo pkg lbi inplace packageDbs
    LHC  -> LHC.registerPackage  verbosity installedPkgInfo pkg lbi inplace packageDbs
    Hugs -> Hugs.registerPackage verbosity installedPkgInfo pkg lbi inplace packageDbs
234
    UHC  -> UHC.registerPackage  verbosity installedPkgInfo pkg lbi inplace packageDbs
Duncan Coutts's avatar
Duncan Coutts committed
235 236 237 238 239 240
    JHC  -> notice verbosity "Registering for jhc (nothing to do)"
    NHC  -> notice verbosity "Registering for nhc98 (nothing to do)"
    _    -> die "Registering is not implemented for this compiler"


writeHcPkgRegisterScript :: Verbosity
241
                         -> InstalledPackageInfo
Duncan Coutts's avatar
Duncan Coutts committed
242
                         -> ConfiguredProgram
243
                         -> PackageDBStack
Duncan Coutts's avatar
Duncan Coutts committed
244
                         -> IO ()
245
writeHcPkgRegisterScript verbosity installedPkgInfo hcPkg packageDbs = do
Duncan Coutts's avatar
Duncan Coutts committed
246
  let invocation  = HcPkg.reregisterInvocation hcPkg Verbosity.normal
247
                      packageDbs (Right installedPkgInfo)
Duncan Coutts's avatar
Duncan Coutts committed
248 249 250
      regScript   = invocationAsSystemScript buildOS   invocation

  notice verbosity ("Creating package registration script: " ++ regScriptFileName)
251
  writeUTF8File regScriptFileName regScript
Duncan Coutts's avatar
Duncan Coutts committed
252 253 254 255 256 257
  setFileExecutable regScriptFileName

regScriptFileName :: FilePath
regScriptFileName = case buildOS of
                        Windows -> "register.bat"
                        _       -> "register.sh"
simonmar's avatar
simonmar committed
258

259

260 261 262
-- -----------------------------------------------------------------------------
-- Making the InstalledPackageInfo

Duncan Coutts's avatar
Duncan Coutts committed
263 264 265 266 267 268 269 270 271 272 273 274 275
-- | Construct 'InstalledPackageInfo' for a library in a package, given a set
-- of installation directories.
--
generalInstalledPackageInfo
  :: ([FilePath] -> [FilePath]) -- ^ Translate relative include dir paths to
                                -- absolute paths.
  -> PackageDescription
  -> Library
  -> ComponentLocalBuildInfo
  -> InstallDirs FilePath
  -> InstalledPackageInfo
generalInstalledPackageInfo adjustRelIncDirs pkg lib clbi installDirs =
  InstalledPackageInfo {
276
    --TODO: do not open-code this conversion from PackageId to InstalledPackageId
277
    IPI.installedPackageId = InstalledPackageId (display (packageId pkg)),
278
    IPI.sourcePackageId    = packageId   pkg,
Duncan Coutts's avatar
Duncan Coutts committed
279 280 281 282 283 284 285
    IPI.license            = license     pkg,
    IPI.copyright          = copyright   pkg,
    IPI.maintainer         = maintainer  pkg,
    IPI.author             = author      pkg,
    IPI.stability          = stability   pkg,
    IPI.homepage           = homepage    pkg,
    IPI.pkgUrl             = pkgUrl      pkg,
286
    IPI.synopsis           = synopsis    pkg,
Duncan Coutts's avatar
Duncan Coutts committed
287 288 289 290 291
    IPI.description        = description pkg,
    IPI.category           = category    pkg,
    IPI.exposed            = libExposed  lib,
    IPI.exposedModules     = exposedModules lib,
    IPI.hiddenModules      = otherModules bi,
292
    IPI.trusted            = IPI.trusted IPI.emptyInstalledPackageInfo,
Duncan Coutts's avatar
Duncan Coutts committed
293 294 295 296
    IPI.importDirs         = [ libdir installDirs | hasModules ],
    IPI.libraryDirs        = if hasLibrary
                               then libdir installDirs : extraLibDirs bi
                               else                      extraLibDirs bi,
refold's avatar
refold committed
297 298
    IPI.hsLibraries        = [ libname
                             | LibraryName libname <- componentLibraries clbi ],
Duncan Coutts's avatar
Duncan Coutts committed
299 300 301 302
    IPI.extraLibraries     = extraLibs bi,
    IPI.extraGHCiLibraries = [],
    IPI.includeDirs        = absinc ++ adjustRelIncDirs relinc,
    IPI.includes           = includes bi,
303
    IPI.depends            = map fst (componentPackageDeps clbi),
Duncan Coutts's avatar
Duncan Coutts committed
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
    IPI.hugsOptions        = hcOptions Hugs bi,
    IPI.ccOptions          = [], -- Note. NOT ccOptions bi!
                                 -- We don't want cc-options to be propagated
                                 -- to C compilations in other packages.
    IPI.ldOptions          = ldOptions bi,
    IPI.frameworkDirs      = [],
    IPI.frameworks         = frameworks bi,
    IPI.haddockInterfaces  = [haddockdir installDirs </> haddockName pkg],
    IPI.haddockHTMLs       = [htmldir installDirs]
  }
  where
    bi = libBuildInfo lib
    (absinc, relinc) = partition isAbsolute (includeDirs bi)
    hasModules = not $ null (exposedModules lib)
                    && null (otherModules bi)
    hasLibrary = hasModules || not (null (cSources bi))


-- | Construct 'InstalledPackageInfo' for a library that is inplace in the
-- build tree.
--
-- This function knows about the layout of inplace packages.
--
inplaceInstalledPackageInfo :: FilePath -- ^ top of the build tree
                            -> FilePath -- ^ location of the dist tree
                            -> PackageDescription
                            -> Library
                            -> LocalBuildInfo
                            -> ComponentLocalBuildInfo
                            -> InstalledPackageInfo
inplaceInstalledPackageInfo inplaceDir distPref pkg lib lbi clbi =
refold's avatar
refold committed
335 336
    generalInstalledPackageInfo adjustRelativeIncludeDirs pkg lib clbi
    installDirs
Duncan Coutts's avatar
Duncan Coutts committed
337
  where
refold's avatar
refold committed
338
    adjustRelativeIncludeDirs = map (inplaceDir </>)
Duncan Coutts's avatar
Duncan Coutts committed
339
    installDirs =
340
      (absoluteInstallDirs pkg lbi NoCopyDest) {
Duncan Coutts's avatar
Duncan Coutts committed
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
        libdir     = inplaceDir </> buildDir lbi,
        datadir    = inplaceDir,
        datasubdir = distPref,
        docdir     = inplaceDocdir,
        htmldir    = inplaceHtmldir,
        haddockdir = inplaceHtmldir
      }
    inplaceDocdir  = inplaceDir </> distPref </> "doc"
    inplaceHtmldir = inplaceDocdir </> "html" </> display (packageName pkg)


-- | Construct 'InstalledPackageInfo' for the final install location of a
-- library package.
--
-- This function knows about the layout of installed packages.
--
absoluteInstalledPackageInfo :: PackageDescription
                             -> Library
                             -> LocalBuildInfo
                             -> ComponentLocalBuildInfo
                             -> InstalledPackageInfo
absoluteInstalledPackageInfo pkg lib lbi clbi =
    generalInstalledPackageInfo adjustReativeIncludeDirs pkg lib clbi installDirs
  where
    -- For installed packages we install all include files into one dir,
    -- whereas in the build tree they may live in multiple local dirs.
    adjustReativeIncludeDirs _
      | null (installIncludes bi) = []
      | otherwise                 = [includedir installDirs]
    bi = libBuildInfo lib
371
    installDirs = absoluteInstallDirs pkg lbi NoCopyDest
Duncan Coutts's avatar
Duncan Coutts committed
372

simonmar's avatar
simonmar committed
373 374
-- -----------------------------------------------------------------------------
-- Unregistration
375

ijones's avatar
ijones committed
376
unregister :: PackageDescription -> LocalBuildInfo -> RegisterFlags -> IO ()
Duncan Coutts's avatar
Duncan Coutts committed
377 378 379
unregister pkg lbi regFlags = do
  let pkgid     = packageId pkg
      genScript = fromFlag (regGenScript regFlags)
380
      verbosity = fromFlag (regVerbosity regFlags)
Duncan Coutts's avatar
Duncan Coutts committed
381
      packageDb = fromFlagOrDefault (registrationPackageDB (withPackageDB lbi))
382
                                    (regPackageDB regFlags)
383
      installDirs = absoluteInstallDirs pkg lbi NoCopyDest
Duncan Coutts's avatar
Duncan Coutts committed
384
  setupMessage verbosity "Unregistering" pkgid
385
  case compilerFlavor (compiler lbi) of
Duncan Coutts's avatar
Duncan Coutts committed
386 387 388 389 390 391
    GHC ->
      let Just ghcPkg = lookupProgram ghcPkgProgram (withPrograms lbi)
          invocation = HcPkg.unregisterInvocation ghcPkg Verbosity.normal
                         packageDb pkgid
      in if genScript
           then writeFileAtomic unregScriptFileName
392
                  (BS.Char8.pack $ invocationAsSystemScript buildOS invocation)
Duncan Coutts's avatar
Duncan Coutts committed
393
            else runProgramInvocation verbosity invocation
ijones's avatar
ijones committed
394
    Hugs -> do
395
        _ <- tryIO $ removeDirectoryRecursive (libdir installDirs)
396
        return ()
397
    NHC -> do
398
        _ <- tryIO $ removeDirectoryRecursive (libdir installDirs)
399
        return ()
ijones's avatar
ijones committed
400
    _ ->
401
        die ("only unregistering with GHC and Hugs is implemented")
ijones's avatar
ijones committed
402

Duncan Coutts's avatar
Duncan Coutts committed
403 404 405 406
unregScriptFileName :: FilePath
unregScriptFileName = case buildOS of
                          Windows -> "unregister.bat"
                          _       -> "unregister.sh"