KisFolderStorage Class Reference

#include <KisFolderStorage.h>

Inheritance diagram for KisFolderStorage:

Public Member Functions
bool	addResource (const QString &resourceType, KoResourceSP resource) override
bool	exportResource (const QString &url, QIODevice *device) override
bool	importResource (const QString &url, QIODevice *device) override
	KisFolderStorage (const QString &location)
bool	loadVersionedResource (KoResourceSP resource) override
QVariant	metaData (const QString &key) const override
QStringList	metaDataKeys () const override
QString	resourceFilePath (const QString &url) 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
	Adds or updates this resource to the storage.
QSharedPointer< KisResourceStorage::TagIterator >	tags (const QString &resourceType) override
virtual	~KisFolderStorage ()
Public Member Functions inherited from KisStoragePlugin
virtual bool	isValid () const
	KisStoragePlugin (const QString &location)
virtual KoResourceSP	resource (const QString &url)
virtual void	setMetaData (const QString &key, const QVariant &value)
virtual bool	supportsVersioning () const
virtual QImage	thumbnail () const
QDateTime	timestamp ()
virtual	~KisStoragePlugin ()

Friends
class	FolderIterator

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

Detailed Description

KisFolderStorage is a KisStoragePlugin which handles resources stored in the user's resource folder. On initial startup, every resource that comes as a folder resource is copied to the user's resource folder. This is also the default location where the resources the user creates are stored.

Definition at line 21 of file KisFolderStorage.h.

Constructor & Destructor Documentation

KisFolderStorage()

KisFolderStorage::KisFolderStorage

(

const QString &

location

)

Definition at line 83 of file KisFolderStorage.cpp.

    : KisStoragePlugin(location)
{
}

~KisFolderStorage()

KisFolderStorage::~KisFolderStorage ( )

virtual

Definition at line 88 of file KisFolderStorage.cpp.

{
}

Member Function Documentation

addResource()

bool KisFolderStorage::addResource ( const QString & resourceType, KoResourceSP resource )

overridevirtual

Reimplemented from KisStoragePlugin.

Definition at line 239 of file KisFolderStorage.cpp.

{
    if (!resource || !resource->valid()) return false;
 
    const QString resourcesSaveLocation = location() + "/" + resourceType;
 
    QFileInfo fi(resourcesSaveLocation + "/" + resource->filename());
    if (fi.exists()) {
        qWarning() << "Resource" << resourceType << resource->filename() << "already exists in" << resourcesSaveLocation;
        return false;
    }
 
    QFile resourceFile(fi.absoluteFilePath());
    if (!resourceFile.open(QFile::WriteOnly)) {
        qWarning() << "Could not open" << fi.absoluteFilePath() << "for writing.";
        return false;
    }
 
    if (!resource->saveToDevice(&resourceFile)) {
        qWarning() << "Could not save resource to" << fi.absoluteFilePath();
        resourceFile.close();
        return false;
    }
    resourceFile.close();
 
 
 
 
    return true;
}

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

exportResource()

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

overridevirtual

Reimplemented from KisStoragePlugin.

Definition at line 218 of file KisFolderStorage.cpp.

{
    bool result = false;
 
    const QString resourcesLocation = location() + "/" + url;
 
    QFile f(resourcesLocation);
 
    if (!f.exists()) return result;
 
    if (f.open(QFile::ReadOnly)) {
        device->write(f.readAll());
        f.close();
        result = true;
    } else {
        qWarning() << "Cannot open" << resourcesLocation << "for reading";
    }
 
    return result;
}

References KisStoragePlugin::location().

importResource()

bool KisFolderStorage::importResource ( const QString & url, QIODevice * device )

overridevirtual

Reimplemented from KisStoragePlugin.

Definition at line 190 of file KisFolderStorage.cpp.

{
    bool result = false;
 
    const QString resourcesLocation = location() + "/" + url;
 
    QFile f(resourcesLocation);
 
    if (f.exists()) return result;
 
    if (f.open(QFile::WriteOnly)) {
        qint64 writtenBytes = f.write(device->readAll());
        f.close();
        result = (writtenBytes == device->size());
    } else {
        qWarning() << "Cannot open" << resourcesLocation << "for writing";
    }
 
    KoResourceSP resourceAfterLoading = resource(url);
 
    if (resourceAfterLoading.isNull()) {
        f.remove();
        return false;
    }
 
    return result;
}

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

loadVersionedResource()

bool KisFolderStorage::loadVersionedResource ( KoResourceSP resource )

overridevirtual

Implements KisStoragePlugin.

Definition at line 107 of file KisFolderStorage.cpp.

