Skip to content

Node.js based forum software built for the modern web

8.8 KB
Raw Blame
'use strict';

const winston = require('winston');
const _ = require('lodash');
const Benchpress = require('benchpressjs');

const plugins = require('../plugins');
const groups = require('../groups');
const db = require('../database');
const apiController = require('../controllers/api');

const widgets = module.exports;

widgets.render = async function (uid, options) {
	if (!options.template) {
		throw new Error('[[error:invalid-data]]');
	}
	const data = await widgets.getWidgetDataForTemplates(['global', options.template]);
	delete data.global.drafts;

	const locations = _.uniq(Object.keys(data.global).concat(Object.keys(data[options.template])));

	let config = options.res.locals.config || {};
	if (options.res.locals.isAPI) {
		config = await apiController.loadConfig(options.req);
	}

	const widgetData = await Promise.all(
		locations.map(location => renderLocation(location, data, uid, options, config))
	);

	const returnData = {};
	locations.forEach((location, i) => {
		if (Array.isArray(widgetData[i]) && widgetData[i].length) {
			returnData[location] = widgetData[i].filter(widget => widget && widget.html);
		}
	});

	return returnData;
};

async function renderLocation(location, data, uid, options, config) {
	const widgetsAtLocation = (data[options.template][location] || []).concat(data.global[location] || []);

	if (!widgetsAtLocation.length) {
		return [];
	}

	const renderedWidgets = await Promise.all(
		widgetsAtLocation.map(widget => renderWidget(widget, uid, options, config, location))
	);
	return renderedWidgets;
}

async function renderWidget(widget, uid, options, config, location) {
	if (!widget || !widget.data || (!!widget.data['hide-mobile'] && options.req.useragent.isMobile)) {
		return;
	}

	const isVisible = await widgets.checkVisibility(widget.data, uid);
	if (!isVisible) {
		return;
	}

	const templateData = _.assign({ }, options.templateData, { config: config });
	try {
		const data = await plugins.hooks.fire(`filter:widget.render:${widget.widget}`, {
			uid: uid,
			area: options,
			templateData: templateData,
			data: widget.data,
			req: options.req,
			res: options.res,
			location,
		});

		if (!data) {
			return;
		}

		let { html } = data;

		if (widget.data.container && widget.data.container.match('{body}')) {
			html = await Benchpress.compileRender(widget.data.container, {
				title: widget.data.title,
				body: html,
				template: data.templateData && data.templateData.template,
				_i18n: options?.res?.locals?._i18n,
			});
		}

		return { html };
	} catch (err) {
		winston.error(err.stack);
		return { html: '' };
	}
}

widgets.checkVisibility = async function (data, uid) {
	let isVisible = true;
	let isHidden = false;
	if (data.groups.length) {
		isVisible = await groups.isMemberOfAny(uid, data.groups);
	}
	if (data.groupsHideFrom.length) {
		isHidden = await groups.isMemberOfAny(uid, data.groupsHideFrom);
	}

	const isExpired = (
		(data.startDate && Date.now() < new Date(data.startDate).getTime()) ||
		(data.endDate && Date.now() > new Date(data.endDate).getTime())
	);

	return isVisible && !isHidden && !isExpired;
};

widgets.getWidgetDataForTemplates = async function (templates) {
	const keys = templates.map(tpl => `widgets:${tpl}`);
	const data = await db.getObjects(keys);

	const returnData = {};

	templates.forEach((template, index) => {
		returnData[template] = returnData[template] || {};

		const templateWidgetData = data[index] || {};
		const locations = Object.keys(templateWidgetData);

		locations.forEach((location) => {
			if (templateWidgetData && templateWidgetData[location]) {
				try {
					returnData[template][location] = parseWidgetData(templateWidgetData[location]);
				} catch (err) {
					winston.error(`can not parse widget data. template:  ${template} location: ${location}\n${err.stack}`);
					returnData[template][location] = [];
				}
			} else {
				returnData[template][location] = [];
			}
		});
	});

	return returnData;
};

widgets.getArea = async function (template, location) {
	const result = await db.getObjectField(`widgets:${template}`, location);
	if (!result) {
		return [];
	}
	return parseWidgetData(result);
};

function parseWidgetData(data) {
	const widgets = JSON.parse(data);
	widgets.forEach((widget) => {
		if (widget) {
			widget.data.groups = widget.data.groups || [];
			if (widget.data.groups && !Array.isArray(widget.data.groups)) {
				widget.data.groups = [widget.data.groups];
			}

			widget.data.groupsHideFrom = widget.data.groupsHideFrom || [];
			if (widget.data.groupsHideFrom && !Array.isArray(widget.data.groupsHideFrom)) {
				widget.data.groupsHideFrom = [widget.data.groupsHideFrom];
			}
		}
	});
	return widgets;
}

