1
0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00
node-red/nodes/core/io/21-httpin.js

451 lines
17 KiB
JavaScript
Raw Normal View History

2013-09-05 16:02:48 +02:00
/**
2015-02-04 21:44:07 +01:00
* Copyright 2013,2015 IBM Corp.
2013-09-05 16:02:48 +02:00
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
**/
2014-05-04 00:32:04 +02:00
module.exports = function(RED) {
"use strict";
2014-05-04 00:32:04 +02:00
var http = require("follow-redirects").http;
var https = require("follow-redirects").https;
var urllib = require("url");
2015-07-15 23:43:24 +02:00
var bodyParser = require("body-parser");
2014-05-04 00:32:04 +02:00
var getBody = require('raw-body');
var mustache = require("mustache");
var querystring = require("querystring");
var cors = require('cors');
2015-07-15 23:43:24 +02:00
var jsonParser = bodyParser.json();
var urlencParser = bodyParser.urlencoded({extended:true});
2015-02-04 21:44:07 +01:00
var onHeaders = require('on-headers');
var typer = require('media-typer');
var isUtf8 = require('is-utf8');
2014-05-04 00:32:04 +02:00
function rawBodyParser(req, res, next) {
2014-07-18 22:49:48 +02:00
if (req._body) { return next(); }
2014-05-04 00:32:04 +02:00
req.body = "";
req._body = true;
var isText = true;
var checkUTF = false;
if (req.headers['content-type']) {
var parsedType = typer.parse(req.headers['content-type'])
if (parsedType.type === "text") {
isText = true;
} else if (parsedType.subtype === "xml" || parsedType.suffix === "xml") {
isText = true;
} else if (parsedType.type !== "application") {
isText = false;
} else if (parsedType.subtype !== "octet-stream") {
checkUTF = true;
}
}
2014-05-04 00:32:04 +02:00
getBody(req, {
length: req.headers['content-length'],
encoding: isText ? "utf8" : null
2014-05-04 00:32:04 +02:00
}, function (err, buf) {
2014-07-18 22:49:48 +02:00
if (err) { return next(err); }
if (!isText && checkUTF && isUtf8(buf)) {
buf = buf.toString()
}
2014-05-04 00:32:04 +02:00
req.body = buf;
next();
});
}
2015-07-15 23:43:24 +02:00
var corsSetup = false;
function createRequestWrapper(node,req) {
var wrapper = {
_req: req
};
var toWrap = [
"param",
"get",
"is",
"acceptsCharset",
"acceptsLanguage",
"app",
"baseUrl",
"body",
"cookies",
"fresh",
"hostname",
"ip",
"ips",
"originalUrl",
"params",
"path",
"protocol",
"query",
"route",
"secure",
"signedCookies",
"stale",
"subdomains",
"xhr",
"socket" // TODO: tidy this up
];
toWrap.forEach(function(f) {
if (typeof req[f] === "function") {
wrapper[f] = function() {
node.warn(RED._("httpin.errors.deprecated-call",{method:"msg.req."+f}));
var result = req[f].apply(req,arguments);
if (result === res) {
return wrapper;
} else {
return result;
}
}
} else {
wrapper[f] = req[f];
}
});
return wrapper;
}
function createResponseWrapper(node,res) {
var wrapper = {
_res: res
};
var toWrap = [
"append",
"attachment",
"cookie",
"clearCookie",
"download",
"end",
"format",
"get",
"json",
"jsonp",
"links",
"location",
"redirect",
"render",
"send",
"sendfile",
"sendFile",
"sendStatus",
"set",
"status",
"type",
"vary"
];
toWrap.forEach(function(f) {
wrapper[f] = function() {
node.warn(RED._("httpin.errors.deprecated-call",{method:"msg.res."+f}));
var result = res[f].apply(res,arguments);
if (result === res) {
return wrapper;
} else {
return result;
}
}
});
return wrapper;
}
2014-05-04 00:32:04 +02:00
function HTTPIn(n) {
RED.nodes.createNode(this,n);
if (RED.settings.httpNodeRoot !== false) {
if (!n.url) {
this.warn(RED._("httpin.errors.missing-path"));
return;
}
2014-05-04 00:32:04 +02:00
this.url = n.url;
this.method = n.method;
this.swaggerDoc = n.swaggerDoc;
2014-05-04 00:32:04 +02:00
var node = this;
2014-05-04 00:32:04 +02:00
this.errorHandler = function(err,req,res,next) {
node.warn(err);
2015-07-15 23:43:24 +02:00
res.sendStatus(500);
2014-05-04 00:32:04 +02:00
};
2014-05-04 00:32:04 +02:00
this.callback = function(req,res) {
var msgid = RED.util.generateId();
res._msgid = msgid;
if (node.method.match(/(^post$|^delete$|^put$|^options$)/)) {
node.send({_msgid:msgid,req:req,res:createResponseWrapper(node,res),payload:req.body});
2014-05-04 00:32:04 +02:00
} else if (node.method == "get") {
node.send({_msgid:msgid,req:req,res:createResponseWrapper(node,res),payload:req.query});
2014-05-04 00:32:04 +02:00
} else {
node.send({_msgid:msgid,req:req,res:createResponseWrapper(node,res)});
}
};
var corsHandler = function(req,res,next) { next(); }
2015-07-15 23:43:24 +02:00
if (RED.settings.httpNodeCors && !corsSetup) {
2014-05-04 00:32:04 +02:00
corsHandler = cors(RED.settings.httpNodeCors);
2015-07-15 23:43:24 +02:00
RED.httpNode.options("*",corsHandler);
corsSetup = true;
2014-05-04 00:32:04 +02:00
}
var httpMiddleware = function(req,res,next) { next(); }
if (RED.settings.httpNodeMiddleware) {
if (typeof RED.settings.httpNodeMiddleware === "function") {
httpMiddleware = RED.settings.httpNodeMiddleware;
}
}
2015-02-04 21:44:07 +01:00
var metricsHandler = function(req,res,next) { next(); }
2015-02-04 21:44:07 +01:00
if (this.metric()) {
metricsHandler = function(req, res, next) {
var startAt = process.hrtime();
onHeaders(res, function() {
if (res._msgid) {
2015-02-04 21:44:07 +01:00
var diff = process.hrtime(startAt);
var ms = diff[0] * 1e3 + diff[1] * 1e-6;
var metricResponseTime = ms.toFixed(3);
var metricContentLength = res._headers["content-length"];
//assuming that _id has been set for res._metrics in HttpOut node!
node.metric("response.time.millis", {_msgid:res._msgid} , metricResponseTime);
node.metric("response.content-length.bytes", {_msgid:res._msgid} , metricContentLength);
2015-02-04 21:44:07 +01:00
}
});
next();
};
}
2014-05-04 00:32:04 +02:00
if (this.method == "get") {
RED.httpNode.get(this.url,httpMiddleware,corsHandler,metricsHandler,this.callback,this.errorHandler);
2014-05-04 00:32:04 +02:00
} else if (this.method == "post") {
RED.httpNode.post(this.url,httpMiddleware,corsHandler,metricsHandler,jsonParser,urlencParser,rawBodyParser,this.callback,this.errorHandler);
2014-05-04 00:32:04 +02:00
} else if (this.method == "put") {
RED.httpNode.put(this.url,httpMiddleware,corsHandler,metricsHandler,jsonParser,urlencParser,rawBodyParser,this.callback,this.errorHandler);
2014-05-04 00:32:04 +02:00
} else if (this.method == "delete") {
RED.httpNode.delete(this.url,httpMiddleware,corsHandler,metricsHandler,jsonParser,urlencParser,rawBodyParser,this.callback,this.errorHandler);
2014-05-04 00:32:04 +02:00
}
2014-05-04 00:32:04 +02:00
this.on("close",function() {
2015-07-15 23:43:24 +02:00
var node = this;
RED.httpNode._router.stack.forEach(function(route,i,routes) {
if (route.route && route.route.path === node.url && route.route.methods[node.method]) {
routes.splice(i,1);
}
2015-07-15 23:43:24 +02:00
});
2014-05-04 00:32:04 +02:00
});
} else {
this.warn(RED._("httpin.errors.not-created"));
}
2014-05-04 00:32:04 +02:00
}
RED.nodes.registerType("http in",HTTPIn);
2014-05-04 00:32:04 +02:00
function HTTPOut(n) {
RED.nodes.createNode(this,n);
var node = this;
this.on("input",function(msg) {
if (msg.res) {
if (msg.headers) {
msg.res._res.set(msg.headers);
}
2014-05-04 00:32:04 +02:00
var statusCode = msg.statusCode || 200;
if (typeof msg.payload == "object" && !Buffer.isBuffer(msg.payload)) {
msg.res._res.status(statusCode).jsonp(msg.payload);
2014-05-04 00:32:04 +02:00
} else {
if (msg.res._res.get('content-length') == null) {
2014-07-09 10:43:02 +02:00
var len;
2014-07-09 10:51:32 +02:00
if (msg.payload == null) {
2014-07-09 10:46:10 +02:00
len = 0;
} else if (Buffer.isBuffer(msg.payload)) {
len = msg.payload.length;
2014-07-09 10:46:10 +02:00
} else if (typeof msg.payload == "number") {
2014-07-09 10:43:02 +02:00
len = Buffer.byteLength(""+msg.payload);
} else {
len = Buffer.byteLength(msg.payload);
}
msg.res._res.set('content-length', len);
}
msg.res._res.status(statusCode).send(msg.payload);
2014-05-04 00:32:04 +02:00
}
} else {
node.warn(RED._("httpin.errors.no-response"));
}
2014-05-04 00:32:04 +02:00
});
}
RED.nodes.registerType("http response",HTTPOut);
2014-05-04 00:32:04 +02:00
function HTTPRequest(n) {
RED.nodes.createNode(this,n);
var nodeUrl = n.url;
var isTemplatedUrl = (nodeUrl||"").indexOf("{{") != -1;
var nodeMethod = n.method || "GET";
this.ret = n.ret || "txt";
2014-05-04 00:32:04 +02:00
var node = this;
var prox, noprox;
if (process.env.http_proxy != null) { prox = process.env.http_proxy; }
if (process.env.HTTP_PROXY != null) { prox = process.env.HTTP_PROXY; }
if (process.env.no_proxy != null) { noprox = process.env.no_proxy.split(","); }
if (process.env.NO_PROXY != null) { noprox = process.env.NO_PROXY.split(","); }
2014-05-04 00:32:04 +02:00
this.on("input",function(msg) {
2015-02-04 21:44:07 +01:00
var preRequestTimestamp = process.hrtime();
2015-07-02 00:02:50 +02:00
node.status({fill:"blue",shape:"dot",text:"httpin.status.requesting"});
var url = nodeUrl || msg.url;
if (msg.url && nodeUrl && (nodeUrl !== msg.url)) { // revert change below when warning is finally removed
2015-05-28 16:29:01 +02:00
node.warn(RED._("common.errors.nooverride"));
}
if (isTemplatedUrl) {
url = mustache.render(nodeUrl,msg);
}
if (!url) {
node.error(RED._("httpin.errors.no-url"),msg);
return;
}
// url must start http:// or https:// so assume http:// if not set
if (!((url.indexOf("http://") === 0) || (url.indexOf("https://") === 0))) {
url = "http://"+url;
}
var method = nodeMethod.toUpperCase() || "GET";
if (msg.method && n.method && (n.method !== "use")) { // warn if override option not set
node.warn(RED._("common.errors.nooverride"));
}
if (msg.method && n.method && (n.method === "use")) {
method = msg.method.toUpperCase(); // use the msg parameter
}
var opts = urllib.parse(url);
opts.method = method;
opts.headers = {};
if (msg.headers) {
2014-07-23 22:28:53 +02:00
for (var v in msg.headers) {
if (msg.headers.hasOwnProperty(v)) {
var name = v.toLowerCase();
if (name !== "content-type" && name !== "content-length") {
// only normalise the known headers used later in this
// function. Otherwise leave them alone.
name = v;
}
opts.headers[name] = msg.headers[v];
2014-07-23 22:28:53 +02:00
}
2014-05-04 00:32:04 +02:00
}
}
if (this.credentials && this.credentials.user) {
opts.auth = this.credentials.user+":"+(this.credentials.password||"");
}
var payload = null;
if (msg.payload && (method == "POST" || method == "PUT" || method == "PATCH" ) ) {
if (typeof msg.payload === "string" || Buffer.isBuffer(msg.payload)) {
payload = msg.payload;
} else if (typeof msg.payload == "number") {
payload = msg.payload+"";
} else {
if (opts.headers['content-type'] == 'application/x-www-form-urlencoded') {
payload = querystring.stringify(msg.payload);
} else {
payload = JSON.stringify(msg.payload);
if (opts.headers['content-type'] == null) {
opts.headers['content-type'] = "application/json";
}
}
}
if (opts.headers['content-length'] == null) {
if (Buffer.isBuffer(payload)) {
opts.headers['content-length'] = payload.length;
} else {
opts.headers['content-length'] = Buffer.byteLength(payload);
}
}
}
var urltotest = url;
var noproxy;
if (noprox) {
for (var i in noprox) {
if (url.indexOf(noprox[i]) !== -1) { noproxy=true; }
}
}
if (prox && !noproxy) {
var match = prox.match(/^(http:\/\/)?(.+)?:([0-9]+)?/i);
if (match) {
//opts.protocol = "http:";
//opts.host = opts.hostname = match[2];
//opts.port = (match[3] != null ? match[3] : 80);
opts.headers['Host'] = opts.host;
var heads = opts.headers;
var path = opts.pathname = opts.href;
opts = urllib.parse(prox);
opts.path = opts.pathname = path;
opts.headers = heads;
opts.method = method;
//console.log(opts);
urltotest = match[0];
}
else { node.warn("Bad proxy url: "+process.env.http_proxy); }
}
var req = ((/^https/.test(urltotest))?https:http).request(opts,function(res) {
(node.ret === "bin") ? res.setEncoding('binary') : res.setEncoding('utf8');
msg.statusCode = res.statusCode;
msg.headers = res.headers;
msg.payload = "";
// msg.url = url; // revert when warning above finally removed
res.on('data',function(chunk) {
msg.payload += chunk;
});
res.on('end',function() {
2015-02-04 21:44:07 +01:00
if (node.metric()) {
// Calculate request time
var diff = process.hrtime(preRequestTimestamp);
var ms = diff[0] * 1e3 + diff[1] * 1e-6;
var metricRequestDurationMillis = ms.toFixed(3);
node.metric("duration.millis", msg, metricRequestDurationMillis);
if (res.client && res.client.bytesRead) {
2015-02-04 21:44:07 +01:00
node.metric("size.bytes", msg, res.client.bytesRead);
}
}
if (node.ret === "bin") {
msg.payload = new Buffer(msg.payload,"binary");
}
else if (node.ret === "obj") {
try { msg.payload = JSON.parse(msg.payload); }
catch(e) { node.warn(RED._("httpin.errors.json-error")); }
}
node.send(msg);
node.status({});
});
});
req.on('error',function(err) {
msg.payload = err.toString() + " : " + url;
msg.statusCode = err.code;
node.send(msg);
node.status({fill:"red",shape:"ring",text:err.code});
});
if (payload) {
req.write(payload);
}
req.end();
2014-05-04 00:32:04 +02:00
});
}
RED.nodes.registerType("http request",HTTPRequest,{
credentials: {
user: {type:"text"},
password: {type: "password"}
}
2014-05-04 00:32:04 +02:00
});
}