/* * Copyright 2018 Gildas Lormeau * contact : gildas.lormeau gmail.com * * This file is part of SingleFile. * * SingleFile is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * SingleFile is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with SingleFile. If not, see . */ /* global browser, singlefile, URL, Blob, FileReader */ singlefile.config = (() => { const DEFAULT_PROFILE_NAME = "__Default_Settings__"; const DISABLED_PROFILE_NAME = "__Disabled_Settings__"; const DEFAULT_CONFIG = { removeHiddenElements: true, removeUnusedStyles: true, removeFrames: false, removeImports: true, removeScripts: true, rawDocument: false, compressHTML: true, compressCSS: true, loadDeferredImages: true, loadDeferredImagesMaxIdleTime: 1500, filenameTemplate: "{page-title} ({date-iso} {time-locale}).html", infobarTemplate: "", confirmInfobarContent: false, confirmFilename: false, filenameConflictAction: "uniquify", contextMenuEnabled: true, shadowEnabled: true, maxResourceSizeEnabled: false, maxResourceSize: 10, removeAudioSrc: true, removeVideoSrc: true, displayInfobar: true, displayStats: false, backgroundSave: true, autoSaveDelay: 1, autoSaveLoad: false, autoSaveUnload: false, autoSaveLoadOrUnload: true, removeAlternativeFonts: true, removeAlternativeMedias: true, removeAlternativeImages: true, groupDuplicateImages: true, saveRawPage: false }; let pendingUpgradePromise = upgrade(); browser.runtime.onMessage.addListener(request => { if (request.getOptions) { return getOptions(); } }); async function upgrade() { const config = await browser.storage.local.get(); const defaultConfig = config; if (!config.profiles) { delete defaultConfig.tabsData; applyUpgrade(defaultConfig); const config = { profiles: {}, rules: [] }; config.profiles[DEFAULT_PROFILE_NAME] = defaultConfig; browser.storage.local.remove(Object.keys(DEFAULT_CONFIG)); return browser.storage.local.set(config); } else { if (!config.rules) { config.rules = []; } Object.keys(config.profiles).forEach(profileName => applyUpgrade(config.profiles[profileName])); await browser.storage.local.remove(["profiles", "defaultProfile", "rules"]); return browser.storage.local.set({ profiles: config.profiles, rules: config.rules }); } } function applyUpgrade(config) { if (config.removeScripts === undefined) { config.removeScripts = true; } config.compressHTML = config.compressCSS = config.compress; if (config.compressCSS === undefined) { config.compressCSS = true; } if (config.compressHTML === undefined) { config.compressHTML = true; } if (config.contextMenuEnabled === undefined) { config.contextMenuEnabled = true; } if (config.filenameTemplate === undefined) { if (config.appendSaveDate || config.appendSaveDate === undefined) { config.filenameTemplate = DEFAULT_CONFIG.filenameTemplate; } else { config.filenameTemplate = "{page-title}.html"; } delete config.appendSaveDate; } if (config.infobarTemplate === undefined) { config.infobarTemplate = ""; } if (config.removeImports === undefined) { config.removeImports = true; } if (config.shadowEnabled === undefined) { config.shadowEnabled = true; } if (config.maxResourceSize === undefined) { config.maxResourceSize = DEFAULT_CONFIG.maxResourceSize; } if (config.maxResourceSize === 0) { config.maxResourceSize = 1; } if (config.removeUnusedStyles === undefined || config.removeUnusedCSSRules) { delete config.removeUnusedCSSRules; config.removeUnusedStyles = true; } if (config.removeAudioSrc === undefined) { config.removeAudioSrc = true; } if (config.removeVideoSrc === undefined) { config.removeVideoSrc = true; } if (config.displayInfobar === undefined) { config.displayInfobar = true; } if (config.backgroundSave === undefined) { config.backgroundSave = true; } if (config.autoSaveDelay === undefined) { config.autoSaveDelay = DEFAULT_CONFIG.autoSaveDelay; } if (config.removeAlternativeFonts === undefined) { config.removeAlternativeFonts = true; } if (config.removeAlternativeMedias === undefined) { config.removeAlternativeMedias = true; } if (config.removeAlternativeImages === undefined) { if (config.removeAlternativeImages === undefined) { config.removeAlternativeImages = true; } else { config.removeAlternativeImages = config.removeSrcSet; } } if (config.groupDuplicateImages === undefined) { config.groupDuplicateImages = true; } if (config.removeHiddenElements === undefined) { config.removeHiddenElements = true; } if (config.autoSaveLoadOrUnload === undefined && !config.autoSaveUnload) { config.autoSaveLoadOrUnload = true; config.autoSaveLoad = false; config.autoSaveUnload = false; } if (config.confirmFilename === undefined) { config.confirmFilename = false; } if (config.confirmInfobarContent === undefined) { config.confirmInfobarContent = config.confirmInfobar; delete config.confirmInfobar; } if (config.filenameConflictAction === undefined) { config.filenameConflictAction = config.conflictAction || DEFAULT_CONFIG.filenameConflictAction; delete config.conflictAction; } if (config.loadDeferredImages === undefined) { config.loadDeferredImages = config.lazyLoadImages || true; delete config.lazyLoadImages; } if (config.loadDeferredImagesMaxIdleTime === undefined) { config.loadDeferredImagesMaxIdleTime = config.maxLazyLoadImagesIdleTime || DEFAULT_CONFIG.loadDeferredImagesMaxIdleTime; delete config.maxLazyLoadImagesIdleTime; } } async function getOptions() { const [config, tabsData] = await Promise.all([getConfig(), singlefile.tabsData.get()]); return config.profiles[tabsData.profileName || DEFAULT_PROFILE_NAME]; } async function getConfig() { await pendingUpgradePromise; return browser.storage.local.get(["profiles", "rules"]); } return { DISABLED_PROFILE_NAME, DEFAULT_PROFILE_NAME, async createProfile(profileName) { const config = await getConfig(); if (Object.keys(config.profiles).includes(profileName)) { throw new Error("Duplicate profile name"); } config.profiles[profileName] = DEFAULT_CONFIG; await browser.storage.local.set({ profiles: config.profiles }); }, async getProfiles() { const config = await getConfig(); return config.profiles; }, async getOptions(profileName, url, autoSave) { const config = await getConfig(); const urlRule = config.rules.sort((ruleLeft, ruleRight) => ruleRight.url.length - ruleLeft.url.length).find(rule => url && url.includes(rule.url)); return urlRule ? config.profiles[urlRule[autoSave ? "autoSaveProfile" : "profile"]] : config.profiles[profileName || singlefile.config.DEFAULT_PROFILE_NAME]; }, async updateProfile(profileName, profile) { const config = await getConfig(); if (!Object.keys(config.profiles).includes(profileName)) { throw new Error("Profile not found"); } config.profiles[profileName] = profile; await browser.storage.local.set({ profiles: config.profiles }); }, async renameProfile(oldProfileName, profileName) { const [config, tabsData] = await Promise.all([getConfig(), singlefile.tabsData.get()]); if (!Object.keys(config.profiles).includes(oldProfileName)) { throw new Error("Profile not found"); } if (Object.keys(config.profiles).includes(profileName)) { throw new Error("Duplicate profile name"); } if (oldProfileName == DEFAULT_PROFILE_NAME) { throw new Error("Default settings cannot be renamed"); } if (tabsData.profileName == oldProfileName) { tabsData.profileName = profileName; await singlefile.tabsData.set(tabsData); } config.profiles[profileName] = config.profiles[oldProfileName]; config.rules.forEach(rule => { if (rule.profile == oldProfileName) { rule.profile = profileName; } if (rule.autoSaveProfile == oldProfileName) { rule.autoSaveProfile = profileName; } }); delete config.profiles[oldProfileName]; await browser.storage.local.set({ profiles: config.profiles, rules: config.rules }); }, async deleteProfile(profileName) { const [config, tabsData] = await Promise.all([getConfig(), singlefile.tabsData.get()]); if (!Object.keys(config.profiles).includes(profileName)) { throw new Error("Profile not found"); } if (profileName == DEFAULT_PROFILE_NAME) { throw new Error("Default settings cannot be deleted"); } if (tabsData.profileName == profileName) { delete tabsData.profileName; await singlefile.tabsData.set(tabsData); } config.rules.forEach(rule => { if (rule.profile == profileName) { rule.profile = DEFAULT_PROFILE_NAME; } if (rule.autoSaveProfile == profileName) { rule.autoSaveProfile = DEFAULT_PROFILE_NAME; } }); delete config.profiles[profileName]; await browser.storage.local.set({ profiles: config.profiles, rules: config.rules }); }, async getRules() { const config = await getConfig(); return config.rules; }, async addRule(url, profile, autoSaveProfile) { if (!url) { throw new Error("URL is empty"); } const config = await getConfig(); if (config.rules.find(rule => rule.url == url)) { throw new Error("URL already exists"); } config.rules.push({ url, profile, autoSaveProfile }); await browser.storage.local.set({ rules: config.rules }); }, async deleteRule(url) { if (!url) { throw new Error("URL is empty"); } const config = await getConfig(); config.rules = config.rules.filter(rule => rule.url != url); await browser.storage.local.set({ rules: config.rules }); }, async updateRule(url, newURL, profile, autoSaveProfile) { if (!url || !newURL) { throw new Error("URL is empty"); } const config = await getConfig(); const urlConfig = config.rules.find(rule => rule.url == url); if (!urlConfig) { throw new Error("URL not found"); } if (config.rules.find(rule => rule.url == newURL && rule.url != url)) { throw new Error("New URL already exists"); } urlConfig.url = newURL; urlConfig.profile = profile; urlConfig.autoSaveProfile = autoSaveProfile; await browser.storage.local.set({ rules: config.rules }); }, async reset() { await pendingUpgradePromise; const tabsData = await singlefile.tabsData.get(); delete tabsData.profileName; await singlefile.tabsData.set(tabsData); await browser.storage.local.remove(["profiles", "rules"]); await browser.storage.local.set({ profiles: { [DEFAULT_PROFILE_NAME]: DEFAULT_CONFIG }, rules: [] }); }, async export() { const config = await getConfig(); const url = URL.createObjectURL(new Blob([JSON.stringify({ profiles: config.profiles, rules: config.rules }, null, 2)], { type: "text/json" })); const downloadInfo = { url, filename: "singlefile-settings.json", saveAs: true }; const downloadId = await browser.downloads.download(downloadInfo); return new Promise((resolve, reject) => { browser.downloads.onChanged.addListener(onChanged); function onChanged(event) { if (event.id == downloadId && event.state) { if (event.state.current == "complete") { URL.revokeObjectURL(url); resolve({}); browser.downloads.onChanged.removeListener(onChanged); } if (event.state.current == "interrupted" && (!event.error || event.error.current != "USER_CANCELED")) { URL.revokeObjectURL(url); reject(new Error(event.state.current)); browser.downloads.onChanged.removeListener(onChanged); } } } }); }, async import(file) { const reader = new FileReader(); reader.readAsText(file); const serializedConfig = await new Promise((resolve, reject) => { reader.addEventListener("load", () => resolve(reader.result), false); reader.addEventListener("error", reject, false); }); const config = JSON.parse(serializedConfig); await browser.storage.local.remove(["profiles", "rules"]); await browser.storage.local.set({ profiles: config.profiles, rules: config.rules }); } }; })();