joplin/packages/lib/onedrive-api-node-utils.js

const { _ } = require('./locale');
const { findAvailablePort } = require('./net-utils');
const shim = require('./shim').default;

const http = require('http');
const urlParser = require('url');
const enableServerDestroy = require('server-destroy');

class OneDriveApiNodeUtils {
	constructor(api) {
		this.api_ = api;
		this.oauthServer_ = null;
	}

	api() {
		return this.api_;
	}

	possibleOAuthDancePorts() {
		return [9967, 8967, 8867];
	}

	makePage(message) {
		const header = `
		<!doctype html>
		<html><head><meta charset="utf-8"></head><body>`;

		const footer = `
		</body></html>
		`;

		return header + message + footer;
	}

	cancelOAuthDance() {
		if (!this.oauthServer_) return;
		this.oauthServer_.destroy();
	}

	async oauthDance(targetConsole = null) {
		if (targetConsole === null) targetConsole = console;

		this.api().setAuth(null);

		const port = await findAvailablePort(require('tcp-port-used'), this.possibleOAuthDancePorts(), 0);
		if (!port) throw new Error(_('All potential ports are in use - please report the issue at %s', 'https://github.com/laurent22/joplin'));

		const authCodeUrl = this.api().authCodeUrl(`http://localhost:${port}`);

		return new Promise((resolve, reject) => {
			this.oauthServer_ = http.createServer();
			const errorMessage = null;

			this.oauthServer_.on('request', (request, response) => {
				const url = urlParser.parse(request.url, true);

				if (url.pathname === '/auth') {
					response.writeHead(302, { Location: authCodeUrl });
					response.end();
					return;
				}

				const query = url.query;

				const writeResponse = (code, message) => {
					response.writeHead(code, { 'Content-Type': 'text/html' });
					response.write(this.makePage(message));
					response.end();
				};

				// After the response has been received, don't destroy the server right
				// away or the browser might display a connection reset error (even
				// though it worked).
				const waitAndDestroy = () => {
					shim.setTimeout(() => {
						this.oauthServer_.destroy();
						this.oauthServer_ = null;
					}, 1000);
				};

				if (!query.code) return writeResponse(400, '"code" query parameter is missing');

				this.api()
					.execTokenRequest(query.code, `http://localhost:${port.toString()}`)
				// eslint-disable-next-line promise/prefer-await-to-then -- Old code before rule was applied
					.then(() => {
						writeResponse(200, _('The application has been authorised - you may now close this browser tab.'));
						targetConsole.log('');
						targetConsole.log(_('The application has been successfully authorised.'));
						waitAndDestroy();
					})
				// eslint-disable-next-line promise/prefer-await-to-then -- Old code before rule was applied
					.catch(error => {
						writeResponse(400, error.message);
						targetConsole.log('');
						targetConsole.log(error.message);
						waitAndDestroy();
					});
			});

			this.oauthServer_.on('close', () => {
				if (errorMessage) {
					reject(new Error(errorMessage));
				} else {
					resolve(this.api().auth());
				}
			});

			this.oauthServer_.listen(port);

			enableServerDestroy(this.oauthServer_);

			// Rather than displaying authCodeUrl directly, we go through the local
			// server. This is just so that the URL being displayed is shorter and
			// doesn't get cut in terminals (especially those that don't handle multi
			// lines URLs).

			targetConsole.log(_('Please open the following URL in your browser to authenticate the application. The application will create a directory in "Apps/Joplin" and will only read and write files in this directory. It will have no access to any files outside this directory nor to any other personal data. No data will be shared with any third party.'));
			targetConsole.log('');
			targetConsole.log(`http://127.0.0.1:${port}/auth`);
		});
	}
}

