Cookie whitelist (#31)

* added whitelist to cookie deletion logic on startup

removed standard cookie deletion and replaced it with a loop deleting all cookies not found in whitelist
storage of list and UI still needed

* added cookieWhitelist for getting and setting whitelist

* added button to add cookiedomain + name to whitelist
added image to represent whitelist button
add update whitelist with cookiedomain
change delete info to detect whitelisted cookies properly
TODO: fix button styling
TODO: fix button if whitelisted
TODO: remove from whitelist if clicked on button of whitelisted cookie-whitelist
TODO: don't place duplicate whitelist items
TODO: make whitelist a dictionary instead of an array

* implement feedback
making whitelist into a dict
removing item from whitelist if clicked on button of whitelisted item
changing location of cookie deletion on startup (not only deleted if delete all option is set)

* fixing setting cookiewhitelist dict on startup
refactoring code to extract cookiedeletion to separate function
fixing dictionary handling in deletecookie method
rewriting whitelist to cookie comparison logic
making logic more compact

* updated code to reuse the delete cookie logic on cookie tab

* allowing whitelisting of domains

fixing logic that removes item from whitelist
updating code to use includes instead of indexOf >=0
replace regex dot removal with function

* fixup! added whitelist to cookie deletion logic on startup

* fixup! fixing setting cookiewhitelist dict on startup refactoring code to extract cookiedeletion to separate function fixing dictionary handling in deletecookie method rewriting whitelist to cookie comparison logic making logic more compact

* improved code based on feedback
changed structure of cookiewhitelist
adapted whitelisting and deleting logic accordingly

* update UI to update whitelist code for both domain and sublist cookies

* update whitelist ckeckbox for subitems
adding logic to update whitelist checkboxes on tab load and on domain cookie load

* added validation before updating sublist items
fixing buttons to image in view instead of using switches
updating css to fix scaling of buttons

* moved check for new whitelist data outside of the updateWhitelistInList method
cleaned up calls to updateWhitelistInList

* filter out unchanged domains and cookies from whitelist before modifying tree

* moved filtering of cookiewhitelistchanges out of updateWhitelistInList logic
fixed up code
updated getcookies to only update whitelist status for that domain

* fix issue deleting whitelist
fix error on opening cookies from domain without data in whitelist

* adding message for whitelist buttons
adding data-i18n to button

* reducing complexity of method checking changes in whitelist

* fix spaces and whitelist icon size

* fixing title message displayed when hovering over whitelist button

* update version in manifest

* adding constant for whitelistbutton titles and added comment for createDomainObj

Author: Jeroen Evens

_locales/en_US/messages.json

@@ -355,6 +355,14 @@
     "description": "text in Cookies 'delete all' dialog",
     "message": "You are about to delete all cookies, are you sure ?"
   },
+  "whitelistCookieDomain": {
+    "description": "text when hovering over Whitelist button for Cookie Domain",
+    "message": "This button adds all cookies from a domain to a Whitelist, preventing them from being automatically deleted, usefull if you want to stay logged in to some websites but still want all other cookies to be deleted"
+  },
+  "whitelistSublistCookie": {
+    "description": "text when hovering over Whitelist button for Sublist Cookies",
+    "message": "This button adds a specific cookie to a Whitelist, preventing them from being automatically deleted, usefull if you want to stay logged in to some websites but still want all other cookies to be deleted"
+  },
   "additionalPermissions": {
     "description": "Label for requesting additional permission setting",
     "message": "Additional permissions"

css/img/check-mark-circle.svg

@@ -288,6 +288,10 @@ button[role="checkbox"][aria-checked="true"] > span:last-child
 #dialog[data-dialog="cookie-edit"] #dialog-content-cookie-form,
 #dialog[data-dialog="cookies-delete-all"] #dialog-content-cookie-delete-all,
 #dialog[data-dialog="setting-info"] #dialog-content-setting-info
+{
+  display: block;
+}#dialog[data-dialog="cookies-delete-all"] #dialog-content-cookie-delete-all,
+#dialog[data-dialog="setting-info"] #dialog-content-setting-info
 {
   display: block;
 }
@@ -527,6 +531,34 @@ button.icon.edit:after
   background-image: url(/css/img/edit.svg);
 }
 
