crates/db_queries/src/lib.rs

   1 #[macro_use]
   2 extern crate diesel;
   3 #[macro_use]
   4 extern crate strum_macros;
   5 #[macro_use]
   6 extern crate lazy_static;
   7 // this is used in tests
   8 #[allow(unused_imports)]
   9 #[macro_use]
  10 extern crate diesel_migrations;
  11
  12 #[cfg(test)]
  13 extern crate serial_test;
  14
  15 use diesel::{result::Error, *};
  16 use lemmy_db_schema::{CommunityId, DbUrl, PersonId};
  17 use lemmy_utils::ApiError;
  18 use regex::Regex;
  19 use serde::{Deserialize, Serialize};
  20 use std::{env, env::VarError};
  21 use url::Url;
  22
  23 pub mod aggregates;
  24 pub mod source;
  25
  26 pub type DbPool = diesel::r2d2::Pool<diesel::r2d2::ConnectionManager<diesel::PgConnection>>;
  27
  28 pub trait Crud {
  29   type Form;
  30   type IdType;
  31   fn create(conn: &PgConnection, form: &Self::Form) -> Result<Self, Error>
  32   where
  33     Self: Sized;
  34   fn read(conn: &PgConnection, id: Self::IdType) -> Result<Self, Error>
  35   where
  36     Self: Sized;
  37   fn update(conn: &PgConnection, id: Self::IdType, form: &Self::Form) -> Result<Self, Error>
  38   where
  39     Self: Sized;
  40   fn delete(_conn: &PgConnection, _id: Self::IdType) -> Result<usize, Error>
  41   where
  42     Self: Sized,
  43   {
  44     unimplemented!()
  45   }
  46 }
  47
  48 pub trait Followable {
  49   type Form;
  50   fn follow(conn: &PgConnection, form: &Self::Form) -> Result<Self, Error>
  51   where
  52     Self: Sized;
  53   fn follow_accepted(
  54     conn: &PgConnection,
  55     community_id: CommunityId,
  56     person_id: PersonId,
  57   ) -> Result<Self, Error>
  58   where
  59     Self: Sized;
  60   fn unfollow(conn: &PgConnection, form: &Self::Form) -> Result<usize, Error>
  61   where
  62     Self: Sized;
  63   fn has_local_followers(conn: &PgConnection, community_id: CommunityId) -> Result<bool, Error>;
  64 }
  65
  66 pub trait Joinable {
  67   type Form;
  68   fn join(conn: &PgConnection, form: &Self::Form) -> Result<Self, Error>
  69   where
  70     Self: Sized;
  71   fn leave(conn: &PgConnection, form: &Self::Form) -> Result<usize, Error>
  72   where
  73     Self: Sized;
  74 }
  75
  76 pub trait Likeable {
  77   type Form;
  78   type IdType;
  79   fn like(conn: &PgConnection, form: &Self::Form) -> Result<Self, Error>
  80   where
  81     Self: Sized;
  82   fn remove(
  83     conn: &PgConnection,
  84     person_id: PersonId,
  85     item_id: Self::IdType,
  86   ) -> Result<usize, Error>
  87   where
  88     Self: Sized;
  89 }
  90
  91 pub trait Bannable {
  92   type Form;
  93   fn ban(conn: &PgConnection, form: &Self::Form) -> Result<Self, Error>
  94   where
  95     Self: Sized;
  96   fn unban(conn: &PgConnection, form: &Self::Form) -> Result<usize, Error>
  97   where
  98     Self: Sized;
  99 }
 100
 101 pub trait Saveable {
 102   type Form;
 103   fn save(conn: &PgConnection, form: &Self::Form) -> Result<Self, Error>
 104   where
 105     Self: Sized;
 106   fn unsave(conn: &PgConnection, form: &Self::Form) -> Result<usize, Error>
 107   where
 108     Self: Sized;
 109 }
 110
 111 pub trait Readable {
 112   type Form;
 113   fn mark_as_read(conn: &PgConnection, form: &Self::Form) -> Result<Self, Error>
 114   where
 115     Self: Sized;
 116   fn mark_as_unread(conn: &PgConnection, form: &Self::Form) -> Result<usize, Error>
 117   where
 118     Self: Sized;
 119 }
 120
 121 pub trait Reportable {
 122   type Form;
 123   fn report(conn: &PgConnection, form: &Self::Form) -> Result<Self, Error>
 124   where
 125     Self: Sized;
 126   fn resolve(conn: &PgConnection, report_id: i32, resolver_id: PersonId) -> Result<usize, Error>
 127   where
 128     Self: Sized;
 129   fn unresolve(conn: &PgConnection, report_id: i32, resolver_id: PersonId) -> Result<usize, Error>
 130   where
 131     Self: Sized;
 132 }
 133
 134 pub trait DeleteableOrRemoveable {
 135   fn blank_out_deleted_or_removed_info(self) -> Self;
 136 }
 137
 138 pub trait ApubObject {
 139   type Form;
 140   fn read_from_apub_id(conn: &PgConnection, object_id: &DbUrl) -> Result<Self, Error>
 141   where
 142     Self: Sized;
 143   fn upsert(conn: &PgConnection, user_form: &Self::Form) -> Result<Self, Error>
 144   where
 145     Self: Sized;
 146 }
 147
 148 pub trait MaybeOptional<T> {
 149   fn get_optional(self) -> Option<T>;
 150 }
 151
 152 impl<T> MaybeOptional<T> for T {
 153   fn get_optional(self) -> Option<T> {
 154     Some(self)
 155   }
 156 }
 157
 158 impl<T> MaybeOptional<T> for Option<T> {
 159   fn get_optional(self) -> Option<T> {
 160     self
 161   }
 162 }
 163
 164 pub trait ToSafe {
 165   type SafeColumns;
 166   fn safe_columns_tuple() -> Self::SafeColumns;
 167 }
 168
 169 pub trait ToSafeSettings {
 170   type SafeSettingsColumns;
 171   fn safe_settings_columns_tuple() -> Self::SafeSettingsColumns;
 172 }
 173
 174 pub trait ViewToVec {
 175   type DbTuple;
 176   fn from_tuple_to_vec(tuple: Vec<Self::DbTuple>) -> Vec<Self>
 177   where
 178     Self: Sized;
 179 }
 180
 181 pub fn get_database_url_from_env() -> Result<String, VarError> {
 182   env::var("LEMMY_DATABASE_URL")
 183 }
 184
 185 #[derive(EnumString, ToString, Debug, Serialize, Deserialize, Clone, Copy)]
 186 pub enum SortType {
 187   Active,
 188   Hot,
 189   New,
 190   TopDay,
 191   TopWeek,
 192   TopMonth,
 193   TopYear,
 194   TopAll,
 195   MostComments,
 196   NewComments,
 197 }
 198
 199 #[derive(EnumString, ToString, Debug, Serialize, Deserialize, Clone, Copy)]
 200 pub enum ListingType {
 201   All,
 202   Local,
 203   Subscribed,
 204   Community,
 205 }
 206
 207 #[derive(EnumString, ToString, Debug, Serialize, Deserialize, Clone, Copy)]
 208 pub enum SearchType {
 209   All,
 210   Comments,
 211   Posts,
 212   Communities,
 213   Users,
 214   Url,
 215 }
 216
 217 pub fn from_opt_str_to_opt_enum<T: std::str::FromStr>(opt: &Option<String>) -> Option<T> {
 218   opt.as_ref().map(|t| T::from_str(t).ok()).flatten()
 219 }
 220
 221 pub fn fuzzy_search(q: &str) -> String {
 222   let replaced = q.replace(" ", "%");
 223   format!("%{}%", replaced)
 224 }
 225
 226 pub fn limit_and_offset(page: Option<i64>, limit: Option<i64>) -> (i64, i64) {
 227   let page = page.unwrap_or(1);
 228   let limit = limit.unwrap_or(10);
 229   let offset = limit * (page - 1);
 230   (limit, offset)
 231 }
 232
 233 pub fn is_email_regex(test: &str) -> bool {
 234   EMAIL_REGEX.is_match(test)
 235 }
 236
 237 pub fn diesel_option_overwrite(opt: &Option<String>) -> Option<Option<String>> {
 238   match opt {
 239     // An empty string is an erase
 240     Some(unwrapped) => {
 241       if !unwrapped.eq("") {
 242         Some(Some(unwrapped.to_owned()))
 243       } else {
 244         Some(None)
 245       }
 246     }
 247     None => None,
 248   }
 249 }
 250
 251 pub fn diesel_option_overwrite_to_url(
 252   opt: &Option<String>,
 253 ) -> Result<Option<Option<DbUrl>>, ApiError> {
 254   match opt.as_ref().map(|s| s.as_str()) {
 255     // An empty string is an erase
 256     Some("") => Ok(Some(None)),
 257     Some(str_url) => match Url::parse(str_url) {
 258       Ok(url) => Ok(Some(Some(url.into()))),
 259       Err(_) => Err(ApiError::err("invalid_url")),
 260     },
 261     None => Ok(None),
 262   }
 263 }
 264
 265 embed_migrations!();
 266
 267 pub fn establish_unpooled_connection() -> PgConnection {
 268   let db_url = match get_database_url_from_env() {
 269     Ok(url) => url,
 270     Err(e) => panic!(
 271       "Failed to read database URL from env var LEMMY_DATABASE_URL: {}",
 272       e
 273     ),
 274   };
 275   let conn =
 276     PgConnection::establish(&db_url).unwrap_or_else(|_| panic!("Error connecting to {}", db_url));
 277   embedded_migrations::run(&conn).expect("load migrations");
 278   conn
 279 }
 280
 281 lazy_static! {
 282   static ref EMAIL_REGEX: Regex =
 283     Regex::new(r"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$")
 284       .expect("compile email regex");
 285 }
 286
 287 pub mod functions {
 288   use diesel::sql_types::*;
 289
 290   sql_function! {
 291     fn hot_rank(score: BigInt, time: Timestamp) -> Integer;
 292   }
 293 }
 294
 295 #[cfg(test)]
 296 mod tests {
 297   use super::{fuzzy_search, *};
 298   use crate::is_email_regex;
 299
 300   #[test]
 301   fn test_fuzzy_search() {
 302     let test = "This is a fuzzy search";
 303     assert_eq!(fuzzy_search(test), "%This%is%a%fuzzy%search%".to_string());
 304   }
 305
 306   #[test]
 307   fn test_email() {
 308     assert!(is_email_regex("gush@gmail.com"));
 309     assert!(!is_email_regex("nada_neutho"));
 310   }
 311
 312   #[test]
 313   fn test_diesel_option_overwrite() {
 314     assert_eq!(diesel_option_overwrite(&None), None);
 315     assert_eq!(diesel_option_overwrite(&Some("".to_string())), Some(None));
 316     assert_eq!(
 317       diesel_option_overwrite(&Some("test".to_string())),
 318       Some(Some("test".to_string()))
 319     );
 320   }
 321
 322   #[test]
 323   fn test_diesel_option_overwrite_to_url() {
 324     assert!(matches!(diesel_option_overwrite_to_url(&None), Ok(None)));
 325     assert!(matches!(
 326       diesel_option_overwrite_to_url(&Some("".to_string())),
 327       Ok(Some(None))
 328     ));
 329     assert!(matches!(
 330       diesel_option_overwrite_to_url(&Some("invalid_url".to_string())),
 331       Err(_)
 332     ));
 333     let example_url = "https://example.com";
 334     assert!(matches!(
 335       diesel_option_overwrite_to_url(&Some(example_url.to_string())),
 336       Ok(Some(Some(url))) if url == Url::parse(example_url).unwrap().into()
 337     ));
 338   }
 339 }