Add basic export/import of user sign rules (#220)

lieser · lieser · commit debd1eb213d9 · 2021-11-07T19:57:43.000+01:00
diff --git a/RuntimeMessage.d.ts b/RuntimeMessage.d.ts
@@ -17,6 +17,17 @@ namespace RuntimeMessage {
             readonly method: "getUserRules";
         }
 
+        interface exportUserRules extends SignRulesMessage {
+            readonly method: "exportUserRules";
+        }
+
+        interface importUserRules extends SignRulesMessage {
+            readonly method: "importUserRules";
+            readonly parameters: {
+                readonly data: any,
+            }
+        }
+
         interface addRule extends SignRulesMessage {
             readonly method: "addRule";
             readonly parameters: {
@@ -46,7 +57,7 @@ namespace RuntimeMessage {
             }
         }
 
-        type Messages = getDefaultRules | getUserRules | addRule | updateRule | deleteRule;
+        type Messages = getDefaultRules | getUserRules | exportUserRules | importUserRules | addRule | updateRule | deleteRule;
     }
 
     namespace KeyDb {
diff --git a/_locales/de/messages.json b/_locales/de/messages.json
@@ -638,6 +638,14 @@
 	"treeviewSigners.deleteSelectedRows": {
 		"message": "Entferne markierte Regeln"
 	},
+	"treeviewSigners.exportRules": {
+		"message": "Regeln exportieren",
+		"description": "Button for exporting sign rules"
+	},
+	"treeviewSigners.importRules": {
+		"message": "Regeln importieren",
+		"description": "Button for importing sign rules"
+	},
 	"addSignersRule.title": {
 		"message": "Füge Signierregeln hinzu"
 	},
diff --git a/_locales/en_US/messages.json b/_locales/en_US/messages.json
@@ -638,6 +638,14 @@
 	"treeviewSigners.deleteSelectedRows": {
 		"message": "Delete selected rules"
 	},
+	"treeviewSigners.exportRules": {
+		"message": "Export rules",
+		"description": "Button for exporting sign rules"
+	},
+	"treeviewSigners.importRules": {
+		"message": "Import rules",
+		"description": "Button for importing sign rules"
+	},
 	"addSignersRule.title": {
 		"message": "Add signers rule"
 	},
diff --git a/content/domUtils.mjs.js b/content/domUtils.mjs.js
@@ -7,6 +7,8 @@
  * included in all copies or substantial portions of the Software.
  */
 
+import { Deferred } from "../modules/utils.mjs.js";
+
 // @ts-check
 
 /**
@@ -20,3 +22,45 @@ export function getElementById(id) {
 	}
 	return element;
 }
+
+/**
+ * Upload JSON data.
+ *
+ * @returns {Promise<any>}
+ */
+export function uploadJsonData() {
+	const deferredData = new Deferred();
+	const inputElement = document.createElement("input");
+	inputElement.type = "file";
+	inputElement.accept = "application/json";
+	inputElement.addEventListener("change", (event) => {
+		try {
+			console.log("event:", event);
+			console.log("files:", inputElement.files);
+			if (!inputElement.files) {
+				throw new Error("Input element has no file");
+			}
+
+			const fileReader = new FileReader();
+			fileReader.addEventListener("error", () => {
+				deferredData.reject(new Error("Error reading file"));
+			});
+			fileReader.addEventListener("load", () => {
+				try {
+					if (typeof fileReader.result !== "string") {
+						throw new Error("File content has unexpected type");
+					}
+					deferredData.resolve(JSON.parse(fileReader.result));
+				} catch (error) {
+					deferredData.reject(error);
+				}
+			});
+			fileReader.readAsText(inputElement.files[0]);
+
+		} catch (error) {
+			deferredData.reject(error);
+		}
+	});
+	inputElement.click();
+	return deferredData.promise;
+}
diff --git a/content/signRulesUserView.html b/content/signRulesUserView.html
@@ -36,6 +36,8 @@
     <button id="addSignersRule" data-i18n="treeviewSigners.addSignersRule"></button>
     <button id="deleteSelectedRows" data-i18n="treeviewSigners.deleteSelectedRows"></button>
     <button id="buttonHelp" data-i18n="button.help"></button>
+    <button id="exportRules" data-i18n="treeviewSigners.exportRules"></button>
+    <button id="importRules" data-i18n="treeviewSigners.importRules"></button>
   </div>
 </body>
 
diff --git a/content/signRulesUserView.mjs.js b/content/signRulesUserView.mjs.js
@@ -14,7 +14,7 @@
 import DataTable from "./table.mjs.js";
 import ExtensionUtils from "../modules/extensionUtils.mjs.js";
 import SignRulesProxy from "../modules/dkim/signRulesProxy.mjs.js";
-import { getElementById } from "./domUtils.mjs.js";
+import { getElementById, uploadJsonData } from "./domUtils.mjs.js";
 
 document.addEventListener("DOMContentLoaded", async () => {
 	const tableElement = getElementById("rulesTable");
@@ -66,4 +66,22 @@ document.addEventListener("DOMContentLoaded", async () => {
 			browser.i18n.getMessage("signersRuleHelp.title"),
 		);
 	});
+
+	const exportRules = getElementById("exportRules");
+	exportRules.addEventListener("click", async () => {
+		const exportedUserRules = await SignRulesProxy.exportUserRules();
+		ExtensionUtils.downloadDataAsJSON(exportedUserRules, "dkim_sign_rules");
+	});
+
+	const importRules = getElementById("importRules");
+	importRules.addEventListener("click", async () => {
+		try {
+			// TODO: warn user about overriding existing rules
+			const data = await uploadJsonData();
+			await SignRulesProxy.importUserRules(data);
+		} catch (error) {
+			// TODO: show visible error message to user
+			console.error("Error importing sing rules.", error);
+		}
+	});
 }, { once: true });
diff --git a/manifest.json b/manifest.json
@@ -14,6 +14,7 @@
 	},
 	"permissions": [
 		"accountsRead",
+		"downloads",
 		"messagesRead",
 		"storage",
 		"tabs"
diff --git a/modules/dkim/signRules.mjs.js b/modules/dkim/signRules.mjs.js
@@ -72,6 +72,28 @@ const AUTO_ADD_RULE_FOR = {
 	BASE_DOMAIN: 2,
 };
 
+/**
+ * Exported DKIM user signing rule.
+ *
+ * @typedef {object} DkimExportedUserSignRule
+ * @property {string} domain
+ * @property {string} listId
+ * @property {string} addr
+ * @property {string} sdid - space separated list of SDIDs
+ * @property {number} type
+ * @property {number} priority
+ * @property {boolean} enabled
+ */
+
+/**
+ * Exported DKIM user signing rules.
+ *
+ * @typedef {object} DkimExportedUserSignRules
+ * @property {"DkimExportedUserSignRules"} dataId
+ * @property {1} dataFormatVersion
+ * @property {DkimExportedUserSignRule[]} rules
+ */
+
 /**
  * DKIM user signing rule.
  *
@@ -372,6 +394,56 @@ export default class SignRules {
 		return userRules;
 	}
 
+	/**
+	 * Get the user sign rules in the export format.
+	 *
+	 * @returns {Promise<DkimExportedUserSignRules>}
+	 */
+	static async exportUserRules() {
+		/** @type {{id?: number, domain: string, listId: string, addr: string, sdid: string, type: number, priority: number, enabled: boolean }[]} */
+		const rules = copy(await this.getUserRules());
+		rules.map(rule => { delete rule.id; return rule; });
+		return {
+			dataId: "DkimExportedUserSignRules",
+			dataFormatVersion: 1,
+			rules,
+		};
+	}
+
+	/**
+	 * Import the given user sign rules.
+	 * Existing rules will be overridden.
+	 *
+	 * @param {{dataId: string, dataFormatVersion: number}} data
+	 * @returns {Promise<void>}
+	 */
+	static async importUserRules(data) {
+		if (data.dataId !== "DkimExportedUserSignRules") {
+			// TODO: proper translated error message
+			log.error(data.dataId);
+			throw new Error("Unknown data");
+		}
+		if (data.dataFormatVersion !== 1) {
+			// TODO: proper translated error message
+			throw new Error("Unsupported format of exported rules");
+		}
+		/** @type {DkimExportedUserSignRules} */
+		// @ts-expect-error
+		const exportedRules = data;
+
+		// Costly but easy way to ensure a race condition with loading the rules does not happen.
+		await loadUserRules();
+
+		let maxId = 0;
+		userRules = exportedRules.rules.map(rule => ({ id: ++maxId, ...rule }));
+		userRulesMaxId = maxId;
+
+		await storeUserRules();
+
+		browser.runtime.sendMessage({ event: "ruleAdded" }).
+			catch(error => log.debug("Error sending ruleAdded event", error));
+	}
+
 	/**
 	 * Checks the DKIM result against the sign rules.
 	 *
@@ -658,6 +730,14 @@ export function initSignRulesProxy() {
 			// eslint-disable-next-line consistent-return
 			return SignRules.getUserRules();
 		}
+		if (request.method === "exportUserRules") {
+			// eslint-disable-next-line consistent-return
+			return SignRules.exportUserRules();
+		}
+		if (request.method === "importUserRules") {
+			// eslint-disable-next-line consistent-return
+			return SignRules.importUserRules(request.parameters.data);
+		}
 		if (request.method === "updateRule") {
 			// eslint-disable-next-line consistent-return
 			return SignRules.updateRule(request.parameters.id, request.parameters.propertyName, request.parameters.newValue);
diff --git a/modules/dkim/signRulesProxy.mjs.js b/modules/dkim/signRulesProxy.mjs.js
@@ -63,6 +63,39 @@ export default class SignRulesProxy {
 		return browser.runtime.sendMessage(message);
 	}
 
+	/**
+	 * Get the user sign rules in the export format.
+	 *
+	 * @returns {Promise<import("./signRules.mjs.js").DkimExportedUserSignRules>}
+	 */
+	static exportUserRules() {
+		/** @type {RuntimeMessage.SignRules.exportUserRules} */
+		const message = {
+			module: "SignRules",
+			method: "exportUserRules",
+		};
+		return browser.runtime.sendMessage(message);
+	}
+
+	/**
+	 * Import the given user sign rules.
+	 * Existing rules will be overridden.
+	 *
+	 * @param {any} data
+	 * @returns {Promise<void>}
+	 */
+	static importUserRules(data) {
+		/** @type {RuntimeMessage.SignRules.importUserRules} */
+		const message = {
+			module: "SignRules",
+			method: "importUserRules",
+			parameters: {
+				data,
+			},
+		};
+		return browser.runtime.sendMessage(message);
+	}
+
 	/**
 	 * Add user rule.
 	 *
diff --git a/modules/extensionUtils.mjs.js b/modules/extensionUtils.mjs.js
@@ -13,7 +13,7 @@
 ///<reference path="../WebExtensions.d.ts" />
 /* eslint-env browser, webextensions */
 
-import { promiseWithTimeout, sleep } from "./utils.mjs.js";
+import { dateToString, promiseWithTimeout, sleep } from "./utils.mjs.js";
 import Logging from "./logging.mjs.js";
 
 const log = Logging.getLogger("ExtensionUtils");
@@ -46,6 +46,22 @@ async function createOrRaisePopup(url, title, height = undefined, width = undefi
 	});
 }
 
