Skip to content

Node.js based forum software built for the modern web

feat(activitypub): add filter option to categorization rules for post queue gating

Julian Lamdfb108e94190
diff --git a/public/language/en-GB/admin/settings/activitypub.json b/public/language/en-GB/admin/settings/activitypub.json
index 8e7e327caa..bd31641fb3 100644
--- a/public/language/en-GB/admin/settings/activitypub.json
+++ b/public/language/en-GB/admin/settings/activitypub.json
@@ -27,6 +27,9 @@
"rules.help-user": "Topics created by the entered user will match. Enter a handle or full ID (e.g. <code>[email protected]</code> or <code>https://example.org/users/bob</code>.",
"rules.type": "Type",
"rules.value": "Value",
+ "rules.filter": "Queue",
+ "rules.filter.help": "If checked, matching content will be passed to the post queue for review before being categorized.",
+ "rules.filter-warning": "You have categorization rules set to queue posts, but the post queue is currently disabled. Posts matching these rules will be published immediately.",
"rules.cid": "Category",
"relays": "Relays",
diff --git a/public/src/admin/federation/rules.js b/public/src/admin/federation/rules.js
index 07bf3bfa27..e948ed8938 100644
--- a/public/src/admin/federation/rules.js
+++ b/public/src/admin/federation/rules.js
@@ -97,7 +97,7 @@ function throwModal() {
});
modal.on('shown.bs.modal', function () {
- modal.find('input').focus();
+ modal.find('#value').focus();
});
diff --git a/src/activitypub/notes.js b/src/activitypub/notes.js
index 828bd74a20..b9a5d52c83 100644
--- a/src/activitypub/notes.js
+++ b/src/activitypub/notes.js
@@ -52,7 +52,7 @@ Notes._normalizeTags = async (tag, cid) => {
return tags;
};
-Notes.assert = async (uid, input, options = { skipChecks: false }) => {
+Notes.assert = async (uid, input, options = { skipChecks: false, queue: false }) => {
/**
* Given the id or object of any as:Note, either retrieves the full context (if resolvable),
* or traverses up the reply chain to build a context.
@@ -139,7 +139,7 @@ Notes.assert = async (uid, input, options = { skipChecks: false }) => {
}
const cid = hasTid ? await topics.getTopicField(tid, 'cid') : options.cid || -1;
- let crosspostCid = false;
+ const crosspostCid = false;
if (options.cid && cid === -1) {
// Move topic if currently uncategorized
@@ -192,9 +192,10 @@ Notes.assert = async (uid, input, options = { skipChecks: false }) => {
}
// Auto-categorization (takes place only if all other categorization efforts fail)
- crosspostCid = await assignCategory(mainPost);
+ let { cid: crosspostCid, filter } = await assignCategory(mainPost);
if (!options.cid) {
options.cid = crosspostCid;
+ options.queue = filter;
crosspostCid = false;
}
@@ -264,8 +265,8 @@ Notes.assert = async (uid, input, options = { skipChecks: false }) => {
return null;
}
- if (mainResult.severity === 3) {
- activitypub.helpers.log(`[activitypub/notes.assert] Queuing main post (${mainPid}) due to blocklist severity 3`);
+ if ((mainResult.severity === 3 || options.queue) && meta.config.postQueue) {
+ activitypub.helpers.log(`[activitypub/notes.assert] Queuing main post (${mainPid}) due to blocklist severity 3${options.queue ? ' or categorization rule' : ''}`);
if (utils.isNumber(mainPid) || (await posts.exists([mainPid]))[0]) {
activitypub.helpers.log(`[activitypub/notes.assert] Rejecting to-be-queued main post (${mainPid}): pid is local or already exists`);
return null;
@@ -347,7 +348,7 @@ Notes.assert = async (uid, input, options = { skipChecks: false }) => {
return;
}
- if (postResult.severity === 3) {
+ if (postResult.severity === 3 && meta.config.postQueue) {
activitypub.helpers.log(`[activitypub/notes.assert] Queuing reply (${post.pid}) due to blocklist severity 3`);
if (utils.isNumber(post.pid) || await posts.exists(post.pid)) {
activitypub.helpers.log(`[activitypub/notes.assert] Rejecting to-be-queued reply (${post.pid}): pid or tid is local or already exists`);
@@ -548,18 +549,17 @@ async function assertRelation(post) {
async function assignCategory(post) {
activitypub.helpers.log('[activitypub] Checking auto-categorization rules.');
- let cid = undefined;
const rules = await activitypub.rules.list();
let tags = await Notes._normalizeTags(post._activitypub.tag || []);
tags = tags.map(tag => tag.toLowerCase());
- cid = rules.reduce((cid, { type, value, cid: target }) => {
- if (!cid) {
+ const matched = rules.reduce((matched, { type, value, cid: target, filter: ruleFilter }) => {
+ if (!matched.cid) {
switch (type) {
case 'hashtag': {
if (tags.includes(value.toLowerCase())) {
activitypub.helpers.log(`[activitypub] - Rule match: #${value}; cid: ${target}`);
- return target;
+ return { cid: target, filter: ruleFilter };
}
break;
}
@@ -567,16 +567,16 @@ async function assignCategory(post) {
case 'user': {
if (post.uid === value) {
activitypub.helpers.log(`[activitypub] - Rule match: user ${value}; cid: ${target}`);
- return target;
+ return { cid: target, filter: ruleFilter };
}
}
}
}
- return cid;
- }, cid);
+ return matched;
+ }, { cid: undefined, filter: false });
- return cid;
+ return matched;
}
Notes.updateLocalRecipients = async (id, { to, cc }) => {
diff --git a/src/activitypub/rules.js b/src/activitypub/rules.js
index bb1b0e1402..c33c29a412 100644
--- a/src/activitypub/rules.js
+++ b/src/activitypub/rules.js
@@ -22,7 +22,7 @@ Rules.list = async () => {
return rules;
};
-Rules.upsert = async (type, value, cid) => {
+Rules.upsert = async (type, value, cid, filter) => {
const rules = await Rules.list();
const existing = rules.find(rule => rule.type === type && rule.value === value);
@@ -42,7 +42,7 @@ Rules.upsert = async (type, value, cid) => {
const uuid = utils.generateUUID();
await Promise.all([
- db.setObject(`rid:${uuid}`, { type, value, cid }),
+ db.setObject(`rid:${uuid}`, { type, value, cid, filter: !!filter }),
db.sortedSetAdd('categorization:rid', Date.now(), uuid),
]);
return uuid;
diff --git a/src/controllers/admin/federation.js b/src/controllers/admin/federation.js
index a7ec9a8d2b..4c1edeed2d 100644
--- a/src/controllers/admin/federation.js
+++ b/src/controllers/admin/federation.js
@@ -3,6 +3,7 @@
const validator = require('validator');
const db = require('../../database');
+const meta = require('../../meta');
const activitypub = require('../../activitypub');
const analytics = require('../../analytics');
@@ -22,10 +23,14 @@ federationController.content = function (req, res) {
federationController.rules = async function (req, res) {
const rules = await activitypub.rules.list();
+ const postQueueEnabled = !!(await meta.configs.get('postQueue'));
+ const hasFilterRules = rules.some(rule => rule.filter === 'true');
res.render(`admin/federation/rules`, {
title: '[[admin/menu:federation/rules]]',
rules,
+ postQueueEnabled,
+ hasFilterRules,
hideSave: true,
});
};
diff --git a/src/controllers/write/admin.js b/src/controllers/write/admin.js
index 3ef27a8977..5282957fd5 100644
--- a/src/controllers/write/admin.js
+++ b/src/controllers/write/admin.js
@@ -88,13 +88,13 @@ Admin.listGroups = async (req, res) => {
Admin.activitypub = {};
Admin.activitypub.addRule = async (req, res) => {
- const { type, value, cid } = req.body;
+ const { type, value, cid, filter } = req.body;
const exists = await categories.exists(cid);
if (!value || !exists) {
return helpers.formatApiResponse(400, res);
}
- await activitypub.rules.upsert(type, value, cid);
+ await activitypub.rules.upsert(type, value, cid, filter === 'true');
helpers.formatApiResponse(200, res, await activitypub.rules.list());
};
diff --git a/src/views/admin/federation/rules.tpl b/src/views/admin/federation/rules.tpl
index ba41467240..9138fb560d 100644
--- a/src/views/admin/federation/rules.tpl
+++ b/src/views/admin/federation/rules.tpl
@@ -6,12 +6,17 @@
<div id="rules" class="mb-4">
<p class="lead">[[admin/settings/activitypub:rules-intro]]</p>
+ {{{ if (hasFilterRules && !postQueueEnabled) }}}
+ <div class="alert alert-warning">[[admin/settings/activitypub:rules.filter-warning]]</div>
+ {{{ end }}}
+
<div class="mb-3 table-responsive-md">
<table class="table table-striped" id="rules">
<thead>
<th></th>
<th>[[admin/settings/activitypub:rules.type]]</th>
<th>[[admin/settings/activitypub:rules.value]]</th>
+ <th>[[admin/settings/activitypub:rules.filter]]</th>
<th>[[admin/settings/activitypub:rules.cid]]</th>
<th></th>
</thead>
@@ -23,6 +28,7 @@
</td>
<td>{./type}</td>
<td>{./value}</td>
+ <td>{{{ if ./filter }}}✓{{{ else }}}✗{{{ end }}}</td>
<td>{./cid}</td>
<td><a href="#" data-action="rules.delete"><i class="fa fa-trash link-danger"></i></a></td>
</tr>
@@ -30,7 +36,7 @@
</tbody>
<tfoot>
<tr>
- <td colspan="5">
+ <td colspan="6">
<button class="btn btn-sm btn-primary" data-action="rules.add">[[admin/settings/activitypub:rules.add]]</button>
</td>
</tr>
diff --git a/src/views/admin/partials/activitypub/rules.tpl b/src/views/admin/partials/activitypub/rules.tpl
index eaf463f6dc..ce43460a8a 100644
--- a/src/views/admin/partials/activitypub/rules.tpl
+++ b/src/views/admin/partials/activitypub/rules.tpl
@@ -24,4 +24,9 @@
</div>
<input type="hidden" name="cid" />
</div>
+ <div class="mb-3 form-check">
+ <input type="checkbox" class="form-check-input" name="filter" id="filter" value="true" />
+ <label class="form-check-label" for="filter">[[admin/settings/activitypub:rules.filter]]</label>
+ <p class="form-text">[[admin/settings/activitypub:rules.filter.help]]</p>
+ </div>
</form>
\ No newline at end of file