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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
/*
* Shared functions for tests related to invoking external handler applications.
*/
"use strict";
var EXPORTED_SYMBOLS = ["HandlerServiceTestUtils"];
const { AppConstants } = ChromeUtils.import(
"resource://gre/modules/AppConstants.jsm"
);
const { XPCOMUtils } = ChromeUtils.import(
"resource://gre/modules/XPCOMUtils.jsm"
);
const { Assert } = ChromeUtils.import("resource://testing-common/Assert.jsm");
XPCOMUtils.defineLazyServiceGetter(
this,
"gExternalProtocolService",
"@mozilla.org/uriloader/external-protocol-service;1",
"nsIExternalProtocolService"
);
XPCOMUtils.defineLazyServiceGetter(
this,
"gMIMEService",
"@mozilla.org/mime;1",
"nsIMIMEService"
);
XPCOMUtils.defineLazyServiceGetter(
this,
"gHandlerService",
"@mozilla.org/uriloader/handler-service;1",
"nsIHandlerService"
);
var HandlerServiceTestUtils = {
/**
* Retrieves the names of all the MIME types and protocols configured in the
* handler service instance currently under testing.
*
* @return Array of strings like "example/type" or "example-scheme", sorted
* alphabetically regardless of category.
*/
getAllHandlerInfoTypes() {
return Array.from(gHandlerService.enumerate(), info => info.type).sort();
},
/**
* Retrieves all the configured handlers for MIME types and protocols.
*
* @note The nsIHandlerInfo instances returned by the "enumerate" method
* cannot be used for testing because they incorporate information from
* the operating system and also from the default nsIHandlerService
* instance, independently from what instance is under testing.
*
* @return Array of nsIHandlerInfo instances sorted by their "type" property.
*/
getAllHandlerInfos() {
return this.getAllHandlerInfoTypes().map(type => this.getHandlerInfo(type));
},
/**
* Retrieves an nsIHandlerInfo for the given MIME type or protocol, which
* incorporates information from the operating system and also from the
* handler service instance currently under testing.
*
* @note If the handler service instance currently under testing is not the
* default one and the requested type is a MIME type, the returned
* nsIHandlerInfo will include information from the default
* nsIHandlerService instance. This cannot be avoided easily because the
* getMIMEInfoFromOS method is not exposed to JavaScript.
*
* @param type
* MIME type or scheme name of the nsIHandlerInfo to retrieve.
*
* @return The populated nsIHandlerInfo instance.
*/
getHandlerInfo(type) {
if (type.includes("/")) {
// We have to use the getFromTypeAndExtension method because we don't have
// access to getMIMEInfoFromOS. This means that we have to reset the data
// that may have been imported from the default nsIHandlerService instance
// and is not overwritten by fillHandlerInfo later.
let handlerInfo = gMIMEService.getFromTypeAndExtension(type, null);
if (AppConstants.platform == "android") {
// On Android, the first handler application is always the internal one.
while (handlerInfo.possibleApplicationHandlers.length > 1) {
handlerInfo.possibleApplicationHandlers.removeElementAt(1);
}
} else {
handlerInfo.possibleApplicationHandlers.clear();
}
handlerInfo.setFileExtensions("");
// Populate the object from the handler service instance under testing.
if (gHandlerService.exists(handlerInfo)) {
gHandlerService.fillHandlerInfo(handlerInfo, "");
}
return handlerInfo;
}
// Populate the protocol information from the handler service instance under
// testing, like the nsIExternalProtocolService::GetProtocolHandlerInfo
// method does on the default nsIHandlerService instance.
let osDefaultHandlerFound = {};
let handlerInfo = gExternalProtocolService.getProtocolHandlerInfoFromOS(
type,
osDefaultHandlerFound
);
if (gHandlerService.exists(handlerInfo)) {
gHandlerService.fillHandlerInfo(handlerInfo, "");
} else {
gExternalProtocolService.setProtocolHandlerDefaults(
handlerInfo,
osDefaultHandlerFound.value
);
}
return handlerInfo;
},
/**
* Creates an nsIHandlerInfo for the given MIME type or protocol, initialized
* to the default values for the current platform.
*
* @note For this method to work, the specified MIME type or protocol must not
* be configured in the default handler service instance or the one
* under testing, and must not be registered in the operating system.
*
* @param type
* MIME type or scheme name of the nsIHandlerInfo to create.
*
* @return The blank nsIHandlerInfo instance.
*/
getBlankHandlerInfo(type) {
let handlerInfo = this.getHandlerInfo(type);
let preferredAction, preferredApplicationHandler;
if (AppConstants.platform == "android") {
// On Android, the default preferredAction for MIME types is useHelperApp.
// For protocols, we always behave as if an operating system provided
// handler existed, and as such we initialize them to useSystemDefault.
// This is because the AndroidBridge is not available in xpcshell tests.
preferredAction = type.includes("/")
? Ci.nsIHandlerInfo.useHelperApp
: Ci.nsIHandlerInfo.useSystemDefault;
// On Android, the default handler application is always the internal one.
preferredApplicationHandler = {
name: "Android chooser",
};
} else {
// On Desktop, the default preferredAction for MIME types is saveToDisk,
// while for protocols it is alwaysAsk.
preferredAction = type.includes("/")
? Ci.nsIHandlerInfo.saveToDisk
: Ci.nsIHandlerInfo.alwaysAsk;
preferredApplicationHandler = null;
}
this.assertHandlerInfoMatches(handlerInfo, {
type,
preferredAction,
alwaysAskBeforeHandling: true,
preferredApplicationHandler,
});
return handlerInfo;
},
/**
* Checks whether an nsIHandlerInfo instance matches the provided object.
*/
assertHandlerInfoMatches(handlerInfo, expected) {
let expectedInterface = expected.type.includes("/")
? Ci.nsIMIMEInfo
: Ci.nsIHandlerInfo;
Assert.ok(handlerInfo instanceof expectedInterface);
Assert.equal(handlerInfo.type, expected.type);
if (!expected.preferredActionOSDependent) {
Assert.equal(handlerInfo.preferredAction, expected.preferredAction);
Assert.equal(
handlerInfo.alwaysAskBeforeHandling,
expected.alwaysAskBeforeHandling
);
}
if (expectedInterface == Ci.nsIMIMEInfo) {
let fileExtensionsEnumerator = handlerInfo.getFileExtensions();
for (let expectedFileExtension of expected.fileExtensions || []) {
Assert.equal(fileExtensionsEnumerator.getNext(), expectedFileExtension);
}
Assert.ok(!fileExtensionsEnumerator.hasMore());
}
if (expected.preferredApplicationHandler) {
this.assertHandlerAppMatches(
handlerInfo.preferredApplicationHandler,
expected.preferredApplicationHandler
);
} else {
Assert.equal(handlerInfo.preferredApplicationHandler, null);
}
let handlerAppsArrayEnumerator = handlerInfo.possibleApplicationHandlers.enumerate();
if (AppConstants.platform == "android") {
// On Android, the first handler application is always the internal one.
this.assertHandlerAppMatches(handlerAppsArrayEnumerator.getNext(), {
name: "Android chooser",
});
}
for (let expectedHandlerApp of expected.possibleApplicationHandlers || []) {
this.assertHandlerAppMatches(
handlerAppsArrayEnumerator.getNext(),
expectedHandlerApp
);
}
Assert.ok(!handlerAppsArrayEnumerator.hasMoreElements());
},
/**
* Checks whether an nsIHandlerApp instance matches the provided object.
*/
assertHandlerAppMatches(handlerApp, expected) {
Assert.ok(handlerApp instanceof Ci.nsIHandlerApp);
Assert.equal(handlerApp.name, expected.name);
if (expected.executable) {
Assert.ok(handlerApp instanceof Ci.nsILocalHandlerApp);
Assert.ok(expected.executable.equals(handlerApp.executable));
} else if (expected.uriTemplate) {
Assert.ok(handlerApp instanceof Ci.nsIWebHandlerApp);
Assert.equal(handlerApp.uriTemplate, expected.uriTemplate);
} else if (expected.service) {
Assert.ok(handlerApp instanceof Ci.nsIDBusHandlerApp);
Assert.equal(handlerApp.service, expected.service);
Assert.equal(handlerApp.method, expected.method);
Assert.equal(handlerApp.dBusInterface, expected.dBusInterface);
Assert.equal(handlerApp.objectPath, expected.objectPath);
}
},
};
|
