Node.js based forum software built for the modern web
refactor: allow #5848
Barış Soner Uşaklı66c9239a6791
diff --git a/public/src/ajaxify.js b/public/src/ajaxify.jsindex cf5221c0c6..2907d8a2ec 100644--- a/public/src/ajaxify.js+++ b/public/src/ajaxify.js@@ -283,13 +283,9 @@ ajaxify.widgets = { render: render };}title = config.titleLayout.replace(/{/g, '{').replace(/}/g, '}')- .replace('{pageTitle}', function () { return title; })- .replace('{browserTitle}', function () { return config.browserTitle; });+ .replace('{pageTitle}', () => title)+ .replace('{browserTitle}', () => config.browserTitle);- // Allow translation strings in title on ajaxify (#5927)- if (!ajaxify.data.template.topic && !ajaxify.data.template.category) {- title = translator.unescape(title);- }const data = { title: title };hooks.fire('action:ajaxify.updateTitle', data);translator.translate(data.title, function (translated) {diff --git a/src/api/search.js b/src/api/search.jsindex a5bc32f83a..7d04c598c9 100644--- a/src/api/search.js+++ b/src/api/search.js@@ -47,6 +47,8 @@ searchApi.categories = async (caller, data) => {let categoriesData = categories.buildForSelectCategories(visibleCategories, ['disabledClass'], data.parentCid);categoriesData = categoriesData.slice(0, 1000);+ const userSettings = await user.getSettings(caller.uid);+ await controllersHelpers.translateCategoryData(categoriesData, userSettings.userLang);categoriesData.forEach((category) => {category.selected = data.selectedCids ? data.selectedCids.includes(String(category.cid)) : false;diff --git a/src/categories/create.js b/src/categories/create.jsindex fa49468834..165cb08852 100644--- a/src/categories/create.js+++ b/src/categories/create.js@@ -31,7 +31,6 @@ module.exports = function (Categories) {name: data.name,handle,description: data.description ? data.description : '',- descriptionParsed: data.descriptionParsed ? data.descriptionParsed : '',icon: data.icon ? data.icon : '',bgColor: data.bgColor || colours[0],color: data.color || colours[1],@@ -85,9 +84,6 @@ module.exports = function (Categories) {category = result.category;await db.setObject(`category:${category.cid}`, category);- if (!category.descriptionParsed) {- await Categories.parseDescription(category.cid, category.description);- }await db.sortedSetAddBulk([['categories:cid', category.order, category.cid],diff --git a/src/categories/data.js b/src/categories/data.jsindex 69d361f842..2e9d95f179 100644--- a/src/categories/data.js+++ b/src/categories/data.js@@ -160,8 +160,8 @@ function modifyCategory(category, fields) {}if (hasField('description')) {- category.description = translator.escape(category.description);category.descriptionParsed = translator.escape(category.descriptionParsed || category.description);+ category.description = translator.escape(category.description);}if (category.nickname) {diff --git a/src/categories/search.js b/src/categories/search.jsindex 9f8c407e76..e77518eed5 100644--- a/src/categories/search.js+++ b/src/categories/search.js@@ -7,6 +7,8 @@ const activitypub = require('../activitypub');const plugins = require('../plugins');const db = require('../database');const utils = require('../utils');+const user = require('../user');+const controllersHelpers = require('../controllers/helpers');module.exports = function (Categories) {Categories.search = async function (data) {@@ -51,6 +53,9 @@ module.exports = function (Categories) {let categoryData = await Categories.getCategories(uniqCids);categoryData = categoryData.filter(Boolean);+ const userSettings = await user.getSettings(uid);+ await controllersHelpers.translateCategoryData(categoryData, userSettings.userLang);+Categories.getTree(categoryData, 0);await Categories.getRecentTopicReplies(categoryData, uid, data.qs);categoryData.forEach((category) => {diff --git a/src/categories/update.js b/src/categories/update.jsindex 2c2053f9fa..77381191af 100644--- a/src/categories/update.js+++ b/src/categories/update.js@@ -61,9 +61,6 @@ module.exports = function (Categories) {}await db.setObjectField(`${utils.isNumber(cid) ? 'category' : 'categoryRemote'}:${cid}`, key, value);- if (key === 'description') {- await Categories.parseDescription(cid, value);- }}async function updateParent(cid, newParent) {@@ -137,11 +134,6 @@ module.exports = function (Categories) {]);}- Categories.parseDescription = async function (cid, description) {- const parsedDescription = await plugins.hooks.fire('filter:parse.raw', description);- await Categories.setCategoryField(cid, 'descriptionParsed', parsedDescription);- };-async function updateName(cid, newName) {const oldName = await Categories.getCategoryField(cid, 'name');await db.sortedSetRemove('categories:name', `${oldName.slice(0, 200).toLowerCase()}:${cid}`);diff --git a/src/controllers/accounts/categories.js b/src/controllers/accounts/categories.jsindex c73c282c95..f62a1de0d9 100644--- a/src/controllers/accounts/categories.js+++ b/src/controllers/accounts/categories.js@@ -11,7 +11,8 @@ const categoriesController = module.exports;categoriesController.get = async function (req, res) {const payload = res.locals.userData;const { username, userslug } = payload;- const [states, allCategoriesData] = await Promise.all([+ const [userSettings, states, allCategoriesData] = await Promise.all([+ user.getSettings(req.uid),user.getCategoryWatchState(res.locals.uid),categories.buildForSelect(res.locals.uid, 'find', ['descriptionParsed', 'depth', 'slug']),]);@@ -22,6 +23,7 @@ categoriesController.get = async function (req, res) {const stop = start + meta.config.categoriesPerPage - 1;const categoriesData = watchCategories.slice(start, stop + 1);+ await helpers.translateCategoryData(categoriesData, userSettings.userLang);categoriesData.forEach((category) => {if (category) {diff --git a/src/controllers/categories.js b/src/controllers/categories.jsindex a169b49be5..74cd125f6c 100644--- a/src/controllers/categories.js+++ b/src/controllers/categories.js@@ -4,6 +4,7 @@ const nconf = require('nconf');const _ = require('lodash');const categories = require('../categories');+const user = require('../user');const meta = require('../meta');const pagination = require('../pagination');const helpers = require('./helpers');@@ -20,7 +21,10 @@ categoriesController.list = async function (req, res) {content: 'website',}];- const allRootCids = await categories.getAllCidsFromSet('cid:0:children');+ const [allRootCids, userSettings] = await Promise.all([+ categories.getAllCidsFromSet('cid:0:children'),+ user.getSettings(req.uid),+ ]);const rootCids = await privileges.categories.filterCids('find', allRootCids, req.uid);const pageCount = Math.max(1, Math.ceil(rootCids.length / meta.config.categoriesPerPage));const page = Math.min(parseInt(req.query.page, 10) || 1, pageCount);@@ -35,6 +39,7 @@ categoriesController.list = async function (req, res) {await Promise.all([categories.getRecentTopicReplies(categoryData, req.uid, req.query),categories.setUnread(tree, pageCids.concat(childCids), req.uid),+ helpers.translateCategoryData(categoryData, userSettings.userLang),]);const data = {diff --git a/src/controllers/category.js b/src/controllers/category.jsindex bf8a9b24eb..e0b84cb3f7 100644--- a/src/controllers/category.js+++ b/src/controllers/category.js@@ -119,7 +119,7 @@ categoryController.get = async function (req, res, next) {const allCategories = [];categories.flattenCategories(allCategories, categoryData.children);-+ await helpers.translateCategoryData([categoryData].concat(categoryData.children), userSettings.userLang),await Promise.all([buildBreadcrumbs(req, categoryData),categories.setUnread([categoryData], allCategories.map(c => c.cid).concat(cid), req.uid),diff --git a/src/controllers/helpers.js b/src/controllers/helpers.jsindex bcc2571e3a..04d6d8dede 100644--- a/src/controllers/helpers.js+++ b/src/controllers/helpers.js@@ -191,15 +191,17 @@ function prependRelativePath(url) {url : relative_path + url;}-helpers.buildCategoryBreadcrumbs = async function (cid) {+helpers.buildCategoryBreadcrumbs = async function (cid, userLang) {const breadcrumbs = [];while (parseInt(cid, 10)) {/* eslint-disable no-await-in-loop */const data = await categories.getCategoryFields(cid, ['name', 'slug', 'parentCid', 'disabled', 'isSection']);++ const translatedName = await translateRawValue(data.name, userLang);if (!data.disabled && !data.isSection) {breadcrumbs.unshift({- text: String(data.name),+ text: translatedName,url: `${url}/category/${data.slug}`,cid: cid,});@@ -247,10 +249,31 @@ helpers.buildTitle = function (pageTitle) {const browserTitle = validator.escape(String(meta.config.browserTitle || meta.config.title || 'NodeBB'));- const title = titleLayout.replace('{pageTitle}', () => pageTitle).replace('{browserTitle}', () => browserTitle);+ const title = titleLayout+ .replace('{pageTitle}', () => pageTitle)+ .replace('{browserTitle}', () => browserTitle);return title;};+// categoy names and descriptions can be tx keys, translate them safely here+// used on category list, category page and users watched categories+async function translateRawValue(value, lang) {+ const rawValue = validator.unescape(translator.unescape(String(value || '')));+ return validator.escape(await translator.translate(rawValue, lang));+}++helpers.translateCategoryData = async function (categoryData, userLang) {+ await Promise.all(categoryData.map(async (category) => {+ if (category) {+ category.name = await translateRawValue(category.name, userLang);+ category.descriptionParsed = await plugins.hooks.fire(+ 'filter:parse.raw', await translateRawValue(category.description, userLang)+ );+ category.description = await translateRawValue(category.description, userLang);+ }+ }));+};+helpers.getCategories = async function (set, uid, privilege, selectedCid) {const cids = await categories.getCidsByPrivilege(set, uid, privilege);return await getCategoryData(cids, uid, selectedCid, Object.values(categories.watchStates), privilege);diff --git a/src/controllers/tags.js b/src/controllers/tags.jsindex e5806c87d2..f601f94596 100644--- a/src/controllers/tags.js+++ b/src/controllers/tags.js@@ -11,21 +11,25 @@ const privileges = require('../privileges');const pagination = require('../pagination');const utils = require('../utils');const helpers = require('./helpers');+const translator = require('../translator');const tagsController = module.exports;const url = nconf.get('url');tagsController.getTag = async function (req, res) {- const tag = validator.escape(utils.cleanUpTag(req.params.tag, meta.config.maximumTagLength));+ const escapedTag = translator.escape(+ validator.escape(utils.cleanUpTag(req.params.tag, meta.config.maximumTagLength))+ );+const page = parseInt(req.query.page, 10) || 1;const cid = Array.isArray(req.query.cid) || !req.query.cid ? req.query.cid : [req.query.cid];const templateData = {topics: [],- tag: tag,- breadcrumbs: helpers.buildBreadcrumbs([{ text: '[[tags:tags]]', url: '/tags' }, { text: tag }]),- title: `[[pages:tag, ${tag}]]`,+ tag: escapedTag,+ breadcrumbs: helpers.buildBreadcrumbs([{ text: '[[tags:tags]]', url: '/tags' }, { text: escapedTag }]),+ title: `[[pages:tag, ${escapedTag}]]`,};const [settings, cids, categoryData, canPost, isPrivileged, rssToken, isFollowing] = await Promise.all([user.getSettings(req.uid),@@ -50,25 +54,27 @@ tagsController.getTag = async function (req, res) {templateData.showSelect = isPrivileged;templateData.showTopicTools = isPrivileged;templateData.isFollowing = isFollowing;- templateData.allCategoriesUrl = `tags/${tag}${helpers.buildQueryString(req.query, 'cid', '')}`;+ templateData.allCategoriesUrl = `tags/${escapedTag}${helpers.buildQueryString(req.query, 'cid', '')}`;templateData.selectedCategory = categoryData.selectedCategory;templateData.selectedCids = categoryData.selectedCids;topics.calculateTopicIndices(templateData.topics, start);res.locals.metaTags = [{name: 'title',- content: tag,+ content: escapedTag,+ noEscape: true,},{property: 'og:title',- content: tag,+ content: escapedTag,+ noEscape: true,},];const pageCount = Math.max(1, Math.ceil(topicCount / settings.topicsPerPage));templateData.pagination = pagination.create(page, pageCount, req.query);helpers.addLinkTags({- url: `tags/${tag}`,+ url: `tags/${escapedTag}`,res: req.res,tags: templateData.pagination.rel,page: page,@@ -76,7 +82,7 @@ tagsController.getTag = async function (req, res) {templateData['feeds:disableRSS'] = meta.config['feeds:disableRSS'];if (!meta.config['feeds:disableRSS']) {- templateData.rssFeedUrl = `${nconf.get('relative_path')}/tags/${tag}.rss`;+ templateData.rssFeedUrl = `${nconf.get('relative_path')}/tags/${escapedTag}.rss`;if (req.loggedIn) {templateData.rssFeedUrl += `?uid=${req.uid}&token=${rssToken}`;}diff --git a/src/controllers/topics.js b/src/controllers/topics.jsindex e5effc02b5..27ca733f6d 100644--- a/src/controllers/topics.js+++ b/src/controllers/topics.js@@ -134,7 +134,7 @@ topicsController.get = async function getTopic(req, res, next) {const [author, crossposts] = await Promise.all([user.getUserFields(topicData.uid, ['username', 'userslug']),topics.crossposts.get(topicData.tid),- buildBreadcrumbs(topicData),+ buildBreadcrumbs(topicData, settings.userLang),addOldCategory(topicData, userPrivileges),addTags(topicData, req, res, currentPage, postAtIndex),topics.increaseViewCount(req, tid),@@ -208,7 +208,8 @@ async function markAsRead(req, tid) {}}-async function buildBreadcrumbs(topicData) {+async function buildBreadcrumbs(topicData, userLang) {+ await helpers.translateCategoryData([topicData.category], userLang);const breadcrumbs = [{text: topicData.category.name,@@ -219,7 +220,7 @@ async function buildBreadcrumbs(topicData) {text: topicData.title,},];- const parentCrumbs = await helpers.buildCategoryBreadcrumbs(topicData.category.parentCid);+ const parentCrumbs = await helpers.buildCategoryBreadcrumbs(topicData.category.parentCid, userLang);topicData.breadcrumbs = parentCrumbs.concat(breadcrumbs);}diff --git a/src/middleware/render.js b/src/middleware/render.jsindex 8ab928b14a..fee9461c69 100644--- a/src/middleware/render.js+++ b/src/middleware/render.js@@ -172,9 +172,7 @@ module.exports = function (middleware) {templateValues.configJSON = jsesc(JSON.stringify(res.locals.config), { isScriptContext: true });- const title = options.template.topic ?- utils.stripHTMLTags(options.title || '') : // don't translate topic titles- translator.unescape(utils.stripHTMLTags(options.title || ''));+ const title = utils.stripHTMLTags(String(options.title || ''));const results = await utils.promiseParallel({isAdmin: user.isAdministrator(req.uid),diff --git a/test/categories.js b/test/categories.jsindex bc740b6387..b31dd5c8fa 100644--- a/test/categories.js+++ b/test/categories.js@@ -890,4 +890,30 @@ describe('Categories', () => {assert.strictEqual(child1.cid, data.children[0].cid);assert.strictEqual(child2.cid, data.children[0].children[0].cid);});++ it.only('should translate category name and description and escape them properly', async () => {+ const category = await Categories.create({+ name: '[[topic:merged-message, javascript:alert(origin), foobar]]',+ description: '[[topic:forked-message, javascript:alert(origin), foobar]]',+ });++ const data = await Categories.getCategoryData(category.cid);+ assert.strictEqual(data.name, '[[topic:merged-message, javascript:alert(origin), foobar]]');+ assert.strictEqual(data.description, '[[topic:forked-message, javascript:alert(origin), foobar]]');+ assert.strictEqual(data.descriptionParsed, '[[topic:forked-message, javascript:alert(origin), foobar]]');+ const { response, body } = await request.get(`${nconf.get('url')}/api/category/${category.cid}/test-category`);+ console.log(body);+ // title comes from category.name so should be escaped as well+ assert.strictEqual(body.title, 'This topic has been merged into <a href="javascript:alert(origin)">foobar</a>');++ // breadcrumbs should be translated & escaped too+ assert.strictEqual(body.breadcrumbs[1].text, 'This topic has been merged into <a href="javascript:alert(origin)">foobar</a>');++ assert.strictEqual(body.name, 'This topic has been merged into <a href="javascript:alert(origin)">foobar</a>');++ assert.strictEqual(body.description, 'This topic was forked from <a href="javascript:alert(origin)">foobar</a>');++ assert.strictEqual(body.descriptionParsed, 'This topic was forked from <a href="javascript:alert(origin)">foobar</a>');+ });});+