summaryrefslogtreecommitdiffstats
path: root/src/plugins
diff options
context:
space:
mode:
Diffstat (limited to 'src/plugins')
-rw-r--r--src/plugins/currency.rs28
-rw-r--r--src/plugins/emoji.rs25
-rw-r--r--src/plugins/factoids/database.rs88
-rw-r--r--src/plugins/factoids/mod.rs187
-rw-r--r--src/plugins/factoids/utils.rs6
-rw-r--r--src/plugins/help.rs16
-rw-r--r--src/plugins/keepnick.rs29
-rw-r--r--src/plugins/mod.rs23
-rw-r--r--src/plugins/tell/mod.rs32
-rw-r--r--src/plugins/url.rs63
10 files changed, 286 insertions, 211 deletions
diff --git a/src/plugins/currency.rs b/src/plugins/currency.rs
index 958c8e2..53a245c 100644
--- a/src/plugins/currency.rs
+++ b/src/plugins/currency.rs
@@ -6,7 +6,6 @@ use std::io::Read;
use std::num::ParseFloatError;
use irc::client::prelude::*;
-use irc::error::IrcError;
use self::reqwest::Client;
use self::reqwest::header::Connection;
@@ -14,6 +13,10 @@ use self::serde_json::Value;
use plugin::*;
+use error::FrippyError;
+use error::ErrorKind as FrippyErrorKind;
+use failure::ResultExt;
+
#[derive(PluginName, Default, Debug)]
pub struct Currency;
@@ -124,20 +127,28 @@ impl Plugin for Currency {
ExecutionStatus::Done
}
- fn execute_threaded(&self, _: &IrcClient, _: &Message) -> Result<(), IrcError> {
+ fn execute_threaded(&self, _: &IrcClient, _: &Message) -> Result<(), FrippyError> {
panic!("Currency does not implement the execute function!")
}
- fn command(&self, client: &IrcClient, mut command: PluginCommand) -> Result<(), IrcError> {
+ fn command(&self, client: &IrcClient, mut command: PluginCommand) -> Result<(), FrippyError> {
if command.tokens.is_empty() {
- return client.send_notice(&command.source, &self.invalid_command(client));
+ return Ok(client
+ .send_notice(&command.source, &self.invalid_command(client))
+ .context(FrippyErrorKind::Connection)?);
}
match command.tokens[0].as_ref() {
- "help" => client.send_notice(&command.source, &self.help(client)),
+ "help" => Ok(client
+ .send_notice(&command.source, &self.help(client))
+ .context(FrippyErrorKind::Connection)?),
_ => match self.convert(client, &mut command) {
- Ok(msg) => client.send_privmsg(&command.target, &msg),
- Err(msg) => client.send_notice(&command.source, &msg),
+ Ok(msg) => Ok(client
+ .send_privmsg(&command.target, &msg)
+ .context(FrippyErrorKind::Connection)?),
+ Err(msg) => Ok(client
+ .send_notice(&command.source, &msg)
+ .context(FrippyErrorKind::Connection)?),
},
}
}
@@ -153,6 +164,3 @@ impl Plugin for Currency {
}
}
}
-
-#[cfg(test)]
-mod tests {}
diff --git a/src/plugins/emoji.rs b/src/plugins/emoji.rs
index a4276f4..f1d9376 100644
--- a/src/plugins/emoji.rs
+++ b/src/plugins/emoji.rs
@@ -3,10 +3,14 @@ extern crate unicode_names;
use std::fmt;
use irc::client::prelude::*;
-use irc::error::IrcError;
use plugin::*;
+use error::FrippyError;
+use error::ErrorKind as FrippyErrorKind;
+use failure::Fail;
+use failure::ResultExt;
+
struct EmojiHandle {
symbol: char,
count: i32,
@@ -100,21 +104,23 @@ impl Plugin for Emoji {
.send_privmsg(message.response_target().unwrap(), &self.emoji(content))
{
Ok(_) => ExecutionStatus::Done,
- Err(e) => ExecutionStatus::Err(Box::new(e)),
+ Err(e) => ExecutionStatus::Err(e.context(FrippyErrorKind::Connection).into()),
},
_ => ExecutionStatus::Done,
}
}
- fn execute_threaded(&self, _: &IrcClient, _: &Message) -> Result<(), IrcError> {
+ fn execute_threaded(&self, _: &IrcClient, _: &Message) -> Result<(), FrippyError> {
panic!("Emoji should not use threading")
}
- fn command(&self, client: &IrcClient, command: PluginCommand) -> Result<(), IrcError> {
- client.send_notice(
- &command.source,
- "This Plugin does not implement any commands.",
- )
+ fn command(&self, client: &IrcClient, command: PluginCommand) -> Result<(), FrippyError> {
+ Ok(client
+ .send_notice(
+ &command.source,
+ "This Plugin does not implement any commands.",
+ )
+ .context(FrippyErrorKind::Connection)?)
}
fn evaluate(&self, _: &IrcClient, command: PluginCommand) -> Result<String, String> {
@@ -126,6 +132,3 @@ impl Plugin for Emoji {
}
}
}
-
-#[cfg(test)]
-mod tests {}
diff --git a/src/plugins/factoids/database.rs b/src/plugins/factoids/database.rs
index 88aa0fd..b1fe8dd 100644
--- a/src/plugins/factoids/database.rs
+++ b/src/plugins/factoids/database.rs
@@ -13,13 +13,12 @@ use diesel::mysql::MysqlConnection;
use r2d2::Pool;
#[cfg(feature = "mysql")]
use r2d2_diesel::ConnectionManager;
+#[cfg(feature = "mysql")]
+use failure::ResultExt;
use chrono::NaiveDateTime;
-pub enum DbResponse {
- Success,
- Failed(&'static str),
-}
+use super::error::*;
#[cfg_attr(feature = "mysql", derive(Queryable))]
#[derive(Clone, Debug)]
@@ -42,15 +41,15 @@ pub struct NewFactoid<'a> {
}
pub trait Database: Send {
- fn insert_factoid(&mut self, factoid: &NewFactoid) -> DbResponse;
- fn get_factoid(&self, name: &str, idx: i32) -> Option<Factoid>;
- fn delete_factoid(&mut self, name: &str, idx: i32) -> DbResponse;
- fn count_factoids(&self, name: &str) -> Result<i32, &'static str>;
+ fn insert_factoid(&mut self, factoid: &NewFactoid) -> Result<(), FactoidsError>;
+ fn get_factoid(&self, name: &str, idx: i32) -> Result<Factoid, FactoidsError>;
+ fn delete_factoid(&mut self, name: &str, idx: i32) -> Result<(), FactoidsError>;
+ fn count_factoids(&self, name: &str) -> Result<i32, FactoidsError>;
}
// HashMap
impl Database for HashMap<(String, i32), Factoid> {
- fn insert_factoid(&mut self, factoid: &NewFactoid) -> DbResponse {
+ fn insert_factoid(&mut self, factoid: &NewFactoid) -> Result<(), FactoidsError> {
let factoid = Factoid {
name: String::from(factoid.name),
idx: factoid.idx,
@@ -61,23 +60,25 @@ impl Database for HashMap<(String, i32), Factoid> {
let name = factoid.name.clone();
match self.insert((name, factoid.idx), factoid) {
- None => DbResponse::Success,
- Some(_) => DbResponse::Failed("Factoid was overwritten"),
+ None => Ok(()),
+ Some(_) => Err(ErrorKind::Duplicate)?,
}
}
- fn get_factoid(&self, name: &str, idx: i32) -> Option<Factoid> {
- self.get(&(String::from(name), idx)).cloned()
+ fn get_factoid(&self, name: &str, idx: i32) -> Result<Factoid, FactoidsError> {
+ Ok(self.get(&(String::from(name), idx))
+ .cloned()
+ .ok_or(ErrorKind::NotFound)?)
}
- fn delete_factoid(&mut self, name: &str, idx: i32) -> DbResponse {
+ fn delete_factoid(&mut self, name: &str, idx: i32) -> Result<(), FactoidsError> {
match self.remove(&(String::from(name), idx)) {
- Some(_) => DbResponse::Success,
- None => DbResponse::Failed("Factoid not found"),
+ Some(_) => Ok(()),
+ None => Err(ErrorKind::NotFound)?,
}
}
- fn count_factoids(&self, name: &str) -> Result<i32, &'static str> {
+ fn count_factoids(&self, name: &str) -> Result<i32, FactoidsError> {
Ok(self.iter().filter(|&(&(ref n, _), _)| n == name).count() as i32)
}
}
@@ -102,38 +103,31 @@ use self::schema::factoids;
#[cfg(feature = "mysql")]
impl Database for Arc<Pool<ConnectionManager<MysqlConnection>>> {
- fn insert_factoid(&mut self, factoid: &NewFactoid) -> DbResponse {
+ fn insert_factoid(&mut self, factoid: &NewFactoid) -> Result<(), FactoidsError> {
use diesel;
- let conn = &*self.get().expect("Failed to get connection");
- match diesel::insert_into(factoids::table)
+ let conn = &*self.get().context(ErrorKind::NoConnection)?;
+ diesel::insert_into(factoids::table)
.values(factoid)
.execute(conn)
- {
- Ok(_) => DbResponse::Success,
- Err(e) => {
- error!("DB Insertion Error: {}", e);
- DbResponse::Failed("Failed to add factoid")
- }
- }
+ .context(ErrorKind::MysqlError)?;
+
+ Ok(())
}
- fn get_factoid(&self, name: &str, idx: i32) -> Option<Factoid> {
- let conn = &*self.get().expect("Failed to get connection");
- match factoids::table.find((name, idx)).first(conn) {
- Ok(f) => Some(f),
- Err(e) => {
- error!("DB Count Error: {}", e);
- None
- }
- }
+ fn get_factoid(&self, name: &str, idx: i32) -> Result<Factoid, FactoidsError> {
+ let conn = &*self.get().context(ErrorKind::NoConnection)?;
+ Ok(factoids::table
+ .find((name, idx))
+ .first(conn)
+ .context(ErrorKind::MysqlError)?)
}
- fn delete_factoid(&mut self, name: &str, idx: i32) -> DbResponse {
+ fn delete_factoid(&mut self, name: &str, idx: i32) -> Result<(), FactoidsError> {
use diesel;
use self::factoids::columns;
- let conn = &*self.get().expect("Failed to get connection");
+ let conn = &*self.get().context(ErrorKind::NoConnection)?;
match diesel::delete(
factoids::table
.filter(columns::name.eq(name))
@@ -142,22 +136,19 @@ impl Database for Arc<Pool<ConnectionManager<MysqlConnection>>> {
{
Ok(v) => {
if v > 0 {
- DbResponse::Success
+ Ok(())
} else {
- DbResponse::Failed("Could not find any factoid with that name")
+ Err(ErrorKind::NotFound)?
}
}
- Err(e) => {
- error!("DB Deletion Error: {}", e);
- DbResponse::Failed("Failed to delete factoid")
- }
+ Err(e) => Err(e).context(ErrorKind::MysqlError)?,
}
}
- fn count_factoids(&self, name: &str) -> Result<i32, &'static str> {
+ fn count_factoids(&self, name: &str) -> Result<i32, FactoidsError> {
use diesel;
- let conn = &*self.get().expect("Failed to get connection");
+ let conn = &*self.get().context(ErrorKind::NoConnection)?;
let count: Result<i64, _> = factoids::table
.filter(factoids::columns::name.eq(name))
.count()
@@ -166,10 +157,7 @@ impl Database for Arc<Pool<ConnectionManager<MysqlConnection>>> {
match count {
Ok(c) => Ok(c as i32),
Err(diesel::NotFound) => Ok(0),
- Err(e) => {
- error!("DB Count Error: {}", e);
- Err("Database Error")
- }
+ Err(e) => Err(e).context(ErrorKind::MysqlError)?,
}
}
}
diff --git a/src/plugins/factoids/mod.rs b/src/plugins/factoids/mod.rs
index 806bb7e..2f3690f 100644
--- a/src/plugins/factoids/mod.rs
+++ b/src/plugins/factoids/mod.rs
@@ -5,21 +5,22 @@ use std::str::FromStr;
use std::sync::Mutex;
use self::rlua::prelude::*;
use irc::client::prelude::*;
-use irc::error::IrcError;
-use error::FrippyError;
-use error::PluginError;
-use failure::Fail;
use time;
use chrono::NaiveDateTime;
use plugin::*;
pub mod database;
-use self::database::{Database, DbResponse};
+use self::database::Database;
mod utils;
use self::utils::*;
+use failure::ResultExt;
+use error::ErrorKind as FrippyErrorKind;
+use error::FrippyError;
+use self::error::*;
+
static LUA_SANDBOX: &'static str = include_str!("sandbox.lua");
#[derive(PluginName)]
@@ -43,8 +44,13 @@ impl<T: Database> Factoids<T> {
}
}
- fn create_factoid(&self, name: &str, content: &str, author: &str) -> Result<&str, FrippyError> {
- let count = try_lock!(self.factoids).count_factoids(name).map_err(|e| PluginError::Factoids { error: e.to_owned() })?;
+ fn create_factoid(
+ &self,
+ name: &str,
+ content: &str,
+ author: &str,
+ ) -> Result<&str, FactoidsError> {
+ let count = try_lock!(self.factoids).count_factoids(name)?;
let tm = time::now().to_timespec();
let factoid = database::NewFactoid {
@@ -55,15 +61,14 @@ impl<T: Database> Factoids<T> {
created: NaiveDateTime::from_timestamp(tm.sec, 0u32),
};
- match try_lock!(self.factoids).insert_factoid(&factoid) {
- DbResponse::Success => Ok("Successfully added"),
- DbResponse::Failed(e) => Err(PluginError::Factoids { error: e.to_owned() })?,
- }
+ Ok(try_lock!(self.factoids)
+ .insert_factoid(&factoid)
+ .map(|()| "Successfully added!")?)
}
- fn add(&self, client: &IrcClient, command: &mut PluginCommand) -> Result<&str, FrippyError> {
+ fn add(&self, command: &mut PluginCommand) -> Result<&str, FactoidsError> {
if command.tokens.len() < 2 {
- return Ok(self.invalid_command(client, command).map(|()| "")?);
+ Err(ErrorKind::InvalidCommand)?;
}
let name = command.tokens.remove(0);
@@ -72,45 +77,41 @@ impl<T: Database> Factoids<T> {
Ok(self.create_factoid(&name, &content, &command.source)?)
}
- fn add_from_url(
- &self,
- client: &IrcClient,
- command: &mut PluginCommand,
- ) -> Result<&str, FrippyError> {
+ fn add_from_url(&self, command: &mut PluginCommand) -> Result<&str, FactoidsError> {
if command.tokens.len() < 2 {
- return Ok(self.invalid_command(client, command).map(|()| "")?);
+ Err(ErrorKind::InvalidCommand)?;
}
let name = command.tokens.remove(0);
let url = &command.tokens[0];
- let content = ::utils::download(url, Some(1024))?;
+ let content = ::utils::download(url, Some(1024)).context(ErrorKind::Download)?;
Ok(self.create_factoid(&name, &content, &command.source)?)
}
- fn remove(&self, client: &IrcClient, command: &mut PluginCommand) -> Result<&str, FrippyError> {
+ fn remove(&self, command: &mut PluginCommand) -> Result<&str, FactoidsError> {
if command.tokens.len() < 1 {
- return Ok(self.invalid_command(client, command).map(|()| "")?);
+ Err(ErrorKind::InvalidCommand)?;
}
let name = command.tokens.remove(0);
- let count = try_lock!(self.factoids).count_factoids(&name).map_err(|e| PluginError::Factoids { error: e.to_owned() } )?;
+ let count = try_lock!(self.factoids).count_factoids(&name)?;
match try_lock!(self.factoids).delete_factoid(&name, count - 1) {
- DbResponse::Success => Ok("Successfully removed"),
- DbResponse::Failed(e) => Err(PluginError::Factoids { error: e.to_owned() })?,
+ Ok(()) => Ok("Successfully removed"),
+ Err(e) => Err(e)?,
}
}
- fn get(&self, client: &IrcClient, command: &PluginCommand) -> Result<String, FrippyError> {
+ fn get(&self, command: &PluginCommand) -> Result<String, FactoidsError> {
let (name, idx) = match command.tokens.len() {
- 0 => return Ok(self.invalid_command(client, command).map(|()| String::new())?),
+ 0 => Err(ErrorKind::InvalidCommand)?,
1 => {
let name = &command.tokens[0];
- let count = try_lock!(self.factoids).count_factoids(name).map_err(|e| PluginError::Factoids { error: e.to_owned() } )?;
+ let count = try_lock!(self.factoids).count_factoids(name)?;
if count < 1 {
- Err(PluginError::Factoids { error: format!("{} does not exist", name) })?;
+ Err(ErrorKind::NotFound)?;
}
(name, count - 1)
@@ -119,61 +120,55 @@ impl<T: Database> Factoids<T> {
let name = &command.tokens[0];
let idx = match i32::from_str(&command.tokens[1]) {
Ok(i) => i,
- Err(_) => Err(PluginError::Factoids { error: String::from("Invalid index") })?,
+ Err(_) => Err(ErrorKind::InvalidCommand)?,
};
(name, idx)
}
};
- let factoid = match try_lock!(self.factoids).get_factoid(name, idx) {
- Some(v) => v,
- None => Err(PluginError::Factoids { error: format!("{}~{} does not exist", name, idx) })?,
- };
+ let factoid = try_lock!(self.factoids)
+ .get_factoid(name, idx)
+ .context(ErrorKind::NotFound)?;
let message = factoid.content.replace("\n", "|").replace("\r", "");
Ok(format!("{}: {}", factoid.name, message))
}
- fn info(&self, client: &IrcClient, command: &PluginCommand) -> Result<String, FrippyError> {
+ fn info(&self, command: &PluginCommand) -> Result<String, FactoidsError> {
match command.tokens.len() {
- 0 => Ok(self.invalid_command(client, command).map(|()| String::new())?),
+ 0 => Err(ErrorKind::InvalidCommand)?,
1 => {
let name = &command.tokens[0];
- let count = try_lock!(self.factoids).count_factoids(name).map_err(|e| PluginError::Factoids { error: e.to_owned() } )?;
+ let count = try_lock!(self.factoids).count_factoids(name)?;
Ok(match count {
- 0 => Err(PluginError::Factoids { error: format!("{} does not exist", name) })?,
+ 0 => Err(ErrorKind::NotFound)?,
1 => format!("There is 1 version of {}", name),
_ => format!("There are {} versions of {}", count, name),
})
}
_ => {
let name = &command.tokens[0];
- let idx = i32::from_str(&command.tokens[1]).map_err(|_| PluginError::Factoids { error: String::from("Invalid index") })?;
-
- let factoid = match try_lock!(self.factoids).get_factoid(name, idx) {
- Some(v) => v,
- None => return Ok(format!("{}~{} does not exist", name, idx)),
- };
+ let idx = i32::from_str(&command.tokens[1]).context(ErrorKind::InvalidIndex)?;
+ let factoid = try_lock!(self.factoids).get_factoid(name, idx)?;
- Ok(format!("{}: Added by {} at {} UTC", name, factoid.author, factoid.created))
+ Ok(format!(
+ "{}: Added by {} at {} UTC",
+ name, factoid.author, factoid.created
+ ))
}
}
}
- fn exec(
- &self,
- client: &IrcClient,
- mut command: PluginCommand,
- ) -> Result<String, FrippyError> {
+ fn exec(&self, mut command: PluginCommand) -> Result<String, FactoidsError> {
if command.tokens.len() < 1 {
- Ok(self.invalid_command(client, &command).map(|()| String::new())?)
+ Err(ErrorKind::InvalidIndex)?
} else {
let name = command.tokens.remove(0);
- let count = try_lock!(self.factoids).count_factoids(&name).map_err(|e| PluginError::Factoids { error: e.to_owned() } )?;
- let factoid = try_lock!(self.factoids).get_factoid(&name, count - 1).ok_or(PluginError::Factoids { error: format!("The factoid \"{}\" does not exist", name) })?;
+ let count = try_lock!(self.factoids).count_factoids(&name)?;
+ let factoid = try_lock!(self.factoids).get_factoid(&name, count - 1)?;
let content = factoid.content;
let value = if content.starts_with('>') {
@@ -225,10 +220,6 @@ impl<T: Database> Factoids<T> {
Ok(output.join("|"))
}
-
- fn invalid_command(&self, client: &IrcClient, command: &PluginCommand) -> Result<(), IrcError> {
- client.send_notice(&command.source, "Invalid Command")
- }
}
impl<T: Database> Plugin for Factoids<T> {
@@ -243,7 +234,7 @@ impl<T: Database> Plugin for Factoids<T> {
}
}
- fn execute_threaded(&self, client: &IrcClient, message: &Message) -> Result<(), IrcError> {
+ fn execute_threaded(&self, client: &IrcClient, message: &Message) -> Result<(), FrippyError> {
if let Command::PRIVMSG(_, mut content) = message.command.clone() {
content.remove(0);
@@ -255,18 +246,22 @@ impl<T: Database> Plugin for Factoids<T> {
tokens: t,
};
- match self.exec(client, c) {
- Ok(f) => client.send_privmsg(&message.response_target().unwrap(), &f),
- Err(_) => Ok(()),
- }
+ Ok(match self.exec(c) {
+ Ok(f) => client
+ .send_privmsg(&message.response_target().unwrap(), &f)
+ .context(FrippyErrorKind::Connection)?,
+ Err(_) => (),
+ })
} else {
Ok(())
}
}
- fn command(&self, client: &IrcClient, mut command: PluginCommand) -> Result<(), IrcError> {
+ fn command(&self, client: &IrcClient, mut command: PluginCommand) -> Result<(), FrippyError> {
if command.tokens.is_empty() {
- return self.invalid_command(client, &command);
+ return Ok(client
+ .send_notice(&command.target, "Invalid command")
+ .context(FrippyErrorKind::Connection)?);
}
let target = command.target.clone();
@@ -274,19 +269,27 @@ impl<T: Database> Plugin for Factoids<T> {
let sub_command = command.tokens.remove(0);
let result = match sub_command.as_ref() {
- "add" => self.add(client, &mut command).map(|s| s.to_owned()),
- "fromurl" => self.add_from_url(client, &mut command).map(|s| s.to_owned()),
- "remove" => self.remove(client, &mut command).map(|s| s.to_owned()),
- "get" => self.get(client, &command),
- "info" => self.info(client, &command),
- "exec" => self.exec(client, command),
- _ => self.invalid_command(client, &command).map(|()| String::new()).map_err(|e| e.into()),
+ "add" => self.add(&mut command).map(|s| s.to_owned()),
+ "fromurl" => self.add_from_url(&mut command).map(|s| s.to_owned()),
+ "remove" => self.remove(&mut command).map(|s| s.to_owned()),
+ "get" => self.get(&command),
+ "info" => self.info(&command),
+ "exec" => self.exec(command),
+ _ => Err(ErrorKind::InvalidCommand.into()),
};
Ok(match result {
- Ok(v) => client.send_privmsg(&target, &v),
- Err(e) => client.send_notice(&source, &e.cause().unwrap().to_string()),
- }?)
+ Ok(v) => client
+ .send_privmsg(&target, &v)
+ .context(FrippyErrorKind::Connection)?,
+ Err(e) => {
+ let message = e.to_string();
+ client
+ .send_notice(&source, &message)
+ .context(FrippyErrorKind::Connection)?;
+ Err(e).context(FrippyErrorKind::Factoids)?
+ }
+ })
}
fn evaluate(&self, _: &IrcClient, _: PluginCommand) -> Result<String, String> {
@@ -301,3 +304,39 @@ impl<T: Database> fmt::Debug for Factoids<T> {
write!(f, "Factoids {{ ... }}")
}
}
+
+pub mod error {
+ #[derive(Copy, Clone, Eq, PartialEq, Debug, Fail, Error)]
+ #[error = "FactoidsError"]
+ pub enum ErrorKind {
+ /// Invalid command error
+ #[fail(display = "Invalid Command")]
+ InvalidCommand,
+
+ /// Invalid index error
+ #[fail(display = "Invalid index")]
+ InvalidIndex,
+
+ /// Download error
+ #[fail(display = "Download failed")]
+ Download,
+
+ /// Duplicate error
+ #[fail(display = "Entry already exists")]
+ Duplicate,
+
+ /// Not found error
+ #[fail(display = "Factoid was not found")]
+ NotFound,
+
+ /// MySQL error
+ #[cfg(feature = "mysql")]
+ #[fail(display = "Failed to execute MySQL Query")]
+ MysqlError,
+
+ /// No connection error
+ #[cfg(feature = "mysql")]
+ #[fail(display = "No connection to the database")]
+ NoConnection,
+ }
+}
diff --git a/src/plugins/factoids/utils.rs b/src/plugins/factoids/utils.rs
index 009b46b..70ac8a7 100644
--- a/src/plugins/factoids/utils.rs
+++ b/src/plugins/factoids/utils.rs
@@ -11,7 +11,11 @@ use self::LuaError::RuntimeError;
pub fn download(_: &Lua, url: String) -> Result<String, LuaError> {
match utils::download(&url, Some(1024)) {
Ok(v) => Ok(v),
- Err(e) => Err(RuntimeError(format!("Failed to download {} - {}", url, e.to_string()))),
+ Err(e) => Err(RuntimeError(format!(
+ "Failed to download {} - {}",
+ url,
+ e.to_string()
+ ))),
}
}
diff --git a/src/plugins/help.rs b/src/plugins/help.rs
index 4dd93d7..7e3658d 100644
--- a/src/plugins/help.rs
+++ b/src/plugins/help.rs
@@ -1,8 +1,11 @@
use irc::client::prelude::*;
-use irc::error::IrcError;
use plugin::*;
+use error::FrippyError;
+use error::ErrorKind as FrippyErrorKind;
+use failure::ResultExt;
+
#[derive(PluginName, Default, Debug)]
pub struct Help;
@@ -17,18 +20,17 @@ impl Plugin for Help {
ExecutionStatus::Done
}
- fn execute_threaded(&self, _: &IrcClient, _: &Message) -> Result<(), IrcError> {
+ fn execute_threaded(&self, _: &IrcClient, _: &Message) -> Result<(), FrippyError> {
panic!("Help should not use threading")
}
- fn command(&self, client: &IrcClient, command: PluginCommand) -> Result<(), IrcError> {
- client.send_notice(&command.source, "Help has not been added yet.")
+ fn command(&self, client: &IrcClient, command: PluginCommand) -> Result<(), FrippyError> {
+ Ok(client
+ .send_notice(&command.source, "Help has not been added yet.")
+ .context(FrippyErrorKind::Connection)?)
}
fn evaluate(&self, _: &IrcClient, _: PluginCommand) -> Result<String, String> {
Err(String::from("Help has not been added yet."))
}
}
-
-#[cfg(test)]
-mod tests {}
diff --git a/src/plugins/keepnick.rs b/src/plugins/keepnick.rs
index bdabd90..58ac167 100644
--- a/src/plugins/keepnick.rs
+++ b/src/plugins/keepnick.rs
@@ -1,8 +1,11 @@
use irc::client::prelude::*;
-use irc::error::IrcError;
use plugin::*;
+use error::FrippyError;
+use error::ErrorKind as FrippyErrorKind;
+use failure::ResultExt;
+
#[derive(PluginName, Default, Debug)]
pub struct KeepNick;
@@ -25,9 +28,12 @@ impl KeepNick {
if client_nick != cfg_nick {
info!("Trying to switch nick from {} to {}", client_nick, cfg_nick);
- match client.send(Command::NICK(cfg_nick)) {
+ match client
+ .send(Command::NICK(cfg_nick))
+ .context(FrippyErrorKind::Connection)
+ {
Ok(_) => ExecutionStatus::Done,
- Err(e) => ExecutionStatus::Err(Box::new(e)),
+ Err(e) => ExecutionStatus::Err(e.into()),
}
} else {
ExecutionStatus::Done
@@ -45,21 +51,20 @@ impl Plugin for KeepNick {
}
}
- fn execute_threaded(&self, _: &IrcClient, _: &Message) -> Result<(), IrcError> {
+ fn execute_threaded(&self, _: &IrcClient, _: &Message) -> Result<(), FrippyError> {
panic!("Tell should not use threading")
}
- fn command(&self, client: &IrcClient, command: PluginCommand) -> Result<(), IrcError> {
- client.send_notice(
- &command.source,
- "This Plugin does not implement any commands.",
- )
+ fn command(&self, client: &IrcClient, command: PluginCommand) -> Result<(), FrippyError> {
+ Ok(client
+ .send_notice(
+ &command.source,
+ "This Plugin does not implement any commands.",
+ )
+ .context(FrippyErrorKind::Connection)?)
}
fn evaluate(&self, _: &IrcClient, _: PluginCommand) -> Result<String, String> {
Err(String::from("This Plugin does not implement any commands."))
}
}
-
-#[cfg(test)]
-mod tests {}
diff --git a/src/plugins/mod.rs b/src/plugins/mod.rs
index 5b32efd..9a3ba2f 100644
--- a/src/plugins/mod.rs
+++ b/src/plugins/mod.rs
@@ -1,17 +1,8 @@
//! Collection of plugins included
-mod help;
-mod url;
-mod emoji;
-mod tell;
-mod currency;
-mod factoids;
-mod keepnick;
-
-pub use self::help::Help;
-pub use self::url::Url;
-pub use self::emoji::Emoji;
-pub use self::tell::Tell;
-pub use self::currency::Currency;
-pub use self::factoids::Factoids;
-pub use self::factoids::database;
-pub use self::keepnick::KeepNick;
+pub mod help;
+pub mod url;
+pub mod emoji;
+pub mod tell;
+pub mod currency;
+pub mod factoids;
+pub mod keepnick;
diff --git a/src/plugins/tell/mod.rs b/src/plugins/tell/mod.rs
index 3a8feeb..7052b3e 100644
--- a/src/plugins/tell/mod.rs
+++ b/src/plugins/tell/mod.rs
@@ -1,5 +1,4 @@
use irc::client::prelude::*;
-use irc::error::IrcError;
use std::time::Duration;
use std::sync::Mutex;
@@ -10,6 +9,11 @@ use humantime::format_duration;
use plugin::*;
+use error::FrippyError;
+use error::ErrorKind as FrippyErrorKind;
+use failure::Fail;
+use failure::ResultExt;
+
pub mod database;
use self::database::{Database, DbResponse};
@@ -84,7 +88,7 @@ impl<T: Database> Tell<T> {
tell.sender, human_dur, tell.message
),
) {
- return ExecutionStatus::Err(Box::new(e));
+ return ExecutionStatus::Err(e.context(FrippyErrorKind::Connection).into());
}
debug!(
"Sent {:?} from {:?} to {:?}",
@@ -123,22 +127,30 @@ impl<T: Database> Plugin for Tell<T> {
}
}
- fn execute_threaded(&self, _: &IrcClient, _: &Message) -> Result<(), IrcError> {
+ fn execute_threaded(&self, _: &IrcClient, _: &Message) -> Result<(), FrippyError> {
panic!("Tell should not use threading")
}
- fn command(&self, client: &IrcClient, command: PluginCommand) -> Result<(), IrcError> {
+ fn command(&self, client: &IrcClient, command: PluginCommand) -> Result<(), FrippyError> {
if command.tokens.is_empty() {
- return client.send_notice(&command.source, &self.invalid_command(client));
+ return Ok(client
+ .send_notice(&command.source, &self.invalid_command(client))
+ .context(FrippyErrorKind::Connection)?);
}
- match command.tokens[0].as_ref() {
- "help" => client.send_notice(&command.source, &self.help(client)),
+ Ok(match command.tokens[0].as_ref() {
+ "help" => client
+ .send_notice(&command.source, &self.help(client))
+ .context(FrippyErrorKind::Connection),
_ => match self.tell_command(client, &command) {
- Ok(msg) => client.send_notice(&command.source, msg),
- Err(msg) => client.send_notice(&command.source, &msg),
+ Ok(msg) => client
+ .send_notice(&command.source, msg)
+ .context(FrippyErrorKind::Connection),
+ Err(msg) => client
+ .send_notice(&command.source, &msg)
+ .context(FrippyErrorKind::Connection),
},
- }
+ }?)
}
fn evaluate(&self, _: &IrcClient, _: PluginCommand) -> Result<String, String> {
diff --git a/src/plugins/url.rs b/src/plugins/url.rs
index 6f00466..fa4c6f4 100644
--- a/src/plugins/url.rs
+++ b/src/plugins/url.rs
@@ -2,7 +2,6 @@ extern crate regex;
extern crate select;
use irc::client::prelude::*;
-use irc::error::IrcError;
use self::regex::Regex;
@@ -11,9 +10,12 @@ use self::select::predicate::Name;
use plugin::*;
use utils;
+
+use self::error::*;
use error::FrippyError;
-use error::UrlError;
+use error::ErrorKind as FrippyErrorKind;
use failure::Fail;
+use failure::ResultExt;
lazy_static! {
static ref RE: Regex = Regex::new(r"(^|\s)(https?://\S+)").unwrap();
@@ -48,11 +50,11 @@ impl Url {
Some(title_text)
}
- fn url(&self, text: &str) -> Result<String, FrippyError> {
- let url = self.grep_url(text).ok_or(UrlError::MissingUrl)?;
- let body = utils::download(&url, Some(self.max_kib))?;
+ fn url(&self, text: &str) -> Result<String, UrlError> {
+ let url = self.grep_url(text).ok_or(ErrorKind::MissingUrl)?;
+ let body = utils::download(&url, Some(self.max_kib)).context(ErrorKind::Download)?;
- Ok(self.get_title(&body).ok_or(UrlError::MissingTitle)?)
+ Ok(self.get_title(&body).ok_or(ErrorKind::MissingTitle)?)
}
}
@@ -68,27 +70,48 @@ impl Plugin for Url {
}
}
- fn execute_threaded(&self, client: &IrcClient, message: &Message) -> Result<(), IrcError> {
- match message.command {
+ fn execute_threaded(&self, client: &IrcClient, message: &Message) -> Result<(), FrippyError> {
+ Ok(match message.command {
Command::PRIVMSG(_, ref content) => match self.url(content) {
- Ok(title) => client.send_privmsg(message.response_target().unwrap(), &title),
- Err(e) => Ok(utils::log_error(e)),
+ Ok(title) => client
+ .send_privmsg(message.response_target().unwrap(), &title)
+ .context(FrippyErrorKind::Connection)?,
+ Err(e) => Err(e).context(FrippyErrorKind::Url)?,
},
- _ => Ok(()),
- }
+ _ => (),
+ })
}
- fn command(&self, client: &IrcClient, command: PluginCommand) -> Result<(), IrcError> {
- client.send_notice(
- &command.source,
- "This Plugin does not implement any commands.",
- )
+ fn command(&self, client: &IrcClient, command: PluginCommand) -> Result<(), FrippyError> {
+ Ok(client
+ .send_notice(
+ &command.source,
+ "This Plugin does not implement any commands.",
+ )
+ .context(FrippyErrorKind::Connection)?)
}
fn evaluate(&self, _: &IrcClient, command: PluginCommand) -> Result<String, String> {
- self.url(&command.tokens[0]).map_err(|e| e.cause().unwrap().to_string())
+ self.url(&command.tokens[0])
+ .map_err(|e| e.cause().unwrap().to_string())
}
}
-#[cfg(test)]
-mod tests {}
+pub mod error {
+ /// A URL plugin error
+ #[derive(Copy, Clone, Eq, PartialEq, Debug, Fail, Error)]
+ #[error = "UrlError"]
+ pub enum ErrorKind {
+ /// A download error
+ #[fail(display = "A download error occured")]
+ Download,
+
+ /// Missing URL error
+ #[fail(display = "No URL was found")]
+ MissingUrl,
+
+ /// Missing title error
+ #[fail(display = "No title was found")]
+ MissingTitle,
+ }
+}