zadam/trilium
1
1
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2024-11-17 13:14:44 +08:00
Code Issues Projects Releases Packages Wiki Activity
trilium/src/routes/api/export.js

270 lines
7.7 KiB
JavaScript
Raw Normal View History

export subtree to filesystem
2017-12-03 10:48:22 +08:00
"use strict";
pretty printing HTML output (for nice git diffs)
2017-12-03 22:19:48 +08:00
const html = require('html');
export subtree to tar file
2018-02-25 23:55:21 +08:00
const tar = require('tar-stream');
const sanitize = require("sanitize-filename");
repository is now stateless
2018-03-31 21:07:58 +08:00
const repository = require("../../services/repository");
OPML export support (issue #78), import missing for now
2018-05-28 00:26:34 +08:00
const utils = require('../../services/utils');
implemented markdown export, #166
2018-09-03 05:39:10 +08:00
const TurndownService = require('turndown');
export subtree to filesystem
2017-12-03 10:48:22 +08:00
converted export/import notes
2018-03-31 03:34:07 +08:00
async function exportNote(req, res) {
export single note as markdown, #166
2018-09-03 15:40:22 +08:00
// entityId maybe either noteId or branchId depending on format
const entityId = req.params.entityId;
OPML export support (issue #78), import missing for now
2018-05-28 00:26:34 +08:00
const format = req.params.format;
export subtree to filesystem
2017-12-03 10:48:22 +08:00
OPML export support (issue #78), import missing for now
2018-05-28 00:26:34 +08:00
if (format === 'tar') {
export single note as markdown, #166
2018-09-03 15:40:22 +08:00
await exportToTar(await repository.getBranch(entityId), res);
OPML export support (issue #78), import missing for now
2018-05-28 00:26:34 +08:00
}
else if (format === 'opml') {
export single note as markdown, #166
2018-09-03 15:40:22 +08:00
await exportToOpml(await repository.getBranch(entityId), res);
OPML export support (issue #78), import missing for now
2018-05-28 00:26:34 +08:00
}
implemented markdown export, #166
2018-09-03 05:39:10 +08:00
else if (format === 'markdown') {
export single note as markdown, #166
2018-09-03 15:40:22 +08:00
await exportToMarkdown(await repository.getBranch(entityId), res);
}
// export single note without subtree
else if (format === 'markdown-single') {
await exportSingleMarkdown(await repository.getNote(entityId), res);
implemented markdown export, #166
2018-09-03 05:39:10 +08:00
}
OPML export support (issue #78), import missing for now
2018-05-28 00:26:34 +08:00
else {
return [404, "Unrecognized export format " + format];
}
}
function escapeXmlAttribute(text) {
return text.replace(/&/g, '&')
.replace(/</g, '&lt;')
.replace(/>/g, '&gt;')
.replace(/"/g, '&quot;')
.replace(/'/g, '&apos;');
}
function prepareText(text) {
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;');
}
export single note as markdown, #166
2018-09-03 15:40:22 +08:00
async function exportToOpml(branch, res) {
OPML export support (issue #78), import missing for now
2018-05-28 00:26:34 +08:00
const note = await branch.getNote();
const title = (branch.prefix ? (branch.prefix + ' - ') : '') + note.title;
const sanitizedTitle = sanitize(title);
async function exportNoteInner(branchId) {
const branch = await repository.getBranch(branchId);
const note = await branch.getNote();
const title = (branch.prefix ? (branch.prefix + ' - ') : '') + note.title;
const preparedTitle = prepareText(title);
const preparedContent = prepareText(note.content);
res.write(`<outline title="${preparedTitle}" text="${preparedContent}">\n`);
for (const child of await note.getChildBranches()) {
await exportNoteInner(child.branchId);
}
res.write('</outline>');
}
res.setHeader('Content-Disposition', 'file; filename="' + sanitizedTitle + '.opml"');
res.setHeader('Content-Type', 'text/x-opml');
res.write(`<?xml version="1.0" encoding="UTF-8"?>
<opml version="1.0">
<head>
<title>Trilium export</title>
</head>
<body>`);
export single note as markdown, #166
2018-09-03 15:40:22 +08:00
await exportNoteInner(branch.branchId);
OPML export support (issue #78), import missing for now
2018-05-28 00:26:34 +08:00
res.write(`</body>
</opml>`);
res.end();
}
export single note as markdown, #166
2018-09-03 15:40:22 +08:00
async function exportToTar(branch, res) {
export subtree to tar file
2018-02-25 23:55:21 +08:00
const pack = tar.pack();
export subtree to filesystem
2017-12-03 10:48:22 +08:00
export & import work correctly with clones
2018-04-09 01:14:30 +08:00
const exportedNoteIds = [];
markdown import
2018-09-03 18:05:44 +08:00
const name = await exportNoteInner(branch, '');
export & import work correctly with clones
2018-04-09 01:14:30 +08:00
markdown import
2018-09-03 18:05:44 +08:00
async function exportNoteInner(branch, directory) {
export & import work correctly with clones
2018-04-09 01:14:30 +08:00
const note = await branch.getNote();
const childFileName = directory + sanitize(note.title);
if (exportedNoteIds.includes(note.noteId)) {
saveMetadataFile(childFileName, {
version: 1,
clone: true,
noteId: note.noteId,
prefix: branch.prefix
});
return;
}
const metadata = {
version: 1,
clone: false,
noteId: note.noteId,
title: note.title,
prefix: branch.prefix,
added links to the import/export + fixing internal links inside note content
2018-11-16 18:42:06 +08:00
isExpanded: branch.isExpanded,
export & import work correctly with clones
2018-04-09 01:14:30 +08:00
type: note.type,
mime: note.mime,
added links to the import/export + fixing internal links inside note content
2018-11-16 18:42:06 +08:00
// we don't export dateCreated and dateModified of any entity since that would be a bit misleading
cleanup of labels and relations from backend
2018-08-07 19:33:10 +08:00
attributes: (await note.getOwnedAttributes()).map(attribute => {
export & import work correctly with clones
2018-04-09 01:14:30 +08:00
return {
cleanup of labels and relations from backend
2018-08-07 19:33:10 +08:00
type: attribute.type,
name: attribute.name,
value: attribute.value,
isInheritable: attribute.isInheritable,
position: attribute.position
export & import work correctly with clones
2018-04-09 01:14:30 +08:00
};
added links to the import/export + fixing internal links inside note content
2018-11-16 18:42:06 +08:00
}),
links: (await note.getLinks()).map(link => {
return {
type: link.type,
targetNoteId: link.targetNoteId
}
export & import work correctly with clones
2018-04-09 01:14:30 +08:00
})
};
implemented markdown export, #166
2018-09-03 05:39:10 +08:00
if (await note.hasLabel('excludeFromExport')) {
export & import work correctly with clones
2018-04-09 01:14:30 +08:00
return;
}
saveMetadataFile(childFileName, metadata);
saveDataFile(childFileName, note);
exportedNoteIds.push(note.noteId);
markdown import
2018-09-03 18:05:44 +08:00
const childBranches = await note.getChildBranches();
if (childBranches.length > 0) {
saveDirectory(childFileName);
}
for (const childBranch of childBranches) {
await exportNoteInner(childBranch, childFileName + "/");
export & import work correctly with clones
2018-04-09 01:14:30 +08:00
}
return childFileName;
import notes from tar archive, closes #63
2018-02-26 13:07:43 +08:00
}
export & import work correctly with clones
2018-04-09 01:14:30 +08:00
function saveDataFile(childFileName, note) {
const content = note.type === 'text' ? html.prettyPrint(note.content, {indent_size: 2}) : note.content;
Script API changes, finished porting reddit plugin, reddit importer tar file
2018-02-27 09:47:34 +08:00
export & import work correctly with clones
2018-04-09 01:14:30 +08:00
pack.entry({name: childFileName + ".dat", size: content.length}, content);
Script API changes, finished porting reddit plugin, reddit importer tar file
2018-02-27 09:47:34 +08:00
}
export subtree to filesystem
2017-12-03 10:48:22 +08:00
export & import work correctly with clones
2018-04-09 01:14:30 +08:00
function saveMetadataFile(childFileName, metadata) {
const metadataJson = JSON.stringify(metadata, null, '\t');
export subtree to filesystem
2017-12-03 10:48:22 +08:00
export & import work correctly with clones
2018-04-09 01:14:30 +08:00
pack.entry({name: childFileName + ".meta", size: metadataJson.length}, metadataJson);
export subtree to filesystem
2017-12-03 10:48:22 +08:00
}
export subtree to tar file
2018-02-25 23:55:21 +08:00
markdown import
2018-09-03 18:05:44 +08:00
function saveDirectory(childFileName) {
pack.entry({name: childFileName, type: 'directory'});
}
export & import work correctly with clones
2018-04-09 01:14:30 +08:00
pack.finalize();
export subtree to tar file
2018-02-25 23:55:21 +08:00
export & import work correctly with clones
2018-04-09 01:14:30 +08:00
res.setHeader('Content-Disposition', 'file; filename="' + name + '.tar"');
res.setHeader('Content-Type', 'application/tar');
pack.pipe(res);
export subtree to filesystem
2017-12-03 10:48:22 +08:00
}
export single note as markdown, #166
2018-09-03 15:40:22 +08:00
async function exportToMarkdown(branch, res) {
const note = await branch.getNote();
if (!await note.hasChildren()) {
await exportSingleMarkdown(note, res);
return;
}
implemented markdown export, #166
2018-09-03 05:39:10 +08:00
const turndownService = new TurndownService();
const pack = tar.pack();
export single note as markdown, #166
2018-09-03 15:40:22 +08:00
const name = await exportNoteInner(note, '');
implemented markdown export, #166
2018-09-03 05:39:10 +08:00
export single note as markdown, #166
2018-09-03 15:40:22 +08:00
async function exportNoteInner(note, directory) {
implemented markdown export, #166
2018-09-03 05:39:10 +08:00
const childFileName = directory + sanitize(note.title);
if (await note.hasLabel('excludeFromExport')) {
return;
}
saveDataFile(childFileName, note);
markdown import
2018-09-03 18:05:44 +08:00
const childNotes = await note.getChildNotes();
if (childNotes.length > 0) {
saveDirectory(childFileName);
}
for (const childNote of childNotes) {
export single note as markdown, #166
2018-09-03 15:40:22 +08:00
await exportNoteInner(childNote, childFileName + "/");
implemented markdown export, #166
2018-09-03 05:39:10 +08:00
}
return childFileName;
}
function saveDataFile(childFileName, note) {
if (note.type !== 'text' && note.type !== 'code') {
return;
}
if (note.content.trim().length === 0) {
return;
}
let markdown;
if (note.type === 'code') {
markdown = '```\n' + note.content + "\n```";
}
else if (note.type === 'text') {
markdown = turndownService.turndown(note.content);
}
else {
// other note types are not supported
return;
}
pack.entry({name: childFileName + ".md", size: markdown.length}, markdown);
}
markdown import
2018-09-03 18:05:44 +08:00
function saveDirectory(childFileName) {
pack.entry({name: childFileName, type: 'directory'});
}
implemented markdown export, #166
2018-09-03 05:39:10 +08:00
pack.finalize();
res.setHeader('Content-Disposition', 'file; filename="' + name + '.tar"');
res.setHeader('Content-Type', 'application/tar');
pack.pipe(res);
}
export single note as markdown, #166
2018-09-03 15:40:22 +08:00
async function exportSingleMarkdown(note, res) {
const turndownService = new TurndownService();
const markdown = turndownService.turndown(note.content);
const name = sanitize(note.title);
res.setHeader('Content-Disposition', 'file; filename="' + name + '.md"');
res.setHeader('Content-Type', 'text/markdown; charset=UTF-8');
res.send(markdown);
}
converted export/import notes
2018-03-31 03:34:07 +08:00
module.exports = {
exportNote
};
Reference in a new issue Copy permalink