alex/yomichan
1
Fork 0
Code Releases Activity

Settings backup refactor (#551)

Browse Source 
* Update backup.js to be a class

* Move utilReadFileArrayBuffer
This commit is contained in:
toasted-nutbread 2020-05-24 13:56:46 -04:00 committed by GitHub
parent 66e1185686
commit 13f57cccba
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 317 additions and 315 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

159
ext/bg/js/settings/backup.js
View File

@ -22,16 +22,26 @@
* utilBackend
* utilBackgroundIsolate
* utilIsolate
* utilReadFileArrayBuffer
*/
// Exporting
class SettingsBackup {
constructor() {
this._settingsExportToken = null;
this._settingsExportRevoke = null;
this._currentVersion = 0;
}
let _settingsExportToken = null;
let _settingsExportRevoke = null;
const SETTINGS_EXPORT_CURRENT_VERSION = 0;
prepare() {
document.querySelector('#settings-export').addEventListener('click', this._onSettingsExportClick.bind(this), false);
document.querySelector('#settings-import').addEventListener('click', this._onSettingsImportClick.bind(this), false);
document.querySelector('#settings-import-file').addEventListener('change', this._onSettingsImportFileChange.bind(this), false);
document.querySelector('#settings-reset').addEventListener('click', this._onSettingsResetClick.bind(this), false);
document.querySelector('#settings-reset-modal-confirm').addEventListener('click', this._onSettingsResetConfirmClick.bind(this), false);
}
function _getSettingsExportDateString(date, dateSeparator, dateTimeSeparator, timeSeparator, resolution) {
// Private
_getSettingsExportDateString(date, dateSeparator, dateTimeSeparator, timeSeparator, resolution) {
const values = [
date.getUTCFullYear().toString(),
dateSeparator,
@ -46,9 +56,9 @@ function _getSettingsExportDateString(date, dateSeparator, dateTimeSeparator, ti
date.getUTCSeconds().toString().padStart(2, '0')
];
return values.slice(0, resolution * 2 - 1).join('');
}
}
async function _getSettingsExportData(date) {
async _getSettingsExportData(date) {
const optionsFull = await api.optionsGetFull();
const environment = await api.getEnvironmentInfo();
const fieldTemplatesDefault = await api.getDefaultAnkiFieldTemplates();
@ -61,8 +71,8 @@ async function _getSettingsExportData(date) {
}
const data = {
version: SETTINGS_EXPORT_CURRENT_VERSION,
date: _getSettingsExportDateString(date, '-', ' ', ':', 6),
version: this._currentVersion,
date: this._getSettingsExportDateString(date, '-', ' ', ':', 6),
url: chrome.runtime.getURL('/'),
manifest: chrome.runtime.getManifest(),
environment,
@ -71,9 +81,9 @@ async function _getSettingsExportData(date) {
};
return data;
}
}
function _saveBlob(blob, fileName) {
_saveBlob(blob, fileName) {
if (typeof navigator === 'object' && typeof navigator.msSaveBlob === 'function') {
if (navigator.msSaveBlob(blob)) {
return;
@ -91,52 +101,60 @@ function _saveBlob(blob, fileName) {
const revoke = () => {
URL.revokeObjectURL(blobUrl);
a.href = '';
_settingsExportRevoke = null;
this._settingsExportRevoke = null;
};
_settingsExportRevoke = revoke;
this._settingsExportRevoke = revoke;
a.dispatchEvent(new MouseEvent('click'));
setTimeout(revoke, 60000);
}
}
async function _onSettingsExportClick() {
if (_settingsExportRevoke !== null) {
_settingsExportRevoke();
_settingsExportRevoke = null;
async _onSettingsExportClick() {
if (this._settingsExportRevoke !== null) {
this._settingsExportRevoke();
this._settingsExportRevoke = null;
}
const date = new Date(Date.now());
const token = {};
_settingsExportToken = token;
const data = await _getSettingsExportData(date);
if (_settingsExportToken !== token) {
this._settingsExportToken = token;
const data = await this._getSettingsExportData(date);
if (this._settingsExportToken !== token) {
// A new export has been started
return;
}
_settingsExportToken = null;
this._settingsExportToken = null;
const fileName = `yomichan-settings-${_getSettingsExportDateString(date, '-', '-', '-', 6)}.json`;
const fileName = `yomichan-settings-${this._getSettingsExportDateString(date, '-', '-', '-', 6)}.json`;
const blob = new Blob([JSON.stringify(data, null, 4)], {type: 'application/json'});
_saveBlob(blob, fileName);
}
this._saveBlob(blob, fileName);
}
_readFileArrayBuffer(file) {
return new Promise((resolve, reject) => {
const reader = new FileReader();
reader.onload = () => resolve(reader.result);
reader.onerror = () => reject(reader.error);
reader.readAsArrayBuffer(file);
});
}
// Importing
// Importing
async function _settingsImportSetOptionsFull(optionsFull) {
async _settingsImportSetOptionsFull(optionsFull) {
return utilIsolate(utilBackend().setFullOptions(
utilBackgroundIsolate(optionsFull)
));
}
}
function _showSettingsImportError(error) {
_showSettingsImportError(error) {
yomichan.logError(error);
document.querySelector('#settings-import-error-modal-message').textContent = `${error}`;
$('#settings-import-error-modal').modal('show');
}
}
async function _showSettingsImportWarnings(warnings) {
async _showSettingsImportWarnings(warnings) {
const modalNode = $('#settings-import-warning-modal');
const buttons = document.querySelectorAll('.settings-import-warning-modal-import-button');
const messageContainer = document.querySelector('#settings-import-warning-modal-message');
@ -190,9 +208,9 @@ async function _showSettingsImportWarnings(warnings) {
button.addEventListener('click', onButtonClick, false);
}
});
}
}
function _isLocalhostUrl(urlString) {
_isLocalhostUrl(urlString) {
try {
const url = new URL(urlString);
switch (url.hostname.toLowerCase()) {
@ -210,9 +228,9 @@ function _isLocalhostUrl(urlString) {
// NOP
}
return false;
}
}
function _settingsImportSanitizeProfileOptions(options, dryRun) {
_settingsImportSanitizeProfileOptions(options, dryRun) {
const warnings = [];
const anki = options.anki;
@ -225,7 +243,7 @@ function _settingsImportSanitizeProfileOptions(options, dryRun) {
}
}
const server = anki.server;
if (typeof server === 'string' && server.length > 0 && !_isLocalhostUrl(server)) {
if (typeof server === 'string' && server.length > 0 && !this._isLocalhostUrl(server)) {
warnings.push('anki.server uses a non-localhost URL');
if (!dryRun) {
delete anki.server;
@ -236,7 +254,7 @@ function _settingsImportSanitizeProfileOptions(options, dryRun) {
const audio = options.audio;
if (isObject(audio)) {
const customSourceUrl = audio.customSourceUrl;
if (typeof customSourceUrl === 'string' && customSourceUrl.length > 0 && !_isLocalhostUrl(customSourceUrl)) {
if (typeof customSourceUrl === 'string' && customSourceUrl.length > 0 && !this._isLocalhostUrl(customSourceUrl)) {
warnings.push('audio.customSourceUrl uses a non-localhost URL');
if (!dryRun) {
delete audio.customSourceUrl;
@ -245,9 +263,9 @@ function _settingsImportSanitizeProfileOptions(options, dryRun) {
}
return warnings;
}
}
function _settingsImportSanitizeOptions(optionsFull, dryRun) {
_settingsImportSanitizeOptions(optionsFull, dryRun) {
const warnings = new Set();
const profiles = optionsFull.profiles;
@ -257,7 +275,7 @@ function _settingsImportSanitizeOptions(optionsFull, dryRun) {
const options = profile.options;
if (!isObject(options)) { continue; }
const warnings2 = _settingsImportSanitizeProfileOptions(options, dryRun);
const warnings2 = this._settingsImportSanitizeProfileOptions(options, dryRun);
for (const warning of warnings2) {
warnings.add(warning);
}
@ -265,19 +283,19 @@ function _settingsImportSanitizeOptions(optionsFull, dryRun) {
}
return warnings;
}
}
function _utf8Decode(arrayBuffer) {
_utf8Decode(arrayBuffer) {
try {
return new TextDecoder('utf-8').decode(arrayBuffer);
} catch (e) {
const binaryString = String.fromCharCode.apply(null, new Uint8Array(arrayBuffer));
return decodeURIComponent(escape(binaryString));
}
}
}
async function _importSettingsFile(file) {
const dataString = _utf8Decode(await utilReadFileArrayBuffer(file));
async _importSettingsFile(file) {
const dataString = this._utf8Decode(await this._readFileArrayBuffer(file));
const data = JSON.parse(dataString);
// Type check
@ -297,7 +315,7 @@ async function _importSettingsFile(file) {
if (!(
version >= 0 &&
version <= SETTINGS_EXPORT_CURRENT_VERSION
version <= this._currentVersion
)) {
throw new Error(`Unsupported version: ${version}`);
}
@ -312,65 +330,58 @@ async function _importSettingsFile(file) {
optionsFull = optionsUpdateVersion(optionsFull, {});
// Check for warnings
const sanitizationWarnings = _settingsImportSanitizeOptions(optionsFull, true);
const sanitizationWarnings = this._settingsImportSanitizeOptions(optionsFull, true);
// Show sanitization warnings
if (sanitizationWarnings.size > 0) {
const {result, sanitize} = await _showSettingsImportWarnings(sanitizationWarnings);
const {result, sanitize} = await this._showSettingsImportWarnings(sanitizationWarnings);
if (!result) { return; }
if (sanitize !== false) {
_settingsImportSanitizeOptions(optionsFull, false);
this._settingsImportSanitizeOptions(optionsFull, false);
}
}
// Assign options
await _settingsImportSetOptionsFull(optionsFull);
await this._settingsImportSetOptionsFull(optionsFull);
// Reload settings page
window.location.reload();
}
}
function _onSettingsImportClick() {
_onSettingsImportClick() {
document.querySelector('#settings-import-file').click();
}
}
function _onSettingsImportFileChange(e) {
async _onSettingsImportFileChange(e) {
const files = e.target.files;
if (files.length === 0) { return; }
const file = files[0];
e.target.value = null;
_importSettingsFile(file).catch(_showSettingsImportError);
}
try {
await this._importSettingsFile(file);
} catch (error) {
this._showSettingsImportError(error);
}
}
// Resetting
// Resetting
function _onSettingsResetClick() {
_onSettingsResetClick() {
$('#settings-reset-modal').modal('show');
}
}
async function _onSettingsResetConfirmClick() {
async _onSettingsResetConfirmClick() {
$('#settings-reset-modal').modal('hide');
// Get default options
const optionsFull = optionsGetDefault();
// Assign options
await _settingsImportSetOptionsFull(optionsFull);
await this._settingsImportSetOptionsFull(optionsFull);
// Reload settings page
window.location.reload();
}
// Setup
function backupInitialize() {
document.querySelector('#settings-export').addEventListener('click', _onSettingsExportClick, false);
document.querySelector('#settings-import').addEventListener('click', _onSettingsImportClick, false);
document.querySelector('#settings-import-file').addEventListener('change', _onSettingsImportFileChange, false);
document.querySelector('#settings-reset').addEventListener('click', _onSettingsResetClick, false);
document.querySelector('#settings-reset-modal-confirm').addEventListener('click', _onSettingsResetConfirmClick, false);
}
}

4
ext/bg/js/settings/main.js
View File

@ -16,13 +16,13 @@
*/
/* global
* SettingsBackup
* ankiInitialize
* ankiTemplatesInitialize
* ankiTemplatesUpdateValue
* api
* appearanceInitialize
* audioSettingsInitialize
* backupInitialize
* dictSettingsInitialize
* getOptionsContext
* onAnkiOptionsChanged
@ -302,7 +302,7 @@ async function onReady() {
await dictSettingsInitialize();
ankiInitialize();
ankiTemplatesInitialize();
backupInitialize();
new SettingsBackup().prepare();
storageInfoInitialize();

9
ext/bg/js/util.js
View File

@ -65,12 +65,3 @@ function utilBackend() {
}
return backend;
}
function utilReadFileArrayBuffer(file) {
return new Promise((resolve, reject) => {
const reader = new FileReader();
reader.onload = () => resolve(reader.result);
reader.onerror = () => reject(reader.error);
reader.readAsArrayBuffer(file);
});
}