NodeBB/src/search.js

'use strict';

var async = require('async');
var _ = require('lodash');

var db = require('./database');
var posts = require('./posts');
var topics = require('./topics');
var categories = require('./categories');
var user = require('./user');
var plugins = require('./plugins');
var privileges = require('./privileges');
var utils = require('./utils');

var search = module.exports;

search.search = function (data, callback) {
	var start = process.hrtime();
	data.searchIn = data.searchIn || 'titlesposts';

	async.waterfall([
		function (next) {
			if (data.searchIn === 'posts' || data.searchIn === 'titles' || data.searchIn === 'titlesposts') {
				searchInContent(data, next);
			} else if (data.searchIn === 'users') {
				user.search(data, next);
			} else if (data.searchIn === 'tags') {
				topics.searchAndLoadTags(data, next);
			} else {
				next(new Error('[[error:unknown-search-filter]]'));
			}
		},
		function (result, next) {
			result.time = (process.elapsedTimeSince(start) / 1000).toFixed(2);
			next(null, result);
		},
	], callback);
};

function searchInContent(data, callback) {
	data.uid = data.uid || 0;
	var matchCount = 0;
	var pids;
	var metadata;
	var itemsPerPage = data.itemsPerPage || 10;
	async.waterfall([
		function (next) {
			async.parallel({
				searchCids: function (next) {
					getSearchCids(data, next);
				},
				searchUids: function (next) {
					getSearchUids(data, next);
				},
			}, next);
		},
		function (results, next) {
			function doSearch(type, searchIn, next) {
				if (searchIn.includes(data.searchIn)) {
					plugins.fireHook('filter:search.query', {
						index: type,
						content: data.query,
						matchWords: data.matchWords || 'all',
						cid: results.searchCids,
						uid: results.searchUids,
						searchData: data,
					}, next);
				} else {
					next(null, []);
				}
			}
			async.parallel({
				pids: function (next) {
					doSearch('post', ['posts', 'titlesposts'], next);
				},
				tids: function (next) {
					doSearch('topic', ['titles', 'titlesposts'], next);
				},
			}, next);
		},
		function (results, next) {
			pids = results.pids;
			if (!results.pids.length && !results.tids.length) {
				return callback(null, { posts: [], matchCount: matchCount, pageCount: 1 });
			}

			topics.getMainPids(results.tids, next);
		},
		function (mainPids, next) {
			pids = mainPids.concat(pids).filter(Boolean);

			privileges.posts.filter('read', pids, data.uid, next);
		},
		function (pids, next) {
			filterAndSort(pids, data, next);
		},
		function (pids, next) {
			plugins.fireHook('filter:search.inContent', {
				pids: pids,
			}, next);
		},
		function (_metadata, next) {
			metadata = _metadata;
			matchCount = metadata.pids.length;

			if (data.page) {
				var start = Math.max(0, (data.page - 1)) * itemsPerPage;
				metadata.pids = metadata.pids.slice(start, start + itemsPerPage);
			}

			posts.getPostSummaryByPids(metadata.pids, data.uid, {}, next);
		},
		function (posts, next) {
			// Append metadata to returned payload (without pids)
			delete metadata.pids;
			next(null, Object.assign({
				posts: posts,
				matchCount: matchCount,
				pageCount: Math.max(1, Math.ceil(parseInt(matchCount, 10) / 10)),
			}, metadata));
		},
	], callback);
}

function filterAndSort(pids, data, callback) {
	async.waterfall([
		function (next) {
			getMatchedPosts(pids, data, next);
		},
		function (posts, next) {
			if (!posts.length) {
				return callback(null, pids);
			}
			posts = posts.filter(Boolean);

			posts = filterByPostcount(posts, data.replies, data.repliesFilter);
			posts = filterByTimerange(posts, data.timeRange, data.timeFilter);
			posts = filterByTags(posts, data.hasTags);

			sortPosts(posts, data);

			plugins.fireHook('filter:search.filterAndSort', { pids: pids, posts: posts, data: data }, next);
		},
		function (result, next) {
			pids = result.posts.map(post => post && post.pid);

			next(null, pids);
		},
	], callback);
}

function getMatchedPosts(pids, data, callback) {
	var postFields = ['pid', 'uid', 'tid', 'timestamp', 'deleted'];
	var categoryFields = [];

	if (data.sortBy && data.sortBy !== 'relevance') {
		if (data.sortBy.startsWith('category.')) {
			categoryFields.push(data.sortBy.split('.')[1]);
		}
	}

	var postsData;
	async.waterfall([
		function (next) {
			posts.getPostsFields(pids, postFields, next);
		},
		function (_postsData, next) {
			postsData = _postsData.filter(post => post && !post.deleted);

			async.parallel({
				users: function (next) {
					if (data.sortBy && data.sortBy.startsWith('user')) {
						var uids = postsData.map(post => post.uid);
						user.getUsersFields(uids, ['username'], next);
					} else {
						next();
					}
				},
				topics: function (next) {
					var topicsData;
					const tids = postsData.map(post => post.tid);
					async.waterfall([
						function (next) {
							topics.getTopicsData(tids, next);
						},
						function (_topics, next) {
							topicsData = _topics;
							async.parallel({
								teasers: function (next) {
									if (data.sortBy && data.sortBy.startsWith('teaser')) {
										var teaserKeys = topicsData.map(topic => 'post:' + topic.teaserPid);
										db.getObjectsFields(teaserKeys, ['timestamp'], next);
									} else {
										next();
									}
								},
								categories: function (next) {
									if (!categoryFields.length) {
										return next();
									}
									var cids = topicsData.map(topic => 'category:' + topic.cid);
									db.getObjectsFields(cids, categoryFields, next);
								},
								tags: function (next) {
									if (Array.isArray(data.hasTags) && data.hasTags.length) {
										topics.getTopicsTags(tids, next);
									} else {
										setImmediate(next);
									}
								},
							}, next);
						},
						function (results, next) {
							topicsData.forEach(function (topic, index) {
								if (topic && results.categories && results.categories[index]) {
									topic.category = results.categories[index];
								}
								if (topic && results.teasers && results.teasers[index]) {
									topic.teaser = results.teasers[index];
								}
								if (topic && results.tags && results.tags[index]) {
									topic.tags = results.tags[index];
								}
							});

							next(null, topicsData);
						},
					], next);
				},
			}, next);
		},
		function (results, next) {
			postsData.forEach(function (post, index) {
				if (results.topics && results.topics[index]) {
					post.topic = results.topics[index];
					if (results.topics[index].category) {
						post.category = results.topics[index].category;
					}
					if (results.topics[index].teaser) {
						post.teaser = results.topics[index].teaser;
					}
				}

				if (results.users && results.users[index]) {
					post.user = results.users[index];
				}
			});

			postsData = postsData.filter(post => post && post.topic && !post.topic.deleted);
			next(null, postsData);
		},
	], callback);
}

