KisBundleStorage Class Reference

#include <KisBundleStorage.h>

Inheritance diagram for KisBundleStorage:

Classes
class	Private

Public Member Functions
bool	exportResource (const QString &url, QIODevice *device) override
	KisBundleStorage (const QString &location)
bool	loadVersionedResource (KoResourceSP resource) override
	Note: this should find resources in a folder that override a resource in the bundle first.
QVariant	metaData (const QString &key) const override
QStringList	metaDataKeys () const override
KisResourceStorage::ResourceItem	resourceItem (const QString &url) override
QString	resourceMd5 (const QString &url) override
QSharedPointer< KisResourceStorage::ResourceIterator >	resources (const QString &resourceType) override
bool	saveAsNewVersion (const QString &resourceType, KoResourceSP resource) override
QSharedPointer< KisResourceStorage::TagIterator >	tags (const QString &resourceType) override
QImage	thumbnail () const override
virtual	~KisBundleStorage ()
Public Member Functions inherited from KisStoragePlugin
virtual bool	addResource (const QString &resourceType, KoResourceSP resource)
virtual bool	importResource (const QString &url, QIODevice *device)
virtual bool	isValid () const
	KisStoragePlugin (const QString &location)
virtual KoResourceSP	resource (const QString &url)
virtual QString	resourceFilePath (const QString &url)
virtual void	setMetaData (const QString &key, const QVariant &value)
virtual bool	supportsVersioning () const
QDateTime	timestamp ()
virtual	~KisStoragePlugin ()

Private Attributes
QScopedPointer< Private >	d

Friends
class	BundleIterator

Additional Inherited Members
Protected Member Functions inherited from KisStoragePlugin
QString	location () const
void	sanitizeResourceFileNameCase (KoResourceSP resource, const QDir &parentDir)

Detailed Description

KisBundleStorage is KisStoragePlugin that can load resources from bundles. It can also manage overridden resources from bundles, which are not stored in the bundles themselves.

Definition at line 18 of file KisBundleStorage.h.

Constructor & Destructor Documentation

KisBundleStorage()

KisBundleStorage::KisBundleStorage

(

const QString &

location

)

Definition at line 82 of file KisBundleStorage.cpp.

    : KisStoragePlugin(location)
    , d(new Private(this))
{
    d->bundle.reset(new KoResourceBundle(location));
    if (!d->bundle->load()) {
        qWarning() << "Could not load bundle" << location;
    }
}

References d, and KisStoragePlugin::location().

~KisBundleStorage()

KisBundleStorage::~KisBundleStorage ( )

virtual

Definition at line 92 of file KisBundleStorage.cpp.

{
}

Member Function Documentation

exportResource()

bool KisBundleStorage::exportResource ( const QString & url, QIODevice * device )

overridevirtual

Reimplemented from KisStoragePlugin.

Definition at line 258 of file KisBundleStorage.cpp.

{
    QStringList parts = url.split('/', Qt::SkipEmptyParts);
    Q_ASSERT(parts.size() == 2);
 
    const QString resourceType = parts[0];
    const QString resourceFileName = parts[1];
 
    bool foundVersionedFile = false;
 
    const QString bundleSaveLocation = location() + "_modified" + "/" + resourceType;
 
    if (QDir(bundleSaveLocation).exists()) {
        const QString fn = bundleSaveLocation  + "/" + resourceFileName;
        if (QFileInfo(fn).exists()) {
            foundVersionedFile = true;
 
            QFile f(fn);
            if (!f.open(QFile::ReadOnly)) {
                qWarning() << "Could not open resource file for reading" << fn;
                return false;
            }
 
            device->write(f.readAll());
        }
    }
 
    if (!foundVersionedFile) {
        d->bundle->exportResource(resourceType, resourceFileName, device);
    }
 
    return true;
}

References d, and KisStoragePlugin::location().

loadVersionedResource()

bool KisBundleStorage::loadVersionedResource ( KoResourceSP resource )

overridevirtual

Note: this should find resources in a folder that override a resource in the bundle first.

Implements KisStoragePlugin.

Definition at line 108 of file KisBundleStorage.cpp.

