2010-12-27 13:22:47 -08:00
|
|
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
|
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
|
|
|
*
|
|
|
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
|
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
|
|
|
* the License. You may obtain a copy of the License at
|
|
|
|
|
* http://www.mozilla.org/MPL/
|
|
|
|
|
*
|
|
|
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
|
|
|
* for the specific language governing rights and limitations under the
|
|
|
|
|
* License.
|
|
|
|
|
*
|
|
|
|
|
* The Original Code is sessionstore test code.
|
|
|
|
|
*
|
|
|
|
|
* The Initial Developer of the Original Code is
|
|
|
|
|
* Mozilla Foundation.
|
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 2010
|
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
|
|
|
|
*
|
|
|
|
|
* Contributor(s):
|
|
|
|
|
* Paul O’Shannessy <paul@oshannessy.com>
|
|
|
|
|
*
|
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
|
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
|
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
|
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
|
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
|
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
|
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
|
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
|
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
|
|
|
* the provisions above, a recipient may use your version of this file under
|
|
|
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
|
|
|
*
|
|
|
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
|
|
2011-06-25 14:38:31 -07:00
|
|
|
|
let ss = Cc["@mozilla.org/browser/sessionstore;1"].getService(Ci.nsISessionStore);
|
2010-12-27 13:22:47 -08:00
|
|
|
|
|
|
|
|
|
// This assumes that tests will at least have some state/entries
|
|
|
|
|
function waitForBrowserState(aState, aSetStateCallback) {
|
|
|
|
|
let windows = [window];
|
|
|
|
|
let tabsRestored = 0;
|
|
|
|
|
let expectedTabsRestored = 0;
|
|
|
|
|
let expectedWindows = aState.windows.length;
|
|
|
|
|
let windowsOpen = 1;
|
2011-05-11 06:07:20 -07:00
|
|
|
|
let listening = false;
|
|
|
|
|
let windowObserving = false;
|
2011-05-19 15:07:55 -07:00
|
|
|
|
let restoreHiddenTabs = Services.prefs.getBoolPref(
|
|
|
|
|
"browser.sessionstore.restore_hidden_tabs");
|
2010-12-27 13:22:47 -08:00
|
|
|
|
|
2011-05-19 15:07:55 -07:00
|
|
|
|
aState.windows.forEach(function (winState) {
|
|
|
|
|
winState.tabs.forEach(function (tabState) {
|
|
|
|
|
if (restoreHiddenTabs || !tabState.hidden)
|
|
|
|
|
expectedTabsRestored++;
|
|
|
|
|
});
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
// There must be only hidden tabs and restoreHiddenTabs = false. We still
|
|
|
|
|
// expect one of them to be restored because it gets shown automatically.
|
|
|
|
|
if (!expectedTabsRestored)
|
|
|
|
|
expectedTabsRestored = 1;
|
2010-12-27 13:22:47 -08:00
|
|
|
|
|
|
|
|
|
function onSSTabRestored(aEvent) {
|
|
|
|
|
if (++tabsRestored == expectedTabsRestored) {
|
|
|
|
|
// Remove the event listener from each window
|
|
|
|
|
windows.forEach(function(win) {
|
|
|
|
|
win.gBrowser.tabContainer.removeEventListener("SSTabRestored", onSSTabRestored, true);
|
|
|
|
|
});
|
2011-05-11 06:07:20 -07:00
|
|
|
|
listening = false;
|
2010-12-27 13:22:47 -08:00
|
|
|
|
info("running " + aSetStateCallback.name);
|
|
|
|
|
executeSoon(aSetStateCallback);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Used to add our listener to further windows so we can catch SSTabRestored
|
|
|
|
|
// coming from them when creating a multi-window state.
|
|
|
|
|
function windowObserver(aSubject, aTopic, aData) {
|
|
|
|
|
if (aTopic == "domwindowopened") {
|
|
|
|
|
let newWindow = aSubject.QueryInterface(Ci.nsIDOMWindow);
|
|
|
|
|
newWindow.addEventListener("load", function() {
|
|
|
|
|
newWindow.removeEventListener("load", arguments.callee, false);
|
|
|
|
|
|
2011-05-11 06:07:20 -07:00
|
|
|
|
if (++windowsOpen == expectedWindows) {
|
2010-12-27 13:22:47 -08:00
|
|
|
|
Services.ww.unregisterNotification(windowObserver);
|
2011-05-11 06:07:20 -07:00
|
|
|
|
windowObserving = false;
|
|
|
|
|
}
|
2010-12-27 13:22:47 -08:00
|
|
|
|
|
|
|
|
|
// Track this window so we can remove the progress listener later
|
|
|
|
|
windows.push(newWindow);
|
|
|
|
|
// Add the progress listener
|
|
|
|
|
newWindow.gBrowser.tabContainer.addEventListener("SSTabRestored", onSSTabRestored, true);
|
|
|
|
|
}, false);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// We only want to register the notification if we expect more than 1 window
|
2011-05-11 06:07:20 -07:00
|
|
|
|
if (expectedWindows > 1) {
|
|
|
|
|
registerCleanupFunction(function() {
|
|
|
|
|
if (windowObserving) {
|
|
|
|
|
Services.ww.unregisterNotification(windowObserver);
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
windowObserving = true;
|
2010-12-27 13:22:47 -08:00
|
|
|
|
Services.ww.registerNotification(windowObserver);
|
2011-05-11 06:07:20 -07:00
|
|
|
|
}
|
2010-12-27 13:22:47 -08:00
|
|
|
|
|
2011-05-11 06:07:20 -07:00
|
|
|
|
registerCleanupFunction(function() {
|
|
|
|
|
if (listening) {
|
|
|
|
|
windows.forEach(function(win) {
|
|
|
|
|
win.gBrowser.tabContainer.removeEventListener("SSTabRestored", onSSTabRestored, true);
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
});
|
2010-12-27 13:22:47 -08:00
|
|
|
|
// Add the event listener for this window as well.
|
2011-05-11 06:07:20 -07:00
|
|
|
|
listening = true;
|
2010-12-27 13:22:47 -08:00
|
|
|
|
gBrowser.tabContainer.addEventListener("SSTabRestored", onSSTabRestored, true);
|
|
|
|
|
|
|
|
|
|
// Finally, call setBrowserState
|
2011-06-25 14:38:31 -07:00
|
|
|
|
ss.setBrowserState(JSON.stringify(aState));
|
2010-12-27 13:22:47 -08:00
|
|
|
|
}
|
|
|
|
|
|
2011-01-14 18:38:25 -08:00
|
|
|
|
// waitForSaveState waits for a state write but not necessarily for the state to
|
|
|
|
|
// turn dirty.
|
|
|
|
|
function waitForSaveState(aSaveStateCallback) {
|
2011-05-11 06:07:20 -07:00
|
|
|
|
let observing = false;
|
2011-05-16 15:41:28 -07:00
|
|
|
|
let topic = "sessionstore-state-write";
|
|
|
|
|
|
|
|
|
|
let sessionSaveTimeout = 1000 +
|
|
|
|
|
Services.prefs.getIntPref("browser.sessionstore.interval");
|
|
|
|
|
|
2011-05-20 10:12:07 -07:00
|
|
|
|
function removeObserver() {
|
|
|
|
|
if (!observing)
|
|
|
|
|
return;
|
2011-05-16 15:41:28 -07:00
|
|
|
|
Services.obs.removeObserver(observer, topic, false);
|
2011-05-20 10:12:07 -07:00
|
|
|
|
observing = false;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
let timeout = setTimeout(function () {
|
|
|
|
|
removeObserver();
|
2011-05-16 15:41:28 -07:00
|
|
|
|
aSaveStateCallback();
|
|
|
|
|
}, sessionSaveTimeout);
|
|
|
|
|
|
2011-05-11 06:07:20 -07:00
|
|
|
|
function observer(aSubject, aTopic, aData) {
|
2011-05-20 10:12:07 -07:00
|
|
|
|
removeObserver();
|
2011-05-16 15:41:28 -07:00
|
|
|
|
timeout = clearTimeout(timeout);
|
2011-01-14 18:38:25 -08:00
|
|
|
|
executeSoon(aSaveStateCallback);
|
2011-05-11 06:07:20 -07:00
|
|
|
|
}
|
2011-05-16 15:41:28 -07:00
|
|
|
|
|
2011-05-11 06:07:20 -07:00
|
|
|
|
registerCleanupFunction(function() {
|
2011-05-20 10:12:07 -07:00
|
|
|
|
removeObserver();
|
2011-05-16 15:41:28 -07:00
|
|
|
|
if (timeout) {
|
|
|
|
|
clearTimeout(timeout);
|
|
|
|
|
}
|
2011-05-11 06:07:20 -07:00
|
|
|
|
});
|
2011-05-16 15:41:28 -07:00
|
|
|
|
|
2011-05-11 06:07:20 -07:00
|
|
|
|
observing = true;
|
|
|
|
|
Services.obs.addObserver(observer, topic, false);
|
2011-01-14 18:38:25 -08:00
|
|
|
|
};
|
|
|
|
|
|
2011-04-14 07:19:34 -07:00
|
|
|
|
var gUniqueCounter = 0;
|
2010-12-27 13:22:47 -08:00
|
|
|
|
function r() {
|
2011-04-14 07:19:34 -07:00
|
|
|
|
return Date.now() + "-" + (++gUniqueCounter);
|
2010-12-27 13:22:47 -08:00
|
|
|
|
}
|