Merge branch 'adsbex-v2' into Next

Author: TwinFan

CMakeLists.txt

@@ -23,7 +23,7 @@ endif()
 set(CMAKE_BUILD_TYPE RelWithDebInfo)
 
 project(LiveTraffic
-        VERSION 4.1.2
+        VERSION 4.2.0
         DESCRIPTION "LiveTraffic X-Plane plugin")
 set(VERSION_BETA 0)
 

Include/DataRefs.h

@@ -796,6 +796,7 @@ class DataRefs
     std::string OpenSkyRetryAt;         ///< OpenSky: If limit is reached, when to retry? (local time as string)
     long ADSBExRLimit = 0;              // ADSBEx: Limit on RapidAPI
     long ADSBExRRemain = 0;             // ADSBEx: Remaining Requests on RapidAPI
+    long ADSBExRReset = 0;              ///< [s] ADSBEx: When will the quota reset?
 
     // UI information
     int UIopacity = DEF_UI_OPACITY;     ///< [%] UI opacity

Include/LTADSBEx.h

@@ -1,7 +1,12 @@
 /// @file       LTADSBEx.h
 /// @brief      ADS-B Exchange and adsb.fi: Requests and processes live tracking data
-/// @see        https://www.adsbexchange.com/
-/// @see        https://github.com/adsbfi/opendata
+/// @see        ADSBEx: https://www.adsbexchange.com/
+///             RAPID API: https://rapidapi.com/adsbx/api/adsbexchange-com1
+///             RAPID API Endpoint: https://rapidapi.com/adsbx/api/adsbexchange-com1/playground/endpoint_7dee5835-86b3-40ce-a402-f1ab43240884
+///             ADSBEx v2 API documentation:
+///             ...on Swagger: https://adsbexchange.com/api/aircraft/v2/docs
+///             ...fields: https://www.adsbexchange.com/version-2-api-wip/
+/// @see        adsb.fi: https://github.com/adsbfi/opendata
 /// @details    Defines a base class handling the ADSBEx data format,
 ///             which is shared by both ADS-B Exchange and adsb.fi.
 /// @details    Defines ADSBExchangeConnection:\n
@@ -39,21 +44,25 @@
 #define ADSBEX_CHECK_POPUP      "Check ADS-B Exchange's coverage"
 
 #define ADSBEX_NAME             "ADS-B Exchange"
-#define ADSBEX_URL              "https://adsbexchange.com/api/aircraft/v2/lat/%f/lon/%f/dist/%d/"
-#define ADSBEX_API_AUTH         "api-auth:"     // additional HTTP header
-
-#define ADSBEX_RAPIDAPI_25_URL  "https://adsbx-flight-sim-traffic.p.rapidapi.com/api/aircraft/json/lat/%f/lon/%f/dist/25/"
-#define ADSBEX_RAPIDAPI_HOST    "X-RapidAPI-Host:adsbx-flight-sim-traffic.p.rapidapi.com"
-#define ADSBEX_RAPIDAPI_KEY     "X-RapidAPI-Key:"
-#define ADSBEX_RAPIDAPI_RLIMIT  "x-ratelimit-requests-limit:"
-#define ADSBEX_RAPIDAPI_RREMAIN "x-ratelimit-requests-remaining:"
+#define ADSBEX_RAPIDAPI_URL     "https://adsbexchange-com1.p.rapidapi.com/v2/lat/%f/lon/%f/dist/%d/"
+#define ADSBEX_RAPIDAPI_HOST    "x-rapidapi-host: adsbexchange-com1.p.rapidapi.com"
+#define ADSBEX_RAPIDAPI_KEY     "x-rapidapi-key: "
+#define ADSBEX_RAPIDAPI_RLIMIT  "x-ratelimit-api-requests-limit: "
+#define ADSBEX_RAPIDAPI_RREMAIN "x-ratelimit-api-requests-remaining: "
+#define ADSBEX_RAPIDAPI_RESET   "x-ratelimit-api-requests-reset: "
 
 #define ADSBEX_TOTAL            "total"
 #define ADSBEX_NOW              "now"
