Read VATSIM servers from servers.json

src/blackcore/vatsim/vatsimserverfilereader.cpp

@@ -0,0 +1,156 @@
+/* Copyright (C) 2023
+ * swift project Community / Contributors
+ *
+ * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
+ * directory of this distribution. No part of swift project, including this file, may be copied, modified, propagated,
+ * or distributed except according to the terms contained in the LICENSE file.
+ */
+
+#include "blackcore/vatsim/vatsimserverfilereader.h"
+#include "blackcore/application.h"
+#include "blackmisc/network/entityflags.h"
+#include "blackmisc/network/server.h"
+#include "blackmisc/network/user.h"
+#include "blackmisc/pq/units.h"
+#include "blackmisc/logmessage.h"
+
+#include <QStringBuilder>
+#include <QMetaObject>
+#include <QNetworkReply>
+#include <QScopedPointerDeleteLater>
+#include <QTimer>
+#include <QUrl>
+#include <QtGlobal>
+#include <QPointer>
+
+using namespace BlackMisc;
+using namespace BlackMisc::Aviation;
+using namespace BlackMisc::Audio;
+using namespace BlackMisc::Network;
+using namespace BlackMisc::Geo;
+using namespace BlackMisc::Simulation;
+using namespace BlackMisc::PhysicalQuantities;
+using namespace BlackCore::Data;
+
+namespace BlackCore::Vatsim
+{
+    CVatsimServerFileReader::CVatsimServerFileReader(QObject *owner) :
+            CThreadedReader(owner, "CVatsimServerFileReader"),
+            CEcosystemAware(CEcosystemAware::providerIfPossible(owner))
+    { }
+
+    CServerList CVatsimServerFileReader::getFsdServers() const
+    {
+        return m_lastGoodSetup.get().getFsdServers();
+    }
+
+    void CVatsimServerFileReader::readInBackgroundThread()
+    {
+        QPointer<CVatsimServerFileReader> myself(this);
+        QTimer::singleShot(0, this, [ = ]
+        {
+            if (!myself) { return; }
+            myself->read();
+        });
+    }
+
+    void CVatsimServerFileReader::doWorkImpl()
+    {
+        this->read();
+    }
+
+    void CVatsimServerFileReader::read()
+    {
+        this->threadAssertCheck();
+        if (!this->doWorkCheck()) { return; }
+        if (!this->isInternetAccessible("No network/internet access, cannot read VATSIM server file")) { return; }
+        if (this->isNotVATSIMEcosystem()) { return; }
+
+        Q_ASSERT_X(sApp, Q_FUNC_INFO, "Missing application");
+        const QUrl url = sApp->getVatsimServerFileUrl();
+        if (url.isEmpty()) { return; }
+        this->getFromNetworkAndLog(url, { this, &CVatsimServerFileReader::parseVatsimFile});
+    }
+
+    void CVatsimServerFileReader::parseVatsimFile(QNetworkReply *nwReplyPtr)
+    {
+        // wrap pointer, make sure any exit cleans up reply
+        // required to use delete later as object is created in a different thread
+        QScopedPointer<QNetworkReply, QScopedPointerDeleteLater> nwReply(nwReplyPtr);
+        this->threadAssertCheck();
+        if (this->isNotVATSIMEcosystem()) { return; }
+
+        // Worker thread, make sure to write only synced here!
+        if (!this->doWorkCheck())
+        {
+            CLogMessage(this).info(u"Terminated VATSIM file parsing process");
+            return; // stop, terminate straight away, ending thread
+        }
+
+        this->logNetworkReplyReceived(nwReplyPtr);
+
+        const QUrl url = nwReply->url();
+        const QString urlString = url.toString();
+
+        if (nwReply->error() == QNetworkReply::NoError)
+        {
+            const QString dataFileData = nwReply->readAll();
+            nwReply->close(); // close asap
+
+            if (dataFileData.isEmpty()) { return; }
+            if (!this->didContentChange(dataFileData)) // Quick check by hash
+            {
+                CLogMessage(this).info(u"VATSIM file '%1' has same content, skipped") << urlString;
+                return;
+            }
+            auto jsonDoc = QJsonDocument::fromJson(dataFileData.toUtf8());
+            if (jsonDoc.isEmpty()) { return; }
+
+            // build on local vars for thread safety
+            CServerList fsdServers;
+
+            for (QJsonValueRef server : jsonDoc.array())
+            {
+                if (!this->doWorkCheck())
+                {
+                    CLogMessage(this).info(u"Terminated VATSIM file parsing process");
+                    return;
+                }
+                fsdServers.push_back(parseServer(server.toObject()));
+                if (!fsdServers.back().hasName()) { fsdServers.pop_back(); }
+            }
+
+            // Setup for VATSIM servers and sorting for comparison
+            fsdServers.sortBy(&CServer::getName, &CServer::getDescription);
+
+            // update cache itself is thread safe
+            CVatsimSetup vs(m_lastGoodSetup.get());
+            const bool changedSetup = vs.setServers(fsdServers, {});
+            if (changedSetup)
+            {
+                vs.setCurrentUtcTime();
+                m_lastGoodSetup.set(vs);
+            }
+
+            // data read finished
+            emit this->dataFileRead(dataFileData.size() / 1000);
+            emit this->dataRead(CEntityFlags::VatsimDataFile, CEntityFlags::ReadFinished, dataFileData.size() / 1000, url);
+        }
+        else
+        {
+            // network error
+            CLogMessage(this).warning(u"Reading VATSIM data file failed '%1' '%2'") << nwReply->errorString() << urlString;
+            nwReply->abort();
+            emit this->dataRead(CEntityFlags::VatsimDataFile, CEntityFlags::ReadFailed, 0, url);
+        }
+    }
+
+    CServer CVatsimServerFileReader::parseServer(const QJsonObject &server) const
+    {
+        return CServer(server["name"].toString(), server["location"].toString(),
+                       server["hostname_or_ip"].toString(), 6809, CUser("id", "real name", "email", "password"),
+                       CFsdSetup::vatsimStandard(), CVoiceSetup::vatsimStandard(), CEcosystem::VATSIM,
+                       CServer::FSDServerVatsim, server["clients_connection_allowed"].toInt());
+    }
+
+} // ns