/* * Copyright (C) 2021 Aravinth Manivannan * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see . */ use std::convert::From; use actix_web::{ dev::HttpResponseBuilder, error::ResponseError, http::{header, StatusCode}, HttpResponse, }; use argon2_creds::errors::CredsError; use derive_more::{Display, Error}; use libmcaptcha::errors::CaptchaError; use serde::{Deserialize, Serialize}; use url::ParseError; use validator::ValidationErrors; #[derive(Debug, Display, PartialEq, Error)] #[cfg(not(tarpaulin_include))] pub enum ServiceError { #[display(fmt = "internal server error")] InternalServerError, #[display( fmt = "This server is is closed for registration. Contact admin if this is unexpecter" )] ClosedForRegistration, #[display(fmt = "The value you entered for email is not an email")] //405j NotAnEmail, #[display(fmt = "The value you entered for URL is not a URL")] //405j NotAUrl, #[display(fmt = "Wrong password")] WrongPassword, #[display(fmt = "Username not found")] UsernameNotFound, /// when the value passed contains profainity #[display(fmt = "Can't allow profanity in usernames")] ProfainityError, /// when the value passed contains blacklisted words /// see [blacklist](https://github.com/shuttlecraft/The-Big-Username-Blacklist) #[display(fmt = "Username contains blacklisted words")] BlacklistError, /// when the value passed contains characters not present /// in [UsernameCaseMapped](https://tools.ietf.org/html/rfc8265#page-7) /// profile #[display(fmt = "username_case_mapped violation")] UsernameCaseMappedError, #[display(fmt = "Passsword too short")] PasswordTooShort, #[display(fmt = "Username too long")] PasswordTooLong, #[display(fmt = "Passwords don't match")] PasswordsDontMatch, /// when the a username is already taken #[display(fmt = "Username not available")] UsernameTaken, /// email is already taken #[display(fmt = "Email not available")] EmailTaken, /// when the a token name is already taken /// token not found #[display(fmt = "Token not found. Is token registered?")] TokenNotFound, #[display(fmt = "{}", _0)] CaptchaError(CaptchaError), } #[derive(Serialize, Deserialize)] #[cfg(not(tarpaulin_include))] pub struct ErrorToResponse { pub error: String, } #[cfg(not(tarpaulin_include))] impl ResponseError for ServiceError { #[cfg(not(tarpaulin_include))] fn error_response(&self) -> HttpResponse { HttpResponseBuilder::new(self.status_code()) .set_header(header::CONTENT_TYPE, "application/json; charset=UTF-8") .json(ErrorToResponse { error: self.to_string(), }) } #[cfg(not(tarpaulin_include))] fn status_code(&self) -> StatusCode { match self { ServiceError::ClosedForRegistration => StatusCode::FORBIDDEN, ServiceError::InternalServerError => StatusCode::INTERNAL_SERVER_ERROR, ServiceError::NotAnEmail => StatusCode::BAD_REQUEST, ServiceError::NotAUrl => StatusCode::BAD_REQUEST, ServiceError::WrongPassword => StatusCode::UNAUTHORIZED, ServiceError::UsernameNotFound => StatusCode::NOT_FOUND, ServiceError::ProfainityError => StatusCode::BAD_REQUEST, ServiceError::BlacklistError => StatusCode::BAD_REQUEST, ServiceError::UsernameCaseMappedError => StatusCode::BAD_REQUEST, ServiceError::PasswordTooShort => StatusCode::BAD_REQUEST, ServiceError::PasswordTooLong => StatusCode::BAD_REQUEST, ServiceError::PasswordsDontMatch => StatusCode::BAD_REQUEST, ServiceError::UsernameTaken => StatusCode::BAD_REQUEST, ServiceError::EmailTaken => StatusCode::BAD_REQUEST, ServiceError::TokenNotFound => StatusCode::NOT_FOUND, ServiceError::CaptchaError(e) => match e { CaptchaError::MailboxError => StatusCode::INTERNAL_SERVER_ERROR, _ => StatusCode::BAD_REQUEST, }, } } } impl From for ServiceError { #[cfg(not(tarpaulin_include))] fn from(e: CredsError) -> ServiceError { match e { CredsError::UsernameCaseMappedError => ServiceError::UsernameCaseMappedError, CredsError::ProfainityError => ServiceError::ProfainityError, CredsError::BlacklistError => ServiceError::BlacklistError, CredsError::NotAnEmail => ServiceError::NotAnEmail, CredsError::Argon2Error(_) => ServiceError::InternalServerError, CredsError::PasswordTooLong => ServiceError::PasswordTooLong, CredsError::PasswordTooShort => ServiceError::PasswordTooShort, } } } impl From for ServiceError { #[cfg(not(tarpaulin_include))] fn from(_: ValidationErrors) -> ServiceError { ServiceError::NotAnEmail } } impl From for ServiceError { #[cfg(not(tarpaulin_include))] fn from(_: ParseError) -> ServiceError { ServiceError::NotAUrl } } #[cfg(not(tarpaulin_include))] impl From for ServiceError { fn from(e: CaptchaError) -> ServiceError { ServiceError::CaptchaError(e) } } #[cfg(not(tarpaulin_include))] impl From for ServiceError { #[cfg(not(tarpaulin_include))] fn from(e: sqlx::Error) -> Self { use sqlx::error::Error; use std::borrow::Cow; if let Error::Database(err) = e { if err.code() == Some(Cow::from("23505")) { return ServiceError::UsernameTaken; } } ServiceError::InternalServerError } } #[cfg(not(tarpaulin_include))] pub type ServiceResult = std::result::Result; #[derive(Debug, Display, PartialEq, Error)] #[cfg(not(tarpaulin_include))] pub enum PageError { #[display(fmt = "Something weng wrong: Internal server error")] InternalServerError, #[display(fmt = "{}", _0)] ServiceError(ServiceError), } #[cfg(not(tarpaulin_include))] impl From for PageError { #[cfg(not(tarpaulin_include))] fn from(_: sqlx::Error) -> Self { PageError::InternalServerError } } #[cfg(not(tarpaulin_include))] impl From for PageError { #[cfg(not(tarpaulin_include))] fn from(e: ServiceError) -> Self { PageError::ServiceError(e) } } impl ResponseError for PageError { fn error_response(&self) -> HttpResponse { use crate::PAGES; match self.status_code() { StatusCode::INTERNAL_SERVER_ERROR => HttpResponse::Found() .header(header::LOCATION, PAGES.errors.internal_server_error) .finish(), _ => HttpResponse::Found() .header(header::LOCATION, PAGES.errors.unknown_error) .finish(), } } #[cfg(not(tarpaulin_include))] fn status_code(&self) -> StatusCode { match self { PageError::InternalServerError => StatusCode::INTERNAL_SERVER_ERROR, PageError::ServiceError(e) => e.status_code(), } } } #[cfg(not(tarpaulin_include))] pub type PageResult = std::result::Result; #[cfg(test)] mod tests { use super::*; use crate::PAGES; #[test] fn error_works() { let resp: HttpResponse = PageError::InternalServerError.error_response(); assert_eq!(resp.status(), StatusCode::FOUND); let headers = resp.headers(); assert_eq!( headers.get(header::LOCATION).unwrap(), PAGES.errors.internal_server_error ); } }