+#define ADSBEX_TIME             "ctime"
 #define ADSBEX_AIRCRAFT_ARR     "ac"
+#define ADSBEX_MSG              "msg"           ///< Error message text field according to documentation
+#define ADSBEX_MESSAGE          "message"       ///< Error message text field we actually see in the responses
+
+#define ADSBEX_SUCCESS          "No error"      ///< Content of 'msg' in case of success
 
 // Version 2 keys
 #define ADSBEX_V2_TRANSP_ICAO   "hex"           // Key data
+#define ADSBEX_V2_TRANSP_TYPE   "type"          ///< type of transponder, or source of data, like "adsb_icao", "adsr_icao", or "tisb_other"
 #define ADSBEX_V2_RADAR_CODE    "squawk"        // Dynamic data
 #define ADSBEX_V2_FLIGHT        "flight"
 #define ADSBEX_V2_LAT           "lat"
@@ -72,47 +81,19 @@
 #define ADSBEX_V2_AC_CATEGORY   "category"
 #define ADSBEX_V2_FLAGS         "dbFlags"
 
-// Version 1 keys
-#define ADSBEX_TIME             "ctime"
-#define ADSBEX_V1_TRANSP_ICAO   "icao"          // Key data
-#define ADSBEX_V1_RADAR_CODE    "sqk"           // Dynamic data
-#define ADSBEX_V1_CALL          "call"
-#define ADSBEX_V1_LAT           "lat"
-#define ADSBEX_V1_LON           "lon"
-#define ADSBEX_V1_ELEVATION     "galt"          // geometric altitude
-#define ADSBEX_V1_ALT           "alt"           // barometric altitude
-#define ADSBEX_V1_TTRK          "ttrk"
-#define ADSBEX_V1_HEADING       "trak"
-#define ADSBEX_V1_GND           "gnd"
-#define ADSBEX_V1_POS_TIME      "postime"
-#define ADSBEX_V1_SPD           "spd"
-#define ADSBEX_V1_VSI           "vsi"
-#define ADSBEX_V1_REG           "reg"
-#define ADSBEX_V1_COUNTRY       "cou"
-#define ADSBEX_V1_AC_TYPE_ICAO  "type"
-#define ADSBEX_V1_MIL           "mil"
-#define ADSBEX_V1_OP_ICAO       "opicao"
-#define ADSBEX_V1_ORIGIN        "from"
-#define ADSBEX_V1_DESTINATION   "to"
-
-#define ADSBEX_V1_TYPE_GND      "-GND"
+#define ADSBEX_V2_TYPE_TISB     "tisb_other"    ///< type value for TIS-B data
 
+// Version 1 keys (only for enabling meaningful error message)
+#define ADSBEX_V1_TRANSP_ICAO   "icao"          // Key data
 
 // Testing an API key
-#define ADSBEX_VERIFY_KEY_URL   "https://adsbexchange.com/api/aircraft/icao/000000"
-#define ADSBEX_ERR              "msg"
-#define ADSBEX_SUCCESS          "No error"
-#define ADSBEX_NO_API_KEY       "You need an authorized API key."
-
-#define ADSBEX_VERIFY_RAPIDAPI  "https://adsbx-flight-sim-traffic.p.rapidapi.com/api/aircraft/json/lat/0.0/lon/0.0/dist/25/"
-#define ADSBEX_RAPID_ERR        "message"
-#define ADSBEX_NO_RAPIDAPI_KEY  "Key doesn't exists"
+#define ADSBEX_VERIFY_RAPIDAPI  "https://adsbexchange-com1.p.rapidapi.com/v2/lat/0.0/lon/0.0/dist/1/"
 
 #define ERR_ADSBEX_KEY_TECH     "ADSBEx: Technical problem while testing key: %d - %s"
 #define MSG_ADSBEX_KEY_SUCCESS  "ADS-B Exchange: API Key tested SUCCESSFULLY"
