KisStorageVersioningHelper Class Reference

#include <KisResourceStorage.h>

Static Public Member Functions
static bool	addVersionedResource (const QString &saveLocation, KoResourceSP resource, int minVersion)
static QString	chooseUniqueName (KoResourceSP resource, int minVersion, std::function< bool(QString)> checkExists)
static void	detectFileVersions (QVector< VersionedResourceEntry > &allFiles)

Detailed Description

Definition at line 342 of file KisResourceStorage.h.

Member Function Documentation

addVersionedResource()

bool KisStorageVersioningHelper::addVersionedResource ( const QString & saveLocation, KoResourceSP resource, int minVersion )

static

Definition at line 464 of file KisResourceStorage.cpp.

{
    int version = qMax(resource->version(), minVersion);
 
    VersionedFileParts parts = guessFileNamePartsLazy(resource->filename(), version);
    version = parts.version;
 
    QString newFilename =
        chooseUniqueName(resource, minVersion,
                         [saveLocation] (const QString &filename) {
                             return QFileInfo(saveLocation + "/" + filename).exists();
                         });
 
    if (newFilename.isEmpty()) return false;
 
    QFile file(saveLocation + "/" + newFilename);
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(!file.exists(), false);
 
    if (!file.open(QFile::WriteOnly)) {
        qWarning() << "Could not open resource file for writing" << newFilename;
        return false;
    }
 
    if (!resource->saveToDevice(&file)) {
        qWarning() << "Could not save resource file" << newFilename;
        return false;
    }
 
    resource->setFilename(newFilename);
    file.close();
 
    if (!resource->thumbnailPath().isEmpty()) {
        // hack for MyPaint brush presets thumbnails
        // note: for all versions of the preset, it will try to save in the same place
        if (!QFileInfo(saveLocation + "/" + resource->thumbnailPath()).exists()) {
            QImage thumbnail = resource->thumbnail();
            thumbnail.save(saveLocation + "/" + resource->thumbnailPath());
        }
    }
 
    return true;
}

References chooseUniqueName(), guessFileNamePartsLazy(), KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, and VersionedFileParts::version.

chooseUniqueName()

QString KisStorageVersioningHelper::chooseUniqueName ( KoResourceSP resource, int minVersion, std::function< bool(QString)> checkExists )

static

Definition at line 393 of file KisResourceStorage.cpp.

{
    int version = qMax(resource->version(), minVersion);
 
    VersionedFileParts parts = guessFileNamePartsLazy(resource->filename(), version);
    version = parts.version;
 
    QString newFilename;
 
    while (1) {
        int numPlaceholders = 4;
 
        if (version > 9999) {
            numPlaceholders = qFloor(std::log10(version)) + 1;
        }
 
        QString versionString = QString("%1").arg(version, numPlaceholders, 10, QChar('0'));
 
        // XXX: Temporary, until I've fixed the tests
        if (versionString == "0000" && qApp->applicationName() == "krita") {
            newFilename = resource->filename();
        }
        else {
            newFilename = parts.basename +
                    "."
                    + versionString
                    + "."
                    + parts.suffix;
        }
        if (checkExists(newFilename)) {
            version++;
            if (version == std::numeric_limits<int>::max()) {
                return QString();
            }
            continue;
        }
 
        break;
    }
 
    return newFilename;
}

References VersionedFileParts::basename, guessFileNamePartsLazy(), VersionedFileParts::suffix, and VersionedFileParts::version.

detectFileVersions()

void KisStorageVersioningHelper::detectFileVersions ( QVector< VersionedResourceEntry > & allFiles )

static

Definition at line 438 of file KisResourceStorage.cpp.

{
    for (auto it = allFiles.begin(); it != allFiles.end(); ++it) {
        VersionedFileParts parts = guessFileNamePartsLazy(it->filename, -1);
        it->guessedKey = parts.basename + parts.suffix;
        it->guessedVersion = parts.version;
    }
 
    std::sort(allFiles.begin(), allFiles.end(), VersionedResourceEntry::KeyVersionLess());
 
    boost::optional<QString> lastResourceKey;
    int availableVersion = 0;
    for (auto it = allFiles.begin(); it != allFiles.end(); ++it) {
        if (!lastResourceKey || *lastResourceKey != it->guessedKey) {
            availableVersion = 0;
            lastResourceKey = it->guessedKey;
        }
 
        if (it->guessedVersion < availableVersion) {
            it->guessedVersion = availableVersion;
        }
 
        availableVersion = it->guessedVersion + 1;
    }
}

References VersionedFileParts::basename, guessFileNamePartsLazy(), VersionedFileParts::suffix, and VersionedFileParts::version.

---

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

• libs/resources/KisResourceStorage.h
• libs/resources/KisResourceStorage.cpp