KisSupporterBundlesFetcher Class Reference

#include <KisSupporterBundlesFetcher.h>

Inheritance diagram for KisSupporterBundlesFetcher:

Signals
void	fetchIndexDone (bool success, const QString &errorMessage)

Public Member Functions
const QVector< KisSupporterBundle > &	bundles () const
QNetworkReply *	fetchBundle (const KisSupporterBundle &bundle)
void	fetchIndex ()
bool	isFetching () const
	KisSupporterBundlesFetcher (QObject *parent=nullptr)

Static Public Member Functions
static bool	hasNetworkReplyError (QNetworkReply *reply, QString &outErrorMessage)

Private Member Functions
bool	checkExistingIndexDb (unsigned int expectedVersion, const QString &expectedHash)
bool	doWithIndexDb (QString &outErrorMessage, const std::function< bool(QSqlDatabase &, QString &)> &block)
void	emitCheckTxtFetchFailed (const QString &errorMessage)
void	emitFailure (const QString &errorMessage)
void	emitIndexDbFetchFailed (const QString &errorMessage)
QNetworkReply *	fetch (const QString &path)
void	fetchIndexDb (unsigned int expectedVersion, const QString &expectedHash)
void	handleCheckTxtFetched (QNetworkReply *reply)
bool	handleCheckTxtPredefinedFailure (const QString &content)
void	handleIndexDbFetched (QNetworkReply *reply, unsigned int expectedVersion, const QString &expectedHash)
void	readIndexDbBundles ()

Static Private Member Functions
static bool	readSqliteUserVersion (const QByteArray &bytes, unsigned int &outVersion)

Private Attributes
QVector< KisSupporterBundle >	m_bundles
bool	m_fetching = false
QString	m_indexDbPath
KisNetworkAccessManager *	m_nam = nullptr

Static Private Attributes
static constexpr char	BASE_URL [] = "https://cdn.kde.org/krita/.android-supporters-extra/supporterbundles/"

Detailed Description

Definition at line 19 of file KisSupporterBundlesFetcher.h.

Constructor & Destructor Documentation

KisSupporterBundlesFetcher()

KisSupporterBundlesFetcher::KisSupporterBundlesFetcher ( QObject * parent = nullptr )

explicit

Definition at line 22 of file KisSupporterBundlesFetcher.cpp.

    : QObject(parent)
{
    QDir cacheDir(QStandardPaths::writableLocation(QStandardPaths::CacheLocation));
    m_indexDbPath = cacheDir.filePath(QStringLiteral("kissupporterbundlesindex.db"));
    dbgResources << "Index db path:" << m_indexDbPath;
}

References dbgResources, and m_indexDbPath.

Member Function Documentation

bundles()

const QVector< KisSupporterBundle > & KisSupporterBundlesFetcher::bundles ( ) const

inline

Definition at line 30 of file KisSupporterBundlesFetcher.h.

    {
        return m_bundles;
    }

References m_bundles.

checkExistingIndexDb()

bool KisSupporterBundlesFetcher::checkExistingIndexDb ( unsigned int expectedVersion, const QString & expectedHash )

private

Definition at line 132 of file KisSupporterBundlesFetcher.cpp.

{
    QFile file(m_indexDbPath);
    if (!file.open(QIODevice::ReadOnly)) {
        dbgResources << "Could not open existing index db";
        return false;
    }
 
    QByteArray bytes = file.readAll();
    unsigned int version;
    if (!readSqliteUserVersion(bytes, version)) {
        dbgResources << "Could not read existing version";
        return false;
    }
 
    if (version != expectedVersion) {
        dbgResources << "Existing version" << version << "!=" << expectedVersion;
        return false;
    }
 
    QString hash = QCryptographicHash::hash(bytes, QCryptographicHash::Md5).toHex();
    if (hash != expectedHash) {
        dbgResources << "Existing hash" << hash << "!=" << expectedHash;
        return false;
    }
 
    dbgResources << "Cached index database is valid";
    return true;
}

References dbgResources, m_indexDbPath, and readSqliteUserVersion().

doWithIndexDb()

bool KisSupporterBundlesFetcher::doWithIndexDb ( QString & outErrorMessage, const std::function< bool(QSqlDatabase &, QString &)> & block )

private

Definition at line 331 of file KisSupporterBundlesFetcher.cpp.

{
    QString connectionName = QStringLiteral("KisSupporterBundlesFetcher");
    bool ok;
    {
        QSqlDatabase db = QSqlDatabase::addDatabase(QStringLiteral("QSQLITE"), connectionName);
        db.setDatabaseName(m_indexDbPath);
        if (db.open()) {
            ok = block(db, outErrorMessage);
            db.close();
        } else {
            ok = false;
            outErrorMessage = db.lastError().text();
        }
    }
    QSqlDatabase::removeDatabase(connectionName);
    return ok;
}

