Preparation for StorageHandler (#92)

This commit is contained in:
nobody 2020-08-30 18:35:08 +02:00
parent 5d05066e76
commit e1c779155d
No known key found for this signature in database
GPG Key ID: 8F6DE3D614FCFD7A
4 changed files with 253 additions and 20 deletions

View File

@ -77,7 +77,30 @@ const Setting = {
'SELECTED_ICON': 'selectedIcon',
'INTERNAL_STATISTICS': 'internalStatistics',
'INTERNAL_STATISTICS_DATA': 'internalStatisticsData',
'ALLOWED_DOMAINS_GOOGLE_FONTS': 'allowedDomainsGoogleFonts'
'ALLOWED_DOMAINS_GOOGLE_FONTS': 'allowedDomainsGoogleFonts',
'STORAGE_TYPE': 'storageType'
};
const SettingDefaults = {
[Setting.ALLOWED_DOMAINS_GOOGLE_FONTS]: {},
[Setting.AMOUNT_INJECTED]: 0,
[Setting.BLOCK_GOOGLE_FONTS]: true,
[Setting.BLOCK_MISSING]: false,
[Setting.DISABLE_PREFETCH]: true,
[Setting.DOMAINS_MANIPULATE_DOM]: {},
[Setting.LOGGING]: false,
[Setting.ENFORCE_STAGING]: false,
[Setting.HIDE_RELEASE_NOTES]: false,
[Setting.INTERNAL_STATISTICS]: false,
[Setting.INTERNAL_STATISTICS_DATA]: {},
[Setting.LAST_MAPPING_UPDATE]: '2020-01-01',
[Setting.NEGATE_HTML_FILTER_LIST]: false,
[Setting.SELECTED_ICON]: 'Default',
[Setting.SHOW_ICON_BADGE]: true,
[Setting.STORAGE_TYPE]: 'local',
[Setting.STRIP_METADATA]: true,
[Setting.WHITELISTED_DOMAINS]: {},
[Setting.XHR_TEST_DOMAIN]: Address.LOCALCDN
};
const WebRequest = {

View File

@ -30,27 +30,10 @@ var main = {};
main._initializeSettings = function () {
let settingDefaults = {
[Setting.XHR_TEST_DOMAIN]: Address.LOCALCDN,
[Setting.SHOW_ICON_BADGE]: true,
[Setting.BLOCK_MISSING]: false,
[Setting.DISABLE_PREFETCH]: true,
[Setting.ENFORCE_STAGING]: false,
[Setting.HIDE_RELEASE_NOTES]: false,
[Setting.STRIP_METADATA]: true,
[Setting.WHITELISTED_DOMAINS]: {},
[Setting.LOGGING]: false,
[Setting.DOMAINS_MANIPULATE_DOM]: {},
[Setting.NEGATE_HTML_FILTER_LIST]: false,
[Setting.BLOCK_GOOGLE_FONTS]: true,
[Setting.SELECTED_ICON]: 'Default',
[Setting.ALLOWED_DOMAINS_GOOGLE_FONTS]: {}
};
chrome.storage.sync.get(settingDefaults, function (items) {
if (items === null) {
items = settingDefaults; // Restore setting defaults.
items = SettingDefaults; // Restore setting defaults.
}
if (items.disablePrefetch !== false) {

227
core/storage-manager.js Normal file
View File

@ -0,0 +1,227 @@
/**
* Storage Manager
* Belongs to LocalCDN
*
* @author nobody
* @since 2020-08-28
*
* @license MPL 2.0
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/.
*/
'use strict';
/**
* Storage Manager
*/
var storageManager = {};
/**
* Public Methods
*/
storageManager.checkStorageType = function () {
chrome.storage.local.get([Setting.STORAGE_TYPE], function (items) {
if (items.storageType === 'sync') {
storageManager.type = chrome.storage.sync;
} else {
storageManager.type = chrome.storage.local;
}
});
};
storageManager.migrateData = function (target) {
let storageSource, storageDestination, newItems, onlyLocal;
newItems = {};
onlyLocal = {};
if (target === 'local') {
storageSource = chrome.storage.sync;
storageDestination = chrome.storage.local;
} else {
storageSource = chrome.storage.local;
storageDestination = chrome.storage.sync;
}
storageSource.get(null, function (items) {
for (const [key, value] of Object.entries(items)) {
// Filter unused old data
if (Object.values(Setting).includes(key)) {
// Remove previous default values
if (key === 'xhrTestDomain' && value === 'decentraleyes.org') {
newItems[key] = 'localcdn.org';
} else if (key === 'amountInjected' || key === 'internalStatistics' || key === 'internalStatisticsData') {
onlyLocal[key] = value;
} else {
newItems[key] = value;
}
}
}
chrome.storage.local.set(onlyLocal);
storageDestination.set(newItems);
// Clear sync storage
// chrome.storage.sync.clear();
});
};
storageManager.export = function () {
let filename = new Date().toISOString();
filename = filename.substring(0, 10) + '_localcdn_backup.txt';
storageManager.type.get(null, function (items) {
let element = document.createElement('a');
element.setAttribute('href', 'data:text/plain;charset=utf-8,' + encodeURIComponent(JSON.stringify(items, null, ' ')));
element.setAttribute('download', filename);
element.style.display = 'none';
document.body.appendChild(element);
element.click();
document.body.removeChild(element);
});
};
storageManager.startImportFilePicker = function () {
const input = document.getElementById('import-file-picker');
input.value = '';
input.click();
};
storageManager.handleImportFilePicker = async function () {
try {
let file = document.getElementById('import-file-picker').files[0];
let content = await storageManager._readFileAsync(file);
storageManager._validation(JSON.parse(content));
} catch (err) {
console.error('[ LocalCDN ] ' + err);
}
};
/**
* Private Methods
*/
storageManager._handleStorageChanged = function (type) {
if (Setting.STORAGE_TYPE in type) {
if (type.storageType.newValue === 'sync') {
storageManager.type = chrome.storage.sync;
} else {
storageManager.type = chrome.storage.local;
}
}
};
storageManager._readFileAsync = function (file) {
return new Promise((resolve, reject) => {
let reader = new FileReader();
reader.onload = () => {
resolve(reader.result);
};
reader.onerror = reject;
reader.readAsText(file);
});
};
storageManager._validation = function (content) {
let imported = {};
for (const [key, value] of Object.entries(SettingDefaults)) {
// If type the same as default settings
if (typeof value === typeof content[key]) {
if (typeof value === 'object' || value instanceof Object) {
imported[key] = storageManager._validateDomainsAndStatistics(key, content[key]);
} else if (typeof value === 'string' || value instanceof String) {
imported[key] = storageManager._validateStrings(content[key]);
} else if ((typeof value === 'number' || value instanceof Number) && key !== 'amountInjected') {
imported[key] = storageManager._validateNumbers(content[key]);
}
} else {
alert(chrome.i18n.getMessage('dialogImportFailed'));
throw 'Invalid file!';
}
}
storageManager.type.set(imported);
alert(chrome.i18n.getMessage('dialogImportSuccessful'));
};
storageManager._validateDomainsAndStatistics = function (type, obj) {
let valid = {};
if (type === 'allowedDomainsGoogleFonts' || type === 'domainsManipulateDOM' || type === 'whitelistedDomains') {
for (const [key, value] of Object.entries(obj)) {
if ((/[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,24}/.test(key) || key === '') && value === true) {
valid[key] = value;
} else {
alert(chrome.i18n.getMessage('dialogImportFailed') + ': ' + key);
throw 'Invalid file!';
}
}
} else if (type === 'internalStatisticsData') {
let statistics = {};
for (const [date, values] of Object.entries(obj)) {
if (/((2[0-9])[0-9]{2})-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])/.test(date)) {
for (const [types, category] of Object.entries(values)) {
if (types === 'frameworks') {
let frameworks = {};
for (const [name, counter] of Object.entries(category)) {
if (/resources\/[0-9a-z.-]+\/((?:\d{1,2}\.){1,3}\d{1,2})?.*\.(css|jsm)/.test(name) && counter > 0 && counter < Number.MAX_VALUE) {
frameworks[name] = counter;
} else {
alert(chrome.i18n.getMessage('dialogImportFailed') + ': ' + name);
throw 'Invalid file!';
}
}
statistics[date] = frameworks;
} else if (types === 'cdns') {
let cdns = {};
for (const [name, counter] of Object.entries(category)) {
if (/[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,24}/.test(name) && counter > 0 && counter < Number.MAX_VALUE) {
cdns[name] = counter;
} else {
alert(chrome.i18n.getMessage('dialogImportFailed') + ': ' + name);
throw 'Invalid file!';
}
}
statistics[date] = cdns;
} else {
alert(chrome.i18n.getMessage('dialogImportFailed') + ': ' + type);
throw 'Invalid file!';
}
}
} else {
alert(chrome.i18n.getMessage('dialogImportFailed') + ': ' + date);
throw 'Invalid file!';
}
}
valid = statistics;
} else {
alert(chrome.i18n.getMessage('dialogImportFailed') + ': ' + type);
throw 'Invalid file!';
}
return valid;
};
storageManager._validateStrings = function (value) {
if (/((2[0-9])[0-9]{2})-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])/.test(value)) {
return value;
} else if (value === 'Default' || value === 'Light' || value === 'Grey') {
return value;
} else if (value === 'local' || value === 'sync') {
return value;
} else if (value === 'decentraleyes.org' || value === 'localcdn.org') {
return 'localcdn.org';
} else {
return '';
}
};
storageManager._validateNumbers = function (value) {
return value > 0 && value < Number.MAX_VALUE ? value : 0;
};
storageManager.data = {};
storageManager.type = chrome.storage.local;
chrome.storage.onChanged.addListener(storageManager._handleStorageChanged);

View File

@ -1,7 +1,7 @@
{
"manifest_version": 2,
"name": "LocalCDN",
"version": "2.3.2",
"version": "2.4.0",
"browser_specific_settings": {
"gecko": {
"id": "{b86e4813-687a-43e6-ab65-0bde4ab75758}",