aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTill Höppner2015-04-18 15:29:14 +0200
committerTill Höppner2015-04-18 15:29:14 +0200
commit057d3e0bdb4bb46749267b45223281fd9afc956d (patch)
treef6994ad12dd7d765d58958599705fb3d9d2c4d16
parent326b5d9d96a5f45fa8b371f2a78394bcd87030e0 (diff)
parent4eea7cdff640f31f6595ec880d5405665fbd5c55 (diff)
downloadirsc-057d3e0bdb4bb46749267b45223281fd9afc956d.tar.gz
irsc-057d3e0bdb4bb46749267b45223281fd9afc956d.tar.xz
irsc-057d3e0bdb4bb46749267b45223281fd9afc956d.zip
Merge pull request #3 from tilpner/refactor
Refactor
-rw-r--r--Cargo.toml21
-rw-r--r--README.md4
-rw-r--r--examples/01.rs42
-rw-r--r--src/callback.rs14
-rw-r--r--src/event.rs50
-rw-r--r--src/ident.rs2
-rw-r--r--src/lib.rs25
-rw-r--r--src/message.rs1207
-rw-r--r--src/server.rs205
9 files changed, 1397 insertions, 173 deletions
diff --git a/Cargo.toml b/Cargo.toml
index f3d1253..23c7f2a 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,9 +1,22 @@
[package]
name = "irsc"
-version = "0.0.3"
-authors = ["Till Hoeppner <hoeppner.till@gmail.com>"]
+version = "0.1.0"
+authors = ["Till Hoeppner <till@hoeppner.ws>"]
description = "A lightweight library for building IRC bots."
-repository = "https://github.com/hoeppnertill/irsc"
+repository = "https://github.com/tilpner/irsc"
keywords = ["irc", "internet", "protocol"]
-license = "WTFPL"
+license = "MIT"
+
+[dependencies]
+log = "*"
+regex = "*"
+regex_macros = "*"
+eventual = "*"
+
+[features]
+ssl = ["openssl"]
+
+[dependencies.openssl]
+version = "*"
+optional = true
diff --git a/README.md b/README.md
index 1eeba5f..b455793 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,6 @@
-irsc [![Build Status](https://travis-ci.org/hoeppnertill/irsc.svg)](https://travis-ci.org/hoeppnertill/irsc)
+irsc
+[![travis-ci.org](https://travis-ci.org/tilpner/irsc.svg?branch=master)](https://travis-ci.org/tilpner/irsc)
+[![crates.io](http://meritbadge.herokuapp.com/irsc)](https://crates.io/crates/irsc)
=========
*This repository contains code that has not been properly tested yet, continue
diff --git a/examples/01.rs b/examples/01.rs
index 0bf51f5..ee6c99a 100644
--- a/examples/01.rs
+++ b/examples/01.rs
@@ -1,38 +1,46 @@
-#![feature(globs, slicing_syntax)]
+#![feature(plugin)]
+#![plugin(regex_macros)]
extern crate irsc;
+use std::borrow::ToOwned;
+
+use std::sync::{Once, ONCE_INIT};
+
use irsc::server::Server;
use irsc::color::bold;
-use irsc::event;
-use irsc::event::{ Event, ParseResult, PrivMsg };
+use irsc::message::{ Message, Command };
static NAME: &'static str = "rusticbot";
static DESC: &'static str = "A bot, written in Rust.";
-fn callback(arg: (Server, Event)) {
- let (mut server, event) = arg;
- match event.command[] {
- event::PRIVMSG => {
- let privmsg: PrivMsg = ParseResult::parse(event).unwrap();
- let response = format!("You wrote: {}", bold(privmsg.content[]));
- server.msg(privmsg.from.nickname[], response[]).unwrap();
+static START: Once = ONCE_INIT;
+
+fn callback(server: &mut Server, msg: &Message) {
+ match Command::from_message(msg) {
+ Some(Command::PrivMsg { from, content, .. }) => {
+ let response = format!("You wrote: {}", bold(&content));
+ server.msg(&from.unwrap(), &response).unwrap();
},
- _ => ()
+ _ => {}
}
+
+ /*
+ "001" => {
+ START.call_once(|| {
+ })
+ },
+ _ => ()
+ }*/
}
fn main() {
let mut s = Server::new();
- s.connect("irc.freenode.org".into_string(), 6667).unwrap();
+ s.connect("irc.mozilla.org".to_owned(), 6667).unwrap();
s.nick(NAME).unwrap();
s.user(NAME, "*", "*", DESC).unwrap();
s.join("#botzoo").unwrap();
- s.msg("flan3002", "Hey, I'm your example bot!").unwrap();
-
- s.events.lock().register(&(callback as fn((Server,Event))));
-
// Dedicate this thread to listening and event processing
- s.listen().unwrap();
+ s.listen(&[callback]).unwrap();
}
diff --git a/src/callback.rs b/src/callback.rs
index c62ebf8..b2027f6 100644
--- a/src/callback.rs
+++ b/src/callback.rs
@@ -1,15 +1,15 @@
-pub struct Callback<A: Sized + Send> {
- items: Vec<fn(A)>
+pub struct Callback<A: Sized> {
+ items: Vec<fn(&mut A)>
}
-impl<A: Sized + Clone + Send> Callback<A> {
+impl<A: Sized> Callback<A> {
pub fn new() -> Callback<A> {
Callback { items: Vec::new() }
}
- pub fn register(&mut self, f: &fn(A)) {
- self.items.push(*f)
+ pub fn register(&mut self, f: fn(&mut A)) {
+ self.items.push(f)
}
- pub fn fire(&self, v: &A) {
- for _ in self.items.iter().map(|&c| c(v.clone())) {}
+ pub fn fire(&self, v: &mut A) {
+ for _ in self.items.iter().map(|&c| c(v)) {}
}
}
diff --git a/src/event.rs b/src/event.rs
deleted file mode 100644
index b8e9743..0000000
--- a/src/event.rs
+++ /dev/null
@@ -1,50 +0,0 @@
-use ident::Ident;
-
-use std::borrow::ToOwned;
-
-#[deriving(Clone)]
-pub struct Event {
- pub prefix: String,
- pub command: String,
- pub content: Vec<String>
-}
-
-pub trait ParseResult {
- fn parse(event: Event) -> Option<Self>;
-}
-
-pub const PING: &'static str = "PING";
-
-pub const PRIVMSG: &'static str = "PRIVMSG";
-
-fn join(v: Vec<String>, from: uint) -> String {
- let mut msg = if v[from].chars().next().unwrap() == ':' {
- v[from][][1..].to_owned()
- } else { v[from].clone() };
- for m in v.iter().skip(from + 1) {
- msg.push_str(" ");
- msg.push_str(m.trim_right());
- }
- msg
-}
-
-pub struct PrivMsg {
- pub from: Ident,
- pub to: String,
- pub content: String
-}
-
-impl ParseResult for PrivMsg {
- fn parse(event: Event) -> Option<PrivMsg> {
- let from = Ident::parse(event.prefix[]);
- let to = event.content[0].clone();
- match from {
- Some(from) => Some(PrivMsg {
- from: from,
- to: to,
- content: join(event.content, 1)
- }),
- None => None
- }
- }
-}
diff --git a/src/ident.rs b/src/ident.rs
index 6a01d12..0008d53 100644
--- a/src/ident.rs
+++ b/src/ident.rs
@@ -3,7 +3,7 @@ use std::borrow::ToOwned;
static PATTERN: Regex = regex!(":(.*)!(.*)@(.*)");
-#[deriving(Show, Clone)]
+#[derive(Debug, Clone)]
pub struct Ident {
pub nickname: String,
pub user: String,
diff --git a/src/lib.rs b/src/lib.rs
index 6d0b42d..577770d 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,14 +1,27 @@
-#![feature(globs, phase, slicing_syntax, macro_rules, unboxed_closures)]
+#![feature(plugin, collections)]
+#![plugin(regex_macros)]
-#[phase(plugin)]
-extern crate regex_macros;
extern crate regex;
-
-#[phase(plugin, link)]
+#[macro_use]
extern crate log;
+extern crate eventual;
pub mod server;
pub mod color;
pub mod ident;
pub mod callback;
-pub mod event;
+pub mod message;
+
+use std::io;
+use std::result;
+
+#[derive(Debug)]
+pub enum IrscError {
+ Io(io::Error),
+ AlreadyConnected,
+ NotConnected
+}
+
+pub type Result<T> = result::Result<T, IrscError>;
+
+pub const DEBUG: bool = cfg!(not(ndebug));
diff --git a/src/message.rs b/src/message.rs
new file mode 100644
index 0000000..fd77aef
--- /dev/null
+++ b/src/message.rs
@@ -0,0 +1,1207 @@
+#![allow(non_camel_case_types)]
+
+use std::str::FromStr;
+use std::string::{ ToString };
+use std::borrow::{ Cow, Borrow, ToOwned };
+
+#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
+pub enum MsgType {
+ /// Plain old IRC messages, as defined in [rfc2812][rfc]
+ /// rfc: http://tools.ietf.org/html/rfc2812
+ Irc,
+ /// Ctcp messages, wrapped in \u{1}
+ Ctcp
+}
+
+#[derive(Debug, PartialEq, Eq, Hash, Clone)]
+pub struct Message<'a> {
+ pub prefix: Option<Cow<'a, String>>,
+ pub command: Cow<'a, String>,
+ pub content: Vec<Cow<'a, String>>,
+ pub suffix: Option<Cow<'a, String>>,
+ pub msg_type: MsgType
+}
+
+impl<'a> Message<'a> {
+ pub fn new(prefix: Option<Cow<'a, String>>, command: Cow<'a, String>, content: Vec<Cow<'a, String>>, suffix: Option<Cow<'a, String>>, msg_type: MsgType) -> Message<'a> {
+ Message {
+ prefix: prefix,
+ command: command,
+ content: content,
+ suffix: suffix,
+ msg_type: msg_type
+ }
+ }
+}
+
+impl<'a> FromStr for Message<'a> {
+ type Err = ::IrscError;
+ fn from_str(i: &str) -> Result<Message<'a>, ::IrscError> {
+ info!("Attempting to parse message: {}", i);
+ let len = i.len();
+ let mut s = i;
+
+ let msg_type = if s.chars().next() == Some('\u{1}') { MsgType::Ctcp } else { MsgType::Irc };
+
+ let prefix = if len >= 1 && s.chars().next() == Some(':') {
+ s.find(' ').map(|i| {
+ let p = s.slice_chars(1, i).to_owned();
+ s = &s[i + 1..];
+ p
+ })
+ } else { None };
+
+ let command = s.find(' ').map(|i| {
+ let p = s.slice_chars(0, i).to_owned();
+ s = &s[i..];
+ p
+ }).map(|c| c.parse()).map(|c| Some(Cow::Owned(c.unwrap())));
+
+ // TODO: Parse last non-suffix argument as suffix if no suffix
+ // with colon is available.
+ let mut content = Vec::with_capacity(15);
+ let mut suffix = None;
+ while s.len() > 0 {
+ if s.chars().next() == Some(':') {
+ suffix = Some(s[1..].to_owned());
+ break
+ }
+ s.find(' ').map(|i| {
+ if i > 0 {
+ content.push(Cow::Owned(s.slice_chars(0, i).to_owned()));
+ s = &s[i..];
+ }
+ });
+ if s.chars().next() == Some(' ') { s = &s[1..] };
+ }
+
+ command.map(move |c|
+ Ok(Message::new(prefix.map(|p| Cow::Owned(p)),
+ c.unwrap(),
+ content,
+ suffix.map(|s| Cow::Owned(s)),
+ msg_type
+ ))
+ ).unwrap()
+
+ }
+}
+
+impl<'a> ToString for Message<'a> {
+ fn to_string(&self) -> String {
+ let mut s = String::with_capacity(512);
+ if let Some(ref p) = self.prefix {
+ s.push(':');
+ s.push_str(&p);
+ s.push(' ');
+ }
+
+ s.push_str(&self.command);
+ s.push(' ');
+
+ for part in self.content.iter() {
+ s.push_str(&part);
+ s.push(' ');
+ }
+
+ if let Some(ref p) = self.suffix {
+ s.push(':');
+ s.push_str(&p);
+ }
+
+ s
+
+ }
+}
+
+/*
+pub trait Command {
+ fn name(&self) -> String;
+ fn to_message(&self) -> Message;
+ fn from_message(msg: &Message) -> Option<Self>
+}
+
+macro_rules! command (
+ ($name: ident { $($field: ident: $t: ty),* } to $to_msg: expr; from $from_msg: expr;) => (
+ pub struct $name {
+ $(pub $field: $t),*
+ }
+
+ impl Command for $name {
+ fn name(&self) -> String { stringify!($name).to_owned() }
+ fn to_message(&self) -> Message { ($to_msg)(self) }
+ fn from_message(msg: &Message) -> Option<$name> { ($from_msg)(msg) }
+ }
+ )
+);*/
+
+/*
+command!(Pass { password: String }
+ to |&:s: &Pass| Message::new(None, "PASS".to_owned(), Vec::new(), Some(s.password.clone()));
+ from |&:msg: &Message| msg.clone().suffix.map(|s| Pass { password: s }););
+
+command!(Ping { server1: Option<String>, server2: Option<String> }
+ to |&:s :&Ping| {
+ let mut v = Vec::new();
+ if let Some(ref s) = s.server1 { v.push(s.clone()) }
+ if let Some(ref s) = s.server2 { v.push(s.clone()) }
+ Message::new(None, "PING".to_owned(), v, None)
+ };
+ from |&:msg: &Message| {
+ let mut c = msg.content.clone();
+ Some(Ping { server2: c.pop(), server1: c.pop() }) }; );
+
+command!(Pong { server1: Option<String>, server2: Option<String> }
+ to |&:s: &Pong| {
+ let mut v = Vec::new();
+ if let Some(ref s) = s.server1 { v.push(s.clone()) }
+ if let Some(ref s) = s.server2 { v.push(s.clone()) }
+ Message::new(None, "PONG".to_owned(), v, None)
+ };
+ from |&:msg: &Message| {
+ let mut c = msg.content.clone();
+ Some(Pong { server2: c.pop(), server1: c.pop() })
+ }; );
+
+command!(PrivMsg { from: Option<String>, to: String, content: String }
+ to |&:s: &PrivMsg| {
+ Message::new(s.from.clone(), "PRIVMSG".to_owned(), vec![s.to.clone()], Some(s.content.clone()))
+ };
+ from |&:msg: &Message| {
+ msg.content.clone().pop().map(
+ |c| PrivMsg {
+ from: msg.prefix.clone(),
+ to: c,
+ content: msg.suffix.clone().unwrap_or(String::new())
+ })
+ }; );
+*/
+
+#[derive(Clone, PartialEq, Eq, Hash)]
+pub enum Mode {
+ Away,
+ Invisible,
+ Wallops,
+ Restricted,
+ Operator,
+ LocalOperator,
+ ServerNotices,
+ Custom(String)
+}
+
+#[derive(Copy, Clone, PartialEq, Eq, Hash)]
+pub enum SetMode {
+ Plus,
+ Minus
+}
+
+#[derive(Clone, PartialEq, Eq, Hash)]
+pub enum Command<'a> {
+ Pass { password: Cow<'a, String> },
+ Nick { nickname: Cow<'a, String> },
+ User { user: Cow<'a, String>, mode: Cow<'a, String>, unused: Cow<'a, String>, realname: Cow<'a, String> },
+ Oper { name: Cow<'a, String>, password: Cow<'a, String> },
+ Mode { nickname: Cow<'a, String>, mode: &'a [(SetMode, Mode)] },
+ Service { nickname: Cow<'a, String>, reserved: Cow<'a, String>, distribution: Cow<'a, String>, service_type: Cow<'a, String>, reserved2: Cow<'a, String>, info: Cow<'a, String> },
+ Quit { message: Option<Cow<'a, String>> },
+ SQuit { server: Cow<'a, String>, comment: Cow<'a, String> },
+ Join { channels: &'a [(Cow<'a, String>, Option<Cow<'a, String>>)] },
+ Join_leave_all,
+ Part { channels: &'a [Cow<'a, String>], message: Cow<'a, String> },
+ /*
+ Topic = 1011,
+ Names = 1012,
+ List = 1013,
+ Invite = 1014,
+ Kick = 1015,
+ */
+ PrivMsg { from: Option<Cow<'a, String>>, to: Cow<'a, String>, content: Cow<'a, String> },
+ Notice { to: Cow<'a, String>, content: Cow<'a, String> },
+ /*
+ Motd = 1018,
+ LUsers = 1019,
+ Version = 1020,
+ Stats = 1021,
+ Links = 1022,
+ Time = 1023,
+ Connect = 1024,
+ Trace = 1025,
+ Admin = 1026,
+ Info = 1027,
+ ServList = 1028,
+ SQuery = 1029,
+ Who = 1030,
+ WhoIs = 1031,
+ WhoWas = 1032,
+ Kill = 1033,
+ */
+ Ping { server1: Option<Cow<'a, String>>, server2: Option<Cow<'a, String>> },
+ Pong { server1: Option<Cow<'a, String>>, server2: Option<Cow<'a, String>> },
+ /*
+ Error = 1036,
+ Away = 1037,
+ Rehash = 1038,
+ Die = 1039,
+ Restart = 1040,
+ Summon = 1041,
+ Users = 1042,
+ Wallops = 1043,
+ Userhost = 1044,
+ Ison = 1045,*/
+
+ Ctcp { command: Cow<'a, String> },
+
+ /*
+
+ /// "Welcome to the Internet Relay Network <nick>!<user>@<host>"
+ RPL_WELCOME = 001,
+ /// "Your host is <servername>, running version <ver>"
+ RPL_YOURHOST = 002,
+ /// "This server was created <date>"
+ RPL_CREATED = 003,
+ /// "<servername> <version> <available user modes> <available channel modes>"
+ RPL_MYINFO = 004,
+ /// "Try server <server name>, port <port number>"
+ /// Sent by the server to a user to suggest an alternative
+ /// server. This is often used when the connection is
+ /// refused because the server is already full.
+ RPL_BOUNCE = 005,
+ /// ":*1<reply> *( " " <reply> )"
+ /// - Reply format used by USERHOST to list replies to
+ /// the query list. The reply string is composed as
+ /// follows:
+ ///
+ /// reply = nickname [ "*" ] "=" ( "+" / "-" ) hostname
+ ///
+ /// The '*' indicates whether the client has registered
+ /// as an Operator. The '-' or '+' characters represent
+ /// whether the client has set an AWAY message or not
+ /// respectively.
+ RPL_USERHOST = 302,
+ /// ":*1<nick> *( " " <nick> )"
+ /// - Reply format used by ISON to list replies to the query list.
+ RPL_ISON = 303,
+ /// "<nick> :<away message>"
+ RPL_AWAY = 301,
+ /// ":You are no longer marked as being away"
+ RPL_UNAWAY = 305,
+ /// ":You have been marked as being away"
+ /// - These replies are used with the AWAY command (if
+ /// allowed). RPL_AWAY is sent to any client sending a
+ /// PRIVMSG to a client which is away. RPL_AWAY is only
+ /// sent by the server to which the client is connected.
+ /// Replies RPL_UNAWAY and RPL_NOWAWAY are sent when the
+ /// client removes and sets an AWAY message./
+ RPL_NOWAWAY = 306,
+ /// "<nick> <user> <host> * :<real name>"
+ RPL_WHOISUSER = 311,
+ /// "<nick> <server> :<server info>"
+ RPL_WHOISSERVER = 312,
+ /// "<nick> :is an IRC operator"
+ RPL_WHOISOPERATOR = 313,
+ /// "<nick> <integer> :seconds idle"
+ RPL_WHOISIDLE = 317,
+ /// "<nick> :End of WHOIS list"
+ RPL_ENDOFWHOIS = 318,
+ /// "<nick> :*( ( "@" / "+" ) <channel> " " )"
+ /// - Replies 311 - 313, 317 - 319 are all replies
+ /// generated in response to a WHOIS message. Given that
+ /// there are enough parameters present, the answering
+ /// server MUST either formulate a reply out of the above
+ /// numerics (if the query nick is found) or return an
+ /// error reply. The '*' in RPL_WHOISUSER is there as
+ /// the literal character and not as a wild card. For
+ /// each reply set, only RPL_WHOISCHANNELS may appear
+ /// more than once (for long lists of channel names).
+ /// The '@' and '+' characters next to the channel name
+ /// indicate whether a client is a channel operator or
+ /// has been granted permission to speak on a moderated
+ /// channel. The RPL_ENDOFWHOIS reply is used to mark
+ /// the end of processing a WHOIS message.
+ RPL_WHOISCHANNELS = 319,
+ /// "<nick> <user> <host> * :<real name>"
+ RPL_WHOWASUSER = 314,
+ /// "<nick> :End of WHOWAS"
+ /// - When replying to a WHOWAS message, a server MUST use
+ /// the replies RPL_WHOWASUSER, RPL_WHOISSERVER or
+ /// ERR_WASNOSUCHNICK for each nickname in the presented
+ /// list. At the end of all reply batches, there MUST
+ /// be RPL_ENDOFWHOWAS (even if there was only one reply
+ /// and it was an error).
+ RPL_ENDOFWHOWAS = 369,
+ /// Obsolete. Not used.
+ #[deprecated = "Obsolete. Not used."]
+ RPL_LISTSTART = 321,
+ /// "<channel> <# visible> :<topic>"
+ RPL_LIST = 322,
+ /// ":End of LIST"
+ /// - Replies RPL_LIST, RPL_LISTEND mark the actual replies
+ /// with data and end of the server's response to a LIST
+ /// command. If there are no channels available to return,
+ /// only the end reply MUST be sent.
+ RPL_LISTEND = 323,
+ /// "<channel> <nickname>"
+ RPL_UNIQOPIS = 325,
+ /// "<channel> <mode> <mode params>"
+ RPL_CHANNELMODEIS = 324,
+ /// "<channel> :No topic is set"
+ RPL_NOTOPIC = 331,
+ /// "<channel> :<topic>"
+ /// - When sending a TOPIC message to determine the
+ /// channel topic, one of two replies is sent. If
+ /// the topic is set, RPL_TOPIC is sent back else
+ /// RPL_NOTOPIC.
+ RPL_TOPIC = 332,
+ /// "<channel> <nick>"
+ /// - Returned by the server to indicate that the
+ /// attempted INVITE message was successful and is
+ /// being passed onto the end client.
+ RPL_INVITING = 341,
+ /// "<user> :Summoning user to IRC"
+ /// - Returned by a server answering a SUMMON message to
+ /// indicate that it is summoning that user.
+ RPL_SUMMONING = 342,
+ /// "<channel> <invitemask>"
+ RPL_INVITELIST = 346,
+ /// "<channel> :End of channel invite list"
+ /// - When listing the 'invitations masks' for a given channel,
+ /// a server is required to send the list back using the
+ /// RPL_INVITELIST and RPL_ENDOFINVITELIST messages. A
+ /// separate RPL_INVITELIST is sent for each active mask.
+ /// After the masks have been listed (or if none present) a
+ /// RPL_ENDOFINVITELIST MUST be sent.
+ RPL_ENDOFINVITELIST = 347,
+ /// "<channel> <exceptionmask>"
+ RPL_EXCEPTLIST = 348,
+ /// "<channel> :End of channel exception list"
+ /// - When listing the 'exception masks' for a given channel,
+ /// a server is required to send the list back using the
+ /// RPL_EXCEPTLIST and RPL_ENDOFEXCEPTLIST messages. A
+ /// separate RPL_EXCEPTLIST is sent for each active mask.
+ /// After the masks have been listed (or if none present)
+ /// a RPL_ENDOFEXCEPTLIST MUST be sent./
+ RPL_ENDOFEXCEPTLIST = 349,
+ /// "<version>.<debuglevel> <server> :<comments>"
+ /// - Reply by the server showing its version details.
+ /// The <version> is the version of the software being
+ /// used (including any patchlevel revisions) and the
+ /// <debuglevel> is used to indicate if the server is
+ /// running in "debug mode".
+ ///
+ /// The "comments" field may contain any comments about
+ /// the version or further version details.
+ RPL_VERSION = 351,
+ /// "<channel> <user> <host> <server> <nick>
+ /// ( "H" / "G" > ["*"] [ ( "@" / "+" ) ]
+ /// :<hopcount> <real name>"
+ RPL_WHOREPLY = 352,
+ /// "<name> :End of WHO list"
+ /// - The RPL_WHOREPLY and RPL_ENDOFWHO pair are used
+ /// to answer a WHO message. The RPL_WHOREPLY is only
+ /// sent if there is an appropriate match to the WHO
+ /// query. If there is a list of parameters supplied
+ /// with a WHO message, a RPL_ENDOFWHO MUST be sent
+ /// after processing each list item with <name> being
+ /// the item.
+ RPL_ENDOFWHO = 315,
+ /// "( "=" / "*" / "@" ) <channel>
+ /// :[ "@" / "+" ] <nick> *( " " [ "@" / "+" ] <nick> )
+ /// - "@" is used for secret channels, "*" for private
+ /// channels, and "=" for others (public channels).
+ RPL_NAMREPLY = 353,
+ /// "<channel> :End of NAMES list"
+ /// - To reply to a NAMES message, a reply pair consisting
+ /// of RPL_NAMREPLY and RPL_ENDOFNAMES is sent by the
+ /// server back to the client. If there is no channel
+ /// found as in the query, then only RPL_ENDOFNAMES is
+ /// returned. The exception to this is when a NAMES
+ /// message is sent with no parameters and all visible
+ /// channels and contents are sent back in a series of
+ /// RPL_NAMEREPLY messages with a RPL_ENDOFNAMES to mark
+ /// the end.
+ RPL_ENDOFNAMES = 366,
+ /// "<mask> <server> :<hopcount> <server info>"
+ RPL_LINKS = 364,
+ /// "<mask> :End of LINKS list"
+ /// - In replying to the LINKS message, a server MUST send
+ /// replies back using the RPL_LINKS numeric and mark the
+ /// end of the list using an RPL_ENDOFLINKS reply.
+ RPL_ENDOFLINKS = 365,
+ /// "<channel> <banmask>"
+ RPL_BANLIST = 367,
+ /// "<channel> :End of channel ban list"
+ /// - When listing the active 'bans' for a given channel,
+ /// a server is required to send the list back using the
+ /// RPL_BANLIST and RPL_ENDOFBANLIST messages. A separate
+ /// RPL_BANLIST is sent for each active banmask. After the
+ /// banmasks have been listed (or if none present) a
+ /// RPL_ENDOFBANLIST MUST be sent.
+ RPL_ENDOFBANLIST = 368,
+ /// ":<string>"
+ RPL_INFO = 371,
+ /// ":End of INFO list"
+ /// - A server responding to an INFO message is required to
+ /// send all its 'info' in a series of RPL_INFO messages
+ /// with a RPL_ENDOFINFO reply to indicate the end of the
+ /// replies.
+ RPL_ENDOFINFO = 374,
+ /// ":- <server> Message of the day - "
+ RPL_MOTDSTART = 375,
+ /// ":- <text>"
+ RPL_MOTD = 372,
+ /// ":End of MOTD command"
+ /// - When responding to the MOTD message and the MOTD file
+ /// is found, the file is displayed line by line, with
+ /// each line no longer than 80 characters, using
+ /// RPL_MOTD format replies. These MUST be surrounded
+ /// by a RPL_MOTDSTART (before the RPL_MOTDs) and an
+ /// RPL_ENDOFMOTD (after).
+ RPL_ENDOFMOTD = 376,
+ /// ":You are now an IRC operator"
+ /// - RPL_YOUREOPER is sent back to a client which has
+ /// just successfully issued an OPER message and gained
+ /// operator status.
+ RPL_YOUREOPER = 381,
+ /// "<config file> :Rehashing"
+ /// - If the REHASH option is used and an operator sends
+ /// a REHASH message, an RPL_REHASHING is sent back to
+ /// the operator.
+ RPL_REHASHING = 382,
+ /// "You are service <servicename>"
+ /// - Sent by the server to a service upon successful
+ /// registration.
+ RPL_YOURESERVICE = 383,
+ /// "<server> :<string showing server's local time>"
+ /// - When replying to the TIME message, a server MUST send
+ /// the reply using the RPL_TIME format above. The string
+ /// showing the time need only contain the correct day and
+ /// time there. There is no further requirement for the
+ /// time string.
+ RPL_TIME = 391,
+ /// ":UserID Terminal Host"
+ RPL_USERSSTART = 392,
+ /// ":<username> <ttyline> <hostname>"
+ RPL_USERS = 393,
+ /// ":End of users"
+ RPL_ENDOFUSERS = 394,
+ /// ":Nobody logged in"
+ /// - If the USERS message is handled by a server, the
+ /// replies RPL_USERSTART, RPL_USERS, RPL_ENDOFUSERS and
+ /// RPL_NOUSERS are used. RPL_USERSSTART MUST be sent
+ /// first, following by either a sequence of RPL_USERS
+ /// or a single RPL_NOUSER. Following this is
+ /// RPL_ENDOFUSERS.
+ RPL_NOUSERS = 395,
+ /// "Link <version & debug level> <destination>
+ /// <next server> V<protocol version>
+ /// <link uptime in seconds> <backstream sendq>
+ /// <upstream sendq>"
+ RPL_TRACELINK = 200,
+ /// "Try. <class> <server>"
+ RPL_TRACECONNECTING = 201,
+ /// "H.S. <class> <server>"
+ RPL_TRACEHANDSHAKE = 202,
+ /// "???? <class> [<client IP address in dot form>]"
+ RPL_TRACEUNKNOWN = 203,
+ /// "Oper <class> <nick>"
+ RPL_TRACEOPERATOR = 204,
+ /// "User <class> <nick>"
+ RPL_TRACEUSER = 205,
+ /// "Serv <class> <int>S <int>C <server>
+ /// <nick!user|*!*>@<host|server> V<protocol version>"
+ RPL_TRACESERVER = 206,
+ /// "Service <class> <name> <type> <active type>"
+ RPL_TRACESERVICE = 207,
+ /// "<newtype> 0 <client name>"
+ RPL_TRACENEWTYPE = 208,
+ /// "Class <class> <count>"
+ RPL_TRACECLASS = 209,
+ /// Unused.
+ #[deprecated = "Unused."]
+ RPL_TRACERECONNECT = 210,
+ /// "File <logfile> <debug level>"
+ RPL_TRACELOG = 261,
+ /// "<server name> <version & debug level> :End of TRACE"
+ /// - The RPL_TRACE* are all returned by the server in
+ /// response to the TRACE message. How many are
+ /// returned is dependent on the TRACE message and
+ /// whether it was sent by an operator or not. There
+ /// is no predefined order for which occurs first.
+ /// Replies RPL_TRACEUNKNOWN, RPL_TRACECONNECTING and
+ /// RPL_TRACEHANDSHAKE are all used for connections
+ /// which have not been fully established and are either
+ /// unknown, still attempting to connect or in the
+ /// process of completing the 'server handshake'.
+ /// RPL_TRACELINK is sent by any server which handles
+ /// a TRACE message and has to pass it on to another
+ /// server. The list of RPL_TRACELINKs sent in
+ /// response to a TRACE command traversing the IRC
+ /// network should reflect the actual connectivity of
+ /// the servers themselves along that path.
+ /// RPL_TRACENEWTYPE is to be used for any connection
+ /// which does not fit in the other categories but is
+ /// being displayed anyway.
+ /// RPL_TRACEEND is sent to indicate the end of the list./
+ RPL_TRACEEND = 262,
+ /// "<linkname> <sendq> <sent messages>
+ /// <sent Kbytes> <received messages>
+ /// <received Kbytes> <time open>"
+ /// - reports statistics on a connection. <linkname>
+ /// identifies the particular connection, <sendq> is
+ /// the amount of data that is queued and waiting to be
+ /// sent <sent messages> the number of messages sent,
+ /// and <sent Kbytes> the amount of data sent, in
+ /// Kbytes. <received messages> and <received Kbytes>
+ /// are the equivalent of <sent messages> and <sent
+ /// Kbytes> for received data, respectively. <time
+ /// open> indicates how long ago the connection was
+ /// opened, in seconds.
+ RPL_STATSLINKINFO = 211,
+ /// "<command> <count> <byte count> <remote count>"
+ /// - reports statistics on commands usage.
+ RPL_STATSCOMMAND = 212,
+ /// "<stats letter> :End of STATS report"
+ RPL_ENDOFSTATS = 219,
+ /// ":Server Up %d days %d:%02d:%02d"
+ /// - reports the server uptime.
+ RPL_STATSUPTIME = 242,
+ /// "O <hostmask> * <name>"
+ /// - reports the allowed hosts from where user may become IRC
+ /// operators.
+ RPL_STATSOLINE = 243,
+ /// "<user mode string>"
+ /// - To answer a query about a client's own mode,
+ /// RPL_UMODEIS is sent back.
+ RPL_UMODEIS = 221,
+ /// "<name> <server> <mask> <type> <hopcount> <info>"
+ RPL_SERVLIST = 234,
+ /// "<mask> <type> :End of service listing"
+ /// - When listing services in reply to a SERVLIST message,
+ /// a server is required to send the list back using the
+ /// RPL_SERVLIST and RPL_SERVLISTEND messages. A separate
+ /// RPL_SERVLIST is sent for each service. After the
+ /// services have been listed (or if none present) a
+ /// RPL_SERVLISTEND MUST be sent./
+ RPL_SERVLISTEND = 235,
+ /// ":There are <integer> users and <integer>
+ /// services on <integer> servers"
+ RPL_LUSERCLIENT = 251,
+ /// "<integer> :operator(s) online"
+ RPL_LUSEROP = 252,
+ /// "<integer> :unknown connection(s)"
+ RPL_LUSERUNKNOWN = 253,
+ /// "<integer> :channels formed"
+ RPL_LUSERCHANNELS = 254,
+ /// ":I have <integer> clients and <integer>
+ /// servers"
+ /// - In processing an LUSERS message, the server
+ /// sends a set of replies from RPL_LUSERCLIENT,
+ /// RPL_LUSEROP, RPL_USERUNKNOWN,
+ /// RPL_LUSERCHANNELS and RPL_LUSERME. When
+ /// replying, a server MUST send back
+ /// RPL_LUSERCLIENT and RPL_LUSERME. The other
+ /// replies are only sent back if a non-zero count
+ /// is found for them.
+ RPL_LUSERME = 255,
+ /// "<server> :Administrative info"
+ RPL_ADMINME = 256,
+ /// ":<admin info>"
+ RPL_ADMINLOC1 = 257,
+ /// ":<admin info>"
+ RPL_ADMINLOC2 = 258,
+ /// ":<admin info>"
+ /// - When replying to an ADMIN message, a server
+ /// is expected to use replies RPL_ADMINME
+ /// through to RPL_ADMINEMAIL and provide a text
+ /// message with each. For RPL_ADMINLOC1 a
+ /// description of what city, state and country
+ /// the server is in is expected, followed by
+ /// details of the institution (RPL_ADMINLOC2)
+ /// and finally the administrative contact for the
+ /// server (an email address here is REQUIRED)
+ /// in RPL_ADMINEMAIL.
+ RPL_ADMINEMAIL = 259,
+ /// "<command> :Please wait a while and try again."
+ /// - When a server drops a command without processing it,
+ /// it MUST use the reply RPL_TRYAGAIN to inform the
+ /// originating client.
+ RPL_TRYAGAIN = 263,
+
+ /// "<nickname> :No such nick/channel"
+ /// - Used to indicate the nickname parameter supplied to a
+ /// command is currently unused.
+ ERR_NOSUCHNICK = 401,
+ /// "<server name> :No such server"
+ /// - Used to indicate the server name given currently
+ /// does not exist.
+ ERR_NOSUCHSERVER = 402,
+ /// "<channel name> :No such channel"
+ /// - Used to indicate the given channel name is invalid.
+ ERR_NOSUCHCHANNEL = 403,
+ /// "<channel name> :Cannot send to channel"
+ /// - Sent to a user who is either (a) not on a channel
+ /// which is mode +n or (b) not a chanop (or mode +v) on
+ /// a channel which has mode +m set or where the user is
+ /// banned and is trying to send a PRIVMSG message to
+ /// that channel.
+ ERR_CANNOTSENDTOCHAN = 404,
+ /// "<channel name> :You have joined too many channels"
+ /// - Sent to a user when they have joined the maximum
+ /// number of allowed channels and they try to join
+ /// another channel.
+ ERR_TOOMANYCHANNELS = 405,
+ /// "<nickname> :There was no such nickname"
+ /// - Returned by WHOWAS to indicate there is no history
+ /// information for that nickname.
+ ERR_WASNOSUCHNICK = 406,
+ /// "<target> :<error code> recipients. <abort message>"
+ /// - Returned to a client which is attempting to send a
+ /// PRIVMSG/NOTICE using the user@host destination format
+ /// and for a user@host which has several occurrences.
+ /// - Returned to a client which trying to send a
+ /// PRIVMSG/NOTICE to too many recipients.
+ /// - Returned to a client which is attempting to JOIN a safe
+ /// channel using the shortname when there are more than one
+ /// such channel.
+ ERR_TOOMANYTARGETS = 407,
+ /// "<service name> :No such service"
+ /// - Returned to a client which is attempting to send a SQUERY
+ /// to a service which does not exist.
+ ERR_NOSUCHSERVICE = 408,
+ /// ":No origin specified"
+ /// - PING or PONG message missing the originator parameter.
+ ERR_NOORIGIN = 409,
+ /// ":No recipient given (<command>)"
+ ERR_NORECIPIENT = 411,
+ /// ":No text to send"
+ ERR_NOTEXTTOSEND = 412,
+ /// "<mask> :No toplevel domain specified"
+ ERR_NOTOPLEVEL = 413,
+ /// "<mask> :Wildcard in toplevel domain"
+ ERR_WILDTOPLEVEL = 414,
+ /// "<mask> :Bad Server/host mask"
+ /// - 412 - 415 are returned by PRIVMSG to indicate that
+ /// the message wasn't delivered for some reason.
+ /// ERR_NOTOPLEVEL and ERR_WILDTOPLEVEL are errors that
+ /// are returned when an invalid use of
+ /// "PRIVMSG $<server>" or "PRIVMSG #<host>" is attempted.
+ ERR_BADMASK = 415,
+ /// "<command> :Unknown command"
+ /// - Returned to a registered client to indicate that the
+ /// command sent is unknown by the server.
+ ERR_UNKNOWNCOMMAND = 421,
+ /// ":MOTD File is missing"
+ /// - Server's MOTD file could not be opened by the server.
+ ERR_NOMOTD = 422,
+ /// "<server> :No administrative info available"
+ /// - Returned by a server in response to an ADMIN message
+ /// when there is an error in finding the appropriate
+ /// information.
+ ERR_NOADMININFO = 423,
+ /// ":File error doing <file op> on <file>"
+ /// - Generic error message used to report a failed file
+ /// operation during the processing of a message.
+ ERR_FILEERROR = 424,
+ /// ":No nickname given"
+ /// - Returned when a nickname parameter expected for a
+ /// command and isn't found.
+ ERR_NONICKNAMEGIVEN = 431,
+ /// "<nick> :Erroneous nickname"
+ /// - Returned after receiving a NICK message which contains
+ /// characters which do not fall in the defined set. See
+ /// section 2.3.1 for details on valid nicknames.
+ ERR_ERRONEUSNICKNAME = 432,
+ /// "<nick> :Nickname is already in use"
+ /// - Returned when a NICK message is processed that results
+ /// in an attempt to change to a currently existing
+ /// nickname.
+ ERR_NICKNAMEINUSE = 433,
+ /// "<nick> :Nickname collision KILL from <user>@<host>"
+ /// - Returned by a server to a client when it detects a
+ /// nickname collision (registered of a NICK that
+ /// already exists by another server).
+ ERR_NICKCOLLISION = 436,
+ /// "<nick/channel> :Nick/channel is temporarily unavailable"
+ /// - Returned by a server to a user trying to join a channel
+ /// currently blocked by the channel delay mechanism.
+ /// - Returned by a server to a user trying to change nickname
+ /// when the desired nickname is blocked by the nick delay
+ /// mechanism.
+ ERR_UNAVAILRESOURCE = 437,
+ /// "<nick> <channel> :They aren't on that channel"
+ /// - Returned by the server to indicate that the target
+ /// user of the command is not on the given channel.
+ ERR_USERNOTINCHANNEL = 441,
+ /// "<channel> :You're not on that channel"
+ /// - Returned by the server whenever a client tries to
+ /// perform a channel affecting command for which the
+ /// client isn't a member.
+ ERR_NOTONCHANNEL = 442,
+ /// "<user> <channel> :is already on channel"
+ /// - Returned when a client tries to invite a user to a
+ /// channel they are already on.
+ ERR_USERONCHANNEL = 443,
+ /// "<user> :User not logged in"
+ /// - Returned by the summon after a SUMMON command for a
+ /// user was unable to be performed since they were not
+ /// logged in.
+ ERR_NOLOGIN = 444,
+ /// ":SUMMON has been disabled"
+ /// - Returned as a response to the SUMMON command. MUST be
+ /// returned by any server which doesn't implement it.
+ ERR_SUMMONDISABLED = 445,
+ /// ":USERS has been disabled"
+ /// - Returned as a response to the USERS command. MUST be
+ /// returned by any server which does not implement it.
+ ERR_USERSDISABLED = 446,*/
+ /// ":You have not registered"
+ /// - Returned by the server to indicate that the client
+ /// MUST be registered before the server will allow it
+ /// to be parsed in detail.
+ ErrNotRegistered,/*
+ /// "<command> :Not enough parameters"
+ /// - Returned by the server by numerous commands to
+ /// indicate to the client that it didn't supply enough
+ /// parameters.
+ ERR_NEEDMOREPARAMS = 461,
+ /// ":Unauthorized command (already registered)"
+ /// - Returned by the server to any link which tries to
+ /// change part of the registered details (such as
+ /// password or user details from second USER message).
+ ERR_ALREADYREGISTERED = 462,
+ /// ":Your host isn't among the privileged"
+ /// - Returned to a client which attempts to register with
+ /// a server which does not been setup to allow
+ /// connections from the host the attempted connection
+ /// is tried.
+ ERR_NOPERMFORHOST = 463,
+ /// ":Password incorrect"
+ /// - Returned to indicate a failed attempt at registering
+ /// a connection for which a password was required and
+ /// was either not given or incorrect.
+ ERR_PASSWDMISMATCH = 464,
+ /// ":You are banned from this server"
+ /// - Returned after an attempt to connect and register
+ /// yourself with a server which has been setup to
+ /// explicitly deny connections to you.
+ ERR_YOUREBANNEDCREEP = 465,
+ /// - Sent by a server to a user to inform that access to the
+ /// server will soon be denied.
+ ERR_YOUWILLBEBANNED = 466,
+ /// "<channel> :Channel key already set"
+ ERR_KEYSET = 467,
+ /// "<channel> :Cannot join channel (+l)"
+ ERR_CHANNELISFULL = 471,
+ /// "<char> :is unknown mode char to me for <channel>"
+ ERR_UNKNOWNMODE = 472,
+ /// "<channel> :Cannot join channel (+i)"
+ ERR_INVITEONLYCHAN = 473,
+ /// "<channel> :Cannot join channel (+b)"
+ ERR_BANNEDFROMCHAN = 474,
+ /// "<channel> :Cannot join channel (+k)"
+ ERR_BADCHANNELKEY = 475,
+ /// "<channel> :Bad Channel Mask"
+ ERR_BADCHANMASK = 476,
+ /// "<channel> :Channel doesn't support modes"
+ ERR_NOCHANMODES = 477,
+ /// "<channel> <char> :Channel list is full"
+ ERR_BANLISTFULL = 478,
+ /// ":Permission Denied- You're not an IRC operator"
+ /// - Any command requiring operator privileges to operate
+ /// MUST return this error to indicate the attempt was
+ /// unsuccessful.
+ ERR_NOPRIVILEGES = 481,
+ /// "<channel> :You're not channel operator"
+ /// - Any command requiring 'chanop' privileges (such as
+ /// MODE messages) MUST return this error if the client
+ /// making the attempt is not a chanop on the specified
+ /// channel.
+ ERR_CHANOPRIVSNEEDED = 482,
+ /// ":You can't kill a server!"
+ /// - Any attempts to use the KILL command on a server
+ /// are to be refused and this error returned directly
+ /// to the client.
+ ERR_CANTKILLSERVER = 483,
+ /// ":Your connection is restricted!"
+ /// - Sent by the server to a user upon connection to indicate
+ /// the restricted nature of the connection (user mode "+r").
+ ERR_RESTRICTED = 484,
+ /// ":You're not the original channel operator"
+ /// - Any MODE requiring "channel creator" privileges MUST
+ /// return this error if the client making the attempt is not
+ /// a chanop on the specified channel.
+ ERR_UNIQOPPRIVSNEEDED = 485,
+ /// ":No O-lines for your host"
+ /// - If a client sends an OPER message and the server has
+ /// not been configured to allow connections from the
+ /// client's host as an operator, this error MUST be
+ /// returned.
+ ERR_NOOPERHOST = 491,
+ /// ":Unknown MODE flag"
+ /// - Returned by the server to indicate that a MODE
+ /// message was sent with a nickname parameter and that
+ /// the a mode flag sent was not recognized.
+ ERR_UMODEUNKNOWNFLAG = 501,
+ /// ":Cannot change mode for other users"
+ /// - Error sent to any user trying to view or change the
+ /// user mode for a user other than themselves.
+ ERR_USERSDONTMATCH = 502
+ */
+}
+
+/*
+impl ToString for Command {
+ fn to_string(&self) -> String {
+ match self {
+ PASS => "PING",
+ NICK => "NICK",
+ USER => "USER",
+ OPER => "1004",
+ MODE => "1005",
+ SERVICE => "1006",
+ QUIT => "1007",
+ SQUIT => "1008",
+ JOIN => "1009",
+ PART => "1010",
+ TOPIC => "1011",
+ NAMES => "1012",
+ LIST => "1013",
+ INVITE => "1014",
+ KICK => "1015",
+ PRIVMSG => "1016",
+ NOTICE => "1017",
+ MOTD => "1018",
+ LUSERS => "1019",
+ VERSION => "1020",
+ STATS => "1021",
+ LINKS => "1022",
+ TIME => "1023",
+ CONNECT => "1024",
+ TRACE => "1025",
+ ADMIN => "1026",
+ INFO => "1027",
+ SERVLIST => "1028",
+ SQUERY => "1029",
+ WHO => "1030",
+ WHOIS => "1031",
+ WHOWAS => "1032",
+ KILL => "1033",
+ PING => "1034",
+ PONG => "1035",
+ ERROR => "1036",
+ AWAY => "1037",
+ REHASH => "1038",
+ DIE => "1039",
+ RESTART => "1040",
+ SUMMON => "1041",
+ USERS => "1042",
+ WALLOPS => "1043",
+ USERHOST => "1044",
+ ISON => "1045",
+
+ RPL_WELCOME => "001",
+ RPL_YOURHOST => "002",
+ RPL_CREATED => "003",
+ RPL_MYINFO => "004",
+ RPL_BOUNCE => "005",
+ RPL_USERHOST => "302",
+ RPL_ISON => "303",
+ RPL_AWAY => "301",
+ RPL_UNAWAY => "305",
+ RPL_NOWAWAY => "306",
+ RPL_WHOISUSER => "311",
+ RPL_WHOISSERVER => "312",
+ RPL_WHOISOPERATOR => "313",
+ RPL_WHOISIDLE => "317",
+ RPL_ENDOFWHOIS => "318",
+ RPL_WHOISCHANNELS => "319",
+ RPL_WHOWASUSER => "314",
+ RPL_ENDOFWHOWAS => "369",
+ RPL_LISTSTART => "321",
+ RPL_LIST => "322",
+ RPL_LISTEND => "323",
+ RPL_UNIQOPIS => "325",
+ RPL_CHANNELMODEIS => "324",
+ RPL_NOTOPIC => "331",
+ RPL_TOPIC => "332",
+ RPL_INVITING => "341",
+ RPL_SUMMONING => "342",
+ RPL_INVITELIST => "346",
+ RPL_ENDOFINVITELIST => "347",
+ RPL_EXCEPTLIST => "348",
+ RPL_ENDOFEXCEPTLIST => "349",
+ RPL_VERSION => "351",
+ RPL_WHOREPLY => "352",
+ RPL_ENDOFWHO => "315",
+ RPL_NAMREPLY => "353",
+ RPL_ENDOFNAMES => "366",
+ RPL_LINKS => "364",
+ RPL_ENDOFLINKS => "365",
+ RPL_BANLIST => "367",
+ RPL_ENDOFBANLIST => "368",
+ RPL_INFO => "371",
+ RPL_ENDOFINFO => "374",
+ RPL_MOTDSTART => "375",
+ RPL_MOTD => "372",
+ RPL_ENDOFMOTD => "376",
+ RPL_YOUREOPER => "381",
+ RPL_REHASHING => "382",
+ RPL_YOURESERVICE => "383",
+ RPL_TIME => "391",
+ RPL_USERSSTART => "392",
+ RPL_USERS => "393",
+ RPL_ENDOFUSERS => "394",
+ RPL_NOUSERS => "395",
+ RPL_TRACELINK => "200",
+ RPL_TRACECONNECTING => "201",
+ RPL_TRACEHANDSHAKE => "202",
+ RPL_TRACEUNKNOWN => "203",
+ RPL_TRACEOPERATOR => "204",
+ RPL_TRACEUSER => "205",
+ RPL_TRACESERVER => "206",
+ RPL_TRACESERVICE => "207",
+ RPL_TRACENEWTYPE => "208",
+ RPL_TRACECLASS => "209",
+ RPL_TRACERECONNECT => "210",
+ RPL_TRACELOG => "261",
+ RPL_TRACEEND => "262",
+ RPL_STATSLINKINFO => "211",
+ RPL_STATSCOMMAND => "212",
+ RPL_ENDOFSTATS => "219",
+ RPL_STATSUPTIME => "242",
+ RPL_STATSOLINE => "243",
+ RPL_UMODEIS => "221",
+ RPL_SERVLIST => "234",
+ RPL_SERVLISTEND => "235",
+ RPL_LUSERCLIENT => "251",
+ RPL_LUSEROP => "252",
+ RPL_LUSERUNKNOWN => "253",
+ RPL_LUSERCHANNELS => "254",
+ RPL_LUSERME => "255",
+ RPL_ADMINME => "256",
+ RPL_ADMINLOC1 => "257",
+ RPL_ADMINLOC2 => "258",
+ RPL_ADMINEMAIL => "259",
+ RPL_TRYAGAIN => "263",
+
+ ERR_NOSUCHNICK => "401",
+ ERR_NOSUCHSERVER => "402",
+ ERR_NOSUCHCHANNEL => "403",
+ ERR_CANNOTSENDTOCHAN => "404",
+ ERR_TOOMANYCHANNELS => "405",
+ ERR_WASNOSUCHNICK => "406",
+ ERR_TOOMANYTARGETS => "407",
+ ERR_NOSUCHSERVICE => "408",
+ ERR_NOORIGIN => "409",
+ ERR_NORECIPIENT => "411",
+ ERR_NOTEXTTOSEND => "412",
+ ERR_NOTOPLEVEL => "413",
+ ERR_WILDTOPLEVEL => "414",
+ ERR_BADMASK => "415",
+ ERR_UNKNOWNCOMMAND => "421",
+ ERR_NOMOTD => "422",
+ ERR_NOADMININFO => "423",
+ ERR_FILEERROR => "424",
+ ERR_NONICKNAMEGIVEN => "431",
+ ERR_ERRONEUSNICKNAME => "432",
+ ERR_NICKNAMEINUSE => "433",
+ ERR_NICKCOLLISION => "436",
+ ERR_UNAVAILRESOURCE => "437",
+ ERR_USERNOTINCHANNEL => "441",
+ ERR_NOTONCHANNEL => "442",
+ ERR_USERONCHANNEL => "443",
+ ERR_NOLOGIN => "444",
+ ERR_SUMMONDISABLED => "445",
+ ERR_USERSDISABLED => "446",
+ ERR_NOTREGISTERED => "451",
+ ERR_NEEDMOREPARAMS => "461",
+ ERR_ALREADYREGISTERED => "462",
+ ERR_NOPERMFORHOST => "463",
+ ERR_PASSWDMISMATCH => "464",
+ ERR_YOUREBANNEDCREEP => "465",
+ ERR_YOUWILLBEBANNED => "466",
+ ERR_KEYSET => "467",
+ ERR_CHANNELISFULL => "471",
+ ERR_UNKNOWNMODE => "472",
+ ERR_INVITEONLYCHAN => "473",
+ ERR_BANNEDFROMCHAN => "474",
+ ERR_BADCHANNELKEY => "475",
+ ERR_BADCHANMASK => "476",
+ ERR_NOCHANMODES => "477",
+ ERR_BANLISTFULL => "478",
+ ERR_NOPRIVILEGES => "481",
+ ERR_CHANOPRIVSNEEDED => "482",
+ ERR_CANTKILLSERVER => "483",
+ ERR_RESTRICTED => "484",
+ ERR_UNIQOPPRIVSNEEDED => "485",
+ ERR_NOOPERHOST => "491",
+ ERR_UMODEUNKNOWNFLAG => "501",
+ }.to_owned()
+ }
+}*/
+
+
+/*
+impl FromStr for Command {
+ fn from_str(s: &str) -> Option<Command> {
+ use self::Command::*;
+ match s {
+ "PASS" => Some(PASS),
+ "NICK" => Some(NICK),
+ "USER" => Some(USER),
+ "OPER" => Some(OPER),
+ "MODE" => Some(MODE),
+ "SERVICE" => Some(SERVICE),
+ "QUIT" => Some(QUIT),
+ "SQUIT" => Some(SQUIT),
+ "JOIN" => Some(JOIN),
+ "PART" => Some(PART),
+ "TOPIC" => Some(TOPIC),
+ "NAMES" => Some(NAMES),
+ "LIST" => Some(LIST),
+ "INVITE" => Some(INVITE),
+ "KICK" => Some(KICK),
+ "PRIVMSG" => Some(PRIVMSG),
+ "NOTICE" => Some(NOTICE),
+ "MOTD" => Some(MOTD),
+ "LUSERS" => Some(LUSERS),
+ "VERSION" => Some(VERSION),
+ "STATS" => Some(STATS),
+ "LINKS" => Some(LINKS),
+ "TIME" => Some(TIME),
+ "CONNECT" => Some(CONNECT),
+ "TRACE" => Some(TRACE),
+ "ADMIN" => Some(ADMIN),
+ "INFO" => Some(INFO),
+ "SERVLIST" => Some(SERVLIST),
+ "SQUERY" => Some(SQUERY),
+ "WHO" => Some(WHO),
+ "WHOIS" => Some(WHOIS),
+ "WHOWAS" => Some(WHOWAS),
+ "KILL" => Some(KILL),
+ "PING" => Some(PING),
+ "PONG" => Some(PONG),
+ "ERROR" => Some(ERROR),
+ "AWAY" => Some(AWAY),
+ "REHASH" => Some(REHASH),
+ "DIE" => Some(DIE),
+ "RESTART" => Some(RESTART),
+ "SUMMON" => Some(SUMMON),
+ "USERS" => Some(USERS),
+ "WALLOPS" => Some(WALLOPS),
+ "USERHOST" => Some(USERHOST),
+ "ISON" => Some(ISON),
+ _ => None
+ }
+ }
+}*/
+
+/// If you hoped it couldn't get any uglier... I'm sorry, it does.
+/// Why a giant match? API.
+///
+/// I tried structuring it as a bunch of structs that impl a `Command` trait,
+/// but the user would have to use Any and lots of cats. Also, extensibility isn't
+/// really a goal; the IRC protocol doesn't seem to evolve very fast.
+///
+/// Granted, I *could* have used a phf-map to map to functions to parse this, which
+/// - while more readable - shouldn't have resulted in performance gains.
+///
+/// Please don't cry.
+
+impl<'a> Command<'a> {
+ pub fn from_message(msg: &'a Message) -> Option<Command<'a>> {
+ match &msg.command.as_ref()[..] {
+ "NOTICE" => msg.content.get(0).and_then(|c| msg.content.get(1).map(|t|
+ Command::Notice { to: Cow::Borrowed(&t), content: Cow::Borrowed(&c) })),
+ "PING" => msg.content.get(0).and_then(|s1| msg.content.get(1).map(|s2|
+ Command::Ping { server1: Some(Cow::Borrowed(&s1)), server2: Some(Cow::Borrowed(&s2)) })),
+ "451" => Some(Command::ErrNotRegistered),
+ _ => unimplemented!()
+ }
+ }
+ pub fn to_message(&'a self) -> Message {
+ match self {
+ &Command::Ping { ref server1, ref server2 } => {
+ let mut c = Vec::new();
+ if let &Some(ref s) = server1 { c.push(s.clone()) }
+ if let &Some(ref s) = server2 { c.push(s.clone()) }
+ Message::new(None, Cow::Owned("PING".to_owned()), c, None, MsgType::Irc)
+ },
+ &Command::Pong { ref server1, ref server2 } => {
+ let mut c = Vec::new();
+ if let &Some(ref s) = server1 { c.push(s.clone()) }
+ if let &Some(ref s) = server2 { c.push(s.clone()) }
+ Message::new(None, Cow::Owned("PONG".to_owned()), c, None, MsgType::Irc)
+ },
+ _ => unimplemented!()
+ }
+ }
+
+ //pub fn is_reply(&self) -> bool { let i = *self as uint; i >= 200 && i <= 399 }
+ //pub fn is_error(&self) -> bool { let i = *self as uint; i >= 400 && i <= 599 }
+}
+
+pub fn join(v: Vec<String>, from: usize) -> String {
+ let mut msg = if v[from].chars().next().unwrap() == ':' {
+ v[from][1..].to_owned()
+ } else { v[from].clone() };
+ for m in v.iter().skip(from + 1) {
+ msg.push_str(" ");
+ msg.push_str(m.trim_right());
+ }
+ msg
+}
+
+/*pub struct PrivMsg {
+ pub from: Ident,
+ pub to: String,
+ pub content: String
+}
+
+impl ParseResult for PrivMsg {
+ fn parse(message: Message) -> Option<PrivMsg> {
+ let from = Ident::parse(message.prefix.unwrap()[]);
+ let to = message.content[0].clone();
+ match from {
+ Some(from) => Some(PrivMsg {
+ from: from,
+ to: to,
+ content: join(message.content, 1)
+ }),
+ None => None
+ }
+ }
+}*/
+
+#[cfg(test)]
+mod test {
+ use std::borrow::{ Cow, ToOwned };
+ use message::{ Message, MsgType };
+
+ #[test]
+ fn parse_message() {
+ let a = ":a.b.c NOTICE AUTH :*** Looking up your hostname...";
+ // I'm not even kidding...
+ let a2 = Message::new(
+ Some(Cow::Owned("a.b.c".to_owned())),
+ Cow::Owned("NOTICE".to_owned()),
+ vec![Cow::Owned("AUTH".to_owned())],
+ Some(Cow::Owned("*** Looking up your hostname...".to_owned())),
+ MsgType::Irc
+ );
+ assert_eq!(a.parse::<Message>().unwrap(), a2.clone());
+ assert_eq!(a2.to_string(), a);
+
+ let b = ":d PRIVMSG You :\u{1}ACTION sends you funny pictures of cats!\u{1}";
+ let b2 = Message::new(
+ Some(Cow::Owned("d".to_owned())),
+ Cow::Owned("PRIVMSG".to_owned()),
+ vec![Cow::Owned("You".to_owned())],
+ Some(Cow::Owned("\u{1}ACTION sends you funny pictures of cats!\u{1}".to_owned())),
+ MsgType::Ctcp
+ );
+ assert_eq!(b.parse::<Message>().unwrap(), b2.clone());
+ assert_eq!(b2.to_string(), b);
+ }
+
+}
diff --git a/src/server.rs b/src/server.rs
index 4c4479a..8f48938 100644
--- a/src/server.rs
+++ b/src/server.rs
@@ -1,139 +1,170 @@
use std::io::{
- BufferedReader,
- TcpStream,
- IoError
+ self,
+ Write,
+ Read,
+ BufRead,
+ BufReader,
};
-use std::sync::Arc;
-use std::sync::Mutex;
+use std::net::TcpStream;
-use std::borrow::ToOwned;
+use message;
+use message::{ Command, Message };
-use callback::Callback;
-use event;
-use event::Event;
+#[cfg(feature = "ssl")]
+use openssl::ssl::{ SslContext, SslMethod, SslStream };
-#[deriving(Show, PartialEq, Eq, Clone)]
-pub enum Failure {
- AlreadyConnected,
- NotConnected,
- Io(IoError)
+/// Yes, I don't like the name either, but it's private, so...
+enum StreamKind {
+ Plain(TcpStream),
+ #[cfg(feature = "ssl")]
+ Ssl(SslStream)
+}
+
+impl Write for StreamKind {
+ fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
+ match *self {
+ StreamKind::Plain(ref mut s) => s.write(buf),
+ #[cfg(feature = "ssl")]
+ StreamKind::Ssl(ref mut s) => s.write(buf)
+ }
+ }
+
+ fn flush(&mut self) -> io::Result<()> {
+ match *self {
+ StreamKind::Plain(ref mut s) => s.flush(),
+ #[cfg(feature = "ssl")]
+ StreamKind::Ssl(ref mut s) => s.flush()
+ }
+ }
+}
+
+impl Read for StreamKind {
+ fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
+ match *self {
+ StreamKind::Plain(ref mut s) => s.read(buf),
+ #[cfg(feature = "ssl")]
+ StreamKind::Ssl(ref mut s) => s.read(buf)
+ }
+ }
}
-#[deriving(Clone)]
pub struct Server {
- stream: Arc<Mutex<Option<TcpStream>>>,
- pub events: Arc<Mutex<Callback<(Server, Event)>>>,
+ stream: Option<StreamKind>,
}
impl Server {
pub fn new() -> Server {
Server {
- stream: Arc::new(Mutex::new(None)),
- events: {
- let mut c = Callback::new();
- c.register(&(Server::handle_event as fn((Server,Event))));
- Arc::new(Mutex::new(c))
- }
+ stream: None
}
}
- fn handle_event(arg: (Server, Event)) {
- let (mut server, event) = arg;
- match event.command[] {
- event::PING => {
- server.sendraw(format!("PONG {}", event.content).as_slice(), true).unwrap();
- }
- _ => ()
+ fn handle_event(&mut self, msg: &message::Message) {
+ if *msg.command == "PING" {
+ let _ = self.send(Command::Pong { server1: msg.suffix.clone(), server2: None }.to_message());
}
}
- pub fn connect(&mut self, host: String, port: u16) -> Result<(), Failure> {
+ pub fn connect(&mut self, host: String, port: u16) -> ::Result<()> {
+ let s = &mut self.stream;
+ match *s { Some(_) => return Err(::IrscError::AlreadyConnected), _ => () };
+ *s = match TcpStream::connect((host.as_ref(), port)) {
+ Ok(tcp) => Some(StreamKind::Plain(tcp)),
+ Err(e) => return Err(::IrscError::Io(e))
+ };
+
+ Ok(())
+ }
+
+ #[cfg(feature = "ssl")]
+ pub fn connect_ssl(&mut self, host: String, port: u16) -> ::Result<()> {
let mut s = self.stream.lock();
- match *s { Some(_) => return Err(Failure::AlreadyConnected), _ => () };
- *s = match TcpStream::connect((host.as_slice(), port)) {
+ match *s { Some(_) => return Err(::IrscError::AlreadyConnected), _ => () };
+ let tcp_stream = match TcpStream::connect((host.as_ref(), port)) {
Ok(tcp) => Some(tcp),
- Err(e) => return Err(Failure::Io(e))
+ Err(e) => return Err(::IrscError::Io(e))
};
+ let ssl = SslContext::new(SslMethod::Tlsv1);
+ let ssl_stream = SslStream::new(&ssl, tcp_stream);
+ *s = ssl_stream;
+
Ok(())
}
#[inline]
- fn sendraw(&mut self, s: &str, newline: bool) -> Result<(), Failure> {
- info!("OUT: {}", s);
- let mut locked_stream = self.stream.lock();
- if locked_stream.is_some() {
- locked_stream.as_mut().map(|stream| {
- match stream.write_str(s) {
- Ok(_) => match { if newline { stream.write_str("\r\n") } else { Ok(()) } } {
- Ok(_) => match stream.flush() {
- Ok(_) => Ok(()),
- Err(e) => return Err(Failure::Io(e))
+ fn sendraw(&mut self, s: &str, newline: bool) -> ::Result<usize> {
+ info!(">> {}", s);
+ if ::DEBUG && s.len() > 510 {
+ panic!("Message too long, kitties will die if this runs in release mode. Msg: {}", s)
+ }
+ let stream = &mut self.stream;
+ if stream.is_some() {
+ stream.as_mut().map(|stream| {
+ match stream.write(s.as_bytes()) {
+ Ok(a) => match { if newline { stream.write(b"\r\n").map(|s| s + a) } else { Ok(a) } } {
+ Ok(b) => match stream.flush() {
+ Ok(_) => Ok(b),
+ Err(e) => return Err(::IrscError::Io(e))
},
- Err(e) => return Err(Failure::Io(e))
+ Err(e) => return Err(::IrscError::Io(e))
},
- Err(e) => return Err(Failure::Io(e))
+ Err(e) => return Err(::IrscError::Io(e))
}
}).unwrap()
} else {
- Err(Failure::NotConnected)
+ Err(::IrscError::NotConnected)
}
}
- pub fn join(&mut self, channel: &str) -> Result<(), Failure> {
- self.sendraw(format!("JOIN {}", channel).as_slice(), true)
+ pub fn send(&mut self, msg: message::Message) -> ::Result<usize> {
+ self.sendraw(&msg.to_string(), true)
}
- pub fn nick(&mut self, nick: &str) -> Result<(), Failure> {
- self.sendraw(format!("NICK {}", nick).as_slice(), true)
+ pub fn join(&mut self, channel: &str) -> ::Result<usize> {
+ self.sendraw(format!("JOIN {}", channel).as_ref(), true)
}
- pub fn user(&mut self, username: &str, hostname: &str, servername: &str, realname: &str) -> Result<(), Failure> {
- self.sendraw(format!("USER {} {} {} :{}", username, hostname, servername, realname).as_slice(), true)
+ pub fn part(&mut self, channel: &str) -> ::Result<usize> {
+ self.sendraw(format!("PART {}", channel).as_ref(), true)
}
- pub fn password(&mut self, password: &str) -> Result<(), Failure> {
- self.sendraw(format!("PASS {}", password).as_slice(), true)
+ pub fn nick(&mut self, nick: &str) -> ::Result<usize> {
+ self.sendraw(format!("NICK {}", nick).as_ref(), true)
}
- pub fn msg(&mut self, target: &str, message: &str) -> Result<(), Failure> {
- self.sendraw(format!("PRIVMSG {} :{}", target, message).as_slice(), true)
+ pub fn user(&mut self, username: &str, hostname: &str, servername: &str, realname: &str) -> ::Result<usize> {
+ self.sendraw(format!("USER {} {} {} :{}", username, hostname, servername, realname).as_ref(), true)
}
- pub fn listen(&mut self) -> Result<(), Failure> {
- let stream = {
- let lock = self.stream.lock();
- match *lock {
- Some(ref s) => s.clone(),
- None => return Err(Failure::NotConnected)
- }
- };
-
- let mut reader = BufferedReader::new(stream);
- loop {
- let line = reader.read_line().unwrap();
- let mut parts = line.as_slice().split(' ').collect::<Vec<&str>>();
+ pub fn password(&mut self, password: &str) -> ::Result<usize> {
+ self.sendraw(format!("PASS {}", password).as_ref(), true)
+ }
- info!("IN: {}", line);
+ pub fn msg(&mut self, target: &str, message: &str) -> ::Result<usize> {
+ self.sendraw(format!("PRIVMSG {} :{}", target, message).as_ref(), true)
+ }
- if parts.len() == 0 {
- continue;
+ pub fn listen(&mut self, events: &[fn(&mut Server, &Message)]) -> ::Result<()> {
+ let mut reader = BufReader::new(match self.stream {
+ Some(StreamKind::Plain(ref s)) => (*s).try_clone().unwrap(),
+ #[cfg(feature = "ssl")]
+ Some(StreamKind::Ssl(ref s)) => (*s).try_clone().unwrap(),
+ None => return Err(::IrscError::NotConnected)
+ });
+
+ for line in reader.lines() {
+ let line = line.unwrap().parse();
+
+ if let Ok(msg) = line {
+ println!("{:?}", msg);
+ self.handle_event(&msg);
+ for e in events.iter() {
+ e(self, &msg)
+ }
}
-
- // if message has a prefix
- let prefix = if parts[0].chars().next().unwrap() == ':' {
- parts.remove(0).unwrap()
- } else { "" };
-
- let cmd = parts.remove(0).unwrap();
- let event = Event {
- prefix: prefix.to_owned(),
- command: cmd.to_owned(),
- content: parts.into_iter().map(|s| s.to_owned()).collect()
- };
-
- self.events.lock().fire(&(self.clone(), event));
}
+ Ok(())
}
}