https://github.com/maxking/cs583-project
Project for CS583 class in Spring 2016.
https://github.com/maxking/cs583-project
Last synced: 11 months ago
JSON representation
Project for CS583 class in Spring 2016.
- Host: GitHub
- URL: https://github.com/maxking/cs583-project
- Owner: maxking
- License: gpl-3.0
- Created: 2016-04-18T04:59:10.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-06-08T03:58:24.000Z (about 10 years ago)
- Last Synced: 2025-03-14T03:44:37.247Z (over 1 year ago)
- Language: Haskell
- Size: 67.4 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
hasbot (CS583 Project)
=============
[](https://travis-ci.org/maxking/cs583-project)
This is an IRC bot that exposes haskell functions over a chat interface.
More details can be found in Proposal.doc
Link to the project: https://github.com/maxking/cs583-project
Project Members:
- Abhilash Raj
- Deepthi S Kumar
Dependencies
------------
- [simpleirc][1] : A small IRC networking library in haskell.
- [parsec][5]
- [warp-3.2.6][6]
How to Run
----------
To run this project, you can build this project by:
```bash
$ git clone https://github.com/maxking/cs583-project
$ cd cs583-project
$ cabal build
```
Then you can run the program like:
```bash
$ ./dist/build/hasbot/hasbot
```
This will run the bot and connect it to IRC (Internet Relay Chat) network. To
interact with the bot, open an irc client or a [web client][2] and join the
channel `##maxking` and you will find the bot there with nick `hasbot`.
For now, the bot just responds to simple IRC commands like
```
>!hi
Hello!
> !add 3 4
7
> !neg -9
9
```
Anything else that you type is echo'd back from the bot.
Features
--------
- hasbot connects to `Frenode` network by default and joins `##maxking` channel
- It logs all the conversation on the channel internally
- Logs are accesible through web at `http://localhost:3000`
- The webserver and irc bot run in two seperate threads that are created using
[forkIO][3].
- hasbot responds to the commands on the channel `##maxking` and also over
private message.
- `!help` command presents a list of all the availabe commands along with usage
for each of the commands.
- `!search` commands accepts one or more words to search in the history of the
channel. The searching algorithm itself is naive and slows down as the length
of the channel history increases.
TODO
----
- Make it easy to add more commands (right now only !add and !neg
commands are available)
Internal Design
---------------
All messages are of type `IrcMessage` and have following important attributes:
- `mNick` : Nickname of the sender
- `mUser` : Realname of the sender
- `mHost` : Hostname of the sender
- `mServer`: Server address of the sender
- `mCode` : IRC code for the message, almost always defaults to `PRIVMSG`
- `mChan` : Sent to, either a channel or to the channel or nick
- `mOrigin` : Sent by, if private message then sender else channel
- `mRaw` : Raw message.
When a message is received, it can be of three types:
1. Sent to the channel
2. Sent to the channel but starting with `hasbot:` to highlight
3. Sent as private message to the bot
In each of the three cases above we perform the following actions:
- 1: Just log the message to a file
- 2: Parse the command in the message and respond to the sender with a response
on the channel that the command was recieved on
- 3: Do the same processing as (2) but send the response as private message to
sender
The raw message extracted from the IrcMessage is then parsed to get a value of
ChatMsg type. The parser is written using the parsec parser combinator library.
A ChatMsg can be a command or some text. A command is prefixed by "!" symbol
and followed by arguments
New commands can be easily added without any changes required at the command
processing level. This is facilitated by the higher order abstract syntax of the
Command data type. The user who wants to add new commands can do so by defining
two functions, one to convert the arguments from String to the required types
(*transform*) and the other which performs the operation (*execute*).
The example commands hi, neg and add that takes zero, one and two arguments
repectively can be used as reference to add new commands.
The type of *transform* function is [String] -> a and that of
*execute* function is a -> String. The type parameter a
here needs to same only for the command that is being defined and not all the
commands. This is achieved by using [existential types][4].
Design Questions
----------------
- Handling messages that are not commands. There is no framework for dealing with
such messages. They are simply echo'd back to the channel.
- How to make the design modular so that commands can be added over the chat
interface itself.
[1]: https://hackage.haskell.org/package/simpleirc-0.3.1/docs/
[2]: https://webchat.freenode.net/
[3]: https://hackage.haskell.org/package/base-4.9.0.0/docs/Control-Concurrent.html#v:forkIO
[4]: https://wiki.haskell.org/Existential_type
[5]: http://hackage.haskell.org/package/parsec
[6]: https://hackage.haskell.org/package/warp-3.2.6/docs/