Nemcio/NodeBB
1
0
Fork 0
mirror of https://github.com/NodeBB/NodeBB.git synced 2026-07-08 18:43:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

feat: allow custom fields in user csv export, closes #12401

Browse Source
This commit is contained in:
Barış Soner Uşaklı
2024-03-11 11:29:05 -04:00
parent bb29cafcf6
commit 83ca23ca37
4 changed files with 97 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/socket.io/admin/user.js
View File

@@ -162,7 +162,7 @@ User.setReputation = async function (socket, data) {
]);
};
User.exportUsersCSV = async function (socket) {
User.exportUsersCSV = async function (socket, data) {
await events.log({
type: 'exportUsersCSV',
uid: socket.uid,
@@ -170,7 +170,7 @@ User.exportUsersCSV = async function (socket) {
});
setTimeout(async () => {
try {
await user.exportUsersCSV();
await user.exportUsersCSV(data.fields);
if (socket.emit) {
socket.emit('event:export-users-csv');
}

39
src/user/admin.js
View File

@@ -5,6 +5,7 @@ const fs = require('fs');
const path = require('path');
const winston = require('winston');
const validator = require('validator');
const json2csvAsync = require('json2csv').parseAsync;
const { baseDir } = require('../constants').paths;
const db = require('../database');
@@ -47,41 +48,39 @@ module.exports = function (User) {
return csvContent;
};
User.exportUsersCSV = async function () {
User.exportUsersCSV = async function (fieldsToExport = ['email', 'username', 'uid', 'ip']) {
winston.verbose('[user/exportUsersCSV] Exporting User CSV data');
const { fields, showIps } = await plugins.hooks.fire('filter:user.csvFields', {
fields: ['email', 'username', 'uid'],
showIps: true,
fields: fieldsToExport,
showIps: fieldsToExport.includes('ip'),
});
if (!showIps && fields.includes('ip')) {
fields.splice(fields.indexOf('ip'), 1);
}
const fd = await fs.promises.open(
path.join(baseDir, 'build/export', 'users.csv'),
'w'
);
fs.promises.appendFile(fd, `${fields.join(',')}${showIps ? ',ip' : ''}\n`);
await batch.processSortedSet('users:joindate', async (uids) => {
const usersData = await User.getUsersFields(uids, fields.slice());
let userIPs = '';
let ips = [];
fs.promises.appendFile(fd, `${fields.map(f => `"${f}"`).join(',')}\n`);
await batch.processSortedSet('group:administrators:members', async (uids) => {
const userFieldsToLoad = fields.filter(field => field !== 'ip' && field !== 'password');
const usersData = await User.getUsersFields(uids, userFieldsToLoad);
let userIps = [];
if (showIps) {
ips = await db.getSortedSetsMembers(uids.map(uid => `uid:${uid}:ip`));
userIps = await db.getSortedSetsMembers(uids.map(uid => `uid:${uid}:ip`));
}
let line = '';
usersData.forEach((user, index) => {
line += `${fields
.map(field => (isFinite(user[field]) ? `'${user[field]}'` : user[field]))
.join(',')}`;
if (showIps) {
userIPs = ips[index] ? ips[index].join(',') : '';
line += `,"${userIPs}"\n`;
} else {
line += '\n';
if (Array.isArray(userIps[index])) {
user.ip = userIps[index].join(',');
}
});
await fs.promises.appendFile(fd, line);
const opts = { fields, header: false };
const csv = await json2csvAsync(usersData, opts);
await fs.promises.appendFile(fd, csv);
}, {
batch: 5000,
interval: 250,