feat: restore compatibility with v2.x (tested with v2.8.x)

Author: julianlam

lib/controllers.js

@@ -24,6 +24,12 @@ Controllers.renderSettings = async function (req, res) {
 	payload.title = '[[ntfy:profile.label]]';
 	payload.breadcrumbs = helpers.buildBreadcrumbs([{ text: username, url: `/user/${userslug}` }, { text: payload.title }]);
 
+	// v2 compatibility
+	if (nconf.get('version').startsWith('2')) {
+		const v2payload = { ...res.locals.templateValues, ...payload };
+		return res.render('account/ntfy-v2', v2payload);
+	}
+
 	res.render('account/ntfy', payload);
 };
 

library.js

@@ -22,9 +22,19 @@ plugin.init = async (params) => {
 		middleware.ensureLoggedIn,
 		middleware.canViewUsers,
 		middleware.checkAccountPermissions,
-		middleware.buildAccountData,
 	];
 
+	// v2 compatibility
+	if (!nconf.get('version').startsWith('2')) {
+		accountMiddlewares.push(middleware.buildAccountData);
+	} else {
+		const accountHelpers = require.main.require('./src/controllers/accounts/helpers');
+		accountMiddlewares.push(async (req, res, next) => {
+			res.locals.templateValues = await accountHelpers.getUserDataByUserSlug(req.params.userslug, req.uid, req.query);
+			next();
+		});
+	}
+
 	routeHelpers.setupPageRoute(router, '/user/:userslug/ntfy', accountMiddlewares, controllers.renderSettings);
 };
 

package.json

@@ -31,7 +31,7 @@
   },
   "readmeFilename": "README.md",
   "nbbpm": {
-    "compatibility": "^3.0.0"
+    "compatibility": "^2.8.x || ^3.0.0"
   },
   "devDependencies": {
     "@commitlint/cli": "17.6.6",

plugin.json

@@ -12,6 +12,9 @@
 	"staticDirs": {
 		"static": "./static"
 	},
+	"scripts": [
+		"static/lib/main.js"
+	],
 	"modules": {
 		"../client/account/ntfy.js": "./static/lib/modules/settings.js",
 		"../admin/plugins/ntfy.js": "./static/lib/admin.js"

static/lib/main.js

@@ -0,0 +1,13 @@
+'use strict';
+
+(async () => {
+	const hooks = await app.require('hooks');
+
+	hooks.on('filter:script.load', ({ tpl_url, scripts }) => {
+		if (tpl_url === 'account/ntfy-v2') {
+			scripts.splice(scripts.indexOf('forum/account/ntfy-v2'), 1, 'forum/account/ntfy');
+		}
+
+		return { tpl_url, scripts };
+	});
+})();

static/templates/account/ntfy-v2.tpl

@@ -0,0 +1,42 @@
+<div class="account">
+	<!-- IMPORT partials/account/header.tpl -->
+
+	<div class="row">
+		<div class="panel panel-default col-xs-12 col-lg-offset-2 col-lg-8" style="margin-top: 1rem;">
+			<div class="panel-body">
+				<p>
+					<a href="https://play.google.com/store/apps/details?id=io.heckel.ntfy">
+						<img src="https://docs.ntfy.sh/static/img/badge-googleplay.png">
+					</a>
+					<a href="https://f-droid.org/en/packages/io.heckel.ntfy/">
+						<img src="https://docs.ntfy.sh/static/img/badge-fdroid.png">
+					</a>
+					<a href="https://apps.apple.com/us/app/ntfy/id1625396347">
+						<img src="https://docs.ntfy.sh/static/img/badge-appstore.png">
+					</a>
+				</p>
+				<p>
+					A mobile device is not necessary, <a href="https://docs.ntfy.sh/subscribe/web/">you can also subscribe to push notifications via your browser.</a>
+				</p>
+
+				<hr />
+
+				<p><strong>Your private push notification "topic name" is:</strong></p>
+				<div class="input-group" style="margin-bottom: 1rem;">
+					<input id="topic" type="text" class="form-control" value="{ntfyTopic}" readonly />
+					<span class="input-group-btn">
+						<a class="btn btn-success" href="{ntfyUrl}">[[ntfy:profile.subscribe]]</a>
+					</span>
+				</div>
+				<!-- TODO: separate server url if specified in ACP -->
+				<p>
+					<em>Treat this topic name like a password!</em>
+				</p>
+				<p>
+					If the topic name is leaked, it can be used by others to receive your notifications.
+				</p>
+				<button class="btn btn-primary" data-action="test">[[ntfy:profile.test]]</button>
+				<button class="btn btn-danger" data-action="regenerate">[[ntfy:profile.regenerate]]</button>
+			</div>
+		</div>
+	</div>