summaryrefslogtreecommitdiff
path: root/common/components/protocols.js
blob: 7869197392c1ac2374d5a94db02723c4f734a382 (plain)
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
// Copyright (c) 2008-2011 Kris Maglione <maglione.k at Gmail>
//
// This work is licensed for reuse under an MIT license. Details are
// given in the LICENSE.txt file included with this file.
"use strict";
function reportError(e) {
    dump("dactyl: protocols: " + e + "\n" + (e.stack || Error().stack));
    Cu.reportError(e);
}

var NAME = "protocols";
var global = this;
var Cc = Components.classes;
var Ci = Components.interfaces;
var Cu = Components.utils;

var ioService = Cc["@mozilla.org/network/io-service;1"].getService(Ci.nsIIOService);
var systemPrincipal = Cc["@mozilla.org/systemprincipal;1"].getService(Ci.nsIPrincipal);

var DNE = "resource://dactyl/content/does/not/exist";
var _DNE;

Components.utils.import("resource://gre/modules/XPCOMUtils.jsm");

function makeChannel(url, orig) {
    try {
        if (url == null)
            return fakeChannel(orig);

        if (typeof url === "function")
            return let ([type, data] = url(orig)) StringChannel(data, type, orig);

        if (isArray(url))
            return let ([type, data] = url) StringChannel(data, type, orig);

        let uri = ioService.newURI(url, null, null);
        return (new XMLChannel(uri)).channel;
    }
    catch (e) {
        util.reportError(e);
        throw e;
    }
}
function fakeChannel(orig) {
    let channel = ioService.newChannel(DNE, null, null);
    channel.originalURI = orig;
    return channel;
}
function redirect(to, orig, time) {
    let html = <html><head><meta http-equiv="Refresh" content={(time || 0) + ";" + to}/></head></html>.toXMLString();
    return StringChannel(html, "text/html", ioService.newURI(to, null, null));
}

function Factory(clas) ({
    __proto__: clas.prototype,
    createInstance: function (outer, iid) {
        try {
            if (outer != null)
                throw Components.results.NS_ERROR_NO_AGGREGATION;
            if (!clas.instance)
                clas.instance = new clas();
            return clas.instance.QueryInterface(iid);
        }
        catch (e) {
            reportError(e);
            throw e;
        }
    }
});

/* Adds support for data: URIs with chrome privileges
 * and fragment identifiers.
 *
 * "chrome-data:" <content-type> [; <flag>]* "," [<data>]
 *
 * By Kris Maglione, ideas from Ed Anuff's nsChromeExtensionHandler.
 */
