fix(fulltext-filter): ZMS-257: Add boolean logic to fulltext filter (#863)

* feat: add boolean logic to fulltext filter

* add support for exact matches (must be in double quotes)

* add tests for new filtering system, fix issues

* add more edge case tests

* tests remove .only, remove console log. Fix parseFilterQueryText OR handling logic

* filterQueryTermMatches normalize exact match to lowercase too, filter-handler actually use exactPhrases

* normalize input text in filterQueryTermMatches, update filter schema

Author: NickOvt

lib/filter-handler.js

@@ -935,9 +935,23 @@ async function checkFilter(filterData, prepared, maildata) {
         }
     }
 
-    if (query.text && maildata.text.toLowerCase().replace(/\s+/g, ' ').indexOf(query.text.toLowerCase()) < 0) {
-        // message plaintext does not match the text field value
-        return false;
+    if (query.text) {
+        const { andTerms, orTerms, exactPhrases } = tools.parseFilterQueryText(query.text);
+
+        const normalizedEmailText = maildata.text.toLowerCase().replace(/\s+/g, ' ');
+
+        if (!andTerms.length && !orTerms.length && normalizedEmailText.indexOf(query.text.toLowerCase()) < 0) {
+            // message plaintext does not match the text field value
+            return false;
+        }
+
+        const andMatches = !andTerms.length || andTerms.every(term => tools.filterQueryTermMatches(normalizedEmailText, term, exactPhrases));
+
+        const orMatches = !orTerms.length || orTerms.some(term => tools.filterQueryTermMatches(normalizedEmailText, term, exactPhrases));
+
+        if (!(andMatches && orMatches)) {
+            return false; // Filter not satisfied
+        }
     }
 
     log.silly('Filter', 'Filter %s matched message %s', filterData.id, prepared.id);

lib/schemas/request/filters-schemas.js

@@ -32,7 +32,14 @@ const FilterQuery = Joi.object({
     to: Joi.string().trim().max(255).empty('').description('Partial match for the To:/Cc: headers (case insensitive)'),
     subject: Joi.string().trim().max(255).empty('').description('Partial match for the Subject: header (case insensitive)'),
     listId: Joi.string().trim().max(255).empty('').description('Partial match for the List-ID: header (case insensitive)'),
-    text: Joi.string().trim().max(255).empty('').description('Fulltext search against message text'),
+    text: Joi.string()
+        .trim()
+        .max(255)
+        .empty('')
+        .description(
+            'Fulltext search against message text. Implements boolean logic where terms like OR and AND are treated as boolean operators. Space and commas are to be treated as AND terms as there is no separate "AND" term. Supports exact matches enclosed in double quotes "exact match text".'
+        )
+        .example('urgent,immediate OR deadline OR meeting standup'),
     ha: booleanSchema.description('Does a message have to have an attachment or not'),
     size: Joi.number()
         .empty('')

lib/tools.js

@@ -597,6 +597,81 @@ function buildCertChain(cert, ca) {
         .join('\n');
 }
 
+function parseFilterQueryText(queryText) {
+    if (!queryText || typeof queryText !== 'string') {
+        return { andTerms: [], orTerms: [] };
+    }
+
+    const normalized = queryText.trim();
+
+    const { cleanQuery, phrases: exactPhrases } = extractQuotedPhrases(normalized);
+
+    const replaceRegex = /^\s*OR\s*|\s*OR\s*$/g;
+
+    const orParts = cleanQuery.split(/\s+OR\s+/).map(part => (part ? part.replace(replaceRegex, '') : '')); // Has to be uppercase
+
+    const orTerms = [];
+    const andTerms = [];
+
+    if (orParts.length === 1) {
+        const terms = cleanQuery.split(/[,\s]+/).filter(term => term.length > 0);
+        andTerms.push(...terms);
+    } else {
+        for (const part of orParts) {
+            const trimmedPart = part.trim();
+            if (trimmedPart) {
+                orTerms.push(trimmedPart);
+            }
+        }
+    }
+
+    return { andTerms, orTerms, exactPhrases };
+}
+
+function filterQueryTermMatches(text, term, exactPhrases = []) {
+    text = text.toLowerCase();
+    const phraseMatch = term.match(/__PHRASE_(\d+)__/);
+
+    if (phraseMatch) {
+        const phraseIndex = parseInt(phraseMatch[1], 10);
+        const exactPhrase = exactPhrases[phraseIndex];
+
+        if (exactPhrase) {
+            return text.includes(exactPhrase.trim().toLowerCase());
+        }
+        return false;
+    }
+
+    term = term.toLowerCase();
+
+    if (term.includes(' ') || term.includes(',')) {
+        const words = term.split(/[,\s]+/).filter(term => term.length > 0);
+        return words.every(word => text.includes(word));
+    }
+
+    return text.includes(term);
+}
+
+function extractQuotedPhrases(query) {
+    const phrases = [];
+    let cleanQuery = query;
+
+    const quoteRegex = /"([^"]*)"/g;
+    let match;
+    let index = 0;
+
+    while ((match = quoteRegex.exec(query)) !== null) {
+        const phrase = match[1].trim();
+        if (phrase) {
+            phrases.push(phrase);
+            cleanQuery = cleanQuery.replace(match[0], `__PHRASE_${index}__`);
+            index++;
+        }
+    }
+
+    return { cleanQuery, phrases };
+}
+
 module.exports = {
     normalizeAddress,
     normalizeDomain,
@@ -622,6 +697,9 @@ module.exports = {
     roundTime,
     parsePemBundle,
     buildCertChain,
+    parseFilterQueryText,
+    filterQueryTermMatches,
+    extractQuotedPhrases,
 
     formatMetaData: metaData => {
         if (typeof metaData === 'string') {