-
Notifications
You must be signed in to change notification settings - Fork 327
/
utils.js
446 lines (363 loc) · 12.9 KB
/
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
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
const GM_GUID = "{e4a8a97b-f2ed-450b-b12d-ee082ba24781}";
// TODO: properly scope this constant
const NAMESPACE = "http://youngpup.net/greasemonkey";
var GM_consoleService = Components.classes["@mozilla.org/consoleservice;1"]
.getService(Components.interfaces.nsIConsoleService);
function GM_isDef(thing) {
return typeof(thing) != "undefined";
}
function GM_getConfig() {
return Components
.classes["@greasemonkey.mozdev.org/greasemonkey-service;1"]
.getService(Components.interfaces.gmIGreasemonkeyService)
.wrappedJSObject.config;
}
function GM_hitch(obj, meth) {
if (!obj[meth]) {
throw "method '" + meth + "' does not exist on object '" + obj + "'";
}
var staticArgs = Array.prototype.splice.call(arguments, 2, arguments.length);
return function() {
// make a copy of staticArgs (don't modify it because it gets reused for
// every invocation).
var args = staticArgs.concat();
// add all the new arguments
for (var i = 0; i < arguments.length; i++) {
args.push(arguments[i]);
}
// invoke the original function with the correct this obj and the combined
// list of static and dynamic arguments.
return obj[meth].apply(obj, args);
};
}
function GM_listen(source, event, listener, opt_capture) {
Components.lookupMethod(source, "addEventListener")(
event, listener, opt_capture);
}
function GM_unlisten(source, event, listener, opt_capture) {
Components.lookupMethod(source, "removeEventListener")(
event, listener, opt_capture);
}
/**
* Utility to create an error message in the log without throwing an error.
*/
function GM_logError(e, opt_warn, fileName, lineNumber) {
var consoleService = Components.classes["@mozilla.org/consoleservice;1"]
.getService(Components.interfaces.nsIConsoleService);
var consoleError = Components.classes["@mozilla.org/scripterror;1"]
.createInstance(Components.interfaces.nsIScriptError);
var flags = opt_warn ? 1 : 0;
// third parameter "sourceLine" is supposed to be the line, of the source,
// on which the error happened. we don't know it. (directly...)
consoleError.init(e.message, fileName, null, lineNumber,
e.columnNumber, flags, null);
consoleService.logMessage(consoleError);
}
function GM_log(message, force) {
if (force || GM_prefRoot.getValue("logChrome", false)) {
GM_consoleService.logStringMessage(message);
}
}
function GM_openUserScriptManager() {
var win = Components.classes["@mozilla.org/appshell/window-mediator;1"]
.getService(Components.interfaces.nsIWindowMediator)
.getMostRecentWindow("Greasemonkey:Manage");
if (win) {
win.focus();
} else {
var parentWindow = (!window.opener || window.opener.closed) ?
window : window.opener;
parentWindow.openDialog("chrome://greasemonkey/content/manage.xul",
"_blank", "resizable,dialog=no,centerscreen");
}
}
// TODO: this stuff was copied wholesale and not refactored at all. Lots of
// the UI and Config rely on it. Needs rethinking.
function openInEditor(script) {
var file = script.editFile;
var stringBundle = Components
.classes["@mozilla.org/intl/stringbundle;1"]
.getService(Components.interfaces.nsIStringBundleService)
.createBundle("chrome://greasemonkey/locale/gm-browser.properties");
var editor = getEditor(stringBundle);
if (!editor) {
// The user did not choose an editor.
return;
}
try {
launchApplicationWithDoc(editor, file);
} catch (e) {
// Something may be wrong with the editor the user selected. Remove so that
// next time they can pick a different one.
alert(stringBundle.GetStringFromName("editor.could_not_launch") + "\n" + e);
GM_prefRoot.remove("editor");
throw e;
}
}
function getEditor(stringBundle) {
var editorPath = GM_prefRoot.getValue("editor");
if (editorPath) {
GM_log("Found saved editor preference: " + editorPath);
var editor = Components.classes["@mozilla.org/file/local;1"]
.createInstance(Components.interfaces.nsILocalFile);
editor.followLinks = true;
editor.initWithPath(editorPath);
// make sure the editor preference is still valid
if (editor.exists() && editor.isExecutable()) {
return editor;
} else {
GM_log("Editor preference either does not exist or is not executable");
GM_prefRoot.remove("editor");
}
}
// Ask the user to choose a new editor. Sometimes users get confused and
// pick a non-executable file, so we set this up in a loop so that if they do
// that we can give them an error and try again.
while (true) {
GM_log("Asking user to choose editor...");
var nsIFilePicker = Components.interfaces.nsIFilePicker;
var filePicker = Components.classes["@mozilla.org/filepicker;1"]
.createInstance(nsIFilePicker);
filePicker.init(window, stringBundle.GetStringFromName("editor.prompt"),
nsIFilePicker.modeOpen);
filePicker.appendFilters(nsIFilePicker.filterApplication);
filePicker.appendFilters(nsIFilePicker.filterAll);
if (filePicker.show() != nsIFilePicker.returnOK) {
// The user canceled, return null.
GM_log("User canceled file picker dialog");
return null;
}
GM_log("User selected: " + filePicker.file.path);
if (filePicker.file.exists() && filePicker.file.isExecutable()) {
GM_prefRoot.setValue("editor", filePicker.file.path);
return filePicker.file;
} else {
alert(stringBundle.GetStringFromName("editor.please_pick_executable"));
}
}
}
function launchApplicationWithDoc(appFile, docFile) {
var args=[docFile.path];
// For the mac, wrap with a call to "open".
var xulRuntime = Components.classes["@mozilla.org/xre/app-info;1"]
.getService(Components.interfaces.nsIXULRuntime);
if ("Darwin"==xulRuntime.OS) {
args=["-a", appFile.path, docFile.path]
appFile = Components.classes["@mozilla.org/file/local;1"]
.createInstance(Components.interfaces.nsILocalFile);
appFile.followLinks = true;
appFile.initWithPath("/usr/bin/open");
}
var process = Components.classes["@mozilla.org/process/util;1"]
.createInstance(Components.interfaces.nsIProcess);
process.init(appFile);
process.run(false, args, args.length);
}
function parseScriptName(sourceUri) {
var name = sourceUri.spec;
name = name.substring(0, name.indexOf(".user.js"));
name = name.substring(name.lastIndexOf("/") + 1);
return name;
}
function getTempFile() {
var file = Components.classes["@mozilla.org/file/directory_service;1"]
.getService(Components.interfaces.nsIProperties)
.get("TmpD", Components.interfaces.nsILocalFile);
file.append("gm-temp");
file.createUnique(
Components.interfaces.nsILocalFile.NORMAL_FILE_TYPE,
0640
);
return file;
}
function getBinaryContents(file) {
var ioService = Components.classes["@mozilla.org/network/io-service;1"]
.getService(Components.interfaces.nsIIOService);
var channel = ioService.newChannelFromURI(GM_getUriFromFile(file));
var input = channel.open();
var bstream = Components.classes["@mozilla.org/binaryinputstream;1"]
.createInstance(Components.interfaces.nsIBinaryInputStream);
bstream.setInputStream(input);
var bytes = bstream.readBytes(bstream.available());
return bytes;
}
function getContents(file, charset) {
if( !charset ) {
charset = "UTF-8"
}
var ioService=Components.classes["@mozilla.org/network/io-service;1"]
.getService(Components.interfaces.nsIIOService);
var scriptableStream=Components
.classes["@mozilla.org/scriptableinputstream;1"]
.getService(Components.interfaces.nsIScriptableInputStream);
// http://lxr.mozilla.org/mozilla/source/intl/uconv/idl/nsIScriptableUConv.idl
var unicodeConverter = Components
.classes["@mozilla.org/intl/scriptableunicodeconverter"]
.createInstance(Components.interfaces.nsIScriptableUnicodeConverter);
unicodeConverter.charset = charset;
var channel = ioService.newChannelFromURI(GM_getUriFromFile(file));
var input=channel.open();
scriptableStream.init(input);
var str=scriptableStream.read(input.available());
scriptableStream.close();
input.close();
try {
return unicodeConverter.ConvertToUnicode(str);
} catch( e ) {
return str;
}
}
function getWriteStream(file) {
var stream = Components.classes["@mozilla.org/network/file-output-stream;1"]
.createInstance(Components.interfaces.nsIFileOutputStream);
stream.init(file, 0x02 | 0x08 | 0x20, 420, -1);
return stream;
}
function GM_getUriFromFile(file) {
return Components.classes["@mozilla.org/network/io-service;1"]
.getService(Components.interfaces.nsIIOService)
.newFileURI(file);
}
/**
* Compares two version numbers
*
* @param {String} aV1 Version of first item in 1.2.3.4..9. format
* @param {String} aV2 Version of second item in 1.2.3.4..9. format
*
* @returns {Int} 1 if first argument is higher
* 0 if arguments are equal
* -1 if second argument is higher
*/
function GM_compareVersions(aV1, aV2) {
var v1 = aV1.split(".");
var v2 = aV2.split(".");
var numSubversions = (v1.length > v2.length) ? v1.length : v2.length;
for (var i = 0; i < numSubversions; i++) {
if (typeof v2[i] == "undefined") {
return 1;
}
if (typeof v1[i] == "undefined") {
return -1;
}
if (parseInt(v2[i], 10) > parseInt(v1[i], 10)) {
return -1;
} else if (parseInt(v2[i], 10) < parseInt(v1[i], 10)) {
return 1;
}
}
// v2 was never higher or lower than v1
return 0;
}
/**
* Takes the place of the traditional prompt() function which became broken
* in FF 1.0.1. :(
*/
function gmPrompt(msg, defVal, title) {
var promptService = Components.classes["@mozilla.org/embedcomp/prompt-service;1"]
.getService(Components.interfaces.nsIPromptService);
var result = {value:defVal};
if (promptService.prompt(null, title, msg, result, null, {value:0})) {
return result.value;
}
else {
return null;
}
}
function ge(id) {
return window.document.getElementById(id);
}
function dbg(o) {
var s = "";
var i = 0;
for (var p in o) {
s += p + ":" + o[p] + "\n";
if (++i % 15 == 0) {
alert(s);
s = "";
}
}
alert(s);
}
function delaydbg(o) {
setTimeout(function() {dbg(o);}, 1000);
}
function delayalert(s) {
setTimeout(function() {alert(s);}, 1000);
}
function GM_isGreasemonkeyable(url) {
var scheme = Components.classes["@mozilla.org/network/io-service;1"]
.getService(Components.interfaces.nsIIOService)
.extractScheme(url);
if ("http" == scheme) return true;
if ("https" == scheme) return true;
if ("ftp" == scheme) return true;
if ("data" == scheme) return true;
if ("file" == scheme) {
return GM_prefRoot.getValue('fileIsGreaseable');
}
if ("about" == scheme) {
// Always allow "about:blank".
if (/^about:blank/.test(url)) return true;
// Conditionally allow the rest of "about:".
return GM_prefRoot.getValue('aboutIsGreaseable');
}
return false;
}
function GM_isFileScheme(url) {
var scheme = Components.classes["@mozilla.org/network/io-service;1"]
.getService(Components.interfaces.nsIIOService)
.extractScheme(url);
return scheme == "file";
}
function GM_getEnabled() {
return GM_prefRoot.getValue("enabled", true);
}
function GM_setEnabled(enabled) {
GM_prefRoot.setValue("enabled", enabled);
}
/**
* Logs a message to the console. The message can have python style %s
* thingers which will be interpolated with additional parameters passed.
*/
function log(message) {
if (GM_prefRoot.getValue("logChrome", false)) {
logf.apply(null, arguments);
}
}
function logf(message) {
for (var i = 1; i < arguments.length; i++) {
message = message.replace(/\%s/, arguments[i]);
}
dump(message + "\n");
}
/**
* Loggifies an object. Every method of the object will have it's entrance,
* any parameters, any errors, and it's exit logged automatically.
*/
function loggify(obj, name) {
for (var p in obj) {
if (typeof obj[p] == "function") {
obj[p] = gen_loggify_wrapper(obj[p], name, p);
}
}
}
function gen_loggify_wrapper(meth, objName, methName) {
return function() {
var retVal;
//var args = new Array(arguments.length);
var argString = "";
for (var i = 0; i < arguments.length; i++) {
//args[i] = arguments[i];
argString += arguments[i] + (((i+1)<arguments.length)? ", " : "");
}
log("> %s.%s(%s)", objName, methName, argString); //args.join(", "));
try {
return retVal = meth.apply(this, arguments);
} finally {
log("< %s.%s: %s",
objName,
methName,
(typeof retVal == "undefined" ? "void" : retVal));
}
}
}