Rewrote nearly everything!v0.2.0

* Rewrote the whole architecture to achieve extreme modularity
* Added the ability to build a multiprotocol bot
* Added cabal integration
* Added configuration handling the XMonad style
* Added configuration in ~/.hsbot
* Refactored many many named and functions
* Refactored data structures
* Cleaned a big bunch of stuff

3 files changed, 65 insertions, 75 deletions

diff --git a/Plugins/Core.hs b/Hsbot/Irc/Plugin/Core.hs
index f81f4bf..5d69ca3 100644
--- a/Plugins/Core.hs
+++ b/Hsbot/Irc/Plugin/Core.hs
@@ -1,20 +1,23 @@
-module Plugins.Core
-    ( mainCore
+module Hsbot.Irc.Plugin.Core
+    ( ircBotPluginCore
     ) where
 
-import Control.Concurrent.Chan(Chan)
+import Control.Concurrent (Chan, myThreadId)
 import Control.Exception
 import Control.Monad.State
 import Prelude hiding (catch)
 
-import Hsbot.IRCPlugin
-import Hsbot.Types
-import Hsbot.Utils
+import Hsbot.Irc.Message
+import Hsbot.Irc.PluginCommons
 
 -- | The plugin's main entry point
-mainCore :: Chan BotMsg -> Chan BotMsg -> IO ()
-mainCore serverChan chan = do
-    let plugin = PluginState "Core" serverChan chan
+ircBotPluginCore :: Chan IrcBotMsg -> Chan IrcBotMsg -> IO ()
+ircBotPluginCore myChan masterChan = do
+    threadId <- myThreadId
+    let plugin = IrcPluginState { ircPluginName       = "Core"
+                                , ircPluginThreadId   = threadId
+                                , ircPluginChan       = myChan
+                                , ircPluginMasterChan = masterChan }
     evalStateT (mapM_ sendRegisterCommand ["list", "load", "reload", "unload"]) plugin
     plugin' <- (execStateT run plugin) `catch` (\(_ :: AsyncException) -> return plugin)
     evalStateT (mapM_ sendUnregisterCommand ["list", "load", "reload", "unload"]) plugin'
@@ -25,21 +28,20 @@ run = forever $ do
     msg <- readMsg
     eval msg
   where
-    eval :: BotMsg -> IrcPlugin ()
-    eval (InternalCmd intCmd) = do
-        let request = intCmdBotMsg intCmd
-        case intCmdCmd intCmd of
-            "RUN"    -> let stuff = words $ intCmdMsg intCmd
+    eval :: IrcBotMsg -> IrcPlugin ()
+    eval (IntIrcCmd intCmd) = do
+        let request = ircCmdBotMsg intCmd
+        case ircCmdCmd intCmd of
+            "RUN"    -> let stuff = words $ ircCmdMsg intCmd
                         in case head stuff of
                             "list"   -> listPlugins request
                             "load"   -> loadPlugin $ tail stuff
                             "reload" -> reloadPlugin $ tail stuff
                             "unload" -> unloadPlugin $ tail stuff
-                            _      -> lift . trace $ show intCmd -- TODO : help message
-            "ANSWER" -> let stuff = intCmdMsg intCmd
+                            _        -> return () -- TODO : help message
+            "ANSWER" -> let stuff = ircCmdMsg intCmd
                         in answerMsg request ("Loaded plugins : " ++ stuff)
-            _        -> lift . trace $ show intCmd
-    eval (InputMsg _) = return ()
+            _        -> return ()
     eval _ = return ()
 
 -- | The list command
diff --git a/Plugins/Quote.hs b/Hsbot/Irc/Plugin/Quote.hs
index 61e4558..ff037c7 100644
--- a/Plugins/Quote.hs
+++ b/Hsbot/Irc/Plugin/Quote.hs
@@ -1,7 +1,8 @@
-module Plugins.Quote
-    ( mainQuote
+module Hsbot.Irc.Plugin.Quote
+    ( ircBotPluginQuote
     ) where
 
+import Control.Concurrent (myThreadId)
 import Control.Concurrent.Chan
 import Control.Exception
 import Control.Monad.State
@@ -10,13 +11,15 @@ import Data.Maybe(fromMaybe)
 import qualified Data.Text as T
 import qualified Data.Text.IO as TIO
 import Data.Time
+import System.Directory
 import IO hiding (catch)
 import Prelude hiding (catch)
+import System.FilePath
+import System.Posix.Files
 import System.Random(randomRIO)
 
-import Hsbot.IRCPlugin
-import Hsbot.Types
-import Hsbot.Utils
+import Hsbot.Irc.Message
+import Hsbot.Irc.PluginCommons
 
 -- | A quote element
 data QuoteElt = QuoteElt
@@ -40,16 +43,29 @@ data QuoteBotState = QuoteBotState
     } deriving (Read, Show)
 
 -- | The QuoteBot monad
-type QuoteBot a = StateT QuoteBotState (StateT PluginState IO) a
+type QuoteBot a = StateT QuoteBotState (StateT IrcPluginState IO) a
 
 -- | The plugin's main entry point
-mainQuote :: Chan BotMsg -> Chan BotMsg -> IO ()
-mainQuote serverChan chan = do
+ircBotPluginQuote :: Chan IrcBotMsg -> Chan IrcBotMsg -> IO ()
+ircBotPluginQuote myChan masterChan = do
     -- First of all we restore the database
-    txtQuoteBot <- TIO.readFile $ "quotedb.txt"
+    dir <- getAppUserDataDirectory "hsbot"
+    let dbfile = dir </> "quotedb.txt"
+    dbfileExists <- fileExist dbfile
+    if not dbfileExists
+      then
+        let quoteBot = QuoteBotState 0 M.empty M.empty
+        in TIO.writeFile dbfile (T.pack $ show quoteBot)
+      else
+        return ()
+    txtQuoteBot <- TIO.readFile $ dbfile
     let quoteBot = read (T.unpack txtQuoteBot) :: QuoteBotState
     -- The plugin main loop
-    let plugin = PluginState "Quote" serverChan chan
+    threadId <- myThreadId
+    let plugin = IrcPluginState { ircPluginName       = "Quote"
+                                , ircPluginThreadId   = threadId
+                                , ircPluginChan       = myChan
+                                , ircPluginMasterChan = masterChan }
     evalStateT (mapM_ sendRegisterCommand ["quote"]) plugin
     _ <- (evalStateT (run quoteBot) plugin) `catch` (\(_ :: AsyncException) -> return quoteBot)
     evalStateT (mapM_ sendUnregisterCommand ["quote"]) plugin
@@ -62,30 +78,31 @@ run quoteBot = do
     run quoteBot'
   where
     -- | evaluate what we just received
-    eval :: BotMsg -> IrcPlugin (QuoteBotState)
-    eval (InternalCmd intCmd)
-      | intCmdCmd intCmd == "RUN" = do
+    eval :: IrcBotMsg -> IrcPlugin (QuoteBotState)
+    eval (IntIrcCmd intCmd)
+      | ircCmdCmd intCmd == "RUN" = do
           quoteBot' <- execStateT (runCommand intCmd) quoteBot
           return quoteBot'
-      | otherwise = do
-          lift . trace $ show intCmd
-          return quoteBot
-    eval (InputMsg _) = return (quoteBot)
-    eval _ = return (quoteBot)
+      | otherwise = return quoteBot
+    eval (InIrcMsg _) = return (quoteBot)
+    eval (OutIrcMsg _) = return (quoteBot)
 
 -- | run a command we received
-runCommand :: IntCmd -> QuoteBot ()
+runCommand :: IrcCmd -> QuoteBot ()
 runCommand intCmd
   | theCommand == "quote" = runQuoteCommand
-  | otherwise = do
-      lift . lift . trace $ show intCmd -- TODO : help message
+  | otherwise = return ()
   where
     -- | the message is a quote command
     runQuoteCommand :: QuoteBot ()
       | length args == 0 = do
           quoteDB <- gets quoteBotDB
           x <- liftIO $ randomRIO (0, (length $ M.keys quoteDB) - 1)
-          mapM_ (lift . answerMsg request) (formatQuote (M.keys quoteDB !! x) (M.elems quoteDB !! x))
+          if (length $ M.keys quoteDB) > 0
+            then
+              mapM_ (lift . answerMsg request) (formatQuote (M.keys quoteDB !! x) (M.elems quoteDB !! x))
+            else
+              lift $ answerMsg request "The quote database is empty."
       | otherwise = do
           dispatchQuoteCmd $ head args
     -- | quote command dispatcher
@@ -94,7 +111,7 @@ runCommand intCmd
       | cmd == "start"  = do
           quoteBot <- get
           now <- liftIO $ getCurrentTime
-          let sender   = takeWhile (/= '!') $ fromMaybe "ARGH" (prefix request)
+          let sender   = takeWhile (/= '!') $ fromMaybe "ARGH" (ircMsgPrefix request)
               newQuote = Quote sender [(quoteElt stuff)] now 0
               quoteId     = nextQuoteId quoteBot
               quotesInProgress' = M.insert quoteId  newQuote (quotesInProgress quoteBot)
@@ -134,17 +151,19 @@ runCommand intCmd
             theQuote  = unwords . tail $ msg
         QuoteElt budy theQuote
     -- | utilities
-    params  = words . intCmdMsg $ intCmd
+    params  = words . ircCmdMsg $ intCmd
     theCommand = head params
     args    = tail params
     stuff   = tail args
-    request = intCmdBotMsg intCmd
+    request = ircCmdBotMsg intCmd
 
 -- | The function that sync the quoteDB on disk
 syncQuoteBot :: QuoteBot ()
 syncQuoteBot = do
+    dir <- liftIO $ getAppUserDataDirectory "hsbot"
+    let dbfile = dir </> "quotedb.txt"
+    file' <- liftIO $ openFile dbfile WriteMode
     quoteBot <- get
-    file' <- liftIO $ openFile "quotedb.txt" WriteMode
     liftIO . hPutStr file' $ show quoteBot
     liftIO $ hClose file'
 
diff --git a/Plugins/Ping.hs b/Plugins/Ping.hs
deleted file mode 100644
index 5da3f2f..0000000
--- a/Plugins/Ping.hs
+++ /dev/null
@@ -1,31 +0,0 @@
-module Plugins.Ping
-    ( mainPing
-    ) where
-
-import Control.Concurrent.Chan
-import Control.Exception
-import Control.Monad.State
-import Prelude hiding (catch)
-
-import Hsbot.IRCPlugin
-import Hsbot.Types
-
--- | The plugin's main entry point
-mainPing :: Chan BotMsg -> Chan BotMsg -> IO ()
-mainPing serverChan chan = do
-    let plugin = PluginState "Ping" serverChan chan
-    _ <- (execStateT run plugin) `catch` (\(_ :: AsyncException) -> return plugin)
-    return ()
-
--- | The IrcPlugin monad main function
-run :: IrcPlugin ()
-run = forever $ do
-    msg <- readMsg
-    eval msg
-  where
-    eval :: BotMsg -> IrcPlugin ()
-    eval (InputMsg msg)
-        | (command msg) == "PING" = writeMsg $ OutputMsg $ IrcMsg Nothing "PONG" (parameters msg)
-        | otherwise = return ()
-    eval _ = return ()
-