mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-01 14:45:29 +00:00
619 lines
17 KiB
JavaScript
619 lines
17 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/. */
|
|
|
|
const {classes: Cc, interfaces: Ci, utils: Cu, results: Cr} = Components;
|
|
|
|
const EXPORTED_SYMBOLS = [
|
|
"RESTRequest",
|
|
"RESTResponse",
|
|
"TokenAuthenticatedRESTRequest"
|
|
];
|
|
|
|
Cu.import("resource://gre/modules/Services.jsm");
|
|
Cu.import("resource://gre/modules/XPCOMUtils.jsm");
|
|
Cu.import("resource://services-crypto/utils.js");
|
|
Cu.import("resource://services-common/log4moz.js");
|
|
Cu.import("resource://services-common/preferences.js");
|
|
Cu.import("resource://services-common/utils.js");
|
|
|
|
const Prefs = new Preferences("services.common.rest.");
|
|
|
|
/**
|
|
* Single use HTTP requests to RESTish resources.
|
|
*
|
|
* @param uri
|
|
* URI for the request. This can be an nsIURI object or a string
|
|
* that can be used to create one. An exception will be thrown if
|
|
* the string is not a valid URI.
|
|
*
|
|
* Examples:
|
|
*
|
|
* (1) Quick GET request:
|
|
*
|
|
* new RESTRequest("http://server/rest/resource").get(function (error) {
|
|
* if (error) {
|
|
* // Deal with a network error.
|
|
* processNetworkErrorCode(error.result);
|
|
* return;
|
|
* }
|
|
* if (!this.response.success) {
|
|
* // Bail out if we're not getting an HTTP 2xx code.
|
|
* processHTTPError(this.response.status);
|
|
* return;
|
|
* }
|
|
* processData(this.response.body);
|
|
* });
|
|
*
|
|
* (2) Quick PUT request (non-string data is automatically JSONified)
|
|
*
|
|
* new RESTRequest("http://server/rest/resource").put(data, function (error) {
|
|
* ...
|
|
* });
|
|
*
|
|
* (3) Streaming GET
|
|
*
|
|
* let request = new RESTRequest("http://server/rest/resource");
|
|
* request.setHeader("Accept", "application/newlines");
|
|
* request.onComplete = function (error) {
|
|
* if (error) {
|
|
* // Deal with a network error.
|
|
* processNetworkErrorCode(error.result);
|
|
* return;
|
|
* }
|
|
* callbackAfterRequestHasCompleted()
|
|
* });
|
|
* request.onProgress = function () {
|
|
* if (!this.response.success) {
|
|
* // Bail out if we're not getting an HTTP 2xx code.
|
|
* return;
|
|
* }
|
|
* // Process body data and reset it so we don't process the same data twice.
|
|
* processIncrementalData(this.response.body);
|
|
* this.response.body = "";
|
|
* });
|
|
* request.get();
|
|
*/
|
|
function RESTRequest(uri) {
|
|
this.status = this.NOT_SENT;
|
|
|
|
// If we don't have an nsIURI object yet, make one. This will throw if
|
|
// 'uri' isn't a valid URI string.
|
|
if (!(uri instanceof Ci.nsIURI)) {
|
|
uri = Services.io.newURI(uri, null, null);
|
|
}
|
|
this.uri = uri;
|
|
|
|
this._headers = {};
|
|
this._log = Log4Moz.repository.getLogger(this._logName);
|
|
this._log.level =
|
|
Log4Moz.Level[Prefs.get("log.logger.rest.request")];
|
|
}
|
|
RESTRequest.prototype = {
|
|
|
|
_logName: "Services.Common.RESTRequest",
|
|
|
|
QueryInterface: XPCOMUtils.generateQI([
|
|
Ci.nsIBadCertListener2,
|
|
Ci.nsIInterfaceRequestor,
|
|
Ci.nsIChannelEventSink
|
|
]),
|
|
|
|
/*** Public API: ***/
|
|
|
|
/**
|
|
* URI for the request (an nsIURI object).
|
|
*/
|
|
uri: null,
|
|
|
|
/**
|
|
* HTTP method (e.g. "GET")
|
|
*/
|
|
method: null,
|
|
|
|
/**
|
|
* RESTResponse object
|
|
*/
|
|
response: null,
|
|
|
|
/**
|
|
* nsIRequest load flags. Don't do any caching by default.
|
|
*/
|
|
loadFlags: Ci.nsIRequest.LOAD_BYPASS_CACHE | Ci.nsIRequest.INHIBIT_CACHING,
|
|
|
|
/**
|
|
* nsIHttpChannel
|
|
*/
|
|
channel: null,
|
|
|
|
/**
|
|
* Flag to indicate the status of the request.
|
|
*
|
|
* One of NOT_SENT, SENT, IN_PROGRESS, COMPLETED, ABORTED.
|
|
*/
|
|
status: null,
|
|
|
|
NOT_SENT: 0,
|
|
SENT: 1,
|
|
IN_PROGRESS: 2,
|
|
COMPLETED: 4,
|
|
ABORTED: 8,
|
|
|
|
/**
|
|
* Request timeout (in seconds, though decimal values can be used for
|
|
* up to millisecond granularity.)
|
|
*
|
|
* 0 for no timeout.
|
|
*/
|
|
timeout: null,
|
|
|
|
/**
|
|
* Called when the request has been completed, including failures and
|
|
* timeouts.
|
|
*
|
|
* @param error
|
|
* Error that occurred while making the request, null if there
|
|
* was no error.
|
|
*/
|
|
onComplete: function onComplete(error) {
|
|
},
|
|
|
|
/**
|
|
* Called whenever data is being received on the channel. If this throws an
|
|
* exception, the request is aborted and the exception is passed as the
|
|
* error to onComplete().
|
|
*/
|
|
onProgress: function onProgress() {
|
|
},
|
|
|
|
/**
|
|
* Set a request header.
|
|
*/
|
|
setHeader: function setHeader(name, value) {
|
|
this._headers[name.toLowerCase()] = value;
|
|
},
|
|
|
|
/**
|
|
* Perform an HTTP GET.
|
|
*
|
|
* @param onComplete
|
|
* Short-circuit way to set the 'onComplete' method. Optional.
|
|
* @param onProgress
|
|
* Short-circuit way to set the 'onProgress' method. Optional.
|
|
*
|
|
* @return the request object.
|
|
*/
|
|
get: function get(onComplete, onProgress) {
|
|
return this.dispatch("GET", null, onComplete, onProgress);
|
|
},
|
|
|
|
/**
|
|
* Perform an HTTP PUT.
|
|
*
|
|
* @param data
|
|
* Data to be used as the request body. If this isn't a string
|
|
* it will be JSONified automatically.
|
|
* @param onComplete
|
|
* Short-circuit way to set the 'onComplete' method. Optional.
|
|
* @param onProgress
|
|
* Short-circuit way to set the 'onProgress' method. Optional.
|
|
*
|
|
* @return the request object.
|
|
*/
|
|
put: function put(data, onComplete, onProgress) {
|
|
return this.dispatch("PUT", data, onComplete, onProgress);
|
|
},
|
|
|
|
/**
|
|
* Perform an HTTP POST.
|
|
*
|
|
* @param data
|
|
* Data to be used as the request body. If this isn't a string
|
|
* it will be JSONified automatically.
|
|
* @param onComplete
|
|
* Short-circuit way to set the 'onComplete' method. Optional.
|
|
* @param onProgress
|
|
* Short-circuit way to set the 'onProgress' method. Optional.
|
|
*
|
|
* @return the request object.
|
|
*/
|
|
post: function post(data, onComplete, onProgress) {
|
|
return this.dispatch("POST", data, onComplete, onProgress);
|
|
},
|
|
|
|
/**
|
|
* Perform an HTTP DELETE.
|
|
*
|
|
* @param onComplete
|
|
* Short-circuit way to set the 'onComplete' method. Optional.
|
|
* @param onProgress
|
|
* Short-circuit way to set the 'onProgress' method. Optional.
|
|
*
|
|
* @return the request object.
|
|
*/
|
|
delete: function delete_(onComplete, onProgress) {
|
|
return this.dispatch("DELETE", null, onComplete, onProgress);
|
|
},
|
|
|
|
/**
|
|
* Abort an active request.
|
|
*/
|
|
abort: function abort() {
|
|
if (this.status != this.SENT && this.status != this.IN_PROGRESS) {
|
|
throw "Can only abort a request that has been sent.";
|
|
}
|
|
|
|
this.status = this.ABORTED;
|
|
this.channel.cancel(Cr.NS_BINDING_ABORTED);
|
|
|
|
if (this.timeoutTimer) {
|
|
// Clear the abort timer now that the channel is done.
|
|
this.timeoutTimer.clear();
|
|
}
|
|
},
|
|
|
|
/*** Implementation stuff ***/
|
|
|
|
dispatch: function dispatch(method, data, onComplete, onProgress) {
|
|
if (this.status != this.NOT_SENT) {
|
|
throw "Request has already been sent!";
|
|
}
|
|
|
|
this.method = method;
|
|
if (onComplete) {
|
|
this.onComplete = onComplete;
|
|
}
|
|
if (onProgress) {
|
|
this.onProgress = onProgress;
|
|
}
|
|
|
|
// Create and initialize HTTP channel.
|
|
let channel = Services.io.newChannelFromURI(this.uri, null, null)
|
|
.QueryInterface(Ci.nsIRequest)
|
|
.QueryInterface(Ci.nsIHttpChannel);
|
|
this.channel = channel;
|
|
channel.loadFlags |= this.loadFlags;
|
|
channel.notificationCallbacks = this;
|
|
|
|
// Set request headers.
|
|
let headers = this._headers;
|
|
for (let key in headers) {
|
|
if (key == 'authorization') {
|
|
this._log.trace("HTTP Header " + key + ": ***** (suppressed)");
|
|
} else {
|
|
this._log.trace("HTTP Header " + key + ": " + headers[key]);
|
|
}
|
|
channel.setRequestHeader(key, headers[key], false);
|
|
}
|
|
|
|
// Set HTTP request body.
|
|
if (method == "PUT" || method == "POST") {
|
|
// Convert non-string bodies into JSON.
|
|
if (typeof data != "string") {
|
|
data = JSON.stringify(data);
|
|
}
|
|
|
|
this._log.debug(method + " Length: " + data.length);
|
|
if (this._log.level <= Log4Moz.Level.Trace) {
|
|
this._log.trace(method + " Body: " + data);
|
|
}
|
|
|
|
let stream = Cc["@mozilla.org/io/string-input-stream;1"]
|
|
.createInstance(Ci.nsIStringInputStream);
|
|
stream.setData(data, data.length);
|
|
|
|
let type = headers["content-type"] || "text/plain";
|
|
channel.QueryInterface(Ci.nsIUploadChannel);
|
|
channel.setUploadStream(stream, type, data.length);
|
|
}
|
|
// We must set this after setting the upload stream, otherwise it
|
|
// will always be 'PUT'. Yeah, I know.
|
|
channel.requestMethod = method;
|
|
|
|
// Blast off!
|
|
channel.asyncOpen(this, null);
|
|
this.status = this.SENT;
|
|
this.delayTimeout();
|
|
return this;
|
|
},
|
|
|
|
/**
|
|
* Create or push back the abort timer that kills this request.
|
|
*/
|
|
delayTimeout: function delayTimeout() {
|
|
if (this.timeout) {
|
|
CommonUtils.namedTimer(this.abortTimeout, this.timeout * 1000, this,
|
|
"timeoutTimer");
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Abort the request based on a timeout.
|
|
*/
|
|
abortTimeout: function abortTimeout() {
|
|
this.abort();
|
|
let error = Components.Exception("Aborting due to channel inactivity.",
|
|
Cr.NS_ERROR_NET_TIMEOUT);
|
|
if (!this.onComplete) {
|
|
this._log.error("Unexpected error: onComplete not defined in " +
|
|
"abortTimeout.")
|
|
return;
|
|
}
|
|
this.onComplete(error);
|
|
},
|
|
|
|
/*** nsIStreamListener ***/
|
|
|
|
onStartRequest: function onStartRequest(channel) {
|
|
if (this.status == this.ABORTED) {
|
|
this._log.trace("Not proceeding with onStartRequest, request was aborted.");
|
|
return;
|
|
}
|
|
|
|
try {
|
|
channel.QueryInterface(Ci.nsIHttpChannel);
|
|
} catch (ex) {
|
|
this._log.error("Unexpected error: channel is not a nsIHttpChannel!");
|
|
this.status = this.ABORTED;
|
|
channel.cancel(Cr.NS_BINDING_ABORTED);
|
|
return;
|
|
}
|
|
|
|
this.status = this.IN_PROGRESS;
|
|
|
|
this._log.trace("onStartRequest: " + channel.requestMethod + " " +
|
|
channel.URI.spec);
|
|
|
|
// Create a response object and fill it with some data.
|
|
let response = this.response = new RESTResponse();
|
|
response.request = this;
|
|
response.body = "";
|
|
|
|
// Define this here so that we don't have make a new one each time
|
|
// onDataAvailable() gets called.
|
|
this._inputStream = Cc["@mozilla.org/scriptableinputstream;1"]
|
|
.createInstance(Ci.nsIScriptableInputStream);
|
|
|
|
this.delayTimeout();
|
|
},
|
|
|
|
onStopRequest: function onStopRequest(channel, context, statusCode) {
|
|
if (this.timeoutTimer) {
|
|
// Clear the abort timer now that the channel is done.
|
|
this.timeoutTimer.clear();
|
|
}
|
|
|
|
// We don't want to do anything for a request that's already been aborted.
|
|
if (this.status == this.ABORTED) {
|
|
this._log.trace("Not proceeding with onStopRequest, request was aborted.");
|
|
return;
|
|
}
|
|
|
|
try {
|
|
channel.QueryInterface(Ci.nsIHttpChannel);
|
|
} catch (ex) {
|
|
this._log.error("Unexpected error: channel not nsIHttpChannel!");
|
|
this.status = this.ABORTED;
|
|
return;
|
|
}
|
|
this.status = this.COMPLETED;
|
|
|
|
let statusSuccess = Components.isSuccessCode(statusCode);
|
|
let uri = channel && channel.URI && channel.URI.spec || "<unknown>";
|
|
this._log.trace("Channel for " + channel.requestMethod + " " + uri +
|
|
" returned status code " + statusCode);
|
|
|
|
if (!this.onComplete) {
|
|
this._log.error("Unexpected error: onComplete not defined in " +
|
|
"abortRequest.");
|
|
this.onProgress = null;
|
|
return;
|
|
}
|
|
|
|
// Throw the failure code and stop execution. Use Components.Exception()
|
|
// instead of Error() so the exception is QI-able and can be passed across
|
|
// XPCOM borders while preserving the status code.
|
|
if (!statusSuccess) {
|
|
let message = Components.Exception("", statusCode).name;
|
|
let error = Components.Exception(message, statusCode);
|
|
this.onComplete(error);
|
|
this.onComplete = this.onProgress = null;
|
|
return;
|
|
}
|
|
|
|
this._log.debug(this.method + " " + uri + " " + this.response.status);
|
|
|
|
// Additionally give the full response body when Trace logging.
|
|
if (this._log.level <= Log4Moz.Level.Trace) {
|
|
this._log.trace(this.method + " body: " + this.response.body);
|
|
}
|
|
|
|
delete this._inputStream;
|
|
|
|
this.onComplete(null);
|
|
this.onComplete = this.onProgress = null;
|
|
},
|
|
|
|
onDataAvailable: function onDataAvailable(req, cb, stream, off, count) {
|
|
this._inputStream.init(stream);
|
|
try {
|
|
this.response.body += this._inputStream.read(count);
|
|
} catch (ex) {
|
|
this._log.warn("Exception thrown reading " + count +
|
|
" bytes from the channel.");
|
|
this._log.debug(CommonUtils.exceptionStr(ex));
|
|
throw ex;
|
|
}
|
|
|
|
try {
|
|
this.onProgress();
|
|
} catch (ex) {
|
|
this._log.warn("Got exception calling onProgress handler, aborting " +
|
|
this.method + " " + req.URI.spec);
|
|
this._log.debug("Exception: " + CommonUtils.exceptionStr(ex));
|
|
this.abort();
|
|
|
|
if (!this.onComplete) {
|
|
this._log.error("Unexpected error: onComplete not defined in " +
|
|
"onDataAvailable.");
|
|
this.onProgress = null;
|
|
return;
|
|
}
|
|
|
|
this.onComplete(ex);
|
|
this.onComplete = this.onProgress = null;
|
|
return;
|
|
}
|
|
|
|
this.delayTimeout();
|
|
},
|
|
|
|
/*** nsIInterfaceRequestor ***/
|
|
|
|
getInterface: function(aIID) {
|
|
return this.QueryInterface(aIID);
|
|
},
|
|
|
|
/*** nsIBadCertListener2 ***/
|
|
|
|
notifyCertProblem: function notifyCertProblem(socketInfo, sslStatus, targetHost) {
|
|
this._log.warn("Invalid HTTPS certificate encountered!");
|
|
// Suppress invalid HTTPS certificate warnings in the UI.
|
|
// (The request will still fail.)
|
|
return true;
|
|
},
|
|
|
|
/*** nsIChannelEventSink ***/
|
|
asyncOnChannelRedirect:
|
|
function asyncOnChannelRedirect(oldChannel, newChannel, flags, callback) {
|
|
|
|
try {
|
|
newChannel.QueryInterface(Ci.nsIHttpChannel);
|
|
} catch (ex) {
|
|
this._log.error("Unexpected error: channel not nsIHttpChannel!");
|
|
callback.onRedirectVerifyCallback(Cr.NS_ERROR_NO_INTERFACE);
|
|
return;
|
|
}
|
|
|
|
this.channel = newChannel;
|
|
|
|
// We let all redirects proceed.
|
|
callback.onRedirectVerifyCallback(Cr.NS_OK);
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Response object for a RESTRequest. This will be created automatically by
|
|
* the RESTRequest.
|
|
*/
|
|
function RESTResponse() {
|
|
this._log = Log4Moz.repository.getLogger(this._logName);
|
|
this._log.level =
|
|
Log4Moz.Level[Prefs.get("log.logger.rest.response")];
|
|
}
|
|
RESTResponse.prototype = {
|
|
|
|
_logName: "Sync.RESTResponse",
|
|
|
|
/**
|
|
* Corresponding REST request
|
|
*/
|
|
request: null,
|
|
|
|
/**
|
|
* HTTP status code
|
|
*/
|
|
get status() {
|
|
let status;
|
|
try {
|
|
let channel = this.request.channel.QueryInterface(Ci.nsIHttpChannel);
|
|
status = channel.responseStatus;
|
|
} catch (ex) {
|
|
this._log.debug("Caught exception fetching HTTP status code:" +
|
|
CommonUtils.exceptionStr(ex));
|
|
return null;
|
|
}
|
|
delete this.status;
|
|
return this.status = status;
|
|
},
|
|
|
|
/**
|
|
* Boolean flag that indicates whether the HTTP status code is 2xx or not.
|
|
*/
|
|
get success() {
|
|
let success;
|
|
try {
|
|
let channel = this.request.channel.QueryInterface(Ci.nsIHttpChannel);
|
|
success = channel.requestSucceeded;
|
|
} catch (ex) {
|
|
this._log.debug("Caught exception fetching HTTP success flag:" +
|
|
CommonUtils.exceptionStr(ex));
|
|
return null;
|
|
}
|
|
delete this.success;
|
|
return this.success = success;
|
|
},
|
|
|
|
/**
|
|
* Object containing HTTP headers (keyed as lower case)
|
|
*/
|
|
get headers() {
|
|
let headers = {};
|
|
try {
|
|
this._log.trace("Processing response headers.");
|
|
let channel = this.request.channel.QueryInterface(Ci.nsIHttpChannel);
|
|
channel.visitResponseHeaders(function (header, value) {
|
|
headers[header.toLowerCase()] = value;
|
|
});
|
|
} catch (ex) {
|
|
this._log.debug("Caught exception processing response headers:" +
|
|
CommonUtils.exceptionStr(ex));
|
|
return null;
|
|
}
|
|
|
|
delete this.headers;
|
|
return this.headers = headers;
|
|
},
|
|
|
|
/**
|
|
* HTTP body (string)
|
|
*/
|
|
body: null
|
|
|
|
};
|
|
|
|
/**
|
|
* Single use MAC authenticated HTTP requests to RESTish resources.
|
|
*
|
|
* @param uri
|
|
* URI going to the RESTRequest constructor.
|
|
* @param authToken
|
|
* (Object) An auth token of the form {id: (string), key: (string)}
|
|
* from which the MAC Authentication header for this request will be
|
|
* derived. A token as obtained from
|
|
* TokenServerClient.getTokenFromBrowserIDAssertion is accepted.
|
|
* @param extra
|
|
* (Object) Optional extra parameters. Valid keys are: nonce_bytes, ts,
|
|
* nonce, and ext. See CrytoUtils.computeHTTPMACSHA1 for information on
|
|
* the purpose of these values.
|
|
*/
|
|
function TokenAuthenticatedRESTRequest(uri, authToken, extra) {
|
|
RESTRequest.call(this, uri);
|
|
this.authToken = authToken;
|
|
this.extra = extra || {};
|
|
}
|
|
TokenAuthenticatedRESTRequest.prototype = {
|
|
__proto__: RESTRequest.prototype,
|
|
|
|
dispatch: function dispatch(method, data, onComplete, onProgress) {
|
|
let sig = CryptoUtils.computeHTTPMACSHA1(
|
|
this.authToken.id, this.authToken.key, method, this.uri, this.extra
|
|
);
|
|
|
|
this.setHeader("Authorization", sig.getHeader());
|
|
|
|
return RESTRequest.prototype.dispatch.call(
|
|
this, method, data, onComplete, onProgress
|
|
);
|
|
},
|
|
}; |