-
-
Notifications
You must be signed in to change notification settings - Fork 8
/
censor.rs
1164 lines (1035 loc) · 41.6 KB
/
censor.rs
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
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
use crate::buffer_proxy_iterator::BufferProxyIterator;
use crate::feature_cell::FeatureCell;
use crate::mtch::*;
use crate::trie::*;
use crate::{is_whitespace, Type};
use crate::{Map, Set};
use lazy_static::lazy_static;
use std::iter::Filter;
use std::mem;
use std::str::Chars;
use unicode_categories::UnicodeCategories;
use unicode_normalization::{Decompositions, Recompositions, UnicodeNormalization};
lazy_static! {
static ref TRIE: FeatureCell<Trie> = FeatureCell::new(
include_str!("profanity.csv")
.lines()
.skip(1)
.map(|line| {
let mut split = line.split(',');
(
split.next().unwrap(),
Type::from_weights(
&[0; Type::WEIGHT_COUNT].map(|_| split.next().unwrap().parse().unwrap()),
),
)
})
.chain(
include_str!("safe.txt")
.lines()
.filter(|line| !line.is_empty() && !line.starts_with('#'))
.map(|line| { (line, Type::SAFE) })
)
.chain(
include_str!("false_positives.txt")
.lines()
.filter(|line| !line.is_empty())
.map(|line| { (line, Type::NONE) })
)
.collect()
);
static ref REPLACEMENTS: Map<char, &'static str> = include_str!("replacements.csv")
.lines()
.filter(|line| !line.is_empty())
.map(|line| {
let comma = line.find(',').unwrap();
(line[..comma].chars().next().unwrap(), &line[comma + 1..])
})
.collect();
static ref BANNED: FeatureCell<Set<char>> = FeatureCell::new(
include_str!("banned_chars.txt")
.lines()
.filter(|s| s.starts_with("U+"))
.map(|s| {
u32::from_str_radix(&s[2..], 16)
.ok()
.and_then(char::from_u32)
.unwrap()
})
.collect()
);
}
/// Censor is a flexible profanity filter that can analyze and/or censor arbitrary text.
///
/// You can also make use of `Censor` via traits `CensorStr` and `CensorIter`, which allow inline
/// checking and censoring of `&str` and `Iterator<Item = char>` respectively.
pub struct Censor<I: Iterator<Item = char>> {
/// Options
ignore_false_positives: bool,
ignore_self_censoring: bool,
censor_first_character_threshold: Type,
//preserve_accents: bool,
censor_replacement: char,
censor_threshold: Type,
/// Where potential matches are kept between calls to Self::next.
matches: Set<Match>,
/// Where potential matches are temporarily shuffled. Only allocate this once.
matches_tmp: Set<Match>,
/// Whether the last character can be considered a separator.
separate: bool,
/// The last position matched against.
last_pos: usize,
/// An accumulation of the different types of inappropriateness.
typ: Type,
/// Counters (mainly for spam detection).
uppercase: u8,
repetitions: u8,
last: Option<char>,
gibberish: u8,
replacements: u8,
/// How many instances of censor replacement in the raw text?
self_censoring: u8,
/// Is the input completely safe.
safe: bool,
#[cfg(any(feature = "find_false_positives", feature = "trace"))]
total_matches: usize,
#[cfg(any(feature = "find_false_positives", feature = "trace"))]
total_match_characters: usize,
/// Where matches are kept after they are complete but may be cancelled due to false positives.
pending_commit: Vec<Match>,
/// A buffer of the input that stores unconfirmed characters (may need to censor before flushing).
/// This is so the censored output is unaffected by the subsequent iterator machinery.
buffer: BufferProxyIterator<Recompositions<Filter<Decompositions<I>, fn(&char) -> bool>>>,
/// Whether already appended a space at the end.
space_appended: bool,
/// Whether all processing of characters has completed.
done: bool,
}
impl<'a> Censor<Chars<'a>> {
/// Creates a `Censor` from a `&str`, ready to censor or analyze it.
pub fn from_str(s: &'a str) -> Self {
Self::new(s.chars())
}
}
impl<I: Iterator<Item = char>> Censor<I> {
/// Allocates a new `Censor` for analyzing and/or censoring text.
pub fn new(text: I) -> Self {
Self {
// Default options
ignore_false_positives: false,
ignore_self_censoring: false,
censor_first_character_threshold: Type::OFFENSIVE & Type::SEVERE,
//preserve_accents: false,
censor_replacement: '*',
censor_threshold: Default::default(),
// The beginning of the sequence is a separator.
separate: true,
// Nothing was detected yet.
typ: Type::NONE,
uppercase: 0,
repetitions: 0,
last: None,
gibberish: 0,
replacements: 0,
self_censoring: 0,
safe: false,
space_appended: false,
done: false,
last_pos: usize::MAX,
#[cfg(any(feature = "find_false_positives", feature = "trace"))]
total_matches: 0,
#[cfg(any(feature = "find_false_positives", feature = "trace"))]
total_match_characters: 0,
matches: Set::default(),
matches_tmp: Set::default(),
pending_commit: Vec::new(),
buffer: Self::buffer_from(text),
}
}
fn buffer_from(
text: I,
) -> BufferProxyIterator<Recompositions<Filter<Decompositions<I>, fn(&char) -> bool>>> {
// Detects if a char isn't a diacritical mark (accent) or banned, such that such characters may be
// filtered on that basis.
fn isnt_mark_nonspacing_or_banned(c: &char) -> bool {
!(c.is_mark_nonspacing() || BANNED.contains(c))
}
BufferProxyIterator::new(
text
// The following three transformers are to ignore diacritical marks.
.nfd()
.filter(isnt_mark_nonspacing_or_banned as fn(&char) -> bool)
.nfc(),
)
}
/// Resets the `Censor` with new text. Does not change any configured options.
/// This avoids reallocation of internal buffers on the heap.
///
/// TODO: This is untested.
#[cfg(feature = "reset_censor")]
pub fn reset(&mut self, text: I) {
self.separate = true;
self.typ = Type::NONE;
self.uppercase = 0;
self.last = None;
self.repetitions = 0;
self.gibberish = 0;
self.replacements = 0;
self.self_censoring = 0;
self.space_appended = false;
self.done = false;
self.last_pos = usize::MAX;
#[cfg(any(feature = "find_false_positives", feature = "trace"))]
self.total_matches = 0;
#[cfg(any(feature = "find_false_positives", feature = "trace"))]
self.total_match_characters = 0;
self.matches.clear();
self.matches_tmp.clear();
self.pending_commit.clear();
self.buffer = Self::buffer_from(text);
}
/// Selects a threshold to apply while censoring. Only words that meet or exceed the threshold
/// are censored.
///
/// At present, [`Type::SPAM`] cannot be censored.
///
/// The default is [`Type::Inappropriate`].
pub fn with_censor_threshold(&mut self, censor_threshold: Type) -> &mut Self {
self.censor_threshold = censor_threshold;
self
}
/// Censor words like "sh*t" in "push it," which heavily increases false positives, but
/// slightly decreases false negatives.
///
/// The default is `false`.
pub fn with_ignore_false_positives(&mut self, ignore_false_positives: bool) -> &mut Self {
self.ignore_false_positives = ignore_false_positives;
self
}
/// Do not count instances of censor replacement in the input text as possible profanity.
///
/// If `false`, the input `"****"` will be assumed to be profane since if censor replacement is
/// set to `'*'`. This can help in cases like `"mother******"` where, if the user hadn't self
/// censored, the censored version would have been `"m***********"`.
///
/// At present, only affects analysis and not censoring.
///
/// The default is `false`.
pub fn with_ignore_self_censoring(&mut self, ignore_self_censoring: bool) -> &mut Self {
self.ignore_self_censoring = ignore_self_censoring;
self
}
/// Censor all characters e.g. "xxxx," instead of all but the first e.g. "fxxx," if the word
/// meets this threshold.
///
/// The default is `false`.
pub fn with_censor_first_character_threshold(
&mut self,
censor_first_character_threshold: Type,
) -> &mut Self {
self.censor_first_character_threshold = censor_first_character_threshold;
self
}
/*
/// Preserve diacritics/accents, at the cost of detecting accented words such as f̸̪͇͘ų̷̖̽c̸͙̎̚k̶͚̗͛.
///
/// The default is false.
pub fn with_preserve_accents(&mut self, preserve_accents: bool) {
self.preserve_accents = preserve_accents;
}
*/
/// Sets the character used to censor detected words.
///
/// The default is `'*'`.
pub fn with_censor_replacement(&mut self, censor_replacement: char) -> &mut Self {
self.censor_replacement = censor_replacement;
self
}
/// Produces a censored string. If called, it must be the first form of processing. It
/// entirely consumes and censors the input characters.
///
/// # Unfortunate Side Effects
///
/// All diacritical marks (accents) are removed by the current implementation. This is subject
/// to change, as a better implementation would make this optional.
///
/// # Panics
///
/// If called after analyze or a previous call to censor (except if reset is called in between).
pub fn censor(&mut self) -> String {
assert!(
!self.buffer.index().is_some(),
"censor must be called before any other form of processing"
);
self.collect()
}
/// Fully analyzes a the input characters, to determine the type of inappropriateness present, if any.
///
/// The return value can be introspected with `Type::is`.
pub fn analyze(&mut self) -> Type {
self.ensure_done();
self.analysis()
}
/// See the documentation of censor and analyze.
pub fn censor_and_analyze(&mut self) -> (String, Type) {
// It is important that censor is called first, so that the input is processed.
let censored = self.censor();
// After that, analysis is ready to call.
(censored, self.analysis())
}
/// Converts internal weights to a `Type`.
fn analysis(&self) -> Type {
self.typ | self.safe_self_censoring_and_spam_detection()
}
#[cfg(any(feature = "find_false_positives", feature = "trace"))]
pub fn total_matches(&self) -> usize {
self.total_matches
}
#[cfg(any(feature = "find_false_positives", feature = "trace"))]
pub fn total_match_characters(&self) -> usize {
self.total_match_characters
}
fn ensure_done(&mut self) {
if !self.done {
for _ in self {}
}
}
fn safe_self_censoring_and_spam_detection(&self) -> Type {
let safe = if self.safe { Type::SAFE } else { Type::NONE };
if self.last_pos < 6 {
// Short strings consisting of a single acronym are problematic percentage-wise.
return safe;
}
// Total opportunities for spam and self censoring. A bias is added so that a few words in a
// relatively short string won't create massive percentages.
let total = self.last_pos.saturating_add(6).min(u16::MAX as usize) as u16;
// Total spam.
let spam = self
.uppercase
.max(self.repetitions)
.max(self.gibberish / 2)
.max(self.replacements) as u16;
// Calculate percents.
let percent_spam = 100 * spam / total;
let percent_self_censoring = 100 * self.self_censoring as u16 / total;
// Assess amount of spam.
let spam = if percent_spam >= 70 && self.last_pos >= 20 {
Type::SPAM & Type::SEVERE
} else if percent_spam >= 50 && self.last_pos >= 10 {
Type::SPAM & Type::MODERATE
} else if percent_spam >= 30 {
Type::SPAM & Type::MILD
} else {
Type::NONE
};
// Assess amount of self-censoring.
let self_censoring = if !self.ignore_self_censoring && percent_self_censoring > 20 {
Type::PROFANE & Type::MILD
} else {
Type::NONE
};
safe | spam | self_censoring
}
}
impl<I: Iterator<Item = char>> Iterator for Censor<I> {
type Item = char;
/// Retrieves the next (potentially censored) character.
fn next(&mut self) -> Option<Self::Item> {
while let Some(raw_c) = self.buffer.next().or_else(|| {
if self.space_appended {
None
} else {
self.space_appended = true;
Some(' ')
}
}) {
if !self.space_appended && raw_c != '!' && raw_c != '.' && raw_c != '?' {
// The input is not over yet, so any previous notion of safety is irrelevant.
self.safe = false;
}
let pos = self.buffer.index();
self.uppercase = self.uppercase.saturating_add(raw_c.is_uppercase() as u8);
let skippable = raw_c.is_punctuation()
|| raw_c.is_separator()
|| is_whitespace(raw_c)
|| matches!(raw_c, '(' | ')');
let replacement = REPLACEMENTS.get(&raw_c);
#[cfg(feature = "trace")]
println!(
"Read '{}', skippable={}, replacing with={:?}",
raw_c, skippable, replacement
);
if (!self.separate || self.last == Some(self.censor_replacement))
&& raw_c == self.censor_replacement
{
// Censor replacement found but not beginning of word.
self.self_censoring = self.self_censoring.saturating_add(1);
}
if let Some(last) = self.last {
if raw_c == last {
self.repetitions = self.repetitions.saturating_add(1);
}
// Characters on the home-row of a QWERTY keyboard.
fn is_gibberish(c: char) -> bool {
matches!(c, 'a' | 's' | 'd' | 'f' | 'j' | 'k' | 'l' | ';')
}
// Single gibberish characters don't count. Must have been preceded by another gibberish character.
if is_gibberish(raw_c) && is_gibberish(last) {
self.gibberish = self.gibberish.saturating_add(1);
}
}
if let Some(pos) = pos {
// Must special-case all skippable, non-replaced characters that may start
// a profanity, so that these profanities are detected.
//
// Not adding a match is mainly an optimization.
if !(skippable && replacement.is_none() && !matches!(raw_c, ' ' | '_')) {
// Seed a new match for every character read.
self.matches.insert(Match {
node: &TRIE.root,
start: pos, // will immediately be incremented if match is kept.
end: usize::MAX, // sentinel.
last: 0 as char, // sentinel.
space_before: self.separate,
space_after: false, // unknown at this time.
spaces: 0,
replacements: 0,
});
}
}
/*
let skippable = match c {
' ' | '~' | '-' | '−' | '_' | '.' | '!' | '?' | ',' | '*' | '"' | '\'' | '\n' | '\r'
| '\t' => true,
_ => false,
};
*/
self.separate = skippable;
if self.separate {
for pending in self.pending_commit.iter_mut() {
if pending.end == self.last_pos {
pending.space_after = true;
}
}
}
let mut drain_start: Option<usize> = None;
let mut safety_end = usize::MAX;
let mut replacement_counted = false;
let raw_c_lower = raw_c.to_lowercase().next().unwrap();
mem::swap(&mut self.matches, &mut self.matches_tmp);
for c in replacement
.unwrap_or(&&*raw_c.encode_utf8(&mut [0; 4]))
.chars()
{
// This replacement raises absolutely zero suspicion.
let benign_replacement = c == raw_c_lower;
// This counts as a replacement, mainly for spam detection purposes.
let countable_replacement = !(replacement_counted
|| benign_replacement
|| raw_c.is_ascii_alphabetic()
|| (raw_c.is_ascii_digit()
&& self.last.map(|l| l.is_ascii_digit()).unwrap_or(false)));
if countable_replacement {
self.replacements = self.replacements.saturating_add(1);
replacement_counted = true;
}
#[cfg(feature = "trace")]
println!(
" - Replacement '{}', benign={}, countable={}",
c, benign_replacement, countable_replacement
);
for m in self.matches_tmp.iter() {
let m = m.clone();
safety_end = safety_end.min(m.start);
#[cfg(feature = "trace")]
println!(
" - Consider match \"{}\" with spaces={}",
m.node.trace, m.spaces
);
if (skippable || c == m.last) && m.start != pos.unwrap_or(0) {
// Undo remove.
#[cfg(feature = "trace")]
println!("undo remove \"{}\" where last={}, node last={:?} and initial spaces={}", m.node.trace, m.last, m.node.last, m.spaces);
let undo_m = Match {
// Here, '.' is primarily for allowing ellipsis ("...") as a form of
// space.
// ( and ) are for ignoring appositive phrases.
// Checking node.last is to collapse multiple spaces into one, to avoid
// invalidating false positives in cases like didn't (it where ( is a space.
spaces: m.spaces.saturating_add(
((matches!(c, ' ' | '.' | ',' | ';' | '…' | '(' | ')')
|| c != raw_c)
&& self.separate
&& m.node.last != Some(' ')
&& c != '\'') as u8,
),
replacements: m
.replacements
.saturating_add((!benign_replacement && !self.separate) as u8),
..m
};
if let Some(existing) = self.matches.get(&undo_m) {
let replacement = existing.combine(&undo_m);
self.matches.replace(replacement);
} else {
self.matches.insert(undo_m);
}
}
if let Some(next) = m.node.children.get(&c) {
let next_m = Match {
node: next,
spaces: m
.spaces
.saturating_add((c != raw_c && self.separate && c != '\'') as u8),
replacements: m
.replacements
.saturating_add((!benign_replacement && !self.separate) as u8),
last: c,
..m
};
#[cfg(feature = "trace")]
println!(
" - Next is \"{}\", with spaces={}, replacements = {}",
next.trace, next_m.spaces, next_m.replacements
);
if next.word {
if next_m.node.typ.is(Type::SAFE)
&& next_m.start == 0
&& next_m.spaces == 0
&& !self.ignore_false_positives
{
// Everything in the input until now is safe.
self.safe = true;
}
#[cfg(feature = "trace")]
if !next_m.node.typ.is(Type::ANY) {
if self.ignore_false_positives {
print!("ignoring");
} else {
print!("found");
}
println!(
" false positive \"{}\", spaces={}, replacements={}",
next_m.node.trace, next_m.spaces, next_m.replacements
);
}
if next_m.node.typ.is(Type::ANY) {
self.pending_commit.push(Match {
end: pos.unwrap(),
..next_m
});
} else if next_m.spaces == 0
&& next_m.replacements == 0
&& !self.ignore_false_positives
{
// Is false positive, so invalidate internal matches.
#[cfg(feature = "trace")]
println!("Found false positive {}", next_m.node.trace);
drain_start = Some(
drain_start
.map(|start| start.min(next_m.start))
.unwrap_or(next_m.start),
);
}
}
if let Some(existing) = self.matches.get(&next_m) {
let replacement = existing.combine(&next_m);
self.matches.replace(replacement);
} else {
self.matches.insert(next_m);
}
}
}
}
self.matches_tmp.clear();
self.last = Some(raw_c);
if let Some(pos) = pos {
self.last_pos = pos;
}
let typ = &mut self.typ;
let spy = &mut self.buffer;
let censor_threshold = self.censor_threshold;
let censor_first_character_threshold = self.censor_first_character_threshold;
let censor_replacement = self.censor_replacement;
#[cfg(any(feature = "find_false_positives", feature = "trace"))]
let total_matches = &mut self.total_matches;
#[cfg(any(feature = "find_false_positives", feature = "trace"))]
let total_match_characters = &mut self.total_match_characters;
self.pending_commit.retain(|pending| {
#[cfg(feature = "trace")]
println!("Consider whether to cancel pending commit {} with start={} against drain_start={:?}", pending.node.trace, pending.start, drain_start);
// Cancel due to false positive.
if let Some(start) = drain_start {
if pending.start >= start {
#[cfg(feature = "trace")]
println!("Cancelled {}", pending.node.trace);
return false;
}
}
// Can pre-commit due to lack of false positive matches.
if pending.end < safety_end {
if pending.commit(
typ,
spy,
censor_threshold,
censor_first_character_threshold,
censor_replacement,
) {
#[cfg(any(feature = "find_false_positives", feature = "trace"))]
{
*total_matches += 1;
*total_match_characters += pending.end - pending.start;
}
}
return false;
}
// At this point, don't know whether this match will be committed or cancelled, so
// return.
true
});
// Yield one character if possible.
if let Some(spy_next_index) = self.buffer.spy_next_index() {
// This covers all in-flight matches.
let mut safe_until = spy_next_index < safety_end;
// This covers all pending commit matches.
for pending in &self.pending_commit {
if pending.start <= spy_next_index {
safe_until = false;
break;
}
}
if safe_until {
return self.buffer.spy_next();
}
}
}
for pending in mem::take(&mut self.pending_commit) {
if pending.commit(
&mut self.typ,
&mut self.buffer,
self.censor_threshold,
self.censor_first_character_threshold,
self.censor_replacement,
) {
#[cfg(any(feature = "find_false_positives", feature = "trace"))]
{
self.total_matches += 1;
self.total_match_characters += pending.end - pending.start;
}
}
}
if let Some(c) = self.buffer.spy_next() {
return Some(c);
}
self.done = true;
None
}
}
/// CensorStr makes it easy to sanitize a `String` or `&str` by calling `.censor()`.
pub trait CensorStr: Sized {
/// The output is a newly allocated, censored string.
fn censor(self) -> String;
/// Returns `true` if the text is inappropriate.
fn is_inappropriate(self) -> bool {
self.is(Type::INAPPROPRIATE)
}
/// Returns `true` if text meets the provided threshold.
fn is(self, threshold: Type) -> bool;
/// Returns `true` if text **does not** meet the provided threshold.
fn isnt(self, threshold: Type) -> bool {
!self.is(threshold)
}
}
impl CensorStr for &str {
fn censor(self) -> String {
Censor::new(self.chars()).censor()
}
fn is(self, threshold: Type) -> bool {
Censor::from_str(self).analyze().is(threshold)
}
}
/// CensorIter makes it easy to sanitize an arbitrary `Iterator<Item=char>` by calling `.censor()`.
pub trait CensorIter {
type Iterator: Iterator<Item = char>;
/// Iteratively censor characters, yielding (except accents) those that are not inappropriate, and replacing
/// those that are with `'*'`.
fn censor(self) -> Self::Iterator;
}
impl<I: Iterator<Item = char> + Clone> CensorIter for I {
type Iterator = Censor<I>;
/// Censors text, keeping (except accents) those that are not inappropriate, and replacing
/// those that are with `'*'`.
fn censor(self) -> Self::Iterator {
Censor::new(self)
}
}
/// Adds a word, with the given type. The type can be `Type::SAFE`, or a combination of `Type::PROFANE`,
/// `Type::Sexual`, `Type::Offensive`, `Type::Mean`, `Type::Mild`, `Type::Moderate`, and `Type::Severe`,
/// but NOT both (can't be safe and unsafe).
///
/// It is recommended to use all lower-case, which will match both cases. Upper-case characters will
/// only match upper-case.
///
/// # Warning
///
/// Any profanity words added this way will not support false positives. For example, if you add the word
/// "field," you can expect "cornfield" to be detected as well, unless you call `add_word("cornfield", Type::None)`.
///
/// # Safety
///
/// This must not be called when the crate is being used in any other way. It is best to call this
/// from the main thread, near the beginning of the program.
#[cfg(feature = "customize")]
pub unsafe fn add_word(word: &str, typ: Type) {
TRIE.get_mut().add(word, typ, true);
}
#[cfg(test)]
mod tests {
#![allow(unused_imports)]
extern crate test;
use crate::{Censor, CensorIter, CensorStr, Type};
use bitflags::_core::ops::Not;
use serial_test::serial;
use std::fs::File;
use std::io::BufReader;
use std::time::{Duration, Instant};
use test::Bencher;
#[test]
#[serial]
fn short_replacement() {
"99".isnt(Type::PROFANE);
"900".isnt(Type::PROFANE);
"kkk".is(Type::OFFENSIVE);
}
#[test]
#[serial]
fn unicode_whitespace() {
assert!("fu\u{1160}ck".is(Type::PROFANE));
assert!(!"fu\u{1161}ck".is(Type::PROFANE));
}
#[allow(dead_code)]
fn find_detection(text: &str) {
let holistic = Censor::from_str(text).analyze();
if holistic & Type::SPAM.not() != Type::NONE {
println!("{}", text);
// There was some non-spam detection.
let mut start = 0;
let mut end = text.chars().count();
while start < end
&& Censor::new(text.chars().skip(start).take(end - start))
.analyze()
.is(Type::ANY)
{
start += 1;
}
start = start.saturating_sub(1);
while start < end
&& Censor::new(text.chars().skip(start).take(end - start))
.analyze()
.is(Type::ANY)
{
end -= 1;
}
end += 1;
for _ in 0..start {
print!("-");
}
for _ in start..end {
print!("^");
}
print!(" ");
println!(
"(\"{}\" is {:?})",
text.chars()
.skip(start)
.take(end - start)
.collect::<String>(),
holistic
);
} else {
println!("{} ({:?})", text, holistic);
}
}
#[test]
#[serial]
fn issue_1() {
// https://github.com/finnbear/rustrict/issues/1#issuecomment-1024426326
assert!("I could say I miss you but it’s not the truth".isnt(Type::ANY));
}
#[test]
#[serial]
fn curated() {
let mut cases: Vec<(&str, bool, Option<bool>)> = vec![("", false, Some(false))];
cases.extend(
include_str!("test_positive.txt")
.split('\n')
.filter(|l| !l.is_empty())
.map(|l| (l, true, Some(false))),
);
cases.extend(
include_str!("test_negative.txt")
.split('\n')
.filter(|l| !l.is_empty())
.map(|l| (l, false, None)),
);
cases.extend(
include_str!("safe.txt")
.split('\n')
.filter(|l| !l.is_empty() && !l.starts_with('#'))
.map(|l| (l, false, Some(true))),
);
cases.extend(
include_str!("test_safe.txt")
.split('\n')
.filter(|l| !l.is_empty())
.map(|l| (l, false, Some(true))),
);
for (case, any_truth, safe_truth) in cases {
/*
#[cfg(debug_assertions)]
println!("Case: \"{}\"", case);
*/
let typ = Censor::from_str(case).analyze();
let any = typ.is(Type::ANY);
let safe = typ.is(Type::SAFE);
//let (censored, analysis) = Censor::from_str(case).with_censor_threshold(Type::ANY).censor_and_analyze();
//println!("\"{}\" -> \"{}\" ({}, {})", case, censored, prediction, analysis.is(Type::ANY));
if any != any_truth {
find_detection(case);
panic!("FAIL: Predicted {:?} for {}", typ, case);
}
if let Some(safe_truth) = safe_truth {
if safe != safe_truth {
panic!("FAIL: Predicted safe={} for {}", safe, case);
}
}
}
}
#[test]
#[serial]
fn censor() {
let censored = Censor::from_str("HELLO fučk Shit nigga WORLD!")
.with_censor_replacement('#')
.censor();
assert_eq!(censored, "HELLO f### S### ##### WORLD!");
// Minor mean-ness is not considered inappropriate
assert_eq!("fcking coward".censor(), "f***** coward");
let censored = Censor::from_str("卍")
.with_censor_first_character_threshold(Type::NONE)
.censor();
assert_eq!(censored, "*");
}
#[test]
#[serial]
fn bidirectional() {
// Censoring removes direction overrides, so that the text output is the text that was analyzed.
assert_eq!("an toidi", "an \u{202e}toidi".censor());
}
#[test]
#[serial]
fn analyze() {
let analysis = Censor::from_str("HELLO fuck shit WORLD!").analyze();
assert_ne!(analysis, Type::NONE);
assert!(analysis.is(Type::INAPPROPRIATE));
assert!(analysis.is(Type::PROFANE));
assert!(analysis.isnt(Type::SEXUAL & Type::SEVERE));
assert!(analysis.isnt(Type::OFFENSIVE));
assert!(analysis.isnt(Type::MEAN));
}
/// This exists purely to ensure all the APIs keep compiling.
#[test]
#[serial]
fn apis() {
"abcd".censor();
String::from("abcd").censor();
let _ = "abcd".chars().censor().collect::<String>();
let (_, _) = Censor::new("abcd".chars())
.with_censor_replacement('?')
.censor_and_analyze();
let mut censor = Censor::from_str("abcd");
let _ = censor.censor();
let _ = censor.analyze();
let (_, _) = Censor::from_str("HELLO crap WORLD!").censor_and_analyze();
}
#[test]
#[serial]
fn levels() {
assert!("poo".is(Type::PROFANE & Type::MILD));
assert!("poo".is(Type::PROFANE & Type::MILD_OR_HIGHER));
assert!("poo".isnt(Type::PROFANE & Type::MODERATE));
assert!("poo".isnt(Type::PROFANE & Type::MODERATE_OR_HIGHER));
assert!("poo".isnt(Type::PROFANE & Type::SEVERE));
assert!("arse".is(Type::PROFANE & Type::MODERATE));
assert!("arse".is(Type::PROFANE & Type::MILD_OR_HIGHER));
assert!("arse".is(Type::PROFANE & Type::MODERATE_OR_HIGHER));
assert!("arse".isnt(Type::PROFANE & Type::MILD));
assert!("arse".isnt(Type::PROFANE & Type::SEVERE));
assert!("i hope you die".is(Type::MEAN & Type::SEVERE));
assert!("i hope you die".is(Type::MEAN & Type::MILD_OR_HIGHER));
assert!("i hope you die".is(Type::MEAN & Type::MODERATE_OR_HIGHER));
assert!("i hope you die".isnt(Type::MEAN & Type::MILD));
assert!("i hope you die".isnt(Type::MEAN & Type::MODERATE));
assert!("You said your mother only smiled on her TV show".isnt(
Type::PROFANE
| Type::OFFENSIVE
| Type::SEXUAL & Type::MODERATE_OR_HIGHER
| Type::MEAN & Type::SEVERE
));
}
#[test]
#[serial]
#[cfg(not(debug_assertions))]
fn accuracy() {
fn rustrict(s: &str) -> bool {
s.is(Type::ANY)
}
#[allow(dead_code)]
fn rustrict_old(s: &str) -> bool {
rustrict_old::CensorStr::is(s, rustrict_old::Type::ANY)
}
fn censor(s: &str) -> bool {
use censor_crate::*;
let filter = Standard + Sex + Zealous;
filter.check(s)
}