QGCNetworkHelper.h

Go to the documentation of this file.

#pragma once
 
#include <QtCore/QJsonDocument>
#include <QtCore/QList>
#include <QtCore/QPair>
#include <QtCore/QString>
#include <QtCore/QUrl>
#include <QtCore/QVariant>
#include <QtHttpServer/QHttpServerRequest>
#include <QtHttpServer/QHttpServerResponder>
#include <QtNetwork/QHttpPart>
#include <QtNetwork/QNetworkReply>
#include <QtNetwork/QNetworkRequest>
#include <QtNetwork/QSslCertificate>
#include <QtNetwork/QSslConfiguration>
#include <QtNetwork/QSslKey>
 
#include "QGCNetworkClient.h"
 
class QIODevice;
class QNetworkAccessManager;
class QNetworkInformation;
 
namespace QGCNetworkHelper {
 
// ============================================================================
// Constants
// ============================================================================
 
constexpr int kDefaultTimeoutMs = 30000;
 
constexpr int kDefaultConnectTimeoutMs = 10000;
 
constexpr int kMaxRedirects = 10;
 
// ============================================================================
// Content-Type Constants
// ============================================================================
 
inline const QString kContentTypeJson = QStringLiteral("application/json");
inline const QString kContentTypeFormUrlencoded = QStringLiteral("application/x-www-form-urlencoded");
inline const QString kContentTypeOctetStream = QStringLiteral("application/octet-stream");
inline const QString kContentTypeMultipartForm = QStringLiteral("multipart/form-data");
inline const QString kContentTypeXml = QStringLiteral("application/xml");
inline const QString kContentTypeTextPlain = QStringLiteral("text/plain");
 
// ============================================================================
// HTTP Status Code Helpers
// ============================================================================
 
using HttpStatusCode = QHttpServerResponder::StatusCode;
 
enum class HttpStatusClass
{
    Informational,  
    Success,        
    Redirection,    
    ClientError,    
    ServerError,    
    Unknown         
};
 
HttpStatusClass classifyHttpStatus(int statusCode);
 
inline bool isHttpSuccess(int statusCode)
{
    return statusCode >= 200 && statusCode < 300;
}
 
inline bool isHttpRedirect(int statusCode)
{
    return statusCode >= 300 && statusCode < 400;
}
 
inline bool isHttpClientError(int statusCode)
{
    return statusCode >= 400 && statusCode < 500;
}
 
inline bool isHttpServerError(int statusCode)
{
    return statusCode >= 500 && statusCode < 600;
}
 
QString httpStatusText(int statusCode);
QString httpStatusText(HttpStatusCode statusCode);
 
// ============================================================================
// HTTP Methods
// ============================================================================
 
using HttpMethod = QHttpServerRequest::Method;
 
QString httpMethodName(HttpMethod method);
 
HttpMethod parseHttpMethod(const QString& methodStr);
 
// ============================================================================
// URL Utilities
// ============================================================================
 
bool isValidUrl(const QUrl& url);
 
bool isHttpUrl(const QUrl& url);
 
bool isHttpsUrl(const QUrl& url);
 
QUrl normalizeUrl(const QUrl& url);
 
QUrl ensureScheme(const QUrl& url, const QString& defaultScheme = QStringLiteral("https"));
 
QUrl buildUrl(const QString& baseUrl, const QMap<QString, QString>& params);
 
QUrl buildUrl(const QString& baseUrl, const QList<QPair<QString, QString>>& params);
 
QUrl urlWithoutQuery(const QUrl& url);
 
QString redactedUrlForLogging(const QUrl& url);
QString redactedUrlForLogging(const QString& url);
 
// ============================================================================
// Request Configuration
// ============================================================================
 
struct RequestConfig
{
    int timeoutMs = kDefaultTimeoutMs;
    bool allowRedirects = true;
    bool http2Allowed = true;
    bool cacheEnabled = true;
    bool backgroundRequest = false;
    QString userAgent;
    QString accept = QStringLiteral("*/*");
    QString acceptEncoding;
    QString contentType;
    QList<QPair<QNetworkRequest::Attribute, QVariant>> requestAttributes;
 
