Refuse to register packages with unversioned dependencies; trac #1837
[ghc.git] / utils / ghc-pkg / Main.hs
1 {-# OPTIONS -fglasgow-exts -cpp #-}
2 -----------------------------------------------------------------------------
3 --
4 -- (c) The University of Glasgow 2004.
5 --
6 -- Package management tool
7 --
8 -----------------------------------------------------------------------------
9
10 -- TODO:
11 -- * validate modules
12 -- * expanding of variables in new-style package conf
13 -- * version manipulation (checking whether old version exists,
14 -- hiding old version?)
15
16 module Main (main) where
17
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 )
28
29 import Prelude
30
31 #include "../../includes/ghcconfig.h"
32
33 import System.Console.GetOpt
34 import Text.PrettyPrint
35 #if __GLASGOW_HASKELL__ >= 609
36 import qualified Control.Exception as Exception
37 #else
38 import qualified Control.Exception.Extensible as Exception
39 #endif
40 import Data.Maybe
41
42 import Data.Char ( isSpace, toLower )
43 import Control.Monad
44 import System.Directory ( doesDirectoryExist, getDirectoryContents,
45 doesFileExist, renameFile, removeFile )
46 import System.Exit ( exitWith, ExitCode(..) )
47 import System.Environment ( getArgs, getProgName, getEnv )
48 import System.IO
49 import System.IO.Error (try)
50 import Data.List
51 import Control.Concurrent
52
53 import Foreign
54 import Foreign.C
55 #ifdef mingw32_HOST_OS
56 import GHC.ConsoleHandler
57 #else
58 import System.Posix hiding (fdToHandle)
59 #endif
60
61 import IO ( isPermissionError )
62 import System.Posix.Internals
63 import GHC.Handle (fdToHandle)
64
65 #if defined(GLOB)
66 import System.Process(runInteractiveCommand)
67 import qualified System.Info(os)
68 #endif
69
70 -- -----------------------------------------------------------------------------
71 -- Entry point
72
73 main :: IO ()
74 main = do
75 args <- getArgs
76
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 ->
82 bye ourCopyright
83 (cli,nonopts,[]) ->
84 runit cli nonopts
85 (_,_,errors) -> do
86 prog <- getProgramName
87 die (concat errors ++ usageInfo (usageHeader prog) flags)
88
89 -- -----------------------------------------------------------------------------
90 -- Command-line syntax
91
92 data Flag
93 = FlagUser
94 | FlagGlobal
95 | FlagHelp
96 | FlagVersion
97 | FlagConfig FilePath
98 | FlagGlobalConfig FilePath
99 | FlagForce
100 | FlagForceFiles
101 | FlagAutoGHCiLibs
102 | FlagSimpleOutput
103 | FlagNamesOnly
104 | FlagIgnoreCase
105 | FlagNoUserDb
106 deriving Eq
107
108 flags :: [OptDescr Flag]
109 flags = [
110 Option [] ["user"] (NoArg FlagUser)
111 "use the current user's package database",
112 Option [] ["global"] (NoArg FlagGlobal)
113 "use the global package database",
114 Option ['f'] ["package-conf"] (ReqArg FlagConfig "FILE")
115 "use the specified package config file",
116 Option [] ["global-conf"] (ReqArg FlagGlobalConfig "FILE")
117 "location of the global package config",
118 Option [] ["no-user-package-conf"] (NoArg FlagNoUserDb)
119 "never read the user package database",
120 Option [] ["force"] (NoArg FlagForce)
121 "ignore missing dependencies, directories, and libraries",
122 Option [] ["force-files"] (NoArg FlagForceFiles)
123 "ignore missing directories and libraries only",
124 Option ['g'] ["auto-ghci-libs"] (NoArg FlagAutoGHCiLibs)
125 "automatically build libs for GHCi (with register)",
126 Option ['?'] ["help"] (NoArg FlagHelp)
127 "display this help and exit",
128 Option ['V'] ["version"] (NoArg FlagVersion)
129 "output version information and exit",
130 Option [] ["simple-output"] (NoArg FlagSimpleOutput)
131 "print output in easy-to-parse format for some commands",
132 Option [] ["names-only"] (NoArg FlagNamesOnly)
133 "only print package names, not versions; can only be used with list --simple-output",
134 Option [] ["ignore-case"] (NoArg FlagIgnoreCase)
135 "ignore case for substring matching"
136 ]
137
138 deprecFlags :: [OptDescr Flag]
139 deprecFlags = [
140 -- put deprecated flags here
141 ]
142
143 ourCopyright :: String
144 ourCopyright = "GHC package manager version " ++ Version.version ++ "\n"
145
146 usageHeader :: String -> String
147 usageHeader prog = substProg prog $
148 "Usage:\n" ++
149 " $p register {filename | -}\n" ++
150 " Register the package using the specified installed package\n" ++
151 " description. The syntax for the latter is given in the $p\n" ++
152 " documentation.\n" ++
153 "\n" ++
154 " $p update {filename | -}\n" ++
155 " Register the package, overwriting any other package with the\n" ++
156 " same name.\n" ++
157 "\n" ++
158 " $p unregister {pkg-id}\n" ++
159 " Unregister the specified package.\n" ++
160 "\n" ++
161 " $p expose {pkg-id}\n" ++
162 " Expose the specified package.\n" ++
163 "\n" ++
164 " $p hide {pkg-id}\n" ++
165 " Hide the specified package.\n" ++
166 "\n" ++
167 " $p list [pkg]\n" ++
168 " List registered packages in the global database, and also the\n" ++
169 " user database if --user is given. If a package name is given\n" ++
170 " all the registered versions will be listed in ascending order.\n" ++
171 " Accepts the --simple-output flag.\n" ++
172 "\n" ++
173 " $p find-module {module}\n" ++
174 " List registered packages exposing module {module} in the global\n" ++
175 " database, and also the user database if --user is given.\n" ++
176 " All the registered versions will be listed in ascending order.\n" ++
177 " Accepts the --simple-output flag.\n" ++
178 "\n" ++
179 " $p latest {pkg-id}\n" ++
180 " Prints the highest registered version of a package.\n" ++
181 "\n" ++
182 " $p check\n" ++
183 " Check the consistency of package depenencies and list broken packages.\n" ++
184 " Accepts the --simple-output flag.\n" ++
185 "\n" ++
186 " $p describe {pkg}\n" ++
187 " Give the registered description for the specified package. The\n" ++
188 " description is returned in precisely the syntax required by $p\n" ++
189 " register.\n" ++
190 "\n" ++
191 " $p field {pkg} {field}\n" ++
192 " Extract the specified field of the package description for the\n" ++
193 " specified package. Accepts comma-separated multiple fields.\n" ++
194 "\n" ++
195 " $p dump\n" ++
196 " Dump the registered description for every package. This is like\n" ++
197 " \"ghc-pkg describe '*'\", except that it is intended to be used\n" ++
198 " by tools that parse the results, rather than humans.\n" ++
199 "\n" ++
200 " Substring matching is supported for {module} in find-module and\n" ++
201 " for {pkg} in list, describe, and field, where a '*' indicates\n" ++
202 " open substring ends (prefix*, *suffix, *infix*).\n" ++
203 "\n" ++
204 " When asked to modify a database (register, unregister, update,\n"++
205 " hide, expose, and also check), ghc-pkg modifies the global database by\n"++
206 " default. Specifying --user causes it to act on the user database,\n"++
207 " or --package-conf can be used to act on another database\n"++
208 " entirely. When multiple of these options are given, the rightmost\n"++
209 " one is used as the database to act upon.\n"++
210 "\n"++
211 " Commands that query the package database (list, latest, describe,\n"++
212 " field) operate on the list of databases specified by the flags\n"++
213 " --user, --global, and --package-conf. If none of these flags are\n"++
214 " given, the default is --global --user.\n"++
215 "\n" ++
216 " The following optional flags are also accepted:\n"
217
218 substProg :: String -> String -> String
219 substProg _ [] = []
220 substProg prog ('$':'p':xs) = prog ++ substProg prog xs
221 substProg prog (c:xs) = c : substProg prog xs
222
223 -- -----------------------------------------------------------------------------
224 -- Do the business
225
226 data Force = ForceAll | ForceFiles | NoForce
227
228 data PackageArg = Id PackageIdentifier | Substring String (String->Bool)
229
230 runit :: [Flag] -> [String] -> IO ()
231 runit cli nonopts = do
232 installSignalHandlers -- catch ^C and clean up
233 prog <- getProgramName
234 let
235 force
236 | FlagForce `elem` cli = ForceAll
237 | FlagForceFiles `elem` cli = ForceFiles
238 | otherwise = NoForce
239 auto_ghci_libs = FlagAutoGHCiLibs `elem` cli
240 splitFields fields = unfoldr splitComma (',':fields)
241 where splitComma "" = Nothing
242 splitComma fs = Just $ break (==',') (tail fs)
243
244 substringCheck :: String -> Maybe (String -> Bool)
245 substringCheck "" = Nothing
246 substringCheck "*" = Just (const True)
247 substringCheck [_] = Nothing
248 substringCheck (h:t) =
249 case (h, init t, last t) of
250 ('*',s,'*') -> Just (isInfixOf (f s) . f)
251 ('*',_, _ ) -> Just (isSuffixOf (f t) . f)
252 ( _ ,s,'*') -> Just (isPrefixOf (f (h:s)) . f)
253 _ -> Nothing
254 where f | FlagIgnoreCase `elem` cli = map toLower
255 | otherwise = id
256 #if defined(GLOB)
257 glob x | System.Info.os=="mingw32" = do
258 -- glob echoes its argument, after win32 filename globbing
259 (_,o,_,_) <- runInteractiveCommand ("glob "++x)
260 txt <- hGetContents o
261 return (read txt)
262 glob x | otherwise = return [x]
263 #endif
264 --
265 -- first, parse the command
266 case nonopts of
267 #if defined(GLOB)
268 -- dummy command to demonstrate usage and permit testing
269 -- without messing things up; use glob to selectively enable
270 -- windows filename globbing for file parameters
271 -- register, update, FlagGlobalConfig, FlagConfig; others?
272 ["glob", filename] -> do
273 print filename
274 glob filename >>= print
275 #endif
276 ["register", filename] ->
277 registerPackage filename cli auto_ghci_libs False force
278 ["update", filename] ->
279 registerPackage filename cli auto_ghci_libs True force
280 ["unregister", pkgid_str] -> do
281 pkgid <- readGlobPkgId pkgid_str
282 unregisterPackage pkgid cli force
283 ["expose", pkgid_str] -> do
284 pkgid <- readGlobPkgId pkgid_str
285 exposePackage pkgid cli force
286 ["hide", pkgid_str] -> do
287 pkgid <- readGlobPkgId pkgid_str
288 hidePackage pkgid cli force
289 ["list"] -> do
290 listPackages cli Nothing Nothing
291 ["list", pkgid_str] ->
292 case substringCheck pkgid_str of
293 Nothing -> do pkgid <- readGlobPkgId pkgid_str
294 listPackages cli (Just (Id pkgid)) Nothing
295 Just m -> listPackages cli (Just (Substring pkgid_str m)) Nothing
296 ["find-module", moduleName] -> do
297 let match = maybe (==moduleName) id (substringCheck moduleName)
298 listPackages cli Nothing (Just match)
299 ["latest", pkgid_str] -> do
300 pkgid <- readGlobPkgId pkgid_str
301 latestPackage cli pkgid
302 ["describe", pkgid_str] ->
303 case substringCheck pkgid_str of
304 Nothing -> do pkgid <- readGlobPkgId pkgid_str
305 describePackage cli (Id pkgid)
306 Just m -> describePackage cli (Substring pkgid_str m)
307 ["field", pkgid_str, fields] ->
308 case substringCheck pkgid_str of
309 Nothing -> do pkgid <- readGlobPkgId pkgid_str
310 describeField cli (Id pkgid) (splitFields fields)
311 Just m -> describeField cli (Substring pkgid_str m)
312 (splitFields fields)
313 ["check"] -> do
314 checkConsistency cli
315
316 ["dump"] -> do
317 dumpPackages cli
318
319 [] -> do
320 die ("missing command\n" ++
321 usageInfo (usageHeader prog) flags)
322 (_cmd:_) -> do
323 die ("command-line syntax error\n" ++
324 usageInfo (usageHeader prog) flags)
325
326 parseCheck :: ReadP a a -> String -> String -> IO a
327 parseCheck parser str what =
328 case [ x | (x,ys) <- readP_to_S parser str, all isSpace ys ] of
329 [x] -> return x
330 _ -> die ("cannot parse \'" ++ str ++ "\' as a " ++ what)
331
332 readGlobPkgId :: String -> IO PackageIdentifier
333 readGlobPkgId str = parseCheck parseGlobPackageId str "package identifier"
334
335 parseGlobPackageId :: ReadP r PackageIdentifier
336 parseGlobPackageId =
337 parse
338 +++
339 (do n <- parse
340 string "-*"
341 return (PackageIdentifier{ pkgName = n, pkgVersion = globVersion }))
342
343 -- globVersion means "all versions"
344 globVersion :: Version
345 globVersion = Version{ versionBranch=[], versionTags=["*"] }
346
347 -- -----------------------------------------------------------------------------
348 -- Package databases
349
350 -- Some commands operate on a single database:
351 -- register, unregister, expose, hide
352 -- however these commands also check the union of the available databases
353 -- in order to check consistency. For example, register will check that
354 -- dependencies exist before registering a package.
355 --
356 -- Some commands operate on multiple databases, with overlapping semantics:
357 -- list, describe, field
358
359 type PackageDBName = FilePath
360 type PackageDB = [InstalledPackageInfo]
361
362 type NamedPackageDB = (PackageDBName, PackageDB)
363 type PackageDBStack = [NamedPackageDB]
364 -- A stack of package databases. Convention: head is the topmost
365 -- in the stack. Earlier entries override later one.
366
367 allPackagesInStack :: PackageDBStack -> [InstalledPackageInfo]
368 allPackagesInStack = concatMap snd
369
370 getPkgDatabases :: Bool -> [Flag] -> IO (PackageDBStack, Maybe PackageDBName)
371 getPkgDatabases modify my_flags = do
372 -- first we determine the location of the global package config. On Windows,
373 -- this is found relative to the ghc-pkg.exe binary, whereas on Unix the
374 -- location is passed to the binary using the --global-config flag by the
375 -- wrapper script.
376 let err_msg = "missing --global-conf option, location of global package.conf unknown\n"
377 global_conf <-
378 case [ f | FlagGlobalConfig f <- my_flags ] of
379 [] -> do mb_dir <- getExecDir "/bin/ghc-pkg.exe"
380 case mb_dir of
381 Nothing -> die err_msg
382 Just dir ->
383 do let path1 = dir </> "package.conf"
384 path2 = dir </> ".." </> ".." </> ".."
385 </> "inplace-datadir"
386 </> "package.conf"
387 exists1 <- doesFileExist path1
388 exists2 <- doesFileExist path2
389 if exists1 then return path1
390 else if exists2 then return path2
391 else die "Can't find package.conf"
392 fs -> return (last fs)
393
394 let global_conf_dir = global_conf ++ ".d"
395 global_conf_dir_exists <- doesDirectoryExist global_conf_dir
396 global_confs <-
397 if global_conf_dir_exists
398 then do files <- getDirectoryContents global_conf_dir
399 return [ global_conf_dir ++ '/' : file
400 | file <- files
401 , isSuffixOf ".conf" file]
402 else return []
403
404 let no_user_db = FlagNoUserDb `elem` my_flags
405
406 -- get the location of the user package database, and create it if necessary
407 -- getAppUserDataDirectory can fail (e.g. if $HOME isn't set)
408 appdir <- try $ getAppUserDataDirectory "ghc"
409
410 mb_user_conf <-
411 if no_user_db then return Nothing else
412 case appdir of
413 Right dir -> do
414 let subdir = targetARCH ++ '-':targetOS ++ '-':Version.version
415 user_conf = dir </> subdir </> "package.conf"
416 user_exists <- doesFileExist user_conf
417 return (Just (user_conf,user_exists))
418 Left _ ->
419 return Nothing
420
421 -- If the user database doesn't exist, and this command isn't a
422 -- "modify" command, then we won't attempt to create or use it.
423 let sys_databases
424 | Just (user_conf,user_exists) <- mb_user_conf,
425 modify || user_exists = user_conf : global_confs ++ [global_conf]
426 | otherwise = global_confs ++ [global_conf]
427
428 e_pkg_path <- try (System.Environment.getEnv "GHC_PACKAGE_PATH")
429 let env_stack =
430 case e_pkg_path of
431 Left _ -> sys_databases
432 Right path
433 | last cs == "" -> init cs ++ sys_databases
434 | otherwise -> cs
435 where cs = parseSearchPath path
436
437 -- The "global" database is always the one at the bottom of the stack.
438 -- This is the database we modify by default.
439 virt_global_conf = last env_stack
440
441 let db_flags = [ f | Just f <- map is_db_flag my_flags ]
442 where is_db_flag FlagUser
443 | Just (user_conf, _user_exists) <- mb_user_conf
444 = Just user_conf
445 is_db_flag FlagGlobal = Just virt_global_conf
446 is_db_flag (FlagConfig f) = Just f
447 is_db_flag _ = Nothing
448
449 (final_stack, to_modify) <-
450 if not modify
451 then -- For a "read" command, we use all the databases
452 -- specified on the command line. If there are no
453 -- command-line flags specifying databases, the default
454 -- is to use all the ones we know about.
455 if null db_flags then return (env_stack, Nothing)
456 else return (reverse (nub db_flags), Nothing)
457 else let
458 -- For a "modify" command, treat all the databases as
459 -- a stack, where we are modifying the top one, but it
460 -- can refer to packages in databases further down the
461 -- stack.
462
463 -- -f flags on the command line add to the database
464 -- stack, unless any of them are present in the stack
465 -- already.
466 flag_stack = filter (`notElem` env_stack)
467 [ f | FlagConfig f <- reverse my_flags ]
468 ++ env_stack
469
470 -- the database we actually modify is the one mentioned
471 -- rightmost on the command-line.
472 to_modify = if null db_flags
473 then Just virt_global_conf
474 else Just (last db_flags)
475 in
476 return (flag_stack, to_modify)
477
478 db_stack <- mapM readParseDatabase final_stack
479 return (db_stack, to_modify)
480
481 readParseDatabase :: PackageDBName -> IO (PackageDBName,PackageDB)
482 readParseDatabase filename = do
483 str <- readFile filename `catchIO` \_ -> return emptyPackageConfig
484 let packages = map convertPackageInfoIn $ read str
485 Exception.evaluate packages
486 `catchError` \e->
487 die ("error while parsing " ++ filename ++ ": " ++ show e)
488 return (filename,packages)
489
490 emptyPackageConfig :: String
491 emptyPackageConfig = "[]"
492
493 -- -----------------------------------------------------------------------------
494 -- Registering
495
496 registerPackage :: FilePath
497 -> [Flag]
498 -> Bool -- auto_ghci_libs
499 -> Bool -- update
500 -> Force
501 -> IO ()
502 registerPackage input my_flags auto_ghci_libs update force = do
503 (db_stack, Just to_modify) <- getPkgDatabases True my_flags
504 let
505 db_to_operate_on = my_head "register" $
506 filter ((== to_modify).fst) db_stack
507 --
508 s <-
509 case input of
510 "-" -> do
511 putStr "Reading package info from stdin ... "
512 getContents
513 f -> do
514 putStr ("Reading package info from " ++ show f ++ " ... ")
515 readFile f
516
517 expanded <- expandEnvVars s force
518
519 pkg <- parsePackageInfo expanded
520 putStrLn "done."
521
522 let unversioned_deps = filter (not . realVersion) (depends pkg)
523 unless (null unversioned_deps) $
524 die ("Unversioned dependencies found: " ++
525 unwords (map display unversioned_deps))
526
527 let truncated_stack = dropWhile ((/= to_modify).fst) db_stack
528 -- truncate the stack for validation, because we don't allow
529 -- packages lower in the stack to refer to those higher up.
530 validatePackageConfig pkg truncated_stack auto_ghci_libs update force
531 let new_details = filter not_this (snd db_to_operate_on) ++ [pkg]
532 not_this p = package p /= package pkg
533 writeNewConfig to_modify new_details
534
535 parsePackageInfo
536 :: String
537 -> IO InstalledPackageInfo
538 parsePackageInfo str =
539 case parseInstalledPackageInfo str of
540 ParseOk _warns ok -> return ok
541 ParseFailed err -> case locatedErrorMsg err of
542 (Nothing, s) -> die s
543 (Just l, s) -> die (show l ++ ": " ++ s)
544
545 -- -----------------------------------------------------------------------------
546 -- Exposing, Hiding, Unregistering are all similar
547
548 exposePackage :: PackageIdentifier -> [Flag] -> Force -> IO ()
549 exposePackage = modifyPackage (\p -> [p{exposed=True}])
550
551 hidePackage :: PackageIdentifier -> [Flag] -> Force -> IO ()
552 hidePackage = modifyPackage (\p -> [p{exposed=False}])
553
554 unregisterPackage :: PackageIdentifier -> [Flag] -> Force -> IO ()
555 unregisterPackage = modifyPackage (\_ -> [])
556
557 modifyPackage
558 :: (InstalledPackageInfo -> [InstalledPackageInfo])
559 -> PackageIdentifier
560 -> [Flag]
561 -> Force
562 -> IO ()
563 modifyPackage fn pkgid my_flags force = do
564 (db_stack, Just _to_modify) <- getPkgDatabases True{-modify-} my_flags
565 ((db_name, pkgs), ps) <- fmap head $ findPackagesByDB db_stack (Id pkgid)
566 -- let ((db_name, pkgs) : rest_of_stack) = db_stack
567 -- ps <- findPackages [(db_name,pkgs)] (Id pkgid)
568 let
569 pids = map package ps
570 modify pkg
571 | package pkg `elem` pids = fn pkg
572 | otherwise = [pkg]
573 new_config = concat (map modify pkgs)
574
575 let
576 old_broken = brokenPackages (allPackagesInStack db_stack)
577 rest_of_stack = [ (nm, mypkgs)
578 | (nm, mypkgs) <- db_stack, nm /= db_name ]
579 new_stack = (db_name,new_config) : rest_of_stack
580 new_broken = map package (brokenPackages (allPackagesInStack new_stack))
581 newly_broken = filter (`notElem` map package old_broken) new_broken
582 --
583 when (not (null newly_broken)) $
584 dieOrForceAll force ("unregistering " ++ display pkgid ++
585 " would break the following packages: "
586 ++ unwords (map display newly_broken))
587
588 writeNewConfig db_name new_config
589
590 -- -----------------------------------------------------------------------------
591 -- Listing packages
592
593 listPackages :: [Flag] -> Maybe PackageArg -> Maybe (String->Bool) -> IO ()
594 listPackages my_flags mPackageName mModuleName = do
595 let simple_output = FlagSimpleOutput `elem` my_flags
596 (db_stack, _) <- getPkgDatabases False my_flags
597 let db_stack_filtered -- if a package is given, filter out all other packages
598 | Just this <- mPackageName =
599 map (\(conf,pkgs) -> (conf, filter (this `matchesPkg`) pkgs))
600 db_stack
601 | Just match <- mModuleName = -- packages which expose mModuleName
602 map (\(conf,pkgs) -> (conf, filter (match `exposedInPkg`) pkgs))
603 db_stack
604 | otherwise = db_stack
605
606 db_stack_sorted
607 = [ (db, sort_pkgs pkgs) | (db,pkgs) <- db_stack_filtered ]
608 where sort_pkgs = sortBy cmpPkgIds
609 cmpPkgIds pkg1 pkg2 =
610 case pkgName p1 `compare` pkgName p2 of
611 LT -> LT
612 GT -> GT
613 EQ -> pkgVersion p1 `compare` pkgVersion p2
614 where (p1,p2) = (package pkg1, package pkg2)
615
616 match `exposedInPkg` pkg = any match (map display $ exposedModules pkg)
617
618 pkg_map = allPackagesInStack db_stack
619 show_func = if simple_output then show_simple else mapM_ (show_normal pkg_map)
620
621 show_func (reverse db_stack_sorted)
622
623 where show_normal pkg_map (db_name,pkg_confs) =
624 hPutStrLn stdout (render $
625 text db_name <> colon $$ nest 4 packages
626 )
627 where packages = fsep (punctuate comma (map pp_pkg pkg_confs))
628 broken = map package (brokenPackages pkg_map)
629 pp_pkg p
630 | package p `elem` broken = braces doc
631 | exposed p = doc
632 | otherwise = parens doc
633 where doc = text (display (package p))
634
635 show_simple db_stack = do
636 let showPkg = if FlagNamesOnly `elem` my_flags then display . pkgName
637 else display
638 pkgs = map showPkg $ sortBy compPkgIdVer $
639 map package (allPackagesInStack db_stack)
640 when (not (null pkgs)) $
641 hPutStrLn stdout $ concat $ intersperse " " pkgs
642
643 -- -----------------------------------------------------------------------------
644 -- Prints the highest (hidden or exposed) version of a package
645
646 latestPackage :: [Flag] -> PackageIdentifier -> IO ()
647 latestPackage my_flags pkgid = do
648 (db_stack, _) <- getPkgDatabases False my_flags
649 ps <- findPackages db_stack (Id pkgid)
650 show_pkg (sortBy compPkgIdVer (map package ps))
651 where
652 show_pkg [] = die "no matches"
653 show_pkg pids = hPutStrLn stdout (display (last pids))
654
655 -- -----------------------------------------------------------------------------
656 -- Describe
657
658 describePackage :: [Flag] -> PackageArg -> IO ()
659 describePackage my_flags pkgarg = do
660 (db_stack, _) <- getPkgDatabases False my_flags
661 ps <- findPackages db_stack pkgarg
662 doDump ps
663
664 dumpPackages :: [Flag] -> IO ()
665 dumpPackages my_flags = do
666 (db_stack, _) <- getPkgDatabases False my_flags
667 doDump (allPackagesInStack db_stack)
668
669 doDump :: [InstalledPackageInfo] -> IO ()
670 doDump = mapM_ putStrLn . intersperse "---" . map showInstalledPackageInfo
671
672 -- PackageId is can have globVersion for the version
673 findPackages :: PackageDBStack -> PackageArg -> IO [InstalledPackageInfo]
674 findPackages db_stack pkgarg
675 = fmap (concatMap snd) $ findPackagesByDB db_stack pkgarg
676
677 findPackagesByDB :: PackageDBStack -> PackageArg
678 -> IO [(NamedPackageDB, [InstalledPackageInfo])]
679 findPackagesByDB db_stack pkgarg
680 = case [ (db, matched)
681 | db@(_, pkgs) <- db_stack,
682 let matched = filter (pkgarg `matchesPkg`) pkgs,
683 not (null matched) ] of
684 [] -> die ("cannot find package " ++ pkg_msg pkgarg)
685 ps -> return ps
686 where
687 pkg_msg (Id pkgid) = display pkgid
688 pkg_msg (Substring pkgpat _) = "matching " ++ pkgpat
689
690 matches :: PackageIdentifier -> PackageIdentifier -> Bool
691 pid `matches` pid'
692 = (pkgName pid == pkgName pid')
693 && (pkgVersion pid == pkgVersion pid' || not (realVersion pid))
694
695 matchesPkg :: PackageArg -> InstalledPackageInfo -> Bool
696 (Id pid) `matchesPkg` pkg = pid `matches` package pkg
697 (Substring _ m) `matchesPkg` pkg = m (display (package pkg))
698
699 compPkgIdVer :: PackageIdentifier -> PackageIdentifier -> Ordering
700 compPkgIdVer p1 p2 = pkgVersion p1 `compare` pkgVersion p2
701
702 -- -----------------------------------------------------------------------------
703 -- Field
704
705 describeField :: [Flag] -> PackageArg -> [String] -> IO ()
706 describeField my_flags pkgarg fields = do
707 (db_stack, _) <- getPkgDatabases False my_flags
708 fns <- toFields fields
709 ps <- findPackages db_stack pkgarg
710 let top_dir = takeDirectory (fst (last db_stack))
711 mapM_ (selectFields fns) (mungePackagePaths top_dir ps)
712 where toFields [] = return []
713 toFields (f:fs) = case toField f of
714 Nothing -> die ("unknown field: " ++ f)
715 Just fn -> do fns <- toFields fs
716 return (fn:fns)
717 selectFields fns info = mapM_ (\fn->putStrLn (fn info)) fns
718
719 mungePackagePaths :: String -> [InstalledPackageInfo] -> [InstalledPackageInfo]
720 -- Replace the strings "$topdir" and "$httptopdir" at the beginning of a path
721 -- with the current topdir (obtained from the -B option).
722 mungePackagePaths top_dir ps = map munge_pkg ps
723 where
724 munge_pkg p = p{ importDirs = munge_paths (importDirs p),
725 includeDirs = munge_paths (includeDirs p),
726 libraryDirs = munge_paths (libraryDirs p),
727 frameworkDirs = munge_paths (frameworkDirs p),
728 haddockInterfaces = munge_paths (haddockInterfaces p),
729 haddockHTMLs = munge_paths (haddockHTMLs p)
730 }
731
732 munge_paths = map munge_path
733
734 munge_path p
735 | Just p' <- maybePrefixMatch "$topdir" p = top_dir ++ p'
736 | Just p' <- maybePrefixMatch "$httptopdir" p = toHttpPath top_dir ++ p'
737 | otherwise = p
738
739 toHttpPath p = "file:///" ++ p
740
741 maybePrefixMatch :: String -> String -> Maybe String
742 maybePrefixMatch [] rest = Just rest
743 maybePrefixMatch (_:_) [] = Nothing
744 maybePrefixMatch (p:pat) (r:rest)
745 | p == r = maybePrefixMatch pat rest
746 | otherwise = Nothing
747
748 toField :: String -> Maybe (InstalledPackageInfo -> String)
749 -- backwards compatibility:
750 toField "import_dirs" = Just $ strList . importDirs
751 toField "source_dirs" = Just $ strList . importDirs
752 toField "library_dirs" = Just $ strList . libraryDirs
753 toField "hs_libraries" = Just $ strList . hsLibraries
754 toField "extra_libraries" = Just $ strList . extraLibraries
755 toField "include_dirs" = Just $ strList . includeDirs
756 toField "c_includes" = Just $ strList . includes
757 toField "package_deps" = Just $ strList . map display. depends
758 toField "extra_cc_opts" = Just $ strList . ccOptions
759 toField "extra_ld_opts" = Just $ strList . ldOptions
760 toField "framework_dirs" = Just $ strList . frameworkDirs
761 toField "extra_frameworks"= Just $ strList . frameworks
762 toField s = showInstalledPackageInfoField s
763
764 strList :: [String] -> String
765 strList = show
766
767
768 -- -----------------------------------------------------------------------------
769 -- Check: Check consistency of installed packages
770
771 checkConsistency :: [Flag] -> IO ()
772 checkConsistency my_flags = do
773 (db_stack, _) <- getPkgDatabases True my_flags
774 -- check behaves like modify for the purposes of deciding which
775 -- databases to use, because ordering is important.
776 let pkgs = allPackagesInStack db_stack
777 broken_pkgs = brokenPackages pkgs
778 broken_ids = map package broken_pkgs
779 broken_why = [ (package p, filter (`elem` broken_ids) (depends p))
780 | p <- broken_pkgs ]
781 mapM_ (putStrLn . render . show_func) broken_why
782 where
783 show_func | FlagSimpleOutput `elem` my_flags = show_simple
784 | otherwise = show_normal
785 show_simple (pid,deps) =
786 text (display pid) <> colon
787 <+> fsep (punctuate comma (map (text . display) deps))
788 show_normal (pid,deps) =
789 text "package" <+> text (display pid) <+> text "has missing dependencies:"
790 $$ nest 4 (fsep (punctuate comma (map (text . display) deps)))
791
792
793 brokenPackages :: [InstalledPackageInfo] -> [InstalledPackageInfo]
794 brokenPackages pkgs = go [] pkgs
795 where
796 go avail not_avail =
797 case partition (depsAvailable avail) not_avail of
798 ([], not_avail') -> not_avail'
799 (new_avail, not_avail') -> go (new_avail ++ avail) not_avail'
800
801 depsAvailable :: [InstalledPackageInfo] -> InstalledPackageInfo
802 -> Bool
803 depsAvailable pkgs_ok pkg = null dangling
804 where dangling = filter (`notElem` pids) (depends pkg)
805 pids = map package pkgs_ok
806
807 -- we want mutually recursive groups of package to show up
808 -- as broken. (#1750)
809
810 -- -----------------------------------------------------------------------------
811 -- Manipulating package.conf files
812
813 type InstalledPackageInfoString = InstalledPackageInfo_ String
814
815 convertPackageInfoOut :: InstalledPackageInfo -> InstalledPackageInfoString
816 convertPackageInfoOut
817 (pkgconf@(InstalledPackageInfo { exposedModules = e,
818 hiddenModules = h })) =
819 pkgconf{ exposedModules = map display e,
820 hiddenModules = map display h }
821
822 convertPackageInfoIn :: InstalledPackageInfoString -> InstalledPackageInfo
823 convertPackageInfoIn
824 (pkgconf@(InstalledPackageInfo { exposedModules = e,
825 hiddenModules = h })) =
826 pkgconf{ exposedModules = map convert e,
827 hiddenModules = map convert h }
828 where convert = fromJust . simpleParse
829
830 writeNewConfig :: FilePath -> [InstalledPackageInfo] -> IO ()
831 writeNewConfig filename packages = do
832 hPutStr stdout "Writing new package config file... "
833 createDirectoryIfMissing True $ takeDirectory filename
834 let shown = concat $ intersperse ",\n "
835 $ map (show . convertPackageInfoOut) packages
836 fileContents = "[" ++ shown ++ "\n]"
837 writeFileAtomic filename fileContents
838 `catch` \e ->
839 if isPermissionError e
840 then die (filename ++ ": you don't have permission to modify this file")
841 else ioError e
842 hPutStrLn stdout "done."
843
844 -----------------------------------------------------------------------------
845 -- Sanity-check a new package config, and automatically build GHCi libs
846 -- if requested.
847
848 validatePackageConfig :: InstalledPackageInfo
849 -> PackageDBStack
850 -> Bool -- auto-ghc-libs
851 -> Bool -- update
852 -> Force
853 -> IO ()
854 validatePackageConfig pkg db_stack auto_ghci_libs update force = do
855 checkPackageId pkg
856 checkDuplicates db_stack pkg update force
857 mapM_ (checkDep db_stack force) (depends pkg)
858 checkDuplicateDepends force (depends pkg)
859 mapM_ (checkDir force) (importDirs pkg)
860 mapM_ (checkDir force) (libraryDirs pkg)
861 mapM_ (checkDir force) (includeDirs pkg)
862 mapM_ (checkHSLib (libraryDirs pkg) auto_ghci_libs force) (hsLibraries pkg)
863 -- ToDo: check these somehow?
864 -- extra_libraries :: [String],
865 -- c_includes :: [String],
866
867 -- When the package name and version are put together, sometimes we can
868 -- end up with a package id that cannot be parsed. This will lead to
869 -- difficulties when the user wants to refer to the package later, so
870 -- we check that the package id can be parsed properly here.
871 checkPackageId :: InstalledPackageInfo -> IO ()
872 checkPackageId ipi =
873 let str = display (package ipi) in
874 case [ x :: PackageIdentifier | (x,ys) <- readP_to_S parse str, all isSpace ys ] of
875 [_] -> return ()
876 [] -> die ("invalid package identifier: " ++ str)
877 _ -> die ("ambiguous package identifier: " ++ str)
878
879 checkDuplicates :: PackageDBStack -> InstalledPackageInfo -> Bool -> Force -> IO ()
880 checkDuplicates db_stack pkg update force = do
881 let
882 pkgid = package pkg
883 (_top_db_name, pkgs) : _ = db_stack
884 --
885 -- Check whether this package id already exists in this DB
886 --
887 when (not update && (pkgid `elem` map package pkgs)) $
888 die ("package " ++ display pkgid ++ " is already installed")
889
890 let
891 uncasep = map toLower . display
892 dups = filter ((== uncasep pkgid) . uncasep) (map package pkgs)
893
894 when (not update && not (null dups)) $ dieOrForceAll force $
895 "Package names may be treated case-insensitively in the future.\n"++
896 "Package " ++ display pkgid ++
897 " overlaps with: " ++ unwords (map display dups)
898
899
900 checkDir :: Force -> String -> IO ()
901 checkDir force d
902 | "$topdir" `isPrefixOf` d = return ()
903 | "$httptopdir" `isPrefixOf` d = return ()
904 -- can't check these, because we don't know what $(http)topdir is
905 | otherwise = do
906 there <- doesDirectoryExist d
907 when (not there)
908 (dieOrForceFile force (d ++ " doesn't exist or isn't a directory"))
909
910 checkDep :: PackageDBStack -> Force -> PackageIdentifier -> IO ()
911 checkDep db_stack force pkgid
912 | pkgid `elem` pkgids || (not real_version && name_exists) = return ()
913 | otherwise = dieOrForceAll force ("dependency " ++ display pkgid
914 ++ " doesn't exist")
915 where
916 -- for backwards compat, we treat 0.0 as a special version,
917 -- and don't check that it actually exists.
918 real_version = realVersion pkgid
919
920 name_exists = any (\p -> pkgName (package p) == name) all_pkgs
921 name = pkgName pkgid
922
923 all_pkgs = allPackagesInStack db_stack
924 pkgids = map package all_pkgs
925
926 checkDuplicateDepends :: Force -> [PackageIdentifier] -> IO ()
927 checkDuplicateDepends force deps
928 | null dups = return ()
929 | otherwise = dieOrForceAll force ("package has duplicate dependencies: " ++
930 unwords (map display dups))
931 where
932 dups = [ p | (p:_:_) <- group (sort deps) ]
933
934 realVersion :: PackageIdentifier -> Bool
935 realVersion pkgid = versionBranch (pkgVersion pkgid) /= []
936
937 checkHSLib :: [String] -> Bool -> Force -> String -> IO ()
938 checkHSLib dirs auto_ghci_libs force lib = do
939 let batch_lib_file = "lib" ++ lib ++ ".a"
940 bs <- mapM (doesLibExistIn batch_lib_file) dirs
941 case [ dir | (exists,dir) <- zip bs dirs, exists ] of
942 [] -> dieOrForceFile force ("cannot find " ++ batch_lib_file ++
943 " on library path")
944 (dir:_) -> checkGHCiLib dirs dir batch_lib_file lib auto_ghci_libs
945
946 doesLibExistIn :: String -> String -> IO Bool
947 doesLibExistIn lib d
948 | "$topdir" `isPrefixOf` d = return True
949 | "$httptopdir" `isPrefixOf` d = return True
950 | otherwise = doesFileExist (d ++ '/':lib)
951
952 checkGHCiLib :: [String] -> String -> String -> String -> Bool -> IO ()
953 checkGHCiLib dirs batch_lib_dir batch_lib_file lib auto_build
954 | auto_build = autoBuildGHCiLib batch_lib_dir batch_lib_file ghci_lib_file
955 | otherwise = do
956 bs <- mapM (doesLibExistIn ghci_lib_file) dirs
957 case [dir | (exists,dir) <- zip bs dirs, exists] of
958 [] -> hPutStrLn stderr ("warning: can't find GHCi lib " ++ ghci_lib_file)
959 (_:_) -> return ()
960 where
961 ghci_lib_file = lib ++ ".o"
962
963 -- automatically build the GHCi version of a batch lib,
964 -- using ld --whole-archive.
965
966 autoBuildGHCiLib :: String -> String -> String -> IO ()
967 autoBuildGHCiLib dir batch_file ghci_file = do
968 let ghci_lib_file = dir ++ '/':ghci_file
969 batch_lib_file = dir ++ '/':batch_file
970 hPutStr stderr ("building GHCi library " ++ ghci_lib_file ++ "...")
971 #if defined(darwin_HOST_OS)
972 r <- rawSystem "ld" ["-r","-x","-o",ghci_lib_file,"-all_load",batch_lib_file]
973 #elif defined(mingw32_HOST_OS)
974 execDir <- getExecDir "/bin/ghc-pkg.exe"
975 r <- rawSystem (maybe "" (++"/gcc-lib/") execDir++"ld") ["-r","-x","-o",ghci_lib_file,"--whole-archive",batch_lib_file]
976 #else
977 r <- rawSystem "ld" ["-r","-x","-o",ghci_lib_file,"--whole-archive",batch_lib_file]
978 #endif
979 when (r /= ExitSuccess) $ exitWith r
980 hPutStrLn stderr (" done.")
981
982 -- -----------------------------------------------------------------------------
983 -- Searching for modules
984
985 #if not_yet
986
987 findModules :: [FilePath] -> IO [String]
988 findModules paths =
989 mms <- mapM searchDir paths
990 return (concat mms)
991
992 searchDir path prefix = do
993 fs <- getDirectoryEntries path `catch` \_ -> return []
994 searchEntries path prefix fs
995
996 searchEntries path prefix [] = return []
997 searchEntries path prefix (f:fs)
998 | looks_like_a_module = do
999 ms <- searchEntries path prefix fs
1000 return (prefix `joinModule` f : ms)
1001 | looks_like_a_component = do
1002 ms <- searchDir (path </> f) (prefix `joinModule` f)
1003 ms' <- searchEntries path prefix fs
1004 return (ms ++ ms')
1005 | otherwise
1006 searchEntries path prefix fs
1007
1008 where
1009 (base,suffix) = splitFileExt f
1010 looks_like_a_module =
1011 suffix `elem` haskell_suffixes &&
1012 all okInModuleName base
1013 looks_like_a_component =
1014 null suffix && all okInModuleName base
1015
1016 okInModuleName c
1017
1018 #endif
1019
1020 -- ---------------------------------------------------------------------------
1021 -- expanding environment variables in the package configuration
1022
1023 expandEnvVars :: String -> Force -> IO String
1024 expandEnvVars str0 force = go str0 ""
1025 where
1026 go "" acc = return $! reverse acc
1027 go ('$':'{':str) acc | (var, '}':rest) <- break close str
1028 = do value <- lookupEnvVar var
1029 go rest (reverse value ++ acc)
1030 where close c = c == '}' || c == '\n' -- don't span newlines
1031 go (c:str) acc
1032 = go str (c:acc)
1033
1034 lookupEnvVar :: String -> IO String
1035 lookupEnvVar nm =
1036 catch (System.Environment.getEnv nm)
1037 (\ _ -> do dieOrForceAll force ("Unable to expand variable " ++
1038 show nm)
1039 return "")
1040
1041 -----------------------------------------------------------------------------
1042
1043 getProgramName :: IO String
1044 getProgramName = liftM (`withoutSuffix` ".bin") getProgName
1045 where str `withoutSuffix` suff
1046 | suff `isSuffixOf` str = take (length str - length suff) str
1047 | otherwise = str
1048
1049 bye :: String -> IO a
1050 bye s = putStr s >> exitWith ExitSuccess
1051
1052 die :: String -> IO a
1053 die = dieWith 1
1054
1055 dieWith :: Int -> String -> IO a
1056 dieWith ec s = do
1057 hFlush stdout
1058 prog <- getProgramName
1059 hPutStrLn stderr (prog ++ ": " ++ s)
1060 exitWith (ExitFailure ec)
1061
1062 dieOrForceAll :: Force -> String -> IO ()
1063 dieOrForceAll ForceAll s = ignoreError s
1064 dieOrForceAll _other s = dieForcible s
1065
1066 dieOrForceFile :: Force -> String -> IO ()
1067 dieOrForceFile ForceAll s = ignoreError s
1068 dieOrForceFile ForceFiles s = ignoreError s
1069 dieOrForceFile _other s = dieForcible s
1070
1071 ignoreError :: String -> IO ()
1072 ignoreError s = do hFlush stdout; hPutStrLn stderr (s ++ " (ignoring)")
1073
1074 dieForcible :: String -> IO ()
1075 dieForcible s = die (s ++ " (use --force to override)")
1076
1077 my_head :: String -> [a] -> a
1078 my_head s [] = error s
1079 my_head _ (x : _) = x
1080
1081 -----------------------------------------
1082 -- Cut and pasted from ghc/compiler/main/SysTools
1083
1084 #if defined(mingw32_HOST_OS)
1085 subst :: Char -> Char -> String -> String
1086 subst a b ls = map (\ x -> if x == a then b else x) ls
1087
1088 unDosifyPath :: FilePath -> FilePath
1089 unDosifyPath xs = subst '\\' '/' xs
1090
1091 getExecDir :: String -> IO (Maybe String)
1092 -- (getExecDir cmd) returns the directory in which the current
1093 -- executable, which should be called 'cmd', is running
1094 -- So if the full path is /a/b/c/d/e, and you pass "d/e" as cmd,
1095 -- you'll get "/a/b/c" back as the result
1096 getExecDir cmd
1097 = allocaArray len $ \buf -> do
1098 ret <- getModuleFileName nullPtr buf len
1099 if ret == 0 then return Nothing
1100 else do s <- peekCString buf
1101 return (Just (reverse (drop (length cmd)
1102 (reverse (unDosifyPath s)))))
1103 where
1104 len = 2048::Int -- Plenty, PATH_MAX is 512 under Win32.
1105
1106 foreign import stdcall unsafe "GetModuleFileNameA"
1107 getModuleFileName :: Ptr () -> CString -> Int -> IO Int32
1108 #else
1109 getExecDir :: String -> IO (Maybe String)
1110 getExecDir _ = return Nothing
1111 #endif
1112
1113 -----------------------------------------
1114 -- Adapted from ghc/compiler/utils/Panic
1115
1116 installSignalHandlers :: IO ()
1117 installSignalHandlers = do
1118 threadid <- myThreadId
1119 let
1120 interrupt = Exception.throwTo threadid
1121 (Exception.ErrorCall "interrupted")
1122 --
1123 #if !defined(mingw32_HOST_OS)
1124 installHandler sigQUIT (Catch interrupt) Nothing
1125 installHandler sigINT (Catch interrupt) Nothing
1126 return ()
1127 #elif __GLASGOW_HASKELL__ >= 603
1128 -- GHC 6.3+ has support for console events on Windows
1129 -- NOTE: running GHCi under a bash shell for some reason requires
1130 -- you to press Ctrl-Break rather than Ctrl-C to provoke
1131 -- an interrupt. Ctrl-C is getting blocked somewhere, I don't know
1132 -- why --SDM 17/12/2004
1133 let sig_handler ControlC = interrupt
1134 sig_handler Break = interrupt
1135 sig_handler _ = return ()
1136
1137 installHandler (Catch sig_handler)
1138 return ()
1139 #else
1140 return () -- nothing
1141 #endif
1142
1143 #if __GLASGOW_HASKELL__ <= 604
1144 isInfixOf :: (Eq a) => [a] -> [a] -> Bool
1145 isInfixOf needle haystack = any (isPrefixOf needle) (tails haystack)
1146 #endif
1147
1148 catchIO :: IO a -> (Exception.IOException -> IO a) -> IO a
1149 catchIO = Exception.catch
1150
1151 #if mingw32_HOST_OS || mingw32_TARGET_OS
1152 throwIOIO :: Exception.IOException -> IO a
1153 throwIOIO = Exception.throwIO
1154 #endif
1155
1156 catchError :: IO a -> (String -> IO a) -> IO a
1157 catchError io handler = io `Exception.catch` handler'
1158 where handler' (Exception.ErrorCall err) = handler err
1159
1160
1161 -- copied from Cabal's Distribution.Simple.Utils, except that we want
1162 -- to use text files here, rather than binary files.
1163 writeFileAtomic :: FilePath -> String -> IO ()
1164 writeFileAtomic targetFile content = do
1165 (newFile, newHandle) <- openNewFile targetDir template
1166 do hPutStr newHandle content
1167 hClose newHandle
1168 #if mingw32_HOST_OS || mingw32_TARGET_OS
1169 renameFile newFile targetFile
1170 -- If the targetFile exists then renameFile will fail
1171 `catchIO` \err -> do
1172 exists <- doesFileExist targetFile
1173 if exists
1174 then do removeFile targetFile
1175 -- Big fat hairy race condition
1176 renameFile newFile targetFile
1177 -- If the removeFile succeeds and the renameFile fails
1178 -- then we've lost the atomic property.
1179 else throwIOIO err
1180 #else
1181 renameFile newFile targetFile
1182 #endif
1183 `Exception.onException` do hClose newHandle
1184 removeFile newFile
1185 where
1186 template = targetName <.> "tmp"
1187 targetDir | null targetDir_ = "."
1188 | otherwise = targetDir_
1189 --TODO: remove this when takeDirectory/splitFileName is fixed
1190 -- to always return a valid dir
1191 (targetDir_,targetName) = splitFileName targetFile
1192
1193 -- Ugh, this is a copy/paste of code from the base library, but
1194 -- if uses 666 rather than 600 for the permissions.
1195 openNewFile :: FilePath -> String -> IO (FilePath, Handle)
1196 openNewFile dir template = do
1197 pid <- c_getpid
1198 findTempName pid
1199 where
1200 -- We split off the last extension, so we can use .foo.ext files
1201 -- for temporary files (hidden on Unix OSes). Unfortunately we're
1202 -- below filepath in the hierarchy here.
1203 (prefix,suffix) =
1204 case break (== '.') $ reverse template of
1205 -- First case: template contains no '.'s. Just re-reverse it.
1206 (rev_suffix, "") -> (reverse rev_suffix, "")
1207 -- Second case: template contains at least one '.'. Strip the
1208 -- dot from the prefix and prepend it to the suffix (if we don't
1209 -- do this, the unique number will get added after the '.' and
1210 -- thus be part of the extension, which is wrong.)
1211 (rev_suffix, '.':rest) -> (reverse rest, '.':reverse rev_suffix)
1212 -- Otherwise, something is wrong, because (break (== '.')) should
1213 -- always return a pair with either the empty string or a string
1214 -- beginning with '.' as the second component.
1215 _ -> error "bug in System.IO.openTempFile"
1216
1217 oflags = rw_flags .|. o_EXCL
1218
1219 findTempName x = do
1220 fd <- withCString filepath $ \ f ->
1221 c_open f oflags 0o666
1222 if fd < 0
1223 then do
1224 errno <- getErrno
1225 if errno == eEXIST
1226 then findTempName (x+1)
1227 else ioError (errnoToIOError "openNewBinaryFile" errno Nothing (Just dir))
1228 else do
1229 -- XXX We want to tell fdToHandle what the filepath is,
1230 -- as any exceptions etc will only be able to report the
1231 -- fd currently
1232 h <-
1233 #if __GLASGOW_HASKELL__ >= 609
1234 fdToHandle fd
1235 #else
1236 fdToHandle (fromIntegral fd)
1237 #endif
1238 `Exception.onException` c_close fd
1239 return (filepath, h)
1240 where
1241 filename = prefix ++ show x ++ suffix
1242 filepath = dir `combine` filename
1243
1244 -- XXX Copied from GHC.Handle
1245 std_flags, output_flags, rw_flags :: CInt
1246 std_flags = o_NONBLOCK .|. o_NOCTTY
1247 output_flags = std_flags .|. o_CREAT
1248 rw_flags = output_flags .|. o_RDWR
1249
1250 -- | The function splits the given string to substrings
1251 -- using 'isSearchPathSeparator'.
1252 parseSearchPath :: String -> [FilePath]
1253 parseSearchPath path = split path
1254 where
1255 split :: String -> [String]
1256 split s =
1257 case rest' of
1258 [] -> [chunk]
1259 _:rest -> chunk : split rest
1260 where
1261 chunk =
1262 case chunk' of
1263 #ifdef mingw32_HOST_OS
1264 ('\"':xs@(_:_)) | last xs == '\"' -> init xs
1265 #endif
1266 _ -> chunk'
1267
1268 (chunk', rest') = break isSearchPathSeparator s