1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
use super::*;
use crate::element::*;
use crate::error::{Error, Result};
use regex::Regex;
use serde::{Deserialize, Serialize};
#[inline]
fn is_false(v: &bool) -> bool {
!v
}
#[inline]
fn u32_is_zero(v: &u32) -> bool {
*v == 0
}
#[inline]
fn u32_is_max(v: &u32) -> bool {
*v == u32::MAX
}
#[inline]
fn normalize_is_none(v: &Normalize) -> bool {
matches!(v, Normalize::None)
}
/// Validator for UTF-8 strings.
///
/// This validator type will only pass string values. Validation passes if:
///
/// - The value's length in bytes is less than or equal to the value in `max_len`.
/// - The value's length in bytes is greater than or equal to the value in `min_len`.
/// - The value's number of unicode characters is less than or equal to the value in `max_char`.
/// - The value's number of unicode characters is greater than or equal to the value in `min_char`.
/// - If a regular expression is present in `matches`, the possibly-normalized value must match
/// against the expression.
/// - If the `in` list is not empty, the possibly-normalized value must be among the values in the list.
/// - The possibly-normalized value must not be among the values in the `nin` list.
///
/// The `normalize` field may be set to `None`, `NFC`, or `NFKC`, corresponding to Unicode
/// normalization forms. When checked for `in`, `nin`, and `matches`, the value is first put
/// into the selected normalization form, and any `in` and `nin` list strings are normalized as
/// well.
///
/// # Defaults
///
/// Fields that aren't specified for the validator use their defaults instead. The defaults for
/// each field are:
///
/// - comment: ""
/// - in_list: empty
/// - nin_list: empty
/// - matches: None
/// - max_len: u32::MAX
/// - min_len: 0
/// - max_char: u32::MAX
/// - min_char: 0
/// - normalize: Normalize::None
/// - query: false
/// - regex: false
/// - size: false
///
/// # Regular Expressions
///
/// Regular expressions can be set for StrValidator using the `matches` field, but should be used
/// sparingly, and should generally be avoided if possible. If they must be used, be aware of their
/// limitations due to their memory, computation, and general consistency issues.
///
/// Regular expression can rapidly use up a lot of memory when compiled. This is one of the reasons
/// why it is inadvisable to accept and use unknown schemas. For queries, a schema will have some
/// upper limit on the number of allowed regular expressions, in order to mitigate possible memory
/// exhaustion.
///
/// Beyond their memory cost, regular expressions have a second problem: there's not really a
/// universal standard for regular expressions; at least, not one that is rigidly followed in
/// implementations. The Rust fog-pack library uses the [`regex`](https://crates.io/crates/regex)
/// crate for regular expressions, supporting Perl-style expression syntax, unicode character
/// classes, and flags for unicode support and case insensitivity. Look around and backreferences
/// are *not* supported. It is hoped that other implementations will support the same syntax, with
/// the same limitations on look around and backreferences.
///
/// Finally, because unicode support is enabled, it is possible to have a string that fails on one
/// library version and succeeds on another due to Unicode versions changing their character class
/// definitions. This is a corner case, but any schema writer should be aware of it as a
/// possibility.
///
/// # Unicode NFC and NFKC
///
/// Unicode normalization can be tricky to get right. Strings are never required to be in a
/// particular normalization form, as it may be that the creator or user of a string specifically
/// wants no normalization, but a query or schema may desire it. To this end, normalization of the
/// string being validated, as well as the `in` and `nin` lists' strings can all be done
/// before running validation. This is settable through the `normalization` field, which can be
/// `None`, `NFC`, or `NFKC`.
///
#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields, default)]
pub struct StrValidator {
/// An optional comment explaining the validator.
#[serde(skip_serializing_if = "String::is_empty")]
pub comment: String,
/// A vector of specific allowed values, stored under the `in` field. If empty, this vector is not checked against.
#[serde(rename = "in", skip_serializing_if = "Vec::is_empty")]
pub in_list: Vec<String>,
/// A vector of specific unallowed values, stored under the `nin` field.
#[serde(rename = "nin", skip_serializing_if = "Vec::is_empty")]
pub nin_list: Vec<String>,
/// A regular expression that the value must match against.
#[serde(skip_serializing_if = "Option::is_none", with = "serde_regex")]
pub matches: Option<Box<Regex>>,
/// The maximum allowed number of bytes in the string value.
#[serde(skip_serializing_if = "u32_is_max")]
pub max_len: u32,
/// The minimum allowed number of bytes in the string value.
#[serde(skip_serializing_if = "u32_is_zero")]
pub min_len: u32,
/// The maximum allowed number of unicode characters in the string value.
#[serde(skip_serializing_if = "u32_is_max")]
pub max_char: u32,
/// The minimum allowed number of unicode characters in the string value.
#[serde(skip_serializing_if = "u32_is_zero")]
pub min_char: u32,
/// The Unicode normalization setting.
#[serde(skip_serializing_if = "normalize_is_none")]
pub normalize: Normalize,
/// If true, queries against matching spots may have values in the `in` or `nin` lists.
#[serde(skip_serializing_if = "is_false")]
pub query: bool,
/// If true, queries against matching spots may use the `matches` value.
#[serde(skip_serializing_if = "is_false")]
pub regex: bool,
/// If true, queries against matching spots may set the `max_len`, `min_len`, `max_char`, and
/// `min_char` values to non-defaults.
#[serde(skip_serializing_if = "is_false")]
pub size: bool,
}
impl PartialEq for StrValidator {
fn eq(&self, rhs: &Self) -> bool {
(self.comment == rhs.comment)
&& (self.in_list == rhs.in_list)
&& (self.nin_list == rhs.nin_list)
&& (self.max_len == rhs.max_len)
&& (self.min_len == rhs.min_len)
&& (self.max_char == rhs.max_char)
&& (self.min_char == rhs.min_char)
&& (self.normalize == rhs.normalize)
&& (self.query == rhs.query)
&& (self.regex == rhs.regex)
&& (self.size == rhs.size)
&& match (&self.matches, &rhs.matches) {
(None, None) => true,
(Some(_), None) => false,
(None, Some(_)) => false,
(Some(lhs), Some(rhs)) => lhs.as_str() == rhs.as_str(),
}
}
}
impl std::default::Default for StrValidator {
fn default() -> Self {
Self {
comment: String::new(),
in_list: Vec::new(),
nin_list: Vec::new(),
matches: None,
max_len: u32::MAX,
min_len: u32::MIN,
max_char: u32::MAX,
min_char: u32::MIN,
normalize: Normalize::None,
query: false,
regex: false,
size: false,
}
}
}
impl StrValidator {
/// Make a new validator with the default configuration.
pub fn new() -> Self {
Self::default()
}
/// Set a comment for the validator.
pub fn comment(mut self, comment: impl Into<String>) -> Self {
self.comment = comment.into();
self
}
/// Set the maximum number of allowed bytes.
pub fn max_len(mut self, max_len: u32) -> Self {
self.max_len = max_len;
self
}
/// Set the minimum number of allowed bytes.
pub fn min_len(mut self, min_len: u32) -> Self {
self.min_len = min_len;
self
}
/// Set the maximum number of allowed characters.
pub fn max_char(mut self, max_char: u32) -> Self {
self.max_char = max_char;
self
}
/// Set the minimum number of allowed characters.
pub fn min_char(mut self, min_char: u32) -> Self {
self.min_char = min_char;
self
}
/// Set the unicode normalization form to use for `in`, `nin`, and `matches` checks.
pub fn normalize(mut self, normalize: Normalize) -> Self {
self.normalize = normalize;
self
}
/// Set the regular expression to check against.
pub fn matches(mut self, matches: Regex) -> Self {
self.matches = Some(Box::new(matches));
self
}
/// Add a value to the `in` list.
pub fn in_add(mut self, add: impl Into<String>) -> Self {
self.in_list.push(add.into());
self
}
/// Add a value to the `nin` list.
pub fn nin_add(mut self, add: impl Into<String>) -> Self {
self.nin_list.push(add.into());
self
}
/// Set whether or not queries can use the `in` and `nin` lists.
pub fn query(mut self, query: bool) -> Self {
self.query = query;
self
}
/// Set whether or not queries can use the `bits_clr` and `bits_set` values.
pub fn regex(mut self, regex: bool) -> Self {
self.regex = regex;
self
}
/// Set whether or not queries can use the `max_len`, `min_len`, `max_char`, and `min_char`
/// values.
pub fn size(mut self, ord: bool) -> Self {
self.size = ord;
self
}
/// Build this into a [`Validator`] enum.
pub fn build(self) -> Validator {
Validator::Str(self)
}
pub(crate) fn validate(&self, parser: &mut Parser) -> Result<()> {
// Get element
let elem = parser
.next()
.ok_or_else(|| Error::FailValidate("expected a string".to_string()))??;
let val = if let Element::Str(v) = elem {
v
} else {
return Err(Error::FailValidate(format!(
"expected Str, got {}",
elem.name()
)));
};
// Length Checks
if (val.len() as u32) > self.max_len {
return Err(Error::FailValidate(
"String is longer than max_len".to_string(),
));
}
if (val.len() as u32) < self.min_len {
return Err(Error::FailValidate(
"String is shorter than min_len".to_string(),
));
}
if self.max_char < u32::MAX || self.min_char > 0 {
let len_char = bytecount::num_chars(val.as_bytes()) as u32;
if len_char > self.max_char {
return Err(Error::FailValidate(
"String is longer than max_len".to_string(),
));
}
if len_char < self.min_char {
return Err(Error::FailValidate(
"String is shorter than min_len".to_string(),
));
}
}
// Content checks
use unicode_normalization::{
is_nfc_quick, is_nfkc_quick, IsNormalized, UnicodeNormalization,
};
match self.normalize {
Normalize::None => {
if !self.in_list.is_empty() && !self.in_list.iter().any(|v| *v == val) {
return Err(Error::FailValidate(
"String is not on `in` list".to_string(),
));
}
if self.nin_list.iter().any(|v| *v == val) {
return Err(Error::FailValidate("String is on `nin` list".to_string()));
}
if let Some(ref regex) = self.matches {
if !regex.is_match(val) {
return Err(Error::FailValidate(
"String doesn't match regular expression".to_string(),
));
}
}
}
Normalize::NFC => {
let temp_string: String;
let val = match is_nfc_quick(val.chars()) {
IsNormalized::Yes => val,
_ => {
temp_string = val.nfc().collect::<String>();
temp_string.as_str()
}
};
if !self.in_list.is_empty() && !self.in_list.iter().any(|v| v.nfc().eq(val.chars()))
{
return Err(Error::FailValidate(
"String is not on `in` list".to_string(),
));
}
if self.nin_list.iter().any(|v| v.nfc().eq(val.chars())) {
return Err(Error::FailValidate("String is on `nin` list".to_string()));
}
if let Some(ref regex) = self.matches {
if !regex.is_match(val) {
return Err(Error::FailValidate(
"String doesn't match regular expression".to_string(),
));
}
}
}
Normalize::NFKC => {
let temp_string: String;
let val = match is_nfkc_quick(val.chars()) {
IsNormalized::Yes => val,
_ => {
temp_string = val.nfkc().collect::<String>();
temp_string.as_str()
}
};
if !self.in_list.is_empty()
&& !self.in_list.iter().any(|v| v.nfkc().eq(val.chars()))
{
return Err(Error::FailValidate(
"String is not on `in` list".to_string(),
));
}
if self.nin_list.iter().any(|v| v.nfkc().eq(val.chars())) {
return Err(Error::FailValidate("String is on `nin` list".to_string()));
}
if let Some(ref regex) = self.matches {
if !regex.is_match(val) {
return Err(Error::FailValidate(
"String doesn't match regular expression".to_string(),
));
}
}
}
}
Ok(())
}
fn query_check_str(&self, other: &Self) -> bool {
(self.query || (other.in_list.is_empty() && other.nin_list.is_empty()))
&& (self.regex || other.matches.is_none())
&& (self.size
|| (u32_is_max(&other.max_len)
&& u32_is_zero(&other.min_len)
&& u32_is_max(&other.max_char)
&& u32_is_zero(&other.min_char)))
}
pub(crate) fn query_check(&self, other: &Validator) -> bool {
match other {
Validator::Str(other) => self.query_check_str(other),
Validator::Multi(list) => list.iter().all(|other| match other {
Validator::Str(other) => self.query_check_str(other),
_ => false,
}),
Validator::Any => true,
_ => false,
}
}
}