Merge pull request #282 from TwinFan/Next

v4.2.1 OpenSky API Credentials

Author: TwinFan

.github/actions/build-mac/action.yml

@@ -22,17 +22,10 @@ outputs:
 runs:
   using: "composite"
   steps:
-  - name: Install required libs
-    shell: bash
-    run: |
-      brew install ninja
-  - name: Prepare
-    shell: bash
-    run: |
-      mkdir build-mac
   - name: CMake
     shell: bash
     run: |
+      mkdir build-mac
       cd build-mac
       pwd
       cmake -G Ninja ..

CMakeLists.txt

@@ -23,7 +23,7 @@ endif()
 set(CMAKE_BUILD_TYPE RelWithDebInfo)
 
 project(LiveTraffic
-        VERSION 4.2.0
+        VERSION 4.2.1
         DESCRIPTION "LiveTraffic X-Plane plugin")
 set(VERSION_BETA 0)
 
@@ -148,6 +148,7 @@ include_directories("${CMAKE_CURRENT_SOURCE_DIR}/Lib/SDK/CHeaders/XPLM")
 include_directories("${CMAKE_CURRENT_SOURCE_DIR}/Lib/ImGui")
 include_directories("${CMAKE_CURRENT_SOURCE_DIR}/Lib/ImGui/misc/cpp")
 include_directories("${CMAKE_CURRENT_SOURCE_DIR}/Lib/ImgWindow")
+include_directories("${CMAKE_CURRENT_SOURCE_DIR}/Lib/portable-file-dialogs")
 include_directories("${CMAKE_CURRENT_SOURCE_DIR}/Lib/Font")
 include_directories("${CMAKE_CURRENT_SOURCE_DIR}/Lib/metaf/include")
 

Include/Constants.h

@@ -145,7 +145,7 @@ extern time_t LT_BETA_VER_LIMIT;        // BETA versions are limited
 extern char LT_BETA_VER_LIMIT_TXT[];
 #define BETA_LIMITED_VERSION    "BETA limited to %s"
 #define BETA_LIMITED_EXPIRED    "BETA-Version limited to %s has EXPIRED -> SHUTTING DOWN! Get an up-to-date version from X-Plane.org."
-constexpr int LT_NEW_VER_CHECK_TIME = 48;   // [h] between two checks of a new
+constexpr int LT_NEW_VER_CHECK_TIME = 24;   ///< [h] between two checks for a new LT version
 
 //MARK: Text Constants
 #define LIVE_TRAFFIC            "LiveTraffic"
@@ -154,10 +154,9 @@ constexpr int LT_NEW_VER_CHECK_TIME = 48;   // [h] between two checks of a new
 #define PLUGIN_SIGNATURE        "TwinFan.plugin.LiveTraffic"
 #define PLUGIN_DESCRIPTION      "Create Multiplayer Aircraft based on live traffic."
 constexpr const char* REMOTE_SIGNATURE      =  "TwinFan.plugin.XPMP2.Remote";
-#define LT_DOWNLOAD_URL         "https://forums.x-plane.org/index.php?/files/file/49749-livetraffic/"
-#define LT_DOWNLOAD_CH          "X-Plane.org"
-#define OPSKY_EDIT_AC           "https://opensky-network.org/aircraft-profile?icao24="
-#define OPSKY_EDIT_ROUTE        "https://opensky-network.org/add-route?callsign="
+#define LT_DOWNLOAD_URL         "https://forums.x-plane.org/files/file/49749-livetraffic/"
+#define OPSKY_EDIT_AC           "https://opensky-network.org/data/aircraft?icao24="
+// Disabled until OpenSky offers the service again to maintain routes - #define OPSKY_EDIT_ROUTE        "https://opensky-network.org/add-route?callsign="
 #define MSG_DISABLED            "Disabled"
 #define MSG_STARTUP             "LiveTraffic %s starting up..."
 #define MSG_WELCOME             "LiveTraffic %s successfully loaded!"
