Skip to content

Node.js based forum software built for the modern web

feat(activitypub): add global hashtag follow feature

Julian Lam4e22def3926b
diff --git a/public/language/en-GB/admin/menu.json b/public/language/en-GB/admin/menu.json
index 07ed4b14b7..d64a0d7f66 100644
--- a/public/language/en-GB/admin/menu.json
+++ b/public/language/en-GB/admin/menu.json
@@ -54,6 +54,7 @@
"federation/content": "Content",
"federation/rules": "Categorization",
"federation/relays": "Relays",
+ "federation/hashtags": "Hashtags",
"federation/pruning": "Storage",
"federation/safety": "Trust & Safety",
"federation/analytics": "Analytics",
diff --git a/public/language/en-GB/admin/settings/activitypub.json b/public/language/en-GB/admin/settings/activitypub.json
index 27f6ae1238..5706852174 100644
--- a/public/language/en-GB/admin/settings/activitypub.json
+++ b/public/language/en-GB/admin/settings/activitypub.json
@@ -110,5 +110,20 @@
"errors.intro": "The following %1 error(s) were recorded by this instance within the last 24 hours.",
"errors.payload-gone": "The payload for this error no longer exists.",
"errors.hostname": "Hostname",
- "errors.type": "Type"
+ "errors.type": "Type",
+
+ "hashtags": "Hashtags",
+ "hashtags.intro": "Follow global hashtag actors to receive content matching specific tags. The instance actor follows the relay's hashtag actor, which sends Announce activities for matching content. Use auto-categorization rules to route content to categories.",
+ "hashtags.relay-host": "Relay Host",
+ "hashtags.relay-host-help": "Choose the relay provider for hashtag actors.",
+ "hashtags.save-relay": "Save",
+ "hashtags.relay-change-warning": "Changing the relay host will unfollow all current hashtag actors and follow them on the new relay.",
+ "hashtags.follow": "Follow Hashtag",
+ "hashtags.modal.tag": "Hashtag",
+ "hashtags.modal.tag-help": "Enter the hashtag name without the # symbol (e.g., nodebb).",
+ "hashtags.state-pending": "Pending",
+ "hashtags.state-active": "Active",
+ "hashtags.state-error": "Error",
+ "hashtags.table.tag": "Tag",
+ "hashtags.table.state": "State"
}
\ No newline at end of file
diff --git a/public/src/admin/federation/hashtags.js b/public/src/admin/federation/hashtags.js
new file mode 100644
index 0000000000..bed221721d
--- /dev/null
+++ b/public/src/admin/federation/hashtags.js
@@ -0,0 +1,127 @@
+'use strict';
+
+import { post, del, put } from 'api';
+import { error, success } from 'alerts';
+import { render } from 'benchpress';
+import * as modals from 'modals';
+
+export async function init() {
+ setupHashtags();
+ setupRelay();
+}
+
+function setupHashtags() {
+ const hashtagsEl = document.getElementById('hashtags');
+ if (!hashtagsEl) {
+ return;
+ }
+
+ hashtagsEl.addEventListener('click', (e) => {
+ const subselector = e.target.closest('[data-action]');
+ if (!subselector) {
+ return;
+ }
+
+ const action = subselector.getAttribute('data-action');
+
+ switch (action) {
+ case 'hashtags.add': {
+ throwModal();
+ break;
+ }
+
+ case 'hashtags.remove': {
+ const tag = subselector.getAttribute('data-tag');
+ del(`/admin/activitypub/hashtags/${encodeURIComponent(tag)}`).then(async (data) => {
+ const html = await app.parseAndTranslate('admin/partials/activitypub/hashtags/list', {}, {
+ hashtags: data.map(h => ({
+ ...h,
+ stateClass: getStateClass(h.state),
+ })),
+ });
+ const listEl = document.querySelector('[component="hashtags/list"]');
+ if (listEl) {
+ $(listEl).html(html);
+ }
+ }).catch(error);
+ break;
+ }
+ }
+ });
+}
+
+function setupRelay() {
+ const setRelayBtn = document.querySelector('[data-action="hashtags.setRelay"]');
+ if (!setRelayBtn) {
+ return;
+ }
+
+ setRelayBtn.addEventListener('click', () => {
+ const relayHostEl = document.getElementById('relayHost');
+ const host = relayHostEl ? relayHostEl.value : '';
+ if (!host) {
+ error('[[error:invalid-data]]');
+ return;
+ }
+
+ put('/admin/activitypub/hashtags/relay', { host }).then(async () => {
+ success('[[success:settings-updated]]');
+ ajaxify.data.relay = host;
+ }).catch(error);
+ });
+}
+
+function throwModal() {
+ render('admin/partials/activitypub/hashtags', {}).then(async function (html) {
+ const submit = function () {
+ const formEl = modal.find('form').get(0);
+ if (!formEl.reportValidity()) {
+ return false;
+ }
+
+ const payload = Object.fromEntries(new FormData(formEl));
+ post('/admin/activitypub/hashtags', payload).then(async (data) => {
+ const html = await app.parseAndTranslate('admin/partials/activitypub/hashtags/list', {}, {
+ hashtags: data.map(h => ({
+ ...h,
+ stateClass: getStateClass(h.state),
+ })),
+ });
+ const listEl = document.querySelector('[component="hashtags/list"]');
+ if (listEl) {
+ $(listEl).html(html);
+ }
+ modal.modal('hide');
+ }).catch(error);
+ };
+
+ const modal = await modals.dialog({
+ title: '[[admin/settings/activitypub:hashtags.follow]]',
+ message: html,
+ buttons: {
+ save: {
+ label: '[[global:save]]',
+ className: 'btn-primary',
+ callback: submit,
+ },
+ },
+ });
+
+ modal.on('shown.bs.modal', function () {
+ modal.find('#hashtagTag').focus();
+ });
+ });
+}
+
+function getStateClass(state) {
+ switch (state) {
+ case 'pending':
+ return 'warning';
+ case 'active':
+ return 'success';
+ case 'error':
+ return 'danger';
+ default:
+ return 'secondary';
+ }
+}
diff --git a/src/activitypub/hashtags.js b/src/activitypub/hashtags.js
new file mode 100644
index 0000000000..a332a9d3b9
--- /dev/null
+++ b/src/activitypub/hashtags.js
@@ -0,0 +1,163 @@
+'use strict';
+
+const db = require('../database');
+
+const activitypub = module.parent.exports;
+
+const Hashtags = module.exports;
+
+const FOLLOWED_KEY = 'ap:hashtags:followed';
+const RELAY_KEY = 'ap:hashtags:relay';
+
+const relayTemplates = {
+ 'relay.fedi.buzz': 'https://relay.fedi.buzz/tag/{tag}',
+ 'tags.pub': 'https://tags.pub/user/{tag}',
+};
+
+Hashtags.getRelay = async () => {
+ return await db.get(RELAY_KEY);
+};
+
+Hashtags.setRelay = async (host) => {
+ if (typeof host !== 'string' || !host.trim()) {
+ throw new Error('[[error:invalid-data]]');
+ }
+ host = host.trim().toLowerCase();
+ if (!relayTemplates[host]) {
+ throw new Error('[[error:activitypub.hashtag.relay-not-found]]');
+ }
+ const oldHost = await Hashtags.getRelay();
+
+ await db.set(RELAY_KEY, host);
+
+ // Migrate existing follows if relay changed
+ if (oldHost && oldHost !== host) {
+ await Hashtags._migrateRelay(oldHost, host);
+ }
+};
+
+Hashtags.getRelayOptions = () => Object.keys(relayTemplates);
+
+Hashtags.resolveActor = (tag, relay) => {
+ const template = relayTemplates[relay];
+ if (!template) {
+ throw new Error('[[error:activitypub.hashtag.relay-not-found]]');
+ }
+ return template.replace('{tag}', encodeURIComponent(tag));
+};
+
+Hashtags.follow = async (tag) => {
+ const relay = await Hashtags.getRelay();
+ if (!relay) {
+ throw new Error('[[error:activitypub.hashtag.no-relay-configured]]');
+ }
+
+ const actor = Hashtags.resolveActor(tag, relay);
+
+ // Check if already followed
+ const existing = await Hashtags.get(tag);
+ if (existing) {
+ return existing;
+ }
+
+ // Send Follow activity via instance actor
+ await activitypub.out.follow('uid', 0, actor);
+
+ // Store record
+ const record = {
+ tag,
+ relay,
+ actor,
+ state: 'pending',
+ createdAt: Date.now(),
+ };
+ await db.setObject(`ap:hashtag:${tag}`, record);
+ await db.sortedSetAdd(FOLLOWED_KEY, Date.now(), tag);
+
+ return record;
+};
+
+Hashtags.unfollow = async (tag) => {
+ const record = await Hashtags.get(tag);
+ if (!record) {
+ return false;
+ }
+
+ // Undo Follow via instance actor
+ await activitypub.out.undo.follow('uid', 0, record.actor);
+
+ // Remove record
+ await Promise.all([
+ db.delete(`ap:hashtag:${tag}`),
+ db.sortedSetRemove(FOLLOWED_KEY, tag),
+ ]);
+
+ return true;
+};
+
+Hashtags.list = async () => {
+ const tags = await db.getSortedSetMembers(FOLLOWED_KEY);
+ if (!tags.length) {
+ return [];
+ }
+
+ const records = await db.getObjects(tags.map(tag => `ap:hashtag:${tag}`));
+
+ return records.filter(Boolean);
+};
+
+Hashtags.get = async (tag) => {
+ const exists = await db.sortedSetMember(FOLLOWED_KEY, tag);
+ if (!exists) {
+ return null;
+ }
+ return await db.getObject(`ap:hashtag:${tag}`);
+};
+
+Hashtags.updateState = async (actor, state) => {
+ // Find record by actor URL
+ const tags = await db.getSortedSetMembers(FOLLOWED_KEY);
+ if (!tags.length) {
+ return;
+ }
+
+ const records = await db.getObjects(tags.map(tag => `ap:hashtag:${tag}`));
+ const record = records.find(r => r && r.actor === actor);
+
+ if (!record) {
+ return;
+ }
+
+ await db.setObjectField(`ap:hashtag:${record.tag}`, 'state', state);
+};
+
+Hashtags._migrateRelay = async (oldHost, newHost) => {
+ const tags = await db.getSortedSetMembers(FOLLOWED_KEY);
+ if (!tags.length) {
+ return;
+ }
+
+ const records = await db.getObjects(tags.map(tag => `ap:hashtag:${tag}`));
+
+ await Promise.all(records.map(async (record) => {
+ if (!record || record.relay !== oldHost) {
+ return;
+ }
+
+ const newActor = Hashtags.resolveActor(record.tag, newHost);
+
+ // Undo follow on old actor
+ await activitypub.out.undo.follow('uid', 0, record.actor);
+
+ // Follow on new actor
+ await activitypub.out.follow('uid', 0, newActor);
+
+ // Update record
+ await db.setObject(`ap:hashtag:${record.tag}`, {
+ ...record,
+ relay: newHost,
+ actor: newActor,
+ state: 'pending',
+ });
+ }));
+};
diff --git a/src/activitypub/inbox.js b/src/activitypub/inbox.js
index 7fb308e701..b7313f6d45 100644
--- a/src/activitypub/inbox.js
+++ b/src/activitypub/inbox.js
@@ -891,6 +891,8 @@ inbox.accept = async (req) => {
db.sortedSetAdd('followingRemote:0', timestamp, actor),
db.sortedSetAdd(`followersRemote:${actor}`, timestamp, 0), // for followers backreference
]);
+ // Transition hashtag follow state to active
+ await activitypub.hashtags.updateState(actor, 'active');
}
activitypub.actors._followerCache.del(actor);
@@ -935,6 +937,8 @@ inbox.undo = async (req) => {
db.sortedSetRemove('followRequests:uid.0', actor),
db.sortedSetRemove(`followersRemote:${actor}`, 0),
]);
+ // Transition hashtag follow state to error
+ await activitypub.hashtags.updateState(actor, 'error');
break;
}
@@ -1054,4 +1058,9 @@ inbox.reject = async (req) => {
db.sortedSetRemove('ap:retry:queue', queueId),
db.delete(`ap:retry:queue:${queueId}`),
]);
+
+ // Transition hashtag follow state to error if this is a rejected Follow from instance actor
+ if (type === 'Follow' && id === `${nconf.get('url')}/actor`) {
+ await activitypub.hashtags.updateState(actor, 'error');
+ }
};
diff --git a/src/activitypub/index.js b/src/activitypub/index.js
index 032b8dd3ab..e9611ee58c 100644
--- a/src/activitypub/index.js
+++ b/src/activitypub/index.js
@@ -90,6 +90,7 @@ ActivityPub.blocklists = require('./blocklists');
ActivityPub.feps = require('./feps');
ActivityPub.rules = require('./rules');
ActivityPub.relays = require('./relays');
+ActivityPub.hashtags = require('./hashtags');
ActivityPub.out = require('./out');
ActivityPub.jobs = require('./jobs');
ActivityPub.analytics = require('./analytics');
diff --git a/src/controllers/admin/federation.js b/src/controllers/admin/federation.js
index 747ab1e8b8..eafe67267d 100644
--- a/src/controllers/admin/federation.js
+++ b/src/controllers/admin/federation.js
@@ -131,6 +131,23 @@ async function getActivitiesByType() {
return Object.fromEntries(results.map(({ type, count }) => [type, count]));
}
+federationController.hashtags = async function (req, res) {
+ const hashtags = await activitypub.hashtags.list();
+ const relay = await activitypub.hashtags.getRelay();
+ const relayOptions = activitypub.hashtags.getRelayOptions();
+
+ hashtags.forEach((h) => {
+ h.stateClass = h.state === 'pending' ? 'warning' : (h.state === 'active' ? 'success' : 'danger');
+ });
+
+ res.render('admin/federation/hashtags', {
+ title: '[[admin/menu:federation/hashtags]]',
+ hashtags,
+ relay,
+ relayOptions,
+ });
+};
+
federationController.errors = async function (req, res) {
const { hostname: filterHostname, type: filterType } = req.query;
let errors = await db.getSortedSetRevRangeByScoreWithScores('ap.errors', 0, -1, Date.now(), '-inf');
diff --git a/src/controllers/write/admin.js b/src/controllers/write/admin.js
index 528da657a0..be3a47f660 100644
--- a/src/controllers/write/admin.js
+++ b/src/controllers/write/admin.js
@@ -239,6 +239,45 @@ Admin.activitypub.removeCoreDomain = async (req, res) => {
helpers.formatApiResponse(200, res, await activitypub.blocklists.get('core'));
};
+Admin.activitypub.getHashtags = async (req, res) => {
+ const hashtags = await activitypub.hashtags.list();
+ const relay = await activitypub.hashtags.getRelay();
+ helpers.formatApiResponse(200, res, { hashtags, relay });
+};
+
+Admin.activitypub.addHashtag = async (req, res) => {
+ let { tag } = req.body;
+
+ if (!tag || !tag.trim()) {
+ return helpers.formatApiResponse(400, res);
+ }
+ tag = tag.trim().toLowerCase();
+
+ await activitypub.hashtags.follow(tag);
+ helpers.formatApiResponse(200, res, await activitypub.hashtags.list());
+};
+
+Admin.activitypub.removeHashtag = async (req, res) => {
+ const { tag } = req.params;
+ await activitypub.hashtags.unfollow(tag);
+ helpers.formatApiResponse(200, res, await activitypub.hashtags.list());
+};
+
+Admin.activitypub.getHashtagRelay = async (req, res) => {
+ const relay = await activitypub.hashtags.getRelay();
+ helpers.formatApiResponse(200, res, { relay });
+};
+
+Admin.activitypub.setHashtagRelay = async (req, res) => {
+ const { host } = req.body;
+ if (!host || !host.trim()) {
+ return helpers.formatApiResponse(400, res);
+ }
+
+ await activitypub.hashtags.setRelay(host);
+ helpers.formatApiResponse(200, res, { relay: host });
+};
+
Admin.plugins = {};
Admin.plugins.install = async (req, res) => {
diff --git a/src/routes/admin.js b/src/routes/admin.js
index 75e213a86e..b554b1bff7 100644
--- a/src/routes/admin.js
+++ b/src/routes/admin.js
@@ -58,6 +58,7 @@ module.exports = function (app, name, middleware, controllers) {
helpers.setupAdminPageRoute(app, `/${name}/federation/safety`, middlewares, controllers.admin.federation.safety);
helpers.setupAdminPageRoute(app, `/${name}/federation/analytics`, middlewares, controllers.admin.federation.analytics);
helpers.setupAdminPageRoute(app, `/${name}/federation/errors`, middlewares, controllers.admin.federation.errors);
+ helpers.setupAdminPageRoute(app, `/${name}/federation/hashtags`, middlewares, controllers.admin.federation.hashtags);
helpers.setupAdminPageRoute(app, `/${name}/appearance/themes`, middlewares, controllers.admin.appearance.themes);
helpers.setupAdminPageRoute(app, `/${name}/appearance/skins`, middlewares, controllers.admin.appearance.skins);
diff --git a/src/routes/write/admin.js b/src/routes/write/admin.js
index 136aea64b3..8f4c039cbc 100644
--- a/src/routes/write/admin.js
+++ b/src/routes/write/admin.js
@@ -47,6 +47,12 @@ module.exports = function () {
setupApiRoute(router, 'delete', '/activitypub/blocklists/:url', [...middlewares], controllers.write.admin.activitypub.removeBlocklist);
setupApiRoute(router, 'post', '/activitypub/blocklists/:url/refresh', [...middlewares], controllers.write.admin.activitypub.refreshBlocklist);
+ setupApiRoute(router, 'get', '/activitypub/hashtags', [...middlewares], controllers.write.admin.activitypub.getHashtags);
+ setupApiRoute(router, 'post', '/activitypub/hashtags', [...middlewares, middleware.checkRequired.bind(null, ['tag'])], controllers.write.admin.activitypub.addHashtag);
+ setupApiRoute(router, 'delete', '/activitypub/hashtags/:tag', [...middlewares], controllers.write.admin.activitypub.removeHashtag);
+ setupApiRoute(router, 'get', '/activitypub/hashtags/relay', [...middlewares], controllers.write.admin.activitypub.getHashtagRelay);
+ setupApiRoute(router, 'put', '/activitypub/hashtags/relay', [...middlewares, middleware.checkRequired.bind(null, ['host'])], controllers.write.admin.activitypub.setHashtagRelay);
+
setupApiRoute(router, 'post', '/plugins/:pluginId', [...middlewares, requireAPIReAuth], controllers.write.admin.plugins.install);
setupApiRoute(router, 'delete', '/plugins/:pluginId', [...middlewares], controllers.write.admin.plugins.uninstall);
setupApiRoute(router, 'put', '/plugins/:pluginId/active', [...middlewares, middleware.checkRequired.bind(null, ['active'])], controllers.write.admin.plugins.setActive);
diff --git a/src/views/admin/federation/hashtags.tpl b/src/views/admin/federation/hashtags.tpl
new file mode 100644
index 0000000000..22b3f69faf
--- /dev/null
+++ b/src/views/admin/federation/hashtags.tpl
@@ -0,0 +1,51 @@
+<div class="d-flex flex-column gap-2 px-lg-4">
+ <div component="settings/main/header" class="row border-bottom py-2 m-0 mb-3 sticky-top acp-page-main-header align-items-center">
+ <div class="col-12 col-md-8 px-0 mb-1 mb-md-0">
+ <h4 class="fw-bold tracking-tight mb-0">{{tx(title)}}</h4>
+ </div>
+ </div>
+
+ <div class="row">
+ <div class="col-12">
+ <p>{{tx("admin/settings/activitypub:hashtags.intro")}}</p>
+
+ <div class="mb-4">
+ <div class="mb-3 row">
+ <div class="col-12 col-md-6">
+ <label class="form-label" for="relayHost">{{tx("admin/settings/activitypub:hashtags.relay-host")}}</label>
+ <div class="input-group mb-3">
+ <select class="form-select" id="relayHost">
+ {{{ each relayOptions }}}
+ <option value="{@value}"{{{ if (@value == relay) }}} selected{{{ end }}}>{@value}</option>
+ {{{ end }}}
+ </select>
+ <button class="btn btn-sm btn-primary" data-action="hashtags.setRelay">{{tx("admin/settings/activitypub:hashtags.save-relay")}}</button>
+ </div>
+ <div class="form-text">{{tx("admin/settings/activitypub:hashtags.relay-host-help")}}</div>
+ <div class="form-text text-warning">{{tx("admin/settings/activitypub:hashtags.relay-change-warning")}}</div>
+ </div>
+ </div>
+ </div>
+
+ <div class="mb-3 table-responsive">
+ <table class="table table-striped" id="hashtags">
+ <thead>
+ <th>{{tx("admin/settings/activitypub:hashtags.table.tag")}}</th>
+ <th>{{tx("admin/settings/activitypub:hashtags.table.state")}}</th>
+ <th></th>
+ </thead>
+ <tbody component="hashtags/list">
+ <!-- IMPORT admin/partials/activitypub/hashtags/list.tpl -->
+ </tbody>
+ <tfoot>
+ <tr>
+ <td colspan="3">
+ <button class="btn btn-sm btn-primary" data-action="hashtags.add">{{tx("admin/settings/activitypub:hashtags.follow")}}</button>
+ </td>
+ </tr>
+ </tfoot>
+ </table>
+ </div>
+ </div>
+ </div>
+</div>
diff --git a/src/views/admin/partials/activitypub/hashtags.tpl b/src/views/admin/partials/activitypub/hashtags.tpl
new file mode 100644
index 0000000000..5461cf8706
--- /dev/null
+++ b/src/views/admin/partials/activitypub/hashtags.tpl
@@ -0,0 +1,7 @@
+<form role="form" id="hashtagForm">
+ <div class="mb-3">
+ <label class="form-label" for="hashtagTag">{{tx("admin/settings/activitypub:hashtags.modal.tag")}}</label>
+ <input type="text" id="hashtagTag" name="tag" class="form-control" placeholder="nodebb" required />
+ <div class="form-text">{{tx("admin/settings/activitypub:hashtags.modal.tag-help")}}</div>
+ </div>
+</form>
diff --git a/src/views/admin/partials/activitypub/hashtags/list.tpl b/src/views/admin/partials/activitypub/hashtags/list.tpl
new file mode 100644
index 0000000000..a1ccdee2ae
--- /dev/null
+++ b/src/views/admin/partials/activitypub/hashtags/list.tpl
@@ -0,0 +1,11 @@
+{{{ each hashtags }}}
+<tr data-tag="{./tag}">
+ <td><code>#{{./tag}}</code></td>
+ <td>
+ <span class="badge bg-{./stateClass}" title="{tx("admin/settings/activitypub:hashtags.state-{./state}")}">
+ {tx("admin/settings/activitypub:hashtags.state-{./state}")}
+ </span>
+ </td>
+ <td><a href="#" data-action="hashtags.remove" data-tag="{./tag}"><i class="fa fa-trash link-danger"></i></a></td>
+</tr>
+{{{ end }}}
diff --git a/src/views/admin/partials/navigation.tpl b/src/views/admin/partials/navigation.tpl
index e652cf7d82..4a1626008b 100644
--- a/src/views/admin/partials/navigation.tpl
+++ b/src/views/admin/partials/navigation.tpl
@@ -107,6 +107,7 @@
<a class="btn btn-ghost btn-sm text-start" id="federation-content" href="{relative_path}/admin/federation/content">{{tx("admin/menu:federation/content")}}</a>
<a class="btn btn-ghost btn-sm text-start" id="federation-rules" href="{relative_path}/admin/federation/rules">{{tx("admin/menu:federation/rules")}}</a>
<a class="btn btn-ghost btn-sm text-start" id="federation-relays" href="{relative_path}/admin/federation/relays">{{tx("admin/menu:federation/relays")}}</a>
+ <a class="btn btn-ghost btn-sm text-start" id="federation-hashtags" href="{relative_path}/admin/federation/hashtags">{{tx("admin/menu:federation/hashtags")}}</a>
<a class="btn btn-ghost btn-sm text-start" id="federation-pruning" href="{relative_path}/admin/federation/pruning">{{tx("admin/menu:federation/pruning")}}</a>
<a class="btn btn-ghost btn-sm text-start" id="federation-safety" href="{relative_path}/admin/federation/safety">{{tx("admin/menu:federation/safety")}}</a>
<a class="btn btn-ghost btn-sm text-start" id="federation-analytics" href="{relative_path}/admin/federation/analytics">{{tx("admin/menu:federation/analytics")}}</a>