References m_indexDbPath.

emitCheckTxtFetchFailed()

void KisSupporterBundlesFetcher::emitCheckTxtFetchFailed ( const QString & errorMessage )

private

Definition at line 315 of file KisSupporterBundlesFetcher.cpp.

{
    emitFailure(i18n("Failed to retrieve bundle checksums: %1", errorMessage));
}

References emitFailure().

emitFailure()

void KisSupporterBundlesFetcher::emitFailure ( const QString & errorMessage )

private

Definition at line 325 of file KisSupporterBundlesFetcher.cpp.

{
    m_fetching = false;
    Q_EMIT fetchIndexDone(false, errorMessage);
}

References fetchIndexDone(), and m_fetching.

emitIndexDbFetchFailed()

void KisSupporterBundlesFetcher::emitIndexDbFetchFailed ( const QString & errorMessage )

private

Definition at line 320 of file KisSupporterBundlesFetcher.cpp.

{
    emitFailure(i18n("Failed to retrieve bundles: %1", errorMessage));
}

References emitFailure().

fetch()

QNetworkReply * KisSupporterBundlesFetcher::fetch ( const QString & path )

private

Definition at line 299 of file KisSupporterBundlesFetcher.cpp.

{
    QUrl url(QString::fromUtf8(BASE_URL));
    url.setPath(url.path(QUrl::FullyDecoded) + path);
 
    QNetworkRequest req;
    req.setUrl(url);
 
    if (!m_nam) {
        m_nam = new KisNetworkAccessManager(this);
    }
 
    dbgResources << "Fetch" << url;
    return m_nam->get(req);
}

References BASE_URL, dbgResources, and m_nam.

fetchBundle()

QNetworkReply * KisSupporterBundlesFetcher::fetchBundle

(

const KisSupporterBundle &

bundle

)

Definition at line 41 of file KisSupporterBundlesFetcher.cpp.

{
    return fetch(QStringLiteral("bundles/%1").arg(bundle.fileName));
}

References fetch(), and KisSupporterBundle::fileName.

fetchIndex()

void KisSupporterBundlesFetcher::fetchIndex

(

)

Definition at line 30 of file KisSupporterBundlesFetcher.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(!m_fetching);
    m_fetching = true;
    QNetworkReply *reply = fetch(QStringLiteral("check0.txt"));
    connect(reply, &QNetworkReply::finished, this, [=] {
        handleCheckTxtFetched(reply);
        reply->deleteLater();
    });
}

References fetch(), handleCheckTxtFetched(), KIS_SAFE_ASSERT_RECOVER_RETURN, and m_fetching.

fetchIndexDb()

void KisSupporterBundlesFetcher::fetchIndexDb ( unsigned int expectedVersion, const QString & expectedHash )

private

Definition at line 162 of file KisSupporterBundlesFetcher.cpp.

{
    QNetworkReply *reply = fetch(QStringLiteral("index0.db"));
    connect(reply, &QNetworkReply::finished, this, [=] {
        handleIndexDbFetched(reply, expectedVersion, expectedHash);
        reply->deleteLater();
    });
}

References fetch(), and handleIndexDbFetched().

fetchIndexDone

void KisSupporterBundlesFetcher::fetchIndexDone ( bool success, const QString & errorMessage )

signal

handleCheckTxtFetched()

void KisSupporterBundlesFetcher::handleCheckTxtFetched ( QNetworkReply * reply )

private

Definition at line 62 of file KisSupporterBundlesFetcher.cpp.

{
    QString errorMessage;
    if (hasNetworkReplyError(reply, errorMessage)) {
        emitCheckTxtFetchFailed(errorMessage);
        return;
    }
 
    QString content = QString::fromUtf8(reply->readAll());
 
    // "Predefined failures" are for forward-compatibility for stuff like the
    // format changing and old versions of Krita becoming unsupported or the
    // service getting discontinued altogether.
    if (handleCheckTxtPredefinedFailure(content)) {
        return;
    }
 
    // The check0.txt is supposed to contain a version followed by an MD5 hash
    // digest. For forward-compatibility, we'll ignore anything else afterwards.
    QRegularExpression re(QStringLiteral("\\A\\s*([0-9]+)\\s+([0-9a-fA-F]+)\\b"));
    QRegularExpressionMatch match = re.match(content);
    if (!match.hasMatch()) {
        emitCheckTxtFetchFailed(i18n("Invalid checksums file."));
        return;
    }
 
    bool ok;
    unsigned int expectedVersion = match.captured(1).toUInt(&ok);
    dbgResources << "Expected version from fetched check0.txt:" << expectedVersion;
    if (!ok) {
        emitCheckTxtFetchFailed(i18n("Invalid checksums version."));
        return;
    }
 
    QString expectedHash = match.captured(2);
    dbgResources << "Expected hash from fetched check0.txt:" << expectedHash;
 
    if (checkExistingIndexDb(expectedVersion, expectedHash)) {
        readIndexDbBundles();
    } else {
        fetchIndexDb(expectedVersion, expectedHash);
    }
}