-#define ERR_ADSBEX_KEY_FAILED   "ADS-B Exchange: API Key INVALID"
-#define ERR_ADSBEX_KEY_UNKNOWN  "ADS-B Exchange: API Key test responded with unknown answer"
-#define ERR_ADSBEX_NO_KEY_DEF   "ADS-B Exchange: API Key missing. Get one at adsbexchange.com and enter it in Basic Settings."
+#define ERR_ADSBEX_KEY_FAILED   "ADS-B Exchange: API Key test FAILED: %s"
+#define ERR_ADSBEX_KEY_UNKNOWN  "ADS-B Exchange: API Key test responded with unknown answer: %s"
+#define ERR_ADSBEX_NO_KEY_DEF   "ADS-B Exchange: API Key missing. Get one at rapidapi.com/adsbx/api/adsbexchange-com1 and enter it in Basic Settings."
 #define ERR_ADSBEX_OTHER        "ADS-B Exchange: Received an ERRor response: %s"
 
 constexpr double ADSBEX_SMOOTH_AIRBORNE = 65.0; // smooth 65s of airborne data
@@ -131,29 +112,23 @@ class ADSBBase : public LTFlightDataChannel
         LTFlightDataChannel(ch, chName), sSlugBase(slugBase) {}
     /// Process ADSBEx foramtted data
     bool ProcessFetchedData () override;
-    /// Give derived class chance for channel-specific error-checking
-    virtual bool ProcessErrors (const JSON_Object* pObj) = 0;
     /// Process v2 data
-    void ProcessV2 (JSON_Object* pJAc, LTFlightData::FDKeyTy& fdKey,
+    void ProcessV2 (const JSON_Object* pJAc, LTFlightData::FDKeyTy& fdKey,
                     const double tBufPeriod, const double adsbxTime,
                     const positionTy& viewPos);
-    /// Process v1 data
-    void ProcessV1 (JSON_Object* pJAc, LTFlightData::FDKeyTy& fdKey,
-                    const double tsSimTime,
-                    const positionTy& viewPos);
+    /// Give derived class chance for channel-specific error-checking
+    virtual bool ProcessErrors (const JSON_Object* pObj) = 0;
+    /// Return the 'msg' content, if any
+    static std::string FetchMsg (const char* buf);
 };
 
 //
 // MARK: ADS-B Exchange
 //
 class ADSBExchangeConnection : public ADSBBase
 {
-public:
-    enum keyTypeE { ADSBEX_KEY_NONE=0, ADSBEX_KEY_EXCHANGE, ADSBEX_KEY_RAPIDAPI };
-    
 protected:
     std::string apiKey;
-    keyTypeE keyTy = ADSBEX_KEY_NONE;
     struct curl_slist* slistKey = NULL;
 public:
     ADSBExchangeConnection ();
@@ -174,12 +149,11 @@ class ADSBExchangeConnection : public ADSBBase
     bool ProcessErrors (const JSON_Object* pObj) override;
 
     // make list of HTTP header fields
-    static struct curl_slist* MakeCurlSList (keyTypeE keyTy, const std::string theKey);
+    static struct curl_slist* MakeCurlSList (const std::string theKey);
     // read header and parse for request limit/remaining
     static size_t ReceiveHeader(char *buffer, size_t size, size_t nitems, void *userdata);
 
 public:
-    static keyTypeE GetKeyType (const std::string theKey);
     // Just quickly sends one simple request to ADSBEx and checks if the response is not "NO KEY"
     // Does a SHOW_MSG about the result and saves the key to dataRefs on success.
     static void TestADSBExAPIKey (const std::string newKey);

LiveTraffic.xcodeproj/project.pbxproj

@@ -598,7 +598,7 @@
 				KnownAssetTags = (
 					New,
 				);
-				LastUpgradeCheck = 1610;
+				LastUpgradeCheck = 1620;
 			};
 			buildConfigurationList = D607B16209A5563100699BC3 /* Build configuration list for PBXProject "LiveTraffic" */;
 			compatibilityVersion = "Xcode 12.0";
@@ -807,8 +807,8 @@
 				LIBRARY_SEARCH_PATHS = Lib/fmod;
 				LIVETRAFFIC_VERSION_BETA = 0;
 				LIVETRAFFIC_VER_MAJOR = 4;
