Skip to content

Node.js based forum software built for the modern web

refactor: one owner for the sortable ACP list editors (#14867)

palmoni53f1fbc62d18e
diff --git a/public/src/admin/manage/users/custom-fields.js b/public/src/admin/manage/users/custom-fields.js
index 296256e797..3f3cd1b770 100644
--- a/public/src/admin/manage/users/custom-fields.js
+++ b/public/src/admin/manage/users/custom-fields.js
@@ -1,110 +1,50 @@
define('admin/manage/user/custom-fields', [
- 'modals', 'alerts', 'iconSelect', 'benchpress', 'jquery-ui/widgets/sortable',
-], function (modals, alerts, iconSelect, Benchpress) {
+ 'admin/modules/listEditor', 'iconSelect',
+], function (listEditor, iconSelect) {
const manageUserFields = {};
manageUserFields.init = function () {
- const table = $('table');
-
- table.on('click', '[data-action="edit"]', function () {
- const row = $(this).parents('[data-key]');
- showModal(getDataFromEl(row));
- });
-
- table.on('click', '[data-action="delete"]', function () {
- const key = $(this).attr('data-key');
- const row = $(this).parents('[data-key]');
- modals.confirm(`[[admin/manage/user-custom-fields:delete-field-confirm-x, ${key}]]`, function (ok) {
- if (!ok) {
- return;
- }
- row.remove();
- });
- });
-
- $('tbody').sortable({
- handle: '[component="sort/handle"]',
- axis: 'y',
- zIndex: 9999,
- });
-
- $('#new').on('click', () => showModal());
-
- $('#save').on('click', () => {
- const fields = [];
- $('tbody tr[data-key]').each((index, el) => {
- fields.push(getDataFromEl($(el)));
- });
- socket.emit('admin.user.saveCustomFields', fields, function (err) {
- if (err) {
- return alerts.error(err);
+ listEditor.init({
+ attributes: {
+ key: 'key',
+ name: 'name',
+ icon: 'icon',
+ type: 'type',
+ 'select-options': 'select-options',
+ visibility: 'visibility',
+ 'min:rep': 'min-rep',
+ },
+ modalTemplate: 'admin/partials/manage-custom-user-fields-modal',
+ rowTemplate: 'admin/manage/users/custom-fields',
+ rowBlock: 'fields',
+ createTitle: '[[admin/manage/user-custom-fields:create-field]]',
+ editTitle: '[[admin/manage/user-custom-fields:edit-field]]',
+ savedMessage: '[[admin/manage/user-custom-fields:custom-fields-saved]]',
+ deleteConfirm: field => `[[admin/manage/user-custom-fields:delete-field-confirm-x, ${field.key}]]`,
+ prepare: function (formData) {
+ if (formData.type === 'select' || formData.type === 'select-multi') {
+ formData.selectOptionsFormatted = formData['select-options'].trim().split('\n').join(', ');
}
- alerts.success('[[admin/manage/user-custom-fields:custom-fields-saved]]');
- });
- });
- };
-
- function getDataFromEl(el) {
- return {
- key: el.attr('data-key'),
- name: el.attr('data-name'),
- icon: el.attr('data-icon'),
- type: el.attr('data-type'),
- 'select-options': el.attr('data-select-options'),
- visibility: el.attr('data-visibility'),
- 'min:rep': el.attr('data-min-rep'),
- };
- }
-
- async function showModal(field = null) {
- const html = await Benchpress.render('admin/partials/manage-custom-user-fields-modal', field);
-
- const modal = await modals.dialog({
- message: html,
- onEscape: true,
- title: field ?
- '[[admin/manage/user-custom-fields:edit-field]]' :
- '[[admin/manage/user-custom-fields:create-field]]',
- buttons: {
- submit: {
- label: '[[global:save]]',
- callback: function () {
- const formData = modal.find('form').serializeObject();
- if (formData.type === 'select' || formData.type === 'select-multi') {
- formData.selectOptionsFormatted = formData['select-options'].trim().split('\n').join(', ');
- }
-
- app.parseAndTranslate('admin/manage/users/custom-fields', 'fields', {
- fields: [formData],
- }, (html) => {
- if (field) {
- const oldKey = field.key;
- $(`tbody [data-key="${oldKey}"]`).replaceWith(html);
- } else {
- $('tbody').append(html);
- }
- });
- },
- },
+ return formData;
},
+ onModalReady: function (modal) {
+ modal.find('#type-select').on('change', function () {
+ const type = $(this).val();
+ modal.find(`[data-input-type]`).addClass('hidden');
+ modal.find(`[data-input-type-${type}]`).removeClass('hidden');
+ });
+
+ modal.find('#icon-select').on('click', function () {
+ iconSelect.init($(this).find('i'), function (el, icon, styles) {
+ styles.push(icon);
+ modal.find('[name="icon"]').val(styles.join(' '));
+ });
+ return false;
+ });
+ },
+ save: fields => socket.emit('admin.user.saveCustomFields', fields),
});
-
- modal.find('#type-select').on('change', function () {
- const type = $(this).val();
- modal.find(`[data-input-type]`).addClass('hidden');
- modal.find(`[data-input-type-${type}]`).removeClass('hidden');
- });
-
- modal.find('#icon-select').on('click', function () {
- iconSelect.init($(this).find('i'), function (el, icon, styles) {
- styles.push(icon);
- modal.find('[name="icon"]').val(styles.join(' '));
- });
- return false;
- });
- }
+ };
return manageUserFields;
});
-
-
diff --git a/public/src/admin/manage/users/custom-reasons.js b/public/src/admin/manage/users/custom-reasons.js
index 4af9515424..bd58fa8d2f 100644
--- a/public/src/admin/manage/users/custom-reasons.js
+++ b/public/src/admin/manage/users/custom-reasons.js
@@ -1,96 +1,37 @@
define('admin/manage/user/custom-reasons', [
- 'benchpress', 'modals', 'alerts', 'jquery-ui/widgets/sortable',
-], function (benchpress, modals, alerts) {
+ 'admin/modules/listEditor',
+], function (listEditor) {
const manageCustomReasons = {};
manageCustomReasons.init = function () {
- const table = $('table');
-
- $('#new').on('click', () => showModal());
-
- table.on('click', '[data-action="edit"]', function () {
- const row = $(this).parents('[data-key]');
- showModal(getDataFromEl(row));
- });
-
- table.on('click', '[data-action="delete"]', function () {
- const row = $(this).parents('[data-key]');
- const title = row.attr('data-title');
- modals.confirm(`[[admin/manage/custom-reasons:delete-reason-confirm-x, "${title}"]]`, function (ok) {
- if (!ok) {
- return;
- }
- row.remove();
- });
- });
-
- $('tbody').sortable({
- handle: '[component="sort/handle"]',
- axis: 'y',
- zIndex: 9999,
- });
-
- $('#save').on('click', () => {
- const reasons = [];
- $('tbody tr[data-key]').each((index, el) => {
- reasons.push(getDataFromEl($(el)));
- });
- socket.emit('admin.user.saveCustomReasons', reasons, function (err) {
- if (err) {
- return alerts.error(err);
+ listEditor.init({
+ attributes: {
+ key: 'key',
+ title: 'title',
+ type: 'type',
+ body: 'body',
+ },
+ modalTemplate: 'admin/partials/manage-custom-reasons-modal',
+ rowTemplate: 'admin/manage/users/custom-reasons',
+ rowBlock: 'reasons',
+ createTitle: '[[admin/manage/custom-reasons:create-reason]]',
+ editTitle: '[[admin/manage/custom-reasons:edit-reason]]',
+ savedMessage: '[[admin/manage/custom-reasons:custom-reasons-saved]]',
+ deleteConfirm: reason => `[[admin/manage/custom-reasons:delete-reason-confirm-x, "${reason.title}"]]`,
+ prepare: async function (formData, reason) {
+ formData.key = reason ? reason.key : Date.now();
+ formData.parsedBody = await socket.emit('admin.parseRaw', formData.body);
+ return formData;
+ },
+ onModalReady: function (modal, reason) {
+ // bootbox translates message we want the translation keys to be preseved.
+ if (reason && reason.body) {
+ modal.find('[name="body"]').val(reason.body);
}
- alerts.success('[[admin/manage/custom-reasons:custom-reasons-saved]]');
- });
- });
- };
-
- function getDataFromEl(el) {
- return {
- key: el.attr('data-key'),
- title: el.attr('data-title'),
- type: el.attr('data-type'),
- body: el.attr('data-body'),
- };
- }
-
- async function showModal(reason = null) {
- const html = await benchpress.render('admin/partials/manage-custom-reasons-modal', reason);
- const modal = await modals.dialog({
- message: html,
- onEscape: true,
- title: reason ?
- '[[admin/manage/custom-reasons:edit-reason]]' :
- '[[admin/manage/custom-reasons:create-reason]]',
- buttons: {
- submit: {
- label: '[[global:save]]',
- callback: async function () {
- const formData = modal.find('form').serializeObject();
- formData.key = reason ? reason.key : Date.now();
- formData.parsedBody = await socket.emit('admin.parseRaw', formData.body);
-
- app.parseAndTranslate('admin/manage/users/custom-reasons', 'reasons', {
- reasons: [formData],
- }, (html) => {
- if (reason) {
- const oldKey = reason.key;
- $(`tbody [data-key="${oldKey}"]`).replaceWith(html);
- } else {
- $('tbody').append(html);
- }
- });
- },
- },
},
+ save: reasons => socket.emit('admin.user.saveCustomReasons', reasons),
});
- // bootbox translates message we want the translation keys to be preseved.
- if (reason && reason.body) {
- modal.find('[name="body"]').val(reason.body);
- }
- }
-
+ };
return manageCustomReasons;
});
-
-
diff --git a/public/src/admin/modules/listEditor.js b/public/src/admin/modules/listEditor.js
new file mode 100644
index 0000000000..c4923722ab
--- /dev/null
+++ b/public/src/admin/modules/listEditor.js
@@ -0,0 +1,92 @@
+'use strict';
+
+define('admin/modules/listEditor', [
+ 'benchpress', 'modals', 'alerts', 'jquery-ui/widgets/sortable',
+], function (Benchpress, modals, alerts) {
+ const listEditor = {};
+
+ listEditor.init = function (options) {
+ const table = $('table');
+
+ table.on('click', '[data-action="edit"]', function () {
+ const row = $(this).parents('[data-key]');
+ showModal(options, getDataFromEl(options, row));
+ });
+
+ table.on('click', '[data-action="delete"]', function () {
+ const row = $(this).parents('[data-key]');
+ modals.confirm(options.deleteConfirm(getDataFromEl(options, row)), function (ok) {
+ if (!ok) {
+ return;
+ }
+ row.remove();
+ });
+ });
+
+ $('tbody').sortable({
+ handle: '[component="sort/handle"]',
+ axis: 'y',
+ zIndex: 9999,
+ });
+
+ $('#new').on('click', () => showModal(options));
+
+ $('#save').on('click', async () => {
+ const items = [];
+ $('tbody tr[data-key]').each((index, el) => {
+ items.push(getDataFromEl(options, $(el)));
+ });
+ try {
+ await options.save(items);
+ alerts.success(options.savedMessage);
+ } catch (err) {
+ alerts.error(err);
+ }
+ });
+ };
+
+ function getDataFromEl(options, el) {
+ const data = {};
+ Object.keys(options.attributes).forEach((prop) => {
+ data[prop] = el.attr(`data-${options.attributes[prop]}`);
+ });
+ return data;
+ }
+
+ async function showModal(options, item = null) {
+ const html = await Benchpress.render(options.modalTemplate, item);
+
+ const modal = await modals.dialog({
+ message: html,
+ onEscape: true,
+ title: item ? options.editTitle : options.createTitle,
+ buttons: {
+ submit: {
+ label: '[[global:save]]',
+ callback: async function () {
+ let formData = modal.find('form').serializeObject();
+ if (options.prepare) {
+ formData = await options.prepare(formData, item);
+ }
+
+ app.parseAndTranslate(options.rowTemplate, options.rowBlock, {
+ [options.rowBlock]: [formData],
+ }, (html) => {
+ if (item) {
+ $(`tbody [data-key="${item.key}"]`).replaceWith(html);
+ } else {
+ $('tbody').append(html);
+ }
+ });
+ },
+ },
+ },
+ });
+
+ if (options.onModalReady) {
+ options.onModalReady(modal, item);
+ }
+ }
+
+ return listEditor;
+});