@@ -211,8 +210,8 @@ constexpr const char* REMOTE_SIGNATURE      =  "TwinFan.plugin.XPMP2.Remote";
 #define CFG_DEFAULT_CAR_TYPE    "DEFAULT_CAR_TYPE"
 #define CFG_DEFAULT_AC_TYP_INFO "Default a/c type is '%s'"
 #define CFG_DEFAULT_CAR_TYP_INFO "Default car type is '%s'"
-#define CFG_OPENSKY_USER        "OpenSky_User"
-#define CFG_OPENSKY_PWD         "OpenSky_Pwd"
+#define CFG_OPENSKY_CLIENT      "OpenSky_Client"
+#define CFG_OPENSKY_SECRET      "OpenSky_Secret"
 #define CFG_ADSBEX_API_KEY      "ADSBEX_API_KEY"
 #define CFG_RT_LICENSE          "RealTraffic_License"
 #define CFG_FSC_USER            "FSC_User"
@@ -242,6 +241,7 @@ constexpr const char* REMOTE_SIGNATURE      =  "TwinFan.plugin.XPMP2.Remote";
 #define MENU_HELP_INSTALL_CSL   "Installaton of CSL Models"
 #define MENU_HELP_SUPPORT_FORUM "Support Forum"
 #define MENU_HELP_SUPPORT_HOWTO "Support HowTo"
+#define MENU_HELP_DOWNLOAD      "Download LiveTraffic"
 #define MENU_NEWVER             "New Version %s available!"
 #ifdef DEBUG
 #define MENU_RELOAD_PLUGINS     "Reload all Plugins (Caution!)"
@@ -278,8 +278,8 @@ constexpr const char* REMOTE_SIGNATURE      =  "TwinFan.plugin.XPMP2.Remote";
 #define HELP_SET_CSL            "setup/configuration/settings-csl"
 #define HELP_SET_DEBUG          "setup/configuration/settings-debug"
 
-#define URL_SUPPORT_FORUM       "https://forums.x-plane.org/index.php?/forums/forum/457-livetraffic-support/"
-#define URL_SUPPORT_HOWTO       "https://forums.x-plane.org/index.php?/forums/topic/174691-support"
+#define URL_SUPPORT_FORUM       "https://forums.x-plane.org/forums/forum/457-livetraffic-support/"
+#define URL_SUPPORT_HOWTO       "https://forums.x-plane.org/forums/topic/174691-support-attach-a-logtxt-file-and-provide-the-following-details/"
 
 //MARK: File Paths
 // these are under the plugins directory
@@ -304,6 +304,7 @@ constexpr const char* PATH_DELIMS = "/\\";      ///< potential path delimiters i
 
 //MARK: Error Texsts
 constexpr long HTTP_OK =            200;
+constexpr long HTTP_MOVED =         302;        ///< redirect
 constexpr long HTTP_BAD_REQUEST =   400;
 constexpr long HTTP_UNAUTHORIZED =  401;
 constexpr long HTTP_PAYMENT_REQU =  402;

Include/DataRefs.h

