nodebb-plugin-poll 3.2.8 → 4.0.0

package/upgrades/poll-4.0-upgrade.js

@@ -0,0 +1,128 @@
+'use strict';
+
+const db = require.main.require('./src/database');
+const batch = require.main.require('./src/batch');
+
+module.exports = {
+	name: 'Convert data structures for v4.0',
+	timestamp: Date.UTC(2026, 2, 7),
+	method: async function () {
+		const { progress } = this;
+
+		await convertSettings();
+
+		await db.delete('polls:scheduled');
+
+		const pollIds = [...new Set(await db.getListRange('polls', 0, -1))];
+		progress.total = pollIds.length;
+
+		await batch.processArray(pollIds, async (pollIds) => {
+			let polls = await db.getObjects(pollIds.map(pollId => `poll:${pollId}`));
+
+			await moveSettingsToPollHash(pollIds);
+
+			await addPollsToSortedSet(polls, pollIds);
+
+			await savePollOptionsInPollHash(pollIds);
+
+			await updatePollIdsInPosts(polls, pollIds);
+
+			progress.incr(pollIds.length);
+		}, {
+			batch: 500,
+		});
+		await db.delete('polls');
+	},
+};
+
+async function convertSettings() {
+	const settings = await db.getObject('settings:poll');
+	if (settings) {
+		try {
+			const parsed = JSON.parse(settings._);
+			const newSettings = {};
+			if (parsed?.toggles?.allowAnon) {
+				newSettings.allowGuestsToViewResults = parsed.toggles.allowAnon;
+			}
+			if (parsed?.limits?.maxOptions) {
+				newSettings.maxOptions = parsed.limits.maxOptions;
+			}
+			if (parsed?.defaults?.title) {
+				newSettings.defaultTitle = parsed.defaults.title;
+			}
+			if (parsed?.defaults?.maxvotes) {
+				newSettings.maximumVotesPerUser = parsed.defaults.maxvotes;
+			}
+			await db.setObject('settings:poll', newSettings);
+		} catch (err) {
+			console.info('[Poll Plugin] Error parsing settings, resetting to defaults');
+		}
+	}
+}
+
+async function moveSettingsToPollHash(pollIds) {
+	const pollSettings = await db.getObjects(pollIds.map(pollId => `poll:${pollId}:settings`));
+	const bulkSet = [];
+	pollSettings.forEach((s, i) => {
+		const pollId = pollIds[i];
+		if (s && pollId) {
+			bulkSet.push([`poll:${pollId}`, {
+				title: Object.hasOwn(s, 'title') ? s.title : 'Poll',
+				end: Object.hasOwn(s, 'end') ? s.end : 0,
+				disallowVoteUpdate: Object.hasOwn(s, 'disallowVoteUpdate') ? s.disallowVoteUpdate : 0,
+				allowAnonVoting: Object.hasOwn(s, 'allowAnonVoting') ? s.allowAnonVoting : 0,
+				maximumVotesPerUser: Object.hasOwn(s, 'maxvotes') ? s.maxvotes : 0,
+			}]);
+		}
+	});
+	await db.setObjectBulk(bulkSet);
+	await db.deleteAll(pollIds.map(pollId => `poll:${pollId}:settings`));
+}
+
+async function addPollsToSortedSet(polls, pollIds) {
+	const bulkAdd = [];
+	polls.forEach((poll, index) => {
+		if (poll) {
+			bulkAdd.push([`polls:createtime`, poll.timestamp || 0, pollIds[index]]);
+		}
+	});
+	await db.sortedSetAddBulk(bulkAdd);
+}
+
+async function savePollOptionsInPollHash(pollIds) {
+	const pollOptions = await db.getSetsMembers(pollIds.map(pollId => `poll:${pollId}:options`));
+	const bulkSet = [];
+	await Promise.all(pollOptions.map(async (options, index) => {
+		const pollId = pollIds[index];
+		if (pollId && options?.length) {
+			const keys = options.map((option, i) => `poll:${pollId}:options:${options[i]}`)
+			const optionData = await db.getObjects(keys);
+			bulkSet.push([
+				`poll:${pollId}`,
+				{
+					pollId: pollId, // some old polls had "pollid" field, this fixes that
+					options: JSON.stringify(optionData.map(o => ({ id: o.id, title: o.title })))
+				},
+			]);
+		}
+	}));
+
+	await db.setObjectBulk(bulkSet);
+	await db.deleteAll(pollIds.map(pollId => `poll:${pollId}:options`))
+}
+
+async function updatePollIdsInPosts(polls, pollIds) {
+	const pids = polls.map(poll => poll && poll.pid);
+	const bulkSet = [];
+	polls.forEach((poll, index) => {
+		if (poll && poll.pid) {
+			bulkSet.push([
+				`post:${poll.pid}`,
+				{ pollIds: JSON.stringify([pollIds[index]]) }
+			]);
+		}
+	});
+
+	await db.setObjectBulk(bulkSet);
+	await db.deleteObjectFields(pids.map(pid => `post:${pid}`), ['pollId']);
+}

package/lib/scheduler.js

@@ -1,52 +0,0 @@
-'use strict';
-
-const cron = require('cron').CronJob;
-const NodeBB = require('./nodebb');
-
-const Poll = require('./poll');
-
-const Scheduler = exports;
-const jobs = {};
-
-Scheduler.start = async function () {
-	const pollIds = await Poll.getScheduled();
-	await Promise.all(pollIds.map(Scheduler.add));
-};
-
-Scheduler.add = async function (pollId) {
-	if (Object.keys(jobs).indexOf(pollId.toString()) !== -1) {
-		return;
-	}
-
-	const settings = await Poll.getSettings(pollId);
-	if (!settings) {
-		return NodeBB.winston.error(`[nodebb-plugin-poll/scheduler] Poll ID ${pollId} has no settings!`);
-	}
-
-	const now = Date.now();
-	const end = parseInt(settings.end, 10);
-
-	if (end < now) {
-		Scheduler.end(pollId);
-	} else {
-		const date = new Date(end);
-		NodeBB.winston.verbose(`[nodebb-plugin-poll/scheduler] Starting scheduler for poll with ID ${pollId} to end on ${date}`);
-		jobs[pollId] = new cron(date, (() => {
-			Scheduler.end(pollId);
-		}), null, true);
-	}
-};
-
-Scheduler.end = async function (pollId) {
-	NodeBB.winston.verbose(`[nodebb-plugin-poll/scheduler] Ending poll with ID ${pollId}`);
-
-	const index = Object.keys(jobs).indexOf(pollId.toString());
-
-	if (index !== -1 && jobs[pollId] !== undefined) {
-		jobs[pollId].stop();
-		delete jobs[pollId];
-	}
-
-	await Poll.end(pollId);
-};
-

package/lib/serializer.js

@@ -1,4 +0,0 @@
-'use strict';
-
-const utils = require.main.require('./src/utils');
-module.exports = require('../public/js/poll/serializer')(utils);

package/public/js/poll/serializer.js

@@ -1,173 +0,0 @@
-'use strict';
-
-module.exports = function (utils) {
-	var Serializer = {};
-
-	var pollRegex = /(?:(?:\[poll(?<settings>.*?)\])(?:\\n|\n|<br \/>)(?<content>(?:-.+?(?:\\n|\n|<br \/>))+)(?:\[\/poll\]))/g;
-	var settingsRegex = /(?<key>.+?)=(?:"|&quot;|&#92;)(?<value>.+?)(?:"|&quot;|&#92;)/g;
-	var settingsValidators = {
-		title: {
-			test: function (value) {
-				return value.length > 0;
-			},
-			parse: function (value) {
-				return utils.stripHTMLTags(value).trim();
-			},
-		},
-		maxvotes: {
-			test: function (value) {
-				return !isNaN(value);
-			},
-			parse: function (value) {
-				return parseInt(value, 10);
-			},
-		},
-		disallowVoteUpdate: {
-			test: function (value) {
-				return /true|false/.test(value);
-			},
-			parse: function (value) {
-				return value === 'true' || value === true ? 1 : 0;
-			},
-		},
-		allowAnonVoting: {
-			test: function (value) {
-				return /true|false/.test(value);
-			},
-			parse: function (value) {
-				return value === 'true' || value === true ? 1 : 0;
-			},
-		},
-		end: {
-			test: function (value) {
-				return (!isNaN(value) && parseInt(value, 10) > Date.now());
-			},
-			parse: function (value) {
-				return parseInt(value, 10);
-			},
-		},
-	};
-
-	Serializer.canSerialize = function (post) {
-		pollRegex.lastIndex = 0;
-		return pollRegex.test(post);
-	};
-
-	Serializer.removeMarkup = function (content, replace) {
-		return content.replace(pollRegex, replace || '');
-	};
-
-	Serializer.hasMarkup = function (content) {
-		pollRegex.lastIndex = 0;
-		const has = pollRegex.test(content);
-		return has;
-	};
-
-	Serializer.serialize = function (post, config) {
-		pollRegex.lastIndex = 0;
-		var match = pollRegex.exec(post);
-
-		if (match === null) {
-			return null;
-		}
-
-		return {
-			options: serializeOptions(match.groups.content, config),
-			settings: serializeSettings(match.groups.settings, config),
-		};
-	};
-
-	Serializer.deserialize = function (poll, config) {
-		var options = deserializeOptions(poll.options, config);
-		var settings = deserializeSettings(poll.settings, config);
-
-		return '[poll' + settings + ']\n' + options + '\n[/poll]';
-	};
-
-	function serializeOptions(raw, config) {
-		// Depending on composer, the line breaks can either be \n or <br /> so handle both
-		var pollOptions = [];
-		var rawOptions = raw.split(/(?:\\n|\n|<br \/>)/);
-		rawOptions.map(raw => utils.stripHTMLTags(raw));
-		var maxOptions = parseInt(config.limits.maxOptions, 10);
-
-		rawOptions.forEach(function (option) {
-			if (option.length) {
-				option = option.split('-').slice(1).join('-').trim();
-
-				if (option.length) {
-					pollOptions.push(option);
-				}
-			}
-		});
-
-		if (pollOptions.length > maxOptions) {
-			pollOptions = pollOptions.slice(0, maxOptions - 1);
-		}
-
-		return pollOptions;
-	}
-
-	function deserializeOptions(options, config) {
-		var maxOptions = config.limits.maxOptions;
-
-		options = options.map(function (option) {
-			return utils.stripHTMLTags(option).trim();
-		}).filter(function (option) {
-			return option.length;
-		});
-
-		if (options.length > maxOptions) {
-			options = options.slice(0, maxOptions - 1);
-		}
-
-		return options.length ? '- ' + options.join('\n- ') : '';
-	}
-
-	function serializeSettings(raw, config) {
-		var settings = {};
-
-		Object.keys(config.defaults).forEach(function (key) {
-			settings[key] = config.defaults[key];
-		});
-
-		const stripped = utils.stripHTMLTags(raw).replace(/\\/g, '&#92;');
-		let match;
-		while ((match = settingsRegex.exec(stripped)) !== null) {
-			var key = match.groups.key.trim();
-			var value = match.groups.value.trim();
-
-			if (key.length && value.length && settingsValidators.hasOwnProperty(key)) {
-				if (settingsValidators[key].test(value)) {
-					settings[key] = settingsValidators[key].parse(value);
-				}
-			}
-		}
-
-		return settings;
-	}
-
-	function deserializeSettings(settings, config) {
-		var deserialized = '';
-
-		for (var k of Object.keys(settings)) {
-			if (settings.hasOwnProperty(k) && config.defaults.hasOwnProperty(k)) {
-				var key = utils.stripHTMLTags(k).trim();
-				var value = utils.stripHTMLTags(settings[k]).trim();
-
-				if (key.length && value.length && settingsValidators.hasOwnProperty(key)) {
-					if (settingsValidators[key].test(value)) {
-						deserialized += ' ' + key + '="' + value + '"';
-					}
-				}
-			}
-		}
-
-		return deserialized;
-	}
-
-	if (typeof window !== 'undefined') {
-		window.Poll.serializer = Serializer;
-	}
-	return Serializer;
-};