-
Notifications
You must be signed in to change notification settings - Fork 54
/
SpecialPowersAPI.jsm
2050 lines (1816 loc) · 58.6 KB
/
SpecialPowersAPI.jsm
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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* 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/. */
/* This code is loaded in every child process that is started by mochitest in
* order to be used as a replacement for UniversalXPConnect
*/
"use strict";
var EXPORTED_SYMBOLS = ["SpecialPowersAPI", "bindDOMWindowUtils"];
var { Services } = ChromeUtils.import("resource://gre/modules/Services.jsm");
ChromeUtils.defineModuleGetter(
this,
"MockFilePicker",
"resource://specialpowers/MockFilePicker.jsm"
);
ChromeUtils.defineModuleGetter(
this,
"MockColorPicker",
"resource://specialpowers/MockColorPicker.jsm"
);
ChromeUtils.defineModuleGetter(
this,
"MockPermissionPrompt",
"resource://specialpowers/MockPermissionPrompt.jsm"
);
ChromeUtils.defineModuleGetter(
this,
"SpecialPowersSandbox",
"resource://specialpowers/SpecialPowersSandbox.jsm"
);
ChromeUtils.defineModuleGetter(
this,
"WrapPrivileged",
"resource://specialpowers/WrapPrivileged.jsm"
);
ChromeUtils.defineModuleGetter(
this,
"PrivateBrowsingUtils",
"resource://gre/modules/PrivateBrowsingUtils.jsm"
);
ChromeUtils.defineModuleGetter(
this,
"NetUtil",
"resource://gre/modules/NetUtil.jsm"
);
ChromeUtils.defineModuleGetter(
this,
"AppConstants",
"resource://gre/modules/AppConstants.jsm"
);
ChromeUtils.defineModuleGetter(
this,
"PerTestCoverageUtils",
"resource://testing-common/PerTestCoverageUtils.jsm"
);
// Allow stuff from this scope to be accessed from non-privileged scopes. This
// would crash if used outside of automation.
Cu.forcePermissiveCOWs();
function bindDOMWindowUtils(aWindow) {
return aWindow && WrapPrivileged.wrap(aWindow.windowUtils);
}
// SPConsoleListener reflects nsIConsoleMessage objects into JS in a
// tidy, XPCOM-hiding way. Messages that are nsIScriptError objects
// have their properties exposed in detail. It also auto-unregisters
// itself when it receives a "sentinel" message.
function SPConsoleListener(callback) {
this.callback = callback;
}
SPConsoleListener.prototype = {
// Overload the observe method for both nsIConsoleListener and nsIObserver.
// The topic will be null for nsIConsoleListener.
observe(msg, topic) {
let m = {
message: msg.message,
errorMessage: null,
cssSelectors: null,
sourceName: null,
sourceLine: null,
lineNumber: null,
columnNumber: null,
category: null,
windowID: null,
isScriptError: false,
isConsoleEvent: false,
isWarning: false,
isException: false,
isStrict: false,
};
if (msg instanceof Ci.nsIScriptError) {
m.errorMessage = msg.errorMessage;
m.cssSelectors = msg.cssSelectors;
m.sourceName = msg.sourceName;
m.sourceLine = msg.sourceLine;
m.lineNumber = msg.lineNumber;
m.columnNumber = msg.columnNumber;
m.category = msg.category;
m.windowID = msg.outerWindowID;
m.innerWindowID = msg.innerWindowID;
m.isScriptError = true;
m.isWarning = (msg.flags & Ci.nsIScriptError.warningFlag) === 1;
m.isException = (msg.flags & Ci.nsIScriptError.exceptionFlag) === 1;
m.isStrict = (msg.flags & Ci.nsIScriptError.strictFlag) === 1;
} else if (topic === "console-api-log-event") {
// This is a dom/console event.
let unwrapped = msg.wrappedJSObject;
m.errorMessage = unwrapped.arguments[0];
m.sourceName = unwrapped.filename;
m.lineNumber = unwrapped.lineNumber;
m.columnNumber = unwrapped.columnNumber;
m.windowID = unwrapped.ID;
m.innerWindowID = unwrapped.innerID;
m.isConsoleEvent = true;
m.isWarning = unwrapped.level === "warning";
}
Object.freeze(m);
// Run in a separate runnable since console listeners aren't
// supposed to touch content and this one might.
Services.tm.dispatchToMainThread(() => {
this.callback.call(undefined, m);
});
if (!m.isScriptError && !m.isConsoleEvent && m.message === "SENTINEL") {
Services.obs.removeObserver(this, "console-api-log-event");
Services.console.unregisterListener(this);
}
},
QueryInterface: ChromeUtils.generateQI([
Ci.nsIConsoleListener,
Ci.nsIObserver,
]),
};
class SpecialPowersAPI extends JSWindowActorChild {
constructor() {
super();
this._consoleListeners = [];
this._encounteredCrashDumpFiles = [];
this._unexpectedCrashDumpFiles = {};
this._crashDumpDir = null;
this._mfl = null;
this._applyingPermissions = false;
this._observingPermissions = false;
this._asyncObservers = new WeakMap();
this._xpcomabi = null;
this._os = null;
this._pu = null;
this._nextExtensionID = 0;
this._extensionListeners = null;
}
receiveMessage(message) {
switch (message.name) {
case "Assert":
{
// An assertion has been done in a mochitest chrome script
let { name, passed, stack, diag } = message.data;
let SimpleTest =
this.contentWindow && this.contentWindow.wrappedJSObject.SimpleTest;
if (SimpleTest) {
SimpleTest.record(
passed,
name,
diag,
stack && stack.formattedStack
);
} else {
// Well, this is unexpected.
dump(name + "\n");
}
}
break;
}
return undefined;
}
/*
* Privileged object wrapping API
*
* Usage:
* var wrapper = SpecialPowers.wrap(obj);
* wrapper.privilegedMethod(); wrapper.privilegedProperty;
* obj === SpecialPowers.unwrap(wrapper);
*
* These functions provide transparent access to privileged objects using
* various pieces of deep SpiderMagic. Conceptually, a wrapper is just an
* object containing a reference to the underlying object, where all method
* calls and property accesses are transparently performed with the System
* Principal. Moreover, objects obtained from the wrapper (including properties
* and method return values) are wrapped automatically. Thus, after a single
* call to SpecialPowers.wrap(), the wrapper layer is transitively maintained.
*
* Known Issues:
*
* - The wrapping function does not preserve identity, so
* SpecialPowers.wrap(foo) !== SpecialPowers.wrap(foo). See bug 718543.
*
* - The wrapper cannot see expando properties on unprivileged DOM objects.
* That is to say, the wrapper uses Xray delegation.
*
* - The wrapper sometimes guesses certain ES5 attributes for returned
* properties. This is explained in a comment in the wrapper code above,
* and shouldn't be a problem.
*/
wrap(obj) {
return WrapPrivileged.wrap(obj);
}
unwrap(obj) {
return WrapPrivileged.unwrap(obj);
}
isWrapper(val) {
return WrapPrivileged.isWrapper(val);
}
/*
* When content needs to pass a callback or a callback object to an API
* accessed over SpecialPowers, that API may sometimes receive arguments for
* whom it is forbidden to create a wrapper in content scopes. As such, we
* need a layer to wrap the values in SpecialPowers wrappers before they ever
* reach content.
*/
wrapCallback(func) {
return WrapPrivileged.wrapCallback(func);
}
wrapCallbackObject(obj) {
return WrapPrivileged.wrapCallbackObject(obj);
}
/*
* Used for assigning a property to a SpecialPowers wrapper, without unwrapping
* the value that is assigned.
*/
setWrapped(obj, prop, val) {
if (!WrapPrivileged.isWrapper(obj)) {
throw new Error(
"You only need to use this for SpecialPowers wrapped objects"
);
}
obj = WrapPrivileged.unwrap(obj);
return Reflect.set(obj, prop, val);
}
/*
* Create blank privileged objects to use as out-params for privileged functions.
*/
createBlankObject() {
return {};
}
/*
* Because SpecialPowers wrappers don't preserve identity, comparing with ==
* can be hazardous. Sometimes we can just unwrap to compare, but sometimes
* wrapping the underlying object into a content scope is forbidden. This
* function strips any wrappers if they exist and compare the underlying
* values.
*/
compare(a, b) {
return WrapPrivileged.unwrap(a) === WrapPrivileged.unwrap(b);
}
get MockFilePicker() {
return MockFilePicker;
}
get MockColorPicker() {
return MockColorPicker;
}
get MockPermissionPrompt() {
return MockPermissionPrompt;
}
/*
* Load a privileged script that runs same-process. This is different from
* |loadChromeScript|, which will run in the parent process in e10s mode.
*/
loadPrivilegedScript(aFunction) {
var str = "(" + aFunction.toString() + ")();";
let gGlobalObject = Cu.getGlobalForObject(this);
let sb = Cu.Sandbox(gGlobalObject);
var window = this.contentWindow;
var mc = new window.MessageChannel();
sb.port = mc.port1;
try {
let blob = new Blob([str], { type: "application/javascript" });
let blobUrl = URL.createObjectURL(blob);
Services.scriptloader.loadSubScript(blobUrl, sb);
} catch (e) {
throw WrapPrivileged.wrap(e);
}
return mc.port2;
}
_readUrlAsString(aUrl) {
// Fetch script content as we can't use scriptloader's loadSubScript
// to evaluate http:// urls...
var scriptableStream = Cc[
"@mozilla.org/scriptableinputstream;1"
].getService(Ci.nsIScriptableInputStream);
var channel = NetUtil.newChannel({
uri: aUrl,
loadUsingSystemPrincipal: true,
});
var input = channel.open();
scriptableStream.init(input);
var str;
var buffer = [];
while ((str = scriptableStream.read(4096))) {
buffer.push(str);
}
var output = buffer.join("");
scriptableStream.close();
input.close();
var status;
if (channel instanceof Ci.nsIHttpChannel) {
status = channel.responseStatus;
}
if (status == 404) {
throw new Error(
`Error while executing chrome script '${aUrl}':\n` +
"The script doesn't exist. Ensure you have registered it in " +
"'support-files' in your mochitest.ini."
);
}
return output;
}
loadChromeScript(urlOrFunction, sandboxOptions) {
// Create a unique id for this chrome script
let uuidGenerator = Cc["@mozilla.org/uuid-generator;1"].getService(
Ci.nsIUUIDGenerator
);
let id = uuidGenerator.generateUUID().toString();
// Tells chrome code to evaluate this chrome script
let scriptArgs = { id, sandboxOptions };
if (typeof urlOrFunction == "function") {
scriptArgs.function = {
body: "(" + urlOrFunction.toString() + ")();",
name: urlOrFunction.name,
};
} else {
// Note: We need to do this in the child since, even though
// `_readUrlAsString` pretends to be synchronous, its channel
// winds up spinning the event loop when loading HTTP URLs. That
// leads to unexpected out-of-order operations if the child sends
// a message immediately after loading the script.
scriptArgs.function = {
body: this._readUrlAsString(urlOrFunction),
};
scriptArgs.url = urlOrFunction;
}
this.sendAsyncMessage("SPLoadChromeScript", scriptArgs);
// Returns a MessageManager like API in order to be
// able to communicate with this chrome script
let listeners = [];
let chromeScript = {
addMessageListener: (name, listener) => {
listeners.push({ name, listener });
},
promiseOneMessage: name =>
new Promise(resolve => {
chromeScript.addMessageListener(name, function listener(message) {
chromeScript.removeMessageListener(name, listener);
resolve(message);
});
}),
removeMessageListener: (name, listener) => {
listeners = listeners.filter(
o => o.name != name || o.listener != listener
);
},
sendAsyncMessage: (name, message) => {
this.sendAsyncMessage("SPChromeScriptMessage", { id, name, message });
},
sendQuery: (name, message) => {
return this.sendQuery("SPChromeScriptMessage", { id, name, message });
},
destroy: () => {
listeners = [];
this._removeMessageListener("SPChromeScriptMessage", chromeScript);
},
receiveMessage: aMessage => {
let messageId = aMessage.json.id;
let name = aMessage.json.name;
let message = aMessage.json.message;
if (this.contentWindow) {
message = new StructuredCloneHolder(message).deserialize(
this.contentWindow
);
}
// Ignore message from other chrome script
if (messageId != id) {
return null;
}
let result;
if (aMessage.name == "SPChromeScriptMessage") {
for (let listener of listeners.filter(o => o.name == name)) {
result = listener.listener(message);
}
}
return result;
},
};
this._addMessageListener("SPChromeScriptMessage", chromeScript);
return this.wrap(chromeScript);
}
async importInMainProcess(importString) {
var message = await this.sendQuery("SPImportInMainProcess", importString);
if (message.hadError) {
throw new Error(
"SpecialPowers.importInMainProcess failed with error " +
message.errorMessage
);
}
}
get Services() {
return WrapPrivileged.wrap(Services);
}
/*
* A getter for the privileged Components object we have.
*/
getFullComponents() {
return Components;
}
/*
* Convenient shortcuts to the standard Components abbreviations.
*/
get Cc() {
return WrapPrivileged.wrap(this.getFullComponents().classes);
}
get Ci() {
return WrapPrivileged.wrap(this.getFullComponents().interfaces);
}
get Cu() {
return WrapPrivileged.wrap(this.getFullComponents().utils);
}
get Cr() {
return WrapPrivileged.wrap(this.getFullComponents().results);
}
getDOMWindowUtils(aWindow) {
if (aWindow == this.contentWindow && this.DOMWindowUtils != null) {
return this.DOMWindowUtils;
}
return bindDOMWindowUtils(aWindow);
}
/*
* A method to get a DOMParser that can't parse XUL.
*/
getNoXULDOMParser() {
// If we create it with a system subject principal (so it gets a
// nullprincipal), it won't be able to parse XUL by default.
return WrapPrivileged.wrap(new DOMParser());
}
get InspectorUtils() {
return WrapPrivileged.wrap(InspectorUtils);
}
get PromiseDebugging() {
return WrapPrivileged.wrap(PromiseDebugging);
}
async waitForCrashes(aExpectingProcessCrash) {
if (!aExpectingProcessCrash) {
return;
}
var crashIds = this._encounteredCrashDumpFiles
.filter(filename => {
return filename.length === 40 && filename.endsWith(".dmp");
})
.map(id => {
return id.slice(0, -4); // Strip the .dmp extension to get the ID
});
await this.sendQuery("SPProcessCrashManagerWait", {
crashIds,
});
}
async removeExpectedCrashDumpFiles(aExpectingProcessCrash) {
var success = true;
if (aExpectingProcessCrash) {
var message = {
op: "delete-crash-dump-files",
filenames: this._encounteredCrashDumpFiles,
};
if (!(await this.sendQuery("SPProcessCrashService", message))) {
success = false;
}
}
this._encounteredCrashDumpFiles.length = 0;
return success;
}
async findUnexpectedCrashDumpFiles() {
var self = this;
var message = {
op: "find-crash-dump-files",
crashDumpFilesToIgnore: this._unexpectedCrashDumpFiles,
};
var crashDumpFiles = await this.sendQuery("SPProcessCrashService", message);
crashDumpFiles.forEach(function(aFilename) {
self._unexpectedCrashDumpFiles[aFilename] = true;
});
return crashDumpFiles;
}
removePendingCrashDumpFiles() {
var message = {
op: "delete-pending-crash-dump-files",
};
return this.sendQuery("SPProcessCrashService", message);
}
_setTimeout(callback) {
// for mochitest-browser
if (typeof this.chromeWindow != "undefined") {
this.chromeWindow.setTimeout(callback, 0);
}
// for mochitest-plain
else {
this.contentWindow.setTimeout(callback, 0);
}
}
promiseTimeout(delay) {
return new Promise(resolve => {
this._setTimeout(resolve, delay);
});
}
_delayCallbackTwice(callback) {
let delayedCallback = () => {
let delayAgain = aCallback => {
// Using this._setTimeout doesn't work here
// It causes failures in mochtests that use
// multiple pushPrefEnv calls
// For chrome/browser-chrome mochitests
this._setTimeout(aCallback);
};
delayAgain(delayAgain.bind(this, callback));
};
return delayedCallback;
}
/* apply permissions to the system and when the test case is finished (SimpleTest.finish())
we will revert the permission back to the original.
inPermissions is an array of objects where each object has a type, action, context, ex:
[{'type': 'SystemXHR', 'allow': 1, 'context': document},
{'type': 'SystemXHR', 'allow': Ci.nsIPermissionManager.PROMPT_ACTION, 'context': document}]
Allow can be a boolean value of true/false or ALLOW_ACTION/DENY_ACTION/PROMPT_ACTION/UNKNOWN_ACTION
*/
async pushPermissions(inPermissions, callback) {
inPermissions = Cu.waiveXrays(inPermissions);
var pendingPermissions = [];
var cleanupPermissions = [];
for (var p in inPermissions) {
var permission = inPermissions[p];
var originalValue = Ci.nsIPermissionManager.UNKNOWN_ACTION;
var context = Cu.unwaiveXrays(permission.context); // Sometimes |context| is a DOM object on which we expect
// to be able to access .nodePrincipal, so we need to unwaive.
if (
await this.testPermission(
permission.type,
Ci.nsIPermissionManager.ALLOW_ACTION,
context
)
) {
originalValue = Ci.nsIPermissionManager.ALLOW_ACTION;
} else if (
await this.testPermission(
permission.type,
Ci.nsIPermissionManager.DENY_ACTION,
context
)
) {
originalValue = Ci.nsIPermissionManager.DENY_ACTION;
} else if (
await this.testPermission(
permission.type,
Ci.nsIPermissionManager.PROMPT_ACTION,
context
)
) {
originalValue = Ci.nsIPermissionManager.PROMPT_ACTION;
} else if (
await this.testPermission(
permission.type,
Ci.nsICookiePermission.ACCESS_SESSION,
context
)
) {
originalValue = Ci.nsICookiePermission.ACCESS_SESSION;
}
let principal = this._getPrincipalFromArg(context);
if (principal.isSystemPrincipal) {
continue;
}
let perm;
if (typeof permission.allow !== "boolean") {
perm = permission.allow;
} else {
perm = permission.allow
? Ci.nsIPermissionManager.ALLOW_ACTION
: Ci.nsIPermissionManager.DENY_ACTION;
}
if (permission.remove) {
perm = Ci.nsIPermissionManager.UNKNOWN_ACTION;
}
if (originalValue == perm) {
continue;
}
var todo = {
op: "add",
type: permission.type,
permission: perm,
value: perm,
principal,
expireType:
typeof permission.expireType === "number" ? permission.expireType : 0, // default: EXPIRE_NEVER
expireTime:
typeof permission.expireTime === "number" ? permission.expireTime : 0,
};
var cleanupTodo = Object.assign({}, todo);
if (permission.remove) {
todo.op = "remove";
}
pendingPermissions.push(todo);
/* Push original permissions value or clear into cleanup array */
if (originalValue == Ci.nsIPermissionManager.UNKNOWN_ACTION) {
cleanupTodo.op = "remove";
} else {
cleanupTodo.value = originalValue;
cleanupTodo.permission = originalValue;
}
cleanupPermissions.push(cleanupTodo);
}
if (pendingPermissions.length > 0) {
// The callback needs to be delayed twice. One delay is because the pref
// service doesn't guarantee the order it calls its observers in, so it
// may notify the observer holding the callback before the other
// observers have been notified and given a chance to make the changes
// that the callback checks for. The second delay is because pref
// observers often defer making their changes by posting an event to the
// event loop.
if (!this._observingPermissions) {
this._observingPermissions = true;
// If specialpowers is in main-process, then we can add a observer
// to get all 'perm-changed' signals. Otherwise, it can't receive
// all signals, so we register a observer in specialpowersobserver(in
// main-process) and get signals from it.
if (this.isMainProcess()) {
this.permissionObserverProxy._specialPowersAPI = this;
Services.obs.addObserver(
this.permissionObserverProxy,
"perm-changed"
);
} else {
this.registerObservers("perm-changed");
// bind() is used to set 'this' to SpecialPowersAPI itself.
this._addMessageListener(
"specialpowers-perm-changed",
this.permChangedProxy.bind(this)
);
}
}
this._permissionsUndoStack.push(cleanupPermissions);
this._pendingPermissions.push([
pendingPermissions,
this._delayCallbackTwice(callback),
]);
this._applyPermissions();
} else {
this._setTimeout(callback);
}
}
/*
* This function should be used when specialpowers is in content process but
* it want to get the notification from chrome space.
*
* This function will call Services.obs.addObserver in SpecialPowersObserver
* (that is in chrome process) and forward the data received to SpecialPowers
* via messageManager.
* You can use this._addMessageListener("specialpowers-YOUR_TOPIC") to fire
* the callback.
*
* To get the expected data, you should modify
* SpecialPowersObserver.prototype._registerObservers.observe. Or the message
* you received from messageManager will only contain 'aData' from Service.obs.
*
* NOTICE: there is no implementation of _addMessageListener in
* ChromePowers.js
*/
registerObservers(topic) {
var msg = {
op: "add",
observerTopic: topic,
};
return this.sendQuery("SPObserverService", msg);
}
permChangedProxy(aMessage) {
let permission = aMessage.json.permission;
let aData = aMessage.json.aData;
this._permissionObserver.observe(permission, aData);
}
popPermissions(callback) {
let promise = new Promise(resolve => {
if (this._permissionsUndoStack.length > 0) {
// See pushPermissions comment regarding delay.
let cb = this._delayCallbackTwice(resolve);
/* Each pop from the stack will yield an object {op/type/permission/value/url/appid/isInIsolatedMozBrowserElement} or null */
this._pendingPermissions.push([this._permissionsUndoStack.pop(), cb]);
this._applyPermissions();
} else {
if (this._observingPermissions) {
this._observingPermissions = false;
this._removeMessageListener(
"specialpowers-perm-changed",
this.permChangedProxy.bind(this)
);
}
this._setTimeout(resolve);
}
});
if (callback) {
promise.then(callback);
}
return promise;
}
flushPermissions(callback) {
while (this._permissionsUndoStack.length > 1) {
this.popPermissions(null);
}
return this.popPermissions(callback);
}
setTestPluginEnabledState(newEnabledState, pluginName) {
return this.sendQuery("SPSetTestPluginEnabledState", {
newEnabledState,
pluginName,
});
}
/*
Iterate through one atomic set of permissions actions and perform allow/deny as appropriate.
All actions performed must modify the relevant permission.
*/
_applyPermissions() {
if (this._applyingPermissions || this._pendingPermissions.length <= 0) {
return;
}
/* Set lock and get prefs from the _pendingPrefs queue */
this._applyingPermissions = true;
var transaction = this._pendingPermissions.shift();
var pendingActions = transaction[0];
var callback = transaction[1];
var lastPermission = pendingActions[pendingActions.length - 1];
var self = this;
this._permissionObserver._self = self;
this._permissionObserver._lastPermission = lastPermission;
this._permissionObserver._callback = callback;
this._permissionObserver._nextCallback = function() {
self._applyingPermissions = false;
// Now apply any permissions that may have been queued while we were applying
self._applyPermissions();
};
for (var idx in pendingActions) {
var perm = pendingActions[idx];
this.sendAsyncMessage("SPPermissionManager", perm);
}
}
async pushPrefEnv(inPrefs, callback = null) {
await this.sendQuery("PushPrefEnv", inPrefs).then(callback);
await this.promiseTimeout(0);
}
async popPrefEnv(callback = null) {
await this.sendQuery("PopPrefEnv").then(callback);
await this.promiseTimeout(0);
}
async flushPrefEnv(callback = null) {
await this.sendQuery("FlushPrefEnv").then(callback);
await this.promiseTimeout(0);
}
_addObserverProxy(notification) {
if (notification in this._proxiedObservers) {
this._addMessageListener(
notification,
this._proxiedObservers[notification]
);
}
}
_removeObserverProxy(notification) {
if (notification in this._proxiedObservers) {
this._removeMessageListener(
notification,
this._proxiedObservers[notification]
);
}
}
addObserver(obs, notification, weak) {
// Make sure the parent side exists, or we won't get any notifications.
this.sendAsyncMessage("Wakeup");
this._addObserverProxy(notification);
obs = Cu.waiveXrays(obs);
if (
typeof obs == "object" &&
obs.observe.name != "SpecialPowersCallbackWrapper"
) {
obs.observe = WrapPrivileged.wrapCallback(obs.observe);
}
Services.obs.addObserver(obs, notification, weak);
}
removeObserver(obs, notification) {
this._removeObserverProxy(notification);
Services.obs.removeObserver(Cu.waiveXrays(obs), notification);
}
notifyObservers(subject, topic, data) {
Services.obs.notifyObservers(subject, topic, data);
}
/**
* An async observer is useful if you're listening for a
* notification that normally is only used by C++ code or chrome
* code (so it runs in the SystemGroup), but we need to know about
* it for a test (which runs as web content). If we used
* addObserver, we would assert when trying to enter web content
* from a runnabled labeled by the SystemGroup. An async observer
* avoids this problem.
*/
addAsyncObserver(obs, notification, weak) {
obs = Cu.waiveXrays(obs);
if (
typeof obs == "object" &&
obs.observe.name != "SpecialPowersCallbackWrapper"
) {
obs.observe = WrapPrivileged.wrapCallback(obs.observe);
}
let asyncObs = (...args) => {
Services.tm.dispatchToMainThread(() => {
if (typeof obs == "function") {
obs(...args);
} else {
obs.observe.call(undefined, ...args);
}
});
};
this._asyncObservers.set(obs, asyncObs);
Services.obs.addObserver(asyncObs, notification, weak);
}
removeAsyncObserver(obs, notification) {
let asyncObs = this._asyncObservers.get(Cu.waiveXrays(obs));
Services.obs.removeObserver(asyncObs, notification);
}
can_QI(obj) {
return obj.QueryInterface !== undefined;
}
do_QueryInterface(obj, iface) {
return obj.QueryInterface(Ci[iface]);
}
call_Instanceof(obj1, obj2) {
obj1 = WrapPrivileged.unwrap(obj1);
obj2 = WrapPrivileged.unwrap(obj2);
return obj1 instanceof obj2;
}
// Returns a privileged getter from an object. GetOwnPropertyDescriptor does
// not work here because xray wrappers don't properly implement it.
//
// This terribleness is used by dom/base/test/test_object.html because
// <object> and <embed> tags will spawn plugins if their prototype is touched,
// so we need to get and cache the getter of |hasRunningPlugin| if we want to
// call it without paradoxically spawning the plugin.
do_lookupGetter(obj, name) {
return Object.prototype.__lookupGetter__.call(obj, name);
}
// Mimic the get*Pref API
getBoolPref(...args) {
return Services.prefs.getBoolPref(...args);
}
getIntPref(...args) {
return Services.prefs.getIntPref(...args);
}
getCharPref(...args) {
return Services.prefs.getCharPref(...args);
}
getComplexValue(prefName, iid) {
return Services.prefs.getComplexValue(prefName, iid);
}
getParentBoolPref(prefName, defaultValue) {
return this._getParentPref(prefName, "BOOL", { defaultValue });
}
getParentIntPref(prefName, defaultValue) {
return this._getParentPref(prefName, "INT", { defaultValue });
}
getParentCharPref(prefName, defaultValue) {
return this._getParentPref(prefName, "CHAR", { defaultValue });
}
// Mimic the set*Pref API
setBoolPref(prefName, value) {
return this._setPref(prefName, "BOOL", value);
}
setIntPref(prefName, value) {
return this._setPref(prefName, "INT", value);
}
setCharPref(prefName, value) {
return this._setPref(prefName, "CHAR", value);
}
setComplexValue(prefName, iid, value) {
return this._setPref(prefName, "COMPLEX", value, iid);
}
// Mimic the clearUserPref API
clearUserPref(prefName) {
let msg = {
op: "clear",
prefName,
prefType: "",
};
return this.sendQuery("SPPrefService", msg);
}
// Private pref functions to communicate to chrome
async _getParentPref(prefName, prefType, { defaultValue, iid }) {
let msg = {
op: "get",
prefName,