nodebb-plugin-poll 3.2.4 → 3.2.6

package/eslint.config.mjs

@@ -0,0 +1,10 @@
+'use strict';
+
+import serverConfig from 'eslint-config-nodebb';
+import publicConfig from 'eslint-config-nodebb/public';
+
+export default [
+	...publicConfig,
+	...serverConfig,
+];
+

package/languages/zh_CN/poll.json

@@ -8,6 +8,7 @@
   "default_title": "默认投票标题",
   "max_votes": "每个用户最多选几项",
   "disallow_vote_update": "不允许用户更改投票",
+  "allow_anon_voting": "允许匿名投票",
   "info_choices": "如果数字大于1,那么就是多选投票",
   "settings": "设置",
   "save": "保存",
@@ -29,10 +30,12 @@
 
   "error.not_main": "只能在帖子主体中添加投票",
   "error.privilege.create": "你不被允许创建投票",
+  "error.anon-voting-not-allowed": "不允许匿名投票",
 
   "warning.redactor": "你正在使用编辑器。<strong>请不要</strong>手动编辑投票模块。 可以重新使用投票创建工具。",
 
   "vote": "投票",
+  "vote_anonymously": "匿名投票",
   "update_vote": "更改投票",
   "remove_vote": "删除投票",
   "to_voting": "去投票",
@@ -43,5 +46,8 @@
   "vote_is_final": "投票已结束，无法更改",
 
   "vote_count": "名用户投了此票",
-  "votes": "票"
-}
+  "votes": "票",
+  "x-votes": "%1 票",
+  "total-votes-x": "总票数: %1",
+  "admin.create-poll": "创建投票"
+}

package/lib/sockets.js

@@ -75,7 +75,7 @@ Sockets.vote = async function (socket, data) {
 	await Vote.add(data);
 
 	const pollData = await Poll.get(data.pollId, socket.uid, false);
-	NodeBB.SocketIndex.server.sockets.emit('event:poll.voteChange', pollData);
+	NodeBB.SocketIndex.server.sockets.emit('event:poll.voteChange', { pollData, uid: socket.uid });
 };
 
 Sockets.updateVote = async function (socket, data) {
@@ -111,7 +111,7 @@ Sockets.updateVote = async function (socket, data) {
 
 	await Vote.update(data);
 	const pollData = await Poll.get(data.pollId, socket.uid, false);
-	NodeBB.SocketIndex.server.sockets.emit('event:poll.voteChange', pollData);
+	NodeBB.SocketIndex.server.sockets.emit('event:poll.voteChange', { pollData, uid: socket.uid });
 };
 
 Sockets.removeVote = async function (socket, data) {
@@ -130,7 +130,7 @@ Sockets.removeVote = async function (socket, data) {
 
 	await Vote.remove(data);
 	const pollData = await Poll.get(data.pollId, socket.uid, false);
-	NodeBB.SocketIndex.server.sockets.emit('event:poll.voteChange', pollData);
+	NodeBB.SocketIndex.server.sockets.emit('event:poll.voteChange', { pollData, uid: socket.uid });
 };
 
 Sockets.getOptionDetails = async function (socket, data) {

package/library.js

@@ -1,5 +1,7 @@
 'use strict';
 
+const nconf = require.main.require('nconf');
+
 const NodeBB = require('./lib/nodebb');
 const Config = require('./lib/config');
 const Sockets = require('./lib/sockets');
@@ -24,7 +26,10 @@ Plugin.load = async function (params) {
 	NodeBB.AdminSockets[Config.plugin.id] = Config.adminSockets;
 
 	NodeBB.app = params.app;
-	Scheduler.start();
+
+	if (nconf.get('runJobs')) {
+		Scheduler.start();
+	}
 
 	await Config.init();
 };
@@ -63,3 +68,30 @@ Plugin.copyPrivilegesFrom = function (data) {
 	}
 	return data;
 };
+
+Plugin.defineWidgets = async function (widgets) {
+	const widget = {
+		widget: 'poll',
+		name: 'Poll',
+		description: 'Display a poll',
+		content: await NodeBB.app.renderAsync('admin/partials/widgets/poll', {}),
+	};
+
+	widgets.push(widget);
+	return widgets;
+};
+
+Plugin.renderPollWidget = async function (widget) {
+	const { tid } = 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;
+	}
+	widget.html = await NodeBB.app.renderAsync('poll/widget.tpl', { pollId });
+	return widget;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-poll",
-  "version": "3.2.4",
+  "version": "3.2.6",
   "description": "NodeBB Poll Plugin",
   "main": "library.js",
   "scripts": {
@@ -29,8 +29,7 @@
     "compatibility": "^4.0.0"
   },
   "devDependencies": {
-    "eslint": "8.57.0",
-    "eslint-config-nodebb": "0.2.1",
-    "eslint-plugin-import": "2.29.1"
+    "eslint": "9.28.0",
+    "eslint-config-nodebb": "1.1.7"
   }
 }

package/plugin.json

@@ -18,7 +18,10 @@
     { "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:topic.restore", "method": "hooks.action.topicRestore" },
+
+    { "hook": "filter:widgets.getWidgets", "method": "defineWidgets" },
+    { "hook": "filter:widget.render:poll", "method": "renderPollWidget" }
   ],
   "scss": [
     "public/scss/style.scss"

package/public/js/poll/main.js

@@ -11,41 +11,53 @@ window.Poll = {};
 		});
 	};
 
