nodebb-plugin-poll 4.0.14 → 4.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-poll",
-  "version": "4.0.14",
+  "version": "4.1.0",
   "description": "NodeBB Poll Plugin",
   "main": "library.js",
   "scripts": {
@@ -26,7 +26,7 @@
     "cron": "^1.8.2"
   },
   "nbbpm": {
-    "compatibility": "^4.14.0"
+    "compatibility": "^4.17.0"
   },
   "devDependencies": {
     "eslint": "10.6.0",

package/plugin.json

@@ -17,6 +17,8 @@
     { "hook": "filter:post.create", "method": "hooks.filter.postCreate" },
     { "hook": "filter:post.getFields", "method": "hooks.filter.postGetFields" },
     { "hook": "filter:post.edit", "method": "hooks.filter.postEdit" },
+    { "hook": "filter:activitypub.mocks.note", "method": "hooks.filter.activitypubMocksNote" },
+    { "hook": "filter:activitypub.create", "method": "hooks.filter.activitypubCreate" },
 
     { "hook": "action:post.delete", "method": "hooks.action.postDelete" },
     { "hook": "action:post.restore", "method": "hooks.action.postRestore" },

package/public/js/poll/creator.js

@@ -46,7 +46,6 @@
 		const html = await Benchpress.render('poll/manage', { post: postData });
 
 		if (modal) {
-			// modal.find('.bootbox-body').html(html[0].outerHTML);
 			modal.find('.bootbox-body').html(html);
 			handleSort({ modal, polls: postData.polls });
 		} else {
@@ -158,7 +157,16 @@
 	Creator.show = function (modalTitle, poll, config) {
 		return new Promise((resolve) => {
 			app.require(['benchpressjs', 'modals']).then(([Benchpress, modals]) => {
-				Benchpress.render('poll/creator', { poll, config }).then(async function (html) {
+				const pollForTemplate = { ...poll };
+				const end = parseInt(pollForTemplate.end, 10);
+				if (end > 0) {
+					const d = new Date(end);
+					const pad = n => String(n).padStart(2, '0');
+					pollForTemplate.end = `${d.getFullYear()}-${pad(d.getMonth() + 1)}-${pad(d.getDate())}T${pad(d.getHours())}:${pad(d.getMinutes())}`;
+				} else {
+					pollForTemplate.end = '';
+				}
+				Benchpress.render('poll/creator', { poll: pollForTemplate, config }).then(async function (html) {
 					const modal = await modals.dialog({
 						title: modalTitle,
 						message: html,
@@ -190,14 +198,20 @@
 						},
 					});
 
+					setTimezoneLabel(modal);
 					handleOptionSort({ modal });
 
+					// Show/hide the anon-voting federation note as the checkbox is toggled
+					modal.find('#allowAnonVoting').on('change', function () {
+						modal.find('#pollAnonVotingNote').toggleClass('hidden', !this.checked);
+					});
+
 					// Add option adder
 					modal.find('#pollAddOption')
 						.off('click')
 						.on('click', async function () {
-							const optionEls = modal.find('[component="post/poll/option/item"]');
-							if (config.maxOptions <= optionEls.length) {
+							const optionCount = modal.find('#poll-options-container [component="post/poll/option/item"]').length;
+							if (config.maxOptions <= optionCount) {
 								clearErrors();
 								error(`[[poll:error.max_options, ${config.maxOptions}]]`);
 								return false;
@@ -230,6 +244,14 @@
 		});
 	}
 
+	function setTimezoneLabel(modal) {
+		const offsetMinutes = -new Date().getTimezoneOffset();
+		const sign = offsetMinutes >= 0 ? '+' : '-';
+		const hours = String(Math.floor(Math.abs(offsetMinutes) / 60)).padStart(2, '0');
+		const minutes = String(Math.abs(offsetMinutes) % 60).padStart(2, '0');
+		modal.find('[data-timezone-label]').text(`(UTC${sign}${hours}:${minutes})`);
+	}
+
 	async function error(message) {
 		const errorBox = $('#pollErrorBox');
 		const translator = await app.require('translator');

package/public/js/poll/main.js

@@ -71,16 +71,27 @@ $(document).ready(function () {
 	});
 
 	function getPollByPost(post) {
-		if (!post || !post.hasOwnProperty('pollIds') || !post.pollIds) return;
-		let pollIds;
-		try {
-			pollIds = JSON.parse(post.pollIds || '[]');
-		} catch (err) {
-			pollIds = [];
+		if (!post) return;
+		let pollIds = [];
+		if (post.pollIds) {
+			try {
+				pollIds = JSON.parse(post.pollIds);
+			} catch (err) {
+				pollIds = [];
+			}
 		}
+		const postEl = $(`[component="post"][data-pid="${post.pid}"]`);
+		const container = postEl.find('[component="post/content"]');
+		const validPollIdSet = new Set((pollIds || []).map(id => String(id)));
+		container.find('[data-poll-id]').each(function () {
+			const existingPollId = $(this).attr('data-poll-id');
+			if (!validPollIdSet.has(existingPollId)) {
+				$(this).remove();
+				delete Poll.view.polls[existingPollId];
+			}
+		});
 		if (pollIds.length) {
-			const postEl = $(`[component="post"][data-pid="${post.pid}"]`);
-			getPolls(pollIds, postEl.find('[component="post/content"]'));
+			getPolls(pollIds, container);
 		}
 	}
 

package/public/js/poll/view.js

@@ -3,7 +3,7 @@
 (function (Poll) {
 	function vote(view, options) {
 		const form = view.dom.votingPanel.find('form');
-		const votes = form.serializeArray().map(option => parseInt(option.value, 10));
+		const votes = form.serializeArray().map(option => option.value);
 
 		if (votes.length > 0) {
 			const voteData = {
@@ -66,7 +66,7 @@
 			handle: function (view) {
 				const form = view.dom.votingPanel.find('form');
 				const votes = form.serializeArray().map(function (option) {
-					return parseInt(option.value, 10);
+					return option.value;
 				});
 
 				if (votes.length > 0) {
@@ -129,6 +129,9 @@
 		{
 			// Option details
 			register: function (view) {
+				if (!app.user.uid) {
+					return;
+				}
 				const self = this;
 				view.dom.resultsPanel.off('click').on('click', '.poll-result-votecount', function (e) {
 					self.handle(view, e);
@@ -201,7 +204,11 @@
 	};
 
 	View.prototype.voteUpdateAllowed = function () {
-		return parseInt(this.pollData.disallowVoteUpdate, 10) !== 1;
+		// 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;
 	};
 
 	View.prototype.pollEndedOrDeleted = function () {
@@ -257,20 +264,26 @@
 		this.dom.messages.addClass('hidden');
 	};
 
-	View.prototype.showOptionDetails = function (details) {
-		require(['benchpress', 'modals'], function (benchpress, modals) {
-			benchpress.render('poll/view/details', details).then(function (html) {
-				modals.dialog({
-					title: `[[poll:x-users-voted-for-this-option, ${details.voteCount}]]`,
-					message: html,
-					backdrop: true,
-					buttons: {
-						close: {
-							label: 'Close',
-						},
-					},
-				});
-			});
+	View.prototype.showOptionDetails = async function (details) {
+		const [modals, Benchpress] = await app.require(['modals', 'benchpressjs']);
+		if (details.votes) {
+			const translator = await app.require('translator');
+			await Promise.all(details.votes.map(async (voter) => {
+				if (!parseInt(voter.uid, 10) && voter.displayname) {
+					voter.displayname = await translator.translate(voter.displayname);
+				}
+			}));
+		}
+		const html = await Benchpress.render('poll/view/details', details);
+		await modals.dialog({
+			title: `[[poll:x-users-voted-for-this-option, ${details.voteCount}]]`,
+			message: html,
+			backdrop: true,
+			buttons: {
+				close: {
+					label: '[[global:close]]',
+				},
+			},
 		});
 	};
 
@@ -301,7 +314,7 @@
 			}
 		} else {
 			this.showVoteButton();
-			if (this.pollData?.info?.allowAnonVoting) {
+			if (this.pollData.info.allowAnonVoting) {
 				this.showVoteAnonButton();
 			}
 		}

package/templates/admin/plugins/poll.tpl

@@ -4,7 +4,7 @@
 			<h4 class="fw-bold tracking-tight mb-0">{title}</h4>
 		</div>
 		<div class="col-12 col-md-4 px-0 px-md-3 text-end">
-			<button id="save" class="btn btn-primary btn-sm fw-semibold ff-secondary text-center text-nowrap">[[admin/admin:save-changes]]</button>
+			<button id="save" class="btn btn-primary btn-sm fw-semibold ff-secondary text-center text-nowrap">{{tx("admin/admin:save-changes")}}</button>
 		</div>
 	</div>
 
@@ -15,10 +15,10 @@
 					<thead>
 						<tr class="text-sm">
 							<th>ID</th>
-							<th class="text-nowrap">[[poll:poll_title]]</th>
-							<th class="text-nowrap">[[poll:created-time]]</th>
-							<th class="text-nowrap">[[poll:end-time]]</th>
-							<th class="text-end text-nowrap text-capitalize">[[poll:votes]]</th>
+							<th class="text-nowrap">{{tx("poll:poll_title")}}</th>
+							<th class="text-nowrap">{{tx("poll:created-time")}}</th>
+							<th class="text-nowrap">{{tx("poll:end-time")}}</th>
+							<th class="text-end text-nowrap text-capitalize">{{tx("poll:votes")}}</th>
 						</tr>
 					</thead>
 					<tbody class="text-xs text-tabular">
@@ -47,27 +47,26 @@
 		<div id="spy-container" class="col-12 col-lg-3" tabindex="0">
 			<form class="form poll-settings">
 				<div class="form-check mb-3">
-					<label class="form-check-label" for="allowGuestsToViewResults">[[poll:allow_guests]]</label>
+					<label class="form-check-label" for="allowGuestsToViewResults">{{tx("poll:allow_guests")}}</label>
 					<input class="form-check-input" type="checkbox" id="allowGuestsToViewResults" name="allowGuestsToViewResults">
 				</div>
 
 				<div class="mb-3">
-					<label class="form-label" for="maxOptions">[[poll:max_options]]</label>
+					<label class="form-label" for="maxOptions">{{tx("poll:max_options")}}</label>
 					<input type="number" class="form-control" id="maxOptions" placeholder="10" min="1" max="100" name="maxOptions">
 				</div>
 
 				<div class="mb-3">
-					<label class="form-label" for="defaultTitle">[[poll:default_title]]</label>
+					<label class="form-label" for="defaultTitle">{{tx("poll:default_title")}}</label>
 					<input type="text" class="form-control" id="defaultTitle" placeholder="Poll" name="defaultTitle">
 				</div>
 				<div>
-					<label class="form-label" for="maximumVotesPerUser">[[poll:max_votes]]</label>
+					<label class="form-label" for="maximumVotesPerUser">{{tx("poll:max_votes")}}</label>
 					<input type="number" class="form-control" id="maximumVotesPerUser" placeholder="1" min="1" max="100" name="maximumVotesPerUser">
-					<p class="form-text">[[poll:info_choices]]</p>
+					<p class="form-text">{{tx("poll:info_choices")}}</p>
 				</div>
 			</form>
 		</div>
 	</div>
 </div>
 
-

package/templates/poll/creator.tpl

@@ -4,12 +4,12 @@
     <input type="hidden" name="pollId" value="{poll.pollId}">
 
     <div class="mb-3">
-        <label class="form-label" for="pollInputTitle">[[poll:poll_title]]</label>
-        <input type="text" name="title" id="pollInputTitle" value="{poll.title}" placeholder="[[poll:poll_title_placeholder]]" class="form-control">
+        <label class="form-label" for="pollInputTitle">{{tx("poll:poll_title")}}</label>
+        <input type="text" name="title" id="pollInputTitle" value="{poll.title}" placeholder="{{tx("poll:poll_title_placeholder")}}" class="form-control">
     </div>
 
     <div class="mb-3 d-flex flex-column gap-1">
-        <label class="form-label" for="pollInputOptions">[[poll:options_title]]</label>
+        <label class="form-label" for="pollInputOptions">{{tx("poll:options_title")}}</label>
         <div id="poll-options-container" class="d-flex flex-column gap-1">
         {{{ if poll.options.length }}}
         {{{ each poll.options }}}
@@ -17,32 +17,34 @@
         {{{ end }}}
         {{{ end }}}
         </div>
-        <button type="button" id="pollAddOption" class="btn btn-primary btn-sm btn-block mt-2">[[poll:options_add]]</button>
+        <button type="button" id="pollAddOption" class="btn btn-primary btn-sm btn-block mt-2">{{tx("poll:options_add")}}</button>
     </div>
 
     <hr>
 
     <div class="mb-3">
-        <label class="form-label" for="pollInputAmount">[[poll:max_votes]]</label>
-        <input type="number" name="maximumVotesPerUser" id="pollInputAmount" value="{poll.maximumVotesPerUser}" min="1" max="10" step="1" placeholder="[[poll:max_votes_placeholder]]" class="form-control">
-        <p class="form-text">[[poll:info_choices]]</p>
+        <label class="form-label" for="pollInputAmount">{{tx("poll:max_votes")}}</label>
+        <input type="number" name="maximumVotesPerUser" id="pollInputAmount" value="{poll.maximumVotesPerUser}" min="1" max="10" step="1" placeholder="{{tx("poll:max_votes_placeholder")}}" class="form-control">
+        <p class="form-text">{{tx("poll:info_choices")}}</p>
     </div>
 
     <div class="form-check mb-3">
-        <label class="form-check-label" for="pollDisallowVoteUpdate">[[poll:disallow_vote_update]]</label>
+        <label class="form-check-label" for="pollDisallowVoteUpdate">{{tx("poll:disallow_vote_update")}}</label>
         <input class="form-check-input" type="checkbox" name="disallowVoteUpdate" id="pollDisallowVoteUpdate" {{{if poll.disallowVoteUpdate}}}checked{{{end}}}>
     </div>
 
     <div class="form-check mb-3">
-        <label class="form-check-label" for="allowAnonVoting">[[poll:allow_anon_voting]]</label>
+        <label class="form-check-label" for="allowAnonVoting">{{tx("poll:allow_anon_voting")}}</label>
         <input class="form-check-input" type="checkbox" name="allowAnonVoting" id="allowAnonVoting" {{{if poll.allowAnonVoting}}}checked{{{end}}}>
+        <p class="form-text {{{if poll.allowAnonVoting}}}{{{else}}}hidden{{{end}}}" id="pollAnonVotingNote">{{tx("poll:anon_voting_not_federated")}}</p>
     </div>
 
     <div class="mb-3">
-        <label class="form-label" for="pollInputEnd">[[poll:auto_end_title]]</label>
+        <label class="form-label" for="pollInputEnd">{{tx("poll:auto_end_title")}}</label>
         <div class="input-group date">
-            <input id="pollInputEnd" placeholder="[[poll:auto_end_placeholder]]" name="end" class="form-control" value="{poll.end}" type="datetime-local">
+            <input id="pollInputEnd" placeholder="{{tx("poll:auto_end_placeholder")}}" name="end" class="form-control" value="{poll.end}" type="datetime-local">
+            <span class="input-group-text poll-timezone-label" data-timezone-label></span>
         </div>
-        <p class="form-text">[[poll:auto_end_help]]</p>
+        <p class="form-text">{{tx("poll:auto_end_help")}}</p>
     </div>
 </form>

package/templates/poll/manage.tpl

@@ -1,6 +1,6 @@
 <div class="topic-poll-modal">
 	{{{ if !post.polls.length }}}
-	<div class="alert alert-info">[[poll:no-polls]]</div>
+	<div class="alert alert-info">{{tx("poll:no-polls")}}</div>
 	{{{ end }}}
 	{{{ each post.polls }}}
 	<div component="post/poll/item" data-poll-id="{./pollId}" class="bg-body d-flex align-items-center justify-content-between mb-3 p-1 border rounded-1">

package/templates/poll/view/messages.tpl

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

package/templates/poll/view/results.tpl

@@ -1,10 +1,16 @@
-<!-- BEGIN poll.options -->
+{{{ each poll.options }}}
 <div class="poll-result" data-poll-option-id="{poll.options.id}">
     <div class="d-flex justify-content-between mb-1">
         <strong>{poll.options.title}</strong>
+        {{{ if config.loggedIn }}}
         <a class="poll-result-votecount small" href="#">
-            <span>[[poll:x-votes, {poll.options.voteCount}]]</span>
+            <span>{{tx("poll:x-votes", poll.options.voteCount)}}</span>
         </a>
+        {{{ else }}}
+        <span class="poll-result-votecount small">
+            <span>{{tx("poll:x-votes", poll.options.voteCount)}}</span>
+        </span>
+        {{{ end }}}
     </div>
     <div class="progress">
         <div class="progress-bar poll-result-progressbar" role="progressbar" aria-valuenow="{poll.options.percentage}" aria-valuemin="0" aria-valuemax="100" style="width: {poll.options.percentage}%;">
@@ -12,4 +18,4 @@
         </div>
     </div>
 </div>
-<!-- END poll.options -->
+{{{ end }}}

package/templates/poll/view/voting.tpl

@@ -1,16 +1,16 @@
 <form role="form" class="poll-voting-form mb-3 d-flex flex-column gap-3">
-    <!-- BEGIN poll.options -->
+    {{{ each poll.options }}}
     <div class="poll-view-option {poll.optionType}" data-poll-option-id="{poll.options.id}">
         <div class="form-check">
             <input class="form-check-input" type="{poll.optionType}" name="pollVoteSelection" value="{poll.options.id}" id="poll-{poll.info.pollId}-option-id-{poll.options.id}">
             <label class="form-check-label" for="poll-{poll.info.pollId}-option-id-{poll.options.id}">{poll.options.title}</label>
         </div>
     </div>
-    <!-- END poll.options -->
+    {{{ end }}}
 </form>
 
-<!-- IF poll.settings.disallowVoteUpdate -->
+{{{ if poll.info.disallowVoteUpdate }}}
 <div class="alert alert-warning" role="alert">
-    [[poll:vote_is_final]]
+    {{tx("poll:vote_is_final")}}
 </div>
-<!-- ENDIF poll.settings.disallowVoteUpdate -->
+{{{ end }}}

package/templates/poll/view.tpl

@@ -9,7 +9,7 @@
                 {{{ end }}}
             </h5>
             {{{ if (isAdmin && !poll.isWidget) }}}
-            <span class="text-sm text-secondary">[[poll:poll-id-x, {poll.info.pollId}]]</span>
+            <span class="text-sm text-secondary">{{tx("poll:poll-id-x", poll.info.pollId)}}</span>
             {{{ end }}}
         </div>
         <div class="card-body">
@@ -19,16 +19,16 @@
             </div>
             <div class="poll-view-results d-flex flex-column gap-3 mb-3 {{{ if !poll.hasVoted }}}hidden{{{ end }}}">
                 <!-- IMPORT poll/view/results.tpl -->
-                <div class="text-end text-sm text-secondary poll-result-total-votecount">[[poll:total-votes-x, {poll.info.voteCount}]]</div>
+                <div class="text-end text-sm text-secondary poll-result-total-votecount">{{tx("poll:total-votes-x", poll.info.voteCount)}}</div>
             </div>
 
             <div class="poll-view-buttons">
-                <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>
+                <button type="button" class="btn btn-sm btn-primary poll-button-vote hidden">{{tx("poll:vote")}}</button>
+                <button type="button" class="btn btn-sm btn-primary poll-button-vote-anon hidden">{{tx("poll:vote_anonymously")}}</button>
+                <button type="button" class="btn btn-sm btn-primary poll-button-update-vote hidden">{{tx("poll:update_vote")}}</button>
+                <button type="button" class="btn btn-sm btn-danger poll-button-remove-vote hidden">{{tx("poll:remove_vote")}}</button>
+                <button type="button" class="btn btn-sm btn-link poll-button-results hidden">{{tx("poll:to_results")}}</button>
+                <button type="button" class="btn btn-sm btn-link poll-button-voting hidden">{{tx("poll:to_voting")}}</button>
             </div>
         </div>
     </div>

package/test/helpers.js

@@ -0,0 +1,49 @@
+'use strict';
+
+// Poll-specific test fixtures. Kept out of core so the core test suite has no
+// plugin-specific artifacts. Generic AP fixtures (note/create/mockRequests)
+// still come from `nodebb.require('./test/activitypub/helpers')`.
+
+const utils = nodebb.require('./src/utils');
+const activitypub = nodebb.require('./src/activitypub');
+
+const baseUrl = 'https://example.org';
+
+module.exports = {
+	// FEP-9967 `Question` (poll) object. Mirrors the core note() factory with
+	// poll fields (oneOf/anyOf, endTime, votersCount). Caches the object in the
+	// AP request cache so the inbox flow can fetch it without real requests.
+	question: (override = {}) => {
+		const uuid = utils.generateUUID();
+		const id = `${baseUrl}/object/${uuid}`;
+		const question = {
+			'@context': 'https://www.w3.org/ns/activitystreams',
+			id,
+			url: id,
+			type: 'Question',
+			to: ['https://www.w3.org/ns/activitystreams#Public'],
+			cc: [`${baseUrl}/user/foobar/followers`],
+			inReplyTo: null,
+			attributedTo: `${baseUrl}/user/foobar`,
+			name: utils.generateUUID(),
+			content: `<p>${utils.generateUUID()}</p>`,
+			published: new Date().toISOString(),
+			endTime: new Date(Date.now() + (24 * 60 * 60 * 1000)).toISOString(),
+			oneOf: [
+				{ type: 'Note', name: 'Option A', replies: { type: 'Collection', totalItems: 3 } },
+				{ type: 'Note', name: 'Option B', replies: { type: 'Collection', totalItems: 7 } },
+			],
+			votersCount: 10,
+			...override,
+		};
+
+		Object.entries(question).forEach(([key, value]) => {
+			if (value === 'remove') {
+				delete question[key];
+			}
+		});
+		activitypub._cache.set(`0;${id}`, question);
+
+		return { id, question };
+	},
+};