server-ts: Port services/export/opml

2025-11-12 08:15:52 +01:00 · 2024-02-19 22:07:21 +02:00
parent ec4bd6659a
commit cfeb0cc6f7
4 changed files with 24 additions and 14 deletions
--- a/src/services/export/opml.ts
+++ b/src/services/export/opml.ts
@@ -0,0 +1,103 @@
+"use strict";
+
+import utils = require('../utils');
+import becca = require('../../becca/becca');
+import TaskContext = require('../task_context');
+import BBranch = require('../../becca/entities/bbranch');
+import { 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', utils.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 = utils.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 = {
+    exportToOpml
+};