server-ts: Port services/export/zip

This commit is contained in:
Elian Doran 2024-02-19 23:08:43 +02:00
parent 1728365fa1
commit 29d37c40c1
12 changed files with 176 additions and 167 deletions

37
package-lock.json generated
View File

@ -89,6 +89,7 @@
"trilium": "src/www.js" "trilium": "src/www.js"
}, },
"devDependencies": { "devDependencies": {
"@types/archiver": "^6.0.2",
"@types/better-sqlite3": "^7.6.9", "@types/better-sqlite3": "^7.6.9",
"@types/escape-html": "^1.0.4", "@types/escape-html": "^1.0.4",
"@types/express": "^4.17.21", "@types/express": "^4.17.21",
@ -1337,6 +1338,15 @@
"resolved": "https://registry.npmjs.org/@tweenjs/tween.js/-/tween.js-21.0.0.tgz", "resolved": "https://registry.npmjs.org/@tweenjs/tween.js/-/tween.js-21.0.0.tgz",
"integrity": "sha512-qVfOiFh0U8ZSkLgA6tf7kj2MciqRbSCWaJZRwftVO7UbtVDNsZAXpWXqvCDtIefvjC83UJB+vHTDOGm5ibXjEA==" "integrity": "sha512-qVfOiFh0U8ZSkLgA6tf7kj2MciqRbSCWaJZRwftVO7UbtVDNsZAXpWXqvCDtIefvjC83UJB+vHTDOGm5ibXjEA=="
}, },
"node_modules/@types/archiver": {
"version": "6.0.2",
"resolved": "https://registry.npmjs.org/@types/archiver/-/archiver-6.0.2.tgz",
"integrity": "sha512-KmROQqbQzKGuaAbmK+ZcytkJ51+YqDa7NmbXjmtC5YBLSyQYo21YaUnQ3HbaPFKL1ooo6RQ6OPYPIDyxfpDDXw==",
"dev": true,
"dependencies": {
"@types/readdir-glob": "*"
}
},
"node_modules/@types/better-sqlite3": { "node_modules/@types/better-sqlite3": {
"version": "7.6.9", "version": "7.6.9",
"resolved": "https://registry.npmjs.org/@types/better-sqlite3/-/better-sqlite3-7.6.9.tgz", "resolved": "https://registry.npmjs.org/@types/better-sqlite3/-/better-sqlite3-7.6.9.tgz",
@ -1647,6 +1657,15 @@
"integrity": "sha512-hKormJbkJqzQGhziax5PItDUTMAM9uE2XXQmM37dyd4hVM+5aVl7oVxMVUiVQn2oCQFN/LKCZdvSM0pFRqbSmQ==", "integrity": "sha512-hKormJbkJqzQGhziax5PItDUTMAM9uE2XXQmM37dyd4hVM+5aVl7oVxMVUiVQn2oCQFN/LKCZdvSM0pFRqbSmQ==",
"dev": true "dev": true
}, },
"node_modules/@types/readdir-glob": {
"version": "1.1.5",
"resolved": "https://registry.npmjs.org/@types/readdir-glob/-/readdir-glob-1.1.5.tgz",
"integrity": "sha512-raiuEPUYqXu+nvtY2Pe8s8FEmZ3x5yAH4VkLdihcPdalvsHltomrRC9BzuStrJ9yk06470hS0Crw0f1pXqD+Hg==",
"dev": true,
"dependencies": {
"@types/node": "*"
}
},
"node_modules/@types/responselike": { "node_modules/@types/responselike": {
"version": "1.0.0", "version": "1.0.0",
"resolved": "https://registry.npmjs.org/@types/responselike/-/responselike-1.0.0.tgz", "resolved": "https://registry.npmjs.org/@types/responselike/-/responselike-1.0.0.tgz",
@ -16088,6 +16107,15 @@
"resolved": "https://registry.npmjs.org/@tweenjs/tween.js/-/tween.js-21.0.0.tgz", "resolved": "https://registry.npmjs.org/@tweenjs/tween.js/-/tween.js-21.0.0.tgz",
"integrity": "sha512-qVfOiFh0U8ZSkLgA6tf7kj2MciqRbSCWaJZRwftVO7UbtVDNsZAXpWXqvCDtIefvjC83UJB+vHTDOGm5ibXjEA==" "integrity": "sha512-qVfOiFh0U8ZSkLgA6tf7kj2MciqRbSCWaJZRwftVO7UbtVDNsZAXpWXqvCDtIefvjC83UJB+vHTDOGm5ibXjEA=="
}, },
"@types/archiver": {
"version": "6.0.2",
"resolved": "https://registry.npmjs.org/@types/archiver/-/archiver-6.0.2.tgz",
"integrity": "sha512-KmROQqbQzKGuaAbmK+ZcytkJ51+YqDa7NmbXjmtC5YBLSyQYo21YaUnQ3HbaPFKL1ooo6RQ6OPYPIDyxfpDDXw==",
"dev": true,
"requires": {
"@types/readdir-glob": "*"
}
},
"@types/better-sqlite3": { "@types/better-sqlite3": {
"version": "7.6.9", "version": "7.6.9",
"resolved": "https://registry.npmjs.org/@types/better-sqlite3/-/better-sqlite3-7.6.9.tgz", "resolved": "https://registry.npmjs.org/@types/better-sqlite3/-/better-sqlite3-7.6.9.tgz",
@ -16391,6 +16419,15 @@
"integrity": "sha512-hKormJbkJqzQGhziax5PItDUTMAM9uE2XXQmM37dyd4hVM+5aVl7oVxMVUiVQn2oCQFN/LKCZdvSM0pFRqbSmQ==", "integrity": "sha512-hKormJbkJqzQGhziax5PItDUTMAM9uE2XXQmM37dyd4hVM+5aVl7oVxMVUiVQn2oCQFN/LKCZdvSM0pFRqbSmQ==",
"dev": true "dev": true
}, },
"@types/readdir-glob": {
"version": "1.1.5",
"resolved": "https://registry.npmjs.org/@types/readdir-glob/-/readdir-glob-1.1.5.tgz",
"integrity": "sha512-raiuEPUYqXu+nvtY2Pe8s8FEmZ3x5yAH4VkLdihcPdalvsHltomrRC9BzuStrJ9yk06470hS0Crw0f1pXqD+Hg==",
"dev": true,
"requires": {
"@types/node": "*"
}
},
"@types/responselike": { "@types/responselike": {
"version": "1.0.0", "version": "1.0.0",
"resolved": "https://registry.npmjs.org/@types/responselike/-/responselike-1.0.0.tgz", "resolved": "https://registry.npmjs.org/@types/responselike/-/responselike-1.0.0.tgz",

View File

@ -112,6 +112,7 @@
"yauzl": "2.10.0" "yauzl": "2.10.0"
}, },
"devDependencies": { "devDependencies": {
"@types/archiver": "^6.0.2",
"@types/better-sqlite3": "^7.6.9", "@types/better-sqlite3": "^7.6.9",
"@types/escape-html": "^1.0.4", "@types/escape-html": "^1.0.4",
"@types/express": "^4.17.21", "@types/express": "^4.17.21",

View File

@ -29,7 +29,7 @@ interface ConstructorData<T extends AbstractBeccaEntity<T>> {
*/ */
abstract class AbstractBeccaEntity<T extends AbstractBeccaEntity<T>> { abstract class AbstractBeccaEntity<T extends AbstractBeccaEntity<T>> {
protected utcDateModified?: string; utcDateModified?: string;
protected dateCreated?: string; protected dateCreated?: string;
protected dateModified?: string; protected dateModified?: string;
protected isSynced?: boolean; protected isSynced?: boolean;

View File

@ -7,8 +7,8 @@ const TaskContext = require('../services/task_context');
const v = require('./validators.js'); const v = require('./validators.js');
const searchService = require('../services/search/services/search'); const searchService = require('../services/search/services/search');
const SearchContext = require('../services/search/search_context'); const SearchContext = require('../services/search/search_context');
const zipExportService = require('../services/export/zip.js'); const zipExportService = require('../services/export/zip');
const zipImportService = require('../services/import/zip.js'); const zipImportService = require('../services/import/zip');
function register(router) { function register(router) {
eu.route(router, 'get', '/etapi/notes', (req, res, next) => { eu.route(router, 'get', '/etapi/notes', (req, res, next) => {

View File

@ -1,6 +1,6 @@
"use strict"; "use strict";
const zipExportService = require('../../services/export/zip.js'); const zipExportService = require('../../services/export/zip');
const singleExportService = require('../../services/export/single'); const singleExportService = require('../../services/export/single');
const opmlExportService = require('../../services/export/opml'); const opmlExportService = require('../../services/export/opml');
const becca = require('../../becca/becca'); const becca = require('../../becca/becca');

View File

@ -2,7 +2,7 @@
const enexImportService = require('../../services/import/enex.js'); const enexImportService = require('../../services/import/enex.js');
const opmlImportService = require('../../services/import/opml'); const opmlImportService = require('../../services/import/opml');
const zipImportService = require('../../services/import/zip.js'); const zipImportService = require('../../services/import/zip');
const singleImportService = require('../../services/import/single'); const singleImportService = require('../../services/import/single');
const cls = require('../../services/cls'); const cls = require('../../services/cls');
const path = require('path'); const path = require('path');

View File

@ -18,7 +18,7 @@ const ws = require('./ws');
const SpacedUpdate = require('./spaced_update.js'); const SpacedUpdate = require('./spaced_update.js');
const specialNotesService = require('./special_notes.js'); const specialNotesService = require('./special_notes.js');
const branchService = require('./branches'); const branchService = require('./branches');
const exportService = require('./export/zip.js'); const exportService = require('./export/zip');
const syncMutex = require('./sync_mutex'); const syncMutex = require('./sync_mutex');
const backupService = require('./backup'); const backupService = require('./backup');
const optionsService = require('./options'); const optionsService = require('./options');

View File

@ -125,6 +125,6 @@ function inlineAttachments(content: string) {
return content; return content;
} }
module.exports = { export = {
exportSingleNote exportSingleNote
}; };

View File

@ -1,33 +1,28 @@
"use strict"; "use strict";
const html = require('html'); import html = require('html');
const dateUtils = require('../date_utils'); import dateUtils = require('../date_utils');
const path = require('path'); import path = require('path');
const mimeTypes = require('mime-types'); import mimeTypes = require('mime-types');
const mdService = require('./md'); import mdService = require('./md');
const packageInfo = require('../../../package.json'); import packageInfo = require('../../../package.json');
const utils = require('../utils'); import utils = require('../utils');
const protectedSessionService = require('../protected_session'); import protectedSessionService = require('../protected_session');
const sanitize = require("sanitize-filename"); import sanitize = require("sanitize-filename");
const fs = require("fs"); import fs = require("fs");
const becca = require('../../becca/becca'); import becca = require('../../becca/becca');
const RESOURCE_DIR = require('../../services/resource_dir').RESOURCE_DIR; const RESOURCE_DIR = require('../../services/resource_dir').RESOURCE_DIR;
const archiver = require('archiver'); import archiver = require('archiver');
const log = require('../log'); import log = require('../log');
const TaskContext = require('../task_context'); import TaskContext = require('../task_context');
const ValidationError = require('../../errors/validation_error'); import ValidationError = require('../../errors/validation_error');
const NoteMeta = require('../meta/note_meta'); import NoteMeta = require('../meta/note_meta');
const AttachmentMeta = require('../meta/attachment_meta'); import AttachmentMeta = require('../meta/attachment_meta');
const AttributeMeta = require('../meta/attribute_meta'); import AttributeMeta = require('../meta/attribute_meta');
import BBranch = require('../../becca/entities/bbranch');
import { Response } from 'express';
/** async function exportToZip(taskContext: TaskContext, branch: BBranch, format: "html" | "markdown", res: Response | fs.WriteStream, setHeaders = true) {
* @param {TaskContext} taskContext
* @param {BBranch} branch
* @param {string} format - 'html' or 'markdown'
* @param {object} res - express response
* @param {boolean} setHeaders
*/
async function exportToZip(taskContext, branch, format, res, setHeaders = true) {
if (!['html', 'markdown'].includes(format)) { if (!['html', 'markdown'].includes(format)) {
throw new ValidationError(`Only 'html' and 'markdown' allowed as export format, '${format}' given`); throw new ValidationError(`Only 'html' and 'markdown' allowed as export format, '${format}' given`);
} }
@ -36,15 +31,9 @@ async function exportToZip(taskContext, branch, format, res, setHeaders = true)
zlib: { level: 9 } // Sets the compression level. zlib: { level: 9 } // Sets the compression level.
}); });
/** @type {Object.<string, NoteMeta>} */ const noteIdToMeta: Record<string, NoteMeta> = {};
const noteIdToMeta = {};
/** function getUniqueFilename(existingFileNames: Record<string, number>, fileName: string) {
* @param {Object.<string, int>} existingFileNames
* @param {string} fileName
* @returns {string}
*/
function getUniqueFilename(existingFileNames, fileName) {
const lcFileName = fileName.toLowerCase(); const lcFileName = fileName.toLowerCase();
if (lcFileName in existingFileNames) { if (lcFileName in existingFileNames) {
@ -67,14 +56,7 @@ async function exportToZip(taskContext, branch, format, res, setHeaders = true)
} }
} }
/** function getDataFileName(type: string | null, mime: string, baseFileName: string, existingFileNames: Record<string, number>): string {
* @param {string|null} type
* @param {string} mime
* @param {string} baseFileName
* @param {Object.<string, int>} existingFileNames
* @return {string}
*/
function getDataFileName(type, mime, baseFileName, existingFileNames) {
let fileName = baseFileName.trim(); let fileName = baseFileName.trim();
if (fileName.length > 30) { if (fileName.length > 30) {
fileName = fileName.substr(0, 30).trim(); fileName = fileName.substr(0, 30).trim();
@ -115,13 +97,7 @@ async function exportToZip(taskContext, branch, format, res, setHeaders = true)
return getUniqueFilename(existingFileNames, fileName); return getUniqueFilename(existingFileNames, fileName);
} }
/** function createNoteMeta(branch: BBranch, parentMeta: Partial<NoteMeta>, existingFileNames: Record<string, number>): NoteMeta | null {
* @param {BBranch} branch
* @param {NoteMeta} parentMeta
* @param {Object.<string, int>} existingFileNames
* @returns {NoteMeta|null}
*/
function createNoteMeta(branch, parentMeta, existingFileNames) {
const note = branch.getNote(); const note = branch.getNote();
if (note.hasOwnedLabel('excludeFromExport')) { if (note.hasOwnedLabel('excludeFromExport')) {
@ -136,24 +112,26 @@ async function exportToZip(taskContext, branch, format, res, setHeaders = true)
baseFileName = baseFileName.substr(0, 200); baseFileName = baseFileName.substr(0, 200);
} }
if (!parentMeta.notePath) { throw new Error("Missing parent note path."); }
const notePath = parentMeta.notePath.concat([note.noteId]); const notePath = parentMeta.notePath.concat([note.noteId]);
if (note.noteId in noteIdToMeta) { if (note.noteId in noteIdToMeta) {
const fileName = getUniqueFilename(existingFileNames, `${baseFileName}.clone.${format === 'html' ? 'html' : 'md'}`); const fileName = getUniqueFilename(existingFileNames, `${baseFileName}.clone.${format === 'html' ? 'html' : 'md'}`);
const meta = new NoteMeta(); const meta: NoteMeta = {
meta.isClone = true; isClone: true,
meta.noteId = note.noteId; noteId: note.noteId,
meta.notePath = notePath; notePath: notePath,
meta.title = note.getTitleOrProtected(); title: note.getTitleOrProtected(),
meta.prefix = branch.prefix; prefix: branch.prefix,
meta.dataFileName = fileName; dataFileName: fileName,
meta.type = 'text'; // export will have text description type: 'text', // export will have text description
meta.format = format; format: format
};
return meta; return meta;
} }
const meta = new NoteMeta(); const meta: Partial<NoteMeta> = {};
meta.isClone = false; meta.isClone = false;
meta.noteId = note.noteId; meta.noteId = note.noteId;
meta.notePath = notePath; meta.notePath = notePath;
@ -164,12 +142,14 @@ async function exportToZip(taskContext, branch, format, res, setHeaders = true)
meta.type = note.type; meta.type = note.type;
meta.mime = note.mime; meta.mime = note.mime;
meta.attributes = note.getOwnedAttributes().map(attribute => { meta.attributes = note.getOwnedAttributes().map(attribute => {
const attrMeta = new AttributeMeta(); const attrMeta = {
attrMeta.type = attribute.type; type: attribute.type,
attrMeta.name = attribute.name; name: attribute.name,
attrMeta.value = attribute.value; value: attribute.value,
attrMeta.isInheritable = attribute.isInheritable; isInheritable: attribute.isInheritable,
attrMeta.position = attribute.position; position: attribute.position
};
return attrMeta; return attrMeta;
}); });
@ -179,12 +159,12 @@ async function exportToZip(taskContext, branch, format, res, setHeaders = true)
meta.format = format; meta.format = format;
} }
noteIdToMeta[note.noteId] = meta; noteIdToMeta[note.noteId] = meta as NoteMeta;
// sort children for having a stable / reproducible export format // sort children for having a stable / reproducible export format
note.sortChildren(); note.sortChildren();
const childBranches = note.getChildBranches() const childBranches = note.getChildBranches()
.filter(branch => branch.noteId !== '_hidden'); .filter(branch => branch?.noteId !== '_hidden');
const available = !note.isProtected || protectedSessionService.isProtectedSessionAvailable(); const available = !note.isProtected || protectedSessionService.isProtectedSessionAvailable();
@ -196,18 +176,19 @@ async function exportToZip(taskContext, branch, format, res, setHeaders = true)
const attachments = note.getAttachments(); const attachments = note.getAttachments();
meta.attachments = attachments meta.attachments = attachments
.map(attachment => { .map(attachment => {
const attMeta = new AttachmentMeta(); const attMeta: AttachmentMeta = {
attMeta.attachmentId = attachment.attachmentId; attachmentId: attachment.attachmentId,
attMeta.title = attachment.title; title: attachment.title,
attMeta.role = attachment.role; role: attachment.role,
attMeta.mime = attachment.mime; mime: attachment.mime,
attMeta.position = attachment.position; position: attachment.position,
attMeta.dataFileName = getDataFileName( dataFileName: getDataFileName(
null, null,
attachment.mime, attachment.mime,
baseFileName + "_" + attachment.title, baseFileName + "_" + attachment.title,
existingFileNames existingFileNames
); )
};
return attMeta; return attMeta;
}); });
@ -219,7 +200,9 @@ async function exportToZip(taskContext, branch, format, res, setHeaders = true)
const childExistingNames = {}; const childExistingNames = {};
for (const childBranch of childBranches) { for (const childBranch of childBranches) {
const note = createNoteMeta(childBranch, meta, childExistingNames); if (!childBranch) { continue; }
const note = createNoteMeta(childBranch, meta as NoteMeta, childExistingNames);
// can be undefined if export is disabled for this note // can be undefined if export is disabled for this note
if (note) { if (note) {
@ -228,18 +211,13 @@ async function exportToZip(taskContext, branch, format, res, setHeaders = true)
} }
} }
return meta; return meta as NoteMeta;
} }
/** function getNoteTargetUrl(targetNoteId: string, sourceMeta: NoteMeta): string | null {
* @param {string} targetNoteId
* @param {NoteMeta} sourceMeta
* @return {string|null}
*/
function getNoteTargetUrl(targetNoteId, sourceMeta) {
const targetMeta = noteIdToMeta[targetNoteId]; const targetMeta = noteIdToMeta[targetNoteId];
if (!targetMeta) { if (!targetMeta || !targetMeta.notePath || !sourceMeta.notePath) {
return null; return null;
} }
@ -256,24 +234,20 @@ async function exportToZip(taskContext, branch, format, res, setHeaders = true)
for (let i = 0; i < targetPath.length - 1; i++) { for (let i = 0; i < targetPath.length - 1; i++) {
const meta = noteIdToMeta[targetPath[i]]; const meta = noteIdToMeta[targetPath[i]];
if (meta.dirFileName) {
url += `${encodeURIComponent(meta.dirFileName)}/`; url += `${encodeURIComponent(meta.dirFileName)}/`;
}
} }
const meta = noteIdToMeta[targetPath[targetPath.length - 1]]; const meta = noteIdToMeta[targetPath[targetPath.length - 1]];
// link can target note which is only "folder-note" and as such, will not have a file in an export // link can target note which is only "folder-note" and as such, will not have a file in an export
url += encodeURIComponent(meta.dataFileName || meta.dirFileName); url += encodeURIComponent(meta.dataFileName || meta.dirFileName || "");
return url; return url;
} }
/** function rewriteLinks(content: string, noteMeta: NoteMeta): string {
* @param {string} content
* @param {NoteMeta} noteMeta
* @return {string}
*/
function rewriteLinks(content, noteMeta) {
content = content.replace(/src="[^"]*api\/images\/([a-zA-Z0-9_]+)\/[^"]*"/g, (match, targetNoteId) => { content = content.replace(/src="[^"]*api\/images\/([a-zA-Z0-9_]+)\/[^"]*"/g, (match, targetNoteId) => {
const url = getNoteTargetUrl(targetNoteId, noteMeta); const url = getNoteTargetUrl(targetNoteId, noteMeta);
@ -300,10 +274,10 @@ async function exportToZip(taskContext, branch, format, res, setHeaders = true)
return content; return content;
function findAttachment(targetAttachmentId) { function findAttachment(targetAttachmentId: string) {
let url; let url;
const attachmentMeta = noteMeta.attachments.find(attMeta => attMeta.attachmentId === targetAttachmentId); const attachmentMeta = (noteMeta.attachments || []).find(attMeta => attMeta.attachmentId === targetAttachmentId);
if (attachmentMeta) { if (attachmentMeta) {
// easy job here, because attachment will be in the same directory as the note's data file. // easy job here, because attachment will be in the same directory as the note's data file.
url = attachmentMeta.dataFileName; url = attachmentMeta.dataFileName;
@ -314,21 +288,17 @@ async function exportToZip(taskContext, branch, format, res, setHeaders = true)
} }
} }
/** function prepareContent(title: string, content: string | Buffer, noteMeta: NoteMeta): string | Buffer {
* @param {string} title if (['html', 'markdown'].includes(noteMeta?.format || "")) {
* @param {string|Buffer} content
* @param {NoteMeta} noteMeta
* @return {string|Buffer}
*/
function prepareContent(title, content, noteMeta) {
if (['html', 'markdown'].includes(noteMeta.format)) {
content = content.toString(); content = content.toString();
content = rewriteLinks(content, noteMeta); content = rewriteLinks(content, noteMeta);
} }
if (noteMeta.format === 'html') { if (noteMeta.format === 'html' && typeof content === "string") {
if (!content.substr(0, 100).toLowerCase().includes("<html")) { if (!content.substr(0, 100).toLowerCase().includes("<html")) {
if (!noteMeta?.notePath?.length) { throw new Error("Missing note path."); }
const cssUrl = `${"../".repeat(noteMeta.notePath.length - 1)}style.css`; const cssUrl = `${"../".repeat(noteMeta.notePath.length - 1)}style.css`;
const htmlTitle = utils.escapeHtml(title); const htmlTitle = utils.escapeHtml(title);
@ -354,7 +324,7 @@ async function exportToZip(taskContext, branch, format, res, setHeaders = true)
return content.length < 100_000 return content.length < 100_000
? html.prettyPrint(content, {indent_size: 2}) ? html.prettyPrint(content, {indent_size: 2})
: content; : content;
} else if (noteMeta.format === 'markdown') { } else if (noteMeta.format === 'markdown' && typeof content === "string") {
let markdownContent = mdService.toMarkdown(content); let markdownContent = mdService.toMarkdown(content);
if (markdownContent.trim().length > 0 && !markdownContent.startsWith("# ")) { if (markdownContent.trim().length > 0 && !markdownContent.startsWith("# ")) {
@ -368,17 +338,17 @@ ${markdownContent}`;
} }
} }
/** function saveNote(noteMeta: NoteMeta, filePathPrefix: string) {
* @param {NoteMeta} noteMeta
* @param {string} filePathPrefix
*/
function saveNote(noteMeta, filePathPrefix) {
log.info(`Exporting note '${noteMeta.noteId}'`); log.info(`Exporting note '${noteMeta.noteId}'`);
if (!noteMeta.noteId || !noteMeta.title) {
throw new Error("Missing note meta.");
}
if (noteMeta.isClone) { if (noteMeta.isClone) {
const targetUrl = getNoteTargetUrl(noteMeta.noteId, noteMeta); const targetUrl = getNoteTargetUrl(noteMeta.noteId, noteMeta);
let content = `<p>This is a clone of a note. Go to its <a href="${targetUrl}">primary location</a>.</p>`; let content: string | Buffer = `<p>This is a clone of a note. Go to its <a href="${targetUrl}">primary location</a>.</p>`;
content = prepareContent(noteMeta.title, content, noteMeta); content = prepareContent(noteMeta.title, content, noteMeta);
@ -388,6 +358,8 @@ ${markdownContent}`;
} }
const note = becca.getNote(noteMeta.noteId); const note = becca.getNote(noteMeta.noteId);
if (!note) { throw new Error("Unable to find note."); }
if (!note.utcDateModified) { throw new Error("Unable to find modification date."); }
if (noteMeta.dataFileName) { if (noteMeta.dataFileName) {
const content = prepareContent(noteMeta.title, note.getContent(), noteMeta); const content = prepareContent(noteMeta.title, note.getContent(), noteMeta);
@ -400,7 +372,9 @@ ${markdownContent}`;
taskContext.increaseProgressCount(); taskContext.increaseProgressCount();
for (const attachmentMeta of noteMeta.attachments) { for (const attachmentMeta of noteMeta.attachments || []) {
if (!attachmentMeta.attachmentId) { continue; }
const attachment = note.getAttachmentById(attachmentMeta.attachmentId); const attachment = note.getAttachmentById(attachmentMeta.attachmentId);
const content = attachment.getContent(); const content = attachment.getContent();
@ -410,29 +384,25 @@ ${markdownContent}`;
}); });
} }
if (noteMeta.children?.length > 0) { if (noteMeta.children?.length || 0 > 0) {
const directoryPath = filePathPrefix + noteMeta.dirFileName; const directoryPath = filePathPrefix + noteMeta.dirFileName;
// create directory // create directory
archive.append('', { name: `${directoryPath}/`, date: dateUtils.parseDateTime(note.utcDateModified) }); archive.append('', { name: `${directoryPath}/`, date: dateUtils.parseDateTime(note.utcDateModified) });
for (const childMeta of noteMeta.children) { for (const childMeta of noteMeta.children || []) {
saveNote(childMeta, `${directoryPath}/`); saveNote(childMeta, `${directoryPath}/`);
} }
} }
} }
/** function saveNavigation(rootMeta: NoteMeta, navigationMeta: NoteMeta) {
* @param {NoteMeta} rootMeta function saveNavigationInner(meta: NoteMeta) {
* @param {NoteMeta} navigationMeta
*/
function saveNavigation(rootMeta, navigationMeta) {
function saveNavigationInner(meta) {
let html = '<li>'; let html = '<li>';
const escapedTitle = utils.escapeHtml(`${meta.prefix ? `${meta.prefix} - ` : ''}${meta.title}`); const escapedTitle = utils.escapeHtml(`${meta.prefix ? `${meta.prefix} - ` : ''}${meta.title}`);
if (meta.dataFileName) { if (meta.dataFileName && meta.noteId) {
const targetUrl = getNoteTargetUrl(meta.noteId, rootMeta); const targetUrl = getNoteTargetUrl(meta.noteId, rootMeta);
html += `<a href="${targetUrl}" target="detail">${escapedTitle}</a>`; html += `<a href="${targetUrl}" target="detail">${escapedTitle}</a>`;
@ -470,16 +440,12 @@ ${markdownContent}`;
archive.append(prettyHtml, { name: navigationMeta.dataFileName }); archive.append(prettyHtml, { name: navigationMeta.dataFileName });
} }
/** function saveIndex(rootMeta: NoteMeta, indexMeta: NoteMeta) {
* @param {NoteMeta} rootMeta
* @param {NoteMeta} indexMeta
*/
function saveIndex(rootMeta, indexMeta) {
let firstNonEmptyNote; let firstNonEmptyNote;
let curMeta = rootMeta; let curMeta = rootMeta;
while (!firstNonEmptyNote) { while (!firstNonEmptyNote) {
if (curMeta.dataFileName) { if (curMeta.dataFileName && curMeta.noteId) {
firstNonEmptyNote = getNoteTargetUrl(curMeta.noteId, rootMeta); firstNonEmptyNote = getNoteTargetUrl(curMeta.noteId, rootMeta);
} }
@ -506,17 +472,13 @@ ${markdownContent}`;
archive.append(fullHtml, { name: indexMeta.dataFileName }); archive.append(fullHtml, { name: indexMeta.dataFileName });
} }
/** function saveCss(rootMeta: NoteMeta, cssMeta: NoteMeta) {
* @param {NoteMeta} rootMeta
* @param {NoteMeta} cssMeta
*/
function saveCss(rootMeta, cssMeta) {
const cssContent = fs.readFileSync(`${RESOURCE_DIR}/libraries/ckeditor/ckeditor-content.css`); const cssContent = fs.readFileSync(`${RESOURCE_DIR}/libraries/ckeditor/ckeditor-content.css`);
archive.append(cssContent, { name: cssMeta.dataFileName }); archive.append(cssContent, { name: cssMeta.dataFileName });
} }
const existingFileNames = format === 'html' ? ['navigation', 'index'] : []; const existingFileNames: Record<string, number> = format === 'html' ? {'navigation': 0, 'index': 1} : {};
const rootMeta = createNoteMeta(branch, { notePath: [] }, existingFileNames); const rootMeta = createNoteMeta(branch, { notePath: [] }, existingFileNames);
const metaFile = { const metaFile = {
@ -525,7 +487,9 @@ ${markdownContent}`;
files: [ rootMeta ] files: [ rootMeta ]
}; };
let navigationMeta, indexMeta, cssMeta; let navigationMeta: NoteMeta | null = null;
let indexMeta: NoteMeta | null = null;
let cssMeta: NoteMeta | null = null;
if (format === 'html') { if (format === 'html') {
navigationMeta = { navigationMeta = {
@ -552,7 +516,7 @@ ${markdownContent}`;
for (const noteMeta of Object.values(noteIdToMeta)) { for (const noteMeta of Object.values(noteIdToMeta)) {
// filter out relations which are not inside this export // filter out relations which are not inside this export
noteMeta.attributes = noteMeta.attributes.filter(attr => { noteMeta.attributes = (noteMeta.attributes || []).filter(attr => {
if (attr.type !== 'relation') { if (attr.type !== 'relation') {
return true; return true;
} else if (attr.value in noteIdToMeta) { } else if (attr.value in noteIdToMeta) {
@ -567,7 +531,9 @@ ${markdownContent}`;
} }
if (!rootMeta) { // corner case of disabled export for exported note if (!rootMeta) { // corner case of disabled export for exported note
res.sendStatus(400); if ("sendStatus" in res) {
res.sendStatus(400);
}
return; return;
} }
@ -578,6 +544,10 @@ ${markdownContent}`;
saveNote(rootMeta, ''); saveNote(rootMeta, '');
if (format === 'html') { if (format === 'html') {
if (!navigationMeta || !indexMeta || !cssMeta) {
throw new Error("Missing meta.");
}
saveNavigation(rootMeta, navigationMeta); saveNavigation(rootMeta, navigationMeta);
saveIndex(rootMeta, indexMeta); saveIndex(rootMeta, indexMeta);
saveCss(rootMeta, cssMeta); saveCss(rootMeta, cssMeta);
@ -586,7 +556,7 @@ ${markdownContent}`;
const note = branch.getNote(); const note = branch.getNote();
const zipFileName = `${branch.prefix ? `${branch.prefix} - ` : ""}${note.getTitleOrProtected()}.zip`; const zipFileName = `${branch.prefix ? `${branch.prefix} - ` : ""}${note.getTitleOrProtected()}.zip`;
if (setHeaders) { if (setHeaders && "setHeader" in res) {
res.setHeader('Content-Disposition', utils.getContentDisposition(zipFileName)); res.setHeader('Content-Disposition', utils.getContentDisposition(zipFileName));
res.setHeader('Content-Type', 'application/zip'); res.setHeader('Content-Type', 'application/zip');
} }
@ -597,7 +567,7 @@ ${markdownContent}`;
taskContext.taskSucceeded(); taskContext.taskSucceeded();
} }
async function exportToZipFile(noteId, format, zipFilePath) { async function exportToZipFile(noteId: string, format: "markdown" | "html", zipFilePath: string) {
const fileOutputStream = fs.createWriteStream(zipFilePath); const fileOutputStream = fs.createWriteStream(zipFilePath);
const taskContext = new TaskContext('no-progress-reporting'); const taskContext = new TaskContext('no-progress-reporting');
@ -612,7 +582,7 @@ async function exportToZipFile(noteId, format, zipFilePath) {
log.info(`Exported '${noteId}' with format '${format}' to '${zipFilePath}'`); log.info(`Exported '${noteId}' with format '${format}' to '${zipFilePath}'`);
} }
module.exports = { export = {
exportToZip, exportToZip,
exportToZipFile exportToZipFile
}; };

View File

@ -1,9 +1,9 @@
interface AttachmentMeta { interface AttachmentMeta {
attachmentId: string; attachmentId?: string;
title: string; title: string;
role: string; role: string;
mime: string; mime: string;
position: number; position?: number;
dataFileName: string; dataFileName: string;
} }

View File

@ -1,23 +1,24 @@
import AttachmentMeta = require("./attachment_meta");
import AttributeMeta = require("./attribute_meta"); import AttributeMeta = require("./attribute_meta");
interface NoteMeta { interface NoteMeta {
noteId: string; noteId?: string;
notePath: string; notePath?: string[];
isClone: boolean; isClone?: boolean;
title: string; title?: string;
notePosition: number; notePosition?: number;
prefix: string; prefix?: string | null;
isExpanded: boolean; isExpanded?: boolean;
type: string; type?: string;
mime: string; mime?: string;
/** 'html' or 'markdown', applicable to text notes only */ /** 'html' or 'markdown', applicable to text notes only */
format: "html" | "markdown"; format?: "html" | "markdown";
dataFileName: string; dataFileName: string;
dirFileName: string; dirFileName?: string;
/** this file should not be imported (e.g., HTML navigation) */ /** this file should not be imported (e.g., HTML navigation) */
noImport: boolean; noImport?: boolean;
attributes: AttributeMeta[]; attributes?: AttributeMeta[];
attachments: AttributeMeta[]; attachments?: AttachmentMeta[];
children?: NoteMeta[]; children?: NoteMeta[];
} }

View File

@ -96,7 +96,7 @@ async function createInitialDatabase() {
const dummyTaskContext = new TaskContext("no-progress-reporting", 'import', false); const dummyTaskContext = new TaskContext("no-progress-reporting", 'import', false);
const zipImportService = require('./import/zip.js'); const zipImportService = require('./import/zip');
await zipImportService.importZip(dummyTaskContext, demoFile, rootNote); await zipImportService.importZip(dummyTaskContext, demoFile, rootNote);
sql.transactional(() => { sql.transactional(() => {