]> git.mxchange.org Git - flightgear.git/blobdiff - src/Main/fg_init.cxx
Reset: make fgSetDefaults non-static.
[flightgear.git] / src / Main / fg_init.cxx
index 9e8c4d83b131ee61f235adb72e34b136c03b7228..d1d4d15ca8237368e373b5e37941ea20f2c529be 100644 (file)
 #  include <config.h>
 #endif
 
+#include <simgear/compiler.h>
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>             // strcmp()
 
-#ifdef _WIN32
+#if defined(SG_WINDOWS)
 #  include <io.h>               // isatty()
+#  include <process.h>          // _getpid()
+#  include <Windows.h>
 #  define isatty _isatty
+#else
+// for open() and options
+#  include <sys/types.h>        
+#  include <sys/stat.h>
+#  include <fcntl.h>
 #endif
 
-#include <simgear/compiler.h>
-
 #include <string>
 #include <boost/algorithm/string/compare.hpp>
 #include <boost/algorithm/string/predicate.hpp>
 #include <simgear/misc/strutils.hxx>
 #include <simgear/props/props_io.hxx>
 
-#include <simgear/misc/interpolator.hxx>
 #include <simgear/scene/material/matlib.hxx>
 #include <simgear/scene/model/particles.hxx>
+#include <simgear/scene/tsync/terrasync.hxx>
 
 #include <Aircraft/controls.hxx>
 #include <Aircraft/replay.hxx>
+#include <Aircraft/FlightHistory.hxx>
 #include <Airports/runways.hxx>
-#include <Airports/simple.hxx>
+#include <Airports/airport.hxx>
 #include <Airports/dynamics.hxx>
 
 #include <AIModel/AIManager.hxx>
@@ -75,6 +83,7 @@
 #include <Canvas/canvas_mgr.hxx>
 #include <Canvas/gui_mgr.hxx>
 #include <GUI/new_gui.hxx>
+#include <GUI/MessageBox.hxx>
 #include <Input/input.hxx>
 #include <Instrumentation/instrument_mgr.hxx>
 #include <Model/acmodel.hxx>
 #include <Navaids/NavDataCache.hxx>
 #include <Instrumentation/HUD/HUD.hxx>
 #include <Cockpit/cockpitDisplayManager.hxx>
+#include <Network/HTTPClient.hxx>
+#include <Network/fgcom.hxx>
 
 #include "fg_init.hxx"
 #include "fg_io.hxx"
 #include "fg_commands.hxx"
 #include "fg_props.hxx"
+#include "FGInterpolator.hxx"
 #include "options.hxx"
 #include "globals.hxx"
 #include "logger.hxx"
 #include "main.hxx"
 #include "positioninit.hxx"
+#include "util.hxx"
+
+#if defined(SG_MAC)
+#include <GUI/CocoaHelpers.h> // for Mac impl of platformDefaultDataPath()
+#endif
 
 using std::string;
+using std::endl;
+using std::cerr;
+using std::cout;
 using namespace boost::algorithm;
 
 
