Issue #303 Part 1: Move basilisk files from /browser to /application/basilisk

1 files changed, 74 insertions, 0 deletions

diff --git a/application/basilisk/components/sessionstore/TabAttributes.jsm b/application/basilisk/components/sessionstore/TabAttributes.jsm
new file mode 100644
index 000000000..8a29680f4
--- /dev/null
+++ b/application/basilisk/components/sessionstore/TabAttributes.jsm
@@ -0,0 +1,74 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+"use strict";
+
+this.EXPORTED_SYMBOLS = ["TabAttributes"];
+
+// We never want to directly read or write these attributes.
+// 'image' should not be accessed directly but handled by using the
+//         gBrowser.getIcon()/setIcon() methods.
+// 'muted' should not be accessed directly but handled by using the
+//         tab.linkedBrowser.audioMuted/toggleMuteAudio methods.
+// 'pending' is used internal by sessionstore and managed accordingly.
+// 'iconLoadingPrincipal' is same as 'image' that it should be handled by
+//                        using the gBrowser.getIcon()/setIcon() methods.
+const ATTRIBUTES_TO_SKIP = new Set(["image", "muted", "pending", "iconLoadingPrincipal"]);
+
+// A set of tab attributes to persist. We will read a given list of tab
+// attributes when collecting tab data and will re-set those attributes when
+// the given tab data is restored to a new tab.
+this.TabAttributes = Object.freeze({
+  persist: function (name) {
+    return TabAttributesInternal.persist(name);
+  },
+
+  get: function (tab) {
+    return TabAttributesInternal.get(tab);
+  },
+
+  set: function (tab, data = {}) {
+    TabAttributesInternal.set(tab, data);
+  }
+});
+
+var TabAttributesInternal = {
+  _attrs: new Set(),
+
+  persist: function (name) {
+    if (this._attrs.has(name) || ATTRIBUTES_TO_SKIP.has(name)) {
+      return false;
+    }
+
+    this._attrs.add(name);
+    return true;
+  },
+
+  get: function (tab) {
+    let data = {};
+
+    for (let name of this._attrs) {
+      if (tab.hasAttribute(name)) {
+        data[name] = tab.getAttribute(name);
+      }
+    }
+
+    return data;
+  },
+
+  set: function (tab, data = {}) {
+    // Clear attributes.
+    for (let name of this._attrs) {
+      tab.removeAttribute(name);
+    }
+
+    // Set attributes.
+    for (let name in data) {
+      if (!ATTRIBUTES_TO_SKIP.has(name)) {
+        tab.setAttribute(name, data[name]);
+      }
+    }
+  }
+};
+