1 {-# OPTIONS -fglasgow-exts -cpp #-}
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 hiding (depends)
20 import Distribution.Compat.ReadP
21 import Distribution.ParseUtils
22 import Distribution.Package
23 import Distribution.Text
24 import Distribution.Version
25 import System.FilePath
26 import System.Cmd ( rawSystem )
27 import System.Directory ( getAppUserDataDirectory, createDirectoryIfMissing )
31 #include "../../includes/ghcconfig.h"
33 import System.Console.GetOpt
34 import Text.PrettyPrint
35 import qualified Control.Exception as Exception
38 import Data.Char ( isSpace, toLower )
40 import System.Directory ( doesDirectoryExist, getDirectoryContents,
41 doesFileExist, renameFile, removeFile )
42 import System.Exit ( exitWith, ExitCode(..) )
43 import System.Environment ( getArgs, getProgName, getEnv )
45 import System.IO.Error (try)
46 import Data.List ( isPrefixOf, isSuffixOf, intersperse, sortBy, nub,
48 #if __GLASGOW_HASKELL__ > 604
49 import Data.List ( isInfixOf )
51 import Data.List ( tails )
53 import Control.Concurrent
55 #ifdef mingw32_HOST_OS
57 import Foreign.C.String
58 import GHC.ConsoleHandler
63 import IO ( isPermissionError, isDoesNotExistError )
66 import System.Process(runInteractiveCommand)
67 import qualified System.Info(os)
70 -- -----------------------------------------------------------------------------
77 case getOpt Permute (flags ++ deprecFlags) args of
78 (cli,_,[]) | FlagHelp `elem` cli -> do
79 prog <- getProgramName
80 bye (usageInfo (usageHeader prog) flags)
81 (cli,_,[]) | FlagVersion `elem` cli ->
86 prog <- getProgramName
87 die (concat errors ++ usageInfo (usageHeader prog) flags)
89 -- -----------------------------------------------------------------------------
90 -- Command-line syntax
98 | FlagGlobalConfig FilePath
107 flags :: [OptDescr Flag]
109 Option [] ["user"] (NoArg FlagUser)
110 "use the current user's package database",
111 Option [] ["global"] (NoArg FlagGlobal)
112 "use the global package database",
113 Option ['f'] ["package-conf"] (ReqArg FlagConfig "FILE")
114 "use the specified package config file",
115 Option [] ["global-conf"] (ReqArg FlagGlobalConfig "FILE")
116 "location of the global package config",
117 Option [] ["force"] (NoArg FlagForce)
118 "ignore missing dependencies, directories, and libraries",
119 Option [] ["force-files"] (NoArg FlagForceFiles)
120 "ignore missing directories and libraries only",
121 Option ['g'] ["auto-ghci-libs"] (NoArg FlagAutoGHCiLibs)
122 "automatically build libs for GHCi (with register)",
123 Option ['?'] ["help"] (NoArg FlagHelp)
124 "display this help and exit",
125 Option ['V'] ["version"] (NoArg FlagVersion)
126 "output version information and exit",
127 Option [] ["simple-output"] (NoArg FlagSimpleOutput)
128 "print output in easy-to-parse format for some commands",
129 Option [] ["names-only"] (NoArg FlagNamesOnly)
130 "only print package names, not versions; can only be used with list --simple-output",
131 Option [] ["ignore-case"] (NoArg FlagIgnoreCase)
132 "ignore case for substring matching"
135 deprecFlags :: [OptDescr Flag]
137 -- put deprecated flags here
140 ourCopyright :: String
141 ourCopyright = "GHC package manager version " ++ Version.version ++ "\n"
143 usageHeader :: String -> String
144 usageHeader prog = substProg prog $
146 " $p register {filename | -}\n" ++
147 " Register the package using the specified installed package\n" ++
148 " description. The syntax for the latter is given in the $p\n" ++
149 " documentation.\n" ++
151 " $p update {filename | -}\n" ++
152 " Register the package, overwriting any other package with the\n" ++
155 " $p unregister {pkg-id}\n" ++
156 " Unregister the specified package.\n" ++
158 " $p expose {pkg-id}\n" ++
159 " Expose the specified package.\n" ++
161 " $p hide {pkg-id}\n" ++
162 " Hide the specified package.\n" ++
164 " $p list [pkg]\n" ++
165 " List registered packages in the global database, and also the\n" ++
166 " user database if --user is given. If a package name is given\n" ++
167 " all the registered versions will be listed in ascending order.\n" ++
168 " Accepts the --simple-output flag.\n" ++
170 " $p find-module {module}\n" ++
171 " List registered packages exposing module {module} in the global\n" ++
172 " database, and also the user database if --user is given.\n" ++
173 " All the registered versions will be listed in ascending order.\n" ++
174 " Accepts the --simple-output flag.\n" ++
176 " $p latest {pkg-id}\n" ++
177 " Prints the highest registered version of a package.\n" ++
180 " Check the consistency of package depenencies and list broken packages.\n" ++
181 " Accepts the --simple-output flag.\n" ++
183 " $p describe {pkg}\n" ++
184 " Give the registered description for the specified package. The\n" ++
185 " description is returned in precisely the syntax required by $p\n" ++
188 " $p field {pkg} {field}\n" ++
189 " Extract the specified field of the package description for the\n" ++
190 " specified package. Accepts comma-separated multiple fields.\n" ++
192 " Substring matching is supported for {module} in find-module and\n" ++
193 " for {pkg} in list, describe, and field, where a '*' indicates\n" ++
194 " open substring ends (prefix*, *suffix, *infix*).\n" ++
196 " When asked to modify a database (register, unregister, update,\n"++
197 " hide, expose, and also check), ghc-pkg modifies the global database by\n"++
198 " default. Specifying --user causes it to act on the user database,\n"++
199 " or --package-conf can be used to act on another database\n"++
200 " entirely. When multiple of these options are given, the rightmost\n"++
201 " one is used as the database to act upon.\n"++
203 " Commands that query the package database (list, latest, describe,\n"++
204 " field) operate on the list of databases specified by the flags\n"++
205 " --user, --global, and --package-conf. If none of these flags are\n"++
206 " given, the default is --global --user.\n"++
208 " The following optional flags are also accepted:\n"
210 substProg :: String -> String -> String
212 substProg prog ('$':'p':xs) = prog ++ substProg prog xs
213 substProg prog (c:xs) = c : substProg prog xs
215 -- -----------------------------------------------------------------------------
218 data Force = ForceAll | ForceFiles | NoForce
220 data PackageArg = Id PackageIdentifier | Substring String (String->Bool)
222 runit :: [Flag] -> [String] -> IO ()
223 runit cli nonopts = do
224 installSignalHandlers -- catch ^C and clean up
225 prog <- getProgramName
228 | FlagForce `elem` cli = ForceAll
229 | FlagForceFiles `elem` cli = ForceFiles
230 | otherwise = NoForce
231 auto_ghci_libs = FlagAutoGHCiLibs `elem` cli
232 splitFields fields = unfoldr splitComma (',':fields)
233 where splitComma "" = Nothing
234 splitComma fs = Just $ break (==',') (tail fs)
236 substringCheck :: String -> Maybe (String -> Bool)
237 substringCheck "" = Nothing
238 substringCheck "*" = Just (const True)
239 substringCheck [_] = Nothing
240 substringCheck (h:t) =
241 case (h, init t, last t) of
242 ('*',s,'*') -> Just (isInfixOf (f s) . f)
243 ('*',_, _ ) -> Just (isSuffixOf (f t) . f)
244 ( _ ,s,'*') -> Just (isPrefixOf (f (h:s)) . f)
246 where f | FlagIgnoreCase `elem` cli = map toLower
249 glob x | System.Info.os=="mingw32" = do
250 -- glob echoes its argument, after win32 filename globbing
251 (_,o,_,_) <- runInteractiveCommand ("glob "++x)
252 txt <- hGetContents o
254 glob x | otherwise = return [x]
257 -- first, parse the command
260 -- dummy command to demonstrate usage and permit testing
261 -- without messing things up; use glob to selectively enable
262 -- windows filename globbing for file parameters
263 -- register, update, FlagGlobalConfig, FlagConfig; others?
264 ["glob", filename] -> do
266 glob filename >>= print
268 ["register", filename] ->
269 registerPackage filename cli auto_ghci_libs False force
270 ["update", filename] ->
271 registerPackage filename cli auto_ghci_libs True force
272 ["unregister", pkgid_str] -> do
273 pkgid <- readGlobPkgId pkgid_str
274 unregisterPackage pkgid cli
275 ["expose", pkgid_str] -> do
276 pkgid <- readGlobPkgId pkgid_str
277 exposePackage pkgid cli
278 ["hide", pkgid_str] -> do
279 pkgid <- readGlobPkgId pkgid_str
280 hidePackage pkgid cli
282 listPackages cli Nothing Nothing
283 ["list", pkgid_str] ->
284 case substringCheck pkgid_str of
285 Nothing -> do pkgid <- readGlobPkgId pkgid_str
286 listPackages cli (Just (Id pkgid)) Nothing
287 Just m -> listPackages cli (Just (Substring pkgid_str m)) Nothing
288 ["find-module", moduleName] -> do
289 let match = maybe (==moduleName) id (substringCheck moduleName)
290 listPackages cli Nothing (Just match)
291 ["latest", pkgid_str] -> do
292 pkgid <- readGlobPkgId pkgid_str
293 latestPackage cli pkgid
294 ["describe", pkgid_str] ->
295 case substringCheck pkgid_str of
296 Nothing -> do pkgid <- readGlobPkgId pkgid_str
297 describePackage cli (Id pkgid)
298 Just m -> describePackage cli (Substring pkgid_str m)
299 ["field", pkgid_str, fields] ->
300 case substringCheck pkgid_str of
301 Nothing -> do pkgid <- readGlobPkgId pkgid_str
302 describeField cli (Id pkgid) (splitFields fields)
303 Just m -> describeField cli (Substring pkgid_str m)
308 die ("missing command\n" ++
309 usageInfo (usageHeader prog) flags)
311 die ("command-line syntax error\n" ++
312 usageInfo (usageHeader prog) flags)
314 parseCheck :: ReadP a a -> String -> String -> IO a
315 parseCheck parser str what =
316 case [ x | (x,ys) <- readP_to_S parser str, all isSpace ys ] of
318 _ -> die ("cannot parse \'" ++ str ++ "\' as a " ++ what)
320 readGlobPkgId :: String -> IO PackageIdentifier
321 readGlobPkgId str = parseCheck parseGlobPackageId str "package identifier"
323 parseGlobPackageId :: ReadP r PackageIdentifier
329 return (PackageIdentifier{ pkgName = n, pkgVersion = globVersion }))
331 -- globVersion means "all versions"
332 globVersion :: Version
333 globVersion = Version{ versionBranch=[], versionTags=["*"] }
335 -- -----------------------------------------------------------------------------
338 -- Some commands operate on a single database:
339 -- register, unregister, expose, hide
340 -- however these commands also check the union of the available databases
341 -- in order to check consistency. For example, register will check that
342 -- dependencies exist before registering a package.
344 -- Some commands operate on multiple databases, with overlapping semantics:
345 -- list, describe, field
347 type PackageDBName = FilePath
348 type PackageDB = [InstalledPackageInfo]
350 type PackageDBStack = [(PackageDBName,PackageDB)]
351 -- A stack of package databases. Convention: head is the topmost
352 -- in the stack. Earlier entries override later one.
354 getPkgDatabases :: Bool -> [Flag] -> IO PackageDBStack
355 getPkgDatabases modify flags = do
356 -- first we determine the location of the global package config. On Windows,
357 -- this is found relative to the ghc-pkg.exe binary, whereas on Unix the
358 -- location is passed to the binary using the --global-config flag by the
360 let err_msg = "missing --global-conf option, location of global package.conf unknown\n"
362 case [ f | FlagGlobalConfig f <- flags ] of
363 [] -> do mb_dir <- getExecDir "/bin/ghc-pkg.exe"
365 Nothing -> die err_msg
366 Just dir -> return (dir </> "package.conf")
367 fs -> return (last fs)
369 let global_conf_dir = global_conf ++ ".d"
370 global_conf_dir_exists <- doesDirectoryExist global_conf_dir
372 if global_conf_dir_exists
373 then do files <- getDirectoryContents global_conf_dir
374 return [ global_conf_dir ++ '/' : file
376 , isSuffixOf ".conf" file]
379 -- get the location of the user package database, and create it if necessary
380 appdir <- getAppUserDataDirectory "ghc"
383 subdir = targetARCH ++ '-':targetOS ++ '-':Version.version
384 archdir = appdir </> subdir
385 user_conf = archdir </> "package.conf"
386 user_exists <- doesFileExist user_conf
388 -- If the user database doesn't exist, and this command isn't a
389 -- "modify" command, then we won't attempt to create or use it.
391 | modify || user_exists = user_conf : global_confs ++ [global_conf]
392 | otherwise = global_confs ++ [global_conf]
394 e_pkg_path <- try (System.Environment.getEnv "GHC_PACKAGE_PATH")
397 Left _ -> sys_databases
399 | last cs == "" -> init cs ++ sys_databases
401 where cs = splitSearchPath path
403 -- The "global" database is always the one at the bottom of the stack.
404 -- This is the database we modify by default.
405 virt_global_conf = last env_stack
407 let db_flags = [ f | Just f <- map is_db_flag flags ]
408 where is_db_flag FlagUser = Just user_conf
409 is_db_flag FlagGlobal = Just virt_global_conf
410 is_db_flag (FlagConfig f) = Just f
411 is_db_flag _ = Nothing
415 then -- For a "read" command, we use all the databases
416 -- specified on the command line. If there are no
417 -- command-line flags specifying databases, the default
418 -- is to use all the ones we know about.
419 if null db_flags then return env_stack
420 else return (reverse (nub db_flags))
422 -- For a "modify" command, treat all the databases as
423 -- a stack, where we are modifying the top one, but it
424 -- can refer to packages in databases further down the
427 -- -f flags on the command line add to the database
428 -- stack, unless any of them are present in the stack
430 flag_stack = filter (`notElem` env_stack)
431 [ f | FlagConfig f <- reverse flags ]
435 | f `elem` flag_stack = return (dropWhile (/= f) flag_stack)
436 | otherwise = die ("requesting modification of database:\n\t" ++ f ++ "\n\twhich is not in the database stack.")
439 then modifying virt_global_conf
440 else modifying (head db_flags)
442 db_stack <- mapM readParseDatabase final_stack
445 readParseDatabase :: PackageDBName -> IO (PackageDBName,PackageDB)
446 readParseDatabase filename = do
447 str <- readFile filename `Exception.catch` \_ -> return emptyPackageConfig
448 let packages = map convertPackageInfoIn $ read str
449 Exception.evaluate packages
450 `Exception.catch` \e->
451 die ("error while parsing " ++ filename ++ ": " ++ show e)
452 return (filename,packages)
454 emptyPackageConfig :: String
455 emptyPackageConfig = "[]"
457 -- -----------------------------------------------------------------------------
460 registerPackage :: FilePath
462 -> Bool -- auto_ghci_libs
466 registerPackage input flags auto_ghci_libs update force = do
467 db_stack <- getPkgDatabases True flags
469 db_to_operate_on = my_head "db" db_stack
470 db_filename = fst db_to_operate_on
476 putStr "Reading package info from stdin ... "
479 putStr ("Reading package info from " ++ show f ++ " ... ")
482 expanded <- expandEnvVars s force
484 pkg <- parsePackageInfo expanded
487 validatePackageConfig pkg db_stack auto_ghci_libs update force
488 let new_details = filter not_this (snd db_to_operate_on) ++ [pkg]
489 not_this p = package p /= package pkg
490 savingOldConfig db_filename $
491 writeNewConfig db_filename new_details
495 -> IO InstalledPackageInfo
496 parsePackageInfo str =
497 case parseInstalledPackageInfo str of
498 ParseOk _warns ok -> return ok
499 ParseFailed err -> case locatedErrorMsg err of
500 (Nothing, s) -> die s
501 (Just l, s) -> die (show l ++ ": " ++ s)
503 -- -----------------------------------------------------------------------------
504 -- Exposing, Hiding, Unregistering are all similar
506 exposePackage :: PackageIdentifier -> [Flag] -> IO ()
507 exposePackage = modifyPackage (\p -> [p{exposed=True}])
509 hidePackage :: PackageIdentifier -> [Flag] -> IO ()
510 hidePackage = modifyPackage (\p -> [p{exposed=False}])
512 unregisterPackage :: PackageIdentifier -> [Flag] -> IO ()
513 unregisterPackage = modifyPackage (\p -> [])
516 :: (InstalledPackageInfo -> [InstalledPackageInfo])
520 modifyPackage fn pkgid flags = do
521 db_stack <- getPkgDatabases True{-modify-} flags
522 let ((db_name, pkgs) : _) = db_stack
523 ps <- findPackages [(db_name,pkgs)] (Id pkgid)
524 let pids = map package ps
525 let new_config = concat (map modify pkgs)
527 | package pkg `elem` pids = fn pkg
529 savingOldConfig db_name $
530 writeNewConfig db_name new_config
532 -- -----------------------------------------------------------------------------
535 listPackages :: [Flag] -> Maybe PackageArg -> Maybe (String->Bool) -> IO ()
536 listPackages flags mPackageName mModuleName = do
537 let simple_output = FlagSimpleOutput `elem` flags
538 db_stack <- getPkgDatabases False flags
539 let db_stack_filtered -- if a package is given, filter out all other packages
540 | Just this <- mPackageName =
541 map (\(conf,pkgs) -> (conf, filter (this `matchesPkg`) pkgs))
543 | Just match <- mModuleName = -- packages which expose mModuleName
544 map (\(conf,pkgs) -> (conf, filter (match `exposedInPkg`) pkgs))
546 | otherwise = db_stack
549 = [ (db, sort_pkgs pkgs) | (db,pkgs) <- db_stack_filtered ]
550 where sort_pkgs = sortBy cmpPkgIds
551 cmpPkgIds pkg1 pkg2 =
552 case pkgName p1 `compare` pkgName p2 of
555 EQ -> pkgVersion p1 `compare` pkgVersion p2
556 where (p1,p2) = (package pkg1, package pkg2)
558 match `exposedInPkg` pkg = any match (map display $ exposedModules pkg)
560 pkg_map = map (\p -> (package p, p)) $ concatMap snd db_stack
561 show_func = if simple_output then show_simple else mapM_ (show_normal pkg_map)
563 show_func (reverse db_stack_sorted)
565 where show_normal pkg_map (db_name,pkg_confs) =
566 hPutStrLn stdout (render $
567 text db_name <> colon $$ nest 4 packages
569 where packages = fsep (punctuate comma (map pp_pkg pkg_confs))
571 | isBrokenPackage p pkg_map = braces doc
573 | otherwise = parens doc
574 where doc = text (display (package p))
576 show_simple db_stack = do
577 let showPkg = if FlagNamesOnly `elem` flags then display . pkgName
579 pkgs = map showPkg $ sortBy compPkgIdVer $
580 map package (concatMap snd db_stack)
581 when (not (null pkgs)) $
582 hPutStrLn stdout $ concat $ intersperse " " pkgs
584 -- -----------------------------------------------------------------------------
585 -- Prints the highest (hidden or exposed) version of a package
587 latestPackage :: [Flag] -> PackageIdentifier -> IO ()
588 latestPackage flags pkgid = do
589 db_stack <- getPkgDatabases False flags
590 ps <- findPackages db_stack (Id pkgid)
591 show_pkg (sortBy compPkgIdVer (map package ps))
593 show_pkg [] = die "no matches"
594 show_pkg pids = hPutStrLn stdout (display (last pids))
596 -- -----------------------------------------------------------------------------
599 describePackage :: [Flag] -> PackageArg -> IO ()
600 describePackage flags pkgarg = do
601 db_stack <- getPkgDatabases False flags
602 ps <- findPackages db_stack pkgarg
603 mapM_ (putStrLn . showInstalledPackageInfo) ps
605 -- PackageId is can have globVersion for the version
606 findPackages :: PackageDBStack -> PackageArg -> IO [InstalledPackageInfo]
607 findPackages db_stack pkgarg
608 = case [ p | p <- all_pkgs, pkgarg `matchesPkg` p ] of
609 [] -> die ("cannot find package " ++ pkg_msg pkgarg)
612 all_pkgs = concat (map snd db_stack)
613 pkg_msg (Id pkgid) = display pkgid
614 pkg_msg (Substring pkgpat _) = "matching "++pkgpat
616 matches :: PackageIdentifier -> PackageIdentifier -> Bool
618 = (pkgName pid == pkgName pid')
619 && (pkgVersion pid == pkgVersion pid' || not (realVersion pid))
621 matchesPkg :: PackageArg -> InstalledPackageInfo -> Bool
622 (Id pid) `matchesPkg` pkg = pid `matches` package pkg
623 (Substring _ m) `matchesPkg` pkg = m (display (package pkg))
625 compPkgIdVer :: PackageIdentifier -> PackageIdentifier -> Ordering
626 compPkgIdVer p1 p2 = pkgVersion p1 `compare` pkgVersion p2
628 -- -----------------------------------------------------------------------------
631 describeField :: [Flag] -> PackageArg -> [String] -> IO ()
632 describeField flags pkgarg fields = do
633 db_stack <- getPkgDatabases False flags
634 fns <- toFields fields
635 ps <- findPackages db_stack pkgarg
636 let top_dir = takeDirectory (fst (last db_stack))
637 mapM_ (selectFields fns) (mungePackagePaths top_dir ps)
638 where toFields [] = return []
639 toFields (f:fs) = case toField f of
640 Nothing -> die ("unknown field: " ++ f)
641 Just fn -> do fns <- toFields fs
643 selectFields fns info = mapM_ (\fn->putStrLn (fn info)) fns
645 mungePackagePaths :: String -> [InstalledPackageInfo] -> [InstalledPackageInfo]
646 -- Replace the strings "$topdir" and "$httptopdir" at the beginning of a path
647 -- with the current topdir (obtained from the -B option).
648 mungePackagePaths top_dir ps = map munge_pkg ps
650 munge_pkg p = p{ importDirs = munge_paths (importDirs p),
651 includeDirs = munge_paths (includeDirs p),
652 libraryDirs = munge_paths (libraryDirs p),
653 frameworkDirs = munge_paths (frameworkDirs p),
654 haddockInterfaces = munge_paths (haddockInterfaces p),
655 haddockHTMLs = munge_paths (haddockHTMLs p)
658 munge_paths = map munge_path
661 | Just p' <- maybePrefixMatch "$topdir" p = top_dir ++ p'
662 | Just p' <- maybePrefixMatch "$httptopdir" p = toHttpPath top_dir ++ p'
665 toHttpPath p = "file:///" ++ p
667 maybePrefixMatch :: String -> String -> Maybe String
668 maybePrefixMatch [] rest = Just rest
669 maybePrefixMatch (_:_) [] = Nothing
670 maybePrefixMatch (p:pat) (r:rest)
671 | p == r = maybePrefixMatch pat rest
672 | otherwise = Nothing
674 toField :: String -> Maybe (InstalledPackageInfo -> String)
675 -- backwards compatibility:
676 toField "import_dirs" = Just $ strList . importDirs
677 toField "source_dirs" = Just $ strList . importDirs
678 toField "library_dirs" = Just $ strList . libraryDirs
679 toField "hs_libraries" = Just $ strList . hsLibraries
680 toField "extra_libraries" = Just $ strList . extraLibraries
681 toField "include_dirs" = Just $ strList . includeDirs
682 toField "c_includes" = Just $ strList . includes
683 toField "package_deps" = Just $ strList . map display. depends
684 toField "extra_cc_opts" = Just $ strList . ccOptions
685 toField "extra_ld_opts" = Just $ strList . ldOptions
686 toField "framework_dirs" = Just $ strList . frameworkDirs
687 toField "extra_frameworks"= Just $ strList . frameworks
688 toField s = showInstalledPackageInfoField s
690 strList :: [String] -> String
694 -- -----------------------------------------------------------------------------
695 -- Check: Check consistency of installed packages
697 checkConsistency :: [Flag] -> IO ()
698 checkConsistency flags = do
699 db_stack <- getPkgDatabases True flags
700 -- check behaves like modify for the purposes of deciding which
701 -- databases to use, because ordering is important.
702 let pkgs = map (\p -> (package p, p)) $ concatMap snd db_stack
705 let broken_deps = missingPackageDeps p pkgs
706 guard (not . null $ broken_deps)
707 return (pid, broken_deps)
708 mapM_ (putStrLn . render . show_func) broken_pkgs
710 show_func | FlagSimpleOutput `elem` flags = show_simple
711 | otherwise = show_normal
712 show_simple (pid,deps) =
713 text (display pid) <> colon
714 <+> fsep (punctuate comma (map (text . display) deps))
715 show_normal (pid,deps) =
716 text "package" <+> text (display pid) <+> text "has missing dependencies:"
717 $$ nest 4 (fsep (punctuate comma (map (text . display) deps)))
719 missingPackageDeps :: InstalledPackageInfo
720 -> [(PackageIdentifier, InstalledPackageInfo)]
721 -> [PackageIdentifier]
722 missingPackageDeps pkg pkg_map =
723 [ d | d <- depends pkg, isNothing (lookup d pkg_map)] ++
724 [ d | d <- depends pkg, Just p <- return (lookup d pkg_map),
725 isBrokenPackage p pkg_map]
727 isBrokenPackage :: InstalledPackageInfo -> [(PackageIdentifier, InstalledPackageInfo)] -> Bool
728 isBrokenPackage pkg pkg_map
729 = not . null $ missingPackageDeps pkg (filter notme pkg_map)
730 where notme (p,ipi) = package pkg /= p
731 -- remove p from the database when we invoke missingPackageDeps,
732 -- because we want mutually recursive groups of package to show up
733 -- as broken. (#1750)
735 -- -----------------------------------------------------------------------------
736 -- Manipulating package.conf files
738 type InstalledPackageInfoString = InstalledPackageInfo_ String
740 convertPackageInfoOut :: InstalledPackageInfo -> InstalledPackageInfoString
741 convertPackageInfoOut
742 (pkgconf@(InstalledPackageInfo { exposedModules = e,
743 hiddenModules = h })) =
744 pkgconf{ exposedModules = map display e,
745 hiddenModules = map display h }
747 convertPackageInfoIn :: InstalledPackageInfoString -> InstalledPackageInfo
749 (pkgconf@(InstalledPackageInfo { exposedModules = e,
750 hiddenModules = h })) =
751 pkgconf{ exposedModules = map convert e,
752 hiddenModules = map convert h }
753 where convert = fromJust . simpleParse
755 writeNewConfig :: FilePath -> [InstalledPackageInfo] -> IO ()
756 writeNewConfig filename packages = do
757 hPutStr stdout "Writing new package config file... "
758 createDirectoryIfMissing True $ takeDirectory filename
759 h <- openFile filename WriteMode `catch` \e ->
760 if isPermissionError e
761 then die (filename ++ ": you don't have permission to modify this file")
763 let shown = concat $ intersperse ",\n "
764 $ map (show . convertPackageInfoOut) packages
765 fileContents = "[" ++ shown ++ "\n]"
766 hPutStrLn h fileContents
768 hPutStrLn stdout "done."
770 savingOldConfig :: FilePath -> IO () -> IO ()
771 savingOldConfig filename io = Exception.block $ do
772 hPutStr stdout "Saving old package config file... "
773 -- mv rather than cp because we've already done an hGetContents
774 -- on this file so we won't be able to open it for writing
775 -- unless we move the old one out of the way...
776 let oldFile = filename ++ ".old"
777 restore_on_error <- catch (renameFile filename oldFile >> return True) $
779 unless (isDoesNotExistError err) $ do
780 hPutStrLn stderr (unwords ["Unable to rename", show filename,
784 (do hPutStrLn stdout "done."; io)
785 `Exception.catch` \e -> do
786 hPutStr stdout ("WARNING: an error was encountered while writing "
787 ++ "the new configuration.\n")
788 -- remove any partially complete new version:
789 try (removeFile filename)
790 -- and attempt to restore the old one, if we had one:
791 when restore_on_error $ do
792 hPutStr stdout "Attempting to restore the old configuration... "
793 do renameFile oldFile filename
794 hPutStrLn stdout "done."
795 `catch` \err -> hPutStrLn stdout ("Failed: " ++ show err)
796 -- Note the above renameFile sometimes fails on Windows with
797 -- "permission denied", I have no idea why --SDM.
800 -----------------------------------------------------------------------------
801 -- Sanity-check a new package config, and automatically build GHCi libs
804 validatePackageConfig :: InstalledPackageInfo
806 -> Bool -- auto-ghc-libs
810 validatePackageConfig pkg db_stack auto_ghci_libs update force = do
812 checkDuplicates db_stack pkg update force
813 mapM_ (checkDep db_stack force) (depends pkg)
814 mapM_ (checkDir force) (importDirs pkg)
815 mapM_ (checkDir force) (libraryDirs pkg)
816 mapM_ (checkDir force) (includeDirs pkg)
817 mapM_ (checkHSLib (libraryDirs pkg) auto_ghci_libs force) (hsLibraries pkg)
818 -- ToDo: check these somehow?
819 -- extra_libraries :: [String],
820 -- c_includes :: [String],
822 -- When the package name and version are put together, sometimes we can
823 -- end up with a package id that cannot be parsed. This will lead to
824 -- difficulties when the user wants to refer to the package later, so
825 -- we check that the package id can be parsed properly here.
826 checkPackageId :: InstalledPackageInfo -> IO ()
828 let str = display (package ipi) in
829 case [ x :: PackageIdentifier | (x,ys) <- readP_to_S parse str, all isSpace ys ] of
831 [] -> die ("invalid package identifier: " ++ str)
832 _ -> die ("ambiguous package identifier: " ++ str)
834 checkDuplicates :: PackageDBStack -> InstalledPackageInfo -> Bool -> Force -> IO ()
835 checkDuplicates db_stack pkg update force = do
838 (_top_db_name, pkgs) : _ = db_stack
840 -- Check whether this package id already exists in this DB
842 when (not update && (pkgid `elem` map package pkgs)) $
843 die ("package " ++ display pkgid ++ " is already installed")
846 uncasep = map toLower . display
847 dups = filter ((== uncasep pkgid) . uncasep) (map package pkgs)
849 when (not update && not (null dups)) $ dieOrForceAll force $
850 "Package names may be treated case-insensitively in the future.\n"++
851 "Package " ++ display pkgid ++
852 " overlaps with: " ++ unwords (map display dups)
855 checkDir :: Force -> String -> IO ()
857 | "$topdir" `isPrefixOf` d = return ()
858 | "$httptopdir" `isPrefixOf` d = return ()
859 -- can't check these, because we don't know what $(http)topdir is
861 there <- doesDirectoryExist d
863 (dieOrForceFile force (d ++ " doesn't exist or isn't a directory"))
865 checkDep :: PackageDBStack -> Force -> PackageIdentifier -> IO ()
866 checkDep db_stack force pkgid
867 | pkgid `elem` pkgids || (not real_version && name_exists) = return ()
868 | otherwise = dieOrForceAll force ("dependency " ++ display pkgid
871 -- for backwards compat, we treat 0.0 as a special version,
872 -- and don't check that it actually exists.
873 real_version = realVersion pkgid
875 name_exists = any (\p -> pkgName (package p) == name) all_pkgs
878 all_pkgs = concat (map snd db_stack)
879 pkgids = map package all_pkgs
881 realVersion :: PackageIdentifier -> Bool
882 realVersion pkgid = versionBranch (pkgVersion pkgid) /= []
884 checkHSLib :: [String] -> Bool -> Force -> String -> IO ()
885 checkHSLib dirs auto_ghci_libs force lib = do
886 let batch_lib_file = "lib" ++ lib ++ ".a"
887 bs <- mapM (doesLibExistIn batch_lib_file) dirs
888 case [ dir | (exists,dir) <- zip bs dirs, exists ] of
889 [] -> dieOrForceFile force ("cannot find " ++ batch_lib_file ++
891 (dir:_) -> checkGHCiLib dirs dir batch_lib_file lib auto_ghci_libs
893 doesLibExistIn :: String -> String -> IO Bool
895 | "$topdir" `isPrefixOf` d = return True
896 | "$httptopdir" `isPrefixOf` d = return True
897 | otherwise = doesFileExist (d ++ '/':lib)
899 checkGHCiLib :: [String] -> String -> String -> String -> Bool -> IO ()
900 checkGHCiLib dirs batch_lib_dir batch_lib_file lib auto_build
901 | auto_build = autoBuildGHCiLib batch_lib_dir batch_lib_file ghci_lib_file
903 bs <- mapM (doesLibExistIn ghci_lib_file) dirs
904 case [dir | (exists,dir) <- zip bs dirs, exists] of
905 [] -> hPutStrLn stderr ("warning: can't find GHCi lib " ++ ghci_lib_file)
908 ghci_lib_file = lib ++ ".o"
910 -- automatically build the GHCi version of a batch lib,
911 -- using ld --whole-archive.
913 autoBuildGHCiLib :: String -> String -> String -> IO ()
914 autoBuildGHCiLib dir batch_file ghci_file = do
915 let ghci_lib_file = dir ++ '/':ghci_file
916 batch_lib_file = dir ++ '/':batch_file
917 hPutStr stderr ("building GHCi library " ++ ghci_lib_file ++ "...")
918 #if defined(darwin_HOST_OS)
919 r <- rawSystem "ld" ["-r","-x","-o",ghci_lib_file,"-all_load",batch_lib_file]
920 #elif defined(mingw32_HOST_OS)
921 execDir <- getExecDir "/bin/ghc-pkg.exe"
922 r <- rawSystem (maybe "" (++"/gcc-lib/") execDir++"ld") ["-r","-x","-o",ghci_lib_file,"--whole-archive",batch_lib_file]
924 r <- rawSystem "ld" ["-r","-x","-o",ghci_lib_file,"--whole-archive",batch_lib_file]
926 when (r /= ExitSuccess) $ exitWith r
927 hPutStrLn stderr (" done.")
929 -- -----------------------------------------------------------------------------
930 -- Searching for modules
934 findModules :: [FilePath] -> IO [String]
936 mms <- mapM searchDir paths
939 searchDir path prefix = do
940 fs <- getDirectoryEntries path `catch` \_ -> return []
941 searchEntries path prefix fs
943 searchEntries path prefix [] = return []
944 searchEntries path prefix (f:fs)
945 | looks_like_a_module = do
946 ms <- searchEntries path prefix fs
947 return (prefix `joinModule` f : ms)
948 | looks_like_a_component = do
949 ms <- searchDir (path </> f) (prefix `joinModule` f)
950 ms' <- searchEntries path prefix fs
953 searchEntries path prefix fs
956 (base,suffix) = splitFileExt f
957 looks_like_a_module =
958 suffix `elem` haskell_suffixes &&
959 all okInModuleName base
960 looks_like_a_component =
961 null suffix && all okInModuleName base
967 -- ---------------------------------------------------------------------------
968 -- expanding environment variables in the package configuration
970 expandEnvVars :: String -> Force -> IO String
971 expandEnvVars str force = go str ""
973 go "" acc = return $! reverse acc
974 go ('$':'{':str) acc | (var, '}':rest) <- break close str
975 = do value <- lookupEnvVar var
976 go rest (reverse value ++ acc)
977 where close c = c == '}' || c == '\n' -- don't span newlines
981 lookupEnvVar :: String -> IO String
983 catch (System.Environment.getEnv nm)
984 (\ _ -> do dieOrForceAll force ("Unable to expand variable " ++
988 -----------------------------------------------------------------------------
990 getProgramName :: IO String
991 getProgramName = liftM (`withoutSuffix` ".bin") getProgName
992 where str `withoutSuffix` suff
993 | suff `isSuffixOf` str = take (length str - length suff) str
996 bye :: String -> IO a
997 bye s = putStr s >> exitWith ExitSuccess
999 die :: String -> IO a
1002 prog <- getProgramName
1003 hPutStrLn stderr (prog ++ ": " ++ s)
1004 exitWith (ExitFailure 1)
1006 dieOrForceAll :: Force -> String -> IO ()
1007 dieOrForceAll ForceAll s = ignoreError s
1008 dieOrForceAll _other s = dieForcible s
1010 dieOrForceFile :: Force -> String -> IO ()
1011 dieOrForceFile ForceAll s = ignoreError s
1012 dieOrForceFile ForceFiles s = ignoreError s
1013 dieOrForceFile _other s = dieForcible s
1015 ignoreError :: String -> IO ()
1016 ignoreError s = do hFlush stdout; hPutStrLn stderr (s ++ " (ignoring)")
1018 dieForcible :: String -> IO ()
1019 dieForcible s = die (s ++ " (use --force to override)")
1021 my_head :: String -> [a] -> a
1022 my_head s [] = error s
1023 my_head s (x:xs) = x
1025 -----------------------------------------
1026 -- Cut and pasted from ghc/compiler/main/SysTools
1028 #if defined(mingw32_HOST_OS)
1029 subst :: Char -> Char -> String -> String
1030 subst a b ls = map (\ x -> if x == a then b else x) ls
1032 unDosifyPath :: FilePath -> FilePath
1033 unDosifyPath xs = subst '\\' '/' xs
1035 getExecDir :: String -> IO (Maybe String)
1036 -- (getExecDir cmd) returns the directory in which the current
1037 -- executable, which should be called 'cmd', is running
1038 -- So if the full path is /a/b/c/d/e, and you pass "d/e" as cmd,
1039 -- you'll get "/a/b/c" back as the result
1041 = allocaArray len $ \buf -> do
1042 ret <- getModuleFileName nullPtr buf len
1043 if ret == 0 then return Nothing
1044 else do s <- peekCString buf
1045 return (Just (reverse (drop (length cmd)
1046 (reverse (unDosifyPath s)))))
1048 len = 2048::Int -- Plenty, PATH_MAX is 512 under Win32.
1050 foreign import stdcall unsafe "GetModuleFileNameA"
1051 getModuleFileName :: Ptr () -> CString -> Int -> IO Int32
1053 getExecDir :: String -> IO (Maybe String)
1054 getExecDir _ = return Nothing
1057 -----------------------------------------
1058 -- Adapted from ghc/compiler/utils/Panic
1060 installSignalHandlers :: IO ()
1061 installSignalHandlers = do
1062 threadid <- myThreadId
1064 interrupt = throwTo threadid (Exception.ErrorCall "interrupted")
1066 #if !defined(mingw32_HOST_OS)
1067 installHandler sigQUIT (Catch interrupt) Nothing
1068 installHandler sigINT (Catch interrupt) Nothing
1070 #elif __GLASGOW_HASKELL__ >= 603
1071 -- GHC 6.3+ has support for console events on Windows
1072 -- NOTE: running GHCi under a bash shell for some reason requires
1073 -- you to press Ctrl-Break rather than Ctrl-C to provoke
1074 -- an interrupt. Ctrl-C is getting blocked somewhere, I don't know
1075 -- why --SDM 17/12/2004
1076 let sig_handler ControlC = interrupt
1077 sig_handler Break = interrupt
1078 sig_handler _ = return ()
1080 installHandler (Catch sig_handler)
1083 return () -- nothing
1086 #if __GLASGOW_HASKELL__ <= 604
1087 isInfixOf :: (Eq a) => [a] -> [a] -> Bool
1088 isInfixOf needle haystack = any (isPrefixOf needle) (tails haystack)