card_database_loader.h

Go to the documentation of this file.

#ifndef COCKATRICE_CARD_DATABASE_LOADER_H
#define COCKATRICE_CARD_DATABASE_LOADER_H
 
#include <QBasicMutex>
#include <QByteArray>
#include <QList>
#include <QLoggingCategory>
#include <QObject>
#include <QString>
#include <QStringList>
#include <qtmetamacros.h>
 
class ICardDatabasePathProvider;
class ICardSetPriorityController;
 
// IWYU pragma: keep
// CardDatabaseData is passed by value to the databaseDataReady() signal, so the
// moc-generated code needs the complete type.
#include "card_database_data.h"
 
inline Q_LOGGING_CATEGORY(CardDatabaseLoadingLog, "card_database.loading");
inline Q_LOGGING_CATEGORY(CardDatabaseLoadingSuccessOrFailureLog, "card_database.loading.success_or_failure");
 
class CardDatabase;
class ICardDatabaseParser;

enum LoadStatus
{
    Ok,            
    VersionTooOld, 
    Invalid,       
    NotLoaded,     
    FileError,     
    NoCards        
};

class CardDatabaseLoader : public QObject
{
    Q_OBJECT
public:
    explicit CardDatabaseLoader(QObject *parent,
                                CardDatabase *db,
                                ICardDatabasePathProvider *pathProvider,
                                ICardSetPriorityController *_priorityController);

    ~CardDatabaseLoader() override;
 
public slots:
    LoadStatus loadCardDatabases(bool ignoreCache = false);

    LoadStatus loadCardDatabase(const QString &path, CardDatabaseData &data);

    bool saveCustomTokensToFile();
 
signals:
    void loadingStarted();

    void loadingFinished();

    void loadingFailed();

    void databaseDataReady(CardDatabaseData data);

    void newSetsFound(int numSets, const QStringList &setNames);

    void allNewSetsEnabled();
 
private:
    LoadStatus loadFromFile(const QString &fileName, CardDatabaseData &data);

    LoadStatus doLoadCardDatabases(bool ignoreCache);

    [[nodiscard]] QStringList collectCustomDatabasePaths() const;

    [[nodiscard]] QByteArray computeSourceHash(const QStringList &customPaths) const;

    [[nodiscard]] QString cachePath() const;

    bool loadFromCache(CardDatabaseData &data, const QByteArray &sourceHash);

    bool saveToCache(const CardDatabaseData &data, const QByteArray &sourceHash);
 
private:
    CardDatabase *database;                         
    ICardDatabasePathProvider *pathProvider;        
    ICardSetPriorityController *priorityController; 
    QList<ICardDatabaseParser *> availableParsers;  
 
    QBasicMutex *loadFromFileMutex = new QBasicMutex();   
    QBasicMutex *reloadDatabaseMutex = new QBasicMutex(); 
};
 
#endif // COCKATRICE_CARD_DATABASE_LOADER_H