function filterByPostcount(posts, postCount, repliesFilter) {
	postCount = parseInt(postCount, 10);
	if (postCount) {
		if (repliesFilter === 'atleast') {
			posts = posts.filter(function (post) {
				return post.topic && post.topic.postcount >= postCount;
			});
		} else {
			posts = posts.filter(function (post) {
				return post.topic && post.topic.postcount <= postCount;
			});
		}
	}
	return posts;
}

function filterByTimerange(posts, timeRange, timeFilter) {
	timeRange = parseInt(timeRange, 10) * 1000;
	if (timeRange) {
		var time = Date.now() - timeRange;
		if (timeFilter === 'newer') {
			posts = posts.filter(function (post) {
				return post.timestamp >= time;
			});
		} else {
			posts = posts.filter(function (post) {
				return post.timestamp <= time;
			});
		}
	}
	return posts;
}

function filterByTags(posts, hasTags) {
	if (Array.isArray(hasTags) && hasTags.length) {
		posts = posts.filter(function (post) {
			var hasAllTags = false;
			if (post && post.topic && Array.isArray(post.topic.tags) && post.topic.tags.length) {
				hasAllTags = hasTags.every(function (tag) {
					return post.topic.tags.includes(tag);
				});
			}
			return hasAllTags;
		});
	}
	return posts;
}

function sortPosts(posts, data) {
	if (!posts.length || !data.sortBy || data.sortBy === 'relevance') {
		return;
	}

	data.sortDirection = data.sortDirection || 'desc';
	var direction = data.sortDirection === 'desc' ? 1 : -1;

	if (data.sortBy === 'timestamp') {
		posts.sort(function (p1, p2) {
			return direction * (p2.timestamp - p1.timestamp);
		});

		return;
	}

	var firstPost = posts[0];
	var fields = data.sortBy.split('.');

	if (!fields || fields.length !== 2 || !firstPost[fields[0]] || !firstPost[fields[0]][fields[1]]) {
		return;
	}

	var isNumeric = utils.isNumber(firstPost[fields[0]][fields[1]]);

	if (isNumeric) {
		posts.sort(function (p1, p2) {
			return direction * (p2[fields[0]][fields[1]] - p1[fields[0]][fields[1]]);
		});
	} else {
		posts.sort(function (p1, p2) {
			if (p1[fields[0]][fields[1]] > p2[fields[0]][fields[1]]) {
				return direction;
			} else if (p1[fields[0]][fields[1]] < p2[fields[0]][fields[1]]) {
				return -direction;
			}
			return 0;
		});
	}
}

function getSearchCids(data, callback) {
	if (!Array.isArray(data.categories) || !data.categories.length) {
		return callback(null, []);
	}

	if (data.categories.includes('all')) {
		return categories.getCidsByPrivilege('categories:cid', data.uid, 'read', callback);
	}

	async.waterfall([
		function (next) {
			async.parallel({
				watchedCids: function (next) {
					if (data.categories.includes('watched')) {
						user.getWatchedCategories(data.uid, next);
					} else {
						next(null, []);
					}
				},
				childrenCids: function (next) {
					if (data.searchChildren) {
						getChildrenCids(data.categories, data.uid, next);
					} else {
						next(null, []);
					}
				},
			}, next);
		},
		function (results, next) {
			var cids = results.watchedCids.concat(results.childrenCids).concat(data.categories).filter(Boolean);
			cids = _.uniq(cids);
			next(null, cids);
		},
	], callback);
}

function getChildrenCids(cids, uid, callback) {
	async.waterfall([
		function (next) {
			categories.getChildren(cids, uid, next);
		},
		function (childrenCategories, next) {
			var childrenCids = [];
			var allCategories = [];

			childrenCategories.forEach(function (childrens) {
				categories.flattenCategories(allCategories, childrens);
				childrenCids = childrenCids.concat(allCategories.map(category => category && category.cid));
			});

			next(null, childrenCids);
		},
	], callback);
}

function getSearchUids(data, callback) {
	if (data.postedBy) {
		user.getUidsByUsernames(Array.isArray(data.postedBy) ? data.postedBy : [data.postedBy], callback);
	} else {
		callback(null, []);
	}
}