References checkExistingIndexDb(), dbgResources, emitCheckTxtFetchFailed(), fetchIndexDb(), handleCheckTxtPredefinedFailure(), hasNetworkReplyError(), and readIndexDbBundles().

handleCheckTxtPredefinedFailure()

bool KisSupporterBundlesFetcher::handleCheckTxtPredefinedFailure ( const QString & content )

private

Definition at line 106 of file KisSupporterBundlesFetcher.cpp.

{
    QRegularExpression re(QStringLiteral("\\A!failure=([a-zA-Z0-9]*)"), QRegularExpression::CaseInsensitiveOption);
    QRegularExpressionMatch match = re.match(content);
    if (!match.hasMatch()) {
        return false;
    }
 
    QString failureType = match.captured(1);
    QString errorMessage;
    if (failureType.compare(QStringLiteral("outdated"), Qt::CaseInsensitive) == 0) {
        errorMessage = i18n("You have to update Krita to use this service.");
    } else if (failureType.compare(QStringLiteral("region"), Qt::CaseInsensitive) == 0) {
        errorMessage = i18n("This service is not available in your region.");
    } else if (failureType.compare(QStringLiteral("unavailable"), Qt::CaseInsensitive) == 0) {
        errorMessage = i18n("This service is currently unavailable.");
    } else if (failureType.compare(QStringLiteral("discontinued"), Qt::CaseInsensitive) == 0) {
        errorMessage = i18n("This service has been discontinued.");
    } else {
        errorMessage = i18n("Unknown service error %1.").arg(failureType);
    }
 
    emitFailure(errorMessage);
    return true;
}

References emitFailure().

handleIndexDbFetched()

void KisSupporterBundlesFetcher::handleIndexDbFetched ( QNetworkReply * reply, unsigned int expectedVersion, const QString & expectedHash )

private

Definition at line 171 of file KisSupporterBundlesFetcher.cpp.

{
    QString errorMessage;
    if (hasNetworkReplyError(reply, errorMessage)) {
        emitIndexDbFetchFailed(errorMessage);
        return;
    }
 
    QByteArray bytes = reply->readAll();
    unsigned int version;
    if (!readSqliteUserVersion(bytes, version)) {
        emitIndexDbFetchFailed(i18n("Not enough data."));
        return;
    }
 
    dbgResources << "got version:" << version;
    dbgResources << "expected:" << expectedVersion;
    if (version != expectedVersion) {
        emitIndexDbFetchFailed(i18n("Invalid version."));
        return;
    }
 
    QString hash = QCryptographicHash::hash(bytes, QCryptographicHash::Md5).toHex();
    dbgResources << "got hash:" << hash;
    dbgResources << "expected:" << expectedHash;
    if (hash != expectedHash) {
        emitIndexDbFetchFailed(i18n("Invalid checksum."));
        return;
    }
 
    QString dirName = QFileInfo(m_indexDbPath).path();
    if (!QDir().mkpath(dirName)) {
        emitIndexDbFetchFailed(i18n("Failed to create directory %1.").arg(dirName));
        return;
    }
 
    QSaveFile saveFile(m_indexDbPath);
    saveFile.setDirectWriteFallback(true);
    if (!saveFile.open(QIODevice::WriteOnly)) {
        emitIndexDbFetchFailed(i18n("Failed to open %1 for writing.").arg(m_indexDbPath));
        return;
    }
 
    qint64 written = saveFile.write(bytes);
    if (written != qint64(bytes.size()) || !saveFile.commit()) {
        emitIndexDbFetchFailed(i18n("Failed to write %1.").arg(m_indexDbPath));
        return;
    }
 
    readIndexDbBundles();
}

References dbgResources, emitIndexDbFetchFailed(), hasNetworkReplyError(), m_indexDbPath, readIndexDbBundles(), and readSqliteUserVersion().

hasNetworkReplyError()

bool KisSupporterBundlesFetcher::hasNetworkReplyError ( QNetworkReply * reply, QString & outErrorMessage )

static

Definition at line 46 of file KisSupporterBundlesFetcher.cpp.

{
    if (reply->error() != QNetworkReply::NoError) {
        outErrorMessage = reply->errorString();
        return true;
    }
 
    int statusCode = reply->attribute(QNetworkRequest::HttpStatusCodeAttribute).toInt();
    if (statusCode < 200 || statusCode > 300) {
        outErrorMessage = i18n("Server responded with error %1.").arg(statusCode);
        return true;
    }
 
    return false;
}

isFetching()

bool KisSupporterBundlesFetcher::isFetching ( ) const

