X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FEnvironment%2Frealwx_ctrl.cxx;h=3db5d905845a8c08e5b93a4633935ae82a82e967;hb=24c1129140dd1a04ac8a9fe5d6b0a17387b49304;hp=b3a55331d7361de9697f4ad1dacce5c45c90b5bf;hpb=b5025ccf5d1dbe5e1dff3b24710ad70deee78558;p=flightgear.git diff --git a/src/Environment/realwx_ctrl.cxx b/src/Environment/realwx_ctrl.cxx index b3a55331d..3db5d9058 100644 --- a/src/Environment/realwx_ctrl.cxx +++ b/src/Environment/realwx_ctrl.cxx @@ -1,7 +1,7 @@ // realwx_ctrl.cxx -- Process real weather data // // Written by David Megginson, started February 2002. -// Rewritten by Torsten Dreyer, August 2010 +// Rewritten by Torsten Dreyer, August 2010, August 2011 // // Copyright (C) 2002 David Megginson - david@megginson.com // @@ -25,47 +25,73 @@ #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 - -using simgear::PropertyList; +#include "metarproperties.hxx" +#include "metarairportfilter.hxx" +#include "fgmetar.hxx" +#include +#include
namespace Environment { + +/* -------------------------------------------------------------------------------- */ + +class MetarDataHandler { +public: + virtual void handleMetarData( const std::string & data ) = 0; +}; + +class MetarRequester { +public: + virtual void requestMetar( MetarDataHandler * metarDataHandler, const std::string & id ) = 0; +}; + /* -------------------------------------------------------------------------------- */ -class LiveMetarProperties : public MetarProperties { +class LiveMetarProperties : public MetarProperties, MetarDataHandler { public: - LiveMetarProperties( SGPropertyNode_ptr rootNode ); + 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 ); + + static const unsigned MAX_POLLING_INTERVAL_SECONDS = 10; + static const unsigned DEFAULT_TIME_TO_LIVE_SECONDS = 900; + private: double _timeToLive; - + double _pollingTimer; + MetarRequester * _metarRequester; + int _maxAge; }; typedef SGSharedPtr LiveMetarProperties_ptr; -LiveMetarProperties::LiveMetarProperties( SGPropertyNode_ptr rootNode ) : +LiveMetarProperties::LiveMetarProperties( SGPropertyNode_ptr rootNode, MetarRequester * metarRequester, int maxAge ) : MetarProperties( rootNode ), - _timeToLive(0.0) + _timeToLive(0.0), + _pollingTimer(0.0), + _metarRequester(metarRequester), + _maxAge(maxAge) { _tiedProperties.Tie("time-to-live", &_timeToLive ); } @@ -78,7 +104,38 @@ LiveMetarProperties::~LiveMetarProperties() void LiveMetarProperties::update( double dt ) { _timeToLive -= dt; - if( _timeToLive < 0.0 ) _timeToLive = 0.0; + _pollingTimer -= dt; + if( _timeToLive <= 0.0 ) { + _timeToLive = 0.0; + std::string stationId = getStationId(); + if( stationId.empty() ) return; + if( _pollingTimer > 0.0 ) return; + _metarRequester->requestMetar( this, stationId ); + _pollingTimer = MAX_POLLING_INTERVAL_SECONDS; + } +} + +void LiveMetarProperties::handleMetarData( const std::string & data ) +{ + SG_LOG( SG_ENVIRONMENT, SG_DEBUG, "LiveMetarProperties::handleMetarData() received METAR for " << getStationId() << ": " << data ); + _timeToLive = DEFAULT_TIME_TO_LIVE_SECONDS; + + SGSharedPtr m; + try { + m = new FGMetar(data.c_str()); + } + catch( sg_io_exception ) { + SG_LOG( SG_ENVIRONMENT, SG_WARN, "Can't parse metar: " << data ); + 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; + } + + setMetar( m ); } /* -------------------------------------------------------------------------------- */ @@ -86,35 +143,80 @@ void LiveMetarProperties::update( double dt ) class BasicRealWxController : public RealWxController { public: - BasicRealWxController( SGPropertyNode_ptr rootNode ); + BasicRealWxController( SGPropertyNode_ptr rootNode, MetarRequester * metarRequester ); virtual ~BasicRealWxController (); 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 dt ) = 0; + void checkNearbyMetar(); long getMetarMaxAgeMin() const { return _max_age_n == NULL ? 0 : _max_age_n->getLongValue(); } SGPropertyNode_ptr _rootNode; - SGPropertyNode_ptr _longitude_n; - SGPropertyNode_ptr _latitude_n; SGPropertyNode_ptr _ground_elevation_n; SGPropertyNode_ptr _max_age_n; bool _enabled; - bool __enabled; + bool _wasEnabled; simgear::TiedPropertyList _tiedProperties; typedef std::vector MetarPropertiesList; MetarPropertiesList _metarProperties; - + 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 @@ -122,40 +224,57 @@ Properties ~/metar[1..n]: string Target property path for metar data */ -BasicRealWxController::BasicRealWxController( SGPropertyNode_ptr rootNode ) : +BasicRealWxController::BasicRealWxController( SGPropertyNode_ptr rootNode, MetarRequester * metarRequester ) : _rootNode(rootNode), - _longitude_n( fgGetNode( "/position/longitude-deg", true )), - _latitude_n( fgGetNode( "/position/latitude-deg", true )), _ground_elevation_n( fgGetNode( "/position/ground-elev-m", true )), _max_age_n( fgGetNode( "/environment/params/metar-max-age-min", false ) ), _enabled(true), - __enabled(false) + _wasEnabled(false), + _requester(metarRequester) { - // at least instantiate MetarProperties for /environment/metar - _metarProperties.push_back( new LiveMetarProperties( - fgGetNode( rootNode->getStringValue("metar", "/environment/metar"), true ) ) ); - - PropertyList metars = rootNode->getChildren("metar"); - for( PropertyList::size_type i = 1; i < metars.size(); i++ ) { - SG_LOG( SG_ALL, SG_INFO, "Adding metar properties at " << metars[i]->getStringValue() ); - _metarProperties.push_back( new LiveMetarProperties( - fgGetNode( metars[i]->getStringValue(), true ))); - } + + 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() @@ -170,201 +289,187 @@ 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 - for( MetarPropertiesList::iterator it = _metarProperties.begin(); - it != _metarProperties.end(); it++ ) { + BOOST_FOREACH(LiveMetarProperties* p, _metarProperties) { // first round? All received METARs are outdated - if( firstIteration ) (*it)->setTimeToLive( 0.0 ); - (*it)->update(dt); + if( firstIteration ) p->resetTimeToLive(); + p->update(dt); } - update( firstIteration, dt ); - __enabled = true; + _wasEnabled = true; } else { - __enabled = false; + _wasEnabled = false; } } -/* -------------------------------------------------------------------------------- */ - -class NoaaMetarRealWxController : public BasicRealWxController { -public: - NoaaMetarRealWxController( SGPropertyNode_ptr rootNode ); - virtual ~NoaaMetarRealWxController(); - virtual void update (bool first, double delta_time_sec); - virtual void shutdown (); - - /** - * callback from MetarGetRequest when a download succeeds - */ - void gotMetar(const string& stationId, const string& metar); -private: - double _positionTimeToLive; - double _requestTimer; +void BasicRealWxController::addMetarAtPath(const string& propPath, const string& icao) +{ + // 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 - simgear::HTTP::Client _http; -}; + 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); +} -class MetarGetRequest : public simgear::HTTP::Request +void BasicRealWxController::removeMetarAtPath(const string &propPath) { -public: - MetarGetRequest(NoaaMetarRealWxController* con, const string& s) : - Request(""), - stationId(s), - fromProxy(false), - wxController(con) - { - setUrl("http://weather.noaa.gov/pub/data/observations/metar/stations/" + stationId + ".TXT"); - } - - virtual string_list requestHeaders() const - { - string_list r; - r.push_back("X-Time"); - return r; - } - - virtual string header(const string& name) const - { - if (name == "X-Time") { - char buf[16]; - snprintf(buf, 16, "%ld", globals->get_time_params()->get_cur_time()); - return buf; - } - - return Request::header(name); + 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; } - - virtual void responseHeader(const string& key, const string& value) - { - if (key == "x-metarproxy") { - fromProxy = true; - } + } + + 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(); + } } - - virtual void gotBodyData(const char* s, int n) - { - metar += string(s, n); + catch( sg_exception & ) { + return; } - virtual void responseComplete() +} + +/* -------------------------------------------------------------------------------- */ + +class NoaaMetarRealWxController : public BasicRealWxController, MetarRequester { +public: + NoaaMetarRealWxController( SGPropertyNode_ptr rootNode ); + + // implementation of MetarRequester + virtual void requestMetar( MetarDataHandler * metarDataHandler, const std::string & id ); + + virtual ~NoaaMetarRealWxController() { - if (responseCode() == 200) { - wxController->gotMetar(stationId, metar); - } else { - SG_LOG(SG_IO, SG_WARN, "metar download failed:" << url() << ": reason:" << responseReason()); - } } +private: - bool fromMetarProxy() const - { return fromProxy; } -private: - string stationId; - string metar; - bool fromProxy; - NoaaMetarRealWxController* wxController; }; - - NoaaMetarRealWxController::NoaaMetarRealWxController( SGPropertyNode_ptr rootNode ) : - BasicRealWxController(rootNode), - _positionTimeToLive(0.0), - _requestTimer(0.0) -{ - string proxyHost(fgGetString("/sim/presets/proxy/host")); - int proxyPort(fgGetInt("/sim/presets/proxy/port")); - string proxyAuth(fgGetString("/sim/presets/proxy/auth")); - - if (!proxyHost.empty()) { - _http.setProxy(proxyHost, proxyPort, proxyAuth); - } -} - -void NoaaMetarRealWxController::shutdown() + BasicRealWxController(rootNode, this ) { } -NoaaMetarRealWxController::~NoaaMetarRealWxController() +void NoaaMetarRealWxController::requestMetar +( + MetarDataHandler* metarDataHandler, + const std::string& id +) { -} - -void NoaaMetarRealWxController::update( bool first, double dt ) -{ - _http.update(); - - _positionTimeToLive -= dt; - _requestTimer -= dt; - - if( _positionTimeToLive <= 0.0 ) { - // check nearest airport - SG_LOG(SG_ALL, SG_INFO, "NoaaMetarRealWxController::update(): (re) checking nearby airport with METAR" ); - _positionTimeToLive = 60.0; - - SGGeod pos = SGGeod::fromDeg(_longitude_n->getDoubleValue(), _latitude_n->getDoubleValue()); - - FGAirport * nearestAirport = FGAirport::findClosest(pos, 10000.0, MetarAirportFilter::instance() ); - if( nearestAirport == NULL ) { - SG_LOG(SG_ALL,SG_WARN,"RealWxController::update can't find airport with METAR within 10000NM" ); - return; - } - - SG_LOG(SG_ALL, SG_INFO, - "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_ALL, 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 ); + 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 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; } - } - - if( _requestTimer <= 0.0 ) { - _requestTimer = 10.0; - - BOOST_FOREACH(LiveMetarProperties* p, _metarProperties) { - if( p->getTimeToLive() > 0.0 ) continue; - const std::string & stationId = p->getStationId(); - if( stationId.empty() ) continue; - - SG_LOG(SG_ALL, SG_INFO, - "NoaaMetarRealWxController::update(): spawning load request for station-id '" << stationId << "'" ); - - _http.makeRequest(new MetarGetRequest(this, stationId)); - } // of MetarProperties iteration - } -} -void NoaaMetarRealWxController::gotMetar(const string& stationId, const string& metar) -{ - SG_LOG( SG_ALL, SG_INFO, "NoaaMetarRwalWxController::update() received METAR for " << stationId << ": " << metar ); - BOOST_FOREACH(LiveMetarProperties* p, _metarProperties) { - if (p->getStationId() != stationId) - continue; - - p->setTimeToLive(900); - p->setMetar( metar ); - } + _metarDataHandler->handleMetarData + ( + simgear::strutils::simplify(responseBody()) + ); + } + + virtual void onFail() + { + SG_LOG(SG_ENVIRONMENT, SG_INFO, "metar download failure"); + } + + 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() +{ } /* -------------------------------------------------------------------------------- */