{-# LANGUAGE CPP #-}
{-# LANGUAGE GADTs #-}

-- | Apache style logger for WAI applications.
--
-- An example:
--
-- > {-# LANGUAGE OverloadedStrings #-}
-- > module Main where
-- >
-- > import Data.ByteString.Builder (byteString)
-- > import Control.Monad.IO.Class (liftIO)
-- > import qualified Data.ByteString.Char8 as BS
-- > import Network.HTTP.Types (status200)
-- > import Network.Wai (Application, responseBuilder)
-- > import Network.Wai.Handler.Warp (run)
-- > import Network.Wai.Logger (withStdoutLogger, ApacheLogger)
-- >
-- > main :: IO ()
-- > main = withStdoutLogger $ \aplogger ->
-- >     run 3000 $ logApp aplogger
-- >
-- > logApp :: ApacheLogger -> Application
-- > logApp aplogger req response = do
-- >     liftIO $ aplogger req status (Just len)
-- >     response $ responseBuilder status hdr msg
-- >   where
-- >     status = status200
-- >     hdr = [("Content-Type", "text/plain")]
-- >     pong = "PONG"
-- >     msg = byteString pong
-- >     len = fromIntegral $ BS.length pong
module Network.Wai.Logger (
    -- * High level functions
    ApacheLogger,
    withStdoutLogger,
    ServerPushLogger,

    -- * Creating a logger
    ApacheLoggerActions,
    apacheLogger,
    serverpushLogger,
    logRotator,
    logRemover,
    initLoggerUser,
    initLogger,

    -- * Types
    IPAddrSource (..),
    LogType' (..),
    LogType,
    FileLogSpec (..),

    -- * Utilities
    showSockAddr,
    logCheck,

    -- * Backward compability
    clockDateCacher,
    ZonedDate,
    DateCacheGetter,
    DateCacheUpdater,
) where

#if __GLASGOW_HASKELL__ < 709
import Control.Applicative ((<$>))
#endif
import Control.Exception (bracket)
import Control.Monad (void)
import Data.ByteString (ByteString)
import Network.HTTP.Types (Status)
import Network.Wai (Request)
import System.Log.FastLogger

import Network.Wai.Logger.Apache
import Network.Wai.Logger.IP (showSockAddr)

----------------------------------------------------------------

-- | Executing a function which takes 'ApacheLogger'.
--   This 'ApacheLogger' writes log message to stdout.
--   Each buffer (4K bytes) is flushed every second.
withStdoutLogger :: (ApacheLogger -> IO a) -> IO a
withStdoutLogger :: forall a. (ApacheLogger -> IO a) -> IO a
withStdoutLogger ApacheLogger -> IO a
app = IO (ApacheLogger, IO ())
-> ((ApacheLogger, IO ()) -> IO ())
-> ((ApacheLogger, IO ()) -> IO a)
-> IO a
forall a b c. IO a -> (a -> IO b) -> (a -> IO c) -> IO c
bracket IO (ApacheLogger, IO ())
setup (ApacheLogger, IO ()) -> IO ()
forall {f :: * -> *} {a} {a}. Functor f => (a, f a) -> f ()
teardown (((ApacheLogger, IO ()) -> IO a) -> IO a)
-> ((ApacheLogger, IO ()) -> IO a) -> IO a
forall a b. (a -> b) -> a -> b
$ \(ApacheLogger
aplogger, IO ()
_) ->
    ApacheLogger -> IO a
app ApacheLogger
aplogger
  where
    setup :: IO (ApacheLogger, IO ())
setup = do
        tgetter <- ByteString -> IO (IO ByteString)
newTimeCache ByteString
simpleTimeFormat
        apf <- initLogger FromFallback (LogStdout 4096) tgetter
        let aplogger = ApacheLoggerActions -> ApacheLogger
apacheLogger ApacheLoggerActions
apf
            remover = ApacheLoggerActions -> IO ()
logRemover ApacheLoggerActions
apf
        return (aplogger, remover)
    teardown :: (a, f a) -> f ()
teardown (a
_, f a
remover) = f a -> f ()
forall (f :: * -> *) a. Functor f => f a -> f ()
void f a
remover

----------------------------------------------------------------

-- | Apache style logger.
type ApacheLogger = Request -> Status -> Maybe Integer -> IO ()

-- | HTTP/2 server push logger in Apache style.
type ServerPushLogger = Request -> ByteString -> Integer -> IO ()

-- | Function set of Apache style logger.
data ApacheLoggerActions = ApacheLoggerActions
    { ApacheLoggerActions -> ApacheLogger
apacheLogger :: ApacheLogger
    -- ^ The Apache logger.
    , ApacheLoggerActions -> ServerPushLogger
serverpushLogger :: ServerPushLogger
    -- ^ The HTTP/2 server push logger.
    , ApacheLoggerActions -> IO ()
logRotator :: IO ()
    -- ^ This is obsoleted. Rotation is done on-demand.
    --   So, this is now an empty action.
    , ApacheLoggerActions -> IO ()
logRemover :: IO ()
    -- ^ Removing resources relating to Apache logger.
    --   E.g. flushing and deallocating internal buffers.
    }

----------------------------------------------------------------

-- | Creating 'ApacheLogger' according to 'LogType'.
initLoggerUser
    :: ToLogStr user
    => Maybe (Request -> Maybe user)
    -> IPAddrSource
    -> LogType
    -> IO FormattedTime
    -> IO ApacheLoggerActions
initLoggerUser :: forall user.
ToLogStr user =>
Maybe (Request -> Maybe user)
-> IPAddrSource
-> LogType
-> IO ByteString
-> IO ApacheLoggerActions
initLoggerUser Maybe (Request -> Maybe user)
ugetter IPAddrSource
ipsrc LogType
typ IO ByteString
tgetter = do
    (fl, cleanUp) <- LogType -> IO (LogStr -> IO (), IO ())
forall v. LogType' v -> IO (v -> IO (), IO ())
newFastLogger LogType
typ
    return $
        ApacheLoggerActions
            { apacheLogger = apache fl ipsrc ugetter tgetter
            , serverpushLogger = serverpush fl ipsrc ugetter tgetter
            , logRotator = return ()
            , logRemover = cleanUp
            }

initLogger
    :: IPAddrSource
    -> LogType
    -> IO FormattedTime
    -> IO ApacheLoggerActions
initLogger :: IPAddrSource -> LogType -> IO ByteString -> IO ApacheLoggerActions
initLogger = Maybe (Request -> Maybe ByteString)
-> IPAddrSource
-> LogType
-> IO ByteString
-> IO ApacheLoggerActions
forall user.
ToLogStr user =>
Maybe (Request -> Maybe user)
-> IPAddrSource
-> LogType
-> IO ByteString
-> IO ApacheLoggerActions
initLoggerUser Maybe (Request -> Maybe ByteString)
nouser
  where
    nouser :: Maybe (Request -> Maybe ByteString)
    nouser :: Maybe (Request -> Maybe ByteString)
nouser = Maybe (Request -> Maybe ByteString)
forall a. Maybe a
Nothing

--- | Checking if a log file can be written if 'LogType' is 'LogFileNoRotate' or 'LogFile'.
logCheck :: LogType -> IO ()
logCheck :: LogType -> IO ()
logCheck LogType
LogNone = () -> IO ()
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return ()
logCheck (LogStdout BufSize
_) = () -> IO ()
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return ()
logCheck (LogStderr BufSize
_) = () -> IO ()
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return ()
logCheck (LogFileNoRotate FilePath
fp BufSize
_) = FilePath -> IO ()
check FilePath
fp
logCheck (LogFile FileLogSpec
spec BufSize
_) = FilePath -> IO ()
check (FileLogSpec -> FilePath
log_file FileLogSpec
spec)
logCheck (LogFileTimedRotate TimedFileLogSpec
spec BufSize
_) = FilePath -> IO ()
check (TimedFileLogSpec -> FilePath
timed_log_file TimedFileLogSpec
spec)
logCheck (LogCallback LogStr -> IO ()
_ IO ()
_) = () -> IO ()
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return ()

----------------------------------------------------------------

apache
    :: ToLogStr user
    => (LogStr -> IO ())
    -> IPAddrSource
    -> Maybe (Request -> Maybe user)
    -> IO FormattedTime
    -> ApacheLogger
apache :: forall user.
ToLogStr user =>
(LogStr -> IO ())
-> IPAddrSource
-> Maybe (Request -> Maybe user)
-> IO ByteString
-> ApacheLogger
apache LogStr -> IO ()
cb IPAddrSource
ipsrc Maybe (Request -> Maybe user)
userget IO ByteString
dateget Request
req Status
st Maybe Integer
mlen = do
    zdata <- IO ByteString
dateget
    cb (apacheLogStr ipsrc (justGetUser userget) zdata req st mlen)

serverpush
    :: ToLogStr user
    => (LogStr -> IO ())
    -> IPAddrSource
    -> Maybe (Request -> Maybe user)
    -> IO FormattedTime
    -> ServerPushLogger
serverpush :: forall user.
ToLogStr user =>
(LogStr -> IO ())
-> IPAddrSource
-> Maybe (Request -> Maybe user)
-> IO ByteString
-> ServerPushLogger
serverpush LogStr -> IO ()
cb IPAddrSource
ipsrc Maybe (Request -> Maybe user)
userget IO ByteString
dateget Request
req ByteString
path Integer
size = do
    zdata <- IO ByteString
dateget
    cb (serverpushLogStr ipsrc (justGetUser userget) zdata req path size)

---------------------------------------------------------------

-- | Getting cached 'ZonedDate'.
type DateCacheGetter = IO ZonedDate

-- | Updateing cached 'ZonedDate'. This should be called every second.
--   See the source code of 'withStdoutLogger'.
type DateCacheUpdater = IO ()

-- | A type for zoned date.
type ZonedDate = FormattedTime

-- |
-- Returning 'DateCacheGetter' and 'DateCacheUpdater'.
--
-- Note: Since version 2.1.2, this function uses the auto-update package
-- internally, and therefore the @DateCacheUpdater@ value returned need
-- not be called. To wit, the return value is in fact an empty action.
clockDateCacher :: IO (DateCacheGetter, DateCacheUpdater)
clockDateCacher :: IO (IO ByteString, IO ())
clockDateCacher = do
    tgetter <- ByteString -> IO (IO ByteString)
newTimeCache ByteString
simpleTimeFormat
    return (tgetter, return ())

justGetUser :: Maybe (Request -> Maybe user) -> (Request -> Maybe user)
justGetUser :: forall user. Maybe (Request -> Maybe user) -> Request -> Maybe user
justGetUser (Just Request -> Maybe user
getter) = Request -> Maybe user
getter
justGetUser Maybe (Request -> Maybe user)
Nothing = \Request
_ -> Maybe user
forall a. Maybe a
Nothing