inline

Definition at line 25 of file KisSupporterBundlesFetcher.h.

    {
        return m_fetching;
    }

References m_fetching.

readIndexDbBundles()

void KisSupporterBundlesFetcher::readIndexDbBundles ( )

private

Definition at line 225 of file KisSupporterBundlesFetcher.cpp.

{
    QString errorMessage;
    bool ok = doWithIndexDb(errorMessage, [this](QSqlDatabase &db, QString &outErrorMessage) {
        QSqlQuery query(db);
 
        QString selectBundlesSql = QStringLiteral(
            "select bundle_id, file_name, size_in_bytes, source, title,\n"
            "       description, author, license, checksum, thumbnail\n"
            "from bundle");
        if (!query.exec(selectBundlesSql)) {
            outErrorMessage = query.lastError().text();
            return false;
        }
 
        QHash<long long, KisSupporterBundle> bundlesById;
        while (query.next()) {
            long long id = query.value(0).toLongLong();
            KisSupporterBundle bundle = {
                query.value(1).toString(),
                query.value(2).toLongLong(),
                query.value(3).toString(),
                query.value(4).toString(),
                query.value(5).toString(),
                query.value(6).toString(),
                query.value(7).toString(),
                query.value(8).toString(),
                QPixmap(),
                QSet<QString>(),
                QHash<QString, int>(),
            };
            bundle.thumbnail.loadFromData(query.value(9).toByteArray());
            bundlesById.insert(id, bundle);
        }
 
        QString selectTagsSql = QStringLiteral("select bundle_id, tag from bundle_tag");
        if (!query.exec(selectTagsSql)) {
            outErrorMessage = query.lastError().text();
            return false;
        }
 
        while (query.next()) {
            long long id = query.value(0).toLongLong();
            QHash<long long, KisSupporterBundle>::iterator it = bundlesById.find(id);
            if (it != bundlesById.end()) {
                it->tags.insert(query.value(1).toString());
            }
        }
 
        QString selectResourceCountsSql = QStringLiteral(
            "select bundle_id, media_type, amount\n"
            "from bundle_resource_count");
        if (query.exec(selectResourceCountsSql)) {
            while (query.next()) {
                long long id = query.value(0).toLongLong();
                QHash<long long, KisSupporterBundle>::iterator it = bundlesById.find(id);
                if (it != bundlesById.end()) {
                    it->resourceCountByMediaType.insert(query.value(1).toString(), query.value(2).toInt());
                }
            }
        } else {
            warnResources << "Error querying bundle resource counts:" << query.lastError().text();
            // Not critical to have these counts, just keep going.
        }
 
        m_bundles = QVector<KisSupporterBundle>(bundlesById.begin(), bundlesById.end());
        dbgResources << "Loaded" << m_bundles.size() << "supporter bundle(s)";
        return true;
    });
 
    m_fetching = false;
    emit fetchIndexDone(ok, errorMessage);
}

References dbgResources, doWithIndexDb(), fetchIndexDone(), m_bundles, m_fetching, KisSupporterBundle::thumbnail, and warnResources.

readSqliteUserVersion()

bool KisSupporterBundlesFetcher::readSqliteUserVersion ( const QByteArray & bytes, unsigned int & outVersion )

staticprivate

Definition at line 351 of file KisSupporterBundlesFetcher.cpp.

{
    // The SQLite format stores its "user version" value at index 60 as a 32 bit
    // bigendian unsigned integer. See https://www.sqlite.org/fileformat.html
    if (bytes.size() < 64) {
        return false;
    } else {
        outVersion = qFromBigEndian<quint32>(bytes.constData() + 60);
        return true;
    }
}

Member Data Documentation

BASE_URL

constexpr char KisSupporterBundlesFetcher::BASE_URL[] = "https://cdn.kde.org/krita/.android-supporters-extra/supporterbundles/"

staticconstexprprivate

Definition at line 45 of file KisSupporterBundlesFetcher.h.

m_bundles

QVector<KisSupporterBundle> KisSupporterBundlesFetcher::m_bundles

private

Definition at line 70 of file KisSupporterBundlesFetcher.h.

m_fetching

bool KisSupporterBundlesFetcher::m_fetching = false

private

Definition at line 71 of file KisSupporterBundlesFetcher.h.

m_indexDbPath

QString KisSupporterBundlesFetcher::m_indexDbPath

private

Definition at line 69 of file KisSupporterBundlesFetcher.h.

m_nam

KisNetworkAccessManager* KisSupporterBundlesFetcher::m_nam = nullptr

private

Definition at line 68 of file KisSupporterBundlesFetcher.h.

---

The documentation for this class was generated from the following files:

• plugins/extensions/resourcemanager/KisSupporterBundlesFetcher.h
• plugins/extensions/resourcemanager/KisSupporterBundlesFetcher.cpp