From 28f23f68d514c18de8f0a568c9c912f0c31dee14 Mon Sep 17 00:00:00 2001
From: Aaron Horler <aghorler@users.noreply.github.com>
Date: Sat, 3 Jun 2017 20:44:19 +1000
Subject: [PATCH] Logic improvements

Various improvements to logic, and added comments.
---
 html/options.html | 10 +++++-----
 js/background.js  | 44 +++++++++++++++++++++++++++++++-------------
 js/options.js     | 20 ++++++++++----------
 manifest.json     |  2 +-
 4 files changed, 47 insertions(+), 29 deletions(-)
diff --git a/html/options.html b/html/options.html
index 04e8a13..5236ded 100644
--- a/html/options.html
+++ b/html/options.html
@@ -6,19 +6,19 @@
 	<body>
 		<p id="conf-warning" style="color: red; text-align: center;">Startup Cookie Manager will not function until you apply these settings.</p>
 
-		<h3>Cookie whitelist (include subdomains)</h3>
+		<h3 title="example.com will preserve example.com, and *.example.com cookies.">Cookie whitelist (include subdomains)</h3>
 
-		<p>
+		<p title="example.com will preserve example.com, and *.example.com cookies.">
 			<textarea id="subdomain-whitelist" rows="4" cols="50"></textarea>
 		</p>
 
-		<h3>Cookie whitelist (domains only)</h3>
+		<h3 title="example.com will preserve example.com, .example.com, and www.example.com cookies.">Cookie whitelist (root domains only)</h3>
 
-		<p>
+		<p title="example.com will preserve example.com, .example.com, and www.example.com cookies.">
 			<textarea id="domain-only-whitelist" rows="4" cols="50"></textarea>
 		</p>
 
-		<h3>Additional settings</h3>
+		<h3 title="Additional tasks to perform whenever cookies and site data are cleared.">Additional settings</h3>
 
 		<p>
 			<label>