@@ -119,17 +139,13 @@ using namespace boost::algorithm;
 string fgBasePackageVersion() {
     SGPath base_path( globals->get_fg_root() );
     base_path.append("version");
-
+    if (!base_path.exists()) {
+        return string();
+    }
+    
     sg_gzifstream in( base_path.str() );
-    if ( !in.is_open() ) {
-        SGPath old_path( globals->get_fg_root() );
-        old_path.append( "Thanks" );
-        sg_gzifstream old( old_path.str() );
-        if ( !old.is_open() ) {
-            return "[none]";
-        } else {
-            return "[old version]";
-        }
+    if (!in.is_open()) {
+        return string();
     }
 
     string version;
@@ -211,6 +227,7 @@ public:
   {
     std::string aircraft = fgGetString( "/sim/aircraft", "");
     if (aircraft.empty()) {
+        flightgear::fatalMessageBox("No aircraft", "No aircraft was specified");
       SG_LOG(SG_GENERAL, SG_ALERT, "no aircraft specified");
       return false;
     }
@@ -228,6 +245,9 @@ public:
           readProperties(setFile.str(), globals->get_props());
         } catch ( const sg_exception &e ) {
           SG_LOG(SG_INPUT, SG_ALERT, "Error reading aircraft: " << e.getFormattedMessage());
+            flightgear::fatalMessageBox("Error reading aircraft",
+                                        "An error occured reading the requested aircraft (" + aircraft + ")",
+                                        e.getFormattedMessage());
           return false;
         }
         
@@ -235,6 +255,9 @@ public:
       } else {
         SG_LOG(SG_GENERAL, SG_ALERT, "aircraft '" << _searchAircraft << 
                "' not found in specified dir:" << aircraftDir);
+          flightgear::fatalMessageBox("Aircraft not found",
+                                      "The requested aircraft '" + aircraft + "' could not be found in the specified location.",
+                                      aircraftDir);
         return false;
       }
     }
@@ -254,6 +277,9 @@ public:
     
     if (_foundPath.str().empty()) {
       SG_LOG(SG_GENERAL, SG_ALERT, "Cannot find specified aircraft: " << aircraft );
+        flightgear::fatalMessageBox("Aircraft not found",
+                                    "The requested aircraft '" + aircraft + "' could not be found in any of the search paths");
+
       return false;
     }
     
@@ -268,6 +294,9 @@ public:
       readProperties(_foundPath.str(), globals->get_props());
     } catch ( const sg_exception &e ) {
       SG_LOG(SG_INPUT, SG_ALERT, "Error reading aircraft: " << e.getFormattedMessage());
+        flightgear::fatalMessageBox("Error reading aircraft",
+                                    "An error occured reading the requested aircraft (" + aircraft + ")",
+                                    e.getFormattedMessage());
       return false;
     }
     
@@ -360,47 +389,93 @@ static SGPath platformDefaultDataPath()
   config.append( "flightgear.org" );
   return config;
 }
-#elif __APPLE__
 
-#include <CoreServices/CoreServices.h>
+#elif defined(SG_MAC)
+
+// platformDefaultDataPath defined in GUI/CocoaHelpers.h
 
-static SGPath platformDefaultDataPath()
-{
-  FSRef ref;
-  OSErr err = FSFindFolder(kUserDomain, kApplicationSupportFolderType, false, &ref);
-  if (err) {
-    return SGPath();
-  }
-  
-  unsigned char path[1024];
-  if (FSRefMakePath(&ref, path, 1024) != noErr) {
-    return SGPath();
-  }
-  
-  SGPath appData;
-  appData.set((const char*) path);
-  appData.append("FlightGear");
-  return appData;
-}
 #else
 static SGPath platformDefaultDataPath()
 {
-  SGPath config( homedir );
-  config.append( ".fgfs" );
-  return config;
+  return SGPath::home() / ".fgfs";
 }
 #endif
 
