Notes/src/services/export/opml.ts

"use strict";

import { getContentDisposition, stripTags } from "../utils.js";
import becca from "../../becca/becca.js";
import type TaskContext from "../task_context.js";
import type BBranch from "../../becca/entities/bbranch.js";
import type { Response } from "express";

function exportToOpml(taskContext: TaskContext, branch: BBranch, version: string, res: Response) {
    if (!["1.0", "2.0"].includes(version)) {
        throw new Error(`Unrecognized OPML version ${version}`);
    }

    const opmlVersion = parseInt(version);

    const note = branch.getNote();

    function exportNoteInner(branchId: string) {
        const branch = becca.getBranch(branchId);
        if (!branch) {
            throw new Error("Unable to find branch.");
        }

        const note = branch.getNote();
        if (!note) {
            throw new Error("Unable to find note.");
        }

        if (note.hasOwnedLabel("excludeFromExport")) {
            return;
        }

        const title = `${branch.prefix ? `${branch.prefix} - ` : ""}${note.title}`;

        if (opmlVersion === 1) {
            const preparedTitle = escapeXmlAttribute(title);
            const preparedContent = note.hasStringContent() ? prepareText(note.getContent() as string) : "";

            res.write(`<outline title="${preparedTitle}" text="${preparedContent}">\n`);
        } else if (opmlVersion === 2) {
            const preparedTitle = escapeXmlAttribute(title);
            const preparedContent = note.hasStringContent() ? escapeXmlAttribute(note.getContent() as string) : "";

            res.write(`<outline text="${preparedTitle}" _note="${preparedContent}">\n`);
        } else {
            throw new Error(`Unrecognized OPML version ${opmlVersion}`);
        }

        taskContext.increaseProgressCount();

        for (const child of note.getChildBranches()) {
            if (child?.branchId) {
                exportNoteInner(child.branchId);
            }
        }

        res.write("</outline>");
    }

    const filename = `${branch.prefix ? `${branch.prefix} - ` : ""}${note.title}.opml`;

    res.setHeader("Content-Disposition", getContentDisposition(filename));
    res.setHeader("Content-Type", "text/x-opml");

    res.write(`<?xml version="1.0" encoding="UTF-8"?>
<opml version="${version}">
<head>
<title>Trilium export</title>
</head>
<body>`);

    if (branch.branchId) {
        exportNoteInner(branch.branchId);
    }

    res.write(`</body>
</opml>`);
    res.end();

    taskContext.taskSucceeded();
}

function prepareText(text: string) {
    const newLines = text.replace(/(<p[^>]*>|<br\s*\/?>)/g, "\n").replace(/&nbsp;/g, " "); // nbsp isn't in XML standard (only HTML)

    const stripped = stripTags(newLines);

    const escaped = escapeXmlAttribute(stripped);

    return escaped.replace(/\n/g, "&#10;");
}

function escapeXmlAttribute(text: string) {
    return text.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&apos;");
}

export default {
    exportToOpml
};
import/export logic refactored into separate files per format, closes #237 2018-11-16 12:12:04 +01:00			`"use strict";`

refactor(services): use named imports from utils 2025-01-02 13:47:44 +01:00			`import { getContentDisposition, stripTags } from "../utils.js";`
server-esm: Change simple local import statements 2024-07-18 21:35:17 +03:00			`import becca from "../../becca/becca.js";`
chore(types): missing import type for JS imports 2025-01-13 23:18:10 +02:00			`import type TaskContext from "../task_context.js";`
			`import type BBranch from "../../becca/entities/bbranch.js";`
refactor(ts): enable verbatim module syntax 2025-01-09 18:36:24 +02:00			`import type { Response } from "express";`
import/export logic refactored into separate files per format, closes #237 2018-11-16 12:12:04 +01:00
server-ts: Port services/export/opml 2024-02-19 22:07:21 +02:00			`function exportToOpml(taskContext: TaskContext, branch: BBranch, version: string, res: Response) {`
chore(prettier): fix all files 2025-01-09 18:07:02 +02:00			`if (!["1.0", "2.0"].includes(version)) {`
always use template strings instead of string concatenation 2022-12-21 15:19:05 +01:00			throw new Error(`Unrecognized OPML version ${version}`);
OPML v2 export 2019-02-16 23:58:42 +01:00			`}`

			`const opmlVersion = parseInt(version);`
UI for export of OPML v2, WIP 2019-02-16 23:33:40 +01:00
syncification 2020-06-20 12:31:38 +02:00			`const note = branch.getNote();`
import/export logic refactored into separate files per format, closes #237 2018-11-16 12:12:04 +01:00
server-ts: Port services/export/opml 2024-02-19 22:07:21 +02:00			`function exportNoteInner(branchId: string) {`
becca conversion WIP 2021-05-02 11:23:58 +02:00			`const branch = becca.getBranch(branchId);`
chore(prettier): fix all files 2025-01-09 18:07:02 +02:00			`if (!branch) {`
			`throw new Error("Unable to find branch.");`
			`}`
server-ts: Port services/export/opml 2024-02-19 22:07:21 +02:00
syncification 2020-06-20 12:31:38 +02:00			`const note = branch.getNote();`
chore(prettier): fix all files 2025-01-09 18:07:02 +02:00			`if (!note) {`
			`throw new Error("Unable to find note.");`
			`}`
excludeFromExport support also in OPML 2018-11-19 09:34:05 +01:00
chore(prettier): fix all files 2025-01-09 18:07:02 +02:00			`if (note.hasOwnedLabel("excludeFromExport")) {`
excludeFromExport support also in OPML 2018-11-19 09:34:05 +01:00			`return;`
			`}`

