src/Main/fg_init.cxx

   1 // fg_init.cxx -- Flight Gear top level initialization routines
   2 //
   3 // Written by Curtis Olson, started August 1997.
   4 //
   5 // Copyright (C) 1997  Curtis L. Olson  - http://www.flightgear.org/~curt
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include <config.h>
  26 #endif
  27
  28 #include <simgear/compiler.h>
  29
  30 #include <stdio.h>
  31 #include <stdlib.h>
  32 #include <string.h>             // strcmp()
  33
  34 #if defined(SG_WINDOWS)
  35 #  include <io.h>               // isatty()
  36 #  include <process.h>          // _getpid()
  37 #  include <Windows.h>
  38 #  define isatty _isatty
  39 #else
  40 // for open() and options
  41 #  include <sys/types.h>
  42 #  include <sys/stat.h>
  43 #  include <fcntl.h>
  44 #endif
  45
  46 #include <string>
  47
  48 #include <boost/algorithm/string/compare.hpp>
  49 #include <boost/algorithm/string/predicate.hpp>
  50
  51 #include <osgViewer/Viewer>
  52
  53 #include <simgear/canvas/Canvas.hxx>
  54 #include <simgear/constants.h>
  55 #include <simgear/debug/logstream.hxx>
  56 #include <simgear/structure/exception.hxx>
  57 #include <simgear/structure/event_mgr.hxx>
  58 #include <simgear/structure/SGPerfMon.hxx>
  59 #include <simgear/misc/sg_path.hxx>
  60 #include <simgear/misc/sg_dir.hxx>
  61 #include <simgear/misc/sgstream.hxx>
  62 #include <simgear/misc/strutils.hxx>
  63 #include <simgear/props/props_io.hxx>
  64 #include <simgear/scene/tsync/terrasync.hxx>
  65
  66 #include <simgear/scene/model/modellib.hxx>
  67 #include <simgear/scene/material/matlib.hxx>
  68 #include <simgear/scene/material/Effect.hxx>
  69 #include <simgear/scene/model/particles.hxx>
  70 #include <simgear/scene/tsync/terrasync.hxx>
  71
  72 #include <Aircraft/controls.hxx>
  73 #include <Aircraft/replay.hxx>
  74 #include <Aircraft/FlightHistory.hxx>
  75 #include <Airports/runways.hxx>
  76 #include <Airports/airport.hxx>
  77 #include <Airports/dynamics.hxx>
  78
  79 #include <AIModel/AIManager.hxx>
  80
  81 #include <ATC/atc_mgr.hxx>
  82
  83 #include <Autopilot/route_mgr.hxx>
  84 #include <Autopilot/autopilotgroup.hxx>
  85
  86 #include <Cockpit/panel.hxx>
  87 #include <Cockpit/panel_io.hxx>
  88
  89 #include <Canvas/canvas_mgr.hxx>
  90 #include <Canvas/gui_mgr.hxx>
  91 #include <Canvas/FGCanvasSystemAdapter.hxx>
  92 #include <GUI/new_gui.hxx>
  93 #include <GUI/MessageBox.hxx>
  94 #include <Input/input.hxx>
  95 #include <Instrumentation/instrument_mgr.hxx>
  96 #include <Model/acmodel.hxx>
  97 #include <Model/modelmgr.hxx>
  98 #include <AIModel/submodel.hxx>
  99 #include <AIModel/AIManager.hxx>
 100 #include <Navaids/navdb.hxx>
 101 #include <Navaids/navlist.hxx>
 102 #include <Scenery/scenery.hxx>
 103 #include <Scenery/tilemgr.hxx>
 104 #include <Scripting/NasalSys.hxx>
 105 #include <Sound/voice.hxx>
 106 #include <Sound/soundmanager.hxx>
 107 #include <Systems/system_mgr.hxx>
 108 #include <Time/light.hxx>
 109 #include <Time/TimeManager.hxx>
 110
 111 #include <Traffic/TrafficMgr.hxx>
 112 #include <MultiPlayer/multiplaymgr.hxx>
 113 #include <FDM/fdm_shell.hxx>
 114 #include <Environment/ephemeris.hxx>
 115 #include <Environment/environment_mgr.hxx>
 116 #include <Viewer/renderer.hxx>
 117 #include <Viewer/viewmgr.hxx>
 118 #include <Viewer/FGEventHandler.hxx>
 119 #include <Navaids/NavDataCache.hxx>
 120 #include <Instrumentation/HUD/HUD.hxx>
 121 #include <Cockpit/cockpitDisplayManager.hxx>
 122 #include <Network/HTTPClient.hxx>
 123 #include <Network/fgcom.hxx>
 124 #include <Network/http/httpd.hxx>
 125
 126 #include <Viewer/CameraGroup.hxx>
 127
 128 #include "fg_init.hxx"
 129 #include "fg_io.hxx"
 130 #include "fg_commands.hxx"
 131 #include "fg_props.hxx"
 132 #include "FGInterpolator.hxx"
 133 #include "options.hxx"
 134 #include "globals.hxx"
 135 #include "logger.hxx"
 136 #include "main.hxx"
 137 #include "positioninit.hxx"
 138 #include "util.hxx"
 139 #include "AircraftDirVisitorBase.hxx"
 140
 141 #if defined(SG_MAC)
 142 #include <GUI/CocoaHelpers.h> // for Mac impl of platformDefaultDataPath()
 143 #endif
 144
 145 #define NEW_RESET 1
 146
 147 using std::string;
 148 using std::endl;
 149 using std::cerr;
 150 using std::cout;
 151 using namespace boost::algorithm;
 152
 153 extern osg::ref_ptr<osgViewer::Viewer> viewer;
 154
 155 // Return the current base package version
 156 string fgBasePackageVersion() {
 157     SGPath base_path( globals->get_fg_root() );
 158     base_path.append("version");
 159     if (!base_path.exists()) {
 160         return string();
 161     }
 162
 163     sg_gzifstream in( base_path.str() );
 164     if (!in.is_open()) {
 165         return string();
 166     }
 167
 168     string version;
 169     in >> version;
 170
 171     return version;
 172 }
 173
 174 class FindAndCacheAircraft : public AircraftDirVistorBase
 175 {
 176 public:
 177   FindAndCacheAircraft(SGPropertyNode* autoSave)
 178   {
 179     _cache = autoSave->getNode("sim/startup/path-cache", true);
 180   }
 181
 182   bool loadAircraft()
 183   {
 184     std::string aircraft = fgGetString( "/sim/aircraft", "");
 185     if (aircraft.empty()) {
 186         flightgear::fatalMessageBox("No aircraft", "No aircraft was specified");
 187       SG_LOG(SG_GENERAL, SG_ALERT, "no aircraft specified");
 188       return false;
 189     }
 190
 191     _searchAircraft = aircraft + "-set.xml";
 192     std::string aircraftDir = fgGetString("/sim/aircraft-dir", "");
 193     if (!aircraftDir.empty()) {
 194       // aircraft-dir was set, skip any searching at all, if it's valid
 195       simgear::Dir acPath(aircraftDir);
 196       SGPath setFile = acPath.file(_searchAircraft);
 197       if (setFile.exists()) {
 198         SG_LOG(SG_GENERAL, SG_INFO, "found aircraft in dir: " << aircraftDir );
 199
 200         try {
 201           readProperties(setFile.str(), globals->get_props());
 202         } catch ( const sg_exception &e ) {
 203           SG_LOG(SG_INPUT, SG_ALERT, "Error reading aircraft: " << e.getFormattedMessage());
 204             flightgear::fatalMessageBox("Error reading aircraft",
 205                                         "An error occured reading the requested aircraft (" + aircraft + ")",
 206                                         e.getFormattedMessage());
 207           return false;
 208         }
 209
 210         return true;
 211       } else {
 212         SG_LOG(SG_GENERAL, SG_ALERT, "aircraft '" << _searchAircraft <<
 213                "' not found in specified dir:" << aircraftDir);
 214           flightgear::fatalMessageBox("Aircraft not found",
 215                                       "The requested aircraft '" + aircraft + "' could not be found in the specified location.",
 216                                       aircraftDir);
 217         return false;
 218       }
 219     }
 220
 221     if (!checkCache()) {
 222       // prepare cache for re-scan
 223       SGPropertyNode *n = _cache->getNode("fg-root", true);
 224       n->setStringValue(globals->get_fg_root().c_str());
 225       n->setAttribute(SGPropertyNode::USERARCHIVE, true);
 226       n = _cache->getNode("fg-aircraft", true);
 227       n->setStringValue(getAircraftPaths().c_str());
 228       n->setAttribute(SGPropertyNode::USERARCHIVE, true);
 229       _cache->removeChildren("aircraft");
 230
 231         visitAircraftPaths();
 232     }
 233
 234     if (_foundPath.str().empty()) {
 235       SG_LOG(SG_GENERAL, SG_ALERT, "Cannot find specified aircraft: " << aircraft );
 236         flightgear::fatalMessageBox("Aircraft not found",
 237                                     "The requested aircraft '" + aircraft + "' could not be found in any of the search paths");
 238
 239       return false;
 240     }
 241
 242     SG_LOG(SG_GENERAL, SG_INFO, "Loading aircraft -set file from:" << _foundPath.str());
 243     fgSetString( "/sim/aircraft-dir", _foundPath.dir().c_str());
 244     if (!_foundPath.exists()) {
 245       SG_LOG(SG_GENERAL, SG_ALERT, "Unable to find -set file:" << _foundPath.str());
 246       return false;
 247     }
 248
 249     try {
 250       readProperties(_foundPath.str(), globals->get_props());
 251     } catch ( const sg_exception &e ) {
 252       SG_LOG(SG_INPUT, SG_ALERT, "Error reading aircraft: " << e.getFormattedMessage());
 253         flightgear::fatalMessageBox("Error reading aircraft",
 254                                     "An error occured reading the requested aircraft (" + aircraft + ")",
 255                                     e.getFormattedMessage());
 256       return false;
 257     }
 258
 259     return true;
 260   }
 261
 262 private:
 263   SGPath getAircraftPaths() {
 264     string_list pathList = globals->get_aircraft_paths();
 265     SGPath aircraftPaths;
 266     string_list::const_iterator it = pathList.begin();
 267     if (it != pathList.end()) {
 268         aircraftPaths.set(*it);
 269         it++;
 270     }
 271     for (; it != pathList.end(); ++it) {
 272         aircraftPaths.add(*it);
 273     }
 274     return aircraftPaths;
 275   }
 276
 277   bool checkCache()
 278   {
 279     if (globals->get_fg_root() != _cache->getStringValue("fg-root", "")) {
 280       return false; // cache mismatch
 281     }
 282
 283     if (getAircraftPaths().str() != _cache->getStringValue("fg-aircraft", "")) {
 284       return false; // cache mismatch
 285     }
 286
 287     vector<SGPropertyNode_ptr> cache = _cache->getChildren("aircraft");
 288     for (unsigned int i = 0; i < cache.size(); i++) {
 289       const char *name = cache[i]->getStringValue("file", "");
 290       if (!boost::equals(_searchAircraft, name, is_iequal())) {
 291         continue;
 292       }
 293
 294       SGPath xml(cache[i]->getStringValue("path", ""));
 295       xml.append(name);
 296       if (xml.exists()) {
 297         _foundPath = xml;
 298         return true;
 299       }
 300
 301       return false;
 302     } // of aircraft in cache iteration
 303
 304     return false;
 305   }
 306
 307   virtual VisitResult visit(const SGPath& p)
 308   {
 309     // create cache node
 310     int i = 0;
 311     while (1) {
 312         if (!_cache->getChild("aircraft", i++, false))
 313             break;
 314     }
 315
 316     SGPropertyNode *n, *entry = _cache->getChild("aircraft", --i, true);
 317
 318     std::string fileName(p.file());
 319     n = entry->getNode("file", true);
 320     n->setStringValue(fileName);
 321     n->setAttribute(SGPropertyNode::USERARCHIVE, true);
 322
 323     n = entry->getNode("path", true);
 324     n->setStringValue(p.dir());
 325     n->setAttribute(SGPropertyNode::USERARCHIVE, true);
 326
 327     if ( boost::equals(fileName, _searchAircraft.c_str(), is_iequal()) ) {
 328         _foundPath = p;
 329         return VISIT_DONE;
 330     }
 331
 332     return VISIT_CONTINUE;
 333   }
 334
 335   std::string _searchAircraft;
 336   SGPath _foundPath;
 337   SGPropertyNode* _cache;
 338 };
 339
 340 #ifdef _WIN32
 341 static SGPath platformDefaultDataPath()
 342 {
 343   char *envp = ::getenv( "APPDATA" );
 344   SGPath config( envp );
 345   config.append( "flightgear.org" );
 346   return config;
 347 }
 348
 349 #elif defined(SG_MAC)
 350
 351 // platformDefaultDataPath defined in GUI/CocoaHelpers.h
 352
 353 #else
 354 static SGPath platformDefaultDataPath()
 355 {
 356   return SGPath::home() / ".fgfs";
 357 }
 358 #endif
 359
 360 bool fgInitHome()
 361 {
 362   SGPath dataPath = SGPath::fromEnv("FG_HOME", platformDefaultDataPath());
 363   globals->set_fg_home(dataPath.c_str());
 364
 365     simgear::Dir fgHome(dataPath);
 366     if (!fgHome.exists()) {
 367         fgHome.create(0755);
 368     }
 369
 370     if (!fgHome.exists()) {
 371         flightgear::fatalMessageBox("Problem setting up user data",
 372                                     "Unable to create the user-data storage folder at: '"
 373                                     + dataPath.str() + "'");
 374         return false;
 375     }
 376
 377     if (fgGetBool("/sim/fghome-readonly", false)) {
 378         // user / config forced us into readonly mode, fine
 379         SG_LOG(SG_GENERAL, SG_INFO, "Running with FG_HOME readonly");
 380         return true;
 381     }
 382
 383 // write our PID, and check writeability
 384     SGPath pidPath(dataPath, "fgfs.pid");
 385     if (pidPath.exists()) {
 386         SG_LOG(SG_GENERAL, SG_INFO, "flightgear instance already running, switching to FG_HOME read-only.");
 387         // set a marker property so terrasync/navcache don't try to write
 388         // from secondary instances
 389         fgSetBool("/sim/fghome-readonly", true);
 390         return true;
 391     }
 392
 393     char buf[16];
 394     bool result = false;
 395 #if defined(SG_WINDOWS)
 396     size_t len = snprintf(buf, 16, "%d", _getpid());
 397
 398     HANDLE f = CreateFileA(pidPath.c_str(), GENERIC_READ | GENERIC_WRITE,
 399                                                    FILE_SHARE_READ, /* sharing */
 400                            NULL, /* security attributes */
 401                            CREATE_NEW, /* error if already exists */
 402                            FILE_FLAG_DELETE_ON_CLOSE,
 403                                                    NULL /* template */);
 404
 405     result = (f != INVALID_HANDLE_VALUE);
 406     if (result) {
 407                 DWORD written;
 408         WriteFile(f, buf, len, &written, NULL /* overlapped */);
 409     }
 410 #else
 411     // POSIX, do open+unlink trick to the file is deleted on exit, even if we
 412     // crash or exit(-1)
 413     ssize_t len = snprintf(buf, 16, "%d", getpid());
 414     int fd = ::open(pidPath.c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, 0644);
 415     if (fd >= 0) {
 416         result = ::write(fd, buf, len) == len;
 417         if( ::unlink(pidPath.c_str()) != 0 ) // delete file when app quits
 418           result = false;
 419     }
 420 #endif
 421
 422     fgSetBool("/sim/fghome-readonly", false);
 423
 424     if (!result) {
 425         flightgear::fatalMessageBox("File permissions problem",
 426                                     "Can't write to user-data storage folder, check file permissions and FG_HOME.",
 427                                     "User-data at:" + dataPath.str());
 428     }
 429     return result;
 430 }
 431
 432 // Read in configuration (file and command line)
 433 int fgInitConfig ( int argc, char **argv, bool reinit )
 434 {
 435     SGPath dataPath = globals->get_fg_home();
 436
 437     simgear::Dir exportDir(simgear::Dir(dataPath).file("Export"));
 438     if (!exportDir.exists()) {
 439       exportDir.create(0755);
 440     }
 441
 442     // Set /sim/fg-home and don't allow malign code to override it until
 443     // Nasal security is set up.  Use FG_HOME if necessary.
 444     SGPropertyNode *home = fgGetNode("/sim", true);
 445     home->removeChild("fg-home", 0);
 446     home = home->getChild("fg-home", 0, true);
 447     home->setStringValue(dataPath.c_str());
 448     home->setAttribute(SGPropertyNode::WRITE, false);
 449
 450     fgSetDefaults();
 451     flightgear::Options* options = flightgear::Options::sharedInstance();
 452     if (!reinit) {
 453         options->init(argc, argv, dataPath);
 454     }
 455
 456     bool loadDefaults = options->shouldLoadDefaultConfig();
 457     if (loadDefaults) {
 458       // Read global preferences from $FG_ROOT/preferences.xml
 459       SG_LOG(SG_INPUT, SG_INFO, "Reading global preferences");
 460       fgLoadProps("preferences.xml", globals->get_props());
 461       SG_LOG(SG_INPUT, SG_INFO, "Finished Reading global preferences");
 462
 463       // do not load user settings when reset to default is requested, or if
 464       // told to explicitly ignore
 465       if (options->isOptionSet("restore-defaults") || options->isOptionSet("ignore-autosave"))
 466       {
 467           SG_LOG(SG_ALL, SG_ALERT, "Ignoring user settings. Restoring defaults.");
 468       }
 469       else
 470       {
 471           globals->loadUserSettings(dataPath);
 472       }
 473     } else {
 474       SG_LOG(SG_GENERAL, SG_INFO, "not reading default configuration files");
 475     }// of no-default-config selected
 476
 477     return flightgear::FG_OPTIONS_OK;
 478 }
 479
 480 int fgInitAircraft(bool reinit)
 481 {
 482     // Scan user config files and command line for a specified aircraft.
 483     if (reinit) {
 484         SGPropertyNode* sim = fgGetNode("/sim", true);
 485         sim->removeChildren("fg-aircraft");
 486         // after reset, add aircraft dirs to props, neede for Nasal IO rules
 487         string_list::const_iterator it;
 488         int index = 0;
 489         for (it = globals->get_aircraft_paths().begin();
 490              it != globals->get_aircraft_paths().end(); ++it, ++index)
 491         {
 492             SGPropertyNode* n = sim->getChild("fg-aircraft", index, true);
 493             n->setStringValue(*it);
 494             n->setAttribute(SGPropertyNode::WRITE, false);
 495
 496         }
 497
 498         SGPropertyNode* aircraftProp = fgGetNode("/sim/aircraft", true);
 499         aircraftProp->setAttribute(SGPropertyNode::PRESERVE, true);
 500     } else {
 501         flightgear::Options::sharedInstance()->initAircraft();
 502     }
 503
 504     FindAndCacheAircraft f(globals->get_props());
 505     if (!f.loadAircraft()) {
 506         return flightgear::FG_OPTIONS_ERROR;
 507     }
 508
 509     return flightgear::FG_OPTIONS_OK;
 510 }
 511
 512 /**
 513  * Initialize vor/ndb/ils/fix list management and query systems (as
 514  * well as simple airport db list)
 515  * This is called multiple times in the case of a cache rebuild,
 516  * to allow lengthy caching to take place in the background, without
 517  * blocking the main/UI thread.
 518  */
 519 bool
 520 fgInitNav ()
 521 {
 522   flightgear::NavDataCache* cache = flightgear::NavDataCache::instance();
 523   static bool doingRebuild = false;
 524   if (doingRebuild || cache->isRebuildRequired()) {
 525     doingRebuild = true;
 526     bool finished = cache->rebuild();
 527     if (!finished) {
 528       // sleep to give the rebuild thread more time
 529       SGTimeStamp::sleepForMSec(50);
 530       return false;
 531     }
 532   }
 533
 534   FGTACANList *channellist = new FGTACANList;
 535   globals->set_channellist( channellist );
 536
 537   SGPath path(globals->get_fg_root());
 538   path.append( "Navaids/TACAN_freq.dat" );
 539   flightgear::loadTacan(path, channellist);
 540
 541   return true;
 542 }
 543
 544 // General house keeping initializations
 545 bool fgInitGeneral() {
 546     string root;
 547
 548     SG_LOG( SG_GENERAL, SG_INFO, "General Initialization" );
 549     SG_LOG( SG_GENERAL, SG_INFO, "======= ==============" );
 550
 551     root = globals->get_fg_root();
 552     if ( ! root.length() ) {
 553         // No root path set? Then bail ...
 554         SG_LOG( SG_GENERAL, SG_ALERT,
 555                 "Cannot continue without a path to the base package "
 556                 << "being defined." );
 557         return false;
 558     }
 559     SG_LOG( SG_GENERAL, SG_INFO, "FG_ROOT = " << '"' << root << '"' << endl );
 560
 561     // Note: browser command is hard-coded for Mac/Windows, so this only affects other platforms
 562     globals->set_browser(fgGetString("/sim/startup/browser-app", WEB_BROWSER));
 563     fgSetString("/sim/startup/browser-app", globals->get_browser());
 564
 565     simgear::Dir cwd(simgear::Dir::current());
 566     SGPropertyNode *curr = fgGetNode("/sim", true);
 567     curr->removeChild("fg-current", 0);
 568     curr = curr->getChild("fg-current", 0, true);
 569     curr->setStringValue(cwd.path().str());
 570     curr->setAttribute(SGPropertyNode::WRITE, false);
 571
 572     fgSetBool("/sim/startup/stdout-to-terminal", isatty(1) != 0 );
 573     fgSetBool("/sim/startup/stderr-to-terminal", isatty(2) != 0 );
 574     return true;
 575 }
 576
 577 // Write various configuraton values out to the logs
 578 void fgOutputSettings()
 579 {
 580     SG_LOG( SG_GENERAL, SG_INFO, "Configuration State" );
 581     SG_LOG( SG_GENERAL, SG_INFO, "======= ==============" );
 582
 583     SG_LOG( SG_GENERAL, SG_INFO, "aircraft-dir = " << '"' << fgGetString("/sim/aircraft-dir") << '"' );
 584     SG_LOG( SG_GENERAL, SG_INFO, "fghome-dir = " << '"' << globals->get_fg_home() << '"');
 585     SG_LOG( SG_GENERAL, SG_INFO, "aircraft-dir = " << '"' << fgGetString("/sim/aircraft-dir") << '"');
 586
 587     SG_LOG( SG_GENERAL, SG_INFO, "aircraft-search-paths = \n\t" << simgear::strutils::join(globals->get_aircraft_paths(), "\n\t") );
 588     SG_LOG( SG_GENERAL, SG_INFO, "scenery-search-paths = \n\t" << simgear::strutils::join(globals->get_fg_scenery(), "\n\t") );
 589 }
 590
 591 // This is the top level init routine which calls all the other
 592 // initialization routines.  If you are adding a subsystem to flight
 593 // gear, its initialization call should located in this routine.
 594 // Returns non-zero if a problem encountered.
 595 void fgCreateSubsystems(bool duringReset) {
 596
 597     SG_LOG( SG_GENERAL, SG_INFO, "Creating Subsystems");
 598     SG_LOG( SG_GENERAL, SG_INFO, "========== ==========");
 599
 600     ////////////////////////////////////////////////////////////////////
 601     // Initialize the sound subsystem.
 602     ////////////////////////////////////////////////////////////////////
 603     // Sound manager uses an own subsystem group "SOUND" which is the last
 604     // to be updated in every loop.
 605     // Sound manager is updated last so it can use the CPU while the GPU
 606     // is processing the scenery (doubled the frame-rate for me) -EMH-
 607     globals->add_subsystem("sound", new FGSoundManager, SGSubsystemMgr::SOUND);
 608
 609     ////////////////////////////////////////////////////////////////////
 610     // Initialize the event manager subsystem.
 611     ////////////////////////////////////////////////////////////////////
 612
 613     globals->get_event_mgr()->init();
 614     globals->get_event_mgr()->setRealtimeProperty(fgGetNode("/sim/time/delta-realtime-sec", true));
 615
 616     ////////////////////////////////////////////////////////////////////
 617     // Initialize the property interpolator subsystem. Put into the INIT
 618     // group because the "nasal" subsystem may need it at GENERAL take-down.
 619     ////////////////////////////////////////////////////////////////////
 620     FGInterpolator* interp = new FGInterpolator;
 621     interp->setRealtimeProperty(fgGetNode("/sim/time/delta-realtime-sec", true));
 622     globals->add_subsystem("prop-interpolator", interp, SGSubsystemMgr::INIT);
 623     SGPropertyNode::setInterpolationMgr(interp);
 624
 625     ////////////////////////////////////////////////////////////////////
 626     // Add the FlightGear property utilities.
 627     ////////////////////////////////////////////////////////////////////
 628     globals->add_subsystem("properties", new FGProperties);
 629
 630
 631     ////////////////////////////////////////////////////////////////////
 632     // Add the performance monitoring system.
 633     ////////////////////////////////////////////////////////////////////
 634     globals->add_subsystem("performance-mon",
 635             new SGPerformanceMonitor(globals->get_subsystem_mgr(),
 636                                      fgGetNode("/sim/performance-monitor", true)));
 637
 638     ////////////////////////////////////////////////////////////////////
 639     // Initialize the material property subsystem.
 640     ////////////////////////////////////////////////////////////////////
 641
 642     SGPath mpath( globals->get_fg_root() );
 643     mpath.append( fgGetString("/sim/rendering/materials-file") );
 644     if ( ! globals->get_matlib()->load(globals->get_fg_root(), mpath.str(),
 645             globals->get_props()) ) {
 646        throw sg_io_exception("Error loading materials file", mpath);
 647     }
 648
 649     globals->add_subsystem( "http", new FGHTTPClient );
 650
 651     ////////////////////////////////////////////////////////////////////
 652     // Initialize the scenery management subsystem.
 653     ////////////////////////////////////////////////////////////////////
 654
 655     globals->get_scenery()->get_scene_graph()
 656         ->addChild(simgear::Particles::getCommonRoot());
 657     simgear::GlobalParticleCallback::setSwitch(fgGetNode("/sim/rendering/particles", true));
 658
 659     ////////////////////////////////////////////////////////////////////
 660     // Initialize the flight model subsystem.
 661     ////////////////////////////////////////////////////////////////////
 662
 663     globals->add_subsystem("flight", new FDMShell, SGSubsystemMgr::FDM);
 664
 665     ////////////////////////////////////////////////////////////////////
 666     // Initialize the weather subsystem.
 667     ////////////////////////////////////////////////////////////////////
 668
 669     // Initialize the weather modeling subsystem
 670     globals->add_subsystem("environment", new FGEnvironmentMgr);
 671     globals->add_subsystem("ephemeris", new Ephemeris);
 672
 673     ////////////////////////////////////////////////////////////////////
 674     // Initialize the aircraft systems and instrumentation (before the
 675     // autopilot.)
 676     ////////////////////////////////////////////////////////////////////
 677
 678     globals->add_subsystem("systems", new FGSystemMgr, SGSubsystemMgr::FDM);
 679     globals->add_subsystem("instrumentation", new FGInstrumentMgr, SGSubsystemMgr::FDM);
 680     globals->add_subsystem("hud", new HUD, SGSubsystemMgr::DISPLAY);
 681     globals->add_subsystem("cockpit-displays", new flightgear::CockpitDisplayManager, SGSubsystemMgr::DISPLAY);
 682
 683     ////////////////////////////////////////////////////////////////////
 684     // Initialize the XML Autopilot subsystem.
 685     ////////////////////////////////////////////////////////////////////
 686
 687     globals->add_subsystem( "xml-autopilot", FGXMLAutopilotGroup::createInstance("autopilot"), SGSubsystemMgr::FDM );
 688     globals->add_subsystem( "xml-proprules", FGXMLAutopilotGroup::createInstance("property-rule"), SGSubsystemMgr::GENERAL );
 689     globals->add_subsystem( "route-manager", new FGRouteMgr );
 690
 691     ////////////////////////////////////////////////////////////////////
 692     // Initialize the Input-Output subsystem
 693     ////////////////////////////////////////////////////////////////////
 694     globals->add_subsystem( "io", new FGIO );
 695
 696     ////////////////////////////////////////////////////////////////////
 697     // Create and register the logger.
 698     ////////////////////////////////////////////////////////////////////
 699
 700     globals->add_subsystem("logger", new FGLogger);
 701
 702     ////////////////////////////////////////////////////////////////////
 703     // Create and register the XML GUI.
 704     ////////////////////////////////////////////////////////////////////
 705
 706     globals->add_subsystem("gui", new NewGUI, SGSubsystemMgr::INIT);
 707
 708     //////////////////////////////////////////////////////////////////////
 709     // Initialize the 2D cloud subsystem.
 710     ////////////////////////////////////////////////////////////////////
 711     fgGetBool("/sim/rendering/bump-mapping", false);
 712
 713     ////////////////////////////////////////////////////////////////////
 714     // Initialize the canvas 2d drawing subsystem.
 715     ////////////////////////////////////////////////////////////////////
 716     simgear::canvas::Canvas::setSystemAdapter(
 717       simgear::canvas::SystemAdapterPtr(new canvas::FGCanvasSystemAdapter)
 718     );
 719     globals->add_subsystem("Canvas", new CanvasMgr, SGSubsystemMgr::DISPLAY);
 720     globals->add_subsystem("CanvasGUI", new GUIMgr, SGSubsystemMgr::DISPLAY);
 721
 722     ////////////////////////////////////////////////////////////////////
 723    // Initialize the ATC subsystem
 724     ////////////////////////////////////////////////////////////////////
 725     globals->add_subsystem("ATC", new FGATCManager, SGSubsystemMgr::POST_FDM);
 726
 727     ////////////////////////////////////////////////////////////////////
 728     // Initialize multiplayer subsystem
 729     ////////////////////////////////////////////////////////////////////
 730
 731     globals->add_subsystem("mp", new FGMultiplayMgr, SGSubsystemMgr::POST_FDM);
 732
 733     ////////////////////////////////////////////////////////////////////
 734     // Initialise the AI Model Manager
 735     ////////////////////////////////////////////////////////////////////
 736     SG_LOG(SG_GENERAL, SG_INFO, "  AI Model Manager");
 737     globals->add_subsystem("ai-model", new FGAIManager, SGSubsystemMgr::POST_FDM);
 738     globals->add_subsystem("submodel-mgr", new FGSubmodelMgr, SGSubsystemMgr::POST_FDM);
 739
 740
 741     // It's probably a good idea to initialize the top level traffic manager
 742     // After the AI and ATC systems have been initialized properly.
 743     // AI Traffic manager
 744     globals->add_subsystem("traffic-manager", new FGTrafficManager, SGSubsystemMgr::POST_FDM);
 745
 746     ////////////////////////////////////////////////////////////////////
 747     // Add a new 2D panel.
 748     ////////////////////////////////////////////////////////////////////
 749
 750     fgSetArchivable("/sim/panel/visibility");
 751     fgSetArchivable("/sim/panel/x-offset");
 752     fgSetArchivable("/sim/panel/y-offset");
 753     fgSetArchivable("/sim/panel/jitter");
 754
 755     ////////////////////////////////////////////////////////////////////
 756     // Initialize the controls subsystem.
 757     ////////////////////////////////////////////////////////////////////
 758
 759     globals->add_subsystem("controls", new FGControls, SGSubsystemMgr::GENERAL);
 760
 761     ////////////////////////////////////////////////////////////////////
 762     // Initialize the input subsystem.
 763     ////////////////////////////////////////////////////////////////////
 764
 765     globals->add_subsystem("input", new FGInput, SGSubsystemMgr::GENERAL);
 766
 767
 768     ////////////////////////////////////////////////////////////////////
 769     // Initialize the replay subsystem
 770     ////////////////////////////////////////////////////////////////////
 771     globals->add_subsystem("replay", new FGReplay);
 772     globals->add_subsystem("history", new FGFlightHistory);
 773
 774 #ifdef ENABLE_AUDIO_SUPPORT
 775     ////////////////////////////////////////////////////////////////////
 776     // Initialize the sound-effects subsystem.
 777     ////////////////////////////////////////////////////////////////////
 778     globals->add_subsystem("voice", new FGVoiceMgr, SGSubsystemMgr::DISPLAY);
 779 #endif
 780
 781 #ifdef ENABLE_IAX
 782     ////////////////////////////////////////////////////////////////////
 783     // Initialize the FGCom subsystem.
 784     ////////////////////////////////////////////////////////////////////
 785     globals->add_subsystem("fgcom", new FGCom);
 786 #endif
 787
 788     {
 789       SGSubsystem * httpd = flightgear::http::FGHttpd::createInstance( fgGetNode(flightgear::http::PROPERTY_ROOT) );
 790       if( NULL != httpd )
 791         globals->add_subsystem("httpd", httpd  );
 792     }
 793
 794     ////////////////////////////////////////////////////////////////////
 795     // Initialize the lighting subsystem.
 796     ////////////////////////////////////////////////////////////////////
 797
 798     // ordering here is important : Nasal (via events), then models, then views
 799     if (!duringReset) {
 800         globals->add_subsystem("lighting", new FGLight, SGSubsystemMgr::DISPLAY);
 801         globals->add_subsystem("events", globals->get_event_mgr(), SGSubsystemMgr::DISPLAY);
 802     }
 803
 804     globals->add_subsystem("aircraft-model", new FGAircraftModel, SGSubsystemMgr::DISPLAY);
 805     globals->add_subsystem("model-manager", new FGModelMgr, SGSubsystemMgr::DISPLAY);
 806
 807     globals->add_subsystem("view-manager", new FGViewMgr, SGSubsystemMgr::DISPLAY);
 808
 809     globals->add_subsystem("tile-manager", globals->get_tile_mgr(),
 810       SGSubsystemMgr::DISPLAY);
 811 }
 812
 813 void fgPostInitSubsystems()
 814 {
 815     SGTimeStamp st;
 816     st.stamp();
 817
 818     ////////////////////////////////////////////////////////////////////////
 819     // Initialize the Nasal interpreter.
 820     // Do this last, so that the loaded scripts see initialized state
 821     ////////////////////////////////////////////////////////////////////////
 822     FGNasalSys* nasal = new FGNasalSys();
 823     globals->add_subsystem("nasal", nasal, SGSubsystemMgr::INIT);
 824     nasal->init();
 825     SG_LOG(SG_GENERAL, SG_INFO, "Nasal init took:" << st.elapsedMSec());
 826
 827     // Ensure IOrules and path validation are working properly by trying to
 828     // access a folder/file which should never be accessible.
 829     const char* no_access_path =
 830 #ifdef _WIN32
 831       "Z:"
 832 #endif
 833       "/do-not-access";
 834
 835     if( fgValidatePath(no_access_path, true) )
 836       SG_LOG
 837       (
 838         SG_GENERAL,
 839         SG_ALERT,
 840         "Check your IOrules! (write to '" << no_access_path << "' is allowed)"
 841       );
 842     if( fgValidatePath(no_access_path, false) )
 843       SG_LOG
 844       (
 845         SG_GENERAL,
 846         SG_ALERT,
 847         "Check your IOrules! (read from '" << no_access_path << "' is allowed)"
 848       );
 849
 850     // initialize methods that depend on other subsystems.
 851     st.stamp();
 852     globals->get_subsystem_mgr()->postinit();
 853     SG_LOG(SG_GENERAL, SG_INFO, "Subsystems postinit took:" << st.elapsedMSec());
 854
 855     ////////////////////////////////////////////////////////////////////////
 856     // End of subsystem initialization.
 857     ////////////////////////////////////////////////////////////////////
 858
 859     fgSetBool("/sim/crashed", false);
 860     fgSetBool("/sim/initialized", true);
 861
 862     SG_LOG( SG_GENERAL, SG_INFO, endl);
 863 }
 864
 865 // re-position is a simplified version of the traditional (legacy)
 866 // reset procedure. We only need to poke systems which will be upset by
 867 // a sudden change in aircraft position. Since this potentially includes
 868 // Nasal, we trigger the 'reinit' signal.
 869 void fgStartReposition()
 870 {
 871   SGPropertyNode *master_freeze = fgGetNode("/sim/freeze/master");
 872   SG_LOG( SG_GENERAL, SG_INFO, "fgStartReposition()");
 873
 874   // ensure we are frozen
 875   bool freeze = master_freeze->getBoolValue();
 876   if ( !freeze ) {
 877     master_freeze->setBoolValue(true);
 878   }
 879
 880   // set this signal so Nasal scripts can take action.
 881   fgSetBool("/sim/signals/reinit", true);
 882   fgSetBool("/sim/crashed", false);
 883
 884   FDMShell* fdm = static_cast<FDMShell*>(globals->get_subsystem("flight"));
 885   fdm->unbind();
 886
 887   // update our position based on current presets
 888   // this will mark position as needed finalized which we'll do in the
 889   // main-loop
 890   flightgear::initPosition();
 891
 892   simgear::SGTerraSync* terraSync =
 893   static_cast<simgear::SGTerraSync*>(globals->get_subsystem("terrasync"));
 894   if (terraSync) {
 895     terraSync->reposition();
 896   }
 897
 898   // Initialize the FDM
 899   globals->get_subsystem("flight")->reinit();
 900
 901   // reset replay buffers
 902   globals->get_subsystem("replay")->reinit();
 903
 904   // ugly: finalizePosition waits for METAR to arrive for the new airport.
 905   // we don't re-init the environment manager here, since historically we did
 906   // not, and doing so seems to have other issues. All that's needed is to
 907   // schedule METAR fetch immediately, so it's available for finalizePosition.
 908   // So we manually extract the METAR-fetching component inside the environment
 909   // manager, and re-init that.
 910   SGSubsystemGroup* envMgr = static_cast<SGSubsystemGroup*>(globals->get_subsystem("environment"));
 911   if (envMgr) {
 912     envMgr->get_subsystem("realwx")->reinit();
 913   }
 914
 915   // need to bind FDMshell again, since we manually unbound it above...
 916   fdm->bind();
 917
 918   // need to reset aircraft (systems/instruments/autopilot)
 919   // so they can adapt to current environment
 920   globals->get_subsystem("systems")->reinit();
 921   globals->get_subsystem("instrumentation")->reinit();
 922   globals->get_subsystem("xml-autopilot")->reinit();
 923
 924   // setup state to end re-init
 925   fgSetBool("/sim/signals/reinit", false);
 926   if ( !freeze ) {
 927     master_freeze->setBoolValue(false);
 928   }
 929   fgSetBool("/sim/sceneryloaded",false);
 930 }
 931
 932 void fgStartNewReset()
 933 {
 934     SGPropertyNode_ptr preserved(new SGPropertyNode);
 935
 936     if (!copyPropertiesWithAttribute(globals->get_props(), preserved, SGPropertyNode::PRESERVE))
 937         SG_LOG(SG_GENERAL, SG_ALERT, "Error saving preserved state");
 938
 939     fgSetBool("/sim/signals/reinit", true);
 940     fgSetBool("/sim/freeze/master", true);
 941
 942     SGSubsystemMgr* subsystemManger = globals->get_subsystem_mgr();
 943     // Nasal is manually inited in fgPostInit, ensure it's already shutdown
 944     // before other subsystems, so Nasal listeners don't fire during shutdonw
 945     SGSubsystem* nasal = subsystemManger->get_subsystem("nasal");
 946     nasal->shutdown();
 947     nasal->unbind();
 948     subsystemManger->remove("nasal");
 949
 950     subsystemManger->shutdown();
 951     subsystemManger->unbind();
 952
 953     // remove most subsystems, with a few exceptions.
 954     for (int g=0; g<SGSubsystemMgr::MAX_GROUPS; ++g) {
 955         SGSubsystemGroup* grp = subsystemManger->get_group(static_cast<SGSubsystemMgr::GroupType>(g));
 956         const string_list& names(grp->member_names());
 957         string_list::const_iterator it;
 958         for (it = names.begin(); it != names.end(); ++it) {
 959             if ((*it == "time") || (*it == "terrasync") || (*it == "events")
 960                 || (*it == "lighting"))
 961             {
 962                 continue;
 963             }
 964
 965             try {
 966                 subsystemManger->remove(it->c_str());
 967             } catch (std::exception& e) {
 968                 SG_LOG(SG_GENERAL, SG_INFO, "caught std::exception shutting down:" << *it);
 969             } catch (...) {
 970                 SG_LOG(SG_GENERAL, SG_INFO, "caught generic exception shutting down:" << *it);
 971             }
 972
 973             // don't delete here, dropping the ref should be sufficient
 974         }
 975     } // of top-level groups iteration
 976
 977     FGRenderer* render = globals->get_renderer();
 978     // needed or we crash in multi-threaded OSG mode
 979     render->getViewer()->stopThreading();
 980
 981     // order is important here since tile-manager shutdown needs to
 982     // access the scenery object
 983     globals->set_tile_mgr(NULL);
 984     globals->set_scenery(NULL);
 985     flightgear::CameraGroup::setDefault(NULL);
 986
 987     // don't cancel the pager until after shutdown, since AIModels (and
 988     // potentially others) can queue delete requests on the pager.
 989     render->getViewer()->getDatabasePager()->cancel();
 990     render->getViewer()->getDatabasePager()->clear();
 991
 992     osgDB::Registry::instance()->clearObjectCache();
 993
 994     // preserve the event handler; re-creating it would entail fixing the
 995     // idle handler
 996     osg::ref_ptr<flightgear::FGEventHandler> eventHandler = render->getEventHandler();
 997
 998     globals->set_renderer(NULL);
 999     globals->set_matlib(NULL);
1000     globals->set_chatter_queue(NULL);
1001
1002     simgear::clearEffectCache();
1003     simgear::SGModelLib::resetPropertyRoot();
1004
1005     simgear::GlobalParticleCallback::setSwitch(NULL);
1006
1007     globals->resetPropertyRoot();
1008     fgInitConfig(0, NULL, true);
1009     fgInitGeneral(); // all of this?
1010
1011     flightgear::Options::sharedInstance()->processOptions();
1012
1013     // PRESERVED properties over-write state from options, intentionally
1014     if ( copyProperties(preserved, globals->get_props()) ) {
1015         SG_LOG( SG_GENERAL, SG_INFO, "Preserved state restored successfully" );
1016     } else {
1017         SG_LOG( SG_GENERAL, SG_INFO,
1018                "Some errors restoring preserved state (read-only props?)" );
1019     }
1020
1021     fgGetNode("/sim")->removeChild("aircraft-dir");
1022     fgInitAircraft(true);
1023
1024     render = new FGRenderer;
1025     render->setEventHandler(eventHandler);
1026     eventHandler->reset();
1027     globals->set_renderer(render);
1028     render->init();
1029     render->setViewer(viewer.get());
1030
1031     viewer->getDatabasePager()->setUpThreads(1, 1);
1032
1033     // must do this before splashinit for Rembrandt
1034     flightgear::CameraGroup::buildDefaultGroup(viewer.get());
1035     render->splashinit();
1036     viewer->startThreading();
1037
1038     fgOSResetProperties();
1039
1040 // init some things manually
1041 // which do not follow the regular init pattern
1042
1043     globals->get_event_mgr()->init();
1044     globals->get_event_mgr()->setRealtimeProperty(fgGetNode("/sim/time/delta-realtime-sec", true));
1045
1046     globals->set_matlib( new SGMaterialLib );
1047
1048 // terra-sync needs the property tree root, pass it back in
1049     simgear::SGTerraSync* terra_sync = static_cast<simgear::SGTerraSync*>(subsystemManger->get_subsystem("terrasync"));
1050     terra_sync->setRoot(globals->get_props());
1051
1052     fgSetBool("/sim/signals/reinit", false);
1053     fgSetBool("/sim/freeze/master", false);
1054     fgSetBool("/sim/sceneryloaded",false);
1055 }
1056