X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FEnvironment%2Frealwx_ctrl.cxx;h=afa41c62b123798c634d420b3808e7a29f9a9044;hb=1edffd1d10bbe30a418e88140df54791ced23649;hp=5592a386e771b9c6ede33013729c4cea81912228;hpb=b1b4b7ecf48c4420d4445979c36cbf3f80be616a;p=flightgear.git diff --git a/src/Environment/realwx_ctrl.cxx b/src/Environment/realwx_ctrl.cxx index 5592a386e..afa41c62b 100644 --- a/src/Environment/realwx_ctrl.cxx +++ b/src/Environment/realwx_ctrl.cxx @@ -25,47 +25,34 @@ #endif #include "realwx_ctrl.hxx" -#include "metarproperties.hxx" -#include "metarairportfilter.hxx" -#include "fgmetar.hxx" - -#include
+#include #include +#include #include #include #include -#include -#include +#include #include +#include +#include -#include +#include "metarproperties.hxx" +#include "metarairportfilter.hxx" +#include "fgmetar.hxx" +#include +#include
namespace Environment { -/* -------------------------------------------------------------------------------- */ -class FGHTTPClient : public simgear::HTTP::Client { -public: - FGHTTPClient(); -}; - -FGHTTPClient::FGHTTPClient() -{ - string proxyHost(fgGetString("/sim/presets/proxy/host")); - int proxyPort(fgGetInt("/sim/presets/proxy/port")); - string proxyAuth(fgGetString("/sim/presets/proxy/auth")); - - if (!proxyHost.empty()) { - setProxy(proxyHost, proxyPort, proxyAuth); - } -} /* -------------------------------------------------------------------------------- */ class MetarDataHandler { public: virtual void handleMetarData( const std::string & data ) = 0; + virtual void handleMetarFailure() = 0; }; class MetarRequester { @@ -77,16 +64,18 @@ public: class LiveMetarProperties : public MetarProperties, MetarDataHandler { public: - LiveMetarProperties( SGPropertyNode_ptr rootNode, MetarRequester * metarRequester ); + LiveMetarProperties( SGPropertyNode_ptr rootNode, MetarRequester * metarRequester, int maxAge ); virtual ~LiveMetarProperties(); virtual void update( double dt ); virtual double getTimeToLive() const { return _timeToLive; } - virtual void setTimeToLive( double value ) { _timeToLive = value; } + virtual void resetTimeToLive() + { _timeToLive = 0.00; _pollingTimer = 0.0; } // implementation of MetarDataHandler virtual void handleMetarData( const std::string & data ); - + virtual void handleMetarFailure(); + static const unsigned MAX_POLLING_INTERVAL_SECONDS = 10; static const unsigned DEFAULT_TIME_TO_LIVE_SECONDS = 900; @@ -94,17 +83,22 @@ private: double _timeToLive; double _pollingTimer; MetarRequester * _metarRequester; + int _maxAge; + bool _failure; }; typedef SGSharedPtr LiveMetarProperties_ptr; -LiveMetarProperties::LiveMetarProperties( SGPropertyNode_ptr rootNode, MetarRequester * metarRequester ) : +LiveMetarProperties::LiveMetarProperties( SGPropertyNode_ptr rootNode, MetarRequester * metarRequester, int maxAge ) : MetarProperties( rootNode ), _timeToLive(0.0), _pollingTimer(0.0), - _metarRequester(metarRequester) + _metarRequester(metarRequester), + _maxAge(maxAge), + _failure(false) { _tiedProperties.Tie("time-to-live", &_timeToLive ); + _tiedProperties.Tie("failure", &_failure); } LiveMetarProperties::~LiveMetarProperties() @@ -116,7 +110,7 @@ void LiveMetarProperties::update( double dt ) { _timeToLive -= dt; _pollingTimer -= dt; - if( _timeToLive < 0.0 ) { + if( _timeToLive <= 0.0 ) { _timeToLive = 0.0; std::string stationId = getStationId(); if( stationId.empty() ) return; @@ -128,11 +122,34 @@ void LiveMetarProperties::update( double dt ) void LiveMetarProperties::handleMetarData( const std::string & data ) { - SG_LOG( SG_ENVIRONMENT, SG_INFO, "LiveMetarProperties::handleMetarData() received METAR for " << getStationId() << ": " << data ); + SG_LOG( SG_ENVIRONMENT, SG_DEBUG, "LiveMetarProperties::handleMetarData() received METAR for " << getStationId() << ": " << data ); _timeToLive = DEFAULT_TIME_TO_LIVE_SECONDS; - setMetar( data ); + + SGSharedPtr m; + try { + m = new FGMetar(data.c_str()); + } + catch( sg_io_exception ) { + SG_LOG( SG_ENVIRONMENT, SG_WARN, "Can't parse metar: " << data ); + _failure = true; + return; + } + + if (_maxAge && (m->getAge_min() > _maxAge)) { + // METAR is older than max-age, ignore + SG_LOG( SG_ENVIRONMENT, SG_DEBUG, "Ignoring outdated METAR for " << getStationId()); + return; + } + + _failure = false; + setMetar( m ); } +void LiveMetarProperties::handleMetarFailure() +{ + _failure = true; +} + /* -------------------------------------------------------------------------------- */ class BasicRealWxController : public RealWxController @@ -143,13 +160,23 @@ public: virtual void init (); virtual void reinit (); - + virtual void shutdown (); + + /** + * Create a metar-property binding at the specified property path, + * and initiate a request for the specified station-ID (which may be + * empty). If the property path is already mapped, the station ID + * will be updated. + */ + void addMetarAtPath(const string& propPath, const string& icao); + + void removeMetarAtPath(const string& propPath); protected: void bind(); void unbind(); void update( double dt ); - virtual void update (bool first, double delta_time_sec); + void checkNearbyMetar(); long getMetarMaxAgeMin() const { return _max_age_n == NULL ? 0 : _max_age_n->getLongValue(); } @@ -158,14 +185,50 @@ protected: SGPropertyNode_ptr _max_age_n; bool _enabled; - bool __enabled; + bool _wasEnabled; simgear::TiedPropertyList _tiedProperties; typedef std::vector MetarPropertiesList; MetarPropertiesList _metarProperties; -private: - double _positionTimeToLive; + MetarRequester* _requester; + }; +static bool commandRequestMetar(const SGPropertyNode* arg) +{ + SGSubsystemGroup* envMgr = (SGSubsystemGroup*) globals->get_subsystem("environment"); + if (!envMgr) { + return false; + } + + BasicRealWxController* self = (BasicRealWxController*) envMgr->get_subsystem("realwx"); + if (!self) { + return false; + } + + string icao(arg->getStringValue("station")); + boost::to_upper(icao); + string path = arg->getStringValue("path"); + self->addMetarAtPath(path, icao); + return true; +} + +static bool commandClearMetar(const SGPropertyNode* arg) +{ + SGSubsystemGroup* envMgr = (SGSubsystemGroup*) globals->get_subsystem("environment"); + if (!envMgr) { + return false; + } + + BasicRealWxController* self = (BasicRealWxController*) envMgr->get_subsystem("realwx"); + if (!self) { + return false; + } + + string path = arg->getStringValue("path"); + self->removeMetarAtPath(path); + return true; +} + /* -------------------------------------------------------------------------------- */ /* Properties @@ -178,33 +241,52 @@ BasicRealWxController::BasicRealWxController( SGPropertyNode_ptr rootNode, Metar _ground_elevation_n( fgGetNode( "/position/ground-elev-m", true )), _max_age_n( fgGetNode( "/environment/params/metar-max-age-min", false ) ), _enabled(true), - __enabled(false), - _positionTimeToLive(0.0) + _wasEnabled(false), + _requester(metarRequester) { - // at least instantiate MetarProperties for /environment/metar - _metarProperties.push_back( new LiveMetarProperties( - fgGetNode( rootNode->getStringValue("metar", "/environment/metar"), true ), metarRequester )); - - BOOST_FOREACH( SGPropertyNode_ptr n, rootNode->getChildren("metar") ) { - SG_LOG( SG_ENVIRONMENT, SG_INFO, "Adding metar properties at " << n->getStringValue() ); - _metarProperties.push_back( new LiveMetarProperties( - fgGetNode( n->getStringValue(), true ), metarRequester )); - } + + globals->get_commands()->addCommand("request-metar", commandRequestMetar); + globals->get_commands()->addCommand("clear-metar", commandClearMetar); } BasicRealWxController::~BasicRealWxController() { + globals->get_commands()->removeCommand("request-metar"); + globals->get_commands()->removeCommand("clear-metar"); } void BasicRealWxController::init() { - __enabled = false; + _wasEnabled = false; + + // at least instantiate MetarProperties for /environment/metar + SGPropertyNode_ptr metarNode = fgGetNode( _rootNode->getStringValue("metar", "/environment/metar"), true ); + _metarProperties.push_back( new LiveMetarProperties(metarNode, + _requester, + getMetarMaxAgeMin())); + + BOOST_FOREACH( SGPropertyNode_ptr n, _rootNode->getChildren("metar") ) { + SGPropertyNode_ptr metarNode = fgGetNode( n->getStringValue(), true ); + addMetarAtPath(metarNode->getPath(), ""); + } + + checkNearbyMetar(); update(0); // fetch data ASAP + + globals->get_event_mgr()->addTask("checkNearbyMetar", this, + &BasicRealWxController::checkNearbyMetar, 60 ); } void BasicRealWxController::reinit() { - __enabled = false; + _wasEnabled = false; + checkNearbyMetar(); + update(0); // fetch data ASAP +} + +void BasicRealWxController::shutdown() +{ + globals->get_event_mgr()->removeTask("checkNearbyMetar"); } void BasicRealWxController::bind() @@ -219,61 +301,90 @@ void BasicRealWxController::unbind() } void BasicRealWxController::update( double dt ) -{ +{ if( _enabled ) { - bool firstIteration = !__enabled; // first iteration after being enabled? - + bool firstIteration = !_wasEnabled; // clock tick for every METAR in stock BOOST_FOREACH(LiveMetarProperties* p, _metarProperties) { // first round? All received METARs are outdated - if( firstIteration ) p->setTimeToLive( 0.0 ); + if( firstIteration ) p->resetTimeToLive(); p->update(dt); } - update( firstIteration, dt ); - __enabled = true; + _wasEnabled = true; } else { - __enabled = false; + _wasEnabled = false; } } -void BasicRealWxController::update( bool first, double dt ) +void BasicRealWxController::addMetarAtPath(const string& propPath, const string& icao) { - _positionTimeToLive -= dt; - - if( _positionTimeToLive <= 0.0 ) { - - - try { - const SGGeod & pos = globals->get_aircraft_position(); - - // check nearest airport - SG_LOG(SG_ENVIRONMENT, SG_INFO, "NoaaMetarRealWxController::update(): (re) checking nearby airport with METAR" ); - _positionTimeToLive = 60.0; - - FGAirport * nearestAirport = FGAirport::findClosest(pos, 10000.0, MetarAirportFilter::instance() ); - if( nearestAirport == NULL ) { - SG_LOG(SG_ENVIRONMENT,SG_WARN,"RealWxController::update can't find airport with METAR within 10000NM" ); - return; - } + // check for duplicate entries + BOOST_FOREACH( LiveMetarProperties_ptr p, _metarProperties ) { + if( p->get_root_node()->getPath() == propPath ) { + // already exists + if (p->getStationId() != icao) { + p->setStationId(icao); + p->resetTimeToLive(); + } + + return; + } + } // of exitsing metar properties iteration - SG_LOG(SG_ENVIRONMENT, SG_INFO, - "NoaaMetarRealWxController::update(): nearest airport with METAR is: " << nearestAirport->ident() ); + SGPropertyNode_ptr metarNode = fgGetNode(propPath, true); + SG_LOG( SG_ENVIRONMENT, SG_INFO, "Adding metar properties at " << propPath ); + LiveMetarProperties_ptr p(new LiveMetarProperties( metarNode, _requester, getMetarMaxAgeMin() )); + _metarProperties.push_back(p); + p->setStationId(icao); +} - // if it has changed, invalidate the associated METAR - if( _metarProperties[0]->getStationId() != nearestAirport->ident() ) { - SG_LOG(SG_ENVIRONMENT, SG_INFO, - "NoaaMetarRealWxController::update(): nearest airport with METAR has changed. Old: '" << - _metarProperties[0]->getStationId() << - "', new: '" << nearestAirport->ident() << "'" ); - _metarProperties[0]->setStationId( nearestAirport->ident() ); - _metarProperties[0]->setTimeToLive( 0.0 ); - } - } - catch( sg_exception & ) { - return; - } +void BasicRealWxController::removeMetarAtPath(const string &propPath) +{ + MetarPropertiesList::iterator it = _metarProperties.begin(); + for (; it != _metarProperties.end(); ++it) { + LiveMetarProperties_ptr p(*it); + if( p->get_root_node()->getPath() == propPath ) { + _metarProperties.erase(it); + // final ref will drop, and delete the MetarProperties, when we return + return; } + } + + SG_LOG(SG_ENVIRONMENT, SG_WARN, "no metar properties at " << propPath); +} + +void BasicRealWxController::checkNearbyMetar() +{ + try { + const SGGeod & pos = globals->get_aircraft_position(); + + // check nearest airport + SG_LOG(SG_ENVIRONMENT, SG_DEBUG, "NoaaMetarRealWxController::update(): (re) checking nearby airport with METAR" ); + + FGAirport * nearestAirport = FGAirport::findClosest(pos, 10000.0, MetarAirportFilter::instance() ); + if( nearestAirport == NULL ) { + SG_LOG(SG_ENVIRONMENT,SG_WARN,"RealWxController::update can't find airport with METAR within 10000NM" ); + return; + } + + SG_LOG(SG_ENVIRONMENT, SG_DEBUG, + "NoaaMetarRealWxController::update(): nearest airport with METAR is: " << nearestAirport->ident() ); + + // if it has changed, invalidate the associated METAR + if( _metarProperties[0]->getStationId() != nearestAirport->ident() ) { + SG_LOG(SG_ENVIRONMENT, SG_INFO, + "NoaaMetarRealWxController::update(): nearest airport with METAR has changed. Old: '" << + _metarProperties[0]->getStationId() << + "', new: '" << nearestAirport->ident() << "'" ); + _metarProperties[0]->setStationId( nearestAirport->ident() ); + _metarProperties[0]->resetTimeToLive(); + } + } + catch( sg_exception & ) { + return; + } + } /* -------------------------------------------------------------------------------- */ @@ -281,14 +392,15 @@ void BasicRealWxController::update( bool first, double dt ) class NoaaMetarRealWxController : public BasicRealWxController, MetarRequester { public: NoaaMetarRealWxController( SGPropertyNode_ptr rootNode ); - virtual ~NoaaMetarRealWxController(); - virtual void update( double dt ); // implementation of MetarRequester virtual void requestMetar( MetarDataHandler * metarDataHandler, const std::string & id ); + virtual ~NoaaMetarRealWxController() + { + } private: - FGHTTPClient _http; + }; NoaaMetarRealWxController::NoaaMetarRealWxController( SGPropertyNode_ptr rootNode ) : @@ -296,93 +408,81 @@ NoaaMetarRealWxController::NoaaMetarRealWxController( SGPropertyNode_ptr rootNod { } -NoaaMetarRealWxController::~NoaaMetarRealWxController() -{ -} - -void NoaaMetarRealWxController::update( double dt ) -{ - _http.update(); - BasicRealWxController::update( dt ); -} - -void NoaaMetarRealWxController::requestMetar( MetarDataHandler * metarDataHandler, const std::string & id ) +void NoaaMetarRealWxController::requestMetar +( + MetarDataHandler* metarDataHandler, + const std::string& id +) { - class NoaaMetarGetRequest : public simgear::HTTP::Request - { + static const std::string NOAA_BASE_URL = + "http://weather.noaa.gov/pub/data/observations/metar/stations/"; + class NoaaMetarGetRequest: + public simgear::HTTP::MemoryRequest + { public: - NoaaMetarGetRequest(MetarDataHandler* metarDataHandler, const string& stationId ) : - Request("http://weather.noaa.gov/pub/data/observations/metar/stations/" + stationId + ".TXT"), - _fromProxy(false), - _metarDataHandler(metarDataHandler) - { - } - - virtual string_list requestHeaders() const - { - string_list reply; - reply.push_back("X-TIME"); - return reply; - } - - virtual std::string header(const std::string& name) const - { - string reply; - - if( name == "X-TIME" ) { - std::ostringstream buf; - buf << globals->get_time_params()->get_cur_time(); - reply = buf.str(); - } - - return reply; - } - - virtual void responseHeader(const string& key, const string& value) - { - if (key == "x-metarproxy") { - _fromProxy = true; - } - } - - virtual void gotBodyData(const char* s, int n) - { - _metar += string(s, n); - } - - virtual void responseComplete() - { - if (responseCode() == 200) { - _metarDataHandler->handleMetarData( _metar); - } else { - SG_LOG(SG_ENVIRONMENT, SG_WARN, "metar download failed:" << url() << ": reason:" << responseReason()); - } - } - - bool fromMetarProxy() const - { return _fromProxy; } - private: - string _metar; - bool _fromProxy; - MetarDataHandler * _metarDataHandler; - }; - - - SG_LOG(SG_ENVIRONMENT, SG_INFO, - "NoaaMetarRealWxController::update(): spawning load request for station-id '" << id << "'" ); - _http.makeRequest(new NoaaMetarGetRequest(metarDataHandler, id)); + NoaaMetarGetRequest( MetarDataHandler* metarDataHandler, + const std::string& stationId ): + MemoryRequest(NOAA_BASE_URL + stationId + ".TXT"), + _metarDataHandler(metarDataHandler) + { + std::ostringstream buf; + buf << globals->get_time_params()->get_cur_time(); + requestHeader("X-TIME") = buf.str(); + } + + virtual void onDone() + { + if( responseCode() != 200 ) + { + SG_LOG + ( + SG_ENVIRONMENT, + SG_WARN, + "metar download failed:" << url() << ": reason:" << responseReason() + ); + return; + } + + _metarDataHandler->handleMetarData + ( + simgear::strutils::simplify(responseBody()) + ); + } + + virtual void onFail() + { + SG_LOG(SG_ENVIRONMENT, SG_INFO, "metar download failure"); + _metarDataHandler->handleMetarFailure(); + } + + private: + MetarDataHandler * _metarDataHandler; + }; + + string upperId = boost::to_upper_copy(id); + + SG_LOG + ( + SG_ENVIRONMENT, + SG_INFO, + "NoaaMetarRealWxController::update(): " + "spawning load request for station-id '" << upperId << "'" + ); + FGHTTPClient* http = static_cast(globals->get_subsystem("http")); + if (http) { + http->makeRequest(new NoaaMetarGetRequest(metarDataHandler, upperId)); + } } /* -------------------------------------------------------------------------------- */ - + RealWxController * RealWxController::createInstance( SGPropertyNode_ptr rootNode ) { -// string dataSource = rootNode->getStringValue("data-source", "noaa" ); -// if( dataSource == "nwx" ) { -// return new NwxMetarRealWxController( rootNode ); -// } else { - return new NoaaMetarRealWxController( rootNode ); -// } + return new NoaaMetarRealWxController( rootNode ); +} + +RealWxController::~RealWxController() +{ } /* -------------------------------------------------------------------------------- */