path: root/Announcer.hs

{-# LANGUAGE DeriveDataTypeable         #-}
{-# LANGUAGE DeriveGeneric              #-}
{-# LANGUAGE ExistentialQuantification  #-}
{-# LANGUAGE FlexibleContexts           #-}
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
{-# LANGUAGE LambdaCase                 #-}
{-# LANGUAGE NamedFieldPuns             #-}
{-# LANGUAGE NondecreasingIndentation   #-}
module Announcer
    ( Announcer()
    , AnnounceKey
    , scheduleAbs
    , scheduleToList
    , packAnnounceKey
    , unpackAnnounceKey
    , forkAnnouncer
    , stopAnnouncer
    , cancel
    , itemStatusNum

    -- lower level, Announcer.Tox needs these.
    , scheduleImmediately
    , ScheduledItem(..)
    , interrutible
    ) where

import qualified Data.MinMaxPSQ as MM
import Data.Wrapper.PSQ         as PSQ
import InterruptibleDelay
import Network.Kademlia.Routing as R
import Network.Kademlia.Search

import Control.Concurrent.Lifted.Instrument
import Control.Concurrent.STM
import Control.Monad
import Control.Applicative
import Data.ByteString                      (ByteString)
import qualified Data.ByteString.Char8      as Char8
import Data.Function
import Data.Hashable
import Data.Maybe
import Data.Ord
import Data.Time.Clock.POSIX
import qualified GHC.Generics as Generics
-- import Generic.Data.Internal.Meta as Lyxia
import System.IO

newtype AnnounceKey = AnnounceKey ByteString
 deriving (Hashable,Ord,Eq)

instance Show AnnounceKey where
    show (AnnounceKey bs) = "AnnounceKey " ++ show (Char8.unpack bs)

packAnnounceKey :: Announcer -> String -> STM AnnounceKey
packAnnounceKey _ = return . AnnounceKey . Char8.pack

unpackAnnounceKey :: Announcer -> AnnounceKey -> STM String
unpackAnnounceKey _ (AnnounceKey bs) = return $ Char8.unpack bs

-- | Actions that can be scheduled to occur at some particular time in the
-- future.  Since periodic event handlers are responsible for re-scheduling
-- themselves, they are typically bootstrapped using 'scheduleImmediately' with
-- 'NewAnnouncement' which triggers the ordinary recurring scheduling of
-- 'Announce'.
data ScheduledItem
    = DeleteAnnouncement
    | ScheduledItem (Announcer -> AnnounceKey -> POSIXTime -> STM (IO ()))
    | StopAnnouncer
 -- Can't use Data because STM and IO. :(
 --   deriving Data {- itemStatusNum sch = constrIndex $ toConstr sch -}
 -- Using Generic works with Lyxia's generic-data package...
 --                 {- itemStatusNum sch = Lyxia.conIdToInt $ Lyxia.conId sch -}
 -- For now, make sure to keep 'itemStatusNum' up to date with 'ScheduledItem'.
 deriving Generics.Generic


itemStatusNum :: ScheduledItem -> Int
itemStatusNum (DeleteAnnouncement   ) = 0
itemStatusNum (ScheduledItem      {}) = 1
itemStatusNum (StopAnnouncer        ) = 2
itemStatusNum _                       = error "itemStatusNum not in sync with ScheduledItem declaration."

newtype Schedule = Schedule { unSchedule :: PSQ' AnnounceKey POSIXTime ScheduledItem }

emptySchedule :: Schedule
emptySchedule = Schedule PSQ.empty

type KPS = (AnnounceKey, POSIXTime, ScheduledItem)
findNextScheduled :: Announcer -> STM KPS
findNextScheduled announcer = maybe retry return =<< (findMin . unSchedule) <$> readTVar (scheduled announcer)

removeFromSchedule :: Announcer -> KPS -> STM ()
removeFromSchedule announcer item = modifyTVar' (scheduled announcer) (Schedule . PSQ.delete (key item) . unSchedule)

scheduleToList :: Announcer -> STM [KPS]
scheduleToList announcer = PSQ.toList . unSchedule <$> readTVar (scheduled announcer)

data Announcer = Announcer
    { -- | The queue of scheduled events.  The priority is the time at which an
      -- event is supposed to occur.
      scheduled       :: TVar Schedule
      -- | This TVar is False when the Announcer thread has finished.
    , announcerActive :: TVar Bool
      -- | This delay is used to wait until it's time to act on the earliest
      -- scheduled item.  It will be interrupted whenever a new item is
      -- scheduled.
    , interrutible    :: InterruptibleDelay
    }

-- | Schedules an event to occur long ago at the epoch (which effectively makes
-- the event happen as soon as possible).  Note that the caller will usually
-- also want to interrupt the 'interrutible' delay so that it finds this item
-- immediately.
scheduleImmediately :: Announcer -> AnnounceKey -> ScheduledItem -> STM ()
scheduleImmediately announcer k item
    = modifyTVar' (scheduled announcer) (Schedule . PSQ.insert' k item 0 . unSchedule)

scheduleAbs :: Announcer -> AnnounceKey -> ScheduledItem -> POSIXTime -> STM ()
scheduleAbs announcer k item absTime =
        modifyTVar (scheduled announcer)
                   (Schedule . PSQ.insert' k item absTime . unSchedule)

-- | Terminate the 'Announcer' thread.  Don't use the Announcer after this.
stopAnnouncer :: Announcer -> IO ()
stopAnnouncer announcer = do
    atomically $ scheduleImmediately announcer (AnnounceKey "*stop*") StopAnnouncer
    interruptDelay (interrutible announcer)
    atomically $ readTVar (announcerActive announcer) >>= check . not

cancel :: Announcer -> AnnounceKey -> IO ()
cancel announcer k = do
    atomically $ scheduleImmediately announcer k $ DeleteAnnouncement
    interruptDelay (interrutible announcer)

-- | Construct an 'Announcer' object and fork a thread in which to perform the
-- Kademlia searches and announces.
forkAnnouncer :: IO Announcer
forkAnnouncer = do
    delay <- interruptibleDelay
    announcer <- atomically $ Announcer <$> newTVar emptySchedule
                                        <*> newTVar True
                                        <*> pure delay
    fork $ announceThread announcer
    return announcer

readTChanTimeout :: POSIXTime -> TChan a -> IO (Maybe a)
readTChanTimeout timeout pktChannel = do
  delay <- registerDelay (toMicroseconds timeout)
  atomically $
        Just <$> readTChan pktChannel
    <|> pure Nothing <* (readTVar >=> check) delay
  where
    toMicroseconds :: POSIXTime -> Int
    toMicroseconds = undefined

data SchedulerCommand = ShutdownScheduler | ScheduledAction KPS

listener :: TChan SchedulerCommand -> IO ()
listener chan = relisten PSQ.empty
  where
    note :: String -> IO ()
    note = if False then print else const (return ())
    relisten queue = do
      case minView queue of
        Nothing -> do
          note "queue empty - listening indefinitely"
          atomically (readTChan chan) >>= \case
            ShutdownScheduler -> return ()
            ScheduledAction (k, p, s) -> do
              note "handling new event"
              relisten $ PSQ.insert' k s p queue
        Just ((k, p, s), queue') -> do
          note "queue full - listening with timeout"
          now <- getPOSIXTime
          readTChanTimeout (p - now) chan >>= \case
            Just (ShutdownScheduler) -> return ()
            Just (ScheduledAction (k, p, s)) -> do
              note "handling new event (event occurred before timeout)"
              relisten $ PSQ.insert' k s p queue
            Nothing -> do
              note "timed out - executing from queue"
              runAction s
              mapM id =<< atomically (performScheduledItem undefined now (k, p, s))
              relisten queue'

runAction :: Monad m => ScheduledItem -> m ()
runAction DeleteAnnouncement = return ()
runAction StopAnnouncer = return ()
runAction (ScheduledItem a) = undefined

announceThread :: Announcer -> IO ()
announceThread announcer = do
    myThreadId >>= flip labelThread "announcer"
    fix $ \loop -> do
    item <- atomically $ findNextScheduled announcer

    now <- getPOSIXTime
    -- Is it time to do something?
    if (prio item <= now)
        then do -- Yes.  Dequeue and handle this event.
              action <- atomically $ do
                  removeFromSchedule announcer item
                  performScheduledItem announcer now item
              -- Are we finished?
              mapM_ (>> loop)  -- No? Okay, perform scheduled op and loop.
                    action
        else do -- No.  Wait a bit.
              startDelay (interrutible announcer) (microseconds $ prio item - now)
              loop
    -- We're done.  Let 'stopAnnouncer' know that it can stop blocking.
    atomically $ writeTVar (announcerActive announcer) False

-- | Returns 'Nothing' to stop the announcer thread (when the event is
-- StopAnnouncer).  Otherwise, returns an action that will be performed in the
-- announcer thread before looping for the next scheduled item.
--
-- Note that the returned action is responsible for re-scheduled another event
-- for periodic tasks.  Otherwise, as is the case for the 'DeleteAnnouncement'
-- event, the item associated with a particular announce key will be removed
-- from the queue.
performScheduledItem :: Announcer -> POSIXTime -> Binding' AnnounceKey POSIXTime ScheduledItem -> STM (Maybe (IO ()))
performScheduledItem announcer now = \case

    (Binding _ StopAnnouncer _)          -> return Nothing

    -- announcement removed:
    (Binding _ DeleteAnnouncement _)     -> return $ Just $ return ()

    (Binding k (ScheduledItem action) _) -> Just <$> action announcer k now