supporting custom ua string per container

2020-08-04 16:11:00 +02:00 · 2020-08-04 16:11:00 +02:00 · 2a317e5aec
commit 2a317e5aec
parent bf16cb694a
5 changed files with 112 additions and 67 deletions
--- a/extension/common.js
+++ b/extension/common.js
@ -5,8 +5,16 @@

 const cache = {};
 const tabs = {};
-chrome.tabs.onRemoved.addListener(id => delete cache[id]);
-chrome.tabs.onCreated.addListener(tab => tabs[tab.id] = tab.windowId);
+const cookieStoreIds = {};
+chrome.tabs.onRemoved.addListener(id => {
+  delete cache[id];
+  delete tabs[id];
+  delete cookieStoreIds[id];
+});
+chrome.tabs.onCreated.addListener(tab => {
+  tabs[tab.id] = tab.windowId;
+  cookieStoreIds[tab.id] = tab.cookieStoreId;
+});

 const prefs = {
  ua: '',
@ -50,7 +58,10 @@ chrome.storage.local.get(prefs, ps => {
    }
    expand();
    chrome.tabs.query({}, ts => {
-      ts.forEach(t => tabs[t.id] = t.windowId);
+      ts.forEach(t => {
+        tabs[t.id] = t.windowId;
+        cookieStoreIds[t.id] = t.cookieStoreId;
+      });
      ua.update();
    });
  });
