This repository has been archived by the owner on Feb 26, 2022. It is now read-only.
/
window-utils.js
227 lines (193 loc) · 6.79 KB
/
window-utils.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
/* 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';
module.metadata = {
'stability': 'deprecated'
};
const { Cc, Ci } = require('chrome');
const { EventEmitter } = require('../deprecated/events');
const { Trait } = require('../deprecated/traits');
const { when } = require('../system/unload');
const events = require('../system/events');
const { getInnerId, getOuterId, windows, isDocumentLoaded, isBrowser,
getMostRecentBrowserWindow, getMostRecentWindow } = require('../window/utils');
const errors = require('../deprecated/errors');
const { deprecateFunction } = require('../util/deprecate');
const { ignoreWindow, isGlobalPBSupported } = require('sdk/private-browsing/utils');
const { isPrivateBrowsingSupported } = require('../self');
const windowWatcher = Cc['@mozilla.org/embedcomp/window-watcher;1'].
getService(Ci.nsIWindowWatcher);
const appShellService = Cc['@mozilla.org/appshell/appShellService;1'].
getService(Ci.nsIAppShellService);
// Bug 834961: ignore private windows when they are not supported
function getWindows() windows(null, { includePrivate: isPrivateBrowsingSupported || isGlobalPBSupported });
/**
* An iterator for XUL windows currently in the application.
*
* @return A generator that yields XUL windows exposing the
* nsIDOMWindow interface.
*/
function windowIterator() {
// Bug 752631: We only pass already loaded window in order to avoid
// breaking XUL windows DOM. DOM is broken when some JS code try
// to access DOM during "uninitialized" state of the related document.
let list = getWindows().filter(isDocumentLoaded);
for (let i = 0, l = list.length; i < l; i++) {
yield list[i];
}
};
exports.windowIterator = windowIterator;
/**
* An iterator for browser windows currently open in the application.
* @returns {Function}
* A generator that yields browser windows exposing the `nsIDOMWindow`
* interface.
*/
function browserWindowIterator() {
for each (let window in windowIterator()) {
if (isBrowser(window))
yield window;
}
}
exports.browserWindowIterator = browserWindowIterator;
function WindowTracker(delegate) {
if (!(this instanceof WindowTracker)) {
return new WindowTracker(delegate);
}
this._delegate = delegate;
this._loadingWindows = [];
for each (let window in getWindows())
this._regWindow(window);
windowWatcher.registerNotification(this);
this._onToplevelWindowReady = this._onToplevelWindowReady.bind(this);
events.on('toplevel-window-ready', this._onToplevelWindowReady);
require('../system/unload').ensure(this);
return this;
};
WindowTracker.prototype = {
_regLoadingWindow: function _regLoadingWindow(window) {
// Bug 834961: ignore private windows when they are not supported
if (ignoreWindow(window))
return;
this._loadingWindows.push(window);
window.addEventListener('load', this, true);
},
_unregLoadingWindow: function _unregLoadingWindow(window) {
var index = this._loadingWindows.indexOf(window);
if (index != -1) {
this._loadingWindows.splice(index, 1);
window.removeEventListener('load', this, true);
}
},
_regWindow: function _regWindow(window) {
// Bug 834961: ignore private windows when they are not supported
if (ignoreWindow(window))
return;
if (window.document.readyState == 'complete') {
this._unregLoadingWindow(window);
this._delegate.onTrack(window);
} else
this._regLoadingWindow(window);
},
_unregWindow: function _unregWindow(window) {
if (window.document.readyState == 'complete') {
if (this._delegate.onUntrack)
this._delegate.onUntrack(window);
} else {
this._unregLoadingWindow(window);
}
},
unload: function unload() {
windowWatcher.unregisterNotification(this);
events.off('toplevel-window-ready', this._onToplevelWindowReady);
for each (let window in getWindows())
this._unregWindow(window);
},
handleEvent: errors.catchAndLog(function handleEvent(event) {
if (event.type == 'load' && event.target) {
var window = event.target.defaultView;
if (window)
this._regWindow(window);
}
}),
_onToplevelWindowReady: function _onToplevelWindowReady({subject}) {
let window = subject;
// ignore private windows if they are not supported
if (ignoreWindow(window))
return;
this._regWindow(window);
},
observe: errors.catchAndLog(function observe(subject, topic, data) {
var window = subject.QueryInterface(Ci.nsIDOMWindow);
// ignore private windows if they are not supported
if (ignoreWindow(window))
return;
if (topic == 'domwindowclosed')
this._unregWindow(window);
})
};
exports.WindowTracker = WindowTracker;
const WindowTrackerTrait = Trait.compose({
_onTrack: Trait.required,
_onUntrack: Trait.required,
constructor: function WindowTrackerTrait() {
WindowTracker({
onTrack: this._onTrack.bind(this),
onUntrack: this._onUntrack.bind(this)
});
}
});
exports.WindowTrackerTrait = WindowTrackerTrait;
var gDocsToClose = [];
function onDocUnload(event) {
var index = gDocsToClose.indexOf(event.target);
if (index == -1)
throw new Error('internal error: unloading document not found');
var document = gDocsToClose.splice(index, 1)[0];
// Just in case, let's remove the event listener too.
document.defaultView.removeEventListener('unload', onDocUnload, false);
}
onDocUnload = require('./errors').catchAndLog(onDocUnload);
exports.closeOnUnload = function closeOnUnload(window) {
window.addEventListener('unload', onDocUnload, false);
gDocsToClose.push(window.document);
};
Object.defineProperties(exports, {
activeWindow: {
enumerable: true,
get: function() {
return getMostRecentWindow(null);
},
set: function(window) {
try {
window.focus();
} catch (e) {}
}
},
activeBrowserWindow: {
enumerable: true,
get: getMostRecentBrowserWindow
}
});
/**
* Returns the ID of the window's current inner window.
*/
exports.getInnerId = deprecateFunction(getInnerId,
'require("window-utils").getInnerId is deprecated, ' +
'please use require("window/utils").getInnerId instead'
);
exports.getOuterId = deprecateFunction(getOuterId,
'require("window-utils").getOuterId is deprecated, ' +
'please use require("window/utils").getOuterId instead'
);
exports.isBrowser = deprecateFunction(isBrowser,
'require("window-utils").isBrowser is deprecated, ' +
'please use require("window/utils").isBrowser instead'
);
exports.hiddenWindow = appShellService.hiddenDOMWindow;
when(
function() {
gDocsToClose.slice().forEach(
function(doc) { doc.defaultView.close(); });
});