summaryrefslogtreecommitdiffstats
path: root/application/basilisk/components/sessionstore/SessionStorage.jsm
diff options
context:
space:
mode:
authorwolfbeast <mcwerewolf@gmail.com>2018-06-04 15:50:03 +0200
committerwolfbeast <mcwerewolf@gmail.com>2018-06-04 15:50:03 +0200
commite3b7744bee37c3d4a026d2193bed5e9439c40ff3 (patch)
treef3f7b07ca9bd78bf7ac2d76dd55b61b2a8bb549e /application/basilisk/components/sessionstore/SessionStorage.jsm
parentcbce4f0b6a337f8250b62cae028f1c6d4cce51df (diff)
parent031afcafe288bf0f46c0c5caae20dd3db8bd0297 (diff)
downloadUXP-e3b7744bee37c3d4a026d2193bed5e9439c40ff3.tar
UXP-e3b7744bee37c3d4a026d2193bed5e9439c40ff3.tar.gz
UXP-e3b7744bee37c3d4a026d2193bed5e9439c40ff3.tar.lz
UXP-e3b7744bee37c3d4a026d2193bed5e9439c40ff3.tar.xz
UXP-e3b7744bee37c3d4a026d2193bed5e9439c40ff3.zip
Merge branch 'move-basilisk'
Diffstat (limited to 'application/basilisk/components/sessionstore/SessionStorage.jsm')
-rw-r--r--application/basilisk/components/sessionstore/SessionStorage.jsm173
1 files changed, 173 insertions, 0 deletions
diff --git a/application/basilisk/components/sessionstore/SessionStorage.jsm b/application/basilisk/components/sessionstore/SessionStorage.jsm
new file mode 100644
index 000000000..705139ebf
--- /dev/null
+++ b/application/basilisk/components/sessionstore/SessionStorage.jsm
@@ -0,0 +1,173 @@
+/* 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 = ["SessionStorage"];
+
+const Cu = Components.utils;
+const Ci = Components.interfaces;
+
+Cu.import("resource://gre/modules/Services.jsm");
+Cu.import("resource://gre/modules/XPCOMUtils.jsm");
+
+XPCOMUtils.defineLazyModuleGetter(this, "console",
+ "resource://gre/modules/Console.jsm");
+
+// Returns the principal for a given |frame| contained in a given |docShell|.
+function getPrincipalForFrame(docShell, frame) {
+ let ssm = Services.scriptSecurityManager;
+ let uri = frame.document.documentURIObject;
+ return ssm.getDocShellCodebasePrincipal(uri, docShell);
+}
+
+this.SessionStorage = Object.freeze({
+ /**
+ * Updates all sessionStorage "super cookies"
+ * @param docShell
+ * That tab's docshell (containing the sessionStorage)
+ * @param frameTree
+ * The docShell's FrameTree instance.
+ * @return Returns a nested object that will have hosts as keys and per-host
+ * session storage data as strings. For example:
+ * {"example.com": {"key": "value", "my_number": "123"}}
+ */
+ collect: function (docShell, frameTree) {
+ return SessionStorageInternal.collect(docShell, frameTree);
+ },
+
+ /**
+ * Restores all sessionStorage "super cookies".
+ * @param aDocShell
+ * A tab's docshell (containing the sessionStorage)
+ * @param aStorageData
+ * A nested object with storage data to be restored that has hosts as
+ * keys and per-host session storage data as strings. For example:
+ * {"example.com": {"key": "value", "my_number": "123"}}
+ */
+ restore: function (aDocShell, aStorageData) {
+ SessionStorageInternal.restore(aDocShell, aStorageData);
+ },
+});
+
+var SessionStorageInternal = {
+ /**
+ * Reads all session storage data from the given docShell.
+ * @param docShell
+ * A tab's docshell (containing the sessionStorage)
+ * @param frameTree
+ * The docShell's FrameTree instance.
+ * @return Returns a nested object that will have hosts as keys and per-host
+ * session storage data as strings. For example:
+ * {"example.com": {"key": "value", "my_number": "123"}}
+ */
+ collect: function (docShell, frameTree) {
+ let data = {};
+ let visitedOrigins = new Set();
+
+ frameTree.forEach(frame => {
+ let principal = getPrincipalForFrame(docShell, frame);
+ if (!principal) {
+ return;
+ }
+
+ // Get the origin of the current history entry
+ // and use that as a key for the per-principal storage data.
+ let origin = principal.origin;
+ if (visitedOrigins.has(origin)) {
+ // Don't read a host twice.
+ return;
+ }
+
+ // Mark the current origin as visited.
+ visitedOrigins.add(origin);
+
+ let originData = this._readEntry(principal, docShell);
+ if (Object.keys(originData).length) {
+ data[origin] = originData;
+ }
+ });
+
+ return Object.keys(data).length ? data : null;
+ },
+
+ /**
+ * Writes session storage data to the given tab.
+ * @param aDocShell
+ * A tab's docshell (containing the sessionStorage)
+ * @param aStorageData
+ * A nested object with storage data to be restored that has hosts as
+ * keys and per-host session storage data as strings. For example:
+ * {"example.com": {"key": "value", "my_number": "123"}}
+ */
+ restore: function (aDocShell, aStorageData) {
+ for (let origin of Object.keys(aStorageData)) {
+ let data = aStorageData[origin];
+
+ let principal;
+
+ try {
+ let attrs = aDocShell.getOriginAttributes();
+ let originURI = Services.io.newURI(origin, null, null);
+ principal = Services.scriptSecurityManager.createCodebasePrincipal(originURI, attrs);
+ } catch (e) {
+ console.error(e);
+ continue;
+ }
+
+ let storageManager = aDocShell.QueryInterface(Ci.nsIDOMStorageManager);
+ let window = aDocShell.QueryInterface(Ci.nsIInterfaceRequestor).getInterface(Ci.nsIDOMWindow);
+
+ // There is no need to pass documentURI, it's only used to fill documentURI property of
+ // domstorage event, which in this case has no consumer. Prevention of events in case
+ // of missing documentURI will be solved in a followup bug to bug 600307.
+ let storage = storageManager.createStorage(window, principal, "", aDocShell.usePrivateBrowsing);
+
+ for (let key of Object.keys(data)) {
+ try {
+ storage.setItem(key, data[key]);
+ } catch (e) {
+ // throws e.g. for URIs that can't have sessionStorage
+ console.error(e);
+ }
+ }
+ }
+ },
+
+ /**
+ * Reads an entry in the session storage data contained in a tab's history.
+ * @param aURI
+ * That history entry uri
+ * @param aDocShell
+ * A tab's docshell (containing the sessionStorage)
+ */
+ _readEntry: function (aPrincipal, aDocShell) {
+ let hostData = {};
+ let storage;
+
+ let window = aDocShell.QueryInterface(Ci.nsIInterfaceRequestor).getInterface(Ci.nsIDOMWindow);
+
+ try {
+ let storageManager = aDocShell.QueryInterface(Ci.nsIDOMStorageManager);
+ storage = storageManager.getStorage(window, aPrincipal);
+ storage.length; // XXX: Bug 1232955 - storage.length can throw, catch that failure
+ } catch (e) {
+ // sessionStorage might throw if it's turned off, see bug 458954
+ storage = null;
+ }
+
+ if (storage && storage.length) {
+ for (let i = 0; i < storage.length; i++) {
+ try {
+ let key = storage.key(i);
+ hostData[key] = storage.getItem(key);
+ } catch (e) {
+ // This currently throws for secured items (cf. bug 442048).
+ }
+ }
+ }
+
+ return hostData;
+ }
+};