1 {-# OPTIONS -fglasgow-exts #-}
2 -----------------------------------------------------------------------------
4 -- (c) The University of Glasgow 2004.
6 -- Package management tool
8 -----------------------------------------------------------------------------
12 -- * expanding of variables in new-style package conf
13 -- * version manipulation (checking whether old version exists,
14 -- hiding old version?)
16 module Main (main) where
18 import Version ( version, targetOS, targetARCH )
19 import Distribution.InstalledPackageInfo
20 import Distribution.Compat.ReadP
21 import Distribution.ParseUtils
22 import Distribution.Package
23 import Distribution.Version
24 import System.FilePath
27 import Compat.Directory ( getAppUserDataDirectory, createDirectoryIfMissing )
28 import Compat.RawSystem ( rawSystem )
30 import System.Directory ( getAppUserDataDirectory, createDirectoryIfMissing )
31 import System.Cmd ( rawSystem )
36 #include "../../includes/ghcconfig.h"
38 import System.Console.GetOpt
39 import Text.PrettyPrint
40 import qualified Control.Exception as Exception
43 import Data.Char ( isSpace, toLower )
46 import System ( getArgs, getProgName, getEnv, exitWith, ExitCode(..) )
48 import System.IO.Error (try)
49 import Data.List ( isPrefixOf, isSuffixOf, intersperse, sortBy )
51 #ifdef mingw32_HOST_OS
53 import Foreign.C.String
56 import IO ( isPermissionError, isDoesNotExistError )
58 -- -----------------------------------------------------------------------------
65 case getOpt Permute (flags ++ deprecFlags) args of
66 (cli,_,[]) | FlagHelp `elem` cli -> do
67 prog <- getProgramName
68 bye (usageInfo (usageHeader prog) flags)
69 (cli,_,[]) | FlagVersion `elem` cli ->
74 prog <- getProgramName
75 die (concat errors ++ usageInfo (usageHeader prog) flags)
77 -- -----------------------------------------------------------------------------
78 -- Command-line syntax
86 | FlagGlobalConfig FilePath
94 flags :: [OptDescr Flag]
96 Option [] ["user"] (NoArg FlagUser)
97 "use the current user's package database",
98 Option [] ["global"] (NoArg FlagGlobal)
99 "(default) use the global package database",
100 Option ['f'] ["package-conf"] (ReqArg FlagConfig "FILE")
101 "act upon specified package config file (only)",
102 Option [] ["global-conf"] (ReqArg FlagGlobalConfig "FILE")
103 "location of the global package config",
104 Option [] ["force"] (NoArg FlagForce)
105 "ignore missing dependencies, directories, and libraries",
106 Option [] ["force-files"] (NoArg FlagForceFiles)
107 "ignore missing directories and libraries only",
108 Option ['g'] ["auto-ghci-libs"] (NoArg FlagAutoGHCiLibs)
109 "automatically build libs for GHCi (with register)",
110 Option ['?'] ["help"] (NoArg FlagHelp)
111 "display this help and exit",
112 Option ['V'] ["version"] (NoArg FlagVersion)
113 "output version information and exit",
114 Option [] ["simple-output"] (NoArg FlagSimpleOutput)
115 "print output in easy-to-parse format for some commands",
116 Option [] ["names-only"] (NoArg FlagNamesOnly)
117 "only print package names, not versions; can only be used with list --simple-output"
120 deprecFlags :: [OptDescr Flag]
122 -- put deprecated flags here
125 ourCopyright :: String
126 ourCopyright = "GHC package manager version " ++ version ++ "\n"
128 usageHeader :: String -> String
129 usageHeader prog = substProg prog $
131 " $p register {filename | -}\n" ++
132 " Register the package using the specified installed package\n" ++
133 " description. The syntax for the latter is given in the $p\n" ++
134 " documentation.\n" ++
136 " $p update {filename | -}\n" ++
137 " Register the package, overwriting any other package with the\n" ++
140 " $p unregister {pkg-id}\n" ++
141 " Unregister the specified package.\n" ++
143 " $p expose {pkg-id}\n" ++
144 " Expose the specified package.\n" ++
146 " $p hide {pkg-id}\n" ++
147 " Hide the specified package.\n" ++
149 " $p list [pkg]\n" ++
150 " List registered packages in the global database, and also the\n" ++
151 " user database if --user is given. If a package name is given\n" ++
152 " all the registered versions will be listed in ascending order.\n" ++
153 " Accepts the --simple-output flag.\n" ++
155 " $p latest pkg\n" ++
156 " Prints the highest registered version of a package.\n" ++
159 " Check the consistency of package depenencies and list broken packages.\n" ++
160 " Accepts the --simple-output flag.\n" ++
162 " $p describe {pkg-id}\n" ++
163 " Give the registered description for the specified package. The\n" ++
164 " description is returned in precisely the syntax required by $p\n" ++
167 " $p field {pkg-id} {field}\n" ++
168 " Extract the specified field of the package description for the\n" ++
169 " specified package.\n" ++
171 " The following optional flags are also accepted:\n"
173 substProg :: String -> String -> String
175 substProg prog ('$':'p':xs) = prog ++ substProg prog xs
176 substProg prog (c:xs) = c : substProg prog xs
178 -- -----------------------------------------------------------------------------
181 data Force = ForceAll | ForceFiles | NoForce
183 runit :: [Flag] -> [String] -> IO ()
184 runit cli nonopts = do
185 prog <- getProgramName
188 | FlagForce `elem` cli = ForceAll
189 | FlagForceFiles `elem` cli = ForceFiles
190 | otherwise = NoForce
191 auto_ghci_libs = FlagAutoGHCiLibs `elem` cli
193 -- first, parse the command
195 ["register", filename] ->
196 registerPackage filename cli auto_ghci_libs False force
197 ["update", filename] ->
198 registerPackage filename cli auto_ghci_libs True force
199 ["unregister", pkgid_str] -> do
200 pkgid <- readGlobPkgId pkgid_str
201 unregisterPackage pkgid cli
202 ["expose", pkgid_str] -> do
203 pkgid <- readGlobPkgId pkgid_str
204 exposePackage pkgid cli
205 ["hide", pkgid_str] -> do
206 pkgid <- readGlobPkgId pkgid_str
207 hidePackage pkgid cli
209 listPackages cli Nothing Nothing
210 ["list", pkgid_str] -> do
211 pkgid <- readGlobPkgId pkgid_str
212 listPackages cli (Just pkgid) Nothing
213 ["find-module", moduleName] -> do
214 listPackages cli Nothing (Just moduleName)
215 ["latest", pkgid_str] -> do
216 pkgid <- readGlobPkgId pkgid_str
217 latestPackage cli pkgid
218 ["describe", pkgid_str] -> do
219 pkgid <- readGlobPkgId pkgid_str
220 describePackage cli pkgid
221 ["field", pkgid_str, field] -> do
222 pkgid <- readGlobPkgId pkgid_str
223 describeField cli pkgid field
227 die ("missing command\n" ++
228 usageInfo (usageHeader prog) flags)
230 die ("command-line syntax error\n" ++
231 usageInfo (usageHeader prog) flags)
233 parseCheck :: ReadP a a -> String -> String -> IO a
234 parseCheck parser str what =
235 case [ x | (x,ys) <- readP_to_S parser str, all isSpace ys ] of
237 _ -> die ("cannot parse \'" ++ str ++ "\' as a " ++ what)
239 readGlobPkgId :: String -> IO PackageIdentifier
240 readGlobPkgId str = parseCheck parseGlobPackageId str "package identifier"
242 parseGlobPackageId :: ReadP r PackageIdentifier
246 (do n <- parsePackageName; string "-*"
247 return (PackageIdentifier{ pkgName = n, pkgVersion = globVersion }))
249 -- globVersion means "all versions"
250 globVersion :: Version
251 globVersion = Version{ versionBranch=[], versionTags=["*"] }
253 -- -----------------------------------------------------------------------------
256 -- Some commands operate on a single database:
257 -- register, unregister, expose, hide
258 -- however these commands also check the union of the available databases
259 -- in order to check consistency. For example, register will check that
260 -- dependencies exist before registering a package.
262 -- Some commands operate on multiple databases, with overlapping semantics:
263 -- list, describe, field
265 type PackageDBName = FilePath
266 type PackageDB = [InstalledPackageInfo]
268 type PackageDBStack = [(PackageDBName,PackageDB)]
269 -- A stack of package databases. Convention: head is the topmost
270 -- in the stack. Earlier entries override later one.
272 getPkgDatabases :: Bool -> [Flag] -> IO PackageDBStack
273 getPkgDatabases modify flags = do
274 -- first we determine the location of the global package config. On Windows,
275 -- this is found relative to the ghc-pkg.exe binary, whereas on Unix the
276 -- location is passed to the binary using the --global-config flag by the
278 let err_msg = "missing --global-conf option, location of global package.conf unknown\n"
280 case [ f | FlagGlobalConfig f <- flags ] of
281 [] -> do mb_dir <- getExecDir "/bin/ghc-pkg.exe"
283 Nothing -> die err_msg
284 Just dir -> return (dir </> "package.conf")
285 fs -> return (last fs)
287 let global_conf_dir = global_conf ++ ".d"
288 global_conf_dir_exists <- doesDirectoryExist global_conf_dir
290 if global_conf_dir_exists
291 then do files <- getDirectoryContents global_conf_dir
292 return [ global_conf_dir ++ '/' : file
294 , isSuffixOf ".conf" file]
297 -- get the location of the user package database, and create it if necessary
298 appdir <- getAppUserDataDirectory "ghc"
301 subdir = targetARCH ++ '-':targetOS ++ '-':version
302 archdir = appdir </> subdir
303 user_conf = archdir </> "package.conf"
304 user_exists <- doesFileExist user_conf
306 -- If the user database doesn't exist, and this command isn't a
307 -- "modify" command, then we won't attempt to create or use it.
309 | modify || user_exists = user_conf : global_confs ++ [global_conf]
310 | otherwise = global_confs ++ [global_conf]
312 e_pkg_path <- try (getEnv "GHC_PACKAGE_PATH")
315 Left _ -> sys_databases
317 | last cs == "" -> init cs ++ sys_databases
319 where cs = splitSearchPath path
321 -- The "global" database is always the one at the bottom of the stack.
322 -- This is the database we modify by default.
323 virt_global_conf = last env_stack
325 -- -f flags on the command line add to the database stack, unless any
326 -- of them are present in the stack already.
327 let flag_stack = filter (`notElem` env_stack)
328 [ f | FlagConfig f <- reverse flags ] ++ env_stack
330 -- Now we have the full stack of databases. Next, if the current
331 -- command is a "modify" type command, then we truncate the stack
332 -- so that the topmost element is the database being modified.
335 then return flag_stack
337 go (FlagUser : fs) = modifying user_conf
338 go (FlagGlobal : fs) = modifying virt_global_conf
339 go (FlagConfig f : fs) = modifying f
341 go [] = modifying virt_global_conf
344 | f `elem` flag_stack = return (dropWhile (/= f) flag_stack)
345 | otherwise = die ("requesting modification of database:\n\t" ++ f ++ "\n\twhich is not in the database stack.")
349 db_stack <- mapM readParseDatabase final_stack
352 readParseDatabase :: PackageDBName -> IO (PackageDBName,PackageDB)
353 readParseDatabase filename = do
354 str <- readFile filename `Exception.catch` \_ -> return emptyPackageConfig
355 let packages = read str
356 Exception.evaluate packages
357 `Exception.catch` \_ ->
358 die (filename ++ ": parse error in package config file")
359 return (filename,packages)
361 emptyPackageConfig :: String
362 emptyPackageConfig = "[]"
364 -- -----------------------------------------------------------------------------
367 registerPackage :: FilePath
369 -> Bool -- auto_ghci_libs
373 registerPackage input flags auto_ghci_libs update force = do
374 db_stack <- getPkgDatabases True flags
376 db_to_operate_on = my_head "db" db_stack
377 db_filename = fst db_to_operate_on
383 putStr "Reading package info from stdin ... "
386 putStr ("Reading package info from " ++ show f ++ " ... ")
389 expanded <- expandEnvVars s force
391 pkg <- parsePackageInfo expanded
394 validatePackageConfig pkg db_stack auto_ghci_libs update force
395 let new_details = filter not_this (snd db_to_operate_on) ++ [pkg]
396 not_this p = package p /= package pkg
397 savingOldConfig db_filename $
398 writeNewConfig db_filename new_details
402 -> IO InstalledPackageInfo
403 parsePackageInfo str =
404 case parseInstalledPackageInfo str of
405 ParseOk _warns ok -> return ok
406 ParseFailed err -> case locatedErrorMsg err of
407 (Nothing, s) -> die s
408 (Just l, s) -> die (show l ++ ": " ++ s)
410 -- -----------------------------------------------------------------------------
411 -- Exposing, Hiding, Unregistering are all similar
413 exposePackage :: PackageIdentifier -> [Flag] -> IO ()
414 exposePackage = modifyPackage (\p -> [p{exposed=True}])
416 hidePackage :: PackageIdentifier -> [Flag] -> IO ()
417 hidePackage = modifyPackage (\p -> [p{exposed=False}])
419 unregisterPackage :: PackageIdentifier -> [Flag] -> IO ()
420 unregisterPackage = modifyPackage (\p -> [])
423 :: (InstalledPackageInfo -> [InstalledPackageInfo])
427 modifyPackage fn pkgid flags = do
428 db_stack <- getPkgDatabases True{-modify-} flags
429 let ((db_name, pkgs) : _) = db_stack
430 ps <- findPackages [(db_name,pkgs)] pkgid
431 let pids = map package ps
432 let new_config = concat (map modify pkgs)
434 | package pkg `elem` pids = fn pkg
436 savingOldConfig db_name $
437 writeNewConfig db_name new_config
439 -- -----------------------------------------------------------------------------
442 listPackages :: [Flag] -> Maybe PackageIdentifier -> Maybe String -> IO ()
443 listPackages flags mPackageName mModuleName = do
444 let simple_output = FlagSimpleOutput `elem` flags
445 db_stack <- getPkgDatabases False flags
446 let db_stack_filtered -- if a package is given, filter out all other packages
447 | Just this <- mPackageName =
448 map (\(conf,pkgs) -> (conf, filter (this `matchesPkg`) pkgs))
450 | Just this <- mModuleName = -- packages which expose mModuleName
451 map (\(conf,pkgs) -> (conf, filter (this `exposedInPkg`) pkgs))
453 | otherwise = db_stack
456 = [ (db, sort_pkgs pkgs) | (db,pkgs) <- db_stack_filtered ]
457 where sort_pkgs = sortBy cmpPkgIds
458 cmpPkgIds pkg1 pkg2 =
459 case pkgName p1 `compare` pkgName p2 of
462 EQ -> pkgVersion p1 `compare` pkgVersion p2
463 where (p1,p2) = (package pkg1, package pkg2)
465 pkg_map = map (\p -> (package p, p)) $ concatMap snd db_stack
466 show_func = if simple_output then show_simple else mapM_ (show_normal pkg_map)
468 show_func (reverse db_stack_sorted)
470 where show_normal pkg_map (db_name,pkg_confs) =
471 hPutStrLn stdout (render $
472 text db_name <> colon $$ nest 4 packages
474 where packages = fsep (punctuate comma (map pp_pkg pkg_confs))
476 | isBrokenPackage p pkg_map = braces doc
478 | otherwise = parens doc
479 where doc = text (showPackageId (package p))
481 show_simple db_stack = do
482 let showPkg = if FlagNamesOnly `elem` flags then pkgName
484 pkgs = map showPkg $ sortBy compPkgIdVer $
485 map package (concatMap snd db_stack)
486 when (null pkgs) $ die "no matches"
487 hPutStrLn stdout $ concat $ intersperse " " pkgs
489 -- -----------------------------------------------------------------------------
490 -- Prints the highest (hidden or exposed) version of a package
492 latestPackage :: [Flag] -> PackageIdentifier -> IO ()
493 latestPackage flags pkgid = do
494 db_stack <- getPkgDatabases False flags
495 ps <- findPackages db_stack pkgid
496 show_pkg (sortBy compPkgIdVer (map package ps))
498 show_pkg [] = die "no matches"
499 show_pkg pids = hPutStrLn stdout (showPackageId (last pids))
501 -- -----------------------------------------------------------------------------
504 describePackage :: [Flag] -> PackageIdentifier -> IO ()
505 describePackage flags pkgid = do
506 db_stack <- getPkgDatabases False flags
507 ps <- findPackages db_stack pkgid
508 mapM_ (putStrLn . showInstalledPackageInfo) ps
510 -- PackageId is can have globVersion for the version
511 findPackages :: PackageDBStack -> PackageIdentifier -> IO [InstalledPackageInfo]
512 findPackages db_stack pkgid
513 = case [ p | p <- all_pkgs, pkgid `matchesPkg` p ] of
514 [] -> die ("cannot find package " ++ showPackageId pkgid)
517 all_pkgs = concat (map snd db_stack)
519 matches :: PackageIdentifier -> PackageIdentifier -> Bool
521 = (pkgName pid == pkgName pid')
522 && (pkgVersion pid == pkgVersion pid' || not (realVersion pid))
524 matchesPkg :: PackageIdentifier -> InstalledPackageInfo -> Bool
525 pid `matchesPkg` pkg = pid `matches` package pkg
527 compPkgIdVer :: PackageIdentifier -> PackageIdentifier -> Ordering
528 compPkgIdVer p1 p2 = pkgVersion p1 `compare` pkgVersion p2
530 exposedInPkg :: String -> InstalledPackageInfo -> Bool
531 moduleName `exposedInPkg` pkg = moduleName `elem` exposedModules pkg
533 -- -----------------------------------------------------------------------------
536 describeField :: [Flag] -> PackageIdentifier -> String -> IO ()
537 describeField flags pkgid field = do
538 db_stack <- getPkgDatabases False flags
539 case toField field of
540 Nothing -> die ("unknown field: " ++ field)
542 ps <- findPackages db_stack pkgid
543 let top_dir = takeDirectory (fst (last db_stack))
544 mapM_ (putStrLn . fn) (mungePackagePaths top_dir ps)
546 mungePackagePaths :: String -> [InstalledPackageInfo] -> [InstalledPackageInfo]
547 -- Replace the strings "$topdir" and "$httptopdir" at the beginning of a path
548 -- with the current topdir (obtained from the -B option).
549 mungePackagePaths top_dir ps = map munge_pkg ps
551 munge_pkg p = p{ importDirs = munge_paths (importDirs p),
552 includeDirs = munge_paths (includeDirs p),
553 libraryDirs = munge_paths (libraryDirs p),
554 frameworkDirs = munge_paths (frameworkDirs p),
555 haddockInterfaces = munge_paths (haddockInterfaces p),
556 haddockHTMLs = munge_paths (haddockHTMLs p)
559 munge_paths = map munge_path
562 | Just p' <- maybePrefixMatch "$topdir" p = top_dir ++ p'
563 | Just p' <- maybePrefixMatch "$httptopdir" p = toHttpPath top_dir ++ p'
566 toHttpPath p = "file:///" ++ p
568 maybePrefixMatch :: String -> String -> Maybe String
569 maybePrefixMatch [] rest = Just rest
570 maybePrefixMatch (_:_) [] = Nothing
571 maybePrefixMatch (p:pat) (r:rest)
572 | p == r = maybePrefixMatch pat rest
573 | otherwise = Nothing
575 toField :: String -> Maybe (InstalledPackageInfo -> String)
576 -- backwards compatibility:
577 toField "import_dirs" = Just $ strList . importDirs
578 toField "source_dirs" = Just $ strList . importDirs
579 toField "library_dirs" = Just $ strList . libraryDirs
580 toField "hs_libraries" = Just $ strList . hsLibraries
581 toField "extra_libraries" = Just $ strList . extraLibraries
582 toField "include_dirs" = Just $ strList . includeDirs
583 toField "c_includes" = Just $ strList . includes
584 toField "package_deps" = Just $ strList . map showPackageId. depends
585 toField "extra_cc_opts" = Just $ strList . ccOptions
586 toField "extra_ld_opts" = Just $ strList . ldOptions
587 toField "framework_dirs" = Just $ strList . frameworkDirs
588 toField "extra_frameworks"= Just $ strList . frameworks
589 toField s = showInstalledPackageInfoField s
591 strList :: [String] -> String
595 -- -----------------------------------------------------------------------------
596 -- Check: Check consistency of installed packages
598 checkConsistency :: [Flag] -> IO ()
599 checkConsistency flags = do
600 db_stack <- getPkgDatabases False flags
601 let pkgs = map (\p -> (package p, p)) $ concatMap snd db_stack
604 let broken_deps = missingPackageDeps p pkgs
605 guard (not . null $ broken_deps)
606 return (pid, broken_deps)
607 mapM_ (putStrLn . render . show_func) broken_pkgs
609 show_func | FlagSimpleOutput `elem` flags = show_simple
610 | otherwise = show_normal
611 show_simple (pid,deps) =
612 text (showPackageId pid) <> colon
613 <+> fsep (punctuate comma (map (text . showPackageId) deps))
614 show_normal (pid,deps) =
615 text "package" <+> text (showPackageId pid) <+> text "has missing dependencies:"
616 $$ nest 4 (fsep (punctuate comma (map (text . showPackageId) deps)))
618 missingPackageDeps :: InstalledPackageInfo
619 -> [(PackageIdentifier, InstalledPackageInfo)]
620 -> [PackageIdentifier]
621 missingPackageDeps pkg pkg_map =
622 [ d | d <- depends pkg, isNothing (lookup d pkg_map)] ++
623 [ d | d <- depends pkg, Just p <- return (lookup d pkg_map), isBrokenPackage p pkg_map]
625 isBrokenPackage :: InstalledPackageInfo -> [(PackageIdentifier, InstalledPackageInfo)] -> Bool
626 isBrokenPackage pkg pkg_map = not . null $ missingPackageDeps pkg pkg_map
629 -- -----------------------------------------------------------------------------
630 -- Manipulating package.conf files
632 writeNewConfig :: FilePath -> [InstalledPackageInfo] -> IO ()
633 writeNewConfig filename packages = do
634 hPutStr stdout "Writing new package config file... "
635 createDirectoryIfMissing True $ takeDirectory filename
636 h <- openFile filename WriteMode `catch` \e ->
637 if isPermissionError e
638 then die (filename ++ ": you don't have permission to modify this file")
640 let shown = concat $ intersperse ",\n " $ map show packages
641 fileContents = "[" ++ shown ++ "\n]"
642 hPutStrLn h fileContents
644 hPutStrLn stdout "done."
646 savingOldConfig :: FilePath -> IO () -> IO ()
647 savingOldConfig filename io = Exception.block $ do
648 hPutStr stdout "Saving old package config file... "
649 -- mv rather than cp because we've already done an hGetContents
650 -- on this file so we won't be able to open it for writing
651 -- unless we move the old one out of the way...
652 let oldFile = filename ++ ".old"
653 restore_on_error <- catch (renameFile filename oldFile >> return True) $
655 unless (isDoesNotExistError err) $ do
656 hPutStrLn stderr (unwords ["Unable to rename", show filename,
660 hPutStrLn stdout "done."
662 hPutStrLn stderr (show e)
663 hPutStr stdout ("\nWARNING: an error was encountered while writing"
664 ++ "the new configuration.\n")
665 when restore_on_error $ do
666 hPutStr stdout "Attempting to restore the old configuration..."
667 do renameFile oldFile filename
668 hPutStrLn stdout "done."
669 `catch` \err -> hPutStrLn stdout ("Failed: " ++ show err)
672 -----------------------------------------------------------------------------
673 -- Sanity-check a new package config, and automatically build GHCi libs
676 validatePackageConfig :: InstalledPackageInfo
678 -> Bool -- auto-ghc-libs
682 validatePackageConfig pkg db_stack auto_ghci_libs update force = do
684 checkDuplicates db_stack pkg update force
685 mapM_ (checkDep db_stack force) (depends pkg)
686 mapM_ (checkDir force) (importDirs pkg)
687 mapM_ (checkDir force) (libraryDirs pkg)
688 mapM_ (checkDir force) (includeDirs pkg)
689 mapM_ (checkHSLib (libraryDirs pkg) auto_ghci_libs force) (hsLibraries pkg)
690 -- ToDo: check these somehow?
691 -- extra_libraries :: [String],
692 -- c_includes :: [String],
694 -- When the package name and version are put together, sometimes we can
695 -- end up with a package id that cannot be parsed. This will lead to
696 -- difficulties when the user wants to refer to the package later, so
697 -- we check that the package id can be parsed properly here.
698 checkPackageId :: InstalledPackageInfo -> IO ()
700 let str = showPackageId (package ipi) in
701 case [ x | (x,ys) <- readP_to_S parsePackageId str, all isSpace ys ] of
703 [] -> die ("invalid package identifier: " ++ str)
704 _ -> die ("ambiguous package identifier: " ++ str)
706 checkDuplicates :: PackageDBStack -> InstalledPackageInfo -> Bool -> Force -> IO ()
707 checkDuplicates db_stack pkg update force = do
710 (_top_db_name, pkgs) : _ = db_stack
712 -- Check whether this package id already exists in this DB
714 when (not update && (pkgid `elem` map package pkgs)) $
715 die ("package " ++ showPackageId pkgid ++ " is already installed")
718 uncasep = map toLower . showPackageId
719 dups = filter ((== uncasep pkgid) . uncasep) (map package pkgs)
721 when (not (null dups)) $ dieOrForceAll force $
722 "Package names may be treated case-insensitively in the future.\n"++
723 "Package " ++ showPackageId pkgid ++
724 " overlaps with: " ++ unwords (map showPackageId dups)
727 checkDir :: Force -> String -> IO ()
729 | "$topdir" `isPrefixOf` d = return ()
730 | "$httptopdir" `isPrefixOf` d = return ()
731 -- can't check these, because we don't know what $(http)topdir is
733 there <- doesDirectoryExist d
735 (dieOrForceFile force (d ++ " doesn't exist or isn't a directory"))
737 checkDep :: PackageDBStack -> Force -> PackageIdentifier -> IO ()
738 checkDep db_stack force pkgid
739 | pkgid `elem` pkgids || (not real_version && name_exists) = return ()
740 | otherwise = dieOrForceAll force ("dependency " ++ showPackageId pkgid
743 -- for backwards compat, we treat 0.0 as a special version,
744 -- and don't check that it actually exists.
745 real_version = realVersion pkgid
747 name_exists = any (\p -> pkgName (package p) == name) all_pkgs
750 all_pkgs = concat (map snd db_stack)
751 pkgids = map package all_pkgs
753 realVersion :: PackageIdentifier -> Bool
754 realVersion pkgid = versionBranch (pkgVersion pkgid) /= []
756 checkHSLib :: [String] -> Bool -> Force -> String -> IO ()
757 checkHSLib dirs auto_ghci_libs force lib = do
758 let batch_lib_file = "lib" ++ lib ++ ".a"
759 bs <- mapM (doesLibExistIn batch_lib_file) dirs
760 case [ dir | (exists,dir) <- zip bs dirs, exists ] of
761 [] -> dieOrForceFile force ("cannot find " ++ batch_lib_file ++
763 (dir:_) -> checkGHCiLib dirs dir batch_lib_file lib auto_ghci_libs
765 doesLibExistIn :: String -> String -> IO Bool
767 | "$topdir" `isPrefixOf` d = return True
768 | "$httptopdir" `isPrefixOf` d = return True
769 | otherwise = doesFileExist (d ++ '/':lib)
771 checkGHCiLib :: [String] -> String -> String -> String -> Bool -> IO ()
772 checkGHCiLib dirs batch_lib_dir batch_lib_file lib auto_build
773 | auto_build = autoBuildGHCiLib batch_lib_dir batch_lib_file ghci_lib_file
775 bs <- mapM (doesLibExistIn ghci_lib_file) dirs
776 case [dir | (exists,dir) <- zip bs dirs, exists] of
777 [] -> hPutStrLn stderr ("warning: can't find GHCi lib " ++ ghci_lib_file)
780 ghci_lib_file = lib ++ ".o"
782 -- automatically build the GHCi version of a batch lib,
783 -- using ld --whole-archive.
785 autoBuildGHCiLib :: String -> String -> String -> IO ()
786 autoBuildGHCiLib dir batch_file ghci_file = do
787 let ghci_lib_file = dir ++ '/':ghci_file
788 batch_lib_file = dir ++ '/':batch_file
789 hPutStr stderr ("building GHCi library " ++ ghci_lib_file ++ "...")
790 #if defined(darwin_HOST_OS)
791 r <- rawSystem "ld" ["-r","-x","-o",ghci_lib_file,"-all_load",batch_lib_file]
792 #elif defined(mingw32_HOST_OS)
793 execDir <- getExecDir "/bin/ghc-pkg.exe"
794 r <- rawSystem (maybe "" (++"/gcc-lib/") execDir++"ld") ["-r","-x","-o",ghci_lib_file,"--whole-archive",batch_lib_file]
796 r <- rawSystem "ld" ["-r","-x","-o",ghci_lib_file,"--whole-archive",batch_lib_file]
798 when (r /= ExitSuccess) $ exitWith r
799 hPutStrLn stderr (" done.")
801 -- -----------------------------------------------------------------------------
802 -- Searching for modules
806 findModules :: [FilePath] -> IO [String]
808 mms <- mapM searchDir paths
811 searchDir path prefix = do
812 fs <- getDirectoryEntries path `catch` \_ -> return []
813 searchEntries path prefix fs
815 searchEntries path prefix [] = return []
816 searchEntries path prefix (f:fs)
817 | looks_like_a_module = do
818 ms <- searchEntries path prefix fs
819 return (prefix `joinModule` f : ms)
820 | looks_like_a_component = do
821 ms <- searchDir (path </> f) (prefix `joinModule` f)
822 ms' <- searchEntries path prefix fs
825 searchEntries path prefix fs
828 (base,suffix) = splitFileExt f
829 looks_like_a_module =
830 suffix `elem` haskell_suffixes &&
831 all okInModuleName base
832 looks_like_a_component =
833 null suffix && all okInModuleName base
839 -- ---------------------------------------------------------------------------
840 -- expanding environment variables in the package configuration
842 expandEnvVars :: String -> Force -> IO String
843 expandEnvVars str force = go str ""
845 go "" acc = return $! reverse acc
846 go ('$':'{':str) acc | (var, '}':rest) <- break close str
847 = do value <- lookupEnvVar var
848 go rest (reverse value ++ acc)
849 where close c = c == '}' || c == '\n' -- don't span newlines
853 lookupEnvVar :: String -> IO String
855 catch (System.getEnv nm)
856 (\ _ -> do dieOrForceAll force ("Unable to expand variable " ++
860 -----------------------------------------------------------------------------
862 getProgramName :: IO String
863 getProgramName = liftM (`withoutSuffix` ".bin") getProgName
864 where str `withoutSuffix` suff
865 | suff `isSuffixOf` str = take (length str - length suff) str
868 bye :: String -> IO a
869 bye s = putStr s >> exitWith ExitSuccess
871 die :: String -> IO a
874 prog <- getProgramName
875 hPutStrLn stderr (prog ++ ": " ++ s)
876 exitWith (ExitFailure 1)
878 dieOrForceAll :: Force -> String -> IO ()
879 dieOrForceAll ForceAll s = ignoreError s
880 dieOrForceAll _other s = dieForcible s
882 dieOrForceFile :: Force -> String -> IO ()
883 dieOrForceFile ForceAll s = ignoreError s
884 dieOrForceFile ForceFiles s = ignoreError s
885 dieOrForceFile _other s = dieForcible s
887 ignoreError :: String -> IO ()
888 ignoreError s = do hFlush stdout; hPutStrLn stderr (s ++ " (ignoring)")
890 dieForcible :: String -> IO ()
891 dieForcible s = die (s ++ " (use --force to override)")
893 my_head :: String -> [a] -> a
894 my_head s [] = error s
897 -----------------------------------------
898 -- Cut and pasted from ghc/compiler/SysTools
900 #if defined(mingw32_HOST_OS)
901 subst :: Char -> Char -> String -> String
902 subst a b ls = map (\ x -> if x == a then b else x) ls
904 unDosifyPath :: FilePath -> FilePath
905 unDosifyPath xs = subst '\\' '/' xs
907 getExecDir :: String -> IO (Maybe String)
908 -- (getExecDir cmd) returns the directory in which the current
909 -- executable, which should be called 'cmd', is running
910 -- So if the full path is /a/b/c/d/e, and you pass "d/e" as cmd,
911 -- you'll get "/a/b/c" back as the result
913 = allocaArray len $ \buf -> do
914 ret <- getModuleFileName nullPtr buf len
915 if ret == 0 then return Nothing
916 else do s <- peekCString buf
917 return (Just (reverse (drop (length cmd)
918 (reverse (unDosifyPath s)))))
920 len = 2048::Int -- Plenty, PATH_MAX is 512 under Win32.
922 foreign import stdcall unsafe "GetModuleFileNameA"
923 getModuleFileName :: Ptr () -> CString -> Int -> IO Int32
925 getExecDir :: String -> IO (Maybe String)
926 getExecDir _ = return Nothing