@ -84,7 +95,6 @@ chrome.storage.local.get(prefs, ps => {
  }, () => chrome.runtime.lastError);
 });
 chrome.storage.onChanged.addListener(ps => {
-  console.log(ps);
  Object.keys(ps).forEach(key => prefs[key] = ps[key].newValue);
  if (ps.ua || ps.mode) {
    ua.update();
@ -95,17 +105,19 @@ chrome.storage.onChanged.addListener(ps => {
 });

 const ua = {
-  _obj: {
-    'global': {}
-  },
-  diff(tabId) { // returns true if there is per window object
-    log('ua.diff is called', tabId);
+  _obj: {},
+  diff(tabId, cookieStoreId = 'default-container') { // returns true if there is per window object
+    log('ua.diff is called', tabId, cookieStoreId);
    const windowId = tabs[tabId];
-    return windowId in this._obj;
+    return windowId in (this._obj[cookieStoreId] || this._obj['default-container'] || {});
  },
  get windows() {
    log('ua.windows is called');
-    return Object.keys(this._obj).filter(id => id !== 'global').map(s => Number(s));
+    const ids = [];
+    for (const cookieStoreId of Object.keys(this._obj)) {
+      ids.push(...Object.keys(this._obj[cookieStoreId]).filter(id => id !== 'global').map(s => Number(s)));
+    }
+    return ids.filter((n, i, l) => n && l.indexOf(n) === i);
  },
  parse: s => {
    log('ua.parse is called', s);
@ -159,18 +171,23 @@ const ua = {
    }
    return o;
  },
-  object(tabId, windowId) {
-    log('ua.object is called', tabId, windowId);
+  object(tabId, windowId, cookieStoreId = 'default-container') {
    windowId = windowId || (tabId ? tabs[tabId] : 'global');
-    return this._obj[windowId] || this._obj.global;
+    log('ua.object is called', tabId, windowId, cookieStoreId);
+
+    if (this._obj[cookieStoreId]) {
+      return this._obj[cookieStoreId][windowId] || this._obj[cookieStoreId].global || this._obj['default-container'].global;
+    }
+    return (this._obj['default-container'] || {}).global;
  },
-  string(str, windowId) {
+  string(str, windowId, cookieStoreId) {
    log('ua.string is called', str, windowId);
+    this._obj[cookieStoreId] = this._obj[cookieStoreId] || {};
    if (str) {
-      this._obj[windowId] = this.parse(str);
+      this._obj[cookieStoreId][windowId] = this.parse(str);
    }
    else {
-      this._obj[windowId] = {};
+      this._obj[cookieStoreId][windowId] = {};
    }
  },
  tooltip(title, tabId) {
@ -195,7 +212,7 @@ const ua = {
      }
    });
  },
-  toolbar: ({windowId, tabId}) => {
+  toolbar: ({windowId, tabId, cookieStoreId}) => {
    log('ua.toolbar is called', windowId, tabId);
    if (windowId) {
      chrome.tabs.query({
@ -204,20 +221,19 @@ const ua = {
        const tabId = tab.id;
        chrome.browserAction.setBadgeText({
          tabId,
-          text: ua.object(null, windowId).platform.substr(0, 3)
+          text: ua.object(null, windowId, tab.cookieStoreId).platform.substr(0, 3)
        });
      }));
    }
    else if (tabId) {
      chrome.browserAction.setBadgeText({
        tabId,
-        text: ua.object(tabId).platform.substr(0, 3)
+        text: ua.object(tabId, undefined, cookieStoreId).platform.substr(0, 3)
      });
    }
  },
-  update(str = prefs.ua, windowId = 'global') {
-    console.log(str);
-    log('ua.update is called', str, windowId);
+  update(str = prefs.ua, windowId = 'global', cookieStoreId = 'default-container') {
+    log('ua.update is called', str, windowId, cookieStoreId);
    // clear caching
    Object.keys(cache).forEach(key => delete cache[key]);
    // remove old listeners
@ -225,7 +241,7 @@ const ua = {
    chrome.webNavigation.onCommitted.removeListener(onCommitted);
    // apply new ones
    if (str || prefs.mode === 'custom' || this.windows.length) {
-      ua.string(str, windowId);
+      ua.string(str, windowId, cookieStoreId);
      chrome.webRequest.onBeforeSendHeaders.addListener(onBeforeSendHeaders, {
        'urls': ['*://*/*']
      }, ['blocking', 'requestHeaders']);
@ -250,7 +266,11 @@ const ua = {
 window.ua = ua; // using from popup
 // make sure to clean on window removal
 if (chrome.windows) { // FF on Android
-  chrome.windows.onRemoved.addListener(windowId => delete ua._obj[windowId]);
+  chrome.windows.onRemoved.addListener(windowId => {
+    Object.keys(ua._obj).forEach(cookieStoreId => {
+      delete ua._obj[cookieStoreId][windowId];
+    });
+  });
 }

 function hostname(url) {
@ -276,8 +296,8 @@ function hostname(url) {
  }
 }
 // returns true, false or an object; true: ignore, false: use from ua object.
-function match({url, tabId}) {
-  log('match', url, tabId);
+function match({url, tabId, cookieStoreId = 'default-container'}) {
+  log('match', url, tabId, cookieStoreId);
  const h = hostname(url);

  if (prefs.mode === 'blacklist') {
@ -307,7 +327,6 @@ function match({url, tabId}) {
      return true;
    }
  }
-  else {
  const [hh] = h.split(':');
  const key = Object.keys(expand.rules).filter(s => {
    if (s === h || s === hh) {
@ -340,22 +359,25 @@ function match({url, tabId}) {
    return ua.parse(s);
  }
  else {
-      return !ua.object(tabId).userAgent;
-    }
+    const o = ua.object(tabId, undefined, cookieStoreId);
+    return o ? !o.userAgent : true;
  }
 }

-const onBeforeSendHeaders = ({tabId, url, requestHeaders, type}) => {
+const onBeforeSendHeaders = d => {
+  const {tabId, url, requestHeaders, type, cookieStoreId} = d;
  if (type === 'main_frame' || prefs.cache === false) {
-    cache[tabId] = match({url, tabId});
+    cache[tabId] = match({url, tabId, cookieStoreId});
  }
+  console.log(cache[tabId]);
+
  if (cache[tabId] === true) {
    return {};
  }
  if (prefs.protected.some(s => url.indexOf(s) !== -1)) {
    return {};
  }
-  const str = (cache[tabId] || ua.object(tabId)).userAgent;
+  const str = (cache[tabId] || ua.object(tabId, undefined, d.cookieStoreId)).userAgent;
  if (str) {
    for (let i = 0, name = requestHeaders[0].name; i < requestHeaders.length; i += 1, name = (requestHeaders[i] || {}).name) {
      if (name === 'User-Agent' || name === 'user-agent') {
@ -368,12 +390,15 @@ const onBeforeSendHeaders = ({tabId, url, requestHeaders, type}) => {
  }
 };

-const onCommitted = ({frameId, url, tabId}) => {
+const onCommitted = d => {
+  const {frameId, url, tabId} = d;
+  const cookieStoreId = cookieStoreIds[tabId] || 'default-container';
+
  if (url && (url.startsWith('http') || url.startsWith('ftp')) || url === 'about:blank') {
    if (cache[tabId] === true) {
      return;
    }
-    const o = cache[tabId] || ua.object(tabId);
+    const o = cache[tabId] || ua.object(tabId, undefined, cookieStoreId);
    if (o.userAgent) {
      chrome.tabs.executeScript(tabId, {
        runAt: 'document_start',
@ -416,8 +441,8 @@ const onCommitted = ({frameId, url, tabId}) => {
    }
  }
  // change the toolbar icon if there is a per window UA setting
-  if (frameId === 0 && ua.diff(tabId)) {
-    ua.toolbar({tabId});
+  if (frameId === 0 && ua.diff(tabId, cookieStoreId)) {
+    ua.toolbar({tabId, cookieStoreId});
  }
 };
 // context menu
--- a/extension/data/popup/index.css
+++ b/extension/data/popup/index.css
@ -190,6 +190,7 @@ select {
  background-color: #4d72b7;
  color: #fff;
 }
+[data-cmd="container"],
 [data-cmd="window"],
 [data-cmd="apply"] {
  color: #fff;
--- a/extension/data/popup/index.html
+++ b/extension/data/popup/index.html
@ -127,7 +127,7 @@
      <input type="button" value="Refresh Tab" title="Refresh the current page" data-cmd="refresh">
      <input type="button" value="Reset" title="Reset User-Agent string to the default one. This will not reset window-based UA strings. To reset them, use the 'Restart' button" data-cmd="reset">
      <input type="button" value="Test" title="Test your user-agent string" data-cmd="test">
-      <span></span>
+      <input type="button" value="Container" title="Set this string as this container's User-Agent string" data-cmd="container">
      <input type="button" value="Window" title="Set this string as this window's User-Agent string" data-cmd="window">
      <input type="button" value="Apply" title="Set this string as the browser's User-Agent string" data-cmd="apply">
    </div>
--- a/extension/data/popup/index.js
+++ b/extension/data/popup/index.js
@ -237,12 +237,27 @@ document.addEventListener('click', ({target}) => {
        }
      });
    }
-    else if (cmd === 'window') {
+    else if (cmd === 'window' || cmd === 'container') {
      const value = document.getElementById('ua').value;
-      chrome.tabs.query({
+      const next = () => chrome.tabs.query({
        active: true,
        currentWindow: true
-      }, ([tab]) => chrome.runtime.getBackgroundPage(bg => bg.ua.update(value, tab.windowId)));
+      }, ([tab]) => {
+        if (cmd === 'window') {
+          chrome.runtime.getBackgroundPage(bg => bg.ua.update(value, tab.windowId, tab.cookieStoreId));
+        }
+        else {
+          chrome.runtime.getBackgroundPage(bg => bg.ua.update(value, undefined, tab.cookieStoreId));
+        }
+      });
+      if (cmd === 'container') {
+        chrome.permissions.request({
+          permissions: ['cookies']
+        }, granted => granted && next());
+      }
+      else {
+        next();
+      }
    }
    else if (cmd === 'reset') {
      const input = document.querySelector('#list :checked');
--- a/extension/manifest.json
+++ b/extension/manifest.json
@ -13,8 +13,12 @@
    "webNavigation",
    "webRequest",
    "webRequestBlocking",
+    "contextualIdentities",
    "contextMenus"
  ],
+  "optional_permissions": [
+    "cookies"
+  ],

  "icons": {
    "16": "data/icons/active/16.png",