-// Read in configuration (file and command line)
-bool fgInitConfig ( int argc, char **argv )
+bool fgInitHome()
 {
-    SGPath dataPath = platformDefaultDataPath();
+  SGPath dataPath = SGPath::fromEnv("FG_HOME", platformDefaultDataPath());
+  globals->set_fg_home(dataPath.c_str());
     
-    const char *fg_home = getenv("FG_HOME");
-    if (fg_home)
-      dataPath = fg_home;
-      
-    globals->set_fg_home(dataPath.c_str());
+    simgear::Dir fgHome(dataPath);
+    if (!fgHome.exists()) {
+        fgHome.create(0755);
+    }
+    
+    if (!fgHome.exists()) {
+        flightgear::fatalMessageBox("Problem setting up user data",
+                                    "Unable to create the user-data storage folder at: '"
+                                    + dataPath.str() + "'");
+        return false;
+    }
+    
+    if (fgGetBool("/sim/fghome-readonly", false)) {
+        // user / config forced us into readonly mode, fine
+        SG_LOG(SG_GENERAL, SG_INFO, "Running with FG_HOME readonly");
+        return true;
+    }
+    
+// write our PID, and check writeability
+    SGPath pidPath(dataPath, "fgfs.pid");
+    if (pidPath.exists()) {
+        SG_LOG(SG_GENERAL, SG_INFO, "flightgear instance already running, switching to FG_HOME read-only.");
+        // set a marker property so terrasync/navcache don't try to write
+        // from secondary instances
+        fgSetBool("/sim/fghome-readonly", true);
+        return true;
+    }
+    
+    char buf[16];
+    bool result = false;
+#if defined(SG_WINDOWS)
+    size_t len = snprintf(buf, 16, "%d", _getpid());
+
+    HANDLE f = CreateFileA(pidPath.c_str(), GENERIC_READ | GENERIC_WRITE, 
+                                                  FILE_SHARE_READ, /* sharing */
+                           NULL, /* security attributes */
+                           CREATE_NEW, /* error if already exists */
+                           FILE_FLAG_DELETE_ON_CLOSE,
+                                                  NULL /* template */);
+    
+    result = (f != INVALID_HANDLE_VALUE);
+    if (result) {
+               DWORD written;
+        WriteFile(f, buf, len, &written, NULL /* overlapped */);
+    }
+#else
+    // POSIX, do open+unlink trick to the file is deleted on exit, even if we
+    // crash or exit(-1)
+    size_t len = snprintf(buf, 16, "%d", getpid());
+    int fd = ::open(pidPath.c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, 0644);
+    if (fd >= 0) {
+        ::write(fd, buf, len);
+        ::unlink(pidPath.c_str()); // delete file when app quits
+        result = true;
+    }
+    
+    fgSetBool("/sim/fghome-readonly", false);
+#endif
+    if (!result) {
+        flightgear::fatalMessageBox("File permissions problem",
+                                    "Can't write to user-data storage folder, check file permissions and FG_HOME.",
+                                    "User-data at:" + dataPath.str());
+    }
+    return result;
+}
+
+// Read in configuration (file and command line)
+int fgInitConfig ( int argc, char **argv )
+{
+    SGPath dataPath = globals->get_fg_home();
     
     simgear::Dir exportDir(simgear::Dir(dataPath).file("Export"));
     if (!exportDir.exists()) {
@@ -415,6 +490,7 @@ bool fgInitConfig ( int argc, char **argv )
     home->setStringValue(dataPath.c_str());
     home->setAttribute(SGPropertyNode::WRITE, false);
   
+    fgSetDefaults();
     flightgear::Options* options = flightgear::Options::sharedInstance();
     options->init(argc, argv, dataPath);
     bool loadDefaults = flightgear::Options::sharedInstance()->shouldLoadDefaultConfig();
@@ -423,9 +499,10 @@ bool fgInitConfig ( int argc, char **argv )
       SG_LOG(SG_INPUT, SG_INFO, "Reading global preferences");
       fgLoadProps("preferences.xml", globals->get_props());
       SG_LOG(SG_INPUT, SG_INFO, "Finished Reading global preferences");
-
-      // do not load user settings when reset to default is requested
-      if (flightgear::Options::sharedInstance()->isOptionSet("restore-defaults"))
+        
+      // do not load user settings when reset to default is requested, or if
+      // told to explicitly ignore
+      if (options->isOptionSet("restore-defaults") || options->isOptionSet("ignore-autosave"))
       {
           SG_LOG(SG_ALL, SG_ALERT, "Ignoring user settings. Restoring defaults.");
       }
@@ -442,14 +519,12 @@ bool fgInitConfig ( int argc, char **argv )
 
     FindAndCacheAircraft f(globals->get_props());
     if (!f.loadAircraft()) {
-      return false;
+      return flightgear::FG_OPTIONS_ERROR;
     }
 
     // parse options after loading aircraft to ensure any user
     // overrides of defaults are honored.
-    options->processOptions();
-      
-    return true;
+    return options->processOptions();
 }
 
 
@@ -458,7 +533,7 @@ bool fgInitConfig ( int argc, char **argv )
  * Initialize vor/ndb/ils/fix list management and query systems (as
  * well as simple airport db list)
  * This is called multiple times in the case of a cache rebuild,
- * to allow length caching to take place in the background, without
+ * to allow lengthy caching to take place in the background, without
  * blocking the main/UI thread.
  */
 bool
@@ -499,7 +574,7 @@ bool fgInitGeneral() {
         SG_LOG( SG_GENERAL, SG_ALERT,
                 "Cannot continue without a path to the base package "
                 << "being defined." );
-        exit(-1);
+        return false;
     }
     SG_LOG( SG_GENERAL, SG_INFO, "FG_ROOT = " << '"' << root << '"' << endl );
 
@@ -519,6 +594,20 @@ bool fgInitGeneral() {
     return true;
 }
 
+// Write various configuraton values out to the logs
+void fgOutputSettings()
+{    
+    SG_LOG( SG_GENERAL, SG_INFO, "Configuration State" );
+    SG_LOG( SG_GENERAL, SG_INFO, "======= ==============" );
+    
+    SG_LOG( SG_GENERAL, SG_INFO, "aircraft-dir = " << '"' << fgGetString("/sim/aircraft-dir") << '"' );
+    SG_LOG( SG_GENERAL, SG_INFO, "fghome-dir = " << '"' << globals->get_fg_home() << '"');
+    SG_LOG( SG_GENERAL, SG_INFO, "aircraft-dir = " << '"' << fgGetString("/sim/aircraft-dir") << '"');
+    
+    SG_LOG( SG_GENERAL, SG_INFO, "aircraft-search-paths = \n\t" << simgear::strutils::join(globals->get_aircraft_paths(), "\n\t") );
+    SG_LOG( SG_GENERAL, SG_INFO, "scenery-search-paths = \n\t" << simgear::strutils::join(globals->get_fg_scenery(), "\n\t") );
+}
+
 // This is the top level init routine which calls all the other
 // initialization routines.  If you are adding a subsystem to flight
 // gear, its initialization call should located in this routine.
@@ -548,8 +637,10 @@ void fgCreateSubsystems() {
     // Initialize the property interpolator subsystem. Put into the INIT
     // group because the "nasal" subsystem may need it at GENERAL take-down.
     ////////////////////////////////////////////////////////////////////
-    globals->add_subsystem("interpolator", new SGInterpolator, SGSubsystemMgr::INIT);
-
+    FGInterpolator* interp = new FGInterpolator;
+    interp->setRealtimeProperty(fgGetNode("/sim/time/delta-realtime-sec", true));
+    globals->add_subsystem("prop-interpolator", interp, SGSubsystemMgr::INIT);
+    SGPropertyNode::setInterpolationMgr(interp);
 
     ////////////////////////////////////////////////////////////////////
     // Add the FlightGear property utilities.
@@ -572,12 +663,11 @@ void fgCreateSubsystems() {
     mpath.append( fgGetString("/sim/rendering/materials-file") );
     if ( ! globals->get_matlib()->load(globals->get_fg_root(), mpath.str(),
             globals->get_props()) ) {
-        SG_LOG( SG_GENERAL, SG_ALERT,
-                "Error loading materials file " << mpath.str() );
-        exit(-1);
+        throw sg_io_exception("Error loading materials file", mpath);
     }
 
-
+    globals->add_subsystem( "http", new FGHTTPClient );
+    
     ////////////////////////////////////////////////////////////////////
     // Initialize the scenery management subsystem.
     ////////////////////////////////////////////////////////////////////
@@ -622,7 +712,7 @@ void fgCreateSubsystems() {
     // Initialize the Input-Output subsystem
     ////////////////////////////////////////////////////////////////////
     globals->add_subsystem( "io", new FGIO );
-
+  
     ////////////////////////////////////////////////////////////////////
     // Create and register the logger.
     ////////////////////////////////////////////////////////////////////
@@ -706,7 +796,8 @@ void fgCreateSubsystems() {
     // Initialize the replay subsystem
     ////////////////////////////////////////////////////////////////////
     globals->add_subsystem("replay", new FGReplay);
-
+    globals->add_subsystem("history", new FGFlightHistory);
+    
 #ifdef ENABLE_AUDIO_SUPPORT
     ////////////////////////////////////////////////////////////////////
     // Initialize the sound-effects subsystem.
@@ -714,6 +805,13 @@ void fgCreateSubsystems() {
     globals->add_subsystem("voice", new FGVoiceMgr, SGSubsystemMgr::DISPLAY);
 #endif
 
+#ifdef ENABLE_IAX
+    ////////////////////////////////////////////////////////////////////
+    // Initialize the FGCom subsystem.
+    ////////////////////////////////////////////////////////////////////
+    globals->add_subsystem("fgcom", new FGCom);
+#endif
+
     ////////////////////////////////////////////////////////////////////
     // Initialize the lighting subsystem.
     ////////////////////////////////////////////////////////////////////
@@ -726,9 +824,7 @@ void fgCreateSubsystems() {
     globals->add_subsystem("aircraft-model", new FGAircraftModel, SGSubsystemMgr::DISPLAY);
     globals->add_subsystem("model-manager", new FGModelMgr, SGSubsystemMgr::DISPLAY);
 
-    FGViewMgr *viewmgr = new FGViewMgr;
-    globals->set_viewmgr( viewmgr );
-    globals->add_subsystem("view-manager", viewmgr, SGSubsystemMgr::DISPLAY);
+    globals->add_subsystem("view-manager", new FGViewMgr, SGSubsystemMgr::DISPLAY);
 
     globals->add_subsystem("tile-manager", globals->get_tile_mgr(), 
       SGSubsystemMgr::DISPLAY);
@@ -747,35 +843,35 @@ void fgPostInitSubsystems()
     globals->add_subsystem("nasal", nasal, SGSubsystemMgr::INIT);
     nasal->init();
     SG_LOG(SG_GENERAL, SG_INFO, "Nasal init took:" << st.elapsedMSec());
+
+    // Ensure IOrules and path validation are working properly by trying to
+    // access a folder/file which should never be accessible.
+    const char* no_access_path =
+#ifdef _WIN32
+      "Z:"
+#endif
+      "/do-not-access";
+
+    if( fgValidatePath(no_access_path, true) )
+      SG_LOG
+      (
+        SG_GENERAL,
+        SG_ALERT,
+        "Check your IOrules! (write to '" << no_access_path << "' is allowed)"
+      );
+    if( fgValidatePath(no_access_path, false) )
+      SG_LOG
+      (
+        SG_GENERAL,
+        SG_ALERT,
+        "Check your IOrules! (read from '" << no_access_path << "' is allowed)"
+      );
   
     // initialize methods that depend on other subsystems.
     st.stamp();
     globals->get_subsystem_mgr()->postinit();
     SG_LOG(SG_GENERAL, SG_INFO, "Subsystems postinit took:" << st.elapsedMSec());
   
-    ////////////////////////////////////////////////////////////////////
-    // TODO FIXME! UGLY KLUDGE!
-    ////////////////////////////////////////////////////////////////////
-    {
-        /* Scenarios require Nasal, so FGAIManager loads the scenarios,
-         * including its models such as a/c carriers, in its 'postinit',
-         * which is the very last thing we do.
-         * flightgear::initPosition is called very early in main.cxx/fgIdleFunction,
-         * one of the first things we do, long before scenarios/carriers are
-         * loaded. => When requested "initial preset position" relates to a
-         * carrier, recalculate the 'initial' position here (how have things
-         * ever worked before this hack - this init sequence has always been
-         * this way...?)*/
-        std::string carrier = fgGetString("/sim/presets/carrier","");
-        if (carrier != "")
-        {
-            // clear preset location and re-trigger position setup
-            fgSetDouble("/sim/presets/longitude-deg", 9999);
-            fgSetDouble("/sim/presets/latitude-deg", 9999);
-            flightgear::initPosition();
-        }
-    }
-
     ////////////////////////////////////////////////////////////////////////
     // End of subsystem initialization.
     ////////////////////////////////////////////////////////////////////
@@ -793,15 +889,14 @@ void fgPostInitSubsystems()
 // Reset: this is what the 'reset' command (and hence, GUI) is attached to
 void fgReInitSubsystems()
 {
-    static const SGPropertyNode *master_freeze
-        = fgGetNode("/sim/freeze/master");
+    SGPropertyNode *master_freeze = fgGetNode("/sim/freeze/master");
 
     SG_LOG( SG_GENERAL, SG_INFO, "fgReInitSubsystems()");
 
 // setup state to begin re-init
     bool freeze = master_freeze->getBoolValue();
     if ( !freeze ) {
-        fgSetBool("/sim/freeze/master", true);
+        master_freeze->setBoolValue(true);
     }
     
     fgSetBool("/sim/signals/reinit", true);
@@ -817,8 +912,16 @@ void fgReInitSubsystems()
     globals->restoreInitialState();
 
     // update our position based on current presets
+    // this will mark position as needed finalized which we'll do in the
+    // main-loop
     flightgear::initPosition();
     
+    simgear::SGTerraSync* terraSync =
+        static_cast<simgear::SGTerraSync*>(globals->get_subsystem("terrasync"));
+    if (terraSync) {
+        terraSync->reposition();
+    }
+    
     // Force reupdating the positions of the ai 3d models. They are used for
     // initializing ground level for the FDM.
     globals->get_subsystem("ai-model")->reinit();
@@ -832,6 +935,17 @@ void fgReInitSubsystems()
     // reload offsets from config defaults
     globals->get_viewmgr()->reinit();
 
+    // ugly: finalizePosition waits for METAR to arrive for the new airport.
+    // we don't re-init the environment manager here, since historically we did
+    // not, and doing so seems to have other issues. All that's needed is to
+    // schedule METAR fetch immediately, so it's available for finalizePosition.
+    // So we manually extract the METAR-fetching component inside the environment
+    // manager, and re-init that.
+    SGSubsystemGroup* envMgr = static_cast<SGSubsystemGroup*>(globals->get_subsystem("environment"));
+    if (envMgr) {
+      envMgr->get_subsystem("realwx")->reinit();
+    }
+  
     globals->get_subsystem("time")->reinit();
 
     // need to bind FDMshell again, since we manually unbound it above...
@@ -841,10 +955,12 @@ void fgReInitSubsystems()
     globals->get_subsystem("systems")->reinit();
     globals->get_subsystem("instrumentation")->reinit();
 
+    globals->get_subsystem("ATIS")->reinit();
+
 // setup state to end re-init
     fgSetBool("/sim/signals/reinit", false);
     if ( !freeze ) {
-        fgSetBool("/sim/freeze/master", false);
+        master_freeze->setBoolValue(false);
     }
     fgSetBool("/sim/sceneryloaded",false);
 }
@@ -868,8 +984,9 @@ public:
   {
     fgFindAircraftInDir(path, this, &ShowAircraft::processAircraft);
   
+       simgear::requestConsole(); // ensure console is shown on Windows
+
     std::sort(_aircraft.begin(), _aircraft.end(), ciLessLibC());
-    SG_LOG( SG_GENERAL, SG_ALERT, "" ); // To popup the console on Windows
     cout << "Available aircraft:" << endl;
     for ( unsigned int i = 0; i < _aircraft.size(); i++ ) {
         cout << _aircraft[i] << endl;
@@ -961,7 +1078,7 @@ void fgShowAircraft(const SGPath &path)
         
 #ifdef _MSC_VER
     cout << "Hit a key to continue..." << endl;
-    cin.get();
+    std::cin.get();
 #endif
 }