mirror of
https://github.com/laurent22/joplin.git
synced 2024-12-30 10:36:35 +02:00
877 lines
28 KiB
TypeScript
877 lines
28 KiB
TypeScript
import shim, { CreatePdfFromImagesOptions, CreateResourceFromPathOptions, PdfInfo } from './shim';
|
|
import GeolocationNode from './geolocation-node';
|
|
import { setLocale, defaultLocale, closestSupportedLocale } from './locale';
|
|
import FsDriverNode from './fs-driver-node';
|
|
import Note from './models/Note';
|
|
import Resource from './models/Resource';
|
|
import { basename, fileExtension, safeFileExtension } from './path-utils';
|
|
import * as fs from 'fs-extra';
|
|
import * as pdfJsNamespace from 'pdfjs-dist';
|
|
import { writeFile } from 'fs/promises';
|
|
import { ResourceEntity } from './services/database/types';
|
|
import { TextItem } from 'pdfjs-dist/types/src/display/api';
|
|
import replaceUnsupportedCharacters from './utils/replaceUnsupportedCharacters';
|
|
import { FetchBlobOptions } from './types';
|
|
|
|
import FileApiDriverLocal from './file-api-driver-local';
|
|
import * as mimeUtils from './mime-utils';
|
|
const { _ } = require('./locale');
|
|
const http = require('http');
|
|
const https = require('https');
|
|
const { HttpProxyAgent, HttpsProxyAgent } = require('hpagent');
|
|
const toRelative = require('relative');
|
|
const timers = require('timers');
|
|
const zlib = require('zlib');
|
|
const dgram = require('dgram');
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
const proxySettings: any = {};
|
|
|
|
function fileExists(filePath: string) {
|
|
try {
|
|
return fs.statSync(filePath).isFile();
|
|
} catch (error) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
function isUrlHttps(url: string) {
|
|
return url.startsWith('https');
|
|
}
|
|
|
|
function resolveProxyUrl(proxyUrl: string) {
|
|
return (
|
|
proxyUrl ||
|
|
process.env['http_proxy'] ||
|
|
process.env['https_proxy'] ||
|
|
process.env['HTTP_PROXY'] ||
|
|
process.env['HTTPS_PROXY']
|
|
);
|
|
}
|
|
|
|
// https://github.com/sindresorhus/callsites/blob/main/index.js
|
|
function callsites() {
|
|
const _prepareStackTrace = Error.prepareStackTrace;
|
|
Error.prepareStackTrace = (_any, stack) => stack;
|
|
const stack = new Error().stack.slice(1);
|
|
Error.prepareStackTrace = _prepareStackTrace;
|
|
return stack;
|
|
}
|
|
|
|
const gunzipFile = function(source: string, destination: string) {
|
|
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', () => {
|
|
resolve(null);
|
|
});
|
|
|
|
src.on('error', () => {
|
|
reject();
|
|
});
|
|
|
|
dest.on('error', () => {
|
|
reject();
|
|
});
|
|
});
|
|
};
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
function setupProxySettings(options: any) {
|
|
proxySettings.maxConcurrentConnections = options.maxConcurrentConnections;
|
|
proxySettings.proxyTimeout = options.proxyTimeout;
|
|
proxySettings.proxyEnabled = options.proxyEnabled;
|
|
proxySettings.proxyUrl = options.proxyUrl;
|
|
}
|
|
|
|
interface ShimInitOptions {
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
sharp: any;
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
keytar: any;
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
React: any;
|
|
appVersion: ()=> string;
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
electronBridge: any;
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
nodeSqlite: any;
|
|
pdfJs: typeof pdfJsNamespace;
|
|
}
|
|
|
|
function shimInit(options: ShimInitOptions = null) {
|
|
options = {
|
|
sharp: null,
|
|
keytar: null,
|
|
React: null,
|
|
appVersion: null,
|
|
electronBridge: null,
|
|
nodeSqlite: null,
|
|
pdfJs: null,
|
|
...options,
|
|
};
|
|
|
|
const sharp = options.sharp;
|
|
const keytar = (shim.isWindows() || shim.isMac()) && !shim.isPortable() ? options.keytar : null;
|
|
const appVersion = options.appVersion;
|
|
const pdfJs = options.pdfJs;
|
|
|
|
shim.setNodeSqlite(options.nodeSqlite);
|
|
|
|
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.electronBridge_ = options.electronBridge;
|
|
|
|
shim.fsDriver = () => {
|
|
if (!shim.fsDriver_) shim.fsDriver_ = new FsDriverNode();
|
|
return shim.fsDriver_;
|
|
};
|
|
|
|
shim.dgram = () => {
|
|
return dgram;
|
|
};
|
|
|
|
if (options.React) {
|
|
shim.react = () => {
|
|
return options.React;
|
|
};
|
|
}
|
|
|
|
shim.electronBridge = () => {
|
|
return shim.electronBridge_;
|
|
};
|
|
|
|
shim.randomBytes = async count => {
|
|
const buffer = require('crypto').randomBytes(count);
|
|
return Array.from(buffer);
|
|
};
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
shim.detectAndSetLocale = function(Setting: any) {
|
|
let locale = shim.isElectron() ? shim.electronBridge().getLocale() : 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 = async (message, options = null) => {
|
|
if (shim.isElectron()) {
|
|
return shim.electronBridge().showMessageBox(message, options);
|
|
} else {
|
|
throw new Error('Not implemented');
|
|
}
|
|
};
|
|
|
|
const handleResizeImage_ = async function(filePath: string, targetPath: string, mime: string, resizeLargeImages: string) {
|
|
const maxDim = Resource.IMAGE_MAX_DIMENSION;
|
|
|
|
if (shim.isElectron()) {
|
|
// For Electron/renderer process
|
|
// Note that we avoid nativeImage because it loses rotation metadata.
|
|
// See https://github.com/electron/electron/issues/41189
|
|
//
|
|
// After the upstream bug has been fixed, this should be reverted to using
|
|
// nativeImage (see commit 99e8818ba093a931b1a0cbccbee0b94a4fd37a54 for the
|
|
// original code).
|
|
|
|
const image = new Image();
|
|
image.src = filePath;
|
|
await new Promise<void>((resolve, reject) => {
|
|
image.onload = () => resolve();
|
|
image.onerror = () => reject(new Error(`Image at ${filePath} failed to load.`));
|
|
image.onabort = () => reject(new Error(`Loading stopped for image at ${filePath}.`));
|
|
});
|
|
if (!image.complete || (image.width === 0 && image.height === 0)) {
|
|
throw new Error(`Image is invalid or does not exist: ${filePath}`);
|
|
}
|
|
|
|
const saveOriginalImage = async () => {
|
|
await shim.fsDriver().copy(filePath, targetPath);
|
|
return true;
|
|
};
|
|
const saveResizedImage = async () => {
|
|
let newWidth, newHeight;
|
|
if (image.width > image.height) {
|
|
newWidth = maxDim;
|
|
newHeight = image.height * maxDim / image.width;
|
|
} else {
|
|
newWidth = image.width * maxDim / image.height;
|
|
newHeight = maxDim;
|
|
}
|
|
|
|
const canvas = new OffscreenCanvas(newWidth, newHeight);
|
|
const ctx = canvas.getContext('2d');
|
|
ctx.drawImage(image, 0, 0, newWidth, newHeight);
|
|
|
|
const resizedImage = await canvas.convertToBlob({ type: mime });
|
|
await fs.writeFile(targetPath, Buffer.from(await resizedImage.arrayBuffer()));
|
|
return true;
|
|
};
|
|
|
|
const canResize = image.width > maxDim || image.height > maxDim;
|
|
if (canResize) {
|
|
if (resizeLargeImages === 'alwaysAsk') {
|
|
const Yes = 0, No = 1, Cancel = 2;
|
|
const userAnswer = await 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?', image.width, image.height, maxDim)}\n\n${_('(You may disable this prompt in the options)')}`, {
|
|
buttons: [_('Yes'), _('No'), _('Cancel')],
|
|
});
|
|
if (userAnswer === Yes) return await saveResizedImage();
|
|
if (userAnswer === No) return await saveOriginalImage();
|
|
if (userAnswer === Cancel) return false;
|
|
} else if (resizeLargeImages === 'alwaysResize') {
|
|
return await saveResizedImage();
|
|
}
|
|
}
|
|
|
|
return await saveOriginalImage();
|
|
} else {
|
|
// For the CLI tool
|
|
const image = sharp(filePath);
|
|
const md = await image.metadata();
|
|
|
|
if (md.width <= maxDim && md.height <= maxDim) {
|
|
await 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,
|
|
})
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
.toFile(targetPath, (error: any, info: any) => {
|
|
if (error) {
|
|
reject(error);
|
|
} else {
|
|
resolve(info);
|
|
}
|
|
});
|
|
});
|
|
}
|
|
};
|
|
|
|
// This is a bit of an ugly method that's used to both create a new resource
|
|
// from a file, and update one. To update a resource, pass the
|
|
// destinationResourceId option. This method is indirectly tested in
|
|
// Api.test.ts.
|
|
shim.createResourceFromPath = async function(filePath, defaultProps: ResourceEntity = null, options: CreateResourceFromPathOptions = null) {
|
|
options = {
|
|
resizeLargeImages: 'always', // 'always', 'ask' or 'never'
|
|
userSideValidation: false,
|
|
destinationResourceId: '',
|
|
...options,
|
|
};
|
|
|
|
const readChunk = require('read-chunk');
|
|
const imageType = require('image-type');
|
|
|
|
const isUpdate = !!options.destinationResourceId;
|
|
|
|
const uuid = require('./uuid').default;
|
|
|
|
if (!(await fs.pathExists(filePath))) throw new Error(_('Cannot access %s', filePath));
|
|
|
|
defaultProps = defaultProps ? defaultProps : {};
|
|
|
|
let resourceId = defaultProps.id ? defaultProps.id : uuid.create();
|
|
if (isUpdate) resourceId = options.destinationResourceId;
|
|
|
|
let resource = isUpdate ? {} : Resource.new();
|
|
resource.id = resourceId;
|
|
|
|
// When this is an update we auto-update the mime type, in case the
|
|
// content type has changed, but we keep the title. It is still possible
|
|
// to modify the title on update using defaultProps.
|
|
resource.mime = mimeUtils.fromFilename(filePath);
|
|
if (!isUpdate) 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;
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
const saveOptions: any = { isNew: true };
|
|
if (options.userSideValidation) saveOptions.userSideValidation = true;
|
|
|
|
if (isUpdate) {
|
|
saveOptions.isNew = false;
|
|
const tempPath = `${targetPath}.tmp`;
|
|
await shim.fsDriver().move(targetPath, tempPath);
|
|
resource = await Resource.save(resource, saveOptions);
|
|
await Resource.updateResourceBlobContent(resource.id, tempPath);
|
|
await shim.fsDriver().remove(tempPath);
|
|
return resource;
|
|
} else {
|
|
return Resource.save(resource, saveOptions);
|
|
}
|
|
};
|
|
|
|
shim.attachFileToNoteBody = async function(noteBody, filePath, position = null, options = null) {
|
|
options = { createFileURL: false, markupLanguage: 1, ...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.markupTag(resource, options.markupLanguage));
|
|
} 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');
|
|
};
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
shim.attachFileToNote = async function(note, filePath, position: number = null, options: any = null) {
|
|
if (!options) options = {};
|
|
if (note.markup_language) options.markupLanguage = note.markup_language;
|
|
const newBody = await shim.attachFileToNoteBody(note.body, filePath, position, options);
|
|
if (!newBody) return null;
|
|
|
|
const newNote = { ...note, body: newBody };
|
|
return Note.save(newNote);
|
|
};
|
|
|
|
shim.imageToDataUrl = async (filePath, maxSize) => {
|
|
if (shim.isElectron()) {
|
|
const nativeImage = require('electron').nativeImage;
|
|
let image = nativeImage.createFromPath(filePath);
|
|
if (!image) throw new Error(`Could not load image: ${filePath}`);
|
|
|
|
const ext = fileExtension(filePath).toLowerCase();
|
|
if (!['jpg', 'jpeg', 'png'].includes(ext)) throw new Error(`Unsupported file format: ${ext}`);
|
|
|
|
if (maxSize) {
|
|
const size = image.getSize();
|
|
|
|
if (size.width > maxSize || size.height > maxSize) {
|
|
console.warn(`Image is over ${maxSize}px - resizing it: ${filePath}`);
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
const options: any = {};
|
|
if (size.width > size.height) {
|
|
options.width = maxSize;
|
|
} else {
|
|
options.height = maxSize;
|
|
}
|
|
|
|
image = image.resize(options);
|
|
}
|
|
}
|
|
|
|
return image.toDataURL();
|
|
} else {
|
|
throw new Error('Unsupported method');
|
|
}
|
|
},
|
|
|
|
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 = {}) {
|
|
try { // Check if the url is valid
|
|
new URL(url);
|
|
} catch (error) { // If the url is not valid, a TypeError will be thrown
|
|
throw new Error(`Not a valid URL: ${url}`);
|
|
}
|
|
const resolvedProxyUrl = resolveProxyUrl(proxySettings.proxyUrl);
|
|
options.agent = (resolvedProxyUrl && proxySettings.proxyEnabled) ? shim.proxyAgent(url, resolvedProxyUrl) : null;
|
|
return shim.fetchWithRetry(() => {
|
|
return nodeFetch(url, options);
|
|
}, options);
|
|
};
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
shim.fetchBlob = async function(url: any, options: FetchBlobOptions) {
|
|
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;
|
|
|
|
// 21 maxRedirects is the default amount from follow-redirects library
|
|
// 20 seems to be the max amount that most popular browsers will allow
|
|
if (!options.maxRedirects) options.maxRedirects = 21;
|
|
if (!options.timeout) options.timeout = undefined;
|
|
|
|
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;
|
|
const downloadController = options.downloadController;
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
function makeResponse(response: any) {
|
|
return {
|
|
ok: response.statusCode < 400,
|
|
path: filePath,
|
|
text: () => {
|
|
return response.statusMessage;
|
|
},
|
|
json: () => {
|
|
return { message: `${response.statusCode}: ${response.statusMessage}` };
|
|
},
|
|
status: response.statusCode,
|
|
headers: response.headers,
|
|
};
|
|
}
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
const requestOptions: any = {
|
|
protocol: url.protocol,
|
|
host: url.hostname,
|
|
port: url.port,
|
|
method: method,
|
|
path: url.pathname + (url.query ? `?${url.query}` : ''),
|
|
headers: headers,
|
|
timeout: options.timeout,
|
|
maxRedirects: options.maxRedirects,
|
|
};
|
|
|
|
const resolvedProxyUrl = resolveProxyUrl(proxySettings.proxyUrl);
|
|
requestOptions.agent = (resolvedProxyUrl && proxySettings.proxyEnabled) ? shim.proxyAgent(url.href, resolvedProxyUrl) : null;
|
|
|
|
const doFetchOperation = async () => {
|
|
return new Promise((resolve, reject) => {
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
let file: any = null;
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
const cleanUpOnError = (error: any) => {
|
|
// We ignore any unlink error as we only want to report on the main error
|
|
void fs.unlink(filePath)
|
|
// eslint-disable-next-line promise/prefer-await-to-then -- Old code before rule was applied
|
|
.catch(() => {})
|
|
// eslint-disable-next-line promise/prefer-await-to-then -- Old code before rule was applied
|
|
.then(() => {
|
|
if (file) {
|
|
file.close(() => {
|
|
file = null;
|
|
reject(error);
|
|
});
|
|
} else {
|
|
reject(error);
|
|
}
|
|
});
|
|
};
|
|
|
|
try {
|
|
// Note: relative paths aren't supported
|
|
file = fs.createWriteStream(filePath);
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
file.on('error', (error: any) => {
|
|
cleanUpOnError(error);
|
|
});
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
const request = http.request(requestOptions, (response: any) => {
|
|
|
|
if (downloadController) {
|
|
response.on('data', downloadController.handleChunk(request));
|
|
}
|
|
|
|
response.pipe(file);
|
|
|
|
const isGzipped = response.headers['content-encoding'] === 'gzip';
|
|
|
|
file.on('finish', () => {
|
|
file.close(async () => {
|
|
if (isGzipped) {
|
|
const gzipFilePath = `${filePath}.gzip`;
|
|
await shim.fsDriver().move(filePath, gzipFilePath);
|
|
|
|
try {
|
|
await gunzipFile(gzipFilePath, filePath);
|
|
// Calling request.destroy() within the downloadController can cause problems.
|
|
// The response.pipe(file) will continue even after request.destroy() is called,
|
|
// potentially causing the same promise to resolve while the cleanUpOnError
|
|
// is removing the file that have been downloaded by this function.
|
|
if (request.destroyed) return;
|
|
resolve(makeResponse(response));
|
|
} catch (error) {
|
|
cleanUpOnError(error);
|
|
}
|
|
|
|
await shim.fsDriver().remove(gzipFilePath);
|
|
} else {
|
|
if (request.destroyed) return;
|
|
resolve(makeResponse(response));
|
|
}
|
|
});
|
|
});
|
|
});
|
|
|
|
request.on('timeout', () => {
|
|
request.destroy(new Error(`Request timed out. Timeout value: ${requestOptions.timeout}ms.`));
|
|
});
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
request.on('error', (error: any) => {
|
|
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 = { ...options, body: content };
|
|
return shim.fetch(url, options);
|
|
};
|
|
|
|
shim.stringByteLength = function(string) {
|
|
return Buffer.byteLength(string, 'utf-8');
|
|
};
|
|
|
|
shim.Buffer = Buffer;
|
|
|
|
shim.openUrl = url => {
|
|
// Returns true if it opens the file successfully; returns false if it could
|
|
// not find the file.
|
|
return shim.electronBridge().openExternal(url);
|
|
};
|
|
|
|
shim.httpAgent_ = null;
|
|
|
|
shim.httpAgent = url => {
|
|
if (!shim.httpAgent_) {
|
|
const AgentSettings = {
|
|
keepAlive: true,
|
|
maxSockets: 1,
|
|
keepAliveMsecs: 5000,
|
|
};
|
|
shim.httpAgent_ = {
|
|
http: new http.Agent(AgentSettings),
|
|
https: new https.Agent(AgentSettings),
|
|
};
|
|
}
|
|
return url.startsWith('https') ? shim.httpAgent_.https : shim.httpAgent_.http;
|
|
};
|
|
|
|
shim.proxyAgent = (serverUrl: string, proxyUrl: string) => {
|
|
const proxyAgentConfig = {
|
|
keepAlive: true,
|
|
maxSockets: proxySettings.maxConcurrentConnections,
|
|
keepAliveMsecs: 5000,
|
|
proxy: proxyUrl,
|
|
timeout: proxySettings.proxyTimeout * 1000,
|
|
};
|
|
|
|
// Based on https://github.com/delvedor/hpagent#usage
|
|
if (!isUrlHttps(proxyUrl) && !isUrlHttps(serverUrl)) {
|
|
return new HttpProxyAgent(proxyAgentConfig);
|
|
} else if (isUrlHttps(proxyUrl) && !isUrlHttps(serverUrl)) {
|
|
return new HttpProxyAgent(proxyAgentConfig);
|
|
} else if (!isUrlHttps(proxyUrl) && isUrlHttps(serverUrl)) {
|
|
return new HttpsProxyAgent(proxyAgentConfig);
|
|
} else {
|
|
return new HttpsProxyAgent(proxyAgentConfig);
|
|
}
|
|
};
|
|
|
|
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
|
|
// Don't use openUrl() there.
|
|
// The underneath require('electron').shell.openExternal() has a bug
|
|
// https://github.com/electron/electron/issues/31347
|
|
|
|
return shim.electronBridge().openItem(filepath);
|
|
};
|
|
|
|
shim.waitForFrame = () => {};
|
|
|
|
shim.appVersion = () => {
|
|
if (appVersion) return appVersion();
|
|
// Should not happen but don't throw an error because version number is
|
|
// used in error messages.
|
|
return 'unknown';
|
|
};
|
|
|
|
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) => {
|
|
if (path.indexOf('.') === 0) {
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
const sites: any = callsites();
|
|
if (sites.length <= 1) throw new Error(`Cannot require file (1) ${path}`);
|
|
const filename = sites[1].getFileName();
|
|
if (!filename) throw new Error(`Cannot require file (2) ${path}`);
|
|
|
|
const fileDirName = require('path').dirname(filename);
|
|
return require(`${fileDirName}/${path}`);
|
|
} else {
|
|
return require(path);
|
|
}
|
|
};
|
|
|
|
const loadPdf = async (path: string) => {
|
|
const loadingTask = pdfJs.getDocument({
|
|
url: path,
|
|
// https://github.com/mozilla/pdf.js/issues/4244#issuecomment-1479534301
|
|
useSystemFonts: true,
|
|
// IMPORTANT: Set to false to mitigate CVE-2024-4367.
|
|
isEvalSupported: false,
|
|
});
|
|
return await loadingTask.promise;
|
|
};
|
|
|
|
shim.pdfExtractEmbeddedText = async (pdfPath: string): Promise<string[]> => {
|
|
const doc = await loadPdf(pdfPath);
|
|
const textByPage = [];
|
|
|
|
try {
|
|
for (let pageNum = 1; pageNum <= doc.numPages; pageNum++) {
|
|
const page = await doc.getPage(pageNum);
|
|
const textContent = await page.getTextContent();
|
|
|
|
const strings = textContent.items.map(item => {
|
|
const text = (item as TextItem).str ?? '';
|
|
return text;
|
|
}).join('\n');
|
|
|
|
// Some PDFs contain unsupported characters that can lead to hard-to-debug issues.
|
|
// We remove them here.
|
|
textByPage.push(replaceUnsupportedCharacters(strings));
|
|
}
|
|
} finally {
|
|
await doc.destroy();
|
|
}
|
|
|
|
return textByPage;
|
|
};
|
|
|
|
shim.pdfToImages = async (pdfPath: string, outputDirectoryPath: string, options?: CreatePdfFromImagesOptions): Promise<string[]> => {
|
|
// We handle both the Electron app and testing framework. Potentially
|
|
// the same code could be use to support the CLI app.
|
|
const isTesting = !shim.isElectron();
|
|
|
|
const createCanvas = () => {
|
|
if (isTesting) {
|
|
return require('canvas').createCanvas();
|
|
}
|
|
return document.createElement('canvas');
|
|
};
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
const canvasToBuffer = async (canvas: any): Promise<Buffer> => {
|
|
const quality = 0.8;
|
|
if (isTesting) {
|
|
return canvas.toBuffer('image/jpeg', { quality });
|
|
} else {
|
|
const canvasToBlob = async (canvas: HTMLCanvasElement): Promise<Blob> => {
|
|
return new Promise(resolve => {
|
|
canvas.toBlob(blob => resolve(blob), 'image/jpg', quality);
|
|
});
|
|
};
|
|
|
|
const blob = await canvasToBlob(canvas);
|
|
return Buffer.from(await blob.arrayBuffer());
|
|
}
|
|
};
|
|
|
|
const filePrefix = `page_${Date.now()}`;
|
|
const output: string[] = [];
|
|
const doc = await loadPdf(pdfPath);
|
|
|
|
try {
|
|
const startPage = options?.minPage ?? 1;
|
|
const endPage = Math.min(doc.numPages, options?.maxPage ?? doc.numPages);
|
|
for (let pageNum = startPage; pageNum <= endPage; pageNum++) {
|
|
const page = await doc.getPage(pageNum);
|
|
const viewport = page.getViewport({ scale: options?.scaleFactor ?? 2 });
|
|
const canvas = createCanvas();
|
|
const ctx = canvas.getContext('2d');
|
|
|
|
canvas.height = viewport.height;
|
|
canvas.width = viewport.width;
|
|
|
|
const renderTask = page.render({ canvasContext: ctx, viewport: viewport });
|
|
await renderTask.promise;
|
|
|
|
const buffer = await canvasToBuffer(canvas);
|
|
const filePath = `${outputDirectoryPath}/${filePrefix}_${pageNum.toString().padStart(4, '0')}.jpg`;
|
|
output.push(filePath);
|
|
await writeFile(filePath, buffer, 'binary');
|
|
if (!(await shim.fsDriver().exists(filePath))) throw new Error(`Could not write to file: ${filePath}`);
|
|
}
|
|
} finally {
|
|
await doc.destroy();
|
|
}
|
|
|
|
return output;
|
|
};
|
|
|
|
shim.pdfInfo = async (pdfPath: string): Promise<PdfInfo> => {
|
|
const doc = await loadPdf(pdfPath);
|
|
return { pageCount: doc.numPages };
|
|
};
|
|
}
|
|
|
|
module.exports = { shimInit, setupProxySettings };
|