@@ -118,7 +118,7 @@ class Doc8643 {
 /// non-standardized human-readable `model` entries in
 /// tracking data (especially in OpenSky's data) to an ICAO a/c type code.
 /// The file has been created by forum user crbascott.
-/// @see https://forums.x-plane.org/index.php?/forums/topic/188206-matching-lacks-icao-ac-type-code/
+/// @see https://forums.x-plane.org/forums/topic/188206-matching-lacks-icao-ac-type-code/
 namespace ModelIcaoType
 {
     /// Read the `model_typecode.txt` file
@@ -753,8 +753,8 @@ class DataRefs
 
     std::string sDefaultAcIcaoType  = CSL_DEFAULT_ICAO_TYPE;
     std::string sDefaultCarIcaoType = CSL_CAR_ICAO_TYPE;
-    std::string sOpenSkyUser;           ///< OpenSky Network user
-    std::string sOpenSkyPwd;            ///< OpenSky Network password
+    std::string sOpenSkyClient;         ///< OpenSky Network Client ID
+    std::string sOpenSkySecret;         ///< OpenSky Network Client Secret
     std::string sADSBExAPIKey;          ///< ADS-B Exchange API key
     std::string sRTLicense;             ///< RealTraffic License
     std::string sFSCUser;               ///< FSCharter login user
@@ -1009,10 +1009,10 @@ class DataRefs
     inline bool IsChannelEnabled (dataRefsLT ch) const { return bChannel[ch - DR_CHANNEL_FIRST]; }
     int CntChannelEnabled () const;
 
-    void GetOpenSkyCredentials (std::string& user, std::string& pwd)
-    { user = sOpenSkyUser; pwd = sOpenSkyPwd; }
-    void SetOpenSkyUser (const std::string& user) { sOpenSkyUser = user; OpenSkyRRemain = LONG_MAX; OpenSkyRetryAt.clear(); }
-    void SetOpenSkyPwd (const std::string& pwd)   { sOpenSkyPwd = pwd;   OpenSkyRRemain = LONG_MAX; OpenSkyRetryAt.clear(); }
+    void GetOpenSkyCredentials (std::string& clientId, std::string& clientSecret)
+    { clientId = sOpenSkyClient; clientSecret = sOpenSkySecret; }
+    void SetOpenSkyClient (const std::string& clientId)     { sOpenSkyClient = clientId;     OpenSkyRRemain = LONG_MAX; OpenSkyRetryAt.clear(); }
+    void SetOpenSkySecret (const std::string& clientSecret) { sOpenSkySecret = clientSecret; OpenSkyRRemain = LONG_MAX; OpenSkyRetryAt.clear(); }
 
     const std::string& GetADSBExAPIKey () const { return sADSBExAPIKey; }
     void SetADSBExAPIKey (const std::string& apiKey) { sADSBExAPIKey = apiKey; }

Include/LTChannel.h

@@ -364,6 +364,13 @@ LTChannel* LTFlightDataGetCh (dataRefsLT ch);
 //
 void LTFlightDataAcMaintenance();
 
+//
+// MARK: Network helper functions
+//
+
+// cleanup the slist, returns if something was actually deleted
+bool CurlCleanupSlist (curl_slist* &pList);
+
 //
 //MARK: Parson Helper Functions
 //

Include/LTOpenSky.h

@@ -29,16 +29,23 @@
 
 //MARK: OpenSky Constants
 #define OPSKY_CHECK_NAME        "OpenSky Explorer"
-#define OPSKY_CHECK_URL         "https://opensky-network.org/network/explorer"
+#define OPSKY_CHECK_URL         "https://map.opensky-network.org/?lat=%.3f&lon=%.3f"
 #define OPSKY_CHECK_POPUP       "Check OpenSky's coverage"
 
+#define OPSKY_URL_GETTOKEN      "https://auth.opensky-network.org/auth/realms/opensky-network/protocol/openid-connect/token"
+#define OPSKY_BODY_GETTOKEN     "grant_type=client_credentials&client_id=%s&client_secret=%s"
+#define OPSKY_ACCESS_TOKEN      "access_token"
+#define OPSKY_AUTH_BEARER       "Authorization: Bearer "
+#define OPSKY_AUTH_EXPIRES      "expires_in"
+constexpr long OPSKY_AUTH_EXP_DEFAULT = 1800;       ///< default expiration in case we don't find expiration field
+
 #define OPSKY_NAME              "OpenSky Network"
 #define OPSKY_URL_ALL           "https://opensky-network.org/api/states/all?lamin=%.3f&lomin=%.3f&lamax=%.3f&lomax=%.3f"
-#define OPSKY_SLUG_FMT          "https://opensky-network.org/network/explorer?icao24=%06lx"
+#define OPSKY_SLUG_FMT          "https://map.opensky-network.org/?icao=%06lx"
 #define OPSKY_TIME              "time"
 #define OPSKY_AIRCRAFT_ARR      "states"
-#define OPSKY_RREMAIN           "X-Rate-Limit-Remaining:"
-#define OPSKY_RETRY             "X-Rate-Limit-Retry-After-Seconds:"
+#define OPSKY_RREMAIN           "x-rate-limit-remaining:"
+#define OPSKY_RETRY             "x-rate-limit-retry-after-seconds:"
 constexpr int OPSKY_TRANSP_ICAO   = 0;               // icao24
 constexpr int OPSKY_CALL          = 1;               // callsign
 constexpr int OPSKY_COUNTRY       = 2;               // origin_county
@@ -60,14 +67,31 @@ constexpr double OPSKY_SMOOTH_GROUND   = 35.0; // smooth 35s of ground data
 //
 class OpenSkyConnection : public LTFlightDataChannel
 {
+protected:
+    enum State {
+        OPSKY_STATE_NONE = 0,                   ///< no/initial/unknown status
+        OPSKY_STATE_GETTING_TOKEN,              ///< have credentials, but no access token yet
+        OPSKY_STATE_GET_PLANES,                 ///< normal operations: fetch planes
+    } eState = OPSKY_STATE_NONE;
+    struct curl_slist* pHdrForm = nullptr;      ///< HTTP Header (needed during fetching a token)
+    struct curl_slist* pHdrToken = nullptr;     ///< HTTP Header containing the bearer token
+    float tTokenExpiration = NAN;               ///< when will the token expire?
 public:
     OpenSkyConnection ();
+    void ResetStatus ();                        ///< used to force fetching a new token, e.g. after change of credentials
     std::string GetURL (const positionTy& pos) override;
+    void ComputeBody (const positionTy& pos) override;      ///< only needed for token request, will then form token request body
     bool ProcessFetchedData () override;
     std::string GetStatusText () const override;  ///< return a human-readable staus
 //    // shall data of this channel be subject to LTFlightData::DataSmoothing?
 //    bool DoDataSmoothing (double& gndRange, double& airbRange) const override
 //    { gndRange = OPSKY_SMOOTH_GROUND; airbRange = OPSKY_SMOOTH_AIRBORNE; return true; }
+    
+    /// @brief Process OpenSKy's 'crendetials.json' file to fetch User ID/Secret from it
+    static bool ProcessCredentialsJson (const std::string& sFileName,
+                                        std::string& sClientId,
+                                        std::string& sSecret);
+    
 protected:
     void Main () override;          ///< virtual thread main function
 
@@ -155,6 +179,7 @@ constexpr unsigned long OPSKY_NUM_LN_PER_POS = 250;
 class OpenSkyAcMasterFile : public LTACMasterdataChannel
 {
 protected:
+    char sAcDbfileName[50] = {0};                                   ///< Aircraft Database file name
     std::ifstream fAcDb;                                            ///< Aircraft Database file
     std::string ln;                                                 ///< a line in the database file
 
@@ -167,7 +192,8 @@ class OpenSkyAcMasterFile : public LTACMasterdataChannel
 public:
     std::string GetURL (const positionTy&) override { return ""; }  ///< No URL for the standard request processing
     bool ProcessFetchedData () override;                            ///< Process looked up master data
-protected:
+    std::string GetStatusText () const override;                    ///< adds the database date to the status text
+    protected:
     bool AcceptRequest (const acStatUpdateTy& requ) override;       ///< accept only master data requests
     void Main () override;                                          ///< virtual thread main function
     bool LookupData ();                                             ///< perform the file lookup

Include/LTSayIntentions.h

@@ -44,7 +44,8 @@
 #define SI_DISPLAYNAME          "displayname"
 #define SI_ORIGIN               "origin"
 #define SI_DEST                 "final_destination"
-#define SI_CALL                 "callsign"
+#define SI_CALL                 "flight_icao"           ///< callsign machine-readable, e.g. "AAL2502"
+#define SI_CALL_SPOKEN          "callsign"              ///< callsign as spoken, e.g. "American-two-five-zero-two"
 #define SI_REG                  "tail_number"
 #define SI_HEADING              "heading"
 #define SI_AC_TYPE              "aircraft_icao"

Include/LiveTraffic.h

@@ -162,6 +162,8 @@ void LTMainStop ();
 
 void LTRegularUpdates();        ///< collects all updates that need to be done up to every flight loop cycle
 void MenuUpdateAllItemStatus();
+bool IsNewVersionAvail ();      ///< Is there a new version of LiveTraffic available for download?
+std::string GetNewVersionNr (); ///< Return the new version's number
 void HandleNewVersionAvail ();
 
 #ifdef DEBUG
@@ -189,6 +191,9 @@ bool IsDir (const std::string& path);
 /// List of files in a directory (wrapper around XPLMGetDirectoryContents)
 std::vector<std::string> GetDirContents (const std::string& path, bool bDirOnly = false);
 
+/// Return a (platform-specific) path to the user's Download folder
+std::string GetDefaultDownloadDir();
+
 /// @brief Read a text line from file, no matter if ended by CRLF or LF
 std::istream& safeGetline(std::istream& is, std::string& t);
 
@@ -430,8 +435,8 @@ float interpolate (const std::vector<float>& scale,
 inline long randoml (long min, long max)
 { return long(((double) rand() / (RAND_MAX+1.0)) * (max-min+1)) + min; }
 
-// gets latest version info from X-Plane.org
-bool FetchXPlaneOrgVersion ();
+/// Fetches the latest available LiveTraffic version number
+bool FetchLatestLTVersion ();
 
 /// LiveTraffic's version number as pure integer for returning in a dataRef, like 201 for v2.01
 int GetLTVerNum(void* = NULL);

Include/SettingsUI.h

@@ -25,6 +25,10 @@
 // Settings UI Main window
 //
 
+// Forward declarations for portable-file-dialog stuff, which we don't want to include in pre-compiled header
+namespace pfd { class open_file; }
+void pfd_open_file_deleter (pfd::open_file* p);
+
 /// Settings dialog
 class LTSettingsUI : public LTImgWindow
 {
@@ -33,9 +37,11 @@ class LTSettingsUI : public LTImgWindow
     char sFilter[50] = {0};
 
     // Channel: OpenSky
-    std::string sOpenSkyUser;       ///< OpenSky Network user
-    std::string sOpenSkyPwd;        ///< OpenSky Network password
-    bool bOpenSkyPwdClearText = false;  ///< Is OpenSky pwd displayed clear text?
+    /// smart pointer to the at most one System File Open Dialog
+    std::unique_ptr<pfd::open_file, decltype(&pfd_open_file_deleter)> pfdOpenFile;
+    std::string sOpenSkyClientId;           ///< OpenSky Network Client ID
+    std::string sOpenSkySecret;             ///< OpenSky Network Secret
+    bool bOpenSkySecretClearText = false;   ///< Is OpenSky pwd displayed clear text?
 
     // Channel: ADS-B Exchange
     enum {

Lib/ImgWindow/ImgWindow.cpp

@@ -562,7 +562,7 @@ ImgWindow::HandleKeyFuncCB(
             // Apparently, the virtual VR keyboard sends both the Up and the Down
             // event within the same drawing cycle, which would overwrite
             // io.KeyDown[XPLM_VK_BACK] with false again before we could pass on true.
-            // Also see https://forums.x-plane.org/index.php?/forums/topic/147139-dear-imgui-x-plane/&do=findComment&comment=2032062
+            // Also see https://forums.x-plane.org/forums/topic/147139-dear-imgui-x-plane/&do=findComment&comment=2032062
             // though I am following a different solution:
             // So we ignore the "up" event (release key) here, and do the actual
             // release only after the next drawing cycle (flag bResetBackspace).