chore(prettier): fix all files 2025-01-09 18:07:02 +02:00			const title = `${branch.prefix ? `${branch.prefix} - ` : ""}${note.title}`;
import/export logic refactored into separate files per format, closes #237 2018-11-16 12:12:04 +01:00
OPML v2 export 2019-02-16 23:58:42 +01:00			`if (opmlVersion === 1) {`
			`const preparedTitle = escapeXmlAttribute(title);`
chore(prettier): fix all files 2025-01-09 18:07:02 +02:00			`const preparedContent = note.hasStringContent() ? prepareText(note.getContent() as string) : "";`
import/export logic refactored into separate files per format, closes #237 2018-11-16 12:12:04 +01:00
OPML v2 export 2019-02-16 23:58:42 +01:00			res.write(`<outline title="${preparedTitle}" text="${preparedContent}">\n`);
chore(prettier): fix all files 2025-01-09 18:07:02 +02:00			`} else if (opmlVersion === 2) {`
OPML v2 export 2019-02-16 23:58:42 +01:00			`const preparedTitle = escapeXmlAttribute(title);`
chore(prettier): fix all files 2025-01-09 18:07:02 +02:00			`const preparedContent = note.hasStringContent() ? escapeXmlAttribute(note.getContent() as string) : "";`
OPML v2 export 2019-02-16 23:58:42 +01:00
			res.write(`<outline text="${preparedTitle}" _note="${preparedContent}">\n`);
chore(prettier): fix all files 2025-01-09 18:07:02 +02:00			`} else {`
always use template strings instead of string concatenation 2022-12-21 15:19:05 +01:00			throw new Error(`Unrecognized OPML version ${opmlVersion}`);
OPML v2 export 2019-02-16 23:58:42 +01:00			`}`
import/export logic refactored into separate files per format, closes #237 2018-11-16 12:12:04 +01:00
refactor exportcontext to taskcontext 2019-10-18 22:27:38 +02:00			`taskContext.increaseProgressCount();`
added progress also to export 2019-02-10 22:30:55 +01:00
syncification 2020-06-20 12:31:38 +02:00			`for (const child of note.getChildBranches()) {`
server-ts: Port services/export/opml 2024-02-19 22:07:21 +02:00			`if (child?.branchId) {`
			`exportNoteInner(child.branchId);`
			`}`
import/export logic refactored into separate files per format, closes #237 2018-11-16 12:12:04 +01:00			`}`

chore(prettier): fix all files 2025-01-09 18:07:02 +02:00			`res.write("</outline>");`
import/export logic refactored into separate files per format, closes #237 2018-11-16 12:12:04 +01:00			`}`

chore(prettier): fix all files 2025-01-09 18:07:02 +02:00			const filename = `${branch.prefix ? `${branch.prefix} - ` : ""}${note.title}.opml`;
OPML v2 export 2019-02-16 23:58:42 +01:00
chore(prettier): fix all files 2025-01-09 18:07:02 +02:00			`res.setHeader("Content-Disposition", getContentDisposition(filename));`
			`res.setHeader("Content-Type", "text/x-opml");`
import/export logic refactored into separate files per format, closes #237 2018-11-16 12:12:04 +01:00
			res.write(`<?xml version="1.0" encoding="UTF-8"?>
fix OPML export to include correct OPML version 2019-03-03 19:43:30 +01:00			`<opml version="${version}">`
import/export logic refactored into separate files per format, closes #237 2018-11-16 12:12:04 +01:00			`<head>`
			`<title>Trilium export</title>`
			`</head>`
			<body>`);

server-ts: Port services/export/opml 2024-02-19 22:07:21 +02:00			`if (branch.branchId) {`
			`exportNoteInner(branch.branchId);`
			`}`
import/export logic refactored into separate files per format, closes #237 2018-11-16 12:12:04 +01:00
			res.write(`</body>
			</opml>`);
			`res.end();`
added progress also to export 2019-02-10 22:30:55 +01:00
refactor exportcontext to taskcontext 2019-10-18 22:27:38 +02:00			`taskContext.taskSucceeded();`
import/export logic refactored into separate files per format, closes #237 2018-11-16 12:12:04 +01:00			`}`

server-ts: Port services/export/opml 2024-02-19 22:07:21 +02:00			`function prepareText(text: string) {`
chore(prettier): fix all files 2025-01-09 18:07:02 +02:00			`const newLines = text.replace(/(<p[^>]>\|<br\s\/?>)/g, "\n").replace(/ /g, " "); // nbsp isn't in XML standard (only HTML)`
import/export logic refactored into separate files per format, closes #237 2018-11-16 12:12:04 +01:00
refactor(services): use named imports from utils 2025-01-02 13:47:44 +01:00			`const stripped = stripTags(newLines);`
import/export logic refactored into separate files per format, closes #237 2018-11-16 12:12:04 +01:00
			`const escaped = escapeXmlAttribute(stripped);`

chore(prettier): fix all files 2025-01-09 18:07:02 +02:00			`return escaped.replace(/\n/g, " ");`
import/export logic refactored into separate files per format, closes #237 2018-11-16 12:12:04 +01:00			`}`

server-ts: Port services/export/opml 2024-02-19 22:07:21 +02:00			`function escapeXmlAttribute(text: string) {`
chore(prettier): fix all files 2025-01-09 18:07:02 +02:00			`return text.replace(/&/g, "&").replace(/</g, "<").replace(/>/g, ">").replace(/"/g, """).replace(/'/g, "'");`
import/export logic refactored into separate files per format, closes #237 2018-11-16 12:12:04 +01:00			`}`

server-esm: Change export object to export default object 2024-07-18 21:42:44 +03:00			`export default {`
import/export logic refactored into separate files per format, closes #237 2018-11-16 12:12:04 +01:00			`exportToOpml`
syncification 2020-06-20 12:31:38 +02:00			`};`