nodebb-plugin-poll 3.2.3 → 3.2.5

package/.eslintrc

@@ -1,116 +1,3 @@
 {
-	"extends": "airbnb-base",
-	"ignorePatterns": ["**/vendor/*.js"],
-	"parserOptions": {
-		"sourceType": "script"
-	},
-
-	"rules": {
-		// === Configure rules for our style ===
-		// imports must be resolvable
-		"import/no-unresolved": "error",
-		// use single quotes,
-		// unless a different style allows avoiding escapes
-		"quotes": ["error", "single", {
-			"avoidEscape": true,
-			"allowTemplateLiterals": true
-		}],
-		// allow else-if return
-		"no-else-return": [ "error", { "allowElseIf": true } ],
-		// expressions split over multiple lines
-		// should break after the operator
-		"operator-linebreak": [ "error", "after" ],
-		// require arrow parens only when needed
-		// and whenever the body is a block
-		"arrow-parens": ["error", "as-needed", { "requireForBlockBody": true }],
-		// what variables are errors in callbacks
-		"handle-callback-err": [ "error","^(e$|(e|(.*(_e|E)))rr)" ],
-		// allow dangling commas in functions
-		// require them everywhere else
-		"comma-dangle": ["error", {
-			"arrays": "always-multiline",
-			"objects": "always-multiline",
-			"imports": "always-multiline",
-			"exports": "always-multiline",
-			"functions": "only-multiline"
-		}],
-		// we actually encourage `return await`
-		"no-return-await": "off",
-		// allow `while (true)`
-		"no-constant-condition": ["error", { "checkLoops": false }],
-		// allow ignoring an error with `catch`
-		"no-empty": ["error", { "allowEmptyCatch": true }],
-		// allow `3 + 5 - 1`, but not `3 * 5 - 1`
-		"no-mixed-operators": ["error", { "allowSamePrecedence": true }],
-		// require `'use strict';`
-		"strict": ["error", "global"],
-		// we actually use tabs for indentation
-		"indent": ["error", "tab", { "SwitchCase": 1 }],
-		"no-tabs": "off",
-		// we want `== null` to also handle undefined
-		"no-eq-null": "off",
-		// allow `for (..; i++)`
-		"no-plusplus": ["error", { "allowForLoopAfterthoughts": true }],
-		// allow using functions defined later
-		"no-use-before-define": ["error", "nofunc"],
-		// require consistent newlines before and after braces
-		// if contents are multiline
-		"object-curly-newline": ["error", { "consistent": true, "multiline": true }],
-		// require consistent linebreaks inline function parenthesis (arguments or params)
-		"function-paren-newline": ["error", "consistent"],
-		// only require const if all parts of destructuring can be const
-		"prefer-const": ["error", { "destructuring": "all" }],
-		// don't require destructuring for arrays or assignment
-		"prefer-destructuring": ["error", {
-			"VariableDeclarator": { "array": false, "object": true },
-			"AssignmentExpression": { "array": false, "object": false }
-		}],
-		// identical to airbnb rule, except for allowing for..of, because we want to use it
-		"no-restricted-syntax": [
-			"error",
-			{
-				"selector": "ForInStatement",
-				"message": "for..in loops iterate over the entire prototype chain, which is virtually never what you want. Use Object.{keys,values,entries}, and iterate over the resulting array."
-			},
-			{
-				"selector": "LabeledStatement",
-				"message": "Labels are a form of GOTO; using them makes code confusing and hard to maintain and understand."
-			},
-			{
-				"selector": "WithStatement",
-				"message": "`with` is disallowed in strict mode because it makes code impossible to predict and optimize."
-			}
-		],
-		// allow lines of up to 120 characters
-		"max-len": ["error", { "code": 120, "tabWidth": 2, "ignoreUrls": true, "ignoreStrings": true, "ignoreTemplateLiterals": true, "ignoreRegExpLiterals": true }],
-
-		// === Disable rules ===
-		// more liberal naming
-		"camelcase": "off",
-		"no-underscore-dangle": "off",
-		// don't require anonymous function names
-		"func-names": "off",
-		// allow console
-		"no-console": "off",
-		// allow new for side effects
-		// allow new with non-capitalized
-		"no-new": "off",
-		"new-cap": "off",
-		// allow shadowing variables (usually callbacks)
-		"no-shadow": "off",
-		// allow multiple empty lines in a row
-		"no-multiple-empty-lines": "off",
-		// allow not using object shorthand
-		"object-shorthand": "off",
-
-		// TODO
-		"consistent-return": "off",
-		"no-restricted-globals": "off",
-		"no-prototype-builtins": "off",
-		"import/no-extraneous-dependencies": "off",
-		"import/no-dynamic-require": "off",
-		"global-require": "off",
-		"no-param-reassign": "off",
-		"default-case": "off"
-	}
+	"extends": "nodebb"
 }

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.3",
+  "version": "3.2.5",
   "description": "NodeBB Poll Plugin",
   "main": "library.js",
   "scripts": {
@@ -26,7 +26,7 @@
     "cron": "^1.8.2"
   },
   "nbbpm": {
-    "compatibility": "^3.2.0"
+    "compatibility": "^4.0.0"
   },
   "devDependencies": {
     "eslint": "8.57.0",

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/.eslintrc

@@ -1,82 +1,3 @@
 {
-	"globals": {
-		"app": true,
-		"io": true,
-		"socket": true,
-		"ajaxify": true,
-		"config": true,
-		"utils": true,
-		"overrides": true,
-		"componentHandler": true,
-		"bootbox": true,
-		"Visibility": true,
-		"Tinycon": true,
-		"Promise": true
-	},
-	"env": {
-		"jquery": true,
-		"amd": true,
-		"browser": true,
-		"es6": true
-	},
-	"rules": {
-		"comma-dangle": ["error", {
-			"arrays": "always-multiline",
-			"objects": "always-multiline",
-			"imports": "always-multiline",
-			"exports": "always-multiline",
-			"functions": "never"
-		}],
-		"block-scoped-var": "off",
-		"no-dupe-class-members": "off",
-		"prefer-object-spread": "off",
-		"prefer-reflect": "off",
-
-		// ES6
-		"prefer-rest-params": "off",
-		"prefer-spread": "off",
-		"prefer-arrow-callback": "off",
-		"prefer-template": "off",
-		"no-var": "off",
-		"object-shorthand": "off",
-		"vars-on-top": "off",
-		"prefer-destructuring": "off",
-		// identical to airbnb rule
-		// except for allowing for..in, because for..of is unavailable on some clients
-		"no-restricted-syntax": [
-			"error",
-			{
-				"selector": "ForOfStatement",
-				"message": "iterators/generators require regenerator-runtime, which is too heavyweight for this guide to allow them. Separately, loops should be avoided in favor of array iterations."
-			},
-			{
-				"selector": "LabeledStatement",
-				"message": "Labels are a form of GOTO; using them makes code confusing and hard to maintain and understand."
-			},
-			{
-				"selector": "WithStatement",
-				"message": "`with` is disallowed in strict mode because it makes code impossible to predict and optimize."
-			}
-		]
-	},
-	"parserOptions": {
-		"ecmaVersion": 2018,
-		"ecmaFeatures": {
-			"classes": false,
-			"defaultParams": false,
-			"blockBindings": false,
-			"forOf": false,
-			"generators": false,
-			"globalReturn": false,
-			"jsx": false,
-			"modules": false,
-			"objectLiteralComputedProperties": false,
-			"objectLiteralDuplicateProperties": false,
-			"objectLiteralShorthandMethods": false,
-			"objectLiteralShorthandProperties": false,
-			"impliedStrict": false,
-			"restParams": false,
-			"superInFunctions": false
-		}
-	}
-}
+	"extends": "nodebb/public"
+}

package/public/js/poll/main.js

@@ -16,36 +16,49 @@ window.Poll = {};
 
 	$(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/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>