summaryrefslogtreecommitdiff
path: root/Utility
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2015-04-04 14:34:03 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2015-04-04 14:34:03 -0400
commit092e6b0f3f61ad3ede912a00bbbeb635ab9bc267 (patch)
tree57107e1a0aaedd9ceff8c4ec33ad1a8fffc6852a /Utility
parentb3b8a1cdfdc583159c117ebe76e3c6a4eb57114b (diff)
well along the way to fully quiet --quiet
Came up with a generic way to filter out progress messages while keeping errors, for commands that use stderr for both. --json mode will disable command outputs too.
Diffstat (limited to 'Utility')
-rw-r--r--Utility/Metered.hs68
-rw-r--r--Utility/Process.hs16
-rw-r--r--Utility/Rsync.hs4
3 files changed, 69 insertions, 19 deletions
diff --git a/Utility/Metered.hs b/Utility/Metered.hs
index baeea0f59..a4f0f88ee 100644
--- a/Utility/Metered.hs
+++ b/Utility/Metered.hs
@@ -1,4 +1,4 @@
-{- Metered IO
+{- Metered IO and actions
-
- Copyright 2012-2105 Joey Hess <id@joeyh.name>
-
@@ -146,6 +146,11 @@ defaultChunkSize = 32 * k - chunkOverhead
k = 1024
chunkOverhead = 2 * sizeOf (undefined :: Int) -- GHC specific
+data OutputHandler = OutputHandler
+ { quietMode :: Bool
+ , stderrHandler :: String -> IO ()
+ }
+
{- Parses the String looking for a command's progress output, and returns
- Maybe the number of bytes done so far, and any any remainder of the
- string that could be an incomplete progress output. That remainder
@@ -155,23 +160,16 @@ defaultChunkSize = 32 * k - chunkOverhead
-}
type ProgressParser = String -> (Maybe BytesProcessed, String)
-data ProgressHandler = ProgressHandler
- { quietMode :: Bool -- don't forward output to stdout
- , stderrHandler :: Handle -> IO () -- callback to handle stderr
- , meterUpdate :: MeterUpdate -- the progress meter to update
- }
-
{- Runs a command and runs a ProgressParser on its output, in order
- to update a meter.
-}
-commandMeter :: ProgressParser -> ProgressHandler -> FilePath -> [CommandParam] -> IO Bool
-commandMeter progressparser progress cmd params =
- liftIO $ catchBoolIO $
- withOEHandles createProcessSuccess p $ \(outh, errh) -> do
- ep <- async $ (stderrHandler progress) errh
- op <- async $ feedprogress zeroBytesProcessed [] outh
- wait ep
- wait op
+commandMeter :: ProgressParser -> OutputHandler -> MeterUpdate -> FilePath -> [CommandParam] -> IO Bool
+commandMeter progressparser oh meterupdate cmd params = catchBoolIO $
+ withOEHandles createProcessSuccess p $ \(outh, errh) -> do
+ ep <- async $ handlestderr errh
+ op <- async $ feedprogress zeroBytesProcessed [] outh
+ wait ep
+ wait op
where
p = proc cmd (toCommand params)
@@ -180,7 +178,7 @@ commandMeter progressparser progress cmd params =
if S.null b
then return True
else do
- unless (quietMode progress) $ do
+ unless (quietMode oh) $ do
S.hPut stdout b
hFlush stdout
let s = w82s (S.unpack b)
@@ -189,5 +187,41 @@ commandMeter progressparser progress cmd params =
Nothing -> feedprogress prev buf' h
(Just bytes) -> do
when (bytes /= prev) $
- (meterUpdate progress) bytes
+ meterupdate bytes
feedprogress bytes buf' h
+
+ handlestderr h = unlessM (hIsEOF h) $ do
+ stderrHandler oh =<< hGetLine h
+ handlestderr h
+
+{- Runs a command, that may display one or more progress meters on
+ - either stdout or stderr, and prevents the meters from being displayed.
+ -
+ - To suppress progress output, while displaying other messages,
+ - filter out lines that contain \r (typically used to reset to the
+ - beginning of the line when updating a progress display).
+ -
+ - The other command output is handled as configured by the OutputHandler.
+ -}
+demeterCommand :: OutputHandler -> FilePath -> [CommandParam] -> IO Bool
+demeterCommand oh cmd params = demeterCommandEnv oh cmd params Nothing
+
+demeterCommandEnv :: OutputHandler -> FilePath -> [CommandParam] -> Maybe [(String, String)] -> IO Bool
+demeterCommandEnv oh cmd params environ = catchBoolIO $
+ withOEHandles createProcessSuccess p $ \(outh, errh) -> do
+ ep <- async $ avoidprogress errh $ stderrHandler oh
+ op <- async $ avoidprogress outh $ \l ->
+ unless (quietMode oh) $
+ putStrLn l
+ wait ep
+ wait op
+ return True
+ where
+ p = (proc cmd (toCommand params))
+ { env = environ }
+
+ avoidprogress h emitter = unlessM (hIsEOF h) $ do
+ s <- hGetLine h
+ unless ('\r' `elem` s) $
+ emitter s
+ avoidprogress h emitter
diff --git a/Utility/Process.hs b/Utility/Process.hs
index 0f494810c..cbbe8a811 100644
--- a/Utility/Process.hs
+++ b/Utility/Process.hs
@@ -28,6 +28,7 @@ module Utility.Process (
withIOHandles,
withOEHandles,
withQuietOutput,
+ feedWithQuietOutput,
createProcess,
startInteractiveProcess,
stdinHandle,
@@ -296,6 +297,21 @@ withQuietOutput creator p = withFile devNull WriteMode $ \nullh -> do
}
creator p' $ const $ return ()
+{- Stdout and stderr are discarded, while the process is fed stdin
+ - from the handle. -}
+feedWithQuietOutput
+ :: CreateProcessRunner
+ -> CreateProcess
+ -> (Handle -> IO a)
+ -> IO a
+feedWithQuietOutput creator p a = withFile devNull WriteMode $ \nullh -> do
+ let p' = p
+ { std_in = CreatePipe
+ , std_out = UseHandle nullh
+ , std_err = UseHandle nullh
+ }
+ creator p' $ a . stdinHandle
+
devNull :: FilePath
#ifndef mingw32_HOST_OS
devNull = "/dev/null"
diff --git a/Utility/Rsync.hs b/Utility/Rsync.hs
index ce8e9602a..4f4c4eb5d 100644
--- a/Utility/Rsync.hs
+++ b/Utility/Rsync.hs
@@ -97,8 +97,8 @@ rsyncUrlIsPath s
-
- The params must enable rsync's --progress mode for this to work.
-}
-rsyncProgress :: ProgressHandler -> [CommandParam] -> IO Bool
-rsyncProgress h = commandMeter parseRsyncProgress h "rsync" . rsyncParamsFixup
+rsyncProgress :: OutputHandler -> MeterUpdate -> [CommandParam] -> IO Bool
+rsyncProgress oh meter = commandMeter parseRsyncProgress oh meter "rsync" . rsyncParamsFixup
{- Strategy: Look for chunks prefixed with \r (rsync writes a \r before
- the first progress output, and each thereafter). The first number