artifact.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2017 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_DB_ARTIFACT_H
#define SWIFT_MISC_DB_ARTIFACT_H
 
#include <QString>
 
#include "misc/db/datastore.h"
#include "misc/db/distributionlist.h"
#include "misc/network/remotefile.h"
#include "misc/platform.h"
#include "misc/swiftmiscexport.h"
 
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::misc::db, CArtifact)
 
namespace swift::misc::db
{
    class SWIFT_MISC_EXPORT CArtifact : public CValueObject<CArtifact>, public IDatastoreObjectWithIntegerKey
    {
    public:
        enum ColumnIndex
        {
            IndexName = CPropertyIndexRef::GlobalIndexCArtifact,
            IndexMd5,
            IndexType,
            IndexPlatform,
            IndexVersionString,
            IndexQVersion,
            IndexSize,
            IndexSizeHumanReadable,
            IndexDistributions
        };
 
        enum ArtifactType
        {
            UnknownArtifact,
            PilotClientInstaller,
            Symbols,
            XSwiftBus
        };
 
        CArtifact();
 
        CArtifact(const QString &name, const QString &version, const QString &md5, ArtifactType type, int size,
                  bool existing, const CPlatform &platform);
 
        bool hasName() const { return !m_name.isEmpty(); }
 
        const QString &getName() const { return m_name; }
 
        void setName(const QString &name) { m_name = name.trimmed(); }
 
        bool matchesName(const QString &name, Qt::CaseSensitivity cs = Qt::CaseSensitive) const;
 
        ArtifactType getType() const { return static_cast<ArtifactType>(m_type); }
 
        bool isUnknown() const { return this->getType() == UnknownArtifact; }
 
        void setType(ArtifactType type) { m_type = static_cast<int>(type); }
 
        int getFileSize() const { return m_size; }
 
        QString getFileSizeHumanReadable() const;
 
        void setFileSize(int size) { m_size = size; }
 
        const QString &getMd5() const { return m_md5; }
 
        const CPlatform &getPlatform() const { return m_platform; }
 
        bool matchesAnyPlatform(const CPlatform &platform) const;
 
        void setPlatform(const CPlatform &platform) { m_platform = platform; }
 
        const CDistributionList &getDistributions() const { return m_distributions; }
 
        CDistribution getMostStableDistribution() const { return this->getDistributions().getMostStableOrDefault(); }
 
        void setDistributions(const CDistributionList &distributions) { m_distributions = distributions; }
 
        bool hasDistributions() const { return !m_distributions.isEmpty(); }
 
        bool hasUnrestrictedDistribution() const;
 
        bool isWithDistribution(const CDistribution &distribution, bool acceptMoreStableDistributions) const;
 
        network::CRemoteFile asRemoteFile() const;
 
        bool isNewerThanCurrentBuild() const;
 
        QString convertToQString(bool i18n = false) const;
 
        QString convertToQString(const QString &separator, bool i18n = false) const;
 
        QVariant propertyByIndex(swift::misc::CPropertyIndexRef index) const;
 
        void setPropertyByIndex(swift::misc::CPropertyIndexRef index, const QVariant &variant);
 
        static CArtifact fromDatabaseJson(const QJsonObject &json, const QString &prefix = {});
 
        static const QString &typeToString(ArtifactType type);
 
        static CPlatform artifactNameToPlatform(const QString &name);
 
    private:
        QString m_name; 
        QString m_md5; 
        int m_type = static_cast<int>(UnknownArtifact); 
        int m_size = -1; 
        bool m_existing = false; 
        CPlatform m_platform; 
        CDistributionList m_distributions; 
 
        static QString versionNumberFromFilename(const QString &filename);
 
        static ArtifactType stringToType(const QString &str);
 
        static QString trimVersionString(const QString &version);
 
        static QString trim4thSegment(const QString &seg);
 
        SWIFT_METACLASS(
            CArtifact,
            SWIFT_METAMEMBER(name),
            SWIFT_METAMEMBER(version),
            SWIFT_METAMEMBER(md5),
            SWIFT_METAMEMBER(type),
            SWIFT_METAMEMBER(size),
            SWIFT_METAMEMBER(existing),
            SWIFT_METAMEMBER(platform),
            SWIFT_METAMEMBER(distributions),
            SWIFT_METAMEMBER(timestampMSecsSinceEpoch));
    };
} // namespace swift::misc::db
 
Q_DECLARE_METATYPE(swift::misc::db::CArtifact)
Q_DECLARE_METATYPE(swift::misc::db::CArtifact::ArtifactType)
 
#endif // SWIFT_MISC_DB_ARTIFACT_H