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 Blockable {
 112   type Form;
 113   fn block(conn: &PgConnection, form: &Self::Form) -> Result<Self, Error>
 114   where
 115     Self: Sized;
 116   fn unblock(conn: &PgConnection, form: &Self::Form) -> Result<usize, Error>
 117   where
 118     Self: Sized;
 119 }
 120
 121 pub trait Readable {
 122   type Form;
 123   fn mark_as_read(conn: &PgConnection, form: &Self::Form) -> Result<Self, Error>
 124   where
 125     Self: Sized;
 126   fn mark_as_unread(conn: &PgConnection, form: &Self::Form) -> Result<usize, Error>
 127   where
 128     Self: Sized;
 129 }
 130
 131 pub trait Reportable {
 132   type Form;
 133   type IdType;
 134   fn report(conn: &PgConnection, form: &Self::Form) -> Result<Self, Error>
 135   where
 136     Self: Sized;
 137   fn resolve(
 138     conn: &PgConnection,
 139     report_id: Self::IdType,
 140     resolver_id: PersonId,
 141   ) -> Result<usize, Error>
 142   where
 143     Self: Sized;
 144   fn unresolve(
 145     conn: &PgConnection,
 146     report_id: Self::IdType,
 147     resolver_id: PersonId,
 148   ) -> Result<usize, Error>
 149   where
 150     Self: Sized;
 151 }
 152
 153 pub trait DeleteableOrRemoveable {
 154   fn blank_out_deleted_or_removed_info(self) -> Self;
 155 }
 156
 157 pub trait MaybeOptional<T> {
 158   fn get_optional(self) -> Option<T>;
 159 }
 160
 161 impl<T> MaybeOptional<T> for T {
 162   fn get_optional(self) -> Option<T> {
 163     Some(self)
 164   }
 165 }
 166
 167 impl<T> MaybeOptional<T> for Option<T> {
 168   fn get_optional(self) -> Option<T> {
 169     self
 170   }
 171 }
 172
 173 pub trait ToSafe {
 174   type SafeColumns;
 175   fn safe_columns_tuple() -> Self::SafeColumns;
 176 }
 177
 178 pub trait ToSafeSettings {
 179   type SafeSettingsColumns;
 180   fn safe_settings_columns_tuple() -> Self::SafeSettingsColumns;
 181 }
 182
 183 pub trait ViewToVec {
 184   type DbTuple;
 185   fn from_tuple_to_vec(tuple: Vec<Self::DbTuple>) -> Vec<Self>
 186   where
 187     Self: Sized;
 188 }
 189
 190 pub fn get_database_url_from_env() -> Result<String, VarError> {
 191   env::var("LEMMY_DATABASE_URL")
 192 }
 193
 194 #[derive(EnumString, ToString, Debug, Serialize, Deserialize, Clone, Copy)]
 195 pub enum SortType {
 196   Active,
 197   Hot,
 198   New,
 199   TopDay,
 200   TopWeek,
 201   TopMonth,
 202   TopYear,
 203   TopAll,
 204   MostComments,
 205   NewComments,
 206 }
 207
 208 #[derive(EnumString, ToString, Debug, Serialize, Deserialize, Clone, Copy)]
 209 pub enum ListingType {
 210   All,
 211   Local,
 212   Subscribed,
 213   Community,
 214 }
 215
 216 #[derive(EnumString, ToString, Debug, Serialize, Deserialize, Clone, Copy)]
 217 pub enum SearchType {
 218   All,
 219   Comments,
 220   Posts,
 221   Communities,
 222   Users,
 223   Url,
 224 }
 225
 226 pub fn from_opt_str_to_opt_enum<T: std::str::FromStr>(opt: &Option<String>) -> Option<T> {
 227   opt.as_ref().map(|t| T::from_str(t).ok()).flatten()
 228 }
 229
 230 pub fn fuzzy_search(q: &str) -> String {
 231   let replaced = q.replace(" ", "%");
 232   format!("%{}%", replaced)
 233 }
 234
 235 pub fn limit_and_offset(page: Option<i64>, limit: Option<i64>) -> (i64, i64) {
 236   let page = page.unwrap_or(1);
 237   let limit = limit.unwrap_or(10);
 238   let offset = limit * (page - 1);
 239   (limit, offset)
 240 }
 241
 242 pub fn is_email_regex(test: &str) -> bool {
 243   EMAIL_REGEX.is_match(test)
 244 }
 245
 246 pub fn diesel_option_overwrite(opt: &Option<String>) -> Option<Option<String>> {
 247   match opt {
 248     // An empty string is an erase
 249     Some(unwrapped) => {
 250       if !unwrapped.eq("") {
 251         Some(Some(unwrapped.to_owned()))
 252       } else {
 253         Some(None)
 254       }
 255     }
 256     None => None,
 257   }
 258 }
 259
 260 pub fn diesel_option_overwrite_to_url(
 261   opt: &Option<String>,
 262 ) -> Result<Option<Option<DbUrl>>, ApiError> {
 263   match opt.as_ref().map(|s| s.as_str()) {
 264     // An empty string is an erase
 265     Some("") => Ok(Some(None)),
 266     Some(str_url) => match Url::parse(str_url) {
 267       Ok(url) => Ok(Some(Some(url.into()))),
 268       Err(_) => Err(ApiError::err("invalid_url")),
 269     },
 270     None => Ok(None),
 271   }
 272 }
 273
 274 embed_migrations!();
 275
 276 pub fn establish_unpooled_connection() -> PgConnection {
 277   let db_url = match get_database_url_from_env() {
 278     Ok(url) => url,
 279     Err(e) => panic!(
 280       "Failed to read database URL from env var LEMMY_DATABASE_URL: {}",
 281       e
 282     ),
 283   };
 284   let conn =
 285     PgConnection::establish(&db_url).unwrap_or_else(|_| panic!("Error connecting to {}", db_url));
 286   embedded_migrations::run(&conn).expect("load migrations");
 287   conn
 288 }
 289
 290 lazy_static! {
 291   static ref EMAIL_REGEX: Regex =
 292     Regex::new(r"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$")
 293       .expect("compile email regex");
 294 }
 295
 296 pub mod functions {
 297   use diesel::sql_types::*;
 298
 299   sql_function! {
 300     fn hot_rank(score: BigInt, time: Timestamp) -> Integer;
 301   }
 302 }
 303
 304 #[cfg(test)]
 305 mod tests {
 306   use super::{fuzzy_search, *};
 307   use crate::is_email_regex;
 308
 309   #[test]
 310   fn test_fuzzy_search() {
 311     let test = "This is a fuzzy search";
 312     assert_eq!(fuzzy_search(test), "%This%is%a%fuzzy%search%".to_string());
 313   }
 314
 315   #[test]
 316   fn test_email() {
 317     assert!(is_email_regex("gush@gmail.com"));
 318     assert!(!is_email_regex("nada_neutho"));
 319   }
 320
 321   #[test]
 322   fn test_diesel_option_overwrite() {
 323     assert_eq!(diesel_option_overwrite(&None), None);
 324     assert_eq!(diesel_option_overwrite(&Some("".to_string())), Some(None));
 325     assert_eq!(
 326       diesel_option_overwrite(&Some("test".to_string())),
 327       Some(Some("test".to_string()))
 328     );
 329   }
 330
 331   #[test]
 332   fn test_diesel_option_overwrite_to_url() {
 333     assert!(matches!(diesel_option_overwrite_to_url(&None), Ok(None)));
 334     assert!(matches!(
 335       diesel_option_overwrite_to_url(&Some("".to_string())),
 336       Ok(Some(None))
 337     ));
 338     assert!(matches!(
 339       diesel_option_overwrite_to_url(&Some("invalid_url".to_string())),
 340       Err(_)
 341     ));
 342     let example_url = "https://example.com";
 343     assert!(matches!(
 344       diesel_option_overwrite_to_url(&Some(example_url.to_string())),
 345       Ok(Some(Some(url))) if url == Url::parse(example_url).unwrap().into()
 346     ));
 347   }
 348 }