src/Environment/realwx_ctrl.cxx

   1 // realwx_ctrl.cxx -- Process real weather data
   2 //
   3 // Written by David Megginson, started February 2002.
   4 // Rewritten by Torsten Dreyer, August 2010, August 2011
   5 //
   6 // Copyright (C) 2002  David Megginson - david@megginson.com
   7 //
   8 // This program is free software; you can redistribute it and/or
   9 // modify it under the terms of the GNU General Public License as
  10 // published by the Free Software Foundation; either version 2 of the
  11 // License, or (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful, but
  14 // WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 // General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the Free Software
  20 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  21 //
  22
  23 #ifdef HAVE_CONFIG_H
  24 #  include "config.h"
  25 #endif
  26
  27 #include "realwx_ctrl.hxx"
  28
  29 #include <algorithm>
  30 #include <boost/foreach.hpp>
  31 #include <boost/algorithm/string/case_conv.hpp>
  32
  33 #include <simgear/structure/exception.hxx>
  34 #include <simgear/misc/strutils.hxx>
  35 #include <simgear/props/tiedpropertylist.hxx>
  36 #include <simgear/io/HTTPMemoryRequest.hxx>
  37 #include <simgear/timing/sg_time.hxx>
  38 #include <simgear/structure/event_mgr.hxx>
  39 #include <simgear/structure/commands.hxx>
  40
  41 #include "metarproperties.hxx"
  42 #include "metarairportfilter.hxx"
  43 #include "fgmetar.hxx"
  44 #include <Network/HTTPClient.hxx>
  45 #include <Main/fg_props.hxx>
  46
  47 namespace Environment {
  48
  49
  50 /* -------------------------------------------------------------------------------- */
  51
  52 class MetarDataHandler {
  53 public:
  54     virtual void handleMetarData( const std::string & data ) = 0;
  55     virtual void handleMetarFailure() = 0;
  56 };
  57
  58 class MetarRequester {
  59 public:
  60     virtual void requestMetar( MetarDataHandler * metarDataHandler, const std::string & id ) = 0;
  61 };
  62
  63 /* -------------------------------------------------------------------------------- */
  64
  65 class LiveMetarProperties : public MetarProperties, MetarDataHandler {
  66 public:
  67     LiveMetarProperties( SGPropertyNode_ptr rootNode, MetarRequester * metarRequester, int maxAge );
  68     virtual ~LiveMetarProperties();
  69     virtual void update( double dt );
  70
  71     virtual double getTimeToLive() const { return _timeToLive; }
  72     virtual void resetTimeToLive()
  73     { _timeToLive = 0.00; _pollingTimer = 0.0; }
  74
  75     // implementation of MetarDataHandler
  76     virtual void handleMetarData( const std::string & data );
  77     virtual void handleMetarFailure();
  78
  79     static const unsigned MAX_POLLING_INTERVAL_SECONDS = 10;
  80     static const unsigned DEFAULT_TIME_TO_LIVE_SECONDS = 900;
  81
  82 private:
  83     double _timeToLive;
  84     double _pollingTimer;
  85     MetarRequester * _metarRequester;
  86     int _maxAge;
  87     bool _failure;
  88 };
  89
  90 typedef SGSharedPtr<LiveMetarProperties> LiveMetarProperties_ptr;
  91
  92 LiveMetarProperties::LiveMetarProperties( SGPropertyNode_ptr rootNode, MetarRequester * metarRequester, int maxAge ) :
  93     MetarProperties( rootNode ),
  94     _timeToLive(0.0),
  95     _pollingTimer(0.0),
  96     _metarRequester(metarRequester),
  97     _maxAge(maxAge),
  98     _failure(false)
  99 {
 100     _tiedProperties.Tie("time-to-live", &_timeToLive );
 101     _tiedProperties.Tie("failure", &_failure);
 102 }
 103
 104 LiveMetarProperties::~LiveMetarProperties()
 105 {
 106     _tiedProperties.Untie();
 107 }
 108
 109 void LiveMetarProperties::update( double dt )
 110 {
 111     _timeToLive -= dt;
 112     _pollingTimer -= dt;
 113     if( _timeToLive <= 0.0 ) {
 114         _timeToLive = 0.0;
 115         invalidate();
 116         std::string stationId = getStationId();
 117         if( stationId.empty() ) return;
 118         if( _pollingTimer > 0.0 ) return;
 119         _metarRequester->requestMetar( this, stationId );
 120         _pollingTimer = MAX_POLLING_INTERVAL_SECONDS;
 121     }
 122 }
 123
 124 void LiveMetarProperties::handleMetarData( const std::string & data )
 125 {
 126     SG_LOG( SG_ENVIRONMENT, SG_DEBUG, "LiveMetarProperties::handleMetarData() received METAR for " << getStationId() << ": " << data );
 127     _timeToLive = DEFAULT_TIME_TO_LIVE_SECONDS;
 128
 129     SGSharedPtr<FGMetar> m;
 130     try {
 131         m = new FGMetar(data.c_str());
 132     }
 133     catch( sg_io_exception ) {
 134         SG_LOG( SG_ENVIRONMENT, SG_WARN, "Can't parse metar: " << data );
 135         _failure = true;
 136         return;
 137     }
 138
 139     if (_maxAge && (m->getAge_min() > _maxAge)) {
 140         // METAR is older than max-age, ignore
 141         SG_LOG( SG_ENVIRONMENT, SG_DEBUG, "Ignoring outdated METAR for " << getStationId());
 142         return;
 143     }
 144
 145     _failure = false;
 146     setMetar( m );
 147 }
 148
 149 void LiveMetarProperties::handleMetarFailure()
 150 {
 151   _failure = true;
 152 }
 153
 154 /* -------------------------------------------------------------------------------- */
 155
 156 class BasicRealWxController : public RealWxController
 157 {
 158 public:
 159     BasicRealWxController( SGPropertyNode_ptr rootNode, MetarRequester * metarRequester );
 160     virtual ~BasicRealWxController ();
 161
 162     virtual void init ();
 163     virtual void reinit ();
 164     virtual void shutdown ();
 165
 166     /**
 167      * Create a metar-property binding at the specified property path,
 168      * and initiate a request for the specified station-ID (which may be
 169      * empty). If the property path is already mapped, the station ID
 170      * will be updated.
 171      */
 172     void addMetarAtPath(const string& propPath, const string& icao);
 173
 174     void removeMetarAtPath(const string& propPath);
 175 protected:
 176     void bind();
 177     void unbind();
 178     void update( double dt );
 179
 180     void checkNearbyMetar();
 181
 182     long getMetarMaxAgeMin() const { return _max_age_n == NULL ? 0 : _max_age_n->getLongValue(); }
 183
 184     SGPropertyNode_ptr _rootNode;
 185     SGPropertyNode_ptr _ground_elevation_n;
 186     SGPropertyNode_ptr _max_age_n;
 187
 188     bool _enabled;
 189     bool _wasEnabled;
 190     simgear::TiedPropertyList _tiedProperties;
 191     typedef std::vector<LiveMetarProperties_ptr> MetarPropertiesList;
 192     MetarPropertiesList _metarProperties;
 193     MetarRequester* _requester;
 194
 195 };
 196
 197 static bool commandRequestMetar(const SGPropertyNode* arg)
 198 {
 199   SGSubsystemGroup* envMgr = (SGSubsystemGroup*) globals->get_subsystem("environment");
 200   if (!envMgr) {
 201     return false;
 202   }
 203
 204   BasicRealWxController* self = (BasicRealWxController*) envMgr->get_subsystem("realwx");
 205   if (!self) {
 206     return false;
 207   }
 208
 209   string icao(arg->getStringValue("station"));
 210   boost::to_upper(icao);
 211   string path = arg->getStringValue("path");
 212   self->addMetarAtPath(path, icao);
 213   return true;
 214 }
 215
 216 static bool commandClearMetar(const SGPropertyNode* arg)
 217 {
 218   SGSubsystemGroup* envMgr = (SGSubsystemGroup*) globals->get_subsystem("environment");
 219   if (!envMgr) {
 220     return false;
 221   }
 222
 223   BasicRealWxController* self = (BasicRealWxController*) envMgr->get_subsystem("realwx");
 224   if (!self) {
 225     return false;
 226   }
 227
 228   string path = arg->getStringValue("path");
 229   self->removeMetarAtPath(path);
 230   return true;
 231 }
 232
 233 /* -------------------------------------------------------------------------------- */
 234 /*
 235 Properties
 236  ~/enabled: bool              Enables/Disables the realwx controller
 237  ~/metar[1..n]: string        Target property path for metar data
 238  */
 239
 240 BasicRealWxController::BasicRealWxController( SGPropertyNode_ptr rootNode, MetarRequester * metarRequester ) :
 241   _rootNode(rootNode),
 242   _ground_elevation_n( fgGetNode( "/position/ground-elev-m", true )),
 243   _max_age_n( fgGetNode( "/environment/params/metar-max-age-min", false ) ),
 244   _enabled(true),
 245   _wasEnabled(false),
 246   _requester(metarRequester)
 247 {
 248
 249     globals->get_commands()->addCommand("request-metar", commandRequestMetar);
 250     globals->get_commands()->addCommand("clear-metar", commandClearMetar);
 251 }
 252
 253 BasicRealWxController::~BasicRealWxController()
 254 {
 255     globals->get_commands()->removeCommand("request-metar");
 256     globals->get_commands()->removeCommand("clear-metar");
 257 }
 258
 259 void BasicRealWxController::init()
 260 {
 261     _wasEnabled = false;
 262
 263     // at least instantiate MetarProperties for /environment/metar
 264     SGPropertyNode_ptr metarNode = fgGetNode( _rootNode->getStringValue("metar", "/environment/metar"), true );
 265     _metarProperties.push_back( new LiveMetarProperties(metarNode,
 266                                                         _requester,
 267                                                         getMetarMaxAgeMin()));
 268
 269     BOOST_FOREACH( SGPropertyNode_ptr n, _rootNode->getChildren("metar") ) {
 270         SGPropertyNode_ptr metarNode = fgGetNode( n->getStringValue(), true );
 271         addMetarAtPath(metarNode->getPath(), "");
 272     }
 273
 274     checkNearbyMetar();
 275     update(0); // fetch data ASAP
 276
 277     globals->get_event_mgr()->addTask("checkNearbyMetar", this,
 278                                       &BasicRealWxController::checkNearbyMetar, 60 );
 279 }
 280
 281 void BasicRealWxController::reinit()
 282 {
 283     _wasEnabled = false;
 284     checkNearbyMetar();
 285     update(0); // fetch data ASAP
 286 }
 287
 288 void BasicRealWxController::shutdown()
 289 {
 290     globals->get_event_mgr()->removeTask("checkNearbyMetar");
 291 }
 292
 293 void BasicRealWxController::bind()
 294 {
 295     _tiedProperties.setRoot( _rootNode );
 296     _tiedProperties.Tie( "enabled", &_enabled );
 297 }
 298
 299 void BasicRealWxController::unbind()
 300 {
 301     _tiedProperties.Untie();
 302 }
 303
 304 void BasicRealWxController::update( double dt )
 305 {
 306   if( _enabled ) {
 307     bool firstIteration = !_wasEnabled;
 308     // clock tick for every METAR in stock
 309     BOOST_FOREACH(LiveMetarProperties* p, _metarProperties) {
 310       // first round? All received METARs are outdated
 311       if( firstIteration ) p->resetTimeToLive();
 312       p->update(dt);
 313     }
 314
 315     _wasEnabled = true;
 316   } else {
 317     _wasEnabled = false;
 318   }
 319 }
 320
 321 void BasicRealWxController::addMetarAtPath(const string& propPath, const string& icao)
 322 {
 323   // check for duplicate entries
 324   BOOST_FOREACH( LiveMetarProperties_ptr p, _metarProperties ) {
 325     if( p->get_root_node()->getPath() == propPath ) {
 326       // already exists
 327       if (p->getStationId() != icao) {
 328         p->setStationId(icao);
 329         p->resetTimeToLive();
 330       }
 331
 332       return;
 333     }
 334   } // of exitsing metar properties iteration
 335
 336   SGPropertyNode_ptr metarNode = fgGetNode(propPath, true);
 337   SG_LOG( SG_ENVIRONMENT, SG_INFO, "Adding metar properties at " << propPath );
 338   LiveMetarProperties_ptr p(new LiveMetarProperties( metarNode, _requester, getMetarMaxAgeMin() ));
 339   _metarProperties.push_back(p);
 340   p->setStationId(icao);
 341 }
 342
 343 void BasicRealWxController::removeMetarAtPath(const string &propPath)
 344 {
 345   SGPropertyNode_ptr n = fgGetNode(propPath,false);
 346   MetarPropertiesList::iterator it = _metarProperties.begin();
 347   for (; it != _metarProperties.end(); ++it) {
 348     LiveMetarProperties_ptr p(*it);
 349     // don not compare unprocessed property path
 350     // /foo/bar[0]/baz equals /foo/bar/baz
 351     if( p->get_root_node()->getPath() == n->getPath() ) {
 352       _metarProperties.erase(it);
 353       // final ref will drop, and delete the MetarProperties, when we return
 354       return;
 355     }
 356   }
 357
 358   SG_LOG(SG_ENVIRONMENT, SG_WARN, "no metar properties at " << propPath);
 359 }
 360
 361 void BasicRealWxController::checkNearbyMetar()
 362 {
 363     try {
 364       const SGGeod & pos = globals->get_aircraft_position();
 365
 366       // check nearest airport
 367       SG_LOG(SG_ENVIRONMENT, SG_DEBUG, "NoaaMetarRealWxController::update(): (re) checking nearby airport with METAR" );
 368
 369       FGAirport * nearestAirport = FGAirport::findClosest(pos, 10000.0, MetarAirportFilter::instance() );
 370       if( nearestAirport == NULL ) {
 371           SG_LOG(SG_ENVIRONMENT,SG_WARN,"RealWxController::update can't find airport with METAR within 10000NM"  );
 372           return;
 373       }
 374
 375       SG_LOG(SG_ENVIRONMENT, SG_DEBUG,
 376           "NoaaMetarRealWxController::update(): nearest airport with METAR is: " << nearestAirport->ident() );
 377
 378       // if it has changed, invalidate the associated METAR
 379       if( _metarProperties[0]->getStationId() != nearestAirport->ident() ) {
 380           SG_LOG(SG_ENVIRONMENT, SG_INFO,
 381               "NoaaMetarRealWxController::update(): nearest airport with METAR has changed. Old: '" <<
 382               _metarProperties[0]->getStationId() <<
 383               "', new: '" << nearestAirport->ident() << "'" );
 384           _metarProperties[0]->setStationId( nearestAirport->ident() );
 385           _metarProperties[0]->resetTimeToLive();
 386       }
 387     }
 388     catch( sg_exception & ) {
 389       return;
 390     }
 391
 392 }
 393
 394 /* -------------------------------------------------------------------------------- */
 395
 396 class NoaaMetarRealWxController : public BasicRealWxController, MetarRequester {
 397 public:
 398     NoaaMetarRealWxController( SGPropertyNode_ptr rootNode );
 399
 400     // implementation of MetarRequester
 401     virtual void requestMetar( MetarDataHandler * metarDataHandler, const std::string & id );
 402
 403     virtual ~NoaaMetarRealWxController()
 404     {
 405     }
 406 private:
 407
 408 };
 409
 410 NoaaMetarRealWxController::NoaaMetarRealWxController( SGPropertyNode_ptr rootNode ) :
 411   BasicRealWxController(rootNode, this )
 412 {
 413 }
 414
 415 void NoaaMetarRealWxController::requestMetar
 416 (
 417   MetarDataHandler* metarDataHandler,
 418   const std::string& id
 419 )
 420 {
 421   static const std::string NOAA_BASE_URL =
 422     "http://weather.noaa.gov/pub/data/observations/metar/stations/";
 423   class NoaaMetarGetRequest:
 424     public simgear::HTTP::MemoryRequest
 425   {
 426     public:
 427       NoaaMetarGetRequest( MetarDataHandler* metarDataHandler,
 428                            const std::string& stationId ):
 429         MemoryRequest(NOAA_BASE_URL + stationId + ".TXT"),
 430         _metarDataHandler(metarDataHandler)
 431       {
 432         std::ostringstream buf;
 433         buf <<  globals->get_time_params()->get_cur_time();
 434         requestHeader("X-TIME") = buf.str();
 435       }
 436
 437       virtual void onDone()
 438       {
 439         if( responseCode() != 200 )
 440         {
 441           SG_LOG
 442           (
 443             SG_ENVIRONMENT,
 444             SG_WARN,
 445             "metar download failed:" << url() << ": reason:" << responseReason()
 446           );
 447           return;
 448         }
 449
 450         _metarDataHandler->handleMetarData
 451         (
 452           simgear::strutils::simplify(responseBody())
 453         );
 454       }
 455
 456       virtual void onFail()
 457       {
 458         SG_LOG(SG_ENVIRONMENT, SG_INFO, "metar download failure");
 459         _metarDataHandler->handleMetarFailure();
 460       }
 461
 462     private:
 463       MetarDataHandler * _metarDataHandler;
 464   };
 465
 466   string upperId = boost::to_upper_copy(id);
 467
 468   SG_LOG
 469   (
 470     SG_ENVIRONMENT,
 471     SG_INFO,
 472     "NoaaMetarRealWxController::update(): "
 473     "spawning load request for station-id '" << upperId << "'"
 474   );
 475   FGHTTPClient* http = static_cast<FGHTTPClient*>(globals->get_subsystem("http"));
 476   if (http) {
 477       http->makeRequest(new NoaaMetarGetRequest(metarDataHandler, upperId));
 478   }
 479 }
 480
 481 /* -------------------------------------------------------------------------------- */
 482
 483 RealWxController * RealWxController::createInstance( SGPropertyNode_ptr rootNode )
 484 {
 485   return new NoaaMetarRealWxController( rootNode );
 486 }
 487
 488 RealWxController::~RealWxController()
 489 {
 490 }
 491
 492 /* -------------------------------------------------------------------------------- */
 493
 494 } // namespace Environment