-----------------------------------------------------------------------------
-- |
-- Module      :  Plugins.Monitors.Net
-- Copyright   :  (c) 2011, 2012, 2013, 2014, 2017, 2020 Jose Antonio Ortega Ruiz
--                (c) 2007-2010 Andrea Rossato
-- License     :  BSD-style (see LICENSE)
--
-- Maintainer  :  Jose A. Ortega Ruiz <jao@gnu.org>
-- Stability   :  unstable
-- Portability :  unportable
--
-- A net device monitor for Xmobar
--

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

{-# LANGUAGE CPP #-}

module Xmobar.Plugins.Monitors.Net (
                        startNet
                      , startDynNet
                      ) where

import Xmobar.Plugins.Monitors.Common
import Xmobar.Plugins.Monitors.Net.Common (NetDev(..), NetDevInfo(..), NetDevRate, NetDevRef)
import Data.IORef (newIORef, readIORef, writeIORef)
import Data.Time.Clock (getCurrentTime, diffUTCTime)
import System.Console.GetOpt

#if defined(freebsd_HOST_OS)
import qualified Xmobar.Plugins.Monitors.Net.FreeBSD as MN
#else
import qualified Xmobar.Plugins.Monitors.Net.Linux as MN
#endif

import Control.Monad (forM)

type DevList = [String]

parseDevList :: String -> DevList
parseDevList :: String -> DevList
parseDevList = String -> DevList
splitOnComma
  where splitOnComma :: String -> DevList
splitOnComma [] = [[]]
        splitOnComma (Char
',':String
xs) = [] forall a. a -> [a] -> [a]
: String -> DevList
splitOnComma String
xs
        splitOnComma (Char
x:String
xs) =
           let rest :: DevList
rest = String -> DevList
splitOnComma String
xs
           in (Char
x forall a. a -> [a] -> [a]
: forall a. [a] -> a
head DevList
rest) forall a. a -> [a] -> [a]
: forall a. [a] -> [a]
tail DevList
rest

data NetOpts = NetOpts
  { NetOpts -> Maybe IconPattern
rxIconPattern :: Maybe IconPattern
  , NetOpts -> Maybe IconPattern
txIconPattern :: Maybe IconPattern
  , NetOpts -> Maybe DevList
onlyDevList :: Maybe DevList
  , NetOpts -> String
upIndicator :: String
  }

defaultOpts :: NetOpts
defaultOpts :: NetOpts
defaultOpts = NetOpts
  { rxIconPattern :: Maybe IconPattern
rxIconPattern = forall a. Maybe a
Nothing
  , txIconPattern :: Maybe IconPattern
txIconPattern = forall a. Maybe a
Nothing
  , onlyDevList :: Maybe DevList
onlyDevList = forall a. Maybe a
Nothing
  , upIndicator :: String
upIndicator = String
"+"
  }

options :: [OptDescr (NetOpts -> NetOpts)]
options :: [OptDescr (NetOpts -> NetOpts)]
options =
  [ forall a. String -> DevList -> ArgDescr a -> String -> OptDescr a
Option String
"" [String
"rx-icon-pattern"] (forall a. (String -> a) -> String -> ArgDescr a
ReqArg (\String
x NetOpts
o ->
     NetOpts
o { rxIconPattern :: Maybe IconPattern
rxIconPattern = forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ String -> IconPattern
parseIconPattern String
x }) String
"") String
""
  , forall a. String -> DevList -> ArgDescr a -> String -> OptDescr a
Option String
"" [String
"tx-icon-pattern"] (forall a. (String -> a) -> String -> ArgDescr a
ReqArg (\String
x NetOpts
o ->
     NetOpts
o { txIconPattern :: Maybe IconPattern
txIconPattern = forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ String -> IconPattern
parseIconPattern String
x }) String
"") String
""
  , forall a. String -> DevList -> ArgDescr a -> String -> OptDescr a
Option String
"" [String
"up"] (forall a. (String -> a) -> String -> ArgDescr a
ReqArg (\String
x NetOpts
o -> NetOpts
o { upIndicator :: String
upIndicator = String
x }) String
"") String
""
  , forall a. String -> DevList -> ArgDescr a -> String -> OptDescr a
Option String
"" [String
"devices"] (forall a. (String -> a) -> String -> ArgDescr a
ReqArg (\String
x NetOpts
o ->
     NetOpts
o { onlyDevList :: Maybe DevList
onlyDevList = forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ String -> DevList
parseDevList String
x }) String
"") String
""
  ]

data UnitPerSec = Bs | KBs | MBs | GBs deriving (UnitPerSec -> UnitPerSec -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: UnitPerSec -> UnitPerSec -> Bool
$c/= :: UnitPerSec -> UnitPerSec -> Bool
== :: UnitPerSec -> UnitPerSec -> Bool
$c== :: UnitPerSec -> UnitPerSec -> Bool
Eq,Int -> UnitPerSec
UnitPerSec -> Int
UnitPerSec -> [UnitPerSec]
UnitPerSec -> UnitPerSec
UnitPerSec -> UnitPerSec -> [UnitPerSec]
UnitPerSec -> UnitPerSec -> UnitPerSec -> [UnitPerSec]
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 :: UnitPerSec -> UnitPerSec -> UnitPerSec -> [UnitPerSec]
$cenumFromThenTo :: UnitPerSec -> UnitPerSec -> UnitPerSec -> [UnitPerSec]
enumFromTo :: UnitPerSec -> UnitPerSec -> [UnitPerSec]
$cenumFromTo :: UnitPerSec -> UnitPerSec -> [UnitPerSec]
enumFromThen :: UnitPerSec -> UnitPerSec -> [UnitPerSec]
$cenumFromThen :: UnitPerSec -> UnitPerSec -> [UnitPerSec]
enumFrom :: UnitPerSec -> [UnitPerSec]
$cenumFrom :: UnitPerSec -> [UnitPerSec]
fromEnum :: UnitPerSec -> Int
$cfromEnum :: UnitPerSec -> Int
toEnum :: Int -> UnitPerSec
$ctoEnum :: Int -> UnitPerSec
pred :: UnitPerSec -> UnitPerSec
$cpred :: UnitPerSec -> UnitPerSec
succ :: UnitPerSec -> UnitPerSec
$csucc :: UnitPerSec -> UnitPerSec
Enum,Eq UnitPerSec
UnitPerSec -> UnitPerSec -> Bool
UnitPerSec -> UnitPerSec -> Ordering
UnitPerSec -> UnitPerSec -> UnitPerSec
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 :: UnitPerSec -> UnitPerSec -> UnitPerSec
$cmin :: UnitPerSec -> UnitPerSec -> UnitPerSec
max :: UnitPerSec -> UnitPerSec -> UnitPerSec
$cmax :: UnitPerSec -> UnitPerSec -> UnitPerSec
>= :: UnitPerSec -> UnitPerSec -> Bool
$c>= :: UnitPerSec -> UnitPerSec -> Bool
> :: UnitPerSec -> UnitPerSec -> Bool
$c> :: UnitPerSec -> UnitPerSec -> Bool
<= :: UnitPerSec -> UnitPerSec -> Bool
$c<= :: UnitPerSec -> UnitPerSec -> Bool
< :: UnitPerSec -> UnitPerSec -> Bool
$c< :: UnitPerSec -> UnitPerSec -> Bool
compare :: UnitPerSec -> UnitPerSec -> Ordering
$ccompare :: UnitPerSec -> UnitPerSec -> Ordering
Ord)
data NetValue = NetValue Float UnitPerSec deriving (NetValue -> NetValue -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: NetValue -> NetValue -> Bool
$c/= :: NetValue -> NetValue -> Bool
== :: NetValue -> NetValue -> Bool
$c== :: NetValue -> NetValue -> Bool
Eq,Int -> NetValue -> ShowS
[NetValue] -> ShowS
NetValue -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [NetValue] -> ShowS
$cshowList :: [NetValue] -> ShowS
show :: NetValue -> String
$cshow :: NetValue -> String
showsPrec :: Int -> NetValue -> ShowS
$cshowsPrec :: Int -> NetValue -> ShowS
Show)

instance Show UnitPerSec where
    show :: UnitPerSec -> String
show UnitPerSec
Bs  = String
"B/s"
    show UnitPerSec
KBs = String
"KB/s"
    show UnitPerSec
MBs = String
"MB/s"
    show UnitPerSec
GBs = String
"GB/s"

netConfig :: IO MConfig
netConfig :: IO MConfig
netConfig = String -> DevList -> IO MConfig
mkMConfig
    String
"<dev>: <rx>KB|<tx>KB"      -- template
    [String
"dev", String
"rx", String
"tx", String
"rxbar", String
"rxvbar", String
"rxipat", String
"txbar", String
"txvbar", String
"txipat", String
"up"]     -- available replacements

formatNet :: Maybe IconPattern -> Float -> Monitor (String, String, String, String)
formatNet :: Maybe IconPattern
-> Float -> Monitor (String, String, String, String)
formatNet Maybe IconPattern
mipat Float
d = do
    Bool
s <- forall a. Selector a -> Monitor a
getConfigValue MConfig -> IORef Bool
useSuffix
    Int
dd <- forall a. Selector a -> Monitor a
getConfigValue MConfig -> IORef Int
decDigits
    let str :: Bool -> Float -> String
str Bool
True Float
v = forall a. RealFloat a => Int -> a -> String
showDigits Int
dd Float
d' forall a. [a] -> [a] -> [a]
++ forall a. Show a => a -> String
show UnitPerSec
u
            where (NetValue Float
d' UnitPerSec
u) = Float -> NetValue
byteNetVal Float
v
        str Bool
False Float
v = forall a. RealFloat a => Int -> a -> String
showDigits Int
dd forall a b. (a -> b) -> a -> b
$ Float
v forall a. Fractional a => a -> a -> a
/ Float
1024
    String
b <- Float -> Float -> Monitor String
showLogBar Float
0.9 Float
d
    String
vb <- Float -> Float -> Monitor String
showLogVBar Float
0.9 Float
d
    String
ipat <- Maybe IconPattern -> Float -> Float -> Monitor String
showLogIconPattern Maybe IconPattern
mipat Float
0.9 Float
d
    String
x <- forall a. (Num a, Ord a) => (a -> String) -> a -> Monitor String
showWithColors (Bool -> Float -> String
str Bool
s) Float
d
    forall (m :: * -> *) a. Monad m => a -> m a
return (String
x, String
b, String
vb, String
ipat)

printNet :: NetOpts -> NetDevRate -> Monitor String
printNet :: NetOpts -> NetDevRate -> Monitor String
printNet NetOpts
opts NetDevRate
nd =
  case NetDevRate
nd of
    N String
d (ND Float
r Float
t) -> do
        (String
rx, String
rb, String
rvb, String
ripat) <- Maybe IconPattern
-> Float -> Monitor (String, String, String, String)
formatNet (NetOpts -> Maybe IconPattern
rxIconPattern NetOpts
opts) Float
r
        (String
tx, String
tb, String
tvb, String
tipat) <- Maybe IconPattern
-> Float -> Monitor (String, String, String, String)
formatNet (NetOpts -> Maybe IconPattern
txIconPattern NetOpts
opts) Float
t
        DevList -> Monitor String
parseTemplate [String
d,String
rx,String
tx,String
rb,String
rvb,String
ripat,String
tb,String
tvb,String
tipat, NetOpts -> String
upIndicator NetOpts
opts]
    N String
_ NetDevInfo Float
NI -> forall (m :: * -> *) a. Monad m => a -> m a
return String
""
    NetDevRate
NA -> forall a. Selector a -> Monitor a
getConfigValue MConfig -> IORef String
naString

parseNet :: NetDevRef -> String -> IO NetDevRate
parseNet :: NetDevRef -> String -> IO NetDevRate
parseNet NetDevRef
nref String
nd = do
  (NetDevRawTotal
n0, UTCTime
t0) <- forall a. IORef a -> IO a
readIORef NetDevRef
nref
  NetDevRawTotal
n1 <- String -> IO NetDevRawTotal
MN.findNetDev String
nd
  UTCTime
t1 <- IO UTCTime
getCurrentTime
  forall a. IORef a -> a -> IO ()
writeIORef NetDevRef
nref (NetDevRawTotal
n1, UTCTime
t1)
  let scx :: Float
scx = forall a b. (Real a, Fractional b) => a -> b
realToFrac (UTCTime -> UTCTime -> NominalDiffTime
diffUTCTime UTCTime
t1 UTCTime
t0)
      scx' :: Float
scx' = if Float
scx forall a. Ord a => a -> a -> Bool
> Float
0 then Float
scx else Float
1
      rate :: a -> a -> Float
rate a
da a
db = Int -> Float -> Float
takeDigits Int
2 forall a b. (a -> b) -> a -> b
$ forall a b. (Integral a, Num b) => a -> b
fromIntegral (a
db forall a. Num a => a -> a -> a
- a
da) forall a. Fractional a => a -> a -> a
/ Float
scx'
      diffRate :: NetDev a -> NetDev a -> NetDevRate
diffRate (N String
d (ND a
ra a
ta)) (N String
_ (ND a
rb a
tb)) = forall num. String -> NetDevInfo num -> NetDev num
N String
d (forall num. num -> num -> NetDevInfo num
ND (forall {a}. Integral a => a -> a -> Float
rate a
ra a
rb) (forall {a}. Integral a => a -> a -> Float
rate a
ta a
tb))
      diffRate (N String
d NetDevInfo a
NI) NetDev a
_ = forall num. String -> NetDevInfo num -> NetDev num
N String
d forall num. NetDevInfo num
NI
      diffRate NetDev a
_ (N String
d NetDevInfo a
NI) = forall num. String -> NetDevInfo num -> NetDev num
N String
d forall num. NetDevInfo num
NI
      diffRate NetDev a
_ NetDev a
_ = forall num. NetDev num
NA
  forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ forall {a}. Integral a => NetDev a -> NetDev a -> NetDevRate
diffRate NetDevRawTotal
n0 NetDevRawTotal
n1

runNet :: NetDevRef -> String -> [String] -> Monitor String
runNet :: NetDevRef -> String -> DevList -> Monitor String
runNet NetDevRef
nref String
i DevList
argv = do
  NetDevRate
dev <- forall a. IO a -> Monitor a
io forall a b. (a -> b) -> a -> b
$ NetDevRef -> String -> IO NetDevRate
parseNet NetDevRef
nref String
i
  NetOpts
opts <- forall a. IO a -> Monitor a
io forall a b. (a -> b) -> a -> b
$ forall opts.
[OptDescr (opts -> opts)] -> opts -> DevList -> IO opts
parseOptsWith [OptDescr (NetOpts -> NetOpts)]
options NetOpts
defaultOpts DevList
argv
  NetOpts -> NetDevRate -> Monitor String
printNet NetOpts
opts NetDevRate
dev

parseNets :: [(NetDevRef, String)] -> IO [NetDevRate]
parseNets :: [(NetDevRef, String)] -> IO [NetDevRate]
parseNets = forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM forall a b. (a -> b) -> a -> b
$ forall a b c. (a -> b -> c) -> (a, b) -> c
uncurry NetDevRef -> String -> IO NetDevRate
parseNet

runNets :: [(NetDevRef, String)] -> [String] -> Monitor String
runNets :: [(NetDevRef, String)] -> DevList -> Monitor String
runNets [(NetDevRef, String)]
refs DevList
argv = do
  NetOpts
opts <- forall a. IO a -> Monitor a
io forall a b. (a -> b) -> a -> b
$ forall opts.
[OptDescr (opts -> opts)] -> opts -> DevList -> IO opts
parseOptsWith [OptDescr (NetOpts -> NetOpts)]
options NetOpts
defaultOpts DevList
argv
  NetDevRate
dev <- forall a. IO a -> Monitor a
io forall a b. (a -> b) -> a -> b
$ [(NetDevRef, String)] -> IO NetDevRate
parseActive forall a b. (a -> b) -> a -> b
$ forall {a}. NetOpts -> [(a, String)] -> [(a, String)]
filterRefs NetOpts
opts [(NetDevRef, String)]
refs
  NetOpts -> NetDevRate -> Monitor String
printNet NetOpts
opts NetDevRate
dev
    where parseActive :: [(NetDevRef, String)] -> IO NetDevRate
parseActive [(NetDevRef, String)]
refs' = forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap [NetDevRate] -> NetDevRate
selectActive ([(NetDevRef, String)] -> IO [NetDevRate]
parseNets [(NetDevRef, String)]
refs')
          refInDevList :: NetOpts -> (a, String) -> Bool
refInDevList NetOpts
opts' (a
_, String
refname') = case NetOpts -> Maybe DevList
onlyDevList NetOpts
opts' of
            Just DevList
theList -> String
refname' forall (t :: * -> *) a. (Foldable t, Eq a) => a -> t a -> Bool
`elem` DevList
theList
            Maybe DevList
Nothing -> Bool
True
          filterRefs :: NetOpts -> [(a, String)] -> [(a, String)]
filterRefs NetOpts
opts' [(a, String)]
refs' = case forall a. (a -> Bool) -> [a] -> [a]
filter (forall {a}. NetOpts -> (a, String) -> Bool
refInDevList NetOpts
opts') [(a, String)]
refs' of
            [] -> [(a, String)]
refs'
            [(a, String)]
xs -> [(a, String)]
xs
          selectActive :: [NetDevRate] -> NetDevRate
selectActive = forall (t :: * -> *) a. (Foldable t, Ord a) => t a -> a
maximum

startNet :: String -> [String] -> Int -> (String -> IO ()) -> IO ()
startNet :: String -> DevList -> Int -> (String -> IO ()) -> IO ()
startNet String
i DevList
a Int
r String -> IO ()
cb = do
  UTCTime
t0 <- IO UTCTime
getCurrentTime
  NetDevRef
nref <- forall a. a -> IO (IORef a)
newIORef (forall num. NetDev num
NA, UTCTime
t0)
  NetDevRate
_ <- NetDevRef -> String -> IO NetDevRate
parseNet NetDevRef
nref String
i
  DevList
-> IO MConfig
-> (DevList -> Monitor String)
-> Int
-> (String -> IO ())
-> IO ()
runM DevList
a IO MConfig
netConfig (NetDevRef -> String -> DevList -> Monitor String
runNet NetDevRef
nref String
i) Int
r String -> IO ()
cb

startDynNet :: [String] -> Int -> (String -> IO ()) -> IO ()
startDynNet :: DevList -> Int -> (String -> IO ()) -> IO ()
startDynNet DevList
a Int
r String -> IO ()
cb = do
  DevList
devs <- IO DevList
MN.existingDevs
  [(NetDevRef, String)]
refs <- forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
t a -> (a -> m b) -> m (t b)
forM DevList
devs forall a b. (a -> b) -> a -> b
$ \String
d -> do
            UTCTime
t <- IO UTCTime
getCurrentTime
            NetDevRef
nref <- forall a. a -> IO (IORef a)
newIORef (forall num. NetDev num
NA, UTCTime
t)
            NetDevRate
_ <- NetDevRef -> String -> IO NetDevRate
parseNet NetDevRef
nref String
d
            forall (m :: * -> *) a. Monad m => a -> m a
return (NetDevRef
nref, String
d)
  DevList
-> IO MConfig
-> (DevList -> Monitor String)
-> Int
-> (String -> IO ())
-> IO ()
runM DevList
a IO MConfig
netConfig ([(NetDevRef, String)] -> DevList -> Monitor String
runNets [(NetDevRef, String)]
refs) Int
r String -> IO ()
cb

byteNetVal :: Float -> NetValue
byteNetVal :: Float -> NetValue
byteNetVal Float
v
    | Float
v forall a. Ord a => a -> a -> Bool
< Float
1024forall a. Floating a => a -> a -> a
**Float
1 = Float -> UnitPerSec -> NetValue
NetValue Float
v UnitPerSec
Bs
    | Float
v forall a. Ord a => a -> a -> Bool
< Float
1024forall a. Floating a => a -> a -> a
**Float
2 = Float -> UnitPerSec -> NetValue
NetValue (Float
vforall a. Fractional a => a -> a -> a
/Float
1024forall a. Floating a => a -> a -> a
**Float
1) UnitPerSec
KBs
    | Float
v forall a. Ord a => a -> a -> Bool
< Float
1024forall a. Floating a => a -> a -> a
**Float
3 = Float -> UnitPerSec -> NetValue
NetValue (Float
vforall a. Fractional a => a -> a -> a
/Float
1024forall a. Floating a => a -> a -> a
**Float
2) UnitPerSec
MBs
    | Bool
otherwise   = Float -> UnitPerSec -> NetValue
NetValue (Float
vforall a. Fractional a => a -> a -> a
/Float
1024forall a. Floating a => a -> a -> a
**Float
3) UnitPerSec
GBs