4 extern crate strum_macros;
6 extern crate lazy_static;
7 // this is used in tests
8 #[allow(unused_imports)]
10 extern crate diesel_migrations;
13 extern crate serial_test;
15 use chrono::NaiveDateTime;
16 use diesel::{result::Error, *};
17 use lemmy_db_schema::{CommunityId, DbUrl, PersonId};
18 use lemmy_utils::ApiError;
20 use serde::{Deserialize, Serialize};
21 use std::{env, env::VarError};
27 pub type DbPool = diesel::r2d2::Pool<diesel::r2d2::ConnectionManager<diesel::PgConnection>>;
32 fn create(conn: &PgConnection, form: &Self::Form) -> Result<Self, Error>
35 fn read(conn: &PgConnection, id: Self::IdType) -> Result<Self, Error>
38 fn update(conn: &PgConnection, id: Self::IdType, form: &Self::Form) -> Result<Self, Error>
41 fn delete(_conn: &PgConnection, _id: Self::IdType) -> Result<usize, Error>
49 pub trait Followable {
51 fn follow(conn: &PgConnection, form: &Self::Form) -> Result<Self, Error>
56 community_id: CommunityId,
58 ) -> Result<Self, Error>
61 fn unfollow(conn: &PgConnection, form: &Self::Form) -> Result<usize, Error>
64 fn has_local_followers(conn: &PgConnection, community_id: CommunityId) -> Result<bool, Error>;
69 fn join(conn: &PgConnection, form: &Self::Form) -> Result<Self, Error>
72 fn leave(conn: &PgConnection, form: &Self::Form) -> Result<usize, Error>
80 fn like(conn: &PgConnection, form: &Self::Form) -> Result<Self, Error>
86 item_id: Self::IdType,
87 ) -> Result<usize, Error>
94 fn ban(conn: &PgConnection, form: &Self::Form) -> Result<Self, Error>
97 fn unban(conn: &PgConnection, form: &Self::Form) -> Result<usize, Error>
104 fn save(conn: &PgConnection, form: &Self::Form) -> Result<Self, Error>
107 fn unsave(conn: &PgConnection, form: &Self::Form) -> Result<usize, Error>
112 pub trait Blockable {
114 fn block(conn: &PgConnection, form: &Self::Form) -> Result<Self, Error>
117 fn unblock(conn: &PgConnection, form: &Self::Form) -> Result<usize, Error>
124 fn mark_as_read(conn: &PgConnection, form: &Self::Form) -> Result<Self, Error>
127 fn mark_as_unread(conn: &PgConnection, form: &Self::Form) -> Result<usize, Error>
132 pub trait Reportable {
134 fn report(conn: &PgConnection, form: &Self::Form) -> Result<Self, Error>
137 fn resolve(conn: &PgConnection, report_id: i32, resolver_id: PersonId) -> Result<usize, Error>
140 fn unresolve(conn: &PgConnection, report_id: i32, resolver_id: PersonId) -> Result<usize, Error>
145 pub trait DeleteableOrRemoveable {
146 fn blank_out_deleted_or_removed_info(self) -> Self;
149 // TODO: move this to apub lib
150 pub trait ApubObject {
151 /// If this object should be refetched after a certain interval, it should return the last refresh
152 /// time here. This is mainly used to update remote actors.
153 fn last_refreshed_at(&self) -> Option<NaiveDateTime>;
154 fn read_from_apub_id(conn: &PgConnection, object_id: &DbUrl) -> Result<Self, Error>
159 pub trait MaybeOptional<T> {
160 fn get_optional(self) -> Option<T>;
163 impl<T> MaybeOptional<T> for T {
164 fn get_optional(self) -> Option<T> {
169 impl<T> MaybeOptional<T> for Option<T> {
170 fn get_optional(self) -> Option<T> {
177 fn safe_columns_tuple() -> Self::SafeColumns;
180 pub trait ToSafeSettings {
181 type SafeSettingsColumns;
182 fn safe_settings_columns_tuple() -> Self::SafeSettingsColumns;
185 pub trait ViewToVec {
187 fn from_tuple_to_vec(tuple: Vec<Self::DbTuple>) -> Vec<Self>
192 pub fn get_database_url_from_env() -> Result<String, VarError> {
193 env::var("LEMMY_DATABASE_URL")
196 #[derive(EnumString, ToString, Debug, Serialize, Deserialize, Clone, Copy)]
210 #[derive(EnumString, ToString, Debug, Serialize, Deserialize, Clone, Copy)]
211 pub enum ListingType {
218 #[derive(EnumString, ToString, Debug, Serialize, Deserialize, Clone, Copy)]
219 pub enum SearchType {
228 pub fn from_opt_str_to_opt_enum<T: std::str::FromStr>(opt: &Option<String>) -> Option<T> {
229 opt.as_ref().map(|t| T::from_str(t).ok()).flatten()
232 pub fn fuzzy_search(q: &str) -> String {
233 let replaced = q.replace(" ", "%");
234 format!("%{}%", replaced)
237 pub fn limit_and_offset(page: Option<i64>, limit: Option<i64>) -> (i64, i64) {
238 let page = page.unwrap_or(1);
239 let limit = limit.unwrap_or(10);
240 let offset = limit * (page - 1);
244 pub fn is_email_regex(test: &str) -> bool {
245 EMAIL_REGEX.is_match(test)
248 pub fn diesel_option_overwrite(opt: &Option<String>) -> Option<Option<String>> {
250 // An empty string is an erase
252 if !unwrapped.eq("") {
253 Some(Some(unwrapped.to_owned()))
262 pub fn diesel_option_overwrite_to_url(
263 opt: &Option<String>,
264 ) -> Result<Option<Option<DbUrl>>, ApiError> {
265 match opt.as_ref().map(|s| s.as_str()) {
266 // An empty string is an erase
267 Some("") => Ok(Some(None)),
268 Some(str_url) => match Url::parse(str_url) {
269 Ok(url) => Ok(Some(Some(url.into()))),
270 Err(_) => Err(ApiError::err("invalid_url")),
278 pub fn establish_unpooled_connection() -> PgConnection {
279 let db_url = match get_database_url_from_env() {
282 "Failed to read database URL from env var LEMMY_DATABASE_URL: {}",
287 PgConnection::establish(&db_url).unwrap_or_else(|_| panic!("Error connecting to {}", db_url));
288 embedded_migrations::run(&conn).expect("load migrations");
293 static ref EMAIL_REGEX: Regex =
294 Regex::new(r"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$")
295 .expect("compile email regex");
299 use diesel::sql_types::*;
302 fn hot_rank(score: BigInt, time: Timestamp) -> Integer;
308 use super::{fuzzy_search, *};
309 use crate::is_email_regex;
312 fn test_fuzzy_search() {
313 let test = "This is a fuzzy search";
314 assert_eq!(fuzzy_search(test), "%This%is%a%fuzzy%search%".to_string());
319 assert!(is_email_regex("gush@gmail.com"));
320 assert!(!is_email_regex("nada_neutho"));
324 fn test_diesel_option_overwrite() {
325 assert_eq!(diesel_option_overwrite(&None), None);
326 assert_eq!(diesel_option_overwrite(&Some("".to_string())), Some(None));
328 diesel_option_overwrite(&Some("test".to_string())),
329 Some(Some("test".to_string()))
334 fn test_diesel_option_overwrite_to_url() {
335 assert!(matches!(diesel_option_overwrite_to_url(&None), Ok(None)));
337 diesel_option_overwrite_to_url(&Some("".to_string())),
341 diesel_option_overwrite_to_url(&Some("invalid_url".to_string())),
344 let example_url = "https://example.com";
346 diesel_option_overwrite_to_url(&Some(example_url.to_string())),
347 Ok(Some(Some(url))) if url == Url::parse(example_url).unwrap().into()