mirror of
https://github.com/swift-project/pilotclient.git
synced 2026-04-07 11:05:33 +08:00
Use nested namespaces (C++17 feature)
This commit is contained in:
Mat Sutcliffe
@@ -27,147 +27,144 @@ class QHttpPart;
|
||||
class QNetworkReply;
|
||||
class QUrlQuery;
|
||||
|
||||
namespace BlackMisc
|
||||
namespace BlackMisc::Network
|
||||
{
|
||||
namespace Network
|
||||
class CServer;
|
||||
|
||||
//! Utilities, e.g. checking whether a network connection can be established
|
||||
class BLACKMISC_EXPORT CNetworkUtils
|
||||
{
|
||||
class CServer;
|
||||
|
||||
//! Utilities, e.g. checking whether a network connection can be established
|
||||
class BLACKMISC_EXPORT CNetworkUtils
|
||||
public:
|
||||
//! Request type
|
||||
enum RequestType
|
||||
{
|
||||
public:
|
||||
//! Request type
|
||||
enum RequestType
|
||||
{
|
||||
Get,
|
||||
PostUrlEncoded,
|
||||
Multipart
|
||||
};
|
||||
|
||||
//! Default for timeout
|
||||
static int getTimeoutMs();
|
||||
|
||||
//! Default for timeout (long)
|
||||
static int getLongTimeoutMs();
|
||||
|
||||
//! Can connect?
|
||||
//! \param hostAddress 130.4.20.3, or myserver.com
|
||||
//! \param port 80, 1234
|
||||
//! \param timeoutMs
|
||||
//! \param message human readable message
|
||||
static bool canConnect(const QString &hostAddress, int port, QString &message, int timeoutMs = getTimeoutMs());
|
||||
|
||||
//! Can connect to server?
|
||||
//! \param server
|
||||
//! \param message human readable message
|
||||
//! \param timeoutMs
|
||||
static bool canConnect(const BlackMisc::Network::CServer &server, QString &message, int timeoutMs = getTimeoutMs());
|
||||
|
||||
//! Can connect to URL?
|
||||
static bool canConnect(const QString &url, QString &message, int timeoutMs = getTimeoutMs());
|
||||
|
||||
//! Can connect to URL?
|
||||
static bool canConnect(const QUrl &url, QString &message, int timeoutMs = getTimeoutMs());
|
||||
|
||||
//! Can connect to URL?
|
||||
static bool canConnect(const QUrl &url, int timeoutMs = getTimeoutMs());
|
||||
|
||||
//! Find out my IPv4 addresses including loopback, empty if not possible
|
||||
static QStringList getKnownLocalIpV4Addresses();
|
||||
|
||||
//! Valid IPv4 address
|
||||
static bool isValidIPv4Address(const QString &candidate);
|
||||
|
||||
//! Valid IPv6 address
|
||||
static bool isValidIPv6Address(const QString &candidate);
|
||||
|
||||
//! Valid port
|
||||
static bool isValidPort(const QString &port);
|
||||
|
||||
//! Build / concatenate an URL
|
||||
static QString buildUrl(const QString &protocol, const QString &server, const QString &baseUrl, const QString &serviceUrl);
|
||||
|
||||
//! Ignore SSL verification such as self signed certificates
|
||||
static void ignoreSslVerification(QNetworkRequest &request);
|
||||
|
||||
//! Set user agent for request
|
||||
static void setSwiftUserAgent(QNetworkRequest &request, const QString &userAgentDetails = {});
|
||||
|
||||
//! Add debug flag
|
||||
static void addDebugFlag(QUrlQuery &qurl);
|
||||
|
||||
//! Our tweaked network request with swift header
|
||||
static QNetworkRequest getSwiftNetworkRequest(const QUrl &url, RequestType type = Get, const QString &userAgentDetails = {});
|
||||
|
||||
//! Get a copied network request with swift header
|
||||
static QNetworkRequest getSwiftNetworkRequest(const QNetworkRequest &request, const QString &userAgentDetails = {});
|
||||
|
||||
//! Last modified from reply
|
||||
static qint64 lastModifiedMsSinceEpoch(const QNetworkReply *nwReply);
|
||||
|
||||
//! Last modified from reply
|
||||
static QDateTime lastModifiedDateTime(const QNetworkReply *nwReply);
|
||||
|
||||
//! Last modified from reply compared with now (in ms)
|
||||
static qint64 lastModifiedSinceNow(const QNetworkReply *nwReply);
|
||||
|
||||
//! Request duration (only works if requested by swift functions)
|
||||
static qint64 requestDuration(const QNetworkReply *nwReply);
|
||||
|
||||
//! Get the http status code
|
||||
static int getHttpStatusCode(QNetworkReply *nwReply);
|
||||
|
||||
//! Is the reply an HTTP redirect?
|
||||
//! \details Status codes:
|
||||
//! - 301: Permanent redirect. Clients making subsequent requests for this resource should use the new URI. Clients should not follow the redirect automatically for POST/PUT/DELETE requests.
|
||||
//! - 302: Redirect for undefined reason. Clients making subsequent requests for this resource should not use the new URI. Clients should not follow the redirect automatically for POST/PUT/DELETE requests.
|
||||
//! - 303: Redirect for undefined reason. Typically, 'Operation has completed, continue elsewhere.' Clients making subsequent requests for this resource should not use the new URI. Clients should follow the redirect for POST/PUT/DELETE requests.
|
||||
//! - 307: Temporary redirect. Resource may return to this location at a later point. Clients making subsequent requests for this resource should use the old URI. Clients should not follow the redirect automatically for POST/PUT/DELETE requests.
|
||||
static bool isHttpStatusRedirect(QNetworkReply *nwReply);
|
||||
|
||||
//! Get the redirect URL if any
|
||||
static QUrl getHttpRedirectUrl(QNetworkReply *nwReply);
|
||||
|
||||
//! Remove the HTML formatting from a PHP error message
|
||||
static QString removeHtmlPartsFromPhpErrorMessage(const QString &errorMessage);
|
||||
|
||||
//! Looks like PHP error messages
|
||||
static bool looksLikePhpErrorMessage(const QString &errorMessage);
|
||||
|
||||
//! Status about network
|
||||
static BlackMisc::CStatusMessageList createNetworkReport(const QNetworkAccessManager *am);
|
||||
|
||||
//! Status about network, can be used when an URL fails to resolve issues
|
||||
//! \remark that can take a moment to complete, as it checks network
|
||||
static BlackMisc::CStatusMessageList createNetworkReport(const QUrl &url, const QNetworkAccessManager *qam = nullptr);
|
||||
|
||||
//! Info about network configurations
|
||||
static QString createNetworkConfigurationReport(const QNetworkConfigurationManager *qcm, const QNetworkAccessManager *qam, const QString &separator = "\n");
|
||||
|
||||
//! Report for QAM
|
||||
static QString createNetworkAccessManagerReport(const QNetworkAccessManager *qam);
|
||||
|
||||
//! Configuration as string
|
||||
static QString networkConfigurationToString(const QNetworkConfiguration &configuration);
|
||||
|
||||
//! Type to string
|
||||
static const QString &networkTypeToString(QNetworkConfiguration::Type type);
|
||||
|
||||
//! State to string
|
||||
static const QString &networkStateToString(QNetworkConfiguration::StateFlag state);
|
||||
|
||||
//! States to string
|
||||
static QString networkStatesToString(QNetworkConfiguration::StateFlags states);
|
||||
|
||||
//! Operation to string
|
||||
static const QString &networkOperationToString(QNetworkAccessManager::Operation operation);
|
||||
|
||||
private:
|
||||
//! Hidden constructor
|
||||
CNetworkUtils() {}
|
||||
Get,
|
||||
PostUrlEncoded,
|
||||
Multipart
|
||||
};
|
||||
} // namespace
|
||||
|
||||
//! Default for timeout
|
||||
static int getTimeoutMs();
|
||||
|
||||
//! Default for timeout (long)
|
||||
static int getLongTimeoutMs();
|
||||
|
||||
//! Can connect?
|
||||
//! \param hostAddress 130.4.20.3, or myserver.com
|
||||
//! \param port 80, 1234
|
||||
//! \param timeoutMs
|
||||
//! \param message human readable message
|
||||
static bool canConnect(const QString &hostAddress, int port, QString &message, int timeoutMs = getTimeoutMs());
|
||||
|
||||
//! Can connect to server?
|
||||
//! \param server
|
||||
//! \param message human readable message
|
||||
//! \param timeoutMs
|
||||
static bool canConnect(const BlackMisc::Network::CServer &server, QString &message, int timeoutMs = getTimeoutMs());
|
||||
|
||||
//! Can connect to URL?
|
||||
static bool canConnect(const QString &url, QString &message, int timeoutMs = getTimeoutMs());
|
||||
|
||||
//! Can connect to URL?
|
||||
static bool canConnect(const QUrl &url, QString &message, int timeoutMs = getTimeoutMs());
|
||||
|
||||
//! Can connect to URL?
|
||||
static bool canConnect(const QUrl &url, int timeoutMs = getTimeoutMs());
|
||||
|
||||
//! Find out my IPv4 addresses including loopback, empty if not possible
|
||||
static QStringList getKnownLocalIpV4Addresses();
|
||||
|
||||
//! Valid IPv4 address
|
||||
static bool isValidIPv4Address(const QString &candidate);
|
||||
|
||||
//! Valid IPv6 address
|
||||
static bool isValidIPv6Address(const QString &candidate);
|
||||
|
||||
//! Valid port
|
||||
static bool isValidPort(const QString &port);
|
||||
|
||||
//! Build / concatenate an URL
|
||||
static QString buildUrl(const QString &protocol, const QString &server, const QString &baseUrl, const QString &serviceUrl);
|
||||
|
||||
//! Ignore SSL verification such as self signed certificates
|
||||
static void ignoreSslVerification(QNetworkRequest &request);
|
||||
|
||||
//! Set user agent for request
|
||||
static void setSwiftUserAgent(QNetworkRequest &request, const QString &userAgentDetails = {});
|
||||
|
||||
//! Add debug flag
|
||||
static void addDebugFlag(QUrlQuery &qurl);
|
||||
|
||||
//! Our tweaked network request with swift header
|
||||
static QNetworkRequest getSwiftNetworkRequest(const QUrl &url, RequestType type = Get, const QString &userAgentDetails = {});
|
||||
|
||||
//! Get a copied network request with swift header
|
||||
static QNetworkRequest getSwiftNetworkRequest(const QNetworkRequest &request, const QString &userAgentDetails = {});
|
||||
|
||||
//! Last modified from reply
|
||||
static qint64 lastModifiedMsSinceEpoch(const QNetworkReply *nwReply);
|
||||
|
||||
//! Last modified from reply
|
||||
static QDateTime lastModifiedDateTime(const QNetworkReply *nwReply);
|
||||
|
||||
//! Last modified from reply compared with now (in ms)
|
||||
static qint64 lastModifiedSinceNow(const QNetworkReply *nwReply);
|
||||
|
||||
//! Request duration (only works if requested by swift functions)
|
||||
static qint64 requestDuration(const QNetworkReply *nwReply);
|
||||
|
||||
//! Get the http status code
|
||||
static int getHttpStatusCode(QNetworkReply *nwReply);
|
||||
|
||||
//! Is the reply an HTTP redirect?
|
||||
//! \details Status codes:
|
||||
//! - 301: Permanent redirect. Clients making subsequent requests for this resource should use the new URI. Clients should not follow the redirect automatically for POST/PUT/DELETE requests.
|
||||
//! - 302: Redirect for undefined reason. Clients making subsequent requests for this resource should not use the new URI. Clients should not follow the redirect automatically for POST/PUT/DELETE requests.
|
||||
//! - 303: Redirect for undefined reason. Typically, 'Operation has completed, continue elsewhere.' Clients making subsequent requests for this resource should not use the new URI. Clients should follow the redirect for POST/PUT/DELETE requests.
|
||||
//! - 307: Temporary redirect. Resource may return to this location at a later point. Clients making subsequent requests for this resource should use the old URI. Clients should not follow the redirect automatically for POST/PUT/DELETE requests.
|
||||
static bool isHttpStatusRedirect(QNetworkReply *nwReply);
|
||||
|
||||
//! Get the redirect URL if any
|
||||
static QUrl getHttpRedirectUrl(QNetworkReply *nwReply);
|
||||
|
||||
//! Remove the HTML formatting from a PHP error message
|
||||
static QString removeHtmlPartsFromPhpErrorMessage(const QString &errorMessage);
|
||||
|
||||
//! Looks like PHP error messages
|
||||
static bool looksLikePhpErrorMessage(const QString &errorMessage);
|
||||
|
||||
//! Status about network
|
||||
static BlackMisc::CStatusMessageList createNetworkReport(const QNetworkAccessManager *am);
|
||||
|
||||
//! Status about network, can be used when an URL fails to resolve issues
|
||||
//! \remark that can take a moment to complete, as it checks network
|
||||
static BlackMisc::CStatusMessageList createNetworkReport(const QUrl &url, const QNetworkAccessManager *qam = nullptr);
|
||||
|
||||
//! Info about network configurations
|
||||
static QString createNetworkConfigurationReport(const QNetworkConfigurationManager *qcm, const QNetworkAccessManager *qam, const QString &separator = "\n");
|
||||
|
||||
//! Report for QAM
|
||||
static QString createNetworkAccessManagerReport(const QNetworkAccessManager *qam);
|
||||
|
||||
//! Configuration as string
|
||||
static QString networkConfigurationToString(const QNetworkConfiguration &configuration);
|
||||
|
||||
//! Type to string
|
||||
static const QString &networkTypeToString(QNetworkConfiguration::Type type);
|
||||
|
||||
//! State to string
|
||||
static const QString &networkStateToString(QNetworkConfiguration::StateFlag state);
|
||||
|
||||
//! States to string
|
||||
static QString networkStatesToString(QNetworkConfiguration::StateFlags states);
|
||||
|
||||
//! Operation to string
|
||||
static const QString &networkOperationToString(QNetworkAccessManager::Operation operation);
|
||||
|
||||
private:
|
||||
//! Hidden constructor
|
||||
CNetworkUtils() {}
|
||||
};
|
||||
} // namespace
|
||||
|
||||
#endif // guard
|
||||
|
||||
Reference in New Issue
Block a user