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