Skip to content

Node.js based forum software built for the modern web

refactor: use json2csv

Barış Soner Uşaklıc2e85bd67006
diff --git a/src/controllers/admin/groups.js b/src/controllers/admin/groups.js
index f03c1a8389..e0ae6d8780 100644
--- a/src/controllers/admin/groups.js
+++ b/src/controllers/admin/groups.js
@@ -1,7 +1,7 @@
'use strict';
const nconf = require('nconf');
-const validator = require('validator');
+const { AsyncParser } = require('@json2csv/node');
const db = require('../../database');
const user = require('../../user');
@@ -9,6 +9,7 @@ const groups = require('../../groups');
const meta = require('../../meta');
const pagination = require('../../pagination');
const events = require('../../events');
+const slugify = require('../../slugify');
const groupsController = module.exports;
@@ -96,13 +97,10 @@ groupsController.getCSV = async function (req, res) {
const members = (await groups.getMembersOfGroups([groupName]))[0];
const fields = ['email', 'username', 'uid'];
const userData = await user.getUsersFields(members, fields);
- let csvContent = `${fields.join(',')}\n`;
- csvContent += userData.reduce((memo, user) => {
- memo += `${user.email},${user.username},${user.uid}\n`;
- return memo;
- }, '');
+ const json2csvAsync = new AsyncParser({ fields });
+ const csvContent = await json2csvAsync.parse(userData).promise();
- res.attachment(`${validator.escape(groupName)}_members.csv`);
+ res.attachment(`${slugify(groupName)}_members.csv`);
res.setHeader('Content-Type', 'text/csv');
res.end(csvContent);
};
diff --git a/src/messaging/notifications.js b/src/messaging/notifications.js
index 6da92ef21c..e101157ea9 100644
--- a/src/messaging/notifications.js
+++ b/src/messaging/notifications.js
@@ -1,7 +1,6 @@
'use strict';
const winston = require('winston');
-const validator = require('validator');
const batch = require('../batch');
const db = require('../database');
@@ -72,9 +71,7 @@ module.exports = function (Messaging) {
if (!isPublic) {
const uids = await Messaging.getAllUidsInRoomFromSet(`chat:room:${roomId}:uids:online`);
unreadData.teaser = {
- content: validator.escape(
- utils.stripHTMLTags(utils.decodeHTMLEntities(messageObj.content))
- ),
+ content: utils.stripHTMLTags(utils.decodeHTMLEntities(messageObj.content)),
user: messageObj.fromUser,
timestampISO: messageObj.timestampISO,
};
diff --git a/src/user/admin.js b/src/user/admin.js
index 441c82bfbb..89c89196de 100644
--- a/src/user/admin.js
+++ b/src/user/admin.js
@@ -33,14 +33,14 @@ module.exports = function (User) {
User.getUsersCSV = async function () {
winston.verbose('[user/getUsersCSV] Compiling User CSV data');
- const data = await plugins.hooks.fire('filter:user.csvFields', { fields: ['uid', 'email', 'username'] });
- let csvContent = `${data.fields.join(',')}\n`;
+ const { fields, showIps } = await plugins.hooks.fire('filter:user.csvFields', {
+ fields: ['uid', 'email', 'username'],
+ showIps: false,
+ });
+
+ let csvContent = `${fields.map(f => `"${f}"`).join(',')}\n`;
await batch.processSortedSet('users:joindate', async (uids) => {
- const usersData = await User.getUsersFields(uids, data.fields);
- csvContent += usersData.reduce((memo, user) => {
- memo += `${data.fields.map(field => user[field]).join(',')}\n`;
- return memo;
- }, '');
+ csvContent += await userDataToCsv(uids, fields, [], showIps);
}, {});
return csvContent;
@@ -54,7 +54,6 @@ module.exports = function (User) {
showIps: fieldsToExport.includes('ip'),
});
const customUserFields = await db.getSortedSetRange('user-custom-fields', 0, -1);
- const fieldsToWrapInQuotes = ['fullname', 'signature', 'aboutme', ...customUserFields];
if (!showIps && fields.includes('ip')) {
fields.splice(fields.indexOf('ip'), 1);
}
@@ -64,27 +63,7 @@ module.exports = function (User) {
);
await fs.promises.appendFile(fd, `${fields.map(f => `"${f}"`).join(',')}\n`);
await batch.processSortedSet('users:joindate', async (uids) => {
- const userFieldsToLoad = fields.filter(field => field !== 'ip' && field !== 'password');
- const usersData = await User.getUsersFields(uids, userFieldsToLoad);
- let userIps = [];
- if (showIps) {
- userIps = await db.getSortedSetsMembers(uids.map(uid => `uid:${uid}:ip`));
- }
-
- usersData.forEach((user, index) => {
- if (Array.isArray(userIps[index])) {
- user.ip = userIps[index].join(',');
- }
- fieldsToWrapInQuotes.forEach((field) => {
- if (user[field]) {
- user[field] = `"${String(user[field])}"`;
- }
- });
- });
-
- const opts = { fields, header: false };
- const json2csvAsync = new AsyncParser(opts);
- const csv = await json2csvAsync.parse(usersData).promise();
+ const csv = await userDataToCsv(uids, fields, customUserFields, showIps);
await fs.promises.appendFile(fd, csv);
}, {
batch: 5000,
@@ -92,4 +71,29 @@ module.exports = function (User) {
});
await fd.close();
};
+
+ async function userDataToCsv(uids, fields, customUserFields, showIps) {
+ const fieldsToWrapInQuotes = ['fullname', 'signature', 'aboutme', ...customUserFields];
+ const userFieldsToLoad = fields.filter(field => field !== 'ip' && field !== 'password');
+ const usersData = await User.getUsersFields(uids, userFieldsToLoad);
+ let userIps = [];
+ if (showIps) {
+ userIps = await db.getSortedSetsMembers(uids.map(uid => `uid:${uid}:ip`));
+ }
+
+ usersData.forEach((user, index) => {
+ if (Array.isArray(userIps[index])) {
+ user.ip = userIps[index].join(',');
+ }
+ fieldsToWrapInQuotes.forEach((field) => {
+ if (user[field]) {
+ user[field] = `"${String(user[field])}"`;
+ }
+ });
+ });
+
+ const opts = { fields, header: false };
+ const json2csvAsync = new AsyncParser(opts);
+ return await json2csvAsync.parse(usersData).promise();
+ }
};