function ChromeData() {}
ChromeData.prototype = {
    contractID:       "@mozilla.org/network/protocol;1?name=chrome-data",
    classID:          Components.ID("{c1b67a07-18f7-4e13-b361-2edcc35a5a0d}"),
    classDescription: "Data URIs with chrome privileges",
    QueryInterface:   XPCOMUtils.generateQI([Ci.nsIProtocolHandler]),
    _xpcom_factory:   Factory(ChromeData),

    scheme: "chrome-data",
    defaultPort: -1,
    allowPort: function (port, scheme) false,
    protocolFlags: Ci.nsIProtocolHandler.URI_NORELATIVE
         | Ci.nsIProtocolHandler.URI_NOAUTH
         | Ci.nsIProtocolHandler.URI_IS_UI_RESOURCE,

    newURI: function (spec, charset, baseURI) {
        var uri = Components.classes["@mozilla.org/network/standard-url;1"]
                            .createInstance(Components.interfaces.nsIStandardURL)
                            .QueryInterface(Components.interfaces.nsIURI);
        uri.init(uri.URLTYPE_STANDARD, this.defaultPort, spec, charset, null);
        return uri;
    },

    newChannel: function (uri) {
        try {
            if (uri.scheme == this.scheme) {
                let channel = ioService.newChannel(uri.spec.replace(/^.*?:\/*(.*)(?:#.*)?/, "data:$1"),
                                                   null, null);
                channel.contentCharset = "UTF-8";
                channel.owner = systemPrincipal;
                channel.originalURI = uri;
                return channel;
            }
        }
        catch (e) {}
        return fakeChannel(uri);
    }
};

function Dactyl() {
    // Kill stupid validator warning.
    this["wrapped" + "JSObject"] = this;

    this.HELP_TAGS = {};
    this.FILE_MAP = {};
    this.OVERLAY_MAP = {};

    this.pages = {};
    this.providers = {};

    Cu.import("resource://dactyl/bootstrap.jsm");
    if (!JSMLoader.initialized)
        JSMLoader.init();
    JSMLoader.load("base.jsm", global);
    require(global, "config");
    require(global, "services");
    require(global, "util");
    _DNE = ioService.newChannel(DNE, null, null).name;

    // Doesn't belong here:
    AboutHandler.prototype.register();
}
Dactyl.prototype = {
    contractID:       "@mozilla.org/network/protocol;1?name=dactyl",
    classID:          Components.ID("{9c8f2530-51c8-4d41-b356-319e0b155c44}"),
    classDescription: "Dactyl utility protocol",
    QueryInterface:   XPCOMUtils.generateQI([Ci.nsIObserver, Ci.nsIProtocolHandler]),
    _xpcom_factory:   Factory(Dactyl),

    init: function (obj) {
        for each (let prop in ["HELP_TAGS", "FILE_MAP", "OVERLAY_MAP"]) {
            this[prop] = this[prop].constructor();
            for (let [k, v] in Iterator(obj[prop] || {}))
                this[prop][k] = v;
        }
        this.initialized = true;
    },

    scheme: "dactyl",
    defaultPort: -1,
    allowPort: function (port, scheme) false,
    protocolFlags: 0
         | Ci.nsIProtocolHandler.URI_IS_UI_RESOURCE
         | Ci.nsIProtocolHandler.URI_IS_LOCAL_RESOURCE,

    newURI: function newURI(spec, charset, baseURI) {
        var uri = Cc["@mozilla.org/network/standard-url;1"]
                        .createInstance(Ci.nsIStandardURL)
                        .QueryInterface(Ci.nsIURI);
        if (baseURI && baseURI.host === "data")
            baseURI = null;
        uri.init(uri.URLTYPE_STANDARD, this.defaultPort, spec, charset, baseURI);
        return uri;
    },

    newChannel: function newChannel(uri) {
        try {
            if (/^help/.test(uri.host) && !("all" in this.FILE_MAP))
                return redirect(uri.spec, uri, 1);

            if (uri.host in this.providers)
                return makeChannel(this.providers[uri.host](uri), uri);

            let path = decodeURIComponent(uri.path.replace(/^\/|#.*/g, ""));
            switch(uri.host) {
            case "content":
                return makeChannel(this.pages[path] || "resource://dactyl-content/" + path, uri);
            case "data":
                try {
                    var channel = ioService.newChannel(uri.path.replace(/^\/(.*)(?:#.*)?/, "data:$1"),
                                                       null, null);
                }
                catch (e) {
                    var error = e;
                    break;
                }
                channel.contentCharset = "UTF-8";
                channel.owner = systemPrincipal;
                channel.originalURI = uri;
                return channel;
            case "help":
                return makeChannel(this.FILE_MAP[path], uri);
            case "help-overlay":
                return makeChannel(this.OVERLAY_MAP[path], uri);
            case "help-tag":
                let tag = decodeURIComponent(uri.path.substr(1));
                if (tag in this.FILE_MAP)
                    return redirect("dactyl://help/" + tag, uri);
                if (tag in this.HELP_TAGS)
                    return redirect("dactyl://help/" + this.HELP_TAGS[tag] + "#" + tag.replace(/#/g, encodeURIComponent), uri);
                break;
            case "locale":
                return LocaleChannel("dactyl-locale", path, uri);
            case "locale-local":
                return LocaleChannel("dactyl-local-locale", path, uri);
            }
        }
        catch (e) {
            util.reportError(e);
        }
        if (error)
            throw error;
        return fakeChannel(uri);
    },

    // FIXME: Belongs elsewhere
    _xpcom_categories: [{
        category: "profile-after-change",
        entry: "m-dactyl"
    }],

    observe: function observe(subject, topic, data) {
        if (topic === "profile-after-change") {
            Cu.import("resource://dactyl/bootstrap.jsm");
            JSMLoader.init();
            require(global, "overlay");
        }
    }
};

function LocaleChannel(pkg, path, orig) {
    for each (let locale in [config.locale, "en-US"])
        for each (let sep in "-/") {
            var channel = makeChannel(["resource:/", pkg + sep + config.locale, path].join("/"), orig);
            if (channel.name !== _DNE)
                return channel;
        }
    return channel;
}

function StringChannel(data, contentType, uri) {
    let channel = services.StreamChannel(uri);
    channel.contentStream = services.CharsetConv("UTF-8").convertToInputStream(data);
    if (contentType)
        channel.contentType = contentType;
    channel.contentCharset = "UTF-8";
    channel.owner = systemPrincipal;
    if (uri)
        channel.originalURI = uri;
    return channel;
}

function XMLChannel(uri, contentType) {
    try {
        var channel = services.io.newChannelFromURI(uri);
        var channelStream = channel.open();
    }
    catch (e) {
        this.channel = fakeChannel(uri);
        return;
    }

    this.uri = uri;
    this.sourceChannel = services.io.newChannelFromURI(uri);
    this.pipe = services.Pipe(true, true, 0, 0, null);
    this.writes = [];

    this.channel = services.StreamChannel(uri);
    this.channel.contentStream = this.pipe.inputStream;
    this.channel.contentType = contentType || channel.contentType;
    this.channel.contentCharset = "UTF-8";
    this.channel.owner = systemPrincipal;

    let stream = services.InputStream(channelStream);
    let [, pre, doctype, url, open, post] = util.regexp(<![CDATA[
            ^ ([^]*?)
            (?:
                (<!DOCTYPE \s+ \S+ \s+) SYSTEM \s+ "([^"]*)"
                (\s+ \[)?
                ([^]*)
            )?
            $
        ]]>, "x").exec(stream.read(4096));
    this.writes.push(pre);
    if (doctype) {
        this.writes.push(doctype + "[\n");
        try {
            this.writes.push(services.io.newChannel(url, null, null).open());
        }
        catch (e) {}
        if (!open)
            this.writes.push("\n]");
        this.writes.push(post);
    }
    this.writes.push(channelStream);

    this.writeNext();
}
XMLChannel.prototype = {
    QueryInterface:   XPCOMUtils.generateQI([Ci.nsIRequestObserver]),
    writeNext: function () {
        try {
            if (!this.writes.length)
                this.pipe.outputStream.close();
            else {
                let stream = this.writes.shift();
                if (isString(stream))
                    stream = services.StringStream(stream);

                services.StreamCopier(stream, this.pipe.outputStream, null,
                                      false, true, 4096, true, false)
                        .asyncCopy(this, null);
            }
        }
        catch (e) {
            util.reportError(e);
        }
    },

    onStartRequest: function (request, context) {},
    onStopRequest: function (request, context, statusCode) {
        this.writeNext();
    }
};

function AboutHandler() {}
AboutHandler.prototype = {
    register: function () {
        try {
            JSMLoader.registerFactory(Factory(AboutHandler));
        }
        catch (e) {
            util.reportError(e);
        }
    },

    get classDescription() "About " + config.appName + " Page",

    classID: Components.ID("81495d80-89ee-4c36-a88d-ea7c4e5ac63f"),

    get contractID() "@mozilla.org/network/protocol/about;1?what=" + config.name,

    QueryInterface: XPCOMUtils.generateQI([Ci.nsIAboutModule]),

    newChannel: function (uri) {
        let channel = Cc["@mozilla.org/network/io-service;1"].getService(Ci.nsIIOService)
                          .newChannel("dactyl://content/about.xul", null, null);
        channel.originalURI = uri;
        return channel;
    },

    getURIFlags: function (uri) Ci.nsIAboutModule.ALLOW_SCRIPT,
};

// A hack to get information about interfaces.
// Doesn't belong here.
function Shim() {}
Shim.prototype = {
    contractID:       "@dactyl.googlecode.com/base/xpc-interface-shim",
    classID:          Components.ID("{f4506a17-5b4d-4cd9-92d4-2eb4630dc388}"),
    classDescription: "XPCOM empty interface shim",
    QueryInterface:   function (iid) {
        if (iid.equals(Ci.nsISecurityCheckedComponent))
            throw Components.results.NS_ERROR_NO_INTERFACE;
        return this;
    },
    getHelperForLanguage: function () null,
    getInterfaces: function (count) { count.value = 0; }
};

if (XPCOMUtils.generateNSGetFactory)
    var NSGetFactory = XPCOMUtils.generateNSGetFactory([ChromeData, Dactyl, Shim]);
else
    var NSGetModule = XPCOMUtils.generateNSGetModule([ChromeData, Dactyl, Shim]);
var EXPORTED_SYMBOLS = ["NSGetFactory", "global"];

// vim: set fdm=marker sw=4 ts=4 et: