Skip to content

Node.js based forum software built for the modern web

refactor: move plugin install/uninstall/activate/upgrade calls

Barış Soner Uşaklı22dc21622a67
diff --git a/public/openapi/write.yaml b/public/openapi/write.yaml
index 2b8e2c2be1..6b9d8094cc 100644
--- a/public/openapi/write.yaml
+++ b/public/openapi/write.yaml
@@ -314,6 +314,12 @@ paths:
$ref: 'write/admin/activitypub/blocklists/url.yaml'
/admin/activitypub/blocklists/{url}/refresh:
$ref: 'write/admin/activitypub/blocklists/url/refresh.yaml'
+ /admin/plugins/{pluginId}:
+ $ref: 'write/admin/plugins/pluginId.yaml'
+ /admin/plugins/{pluginId}/active:
+ $ref: 'write/admin/plugins/pluginId/active.yaml'
+ /admin/plugins/{pluginId}/upgrade:
+ $ref: 'write/admin/plugins/pluginId/upgrade.yaml'
/files/:
$ref: 'write/files.yaml'
/files/folder:
diff --git a/public/openapi/write/admin/plugins/pluginId.yaml b/public/openapi/write/admin/plugins/pluginId.yaml
new file mode 100644
index 0000000000..8f41761ad0
--- /dev/null
+++ b/public/openapi/write/admin/plugins/pluginId.yaml
@@ -0,0 +1,67 @@
+post:
+ tags:
+ - admin
+ summary: install a plugin
+ description: This operation installs a nodebb plugin
+ parameters:
+ - in: path
+ name: pluginId
+ schema:
+ type: string
+ required: true
+ description: a nodebb plugin id
+ example: nodebb-plugin-imgur
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ required:
+ - version
+ properties:
+ version:
+ type: string
+ responses:
+ '200':
+ description: plugin succesfully installed
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ status:
+ $ref: ../../../components/schemas/Status.yaml#/Status
+ response:
+ type: object
+ '400':
+ $ref: ../../../components/responses/400.yaml#/400
+ '401':
+ $ref: ../../../components/responses/401.yaml#/401
+delete:
+ tags:
+ - admin
+ summary: uninstall a plugin
+ description: This operation uninstalls a nodebb plugin
+ parameters:
+ - in: path
+ name: pluginId
+ schema:
+ type: string
+ required: true
+ description: a nodebb plugin id
+ example: nodebb-plugin-imgur
+ responses:
+ '200':
+ description: plugin succesfully uninstalled
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ status:
+ $ref: ../../../components/schemas/Status.yaml#/Status
+ response:
+ type: object
+ '400':
+ $ref: ../../../components/responses/400.yaml#/400
diff --git a/public/openapi/write/admin/plugins/pluginId/active.yaml b/public/openapi/write/admin/plugins/pluginId/active.yaml
new file mode 100644
index 0000000000..11ceb512dc
--- /dev/null
+++ b/public/openapi/write/admin/plugins/pluginId/active.yaml
@@ -0,0 +1,38 @@
+put:
+ tags:
+ - admin
+ summary: activate or deactivate a plugin
+ description: This operation activates or deactivates a nodebb plugin
+ parameters:
+ - in: path
+ name: pluginId
+ schema:
+ type: string
+ required: true
+ description: a nodebb plugin id
+ example: nodebb-plugin-imgur
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ required:
+ - active
+ properties:
+ active:
+ type: boolean
+ responses:
+ '200':
+ description: plugin succesfully activated or deactivated
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ status:
+ $ref: ../../../../components/schemas/Status.yaml#/Status
+ response:
+ type: object
+ '400':
+ $ref: ../../../../components/responses/400.yaml#/400
\ No newline at end of file
diff --git a/public/openapi/write/admin/plugins/pluginId/upgrade.yaml b/public/openapi/write/admin/plugins/pluginId/upgrade.yaml
new file mode 100644
index 0000000000..dff9dce272
--- /dev/null
+++ b/public/openapi/write/admin/plugins/pluginId/upgrade.yaml
@@ -0,0 +1,38 @@
+put:
+ tags:
+ - admin
+ summary: upgrade a plugin
+ description: This operation upgrades a nodebb plugin to the supplied version
+ parameters:
+ - in: path
+ name: pluginId
+ schema:
+ type: string
+ required: true
+ description: a nodebb plugin id
+ example: nodebb-plugin-imgur
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ required:
+ - version
+ properties:
+ version:
+ type: string
+ responses:
+ '200':
+ description: plugin succesfully upgraded
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ status:
+ $ref: ../../../../components/schemas/Status.yaml#/Status
+ response:
+ type: object
+ '400':
+ $ref: ../../../../components/responses/400.yaml#/400
\ No newline at end of file
diff --git a/public/src/admin/extend/plugins.js b/public/src/admin/extend/plugins.js
index e09b61ed80..5134d2c467 100644
--- a/public/src/admin/extend/plugins.js
+++ b/public/src/admin/extend/plugins.js
@@ -2,20 +2,25 @@
define('admin/extend/plugins', [
+ 'api',
'translator',
'modals',
'alerts',
'helpers',
'benchpress',
+ 'compare-versions',
+ 'storage',
'jquery-ui/widgets/sortable',
-], function (translator, modals, alerts, helpers, Benchpress) {
+], function (api, translator, modals, alerts, helpers, Benchpress, compareVersions, storage) {
const Plugins = {};
Plugins.init = function () {
const pluginsList = $('.plugins');
let pluginID;
- if (window.location.hash) {
- $(`.nav-pills button[data-bs-target="${window.location.hash}"]`).trigger('click');
+ const targetHash = window.location.hash || storage.getItem('location-hash');
+ storage.removeItem('location-hash');
+ if (targetHash) {
+ $(`.nav-pills button[data-bs-target="${targetHash}"]`).trigger('click');
}
$('#plugin-tabs').on('shown.bs.tab', function (ev) {
@@ -31,6 +36,7 @@ define('admin/extend/plugins', [
const pluginEl = $(this).parents('li');
pluginID = pluginEl.attr('data-plugin-id');
const btn = $(this);
+ const activeState = parseInt(btn.attr('data-active-state'), 10);
const pluginData = ajaxify.data.installed.find(plugin => plugin.id === pluginID);
if (!pluginData) {
@@ -38,26 +44,23 @@ define('admin/extend/plugins', [
}
function toggleActivate() {
- socket.emit('admin.plugins.toggleActive', pluginID, function (err, status) {
- if (err) {
- return alerts.error(err);
- }
+ api.put(`/admin/plugins/${encodeURIComponent(pluginID)}/active`, { active: activeState }).then(() => {
btn.siblings('[data-action="toggleActive"]').removeClass('hidden');
btn.addClass('hidden');
// clone it to active plugins tab
- if (status.active && !$('#active [id="' + pluginID + '"]').length) {
+ if (activeState && !$('#active [id="' + pluginID + '"]').length) {
$('#active ul').prepend(pluginEl.clone(true));
}
// Toggle active state in template data
- pluginData.active = !pluginData.active;
+ pluginData.active = activeState === 1;
alerts.alert({
alert_id: 'plugin_toggled',
- title: '[[admin/extend/plugins:alert.' + (status.active ? 'enabled' : 'disabled') + ']]',
- message: '[[admin/extend/plugins:alert.' + (status.active ? 'activate-success' : 'deactivate-success') + ']]',
- type: status.active ? 'warning' : 'success',
+ title: '[[admin/extend/plugins:alert.' + (activeState ? 'enabled' : 'disabled') + ']]',
+ message: '[[admin/extend/plugins:alert.' + (activeState ? 'activate-success' : 'deactivate-success') + ']]',
+ type: activeState ? 'warning' : 'success',
timeout: 5000,
clickfn: function () {
require(['admin/modules/instance'], function (instance) {
@@ -65,7 +68,7 @@ define('admin/extend/plugins', [
});
},
});
- });
+ }).catch(alerts.error);
}
if (pluginData.license && pluginData.active !== true) {
@@ -98,68 +101,58 @@ define('admin/extend/plugins', [
}
});
- pluginsList.on('click', 'button[data-action="toggleInstall"]', function () {
+ pluginsList.on('click', 'button[data-action="toggleInstall"]', async function () {
const btn = $(this);
btn.attr('disabled', true);
pluginID = $(this).parents('li').attr('data-plugin-id');
if ($(this).attr('data-installed') === '1') {
- return Plugins.toggleInstall(pluginID, $(this).parents('li').attr('data-version'));
+ return Plugins.uninstallPlugin(pluginID);
}
- Plugins.suggest(pluginID, function (err, payload) {
- if (err) {
- modals.confirm(translator.compile('admin/extend/plugins:alert.suggest-error', err.status, err.responseText), function (confirm) {
- if (confirm) {
- Plugins.toggleInstall(pluginID, 'latest');
- } else {
- btn.removeAttr('disabled');
- }
- });
- return;
- }
-
+ try {
+ const payload = await Plugins.suggest(pluginID);
if (payload.version === null || payload.version === 'latest') {
- confirmInstall(pluginID, function (confirm) {
- if (confirm) {
- Plugins.toggleInstall(pluginID, 'latest');
- } else {
- btn.removeAttr('disabled');
- }
- });
+ const confirm = await confirmInstall(pluginID);
+ if (confirm) {
+ Plugins.installPlugin(pluginID, 'latest');
+ }
} else if (payload.version) {
- Plugins.toggleInstall(pluginID, payload.version);
- } else {
- btn.removeAttr('disabled');
+ Plugins.installPlugin(pluginID, payload.version);
}
- });
+ } catch (err) {
+ const confirm = await confirmAsync(translator.compile('admin/extend/plugins:alert.suggest-error', err.status, err.responseText));
+ if (confirm) {
+ Plugins.installPlugin(pluginID, 'latest');
+ }
+ } finally {
+ btn.removeAttr('disabled');
+ }
});
- pluginsList.on('click', 'button[data-action="upgrade"]', function () {
+ pluginsList.on('click', 'button[data-action="upgrade"]', async function () {
const btn = $(this);
const parent = btn.parents('li');
pluginID = parent.attr('data-plugin-id');
-
- Plugins.suggest(pluginID, function (err, payload) {
- if (err) {
- return modals.alert('[[admin/extend/plugins:alert.package-manager-unreachable]]');
+ try {
+ const payload = await Plugins.suggest(pluginID);
+ const currentVersion = parent.find('.currentVersion').text();
+ if (payload.version && payload.version !== 'latest' && compareVersions.compare(payload.version, currentVersion, '>')) {
+ upgrade(pluginID, btn, payload.version);
+ } else if (payload.version === 'latest' || payload.version === null) {
+ confirmInstall(pluginID, function (confirm) {
+ if (confirm) {
+ upgrade(pluginID, btn, payload.version);
+ }
+ });
+ } else {
+ modals.alert(
+ translator.compile('admin/extend/plugins:alert.incompatible', app.config.version, payload.version)
+ );
}
-
- require(['compare-versions'], function (compareVersions) {
- const currentVersion = parent.find('.currentVersion').text();
- if (payload.version && payload.version !== 'latest' && compareVersions.compare(payload.version, currentVersion, '>')) {
- upgrade(pluginID, btn, payload.version);
- } else if (payload.version === 'latest' || payload.version === null) {
- confirmInstall(pluginID, function (confirm) {
- if (confirm) {
- upgrade(pluginID, btn, payload.version);
- }
- });
- } else {
- modals.alert(translator.compile('admin/extend/plugins:alert.incompatible', app.config.version, payload.version));
- }
- });
- });
+ } catch (err) {
+ modals.alert('[[admin/extend/plugins:alert.package-manager-unreachable]]');
+ }
});
$(searchInputEl).on('input propertychange', utils.debounce(function () {
@@ -274,21 +267,21 @@ define('admin/extend/plugins', [
$('#download ul').html(html);
}
- function confirmInstall(pluginID, callback) {
- modals.confirm(translator.compile('admin/extend/plugins:alert.possibly-incompatible', pluginID), function (confirm) {
- callback(confirm);
+ function confirmAsync(text) {
+ return new Promise((resolve) => {
+ modals.confirm(text, resolve);
});
}
+ function confirmInstall(pluginID) {
+ return confirmAsync(translator.compile('admin/extend/plugins:alert.possibly-incompatible', pluginID));
+ }
+
function upgrade(pluginID, btn, version) {
btn.attr('disabled', true).find('i').attr('class', 'fa fa-refresh fa-spin');
- socket.emit('admin.plugins.upgrade', {
- id: pluginID,
+ api.put(`/admin/plugins/${encodeURIComponent(pluginID)}/upgrade`, {
version: version,
- }, function (err, isActive) {
- if (err) {
- return alerts.error(err);
- }
+ }).then((isActive) => {
const parent = btn.parents('li');
parent.find('.fa-exclamation-triangle').remove();
parent.find('.currentVersion').text(version);
@@ -307,58 +300,64 @@ define('admin/extend/plugins', [
},
});
}
- });
+ }).catch(alerts.error);
}
- Plugins.toggleInstall = function (pluginID, version, callback) {
- const btn = $('li[data-plugin-id="' + pluginID + '"] button[data-action="toggleInstall"]');
+ Plugins.installPlugin = function (pluginID, version) {
+ const btn = $(`li[data-plugin-id="${pluginID}"] button[data-action="toggleInstall"]`);
btn.find('i').attr('class', 'fa fa-refresh fa-spin');
- socket.emit('admin.plugins.toggleInstall', {
- id: pluginID,
+ api.post(`/admin/plugins/${encodeURIComponent(pluginID)}`, {
version: version,
- }, function (err, pluginData) {
- if (err) {
- btn.removeAttr('disabled');
- return alerts.error(err);
- }
- function removeAndUpdateBadge(section) {
+ }).then(() => {
+ ajaxify.refresh();
+
+ alerts.alert({
+ alert_id: 'plugin_toggled',
+ title: '[[admin/extend/plugins:alert.installed]]',
+ message: '[[admin/extend/plugins:alert.install-success]]',
+ type: 'info',
+ timeout: 10000,
+ });
+ }).catch((err) => {
+ btn.removeAttr('disabled');
+ alerts.error(err);
+ });
+ };
+
+ Plugins.uninstallPlugin = function (pluginID) {
+ const btn = $(`li[data-plugin-id="${pluginID}"] button[data-action="toggleInstall"]`);
+ btn.find('i').attr('class', 'fa fa-refresh fa-spin');
+
+ api.del(`/admin/plugins/${encodeURIComponent(pluginID)}`).then(() => {
+ ['#installed', '#active', '#deactive', '#upgrade'].forEach(function removeAndUpdateBadge(section) {
$(`${section} [data-plugin-id="${pluginID}"]`).remove();
const count = $(`${section} [data-plugin-id]`).length;
$(`[data-bs-target="${section}"] .badge`).text(count);
- }
- if (!pluginData.installed) {
- ['#installed', '#active', '#deactive', '#upgrade'].forEach(removeAndUpdateBadge);
- } else {
- ajaxify.refresh();
- }
-
+ });
alerts.alert({
alert_id: 'plugin_toggled',
- title: '[[admin/extend/plugins:alert.' + (pluginData.installed ? 'installed' : 'uninstalled') + ']]',
- message: '[[admin/extend/plugins:alert.' + (pluginData.installed ? 'install-success' : 'uninstall-success') + ']]',
+ title: '[[admin/extend/plugins:alert.uninstalled]]',
+ message: '[[admin/extend/plugins:alert.uninstall-success]]',
type: 'info',
timeout: 5000,
});
-
- if (typeof callback === 'function') {
- callback.apply(this, arguments);
- }
+ }).catch((err) => {
+ btn.removeAttr('disabled');
+ alerts.error(err);
});
};
- Plugins.suggest = function (pluginId, callback) {
+ Plugins.suggest = function (pluginId) {
const nbbVersion = app.config.version.match(/^\d+\.\d+\.\d+/);
- $.ajax((app.config.registry || 'https://packages.nodebb.org') + '/api/v1/suggest', {
+ return $.ajax((app.config.registry || 'https://packages.nodebb.org') + '/api/v1/suggest', {
type: 'GET',
data: {
package: pluginId,
version: nbbVersion[0],
},
dataType: 'json',
- }).done(function (payload) {
- callback(undefined, payload);
- }).fail(callback);
+ });
};
return Plugins;
diff --git a/public/src/admin/manage/users.js b/public/src/admin/manage/users.js
index 9312344d6b..7e36b1a0e5 100644
--- a/public/src/admin/manage/users.js
+++ b/public/src/admin/manage/users.js
@@ -55,18 +55,11 @@ define('admin/manage/users', [
selected: false,
})));
- const options = defaultFields.map((field, i) => (`
- <div class="form-check mb-2">
- <input data-field="${field.field}" class="form-check-input" type="checkbox" id="option-${i}" ${field.selected ? 'checked' : ''}>
- <label class="form-check-label" for="option-${i}">
- ${field.label}
- </label>
- </div>`
- )).join('');
+ const html = await Benchpress.render('admin/partials/export-users-csv', { options: defaultFields });
const modal = await modals.dialog({
- message: options,
title: '[[admin/manage/users:export-users-fields-title]]',
+ message: html,
buttons: {
submit: {
label: '[[admin/manage/users:export]]',
diff --git a/public/src/modules/api.js b/public/src/modules/api.js
index 2d60c6b791..4252e39d03 100644
--- a/public/src/modules/api.js
+++ b/public/src/modules/api.js
@@ -3,6 +3,7 @@
import { fire as fireHook } from 'hooks';
import { confirm } from 'modals';
import * as translator from 'translator';
+import * as storage from 'storage';
const baseUrl = config.relative_path + '/api/v3';
@@ -30,6 +31,7 @@ async function call(options, callback) {
const message = await translator.translate('[[error:api.reauth-required]]', config.userLang);
confirm(message, (ok) => {
if (ok) {
+ storage.setItem('location-hash', window.location.hash);
ajaxify.go(url);
}
});
diff --git a/src/api/admin.js b/src/api/admin.js
index 1b52ccd1ba..a9d8be8259 100644
--- a/src/api/admin.js
+++ b/src/api/admin.js
@@ -1,9 +1,14 @@
'use strict';
+const nconf = require('nconf');
+
const meta = require('../meta');
const analytics = require('../analytics');
const privileges = require('../privileges');
const groups = require('../groups');
+const plugins = require('../plugins');
+const events = require('../events');
+const postsCache = require('../posts/cache');
const adminApi = module.exports;
@@ -43,3 +48,87 @@ adminApi.listGroups = async () => {
const payload = await groups.getNonPrivilegeGroups('groups:createtime', 0, -1, { ephemeral: false });
return { groups: payload };
};
+adminApi.plugins = {};
+adminApi.plugins.install = async (caller, { id, version }) => {
+ if (!id || !version) {
+ throw new Error('[[error:invalid-data]]');
+ }
+ if (await plugins.isSystemPlugin(id)) {
+ throw new Error('[[error:cannot-install-system-plugin]]');
+ }
+
+ const isStarterPlan = nconf.get('saas_plan') === 'starter';
+ if (isStarterPlan || nconf.get('acpPluginInstallDisabled')) {
+ throw new Error('[[error:plugin-installation-via-acp-disabled]]');
+ }
+
+ postsCache.reset();
+
+ await plugins.checkWhitelist(id, version);
+ await plugins.toggleInstall(id, version, 'install');
+ await events.log({
+ type: 'plugin-install',
+ text: id,
+ version: version,
+ uid: caller.uid,
+ });
+};
+
+adminApi.plugins.uninstall = async (caller, { id }) => {
+ if (!id) {
+ throw new Error('[[error:invalid-data]]');
+ }
+ if (await plugins.isSystemPlugin(id)) {
+ throw new Error('[[error:cannot-uninstall-system-plugin]]');
+ }
+ const isInstalled = await plugins.isInstalled(id);
+ if (!isInstalled) {
+ throw new Error('[[error:plugin-not-installed]]');
+ }
+ const isStarterPlan = nconf.get('saas_plan') === 'starter';
+ if (isStarterPlan || nconf.get('acpPluginInstallDisabled')) {
+ throw new Error('[[error:plugin-installation-via-acp-disabled]]');
+ }
+
+ postsCache.reset();
+
+ await plugins.toggleInstall(id, '', 'uninstall');
+ await events.log({
+ type: 'plugin-uninstall',
+ text: id,
+ uid: caller.uid,
+ });
+};
+
+adminApi.plugins.setActive = async (caller, { id, active }) => {
+ if (await plugins.isSystemPlugin(id)) {
+ throw new Error('[[error:cannot-toggle-system-plugin]]');
+ }
+ postsCache.reset();
+ const data = await plugins.toggleActive(id, active);
+ await events.log({
+ type: `plugin-${data.active ? 'activate' : 'deactivate'}`,
+ text: id,
+ uid: caller.uid,
+ });
+ return data;
+};
+
+adminApi.plugins.upgrade = async (caller, { id, version}) => {
+ if (!id || !version) {
+ throw new Error('[[error:invalid-data]]');
+ }
+ if (await plugins.isSystemPlugin(id)) {
+ throw new Error('[[error:cannot-upgrade-system-plugin]]');
+ }
+ const isInstalled = await plugins.isInstalled(id);
+ if (!isInstalled) {
+ throw new Error('[[error:plugin-not-installed]]');
+ }
+ if (nconf.get('acpPluginInstallDisabled')) {
+ throw new Error('[[error:plugin-installation-via-acp-disabled]]');
+ }
+
+ await plugins.checkWhitelist(id, version);
+ return await plugins.upgrade(id, version);
+};
\ No newline at end of file
diff --git a/src/controllers/write/admin.js b/src/controllers/write/admin.js
index 3eea8a8e85..528da657a0 100644
--- a/src/controllers/write/admin.js
+++ b/src/controllers/write/admin.js
@@ -238,3 +238,25 @@ Admin.activitypub.removeCoreDomain = async (req, res) => {
await activitypub.blocklists.core.remove(domain);
helpers.formatApiResponse(200, res, await activitypub.blocklists.get('core'));
};
+
+Admin.plugins = {};
+
+Admin.plugins.install = async (req, res) => {
+ await api.admin.plugins.install(req, { id: req.params.pluginId, version: req.body.version });
+ helpers.formatApiResponse(200, res);
+};
+
+Admin.plugins.uninstall = async (req, res) => {
+ await api.admin.plugins.uninstall(req, { id: req.params.pluginId });
+ helpers.formatApiResponse(200, res);
+};
+
+Admin.plugins.setActive = async (req, res) => {
+ await api.admin.plugins.setActive(req, { id: req.params.pluginId, active: req.body.active });
+ helpers.formatApiResponse(200, res);
+};
+
+Admin.plugins.upgrade = async (req, res) => {
+ await api.admin.plugins.upgrade(req, { id: req.params.pluginId, version: req.body.version });
+ helpers.formatApiResponse(200, res);
+};
\ No newline at end of file
diff --git a/src/plugins/install.js b/src/plugins/install.js
index 5aa334dbfa..4c5cd2031f 100644
--- a/src/plugins/install.js
+++ b/src/plugins/install.js
@@ -46,7 +46,7 @@ module.exports = function (Plugins) {
pubsub.on('plugins:toggleInstall', async (data) => {
if (data.hostname !== os.hostname()) {
try {
- await toggleInstall(data.id, data.version);
+ await toggleInstall(data.id, data.version, data.type);
} catch (err) {
winston.error(err.stack);
}
@@ -64,7 +64,7 @@ module.exports = function (Plugins) {
});
}
- Plugins.toggleActive = async function (id) {
+ Plugins.toggleActive = async function (id, active) {
if (nconf.get('plugins:active')) {
winston.error('Cannot activate plugins while plugin state is set in the configuration (config.json, environmental variables or terminal arguments), please modify the configuration instead');
throw new Error('[[error:plugins-set-in-configuration]]');
@@ -72,18 +72,21 @@ module.exports = function (Plugins) {
if (!pluginNamePattern.test(id)) {
throw new Error('[[error:invalid-plugin-id]]');
}
- const isActive = await Plugins.isActive(id);
- if (isActive) {
+ if (typeof active === 'string') {
+ active = active === '1';
+ }
+ const isActivating = active ?? !await Plugins.isActive(id);
+ if (!isActivating) {
await db.sortedSetRemove('plugins:active', id);
} else {
const count = await db.sortedSetCard('plugins:active');
await db.sortedSetAdd('plugins:active', count, id);
}
- cache.set(`plugin:isActive:${id}`, !isActive);
+ cache.set(`plugin:isActive:${id}`, isActivating);
meta.reloadRequired = true;
- const hook = isActive ? 'deactivate' : 'activate';
+ const hook = isActivating ? 'activate' : 'deactivate';
Plugins.hooks.fire(`action:plugin.${hook}`, { id: id });
- return { id: id, active: !isActive };
+ return { id: id, active: isActivating };
};
Plugins.checkWhitelist = async function (id, version) {
@@ -106,28 +109,32 @@ module.exports = function (Plugins) {
return body;
};
- Plugins.toggleInstall = async function (id, version) {
+ Plugins.toggleInstall = async function (id, version, type) {
if (!pluginNamePattern.test(id)) {
throw new Error('[[error:invalid-plugin-id]]');
}
- pubsub.publish('plugins:toggleInstall', { hostname: os.hostname(), id: id, version: version });
- return await toggleInstall(id, version);
+ pubsub.publish('plugins:toggleInstall', { hostname: os.hostname(), id, version, type });
+ return await toggleInstall(id, version, type);
};
const runPackageManagerCommandAsync = util.promisify(runPackageManagerCommand);
- async function toggleInstall(id, version) {
+ async function toggleInstall(id, version, type) {
const [installed, active] = await Promise.all([
Plugins.isInstalled(id),
Plugins.isActive(id),
]);
- const type = installed ? 'uninstall' : 'install';
+ if (type && type !== 'install' && type !== 'uninstall') {
+ throw new Error('[[error:invalid-data]]');
+ }
+ type = type ?? (installed ? 'uninstall' : 'install');
if (active && !nconf.get('plugins:active')) {
await Plugins.toggleActive(id);
}
+
await runPackageManagerCommandAsync(type, id, version || 'latest');
const pluginData = await Plugins.get(id);
- Plugins.hooks.fire(`action:plugin.${type}`, { id: id, version: version });
+ Plugins.hooks.fire(`action:plugin.${type}`, { id, version });
return pluginData;
}
diff --git a/src/privileges/admin.js b/src/privileges/admin.js
index ae8fdf7881..97beafbcfe 100644
--- a/src/privileges/admin.js
+++ b/src/privileges/admin.js
@@ -93,19 +93,12 @@ privsAdmin.socketMap = {
'admin.categories.copyPrivilegesFrom': 'admin:privileges',
'admin.categories.copyPrivilegesToAllCategories': 'admin:privileges',
- 'admin.user.makeAdmins': 'admin:admins-mods',
- 'admin.user.removeAdmins': 'admin:admins-mods',
-
'admin.user.loadGroups': 'admin:users',
- 'admin.user.saveCustomFields': 'admin:users',
- 'admin.groups.join': 'admin:users',
- 'admin.groups.leave': 'admin:users',
'admin.user.resetLockouts': 'admin:users',
'admin.user.validateEmail': 'admin:users',
'admin.user.sendValidationEmail': 'admin:users',
'admin.user.sendPasswordResetEmail': 'admin:users',
'admin.user.forcePasswordReset': 'admin:users',
- 'admin.user.invite': 'admin:users',
'admin.tags.create': 'admin:tags',
'admin.tags.rename': 'admin:tags',
diff --git a/src/routes/write/admin.js b/src/routes/write/admin.js
index 8033b92050..136aea64b3 100644
--- a/src/routes/write/admin.js
+++ b/src/routes/write/admin.js
@@ -47,5 +47,10 @@ 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, '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);
+ setupApiRoute(router, 'put', '/plugins/:pluginId/upgrade', [...middlewares], controllers.write.admin.plugins.upgrade);
+
return router;
};
diff --git a/src/socket.io/admin/plugins.js b/src/socket.io/admin/plugins.js
index 762470b7ef..65ed63f42b 100644
--- a/src/socket.io/admin/plugins.js
+++ b/src/socket.io/admin/plugins.js
@@ -3,48 +3,11 @@
const nconf = require('nconf');
const plugins = require('../../plugins');
-const events = require('../../events');
const db = require('../../database');
-const postsCache = require('../../posts/cache');
const { pluginNamePattern } = require('../../constants');
const Plugins = module.exports;
-Plugins.toggleActive = async function (socket, plugin_id) {
- if (await plugins.isSystemPlugin(plugin_id)) {
- throw new Error('[[error:cannot-toggle-system-plugin]]');
- }
- postsCache.reset();
- const data = await plugins.toggleActive(plugin_id);
- await events.log({
- type: `plugin-${data.active ? 'activate' : 'deactivate'}`,
- text: plugin_id,
- uid: socket.uid,
- });
- return data;
-};
-
-Plugins.toggleInstall = async function (socket, data) {
- if (await plugins.isSystemPlugin(data.id)) {
- throw new Error('[[error:cannot-toggle-system-plugin]]');
- }
- const isInstalled = await plugins.isInstalled(data.id);
- const isStarterPlan = nconf.get('saas_plan') === 'starter';
- if ((isStarterPlan || nconf.get('acpPluginInstallDisabled')) && !isInstalled) {
- throw new Error('[[error:plugin-installation-via-acp-disabled]]');
- }
- postsCache.reset();
- await plugins.checkWhitelist(data.id, data.version);
- const pluginData = await plugins.toggleInstall(data.id, data.version);
- await events.log({
- type: `plugin-${pluginData.installed ? 'install' : 'uninstall'}`,
- text: data.id,
- version: data.version,
- uid: socket.uid,
- });
- return pluginData;
-};
-
Plugins.getActive = async function () {
return await plugins.getActive();
};
@@ -63,18 +26,3 @@ Plugins.orderActivePlugins = async function (socket, data) {
await db.sortedSetAdd('plugins:active', data.map(p => p.order || 0), data.map(p => p.name));
};
-
-Plugins.upgrade = async function (socket, data) {
- if (await plugins.isSystemPlugin(data.id)) {
- throw new Error('[[error:cannot-upgrade-system-plugin]]');
- }
- const isInstalled = await plugins.isInstalled(data.id);
- if (!isInstalled) {
- throw new Error('[[error:plugin-not-installed]]');
- }
- if (nconf.get('acpPluginInstallDisabled')) {
- throw new Error('[[error:plugin-installation-via-acp-disabled]]');
- }
- await plugins.checkWhitelist(data.id, data.version);
- return await plugins.upgrade(data.id, data.version);
-};
diff --git a/src/views/admin/partials/download_plugin_item.tpl b/src/views/admin/partials/download_plugin_item.tpl
index 952a974118..251fcb6fb5 100644
--- a/src/views/admin/partials/download_plugin_item.tpl
+++ b/src/views/admin/partials/download_plugin_item.tpl
@@ -20,7 +20,7 @@
{{{ end }}}
</div>
<div class="d-flex flex-column gap-1">
- <button data-action="toggleActive" class="btn btn-light btn-sm hidden text-nowrap">
+ <button data-action="toggleActive" class="btn btn-light btn-sm hidden text-nowrap" data-active-state="1">
<i class="fa fa-power-off text-primary"></i> {{tx("admin/extend/plugins:plugin-item.activate")}}
</button>
diff --git a/src/views/admin/partials/export-users-csv.tpl b/src/views/admin/partials/export-users-csv.tpl
new file mode 100644
index 0000000000..e76b36c817
--- /dev/null
+++ b/src/views/admin/partials/export-users-csv.tpl
@@ -0,0 +1,10 @@
+<div>
+ {{{ each options }}}
+ <div class="form-check mb-2">
+ <input data-field="{./field}" class="form-check-input" type="checkbox" id="option-{@index}" {{{ if ./selected }}}checked{{{ end }}}>
+ <label class="form-check-label" for="option-{@index}">
+ {{tx(./label)}}
+ </label>
+ </div>
+ {{{ end }}}
+</div>
\ No newline at end of file
diff --git a/src/views/admin/partials/installed_plugin_item.tpl b/src/views/admin/partials/installed_plugin_item.tpl
index e676528674..358d40b802 100644
--- a/src/views/admin/partials/installed_plugin_item.tpl
+++ b/src/views/admin/partials/installed_plugin_item.tpl
@@ -31,11 +31,11 @@
<a href="{config.relative_path}/admin/appearance/themes" class="btn btn-light btn-sm text-nowrap"><i class="fa fa-arrow-up-right-from-square text-primary"></i> {{tx("admin/extend/plugins:plugin-item.themes")}}</a>
{{{ else }}}
- <button data-action="toggleActive" class="btn btn-light btn-sm text-nowrap {{{ if !./active }}}hidden{{{ end }}} {{{ if !canChangeState }}}disabled{{{ end }}}">
+ <button data-action="toggleActive" class="btn btn-light btn-sm text-nowrap {{{ if !./active }}}hidden{{{ end }}} {{{ if !canChangeState }}}disabled{{{ end }}}" data-active-state="0">
<i class="fa fa-power-off text-danger"></i> {{tx("admin/extend/plugins:plugin-item.deactivate")}}
</button>
- <button data-action="toggleActive" class="btn btn-light btn-sm text-nowrap {{{ if ./active }}}hidden{{{ end }}} {{{ if !canChangeState }}}disabled{{{ end }}}">
+ <button data-action="toggleActive" class="btn btn-light btn-sm text-nowrap {{{ if ./active }}}hidden{{{ end }}} {{{ if !canChangeState }}}disabled{{{ end }}}" data-active-state="1">
<i class="fa fa-power-off text-primary"></i> {{tx("admin/extend/plugins:plugin-item.activate")}}
</button>
diff --git a/test/socket.io.js b/test/socket.io.js
index 78a923730b..09d998673f 100644
--- a/test/socket.io.js
+++ b/test/socket.io.js
@@ -21,6 +21,7 @@ const meta = require('../src/meta');
const events = require('../src/events');
const socketAdmin = require('../src/socket.io/admin');
+const apiAdmin = require('../src/api/admin');
describe('socket.io', () => {
let io;
@@ -457,70 +458,64 @@ describe('socket.io', () => {
});
it('should toggle plugin active', (done) => {
- socketAdmin.plugins.toggleActive({ uid: adminUid }, 'nodebb-plugin-location-to-map', (err, data) => {
- assert.ifError(err);
- assert.deepEqual(data, { id: 'nodebb-plugin-location-to-map', active: true });
+ apiAdmin.plugins.setActive({ uid: adminUid }, { id: 'nodebb-plugin-location-to-map', active: true }).then(() => {
done();
- });
+ }).catch(err => assert.fail(err.message));
});
describe('install/upgrade plugin', () => {
- it('should toggle plugin install', function (done) {
+ it('should install a plugin', function (done) {
this.timeout(0);
const oldValue = process.env.NODE_ENV;
process.env.NODE_ENV = 'development';
- socketAdmin.plugins.toggleInstall({
+ apiAdmin.plugins.install({
uid: adminUid,
}, {
id: 'nodebb-plugin-location-to-map',
version: 'latest',
- }, (err, data) => {
- assert.ifError(err);
- assert.equal(data.name, 'nodebb-plugin-location-to-map');
+ }).then(() => {
process.env.NODE_ENV = oldValue;
done();
- });
+ }).catch(err => assert.fail(err.message));
});
it('should upgrade plugin', function (done) {
this.timeout(0);
const oldValue = process.env.NODE_ENV;
process.env.NODE_ENV = 'development';
- socketAdmin.plugins.upgrade({
+ apiAdmin.plugins.upgrade({
uid: adminUid,
}, {
id: 'nodebb-plugin-markdown',
version: 'latest',
- }, (err) => {
- assert.ifError(err);
+ }).then((err) => {
process.env.NODE_ENV = oldValue;
done();
- });
+ }).catch(err => assert.fail(err.message));
});
it('should fail to upgrade plugin if it is not installed', function (done) {
this.timeout(0);
const oldValue = process.env.NODE_ENV;
process.env.NODE_ENV = 'development';
- socketAdmin.plugins.toggleInstall({
+ apiAdmin.plugins.uninstall({
uid: adminUid,
}, {
id: 'nodebb-plugin-location-to-map',
- version: 'latest',
- }, function (err) {
- assert.ifError(err);
- socketAdmin.plugins.upgrade({
+ }).then(() => {
+ apiAdmin.plugins.upgrade({
uid: adminUid,
}, {
id: 'nodebb-plugin-location-to-map',
version: 'latest',
- }, (err) => {
- console.log(err);
+ }).then(() => {
+ assert.fail('Upgrade should have failed if plugin is not installed');
+ }).catch((err) => {
assert.strictEqual(err.message, '[[error:plugin-not-installed]]');
process.env.NODE_ENV = oldValue;
done();
});
- });
+ }).catch(err => assert.fail(err.message));
});
});