IRC Bots, Redis bindings and Formlets



Published on September 27, 2010 under the tag Stuff I've been working on the last monthPublished on September 27, 2010 under the tag haskell

It’s been a bit quiet on this blog – my last post dates from the 9th of August. But it’s still September, which means I still haven’t broken my goal of writing at least one blogpost every month.

The new academic term has now started at Ghent University, and I thought it’d be a good idea to write a bit on the side projects I’ve done after my Google Summer of Code project ended.

Number Six

Number Six is a sexy IRC bot I’ve been working on, originally meant for the GhentFPG IRC channel ( #ghentfpg on Freenode).

I’ve tried to abstract the gore IRC protocol away as much as possible. The result is that writing handlers (plugins responding to IRC messages) can now happen in an easy yet quite flexible way.

All handlers run in the Irc monad, which gives them access to many useful variables such as the IRC command used in the incoming message, the sender, the text… Number Six will also run your handlers in separate thread, so a crashing plugin will have no effect on the rest of the bot.

This is a sample plugin that will reconnect the bot when it’s kicked:

handler :: Handler String = makeHandler "kick" $ return $ onCommand "KICK" $ do handlermakeHandleronCommand : nick' : _) <- getParameters (channelnick'_)getParameters <- getNick myNickgetNick == myNick) $ do when (nick'myNick) 3 sleep "JOIN" [channel] writeMessage[channel]

I’ve parametrized Handler on String – it simply specifies the string type used ( String and ByteString are supported). I’m using an irrefutable pattern match, because I know that a crashing plugin won’t matter much.

Of course, the code contains a large number of utility functions to quickly create simpler handlers. Here is the code of a handler that does some basic base conversions.

Storing data in a database is also very simple. There is a Redis util module which will automagically generate keys that don’t clash between handlers and bots. Here is an example.

Redis bindings

That leads us to the next subject. I’ve written a small wrapper around the Haskell Redis bindings which provide a somewhat simpler interface. It only supports a small subset of the bindings (coincidentally, this subset equals the subset of functions I needed).

<- connect localhost defaultPort redisconnect localhost defaultPort "commander" ( "Adama" :: String ) itemSet redis Just commander <- itemGet redis "commander" commanderitemGet redis putStrLn $ commander commander

My package can be found here. As you can see, I’ve made the bindings as simple as I could. However, if you need full redis functionality, I still recommend the original package.

Formlets

A week or so ago, I read this discussion on the state of Haskell web frameworks.

I noticed that Chris Done was using both blaze-html and xhtml. This is because the formlets library can only output xhtml, which makes it a bit cumbersome to make it work together with blaze-html.

So, I’ve ported formlets to blaze-html. The results should appear on Hackage when the maintainers find time to look over my patches. In the meanwhile, you can find my fork here.