'use strict'; /** * Copyright Yaco Sistemas S.L. 2011. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS-IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import log4js from 'log4js'; import AttributeMap from '../../static/js/AttributeMap'; import {deserializeOps} from '../../static/js/Changeset'; const contentcollector = require('../../static/js/contentcollector'); import jsdom from 'jsdom'; import {PadType} from "../types/PadType"; import {Builder} from "../../static/js/Builder"; // Mirror of `Pad.SYSTEM_AUTHOR_ID`. Imported as a literal to avoid a // circular require between Pad and ImportHtml during module init. const SYSTEM_AUTHOR_ID = 'a.etherpad-system'; const apiLogger = log4js.getLogger('ImportHtml'); let processor:any; exports.setPadHTML = async (pad: PadType, html:string, authorId = '') => { if (processor == null) { const [{rehype}, {default: minifyWhitespace}] = await Promise.all([import('rehype'), import('rehype-minify-whitespace')]); processor = rehype().use(minifyWhitespace, {newlines: false}); } html = String(await processor.process(html)); const {window: {document}} = new jsdom.JSDOM(html); // Appends a line break, used by Etherpad to ensure a caret is available // below the last line of an import document.body.appendChild(document.createElement('p')); apiLogger.debug('html:'); apiLogger.debug(html); // Convert a dom tree into a list of lines and attribute liens // using the content collector object const cc = contentcollector.makeContentCollector(true, null, pad.pool); try { // we use a try here because if the HTML is bad it will blow up cc.collectContent(document.body); } catch (err: any) { apiLogger.warn(`Error processing HTML: ${err.stack || err}`); throw err; } const result = cc.finish(); apiLogger.debug('Lines:'); let i; for (i = 0; i < result.lines.length; i++) { apiLogger.debug(`Line ${i + 1} text: ${result.lines[i]}`); apiLogger.debug(`Line ${i + 1} attributes: ${result.lineAttribs[i]}`); } // Get the new plain text and its attributes const newText = result.lines.join('\n'); apiLogger.debug('newText:'); apiLogger.debug(newText); const newAttribs = `${result.lineAttribs.join('|1+1')}|1+1`; // create a new changeset with a helper builder object const builder = new Builder(1); // Every insert op needs an `author` attribute (the appendRevision // precondition). The contentcollector tags ops with style // attributes (bold, italic, etc.) but doesn't add an author; for // server-side imports the author is implicit in the caller, so // substitute the system author when no explicit one was supplied — // same pattern setText/spliceText already use. const effectiveAuthorId = (newText.length > 0 && !authorId) ? SYSTEM_AUTHOR_ID : authorId; // assemble each line into the builder let textIndex = 0; const newTextStart = 0; const newTextEnd = newText.length; for (const op of deserializeOps(newAttribs)) { const nextIndex = textIndex + op.chars; if (!(nextIndex <= newTextStart || textIndex >= newTextEnd)) { const start = Math.max(newTextStart, textIndex); const end = Math.min(newTextEnd, nextIndex); // Merge via AttributeMap so the result is in canonical order // (sorted by pool index) — a raw `*N` prefix could violate // checkRep's canonical-form assertion. let mergedAttribs = op.attribs; if (effectiveAuthorId) { mergedAttribs = AttributeMap.fromString(op.attribs, pad.pool) .set('author', effectiveAuthorId) .toString(); } builder.insert(newText.substring(start, end), mergedAttribs); } textIndex = nextIndex; } // the changeset is ready! const theChangeset = builder.toString(); apiLogger.debug(`The changeset: ${theChangeset}`); // Pass effectiveAuthorId here too so meta.author on the stored // revision matches the author attribute we merged into the op // attribs above — and so the padCreate / padUpdate hooks and // authorManager.addPad link the same author identity. await pad.setText('\n', effectiveAuthorId); await pad.appendRevision(theChangeset, effectiveAuthorId); };