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
|
/* -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim:set ts=2 sw=2 sts=2 et: */
/* ***** 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 Jetpack.
*
* The Initial Developer of the Original Code is
* the Mozilla Foundation.
* Portions created by the Initial Developer are Copyright (C) 2010
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Felipe Gomes <felipc@gmail.com> (Original Author)
* Myk Melez <myk@mozilla.org>
*
* 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 ***** */
"use strict";
const {Cc, Ci} = require("chrome");
const errors = require("./errors");
const apiUtils = require("./api-utils");
const timer = require("./timer");
const XUL_NS = "http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul";
let hostFrame, hostDocument, hiddenWindow, isHostFrameReady = false;
if (!require("./xul-app").isOneOf(["Firefox", "Thunderbird"])) {
throw new Error([
"The hidden-frame module currently supports only Firefox and Thunderbird. ",
"In the future, we would like it to support other applications, however. ",
"Please see https://bugzilla.mozilla.org/show_bug.cgi?id=546740 for more ",
"information."
].join(""));
}
let appShellService = Cc["@mozilla.org/appshell/appShellService;1"].
getService(Ci.nsIAppShellService);
hiddenWindow = appShellService.hiddenDOMWindow;
if (!hiddenWindow) {
throw new Error([
"The hidden-frame module needs an app that supports a hidden window. ",
"We would like it to support other applications, however. Please see ",
"https://bugzilla.mozilla.org/show_bug.cgi?id=546740 for more information."
].join(""));
}
// Check if we can use the hidden window itself to host our iframes.
// If it's not a suitable host, the hostFrame will be lazily created
// by the first HiddenFrame instance.
if (hiddenWindow.location.protocol == "chrome:" &&
(hiddenWindow.document.contentType == "application/vnd.mozilla.xul+xml" ||
hiddenWindow.document.contentType == "application/xhtml+xml")) {
hostFrame = hiddenWindow;
hostDocument = hiddenWindow.document;
isHostFrameReady = true;
}
function setHostFrameReady() {
hostDocument = hostFrame.contentDocument;
hostFrame.removeEventListener("DOMContentLoaded", setHostFrameReady, false);
isHostFrameReady = true;
}
// This cache is used to access friend properties between functions
// without exposing them on the public API.
let cache = [];
exports.HiddenFrame = apiUtils.publicConstructor(HiddenFrame);
function HiddenFrame(options) {
options = options || {};
let self = this;
for each (let [key, val] in Iterator(apiUtils.validateOptions(options, {
onReady: {
is: ["undefined", "function", "array"],
ok: function(v) {
if (apiUtils.getTypeOf(v) === "array") {
// make sure every item is a function
return v.every(function (item) typeof(item) === "function")
}
return true;
}
}
}))) {
if (typeof(val) != "undefined")
options[key] = val;
}
require("./collection").addCollectionProperty(this, "onReady");
if (options.onReady)
this.onReady.add(options.onReady);
if (!hostFrame) {
hostFrame = hiddenWindow.document.createElement("iframe");
// ugly ugly hack. This is the most lightweight chrome:// file I could find on the tree
// This hack should be removed by proper platform support on bug 565388
hostFrame.setAttribute("src", "chrome://global/content/mozilla.xhtml");
hostFrame.addEventListener("DOMContentLoaded", setHostFrameReady, false);
hiddenWindow.document.body.appendChild(hostFrame);
}
this.toString = function toString() "[object Frame]";
}
exports.add = function JP_SDK_Frame_add(frame) {
if (!(frame instanceof HiddenFrame))
throw new Error("The object to be added must be a HiddenFrame.");
// This instance was already added.
if (cache.filter(function (v) v.frame === frame)[0])
return frame;
function createElement() {
hostFrame.removeEventListener("DOMContentLoaded", createElement, false);
let element = hostDocument.createElementNS(XUL_NS, "iframe");
element.setAttribute("type", "content");
hostDocument.documentElement.appendChild(element);
/* Public API: hiddenFrame.element */
frame.__defineGetter__("element", function () element);
// Notify consumers that the frame is ready.
function onReadyListener(event) {
element.removeEventListener("DOMContentLoaded", onReadyListener, false);
if (event.target == element.contentDocument) {
for (let handler in frame.onReady)
errors.catchAndLog(function () handler.call(frame))();
}
}
element.addEventListener("DOMContentLoaded", onReadyListener, false);
cache.push({
frame: frame,
element: element,
unload: function unload() {
hostDocument.documentElement.removeChild(element);
}
});
}
/* Begin element construction or schedule it for later */
if (isHostFrameReady) {
createElement();
} else {
hostFrame.addEventListener("DOMContentLoaded", createElement, false);
}
return frame;
}
exports.remove = function remove(frame) {
if (!(frame instanceof HiddenFrame))
throw new Error("The object to be removed must be a HiddenFrame.");
let entry = cache.filter(function (v) v.frame === frame)[0];
if (!entry)
return;
entry.unload();
cache.splice(cache.indexOf(entry), 1);
}
require("./unload").when(function () {
for each (let entry in cache.slice())
exports.remove(entry.frame);
if (hostFrame && hostFrame !== hiddenWindow)
hiddenWindow.document.body.removeChild(hostFrame);
});
|
