fix: return null

pass query to emits

public/src/admin/manage/categories.js

@@ -99,7 +99,7 @@ define('admin/manage/categories', [
 	}
 
 	Categories.throwCreateModal = function () {
-		socket.emit('categories.getSelectCategories', {}, function (err, categories) {
+		socket.emit('categories.getSelectCategories', { query: utils.params() }, function (err, categories) {
 			if (err) {
 				return app.alertError(err.message);
 			}

public/src/admin/manage/category.js

@@ -114,7 +114,7 @@ define('admin/manage/category', [
 		});
 
 		$('.copy-settings').on('click', function () {
-			socket.emit('categories.getSelectCategories', {}, function (err, allCategories) {
+			socket.emit('categories.getSelectCategories', { query: utils.params() }, function (err, allCategories) {
 				if (err) {
 					return app.alertError(err.message);
 				}
@@ -261,7 +261,7 @@ define('admin/manage/category', [
 	}
 
 	Category.launchParentSelector = function () {
-		socket.emit('categories.getSelectCategories', {}, function (err, allCategories) {
+		socket.emit('categories.getSelectCategories', { query: utils.params() }, function (err, allCategories) {
 			if (err) {
 				return app.alertError(err.message);
 			}

public/src/client/topic/move.js

@@ -12,7 +12,7 @@ define('forum/topic/move', ['categorySelector', 'alerts'], function (categorySel
 		Move.onComplete = onComplete;
 		Move.moveAll = !tids;
 
-		socket.emit('categories.getMoveCategories', onCategoriesLoaded);
+		socket.emit('categories.getMoveCategories', { query: utils.params() }, onCategoriesLoaded);
 	};
 
 	function onCategoriesLoaded(err, categories) {

src/controllers/404.js

@@ -7,6 +7,7 @@ const validator = require('validator');
 const meta = require('../meta');
 const plugins = require('../plugins');
 const middleware = require('../middleware');
+const helpers = require('../middleware/helpers');
 
 exports.handle404 = function handle404(req, res) {
 	const relativePath = nconf.get('relative_path');
@@ -22,7 +23,13 @@ exports.handle404 = function handle404(req, res) {
 
 	if (isClientScript.test(req.url)) {
 		res.type('text/javascript').status(404).send('Not Found');
-	} else if (req.path.startsWith(relativePath + '/assets/uploads') || (req.get('accept') && !req.get('accept').includes('text/html')) || req.path === '/favicon.ico') {
+	} else if (
+		!res.locals.isAPI && (
+			req.path.startsWith(`${relativePath}/assets/uploads`) ||
+			(req.get('accept') && !req.get('accept').includes('text/html')) ||
+			req.path === '/favicon.ico'
+		)
+	) {
 		meta.errors.log404(req.path || '');
 		res.sendStatus(404);
 	} else if (req.accepts('html')) {
@@ -41,8 +48,16 @@ exports.send404 = async function (req, res) {
 	res.status(404);
 	const path = String(req.path || '');
 	if (res.locals.isAPI) {
-		return res.json({ path: validator.escape(path.replace(/^\/api/, '')), title: '[[global:404.title]]' });
+		return res.json({
+			path: validator.escape(path.replace(/^\/api/, '')),
+			title: '[[global:404.title]]',
+			bodyClass: helpers.buildBodyClass(req, res),
+		});
 	}
 	await middleware.buildHeaderAsync(req, res);
-	res.render('404', { path: validator.escape(path), title: '[[global:404.title]]' });
+	await res.render('404', {
+		path: validator.escape(path),
+		title: '[[global:404.title]]',
+		bodyClass: helpers.buildBodyClass(req, res),
+	});
 };

src/controllers/category.js

@@ -3,6 +3,7 @@
 
 const nconf = require('nconf');
 const validator = require('validator');
+const qs = require('querystring');
 
 const db = require('../database');
 const privileges = require('../privileges');
@@ -42,7 +43,7 @@ categoryController.get = async function (req, res, next) {
 		return next();
 	}
 	if (topicIndex < 0) {
-		return helpers.redirect(res, '/category/' + categoryFields.slug);
+		return helpers.redirect(res, `/category/${categoryFields.slug}?${qs.stringify(req.query)}`);
 	}
 
 	if (!userPrivileges.read) {
@@ -50,7 +51,7 @@ categoryController.get = async function (req, res, next) {
 	}
 
 	if (!res.locals.isAPI && !req.params.slug && (categoryFields.slug && categoryFields.slug !== `${cid}/`)) {
-		return helpers.redirect(res, `/category/${categoryFields.slug}`, true);
+		return helpers.redirect(res, `/category/${categoryFields.slug}?${qs.stringify(req.query)}`, true);
 	}
 
 	if (categoryFields.link) {
@@ -86,7 +87,7 @@ categoryController.get = async function (req, res, next) {
 	}
 
 	if (topicIndex > Math.max(categoryData.topic_count - 1, 0)) {
-		return helpers.redirect(res, '/category/' + categoryData.slug + '/' + categoryData.topic_count);
+		return helpers.redirect(res, `/category/${categoryData.slug}/${categoryData.topic_count}?${qs.stringify(req.query)}`);
 	}
 	const pageCount = Math.max(1, Math.ceil(categoryData.topic_count / userSettings.topicsPerPage));
 	if (userSettings.usePagination && currentPage > pageCount) {

src/controllers/mods.js

@@ -106,6 +106,7 @@ modsController.flags.list = async function (req, res, next) {
 			filters: filters,
 			sort: sort,
 			uid: req.uid,
+			query: req.query,
 		}),
 		analytics.getDailyStatsForSet('analytics:flags', Date.now(), 30),
 		categories.buildForSelect(req.uid, 'read'),

src/flags.js

@@ -121,13 +121,13 @@ Flags.get = async function (flagId) {
 	return data.flag;
 };
 
-Flags.getCount = async function ({ uid, filters }) {
+Flags.getCount = async function ({ uid, filters, query }) {
 	filters = filters || {};
-	const flagIds = await Flags.getFlagIdsWithFilters({ filters, uid });
+	const flagIds = await Flags.getFlagIdsWithFilters({ filters, uid, query });
 	return flagIds.length;
 };
 
-Flags.getFlagIdsWithFilters = async function ({ filters, uid }) {
+Flags.getFlagIdsWithFilters = async function ({ filters, uid, query }) {
 	let sets = [];
 	const orSets = [];
 
@@ -164,7 +164,13 @@ Flags.getFlagIdsWithFilters = async function ({ filters, uid }) {
 		}
 	}
 
-	return flagIds;
+	const result = await plugins.hooks.fire('filter:flags.getFlagIdsWithFilters', {
+		filters,
+		uid,
+		query,
+		flagIds,
+	});
+	return result.flagIds;
 };
 
 Flags.list = async function (data) {
@@ -172,6 +178,7 @@ Flags.list = async function (data) {
 	let flagIds = await Flags.getFlagIdsWithFilters({
 		filters,
 		uid: data.uid,
+		query: data.query,
 	});
 	flagIds = await Flags.sort(flagIds, data.sort);
 

src/middleware/header.js

@@ -109,6 +109,7 @@ middleware.renderHeader = async function renderHeader(req, res, data) {
 		unreadCount: templateValues.unreadCount,
 	} = await appendUnreadCounts({
 		uid: req.uid,
+		query: req.query,
 		navigation: results.navigation,
 		unreadData,
 	}));
@@ -152,16 +153,17 @@ middleware.renderHeader = async function renderHeader(req, res, data) {
 	return await req.app.renderAsync('header', hookReturn.templateValues);
 };
 
-async function appendUnreadCounts({ uid, navigation, unreadData }) {
+async function appendUnreadCounts({ uid, navigation, unreadData, query }) {
 	const originalRoutes = navigation.map(nav => nav.originalRoute);
 	const calls = {
-		unreadData: topics.getUnreadData({ uid: uid }),
+		unreadData: topics.getUnreadData({ uid: uid, query: query }),
 		unreadChatCount: messaging.getUnreadCount(uid),
 		unreadNotificationCount: user.notifications.getUnreadCount(uid),
 		unreadFlagCount: (async function () {
 			if (originalRoutes.includes('/flags') && await user.isPrivileged(uid)) {
 				return flags.getCount({
 					uid,
+					query,
 					filters: {
 						quick: 'unresolved',
 						cid: (await user.isAdminOrGlobalMod(uid)) ? [] : (await user.getModeratedCids(uid)),

src/middleware/helpers.js

@@ -1,5 +1,9 @@
 'use strict';
 
+const winston = require('winston');
+const validator = require('validator');
+const slugify = require('../slugify');
+
 const helpers = module.exports;
 
 helpers.try = function (middleware) {
@@ -20,3 +24,34 @@ helpers.try = function (middleware) {
 		}
 	};
 };
+
+helpers.buildBodyClass = function (req, res, templateData = {}) {
+	const clean = req.path.replace(/^\/api/, '').replace(/^\/|\/$/g, '');
+	const parts = clean.split('/').slice(0, 3);
+	parts.forEach((p, index) => {
+		try {
+			p = slugify(decodeURIComponent(p));
+		} catch (err) {
+			winston.error(err.stack);
+			p = '';
+		}
+		p = validator.escape(String(p));
+		parts[index] = index ? `${parts[0]}-${p}` : `page-${p || 'home'}`;
+	});
+
+	if (templateData.template && templateData.template.topic) {
+		parts.push(`page-topic-category-${templateData.category.cid}`);
+		parts.push(`page-topic-category-${slugify(templateData.category.name)}`);
+	}
+
+	if (Array.isArray(templateData.breadcrumbs)) {
+		templateData.breadcrumbs.forEach((crumb) => {
+			if (crumb && crumb.hasOwnProperty('cid')) {
+				parts.push(`parent-category-${crumb.cid}`);
+			}
+		});
+	}
+
+	parts.push(`page-status-${res.statusCode}`);
+	return parts.join(' ');
+};

src/middleware/render.js

@@ -2,14 +2,14 @@
 
 const nconf = require('nconf');
 const validator = require('validator');
-const winston = require('winston');
+
 
 const plugins = require('../plugins');
 const meta = require('../meta');
 const translator = require('../translator');
 const widgets = require('../widgets');
 const utils = require('../utils');
-const slugify = require('../slugify');
+const helpers = require('./helpers');
 
 const relative_path = nconf.get('relative_path');
 
@@ -31,7 +31,7 @@ module.exports = function (middleware) {
 			options.relative_path = relative_path;
 			options.template = { name: template, [template]: true };
 			options.url = (req.baseUrl + req.path.replace(/^\/api/, ''));
-			options.bodyClass = buildBodyClass(req, res, options);
+			options.bodyClass = helpers.buildBodyClass(req, res, options);
 
 			const buildResult = await plugins.hooks.fire(`filter:${template}.build`, { req: req, res: res, templateData: options });
 			if (res.headersSent) {
@@ -123,34 +123,4 @@ module.exports = function (middleware) {
 		const translated = await translator.translate(str, language);
 		return translator.unescape(translated);
 	}
-
-	function buildBodyClass(req, res, templateData) {
-		const clean = req.path.replace(/^\/api/, '').replace(/^\/|\/$/g, '');
-		const parts = clean.split('/').slice(0, 3);
-		parts.forEach(function (p, index) {
-			try {
-				p = slugify(decodeURIComponent(p));
-			} catch (err) {
-				winston.error(err.stack);
-				p = '';
-			}
-			p = validator.escape(String(p));
-			parts[index] = index ? parts[0] + '-' + p : 'page-' + (p || 'home');
-		});
-
-		if (templateData.template.topic) {
-			parts.push('page-topic-category-' + templateData.category.cid);
-			parts.push('page-topic-category-' + slugify(templateData.category.name));
-		}
-		if (templateData.breadcrumbs) {
-			templateData.breadcrumbs.forEach(function (crumb) {
-				if (crumb.hasOwnProperty('cid')) {
-					parts.push('parent-category-' + crumb.cid);
-				}
-			});
-		}
-
-		parts.push('page-status-' + res.statusCode);
-		return parts.join(' ');
-	}
 };

src/notifications.js

@@ -123,6 +123,12 @@ Notifications.create = async function (data) {
 	}
 	const now = Date.now();
 	data.datetime = now;
+	const result = await plugins.hooks.fire('filter:notifications.create', {
+		data: data,
+	});
+	if (!result.data) {
+		return null;
+	}
 	await Promise.all([
 		db.sortedSetAdd('notifications', now, data.nid),
 		db.setObject('notifications:' + data.nid, data),

src/search.js

@@ -282,7 +282,7 @@ async function getWatchedCids(data) {
 	if (!data.categories.includes('watched')) {
 		return [];
 	}
-	return await user.getCategoriesByStates(data.uid, [categories.watchStates.watching]);
+	return await user.getWatchedCategories(data.uid);
 }
 
 async function getChildrenCids(data) {

src/socket.io/categories.js

@@ -6,6 +6,7 @@ const user = require('../user');
 const topics = require('../topics');
 const api = require('../api');
 const sockets = require('.');
+const plugins = require('../plugins');
 
 const SocketCategories = module.exports;
 
@@ -94,12 +95,17 @@ SocketCategories.getMoveCategories = async function (socket, data) {
 	return await SocketCategories.getSelectCategories(socket, data);
 };
 
-SocketCategories.getSelectCategories = async function (socket) {
+SocketCategories.getSelectCategories = async function (socket, data) {
 	const [isAdmin, categoriesData] = await Promise.all([
 		user.isAdministrator(socket.uid),
 		categories.buildForSelect(socket.uid, 'find', ['disabled', 'link']),
 	]);
-	return categoriesData.filter(category => category && (!category.disabled || isAdmin) && !category.link);
+	const result = await plugins.hooks.fire('filter:categories.getSelectCategories', {
+		categories: categoriesData,
+		isAdmin: isAdmin,
+		query: data.query || {},
+	});
+	return result.categories.filter(category => category && (!category.disabled || isAdmin) && !category.link);
 };
 
 SocketCategories.setWatchState = async function (socket, data) {

src/user/categories.js

@@ -4,6 +4,7 @@ const _ = require('lodash');
 
 const db = require('../database');
 const categories = require('../categories');
+const plugins = require('../plugins');
 
 module.exports = function (User) {
 	User.setCategoryWatchState = async function (uid, cids, state) {
@@ -36,14 +37,24 @@ module.exports = function (User) {
 		if (!(parseInt(uid, 10) > 0)) {
 			return [];
 		}
-		return await User.getCategoriesByStates(uid, [categories.watchStates.ignoring]);
+		const cids = await User.getCategoriesByStates(uid, [categories.watchStates.ignoring]);
+		const result = await plugins.hooks.fire('filter:user.getIgnoredCategories', {
+			uid: uid,
+			cids: cids,
+		});
+		return result.cids;
 	};
 
 	User.getWatchedCategories = async function (uid) {
 		if (!(parseInt(uid, 10) > 0)) {
 			return [];
 		}
-		return await User.getCategoriesByStates(uid, [categories.watchStates.watching]);
+		const cids = await User.getCategoriesByStates(uid, [categories.watchStates.watching]);
+		const result = await plugins.hooks.fire('filter:user.getWatchedCategories', {
+			uid: uid,
+			cids: cids,
+		});
+		return result.cids;
 	};
 
 	User.getCategoriesByStates = async function (uid, states) {