gristlabs_grist-core/app/client/lib/tableUtil.ts
Alex Hall bf271c822b (core) Copy column type and options when pasting into an empty column
Summary:
Adds a `data-grist-col-ref` attribute to the copied HTML, then uses that when pasting to look up the source column and retrieve info about it. Copies the info into the target column if:

- The document is the same (the docId hash matches)
- The source column still exists and has the same type as when copied
- The source type isn't Text, because in that case it's nice if type guessing still happens
- The target column is empty, meaning it has type Any (we check earlier that it's not a formula column)

The info copied is the type, widgetOptions, and reference column settings (visible and display columns) but not conditional formatting.

The changes are mostly in a function `parsePasteForView` which is based on `BaseView._parsePasteForView` but ported to TypeScript in a new file `BaseView2.ts`.

Added a useraction `MaybeCopyDisplayFormula` exposing an existing Python function `maybe_copy_display_formula` because the target column needs a slightly different display formula.

Test Plan: Added a new nbrowser test file and fixture doc.

Reviewers: cyprien

Reviewed By: cyprien

Subscribers: jarek, dsagal

Differential Revision: https://phab.getgrist.com/D3344
2022-04-04 14:53:16 +02:00

209 lines
8.7 KiB
TypeScript

import type {CopySelection} from 'app/client/components/CopySelection';
import {get as getBrowserGlobals} from 'app/client/lib/browserGlobals';
import type {KoArray} from 'app/client/lib/koArray';
import {simpleStringHash} from 'app/client/lib/textUtils';
import type {ViewFieldRec} from 'app/client/models/DocModel';
import type {BulkUpdateRecord} from 'app/common/DocActions';
import {safeJsonParse} from 'app/common/gutil';
import type {TableData} from 'app/common/TableData';
import {tsvEncode} from 'app/common/tsvFormat';
import {dom} from 'grainjs';
import map = require('lodash/map');
import zipObject = require('lodash/zipObject');
const G = getBrowserGlobals('document', 'DOMParser');
/**
* Returns unique positions given upper and lower position. This function returns a suitable
* position number for the to-be-inserted element to end up at the given index.
* Inserting n elements between a and b should give the positions:
* (a+(b-a)/(n+1)), (a+2(b-a)/(n+1)) , ..., (a+(n)(b-a)/(n+1))
* @param {number} lowerPos - a lower bound
* @param {number} upperPos - an upper bound, must be greater than or equal to lowerPos
* @param {number} numInserts - Number of new positions to insert
* @returns {number[]} A sorted Array of unique positions bounded by lowerPos and upperPos.
* If neither an upper nor lowerPos is given, return 0, 1, ..., numInserts - 1
* If an upperPos is not given, return consecutive values greater than lowerPos
* If a lowerPos is not given, return consecutive values lower than upperPos
* Else return the avg position of to-be neighboring elements.
* Ex: insertPositions(null, 0, 4) = [-4, -3, -2, -1]
* insertPositions(0, null, 4) = [1, 2, 3, 4]
* insertPositions(0, 1, 4) = [0.2, 0.4, 0.6, 0.8]
*/
export function insertPositions(lowerPos: number|null, upperPos: number|null, numInserts: number): number[] {
numInserts = (typeof numInserts === 'undefined') ? 1 : numInserts;
let start = 0;
let step = 1;
const positions = [];
if (typeof lowerPos !== 'number' && typeof upperPos !== 'number') {
start = 0;
} else if (typeof lowerPos !== 'number') {
start = upperPos! - numInserts;
} else if (typeof upperPos !== 'number') {
start = lowerPos + 1;
} else {
step = (upperPos - lowerPos)/(numInserts + 1);
start = lowerPos + step;
}
for(let i = 0; i < numInserts; i++ ){
positions.push(start + step*i);
}
return positions;
}
/**
* Returns a sorted array of parentPos values between the parentPos of the viewField at index-1 and index.
* @param {koArray} viewFields - koArray of viewFields
* @{param} {number} index - index to insert the viewFields into
* @{param} {number} numInserts - number of new fields to insert
*/
export function fieldInsertPositions(viewFields: KoArray<ViewFieldRec>, index: number, numInserts: number): number[] {
const leftPos = (index > 0) ? viewFields.at(index - 1)!.parentPos() : null;
const rightPos = (index < viewFields.peekLength) ? viewFields.at(index)!.parentPos() : null;
return insertPositions(leftPos, rightPos, numInserts);
}
/**
* Returns tsv formatted values from TableData at the given rowIDs and columnIds.
* @param {TableData} tableData - the table containing the values to convert
* @param {CopySelection} selection - a CopySelection instance
* @return {String}
**/
export function makePasteText(tableData: TableData, selection: CopySelection) {
// tsvEncode expects data as a 2-d array with each a array representing a row
// i.e. [["1-1", "1-2", "1-3"],["2-1", "2-2", "2-3"]]
const values = selection.rowIds.map(rowId =>
selection.columns.map(col => col.fmtGetter(rowId)));
return tsvEncode(values);
}
/**
* Hash of the current docId to allow checking if copying and pasting is happening in the same document,
* without leaking the actual docId which may allow others to access the document.
*/
export function getDocIdHash(): string {
const docId = (window as any).gristDocPageModel.currentDocId.get();
return simpleStringHash(docId);
}
/**
* Returns an html table of containing the cells denoted by the cross product of
* the given rows and columns, styled by the given table/row/col style dictionaries.
* @param {TableData} tableData - the table containing the values denoted by the grid selection
* @param {CopySelection} selection - a CopySelection instance
* @param {Boolean} showColHeader - whether to include a column header row
* @return {String} The html for a table containing the given data.
**/
export function makePasteHtml(tableData: TableData, selection: CopySelection, includeColHeaders: boolean) {
const rowStyle = selection.rowStyle || {}; // Maps rowId to style object.
const colStyle = selection.colStyle || {}; // Maps colId to style object.
const elem = dom('table',
{border: '1', cellspacing: '0', style: 'white-space: pre', 'data-grist-doc-id-hash': getDocIdHash()},
dom('colgroup', selection.colIds.map((colId, idx) =>
dom('col', {
style: _styleAttr(colStyle[colId]),
'data-grist-col-ref': String(selection.colRefs[idx]),
'data-grist-col-type': tableData.getColType(colId)
})
)),
// Include column headers if requested.
(includeColHeaders ?
dom('tr', selection.colIds.map(colId => dom('th', colId))) :
null
),
// Fill with table cells.
selection.rowIds.map(rowId =>
dom('tr',
{style: _styleAttr(rowStyle[rowId as number])},
selection.columns.map(col => {
const rawValue = col.rawGetter(rowId);
const fmtValue = col.fmtGetter(rowId);
const dataOptions = (rawValue === fmtValue) ? {} :
{'data-grist-raw-value': JSON.stringify(rawValue)};
return dom('td', dataOptions, fmtValue);
})
)
)
);
return elem.outerHTML;
}
export interface RichPasteObject {
displayValue: string;
docIdHash?: string|null;
colType?: string|null; // Column type of the source column.
colRef?: number|null;
rawValue?: unknown; // Optional rawValue that should be used if colType matches destination.
}
/**
* Parses a 2-d array of objects from a text string containing an HTML table.
* @param {string} data - String of an HTML table.
* @return {Array<Array<RichPasteObj>>} - 2-d array of objects containing details of copied cells.
*/
export function parsePasteHtml(data: string): RichPasteObject[][] {
const parser = new G.DOMParser() as DOMParser;
const doc = parser.parseFromString(data, 'text/html');
const table = doc.querySelector('table')!;
const docIdHash = table.getAttribute('data-grist-doc-id-hash');
const cols = [...table.querySelectorAll('col')];
const rows = [...table.querySelectorAll('tr')];
const result = rows.map(row =>
Array.from(row.querySelectorAll('td, th'), (cell, colIdx) => {
const col = cols[colIdx];
const colType = col?.getAttribute('data-grist-col-type');
const colRef = col && Number(col.getAttribute('data-grist-col-ref'));
const o: RichPasteObject = {displayValue: cell.textContent!, docIdHash, colType, colRef};
if (cell.hasAttribute('data-grist-raw-value')) {
o.rawValue = safeJsonParse(cell.getAttribute('data-grist-raw-value')!,
o.displayValue);
}
return o;
}))
.filter((row) => (row.length > 0));
if (result.length === 0) {
throw new Error('Unable to parse data from text/html');
}
return result;
}
// Helper function to add css style properties to an html tag
function _styleAttr(style: object) {
return map(style, (value, prop) => `${prop}: ${value};`).join(' ');
}
/**
* Given a selection object, creates a action to set all references in the object to the empty string.
* @param {Object} selection - an object with a list of selected row Ids, selected column Ids, a list of
* column metaRowModels and other information about the currently selected cells.
* See GridView.js getSelection and DetailView.js getSelection.
* @returns {Object} BulkUpdateRecord action
*/
export function makeDeleteAction(selection: CopySelection): BulkUpdateRecord|null {
// If the selection includes the "new" row, ignore that one.
const rowIds = selection.rowIds.filter((r): r is number => (typeof r === 'number'));
if (rowIds.length === 0) {
return null;
}
const blankRow = rowIds.map(() => '');
const colIds = selection.fields
.filter(field => !field.column().isRealFormula() && !field.disableEditData())
.map(field => field.colId());
// Get the tableId from the first selected column.
const tableId = selection.fields[0].column().table().tableId();
if (colIds.length === 0) {
return null;
}
return ['BulkUpdateRecord', tableId, rowIds,
zipObject(colIds, colIds.map(() => blankRow))];
}