import markdownUtils from './markdownUtils'; import { ResourceEntity } from './services/database/types'; import { htmlentities } from '@joplin/utils/html'; const stringPadding = require('string-padding'); const stringToStream = require('string-to-stream'); const resourceUtils = require('./resourceUtils.js'); const cssParser = require('@adobe/css-tools'); const BLOCK_OPEN = '[[BLOCK_OPEN]]'; const BLOCK_CLOSE = '[[BLOCK_CLOSE]]'; const NEWLINE = '[[NEWLINE]]'; const NEWLINE_MERGED = '[[MERGED]]'; const SPACE = '[[SPACE]]'; enum SectionType { Text = 'text', Tr = 'tr', Td = 'td', Table = 'table', Caption = 'caption', Hidden = 'hidden', Code = 'code', } interface Section { type: SectionType; parent: Section; lines: any[]; isHeader?: boolean; } interface ParserStateTag { name: string; visible: boolean; isCodeBlock: boolean; isHighlight: boolean; } enum ListTag { Ul = 'ul', Ol = 'ol', CheckboxList = 'checkboxList', TaskList = 'taskList', } interface ParserStateList { tag: ListTag; counter: number; startedText: boolean; } interface ParserState { inCode: boolean[]; inPre: boolean; inQuote: boolean; lists: ParserStateList[]; anchorAttributes: any[]; spanAttributes: string[]; tags: ParserStateTag[]; currentCode?: string; } interface ExtractedTask { title: string; completed: boolean; groupId: string; } interface EnexXmlToMdArrayResult { content: Section; resources: ResourceEntity[]; } function processMdArrayNewLines(md: string[]): string { while (md.length && md[0] === BLOCK_OPEN) { md.shift(); } while (md.length && md[md.length - 1] === BLOCK_CLOSE) { md.pop(); } let temp = []; let last = ''; for (let i = 0; i < md.length; i++) { const v = md[i]; if (isNewLineBlock(last) && isNewLineBlock(v) && last === v) { // Skip it } else { temp.push(v); } last = v; } md = temp; temp = []; last = ''; for (let i = 0; i < md.length; i++) { const v = md[i]; if (last === BLOCK_CLOSE && v === BLOCK_OPEN) { temp.pop(); temp.push(NEWLINE_MERGED); } else { temp.push(v); } last = v; } md = temp; temp = []; last = ''; for (let i = 0; i < md.length; i++) { const v = md[i]; if (last === NEWLINE && (v === NEWLINE_MERGED || v === BLOCK_CLOSE)) { // Skip it } else { temp.push(v); } last = v; } md = temp; // NEW!!! temp = []; last = ''; for (let i = 0; i < md.length; i++) { const v = md[i]; if (last === NEWLINE && (v === NEWLINE_MERGED || v === BLOCK_OPEN)) { // Skip it } else { temp.push(v); } last = v; } md = temp; if (md.length > 2) { if (md[md.length - 2] === NEWLINE_MERGED && md[md.length - 1] === NEWLINE) { md.pop(); } } let output = ''; let previous = ''; let start = true; for (let i = 0; i < md.length; i++) { const v = md[i]; let add = ''; if (v === BLOCK_CLOSE || v === BLOCK_OPEN || v === NEWLINE || v === NEWLINE_MERGED) { add = '\n'; } else if (v === SPACE) { if (previous === SPACE || previous === '\n' || start) { continue; // skip } else { add = ' '; } } else { add = v; } start = false; output += add; previous = add; } if (!output.trim().length) return ''; // To simplify the result, we only allow up to one empty line between blocks of text const mergeMultipleNewLines = function(lines: string[]) { const output = []; let newlineCount = 0; for (let i = 0; i < lines.length; i++) { const line = lines[i]; if (!line.trim()) { newlineCount++; } else { newlineCount = 0; } if (newlineCount >= 2) continue; output.push(line); } return output; }; let lines = output.replace(/\\r/g, '').split('\n'); lines = formatMdLayout(lines); lines = mergeMultipleNewLines(lines); return lines.join('\n'); } // While the processMdArrayNewLines() function adds newlines in a way that's technically correct, the resulting Markdown can look messy. // This is because while a "block" element should be surrounded by newlines, in practice, some should be surrounded by TWO new lines, while // others by only ONE. // // For instance, this: // //
  • one
  • //
  • two
  • //
  • three
  • // // should result in this: // // - one // - two // - three // // While this: // //

    Some long paragraph

    And another one

    And the last paragraph

    // // should result in this: // // Some long paragraph // // And another one // // And the last paragraph // // So in one case, one newline between tags, and in another two newlines. In HTML this would be done via CSS, but in Markdown we need // to add new lines. It's also important to get these newlines right because two blocks of text next to each others might be renderered // differently than if there's a newlines between them. So the function below parses the almost final MD and add new lines depending // on various rules. const isHeading = function(line: string) { return !!line.match(/^#+\s/); }; const isListItem = function(line: string) { return line && line.trim().indexOf('- ') === 0; }; const isCodeLine = function(line: string) { return line && line.indexOf('\t') === 0; }; const isTableLine = function(line: string) { return line.indexOf('| ') === 0; }; const isPlainParagraph = function(line: string) { // Note: if a line is no longer than 80 characters, we don't consider it's a paragraph, which // means no newlines will be added before or after. This is to handle text that has been // written with "hard" new lines. if (!line || line.length < 80) return false; if (isListItem(line)) return false; if (isHeading(line)) return false; if (isCodeLine(line)) return false; if (isTableLine(line)) return false; return true; }; function formatMdLayout(lines: string[]) { let previous = ''; const newLines = []; for (let i = 0; i < lines.length; i++) { const line = lines[i]; // Add a new line at the end of a list of items if (isListItem(previous) && line && !isListItem(line)) { newLines.push(''); // Add a new line at the beginning of a list of items } else if (isListItem(line) && previous && !isListItem(previous)) { newLines.push(''); // Add a new line before a heading } else if (isHeading(line) && previous) { newLines.push(''); // Add a new line after a heading } else if (isHeading(previous) && line) { newLines.push(''); } else if (isCodeLine(line) && !isCodeLine(previous)) { newLines.push(''); } else if (!isCodeLine(line) && isCodeLine(previous)) { newLines.push(''); } else if (isTableLine(line) && !isTableLine(previous)) { newLines.push(''); } else if (!isTableLine(line) && isTableLine(previous)) { newLines.push(''); // Add a new line at beginning of paragraph } else if (isPlainParagraph(line) && previous) { newLines.push(''); // Add a new line at end of paragraph } else if (isPlainParagraph(previous) && line) { newLines.push(''); } newLines.push(line); previous = newLines[newLines.length - 1]; } return newLines; } function isWhiteSpace(c: string): boolean { return c === '\n' || c === '\r' || c === '\v' || c === '\f' || c === '\t' || c === ' '; } // Like QString::simplified(), except that it preserves non-breaking spaces (which // Evernote uses for indentation, etc.) function simplifyString(s: string): string { let output = ''; let previousWhite = false; for (let i = 0; i < s.length; i++) { const c = s[i]; const isWhite = isWhiteSpace(c); if (previousWhite && isWhite) { // skip } else { output += c; } previousWhite = isWhite; } while (output.length && isWhiteSpace(output[0])) output = output.substr(1); while (output.length && isWhiteSpace(output[output.length - 1])) output = output.substr(0, output.length - 1); return output; } function collapseWhiteSpaceAndAppend(lines: string[], state: any, text: string) { if (state.inCode.length) { lines.push(text); } else { // Remove all \n and \r from the left and right of the text while (text.length && (text[0] === '\n' || text[0] === '\r')) text = text.substr(1); while (text.length && (text[text.length - 1] === '\n' || text[text.length - 1] === '\r')) text = text.substr(0, text.length - 1); // Collapse all white spaces to just one. If there are spaces to the left and right of the string // also collapse them to just one space. const spaceLeft = text.length && text[0] === ' '; const spaceRight = text.length && text[text.length - 1] === ' '; text = simplifyString(text); if (!spaceLeft && !spaceRight && text === '') return lines; if (state.inQuote) { // Add a ">" at the beginning of the block then at the beginning of each lines. So it turns this: // "my quote\nsecond line" into this => "> my quote\n> second line" lines.push('> '); if (lines.indexOf('\r') >= 0) { text = text.replace(/\n\r/g, '\n\r> '); } else { text = text.replace(/\n/g, '\n> '); } } if (spaceLeft) lines.push(SPACE); lines.push(text); if (spaceRight) lines.push(SPACE); } return lines; } function tagAttributeToMdText(attr: string): string { // HTML attributes may contain newlines so remove them. // https://github.com/laurent22/joplin/issues/1583 if (!attr) return ''; attr = attr.replace(/[\n\r]+/g, ' '); attr = attr.replace(/\]/g, '\\]'); return attr; } interface AddResourceOptions { alt?: string; width?: number; height?: number; } const addResourceTag = (lines: string[], src: string, mime: string, options: AddResourceOptions): string[] => { const alt = options.alt ? tagAttributeToMdText(options.alt) : ''; if (resourceUtils.isImageMimeType(mime)) { if (!!options.width || !!options.height) { const attrs: Record = { src }; if (options.width) attrs.width = options.width.toString(); if (options.height) attrs.height = options.height.toString(); if (alt) attrs.alt = alt; const attrsHtml: string[] = []; for (const [key, value] of Object.entries(attrs)) { attrsHtml.push(`${key}="${htmlentities(value)}"`); } lines.push(``); } else { lines.push('!['); lines.push(alt); lines.push(`](${markdownUtils.escapeLinkUrl(src)})`); } } else { lines.push('['); lines.push(alt); lines.push(`](${markdownUtils.escapeLinkUrl(src)})`); } return lines; }; const altFromResource = (resource: ResourceEntity): string => { let alt = ''; if (!alt) alt = resource.title; if (!alt) alt = resource.filename; return alt; }; function isBlockTag(n: string) { return ['div', 'p', 'dl', 'dd', 'dt', 'center', 'address'].indexOf(n) >= 0; } function isStrongTag(n: string) { return n === 'strong' || n === 'b' || n === 'big'; } function isStrikeTag(n: string) { return n === 'strike' || n === 's' || n === 'del'; } function isEmTag(n: string) { return n === 'em' || n === 'i' || n === 'u'; } function isAnchor(n: string) { return n === 'a'; } function isIgnoredEndTag(n: string) { return ['en-note', 'en-todo', 'body', 'html', 'font', 'br', 'hr', 'tbody', 'sup', 'img', 'abbr', 'cite', 'thead', 'small', 'tt', 'sub', 'colgroup', 'col', 'ins', 'caption', 'var', 'map', 'area'].indexOf(n) >= 0; } function isListTag(n: string) { return n === 'ol' || n === 'ul'; } // Elements that don't require any special treatment beside adding a newline character function isNewLineOnlyEndTag(n: string) { return ['div', 'p', 'li', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'dl', 'dd', 'dt', 'center', 'address'].indexOf(n) >= 0; } function isInlineCodeTag(n: string) { return ['samp', 'kbd'].indexOf(n) >= 0; } function isNewLineBlock(s: string) { return s === BLOCK_OPEN || s === BLOCK_CLOSE; } function attributeToLowerCase(node: any) { if (!node.attributes) return {}; const output: any = {}; for (const n in node.attributes) { if (!node.attributes.hasOwnProperty(n)) continue; output[n.toLowerCase()] = node.attributes[n]; } return output; } function cssValue(context: any, style: string, propName: string | string[]): string { if (!style) return null; const propNames = Array.isArray(propName) ? propName : [propName]; try { const o = cssParser.parse(`pre {${style}}`); if (!o.stylesheet.rules.length) return null; for (const propName of propNames) { const prop = o.stylesheet.rules[0].declarations.find((d: any) => d.property.toLowerCase() === propName); if (prop && prop.value) return prop.value.trim().toLowerCase(); } return null; } catch (error) { displaySaxWarning(context, `Invalid CSS value: ${error.message}`); return null; } } function isInvisibleBlock(context: any, attributes: any) { const display = cssValue(context, attributes.style, 'display'); return display && display.indexOf('none') === 0; } function trimBlockOpenAndClose(lines: string[]): string[] { const output = lines.slice(); while (output.length && [BLOCK_OPEN, BLOCK_CLOSE, ''].includes(output[0])) { output.splice(0, 1); } while (output.length && [BLOCK_OPEN, BLOCK_CLOSE, ''].includes(output[output.length - 1])) { output.pop(); } return output; } function isSpanWithStyle(attributes: any) { if (attributes) { if ('style' in attributes) { return true; } else { return false; } } return false; } function isSpanStyleBold(attributes: any) { let style = attributes.style; if (!style) return false; style = style.replace(/\s+/g, ''); if (style.includes('font-weight:bold') || style.includes('font-weight:700') || style.includes('font-weight:800') || style.includes('font-weight:900')) { return true; } else if (style.search(/font-family:.*,Bold.*;/) !== -1) { return true; } else { return false; } } function isSpanStyleItalic(attributes: any) { let style = attributes.style; style = style.replace(/\s+/g, ''); return (style.toLowerCase().includes('font-style:italic')); } function displaySaxWarning(context: any, message: string) { const line = []; const parser = context ? context._parser : null; if (parser) { line.push(`Line ${parser.line}:${parser.column}`); } line.push(message); console.warn(line.join(': ')); } function isCodeBlock(context: any, nodeName: string, attributes: any) { if (nodeName === 'code') return true; if (attributes && attributes.style) { // Yes, this property sometimes appears as -en-codeblock, sometimes as // --en-codeblock. Would be too easy to import ENEX data otherwise. // https://github.com/laurent22/joplin/issues/4965 const enCodeBlock = cssValue(context, attributes.style, [ '-en-codeblock', '--en-codeblock', '-evernote-codeblock', '--evernote-codeblock', ]); if (enCodeBlock && enCodeBlock.toLowerCase() === 'true') return true; } return false; } function isHighlight(context: any, _nodeName: string, attributes: any) { if (attributes && attributes.style) { // Evernote uses various inconsistent CSS prefixes: so far I've found // "--en", "-en", "-evernote", so I'm guessing "--evernote" probably // exists too. const enHighlight = cssValue(context, attributes.style, [ '-evernote-highlight', '--evernote-highlight', '-en-highlight', '--en-highlight', ]); // Value can be any colour or "true". I guess if it's set at all it // should be highlighted but just in case handle case where it's // "false". if (enHighlight && enHighlight.toLowerCase() !== 'false') return true; } return false; } function enexXmlToMdArray(stream: any, resources: ResourceEntity[], tasks: ExtractedTask[]): Promise { const remainingResources = resources.slice(); const removeRemainingResource = (id: string) => { for (let i = 0; i < remainingResources.length; i++) { const r = remainingResources[i]; if (r.id === id) { remainingResources.splice(i, 1); } } }; return new Promise((resolve) => { const state: ParserState = { inCode: [], inPre: false, inQuote: false, lists: [], anchorAttributes: [], spanAttributes: [], tags: [], }; const options = {}; const strict = false; const saxStream = require('@joplin/fork-sax').createStream(strict, options); let section: Section = { type: SectionType.Text, lines: [], parent: null, }; saxStream.on('error', (e: any) => { console.warn(e); }); const unwrapInnerText = (text: string) => { const lines = text.split('\n'); let output = ''; for (let i = 0; i < lines.length; i++) { const line = lines[i]; const nextLine = i < lines.length - 1 ? lines[i + 1] : ''; if (!line) { output += '\n'; continue; } if (nextLine) { output += `${line} `; } else { output += line; } } return output; }; saxStream.on('text', (text: string) => { if (['table', 'tr', 'tbody'].indexOf(section.type) >= 0) return; const currentList = state.lists && state.lists.length ? state.lists[state.lists.length - 1] : null; if ((currentList) && (currentList.tag === ListTag.TaskList)) { // skip text on task lists return; } text = !state.inPre ? unwrapInnerText(text) : text; section.lines = collapseWhiteSpaceAndAppend(section.lines, state, text); }); saxStream.on('opentag', function(node: any) { const nodeAttributes = attributeToLowerCase(node); const n = node.name.toLowerCase(); const isVisible = !isInvisibleBlock(this, nodeAttributes); const tagInfo: ParserStateTag = { name: n, visible: isVisible, isCodeBlock: isCodeBlock(this, n, nodeAttributes), isHighlight: isHighlight(this, n, nodeAttributes), }; state.tags.push(tagInfo); const currentList = state.lists && state.lists.length ? state.lists[state.lists.length - 1] : null; // Kind of a hack: If we are inside a list, at the beginning of an item (when a "- " or "1. " has been added // but no other text yet), if the current tag is eg. a
    or any other block tag, we skip it, so that a new line // does not get created. It is to handle list4.html test case. // https://github.com/laurent22/joplin/issues/832 if (currentList) { if (!currentList.startedText && isBlockTag(n)) return; currentList.startedText = true; } // Note that the order of if/else blocks is important. In // particular table-related blocks should always be on top and // take priority over, in particular, hidden blocks. This is so // that a block that is both table-related and hidden is simply // handled as table-related. This is to ensure that the table // structure is valid. if (n === 'en-note') { // Start of note } else if (n === 'table') { const newSection: Section = { type: SectionType.Table, lines: [], parent: section, }; section.lines.push(newSection); section = newSection; } else if (n === 'tbody' || n === 'thead') { // Ignore it } else if (n === 'tr') { // Note: Even if we encounter tags in the wrong place, we // create the sections anyway so that the data is imported. // Invalid HTML like would most likely be from clipped // pages which would look like a mess in Evernote. So it // will look like a mess in Joplin too but at least the // data will be there. // // Also if we simply skip the section, it will cause an // error in drawTable() later on. // // https://discourse.joplinapp.org/t/not-all-notes-imported-from-evernote/13056/12?u=laurent if (section.type !== 'table') { displaySaxWarning(this, 'Found a tag outside of a table'); // return; } const newSection: Section = { type: SectionType.Tr, lines: [], parent: section, isHeader: false, }; section.lines.push(newSection); section = newSection; } else if (n === 'td' || n === 'th') { if (section.type !== 'tr') { displaySaxWarning(this, 'Found a tag outside of a '); // return; } if (n === 'th') section.isHeader = true; const newSection: Section = { type: SectionType.Td, lines: [], parent: section, }; section.lines.push(newSection); section = newSection; } else if (n === 'caption') { if (section.type !== 'table') { displaySaxWarning(this, 'Found a tag outside of a '); } const newSection: Section = { type: SectionType.Caption, lines: [], parent: section, }; section.lines.push(newSection); section = newSection; } else if (!isVisible) { const newSection: Section = { type: SectionType.Hidden, lines: [], parent: section, }; section.lines.push(newSection); section = newSection; } else if (tagInfo.isCodeBlock) { state.inCode.push(true); state.currentCode = ''; const newSection: Section = { type: SectionType.Code, lines: [], parent: section, }; section.lines.push(newSection); section = newSection; } else if (isBlockTag(n)) { const isTodosList = cssValue(this, nodeAttributes.style, '--en-task-group') === 'true'; if (isTodosList) { const todoGroup = cssValue(this, nodeAttributes.style, '--en-id'); section.lines.push(BLOCK_OPEN); for (const t of tasks) { if (t.groupId === todoGroup) { section.lines.push(`- [${t.completed ? 'x' : ' '}] ${t.title}\n`); } } tagInfo.name = ListTag.TaskList; state.lists.push({ tag: ListTag.TaskList, counter: 1, startedText: false }); } else { section.lines.push(BLOCK_OPEN); } } else if (isListTag(n)) { section.lines.push(BLOCK_OPEN); const isCheckboxList = cssValue(this, nodeAttributes.style, '--en-todo') === 'true'; const tag = isCheckboxList ? ListTag.CheckboxList : n as ListTag; state.lists.push({ tag: tag, counter: 1, startedText: false }); } else if (n === 'li') { section.lines.push(BLOCK_OPEN); if (!state.lists.length) { displaySaxWarning(this, 'Found
  • tag without being inside a list'); return; } const container = state.lists[state.lists.length - 1]; container.startedText = false; const indent = ' '.repeat(state.lists.length - 1); if (container.tag === ListTag.CheckboxList) { const x = cssValue(this, nodeAttributes.style, '--en-checked') === 'true' ? 'X' : ' '; section.lines.push(`${indent}- [${x}] `); } else if (container.tag === ListTag.Ul) { section.lines.push(`${indent}- `); } else { section.lines.push(`${indent + container.counter}. `); container.counter++; } } else if (tagInfo.isHighlight) { section.lines.push('=='); } else if (isStrongTag(n)) { section.lines.push('**'); } else if (isStrikeTag(n)) { section.lines.push(''); } else if (isInlineCodeTag(n)) { section.lines.push('`'); } else if (n === 'q') { section.lines.push('"'); } else if (n === 'img') { // Many (most?) img tags don't have no source associated, // especially when they were imported from HTML if (nodeAttributes.src) { section.lines = addResourceTag(section.lines, nodeAttributes.src, 'image/png', { width: nodeAttributes.width ? Number(nodeAttributes.width) : 0, height: nodeAttributes.height ? Number(nodeAttributes.height) : 0, alt: nodeAttributes.alt ? nodeAttributes.alt : '', }); } } else if (isAnchor(n)) { state.anchorAttributes.push(nodeAttributes); // Need to add the '[' via this function to make sure that links within code blocks // are handled correctly. collapseWhiteSpaceAndAppend(section.lines, state, '['); } else if (isEmTag(n)) { section.lines.push('*'); } else if (n === 'en-todo') { const x = nodeAttributes.checked && nodeAttributes.checked.toLowerCase() === 'true' ? 'X' : ' '; section.lines.push(`- [${x}] `); } else if (n === 'hr') { // Needs to be surrounded by new lines so that it's properly rendered as a line when converting to HTML section.lines.push(NEWLINE); section.lines.push('* * *'); section.lines.push(NEWLINE); section.lines.push(NEWLINE); } else if (n === 'h1') { section.lines.push(BLOCK_OPEN); section.lines.push('# '); } else if (n === 'h2') { section.lines.push(BLOCK_OPEN); section.lines.push('## '); } else if (n === 'h3') { section.lines.push(BLOCK_OPEN); section.lines.push('### '); } else if (n === 'h4') { section.lines.push(BLOCK_OPEN); section.lines.push('#### '); } else if (n === 'h5') { section.lines.push(BLOCK_OPEN); section.lines.push('##### '); } else if (n === 'h6') { section.lines.push(BLOCK_OPEN); section.lines.push('###### '); } else if (n === 'blockquote') { section.lines.push(BLOCK_OPEN); state.inQuote = true; } else if (n === 'pre') { section.lines.push(BLOCK_OPEN); state.inPre = true; } else if (n === 'br') { section.lines.push(NEWLINE); } else if (n === 'en-media') { const hash = nodeAttributes.hash; let resource = null; for (let i = 0; i < resources.length; i++) { const r = resources[i]; if (r.id === hash) { resource = r; removeRemainingResource(r.id); break; } } if (!resource) { // This is a bit of a hack. Notes sometime have resources attached to it, but those tags don't contain // an "objID" tag, making it impossible to reference the resource. However, in this case the content of the note // will contain a corresponding tag, which has the ID in the "hash" attribute. All this information // has been collected above so we now set the resource ID to the hash attribute of the en-media tags. Here's an // example of note that shows this problem: // // // // // Command // // // // // // // ]]> // // 20160921T203424Z // 20160921T203438Z // // 20160902T140445Z // 20160924T101120Z // // // ........ // image/png // 150 // 150 // // // // Note that there's also the case of resources with no ID where the ID is actually the MD5 of the content. // This is handled in import-enex.js let found = false; for (let i = 0; i < remainingResources.length; i++) { const r = remainingResources[i]; if (!r.id) { resource = { ...r }; resource.id = hash; remainingResources.splice(i, 1); found = true; break; } } if (!found) { // console.warn(`Hash with no associated resource: ${hash}`); } } // If the resource does not appear among the note's resources, it // means it's an attachment. It will be appended along with the // other remaining resources at the bottom of the markdown text. if (resource && !!resource.id) { section.lines = addResourceTag(section.lines, `:/${resource.id}`, resource.mime, { alt: nodeAttributes.alt ? nodeAttributes.alt : altFromResource(resource), width: nodeAttributes.width ? Number(nodeAttributes.width) : 0, height: nodeAttributes.height ? Number(nodeAttributes.height) : 0, }); } } else if (n === 'span') { if (isSpanWithStyle(nodeAttributes)) { // Found style(s) in span tag state.spanAttributes.push(nodeAttributes); if (isSpanStyleBold(nodeAttributes)) { // Applying style found in span tag: bold' section.lines.push('**'); } if (isSpanStyleItalic(nodeAttributes)) { // Applying style found in span tag: italic' section.lines.push('*'); } } } else if (['font', 'sup', 'cite', 'abbr', 'small', 'tt', 'sub', 'colgroup', 'col', 'ins', 'caption', 'var', 'map', 'area'].indexOf(n) >= 0) { // Inline tags that can be ignored in Markdown } else { console.warn(`Unsupported start tag: ${n}`); } }); saxStream.on('closetag', (n: string) => { n = n ? n.toLowerCase() : n; const poppedTag = state.tags.pop(); if (n === 'en-note') { // End of note } else if (!poppedTag.visible) { if (section && section.parent) section = section.parent; } else if (poppedTag.isHighlight) { section.lines.push('=='); } else if (poppedTag.isCodeBlock) { state.inCode.pop(); if (!state.inCode.length) { // When a codeblock is wrapped in
    , it will have
    					// extra empty lines added by the "pre" logic, but since we
    					// are in a codeblock we should actually trim those.
    					const codeLines = trimBlockOpenAndClose(processMdArrayNewLines(section.lines).split('\n'));
    					section.lines = [];
    					if (codeLines.length > 1) {
    						section.lines.push('\n\n```\n');
    						for (let i = 0; i < codeLines.length; i++) {
    							if (i > 0) section.lines.push('\n');
    							section.lines.push(codeLines[i]);
    						}
    						section.lines.push('\n```\n\n');
    					} else {
    						section.lines.push(`\`${markdownUtils.escapeInlineCode(codeLines.join(''))}\``);
    					}
    
    					if (section && section.parent) section = section.parent;
    				}
    			} else if (isNewLineOnlyEndTag(n)) {
    				if (poppedTag.name === ListTag.TaskList) {
    					state.lists.pop();
    				}
    				section.lines.push(BLOCK_CLOSE);
    			} else if (n === 'td' || n === 'th') {
    				if (section && section.parent) section = section.parent;
    			} else if (n === 'tr' || n === 'caption') {
    				if (section && section.parent) section = section.parent;
    			} else if (n === 'table') {
    				if (section && section.parent) section = section.parent;
    			} else if (isIgnoredEndTag(n)) {
    				// Skip
    			} else if (isListTag(n)) {
    				section.lines.push(BLOCK_CLOSE);
    				state.lists.pop();
    			} else if (isStrongTag(n)) {
    				section.lines.push('**');
    			} else if (isStrikeTag(n)) {
    				section.lines.push('');
    			} else if (isInlineCodeTag(n)) {
    				section.lines.push('`');
    			} else if (isEmTag(n)) {
    				section.lines.push('*');
    			} else if (n === 'q') {
    				section.lines.push('"');
    			} else if (n === 'blockquote') {
    				section.lines.push(BLOCK_OPEN);
    				state.inQuote = false;
    			} else if (n === 'pre') {
    				state.inPre = false;
    				section.lines.push(BLOCK_CLOSE);
    			} else if (isAnchor(n)) {
    				const attributes = state.anchorAttributes.pop();
    				const url = attributes && attributes.href ? attributes.href : '';
    
    				if (section.lines.length < 1) throw new Error('Invalid anchor tag closing'); // Sanity check, but normally not possible
    
    				// When closing the anchor tag, check if there's is any text content. If not
    				// put the URL as is (don't wrap it in [](url)). The markdown parser, using
    				// GitHub flavour, will turn this URL into a link. This is to generate slightly
    				// cleaner markdown.
    
    				// Need to loop on the previous tags so as to skip the special ones, which are not relevant for the below algorithm.
    				let previous = null;
    				for (let i = section.lines.length - 1; i >= 0; i--) {
    					previous = section.lines[i];
    					if ([BLOCK_OPEN, BLOCK_CLOSE, NEWLINE, NEWLINE_MERGED, SPACE].indexOf(previous) >= 0 || !previous) {
    						continue;
    					} else {
    						break;
    					}
    				}
    
    				if (previous === '[') {
    					// We have a link that had some content but, after parsing, nothing is left. The content was most likely
    					// something that shows up via CSS and which we cannot support. For example:
    					//
    					// 
    					//    
    //
    // // In the case above the arrow is displayed via CSS. // It is useless to display the full URL since often it is not relevant for a note (for example // it's interactive bits) and it's not user-generated content such as a URL that would appear in a comment. // So in this case, we still want to preserve the information but display it in a discreet way as a simple [L]. // Need to pop everything inside the current [] because it can only be special chars that we don't want (they would create unnecessary newlines) for (let i = section.lines.length - 1; i >= 0; i--) { if (section.lines[i] !== '[') { section.lines.pop(); } else { break; } } if (!url) { // If there's no URL and no content, pop the [ and don't save any content. section.lines.pop(); } else { section.lines.push('(L)'); section.lines.push(`](${url})`); } } else if (!previous || previous === url) { section.lines.pop(); section.lines.pop(); section.lines.push(url); } else { // Need to remove any new line character between the current ']' and the previous '[' // otherwise it won't render properly. let allSpaces = true; for (let i = section.lines.length - 1; i >= 0; i--) { const c = section.lines[i]; if (c === '[') { break; } else { if (c === BLOCK_CLOSE || c === BLOCK_OPEN || c === NEWLINE) { section.lines[i] = SPACE; } else { if (!isWhiteSpace(c)) allSpaces = false; } } } if (allSpaces) { for (let i = section.lines.length - 1; i >= 0; i--) { const c = section.lines.pop(); if (c === '[') break; } section.lines.push(url); } else { // Eg. converts: // [ Sign in ](https://example.com) // to: // [Sign in](https://example.com) const trimTextStartAndEndSpaces = function(lines: string[]) { let firstBracketIndex = 0; let foundFirstNonWhite = false; for (let i = lines.length - 1; i >= 0; i--) { const l = lines[i]; if (!foundFirstNonWhite && (l === SPACE || l === ' ' || !l)) { lines.pop(); } else { foundFirstNonWhite = true; } if (l === '[') { firstBracketIndex = i; break; } } for (let i = firstBracketIndex + 1; i < lines.length; i++) { const l = lines[i]; if (l === SPACE || l === ' ' || !l) { lines.splice(i, 1); } else { break; } } return lines; }; section.lines = trimTextStartAndEndSpaces(section.lines); section.lines.push(`](${url})`); } } } else if (n === 'en-media') { // Skip } else if (n === 'span') { const attributes = state.spanAttributes.pop(); if (isSpanWithStyle(attributes)) { if (isSpanStyleBold(attributes)) { // Applying style found in span tag (closing): bold' section.lines.push('**'); } if (isSpanStyleItalic(attributes)) { // Applying style found in span tag (closing): italic' section.lines.push('*'); } } } else { console.warn(`Unsupported end tag: ${n}`); } }); saxStream.on('attribute', () => {}); saxStream.on('end', () => { resolve({ content: section, resources: remainingResources, } as EnexXmlToMdArrayResult); }); stream.pipe(saxStream); }); } function tableHasSubTables(table: Section) { for (let trIndex = 0; trIndex < table.lines.length; trIndex++) { const tr = table.lines[trIndex]; if (!tr || !tr.lines) continue; for (let tdIndex = 0; tdIndex < tr.lines.length; tdIndex++) { const td = tr.lines[tdIndex]; // We are inside a CAPTION, not a TD if (typeof td === 'string') continue; for (let i = 0; i < td.lines.length; i++) { if (typeof td.lines[i] === 'object') return true; } } } return false; } // Markdown tables don't support tables within tables, which is common in notes that are complete web pages, for example when imported // via Web Clipper. So to handle this, we render all the outer tables as regular text (as if replacing all the
  • , and
    // elements by
    ) and only the inner ones, those that don't contain any other tables, are rendered as actual tables. This is generally // the required behaviour since the outer tables are usually for layout and the inner ones are the content. function drawTable(table: Section) { // | First Header | Second Header | // | ------------- | ------------- | // | Content Cell | Content Cell | // | Content Cell | Content Cell | // There must be at least 3 dashes separating each header cell. // https://gist.github.com/IanWang/28965e13cdafdef4e11dc91f578d160d#tables const flatRender = tableHasSubTables(table); // Render the table has regular text let lines = []; lines.push(BLOCK_OPEN); let headerDone = false; let caption = null; for (let trIndex = 0; trIndex < table.lines.length; trIndex++) { const tr = table.lines[trIndex]; if (tr.type === 'caption') { caption = tr; continue; } if (typeof tr === 'string') { // A tag should only have tags as direct children. // However certain Evernote notes can contain other random tags // such as empty DIVs. In that case we just skip the content. // See test "table_with_invalid_content.html". continue; } const isHeader = tr.isHeader; const line = []; const headerLine = []; let emptyHeader = null; for (let tdIndex = 0; tdIndex < tr.lines.length; tdIndex++) { const td = tr.lines[tdIndex]; if (typeof td === 'string') { // Same comment as above the tags. continue; } if (flatRender) { line.push(BLOCK_OPEN); let currentCells: any[] = []; const renderCurrentCells = () => { if (!currentCells.length) return; const cellText = processMdArrayNewLines(currentCells); line.push(cellText); currentCells = []; }; // In here, recursively render the tables for (let i = 0; i < td.lines.length; i++) { const c = td.lines[i]; if (typeof c === 'object' && ['table', 'td', 'tr', 'th', 'caption'].indexOf(c.type) >= 0) { // This is a table renderCurrentCells(); currentCells = currentCells.concat(drawTable(c)); } else { // This is plain text // currentCells.push(c); currentCells = currentCells.concat(renderLine(c)); } } renderCurrentCells(); line.push(BLOCK_CLOSE); } else { // Regular table rendering // A cell in a Markdown table cannot have actual new lines so replace // them with
    , which are supported by the markdown renderers. let cellText = processMdArrayNewLines(td.lines); let lines = cellText.split('\n'); lines = postProcessMarkdown(lines); cellText = lines.join('\n').replace(/\n+/g, '
    '); // Inside tables cells, "|" needs to be escaped cellText = cellText.replace(/\|/g, '\\|'); // Previously the width of the cell was as big as the content since it looks nicer, however that often doesn't work // since the content can be very long, resulting in unreadable markdown. So no solution is perfect but making it a // width of 3 is a bit better. Note that 3 is the minimum width of a cell - below this, it won't be rendered by // markdown parsers. const width = 3; line.push(stringPadding(cellText, width, ' ', stringPadding.RIGHT)); if (!headerDone) { if (!isHeader) { if (!emptyHeader) emptyHeader = []; const h = stringPadding(' ', width, ' ', stringPadding.RIGHT); emptyHeader.push(h); } headerLine.push('-'.repeat(width)); } } } if (flatRender) { headerDone = true; lines.push(BLOCK_OPEN); lines = lines.concat(line); lines.push(BLOCK_CLOSE); } else { if (emptyHeader) { lines.push(`| ${emptyHeader.join(' | ')} |`); lines.push(`| ${headerLine.join(' | ')} |`); headerDone = true; } lines.push(`| ${line.join(' | ')} |`); if (!headerDone) { lines.push(`| ${headerLine.join(' | ')} |`); headerDone = true; } } } lines.push(BLOCK_CLOSE); if (caption) { const captionLines: any[] = renderLines(caption.lines); lines = lines.concat(captionLines); } return flatRender ? lines : lines.join(`<<<<:D>>>>${NEWLINE}<<<<:D>>>>`).split('<<<<:D>>>>'); } function postProcessMarkdown(lines: string[]) { // After importing HTML, the resulting Markdown often has empty lines at the beginning and end due to // block start/end or elements that were ignored, etc. If these white spaces were intended it's not really // possible to detect it, so simply trim them all so that the result is more deterministic and can be // easily unit tested. const trimEmptyLines = function(lines: string[]) { while (lines.length) { if (!lines[0].trim()) { lines.splice(0, 1); } else { break; } } while (lines.length) { if (!lines[lines.length - 1].trim()) { lines.pop(); } else { break; } } return lines; }; function cleanUpSpaces(lines: string[]) { const output = []; for (let i = 0; i < lines.length; i++) { let line = lines[i]; if (line.length) { // eg. " - Some list item" => " - Some list item" // Note that spaces before the "-" are preserved line = line.replace(/^(\s+|)-\s+/, '$1- '); // eg "Some text " => "Some text" line = line.replace(/^(.*?)\s+$/, '$1'); } output.push(line); } return output; } lines = trimEmptyLines(lines); lines = cleanUpSpaces(lines); return lines; } // A "line" can be some Markdown text, or it can be a section, like a table, // etc. so this function returns an array of strings. function renderLine(line: any) { if (typeof line === 'object' && line.type === 'table') { // A table const table = line; return drawTable(table); } else if (typeof line === 'object' && line.type === 'code') { return line.lines; } else if (typeof line === 'object' && line.type === 'hidden') { // ENEX notes sometimes have hidden tags. We could strip off these // sections but in the spirit of preserving all data we wrap them in // a hidden tag too. let hiddenLines = ['
    ']; hiddenLines = hiddenLines.concat(renderLines(line.lines)); hiddenLines.push('
    '); // We need to add two new lines after the HTML block, or the Markdown // after that will not render. // https://github.com/markdown-it/markdown-it/issues/746 hiddenLines.push(NEWLINE); hiddenLines.push(NEWLINE); return hiddenLines; } else if (typeof line === 'object') { console.warn('Unhandled object type:', line); return line.lines; } else { // an actual line return [line]; } } function renderLines(lines: any[]) { let mdLines: string[] = []; for (let i = 0; i < lines.length; i++) { const renderedLines = renderLine(lines[i]); mdLines = mdLines.concat(renderedLines); } return mdLines; } async function enexXmlToMd(xmlString: string, resources: ResourceEntity[], tasks: ExtractedTask[]) { const stream = stringToStream(xmlString); const result = await enexXmlToMdArray(stream, resources, tasks); let mdLines = renderLines(result.content.lines); let firstAttachment = true; for (let i = 0; i < result.resources.length; i++) { const r = result.resources[i]; if (firstAttachment) mdLines.push(NEWLINE); mdLines.push(NEWLINE); mdLines = addResourceTag(mdLines, `:/${r.id}`, r.mime, { alt: altFromResource(r), }); firstAttachment = false; } let output = processMdArrayNewLines(mdLines).split('\n'); output = postProcessMarkdown(output); return output.join('\n'); } export { enexXmlToMd, processMdArrayNewLines, NEWLINE, cssValue };