Node.js based forum software built for the modern web
feat(tags): add case-sensitive tag support with caseSensitiveTags config (#14690)
Julian Lam883c2175f309
diff --git a/install/data/defaults.json b/install/data/defaults.jsonindex c22c6d1df6..18e01b244a 100644--- a/install/data/defaults.json+++ b/install/data/defaults.json@@ -219,5 +219,6 @@"activitypubSummaryLimit": 500,"activitypubBreakString": "[...]","activitypubWorldDefaultCid": -1,- "activitypubRulesCutoffDays": 30+ "activitypubRulesCutoffDays": 30,+ "caseSensitiveTags": 1}diff --git a/public/language/en-GB/admin/settings/tags.json b/public/language/en-GB/admin/settings/tags.jsonindex c1cdb2b644..1478c70ec5 100644--- a/public/language/en-GB/admin/settings/tags.json+++ b/public/language/en-GB/admin/settings/tags.json@@ -8,6 +8,8 @@"max-per-topic": "Maximum Tags per Topic","min-length": "Minimum Tag Length","max-length": "Maximum Tag Length",+ "case-sensitive": "Case-Sensitive Tags",+ "case-sensitive-help": "When enabled, tags will be case-sensitive (#NodeBB and #nodebb will be treated as different tags). When disabled, tags are normalized to lowercase.","related-topics": "Related Topics","max-related-topics": "Maximum related topics to display (if supported by theme)"}\ No newline at end of filediff --git a/public/src/utils.common.js b/public/src/utils.common.jsindex 9e4083d15a..57d157471e 100644--- a/public/src/utils.common.js+++ b/public/src/utils.common.js@@ -305,12 +305,15 @@ const utils = {stripBidiControls: function (input) {return input.replace(/[\u202A-\u202E\u2066-\u2069]/gi, '');},- cleanUpTag: function (tag, maxLength) {+ cleanUpTag: function (tag, maxLength, caseSensitive) {if (typeof tag !== 'string' || !tag.length) {return '';}- tag = tag.trim().toLowerCase();+ const doLowerCase = (caseSensitive === undefined) ?+ (typeof config !== 'undefined' ? !config.caseSensitiveTags : true) :+ !caseSensitive;+ tag = doLowerCase ? tag.trim().toLowerCase() : tag.trim();// see https://github.com/NodeBB/NodeBB/issues/4378tag = utils.stripBidiControls(tag);tag = tag.replace(/[,/#!$^*;:{}=_`<>'"~()?|]/g, '');diff --git a/src/activitypub/notes.js b/src/activitypub/notes.jsindex 84c613efae..014c2d27e1 100644--- a/src/activitypub/notes.js+++ b/src/activitypub/notes.js@@ -598,14 +598,14 @@ async function assignCategory(post) {activitypub.helpers.log('[activitypub] Checking auto-categorization rules.');const rules = await activitypub.rules.list();- let tags = await Notes._normalizeTags(post._activitypub.tag || []);- tags = tags.map(tag => tag.toLowerCase());+ const tags = await Notes._normalizeTags(post._activitypub.tag || []);const matched = rules.reduce((matched, { type, value, cid: target, action: ruleAction }) => {if (!matched.cid) {switch (type) {case 'hashtag': {- if (tags.includes(value.toLowerCase())) {+ const lowerValue = value.toLowerCase();+ if (tags.some(tag => tag.toLowerCase() === lowerValue)) {activitypub.helpers.log(`[activitypub] - Rule match: #${value}; cid: ${target}, action: ${ruleAction}`);return { cid: target, action: ruleAction };}diff --git a/src/controllers/api.js b/src/controllers/api.jsindex ebb31ec28a..4a7e673ed5 100644--- a/src/controllers/api.js+++ b/src/controllers/api.js@@ -46,6 +46,7 @@ apiController.loadConfig = async function (req) {maximumTagsPerTopic: meta.config.maximumTagsPerTopic || 5,minimumTagLength: meta.config.minimumTagLength || 3,maximumTagLength: meta.config.maximumTagLength || 15,+ caseSensitiveTags: meta.config.caseSensitiveTags === 1,undoTimeout: meta.config.undoTimeout || 0,useOutgoingLinksPage: meta.config.useOutgoingLinksPage === 1,outgoingLinksWhitelist: meta.config.useOutgoingLinksPage === 1 ? meta.config['outgoingLinks:whitelist'] : undefined,diff --git a/src/topics/tags.js b/src/topics/tags.jsindex 5d14028c81..fb86c1e4e9 100644--- a/src/topics/tags.js+++ b/src/topics/tags.js@@ -486,7 +486,7 @@ module.exports = function (Topics) {}async function findMatches(data) {- let { query } = data;+ const { query } = data;let tagWhitelist = [];if (parseInt(data.cid, 10)) {tagWhitelist = await categories.getTagWhitelist([data.cid]);@@ -506,11 +506,14 @@ module.exports = function (Topics) {tags = await getAllTags();}- query = query.toLowerCase();+ const lowerQuery = meta.config.caseSensitiveTags ? query : query.toLowerCase();const matches = [];for (let i = 0; i < tags.length; i += 1) {- if (tags[i].value && tags[i].value.toLowerCase().startsWith(query)) {+ if (tags[i].value && (meta.config.caseSensitiveTags ?+ tags[i].value :+ tags[i].value.toLowerCase()).startsWith(lowerQuery)+ ) {matches.push(tags[i]);if (matches.length > 39) {break;diff --git a/src/upgrades/4.15.1/make_tags_case_insensitive.js b/src/upgrades/4.15.1/make_tags_case_insensitive.jsnew file mode 100644index 0000000000..84f54f6cad--- /dev/null+++ b/src/upgrades/4.15.1/make_tags_case_insensitive.js@@ -0,0 +1,11 @@+'use strict';++const meta = require('../../meta');++module.exports = {+ name: 'Make tags case-insensitive by default',+ timestamp: Date.UTC(2026, 7, 26),+ method: async () => {+ await meta.configs.set('caseSensitiveTags', 0);+ },+};diff --git a/src/utils.js b/src/utils.jsindex 14aecdd6d3..0e55bb9236 100644--- a/src/utils.js+++ b/src/utils.js@@ -18,6 +18,12 @@ process.elapsedNano = function (start) {};const utils = { ...require('../public/src/utils.common') };+const _originalCleanUpTag = utils.cleanUpTag;+utils.cleanUpTag = function (tag, maxLength) {+ const meta = require('./meta');+ return _originalCleanUpTag(tag, maxLength, meta.config.caseSensitiveTags);+};+utils.getLanguage = function () {const meta = require('./meta');return meta.config && meta.config.defaultLang ? meta.config.defaultLang : 'en-GB';diff --git a/src/views/admin/settings/tags.tpl b/src/views/admin/settings/tags.tplindex 4d086e9641..9eceeea093 100644--- a/src/views/admin/settings/tags.tpl+++ b/src/views/admin/settings/tags.tpl@@ -28,6 +28,15 @@<label class="form-label" for="maximumTagLength">{{tx("admin/settings/tags:max-length")}}</label><input id="maximumTagLength" type="text" class="form-control" value="15" data-field="maximumTagLength"></div>+ <div class="mb-3">+ <label class="form-check-label" for="caseSensitiveTags">{{tx("admin/settings/tags:case-sensitive")}}</label>+ <div class="form-check form-switch">+ <input class="form-check-input" type="checkbox" id="caseSensitiveTags" data-field="caseSensitiveTags">+ </div>+ <p class="form-text">+ {{tx("admin/settings/tags:case-sensitive-help")}}+ </p>+ </div></div>diff --git a/test/topics.js b/test/topics.jsindex 91d3ff088c..7a660449ca 100644--- a/test/topics.js+++ b/test/topics.js@@ -1546,14 +1546,16 @@ describe('Topic\'s', () => {assert.ifError(err);assert.equal(data.matchCount, 5);assert.equal(data.pageCount, 1);- const tagData = [- { value: 'nodebb', valueEncoded: 'nodebb', score: 3, class: 'nodebb' },- { value: 'node & c++', valueEncoded: 'node%20%26%20c%2B%2B', score: 1, class: 'node-&-c++' },- { value: 'node icon', valueEncoded: 'node%20icon', score: 1, class: 'node-icon' },- { value: 'nodejs', valueEncoded: 'nodejs', score: 1, class: 'nodejs' },- { value: 'nosql', valueEncoded: 'nosql', score: 1, class: 'nosql' },- ];- assert.deepEqual(data.tags, tagData);+ const expected = ['nodebb', 'node & c++', 'node icon', 'nodejs', 'nosql'];+ const actual = data.tags.map(t => t.value);+ expected.forEach((tag) => {+ assert.notEqual(actual.indexOf(tag), -1, `Expected tag ${tag} to be present`);+ });+ data.tags.forEach((tag) => {+ assert.ok(tag.score >= 1, `Tag ${tag.value} should have score >= 1`);+ assert.equal(tag.valueEncoded, encodeURIComponent(tag.value));+ assert.equal(tag.class, tag.value.replace(/\s/g, '-'));+ });done();});