-				LIVETRAFFIC_VER_MINOR = 1;
-				LIVETRAFFIC_VER_PATCH = 1;
+				LIVETRAFFIC_VER_MINOR = 2;
+				LIVETRAFFIC_VER_PATCH = 0;
 				LLVM_LTO = NO;
 				MACH_O_TYPE = mh_dylib;
 				MACOSX_DEPLOYMENT_TARGET = 10.15;
@@ -916,8 +916,8 @@
 				LIBRARY_SEARCH_PATHS = Lib/fmod;
 				LIVETRAFFIC_VERSION_BETA = 0;
 				LIVETRAFFIC_VER_MAJOR = 4;
-				LIVETRAFFIC_VER_MINOR = 1;
-				LIVETRAFFIC_VER_PATCH = 1;
+				LIVETRAFFIC_VER_MINOR = 2;
+				LIVETRAFFIC_VER_PATCH = 0;
 				LLVM_LTO = YES;
 				MACH_O_TYPE = mh_dylib;
 				MACOSX_DEPLOYMENT_TARGET = 10.15;

LiveTraffic.xcodeproj/xcuserdata/birger.xcuserdatad/xcschemes/LiveTraffic.xcscheme

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1610"
+   LastUpgradeVersion = "1620"
    version = "1.8">
    <BuildAction
       parallelizeBuildables = "YES"

Src/DataRefs.cpp

@@ -2033,7 +2033,7 @@ bool DataRefs::LoadConfigFile()
 
     // which conversion to do with the (older) version of the config file?
     unsigned long cfgFileVer = 0;
-    enum cfgFileConvE { CFG_NO_CONV=0, CFG_V3, CFG_V31, CFG_V331, CFG_V342, CFG_V350 } conv = CFG_NO_CONV;
+    enum cfgFileConvE { CFG_NO_CONV=0, CFG_V3, CFG_V31, CFG_V331, CFG_V342, CFG_V350, CFG_V420 } conv = CFG_NO_CONV;
 
     // open a config file
     std::string sFileName (LTCalcFullPath(PATH_CONFIG_FILE));
@@ -2103,6 +2103,8 @@ bool DataRefs::LoadConfigFile()
                 rtConnType = RT_CONN_APP;   //         Switch RealTraffic default to App as it was before
                 conv = CFG_V350;
             }
+            if (cfgFileVer < 40200)         // < 4.2.0: Clear ADSBEx API key (switch to other service)
+                conv = CFG_V420;
         }
     }
 
@@ -2174,6 +2176,11 @@ bool DataRefs::LoadConfigFile()
                         // RealTraffic Sim Time Control: previous value 1 is re-purposed, switch instead to 2
                         if (*i == DATA_REFS_LT[DR_CFG_RT_SIM_TIME_CTRL] && sVal == "1")
                             sVal = "2";
+                        [[fallthrough]];
+                    case CFG_V420:
+                        // Switching to v4.2 we need to disable ADSBEx until a new API key is configured
+                        if (*i == DATA_REFS_LT[DR_CHANNEL_ADSB_EXCHANGE_ONLINE])
+                            sVal = "0";
                         break;
                 }
 
@@ -2200,9 +2207,11 @@ bool DataRefs::LoadConfigFile()
                 SetOpenSkyUser(sVal);
             else if (sDataRef == CFG_OPENSKY_PWD)
                 SetOpenSkyPwd(Cleartext(sVal));
-            else if (sDataRef == CFG_ADSBEX_API_KEY)
-                // With v3 we start obfuscating the API key
-                SetADSBExAPIKey(conv == CFG_V3 ? sVal : Cleartext(sVal));
+            else if (sDataRef == CFG_ADSBEX_API_KEY) {
+                // With v4.2 ADSBEx switches to a new service, so we need a new API key
+                if (conv != CFG_V420)
+                    SetADSBExAPIKey(Cleartext(sVal));
+            }
             else if (sDataRef == CFG_RT_LICENSE)
                 SetRTLicense(Cleartext(sVal));
             else if (sDataRef == CFG_FSC_USER)