networkutils.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2013 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_NETWORKUTILS_H
#define SWIFT_MISC_NETWORKUTILS_H
 
#include <QNetworkAccessManager>
#include <QNetworkRequest>
#include <QString>
#include <QStringList>
#include <QtGlobal>
 
#include "misc/network/ping.h"
#include "misc/statusmessagelist.h"
#include "misc/swiftmiscexport.h"
 
class QHttpPart;
class QNetworkReply;
class QUrlQuery;
 
namespace swift::misc::network
{
    class CServer;
 
    class SWIFT_MISC_EXPORT CNetworkUtils
    {
    public:
        enum RequestType
        {
            Get,
            PostUrlEncoded,
            Multipart
        };
 
        static int getTimeoutMs();
 
        static int getLongTimeoutMs();
 
        static bool canConnect(const QString &hostAddress, int port, QString &message, int timeoutMs = getTimeoutMs());
 
        static bool canConnect(const swift::misc::network::CServer &server, QString &message,
                               int timeoutMs = getTimeoutMs());
 
        static bool canConnect(const QString &url, QString &message, int timeoutMs = getTimeoutMs());
 
        static bool canConnect(const QUrl &url, QString &message, int timeoutMs = getTimeoutMs());
 
        static bool canConnect(const QUrl &url, int timeoutMs = getTimeoutMs());
 
        static QStringList getKnownLocalIpV4Addresses();
 
        static bool isValidIPv4Address(const QString &candidate);
 
        static bool isValidIPv6Address(const QString &candidate);
 
        static bool isValidPort(const QString &port);
 
        static QString buildUrl(const QString &protocol, const QString &server, const QString &baseUrl,
                                const QString &serviceUrl);
 
        static void setSwiftUserAgent(QNetworkRequest &request, const QString &userAgentDetails = {});
 
        static void addDebugFlag(QUrlQuery &qurl);
 
        static QNetworkRequest getSwiftNetworkRequest(const QUrl &url, RequestType type = Get,
                                                      const QString &userAgentDetails = {});
 
        static QNetworkRequest getSwiftNetworkRequest(const QNetworkRequest &request,
                                                      const QString &userAgentDetails = {});
 
        static qint64 lastModifiedMsSinceEpoch(const QNetworkReply *nwReply);
 
        static QDateTime lastModifiedDateTime(const QNetworkReply *nwReply);
 
        static qint64 lastModifiedSinceNow(const QNetworkReply *nwReply);
 
        static qint64 requestDuration(const QNetworkReply *nwReply);
 
        static int getHttpStatusCode(QNetworkReply *nwReply);
 
        static bool isHttpStatusRedirect(QNetworkReply *nwReply);
 
        static QUrl getHttpRedirectUrl(QNetworkReply *nwReply);
 
        static QString removeHtmlPartsFromPhpErrorMessage(const QString &errorMessage);
 
        static bool looksLikePhpErrorMessage(const QString &errorMessage);
 
        static const QString &networkOperationToString(QNetworkAccessManager::Operation operation);
 
    private:
        CNetworkUtils() {}
    };
} // namespace swift::misc::network
 
#endif // SWIFT_MISC_NETWORKUTILS_H