{
    bool foundVersionedFile = false;
 
    const QString resourceType = resource->resourceType().first;
    const QString resourceUrl = resourceType + "/" + resource->filename();
 
    const QString bundleSaveLocation = location() + "_modified" + "/" + resourceType;
 
    if (QDir(bundleSaveLocation).exists()) {
        const QString fn = bundleSaveLocation  + "/" + resource->filename();
        const QFileInfo fi(fn);
        if (fi.exists()) {
            foundVersionedFile = true;
 
            QFile f(fn);
            if (!f.open(QFile::ReadOnly)) {
                qWarning() << "Could not open resource file for reading" << fn;
                return false;
            }
            if (!resource->loadFromDevice(&f, KisGlobalResourcesInterface::instance())) {
                qWarning() << "Could not reload resource file" << fn;
                return false;
            }
 
            sanitizeResourceFileNameCase(resource, fi.dir());
 
            // Check for the thumbnail
            if ((resource->image().isNull() || resource->thumbnail().isNull()) && !resource->thumbnailPath().isNull()) {
                QImage img(bundleSaveLocation  + "/" +  '/' + resource->thumbnailPath());
                resource->setImage(img);
                resource->updateThumbnail();
            }
            f.close();
        }
    }
 
    if (!foundVersionedFile) {
        d->bundle->loadResource(resource);
    }
 
    return true;
}

References d, KisGlobalResourcesInterface::instance(), KisStoragePlugin::location(), KisStoragePlugin::resource(), and KisStoragePlugin::sanitizeResourceFileNameCase().

metaData()

QVariant KisBundleStorage::metaData ( const QString & key ) const

overridevirtual

Reimplemented from KisStoragePlugin.

Definition at line 242 of file KisBundleStorage.cpp.

{
    return d->bundle->metaData(key);
}

References d.

metaDataKeys()

QStringList KisBundleStorage::metaDataKeys ( ) const

overridevirtual

Reimplemented from KisStoragePlugin.

Definition at line 224 of file KisBundleStorage.cpp.

{
 
    return QStringList() << KisResourceStorage::s_meta_generator
                         << KisResourceStorage::s_meta_author
                         << KisResourceStorage::s_meta_title
                         << KisResourceStorage::s_meta_description
                         << KisResourceStorage::s_meta_initial_creator
                         << KisResourceStorage::s_meta_creator
                         << KisResourceStorage::s_meta_creation_date
                         << KisResourceStorage::s_meta_dc_date
                         << KisResourceStorage::s_meta_user_defined
                         << KisResourceStorage::s_meta_name
                         << KisResourceStorage::s_meta_value
                         << KisResourceStorage::s_meta_version;
 
}

References KisResourceStorage::s_meta_author, KisResourceStorage::s_meta_creation_date, KisResourceStorage::s_meta_creator, KisResourceStorage::s_meta_dc_date, KisResourceStorage::s_meta_description, KisResourceStorage::s_meta_generator, KisResourceStorage::s_meta_initial_creator, KisResourceStorage::s_meta_name, KisResourceStorage::s_meta_title, KisResourceStorage::s_meta_user_defined, KisResourceStorage::s_meta_value, and KisResourceStorage::s_meta_version.

resourceItem()

KisResourceStorage::ResourceItem KisBundleStorage::resourceItem ( const QString & url )

overridevirtual

Implements KisStoragePlugin.

Definition at line 96 of file KisBundleStorage.cpp.

{
    KisResourceStorage::ResourceItem item;
    item.url = url;
    QStringList parts = url.split('/', Qt::SkipEmptyParts);
    Q_ASSERT(parts.size() == 2);
    item.folder = parts[0];
    item.resourceType = parts[0];
    item.lastModified = QFileInfo(d->bundle->filename()).lastModified();
    return item;
}

References d, KisResourceStorage::ResourceItem::folder, KisResourceStorage::ResourceItem::lastModified, KisResourceStorage::ResourceItem::resourceType, and KisResourceStorage::ResourceItem::url.

resourceMd5()

QString KisBundleStorage::resourceMd5 ( const QString & url )

overridevirtual

Reimplemented from KisStoragePlugin.

Definition at line 152 of file KisBundleStorage.cpp.

{
    QString result;
 
    QFile modifiedFile(location() + "_modified" + "/" + url);
    if (modifiedFile.exists() && modifiedFile.open(QIODevice::ReadOnly)) {
        result = KoMD5Generator::generateHash(modifiedFile.readAll());
    } else {
        result = d->bundle->resourceMd5(url);
    }
 
    return result;
}

