* SS14-17313 Chat Censorship Systems Adds some systems to manage chat censorship: 1. No-op: does nothing 2. SimpleCensor: a regex-free censor with a variety of rules to use 3. RegexCensor: a censor that uses regex. This exposes a singleton backed by a builder pattern (ChatCensor) that is set up, probably during the code init phase, and then globally available for your censorship needs. * Migrate to Shared * Add a reset function to the builder. * Resolve PJB's feedback; add unit tests
163 lines
5.0 KiB
C#
163 lines
5.0 KiB
C#
using System.Text.Unicode;
|
|
using Content.Shared.Chat.V2.Moderation;
|
|
using NUnit.Framework;
|
|
|
|
namespace Content.Tests.Shared.Chat.V2.Moderation;
|
|
|
|
public sealed class SimpleCensorTests
|
|
{
|
|
[Test]
|
|
public void CanCensorASingleWord()
|
|
{
|
|
var sut = new SimpleCensor().WithCustomDictionary(["amogus"]);
|
|
var output = sut.Censor("hello amogus");
|
|
|
|
Assert.That(output, Is.EqualTo("hello ******"));
|
|
}
|
|
|
|
// Basics - use custom dictionary
|
|
|
|
[Test]
|
|
public void CanCensorMultipleWordInstances()
|
|
{
|
|
var sut= new SimpleCensor().WithCustomDictionary(["amogus"]);
|
|
var output = sut.Censor("amogus hello amogus");
|
|
|
|
Assert.That(output, Is.EqualTo("****** hello ******"));
|
|
}
|
|
|
|
[Test]
|
|
public void CanCensorMultipleWords()
|
|
{
|
|
var sut= new SimpleCensor().WithCustomDictionary(["amogus", "sus"]);
|
|
var output = sut.Censor("amogus hello sus");
|
|
|
|
Assert.That(output, Is.EqualTo("****** hello ***"));
|
|
}
|
|
|
|
[Test]
|
|
public void CanUseDifferentCensorSymbols()
|
|
{
|
|
var sut= new SimpleCensor().WithCustomDictionary(["amogus", "sus"]);
|
|
var output = sut.Censor("amogus hello sus", '#');
|
|
|
|
Assert.That(output, Is.EqualTo("###### hello ###"));
|
|
}
|
|
|
|
[Test]
|
|
public void CanCatchCapitalizedWords()
|
|
{
|
|
var sut= new SimpleCensor().WithCustomDictionary(["amogus", "sus"]);
|
|
var output = sut.Censor("AMOGUS hello SUS");
|
|
|
|
Assert.That(output, Is.EqualTo("****** hello ***"));
|
|
}
|
|
|
|
[Test]
|
|
public void CanCatchWordsWithSomeCaptialsInThem()
|
|
{
|
|
var sut= new SimpleCensor().WithCustomDictionary(["amogus", "sus"]);
|
|
var output = sut.Censor("AmoGuS hello SuS");
|
|
|
|
Assert.That(output, Is.EqualTo("****** hello ***"));
|
|
}
|
|
|
|
[Test]
|
|
public void CanCatchWordsHiddenInsideOtherWords()
|
|
{
|
|
var sut= new SimpleCensor().WithCustomDictionary(["amogus", "sus"]);
|
|
var output = sut.Censor("helamoguslo suspicious");
|
|
|
|
Assert.That(output, Is.EqualTo("hel******lo ***picious"));
|
|
}
|
|
|
|
// Sanitizing Leetspeak
|
|
|
|
[Test]
|
|
public void CanSanitizeLeetspeak()
|
|
{
|
|
var sut = new SimpleCensor().WithCustomDictionary(["amogus", "sus"]).WithSanitizeLeetSpeak();
|
|
var output = sut.Censor("am0gu5 hello 5u5");
|
|
|
|
Assert.That(output, Is.EqualTo("****** hello ***"));
|
|
}
|
|
|
|
[Test]
|
|
public void SanitizingLeetspeakOnlyOccursWhenTheWordIsBlocked()
|
|
{
|
|
var sut = new SimpleCensor().WithCustomDictionary(["amogus", "sus"]).WithSanitizeLeetSpeak();
|
|
var output = sut.Censor("he110");
|
|
|
|
Assert.That(output, Is.EqualTo("he110"));
|
|
}
|
|
|
|
[Test]
|
|
public void CanCatchLeetspeakReplacementsWithMoreThanOneLetter()
|
|
{
|
|
var sut = new SimpleCensor().WithCustomDictionary(["amogus", "sus"]).WithSanitizeLeetSpeak();
|
|
var output = sut.Censor("am()gu5 hello 5u5");
|
|
|
|
Assert.That(output, Is.EqualTo("******* hello ***"));
|
|
}
|
|
|
|
// Sanitizing special characters
|
|
|
|
[Test]
|
|
public void DoesNotSanitizeOutUncensoredSpecialCharacters()
|
|
{
|
|
var sut = new SimpleCensor().WithCustomDictionary(["amogus", "sus"]).WithSanitizeSpecialCharacters();
|
|
var output = sut.Censor("amogus!hello!sus");
|
|
|
|
Assert.That(output, Is.EqualTo("******!hello!***"));
|
|
}
|
|
|
|
[Test]
|
|
public void DoesSanitizeOutCensoredSpecialCharacters()
|
|
{
|
|
var sut = new SimpleCensor().WithCustomDictionary(["amogus", "sus"]).WithSanitizeSpecialCharacters();
|
|
var output = sut.Censor("amo!gus hello s?us");
|
|
|
|
Assert.That(output, Is.EqualTo("***!*** hello *?**"));
|
|
}
|
|
|
|
// Unicode ranges
|
|
|
|
[Test]
|
|
public void SanitizesOutNonLatinCharaters()
|
|
{
|
|
var sut = new SimpleCensor().WithRanges([UnicodeRanges.BasicLatin, UnicodeRanges.Latin1Supplement]);
|
|
var output = sut.Censor("amogus Україна sus 日本");
|
|
|
|
Assert.That(output, Is.EqualTo("amogus sus "));
|
|
}
|
|
|
|
[Test]
|
|
public void SanitizesOutNonLatinOrCyrillicCharaters()
|
|
{
|
|
var sut = new SimpleCensor().WithRanges([UnicodeRanges.BasicLatin, UnicodeRanges.Latin1Supplement, UnicodeRanges.Cyrillic]);
|
|
var output = sut.Censor("amogus Україна sus 日本");
|
|
|
|
Assert.That(output, Is.EqualTo("amogus Україна sus "));
|
|
}
|
|
|
|
// False positives
|
|
[Test]
|
|
public void CanHandleFalsePositives()
|
|
{
|
|
var sut = new SimpleCensor().WithCustomDictionary(["amogus", "sus"]).WithFalsePositives(["amogusus"]);
|
|
var output = sut.Censor("amogusus hello amogus hello sus");
|
|
|
|
Assert.That(output, Is.EqualTo("amogusus hello ****** hello ***"));
|
|
}
|
|
|
|
// False negatives
|
|
[Test]
|
|
public void CanHandleFalseNegatives()
|
|
{
|
|
var sut = new SimpleCensor().WithCustomDictionary(["amogus", "sus"]).WithFalsePositives(["amogusus"]).WithFalseNegatives(["susamogusus"]);
|
|
var output = sut.Censor("susamogusus hello amogus hello sus amogusus");
|
|
|
|
Assert.That(output, Is.EqualTo("*********** hello ****** hello *** ********"));
|
|
}
|
|
}
|