import type { Ref } from 'vue' import { computed } from 'vue' import dayjs from 'dayjs' import type { MaybeRef } from '@vueuse/core' import type { AttachmentType, ColumnType, LinkToAnotherRecordType, PaginatedType, TableType, UserFieldRecordType, ViewType, } from 'nocodb-sdk' import { UITypes, dateFormats, isDateMonthFormat, isSystemColumn, isVirtualCol, populateUniqueFileName, timeFormats, } from 'nocodb-sdk' import { parse } from 'papaparse' import type { Row } from '../../lib/types' import { generateUniqueColumnName } from '../../helpers/parsers/parserHelpers' import type { Cell } from './cellRange' import { CellRange } from './cellRange' import convertCellData from './convertCellData' const MAIN_MOUSE_PRESSED = 0 /** * Utility to help with multi-selecting rows/cells in the smartsheet */ export function useMultiSelect( _meta: MaybeRef, fields: MaybeRef, data: MaybeRef | MaybeRef>, _totalRows?: MaybeRef, _editEnabled: MaybeRef, isPkAvail: MaybeRef, contextMenu: Ref, clearCell: Function, clearSelectedRangeOfCells: Function, makeEditable: Function, scrollToCell?: (row?: number | null, col?: number | null, scrollBehaviour?: ScrollBehavior) => void, expandRows?: ({ newRows, newColumns, cellsOverwritten, rowsUpdated, }: { newRows: number newColumns: number cellsOverwritten: number rowsUpdated: number }) => Promise<{ continue: boolean expand: boolean }>, keyEventHandler?: Function, syncCellData?: Function, bulkUpdateRows?: ( rows: Row[], props: string[], metas?: { metaValue?: TableType; viewMetaValue?: ViewType }, undo?: boolean, ) => Promise, bulkUpsertRows?: ( insertRows: Row[], updateRows: Row[], props: string[], metas?: { metaValue?: TableType; viewMetaValue?: ViewType }, newColumns?: Partial[], ) => Promise, fillHandle?: MaybeRef, view?: MaybeRef, paginationData?: MaybeRef, changePage?: (page: number) => void, fetchChunk?: (chunkId: number) => Promise, onActiveCellChanged?: () => void, ) { const meta = ref(_meta) const MAX_ROW_SELECTION = 100 const CHUNK_SIZE = 50 const { t } = useI18n() const { copy } = useCopy() const { getMeta } = useMetas() const { appInfo } = useGlobal() const { isMysql, isPg } = useBase() const { base } = storeToRefs(useBase()) const { api } = useApi() const { addUndo, clone, defineViewScope } = useUndoRedo() const { isDataReadOnly } = useRoles() const isArrayStructure = typeof unref(data) === 'object' && Array.isArray(unref(data)) const paginationDataRef = ref(paginationData) const editEnabled = ref(_editEnabled) const isMouseDown = ref(false) const isFillMode = ref(false) const activeView = ref(view) const selectedRange = reactive(new CellRange()) const fillRange = reactive(new CellRange()) const activeCell = reactive>({ row: null, col: null }) const columnLength = computed(() => unref(fields)?.length) const isCellActive = computed( () => !(activeCell.row === null || activeCell.col === null || isNaN(activeCell.row) || isNaN(activeCell.col)), ) function limitSelection(anchor: Cell, end: Cell): Cell { const limitedEnd = { ...end } const totalRows = Math.abs(end.row - anchor.row) + 1 if (totalRows > MAX_ROW_SELECTION) { const direction = end.row > anchor.row ? 1 : -1 limitedEnd.row = anchor.row + (MAX_ROW_SELECTION - 1) * direction } return limitedEnd } function makeActive(row: number, col: number) { if (activeCell.row === row && activeCell.col === col) { return } // disable edit mode if active cell is changed editEnabled.value = false activeCell.row = row activeCell.col = col } function constructDateTimeFormat(column: ColumnType) { const dateFormat = constructDateFormat(column) const timeFormat = constructTimeFormat(column) return `${dateFormat} ${timeFormat}` } function constructDateFormat(column: ColumnType) { return parseProp(column?.meta)?.date_format ?? dateFormats[0] } function constructTimeFormat(column: ColumnType) { return parseProp(column?.meta)?.time_format ?? timeFormats[0] } const valueToCopy = (rowObj: Row, columnObj: ColumnType) => { let textToCopy = (columnObj.title && rowObj.row[columnObj.title]) || '' if (columnObj.uidt === UITypes.Checkbox) { textToCopy = !!textToCopy } if ([UITypes.User, UITypes.CreatedBy, UITypes.LastModifiedBy].includes(columnObj.uidt as UITypes)) { if (textToCopy) { textToCopy = Array.isArray(textToCopy) ? textToCopy : [textToCopy] .map((user: UserFieldRecordType) => { return user.email }) .join(', ') } } if (isBt(columnObj) || isOo(columnObj)) { // fk_related_model_id is used to prevent paste operation in different fk_related_model_id cell textToCopy = { fk_related_model_id: (columnObj.colOptions as LinkToAnotherRecordType).fk_related_model_id, value: textToCopy || null, } } if (isMm(columnObj)) { textToCopy = { rowId: extractPkFromRow(rowObj.row, meta.value?.columns as ColumnType[]), columnId: columnObj.id, fk_related_model_id: (columnObj.colOptions as LinkToAnotherRecordType).fk_related_model_id, value: !isNaN(+textToCopy) ? +textToCopy : 0, } } if (typeof textToCopy === 'object') { textToCopy = JSON.stringify(textToCopy) } else { textToCopy = textToCopy.toString() } if (columnObj.uidt === UITypes.Formula) { textToCopy = textToCopy.replace(/\b(\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2})\b/g, (d: string) => { // TODO(timezone): retrieve the format from the corresponding column meta // assume hh:mm at this moment return dayjs(d).utc().local().format('YYYY-MM-DD HH:mm') }) } if ([UITypes.DateTime, UITypes.CreatedTime, UITypes.LastModifiedTime].includes(columnObj.uidt as UITypes)) { // remove `"` // e.g. "2023-05-12T08:03:53.000Z" -> 2023-05-12T08:03:53.000Z textToCopy = textToCopy.replace(/["']/g, '') const isMySQL = isMysql(columnObj.source_id) let d = dayjs(textToCopy) if (!d.isValid()) { // insert a datetime value, copy the value without refreshing // e.g. textToCopy = 2023-05-12T03:49:25.000Z // feed custom parse format d = dayjs(textToCopy, isMySQL ? 'YYYY-MM-DD HH:mm:ss' : 'YYYY-MM-DD HH:mm:ssZ') } // users can change the datetime format in UI // `textToCopy` would be always in YYYY-MM-DD HH:mm:ss(Z / +xx:yy) format // therefore, here we reformat to the correct datetime format based on the meta textToCopy = d.format(constructDateTimeFormat(columnObj)) if (!d.isValid()) { // return empty string for invalid datetime return '' } } if (columnObj.uidt === UITypes.Date) { const dateFormat = parseProp(columnObj.meta)?.date_format if (dateFormat && isDateMonthFormat(dateFormat)) { // any date month format (e.g. YYYY-MM) couldn't be stored in database // with date type since it is not a valid date // therefore, we reformat the value here to display with the formatted one // e.g. 2023-06-03 -> 2023-06 textToCopy = dayjs(textToCopy, dateFormat).format(dateFormat) } else { // e.g. 2023-06-03 (in DB) -> 03/06/2023 (in UI) textToCopy = dayjs(textToCopy, 'YYYY-MM-DD').format(dateFormat) } } if (columnObj.uidt === UITypes.Time) { // remove `"` // e.g. "2023-05-12T08:03:53.000Z" -> 2023-05-12T08:03:53.000Z textToCopy = textToCopy.replace(/["']/g, '') const isMySQL = isMysql(columnObj.source_id) const isPostgres = isPg(columnObj.source_id) let d = dayjs(textToCopy) if (!d.isValid()) { // insert a datetime value, copy the value without refreshing // e.g. textToCopy = 2023-05-12T03:49:25.000Z // feed custom parse format d = dayjs(textToCopy, isMySQL ? 'YYYY-MM-DD HH:mm:ss' : 'YYYY-MM-DD HH:mm:ssZ') } if (!d.isValid()) { // MySQL and Postgres store time in HH:mm:ss format so we need to feed custom parse format d = isMySQL || isPostgres ? dayjs(textToCopy, 'HH:mm:ss') : dayjs(textToCopy) } if (!d.isValid()) { // return empty string for invalid time return '' } textToCopy = d.format(constructTimeFormat(columnObj)) } if (columnObj.uidt === UITypes.LongText) { textToCopy = `"${textToCopy.replace(/"/g, '\\"')}"` } return textToCopy } const serializeRange = (rows: Row[], cols: ColumnType[]) => { let html = '' let text = '' const json: string[][] = [] rows.forEach((row, i) => { let copyRow = '' const jsonRow: string[] = [] cols.forEach((col, i) => { const value = valueToCopy(row, col) copyRow += `` text = `${text}${value}${cols.length - 1 !== i ? '\t' : ''}` jsonRow.push(value) }) html += `${copyRow}` if (rows.length - 1 !== i) { text = `${text}\n` } json.push(jsonRow) }) html += '
${value}
' return { html, text, json } } const copyTable = async (rows: Row[], cols: ColumnType[]) => { const { html: copyHTML, text: copyPlainText } = serializeRange(rows, cols) const blobHTML = new Blob([copyHTML], { type: 'text/html' }) const blobPlainText = new Blob([copyPlainText], { type: 'text/plain' }) return ( navigator.clipboard?.write([new ClipboardItem({ [blobHTML.type]: blobHTML, [blobPlainText.type]: blobPlainText })]) ?? copy(copyPlainText) ) } async function copyValue(ctx?: Cell) { try { if (selectedRange.start !== null && selectedRange.end !== null && !selectedRange.isSingleCell()) { let cprows if (isArrayStructure) { cprows = unref(data as Row[]).slice(selectedRange.start.row, selectedRange.end.row + 1) // slice the selected rows for copy } else { const startChunkId = Math.floor(selectedRange.start.row / CHUNK_SIZE) const endChunkId = Math.floor(selectedRange.end.row / CHUNK_SIZE) const chunksToFetch = new Set() for (let chunkId = startChunkId; chunkId <= endChunkId; chunkId++) { chunksToFetch.add(chunkId) } // Fetch all required chunks await Promise.all([...chunksToFetch].map(fetchChunk)) cprows = Array.from(unref(data as Map).entries()) .filter(([index]) => index >= selectedRange.start.row && index <= selectedRange.end.row) .map(([, row]) => row) } const cpcols = unref(fields).slice(selectedRange.start.col, selectedRange.end.col + 1) // slice the selected cols for copy await copyTable(cprows, cpcols) message.success(t('msg.info.copiedToClipboard')) } else { // if copy was called with context (right click position) - copy value from context // else if there is just one selected cell, copy it's value const cpRow = ctx?.row ?? activeCell.row const cpCol = ctx?.col ?? activeCell.col if (cpRow != null && cpCol != null) { const rowObj = isArrayStructure ? unref(data as Row[])[cpRow] : unref(data as Map).get(cpRow) if (!rowObj) return const columnObj = unref(fields)[cpCol] const textToCopy = valueToCopy(rowObj, columnObj) await copy(textToCopy) message.success(t('msg.info.copiedToClipboard')) } } } catch { message.error(t('msg.error.copyToClipboardError')) } } const fillRangeMap = computed(() => { /* `${rowIndex}-${colIndex}`: true | false */ const map: Record = {} if (fillRange._start === null || fillRange._end === null) { return map } for (let row = fillRange.start.row; row <= fillRange.end.row; row++) { for (let col = fillRange.start.col; col <= fillRange.end.col; col++) { map[`${row}-${col}`] = true } } return map }) const selectRangeMap = computed(() => { /* `${rowIndex}-${colIndex}`: true | false */ const map: Record = {} if (activeCell.row !== null && activeCell.col !== null) { map[`${activeCell.row}-${activeCell.col}`] = true } if (selectedRange._start === null || selectedRange._end === null) { return map } for (let row = selectedRange.start.row; row <= selectedRange.end.row; row++) { for (let col = selectedRange.start.col; col <= selectedRange.end.col; col++) { map[`${row}-${col}`] = true } } return map }) const isPasteable = (row?: Row, col?: ColumnType, showInfo = false) => { if (!row || !col) { if (showInfo) { message.info('Please select a cell to paste') } return false } // skip pasting virtual columns (including LTAR columns for now) and system columns if (isVirtualCol(col) || isSystemColumn(col)) { if (showInfo) { message.info(t('msg.info.pasteNotSupported')) } return false } // skip pasting auto increment columns if (col.ai) { if (showInfo) { message.info(t('msg.info.autoIncFieldNotEditable')) } return false } // skip pasting primary key columns if (col.pk && !row.rowMeta.new) { if (showInfo) { message.info(t('msg.info.editingPKnotSupported')) } return false } return true } function handleMouseOver(event: MouseEvent, row: number, col: number) { if (isFillMode.value) { const rw = isArrayStructure ? (unref(data) as Row[])[row] : (unref(data) as Map).get(row) if (!rw) return if (!selectedRange._start || !selectedRange._end) return // fill is not supported for new rows yet if (rw.rowMeta.new) return const endRow = Math.min(selectedRange._start.row + 100, row) fillRange.endRange({ row: endRow, col: selectedRange._end.col, }) scrollToCell?.(endRow, col) return } if (!isMouseDown.value) { return } const limitedEnd = limitSelection(selectedRange.start, { row, col }) selectedRange.endRange(limitedEnd) scrollToCell?.(limitedEnd.row, limitedEnd.col) // avoid selecting text event.preventDefault() } function handleMouseDown(event: MouseEvent, row: number, col: number) { // if there was a right click on selected range, don't restart the selection if ( (event?.button !== MAIN_MOUSE_PRESSED || (event?.button === MAIN_MOUSE_PRESSED && event.ctrlKey)) && selectRangeMap.value[`${row}-${col}`] ) { return } // if edit is enabled, don't start the selection (some cells shrink after edit mode, which causes the selection to expand if flag is set) if (!editEnabled.value) isMouseDown.value = true contextMenu.value = false // avoid text selection event.preventDefault() // if shift key is pressed, extend the selection if (event.shiftKey) { // if shift key is pressed, don't restart the selection (unless there is no active cell) if (activeCell.col === null || activeCell.row === null) { selectedRange.startRange({ row, col }) } selectedRange.endRange({ row, col }) return } // start a new selection selectedRange.startRange({ row, col }) if (activeCell.row !== row || activeCell.col !== col) { // clear active cell on selection start // activeCell.row = null activeCell.col = null } } const handleCellClick = (event: MouseEvent, row: number, col: number) => { // if shift key is pressed, don't change the active cell (unless there is no active cell) if (!event.shiftKey || activeCell.col === null || activeCell.row === null) { makeActive(row, col) } scrollToCell?.(row, col) } const handleMouseUp = (_event: MouseEvent) => { if (isFillMode.value) { isFillMode.value = false if (fillRange._start === null || fillRange._end === null) return if (selectedRange._start !== null && selectedRange._end !== null) { const tempActiveCell = { row: selectedRange._start.row, col: selectedRange._start.col } let cprows if (isArrayStructure) { cprows = (unref(data) as Row[]).slice(selectedRange.start.row, selectedRange.end.row + 1) } else { cprows = Array.from(unref(data) as Map) .filter(([index]) => index >= selectedRange.start.row && index <= selectedRange.end.row) .map(([, row]) => row) } const cpcols = unref(fields).slice(selectedRange.start.col, selectedRange.end.col + 1) // slice the selected cols for copy const rawMatrix = serializeRange(cprows, cpcols).json const fillDirection = fillRange._start.row <= fillRange._end.row ? 1 : -1 let fillIndex = fillDirection === 1 ? 0 : rawMatrix.length - 1 const rowsToPaste: Row[] = [] const propsToPaste: string[] = [] for ( let row = fillRange._start.row; fillDirection === 1 ? row <= fillRange._end.row : row >= fillRange._end.row; row += fillDirection ) { if (selectRangeMap.value[`${row}-${selectedRange.start.col}`]) { continue } const rowObj = isArrayStructure ? (unref(data) as Row[])[row] : (unref(data) as Map).get(row) if (!rowObj) { continue } let pasteIndex = 0 for (let col = fillRange.start.col; col <= fillRange.end.col; col++) { const colObj = unref(fields)[col] if (!isPasteable(rowObj, colObj)) { pasteIndex++ continue } propsToPaste.push(colObj.title!) const pasteValue = convertCellData( { value: rawMatrix[fillIndex][pasteIndex], to: colObj.uidt as UITypes, column: colObj, appInfo: unref(appInfo), }, isMysql(meta.value?.source_id), true, ) if (pasteValue !== undefined) { rowObj.row[colObj.title!] = pasteValue rowsToPaste.push(rowObj) } pasteIndex++ } if (fillDirection === 1) { fillIndex = fillIndex < rawMatrix.length - 1 ? fillIndex + 1 : 0 } else { fillIndex = fillIndex >= 1 ? fillIndex - 1 : rawMatrix.length - 1 } } bulkUpdateRows?.(rowsToPaste, propsToPaste).then(() => { if (fillRange._start === null || fillRange._end === null) return selectedRange.startRange(tempActiveCell) selectedRange.endRange(fillRange._end) makeActive(tempActiveCell.row, tempActiveCell.col) fillRange.clear() }) } else { fillRange.clear() } return } if (isMouseDown.value) { isMouseDown.value = false // timeout is needed, because we want to set cell as active AFTER all the child's click handler's called // this is needed e.g. for date field edit, where two clicks had to be done - one to select cell, and another one to open date dropdown setTimeout(() => { if (selectedRange._start) { if (activeCell.row !== selectedRange._start.row || activeCell.col !== selectedRange._start.col) { makeActive(selectedRange._start.row, selectedRange._start.col) } } }, 0) } } const handleKeyDownAction = async (e: KeyboardEvent) => { const cmdOrCtrl = isMac() ? e.metaKey : e.ctrlKey if (activeCell.row === null || activeCell.col === null) return switch (e.key) { case 'Tab': selectedRange.clear() if (e.shiftKey) { if (activeCell.col > 0) { activeCell.col-- editEnabled.value = false } else if (activeCell.row > 0) { activeCell.row-- activeCell.col = unref(columnLength.value) - 1 editEnabled.value = false } } else { if (activeCell.col < unref(columnLength.value) - 1) { activeCell.col++ editEnabled.value = false } else if (activeCell.row < (isArrayStructure ? (unref(data) as Row[]).length : unref(_totalRows!)) - 1) { activeCell.row++ activeCell.col = 0 editEnabled.value = false } } scrollToCell?.() break case 'ArrowRight': if (e.shiftKey) { if (cmdOrCtrl) { editEnabled.value = false selectedRange.endRange({ row: selectedRange._end?.row ?? activeCell.row, col: unref(columnLength.value) - 1, }) scrollToCell?.(selectedRange._end?.row, selectedRange._end?.col) } else if ((selectedRange._end?.col ?? activeCell.col) < unref(columnLength.value) - 1) { editEnabled.value = false selectedRange.endRange({ row: selectedRange._end?.row ?? activeCell.row, col: (selectedRange._end?.col ?? activeCell.col) + 1, }) scrollToCell?.(selectedRange._end?.row, selectedRange._end?.col) } } else { selectedRange.clear() if (activeCell.col < unref(columnLength.value) - 1) { activeCell.col++ selectedRange.startRange({ row: activeCell.row, col: activeCell.col }) scrollToCell?.() editEnabled.value = false } } break case 'ArrowLeft': if (e.shiftKey) { if (cmdOrCtrl) { editEnabled.value = false selectedRange.endRange({ row: selectedRange._end?.row ?? activeCell.row, col: 0, }) scrollToCell?.(selectedRange._end?.row, selectedRange._end?.col) } else if ((selectedRange._end?.col ?? activeCell.col) > 0) { editEnabled.value = false selectedRange.endRange({ row: selectedRange._end?.row ?? activeCell.row, col: (selectedRange._end?.col ?? activeCell.col) - 1, }) scrollToCell?.(selectedRange._end?.row, selectedRange._end?.col) } } else { selectedRange.clear() if (activeCell.col > 0) { activeCell.col-- selectedRange.startRange({ row: activeCell.row, col: activeCell.col }) scrollToCell?.() editEnabled.value = false } } break case 'ArrowUp': if (e.shiftKey) { const anchor = selectedRange._start ?? activeCell let newEnd: Cell if (cmdOrCtrl) { newEnd = { row: 0, col: selectedRange._end?.col ?? activeCell.col } } else { newEnd = { row: (selectedRange._end?.row ?? activeCell.row) - 1, col: selectedRange._end?.col ?? activeCell.col, } } const limitedEnd = limitSelection(anchor, newEnd) editEnabled.value = false selectedRange.endRange(limitedEnd) scrollToCell?.(limitedEnd.row, limitedEnd.col, 'instant') } else { selectedRange.clear() if (activeCell.row > 0) { activeCell.row-- selectedRange.startRange({ row: activeCell.row, col: activeCell.col }) scrollToCell?.() editEnabled.value = false } } onActiveCellChanged?.() break case 'ArrowDown': if (e.shiftKey) { const anchor = selectedRange._start ?? activeCell let newEnd: Cell if (cmdOrCtrl) { newEnd = { row: (isArrayStructure ? (unref(data) as Row[]).length : unref(_totalRows!)) - 1, col: selectedRange._end?.col ?? activeCell.col, } } else { newEnd = { row: (selectedRange._end?.row ?? activeCell.row) + 1, col: selectedRange._end?.col ?? activeCell.col, } } const limitedEnd = limitSelection(anchor, newEnd) editEnabled.value = false selectedRange.endRange(limitedEnd) scrollToCell?.(limitedEnd.row, limitedEnd.col, 'instant') } else { selectedRange.clear() if (activeCell.row < (isArrayStructure ? (unref(data) as Row[]).length : unref(_totalRows!))) { activeCell.row++ selectedRange.startRange({ row: activeCell.row, col: activeCell.col }) scrollToCell?.() editEnabled.value = false } } onActiveCellChanged?.() break case 'Enter': { selectedRange.clear() let row if (isArrayStructure) { row = (unref(data) as Row[])[activeCell.row] } else { row = (unref(data) as Map).get(activeCell.row) } makeEditable(row, unref(fields)[activeCell.col]) break } case 'Delete': case 'Backspace': if (isDataReadOnly.value) { return } if (selectedRange.isSingleCell()) { selectedRange.clear() await clearCell(activeCell as { row: number; col: number }) } else { await clearSelectedRangeOfCells() } break } } const handleThrottledKeyDownAction = useThrottleFn(handleKeyDownAction, 60) const handleKeyDown = async (e: KeyboardEvent) => { // invoke the keyEventHandler if provided and return if it returns true if (isArrayStructure ? await keyEventHandler?.(e) : keyEventHandler?.(e)) { return true } if (isExpandedCellInputExist()) { return } if (!isCellActive.value || activeCell.row === null || activeCell.col === null) { return } /** on tab key press navigate through cells */ switch (e.key) { case 'Tab': case 'Enter': case 'Delete': case 'Backspace': case 'ArrowRight': case 'ArrowLeft': case 'ArrowUp': case 'ArrowDown': e.preventDefault() handleThrottledKeyDownAction(e) break default: { const rowObj = isArrayStructure ? (unref(data) as Row[])[activeCell.row] : (unref(data) as Map).get(activeCell.row) if (!rowObj) return const columnObj = unref(fields)[activeCell.col] if ( (!unref(editEnabled) || !isTypableInputColumn(columnObj)) && !isDrawerOrModalExist() && (isMac() ? e.metaKey : e.ctrlKey) ) { switch (e.keyCode) { // copy - ctrl/cmd +c case 67: await copyValue() break } } if (unref(editEnabled) || e.ctrlKey || e.altKey || e.metaKey) { return true } /** on letter key press make cell editable and empty */ if (e.key.length === 1) { if (!unref(isPkAvail) && !rowObj.rowMeta.new) { // Update not allowed for table which doesn't have primary Key return message.info(t('msg.info.updateNotAllowedWithoutPK')) } if (isTypableInputColumn(columnObj) && makeEditable(rowObj, columnObj) && columnObj.title) { if (columnObj.uidt === UITypes.LongText) { if (rowObj.row[columnObj.title] === '
') { rowObj.row[columnObj.title] = e.key } else if (parseProp(columnObj.meta).richMode) { rowObj.row[columnObj.title] = rowObj.row[columnObj.title] ? rowObj.row[columnObj.title] + e.key : e.key } } else { rowObj.row[columnObj.title] = '' } } // editEnabled = true } } break } } const resetSelectedRange = () => selectedRange.clear() const clearSelectedRange = selectedRange.clear.bind(selectedRange) const handlePaste = async (e: ClipboardEvent) => { if (isDataReadOnly.value) { return } if (isDrawerOrModalExist() || isExpandedCellInputExist() || isLinkDropdownExist()) { return } if (!isCellActive.value) { return } if (unref(editEnabled)) { return } if (activeCell.row === null || activeCell.row === undefined || activeCell.col === null || activeCell.col === undefined) { return } e.preventDefault() // Replace \" with " in clipboard data let clipboardData = e.clipboardData?.getData('text/plain') || '' if (clipboardData?.endsWith('\n')) { // Remove '\n' from the end of the clipboardData // When copying from XLS/XLSX files, there is an extra '\n' appended to the end // this overwrites one additional cell information when we paste in NocoDB clipboardData = clipboardData.replace(/\n$/, '') } try { if (clipboardData?.includes('\n') || clipboardData?.includes('\t')) { // if the clipboard data contains new line or tab, then it is a matrix or LongText const parsedClipboard = parse(clipboardData, { delimiter: '\t', escapeChar: '\\' }) if (parsedClipboard.errors.length > 0) { throw new Error(parsedClipboard.errors[0].message) } const clipboardMatrix = parsedClipboard.data as string[][] const selectionRowCount = Math.max(clipboardMatrix.length, selectedRange.end.row - selectedRange.start.row + 1) const pasteMatrixCols = clipboardMatrix[0].length const existingFields = unref(fields) const startColIndex = activeCell.col const existingColCount = existingFields.length - startColIndex const newColsNeeded = Math.max(0, pasteMatrixCols - existingColCount) let tempTotalRows = 0 let totalRowsBeforeActiveCell let availableRowsToUpdate let rowsToAdd if (isArrayStructure) { const { totalRows: _tempTr, page = 1, pageSize = 100 } = unref(paginationData)! tempTotalRows = _tempTr as number totalRowsBeforeActiveCell = (page - 1) * pageSize + activeCell.row availableRowsToUpdate = Math.max(0, tempTotalRows - totalRowsBeforeActiveCell) rowsToAdd = Math.max(0, selectionRowCount - availableRowsToUpdate) } else { tempTotalRows = unref(_totalRows) as number totalRowsBeforeActiveCell = activeCell.row availableRowsToUpdate = Math.max(0, tempTotalRows - totalRowsBeforeActiveCell) rowsToAdd = Math.max(0, selectionRowCount - availableRowsToUpdate) } let options = { continue: false, expand: (rowsToAdd > 0 || newColsNeeded > 0) && !isArrayStructure, } if (options.expand && !isArrayStructure) { options = await expandRows?.({ newRows: rowsToAdd, newColumns: newColsNeeded, cellsOverwritten: Math.min(availableRowsToUpdate, selectionRowCount) * (pasteMatrixCols - newColsNeeded), rowsUpdated: Math.min(availableRowsToUpdate, selectionRowCount), }) if (!options.continue) return } let colsToPaste const bulkOpsCols = [] if (options.expand) { colsToPaste = existingFields.slice(startColIndex, startColIndex + pasteMatrixCols) if (newColsNeeded > 0) { const columnsHash = (await api.dbTableColumn.hash(meta.value?.id)).hash const columnsLength = meta.value?.columns?.length || 0 for (let i = 0; i < newColsNeeded; i++) { const tempCol = { uidt: UITypes.SingleLineText, order: columnsLength + i, column_order: { order: columnsLength + i, view_id: activeView.value?.id, }, view_id: activeView.value?.id, table_name: meta.value?.table_name, } const newColTitle = generateUniqueColumnName({ metaColumns: [...(meta.value?.columns ?? []), ...bulkOpsCols.map(({ column }) => column)], formState: tempCol, }) bulkOpsCols.push({ op: 'add', column: { ...tempCol, title: newColTitle, }, }) } await api.dbTableColumn.bulk(meta.value?.id, { hash: columnsHash, ops: bulkOpsCols, }) await getMeta(meta?.value?.id as string, true) colsToPaste = [...colsToPaste, ...bulkOpsCols.map(({ column }) => column)] } } else { colsToPaste = unref(fields).slice(activeCell.col, activeCell.col + pasteMatrixCols) } const dataRef = unref(data) const updatedRows: Row[] = [] const newRows: Row[] = [] const propsToPaste: string[] = [] let isInfoShown = false for (let i = 0; i < selectionRowCount; i++) { const clipboardRowIndex = i % clipboardMatrix.length let targetRow: any if (i < availableRowsToUpdate) { const absoluteRowIndex = totalRowsBeforeActiveCell + i if (isArrayStructure) { targetRow = i < (dataRef as Row[]).length ? (dataRef as Row[])[absoluteRowIndex] : { row: {}, oldRow: {}, rowMeta: { isExistingRow: true, rowIndex: absoluteRowIndex, }, } } else { targetRow = (dataRef as Map).get(absoluteRowIndex) || { row: {}, oldRow: {}, rowMeta: { isExistingRow: true, rowIndex: absoluteRowIndex, }, } } updatedRows.push(targetRow) } else { targetRow = { row: {}, oldRow: {}, rowMeta: { isExistingRow: false, }, } newRows.push(targetRow) } for (let j = 0; j < clipboardMatrix[clipboardRowIndex].length; j++) { const column = colsToPaste[j] if (!column) continue if (column && isPasteable(targetRow, column)) { propsToPaste.push(column.title!) const pasteValue = convertCellData( { value: clipboardMatrix[clipboardRowIndex][j], to: column.uidt as UITypes, column, appInfo: unref(appInfo), oldValue: column.uidt === UITypes.Attachment ? targetRow.row[column.title!] : undefined, }, isMysql(meta.value?.source_id), true, ) if (pasteValue !== undefined) { targetRow.row[column.title!] = pasteValue } } else if ((isBt(column) || isOo(column) || isMm(column)) && !isInfoShown) { message.info(t('msg.info.groupPasteIsNotSupportedOnLinksColumn')) isInfoShown = true } } } if (options.expand && !isArrayStructure) { await bulkUpsertRows?.( newRows, updatedRows, propsToPaste, undefined, bulkOpsCols.map(({ column }) => column), ) scrollToCell?.() } else { await bulkUpdateRows?.(updatedRows, propsToPaste) } } else { if (selectedRange.isSingleCell()) { const rowObj = isArrayStructure ? (unref(data) as Row[])[activeCell.row] : (unref(data) as Map).get(activeCell.row) if (!rowObj) return const columnObj = unref(fields)[activeCell.col] // handle belongs to column, skip custom links if (isBt(columnObj) && !columnObj.meta?.custom) { const pasteVal = convertCellData( { value: clipboardData, to: columnObj.uidt as UITypes, column: columnObj, appInfo: unref(appInfo), }, isMysql(meta.value?.source_id), ) if (pasteVal === undefined) return const foreignKeyColumn = meta.value?.columns?.find( (column: ColumnType) => column.id === (columnObj.colOptions as LinkToAnotherRecordType)?.fk_child_column_id, ) if (!foreignKeyColumn) return const relatedTableMeta = await getMeta((columnObj.colOptions as LinkToAnotherRecordType).fk_related_model_id!) // update old row to allow undo redo as bt column update only through foreignKeyColumn title rowObj.oldRow[columnObj.title!] = rowObj.row[columnObj.title!] rowObj.oldRow[foreignKeyColumn.title!] = rowObj.row[columnObj.title!] ? extractPkFromRow(rowObj.row[columnObj.title!], (relatedTableMeta as any)!.columns!) : null rowObj.row[columnObj.title!] = pasteVal?.value rowObj.row[foreignKeyColumn.title!] = pasteVal?.value ? extractPkFromRow(pasteVal.value, (relatedTableMeta as any)!.columns!) : null return await syncCellData?.({ ...activeCell, updatedColumnTitle: foreignKeyColumn.title }) } if (isMm(columnObj)) { const pasteVal = convertCellData( { value: clipboardData, to: columnObj.uidt as UITypes, column: columnObj, appInfo: unref(appInfo), }, isMysql(meta.value?.source_id), ) if (pasteVal === undefined) return const pasteRowPk = extractPkFromRow(rowObj.row, meta.value?.columns as ColumnType[]) if (!pasteRowPk) return const oldCellValue = rowObj.row[columnObj.title!] rowObj.row[columnObj.title!] = pasteVal.value let result try { result = await api.dbDataTableRow.nestedListCopyPasteOrDeleteAll( meta.value?.id as string, columnObj.id as string, [ { operation: 'copy', rowId: pasteVal.rowId, columnId: pasteVal.columnId, fk_related_model_id: pasteVal.fk_related_model_id, }, { operation: 'paste', rowId: pasteRowPk, columnId: columnObj.id as string, fk_related_model_id: (columnObj.colOptions as LinkToAnotherRecordType).fk_related_model_id || pasteVal.fk_related_model_id, }, ], { viewId: activeView?.value?.id }, ) } catch { rowObj.row[columnObj.title!] = oldCellValue return } if (result && result?.link && result?.unlink && Array.isArray(result.link) && Array.isArray(result.unlink)) { if (!result.link.length && !result.unlink.length) { rowObj.row[columnObj.title!] = oldCellValue return } if (isArrayStructure) { addUndo({ redo: { fn: async ( activeCell: Cell, col: ColumnType, row: Row, pg: PaginatedType, value: number, result: { link: any[]; unlink: any[] }, ) => { if (paginationDataRef.value?.pageSize === pg?.pageSize) { if (paginationDataRef.value?.page !== pg?.page) { await changePage?.(pg?.page) } const pasteRowPk = extractPkFromRow(row.row, meta.value?.columns as ColumnType[]) const rowObj = (unref(data) as Row[])[activeCell.row] const columnObj = unref(fields)[activeCell.col] if ( pasteRowPk === extractPkFromRow(rowObj.row, meta.value?.columns as ColumnType[]) && columnObj.id === col.id ) { await Promise.all([ result.link.length && api.dbDataTableRow.nestedLink( meta.value?.id as string, columnObj.id as string, encodeURIComponent(pasteRowPk), result.link, { viewId: activeView?.value?.id, }, ), result.unlink.length && api.dbDataTableRow.nestedUnlink( meta.value?.id as string, columnObj.id as string, encodeURIComponent(pasteRowPk), result.unlink, { viewId: activeView?.value?.id }, ), ]) rowObj.row[columnObj.title!] = value await syncCellData?.(activeCell) } else { throw new Error(t('msg.recordCouldNotBeFound')) } } else { throw new Error(t('msg.pageSizeChanged')) } }, args: [ clone(activeCell), clone(columnObj), clone(rowObj), clone(paginationDataRef.value), clone(pasteVal.value), result, ], }, undo: { fn: async ( activeCell: Cell, col: ColumnType, row: Row, pg: PaginatedType, value: number, result: { link: any[]; unlink: any[] }, ) => { if (paginationDataRef.value?.pageSize === pg.pageSize) { if (paginationDataRef.value?.page !== pg.page) { await changePage?.(pg.page!) } const pasteRowPk = extractPkFromRow(row.row, meta.value?.columns as ColumnType[]) const rowObj = (unref(data) as Row[])[activeCell.row] const columnObj = unref(fields)[activeCell.col] if ( pasteRowPk === extractPkFromRow(rowObj.row, meta.value?.columns as ColumnType[]) && columnObj.id === col.id ) { await Promise.all([ result.unlink.length && api.dbDataTableRow.nestedLink( meta.value?.id as string, columnObj.id as string, encodeURIComponent(pasteRowPk), result.unlink, ), result.link.length && api.dbDataTableRow.nestedUnlink( meta.value?.id as string, columnObj.id as string, encodeURIComponent(pasteRowPk), result.link, ), ]) rowObj.row[columnObj.title!] = value await syncCellData?.(activeCell) } else { throw new Error(t('msg.recordCouldNotBeFound')) } } else { throw new Error(t('msg.pageSizeChanged')) } }, args: [ clone(activeCell), clone(columnObj), clone(rowObj), clone(paginationDataRef.value), clone(oldCellValue), result, ], }, scope: defineViewScope({ view: activeView?.value }), }) } else { addUndo({ redo: { fn: async ( activeCell: Cell, col: ColumnType, row: Row, value: number, result: { link: any[]; unlink: any[] }, ) => { const pasteRowPk = extractPkFromRow(row.row, meta.value?.columns as ColumnType[]) const rowObj = (unref(data) as Map).get(activeCell.row) if (!rowObj) return const columnObj = unref(fields)[activeCell.col] if ( pasteRowPk === extractPkFromRow(rowObj.row, meta.value?.columns as ColumnType[]) && columnObj.id === col.id ) { await Promise.all([ result.link.length && api.dbDataTableRow.nestedLink( meta.value?.id as string, columnObj.id as string, encodeURIComponent(pasteRowPk), result.link, { viewId: activeView?.value?.id, }, ), result.unlink.length && api.dbDataTableRow.nestedUnlink( meta.value?.id as string, columnObj.id as string, encodeURIComponent(pasteRowPk), result.unlink, { viewId: activeView?.value?.id }, ), ]) rowObj.row[columnObj.title!] = value await syncCellData?.(activeCell) } }, args: [clone(activeCell), clone(columnObj), clone(rowObj), clone(pasteVal.value), result], }, undo: { fn: async ( activeCell: Cell, col: ColumnType, row: Row, value: number, result: { link: any[]; unlink: any[] }, ) => { const pasteRowPk = extractPkFromRow(row.row, meta.value?.columns as ColumnType[]) const rowObj = (unref(data) as Map).get(activeCell.row) if (!rowObj) return const columnObj = unref(fields)[activeCell.col] if ( pasteRowPk === extractPkFromRow(rowObj.row, meta.value?.columns as ColumnType[]) && columnObj.id === col.id ) { await Promise.all([ result.unlink.length && api.dbDataTableRow.nestedLink( meta.value?.id as string, columnObj.id as string, encodeURIComponent(pasteRowPk), result.unlink, ), result.link.length && api.dbDataTableRow.nestedUnlink( meta.value?.id as string, columnObj.id as string, encodeURIComponent(pasteRowPk), result.link, ), ]) rowObj.row[columnObj.title!] = value await syncCellData?.(activeCell) } }, args: [clone(activeCell), clone(columnObj), clone(rowObj), clone(oldCellValue), result], }, scope: defineViewScope({ view: activeView?.value }), }) } } return await syncCellData?.(activeCell) } if (!isPasteable(rowObj, columnObj, true)) { return } const pasteValue = convertCellData( { value: clipboardData, to: columnObj.uidt as UITypes, column: columnObj, appInfo: unref(appInfo), files: columnObj.uidt === UITypes.Attachment && e.clipboardData?.files?.length ? e.clipboardData?.files : undefined, oldValue: rowObj.row[columnObj.title!], }, isMysql(meta.value?.source_id), ) if (columnObj.uidt === UITypes.Attachment && e.clipboardData?.files?.length && pasteValue?.length) { const newAttachments = await handleFileUploadAndGetCellValue(pasteValue, columnObj.id!, rowObj.row[columnObj.title!]) rowObj.row[columnObj.title!] = newAttachments ? JSON.stringify(newAttachments) : null } else if (pasteValue !== undefined) { rowObj.row[columnObj.title!] = pasteValue } await syncCellData?.(activeCell) } else { const start = selectedRange.start const end = selectedRange.end const startRow = Math.min(start.row, end.row) const endRow = Math.max(start.row, end.row) const startCol = Math.min(start.col, end.col) const endCol = Math.max(start.col, end.col) const cols = unref(fields).slice(startCol, endCol + 1) let rows if (isArrayStructure) { rows = (unref(data) as Row[]).slice(startRow, endRow + 1) } else { rows = Array.from(unref(data) as Map) .filter(([index]) => index >= startRow && index <= endRow) .map(([, row]) => row) } const props = [] let pasteValue let isInfoShown = false const files = e.clipboardData?.files for (const row of rows) { // TODO handle insert new row if (!row || row.rowMeta.new) continue for (const col of cols) { if (!col.title || !isPasteable(row, col)) { if ((isBt(col) || isOo(col) || isMm(col)) && !isInfoShown) { message.info(t('msg.info.groupPasteIsNotSupportedOnLinksColumn')) isInfoShown = true } continue } if (files?.length) { if (col.uidt !== UITypes.Attachment) { continue } if (pasteValue === undefined) { const fileUploadPayload = convertCellData( { value: '', to: col.uidt as UITypes, column: col, appInfo: unref(appInfo), files, oldValue: row.row[col.title], }, isMysql(meta.value?.source_id), true, ) if (fileUploadPayload?.length) { const newAttachments = await handleFileUploadAndGetCellValue(fileUploadPayload, col.id!, row.row[col.title!]) pasteValue = newAttachments ? JSON.stringify(newAttachments) : null } } } else { pasteValue = convertCellData( { value: clipboardData, to: col.uidt as UITypes, column: col, appInfo: unref(appInfo), oldValue: row.row[col.title], }, isMysql(meta.value?.source_id), true, ) } props.push(col.title) if (pasteValue !== undefined) { row.row[col.title] = pasteValue } } } if (!props.length) return await bulkUpdateRows?.(rows, props) } } } catch (error: any) { console.error(error) message.error(await extractSdkResponseErrorMsg(error)) } } function fillHandleMouseDown(event: MouseEvent) { if (event?.button !== MAIN_MOUSE_PRESSED) { return } isFillMode.value = true if (selectedRange._start && selectedRange._end) { fillRange.startRange({ row: selectedRange._start?.row, col: selectedRange._start.col }) fillRange.endRange({ row: selectedRange._end?.row, col: selectedRange._end.col }) } event.preventDefault() } async function handleFileUploadAndGetCellValue(files: File[], columnId: string, oldValue: AttachmentType[]) { const newAttachments: AttachmentType[] = [] try { const data = await api.storage.upload( { path: [NOCO, base.value.id, meta.value?.id, columnId].join('/'), }, { files, }, ) // add suffix in duplicate file title for (const uploadedFile of data) { newAttachments.push({ ...uploadedFile, title: populateUniqueFileName( uploadedFile?.title, [...handleParseAttachmentCellData(oldValue), ...newAttachments].map((fn) => fn?.title || fn?.fileName), uploadedFile?.mimetype, ), }) } return newAttachments } catch (e: any) { message.error(e.message || t('msg.error.internalError')) } } function handleParseAttachmentCellData(value: T): T { const parsedVal = parseProp(value) if (parsedVal && Array.isArray(parsedVal)) { return parsedVal as T } else { return [] as T } } useEventListener(document, 'keydown', handleKeyDown) useEventListener(document, 'mouseup', handleMouseUp) useEventListener(document, 'paste', handlePaste) useEventListener(fillHandle, 'mousedown', fillHandleMouseDown) return { isCellActive, handleMouseDown, handleMouseOver, clearSelectedRange, copyValue, activeCell, handleCellClick, resetSelectedRange, selectedRange, makeActive, isMouseDown, isFillMode, selectRangeMap, fillRangeMap, } }