use crate::cnf::GENERATION_ALLOCATION_LIMIT;
use crate::err::Error;
use crate::fnc::util::string;
use crate::sql::value::Value;
use crate::sql::Regex;
fn limit(name: &str, n: usize) -> Result<(), Error> {
if n > *GENERATION_ALLOCATION_LIMIT {
Err(Error::InvalidArguments {
name: name.to_owned(),
message: format!("Output must not exceed {} bytes.", *GENERATION_ALLOCATION_LIMIT),
})
} else {
Ok(())
}
}
pub fn concat(args: Vec<Value>) -> Result<Value, Error> {
let strings = args.into_iter().map(Value::as_string).collect::<Vec<_>>();
limit("string::concat", strings.iter().map(String::len).sum::<usize>())?;
Ok(strings.concat().into())
}
pub fn contains((val, check): (String, String)) -> Result<Value, Error> {
Ok(val.contains(&check).into())
}
pub fn ends_with((val, chr): (String, String)) -> Result<Value, Error> {
Ok(val.ends_with(&chr).into())
}
pub fn join(args: Vec<Value>) -> Result<Value, Error> {
let mut args = args.into_iter().map(Value::as_string);
let chr = args.next().ok_or_else(|| Error::InvalidArguments {
name: String::from("string::join"),
message: String::from("Expected at least one argument"),
})?;
let strings = args.collect::<Vec<_>>();
limit(
"string::join",
strings
.len()
.saturating_mul(chr.len())
.saturating_add(strings.iter().map(String::len).sum::<usize>()),
)?;
Ok(strings.join(&chr).into())
}
pub fn len((string,): (String,)) -> Result<Value, Error> {
let num = string.chars().count() as i64;
Ok(num.into())
}
pub fn lowercase((string,): (String,)) -> Result<Value, Error> {
Ok(string.to_lowercase().into())
}
pub fn repeat((val, num): (String, usize)) -> Result<Value, Error> {
limit("string::repeat", val.len().saturating_mul(num))?;
Ok(val.repeat(num).into())
}
pub fn matches((val, regex): (String, Regex)) -> Result<Value, Error> {
Ok(regex.0.is_match(&val).into())
}
pub fn replace((val, search, replace): (String, Value, String)) -> Result<Value, Error> {
match search {
Value::Strand(search) => {
if replace.len() > search.len() {
let increase = replace.len() - search.len();
limit(
"string::replace",
val.len()
.saturating_add(val.matches(&search.0).count().saturating_mul(increase)),
)?;
}
Ok(val.replace(&search.0, &replace).into())
}
Value::Regex(search) => Ok(search.0.replace_all(&val, replace).into_owned().into()),
_ => Err(Error::InvalidArguments {
name: "string::replace".to_string(),
message: format!(
"Argument 2 was the wrong type. Expected a string but found {}",
search
),
}),
}
}
pub fn reverse((string,): (String,)) -> Result<Value, Error> {
Ok(string.chars().rev().collect::<String>().into())
}
pub fn slice((val, beg, lim): (String, Option<isize>, Option<isize>)) -> Result<Value, Error> {
let mut char_count = usize::MAX;
let mut count_chars = || {
if char_count == usize::MAX {
char_count = val.chars().count();
}
char_count
};
let skip = match beg {
Some(v) if v < 0 => count_chars().saturating_sub(v.unsigned_abs()),
Some(v) => v as usize,
None => 0,
};
let take = match lim {
Some(v) if v < 0 => count_chars().saturating_sub(skip).saturating_sub(v.unsigned_abs()),
Some(v) => v as usize,
None => usize::MAX,
};
Ok(if skip > 0 || take < usize::MAX {
val.chars().skip(skip).take(take).collect::<String>()
} else {
val
}
.into())
}
pub fn slug((string,): (String,)) -> Result<Value, Error> {
Ok(string::slug::slug(string).into())
}
pub fn split((val, chr): (String, String)) -> Result<Value, Error> {
Ok(val.split(&chr).collect::<Vec<&str>>().into())
}
pub fn starts_with((val, chr): (String, String)) -> Result<Value, Error> {
Ok(val.starts_with(&chr).into())
}
pub fn trim((string,): (String,)) -> Result<Value, Error> {
Ok(string.trim().into())
}
pub fn uppercase((string,): (String,)) -> Result<Value, Error> {
Ok(string.to_uppercase().into())
}
pub fn words((string,): (String,)) -> Result<Value, Error> {
Ok(string.split_whitespace().collect::<Vec<&str>>().into())
}
pub mod distance {
use crate::err::Error;
use crate::sql::Value;
use strsim;
pub fn damerau_levenshtein((a, b): (String, String)) -> Result<Value, Error> {
Ok(strsim::damerau_levenshtein(&a, &b).into())
}
pub fn normalized_damerau_levenshtein((a, b): (String, String)) -> Result<Value, Error> {
Ok(strsim::normalized_damerau_levenshtein(&a, &b).into())
}
pub fn hamming((a, b): (String, String)) -> Result<Value, Error> {
match strsim::hamming(&a, &b) {
Ok(v) => Ok(v.into()),
Err(_) => Err(Error::InvalidArguments {
name: "string::distance::hamming".into(),
message: "Strings must be of equal length.".into(),
}),
}
}
pub fn levenshtein((a, b): (String, String)) -> Result<Value, Error> {
Ok(strsim::levenshtein(&a, &b).into())
}
pub fn normalized_levenshtein((a, b): (String, String)) -> Result<Value, Error> {
Ok(strsim::normalized_levenshtein(&a, &b).into())
}
pub fn osa_distance((a, b): (String, String)) -> Result<Value, Error> {
Ok(strsim::osa_distance(&a, &b).into())
}
}
pub mod html {
use crate::err::Error;
use crate::sql::value::Value;
pub fn encode((arg,): (String,)) -> Result<Value, Error> {
Ok(ammonia::clean_text(&arg).into())
}
pub fn sanitize((arg,): (String,)) -> Result<Value, Error> {
Ok(ammonia::clean(&arg).into())
}
}
pub mod is {
use crate::err::Error;
use crate::sql::value::Value;
use crate::sql::{Datetime, Thing};
use chrono::NaiveDateTime;
use regex::Regex;
use semver::Version;
use std::char;
use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
use std::sync::LazyLock;
use ulid::Ulid;
use url::Url;
use uuid::Uuid;
#[rustfmt::skip] static LATITUDE_RE: LazyLock<Regex> = LazyLock::new(|| Regex::new("^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$").unwrap());
#[rustfmt::skip] static LONGITUDE_RE: LazyLock<Regex> = LazyLock::new(|| Regex::new("^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$").unwrap());
pub fn alphanum((arg,): (String,)) -> Result<Value, Error> {
Ok(arg.chars().all(char::is_alphanumeric).into())
}
pub fn alpha((arg,): (String,)) -> Result<Value, Error> {
Ok(arg.chars().all(char::is_alphabetic).into())
}
pub fn ascii((arg,): (String,)) -> Result<Value, Error> {
Ok(arg.is_ascii().into())
}
pub fn datetime((arg, fmt): (String, Option<String>)) -> Result<Value, Error> {
Ok(match fmt {
Some(fmt) => NaiveDateTime::parse_from_str(&arg, &fmt).is_ok().into(),
None => Datetime::try_from(arg.as_ref()).is_ok().into(),
})
}
pub fn domain((arg,): (String,)) -> Result<Value, Error> {
Ok(addr::parse_domain_name(arg.as_str()).is_ok().into())
}
pub fn email((arg,): (String,)) -> Result<Value, Error> {
Ok(addr::parse_email_address(arg.as_str()).is_ok().into())
}
pub fn hexadecimal((arg,): (String,)) -> Result<Value, Error> {
Ok(arg.chars().all(|x| char::is_ascii_hexdigit(&x)).into())
}
pub fn ip((arg,): (String,)) -> Result<Value, Error> {
Ok(arg.parse::<IpAddr>().is_ok().into())
}
pub fn ipv4((arg,): (String,)) -> Result<Value, Error> {
Ok(arg.parse::<Ipv4Addr>().is_ok().into())
}
pub fn ipv6((arg,): (String,)) -> Result<Value, Error> {
Ok(arg.parse::<Ipv6Addr>().is_ok().into())
}
pub fn latitude((arg,): (String,)) -> Result<Value, Error> {
Ok(LATITUDE_RE.is_match(arg.as_str()).into())
}
pub fn longitude((arg,): (String,)) -> Result<Value, Error> {
Ok(LONGITUDE_RE.is_match(arg.as_str()).into())
}
pub fn numeric((arg,): (String,)) -> Result<Value, Error> {
Ok(arg.chars().all(char::is_numeric).into())
}
pub fn semver((arg,): (String,)) -> Result<Value, Error> {
Ok(Version::parse(arg.as_str()).is_ok().into())
}
pub fn url((arg,): (String,)) -> Result<Value, Error> {
Ok(Url::parse(&arg).is_ok().into())
}
pub fn uuid((arg,): (String,)) -> Result<Value, Error> {
Ok(Uuid::parse_str(arg.as_ref()).is_ok().into())
}
pub fn ulid((arg,): (String,)) -> Result<Value, Error> {
Ok(Ulid::from_string(arg.as_ref()).is_ok().into())
}
pub fn record((arg, tb): (String, Option<Value>)) -> Result<Value, Error> {
let res = match Thing::try_from(arg) {
Ok(t) => match tb {
Some(Value::Strand(tb)) => t.tb == *tb,
Some(Value::Table(tb)) => t.tb == tb.0,
Some(_) => {
return Err(Error::InvalidArguments {
name: "string::is::record()".into(),
message:
"Expected an optional string or table type for the second argument"
.into(),
})
}
None => true,
},
_ => false,
};
Ok(res.into())
}
}
pub mod similarity {
use crate::err::Error;
use crate::fnc::util::string::fuzzy::Fuzzy;
use crate::sql::Value;
use strsim;
pub fn fuzzy((a, b): (String, String)) -> Result<Value, Error> {
Ok(a.as_str().fuzzy_score(b.as_str()).into())
}
pub fn jaro((a, b): (String, String)) -> Result<Value, Error> {
Ok(strsim::jaro(&a, &b).into())
}
pub fn jaro_winkler((a, b): (String, String)) -> Result<Value, Error> {
Ok(strsim::jaro_winkler(&a, &b).into())
}
pub fn smithwaterman((a, b): (String, String)) -> Result<Value, Error> {
Ok(a.as_str().fuzzy_score(b.as_str()).into())
}
pub fn sorensen_dice((a, b): (String, String)) -> Result<Value, Error> {
Ok(strsim::sorensen_dice(&a, &b).into())
}
}
pub mod semver {
use crate::err::Error;
use crate::sql::Value;
use semver::Version;
fn parse_version(ver: &str, func: &str, msg: &str) -> Result<Version, Error> {
Version::parse(ver).map_err(|_| Error::InvalidArguments {
name: String::from(func),
message: String::from(msg),
})
}
pub fn compare((left, right): (String, String)) -> Result<Value, Error> {
let left = parse_version(
&left,
"string::semver::compare",
"Invalid semantic version string for left argument",
)?;
let right = parse_version(
&right,
"string::semver::compare",
"Invalid semantic version string for right argument",
)?;
Ok((left.cmp(&right) as i32).into())
}
pub fn major((version,): (String,)) -> Result<Value, Error> {
parse_version(&version, "string::semver::major", "Invalid semantic version")
.map(|v| v.major.into())
}
pub fn minor((version,): (String,)) -> Result<Value, Error> {
parse_version(&version, "string::semver::minor", "Invalid semantic version")
.map(|v| v.minor.into())
}
pub fn patch((version,): (String,)) -> Result<Value, Error> {
parse_version(&version, "string::semver::patch", "Invalid semantic version")
.map(|v| v.patch.into())
}
pub mod inc {
use crate::err::Error;
use crate::fnc::string::semver::parse_version;
use crate::sql::Value;
pub fn major((version,): (String,)) -> Result<Value, Error> {
parse_version(&version, "string::semver::inc::major", "Invalid semantic version").map(
|mut version| {
version.major += 1;
version.minor = 0;
version.patch = 0;
version.to_string().into()
},
)
}
pub fn minor((version,): (String,)) -> Result<Value, Error> {
parse_version(&version, "string::semver::inc::minor", "Invalid semantic version").map(
|mut version| {
version.minor += 1;
version.patch = 0;
version.to_string().into()
},
)
}
pub fn patch((version,): (String,)) -> Result<Value, Error> {
parse_version(&version, "string::semver::inc::patch", "Invalid semantic version").map(
|mut version| {
version.patch += 1;
version.to_string().into()
},
)
}
}
pub mod set {
use crate::err::Error;
use crate::fnc::string::semver::parse_version;
use crate::sql::Value;
pub fn major((version, value): (String, u64)) -> Result<Value, Error> {
parse_version(&version, "string::semver::set::major", "Invalid semantic version").map(
|mut version| {
version.major = value;
version.to_string().into()
},
)
}
pub fn minor((version, value): (String, u64)) -> Result<Value, Error> {
parse_version(&version, "string::semver::set::minor", "Invalid semantic version").map(
|mut version| {
version.minor = value;
version.to_string().into()
},
)
}
pub fn patch((version, value): (String, u64)) -> Result<Value, Error> {
parse_version(&version, "string::semver::set::patch", "Invalid semantic version").map(
|mut version| {
version.patch = value;
version.to_string().into()
},
)
}
}
}
#[cfg(test)]
mod tests {
use super::{contains, matches, replace, slice};
use crate::sql::Value;
#[test]
fn string_slice() {
fn test(initial: &str, beg: Option<isize>, end: Option<isize>, expected: &str) {
assert_eq!(slice((initial.to_owned(), beg, end)).unwrap(), Value::from(expected));
}
let string = "abcdefg";
test(string, None, None, string);
test(string, Some(2), None, &string[2..]);
test(string, Some(2), Some(3), &string[2..5]);
test(string, Some(2), Some(-1), "cdef");
test(string, Some(-2), None, "fg");
test(string, Some(-4), Some(2), "de");
test(string, Some(-4), Some(-1), "def");
let string = "你好世界";
test(string, None, None, string);
test(string, Some(1), None, "好世界");
test(string, Some(-1), None, "界");
test(string, Some(-2), Some(1), "世");
}
#[test]
fn string_contains() {
fn test(base: &str, contained: &str, expected: bool) {
assert_eq!(
contains((base.to_string(), contained.to_string())).unwrap(),
Value::from(expected)
);
}
test("", "", true);
test("", "a", false);
test("a", "", true);
test("abcde", "bcd", true);
test("abcde", "cbcd", false);
test("好世界", "世", true);
test("好世界", "你好", false);
}
#[test]
fn string_replace() {
fn test(base: &str, pattern: Value, replacement: &str, expected: &str) {
assert_eq!(
replace((base.to_string(), pattern.clone(), replacement.to_string())).unwrap(),
Value::from(expected),
"replace({},{},{})",
base,
pattern,
replacement
);
}
test("foo bar", Value::Regex("foo".parse().unwrap()), "bar", "bar bar");
test("foo bar", "bar".into(), "foo", "foo foo");
}
#[test]
fn string_matches() {
fn test(base: &str, regex: &str, expected: bool) {
assert_eq!(
matches((base.to_string(), regex.parse().unwrap())).unwrap(),
Value::from(expected),
"matches({},{})",
base,
regex
);
}
test("bar", "foo", false);
test("", "foo", false);
test("foo bar", "foo", true);
test("foo bar", "bar", true);
}
#[test]
fn is_alphanum() {
let value = super::is::alphanum((String::from("abc123"),)).unwrap();
assert_eq!(value, Value::Bool(true));
let value = super::is::alphanum((String::from("y%*"),)).unwrap();
assert_eq!(value, Value::Bool(false));
}
#[test]
fn is_alpha() {
let value = super::is::alpha((String::from("abc"),)).unwrap();
assert_eq!(value, Value::Bool(true));
let value = super::is::alpha((String::from("1234"),)).unwrap();
assert_eq!(value, Value::Bool(false));
}
#[test]
fn is_ascii() {
let value = super::is::ascii((String::from("abc"),)).unwrap();
assert_eq!(value, Value::Bool(true));
let value = super::is::ascii((String::from("中国"),)).unwrap();
assert_eq!(value, Value::Bool(false));
}
#[test]
fn is_domain() {
let value = super::is::domain((String::from("食狮.中国"),)).unwrap();
assert_eq!(value, Value::Bool(true));
let value = super::is::domain((String::from("example-.com"),)).unwrap();
assert_eq!(value, Value::Bool(false));
}
#[test]
fn is_email() {
let input = (String::from("user@[fd79:cdcb:38cc:9dd:f686:e06d:32f3:c123]"),);
let value = super::is::email(input).unwrap();
assert_eq!(value, Value::Bool(true));
let input = (String::from("john..doe@example.com"),);
let value = super::is::email(input).unwrap();
assert_eq!(value, Value::Bool(false));
}
#[test]
fn is_hexadecimal() {
let value = super::is::hexadecimal((String::from("00FF00"),)).unwrap();
assert_eq!(value, Value::Bool(true));
let value = super::is::hexadecimal((String::from("SurrealDB"),)).unwrap();
assert_eq!(value, Value::Bool(false));
}
#[test]
fn is_ip() {
let value = super::is::ip((String::from("127.0.0.1"),)).unwrap();
assert_eq!(value, Value::Bool(true));
let value = super::is::ip((String::from("127.0.0"),)).unwrap();
assert_eq!(value, Value::Bool(false));
}
#[test]
fn is_ipv4() {
let value = super::is::ipv4((String::from("127.0.0.1"),)).unwrap();
assert_eq!(value, Value::Bool(true));
let value = super::is::ipv4((String::from("127.0.0"),)).unwrap();
assert_eq!(value, Value::Bool(false));
}
#[test]
fn is_ipv6() {
let value = super::is::ipv6((String::from("::1"),)).unwrap();
assert_eq!(value, Value::Bool(true));
let value = super::is::ipv6((String::from("200t:db8::"),)).unwrap();
assert_eq!(value, Value::Bool(false));
}
#[test]
fn is_latitude() {
let value = super::is::latitude((String::from("-0.118092"),)).unwrap();
assert_eq!(value, Value::Bool(true));
let value = super::is::latitude((String::from("12345"),)).unwrap();
assert_eq!(value, Value::Bool(false));
}
#[test]
fn is_longitude() {
let value = super::is::longitude((String::from("91.509865"),)).unwrap();
assert_eq!(value, Value::Bool(true));
let value = super::is::longitude((String::from("-91.509865"),)).unwrap();
assert_eq!(value, Value::Bool(true));
let value = super::is::longitude((String::from("-180.00000"),)).unwrap();
assert_eq!(value, Value::Bool(true));
let value = super::is::longitude((String::from("-180.00001"),)).unwrap();
assert_eq!(value, Value::Bool(false));
let value = super::is::longitude((String::from("180.00000"),)).unwrap();
assert_eq!(value, Value::Bool(true));
let value = super::is::longitude((String::from("180.00001"),)).unwrap();
assert_eq!(value, Value::Bool(false));
let value = super::is::longitude((String::from("12345"),)).unwrap();
assert_eq!(value, Value::Bool(false));
}
#[test]
fn is_numeric() {
let value = super::is::numeric((String::from("12345"),)).unwrap();
assert_eq!(value, Value::Bool(true));
let value = super::is::numeric((String::from("abcde"),)).unwrap();
assert_eq!(value, Value::Bool(false));
}
#[test]
fn is_semver() {
let value = super::is::semver((String::from("1.0.0"),)).unwrap();
assert_eq!(value, Value::Bool(true));
let value = super::is::semver((String::from("1.0"),)).unwrap();
assert_eq!(value, Value::Bool(false));
}
#[test]
fn is_uuid() {
let input = (String::from("123e4567-e89b-12d3-a456-426614174000"),);
let value = super::is::uuid(input).unwrap();
assert_eq!(value, Value::Bool(true));
let input = (String::from("foo-bar"),);
let value = super::is::uuid(input).unwrap();
assert_eq!(value, Value::Bool(false));
}
#[test]
fn html_encode() {
let value = super::html::encode((String::from("<div>Hello world!</div>"),)).unwrap();
assert_eq!(value, Value::Strand("<div>Hello world!</div>".into()));
let value = super::html::encode((String::from("SurrealDB"),)).unwrap();
assert_eq!(value, Value::Strand("SurrealDB".into()));
}
#[test]
fn html_sanitize() {
let value = super::html::sanitize((String::from("<div>Hello world!</div>"),)).unwrap();
assert_eq!(value, Value::Strand("<div>Hello world!</div>".into()));
let value = super::html::sanitize((String::from("XSS<script>attack</script>"),)).unwrap();
assert_eq!(value, Value::Strand("XSS".into()));
}
#[test]
fn semver_compare() {
let value = super::semver::compare((String::from("1.2.3"), String::from("1.0.0"))).unwrap();
assert_eq!(value, Value::from(1));
let value = super::semver::compare((String::from("1.2.3"), String::from("1.2.3"))).unwrap();
assert_eq!(value, Value::from(0));
let value = super::semver::compare((String::from("1.0.0"), String::from("1.2.3"))).unwrap();
assert_eq!(value, Value::from(-1));
}
#[test]
fn semver_extract() {
let value = super::semver::major((String::from("1.2.3"),)).unwrap();
assert_eq!(value, Value::from(1));
let value = super::semver::minor((String::from("1.2.3"),)).unwrap();
assert_eq!(value, Value::from(2));
let value = super::semver::patch((String::from("1.2.3"),)).unwrap();
assert_eq!(value, Value::from(3));
}
#[test]
fn semver_increment() {
let value = super::semver::inc::major((String::from("1.2.3"),)).unwrap();
assert_eq!(value, Value::from("2.0.0"));
let value = super::semver::inc::minor((String::from("1.2.3"),)).unwrap();
assert_eq!(value, Value::from("1.3.0"));
let value = super::semver::inc::patch((String::from("1.2.3"),)).unwrap();
assert_eq!(value, Value::from("1.2.4"));
}
#[test]
fn semver_set() {
let value = super::semver::set::major((String::from("1.2.3"), 9)).unwrap();
assert_eq!(value, Value::from("9.2.3"));
let value = super::semver::set::minor((String::from("1.2.3"), 9)).unwrap();
assert_eq!(value, Value::from("1.9.3"));
let value = super::semver::set::patch((String::from("1.2.3"), 9)).unwrap();
assert_eq!(value, Value::from("1.2.9"));
}
}