2020-10-09 19:35:46 +02:00
|
|
|
import { ImportExportResult } from './types';
|
|
|
|
import { _ } from 'lib/locale';
|
|
|
|
|
|
|
|
const InteropService_Importer_Base = require('lib/services/interop/InteropService_Importer_Base').default;
|
2018-02-26 21:25:54 +02:00
|
|
|
const Folder = require('lib/models/Folder.js');
|
|
|
|
const Note = require('lib/models/Note.js');
|
Desktop: when importing MD files create resources for local linked files (#2262)
* md importer: first pass import attachment resources with markdown files
* md importer: import resources from md - no unneeded saves, check if files exist, regex name
* md importer: test import of local files as resources, separate method for importing linked files, comment regex matching md tags
* md importer: move stateful regex to method scope, remove spurius await
* md importer: lint
* md importer: respond to PR comments: remove test nesting, test sample, check if path is dir, use shim.fsDriver
* md importer: use file-path methods for getting attachment path
* md importer: use extractImageUrls helper, test for file with zero links
* md importer: try catch around importLocalImages, improve test
* md importer: importing attached images cover case where link also appears elsewhere in doc
* md importer: only create 1 resource if note contains duplicate links, test
* md importer: remove log
* md importer: remove use of lodash
2020-01-19 17:39:38 +02:00
|
|
|
const { basename, filename, rtrimSlashes, fileExtension, dirname } = require('lib/path-utils.js');
|
2020-10-09 19:35:46 +02:00
|
|
|
const shim = require('lib/shim').default;
|
|
|
|
const { extractImageUrls } = require('lib/markdownUtils').default;
|
2020-02-05 00:09:34 +02:00
|
|
|
const { unique } = require('lib/ArrayUtils');
|
Desktop: when importing MD files create resources for local linked files (#2262)
* md importer: first pass import attachment resources with markdown files
* md importer: import resources from md - no unneeded saves, check if files exist, regex name
* md importer: test import of local files as resources, separate method for importing linked files, comment regex matching md tags
* md importer: move stateful regex to method scope, remove spurius await
* md importer: lint
* md importer: respond to PR comments: remove test nesting, test sample, check if path is dir, use shim.fsDriver
* md importer: use file-path methods for getting attachment path
* md importer: use extractImageUrls helper, test for file with zero links
* md importer: try catch around importLocalImages, improve test
* md importer: importing attached images cover case where link also appears elsewhere in doc
* md importer: only create 1 resource if note contains duplicate links, test
* md importer: remove log
* md importer: remove use of lodash
2020-01-19 17:39:38 +02:00
|
|
|
const { pregQuote } = require('lib/string-utils-common');
|
2018-02-26 21:25:54 +02:00
|
|
|
|
2020-10-09 19:35:46 +02:00
|
|
|
export default class InteropService_Importer_Md extends InteropService_Importer_Base {
|
|
|
|
async exec(result:ImportExportResult) {
|
2018-02-27 22:04:38 +02:00
|
|
|
let parentFolderId = null;
|
2018-02-26 21:25:54 +02:00
|
|
|
|
2018-09-09 21:32:23 +02:00
|
|
|
const sourcePath = rtrimSlashes(this.sourcePath_);
|
2018-06-26 01:07:53 +02:00
|
|
|
|
2018-02-26 21:25:54 +02:00
|
|
|
const filePaths = [];
|
2018-09-09 21:32:23 +02:00
|
|
|
if (await shim.fsDriver().isDirectory(sourcePath)) {
|
2018-02-27 22:04:38 +02:00
|
|
|
if (!this.options_.destinationFolder) {
|
2018-09-09 21:32:23 +02:00
|
|
|
const folderTitle = await Folder.findUniqueItemTitle(basename(sourcePath));
|
2018-02-27 22:04:38 +02:00
|
|
|
const folder = await Folder.save({ title: folderTitle });
|
|
|
|
parentFolderId = folder.id;
|
|
|
|
} else {
|
|
|
|
parentFolderId = this.options_.destinationFolder.id;
|
|
|
|
}
|
2018-09-09 21:32:23 +02:00
|
|
|
|
|
|
|
this.importDirectory(sourcePath, parentFolderId);
|
2018-02-26 21:25:54 +02:00
|
|
|
} else {
|
2018-02-27 22:04:38 +02:00
|
|
|
if (!this.options_.destinationFolder) throw new Error(_('Please specify the notebook where the notes should be imported to.'));
|
2019-07-29 15:43:53 +02:00
|
|
|
parentFolderId = this.options_.destinationFolder.id;
|
2018-09-09 21:32:23 +02:00
|
|
|
filePaths.push(sourcePath);
|
2018-02-26 21:25:54 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
for (let i = 0; i < filePaths.length; i++) {
|
2018-09-09 21:32:23 +02:00
|
|
|
await this.importFile(filePaths[i], parentFolderId);
|
2018-02-26 21:25:54 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
|
2020-10-09 19:35:46 +02:00
|
|
|
async importDirectory(dirPath:string, parentFolderId:string) {
|
2019-09-19 23:51:18 +02:00
|
|
|
console.info(`Import: ${dirPath}`);
|
2018-09-09 21:32:23 +02:00
|
|
|
|
|
|
|
const supportedFileExtension = this.metadata().fileExtensions;
|
|
|
|
const stats = await shim.fsDriver().readDirStats(dirPath);
|
|
|
|
for (let i = 0; i < stats.length; i++) {
|
|
|
|
const stat = stats[i];
|
|
|
|
|
|
|
|
if (stat.isDirectory()) {
|
|
|
|
const folderTitle = await Folder.findUniqueItemTitle(basename(stat.path));
|
|
|
|
const folder = await Folder.save({ title: folderTitle, parent_id: parentFolderId });
|
2019-09-19 23:51:18 +02:00
|
|
|
this.importDirectory(`${dirPath}/${basename(stat.path)}`, folder.id);
|
2018-09-09 21:32:23 +02:00
|
|
|
} else if (supportedFileExtension.indexOf(fileExtension(stat.path).toLowerCase()) >= 0) {
|
2019-09-19 23:51:18 +02:00
|
|
|
this.importFile(`${dirPath}/${stat.path}`, parentFolderId);
|
2018-09-09 21:32:23 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
Desktop: when importing MD files create resources for local linked files (#2262)
* md importer: first pass import attachment resources with markdown files
* md importer: import resources from md - no unneeded saves, check if files exist, regex name
* md importer: test import of local files as resources, separate method for importing linked files, comment regex matching md tags
* md importer: move stateful regex to method scope, remove spurius await
* md importer: lint
* md importer: respond to PR comments: remove test nesting, test sample, check if path is dir, use shim.fsDriver
* md importer: use file-path methods for getting attachment path
* md importer: use extractImageUrls helper, test for file with zero links
* md importer: try catch around importLocalImages, improve test
* md importer: importing attached images cover case where link also appears elsewhere in doc
* md importer: only create 1 resource if note contains duplicate links, test
* md importer: remove log
* md importer: remove use of lodash
2020-01-19 17:39:38 +02:00
|
|
|
/**
|
|
|
|
* Parse text for links, attempt to find local file, if found create Joplin resource
|
|
|
|
* and update link accordingly.
|
|
|
|
*/
|
2020-10-09 19:35:46 +02:00
|
|
|
async importLocalImages(filePath:string, md:string) {
|
Desktop: when importing MD files create resources for local linked files (#2262)
* md importer: first pass import attachment resources with markdown files
* md importer: import resources from md - no unneeded saves, check if files exist, regex name
* md importer: test import of local files as resources, separate method for importing linked files, comment regex matching md tags
* md importer: move stateful regex to method scope, remove spurius await
* md importer: lint
* md importer: respond to PR comments: remove test nesting, test sample, check if path is dir, use shim.fsDriver
* md importer: use file-path methods for getting attachment path
* md importer: use extractImageUrls helper, test for file with zero links
* md importer: try catch around importLocalImages, improve test
* md importer: importing attached images cover case where link also appears elsewhere in doc
* md importer: only create 1 resource if note contains duplicate links, test
* md importer: remove log
* md importer: remove use of lodash
2020-01-19 17:39:38 +02:00
|
|
|
let updated = md;
|
|
|
|
const imageLinks = unique(extractImageUrls(md));
|
2020-10-09 19:35:46 +02:00
|
|
|
await Promise.all(imageLinks.map(async (encodedLink:string) => {
|
2020-03-27 14:20:38 +02:00
|
|
|
const link = decodeURI(encodedLink);
|
Desktop: when importing MD files create resources for local linked files (#2262)
* md importer: first pass import attachment resources with markdown files
* md importer: import resources from md - no unneeded saves, check if files exist, regex name
* md importer: test import of local files as resources, separate method for importing linked files, comment regex matching md tags
* md importer: move stateful regex to method scope, remove spurius await
* md importer: lint
* md importer: respond to PR comments: remove test nesting, test sample, check if path is dir, use shim.fsDriver
* md importer: use file-path methods for getting attachment path
* md importer: use extractImageUrls helper, test for file with zero links
* md importer: try catch around importLocalImages, improve test
* md importer: importing attached images cover case where link also appears elsewhere in doc
* md importer: only create 1 resource if note contains duplicate links, test
* md importer: remove log
* md importer: remove use of lodash
2020-01-19 17:39:38 +02:00
|
|
|
const attachmentPath = filename(`${dirname(filePath)}/${link}`, true);
|
|
|
|
const pathWithExtension = `${attachmentPath}.${fileExtension(link)}`;
|
|
|
|
const stat = await shim.fsDriver().stat(pathWithExtension);
|
|
|
|
const isDir = stat ? stat.isDirectory() : false;
|
|
|
|
if (stat && !isDir) {
|
|
|
|
const resource = await shim.createResourceFromPath(pathWithExtension);
|
|
|
|
// NOTE: use ](link) in case the link also appears elsewhere, such as in alt text
|
|
|
|
const linkPatternEscaped = pregQuote(`](${link})`);
|
|
|
|
const reg = new RegExp(linkPatternEscaped, 'g');
|
|
|
|
updated = updated.replace(reg, `](:/${resource.id})`);
|
|
|
|
}
|
|
|
|
}));
|
|
|
|
return updated;
|
|
|
|
}
|
|
|
|
|
2020-10-09 19:35:46 +02:00
|
|
|
async importFile(filePath:string, parentFolderId:string) {
|
2018-09-09 21:32:23 +02:00
|
|
|
const stat = await shim.fsDriver().stat(filePath);
|
2019-09-19 23:51:18 +02:00
|
|
|
if (!stat) throw new Error(`Cannot read ${filePath}`);
|
2018-09-09 21:32:23 +02:00
|
|
|
const title = filename(filePath);
|
|
|
|
const body = await shim.fsDriver().readFile(filePath);
|
Desktop: when importing MD files create resources for local linked files (#2262)
* md importer: first pass import attachment resources with markdown files
* md importer: import resources from md - no unneeded saves, check if files exist, regex name
* md importer: test import of local files as resources, separate method for importing linked files, comment regex matching md tags
* md importer: move stateful regex to method scope, remove spurius await
* md importer: lint
* md importer: respond to PR comments: remove test nesting, test sample, check if path is dir, use shim.fsDriver
* md importer: use file-path methods for getting attachment path
* md importer: use extractImageUrls helper, test for file with zero links
* md importer: try catch around importLocalImages, improve test
* md importer: importing attached images cover case where link also appears elsewhere in doc
* md importer: only create 1 resource if note contains duplicate links, test
* md importer: remove log
* md importer: remove use of lodash
2020-01-19 17:39:38 +02:00
|
|
|
let updatedBody;
|
|
|
|
try {
|
|
|
|
updatedBody = await this.importLocalImages(filePath, body);
|
|
|
|
} catch (error) {
|
|
|
|
// console.error(`Problem importing links for file ${filePath}, error:\n ${error}`);
|
|
|
|
}
|
2018-09-09 21:32:23 +02:00
|
|
|
const note = {
|
|
|
|
parent_id: parentFolderId,
|
|
|
|
title: title,
|
Desktop: when importing MD files create resources for local linked files (#2262)
* md importer: first pass import attachment resources with markdown files
* md importer: import resources from md - no unneeded saves, check if files exist, regex name
* md importer: test import of local files as resources, separate method for importing linked files, comment regex matching md tags
* md importer: move stateful regex to method scope, remove spurius await
* md importer: lint
* md importer: respond to PR comments: remove test nesting, test sample, check if path is dir, use shim.fsDriver
* md importer: use file-path methods for getting attachment path
* md importer: use extractImageUrls helper, test for file with zero links
* md importer: try catch around importLocalImages, improve test
* md importer: importing attached images cover case where link also appears elsewhere in doc
* md importer: only create 1 resource if note contains duplicate links, test
* md importer: remove log
* md importer: remove use of lodash
2020-01-19 17:39:38 +02:00
|
|
|
body: updatedBody || body,
|
2018-09-09 21:32:23 +02:00
|
|
|
updated_time: stat.mtime.getTime(),
|
|
|
|
created_time: stat.birthtime.getTime(),
|
|
|
|
user_updated_time: stat.mtime.getTime(),
|
|
|
|
user_created_time: stat.birthtime.getTime(),
|
|
|
|
};
|
Desktop: when importing MD files create resources for local linked files (#2262)
* md importer: first pass import attachment resources with markdown files
* md importer: import resources from md - no unneeded saves, check if files exist, regex name
* md importer: test import of local files as resources, separate method for importing linked files, comment regex matching md tags
* md importer: move stateful regex to method scope, remove spurius await
* md importer: lint
* md importer: respond to PR comments: remove test nesting, test sample, check if path is dir, use shim.fsDriver
* md importer: use file-path methods for getting attachment path
* md importer: use extractImageUrls helper, test for file with zero links
* md importer: try catch around importLocalImages, improve test
* md importer: importing attached images cover case where link also appears elsewhere in doc
* md importer: only create 1 resource if note contains duplicate links, test
* md importer: remove log
* md importer: remove use of lodash
2020-01-19 17:39:38 +02:00
|
|
|
|
|
|
|
return Note.save(note, { autoTimestamp: false });
|
2018-09-09 21:32:23 +02:00
|
|
|
}
|
2018-02-26 21:25:54 +02:00
|
|
|
}
|