+/**
+ * Download data as JSON.
+ *
+ * @param {object} data
+ * @param {string} dataName
+ * @returns {void}
+ */
+function downloadDataAsJSON(data, dataName) {
+	const jsonBlob = new Blob([JSON.stringify(data, null, 2)], { type: "application/json" });
+	browser.downloads.download({
+		'url': URL.createObjectURL(jsonBlob),
+		'filename': `${dataName}_${dateToString(new Date())}.json`,
+		'saveAs': true,
+	});
+}
+
 /**
  * Checks if a message is outgoing.
  *
@@ -128,9 +144,10 @@ async function safeGetLocalStorage() {
 }
 
 const ExtensionUtils = {
-	createOrRaisePopup: createOrRaisePopup,
-	isOutgoing: isOutgoing,
-	safeGetLocalStorage: safeGetLocalStorage,
-	readFile: readFile,
+	createOrRaisePopup,
+	downloadDataAsJSON,
+	isOutgoing,
+	safeGetLocalStorage,
+	readFile,
 };
 export default ExtensionUtils;
diff --git a/test/unittest/signRulesSpec.mjs.js b/test/unittest/signRulesSpec.mjs.js

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,17 @@ namespace RuntimeMessage {`
`17`	`17`	`readonly method: "getUserRules";`
`18`	`18`	`}`
`19`	`19`
	`20`	`+ interface exportUserRules extends SignRulesMessage {`
	`21`	`+ readonly method: "exportUserRules";`
	`22`	`+ }`
	`23`	`+`
	`24`	`+ interface importUserRules extends SignRulesMessage {`
	`25`	`+ readonly method: "importUserRules";`
	`26`	`+ readonly parameters: {`
	`27`	`+ readonly data: any,`
	`28`	`+ }`
	`29`	`+ }`
	`30`	`+`
`20`	`31`	`interface addRule extends SignRulesMessage {`
`21`	`32`	`readonly method: "addRule";`
`22`	`33`	`readonly parameters: {`
`@@ -46,7 +57,7 @@ namespace RuntimeMessage {`
`46`	`57`	`}`
`47`	`58`	`}`
`48`	`59`
`49`		`- type Messages = getDefaultRules \| getUserRules \| addRule \| updateRule \| deleteRule;`
	`60`	`+ type Messages = getDefaultRules \| getUserRules \| exportUserRules \| importUserRules \| addRule \| updateRule \| deleteRule;`
`50`	`61`	`}`
`51`	`62`
`52`	`63`	`namespace KeyDb {`