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