Add WebDAV support to backups

lib/modules/backupAndRestore.js

@@ -103,6 +103,39 @@ module.options = {
 		title: 'backupAndRestoreGoogleAccountTitle',
 		advanced: true,
 	},
+	webDAV: {
+		type: 'table',
+		addRowText: 'backupAndRestoreAddWebDAVAccount',
+		fields: [{
+			key: 'username',
+			name: 'backupAndRestoreUsername',
+			type: 'text',
+		}, {
+			key: 'password',
+			name: 'backupAndRestorePassword',
+			type: 'password',
+		}, {
+			key: 'url',
+			name: 'backupAndRestoreUrl',
+			type: 'text',
+		}, {
+			key: 'digest',
+			name: 'backupAndRestoreDigest',
+			type: 'boolean',
+			value: false,
+		}],
+		value: ([]: Array<[string, string, string, boolean]>),
+		description: 'backupAndRestoreWebDAVDesc',
+		title: 'backupAndRestoreWebDAVTitle',
+		onChange() {
+			Notifications.showNotification({
+				message: i18n('backupAndRestoreWarnNotification'),
+				notificationID: i18n('backupAndRestoreWarn'),
+				moduleID: module.moduleID,
+				closeDelay: 1000,
+			});
+		},
+	},
 };
 
 module.afterLoad = async () => {
@@ -112,6 +145,10 @@ module.afterLoad = async () => {
 function getProvider(providerClass) {
 	return new providerClass().init({ // eslint-disable-line new-cap
 		googleLoginHint: module.options.googleAccount.value,
+		webDAVUsername: module.options.webDAV.value[0][0],
+		webDAVPassword: module.options.webDAV.value[0][1],
+		webDAVUrl: module.options.webDAV.value[0][2],
+		webDAVDigest: module.options.webDAV.value[0][3],
 	});
 }
 

lib/modules/backupAndRestore/providers/WebDAV.js

@@ -0,0 +1,37 @@
+/* @flow */
+
+import { AuthType, createClient } from 'webdav/web';
+import { Provider } from './Provider';
+
+const FILE = '/res-storage.json';
+
+export class WebDAV extends Provider {
+	static key = 'webdav';
+	static text = 'WebDAV';
+	static supportsAutomaticBackups = true;
+
+	client: any;
+
+	// eslint-disable-next-line require-await
+	async init({ webDAVUrl, webDAVDigest, webDAVUsername, webDAVPassword }: *): Promise<Provider> { // eslint-disable-line no-empty-pattern
+		this.client = createClient(webDAVUrl, {
+			authType: webDAVDigest ? AuthType.digest : AuthType.password,
+			username: webDAVUsername,
+			password: webDAVPassword,
+		});
+
+		return this;
+	}
+
+	async read() {
+		try {
+			return await this.client.getFileContents(FILE);
+		} catch (e) {
+			throw new Error('Could not find backup.');
+		}
+	}
+
+	async write(data: string) {
+		await this.client.putFileContents(FILE, data);
+	}
+}

lib/modules/backupAndRestore/providers/index.js

@@ -4,3 +4,4 @@ export { File } from './File';
 export { GoogleDrive } from './GoogleDrive';
 export { OneDrive } from './OneDrive';
 export { Dropbox } from './Dropbox';
+export { WebDAV } from './WebDAV';

locales/locales/en.json

@@ -1860,6 +1860,27 @@
 	"backupAndRestoreGoogleAccountDesc": {
 		"message": "If, and only if, you have multiple Google accounts logged in at once, enter the email of the account you want to use.\n\nIn most cases you will not need to use this option."
 	},
+	"backupAndRestoreAddWebDAVAccount": {
+		"message": "+add account"
+	},
+	"backupAndRestoreWebDAVTitle": {
+		"message": "WebDAV"
+	},
+	"backupAndRestoreWebDAVDesc": {
+		"message": "Configure a WebDAV account for use in RES backups"
+	},
+	"backupAndRestoreUsername": {
+		"message": "username"
+	},
+	"backupAndRestorePassword": {
+		"message": "password"
+	},
+	"backupAndRestoreUrl": {
+		"message": "url"
+	},
+	"backupAndRestoreDigest": {
+		"message": "uses digest"
+	},
 	"backupAndRestoreBackupTitle": {
 		"message": "Backup"
 	},
@@ -1884,6 +1905,12 @@
 	"backupAndRestoreSavedNotification": {
 		"message": "Backup saved to $1."
 	},
+	"backupAndRestoreWarnNotification": {
+		"message": "RES stores WebDAV credentials in plain text."
+	},
+	"backupAndRestoreWarn": {
+		"message": "Warning"
+	},
 	"backupAndRestoreFoundBackup": {
 		"message": "Found new automatic backup from $1."
 	},

package.json

@@ -62,8 +62,10 @@
     "lodash-es": "4.17.21",
     "snudown-js": "3.2.2",
     "sortablejs": "1.15.0",
+    "stream": "^0.0.2",
     "suncalc": "1.9.0",
-    "tinycolor2": "1.4.2"
+    "tinycolor2": "1.4.2",
+    "webdav": "^4.9.0"
   },
   "devDependencies": {
     "@babel/core": "7.17.10",