feat: Initial clean release of CHM

packages/lib/SyncTargetOneDrive.ts

@@ -0,0 +1,140 @@
+import OneDriveApi from './onedrive-api';
+import { _ } from './locale';
+import Setting from './models/Setting';
+import Synchronizer from './Synchronizer';
+import BaseSyncTarget from './BaseSyncTarget';
+
+import { parameters } from './parameters';
+import { FileApi } from './file-api';
+import FileApiDriverOneDrive from './file-api-driver-onedrive';
+
+export default class SyncTargetOneDrive extends BaseSyncTarget {
+
+	private api_: OneDriveApi;
+
+	public static id() {
+		return 3;
+	}
+
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any -- See BaseSyncTarget.db_: subclasses pass JoplinDatabase or test mocks
+	public constructor(db: any, options: Record<string, unknown> = null) {
+		super(db, options);
+		this.api_ = null;
+	}
+
+	public static unsupportedPlatforms() {
+		// Web: The login UI doesn't work.
+		return ['web'];
+	}
+
+	public static targetName() {
+		return 'onedrive';
+	}
+
+	public static label() {
+		return _('OneDrive');
+	}
+
+	public static description() {
+		return 'A file hosting service operated by Microsoft as part of its web version of Office.';
+	}
+
+	public static supportsSelfHosted(): boolean {
+		return false;
+	}
+
+	public async isAuthenticated() {
+		return !!this.api().auth();
+	}
+
+	public syncTargetId() {
+		return SyncTargetOneDrive.id();
+	}
+
+	public isTesting() {
+		const p = parameters();
+		return !!p.oneDriveTest;
+	}
+
+	public oneDriveParameters() {
+		const p = parameters();
+		if (p.oneDriveTest) return p.oneDriveTest;
+		return p.oneDrive;
+	}
+
+	public authRouteName() {
+		return 'OneDriveLogin';
+	}
+
+	public api() {
+		if (this.isTesting()) {
+			return this.fileApi_.driver().api();
+		}
+
+		if (this.api_) return this.api_;
+
+		const isPublic = Setting.value('appType') !== 'cli' && Setting.value('appType') !== 'desktop';
+
+		this.api_ = new OneDriveApi(this.oneDriveParameters().id, this.oneDriveParameters().secret, isPublic);
+
+		this.api_.on('authRefreshed', (a: unknown) => {
+			this.logger().info('Saving updated OneDrive auth.');
+			Setting.setValue(`sync.${this.syncTargetId()}.auth`, a ? JSON.stringify(a) : null);
+		});
+
+		let auth = Setting.value(`sync.${this.syncTargetId()}.auth`);
+		if (auth) {
+			try {
+				auth = JSON.parse(auth);
+			} catch (error) {
+				this.logger().warn('Could not parse OneDrive auth token');
+				this.logger().warn(error);
+				auth = null;
+			}
+
+			this.api_.setAuth(auth);
+		}
+
+		return this.api_;
+	}
+
+	public async initFileApi() {
+		let context = Setting.value(`sync.${this.syncTargetId()}.context`);
+		context = context === '' ? null : JSON.parse(context);
+		let accountProperties = context ? context.accountProperties : null;
+		const api = this.api();
+
+		if (!accountProperties) {
+			accountProperties = await api.execAccountPropertiesRequest();
+			if (context) {
+				context.accountProperties = accountProperties;
+			} else {
+				context = { accountProperties: accountProperties };
+			}
+			Setting.setValue(`sync.${this.syncTargetId()}.context`, JSON.stringify(context));
+		}
+		api.setAccountProperties(accountProperties);
+		const appDir = await this.api().appDirectory();
+		// the appDir might contain non-ASCII characters
+		// /[^\u0021-\u00ff]/ is used in Node.js to detect the unescaped characters.
+		// See https://github.com/nodejs/node/blob/bbbf97b6dae63697371082475dc8651a6a220336/lib/_http_client.js#L176
+		// eslint-disable-next-line prefer-regex-literals -- Old code before rule was applied
+		const baseDir = RegExp(/[^\u0021-\u00ff]/).exec(appDir) !== null ? encodeURI(appDir) : appDir;
+		const fileApi = new FileApi(baseDir, new FileApiDriverOneDrive(this.api()));
+		fileApi.setSyncTargetId(this.syncTargetId());
+		fileApi.setLogger(this.logger());
+		return fileApi;
+	}
+
+	public async initSynchronizer() {
+		try {
+			if (!(await this.isAuthenticated())) throw new Error('User is not authenticated');
+			return new Synchronizer(this.db(), await this.fileApi(), Setting.value('appType'));
+		} catch (error) {
+			BaseSyncTarget.dispatch({ type: 'SYNC_REPORT_UPDATE', report: { errors: [error] } });
+			throw error;
+		}
+
+
+	}
+}