nodebb-plugin-composer-quill/library.js

'use strict';

const SocketPlugins = require.main.require('./src/socket.io/plugins');
const SocketAdmin = require.main.require('./src/socket.io/admin').plugins;
SocketAdmin['composer-quill'] = require('./lib/adminsockets');

const defaultComposer = require.main.require('nodebb-plugin-composer-default');
const plugins = module.parent.exports;
const meta = require.main.require('./src/meta');
const posts = require.main.require('./src/posts');
const messaging = require.main.require('./src/messaging');
const helpers = require.main.require('./src/controllers/helpers');

const async = require('async');

const winston = require.main.require('winston');
const nconf = require.main.require('nconf');

const controllers = require('./lib/controllers');
const migrator = require('./lib/migrator');

const plugin = {};

plugin.init = function (data, callback) {
	const { router } = data;
	const hostMiddleware = data.middleware;

	router.get('/admin/plugins/composer-quill', hostMiddleware.admin.buildHeader, controllers.renderAdminPage);
	router.get('/api/admin/plugins/composer-quill', controllers.renderAdminPage);

	// Expose the default composer's socket method calls for this composer as well
	plugin.checkCompatibility((err, checks) => {
		if (err) {
			return winston.error(`[plugin/composer-quill] Error initialising plugin: ${err.message}`);
		}

		if (checks.composer) {
			SocketPlugins.composer = defaultComposer.socketMethods;
			SocketPlugins['composer-quill'] = require('./lib/websockets');
		} else {
			winston.warn('[plugin/composer-quill] Another composer plugin is active! Please disable all other composers.');
		}
	});

	callback();
};

plugin.checkCompatibility = function (callback) {
	async.parallel({
		active: async.apply(plugins.getActive),
		markdown: async.apply(meta.settings.get, 'markdown'),
	}, (err, data) => {
		callback(err, {
			markdown: data.active.indexOf('nodebb-plugin-markdown') === -1,	// plugin disabled
			composer: data.active.filter(plugin => plugin.startsWith('nodebb-plugin-composer-') && plugin !== 'nodebb-plugin-composer-quill').length === 0,
		});
	});
};

plugin.addAdminNavigation = function (header, callback) {
	header.plugins.push({
		route: '/plugins/composer-quill',
		icon: 'fa-edit',
		name: 'Quill (Composer)',
	});

	callback(null, header);
};

plugin.build = function (data, callback) {
	// No plans for a standalone composer route, so handle redirection on f5
	const { req } = data;
	const { res } = data;

	if (req.query.p) {
		if (!res.locals.isAPI) {
			if (req.query.p.startsWith(nconf.get('relative_path'))) {
				req.query.p = req.query.p.replace(nconf.get('relative_path'), '');
			}

			return helpers.redirect(res, req.query.p);
		}
		return res.render('', {});
	} else if (!req.query.pid && !req.query.tid && !req.query.cid) {
		return helpers.redirect(res, '/');
	}

	callback(null, data);
};

plugin.savePost = async (data, path = 'post') => {
	if (typeof path === 'function') {
		path = 'post';
	}

	if (migrator.isDelta(data[path].content)) {
		// Optimistic case: regular post via quill composer
		data[path].quillDelta = data[path].content;
		data[path].content = migrator.toHtml(data[path].content);
	} else {
		// Fallback to handle write-api and such
		data[path] = migrator.toQuill(data[path]);
	}

	return data;
};

plugin.savePostQueue = async (data) => {
	data = await plugin.savePost(data, 'data');
	return data;
};

plugin.saveChat = (data, callback) => {
	if (data.system) {
		return setImmediate(callback, null, data);
	}

	data.quillDelta = data.content;
	data.content = migrator.toHtml(data.content);
	callback(null, data);
};

plugin.append = async (data) => {
	const delta = await posts.getPostField(data.pid, 'quillDelta');
	if (delta) {
		data.body = delta;
	}
	return data;
};

plugin.handleRawPost = async (data) => {
	const delta = await posts.getPostField(data.postData.pid, 'quillDelta');
	if (delta) {
		data.postData.content = delta;
	}
	return data;
};

plugin.handleMessageEdit = async (data) => {
	// Only handle situations where message content is requested
	if (data.fields.length > 1 || data.fields[0] !== 'content') {
		return data;
	}

	const delta = await messaging.getMessageField(data.mid, 'quillDelta');
	data.message.content = delta;
	return data;
};

plugin.handleMessageCheck = async ({ content, length }) => {
	try {
		const delta = JSON.parse(content);
		if (!delta.ops) {
			throw new Error();
		}

		content = delta.ops.reduce((memo, cur) => {
			memo += cur.insert ? cur.insert : '';
			return memo;
		}, '');
		length = String(content).trim().length;
	} catch (e) {
		winston.warn('[plugins/quill/handleMessageCheck] Did not receive a delta, ignoring...');
	}

	return { content, length };
};

module.exports = plugin;