nodebb-plugin-poll 4.0.14 → 4.1.0

package/lib/sockets.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const nconf = nodebb.require('nconf');
 const _ = nodebb.require('lodash');
 const db = nodebb.require('./src/database');
 const posts = nodebb.require('./src/posts');
@@ -15,7 +16,7 @@ const Sockets = exports;
 
 Sockets.get = async function (socket, data) {
 	const settings = await Config.getSettings();
-	const allowAnon = settings.allowGuestsToViewResults === 'on';
+	const allowAnon = !!settings.allowGuestsToViewResults;
 
 	if (!data) {
 		throw new Error('Invalid request, request data is not defined');
@@ -27,13 +28,13 @@ Sockets.get = async function (socket, data) {
 		return [];
 	}
 	return await Promise.all(data.pollIds.map(async (pollId) => {
-		const withVotes = allowAnon || socket.uid > 0;
+		const withVotes = !!socket.uid;
 		const pollData = await Poll.get(pollId, socket.uid, withVotes);
 		if (!pollData) {
 			return null;
 		}
 
-		if (parseInt(pollData.info.allowAnonVoting, 10) === 1) {
+		if (withVotes && parseInt(pollData.info.allowAnonVoting, 10) === 1) {
 			await anonymizeVoters(socket.uid, pollId, pollData.options);
 		}
 
@@ -76,6 +77,13 @@ Sockets.vote = async function (socket, 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,
+		});
+	}
+
 	const returnPoll = await Poll.get(data.pollId, socket.uid, false);
 	NodeBB.SocketIndex.server.sockets.emit('event:poll.voteChange', {
 		pollData: returnPoll,
@@ -114,7 +122,20 @@ Sockets.updateVote = async function (socket, data) {
 		throw new Error('Invalid option');
 	}
 
+	// Capture the prior vote 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 : [];
+
 	await Vote.update(data);
+
+	// Federate the vote change out (FEP-9967) if this is a remote poll
+	if (isRemote) {
+		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 });
+	}
+
 	const returnPoll = await Poll.get(data.pollId, socket.uid, false);
 	NodeBB.SocketIndex.server.sockets.emit('event:poll.voteChange', {
 		pollData: returnPoll,
@@ -136,29 +157,39 @@ Sockets.removeVote = async function (socket, data) {
 		throw new Error('Can\'t remove vote');
 	}
 
+	const pollData = await db.getObject(`poll:${data.pollId}`);
+	const isRemote = parseInt(pollData.remote, 10) === 1;
+	// Capture the prior vote + anon flag before removal (remote polls only)
+	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.remove(data);
-	const pollData = await Poll.get(data.pollId, socket.uid, false);
+
+	// Federate the vote removal out (FEP-9967) if this is a remote poll
+	if (isRemote) {
+		await federateVoteChange({ pollData, socket, voteAnon, removedOptionIds: oldOptions, addedOptionIds: [] });
+	}
+
+	const returnPoll = await Poll.get(data.pollId, socket.uid, false);
 	NodeBB.SocketIndex.server.sockets.emit('event:poll.voteChange', {
-		pollData,
+		pollData: returnPoll,
 		uid: socket.uid,
 	});
 };
 
 Sockets.getOptionDetails = async function (socket, data) {
-	if (!data || isNaN(parseInt(data.pollId, 10)) || isNaN(parseInt(data.optionId, 10))) {
+	if (!socket.uid || !data || isNaN(parseInt(data.pollId, 10)) || isNaN(parseInt(data.optionId, 10))) {
 		throw new Error('Invalid request');
 	}
-	const [poll, option, settings] = await Promise.all([
+	const [poll, option] = await Promise.all([
 		Poll.getInfo(data.pollId),
 		Poll.getOption(data.pollId, data.optionId, true),
-		Config.getSettings(),
 	]);
 	if (!poll) {
 		throw new Error('[[error:invalid-data]]');
 	}
-	const allowAnon = settings.allowGuestsToViewResults === 'on';
 	const canRead = await privileges.posts.can('topics:read', poll.pid, socket.uid);
-	if (!canRead || (!allowAnon && socket.uid <= 0)) {
+	if (!canRead) {
 		throw new Error('[[error:no-privileges]]');
 	}
 	if (!option || !option.votes || !option.votes.length) {
@@ -170,7 +201,7 @@ Sockets.getOptionDetails = async function (socket, data) {
 	}
 
 	const userData = await NodeBB.User.getUsersFields(option.votes, [
-		'uid', 'username', 'userslug', 'picture',
+		'uid', 'username', 'userslug', 'picture', 'displayname', 'icon:text', 'icon:bgColor',
 	]);
 	option.votes = userData;
 
@@ -205,7 +236,7 @@ async function anonymizeVoters(callerUid, pollId, options) {
 	}
 	const uidToIsAnon = _.zipObject(uids, isAnon);
 	options.forEach((opt) => {
-		opt.votes = opt.votes.map(
+		opt.votes = (opt.votes || []).map(
 			uid => (uidToIsAnon[uid] && String(callerUid) !== uid ? 0 : uid)
 		);
 	});
@@ -218,3 +249,77 @@ async function checkPrivs(cid, socketUid) {
 	}
 	return true;
 }
+
+// ---------------------------------------------------------------------------
+// FEP-9967 outbound vote federation
+// ---------------------------------------------------------------------------
+
+// Build a FEP-9967 vote Note. Stable, idempotent id so re-sends and Undos
+// dedupe remotely.
+function buildVoteNote({ voterUrl, questionId, optionName, pollAuthorUrl }) {
+	const voteId = `${voterUrl}#activity/vote/${encodeURIComponent(questionId)}/${encodeURIComponent(optionName)}`;
+	return {
+		id: voteId,
+		type: 'Note',
+		attributedTo: voterUrl,
+		inReplyTo: questionId,
+		name: optionName,
+		to: [pollAuthorUrl],
+	};
+}
+
+// Federate a vote change (additions and/or removals) for a remote poll.
+// Anonymous votes are not federated (FEP votes are attributed to the voter
+// actor, which anon votes lack).
+async function federateVoteChange({ pollData, socket, voteAnon, removedOptionIds, addedOptionIds }) {
+	if (voteAnon) {
+		return;
+	}
+	if (!removedOptionIds.length && !addedOptionIds.length) {
+		return;
+	}
+
+	const activitypub = nodebb.require('./src/activitypub');
+	const options = JSON.parse(pollData.options || '[]');
+	const [questionId, pollAuthorUrl] = await Promise.all([
+		posts.getPostField(pollData.pid, 'url'), // remote Question id (a URL)
+		posts.getPostField(pollData.pid, 'uid'), // remote actor URL (poll author)
+	]);
+	const voterUrl = `${nconf.get('url')}/uid/${socket.uid}`;
+
+	const toName = (id) => {
+		const opt = options.find(o => String(o.id) === String(id));
+		return opt ? opt.title : null;
+	};
+
+	// Undo removed options
+	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,
+			},
+		});
+	}
+
+	// Create added options
+	for (const id of addedOptionIds) {
+		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,
+			type: 'Create',
+			object: voteNote,
+		});
+	}
+}

package/lib/vote.js

@@ -73,6 +73,10 @@ 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

@@ -92,7 +92,7 @@ Plugin.renderPollWidget = async function (widget) {
 	const Poll = require('./lib/poll');
 
 	const settings = await Config.getSettings();
-	const allowAnon = settings.allowGuestsToViewResults === 'on';
+	const allowAnon = !!settings.allowGuestsToViewResults;
 
 	if (!widget.uid && !allowAnon) {
 		return null;