Skip to content
This repository has been archived by the owner on Nov 6, 2023. It is now read-only.

Refactor code for the browser session storage #18153

Merged
merged 2 commits into from
Jul 9, 2019
Merged

Refactor code for the browser session storage #18153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be6dd29
Refactor code for the browser session storage
Jul 1, 2019
7decfe3
Use arrow function to get ride of this is that
Jul 2, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
142 changes: 70 additions & 72 deletions chromium/background-scripts/background.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,37 +187,57 @@ chrome.browserAction.onClicked.addListener(e => {
});



/**
* Add a listener for removed tabs
* A centralized storage for browsing data within the browser session.
*/
function AppliedRulesets() {
this.active_tab_rules = new Map();
this.active_tab_main_frames = new Map();
function BrowserSession() {
this.tabs = new Map();
this.requests = new Map();

let that = this;
if (chrome.tabs) {
chrome.tabs.onRemoved.addListener(function(tabId) {
that.removeTab(tabId);
chrome.tabs.onRemoved.addListener(tabId => {
this.deleteTab(tabId);
});
}
}

AppliedRulesets.prototype = {
addRulesetToTab: function(tabId, type, ruleset) {
if (!this.active_tab_main_frames.has(tabId)) {
this.active_tab_main_frames.set(tabId, false);
BrowserSession.prototype = {
putTab: function(tabId, key, value, overwrite) {
if (!this.tabs.has(tabId)) {
this.tabs.set(tabId, {});
}

if (!(key in this.tabs.get(tabId)) || overwrite) {
this.tabs.get(tabId)[key] = value;
}
},

getTab: function(tabId, key, defaultValue) {
if (this.tabs.has(tabId) && key in this.tabs.get(tabId)) {
return this.tabs.get(tabId)[key];
}
return defaultValue;
},

deleteTab: function(tabId) {
if (this.tabs.has(tabId)) {
this.tabs.delete(tabId);
}
},

putTabAppliedRulesets: function(tabId, type, ruleset) {
this.putTab(tabId, "main_frame", false, false);

// always show main_frame ruleset on the top
if (type == "main_frame") {
this.active_tab_main_frames.set(tabId, true);
this.active_tab_rules.set(tabId, [ruleset,]);
this.putTab(tabId, "main_frame", true, true);
this.putTab(tabId, "applied_rulesets", [ruleset,], true);
return ;
}

if (this.active_tab_rules.has(tabId)) {
let rulesets = this.active_tab_rules.get(tabId);
// sort by ruleset names alphabetically, case-insensitive
if (this.getTab(tabId, "applied_rulesets", null)) {
let rulesets = this.getTab(tabId, "applied_rulesets");
let insertIndex = 0;

const ruleset_name = ruleset.name.toLowerCase();
Expand All @@ -227,58 +247,47 @@ AppliedRulesets.prototype = {

if (item_name == ruleset_name) {
return ;
} else if (insertIndex == 0 && this.active_tab_main_frames.get(tabId)) {
} else if (insertIndex == 0 && this.getTab(tabId, "main_frame", false)) {
insertIndex = 1;
} else if (item_name < ruleset_name) {
insertIndex++;
}
}
rulesets.splice(insertIndex, 0, ruleset);
} else {
this.active_tab_rules.set(tabId, [ruleset,]);
this.putTab(tabId, "applied_rulesets", [ruleset,], true);
}
},

getRulesets: function(tabId) {
if (this.active_tab_rules.has(tabId)) {
return this.active_tab_rules.get(tabId);
} else {
return null;
}
getTabAppliedRulesets: function(tabId) {
return this.getTab(tabId, "applied_rulesets", null);
},

removeTab: function(tabId) {
this.active_tab_rules.delete(tabId);
this.active_tab_main_frames.delete(tabId);
putRequest: function(requestId, key, value) {
if (!this.requests.has(requestId)) {
this.requests.set(requestId, {});
}
this.requests.get(requestId)[key] = value;
},

getActiveRulesetCount: function (tabId) {
let activeCount = 0;
getRequest: function(requestId, key, defaultValue) {
if (this.requests.has(requestId) && key in this.requests.get(requestId)) {
return this.requests.get(requestId)[key];
}
return defaultValue;
},

const rulesets = this.getRulesets(tabId);
if (rulesets) {
for (const ruleset of rulesets) {
if (ruleset.active) {
activeCount++;
}
}
deleteRequest: function(requestId) {
if (this.requests.has(requestId)) {
this.requests.delete(requestId);
}
return activeCount;
}
};
}

var appliedRulesets = new AppliedRulesets();
let browserSession = new BrowserSession();

var urlBlacklist = new Set();

// redirect counter workaround
// TODO: Remove this code if they ever give us a real counter
var redirectCounter = new Map();

// Create a map to indicate whether a given request has been subject to a simple
// HTTP Nowhere redirect.
let simpleHTTPNowhereRedirect = new Map();

const cancelUrl = chrome.runtime.getURL("/pages/cancel/index.html");

function redirectOnCancel(shouldCancel, originURL) {
Expand All @@ -303,7 +312,7 @@ function onBeforeRequest(details) {
// otherwise, the extension page might include rulesets
// from previous page.
if (details.type == "main_frame") {
appliedRulesets.removeTab(details.tabId);
browserSession.deleteTab(details.tabId);
}

let uri = new URL(details.url);
Expand Down Expand Up @@ -366,7 +375,7 @@ function onBeforeRequest(details) {
return redirectOnCancel(shouldCancel, details.url);
}

if (redirectCounter.get(details.requestId) >= 8) {
if (browserSession.getRequest(details.requestId, "redirect_count") >= 8) {
util.log(util.NOTE, "Redirect counter hit for " + uri.href);
urlBlacklist.add(uri.href);
rules.settings.domainBlacklist.add(uri.hostname);
Expand All @@ -382,7 +391,7 @@ function onBeforeRequest(details) {

for (let ruleset of potentiallyApplicable) {
if (details.url.match(ruleset.scope)) {
appliedRulesets.addRulesetToTab(details.tabId, details.type, ruleset);
browserSession.putTabAppliedRulesets(details.tabId, details.type, ruleset);
if (ruleset.active && !newuristr) {
newuristr = ruleset.apply(uri.href);
}
Expand Down Expand Up @@ -427,7 +436,7 @@ function onBeforeRequest(details) {
if (shouldCancel) {
if (!newuristr) {
newuristr = uri.href.replace(/^http:/, "https:");
simpleHTTPNowhereRedirect.set(details.requestId, true);
browserSession.putRequest(details.requestId, "simple_http_nowhere_redirect", true);
upgradeToSecure = true;
} else {
newuristr = newuristr.replace(/^http:/, "https:");
Expand Down Expand Up @@ -592,13 +601,12 @@ function onBeforeRedirect(details) {
// Catch redirect loops (ignoring about:blank, etc. caused by other extensions)
let prefix = details.redirectUrl.substring(0, 5);
if (prefix === "http:" || prefix === "https") {
let count = redirectCounter.get(details.requestId);
let count = browserSession.getRequest(details.requestId, "redirect_count", 0);
if (count) {
redirectCounter.set(details.requestId, count + 1);
util.log(util.DBUG, "Got redirect id "+details.requestId+
": "+count);
browserSession.putRequest(details.requestId, "redirect_count", count + 1);
util.log(util.DBUG, "Got redirect id " + details.requestId + ": "+count);
} else {
redirectCounter.set(details.requestId, 1);
browserSession.putRequest(details.requestId, "redirect_count", 1);
}
}
}
Expand All @@ -608,12 +616,7 @@ function onBeforeRedirect(details) {
* @param details details for the chrome.webRequest (see chrome doc)
*/
function onCompleted(details) {
if (redirectCounter.has(details.requestId)) {
redirectCounter.delete(details.requestId);
}
if (simpleHTTPNowhereRedirect.has(details.requestId)) {
simpleHTTPNowhereRedirect.delete(details.requestId);
}
browserSession.deleteRequest(details.requestId);
}

/**
Expand All @@ -623,7 +626,7 @@ function onCompleted(details) {
function onErrorOccurred(details) {
if (httpNowhereOn &&
details.type == "main_frame" &&
simpleHTTPNowhereRedirect.get(details.requestId) &&
browserSession.getRequest(details.requestId, "simple_http_nowhere_redirect", false) &&
( // Enumerate a class of errors that are likely due to HTTPS misconfigurations
details.error.indexOf("net::ERR_SSL_") == 0 ||
details.error.indexOf("net::ERR_CERT_") == 0 ||
Expand Down Expand Up @@ -654,12 +657,7 @@ function onErrorOccurred(details) {
chrome.tabs.update(details.tabId, {url: newCancelUrl(url.toString())});
}

if (redirectCounter.has(details.requestId)) {
redirectCounter.delete(details.requestId);
}
if (simpleHTTPNowhereRedirect.has(details.requestId)) {
simpleHTTPNowhereRedirect.delete(details.requestId);
}
browserSession.deleteRequest(details.requestId);
}

/**
Expand Down Expand Up @@ -859,12 +857,12 @@ chrome.runtime.onMessage.addListener(function(message, sender, sendResponse) {
delete_from_ruleset_cache: () => {
all_rules.ruleCache.delete(message.object);
},
get_active_rulesets: () => {
sendResponse(appliedRulesets.getRulesets(message.object));
get_applied_rulesets: () => {
sendResponse(browserSession.getTabAppliedRulesets(message.object));
return true;
},
set_ruleset_active_status: () => {
let rulesets = appliedRulesets.getRulesets(message.object.tab_id);
let rulesets = browserSession.getTabAppliedRulesets(message.object.tab_id);

for (let ruleset of rulesets) {
if (ruleset.name == message.object.name) {
Expand Down
2 changes: 1 addition & 1 deletion chromium/pages/popup/ux.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ function toggleEnabledDisabled() {
* @param activeTab
*/
function listRules(activeTab) {
sendMessage("get_active_rulesets", activeTab.id, function(rulesets) {
sendMessage("get_applied_rulesets", activeTab.id, function(rulesets) {
if (rulesets) {
// show the number of potentially applicable rulesets
let counter = rulesets.length;
Expand Down