entryinternal.h

/*
    knewstuff3/entry.h.
    SPDX-FileCopyrightText: 2002 Cornelius Schumacher <[email protected]>
    SPDX-FileCopyrightText: 2003-2007 Josef Spillner <[email protected]>
    SPDX-FileCopyrightText: 2009 Jeremy Whiting <[email protected]>
    SPDX-FileCopyrightText: 2009 Frederik Gladhorn <[email protected]>

    SPDX-License-Identifier: LGPL-2.1-or-later
*/

#ifndef KNEWSTUFF3_ENTRYINTERNAL_P_H
#define KNEWSTUFF3_ENTRYINTERNAL_P_H

#include <QDate>
#include <QDomElement>
#include <QString>
#include <QUrl>
#include <QImage>

#include "author.h"
// This include only exists for the KNS3::Entry::Status enum
// TODO Move the KNS3::Entry::Status enum to Core for KF6
#include "entry.h"

#include "knewstuffcore_export.h"

class QXmlStreamReader;

namespace KNSCore
{
static const int PreviewWidth = 96;
static const int PreviewHeight = 72;

KNEWSTUFFCORE_EXPORT QString replaceBBCode(const QString &unformattedText);

class KNEWSTUFFCORE_EXPORT EntryInternal
{
public:
    typedef QList<EntryInternal> List;

    enum Source {
        Cache,
        Online,
        Registry,
    };

    enum PreviewType {
        PreviewSmall1,
        PreviewSmall2,
        PreviewSmall3,
        PreviewBig1,
        PreviewBig2,
        PreviewBig3,
    };

    struct DownloadLinkInformation {
        QString name;
        QString priceAmount;
        QString distributionType;
        QString descriptionLink;
        int id;
        bool isDownloadtypeLink;
        quint64 size = 0;
        QStringList tags;
    };

    enum EntryEvent {
        UnknownEvent = 0,
        StatusChangedEvent = 1,
        AdoptedEvent = 2,
        DetailsLoadedEvent = 3,
    };

    EntryInternal();

    EntryInternal(const EntryInternal &other);
    EntryInternal &operator=(const EntryInternal &other);

    bool operator==(const EntryInternal &other) const;
    bool operator<(const EntryInternal &other) const;

    ~EntryInternal();

    bool isValid() const;

    void setName(const QString &name);

    QString name() const;

    void setUniqueId(const QString &id);
    QString uniqueId() const;

    void setCategory(const QString &category);

    QString category() const;

    void setHomepage(const QUrl &page);
    QUrl homepage() const;

    void setAuthor(const Author &author);

    Author author() const;

    void setLicense(const QString &license);

    QString license() const;

    void setSummary(const QString &summary);

    QString shortSummary() const;

    void setShortSummary(const QString &summary);

    QString summary() const;

    void setChangelog(const QString &changelog);
    QString changelog() const;

    void setVersion(const QString &version);

    QString version() const;

    void setReleaseDate(const QDate &releasedate);

    QDate releaseDate() const;

    void setUpdateVersion(const QString &version);

    QString updateVersion() const;

    void setUpdateReleaseDate(const QDate &releasedate);

    QDate updateReleaseDate() const;

    void setPayload(const QString &url);

    QString payload() const;

    void setPreviewUrl(const QString &url, PreviewType type = PreviewSmall1);

    QString previewUrl(PreviewType type = PreviewSmall1) const;

    QImage previewImage(PreviewType type = PreviewSmall1) const;
    void setPreviewImage(const QImage &image, PreviewType type = PreviewSmall1);

    void setInstalledFiles(const QStringList &files);

    QStringList installedFiles() const;

    void setUnInstalledFiles(const QStringList &files);

    QStringList uninstalledFiles() const;

    void setRating(int rating);

    int rating() const;

    void setNumberOfComments(int comments);

    int numberOfComments() const;

    void setDownloadCount(int downloads);

    int downloadCount() const;

    int numberFans() const;
    void setNumberFans(int fans);

    int numberKnowledgebaseEntries() const;
    void setNumberKnowledgebaseEntries(int num);
    QString knowledgebaseLink() const;
    void setKnowledgebaseLink(const QString &link);

    int downloadLinkCount() const;
    QList<DownloadLinkInformation> downloadLinkInformationList() const;
    void appendDownloadLinkInformation(const DownloadLinkInformation &info);
    void clearDownloadLinkInformation();

    QString donationLink() const;
    void setDonationLink(const QString &link);

    QStringList tags() const;
    void setTags(const QStringList &tags);

    QString providerId() const;
    void setProviderId(const QString &id);

    void setSource(Source source);
    Source source() const;

    bool setEntryXML(QXmlStreamReader &reader);

//#if KNEWSTUFFCORE_ENABLE_DEPRECATED_SINCE(5, 36) // TODO This is still internally used and has not been fully ported
    KNEWSTUFFCORE_DEPRECATED_VERSION(5, 36, "Use EntryInternal::setEntryXML(QXmlStreamReader &)")
    bool setEntryXML(const QDomElement &xmldata);
//#endif

    QDomElement entryXML() const;

    void setStatus(KNS3::Entry::Status status);

    KNS3::Entry::Status status() const;

    static KNSCore::EntryInternal fromEntry(const KNS3::Entry &entry);
private:
    class Private;
    QExplicitlySharedDataPointer<Private> d;
};

inline uint qHash(const KNSCore::EntryInternal &entry)
{
    return qHash(entry.uniqueId());
}

}
Q_DECLARE_METATYPE(KNSCore::EntryInternal::List)

#endif