module.exports = { OneDriveApiNodeUtils };
All: Use Lerna to manage monorepo 2020-11-05 18:58:23 +02:00			`const { _ } = require('./locale');`
All: Resolves #5754: Improved error message when synchronising with Joplin Server 2021-11-19 13:26:01 +02:00			`const { findAvailablePort } = require('./net-utils');`
All: Use Lerna to manage monorepo 2020-11-05 18:58:23 +02:00			`const shim = require('./shim').default;`
Making more strings translatable 2017-07-18 20:21:03 +02:00
Linter update (#1777) * Update eslint config * Applied linter to lib * Applied eslint config to CliClient/app * Removed prettier due to https://github.com/prettier/prettier/pull/4765 * First pass on test units * Applied linter config to test units * Applied eslint config to clipper * Applied to plugin dir * Applied to root of ElectronClient * Applied on RN root * Applied on CLI root * Applied on Clipper root * Applied config to tools * test hook * test hook * test hook * Added pre-commit hook * Applied rule no-trailing-spaces * Make sure root packages are installed when installing sub-dir * Added doc 2019-07-30 09:35:42 +02:00			`const http = require('http');`
			`const urlParser = require('url');`
Make fetch and FormData work in both RN and node 2017-07-06 20:58:01 +02:00			`const enableServerDestroy = require('server-destroy');`

			`class OneDriveApiNodeUtils {`
			`constructor(api) {`
			`this.api_ = api;`
Allow cancelling OAuth dance, and fixed status bar display issue 2017-10-24 20:03:12 +02:00			`this.oauthServer_ = null;`
Make fetch and FormData work in both RN and node 2017-07-06 20:58:01 +02:00			`}`

			`api() {`
			`return this.api_;`
			`}`

			`possibleOAuthDancePorts() {`
More tweaks 2017-07-28 20:13:07 +02:00			`return [9967, 8967, 8867];`
Make fetch and FormData work in both RN and node 2017-07-06 20:58:01 +02:00			`}`

Minor CLI bug fixes and improvements 2017-07-26 23:07:27 +02:00			`makePage(message) {`
			const header = `
			`<!doctype html>`
			<html><head><meta charset="utf-8"></head><body>`;

			const footer = `
			`</body></html>`
			`;

			`return header + message + footer;`
			`}`

Allow cancelling OAuth dance, and fixed status bar display issue 2017-10-24 20:03:12 +02:00			`cancelOAuthDance() {`
			`if (!this.oauthServer_) return;`
			`this.oauthServer_.destroy();`
			`}`

Make fetch and FormData work in both RN and node 2017-07-06 20:58:01 +02:00			`async oauthDance(targetConsole = null) {`
			`if (targetConsole === null) targetConsole = console;`

			`this.api().setAuth(null);`

Tools: Fixed Android build 2021-11-21 18:38:56 +02:00			`const port = await findAvailablePort(require('tcp-port-used'), this.possibleOAuthDancePorts(), 0);`
Translated to French 2017-07-18 20:49:47 +02:00			`if (!port) throw new Error(_('All potential ports are in use - please report the issue at %s', 'https://github.com/laurent22/joplin'));`
Make fetch and FormData work in both RN and node 2017-07-06 20:58:01 +02:00
Tools: Enforce and apply eslint rules prefer-const and no-var 2020-03-14 01:46:14 +02:00			const authCodeUrl = this.api().authCodeUrl(`http://localhost:${port}`);
Make fetch and FormData work in both RN and node 2017-07-06 20:58:01 +02:00
Linter update (#1777) * Update eslint config * Applied linter to lib * Applied eslint config to CliClient/app * Removed prettier due to https://github.com/prettier/prettier/pull/4765 * First pass on test units * Applied linter config to test units * Applied eslint config to clipper * Applied to plugin dir * Applied to root of ElectronClient * Applied on RN root * Applied on CLI root * Applied on Clipper root * Applied config to tools * test hook * test hook * test hook * Added pre-commit hook * Applied rule no-trailing-spaces * Make sure root packages are installed when installing sub-dir * Added doc 2019-07-30 09:35:42 +02:00			`return new Promise((resolve, reject) => {`
Allow cancelling OAuth dance, and fixed status bar display issue 2017-10-24 20:03:12 +02:00			`this.oauthServer_ = http.createServer();`
Tools: Enforce and apply eslint rules prefer-const and no-var 2020-03-14 01:46:14 +02:00			`const errorMessage = null;`
Make fetch and FormData work in both RN and node 2017-07-06 20:58:01 +02:00
Allow cancelling OAuth dance, and fixed status bar display issue 2017-10-24 20:03:12 +02:00			`this.oauthServer_.on('request', (request, response) => {`
Minor UI changes and reverter back to npm 2017-10-25 19:23:45 +02:00			`const url = urlParser.parse(request.url, true);`

			`if (url.pathname === '/auth') {`
Linter update (#1777) * Update eslint config * Applied linter to lib * Applied eslint config to CliClient/app * Removed prettier due to https://github.com/prettier/prettier/pull/4765 * First pass on test units * Applied linter config to test units * Applied eslint config to clipper * Applied to plugin dir * Applied to root of ElectronClient * Applied on RN root * Applied on CLI root * Applied on Clipper root * Applied config to tools * test hook * test hook * test hook * Added pre-commit hook * Applied rule no-trailing-spaces * Make sure root packages are installed when installing sub-dir * Added doc 2019-07-30 09:35:42 +02:00			`response.writeHead(302, { Location: authCodeUrl });`
Minor UI changes and reverter back to npm 2017-10-25 19:23:45 +02:00			`response.end();`
			`return;`
			`}`

			`const query = url.query;`
Make fetch and FormData work in both RN and node 2017-07-06 20:58:01 +02:00
Minor CLI bug fixes and improvements 2017-07-26 23:07:27 +02:00			`const writeResponse = (code, message) => {`
Linter update (#1777) * Update eslint config * Applied linter to lib * Applied eslint config to CliClient/app * Removed prettier due to https://github.com/prettier/prettier/pull/4765 * First pass on test units * Applied linter config to test units * Applied eslint config to clipper * Applied to plugin dir * Applied to root of ElectronClient * Applied on RN root * Applied on CLI root * Applied on Clipper root * Applied config to tools * test hook * test hook * test hook * Added pre-commit hook * Applied rule no-trailing-spaces * Make sure root packages are installed when installing sub-dir * Added doc 2019-07-30 09:35:42 +02:00			`response.writeHead(code, { 'Content-Type': 'text/html' });`
Minor CLI bug fixes and improvements 2017-07-26 23:07:27 +02:00			`response.write(this.makePage(message));`
Make fetch and FormData work in both RN and node 2017-07-06 20:58:01 +02:00			`response.end();`
Linter update (#1777) * Update eslint config * Applied linter to lib * Applied eslint config to CliClient/app * Removed prettier due to https://github.com/prettier/prettier/pull/4765 * First pass on test units * Applied linter config to test units * Applied eslint config to clipper * Applied to plugin dir * Applied to root of ElectronClient * Applied on RN root * Applied on CLI root * Applied on Clipper root * Applied config to tools * test hook * test hook * test hook * Added pre-commit hook * Applied rule no-trailing-spaces * Make sure root packages are installed when installing sub-dir * Added doc 2019-07-30 09:35:42 +02:00			`};`
Make fetch and FormData work in both RN and node 2017-07-06 20:58:01 +02:00
Many improvements and bug fixes 2017-10-19 00:13:53 +02:00			`// After the response has been received, don't destroy the server right`
			`// away or the browser might display a connection reset error (even`
			`// though it worked).`
			`const waitAndDestroy = () => {`
All: Add support for application plugins (#3257) 2020-10-09 19:35:46 +02:00			`shim.setTimeout(() => {`
Allow cancelling OAuth dance, and fixed status bar display issue 2017-10-24 20:03:12 +02:00			`this.oauthServer_.destroy();`
			`this.oauthServer_ = null;`
Many improvements and bug fixes 2017-10-19 00:13:53 +02:00			`}, 1000);`
Linter update (#1777) * Update eslint config * Applied linter to lib * Applied eslint config to CliClient/app * Removed prettier due to https://github.com/prettier/prettier/pull/4765 * First pass on test units * Applied linter config to test units * Applied eslint config to clipper * Applied to plugin dir * Applied to root of ElectronClient * Applied on RN root * Applied on CLI root * Applied on Clipper root * Applied config to tools * test hook * test hook * test hook * Added pre-commit hook * Applied rule no-trailing-spaces * Make sure root packages are installed when installing sub-dir * Added doc 2019-07-30 09:35:42 +02:00			`};`
Many improvements and bug fixes 2017-10-19 00:13:53 +02:00
Make fetch and FormData work in both RN and node 2017-07-06 20:58:01 +02:00			`if (!query.code) return writeResponse(400, '"code" query parameter is missing');`

Linter update (#1777) * Update eslint config * Applied linter to lib * Applied eslint config to CliClient/app * Removed prettier due to https://github.com/prettier/prettier/pull/4765 * First pass on test units * Applied linter config to test units * Applied eslint config to clipper * Applied to plugin dir * Applied to root of ElectronClient * Applied on RN root * Applied on CLI root * Applied on Clipper root * Applied config to tools * test hook * test hook * test hook * Added pre-commit hook * Applied rule no-trailing-spaces * Make sure root packages are installed when installing sub-dir * Added doc 2019-07-30 09:35:42 +02:00			`this.api()`
Chore: Apply eslint rules 2019-09-19 23:51:18 +02:00			.execTokenRequest(query.code, `http://localhost:${port.toString()}`)
Tools: Add eslint rule prefer-await-to-then 2022-09-30 18:23:14 +02:00			`// eslint-disable-next-line promise/prefer-await-to-then -- Old code before rule was applied`
Linter update (#1777) * Update eslint config * Applied linter to lib * Applied eslint config to CliClient/app * Removed prettier due to https://github.com/prettier/prettier/pull/4765 * First pass on test units * Applied linter config to test units * Applied eslint config to clipper * Applied to plugin dir * Applied to root of ElectronClient * Applied on RN root * Applied on CLI root * Applied on Clipper root * Applied config to tools * test hook * test hook * test hook * Added pre-commit hook * Applied rule no-trailing-spaces * Make sure root packages are installed when installing sub-dir * Added doc 2019-07-30 09:35:42 +02:00			`.then(() => {`
			`writeResponse(200, _('The application has been authorised - you may now close this browser tab.'));`
			`targetConsole.log('');`
			`targetConsole.log(_('The application has been successfully authorised.'));`
			`waitAndDestroy();`
			`})`
Tools: Add eslint rule prefer-await-to-then 2022-09-30 18:23:14 +02:00			`// eslint-disable-next-line promise/prefer-await-to-then -- Old code before rule was applied`
Revert "Tools: Added eslint rule arrow-parens" This reverts commit 0b6f5581f0c908f88636171004561da5dbe138cd. It causes too many conflicts with pull requests. 2020-05-21 10:14:33 +02:00			`.catch(error => {`
Linter update (#1777) * Update eslint config * Applied linter to lib * Applied eslint config to CliClient/app * Removed prettier due to https://github.com/prettier/prettier/pull/4765 * First pass on test units * Applied linter config to test units * Applied eslint config to clipper * Applied to plugin dir * Applied to root of ElectronClient * Applied on RN root * Applied on CLI root * Applied on Clipper root * Applied config to tools * test hook * test hook * test hook * Added pre-commit hook * Applied rule no-trailing-spaces * Make sure root packages are installed when installing sub-dir * Added doc 2019-07-30 09:35:42 +02:00			`writeResponse(400, error.message);`
			`targetConsole.log('');`
			`targetConsole.log(error.message);`
			`waitAndDestroy();`
			`});`
Make fetch and FormData work in both RN and node 2017-07-06 20:58:01 +02:00			`});`

Allow cancelling OAuth dance, and fixed status bar display issue 2017-10-24 20:03:12 +02:00			`this.oauthServer_.on('close', () => {`
Make fetch and FormData work in both RN and node 2017-07-06 20:58:01 +02:00			`if (errorMessage) {`
			`reject(new Error(errorMessage));`
			`} else {`
			`resolve(this.api().auth());`
			`}`
			`});`

Allow cancelling OAuth dance, and fixed status bar display issue 2017-10-24 20:03:12 +02:00			`this.oauthServer_.listen(port);`
Make fetch and FormData work in both RN and node 2017-07-06 20:58:01 +02:00
Allow cancelling OAuth dance, and fixed status bar display issue 2017-10-24 20:03:12 +02:00			`enableServerDestroy(this.oauthServer_);`
Make fetch and FormData work in both RN and node 2017-07-06 20:58:01 +02:00
Doc: Fix documentation and source comment typos (#2037) * Misc. typo and whitespace fixes Found via `codespell -q 3 -S .po,.pot,./ElectronClient/app/locales,./ReactNativeClient/locales,./CliClient/locales -L adresse,ba,fonction,te,whet` * Revert a previous change 2019-10-29 11:02:42 +02:00			`// Rather than displaying authCodeUrl directly, we go through the local`
Minor UI changes and reverter back to npm 2017-10-25 19:23:45 +02:00			`// server. This is just so that the URL being displayed is shorter and`
			`// doesn't get cut in terminals (especially those that don't handle multi`
			`// lines URLs).`

Minor changes 2017-08-05 00:15:08 +02:00			`targetConsole.log(_('Please open the following URL in your browser to authenticate the application. The application will create a directory in "Apps/Joplin" and will only read and write files in this directory. It will have no access to any files outside this directory nor to any other personal data. No data will be shared with any third party.'));`
Make fetch and FormData work in both RN and node 2017-07-06 20:58:01 +02:00			`targetConsole.log('');`
Chore: Apply eslint rules 2019-09-19 23:51:18 +02:00			targetConsole.log(`http://127.0.0.1:${port}/auth`);
Make fetch and FormData work in both RN and node 2017-07-06 20:58:01 +02:00			`});`
			`}`
			`}`

Linter update (#1777) * Update eslint config * Applied linter to lib * Applied eslint config to CliClient/app * Removed prettier due to https://github.com/prettier/prettier/pull/4765 * First pass on test units * Applied linter config to test units * Applied eslint config to clipper * Applied to plugin dir * Applied to root of ElectronClient * Applied on RN root * Applied on CLI root * Applied on Clipper root * Applied config to tools * test hook * test hook * test hook * Added pre-commit hook * Applied rule no-trailing-spaces * Make sure root packages are installed when installing sub-dir * Added doc 2019-07-30 09:35:42 +02:00			`module.exports = { OneDriveApiNodeUtils };`