-- |
-- Module: Staversion.Internal.Log
-- Description: types and functions about logging
-- Maintainer: Toshio Ito <debug.ito@gmail.com>
--
-- 
module Staversion.Internal.Log
       ( LogLevel(..),
         LogEntry(..),
         Logger(loggerThreshold),
         defaultLogger,
         putLog,
         putLogEntry,
         logDebug,
         logInfo,
         logWarn,
         logError,
         -- * For tests
         _mockLogger
       ) where

import Control.Monad (when)
import Data.IORef (IORef, newIORef, modifyIORef)
import System.IO (Handle, stderr, hPutStrLn)

data LogLevel = LogDebug
              | LogInfo
              | LogWarn
              | LogError
              deriving (Int -> LogLevel -> ShowS
[LogLevel] -> ShowS
LogLevel -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [LogLevel] -> ShowS
$cshowList :: [LogLevel] -> ShowS
show :: LogLevel -> String
$cshow :: LogLevel -> String
showsPrec :: Int -> LogLevel -> ShowS
$cshowsPrec :: Int -> LogLevel -> ShowS
Show,LogLevel -> LogLevel -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: LogLevel -> LogLevel -> Bool
$c/= :: LogLevel -> LogLevel -> Bool
== :: LogLevel -> LogLevel -> Bool
$c== :: LogLevel -> LogLevel -> Bool
Eq,Eq LogLevel
LogLevel -> LogLevel -> Bool
LogLevel -> LogLevel -> Ordering
LogLevel -> LogLevel -> LogLevel
forall a.
Eq a
-> (a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
min :: LogLevel -> LogLevel -> LogLevel
$cmin :: LogLevel -> LogLevel -> LogLevel
max :: LogLevel -> LogLevel -> LogLevel
$cmax :: LogLevel -> LogLevel -> LogLevel
>= :: LogLevel -> LogLevel -> Bool
$c>= :: LogLevel -> LogLevel -> Bool
> :: LogLevel -> LogLevel -> Bool
$c> :: LogLevel -> LogLevel -> Bool
<= :: LogLevel -> LogLevel -> Bool
$c<= :: LogLevel -> LogLevel -> Bool
< :: LogLevel -> LogLevel -> Bool
$c< :: LogLevel -> LogLevel -> Bool
compare :: LogLevel -> LogLevel -> Ordering
$ccompare :: LogLevel -> LogLevel -> Ordering
Ord,Int -> LogLevel
LogLevel -> Int
LogLevel -> [LogLevel]
LogLevel -> LogLevel
LogLevel -> LogLevel -> [LogLevel]
LogLevel -> LogLevel -> LogLevel -> [LogLevel]
forall a.
(a -> a)
-> (a -> a)
-> (Int -> a)
-> (a -> Int)
-> (a -> [a])
-> (a -> a -> [a])
-> (a -> a -> [a])
-> (a -> a -> a -> [a])
-> Enum a
enumFromThenTo :: LogLevel -> LogLevel -> LogLevel -> [LogLevel]
$cenumFromThenTo :: LogLevel -> LogLevel -> LogLevel -> [LogLevel]
enumFromTo :: LogLevel -> LogLevel -> [LogLevel]
$cenumFromTo :: LogLevel -> LogLevel -> [LogLevel]
enumFromThen :: LogLevel -> LogLevel -> [LogLevel]
$cenumFromThen :: LogLevel -> LogLevel -> [LogLevel]
enumFrom :: LogLevel -> [LogLevel]
$cenumFrom :: LogLevel -> [LogLevel]
fromEnum :: LogLevel -> Int
$cfromEnum :: LogLevel -> Int
toEnum :: Int -> LogLevel
$ctoEnum :: Int -> LogLevel
pred :: LogLevel -> LogLevel
$cpred :: LogLevel -> LogLevel
succ :: LogLevel -> LogLevel
$csucc :: LogLevel -> LogLevel
Enum,LogLevel
forall a. a -> a -> Bounded a
maxBound :: LogLevel
$cmaxBound :: LogLevel
minBound :: LogLevel
$cminBound :: LogLevel
Bounded)

data LogEntry = LogEntry { LogEntry -> LogLevel
logLevel :: LogLevel,
                           LogEntry -> String
logMessage :: String
                         } deriving (Int -> LogEntry -> ShowS
[LogEntry] -> ShowS
LogEntry -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [LogEntry] -> ShowS
$cshowList :: [LogEntry] -> ShowS
show :: LogEntry -> String
$cshow :: LogEntry -> String
showsPrec :: Int -> LogEntry -> ShowS
$cshowsPrec :: Int -> LogEntry -> ShowS
Show,LogEntry -> LogEntry -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: LogEntry -> LogEntry -> Bool
$c/= :: LogEntry -> LogEntry -> Bool
== :: LogEntry -> LogEntry -> Bool
$c== :: LogEntry -> LogEntry -> Bool
Eq,Eq LogEntry
LogEntry -> LogEntry -> Bool
LogEntry -> LogEntry -> Ordering
LogEntry -> LogEntry -> LogEntry
forall a.
Eq a
-> (a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
min :: LogEntry -> LogEntry -> LogEntry
$cmin :: LogEntry -> LogEntry -> LogEntry
max :: LogEntry -> LogEntry -> LogEntry
$cmax :: LogEntry -> LogEntry -> LogEntry
>= :: LogEntry -> LogEntry -> Bool
$c>= :: LogEntry -> LogEntry -> Bool
> :: LogEntry -> LogEntry -> Bool
$c> :: LogEntry -> LogEntry -> Bool
<= :: LogEntry -> LogEntry -> Bool
$c<= :: LogEntry -> LogEntry -> Bool
< :: LogEntry -> LogEntry -> Bool
$c< :: LogEntry -> LogEntry -> Bool
compare :: LogEntry -> LogEntry -> Ordering
$ccompare :: LogEntry -> LogEntry -> Ordering
Ord)

data Logger = Logger { Logger -> Maybe LogLevel
loggerThreshold :: Maybe LogLevel,
                       -- ^ If 'Nothing', logging is disabled.
                       Logger -> LogLevel -> String -> IO ()
loggerPutLogRaw :: LogLevel -> String -> IO ()
                     }

instance Show Logger where
  show :: Logger -> String
show Logger
l = String
"Logger { loggerThreshold = " forall a. [a] -> [a] -> [a]
++ forall a. Show a => a -> String
show (Logger -> Maybe LogLevel
loggerThreshold Logger
l) forall a. [a] -> [a] -> [a]
++ String
" }"

defaultLogger :: Logger
defaultLogger :: Logger
defaultLogger = Logger { loggerThreshold :: Maybe LogLevel
loggerThreshold = forall a. a -> Maybe a
Just LogLevel
LogInfo,
                         loggerPutLogRaw :: LogLevel -> String -> IO ()
loggerPutLogRaw = \LogLevel
_ String
msg -> Handle -> String -> IO ()
hPutStrLn Handle
stderr String
msg
                       }

toLabel :: LogLevel -> String
toLabel :: LogLevel -> String
toLabel LogLevel
l = case LogLevel
l of
  LogLevel
LogDebug -> String
"[debug]"
  LogLevel
LogInfo ->  String
"[info]"
  LogLevel
LogWarn ->  String
"[warn]"
  LogLevel
LogError -> String
"[error]"

putLog :: Logger -> LogLevel -> String -> IO ()
putLog :: Logger -> LogLevel -> String -> IO ()
putLog Logger
logger LogLevel
level String
raw_msg = forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
when (forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap (LogLevel
level forall a. Ord a => a -> a -> Bool
>=) Maybe LogLevel
mthreshold forall a. Eq a => a -> a -> Bool
== forall a. a -> Maybe a
Just Bool
True) forall a b. (a -> b) -> a -> b
$ Logger -> LogLevel -> String -> IO ()
loggerPutLogRaw Logger
logger LogLevel
level String
msg where
  mthreshold :: Maybe LogLevel
mthreshold = Logger -> Maybe LogLevel
loggerThreshold Logger
logger
  msg :: String
msg = LogLevel -> String
toLabel LogLevel
level forall a. [a] -> [a] -> [a]
++ String
" " forall a. [a] -> [a] -> [a]
++ String
raw_msg

putLogEntry :: Logger -> LogEntry -> IO ()
putLogEntry :: Logger -> LogEntry -> IO ()
putLogEntry Logger
logger LogEntry
entry = Logger -> LogLevel -> String -> IO ()
putLog Logger
logger (LogEntry -> LogLevel
logLevel LogEntry
entry) (LogEntry -> String
logMessage LogEntry
entry)

logDebug :: Logger -> String -> IO ()
logDebug :: Logger -> String -> IO ()
logDebug = forall a b c. (a -> b -> c) -> b -> a -> c
flip Logger -> LogLevel -> String -> IO ()
putLog forall a b. (a -> b) -> a -> b
$ LogLevel
LogDebug

logInfo :: Logger -> String -> IO ()
logInfo :: Logger -> String -> IO ()
logInfo = forall a b c. (a -> b -> c) -> b -> a -> c
flip Logger -> LogLevel -> String -> IO ()
putLog forall a b. (a -> b) -> a -> b
$ LogLevel
LogInfo

logWarn :: Logger -> String -> IO ()
logWarn :: Logger -> String -> IO ()
logWarn = forall a b c. (a -> b -> c) -> b -> a -> c
flip Logger -> LogLevel -> String -> IO ()
putLog forall a b. (a -> b) -> a -> b
$ LogLevel
LogWarn

logError :: Logger -> String -> IO ()
logError :: Logger -> String -> IO ()
logError = forall a b c. (a -> b -> c) -> b -> a -> c
flip Logger -> LogLevel -> String -> IO ()
putLog forall a b. (a -> b) -> a -> b
$ LogLevel
LogError

-- | FOR TEST: the IORef is the history of logged messages.
_mockLogger :: IO (Logger, IORef [LogEntry])
_mockLogger :: IO (Logger, IORef [LogEntry])
_mockLogger = do
  IORef [LogEntry]
history <- forall a. a -> IO (IORef a)
newIORef []
  let puts :: LogLevel -> String -> IO ()
puts LogLevel
level String
msg = forall a. IORef a -> (a -> a) -> IO ()
modifyIORef IORef [LogEntry]
history (forall a. [a] -> [a] -> [a]
++ [LogLevel -> String -> LogEntry
LogEntry LogLevel
level String
msg])
  forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ (Logger
defaultLogger { loggerPutLogRaw :: LogLevel -> String -> IO ()
loggerPutLogRaw = LogLevel -> String -> IO ()
puts }, IORef [LogEntry]
history)