Register.hs 17.2 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 60
    register,
    unregister,

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

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

105
import System.FilePath ((</>), (<.>), isAbsolute)
Duncan Coutts's avatar
Duncan Coutts committed
106 107
import System.Directory
         ( getCurrentDirectory, removeDirectoryRecursive )
108
import System.IO.Error (try)
ijones's avatar
ijones committed
109

110
import Control.Monad (when)
Duncan Coutts's avatar
Duncan Coutts committed
111 112
import Data.Maybe
         ( isJust, fromMaybe )
113
import Data.List (partition)
simonmar's avatar
simonmar committed
114

115

simonmar's avatar
simonmar committed
116 117 118
-- -----------------------------------------------------------------------------
-- Registration

ijones's avatar
ijones committed
119
register :: PackageDescription -> LocalBuildInfo
ijones's avatar
ijones committed
120
         -> RegisterFlags -- ^Install in the user's database?; verbose
ijones's avatar
ijones committed
121
         -> IO ()
Duncan Coutts's avatar
Duncan Coutts committed
122 123
register pkg@PackageDescription { library       = Just lib  }
         lbi@LocalBuildInfo     { libraryConfig = Just clbi } regFlags
124 125 126 127 128 129 130 131 132 133 134
  = do

    installedPkgInfo <- generateRegistrationInfo
                           verbosity pkg lib lbi clbi inplace distPref

     -- Three different modes:
    case () of
     _ | modeGenerateRegFile   -> writeRegistrationFile installedPkgInfo
       | modeGenerateRegScript -> writeRegisterScript   installedPkgInfo
       | otherwise             -> registerPackage verbosity
                                    installedPkgInfo pkg lbi inplace packageDb
Duncan Coutts's avatar
Duncan Coutts committed
135 136 137 138 139 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)
    packageDb = fromFlagOrDefault (registrationPackageDB (withPackageDB lbi))
                                  (regPackageDB regFlags)
    distPref  = fromFlag (regDistPref regFlags)
    verbosity = fromFlag (regVerbosity regFlags)

149
    writeRegistrationFile installedPkgInfo = do
Duncan Coutts's avatar
Duncan Coutts committed
150
      notice verbosity ("Creating package registration file: " ++ regFile)
151
      writeUTF8File regFile (showInstalledPackageInfo installedPkgInfo)
Duncan Coutts's avatar
Duncan Coutts committed
152

153
    writeRegisterScript installedPkgInfo =
Duncan Coutts's avatar
Duncan Coutts committed
154 155
      case compilerFlavor (compiler lbi) of
        GHC  -> do (ghcPkg, _) <- requireProgram verbosity ghcPkgProgram (withPrograms lbi)
156
                   writeHcPkgRegisterScript verbosity installedPkgInfo ghcPkg packageDb
Duncan Coutts's avatar
Duncan Coutts committed
157
        LHC  -> do (lhcPkg, _) <- requireProgram verbosity lhcPkgProgram (withPrograms lbi)
158
                   writeHcPkgRegisterScript verbosity installedPkgInfo lhcPkg packageDb
Duncan Coutts's avatar
Duncan Coutts committed
159 160 161 162 163 164 165 166 167 168
        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"
        _    -> die "Registration scripts are not implemented for this compiler"

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


169 170
generateRegistrationInfo :: Verbosity
                         -> PackageDescription
Duncan Coutts's avatar
Duncan Coutts committed
171 172 173 174 175 176
                         -> Library
                         -> LocalBuildInfo
                         -> ComponentLocalBuildInfo
                         -> Bool
                         -> FilePath
                         -> IO InstalledPackageInfo
177
generateRegistrationInfo verbosity pkg lib lbi clbi inplace distPref = do
Duncan Coutts's avatar
Duncan Coutts committed
178 179
  --TODO: eliminate pwd!
  pwd <- getCurrentDirectory
180

181 182
  --TODO: the method of setting the InstalledPackageId is compiler specific
  --      this aspect should be delegated to a per-compiler helper.
183
  let comp = compiler lbi
184 185 186 187 188 189 190
  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)))
191

Duncan Coutts's avatar
Duncan Coutts committed
192 193 194 195 196
  let installedPkgInfo
        | inplace   = inplaceInstalledPackageInfo pwd distPref
                        pkg lib lbi clbi
        | otherwise = absoluteInstalledPackageInfo
                        pkg lib lbi clbi
197

198 199 200
  return installedPkgInfo{ IPI.installedPackageId = ipid }


Duncan Coutts's avatar
Duncan Coutts committed
201
registerPackage :: Verbosity
202
                -> InstalledPackageInfo
Duncan Coutts's avatar
Duncan Coutts committed
203 204 205 206 207
                -> PackageDescription
                -> LocalBuildInfo
                -> Bool
                -> PackageDB
                -> IO ()
