crates/utils/src/utils.rs

   1 use crate::{settings::structs::Settings, ApiError, IpAddr};
   2 use actix_web::dev::ConnectionInfo;
   3 use chrono::{DateTime, FixedOffset, NaiveDateTime};
   4 use itertools::Itertools;
   5 use rand::{distributions::Alphanumeric, thread_rng, Rng};
   6 use regex::{Regex, RegexBuilder};
   7 use url::Url;
   8
   9 lazy_static! {
  10   static ref EMAIL_REGEX: Regex = Regex::new(r"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$").expect("compile regex");
  11   static ref SLUR_REGEX: Regex = {
  12     let mut slurs = r"(fag(g|got|tard)?\b|cock\s?sucker(s|ing)?|ni((g{2,}|q)+|[gq]{2,})[e3r]+(s|z)?|mudslime?s?|kikes?|\bspi(c|k)s?\b|\bchinks?|gooks?|bitch(es|ing|y)?|whor(es?|ing)|\btr(a|@)nn?(y|ies?)|\b(b|re|r)tard(ed)?s?)".to_string();
  13     if let Some(additional_slurs) = Settings::get().additional_slurs {
  14         slurs.push('|');
  15         slurs.push_str(&additional_slurs);
  16     };
  17     RegexBuilder::new(&slurs).case_insensitive(true).build().expect("compile regex")
  18   };
  19
  20
  21   static ref USERNAME_MATCHES_REGEX: Regex = Regex::new(r"/u/[a-zA-Z][0-9a-zA-Z_]*").expect("compile regex");
  22   // TODO keep this old one, it didn't work with port well tho
  23   // static ref MENTIONS_REGEX: Regex = Regex::new(r"@(?P<name>[\w.]+)@(?P<domain>[a-zA-Z0-9._-]+\.[a-zA-Z0-9_-]+)").expect("compile regex");
  24   static ref MENTIONS_REGEX: Regex = Regex::new(r"@(?P<name>[\w.]+)@(?P<domain>[a-zA-Z0-9._:-]+)").expect("compile regex");
  25   static ref VALID_USERNAME_REGEX: Regex = Regex::new(r"^[a-zA-Z0-9_]{3,20}$").expect("compile regex");
  26   static ref VALID_COMMUNITY_NAME_REGEX: Regex = Regex::new(r"^[a-z0-9_]{3,20}$").expect("compile regex");
  27   static ref VALID_POST_TITLE_REGEX: Regex = Regex::new(r".*\S.*").expect("compile regex");
  28   static ref VALID_MATRIX_ID_REGEX: Regex = Regex::new(r"^@[A-Za-z0-9._=-]+:[A-Za-z0-9.-]+\.[A-Za-z]{2,}$").expect("compile regex");
  29   // taken from https://en.wikipedia.org/wiki/UTM_parameters
  30   static ref CLEAN_URL_PARAMS_REGEX: Regex = Regex::new(r"^utm_source|utm_medium|utm_campaign|utm_term|utm_content|gclid|gclsrc|dclid|fbclid$").expect("compile regex");
  31 }
  32
  33 pub fn naive_from_unix(time: i64) -> NaiveDateTime {
  34   NaiveDateTime::from_timestamp(time, 0)
  35 }
  36
  37 pub fn convert_datetime(datetime: NaiveDateTime) -> DateTime<FixedOffset> {
  38   DateTime::<FixedOffset>::from_utc(datetime, FixedOffset::east(0))
  39 }
  40
  41 pub fn remove_slurs(test: &str) -> String {
  42   SLUR_REGEX.replace_all(test, "*removed*").to_string()
  43 }
  44
  45 pub(crate) fn slur_check(test: &str) -> Result<(), Vec<&str>> {
  46   let mut matches: Vec<&str> = SLUR_REGEX.find_iter(test).map(|mat| mat.as_str()).collect();
  47
  48   // Unique
  49   matches.sort_unstable();
  50   matches.dedup();
  51
  52   if matches.is_empty() {
  53     Ok(())
  54   } else {
  55     Err(matches)
  56   }
  57 }
  58
  59 pub fn check_slurs(text: &str) -> Result<(), ApiError> {
  60   if let Err(slurs) = slur_check(text) {
  61     Err(ApiError::err(&slurs_vec_to_str(slurs)))
  62   } else {
  63     Ok(())
  64   }
  65 }
  66
  67 pub fn check_slurs_opt(text: &Option<String>) -> Result<(), ApiError> {
  68   match text {
  69     Some(t) => check_slurs(t),
  70     None => Ok(()),
  71   }
  72 }
  73
  74 pub(crate) fn slurs_vec_to_str(slurs: Vec<&str>) -> String {
  75   let start = "No slurs - ";
  76   let combined = &slurs.join(", ");
  77   [start, combined].concat()
  78 }
  79
  80 pub fn generate_random_string() -> String {
  81   thread_rng()
  82     .sample_iter(&Alphanumeric)
  83     .map(char::from)
  84     .take(30)
  85     .collect()
  86 }
  87
  88 pub fn markdown_to_html(text: &str) -> String {
  89   comrak::markdown_to_html(text, &comrak::ComrakOptions::default())
  90 }
  91
  92 // TODO nothing is done with community / group webfingers yet, so just ignore those for now
  93 #[derive(Clone, PartialEq, Eq, Hash)]
  94 pub struct MentionData {
  95   pub name: String,
  96   pub domain: String,
  97 }
  98
  99 impl MentionData {
 100   pub fn is_local(&self) -> bool {
 101     Settings::get().hostname().eq(&self.domain)
 102   }
 103   pub fn full_name(&self) -> String {
 104     format!("@{}@{}", &self.name, &self.domain)
 105   }
 106 }
 107
 108 pub fn scrape_text_for_mentions(text: &str) -> Vec<MentionData> {
 109   let mut out: Vec<MentionData> = Vec::new();
 110   for caps in MENTIONS_REGEX.captures_iter(text) {
 111     out.push(MentionData {
 112       name: caps["name"].to_string(),
 113       domain: caps["domain"].to_string(),
 114     });
 115   }
 116   out.into_iter().unique().collect()
 117 }
 118
 119 pub fn is_valid_username(name: &str) -> bool {
 120   VALID_USERNAME_REGEX.is_match(name)
 121 }
 122
 123 // Can't do a regex here, reverse lookarounds not supported
 124 pub fn is_valid_display_name(name: &str) -> bool {
 125   !name.starts_with('@')
 126     && !name.starts_with('\u{200b}')
 127     && name.chars().count() >= 3
 128     && name.chars().count() <= 20
 129 }
 130
 131 pub fn is_valid_matrix_id(matrix_id: &str) -> bool {
 132   VALID_MATRIX_ID_REGEX.is_match(matrix_id)
 133 }
 134
 135 pub fn is_valid_community_name(name: &str) -> bool {
 136   VALID_COMMUNITY_NAME_REGEX.is_match(name)
 137 }
 138
 139 pub fn is_valid_post_title(title: &str) -> bool {
 140   VALID_POST_TITLE_REGEX.is_match(title)
 141 }
 142
 143 pub fn get_ip(conn_info: &ConnectionInfo) -> IpAddr {
 144   IpAddr(
 145     conn_info
 146       .realip_remote_addr()
 147       .unwrap_or("127.0.0.1:12345")
 148       .split(':')
 149       .next()
 150       .unwrap_or("127.0.0.1")
 151       .to_string(),
 152   )
 153 }
 154
 155 pub fn clean_url_params(mut url: Url) -> Url {
 156   let new_query = url
 157     .query_pairs()
 158     .filter(|q| !CLEAN_URL_PARAMS_REGEX.is_match(&q.0))
 159     .map(|q| format!("{}={}", q.0, q.1))
 160     .join("&");
 161   url.set_query(Some(&new_query));
 162   url
 163 }
 164
 165 #[cfg(test)]
 166 mod tests {
 167   use crate::utils::clean_url_params;
 168   use url::Url;
 169
 170   #[test]
 171   fn test_clean_url_params() {
 172     let url = Url::parse("https://example.com/path/123?utm_content=buffercf3b2&utm_medium=social&username=randomuser&id=123").unwrap();
 173     let cleaned = clean_url_params(url);
 174     let expected = Url::parse("https://example.com/path/123?username=randomuser&id=123").unwrap();
 175     assert_eq!(expected.to_string(), cleaned.to_string());
 176   }
 177 }