nodebb-plugin-poll 3.2.1 → 3.2.3

package/README.md

@@ -11,6 +11,7 @@ Currently supported settings:
 
     maxvotes="1" //Max number of votes per user. If larger than 1, a multiple choice poll will be created
     disallowVoteUpdate="0" //if set, users won't be able to update/remove their vote
+    allowAnonVoting="0" // if set to 1, users will be able to vote anonymously
     title="Poll title" //Poll title
 
 There's also a helpful modal available that will allow you to easily create a poll:

package/languages/en_GB/poll.json

@@ -8,6 +8,7 @@
   "default_title": "Default poll title",
   "max_votes": "Maximum number of votes per user",
   "disallow_vote_update": "Don't allow users to update their vote",
+  "allow_anon_voting": "Allow anonymous voting",
   "info_choices": "A number greater than 1 will enable multiple choice polls.",
   "settings": "Settings",
   "save": "Save",
@@ -29,10 +30,12 @@
 
   "error.not_main": "Can only add poll in main post.",
   "error.privilege.create": "You're not allowed to create a poll",
+  "error.anon-voting-not-allowed": "This poll does not allow voting anonymously",
 
   "warning.redactor": "You're using Redactor. Do <strong>not</strong> edit the markup manually. Instead, re-open the poll creator.",
 
   "vote": "Vote",
+  "vote_anonymously": "Vote anonymously",
   "update_vote": "Update vote",
   "remove_vote": "Remove vote",
   "to_voting": "To Voting",

package/languages/en_US/poll.json

@@ -8,6 +8,7 @@
   "default_title": "Default poll title",
   "max_votes": "Maximum number of votes per user",
   "disallow_vote_update": "Don't allow users to update their vote",
+  "allow_anon_voting": "Allow anonymous voting",
   "info_choices": "A number greater than 1 will enable multiple choice polls.",
   "settings": "Settings",
   "save": "Save",
@@ -29,10 +30,12 @@
 
   "error.not_main": "Can only add poll in main post.",
   "error.privilege.create": "You're not allowed to create a poll",
+  "error.anon-voting-not-allowed": "This poll does not allow voting anonymously",
 
   "warning.redactor": "You're using Redactor. Do <strong>not</strong> edit the markup manually. Instead, re-open the poll creator.",
 
   "vote": "Vote",
+  "vote_anonymously": "Vote anonymously",
   "update_vote": "Update vote",
   "remove_vote": "Remove vote",
   "to_voting": "To Voting",

package/lib/config.js

@@ -28,6 +28,7 @@ Config.defaults = {
 		title: 'Poll',
 		maxvotes: 1,
 		disallowVoteUpdate: 0,
+		allowAnonVoting: 0,
 		end: 0,
 	},
 };

package/lib/sockets.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const _ = require.main.require('lodash');
 const NodeBB = require('./nodebb');
 
 const Config = require('./config');
@@ -31,6 +32,10 @@ Sockets.get = async function (socket, data) {
 		throw new Error('Legacy polls are not supported');
 	}
 
+	if (parseInt(pollData.settings.allowAnonVoting, 10) === 1) {
+		await anonymizeVoters(socket.uid, data.pollId, pollData.options);
+	}
+
 	pollData.optionType = parseInt(pollData.settings.maxvotes, 10) > 1 ? 'checkbox' : 'radio';
 	return pollData;
 };
@@ -59,6 +64,10 @@ Sockets.vote = async function (socket, data) {
 		throw new Error(`You can only vote for ${settings.maxvotes} options on this poll.`);
 	}
 
+	if (data.voteAnon && parseInt(settings.allowAnonVoting, 10) !== 1) {
+		throw new Error('[[poll:error.anon-voting-not-allowed]]');
+	}
+
 	if (!canVote || !data.options.length) {
 		throw new Error('Already voted or invalid option');
 	}