208
registerPackage verbosity installedPkgInfo pkg lbi inplace packageDb = do
Duncan Coutts's avatar
Duncan Coutts committed
209 210
  setupMessage verbosity "Registering" (packageId pkg)
  case compilerFlavor (compiler lbi) of
211 212 213
    GHC  -> registerPackageGHC  verbosity installedPkgInfo pkg lbi inplace packageDb
    LHC  -> registerPackageLHC  verbosity installedPkgInfo pkg lbi inplace packageDb
    Hugs -> registerPackageHugs verbosity installedPkgInfo pkg lbi inplace packageDb
Duncan Coutts's avatar
Duncan Coutts committed
214 215 216 217 218 219 220
    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"


registerPackageGHC, registerPackageLHC, registerPackageHugs
  :: Verbosity
221
  -> InstalledPackageInfo
Duncan Coutts's avatar
Duncan Coutts committed
222 223 224 225 226
  -> PackageDescription
  -> LocalBuildInfo
  -> Bool
  -> PackageDB
  -> IO ()
227
registerPackageGHC verbosity installedPkgInfo _pkg lbi _inplace packageDb = do
Duncan Coutts's avatar
Duncan Coutts committed
228 229 230
  let Just ghcPkg = lookupProgram ghcPkgProgram (withPrograms lbi)
  HcPkg.reregister verbosity ghcPkg packageDb (Right installedPkgInfo)

231
registerPackageLHC verbosity installedPkgInfo _pkg lbi _inplace packageDb = do
Duncan Coutts's avatar
Duncan Coutts committed
232 233 234
  let Just lhcPkg = lookupProgram lhcPkgProgram (withPrograms lbi)
  HcPkg.reregister verbosity lhcPkg packageDb (Right installedPkgInfo)

235
registerPackageHugs verbosity installedPkgInfo pkg lbi inplace _packageDb = do
Duncan Coutts's avatar
Duncan Coutts committed
236
  when inplace $ die "--inplace is not supported with Hugs"
237
  let installDirs = absoluteInstallDirs pkg lbi NoCopyDest
Duncan Coutts's avatar
Duncan Coutts committed
238
  createDirectoryIfMissingVerbose verbosity True (libdir installDirs)
239 240
  writeUTF8File (libdir installDirs </> "package.conf")
                (showInstalledPackageInfo installedPkgInfo)
Duncan Coutts's avatar
Duncan Coutts committed
241 242 243


writeHcPkgRegisterScript :: Verbosity
244
                         -> InstalledPackageInfo
Duncan Coutts's avatar
Duncan Coutts committed
245 246 247
                         -> ConfiguredProgram
                         -> PackageDB
                         -> IO ()
248
writeHcPkgRegisterScript verbosity installedPkgInfo hcPkg packageDb = do
Duncan Coutts's avatar
Duncan Coutts committed
249 250 251 252 253
  let invocation  = HcPkg.reregisterInvocation hcPkg Verbosity.normal
                      packageDb (Right installedPkgInfo)
      regScript   = invocationAsSystemScript buildOS   invocation

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

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

262

263 264 265
-- -----------------------------------------------------------------------------
-- Making the InstalledPackageInfo

Duncan Coutts's avatar
Duncan Coutts committed
266 267 268 269 270 271 272 273 274 275 276 277 278
-- | 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 {
279
    --TODO: do not open-code this conversion from PackageId to InstalledPackageId
280
    IPI.installedPackageId = InstalledPackageId (display (packageId pkg)),
281
    IPI.sourcePackageId    = packageId   pkg,
Duncan Coutts's avatar
Duncan Coutts committed
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
    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,
    IPI.description        = description pkg,
    IPI.category           = category    pkg,
    IPI.exposed            = libExposed  lib,
    IPI.exposedModules     = exposedModules lib,
    IPI.hiddenModules      = otherModules bi,
    IPI.importDirs         = [ libdir installDirs | hasModules ],
    IPI.libraryDirs        = if hasLibrary
                               then libdir installDirs : extraLibDirs bi
                               else                      extraLibDirs bi,
    IPI.hsLibraries        = [ "HS" ++ display (packageId pkg) | hasLibrary ],
    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 335 336 337 338
    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 =
    generalInstalledPackageInfo adjustReativeIncludeDirs pkg lib clbi installDirs
  where
    adjustReativeIncludeDirs = map (inplaceDir </>)
    installDirs =
339
      (absoluteInstallDirs pkg lbi NoCopyDest) {
Duncan Coutts's avatar
Duncan Coutts committed
340 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
        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
370
    installDirs = absoluteInstallDirs pkg lbi NoCopyDest
Duncan Coutts's avatar
Duncan Coutts committed
371

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

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

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