You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
117 lines
4.4 KiB
117 lines
4.4 KiB
import {ApiError} from 'app/common/ApiError';
|
|
import {ActiveDoc} from 'app/server/lib/ActiveDoc';
|
|
import {FilterColValues} from "app/common/ActiveDocAPI";
|
|
import {DownloadOptions, ExportData, ExportHeader, exportSection, exportTable, Filter} from 'app/server/lib/Export';
|
|
import log from 'app/server/lib/log';
|
|
import * as bluebird from 'bluebird';
|
|
import contentDisposition from 'content-disposition';
|
|
import csv from 'csv';
|
|
import * as express from 'express';
|
|
|
|
// promisify csv
|
|
bluebird.promisifyAll(csv);
|
|
|
|
/**
|
|
* Converts `activeDoc` to a CSV and sends the converted data through `res`.
|
|
*/
|
|
export async function downloadCSV(activeDoc: ActiveDoc, req: express.Request,
|
|
res: express.Response, options: DownloadOptions) {
|
|
log.info('Generating .csv file...');
|
|
const {filename, tableId, viewSectionId, filters, sortOrder, linkingFilter, header} = options;
|
|
const data = viewSectionId ?
|
|
await makeCSVFromViewSection({
|
|
activeDoc, viewSectionId, sortOrder: sortOrder || null, filters: filters || null,
|
|
linkingFilter: linkingFilter || null, header, req
|
|
}) :
|
|
await makeCSVFromTable({activeDoc, tableId, header, req});
|
|
res.set('Content-Type', 'text/csv');
|
|
res.setHeader('Content-Disposition', contentDisposition(filename + '.csv'));
|
|
res.send(data);
|
|
}
|
|
|
|
/**
|
|
* Returns a csv stream of a view section that can be transformed or parsed.
|
|
*
|
|
* See https://github.com/wdavidw/node-csv for API details.
|
|
*
|
|
* @param {Object} options - options for the export.
|
|
* @param {Object} options.activeDoc - the activeDoc that the table being converted belongs to.
|
|
* @param {Integer} options.viewSectionId - id of the viewsection to export.
|
|
* @param {Integer[]} options.activeSortOrder (optional) - overriding sort order.
|
|
* @param {Filter[]} options.filters (optional) - filters defined from ui.
|
|
* @param {FilterColValues} options.linkingFilter (optional) - linking filter defined from ui.
|
|
* @param {string} options.header (optional) - which field of the column to use as header
|
|
* @param {express.Request} options.req - the request object.
|
|
*
|
|
* @return {Promise<string>} Promise for the resulting CSV.
|
|
*/
|
|
export async function makeCSVFromViewSection({
|
|
activeDoc, viewSectionId, sortOrder = null, filters = null, linkingFilter = null, header, req
|
|
}: {
|
|
activeDoc: ActiveDoc,
|
|
viewSectionId: number,
|
|
sortOrder: number[] | null,
|
|
filters: Filter[] | null,
|
|
linkingFilter: FilterColValues | null,
|
|
header?: ExportHeader,
|
|
req: express.Request
|
|
}) {
|
|
|
|
const data = await exportSection(activeDoc, viewSectionId, sortOrder, filters, linkingFilter, req);
|
|
const file = convertToCsv(data, { header });
|
|
return file;
|
|
}
|
|
|
|
/**
|
|
* Returns a csv stream of a table that can be transformed or parsed.
|
|
*
|
|
* @param {Object} options - options for the export.
|
|
* @param {Object} options.activeDoc - the activeDoc that the table being converted belongs to.
|
|
* @param {Integer} options.tableId - id of the table to export.
|
|
* @param {string} options.header (optional) - which field of the column to use as header
|
|
* @param {express.Request} options.req - the request object.
|
|
*
|
|
* @return {Promise<string>} Promise for the resulting CSV.
|
|
*/
|
|
export async function makeCSVFromTable({ activeDoc, tableId, header, req }: {
|
|
activeDoc: ActiveDoc,
|
|
tableId: string,
|
|
header?: ExportHeader,
|
|
req: express.Request
|
|
}) {
|
|
|
|
if (!activeDoc.docData) {
|
|
throw new Error('No docData in active document');
|
|
}
|
|
|
|
// Look up the table to make a CSV from.
|
|
const tables = activeDoc.docData.getMetaTable('_grist_Tables');
|
|
const tableRef = tables.findRow('tableId', tableId);
|
|
|
|
if (tableRef === 0) {
|
|
throw new ApiError(`Table ${tableId} not found.`, 404);
|
|
}
|
|
|
|
const data = await exportTable(activeDoc, tableRef, req);
|
|
const file = convertToCsv(data, { header });
|
|
return file;
|
|
}
|
|
|
|
function convertToCsv({
|
|
rowIds,
|
|
access,
|
|
columns: viewColumns,
|
|
}: ExportData, options: { header?: ExportHeader }) {
|
|
|
|
// create formatters for columns
|
|
const formatters = viewColumns.map(col => col.formatter);
|
|
// Arrange the data into a row-indexed matrix, starting with column headers.
|
|
const colPropertyAsHeader = options.header ?? 'label';
|
|
const csvMatrix = [viewColumns.map(col => col[colPropertyAsHeader])];
|
|
// populate all the rows with values as strings
|
|
rowIds.forEach(row => {
|
|
csvMatrix.push(access.map((getter, c) => formatters[c].formatAny(getter(row))));
|
|
});
|
|
return csv.stringifyAsync(csvMatrix);
|
|
}
|