nodebb-rewards-essentials/lib/rewards.js

Essential Rewards Starter Pack for NodeBB

'use strict';

const validator = require.main.require('validator');

const groups = require.main.require('./src/groups');
const user = require.main.require('./src/user');
const notifications = require.main.require('./src/notifications');
const slugify = require.main.require('./src/slugify');
const plugins = require.main.require('./src/plugins');

const rewards = module.exports;

rewards.get = async function (rewards) {
	const groupsData = await getGroupList();

	rewards = rewards.concat([
		{
			rid: 'essentials/add-to-group',
			name: 'Add to Group',
			inputs: [
				{
					type: 'select',
					name: 'groupname',
					label: 'Group Name:',
					values: groupsData,
				},
			],
		},
		{
			rid: 'essentials/remove-from-group',
			name: 'Remove from Group',
			inputs: [
				{
					type: 'select',
					name: 'groupname',
					label: 'Group Name:',
					values: groupsData,
				},
			],
		},
		{
			rid: 'essentials/alert-user',
			name: 'Send alert message',
			inputs: [
				{
					type: 'text',
					name: 'title',
					label: 'Title:',
				},
				{
					type: 'text',
					name: 'message',
					label: 'Message:',
				},
			],
		},
		{
			rid: 'essentials/award-reputation',
			name: 'Award Reputation',
			inputs: [
				{
					type: 'text',
					name: 'reputation',
					label: 'Amount of reputation:',
				},
			],
		},
	]);
	return rewards;
};

async function getConditionalString(conditional) {
	const conds = await plugins.hooks.fire('filter:rewards.conditionals', []);
	const names = conds.filter(cond => cond && cond.conditional === conditional).map(cond => cond.name);
	return names.length ? names[0] : '';
}

async function getConditionalLangKey(rewardData) {
	const conditionalStr = await getConditionalString(rewardData.conditional);
	let { value } = rewardData;
	if (['essentials/user.lastonline', 'essentials/user.joindate'].includes(rewardData.condition)) {
		value = new Date(parseInt(value, 10)).toDateString();
	}
	return `[[rewards:${rewardData.condition}-conditional-value, ${conditionalStr}, ${value}]]`;
}

rewards.addToGroup = async function (data) {
	await groups.join(data.reward.groupname, data.uid);
	const langKey = await getConditionalLangKey(data.rewardData);
	await sendNotification(data.uid, {
		bodyShort: `[[rewards:awarded-group-membership, ${data.reward.groupname}]]<br/>${langKey}`,
		nid: `uid:${data.uid}:id:${data.rewardData.id}`,
		path: `/groups/${slugify(data.reward.groupname)}`,
	});
};

rewards.removeFromGroup = async function (data) {
	await groups.leave(data.reward.groupname, data.uid);
};

rewards.alertUser = function (data) {
	const websockets = require.main.require('./src/socket.io');
	websockets.in(`uid_${data.uid}`).emit('event:alert', data.reward);
};

rewards.awardReputation = async function (data) {
	await user.incrementUserReputationBy(data.uid, data.reward.reputation);
	const langKey = await getConditionalLangKey(data.rewardData);
	await sendNotification(data.uid, {
		bodyShort: `[[rewards:awarded-x-reputation, ${data.reward.reputation}]]<br/>${langKey}`,
		nid: `uid:${data.uid}:id:${data.rewardData.id}`,
		icon: 'fa-medal',
	});
};

async function sendNotification(uid, notifData) {
	const notifObj = await notifications.create({
		type: 'new-reward',
		icon: 'fa-trophy',
		...notifData,
	});
	notifications.push(notifObj, [uid]);
}

async function getGroupList() {
	const groupNames = await groups.getGroups('groups:createtime', 0, -1);

	groupNames.sort((a, b) => {
		const isAPrivGroup = groups.isPrivilegeGroup(a);
		const isBPrivGroup = groups.isPrivilegeGroup(b);
		if (isAPrivGroup && !isBPrivGroup) {
			return 1;
		} else if (!isAPrivGroup && isBPrivGroup) {
			return -1;
		}
		if (a > b) {
			return 1;
		} else if (b > a) {
			return -1;
		}
		return 0;
	});

	const groupData = groupNames.map((group) => {
		let name = group;
		const matchesCatPrivsGroup = group.match(/cid:([0-9]*):privileges:groups:([\s\S]*)/);

		if (matchesCatPrivsGroup !== null) {
			if (matchesCatPrivsGroup[1] === '0') {
				return null;
			}
			name = `Category ${matchesCatPrivsGroup[1]} group with privilege ${matchesCatPrivsGroup[2]}`;
		} else if (groups.isPrivilegeGroup(group)) {
			return null;
		}

		return {
			name: validator.escape(String(name || group)),
			value: validator.escape(String(group)),
		};
	});
	return groupData.filter(Boolean);
}