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
|
/* 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": "stable"
};
const { ns } = require("./core/namespace");
const { emit } = require("./event/core");
const { merge } = require("./util/object");
const { stringify } = require("./querystring");
const { EventTarget } = require("./event/target");
const { Class } = require("./core/heritage");
const { XMLHttpRequest } = require("./net/xhr");
const apiUtils = require("./deprecated/api-utils");
const response = ns();
const request = ns();
// Instead of creating a new validator for each request, just make one and
// reuse it.
const { validateOptions, validateSingleOption } = new OptionsValidator({
url: {
//XXXzpao should probably verify that url is a valid url as well
is: ["string"]
},
headers: {
map: function (v) v || {},
is: ["object"],
},
content: {
map: function (v) v || null,
is: ["string", "object", "null"],
},
contentType: {
map: function (v) v || "application/x-www-form-urlencoded",
is: ["string"],
},
overrideMimeType: {
map: function(v) v || null,
is: ["string", "null"],
}
});
const REUSE_ERROR = "This request object has been used already. You must " +
"create a new one to make a new request."
// Utility function to prep the request since it's the same between GET and
// POST
function runRequest(mode, target) {
let source = request(target)
let { xhr, url, content, contentType, headers, overrideMimeType } = source;
// If this request has already been used, then we can't reuse it.
// Throw an error.
if (xhr)
throw new Error(REUSE_ERROR);
xhr = source.xhr = new XMLHttpRequest();
// Build the data to be set. For GET requests, we want to append that to
// the URL before opening the request.
let data = stringify(content);
// If the URL already has ? in it, then we want to just use &
if (mode == "GET" && data)
url = url + (/\?/.test(url) ? "&" : "?") + data;
// open the request
xhr.open(mode, url);
// request header must be set after open, but before send
xhr.setRequestHeader("Content-Type", contentType);
// set other headers
Object.keys(headers).forEach(function(name) {
xhr.setRequestHeader(name, headers[name]);
});
// set overrideMimeType
if (overrideMimeType)
xhr.overrideMimeType(overrideMimeType);
// handle the readystate, create the response, and call the callback
xhr.onreadystatechange = function onreadystatechange() {
if (xhr.readyState === 4) {
let response = Response(xhr);
source.response = response;
emit(target, 'complete', response);
}
};
// actually send the request.
// We don't want to send data on GET requests.
xhr.send(mode !== "GET" ? data : null);
}
const Request = Class({
extends: EventTarget,
initialize: function initialize(options) {
// `EventTarget.initialize` will set event listeners that are named
// like `onEvent` in this case `onComplete` listener will be set to
// `complete` event.
EventTarget.prototype.initialize.call(this, options);
// Copy normalized options.
merge(request(this), validateOptions(options));
},
get url() { return request(this).url; },
set url(value) { request(this).url = validateSingleOption('url', value); },
get headers() { return request(this).headers; },
set headers(value) {
return request(this).headers = validateSingleOption('headers', value);
},
get content() { return request(this).content; },
set content(value) {
request(this).content = validateSingleOption('content', value);
},
get contentType() { return request(this).contentType; },
set contentType(value) {
request(this).contentType = validateSingleOption('contentType', value);
},
get response() { return request(this).response; },
get: function() {
runRequest('GET', this);
return this;
},
post: function() {
runRequest('POST', this);
return this;
},
put: function() {
runRequest('PUT', this);
return this;
}
});
exports.Request = Request;
const Response = Class({
initialize: function initialize(request) {
response(this).request = request;
},
get text() response(this).request.responseText,
get xml() {
throw new Error("Sorry, the 'xml' property is no longer available. " +
"see bug 611042 for more information.");
},
get status() response(this).request.status,
get statusText() response(this).request.statusText,
get json() {
try {
return JSON.parse(this.text);
} catch(error) {
return null;
}
},
get headers() {
let headers = {}, lastKey;
// Since getAllResponseHeaders() will return null if there are no headers,
// defend against it by defaulting to ""
let rawHeaders = response(this).request.getAllResponseHeaders() || "";
rawHeaders.split("\n").forEach(function (h) {
// According to the HTTP spec, the header string is terminated by an empty
// line, so we can just skip it.
if (!h.length) {
return;
}
let index = h.indexOf(":");
// The spec allows for leading spaces, so instead of assuming a single
// leading space, just trim the values.
let key = h.substring(0, index).trim(),
val = h.substring(index + 1).trim();
// For empty keys, that means that the header value spanned multiple lines.
// In that case we should append the value to the value of lastKey with a
// new line. We'll assume lastKey will be set because there should never
// be an empty key on the first pass.
if (key) {
headers[key] = val;
lastKey = key;
}
else {
headers[lastKey] += "\n" + val;
}
});
return headers;
}
});
// apiUtils.validateOptions doesn't give the ability to easily validate single
// options, so this is a wrapper that provides that ability.
function OptionsValidator(rules) {
return {
validateOptions: function (options) {
return apiUtils.validateOptions(options, rules);
},
validateSingleOption: function (field, value) {
// We need to create a single rule object from our listed rules. To avoid
// JavaScript String warnings, check for the field & default to an empty object.
let singleRule = {};
if (field in rules) {
singleRule[field] = rules[field];
}
let singleOption = {};
singleOption[field] = value;
// This should throw if it's invalid, which will bubble up & out.
return apiUtils.validateOptions(singleOption, singleRule)[field];
}
};
}
|