References d, KoMD5Generator::generateHash(), and KisStoragePlugin::location().

resources()

QSharedPointer< KisResourceStorage::ResourceIterator > KisBundleStorage::resources ( const QString & resourceType )

overridevirtual

Implements KisStoragePlugin.

Definition at line 166 of file KisBundleStorage.cpp.

{
    QVector<VersionedResourceEntry> entries;
 
    QList<KoResourceBundleManifest::ResourceReference> references =
        d->bundle->manifest().files(resourceType);
 
    for (auto it = references.begin(); it != references.end(); ++it) {
        VersionedResourceEntry entry;
        // it->resourcePath() contains paths like "brushes/ink.png" or "brushes/subfolder/splash.png".
        // we need to cut off the first part and get "ink.png" in the first case,
        // but "subfolder/splash.png" in the second case in order for subfolders to work
        // so it cannot just use QFileInfo(verIt->url()).fileName() here.
        QString path = QDir::fromNativeSeparators(it->resourcePath); // make sure it uses Unix separators
        int folderEndIdx = path.indexOf("/");
        QString properFilenameWithSubfolders = path.right(path.length() - folderEndIdx - 1);
 
        entry.filename = properFilenameWithSubfolders;
        entry.lastModified = QFileInfo(location()).lastModified();
        entry.tagList = it->tagList;
        entry.resourceType = resourceType;
        entries.append(entry);
    }
 
    const QString bundleSaveLocation = location() + "_modified" + "/" + resourceType;
 
    QDirIterator it(bundleSaveLocation,
                    KisResourceLoaderRegistry::instance()->filters(resourceType),
                    QDir::Files | QDir::Readable,
                    QDirIterator::Subdirectories);;
 
    while (it.hasNext()) {
        it.next();
        QFileInfo info(it.fileInfo());
 
        VersionedResourceEntry entry;
        entry.filename = info.fileName();
        entry.lastModified = info.lastModified();
        entry.tagList = {}; // TODO
        entry.resourceType = resourceType;
        entries.append(entry);
    }
 
    KisStorageVersioningHelper::detectFileVersions(entries);
 
    return toQShared(new KisVersionedStorageIterator(entries, this));
}

References d, KisStorageVersioningHelper::detectFileVersions(), VersionedResourceEntry::filename, KisResourceLoaderRegistry::instance(), VersionedResourceEntry::lastModified, KisStoragePlugin::location(), VersionedResourceEntry::resourceType, VersionedResourceEntry::tagList, and toQShared().

saveAsNewVersion()

bool KisBundleStorage::saveAsNewVersion ( const QString & resourceType, KoResourceSP resource )

overridevirtual

Add a resource to this bundle: note, the bundle itself should NOT be rewritten, but we need to put these tags in a place in the file system

Reimplemented from KisStoragePlugin.

Definition at line 247 of file KisBundleStorage.cpp.

{
    QString bundleSaveLocation = location() + "_modified" + "/" + resourceType;
 
    if (!QDir(bundleSaveLocation).exists()) {
        QDir().mkpath(bundleSaveLocation);
    }
 
    return KisStorageVersioningHelper::addVersionedResource(bundleSaveLocation, resource, 1);
}

References KisStorageVersioningHelper::addVersionedResource(), KisStoragePlugin::location(), and KisStoragePlugin::resource().

tags()

QSharedPointer< KisResourceStorage::TagIterator > KisBundleStorage::tags ( const QString & resourceType )

overridevirtual

Implements KisStoragePlugin.

Definition at line 214 of file KisBundleStorage.cpp.

{
    return QSharedPointer<KisResourceStorage::TagIterator>(new BundleTagIterator(d->bundle.data(), resourceType));
}

References d.

thumbnail()

QImage KisBundleStorage::thumbnail ( ) const

overridevirtual

Reimplemented from KisStoragePlugin.

Definition at line 219 of file KisBundleStorage.cpp.

{
    return d->bundle->image();
}

References d.

Friends And Related Symbol Documentation

BundleIterator

friend class BundleIterator

friend

Definition at line 42 of file KisBundleStorage.h.

Member Data Documentation

d

QScopedPointer<Private> KisBundleStorage::d

private

Definition at line 46 of file KisBundleStorage.h.

---

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

• libs/resources/KisBundleStorage.h
• libs/resources/KisBundleStorage.cpp