+.tableList > li > div .icon.whitelist::after
+{
+  background-image: url(/css/img/check-mark-circle.svg);
+  background-size: 100%;
+  background-repeat: no-repeat;
+}
+
+.tableList li > ul li > div .icon.whitelist::after
+{
+  background-image: url(/css/img/check-mark-circle.svg);
+  background-size: 100%;
+  background-repeat: no-repeat;
+}
+
+.tableList > li[data-whitelist="true"] > div .icon.whitelist::after
+{
+  background-image: url(/css/img/check-mark-filled.svg);
+  background-size: 100%;
+  background-repeat: no-repeat;
+}
+
+.tableList li > ul li[data-whitelist="true"] > div .icon.whitelist::after
+{
+  background-image: url(/css/img/check-mark-filled.svg);
+  background-size: 100%;
+  background-repeat: no-repeat;
+}
+
 button.icon.edit:hover:after
 {
   background-image: url(/css/img/edit-hover.svg);

css/img/check-mark-filled.svg

@@ -23,16 +23,22 @@
   global.collectedRequests = [];
   const requestCollectionLength = 500;
 
-  function profileStart()
-  {
-    getStorage("settingList", function(data)
+  function profileStart() {
+    getStorage("cookieWhitelist", function (data) 
+    {
+      if (!data || !data.cookieWhitelist) 
+      {
+        setStorage({"cookieWhitelist": {} })
+      }
+    })
+    getStorage("settingList", function (data) 
     {
       deleteBrowsingData(data.settingList);
     });
   }
 
   //TODO: Find a solution to avoide duplication
-  getStorage("settingList", function(data)
+  getStorage("settingList", function (data) 
   {
     if (data.settingList && data.settingList.collectHeaders)
       startCollectingRequests();
@@ -41,90 +47,98 @@
       addBlockAgentListener();
   });
 
-  function deleteBrowsingData(data)
+  function deleteBrowsingData(data) 
   {
     if (!data)
       return;
 
     // Filter "data" object to only match properties from "browsingData".
-    var browsingDataObj = Object.keys(data).filter(function(key)
+    var browsingDataObj = Object.keys(data).filter(function (key) 
     {
       return browsingData.includes(key);
-    }).reduce(function(accumulator, dataType)
+    }).reduce(function (accumulator, dataType) 
     {
       accumulator[dataType] = data[dataType];
       return accumulator;
     }, {});
 
-    if (browsingDataObj.removeAll == true)
+    if (browsingDataObj.removeAll == true) 
     {
-      var browsingDataObj = browsingData.reduce(function(accumulator, dataType)
+      var browsingDataObj = browsingData.reduce(function (accumulator, dataType) 
       {
         if (dataType != "removeAll")
           accumulator[dataType] = true;
 
         return accumulator;
       }, {});
+      
+      if (browsingDataObj.cookies) 
+      {
+        deleteCookies()
+      }
+      browsingDataObj.cookies = false;
       chrome.browsingData.remove({}, browsingDataObj);
     }
-    else
-    {
-      delete browsingDataObj.removeAll;
+    else {
+      if (browsingDataObj.cookies) 
+      {
+        deleteCookies()
+      }
+      browsingDataObj.cookies = false;
       chrome.browsingData.remove({}, browsingDataObj);
     }
   }
 
-  global.startCollectingRequests = function()
+  global.startCollectingRequests = function () 
   {
     addRequestListener(onSendHeaders, onHeadersReceived);
   };
 
-  global.stopCollectingRequests = function()
+  global.stopCollectingRequests = function () 
   {
     removeRequestListener(onSendHeaders, onHeadersReceived);
   };
 
-  function onSendHeaders(details)
+  function onSendHeaders(details) 
   {
     updateRequestObj(details, "send");
     addToRequestArray(details);
   }
 
-  function onHeadersReceived(details)
+  function onHeadersReceived(details) 
   {
     updateRequestObj(details, "receive");
     addToRequestArray(details);
   }
 
-  function addToRequestArray(details)
+  function addToRequestArray(details) 
   {
-    if(collectedRequests.length > requestCollectionLength)
+    if (collectedRequests.length > requestCollectionLength)
       collectedRequests.shift();
 
     collectedRequests.push(details);
   }
 
-  chrome.storage.onChanged.addListener(function(change)
+  chrome.storage.onChanged.addListener(function (change) 
   {
-    if (change.settingList)
-    {
-      chrome.permissions.contains(additionalPermission, function(result)
+    if (change.settingList) {
+      chrome.permissions.contains(additionalPermission, function (result) 
       {
         var newValue = change.settingList.newValue.collectHeaders;
         var oldValue = change.settingList.oldValue;
-        if (oldValue && newValue != oldValue.collectHeaders)
+        if (oldValue && newValue != oldValue.collectHeaders) 
         {
-          if(result && newValue)
+          if (result && newValue)
             startCollectingRequests();
           else
             stopCollectingRequests();
         }
 
         var newValue = change.settingList.newValue.blockUserAgent;
         var oldValue = change.settingList.oldValue;
-        if (oldValue && newValue != oldValue.blockUserAgent)
+        if (oldValue && newValue != oldValue.blockUserAgent) 
         {
-          if(result && newValue)
+          if (result && newValue)
             addBlockAgentListener();
           else
             removeBlockAgentListener();
@@ -133,12 +147,13 @@
     }
   });
 
-  chrome.permissions.onRemoved.addListener(function(result)
-  {
+  chrome.permissions.onRemoved.addListener(function (result)
+   {
     removeBlockAgentListener();
     removeRequestListener(onSendHeaders, onHeadersReceived);
   });
 
   // Fired on a profile start up
+  chrome.runtime.onInstalled.addListener(profileStart);
   chrome.runtime.onStartup.addListener(profileStart);
 })(this);

css/main.css

@@ -26,6 +26,8 @@ const browsingData = ["removeAll", "appcache", "cache", "cookies", "downloads",
                       "fileSystems", "formData", "history", "indexedDB", 
                       "localStorage", "serverBoundCertificates", "passwords", 
                       "pluginData", "serviceWorkers", "webSQL"];
+const getAllCookies = chrome.cookies.getAll;
+const removeCookie = chrome.cookies.remove;
 
 function getStorage(keys, callback)
 {
@@ -38,6 +40,10 @@ function setStorage(items, callback)
   chrome.storage.local.set(items, callback);
 }
 
+function getUrl(domain, path, isSecure)
+{
+  return "http" + (isSecure ? "s" : "") + "://" + domain + path;
+}
 function addRequestListener(onSendHeadersCallback, onHeadersReceivedCallback)
 {
   chrome.webRequest.onSendHeaders.addListener(onSendHeadersCallback, 
@@ -84,3 +90,31 @@ function blockUserAgent(details)
   }
   return {requestHeaders: details.requestHeaders};
 }
+
+function removeStartDot(string)
+{
+  return string.replace(/^\./, "");
+}
+
+function deleteCookies() 
+{
+  // delete cookies here + ignore whitelisted cookies
+  getStorage("cookieWhitelist", function (data) 
+  {
+    let domainList = data.cookieWhitelist
+    getAllCookies({}, function (cookies) 
+    {
+      let callbackCount = 0;
+      for (let cookie of cookies) 
+      {
+        let url = getUrl(cookie.domain, cookie.path, cookie.secure);
+        // replace leading dots sometimes present in cookie domains
+        let domainWhitelist = domainList[removeStartDot(cookie.domain)]
+        if (!domainWhitelist || (!domainWhitelist.cookies.includes(cookie.name) && !domainWhitelist.domainWhitelist)) 
+        {
+          removeCookie({ "url": url, "name": cookie.name });
+        }
+      }
+    });
+  });
+}

js/back.js

@@ -709,6 +709,13 @@ TableList.prototype._updateListElem = function(itemObj, listElem)
     if (textElement)
       textElement.textContent = textsObj[name];
   }
+  var titleObjs = itemObj.titles;
+  for (var title in titleObjs)
+  {
+    var titleElement = listElem.querySelector("[data-text='"+ title +"']");
+    if (titleElement)
+      titleElement.title = titleObjs[title];
+  }
 
   // Set default tabindex to the first list Element
   if (this.listElem.childElementCount == 0)