Files
tubestation/addon-sdk/source/lib/sdk/net/url.js
2014-04-24 12:32:56 -07:00

89 lines
2.4 KiB
JavaScript

/* 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/. */
"use strict";
module.metadata = {
"stability": "experimental"
};
const { Cu, components } = require("chrome");
const { defer } = require("../core/promise");
const { merge } = require("../util/object");
const { NetUtil } = Cu.import("resource://gre/modules/NetUtil.jsm", {});
/**
* Reads a URI and returns a promise.
*
* @param uri {string} The URI to read
* @param [options] {object} This parameter can have any or all of the following
* fields: `charset`. By default the `charset` is set to 'UTF-8'.
*
* @returns {promise} The promise that will be resolved with the content of the
* URL given.
*
* @example
* let promise = readURI('resource://gre/modules/NetUtil.jsm', {
* charset: 'US-ASCII'
* });
*/
function readURI(uri, options) {
options = options || {};
let charset = options.charset || 'UTF-8';
let channel = NetUtil.newChannel(uri, charset, null);
let { promise, resolve, reject } = defer();
try {
NetUtil.asyncFetch(channel, function (stream, result) {
if (components.isSuccessCode(result)) {
let count = stream.available();
let data = NetUtil.readInputStreamToString(stream, count, { charset : charset });
resolve(data);
} else {
reject("Failed to read: '" + uri + "' (Error Code: " + result + ")");
}
});
}
catch (e) {
reject("Failed to read: '" + uri + "' (Error: " + e.message + ")");
}
return promise;
}
exports.readURI = readURI;
/**
* Reads a URI synchronously.
* This function is intentionally undocumented to favorites the `readURI` usage.
*
* @param uri {string} The URI to read
* @param [charset] {string} The character set to use when read the content of
* the `uri` given. By default is set to 'UTF-8'.
*
* @returns {string} The content of the URI given.
*
* @example
* let data = readURISync('resource://gre/modules/NetUtil.jsm');
*/
function readURISync(uri, charset) {
charset = typeof charset === "string" ? charset : "UTF-8";
let channel = NetUtil.newChannel(uri, charset, null);
let stream = channel.open();
let count = stream.available();
let data = NetUtil.readInputStreamToString(stream, count, { charset : charset });
stream.close();
return data;
}
exports.readURISync = readURISync;