nodebb-plugin-poll 3.2.8 → 4.0.0

package/lib/vote.js

@@ -1,23 +1,25 @@
 'use strict';
 
-const NodeBB = require('./nodebb');
+const db = require.main.require('./src/database');
+const privileges = require.main.require('./src/privileges');
+
 const Poll = require('./poll');
 
 const Vote = exports;
 
 Vote.add = async function (voteData) {
-	const { pollId, options, uid } = voteData;
-	const timestamp = +new Date();
+	const { pollId, options, uid, voteAnon } = voteData;
+	const timestamp = Date.now();
 
 	const promises = [
-		NodeBB.db.sortedSetAdd(`poll:${pollId}:voters`, timestamp, uid),
-		NodeBB.db.sortedSetAddBulk(
+		db.sortedSetAdd(`poll:${pollId}:voters`, timestamp, uid),
+		db.sortedSetAddBulk(
 			options.map(option => ([`poll:${pollId}:options:${option}:votes`, timestamp, uid]))
 		),
 	];
-	if (voteData.voteAnon) {
+	if (voteAnon) {
 		promises.push(
-			NodeBB.db.sortedSetAdd(`poll:${pollId}:anon:voters`, timestamp, uid)
+			db.sortedSetAdd(`poll:${pollId}:anon:voters`, timestamp, uid)
 		);
 	}
 
@@ -36,11 +38,11 @@ Vote.removeUidVote = async function (uid, pollId) {
 	const vote = await Vote.getUidVote(uid, pollId);
 	const options = vote.options || [];
 	await Promise.all([
-		NodeBB.db.sortedSetsRemove([
+		db.sortedSetsRemove([
 			`poll:${pollId}:voters`,
 			`poll:${pollId}:anon:voters`,
 		], uid),
-		NodeBB.db.sortedSetsRemove(
+		db.sortedSetsRemove(
 			options.map(option => `poll:${pollId}:options:${option}:votes`),
 			uid,
 		),
@@ -60,37 +62,48 @@ Vote.getUidVote = async function (uid, pollId) {
 
 Vote.update = async function (voteData) {
 	const { uid, pollId } = voteData;
-	const isVotedAnon = await NodeBB.db.isSortedSetMember(`poll:${pollId}:anon:voters`, uid);
+	const isVotedAnon = await db.isSortedSetMember(`poll:${pollId}:anon:voters`, uid);
 	await Vote.remove(voteData);
 	voteData.voteAnon = isVotedAnon;
 	await Vote.add(voteData);
 };
 
 Vote.canUpdateVote = async function (uid, pollId) {
-	const [ended, deleted, updateDisabled] = await Promise.all([
+	const pollInfo = await Poll.getInfo(pollId, false);
+	if (!pollInfo) {
+		throw new Error('[[error:invalid-data]]');
+	}
+	const [canRead, ended, deleted, updateDisabled] = await Promise.all([
+		privileges.posts.can('topics:read', pollInfo.pid, uid),
 		Poll.hasEnded(pollId),
 		Poll.isDeleted(pollId),
 		Poll.doesDisallowVoteUpdate(pollId),
 	]);
-	return !ended && !deleted && !updateDisabled;
+	return !canRead && !ended && !deleted && !updateDisabled;
 };
 
 Vote.canVote = async function (uid, pollId) {
-	const [ended, deleted, hasVoted] = await Promise.all([
+	const pollInfo = await Poll.getInfo(pollId, false);
+	if (!pollInfo) {
+		throw new Error('[[error:invalid-data]]');
+	}
+
+	const [canRead, ended, deleted, hasVoted] = await Promise.all([
+		privileges.posts.can('topics:read', pollInfo.pid, uid),
 		Poll.hasEnded(pollId),
 		Poll.isDeleted(pollId),
 		Vote.hasUidVoted(uid, pollId),
 	]);
-	return !ended && !deleted && !hasVoted;
+	return !canRead && !ended && !deleted && !hasVoted;
 };
 
 Vote.hasUidVoted = async function (uid, pollId) {
-	const score = await NodeBB.db.sortedSetScore(`poll:${pollId}:voters`, uid);
+	const score = await db.sortedSetScore(`poll:${pollId}:voters`, uid);
 	return !!score;
 };
 
 Vote.hasUidVotedOnOption = async function (uid, pollId, option) {
-	const score = await NodeBB.db.sortedSetScore(`poll:${pollId}:options:${option}:votes`, uid);
+	const score = await db.sortedSetScore(`poll:${pollId}:options:${option}:votes`, uid);
 	return !!score;
 };
 

package/library.js

@@ -1,12 +1,13 @@
 'use strict';
 
-const nconf = require.main.require('nconf');
-
 const NodeBB = require('./lib/nodebb');
 const Config = require('./lib/config');
 const Sockets = require('./lib/sockets');
 const Hooks = require('./lib/hooks');
-const Scheduler = require('./lib/scheduler');
+const Poll = require('./lib/poll');
+const db = require.main.require('./src/database');
+const pagination = require.main.require('./src/pagination');
+const utils = require.main.require('./src/utils');
 
 const Plugin = module.exports;
 
@@ -16,22 +17,36 @@ Plugin.load = async function (params) {
 	const routeHelpers = require.main.require('./src/routes/helpers');
 	const { router } = params;
 
-	routeHelpers.setupAdminPageRoute(router, `/admin/plugins/${Config.plugin.id}`, (req, res) => {
+	routeHelpers.setupAdminPageRoute(router, `/admin/plugins/${Config.plugin.id}`, async (req, res) => {
+		const page = Math.max(parseInt(req.query.page, 10) || 1, 1);
+		const itemsPerPage = 20;
+		const start = Math.max(0, (page - 1) * itemsPerPage);
+		const stop = start + itemsPerPage - 1;
+		const [pollIds, count] = await Promise.all([
+			db.getSortedSetRevRange('polls:createtime', start, stop),
+			db.sortedSetCard('polls:createtime'),
+		]);
+
+		const pollData = await db.getObjects(pollIds.map(pollId => `poll:${pollId}`));
+		const voteCounts = await Promise.all(pollIds.map(Poll.getVoteCount));
+		pollData.forEach((poll, index) => {
+			if (poll) {
+				poll.timestampISO = utils.toISOString(poll.timestamp);
+				poll.endISO = utils.toISOString(poll.end);
+				poll.voteCount = voteCounts[index];
+			}
+		});
+		const pageCount = Math.ceil(count / itemsPerPage);
 		res.render(`admin/plugins/${Config.plugin.id}`, {
 			title: 'Poll',
+			polls: pollData,
+			pagination: pagination.create(page, pageCount, req.query),
 		});
 	});
 
 	NodeBB.PluginSockets[Config.plugin.id] = Sockets;
-	NodeBB.AdminSockets[Config.plugin.id] = Config.adminSockets;
 
 	NodeBB.app = params.app;
-
-	if (nconf.get('runJobs')) {
-		Scheduler.start();
-	}
-
-	await Config.init();
 };
 
 Plugin.addAdminNavigation = function (adminHeader) {
@@ -43,15 +58,6 @@ Plugin.addAdminNavigation = function (adminHeader) {
 	return adminHeader;
 };
 
-Plugin.registerFormatting = function (payload) {
-	payload.options.push({
-		name: 'poll',
-		className: `fa ${Config.plugin.icon}`,
-		title: '[[poll:creator_title]]',
-	});
-	return payload;
-};
-
 Plugin.addPrivilege = function (hookData) {
 	hookData.privileges.set(
 		'poll:create', { label: '[[poll:admin.create-poll]]' },
@@ -82,12 +88,8 @@ Plugin.defineWidgets = async function (widgets) {
 };
 
 Plugin.renderPollWidget = async function (widget) {
-	const { tid } = widget.data;
+	const { pollId } = widget.data;
 	const Poll = require('./lib/poll');
-	const pollId = await Poll.getPollIdByTid(tid);
-	if (!pollId) {
-		return null;
-	}
 	const pollData = await Poll.get(pollId, widget.uid, widget.req.loggedIn);
 	if (!pollData) {
 		return null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-poll",
-  "version": "3.2.8",
+  "version": "4.0.0",
   "description": "NodeBB Poll Plugin",
   "main": "library.js",
   "scripts": {
@@ -26,10 +26,10 @@
     "cron": "^1.8.2"
   },
   "nbbpm": {
-    "compatibility": "^4.0.0"
+    "compatibility": "^4.9.2"
   },
   "devDependencies": {
-    "eslint": "9.28.0",
-    "eslint-config-nodebb": "1.1.7"
+    "eslint": "10.0.3",
+    "eslint-config-nodebb": "^2.0.0"
   }
 }

package/plugin.json

@@ -6,19 +6,21 @@
   "library": "library.js",
   "hooks": [
     { "hook": "static:app.load", "method": "load" },
+    { "hook": "filter:config.get", "method": "hooks.filter.configGet" },
     { "hook": "filter:admin.header.build", "method": "addAdminNavigation" },
-    { "hook": "filter:composer.formatting", "method": "registerFormatting" },
+    { "hook": "filter:composer.formatting", "method": "hooks.filter.registerFormatting" },
+    { "hook": "filter:composer.push", "method": "hooks.filter.composerPush" },
     { "hook": "static:privileges.categories.init", "method": "addPrivilege" },
     { "hook": "filter:categories.copyPrivilegesFrom", "method": "copyPrivilegesFrom" },
     { "hook": "filter:topic.post", "method": "hooks.filter.topicPost" },
-    { "hook": "filter:parse.raw", "method": "hooks.filter.parseRaw", "priority": 1 },
+    { "hook": "filter:topic.reply", "method": "hooks.filter.topicReply" },
     { "hook": "filter:post.create", "method": "hooks.filter.postCreate" },
+    { "hook": "filter:post.getFields", "method": "hooks.filter.postGetFields" },
     { "hook": "filter:post.edit", "method": "hooks.filter.postEdit" },
 
     { "hook": "action:post.delete", "method": "hooks.action.postDelete" },
     { "hook": "action:post.restore", "method": "hooks.action.postRestore" },
-    { "hook": "action:topic.delete", "method": "hooks.action.topicDelete" },
-    { "hook": "action:topic.restore", "method": "hooks.action.topicRestore" },
+    { "hook": "action:posts.purge", "method": "hooks.action.postsPurge" },
 
     { "hook": "filter:widgets.getWidgets", "method": "defineWidgets" },
     { "hook": "filter:widget.render:poll", "method": "renderPollWidget" }
@@ -40,6 +42,7 @@
   "upgrades": [
     "upgrades/give_categories_poll_create_privs_to_reg_users.js",
     "upgrades/convert_poll_id_voters_and_options_votes_to_sorted_sets.js",
-    "upgrades/fix_incorrect_poll_privilege.js"
+    "upgrades/fix_incorrect_poll_privilege.js",
+    "upgrades/poll-4.0-upgrade.js"
   ]
 }

package/public/js/admin.js

@@ -1,44 +1,15 @@
 'use strict';
 
 define('admin/plugins/poll', ['settings'], function (Settings) {
-	var wrapper;
-
-	var ACP = {};
+	const ACP = {};
 
 	ACP.init = function () {
-		wrapper = $('.poll-settings');
-
-		Settings.sync('poll', wrapper);
+		Settings.load('poll', $('.poll-settings'));
 
 		$('#save').on('click', function () {
-			save();
-		});
-
-		$('#reset').click(function () {
-			reset();
+			Settings.save('poll', $('.poll-settings'));
 		});
 	};
 
-	function save() {
-		Settings.persist('poll', wrapper, function () {
-			socket.emit('admin.plugins.poll.sync');
-		});
-	}
-
-	function reset() {
-		bootbox.confirm('Are you sure you wish to reset the settings?', function (sure) {
-			if (sure) {
-				socket.emit('admin.plugins.poll.getDefaults', null, function (err, data) {
-					if (err) {
-						console.error(err);
-					}
-					Settings.set('poll', data, wrapper, function () {
-						socket.emit('admin.plugins.poll.sync');
-					});
-				});
-			}
-		});
-	}
-
 	return ACP;
 });