Skip to content

A free and open source instant messaging and VoIP chat app built for friends, groups, and communities.

TypeScript fluxerfluxerapp
2.8 KB
Raw Blame
// SPDX-License-Identifier: AGPL-3.0-or-later

import {transliterate} from 'transliteration';

const CONTROL_OR_FORMAT_REGEX = /[\p{Cc}\p{Cf}\uFFFE\uFFFF]/gu;
const VARIATION_SELECTOR_REGEX = /(?:[\uFE00-\uFE0F]|[\u{E0100}-\u{E01EF}])/gu;
const COMBINING_MARKS_REGEX = /\p{M}+/gu;
const NON_ALPHANUMERIC_REGEX = /[^\p{L}\p{N}]+/gu;
const ASCII_NON_ALPHANUMERIC_REGEX = /[^a-z0-9]+/g;
const WHITESPACE_REGEX = /\s+/gu;
const MIN_AGGRESSIVE_FORM_LENGTH = 3;

interface PhraseMatchForms {
	readonly raw: string;
	readonly words: string;
	readonly compact: string;
	readonly asciiWords: string;
	readonly asciiCompact: string;
}

function collapseWhitespace(value: string): string {
	return value.replace(WHITESPACE_REGEX, ' ').trim();
}

function stripIgnorableCharacters(value: string): string {
	return value.replace(CONTROL_OR_FORMAT_REGEX, '').replace(VARIATION_SELECTOR_REGEX, '');
}

function maybeKeepAggressiveForm(value: string): string {
	return value.length >= MIN_AGGRESSIVE_FORM_LENGTH ? value : '';
}

function buildWordFormFromCanonical(value: string): string {
	return collapseWhitespace(
		value.normalize('NFKD').replace(COMBINING_MARKS_REGEX, '').replace(NON_ALPHANUMERIC_REGEX, ' '),
	);
}

function buildAsciiWordFormFromCanonical(value: string): string {
	return collapseWhitespace(
		transliterate(value)
			.toLowerCase()
			.normalize('NFKD')
			.replace(COMBINING_MARKS_REGEX, '')
			.replace(ASCII_NON_ALPHANUMERIC_REGEX, ' '),
	);
}

class LazyPhraseMatchForms implements PhraseMatchForms {
	readonly raw: string;
	private wordsForm: string | null = null;
	private compactForm: string | null = null;
	private asciiWordsForm: string | null = null;
	private asciiCompactForm: string | null = null;

	constructor(value: string) {
		this.raw = canonicalizeStoredPhrase(value);
	}

	get words(): string {
		if (this.wordsForm === null) {
			this.wordsForm = maybeKeepAggressiveForm(buildWordFormFromCanonical(this.raw));
		}
		return this.wordsForm;
	}

	get compact(): string {
		if (this.compactForm === null) {
			this.compactForm = maybeKeepAggressiveForm(this.words.replace(WHITESPACE_REGEX, ''));
		}
		return this.compactForm;
	}

	get asciiWords(): string {
		if (this.asciiWordsForm === null) {
			this.asciiWordsForm = maybeKeepAggressiveForm(buildAsciiWordFormFromCanonical(this.raw));
		}
		return this.asciiWordsForm;
	}

	get asciiCompact(): string {
		if (this.asciiCompactForm === null) {
			this.asciiCompactForm = maybeKeepAggressiveForm(this.asciiWords.replace(WHITESPACE_REGEX, ''));
		}
		return this.asciiCompactForm;
	}
}

export function canonicalizeStoredPhrase(value: string): string {
	return stripIgnorableCharacters(value.normalize('NFKC')).toLowerCase().normalize('NFKC').trim();
}

export function buildPhraseMatchForms(value: string): PhraseMatchForms {
	return new LazyPhraseMatchForms(value);
}