@@ -128,14 +137,20 @@ Sockets.getOptionDetails = async function (socket, data) {
 	if (!socket.uid || !data || isNaN(parseInt(data.pollId, 10)) || isNaN(parseInt(data.optionId, 10))) {
 		throw new Error('Invalid request');
 	}
-	const [poll, option] = await Promise.all([
+	const [poll, settings, option] = await Promise.all([
 		Poll.getInfo(data.pollId),
+		Poll.getSettings(data.pollId),
 		Poll.getOption(data.pollId, data.optionId, true),
 	]);
 
 	if (!option.votes || !option.votes.length) {
 		return option;
 	}
+
+	if (parseInt(settings.allowAnonVoting, 10) === 1) {
+		await anonymizeVoters(socket.uid, data.pollId, [option]);
+	}
+
 	const userData = await NodeBB.User.getUsersFields(option.votes, [
 		'uid', 'username', 'userslug', 'picture',
 	]);
@@ -160,6 +175,23 @@ Sockets.canCreate = async function (socket, data) {
 	return await checkPrivs(data.cid, socket.uid);
 };
 
+async function anonymizeVoters(callerUid, pollId, options) {
+	const uids = _.uniq(options.map(opt => opt.votes).flat());
+	const [isAnon, isPrivileged] = await Promise.all([
+		NodeBB.db.isSortedSetMembers(`poll:${pollId}:anon:voters`, uids),
+		NodeBB.User.isPrivileged(callerUid),
+	]);
+	if (isPrivileged) {
+		return;
+	}
+	const uidToIsAnon = _.zipObject(uids, isAnon);
+	options.forEach((opt) => {
+		opt.votes = opt.votes.map(
+			uid => (uidToIsAnon[uid] && String(callerUid) !== uid ? 0 : uid)
+		);
+	});
+}
+
 async function checkPrivs(cid, socketUid) {
 	const can = await NodeBB.Privileges.categories.can('poll:create', cid, socketUid);
 	if (!can) {

package/lib/vote.js

@@ -9,12 +9,19 @@ Vote.add = async function (voteData) {
 	const { pollId, options, uid } = voteData;
 	const timestamp = +new Date();
 
-	await Promise.all([
+	const promises = [
 		NodeBB.db.sortedSetAdd(`poll:${pollId}:voters`, timestamp, uid),
 		NodeBB.db.sortedSetAddBulk(
 			options.map(option => ([`poll:${pollId}:options:${option}:votes`, timestamp, uid]))
 		),
-	]);
+	];
+	if (voteData.voteAnon) {
+		promises.push(
+			NodeBB.db.sortedSetAdd(`poll:${pollId}:anon:voters`, timestamp, uid)
+		);
+	}
+
+	await Promise.all(promises);
 };
 
 Vote.remove = async function (voteData) {
@@ -29,7 +36,10 @@ Vote.removeUidVote = async function (uid, pollId) {
 	const vote = await Vote.getUidVote(uid, pollId);
 	const options = vote.options || [];
 	await Promise.all([
-		NodeBB.db.sortedSetRemove(`poll:${pollId}:voters`, uid),
+		NodeBB.db.sortedSetsRemove([
+			`poll:${pollId}:voters`,
+			`poll:${pollId}:anon:voters`,
+		], uid),
 		NodeBB.db.sortedSetsRemove(
 			options.map(option => `poll:${pollId}:options:${option}:votes`),
 			uid,
@@ -49,7 +59,10 @@ 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);
 	await Vote.remove(voteData);
+	voteData.voteAnon = isVotedAnon;
 	await Vote.add(voteData);
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-poll",
-  "version": "3.2.1",
+  "version": "3.2.3",
   "description": "NodeBB Poll Plugin",
   "main": "library.js",
   "scripts": {

package/plugin.json

@@ -25,7 +25,6 @@
   ],
   "scripts": [
     "public/js/poll/main.js",
-    "public/js/poll/sockets.js",
     "public/js/poll/creator.js",
     "public/js/poll/view.js"
   ],

package/public/js/poll/creator.js

@@ -70,15 +70,17 @@
 				return alerts.error('[[error:category-not-selected]]');
 			}
 
-			Poll.sockets.canCreate({ cid: post.cid, pid: post.pid }, function (err, canCreate) {
+			socket.emit('plugins.poll.canCreate', {
+				cid: post.cid,
+				pid: post.pid,
+			}, function (err, canCreate) {
 				if (err) {
-					return alerts.error(err.message);
+					return alerts.error(err);
 				}
 				if (!canCreate) {
 					return alerts.error('[[error:no-privileges]]');
 				}
-
-				Poll.sockets.getConfig(null, function (err, config) {
+				socket.emit('plugins.poll.getConfig', null, function (err, config) {
 					if (err) {
 						return alerts.error(err);
 					}
@@ -217,6 +219,7 @@
 				title: obj['settings.title'],
 				maxvotes: obj['settings.maxvotes'],
 				disallowVoteUpdate: obj['settings.disallowVoteUpdate'] === 'on' ? 'true' : 'false',
+				allowAnonVoting: obj['settings.allowAnonVoting'] === 'on' ? 'true' : 'false',
 				end: obj['settings.end'],
 			},
 		};

package/public/js/poll/main.js

@@ -1,5 +1,7 @@
 'use strict';
 
+/* global Poll */
+
 window.Poll = {};
 
 (function () {
@@ -9,7 +11,9 @@ 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);
@@ -30,11 +34,15 @@ window.Poll = {};
 		}
 	});
 
+	socket.on('event:poll.voteChange', function (data) {
+		Poll.view.update(data);
+	});
+
 	function getPoll(pollId) {
 		pollId = parseInt(pollId, 10);
 
 		if (!isNaN(pollId)) {
-			Poll.sockets.getPoll({ pollId: pollId }, function (err, pollData) {
+			socket.emit('plugins.poll.get', { pollId }, function (err, pollData) {
 				if (err) {
 					return Poll.alertError(err.message);
 				}

package/public/js/poll/serializer.js

@@ -30,6 +30,14 @@ module.exports = function (utils) {
 				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());

package/public/js/poll/view.js

@@ -1,6 +1,33 @@
 'use strict';
 
 (function (Poll) {
+	function vote(view, options) {
+		var form = view.dom.votingPanel.find('form');
+		var votes = form.serializeArray().map(function (option) {
+			return parseInt(option.value, 10);
+		});
+
+		if (votes.length > 0) {
+			var voteData = {
+				pollId: view.pollData.info.pollId,
+				options: votes,
+				voteAnon: options.voteAnon,
+			};
+
+			socket.emit('plugins.poll.vote', voteData, function (err) {
+				if (!config.loggedIn) {
+					$(window).trigger('action:poll.vote.notloggedin');
+				}
+
+				if (err) {
+					return Poll.alertError(err.message);
+				}
+
+				view.showResultsPanel();
+			});
+		}
+	}
+
 	var Actions = [
 		{
 			// Voting
@@ -11,33 +38,27 @@
 				});
 			},
 			handle: function (view) {
-				var form = view.dom.votingPanel.find('form');
-				var votes = form.serializeArray().map(function (option) {
-					return parseInt(option.value, 10);
+				vote(view, {
+					voteAnon: false,
 				});
-
-				if (votes.length > 0) {
-					var voteData = {
-						pollId: view.pollData.info.pollId,
-						options: votes,
-					};
-
-					Poll.sockets.vote(voteData, function (err) {
-						if (!config.loggedIn) {
-							$(window).trigger('action:poll.vote.notloggedin');
-						}
-
-						if (err) {
-							return Poll.alertError(err.message);
-						}
-
-						view.showResultsPanel();
-					});
-				}
 			},
 		},
 		{
-			// Voting
+			// vote anon
+			register: function (view) {
+				var self = this;
+				view.dom.voteAnonButton.off('click').on('click', function () {
+					self.handle(view);
+				});
+			},
+			handle: function (view) {
+				vote(view, {
+					voteAnon: true,
+				});
+			},
+		},
+		{
+			// update voting
 			register: function (view) {
 				var self = this;
 				view.dom.updateVoteButton.off('click').on('click', function () {
@@ -55,8 +76,7 @@
 						pollId: view.pollData.info.pollId,
 						options: votes,
 					};
-
-					Poll.sockets.updateVote(voteData, function (err) {
+					socket.emit('plugins.poll.updateVote', voteData, function (err) {
 						if (err) {
 							return Poll.alertError(err.message);
 						}
@@ -76,7 +96,7 @@
 			handle: function (view) {
 				var voteData = { pollId: view.pollData.info.pollId };
 
-				Poll.sockets.removeVote(voteData, function (err) {
+				socket.emit('plugins.poll.removeVote', voteData, function (err) {
 					if (err) {
 						return Poll.alertError(err.message);
 					}
@@ -119,7 +139,7 @@
 			handle: function (view, e) {
 				var optionId = $(e.currentTarget).parents('[data-poll-option-id]').data('poll-option-id');
 
-				Poll.sockets.getOptionDetails({
+				socket.emit('plugins.poll.getOptionDetails', {
 					pollId: view.pollData.info.pollId,
 					optionId: optionId,
 				}, function (err, details) {
@@ -140,7 +160,7 @@
 				});
 			},
 			handle: function (view) {
-				Poll.sockets.getConfig(null, function (err, config) {
+				socket.emit('plugins.poll.getConfig', null, function (err, config) {
 					if (err) {
 						console.error(err);
 					}
@@ -170,6 +190,7 @@
 						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'),
@@ -250,15 +271,17 @@
 	};
 
 	View.prototype.showOptionDetails = function (details) {
-		app.parseAndTranslate('poll/view/details', details, function (html) {
-			bootbox.dialog({
-				message: html,
-				backdrop: true,
-				buttons: {
-					close: {
-						label: 'Close',
+		require(['bootbox'], function (bootbox) {
+			app.parseAndTranslate('poll/view/details', details, function (html) {
+				bootbox.dialog({
+					message: html,
+					backdrop: true,
+					buttons: {
+						close: {
+							label: 'Close',
+						},
 					},
-				},
+				});
 			});
 		});
 	};
@@ -290,6 +313,9 @@
 			}
 		} else {
 			this.showVoteButton();
+			if (this.pollData.settings.allowAnonVoting) {
+				this.showVoteAnonButton();
+			}
 		}
 		this.dom.votingPanel.removeClass('hidden');
 	};
@@ -300,6 +326,7 @@
 		this.hideRemoveVoteButton();
 		this.resetVotingForm();
 		this.hideVoteButton();
+		this.hideVoteAnonButton();
 		this.dom.votingPanel.addClass('hidden');
 	};
 
@@ -326,6 +353,14 @@
 		this.dom.voteButton.addClass('hidden');
 	};
 
+	View.prototype.showVoteAnonButton = function () {
+		this.dom.voteAnonButton.removeClass('hidden');
+	};
+
+	View.prototype.hideVoteAnonButton = function () {
+		this.dom.voteAnonButton.addClass('hidden');
+	};
+
 	View.prototype.showUpdateVoteButton = function () {
 		this.dom.updateVoteButton.removeClass('hidden');
 	};

package/templates/poll/creator.tpl

@@ -26,11 +26,14 @@
                min="1" max="10" step="1" placeholder="[[poll:max_votes_placeholder]]" class="form-control">
     </div>
 
-    <div class="mb-3">
-        <div class="form-check">
-            <label class="form-check-label" for="pollDisallowVoteUpdate">[[poll:disallow_vote_update]]</label>
-            <input class="form-check-input" type="checkbox" name="settings.disallowVoteUpdate" id="pollDisallowVoteUpdate" {{{if poll.settings.disallowVoteUpdate}}}checked{{{end}}}>
-        </div>
+    <div class="form-check mb-3">
+        <label class="form-check-label" for="pollDisallowVoteUpdate">[[poll:disallow_vote_update]]</label>
+        <input class="form-check-input" type="checkbox" name="settings.disallowVoteUpdate" id="pollDisallowVoteUpdate" {{{if poll.settings.disallowVoteUpdate}}}checked{{{end}}}>
+    </div>
+
+    <div class="form-check mb-3">
+        <label class="form-check-label" for="allowAnonVoting">[[poll:allow_anon_voting]]</label>
+        <input class="form-check-input" type="checkbox" name="settings.allowAnonVoting" id="allowAnonVoting" {{{if poll.settings.allowAnonVoting}}}checked{{{end}}}>
     </div>
 
     <div class="mb-3">

package/templates/poll/view/details.tpl

@@ -1,4 +1,4 @@
-<h2>{voteCount} [[poll:vote_count]]</h2>
+<h4>{voteCount} [[poll:vote_count]]</h4>
 <!-- BEGIN votes -->
 <a href="{config.relative_path}/user/{votes.userslug}" class="poll-result-details">
     {buildAvatar(votes, "24px", true)}

package/templates/poll/view.tpl

@@ -18,11 +18,12 @@
             </div>
 
             <div class="poll-view-buttons">
-                <button type="button" class="btn btn-primary poll-button-vote hidden">[[poll:vote]]</button>
-                <button type="button" class="btn btn-primary poll-button-update-vote hidden">[[poll:update_vote]]</button>
-                <button type="button" class="btn btn-danger poll-button-remove-vote hidden">[[poll:remove_vote]]</button>
-                <button type="button" class="btn btn-link poll-button-results hidden">[[poll:to_results]]</button>
-                <button type="button" class="btn btn-link poll-button-voting hidden">[[poll:to_voting]]</button>
+                <button type="button" class="btn btn-sm btn-primary poll-button-vote hidden">[[poll:vote]]</button>
+                <button type="button" class="btn btn-sm btn-primary poll-button-vote-anon hidden">[[poll:vote_anonymously]]</button>
+                <button type="button" class="btn btn-sm btn-primary poll-button-update-vote hidden">[[poll:update_vote]]</button>
+                <button type="button" class="btn btn-sm btn-danger poll-button-remove-vote hidden">[[poll:remove_vote]]</button>
+                <button type="button" class="btn btn-sm btn-link poll-button-results hidden">[[poll:to_results]]</button>
+                <button type="button" class="btn btn-sm btn-link poll-button-voting hidden">[[poll:to_voting]]</button>
             </div>
         </div>
     </div>

package/public/js/poll/sockets.js

@@ -1,61 +0,0 @@
-'use strict';
-
-(function (Poll) {
-	var messages = [
-		{
-			method: 'getPoll',
-			message: 'plugins.poll.get',
-		},
-		{
-			method: 'vote',
-			message: 'plugins.poll.vote',
-		},
-		{
-			method: 'updateVote',
-			message: 'plugins.poll.updateVote',
-		},
-		{
-			method: 'removeVote',
-			message: 'plugins.poll.removeVote',
-		},
-		{
-			method: 'getOptionDetails',
-			message: 'plugins.poll.getOptionDetails',
-		},
-		{
-			method: 'getConfig',
-			message: 'plugins.poll.getConfig',
-		},
-		{
-			method: 'canCreate',
-			message: 'plugins.poll.canCreate',
-		},
-	];
-
-	var handlers = [
-		{
-			event: 'event:poll.voteChange',
-			handle: function (data) {
-				Poll.view.update(data);
-			},
-		},
-	];
-
-	function init() {
-		handlers.forEach(function (handler) {
-			if (socket.listeners(handler.event).length === 0) {
-				socket.on(handler.event, handler.handle);
-			}
-		});
-
-		messages.forEach(function (message) {
-			Poll.sockets[message.method] = function (data, callback) {
-				socket.emit(message.message, data, callback);
-			};
-		});
-	}
-
-	Poll.sockets = {};
-
-	init();
-}(window.Poll));