    -----------------------------------------------------------------------------
    -- |
    -- Module      :  Distribution.Simple.Install
    -- Copyright   :  Isaac Jones 2003-2004
    --
    -- Maintainer  :  cabal-devel@haskell.org
    -- Portability :  portable
    --
    -- This is the entry point into installing a built package. Performs the
    -- \"@.\/setup install@\" and \"@.\/setup copy@\" actions. It moves files into
    -- place based on the prefix argument. It does the generic bits and then calls
    -- compiler-specific functions to do the rest.

    {- 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. -}

    module Distribution.Simple.Install (
            install,
      ) where

    import Distribution.PackageDescription (
            PackageDescription(..), BuildInfo(..), Library(..),
            hasLibs, withLib, hasExes, withExe )
    import Distribution.Package (Package(..))
    import Distribution.Simple.LocalBuildInfo (
            LocalBuildInfo(..), InstallDirs(..), absoluteInstallDirs,
            substPathTemplate)
    import Distribution.Simple.BuildPaths (haddockName, haddockPref)
    import Distribution.Simple.Utils
             ( createDirectoryIfMissingVerbose, installDirectoryContents
             , installOrdinaryFile, die, info, notice, matchDirFileGlob )
    import Distribution.Simple.Compiler
             ( CompilerFlavor(..), compilerFlavor )
    import Distribution.Simple.Setup (CopyFlags(..), CopyDest(..), fromFlag)

    import qualified Distribution.Simple.GHC  as GHC
    import qualified Distribution.Simple.NHC  as NHC
    import qualified Distribution.Simple.JHC  as JHC
    import qualified Distribution.Simple.LHC  as LHC
    import qualified Distribution.Simple.Hugs as Hugs
    import qualified Distribution.Simple.UHC  as UHC

    import Control.Monad (when, unless)
    import System.Directory
             ( doesDirectoryExist, doesFileExist )
    import System.FilePath
             ( takeFileName, takeDirectory, (</>), isAbsolute )

    import Distribution.Verbosity
    import Distribution.Text
             ( display )

    -- |Perform the \"@.\/setup install@\" and \"@.\/setup copy@\"
    -- actions.  Move files into place based on the prefix argument.  FIX:
    -- nhc isn't implemented yet.

    install :: PackageDescription -- ^information from the .cabal file
            -> LocalBuildInfo -- ^information from the configure step
            -> CopyFlags -- ^flags sent to copy or install
            -> IO ()
    install pkg_descr lbi flags = do
      let distPref  = fromFlag (copyDistPref flags)
          verbosity = fromFlag (copyVerbosity flags)
          copydest  = fromFlag (copyDest flags)
          installDirs@(InstallDirs {
             bindir     = binPref,
             libdir     = libPref,
    --         dynlibdir  = dynlibPref, --see TODO below
             datadir    = dataPref,
             progdir    = progPref,
             docdir     = docPref,
             htmldir    = htmlPref,
             haddockdir = interfacePref,
             includedir = incPref})
                 = absoluteInstallDirs pkg_descr lbi copydest

          --TODO: decide if we need the user to be able to control the libdir
          -- for shared libs independently of the one for static libs. If so
          -- it should also have a flag in the command line UI
          -- For the moment use dynlibdir = libdir
          dynlibPref = libPref
          progPrefixPref = substPathTemplate (packageId pkg_descr) lbi (progPrefix lbi)
          progSuffixPref = substPathTemplate (packageId pkg_descr) lbi (progSuffix lbi)

      docExists <- doesDirectoryExist $ haddockPref distPref pkg_descr
      info verbosity ("directory " ++ haddockPref distPref pkg_descr ++
                      " does exist: " ++ show docExists)

      installDataFiles verbosity pkg_descr dataPref

      when docExists $ do
          createDirectoryIfMissingVerbose verbosity True htmlPref
          installDirectoryContents verbosity
              (haddockPref distPref pkg_descr) htmlPref
          -- setPermissionsRecursive [Read] htmlPref
          -- The haddock interface file actually already got installed
          -- in the recursive copy, but now we install it where we actually
          -- want it to be (normally the same place). We could remove the
          -- copy in htmlPref first.
          let haddockInterfaceFileSrc  = haddockPref distPref pkg_descr
                                                       </> haddockName pkg_descr
              haddockInterfaceFileDest = interfacePref </> haddockName pkg_descr
          -- We only generate the haddock interface file for libs, So if the
          -- package consists only of executables there will not be one:
          exists <- doesFileExist haddockInterfaceFileSrc
          when exists $ do
            createDirectoryIfMissingVerbose verbosity True interfacePref
            installOrdinaryFile verbosity haddockInterfaceFileSrc
                                          haddockInterfaceFileDest

      let lfile = licenseFile pkg_descr
      unless (null lfile) $ do
        createDirectoryIfMissingVerbose verbosity True docPref
        installOrdinaryFile verbosity lfile (docPref </> takeFileName lfile)

      let buildPref = buildDir lbi
      when (hasLibs pkg_descr) $
        notice verbosity ("Installing library in " ++ libPref)
      when (hasExes pkg_descr) $
        notice verbosity ("Installing executable(s) in " ++ binPref)

      -- install include files for all compilers - they may be needed to compile
      -- haskell files (using the CPP extension)
      when (hasLibs pkg_descr) $ installIncludeFiles verbosity pkg_descr incPref

      case compilerFlavor (compiler lbi) of
         GHC  -> do withLib pkg_descr $
                      GHC.installLib verbosity lbi libPref dynlibPref buildPref pkg_descr
                    withExe pkg_descr $
                      GHC.installExe verbosity lbi installDirs buildPref (progPrefixPref, progSuffixPref) pkg_descr
         LHC  -> do withLib pkg_descr $
                      LHC.installLib verbosity lbi libPref dynlibPref buildPref pkg_descr
                    withExe pkg_descr $
                      LHC.installExe verbosity lbi installDirs buildPref (progPrefixPref, progSuffixPref) pkg_descr
         JHC  -> do withLib pkg_descr $
                      JHC.installLib verbosity libPref buildPref pkg_descr
                    withExe pkg_descr $
                      JHC.installExe verbosity binPref buildPref (progPrefixPref, progSuffixPref) pkg_descr
         Hugs -> do
           let targetProgPref = progdir (absoluteInstallDirs pkg_descr lbi NoCopyDest)
           let scratchPref = scratchDir lbi
           Hugs.install verbosity lbi libPref progPref binPref targetProgPref scratchPref (progPrefixPref, progSuffixPref) pkg_descr
         NHC  -> do withLib pkg_descr $ NHC.installLib verbosity libPref buildPref (packageId pkg_descr)
                    withExe pkg_descr $ NHC.installExe verbosity binPref buildPref (progPrefixPref, progSuffixPref)
         UHC  -> do withLib pkg_descr $ UHC.installLib verbosity lbi libPref dynlibPref buildPref pkg_descr
         _    -> die $ "installing with "
                    ++ display (compilerFlavor (compiler lbi))
                    ++ " is not implemented"
      return ()
      -- register step should be performed by caller.

    -- | Install the files listed in data-files
    --
    installDataFiles :: Verbosity -> PackageDescription -> FilePath -> IO ()
    installDataFiles verbosity pkg_descr destDataDir =
      flip mapM_ (dataFiles pkg_descr) $ \ file -> do
        let srcDataDir = dataDir pkg_descr
        files <- matchDirFileGlob srcDataDir file
        let dir = takeDirectory file
        createDirectoryIfMissingVerbose verbosity True (destDataDir </> dir)
        sequence_ [ installOrdinaryFile verbosity (srcDataDir  </> file')
                                                  (destDataDir </> file')
                  | file' <- files ]

    -- | Install the files listed in install-includes
    --
    installIncludeFiles :: Verbosity -> PackageDescription -> FilePath -> IO ()
    installIncludeFiles verbosity
      PackageDescription { library = Just lib } destIncludeDir = do

      incs <- mapM (findInc relincdirs) (installIncludes lbi)
      sequence_
        [ do createDirectoryIfMissingVerbose verbosity True destDir
             installOrdinaryFile verbosity srcFile destFile
        | (relFile, srcFile) <- incs
        , let destFile = destIncludeDir </> relFile
              destDir  = takeDirectory destFile ]
      where
       relincdirs = "." : filter (not.isAbsolute) (includeDirs lbi)
       lbi = libBuildInfo lib

       findInc []         file = die ("can't find include file " ++ file)
       findInc (dir:dirs) file = do
         let path = dir </> file
         exists <- doesFileExist path
         if exists then return (file, path) else findInc dirs file
    installIncludeFiles _ _ _ = die "installIncludeFiles: Can't happen?"