url.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2015 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_NETWORK_URL_H
#define SWIFT_MISC_NETWORK_URL_H
 
#include <QJsonObject>
#include <QMetaType>
#include <QNetworkRequest>
#include <QString>
#include <QUrl>
 
#include "misc/metaclass.h"
#include "misc/propertyindexref.h"
#include "misc/swiftmiscexport.h"
#include "misc/valueobject.h"
 
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::misc::network, CUrl)
 
namespace swift::misc::network
{
    class SWIFT_MISC_EXPORT CUrl : public CValueObject<CUrl>
    {
    public:
        enum ColumnIndex
        {
            IndexScheme = CPropertyIndexRef::GlobalIndexCUrl,
            IndexHost,
            IndexPort,
            IndexPath,
            IndexQuery
        };
 
        CUrl(const QString &fullUrl = QString());
 
        CUrl(const char *url);
 
        CUrl(const QUrl &url);
 
        CUrl(const QString &address, int port);
 
        CUrl(const QString &scheme, const QString &address, int port, const QString &path);
 
        const QString &getHost() const { return m_host; }
 
        void setHost(const QString &address) { m_host = address.trimmed(); }
 
        const QString &getScheme() const { return m_scheme; }
 
        void setScheme(const QString &protocol);
 
        bool hasScheme() const { return !m_scheme.isEmpty(); }
 
        const QString &getPath() const { return m_path; }
 
        void setPath(const QString &path);
 
        QString appendPath(const QString &pathToAppend);
 
        bool hasPath() const { return !m_path.isEmpty(); }
 
        int getPort() const;
 
        void setPort(int port) { m_port = port; }
 
        bool hasPort() const;
 
        bool hasDefaultPort() const;
 
        QString getQuery() const { return m_query; }
 
        void setQuery(const QString &query);
 
        bool hasQuery() const;
 
        void appendQuery(const QString &queryToAppend);
 
        void appendQuery(const QString &key, const QString &value);
 
        bool hasFragment() const;
 
        void setFragment(const QString &fragment);
 
        bool isEmpty() const;
 
        QString getFullUrl(bool withQuery = true) const;
 
        void setFullUrl(const QString &fullUrl);
 
        QString getFileName() const;
 
        QUrl toQUrl() const;
 
        void setQUrl(const QUrl &url);
 
        QNetworkRequest toNetworkRequest() const;
 
        CUrl withAppendedPath(const QString &path) const;
 
        CUrl withAppendedQuery(const QString &query) const;
 
        CUrl withSwitchedScheme(const QString &protocol, int port) const;
 
        bool pathEndsWith(const QString &ending, Qt::CaseSensitivity cs = Qt::CaseInsensitive) const;
 
        bool isFile() const;
 
        bool isFileWithSuffix(const QString &suffix = {}) const;
 
        QString getFileSuffix() const;
 
        QString getFileSuffixPlusDot() const;
 
        bool isHavingHtmlSuffix() const;
 
        bool isExecutableFile() const;
 
        bool isSwiftInstaller() const;
 
        QVariant propertyByIndex(swift::misc::CPropertyIndexRef index) const;
 
        void setPropertyByIndex(swift::misc::CPropertyIndexRef index, const QVariant &variant);
 
        QString convertToQString(bool i18n = false) const;
 
        QJsonObject toJson() const;
 
        void convertFromJson(const QJsonObject &json);
 
        static int protocolToDefaultPort(const QString &protocol);
 
        static bool isDefaultPort(const QString &protocol, int port);
 
        static CUrl fromLocalFile(const QString &localFile);
 
        operator QUrl() const { return this->toQUrl(); }
 
    private:
        QString m_scheme;
        QString m_host;
        int m_port = -1;
        QString m_path;
        QString m_query;
        QString m_fragment;
 
        static QString stripQueryString(const QString &query);
 
        SWIFT_METACLASS(
            CUrl,
            SWIFT_METAMEMBER(scheme),
            SWIFT_METAMEMBER(host),
            SWIFT_METAMEMBER(port),
            SWIFT_METAMEMBER(path),
            SWIFT_METAMEMBER(query),
            SWIFT_METAMEMBER(fragment));
    };
} // namespace swift::misc::network
 
Q_DECLARE_METATYPE(swift::misc::network::CUrl)
 
#endif // SWIFT_MISC_NETWORK_URL_H