mirror of
https://github.com/laurent22/joplin.git
synced 2024-12-24 10:27:10 +02:00
543 lines
15 KiB
JavaScript
543 lines
15 KiB
JavaScript
const fs = require('fs-extra');
|
|
const shim = require('./shim').default;
|
|
const { GeolocationNode } = require('./geolocation-node.js');
|
|
const { FileApiDriverLocal } = require('./file-api-driver-local.js');
|
|
const { setLocale, defaultLocale, closestSupportedLocale } = require('./locale');
|
|
const FsDriverNode = require('./fs-driver-node').default;
|
|
const mimeUtils = require('./mime-utils.js').mime;
|
|
const Note = require('./models/Note.js');
|
|
const Resource = require('./models/Resource.js');
|
|
const urlValidator = require('valid-url');
|
|
const { _ } = require('./locale');
|
|
const http = require('http');
|
|
const https = require('https');
|
|
const toRelative = require('relative');
|
|
const timers = require('timers');
|
|
const zlib = require('zlib');
|
|
|
|
function fileExists(filePath) {
|
|
try {
|
|
return fs.statSync(filePath).isFile();
|
|
} catch (err) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
const gunzipFile = function(source, destination) {
|
|
if (!fileExists(source)) {
|
|
throw new Error(`No such file: ${source}`);
|
|
}
|
|
|
|
return new Promise((resolve, reject) => {
|
|
// prepare streams
|
|
const src = fs.createReadStream(source);
|
|
const dest = fs.createWriteStream(destination);
|
|
|
|
// extract the archive
|
|
src.pipe(zlib.createGunzip()).pipe(dest);
|
|
|
|
// callback on extract completion
|
|
dest.on('close', function() {
|
|
resolve();
|
|
});
|
|
|
|
src.on('error', () => {
|
|
reject();
|
|
});
|
|
|
|
dest.on('error', () => {
|
|
reject();
|
|
});
|
|
});
|
|
};
|
|
|
|
function shimInit(sharp = null, keytar = null, React = null) {
|
|
keytar = (shim.isWindows() || shim.isMac()) && !shim.isPortable() ? keytar : null;
|
|
|
|
shim.fsDriver = () => {
|
|
throw new Error('Not implemented');
|
|
};
|
|
shim.FileApiDriverLocal = FileApiDriverLocal;
|
|
shim.Geolocation = GeolocationNode;
|
|
shim.FormData = require('form-data');
|
|
shim.sjclModule = require('./vendor/sjcl.js');
|
|
|
|
shim.fsDriver = () => {
|
|
if (!shim.fsDriver_) shim.fsDriver_ = new FsDriverNode();
|
|
return shim.fsDriver_;
|
|
};
|
|
|
|
if (React) {
|
|
shim.react = () => {
|
|
return React;
|
|
};
|
|
}
|
|
|
|
shim.randomBytes = async count => {
|
|
const buffer = require('crypto').randomBytes(count);
|
|
return Array.from(buffer);
|
|
};
|
|
|
|
shim.detectAndSetLocale = function(Setting) {
|
|
let locale = process.env.LANG;
|
|
if (!locale) locale = defaultLocale();
|
|
locale = locale.split('.');
|
|
locale = locale[0];
|
|
locale = closestSupportedLocale(locale);
|
|
Setting.setValue('locale', locale);
|
|
setLocale(locale);
|
|
return locale;
|
|
};
|
|
|
|
shim.writeImageToFile = async function(nativeImage, mime, targetPath) {
|
|
if (shim.isElectron()) {
|
|
// For Electron
|
|
let buffer = null;
|
|
|
|
mime = mime.toLowerCase();
|
|
|
|
if (mime === 'image/png') {
|
|
buffer = nativeImage.toPNG();
|
|
} else if (mime === 'image/jpg' || mime === 'image/jpeg') {
|
|
buffer = nativeImage.toJPEG(90);
|
|
}
|
|
|
|
if (!buffer) throw new Error(`Cannot resize image because mime type "${mime}" is not supported: ${targetPath}`);
|
|
|
|
await shim.fsDriver().writeFile(targetPath, buffer, 'buffer');
|
|
} else {
|
|
throw new Error('Node support not implemented');
|
|
}
|
|
};
|
|
|
|
shim.showMessageBox = (message, options = null) => {
|
|
if (shim.isElectron()) {
|
|
const bridge = require('electron').remote.require('./bridge').default;
|
|
return bridge().showMessageBox(message, options);
|
|
} else {
|
|
throw new Error('Not implemented');
|
|
}
|
|
};
|
|
|
|
const handleResizeImage_ = async function(filePath, targetPath, mime, resizeLargeImages) {
|
|
const maxDim = Resource.IMAGE_MAX_DIMENSION;
|
|
|
|
if (shim.isElectron()) {
|
|
// For Electron
|
|
const nativeImage = require('electron').nativeImage;
|
|
let image = nativeImage.createFromPath(filePath);
|
|
if (image.isEmpty()) throw new Error(`Image is invalid or does not exist: ${filePath}`);
|
|
|
|
const size = image.getSize();
|
|
|
|
let mustResize = size.width > maxDim || size.height > maxDim;
|
|
|
|
if (mustResize && resizeLargeImages === 'ask') {
|
|
const answer = shim.showMessageBox(_('You are about to attach a large image (%dx%d pixels). Would you like to resize it down to %d pixels before attaching it?', size.width, size.height, maxDim), {
|
|
buttons: [_('Yes'), _('No'), _('Cancel')],
|
|
});
|
|
|
|
if (answer === 2) return false;
|
|
|
|
mustResize = answer === 0;
|
|
}
|
|
|
|
if (!mustResize) {
|
|
shim.fsDriver().copy(filePath, targetPath);
|
|
return true;
|
|
}
|
|
|
|
const options = {};
|
|
if (size.width > size.height) {
|
|
options.width = maxDim;
|
|
} else {
|
|
options.height = maxDim;
|
|
}
|
|
|
|
image = image.resize(options);
|
|
|
|
await shim.writeImageToFile(image, mime, targetPath);
|
|
} else {
|
|
// For the CLI tool
|
|
const image = sharp(filePath);
|
|
const md = await image.metadata();
|
|
|
|
if (md.width <= maxDim && md.height <= maxDim) {
|
|
shim.fsDriver().copy(filePath, targetPath);
|
|
return true;
|
|
}
|
|
|
|
return new Promise((resolve, reject) => {
|
|
image
|
|
.resize(Resource.IMAGE_MAX_DIMENSION, Resource.IMAGE_MAX_DIMENSION, {
|
|
fit: 'inside',
|
|
withoutEnlargement: true,
|
|
})
|
|
.toFile(targetPath, (err, info) => {
|
|
if (err) {
|
|
reject(err);
|
|
} else {
|
|
resolve(info);
|
|
}
|
|
});
|
|
});
|
|
}
|
|
|
|
return true;
|
|
};
|
|
|
|
shim.createResourceFromPath = async function(filePath, defaultProps = null, options = null) {
|
|
options = Object.assign({
|
|
resizeLargeImages: 'always', // 'always', 'ask' or 'never'
|
|
userSideValidation: false,
|
|
}, options);
|
|
|
|
const readChunk = require('read-chunk');
|
|
const imageType = require('image-type');
|
|
|
|
const uuid = require('./uuid').default;
|
|
const { basename, fileExtension, safeFileExtension } = require('./path-utils');
|
|
|
|
if (!(await fs.pathExists(filePath))) throw new Error(_('Cannot access %s', filePath));
|
|
|
|
defaultProps = defaultProps ? defaultProps : {};
|
|
|
|
const resourceId = defaultProps.id ? defaultProps.id : uuid.create();
|
|
|
|
const resource = Resource.new();
|
|
resource.id = resourceId;
|
|
resource.mime = mimeUtils.fromFilename(filePath);
|
|
resource.title = basename(filePath);
|
|
|
|
let fileExt = safeFileExtension(fileExtension(filePath));
|
|
|
|
if (!resource.mime) {
|
|
const buffer = await readChunk(filePath, 0, 64);
|
|
const detectedType = imageType(buffer);
|
|
|
|
if (detectedType) {
|
|
fileExt = detectedType.ext;
|
|
resource.mime = detectedType.mime;
|
|
} else {
|
|
resource.mime = 'application/octet-stream';
|
|
}
|
|
}
|
|
|
|
resource.file_extension = fileExt;
|
|
|
|
const targetPath = Resource.fullPath(resource);
|
|
|
|
if (options.resizeLargeImages !== 'never' && ['image/jpeg', 'image/jpg', 'image/png'].includes(resource.mime)) {
|
|
const ok = await handleResizeImage_(filePath, targetPath, resource.mime, options.resizeLargeImages);
|
|
if (!ok) return null;
|
|
} else {
|
|
await fs.copy(filePath, targetPath, { overwrite: true });
|
|
}
|
|
|
|
// While a whole object can be passed as defaultProps, we only just
|
|
// support the title and ID (used above). Any other prop should be
|
|
// derived from the provided file.
|
|
if ('title' in defaultProps) resource.title = defaultProps.title;
|
|
|
|
const itDoes = await shim.fsDriver().waitTillExists(targetPath);
|
|
if (!itDoes) throw new Error(`Resource file was not created: ${targetPath}`);
|
|
|
|
const fileStat = await shim.fsDriver().stat(targetPath);
|
|
resource.size = fileStat.size;
|
|
|
|
const saveOptions = { isNew: true };
|
|
if (options.userSideValidation) saveOptions.userSideValidation = true;
|
|
return Resource.save(resource, saveOptions);
|
|
};
|
|
|
|
shim.attachFileToNoteBody = async function(noteBody, filePath, position = null, options = null) {
|
|
options = Object.assign({}, {
|
|
createFileURL: false,
|
|
}, options);
|
|
|
|
const { basename } = require('path');
|
|
const { escapeTitleText } = require('./markdownUtils').default;
|
|
const { toFileProtocolPath } = require('./path-utils');
|
|
|
|
let resource = null;
|
|
if (!options.createFileURL) {
|
|
resource = await shim.createResourceFromPath(filePath, null, options);
|
|
if (!resource) return null;
|
|
}
|
|
|
|
const newBody = [];
|
|
|
|
if (position === null) {
|
|
position = noteBody ? noteBody.length : 0;
|
|
}
|
|
|
|
if (noteBody && position) newBody.push(noteBody.substr(0, position));
|
|
|
|
if (!options.createFileURL) {
|
|
newBody.push(Resource.markdownTag(resource));
|
|
} else {
|
|
const filename = escapeTitleText(basename(filePath)); // to get same filename as standard drag and drop
|
|
const fileURL = `[${filename}](${toFileProtocolPath(filePath)})`;
|
|
newBody.push(fileURL);
|
|
}
|
|
|
|
if (noteBody) newBody.push(noteBody.substr(position));
|
|
|
|
return newBody.join('\n\n');
|
|
};
|
|
|
|
shim.attachFileToNote = async function(note, filePath, position = null, options = null) {
|
|
const newBody = await shim.attachFileToNoteBody(note.body, filePath, position, options);
|
|
if (!newBody) return null;
|
|
|
|
const newNote = Object.assign({}, note, {
|
|
body: newBody,
|
|
});
|
|
return Note.save(newNote);
|
|
};
|
|
|
|
shim.imageFromDataUrl = async function(imageDataUrl, filePath, options = null) {
|
|
if (options === null) options = {};
|
|
|
|
if (shim.isElectron()) {
|
|
const nativeImage = require('electron').nativeImage;
|
|
let image = nativeImage.createFromDataURL(imageDataUrl);
|
|
if (image.isEmpty()) throw new Error('Could not convert data URL to image - perhaps the format is not supported (eg. image/gif)'); // Would throw for example if the image format is no supported (eg. image/gif)
|
|
if (options.cropRect) {
|
|
// Crop rectangle values need to be rounded or the crop() call will fail
|
|
const c = options.cropRect;
|
|
if ('x' in c) c.x = Math.round(c.x);
|
|
if ('y' in c) c.y = Math.round(c.y);
|
|
if ('width' in c) c.width = Math.round(c.width);
|
|
if ('height' in c) c.height = Math.round(c.height);
|
|
image = image.crop(c);
|
|
}
|
|
const mime = mimeUtils.fromDataUrl(imageDataUrl);
|
|
await shim.writeImageToFile(image, mime, filePath);
|
|
} else {
|
|
if (options.cropRect) throw new Error('Crop rect not supported in Node');
|
|
|
|
const imageDataURI = require('image-data-uri');
|
|
const result = imageDataURI.decode(imageDataUrl);
|
|
await shim.fsDriver().writeFile(filePath, result.dataBuffer, 'buffer');
|
|
}
|
|
};
|
|
|
|
const nodeFetch = require('node-fetch');
|
|
|
|
// Not used??
|
|
shim.readLocalFileBase64 = path => {
|
|
const data = fs.readFileSync(path);
|
|
return new Buffer(data).toString('base64');
|
|
};
|
|
|
|
shim.fetch = async function(url, options = null) {
|
|
const validatedUrl = urlValidator.isUri(url);
|
|
if (!validatedUrl) throw new Error(`Not a valid URL: ${url}`);
|
|
|
|
return shim.fetchWithRetry(() => {
|
|
return nodeFetch(url, options);
|
|
}, options);
|
|
};
|
|
|
|
shim.fetchBlob = async function(url, options) {
|
|
if (!options || !options.path) throw new Error('fetchBlob: target file path is missing');
|
|
if (!options.method) options.method = 'GET';
|
|
// if (!('maxRetry' in options)) options.maxRetry = 5;
|
|
|
|
const urlParse = require('url').parse;
|
|
|
|
url = urlParse(url.trim());
|
|
const method = options.method ? options.method : 'GET';
|
|
const http = url.protocol.toLowerCase() == 'http:' ? require('follow-redirects').http : require('follow-redirects').https;
|
|
const headers = options.headers ? options.headers : {};
|
|
const filePath = options.path;
|
|
|
|
function makeResponse(response) {
|
|
return {
|
|
ok: response.statusCode < 400,
|
|
path: filePath,
|
|
text: () => {
|
|
return response.statusMessage;
|
|
},
|
|
json: () => {
|
|
return { message: `${response.statusCode}: ${response.statusMessage}` };
|
|
},
|
|
status: response.statusCode,
|
|
headers: response.headers,
|
|
};
|
|
}
|
|
|
|
const requestOptions = {
|
|
protocol: url.protocol,
|
|
host: url.hostname,
|
|
port: url.port,
|
|
method: method,
|
|
path: url.pathname + (url.query ? `?${url.query}` : ''),
|
|
headers: headers,
|
|
};
|
|
|
|
const doFetchOperation = async () => {
|
|
return new Promise((resolve, reject) => {
|
|
let file = null;
|
|
|
|
const cleanUpOnError = error => {
|
|
// We ignore any unlink error as we only want to report on the main error
|
|
fs.unlink(filePath)
|
|
.catch(() => {})
|
|
.then(() => {
|
|
if (file) {
|
|
file.close(() => {
|
|
file = null;
|
|
reject(error);
|
|
});
|
|
} else {
|
|
reject(error);
|
|
}
|
|
});
|
|
};
|
|
|
|
try {
|
|
// Note: relative paths aren't supported
|
|
file = fs.createWriteStream(filePath);
|
|
|
|
file.on('error', function(error) {
|
|
cleanUpOnError(error);
|
|
});
|
|
|
|
const request = http.request(requestOptions, function(response) {
|
|
response.pipe(file);
|
|
|
|
const isGzipped = response.headers['content-encoding'] === 'gzip';
|
|
|
|
file.on('finish', function() {
|
|
file.close(async () => {
|
|
if (isGzipped) {
|
|
const gzipFilePath = `${filePath}.gzip`;
|
|
await shim.fsDriver().move(filePath, gzipFilePath);
|
|
|
|
try {
|
|
await gunzipFile(gzipFilePath, filePath);
|
|
resolve(makeResponse(response));
|
|
} catch (error) {
|
|
cleanUpOnError(error);
|
|
}
|
|
|
|
shim.fsDriver().remove(gzipFilePath);
|
|
} else {
|
|
resolve(makeResponse(response));
|
|
}
|
|
});
|
|
});
|
|
});
|
|
|
|
request.on('error', function(error) {
|
|
cleanUpOnError(error);
|
|
});
|
|
|
|
request.end();
|
|
} catch (error) {
|
|
cleanUpOnError(error);
|
|
}
|
|
});
|
|
};
|
|
|
|
return shim.fetchWithRetry(doFetchOperation, options);
|
|
};
|
|
|
|
shim.uploadBlob = async function(url, options) {
|
|
if (!options || !options.path) throw new Error('uploadBlob: source file path is missing');
|
|
const content = await fs.readFile(options.path);
|
|
options = Object.assign({}, options, {
|
|
body: content,
|
|
});
|
|
return shim.fetch(url, options);
|
|
};
|
|
|
|
shim.stringByteLength = function(string) {
|
|
return Buffer.byteLength(string, 'utf-8');
|
|
};
|
|
|
|
shim.Buffer = Buffer;
|
|
|
|
shim.openUrl = url => {
|
|
const bridge = require('electron').remote.require('./bridge').default;
|
|
// Returns true if it opens the file successfully; returns false if it could
|
|
// not find the file.
|
|
return bridge().openExternal(url);
|
|
};
|
|
|
|
shim.httpAgent_ = null;
|
|
|
|
shim.httpAgent = url => {
|
|
if (shim.isLinux() && !shim.httpAgent) {
|
|
const AgentSettings = {
|
|
keepAlive: true,
|
|
maxSockets: 1,
|
|
keepAliveMsecs: 5000,
|
|
};
|
|
if (url.startsWith('https')) {
|
|
shim.httpAgent_ = new https.Agent(AgentSettings);
|
|
} else {
|
|
shim.httpAgent_ = new http.Agent(AgentSettings);
|
|
}
|
|
}
|
|
return shim.httpAgent_;
|
|
};
|
|
|
|
shim.openOrCreateFile = (filepath, defaultContents) => {
|
|
// If the file doesn't exist, create it
|
|
if (!fs.existsSync(filepath)) {
|
|
fs.writeFile(filepath, defaultContents, 'utf-8', (error) => {
|
|
if (error) {
|
|
console.error(`error: ${error}`);
|
|
}
|
|
});
|
|
}
|
|
|
|
// Open the file
|
|
return shim.openUrl(`file://${filepath}`);
|
|
};
|
|
|
|
shim.waitForFrame = () => {};
|
|
|
|
shim.appVersion = () => {
|
|
if (shim.isElectron()) {
|
|
const p = require('../packageInfo.js');
|
|
return p.version;
|
|
}
|
|
const p = require('../package.json');
|
|
return p.version;
|
|
};
|
|
|
|
shim.pathRelativeToCwd = (path) => {
|
|
return toRelative(process.cwd(), path);
|
|
};
|
|
|
|
shim.setTimeout = (fn, interval) => {
|
|
return timers.setTimeout(fn, interval);
|
|
};
|
|
|
|
shim.setInterval = (fn, interval) => {
|
|
return timers.setInterval(fn, interval);
|
|
};
|
|
|
|
shim.clearTimeout = (id) => {
|
|
return timers.clearTimeout(id);
|
|
};
|
|
|
|
shim.clearInterval = (id) => {
|
|
return timers.clearInterval(id);
|
|
};
|
|
|
|
shim.keytar = () => {
|
|
return keytar;
|
|
};
|
|
|
|
shim.requireDynamic = (path) => {
|
|
return require(path);
|
|
};
|
|
}
|
|
|
|
module.exports = { shimInit };
|