diff --git a/js/background.js b/js/background.js
index 5c79ab9..6ec7ba0 100644
--- a/js/background.js
+++ b/js/background.js
@@ -1,23 +1,30 @@
-function removeCookie(cookie){
+/* Function to check whitelist status of cookie, and delete accordingly. */
+function checkCookie(cookie){
 	chrome.storage.local.get({
-		subdomainWhitelist: [],
-		domainOnlyWhitelist: []
+		subDomainWhitelist: [],
+		rootDomainWhitelist: []
 	}, function(array){
-		var subdomainCheck = 0;
-		for(var i = 0; i < array.subdomainWhitelist.length; i++){
-			if(cookie.domain.endsWith(array.subdomainWhitelist[i])){
-				subdomainCheck++;
+
+		/* Check if cookie matches element of subdomain whitelist. (example.com or *.example.com) */
+		var preserveCookieSubdomain = false;
+		for(var i = 0; i < array.subDomainWhitelist.length; i++){
+			if(cookie.domain == array.subDomainWhitelist[i] || cookie.domain.endsWith("." + array.subDomainWhitelist[i])){
+				preserveCookieSubdomain = true;
+				break;
 			}
 		}
 
-		var domainCheck = 0;
-		for(var i = 0; i < array.domainOnlyWhitelist.length; i++){
-			if(cookie.domain == array.domainOnlyWhitelist[i] || cookie.domain == "." + array.domainOnlyWhitelist[i] || cookie.domain == "www." + array.domainOnlyWhitelist[i]){
-				domainCheck++;
+		/* Check if cookie matches element of root domain whitelist. (example.com or .example.com or www.example.com) */
+		var preserveCookieRoot = false;
+		for(var i = 0; i < array.rootDomainWhitelist.length; i++){
+			if(cookie.domain == array.rootDomainWhitelist[i] || cookie.domain == "." + array.rootDomainWhitelist[i] || cookie.domain == "www." + array.rootDomainWhitelist[i]){
+				preserveCookieRoot = true;
+				break;
 			}
 		}
 
-		if(subdomainCheck == 0 && domainCheck == 0){
+		/* Delete cookie if preservation flag not set. */
+		if(preserveCookieSubdomain == false && preserveCookieRoot == false){
 			var url = "http" + (cookie.secure ? "s" : "") + "://" + cookie.domain + cookie.path;
 			chrome.cookies.remove({"url": url, "name": cookie.name});
 			console.log("Removed: " + cookie.domain + " " + url);
@@ -25,21 +32,28 @@ function removeCookie(cookie){
 	});
 }
 
+/* Function to delete cookies using the checkCookie function, and indiscriminately delete all other relevant site data. */
 function clearSiteData(){
 	chrome.storage.local.get('configured', function(check){
+
+		/* Check if extension has been configured. This prevents the extension from removing all cookies on installation. */
 		if(check.configured){
+
+			/* Pass all cookies, one-by-one, to the checkCookie function. */
 			chrome.cookies.getAll({}, function(allCookies){
 				for(var i = 0; i < allCookies.length; i++){
-					removeCookie(allCookies[i]);
+					checkCookie(allCookies[i]);
 				}
 			});
 
+			/* Delete various other forms of site data, along with history and cache depending on user preference, indiscriminately. */
 			chrome.browsingData.remove({
 				"originTypes": {
 					"unprotectedWeb": true,
 					"protectedWeb": true
 				}
 			}, {
+				"appcache": true,
 				"fileSystems": true,
 				"indexedDB": true,
 				"localStorage": true,
@@ -91,14 +105,18 @@ function clearSiteData(){
 	});
 }
 
+/* Open extension options page on installation. */
 chrome.runtime.onInstalled.addListener(function(details){
 	if(details.reason == "install"){
 		chrome.runtime.openOptionsPage();
 	}
 });
 
+
+/* Run clearSiteData function on extension toolbar icon click. */
 chrome.browserAction.onClicked.addListener(function(){
 	clearSiteData();
 });
 
+/* Run clearSiteData function on extension load (on boot). */
 clearSiteData();
diff --git a/js/options.js b/js/options.js
index 64c6bb1..dc81a73 100644
--- a/js/options.js
+++ b/js/options.js
@@ -1,14 +1,14 @@
 function saveOptions(){
-	var subdomainArray = document.getElementById('subdomain-whitelist').value.split('\n');
-	subdomainArray = subdomainArray.filter(Boolean);
-	var domainOnlyArray = document.getElementById('domain-only-whitelist').value.split('\n');
-	domainOnlyArray = domainOnlyArray.filter(Boolean);
+	var subDomainArray = document.getElementById('subdomain-whitelist').value.split('\n');
+	subDomainArray = subDomainArray.filter(Boolean);
+	var rootDomainArray = document.getElementById('domain-only-whitelist').value.split('\n');
+	rootDomainArray = rootDomainArray.filter(Boolean);
 	var cacheOption = document.getElementById('cache_option').checked;
 	var historyOption = document.getElementById('history_option').checked;
 
 	chrome.storage.local.set({
-		subdomainWhitelist: subdomainArray,
-		domainOnlyWhitelist: domainOnlyArray,
+		subDomainWhitelist: subDomainArray,
+		rootDomainWhitelist: rootDomainArray,
 		clearCache: cacheOption,
 		clearHistory: historyOption,
 		configured: true
@@ -24,14 +24,14 @@ function saveOptions(){
 
 function restoreOptions(){
 	chrome.storage.local.get({
-		subdomainWhitelist: [],
-		domainOnlyWhitelist: [],
+		subDomainWhitelist: [],
+		rootDomainWhitelist: [],
 		clearCache: false,
 		clearHistory: false,
 		configured: false
 	}, function(items){
-		document.getElementById('subdomain-whitelist').value = items.subdomainWhitelist.join("\n");
-		document.getElementById('domain-only-whitelist').value = items.domainOnlyWhitelist.join("\n");
+		document.getElementById('subdomain-whitelist').value = items.subDomainWhitelist.join("\n");
+		document.getElementById('domain-only-whitelist').value = items.rootDomainWhitelist.join("\n");
 		document.getElementById('cache_option').checked = items.clearCache;
 		document.getElementById('history_option').checked = items.clearHistory;
 
diff --git a/manifest.json b/manifest.json
index 7157113..eab2ced 100644
--- a/manifest.json
+++ b/manifest.json
@@ -1,6 +1,6 @@
 {
 	"name": "Startup Cookie Destroyer",
-	"version": "1.0.2",
+	"version": "1.0.3",
 	"manifest_version": 2,
 	"description": "Remove unwanted cookies and site data on startup, and manually from the toolbar.",
 	"background": {