widgets.setArea = async function (area) {
	if (!area.location || !area.template) {
		throw new Error('Missing location and template data');
	}

	await db.setObjectField(`widgets:${area.template}`, area.location, JSON.stringify(area.widgets));
};

widgets.setAreas = async function (areas) {
	const templates = {};
	areas.forEach((area) => {
		if (!area.location || !area.template) {
			throw new Error('Missing location and template data');
		}
		templates[area.template] = templates[area.template] || {};
		templates[area.template][area.location] = JSON.stringify(area.widgets);
	});

	await db.setObjectBulk(
		Object.keys(templates).map(tpl => [`widgets:${tpl}`, templates[tpl]])
	);
};

widgets.getAvailableAreas = async function () {
	const defaultAreas = [
		{ name: 'Global Header', template: 'global', location: 'header' },
		{ name: 'Global Footer', template: 'global', location: 'footer' },
		{ name: 'Global Sidebar', template: 'global', location: 'sidebar' },

		{ name: 'Group Page (Left)', template: 'groups/details.tpl', location: 'left' },
		{ name: 'Group Page (Right)', template: 'groups/details.tpl', location: 'right' },

		{ name: 'Chat Header', template: 'chats.tpl', location: 'header' },
		{ name: 'Chat Sidebar', template: 'chats.tpl', location: 'sidebar' },
	];

	return await plugins.hooks.fire('filter:widgets.getAreas', defaultAreas);
};

widgets.saveLocationsOnThemeReset = async function () {
	const locations = {};
	const available = await widgets.getAvailableAreas();
	for (const area of available) {
		/* eslint-disable no-await-in-loop */
		const widgetsAtLocation = await widgets.getArea(area.template, area.location);
		if (widgetsAtLocation.length) {
			locations[area.template] = locations[area.template] || [];
			if (!locations[area.template].includes(area.location)) {
				locations[area.template].push(area.location);
			}
		}
	}

	if (Object.keys(locations).length) {
		await db.set('widgets:draft:locations', JSON.stringify(locations));
	}
};

widgets.moveMissingAreasToDrafts = async function () {
	const locationsObj = await db.get('widgets:draft:locations');
	if (!locationsObj) {
		return;
	}
	try {
		const locations = JSON.parse(locationsObj);
		const [available, draftWidgets] = await Promise.all([
			widgets.getAvailableAreas(),
			widgets.getArea('global', 'drafts'),
		]);
		let saveDraftWidgets = draftWidgets || [];
		for (const [template, tplLocations] of Object.entries(locations)) {
			for (const location of tplLocations) {
				const locationExists = available.find(
					area => area.template === template && area.location === location
				);
				if (!locationExists) {
					const widgetsAtLocation = await widgets.getArea(template, location);
					saveDraftWidgets = saveDraftWidgets.concat(widgetsAtLocation);
					await widgets.setArea({
						template,
						location,
						widgets: [],
					});
				}
			}
		}
		await widgets.setArea({
			template: 'global',
			location: 'drafts',
			widgets: saveDraftWidgets,
		});
	} catch (err) {
		winston.error(err.stack);
	} finally {
		await db.delete('widgets:draft:locations');
	}
};

widgets.reset = async function () {
	const [areas, drafts] = await Promise.all([
		widgets.getAvailableAreas(),
		widgets.getArea('global', 'drafts'),
	]);

	let saveDrafts = drafts || [];
	for (const area of areas) {
		/* eslint-disable no-await-in-loop */
		const areaData = await widgets.getArea(area.template, area.location);
		saveDrafts = saveDrafts.concat(areaData);
		area.widgets = [];
		await widgets.setArea(area);
	}

	await widgets.setArea({
		template: 'global',
		location: 'drafts',
		widgets: saveDrafts,
	});
};

widgets.resetTemplate = async function (template) {
	const area = await db.getObject(`widgets:${template}.tpl`);
	if (area) {
		const toBeDrafted = _.flatMap(Object.values(area), value => JSON.parse(value));
		await db.delete(`widgets:${template}.tpl`);
		let draftWidgets = await db.getObjectField('widgets:global', 'drafts');
		draftWidgets = JSON.parse(draftWidgets).concat(toBeDrafted);
		await db.setObjectField('widgets:global', 'drafts', JSON.stringify(draftWidgets));
	}
};

widgets.resetTemplates = async function (templates) {
	for (const template of templates) {
		/* eslint-disable no-await-in-loop */
		await widgets.resetTemplate(template);
	}
};

require('../promisify')(widgets);