nodebb-plugin-poll 4.1.0 → 4.2.1

package/.editorconfig

@@ -1,8 +1,8 @@
-root = true
-
-[{*.js, *.css, *.tpl, *.json}]
-indent_style = tab
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
+root = true
+
+[{*.js, *.css, *.tpl, *.json}]
+indent_style = tab
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
 insert_final_newline = false

package/LICENSE

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2015 Erik Schamper
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+The MIT License (MIT)
+
+Copyright (c) 2015 Erik Schamper
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -3,10 +3,56 @@
 This NodeBB plugin will allow you to add polls to posts.
 
 There's helpful modal available that will allow you to easily create a poll:
+
 ![](https://i.imgur.com/2fPnWLb.png)
 
 If you're willing to help, please make any improvements you want and submit a PR.
 
+## Features
+
+### Creating and editing polls
+
+- Create polls from the composer (topic posts and replies) via the poll button in the formatting bar; multiple polls per post are supported
+- Edit polls in the composer: change the title, add/remove options, adjust the end time and per-poll settings
+- Poll creation is gated by the `poll:create` category privilege
+- Polls follow their post's lifecycle — deleting a post soft-deletes its polls, restoring it restores them
+
+### Per-poll options
+
+- **Title** for the poll
+- **Options** — up to the site-wide maximum (default 10)
+- **Maximum votes per user** — `1` for single-choice (radio buttons), higher for multi-choice (checkboxes)
+- **Optional end date/time** — the poll closes automatically when reached; no more voting after that
+- **Allow anonymous voting** — voters can opt to hide their identity; anonymous voters are masked in the per-option voter lists for everyone except privileged users
+- **Disallow vote updates** — lock the poll so votes can't be changed once cast
+
+### Voting
+
+- Logged-in users only (guests can view results if enabled in the ACP)
+- Cast, change, and remove votes (subject to the per-poll settings above)
+- Live results — vote changes are pushed to viewers in real time
+- Per-option voter lists with percentages
+
+### Site-wide settings (ACP)
+
+- Default poll title
+- Maximum number of options per poll
+- Default maximum votes per user
+- Allow guests to view results
+
+## Federation
+
+Polls federate across the fediverse as ActivityPub `Question` objects per [FEP-9967](https://codeberg.org/fediverse/fep/src/branch/main/fep/9967/fep-9967.md):
+
+- **Inbound:** remote `Question` posts are ingested as polls and displayed with their current results. Local users can vote on remote polls, and each vote is federated back to the poll's author.
+- **Outbound:** local polls are published as `Question` objects (single-choice as `oneOf`, multi-choice as `anyOf`), and votes received from remote actors are applied to the local poll's results.
+
+Limitations:
+
+- Only the **first** poll on a post is federated (FEP-9967 models one `Question` per poll); multiple polls per post are not supported.
+- **Anonymous votes are not federated**, since FEP-9967 votes are attributed to the voter's actor.
+- Votes on **remote** polls can be changed or removed (federated as `Create`/`Delete` per FEP-9967), but not all servers support this — e.g. some ignore `Delete` of a vote — so the change may not be reflected on the remote poll.
+
 ## Installation
 
 Either through the NodeBB ACP or:

package/languages/en_GB/poll.json

@@ -38,6 +38,7 @@
   "error.invalid-post": "Invalid post.",
   "error.privilege.create": "You're not allowed to create a poll",
   "error.anon-voting-not-allowed": "This poll does not allow voting anonymously",
+  "error.already-voting": "You are already voting for this poll",
 
   "warning.redactor": "You're using Redactor. Do <strong>not</strong> edit the markup manually. Instead, re-open the poll creator.",
 
@@ -51,6 +52,7 @@
   "voting_unavailable_message": "This poll has ended or has been marked as deleted. You can still view the results.",
   "voting_update_disallowed_message": "You have already voted and changing your vote is not allowed for this poll",
   "vote_is_final": "Changing your vote is not allowed for this poll so your vote is final",
+  "remote_vote_caveat": "This poll is from another server. Not all servers support changing or removing a vote, so your update may not be reflected there.",
 
   "x-users-voted-for-this-option": "%1 user(s) voted for this option",
   "votes": "votes",

package/lib/sockets.js

@@ -53,42 +53,50 @@ Sockets.vote = async function (socket, data) {
 
 	data.uid = socket.uid;
 
-	const [pollData, canVote, optionsFilter] = await Promise.all([
-		db.getObject(`poll:${data.pollId}`),
-		Vote.canVote(socket.uid, data.pollId),
-		Poll.hasOptions(data.pollId, data.options),
-	]);
-
-	// Filter the options on their existence
-	data.options = data.options.filter((el, index) => optionsFilter[index]);
+	const count = await db.incrObjectField(`poll:voteLocks`, `${data.pollId}:${socket.uid}`);
+	if (count > 1) {
+		throw new Error('[[poll:error.already-voting]]');
+	}
+	try {
+		const [pollData, canVote, optionsFilter] = await Promise.all([
+			db.getObject(`poll:${data.pollId}`),
+			Vote.canVote(socket.uid, data.pollId),
+			Poll.hasOptions(data.pollId, data.options),
+		]);
+
+		// Filter the options on their existence
+		data.options = data.options.filter((el, index) => optionsFilter[index]);
+
+		// Give an error if there are too many votes
+		if (data.options.length > parseInt(pollData.maximumVotesPerUser, 10)) {
+			throw new Error(`You can only vote for ${pollData.maximumVotesPerUser} options on this poll.`);
+		}
 
-	// Give an error if there are too many votes
-	if (data.options.length > parseInt(pollData.maximumVotesPerUser, 10)) {
-		throw new Error(`You can only vote for ${pollData.maximumVotesPerUser} options on this poll.`);
-	}
+		if (data.voteAnon && parseInt(pollData.allowAnonVoting, 10) !== 1) {
+			throw new Error('[[poll:error.anon-voting-not-allowed]]');
+		}
 
-	if (data.voteAnon && parseInt(pollData.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');
+		}
 
-	if (!canVote || !data.options.length) {
-		throw new Error('Already voted or invalid option');
-	}
+		await Vote.add(data);
 
-	await Vote.add(data);
+		// Federate the vote out (FEP-9967) if this is a remote poll
+		if (parseInt(pollData.remote, 10) === 1) {
+			await federateVoteChange({
+				pollData, socket, voteAnon: data.voteAnon, removedOptionIds: [], addedOptionIds: data.options,
+			});
+		}
 
-	// Federate the vote out (FEP-9967) if this is a remote poll
-	if (parseInt(pollData.remote, 10) === 1) {
-		await federateVoteChange({
-			pollData, socket, voteAnon: data.voteAnon, removedOptionIds: [], addedOptionIds: data.options,
+		const returnPoll = await Poll.get(data.pollId, socket.uid, false);
+		NodeBB.SocketIndex.server.sockets.emit('event:poll.voteChange', {
+			pollData: returnPoll,
+			uid: socket.uid,
 		});
+	} finally {
+		await db.deleteObjectField(`poll:voteLocks`, `${data.pollId}:${socket.uid}`);
 	}
-
-	const returnPoll = await Poll.get(data.pollId, socket.uid, false);
-	NodeBB.SocketIndex.server.sockets.emit('event:poll.voteChange', {
-		pollData: returnPoll,
-		uid: socket.uid,
-	});
 };
 
 Sockets.updateVote = async function (socket, data) {
@@ -122,9 +130,10 @@ Sockets.updateVote = async function (socket, data) {
 		throw new Error('Invalid option');
 	}
 
-	// Capture the prior vote so we can federate the diff (remote polls only)
+	// Capture the prior vote + anon flag so we can federate the diff (remote polls only)
 	const isRemote = parseInt(pollData.remote, 10) === 1;
 	const oldOptions = isRemote ? (await Vote.get({ uid: socket.uid, pollId: data.pollId })).options : [];
+	const voteAnon = isRemote ? await db.isSortedSetMember(`poll:${data.pollId}:anon:voters`, socket.uid) : false;
 
 	await Vote.update(data);
 
@@ -133,7 +142,7 @@ Sockets.updateVote = async function (socket, data) {
 		const oldSet = oldOptions.map(String);
 		const removedOptionIds = oldOptions.filter(id => !data.options.map(String).includes(String(id)));
 		const addedOptionIds = data.options.filter(id => !oldSet.includes(String(id)));
-		await federateVoteChange({ pollData, socket, voteAnon: data.voteAnon, removedOptionIds, addedOptionIds });
+		await federateVoteChange({ pollData, socket, voteAnon, removedOptionIds, addedOptionIds });
 	}
 
 	const returnPoll = await Poll.get(data.pollId, socket.uid, false);
@@ -254,8 +263,8 @@ async function checkPrivs(cid, socketUid) {
 // FEP-9967 outbound vote federation
 // ---------------------------------------------------------------------------
 
-// Build a FEP-9967 vote Note. Stable, idempotent id so re-sends and Undos
-// dedupe remotely.
+// Build a FEP-9967 vote Note. Stable, idempotent id so re-sends and
+// Deletes dedupe remotely.
 function buildVoteNote({ voterUrl, questionId, optionName, pollAuthorUrl }) {
 	const voteId = `${voterUrl}#activity/vote/${encodeURIComponent(questionId)}/${encodeURIComponent(optionName)}`;
 	return {
@@ -292,21 +301,16 @@ async function federateVoteChange({ pollData, socket, voteAnon, removedOptionIds
 		return opt ? opt.title : null;
 	};
 
-	// Undo removed options
+	// Delete removed options (the vote Note is an entity; retraction deletes it)
 	for (const id of removedOptionIds) {
 		const name = toName(id);
 		if (!name) continue;
 		const voteNote = buildVoteNote({ voterUrl, questionId, optionName: name, pollAuthorUrl });
 		// eslint-disable-next-line no-await-in-loop
 		await activitypub.send('uid', socket.uid, [pollAuthorUrl], {
-			id: `${voteNote.id}#undo`,
-			type: 'Undo',
-			object: {
-				id: voteNote.id,
-				type: 'Create',
-				actor: voterUrl,
-				object: voteNote,
-			},
+			id: `${voteNote.id}#delete`,
+			type: 'Delete',
+			object: voteNote,
 		});
 	}
 

package/lib/vote.js

@@ -73,10 +73,6 @@ Vote.canUpdateVote = async function (uid, pollId) {
 	if (!pollInfo) {
 		throw new Error('[[error:invalid-data]]');
 	}
-	// Remote polls: vote changes/removals are not federated (no OSW support yet)
-	if (parseInt(pollInfo.remote, 10) === 1) {
-		return false;
-	}
 	const [canRead, ended, deleted, updateDisabled] = await Promise.all([
 		privileges.posts.can('topics:read', pollInfo.pid, uid),
 		Poll.hasEnded(pollId),

package/library.js

@@ -1,5 +1,7 @@
 'use strict';
 
+const nconf = nodebb.require('nconf');
+
 const NodeBB = require('./lib/nodebb');
 const Config = require('./lib/config');
 const Sockets = require('./lib/sockets');
@@ -47,6 +49,10 @@ Plugin.load = async function (params) {
 	NodeBB.PluginSockets[Config.plugin.id] = Sockets;
 
 	NodeBB.app = params.app;
+
+	if (nconf.get('runJobs')) {
+		await db.delete(`poll:voteLocks`);
+	}
 };
 
 Plugin.addAdminNavigation = function (adminHeader) {

package/package.json

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

package/public/js/poll/view.js

@@ -204,10 +204,6 @@
 	};
 
 	View.prototype.voteUpdateAllowed = function () {
-		// Remote polls: vote changes/removals are not federated (no OSW support yet)
-		if (parseInt(this.pollData.info.remote, 10) === 1) {
-			return false;
-		}
 		return parseInt(this.pollData.info.disallowVoteUpdate, 10) !== 1;
 	};
 

package/templates/poll/view/voting.tpl

@@ -14,3 +14,9 @@
     {{tx("poll:vote_is_final")}}
 </div>
 {{{ end }}}
+
+{{{ if poll.info.remote }}}
+<div class="alert alert-info" role="alert">
+    {{tx("poll:remote_vote_caveat")}}
+</div>
+{{{ end }}}

package/upgrades/fix_incorrect_poll_privilege.js

@@ -1,15 +1,15 @@
-'use strict';
-
-const db = nodebb.require('./src/database');
-const privileges = nodebb.require('./src/privileges');
-
-module.exports = {
-	name: 'Fix incorrectly given poll privilege',
-	timestamp: Date.UTC(2020, 9, 29),
-	method: async () => {
-		const cids = await db.getSortedSetRange('categories:cid', 0, -1);
-		await Promise.all(cids.map(async (cid) => {
-			await privileges.categories.rescind(['poll:create'], cid, ['registered-users']);
-		}));
-	},
-};
+'use strict';
+
+const db = nodebb.require('./src/database');
+const privileges = nodebb.require('./src/privileges');
+
+module.exports = {
+	name: 'Fix incorrectly given poll privilege',
+	timestamp: Date.UTC(2020, 9, 29),
+	method: async () => {
+		const cids = await db.getSortedSetRange('categories:cid', 0, -1);
+		await Promise.all(cids.map(async (cid) => {
+			await privileges.categories.rescind(['poll:create'], cid, ['registered-users']);
+		}));
+	},
+};