-	// eslint-disable-next-line import/no-unresolved
 	require('poll/serializer')(window.utils);
 
 	$(window).on('action:topic.loading', function () {
 		if (ajaxify.data.posts.length > 0 && ajaxify.data.posts[0].hasOwnProperty('pollId')) {
-			getPoll(ajaxify.data.posts[0].pollId);
+			getPollByPost(ajaxify.data.posts[0]);
 		}
 	});
 
 	$(window).on('action:posts.loaded', function (ev, data) {
 		data.posts.forEach((post) => {
 			if (post.hasOwnProperty('pollId')) {
-				getPoll(post.pollId);
+				getPollByPost(post);
 			}
 		});
 	});
 
 	$(window).on('action:posts.edited', function (ev, data) {
 		if (data.post.hasOwnProperty('pollId')) {
-			getPoll(data.post.pollId);
+			getPollByPost(data.post);
 		}
 	});
 
+	$(window).on('action:ajaxify.end', function () {
+		$('[data-widget-poll-id]').each(function () {
+			getPoll($(this).attr('data-widget-poll-id'), $(this));
+		});
+	});
+
 	socket.on('event:poll.voteChange', function (data) {
-		Poll.view.update(data);
+		Poll.view.update(data.pollData, data.uid);
 	});
 
-	function getPoll(pollId) {
-		pollId = parseInt(pollId, 10);
+	function getPollByPost(post) {
+		const postEl = $('[component="post"][data-pid="' + post.pid + '"]');
+		if (postEl.length && post.pollId) {
+			getPoll(post.pollId, postEl.find('[component="post/content"]'));
+		}
+	}
 
+	function getPoll(pollId, container) {
+		pollId = parseInt(pollId, 10);
 		if (!isNaN(pollId)) {
 			socket.emit('plugins.poll.get', { pollId }, function (err, pollData) {
 				if (err) {
 					return Poll.alertError(err.message);
 				}
+				pollData.container = container;
 				Poll.view.load(pollData);
 			});
 		}

package/public/js/poll/serializer.js

@@ -133,7 +133,7 @@ module.exports = function (utils) {
 
 		const stripped = utils.stripHTMLTags(raw).replace(/\\/g, '\');
 		let match;
-		while ((match = settingsRegex.exec(stripped)) !== null) { // eslint-disable-line no-cond-assign
+		while ((match = settingsRegex.exec(stripped)) !== null) {
 			var key = match.groups.key.trim();
 			var value = match.groups.value.trim();
 
@@ -150,7 +150,7 @@ module.exports = function (utils) {
 	function deserializeSettings(settings, config) {
 		var deserialized = '';
 
-		for (var k in settings) {
+		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();

package/public/js/poll/view.js

@@ -176,44 +176,41 @@
 
 	View.prototype.load = function () {
 		var self = this;
+		if (!self.pollData.container.length) {
+			return;
+		}
 
-		require(['components'], function (components) {
-			var posts = components.get('post');
-			if (posts.length > 0 && parseInt(posts.eq(0).data('pid'), 10) === parseInt(self.pollData.info.pid, 10)) {
-				app.parseAndTranslate('poll/view', { poll: self.pollData }, function (panel) {
-					posts.eq(0).find('[component="post/content"]').prepend(panel);
-
-					self.dom = {
-						panel: panel,
-						votingForm: panel.find('.poll-voting-form'),
-						messages: panel.find('.poll-view-messages'),
-						votingPanel: panel.find('.poll-view-voting'),
-						resultsPanel: panel.find('.poll-view-results'),
-						voteButton: panel.find('.poll-button-vote'),
-						voteAnonButton: panel.find('.poll-button-vote-anon'),
-						updateVoteButton: panel.find('.poll-button-update-vote'),
-						removeVoteButton: panel.find('.poll-button-remove-vote'),
-						votingPanelButton: panel.find('.poll-button-voting'),
-						resultsPanelButton: panel.find('.poll-button-results'),
-						editButton: panel.find('.poll-button-edit'),
-					};
-
-					self.hideMessage();
+		app.parseAndTranslate('poll/view', { poll: self.pollData }, function (panel) {
+			self.pollData.container.prepend(panel);
+			self.dom = {
+				panel: panel,
+				votingForm: panel.find('.poll-voting-form'),
+				messages: panel.find('.poll-view-messages'),
+				votingPanel: panel.find('.poll-view-voting'),
+				resultsPanel: panel.find('.poll-view-results'),
+				voteButton: panel.find('.poll-button-vote'),
+				voteAnonButton: panel.find('.poll-button-vote-anon'),
+				updateVoteButton: panel.find('.poll-button-update-vote'),
+				removeVoteButton: panel.find('.poll-button-remove-vote'),
+				votingPanelButton: panel.find('.poll-button-voting'),
+				resultsPanelButton: panel.find('.poll-button-results'),
+				editButton: panel.find('.poll-button-edit'),
+			};
 
-					self.pollEndedOrDeleted();
-					self.hasVotedAndVotingUpdateDisallowed();
+			self.hideMessage();
 
-					if (!app.user.uid || self.pollData.hasVoted) {
-						self.showResultsPanel();
-					} else {
-						self.showVotingPanel();
-					}
+			self.pollEndedOrDeleted();
+			self.hasVotedAndVotingUpdateDisallowed();
 
-					Actions.forEach(function (action) {
-						action.register(self);
-					});
-				});
+			if (!app.user.uid || self.pollData.hasVoted) {
+				self.showResultsPanel();
+			} else {
+				self.showVotingPanel();
 			}
+
+			Actions.forEach(function (action) {
+				action.register(self);
+			});
 		});
 	};
 
@@ -241,8 +238,16 @@
 		}
 	};
 
-	View.prototype.update = function (pollData) {
+	View.prototype.update = function (pollData, uid) {
+		const isSelf = String(uid) === String(app.user.uid);
+		const hasVoted = this.pollData.hasVoted;
+		const vote = this.pollData.vote;
 		this.pollData = pollData;
+		if (!isSelf) {
+			// restore user specific data if update is not self
+			this.pollData.hasVoted = hasVoted;
+			this.pollData.vote = vote;
+		}
 
 		this.pollEndedOrDeleted();
 
@@ -401,10 +406,10 @@
 
 			view.load();
 		},
-		update: function (pollData) {
+		update: function (pollData, uid) {
 			var pollId = pollData.info.pollId;
 			if (this.polls.hasOwnProperty(pollId)) {
-				this.polls[pollId].update(pollData);
+				this.polls[pollId].update(pollData, uid);
 			}
 		},
 	};

package/templates/admin/partials/widgets/poll.tpl

@@ -0,0 +1,5 @@
+<div class="mb-3">
+	<label class="form-label">Topic ID:</label>
+	<input type="text" class="form-control" name="tid" />
+</div>
+

package/templates/poll/view/messages.tpl

@@ -1,3 +1,3 @@
-<h3>{title}</h3>
+<h5>{title}</h5>
 <p>{content}</p>
 <hr>

package/templates/poll/widget.tpl

@@ -0,0 +1 @@
+<div data-widget-poll-id="{./pollId}"></div>

package/.eslintrc

@@ -1,3 +0,0 @@
-{
-	"extends": "nodebb"
-}

package/public/js/.eslintrc

@@ -1,3 +0,0 @@
-{
-	"extends": "nodebb/public"
-}