    int connectionCacheExpirySecs = -1;
    int tcpKeepAliveIdleSecs = -1;
    int tcpKeepAliveIntervalSecs = -1;
    int tcpKeepAliveProbeCount = -1;
};
 
void configureRequest(QNetworkRequest& request, const RequestConfig& config = {});
 
QNetworkRequest createRequest(const QUrl& url, const RequestConfig& config = {});
 
void setStandardHeaders(QNetworkRequest& request, const QString& userAgent = {});
 
void setJsonHeaders(QNetworkRequest& request);
 
void setFormHeaders(QNetworkRequest& request);
 
// ============================================================================
// Authentication Helpers
// ============================================================================
 
void setBasicAuth(QNetworkRequest& request, const QString& credentials);
 
void setBasicAuth(QNetworkRequest& request, const QString& username, const QString& password);
 
void setBearerToken(QNetworkRequest& request, const QString& token);
 
QString createBasicAuthCredentials(const QString& username, const QString& password);
 
// ============================================================================
// Multipart Form Data Helpers
// ============================================================================
 
QHttpPart createFormField(const QString& name, const QString& value);
 
QHttpPart createFilePart(const QString& name, const QString& fileName, const QString& contentType, QIODevice* device);
 
QHttpPart createFilePart(const QString& name, const QString& fileName, QIODevice* device);
 
// ============================================================================
// SSL/TLS Configuration Builders
// ============================================================================
 
QSslConfiguration createInsecureSslConfig();
 
void applySslConfig(QNetworkRequest& request, const QSslConfiguration& config);
 
QList<QSslCertificate> loadCaCertificates(const QString& filePath, QString* errorOut = nullptr);
 
bool loadClientCertAndKey(const QString& certPath, const QString& keyPath, QSslCertificate& certOut, QSslKey& keyOut,
                          QString* errorOut = nullptr);
 
// ============================================================================
// JSON Response Helpers
// ============================================================================
 
QJsonDocument parseJson(const QByteArray& data, QJsonParseError* error = nullptr);
 
QJsonDocument parseJsonReply(QNetworkReply* reply, QJsonParseError* error = nullptr);
 
bool looksLikeJson(const QByteArray& data);
 
// ============================================================================
// Network Reply Helpers
// ============================================================================
 
int httpStatusCode(const QNetworkReply* reply);
 
QUrl redirectUrl(const QNetworkReply* reply);
 
QString errorMessage(const QNetworkReply* reply);
 
bool isSuccess(const QNetworkReply* reply);
 
bool isRedirect(const QNetworkReply* reply);
 
QString contentType(const QNetworkReply* reply);
 
qint64 contentLength(const QNetworkReply* reply);
 
bool isJsonResponse(const QNetworkReply* reply);
 
// ============================================================================
// Network Availability
// ============================================================================
 
QNetworkInformation* networkInformation();
 
bool isNetworkAvailable();
 
bool isInternetAvailable();
 
bool isNetworkEthernet();
 
bool isBluetoothAvailable();
 
enum class ConnectionType
{
    None,       
    Unknown,    
    Ethernet,   
    WiFi,       
    Cellular,   
    Bluetooth,  
};
 
ConnectionType connectionType();
 
QString connectionTypeName(ConnectionType type);
 
// ============================================================================
// SSL/TLS Helpers
// ============================================================================
 
void ignoreSslErrors(QNetworkReply* reply);
 
void ignoreSslErrorsIfNeeded(QNetworkReply* reply);
 
bool isSslAvailable();
 
QString sslVersion();
 
// ============================================================================
// Network Access Manager Helpers
// ============================================================================
 
void initializeProxySupport();
 
QNetworkAccessManager* createNetworkManager(QObject* parent);
 
void configureProxy(QNetworkAccessManager* manager);
 
}  // namespace QGCNetworkHelper