{
    QFileInfo fi(location() + '/' + resource->resourceType().first + '/' + resource->filename());
 
    QFile f(fi.absoluteFilePath());
    if (!f.open(QFile::ReadOnly)) {
        qWarning() << "Could not open" << fi.absoluteFilePath() << "for reading";
        return false;
    }
 
    bool r = resource->loadFromDevice(&f, KisGlobalResourcesInterface::instance());
 
    // Check for the thumbnail
    if (r) {
        sanitizeResourceFileNameCase(resource, fi.dir());
 
        if ((resource->image().isNull() || resource->thumbnail().isNull()) && !resource->thumbnailPath().isNull()) {
            QImage img(location() + '/' + resource->resourceType().first + '/' + resource->thumbnailPath());
            resource->setImage(img);
            resource->updateThumbnail();
        }
    }
 
    return r;
}

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

metaData()

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

overridevirtual

Reimplemented from KisStoragePlugin.

Definition at line 275 of file KisFolderStorage.cpp.

{
    if (key == KisResourceStorage::s_meta_name) {
        return i18n("Local Resources");
    }
    return QVariant();
 
}

References KisResourceStorage::s_meta_name.

metaDataKeys()

QStringList KisFolderStorage::metaDataKeys ( ) const

overridevirtual

Reimplemented from KisStoragePlugin.

Definition at line 270 of file KisFolderStorage.cpp.

{
    return QStringList() << KisResourceStorage::s_meta_name;
}

References KisResourceStorage::s_meta_name.

resourceFilePath()

QString KisFolderStorage::resourceFilePath ( const QString & url )

overridevirtual

Reimplemented from KisStoragePlugin.

Definition at line 145 of file KisFolderStorage.cpp.

{
    QFileInfo file(location() + "/" + url);
    return file.exists() ? file.absoluteFilePath() : QString();
}

References KisStoragePlugin::location().

resourceItem()

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

overridevirtual

Implements KisStoragePlugin.

Definition at line 97 of file KisFolderStorage.cpp.

{
    QFileInfo fi(url);
    FolderItem item;
    item.url = url;
    item.folder = fi.path().split("/").last();
    item.lastModified = fi.lastModified();
    return item;
}

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

resourceMd5()

QString KisFolderStorage::resourceMd5 ( const QString & url )

overridevirtual

Reimplemented from KisStoragePlugin.

Definition at line 133 of file KisFolderStorage.cpp.

{
    QString result;
 
    QFile file(location() + "/" + url);
    if (file.exists() && file.open(QIODevice::ReadOnly)) {
        result = KoMD5Generator::generateHash(file.readAll());
    }
 
    return result;
}

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

resources()

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

overridevirtual

Implements KisStoragePlugin.

Definition at line 151 of file KisFolderStorage.cpp.

{
    QVector<VersionedResourceEntry> entries;
 
    const QString resourcesSaveLocation = location() + "/" + resourceType;
 
    QDirIterator it(resourcesSaveLocation,
                    KisResourceLoaderRegistry::instance()->filters(resourceType),
                    QDir::Files | QDir::Readable,
                    QDirIterator::Subdirectories);;
 
    while (it.hasNext()) {
        it.next();
        QFileInfo info(it.fileInfo());
 
        VersionedResourceEntry entry;
        entry.filename = it.filePath().mid(resourcesSaveLocation.size() + 1);
 
        // Don't load 4.x backup resources
        if (entry.filename.contains("backup")) {
            continue;
        }
 
        entry.lastModified = info.lastModified();
        entry.tagList = {}; // TODO
        entry.resourceType = resourceType;
        entries.append(entry);
    }
 
    KisStorageVersioningHelper::detectFileVersions(entries);
 
    return toQShared(new KisVersionedStorageIterator(entries, this));
}

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

saveAsNewVersion()

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

overridevirtual

Adds or updates this resource to the storage.

Reimplemented from KisStoragePlugin.

Definition at line 92 of file KisFolderStorage.cpp.

{
    return KisStorageVersioningHelper::addVersionedResource(location() + "/" + resourceType, _resource, 0);
}

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

tags()

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

overridevirtual

Implements KisStoragePlugin.

Definition at line 185 of file KisFolderStorage.cpp.

{
    return QSharedPointer<KisResourceStorage::TagIterator>(new FolderTagIterator(location(), resourceType));
}

References KisStoragePlugin::location().

Friends And Related Symbol Documentation

FolderIterator

friend class FolderIterator

friend

Definition at line 44 of file KisFolderStorage.h.

---

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

• libs/resources/KisFolderStorage.h
• libs/resources/KisFolderStorage.cpp