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 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661
|
// httpd.cxx -- a http daemon subsystem based on Mongoose http
//
// Written by Torsten Dreyer, started April 2014.
//
// Copyright (C) 2014 Torsten Dreyer
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 2 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#include "httpd.hxx"
#include "HTTPRequest.hxx"
#include "PropertyChangeWebsocket.hxx"
#include "MirrorPropertyTreeWebsocket.hxx"
#include "ScreenshotUriHandler.hxx"
#include "PropertyUriHandler.hxx"
#include "JsonUriHandler.hxx"
#include "FlightHistoryUriHandler.hxx"
#include "PkgUriHandler.hxx"
#include "RunUriHandler.hxx"
#include "NavdbUriHandler.hxx"
#include "PropertyChangeObserver.hxx"
#include <Main/fg_props.hxx>
#include <Include/version.h>
#include <3rdparty/mongoose/mongoose.h>
#include <3rdparty/cjson/cJSON.h>
#include <string>
#include <vector>
using std::string;
using std::vector;
namespace flightgear {
namespace http {
const char * PROPERTY_ROOT = "/sim/http";
/**
* A Helper class for URI Handlers
*
* This class stores a list of URI Handlers and provides a lookup
* method for find the handler by it's URI prefix
*/
class URIHandlerMap: public vector<SGSharedPtr<URIHandler> > {
public:
/**
* Find a URI Handler for a given URI
*
* Look for the first handler with a uri matching the beginning
* of the given uri parameter.
*
* @param uri The uri to find the handler for
* @return a SGSharedPtr of the URIHandler or an invalid SGSharedPtr if not found
*/
SGSharedPtr<URIHandler> findHandler(const std::string & uri)
{
for (iterator it = begin(); it != end(); ++it) {
SGSharedPtr<URIHandler> handler = *it;
// check if the request-uri starts with the registered uri-string
if (0 == uri.find(handler->getUri())) return handler;
}
return SGSharedPtr<URIHandler>();
}
};
/**
* A Helper class to create a HTTPRequest from a mongoose connection struct
*/
class MongooseHTTPRequest: public HTTPRequest {
private:
/**
* Creates a std::string from a char pointer and an optionally given length
* If the pointer is NULL or the length is zero, return an empty string
* If no length is given, create a std::string from a c-string (up to the /0 terminator)
* If length is given, use as many chars as given in length (can exceed the /0 terminator)
*
* @param cp Points to the source of the string
* @param len The number of chars to copy to the new string (optional)
* @return a std::string containing a copy of the source
*/
static inline string NotNull(const char * cp, size_t len = string::npos)
{
if ( NULL == cp || 0 == len) return string("");
if (string::npos == len) return string(cp);
return string(cp, len);
}
public:
/**
* Constructs a HTTPRequest from a mongoose connection struct
* Copies all fields into STL compatible local elements, performs urlDecode etc.
*
* @param connection the mongoose connection struct with the source data
*/
MongooseHTTPRequest(struct mg_connection * connection)
{
Method = NotNull(connection->request_method);
Uri = urlDecode(NotNull(connection->uri));
HttpVersion = NotNull(connection->http_version);
QueryString = NotNull(connection->query_string);
remoteAddress = NotNull(connection->remote_ip);
remotePort = connection->remote_port;
localAddress = NotNull(connection->local_ip);
localPort = connection->local_port;
using namespace simgear::strutils;
string_list pairs = split(string(QueryString), "&");
for (string_list::iterator it = pairs.begin(); it != pairs.end(); ++it) {
string_list nvp = split(*it, "=");
if (nvp.size() != 2) continue;
RequestVariables.insert(make_pair(urlDecode(nvp[0]), urlDecode(nvp[1])));
}
for (int i = 0; i < connection->num_headers; i++)
HeaderVariables[connection->http_headers[i].name] = connection->http_headers[i].value;
Content = NotNull(connection->content, connection->content_len);
}
/**
* Decodes a URL encoded string
* replaces '+' by ' '
* replaces %nn hexdigits
*
* @param s The source string do decode
* @return The decoded String
*/
static string urlDecode(const string & s)
{
string r = "";
int max = s.length();
int a, b;
for (int i = 0; i < max; i++) {
if (s[i] == '+') {
r += ' ';
} else if (s[i] == '%' && i + 2 < max && isxdigit(s[i + 1]) && isxdigit(s[i + 2])) {
i++;
a = isdigit(s[i]) ? s[i] - '0' : toupper(s[i]) - 'A' + 10;
i++;
b = isdigit(s[i]) ? s[i] - '0' : toupper(s[i]) - 'A' + 10;
r += (char) (a * 16 + b);
} else {
r += s[i];
}
}
return r;
}
};
/**
* A FGHttpd implementation based on mongoose httpd
*
* Mongoose API is documented here: http://cesanta.com/docs/API.shtml
*/
class MongooseHttpd: public FGHttpd {
public:
/**
* Construct a MongooseHttpd object from options in a PropertyNode
*/
MongooseHttpd(SGPropertyNode_ptr);
/**
* Cleanup et.al.
*/
~MongooseHttpd();
/**
* override SGSubsystem::init()
*
* Reads the configuration PropertyNode, installs URIHandlers and configures mongoose
*/
void init();
/**
* override SGSubsystem::bind()
*
* Currently a noop
*/
void bind();
/**
* override SGSubsystem::unbind()
* shutdown of mongoose, clear connections, unregister URIHandlers
*/
void unbind();
/**
* overrride SGSubsystem::update()
* poll connections, check for changed properties
*/
void update(double dt);
/**
* Returns a URIHandler for the given uri
*
* @see URIHandlerMap::findHandler( const std::string & uri )
*/
SGSharedPtr<URIHandler> findHandler(const std::string & uri)
{
return _uriHandler.findHandler(uri);
}
Websocket * newWebsocket(const string & uri);
private:
int poll(struct mg_connection * connection);
int auth(struct mg_connection * connection);
int request(struct mg_connection * connection);
int onConnect(struct mg_connection * connection);
void close(struct mg_connection * connection);
static int staticRequestHandler(struct mg_connection *, mg_event event);
struct mg_server *_server;
SGPropertyNode_ptr _configNode;
typedef int (MongooseHttpd::*handler_t)(struct mg_connection *);
URIHandlerMap _uriHandler;
PropertyChangeObserver _propertyChangeObserver;
};
class MongooseConnection: public Connection {
public:
MongooseConnection(MongooseHttpd * httpd)
: _httpd(httpd)
{
}
virtual ~MongooseConnection();
virtual void close(struct mg_connection * connection) = 0;
virtual int poll(struct mg_connection * connection) = 0;
virtual int request(struct mg_connection * connection) = 0;
virtual int onConnect(struct mg_connection * connection) {return 0;}
virtual void write(const char * data, size_t len)
{
if (_connection) mg_send_data(_connection, data, len);
}
static MongooseConnection * getConnection(MongooseHttpd * httpd, struct mg_connection * connection);
protected:
void setConnection(struct mg_connection * connection)
{
_connection = connection;
}
MongooseHttpd * _httpd;
struct mg_connection * _connection;
};
MongooseConnection::~MongooseConnection()
{
}
class RegularConnection: public MongooseConnection {
public:
RegularConnection(MongooseHttpd * httpd)
: MongooseConnection(httpd)
{
}
virtual ~RegularConnection()
{
}
virtual void close(struct mg_connection * connection);
virtual int poll(struct mg_connection * connection);
virtual int request(struct mg_connection * connection);
private:
SGSharedPtr<URIHandler> _handler;
};
class WebsocketConnection: public MongooseConnection {
public:
WebsocketConnection(MongooseHttpd * httpd)
: MongooseConnection(httpd), _websocket(NULL)
{
}
virtual ~WebsocketConnection()
{
delete _websocket;
}
virtual void close(struct mg_connection * connection);
virtual int poll(struct mg_connection * connection);
virtual int request(struct mg_connection * connection);
virtual int onConnect(struct mg_connection * connection);
private:
class MongooseWebsocketWriter: public WebsocketWriter {
public:
MongooseWebsocketWriter(struct mg_connection * connection)
: _connection(connection)
{
}
virtual int writeToWebsocket(int opcode, const char * data, size_t len)
{
return mg_websocket_write(_connection, opcode, data, len);
}
private:
struct mg_connection * _connection;
};
Websocket * _websocket;
};
MongooseConnection * MongooseConnection::getConnection(MongooseHttpd * httpd, struct mg_connection * connection)
{
if (connection->connection_param) return static_cast<MongooseConnection*>(connection->connection_param);
MongooseConnection * c;
if (connection->is_websocket) c = new WebsocketConnection(httpd);
else c = new RegularConnection(httpd);
connection->connection_param = c;
return c;
}
int RegularConnection::request(struct mg_connection * connection)
{
setConnection(connection);
MongooseHTTPRequest request(connection);
SG_LOG(SG_NETWORK, SG_INFO, "RegularConnection::request for " << request.Uri);
// find a handler for the uri and remember it for possible polls on this connection
_handler = _httpd->findHandler(request.Uri);
if (false == _handler.valid()) {
// uri not registered - pass false to indicate we have not processed the request
return MG_FALSE;
}
// We handle this URI, prepare the response
HTTPResponse response;
response.Header["Server"] = "FlightGear/" FLIGHTGEAR_VERSION " Mongoose/" MONGOOSE_VERSION;
response.Header["Connection"] = "keep-alive";
response.Header["Cache-Control"] = "no-cache";
{
char buf[64];
time_t now = time(NULL);
strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", gmtime(&now));
response.Header["Date"] = buf;
}
// hand the request over to the handler, returns true if request is finished,
// false the handler wants to get polled again (calling handlePoll() next time)
bool done = _handler->handleRequest(request, response, this);
// fill in the response header
mg_send_status(connection, response.StatusCode);
for (HTTPResponse::Header_t::const_iterator it = response.Header.begin(); it != response.Header.end(); ++it) {
const string name = it->first;
const string value = it->second;
if (name.empty() || value.empty()) continue;
mg_send_header(connection, name.c_str(), value.c_str());
}
if (done || false == response.Content.empty()) {
SG_LOG(SG_NETWORK, SG_INFO,
"RegularConnection::request() responding " << response.Content.length() << " Bytes, done=" << done);
mg_send_data(connection, response.Content.c_str(), response.Content.length());
}
return done ? MG_TRUE : MG_MORE;
}
int RegularConnection::poll(struct mg_connection * connection)
{
setConnection(connection);
if (false == _handler.valid()) return MG_FALSE;
// only return MG_TRUE if we handle this request
return _handler->poll(this) ? MG_TRUE : MG_MORE;
}
void RegularConnection::close(struct mg_connection * connection)
{
setConnection(connection);
// nothing to close
}
void WebsocketConnection::close(struct mg_connection * connection)
{
setConnection(connection);
if ( NULL != _websocket) _websocket->close();
delete _websocket;
_websocket = NULL;
}
int WebsocketConnection::poll(struct mg_connection * connection)
{
setConnection(connection);
// we get polled before the first request came in but we know
// nothing about how to handle that before we know the URI.
// so simply ignore that poll
if ( NULL != _websocket) {
MongooseWebsocketWriter writer(connection);
_websocket->poll(writer);
}
return MG_MORE;
}
int WebsocketConnection::onConnect(struct mg_connection * connection)
{
setConnection(connection);
MongooseHTTPRequest request(connection);
SG_LOG(SG_NETWORK, SG_INFO, "WebsocketConnection::connect for " << request.Uri);
if ( NULL == _websocket) _websocket = _httpd->newWebsocket(request.Uri);
if ( NULL == _websocket) {
SG_LOG(SG_NETWORK, SG_WARN, "httpd: unhandled websocket uri: " << request.Uri);
return 0;
}
return 0;
}
int WebsocketConnection::request(struct mg_connection * connection)
{
setConnection(connection);
MongooseHTTPRequest request(connection);
SG_LOG(SG_NETWORK, SG_INFO, "WebsocketConnection::request for " << request.Uri);
if ( NULL == _websocket) {
SG_LOG(SG_NETWORK, SG_ALERT, "httpd: unhandled websocket uri: " << request.Uri);
return MG_TRUE; // close connection - good bye
}
MongooseWebsocketWriter writer(connection);
_websocket->handleRequest(request, writer);
return MG_MORE;
}
MongooseHttpd::MongooseHttpd(SGPropertyNode_ptr configNode)
: _server(NULL), _configNode(configNode)
{
}
MongooseHttpd::~MongooseHttpd()
{
mg_destroy_server(&_server);
}
void MongooseHttpd::init()
{
SGPropertyNode_ptr n = _configNode->getNode("uri-handler");
if (n.valid()) {
const char * uri;
if ((uri = n->getStringValue("screenshot"))[0] != 0) {
SG_LOG(SG_NETWORK, SG_INFO, "httpd: adding screenshot uri handler at " << uri);
_uriHandler.push_back(new flightgear::http::ScreenshotUriHandler(uri));
}
if ((uri = n->getStringValue("property"))[0] != 0) {
SG_LOG(SG_NETWORK, SG_INFO, "httpd: adding property uri handler at " << uri);
_uriHandler.push_back(new flightgear::http::PropertyUriHandler(uri));
}
if ((uri = n->getStringValue("json"))[0] != 0) {
SG_LOG(SG_NETWORK, SG_INFO, "httpd: adding json uri handler at " << uri);
_uriHandler.push_back(new flightgear::http::JsonUriHandler(uri));
}
if ((uri = n->getStringValue("pkg"))[0] != 0) {
SG_LOG(SG_NETWORK, SG_INFO, "httpd: adding pkg uri handler at " << uri);
_uriHandler.push_back(new flightgear::http::PkgUriHandler(uri));
}
if ((uri = n->getStringValue("flighthistory"))[0] != 0) {
SG_LOG(SG_NETWORK, SG_INFO, "httpd: adding flighthistory uri handler at " << uri);
_uriHandler.push_back(new flightgear::http::FlightHistoryUriHandler(uri));
}
if ((uri = n->getStringValue("run"))[0] != 0) {
SG_LOG(SG_NETWORK, SG_INFO, "httpd: adding run uri handler at " << uri);
_uriHandler.push_back(new flightgear::http::RunUriHandler(uri));
}
if ((uri = n->getStringValue("navdb"))[0] != 0) {
SG_LOG(SG_NETWORK, SG_INFO, "httpd: adding navdb uri handler at " << uri);
_uriHandler.push_back(new flightgear::http::NavdbUriHandler(uri));
}
}
_server = mg_create_server(this, MongooseHttpd::staticRequestHandler);
n = _configNode->getNode("options");
if (n.valid()) {
const string fgRoot = fgGetString("/sim/fg-root");
string docRoot = n->getStringValue("document-root", fgRoot.c_str());
if (docRoot[0] != '/') docRoot.insert(0, "/").insert(0, fgRoot);
mg_set_option(_server, "document_root", docRoot.c_str());
mg_set_option(_server, "listening_port", n->getStringValue("listening-port", "8080"));
{
// build url rewrites relative to fg-root
string rewrites = n->getStringValue("url-rewrites", "");
string_list rwl = simgear::strutils::split(rewrites, ",");
rwl.push_back(string("/aircraft-dir/=") + fgGetString("/sim/aircraft-dir") + "/" );
rwl.push_back(string("/fg-home/=") + fgGetString("/sim/fg-home") + "/" );
rwl.push_back(string("/fg-root/=") + fgGetString("/sim/fg-root") + "/" );
rewrites.clear();
for (string_list::iterator it = rwl.begin(); it != rwl.end(); ++it) {
string_list rw_entries = simgear::strutils::split(*it, "=");
if (rw_entries.size() != 2) {
SG_LOG(SG_NETWORK, SG_WARN, "invalid entry '" << *it << "' in url-rewrites ignored.");
continue;
}
string & lhs = rw_entries[0];
string & rhs = rw_entries[1];
if (false == rewrites.empty()) rewrites.append(1, ',');
rewrites.append(lhs).append(1, '=');
SGPath targetPath(rhs);
if (targetPath.isAbsolute() ) {
rewrites.append(rhs);
} else {
// don't use targetPath here because SGPath strips trailing '/'
rewrites.append(fgRoot).append(1, '/').append(rhs);
}
}
if (false == rewrites.empty()) mg_set_option(_server, "url_rewrites", rewrites.c_str());
}
mg_set_option(_server, "enable_directory_listing", n->getStringValue("enable-directory-listing", "yes"));
mg_set_option(_server, "idle_timeout_ms", n->getStringValue("idle-timeout-ms", "30000"));
mg_set_option(_server, "index_files", n->getStringValue("index-files", "index.html"));
mg_set_option(_server, "extra_mime_types", n->getStringValue("extra-mime-types", ""));
mg_set_option(_server, "access_log_file", n->getStringValue("access-log-file", ""));
if( sglog().would_log(SG_NETWORK,SG_INFO) ) {
SG_LOG(SG_NETWORK,SG_INFO,"starting mongoose with these options: ");
const char ** optionNames = mg_get_valid_option_names();
for( int i = 0; optionNames[i] != NULL; i+= 2 ) {
SG_LOG(SG_NETWORK,SG_INFO, " > " << optionNames[i] << ": '" << mg_get_option(_server, optionNames[i]) << "'" );
}
SG_LOG(SG_NETWORK,SG_INFO,"end of mongoose options.");
}
}
_configNode->setBoolValue("running",true);
}
void MongooseHttpd::bind()
{
}
void MongooseHttpd::unbind()
{
_configNode->setBoolValue("running",false);
mg_destroy_server(&_server);
_uriHandler.clear();
_propertyChangeObserver.clear();
}
void MongooseHttpd::update(double dt)
{
_propertyChangeObserver.check();
mg_poll_server(_server, 0);
_propertyChangeObserver.uncheck();
}
int MongooseHttpd::poll(struct mg_connection * connection)
{
if ( NULL == connection->connection_param) return MG_FALSE; // connection not yet set up - ignore poll
return MongooseConnection::getConnection(this, connection)->poll(connection);
}
int MongooseHttpd::auth(struct mg_connection * connection)
{
// auth preceds request for websockets and regular connections,
// and eventually the websocket has been already set up by mongoose
// use this to choose the connection type
MongooseConnection::getConnection(this, connection);
//return MongooseConnection::getConnection(this,connection)->auth(connection);
return MG_TRUE; // unrestricted access for now
}
int MongooseHttpd::request(struct mg_connection * connection)
{
return MongooseConnection::getConnection(this, connection)->request(connection);
}
int MongooseHttpd::onConnect(struct mg_connection * connection)
{
return MongooseConnection::getConnection(this, connection)->onConnect(connection);
}
void MongooseHttpd::close(struct mg_connection * connection)
{
MongooseConnection * c = MongooseConnection::getConnection(this, connection);
c->close(connection);
delete c;
}
Websocket * MongooseHttpd::newWebsocket(const string & uri)
{
if (uri.find("/PropertyListener") == 0) {
SG_LOG(SG_NETWORK, SG_INFO, "new PropertyChangeWebsocket for: " << uri);
return new PropertyChangeWebsocket(&_propertyChangeObserver);
} else if (uri.find("/PropertyTreeMirror/") == 0) {
SG_LOG(SG_NETWORK, SG_INFO, "new MirrorPropertyTreeWebsocket for: " << uri);
return new MirrorPropertyTreeWebsocket(uri.substr(20));
}
return NULL;
}
int MongooseHttpd::staticRequestHandler(struct mg_connection * connection, mg_event event)
{
switch (event) {
case MG_POLL: // MG_TRUE: finished sending data, MG_MORE, call again
return static_cast<MongooseHttpd*>(connection->server_param)->poll(connection);
case MG_AUTH: // If callback returns MG_FALSE, authentication fails
return static_cast<MongooseHttpd*>(connection->server_param)->auth(connection);
case MG_REQUEST: // If callback returns MG_FALSE, Mongoose continues with req
return static_cast<MongooseHttpd*>(connection->server_param)->request(connection);
case MG_CLOSE: // Connection is closed, callback return value is ignored
static_cast<MongooseHttpd*>(connection->server_param)->close(connection);
return MG_TRUE;
case MG_HTTP_ERROR: // If callback returns MG_FALSE, Mongoose continues with err
return MG_FALSE; // we don't handle errors - let mongoose do the work
// client services not used/implemented. Signal 'close connection' to be sure
case MG_CONNECT: // If callback returns MG_FALSE, connect fails
case MG_REPLY: // If callback returns MG_FALSE, Mongoose closes connection
return MG_FALSE;
case MG_WS_CONNECT: // New websocket connection established, return value ignored
return static_cast<MongooseHttpd*>(connection->server_param)->onConnect(connection);
default:
return MG_FALSE; // keep compiler happy..
}
}
FGHttpd * FGHttpd::createInstance(SGPropertyNode_ptr configNode)
{
// only create a server if a port has been configured
if (false == configNode.valid()) return NULL;
string port = configNode->getStringValue("options/listening-port", "");
if (port.empty()) return NULL;
return new MongooseHttpd(configNode);
}
} // namespace http
} // namespace flightgear
|