KisMemoryStorage Class Reference

The KisMemoryStorage class stores the temporary resources that are not saved to disk or bundle. It is also used to stores transient per-document resources, such as the document-local palette list. More...

#include <KisMemoryStorage.h>

Inheritance diagram for KisMemoryStorage:

Classes
class	Private

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
	KisMemoryStorage (const KisMemoryStorage &rhs)
	Copying the memory storage clones all contained resources and tags.
	KisMemoryStorage (const QString &location=QString("memory"))
bool	loadVersionedResource (KoResourceSP resource) override
QVariant	metaData (const QString &key) const override
QStringList	metaDataKeys () const override
KisMemoryStorage &	operator= (const KisMemoryStorage &rhs)
	This clones all contained resources and tags from rhs.
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
void	setMetaData (const QString &key, const QVariant &value) override
QSharedPointer< KisResourceStorage::TagIterator >	tags (const QString &resourceType) override
virtual	~KisMemoryStorage ()
Public Member Functions inherited from KisStoragePlugin
virtual bool	isValid () const
	KisStoragePlugin (const QString &location)
virtual KoResourceSP	resource (const QString &url)
virtual QString	resourceFilePath (const QString &url)
virtual bool	supportsVersioning () const
virtual QImage	thumbnail () const
QDateTime	timestamp ()
virtual	~KisStoragePlugin ()

Private Member Functions
bool	testingAddTag (const QString &resourceType, KisTagSP tag)
bool	testingRemoveResource (const QString &url)
bool	testingRemoveTag (const QString &resourceType, const QString &tagUrl)

Private Attributes
QScopedPointer< Private >	d

Friends
class	TestMemoryStorage
class	TestResourceLocator
class	TestStorageWrapper

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

Detailed Description

The KisMemoryStorage class stores the temporary resources that are not saved to disk or bundle. It is also used to stores transient per-document resources, such as the document-local palette list.

Definition at line 20 of file KisMemoryStorage.h.

Constructor & Destructor Documentation

KisMemoryStorage() [1/2]

KisMemoryStorage::KisMemoryStorage

(

const QString &

location = QString("memory")

)

Definition at line 96 of file KisMemoryStorage.cpp.

    : KisStoragePlugin(location)
    , d(new Private)
{
}

~KisMemoryStorage()

KisMemoryStorage::~KisMemoryStorage ( )

virtual

Definition at line 102 of file KisMemoryStorage.cpp.

{
}

KisMemoryStorage() [2/2]

KisMemoryStorage::KisMemoryStorage

(

const KisMemoryStorage &

rhs

)

Copying the memory storage clones all contained resources and tags.

Definition at line 106 of file KisMemoryStorage.cpp.

    : KisStoragePlugin(rhs.location())
    , d(new Private)
{
    *this = rhs;
    d->resourcesNew = rhs.d->resourcesNew;
    d->tags = rhs.d->tags;
    d->metadata = rhs.d->metadata;
}

References d.

Member Function Documentation

addResource()

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

overridevirtual

here we silently overwrite the resource if the filename is the same; it is the job of higher-level code to actually resolve file name clashes

Reimplemented from KisStoragePlugin.

Definition at line 249 of file KisMemoryStorage.cpp.

{
    QHash<QString, StoredResource> &typedResources = d->resourcesNew[resourceType];
 
    if (typedResources.contains(resource->filename())) {
        return true;
    };
 
    StoredResource storedResource;
    storedResource.timestamp = QDateTime::currentDateTime();
    storedResource.data.reset(new QByteArray());
    if (resource->isSerializable()) {
        QBuffer buffer(storedResource.data.data());
        buffer.open(QIODevice::WriteOnly);
        if (!resource->saveToDevice(&buffer)) {
            storedResource.resource = resource;
        }
        buffer.close();
    } else {
        storedResource.resource = resource;
    }
 
    typedResources.insert(resource->filename(), storedResource);
 
    return true;
}

References d, StoredResource::data, StoredResource::resource, KisStoragePlugin::resource(), and StoredResource::timestamp.

exportResource()

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

overridevirtual

Reimplemented from KisStoragePlugin.

Definition at line 226 of file KisMemoryStorage.cpp.

{
    auto parsedUrl = detail::splitResourceUrl(url);
    if (!parsedUrl) return false;
    auto [resourceType, resourceFilename] = *parsedUrl;
 
    if (!d->resourcesNew.contains(resourceType) ||
        !d->resourcesNew[resourceType].contains(resourceFilename)) {
        return false;
    }
 
    const StoredResource &storedResource =
        d->resourcesNew[resourceType][resourceFilename];
 
    if (!storedResource.data) {
        qWarning() << "Stored resource doesn't have a serialized representation!";
        return false;
    }
 
    device->write(*storedResource.data);
    return true;
}

References d, StoredResource::data, and detail::splitResourceUrl().

importResource()

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

overridevirtual

Reimplemented from KisStoragePlugin.

Definition at line 203 of file KisMemoryStorage.cpp.

{
    auto parsedUrl = detail::splitResourceUrl(url);
    if (!parsedUrl) return false;
    auto [resourceType, resourceFilename] = *parsedUrl;
 
    // we cannot overwrite existing file by API convention
    if (d->resourcesNew.contains(resourceType) &&
        d->resourcesNew[resourceType].contains(resourceFilename)) {
        return false;
    }
 
    StoredResource storedResource;
    storedResource.timestamp = QDateTime::currentDateTime();
    storedResource.data.reset(new QByteArray(device->readAll()));
 
    QHash<QString, StoredResource> &typedResources =
        d->resourcesNew[resourceType];
    typedResources.insert(resourceFilename, storedResource);
 
    return true;
}

References d, StoredResource::data, detail::splitResourceUrl(), and StoredResource::timestamp.

loadVersionedResource()

bool KisMemoryStorage::loadVersionedResource ( KoResourceSP resource )

overridevirtual

Implements KisStoragePlugin.

Definition at line 175 of file KisMemoryStorage.cpp.

{
    const QString resourceType = resource->resourceType().first;
    const QString resourceFilename = resource->filename();
 
    bool retval = false;
 
    if (d->resourcesNew.contains(resourceType) &&
        d->resourcesNew[resourceType].contains(resourceFilename)) {
 
        const StoredResource &storedResource =
            d->resourcesNew[resourceType][resourceFilename];
 
        if (storedResource.data->size() > 0) {
            QBuffer buffer(storedResource.data.data());
            buffer.open(QIODevice::ReadOnly);
            resource->loadFromDevice(&buffer, KisGlobalResourcesInterface::instance());
        } else {
            KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(storedResource.data->size() > 0, false);
            qWarning() << "Cannot load resource from device in KisMemoryStorage::loadVersionedResource";
            return false;
        }
        retval = true;
    }
 
    return retval;
}

References d, StoredResource::data, KisGlobalResourcesInterface::instance(), KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, and KisStoragePlugin::resource().

metaData()

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

overridevirtual

Reimplemented from KisStoragePlugin.

Definition at line 389 of file KisMemoryStorage.cpp.

{
    QVariant r;
    if (d->metadata.contains(key)) {
        r = d->metadata[key];
    }
    return r;
}

References d.

metaDataKeys()

QStringList KisMemoryStorage::metaDataKeys ( ) const

overridevirtual

Reimplemented from KisStoragePlugin.

Definition at line 378 of file KisMemoryStorage.cpp.

{
    QStringList keys = d->metadata.keys();
 
    if (!keys.contains(KisResourceStorage::s_meta_name)) {
        keys << KisResourceStorage::s_meta_name;
    }
 
    return keys;
}

References d, and KisResourceStorage::s_meta_name.

operator=()

KisMemoryStorage & KisMemoryStorage::operator=

(

const KisMemoryStorage &

rhs

)

This clones all contained resources and tags from rhs.

Definition at line 116 of file KisMemoryStorage.cpp.

{
    if (this != &rhs) {
        d->resourcesNew = rhs.d->resourcesNew;
 
        Q_FOREACH(const QString &key, rhs.d->tags.keys()) {
            Q_FOREACH(const KisTagSP tag, rhs.d->tags[key]) {
                if (!d->tags.contains(key)) {
                    d->tags[key] = QVector<KisTagSP>();
                }
                d->tags[key] << tag->clone();
            }
        }
    }
    return *this;
}

References d.

resourceItem()

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

overridevirtual

Implements KisStoragePlugin.

Definition at line 166 of file KisMemoryStorage.cpp.

{
    MemoryItem item;
    item.url = url;
    item.folder = QString();
    item.lastModified = QDateTime::fromMSecsSinceEpoch(0);
    return item;
}

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

resourceMd5()

QString KisMemoryStorage::resourceMd5 ( const QString & url )

overridevirtual

Reimplemented from KisStoragePlugin.

Definition at line 321 of file KisMemoryStorage.cpp.

{
    auto parsedUrl = detail::splitResourceUrl(url);
    if (!parsedUrl) return QString();
    auto [resourceType, resourceFilename] = *parsedUrl;
 
    QString result;
 
    if (d->resourcesNew.contains(resourceType) &&
        d->resourcesNew[resourceType].contains(resourceFilename)) {
 
        const StoredResource &storedResource =
            d->resourcesNew[resourceType][resourceFilename];
 
        if (storedResource.data->size() > 0 || storedResource.resource.isNull()) {
            result = KoMD5Generator::generateHash(*storedResource.data);
        } else {
            result = storedResource.resource->md5Sum();
        }
    }
 
    return result;
}

References d, StoredResource::data, KoMD5Generator::generateHash(), StoredResource::resource, and detail::splitResourceUrl().

resources()

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

overridevirtual

Implements KisStoragePlugin.

Definition at line 345 of file KisMemoryStorage.cpp.

{
    QVector<VersionedResourceEntry> entries;
 
 
    QHash<QString, StoredResource> &typedResources =
        d->resourcesNew[resourceType];
 
    for (auto it = typedResources.begin(); it != typedResources.end(); ++it) {
        VersionedResourceEntry entry;
        entry.filename = it.key();
        entry.lastModified = it.value().timestamp;
        entry.tagList = {}; // TODO
        entry.resourceType = resourceType;
        entries.append(entry);
 
    }
 
    KisStorageVersioningHelper::detectFileVersions(entries);
 
    return toQShared(new KisVersionedStorageIterator(entries, this));
}

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

saveAsNewVersion()

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

overridevirtual

Reimplemented from KisStoragePlugin.

Definition at line 133 of file KisMemoryStorage.cpp.

{
    QHash<QString, StoredResource> &typedResources =
        d->resourcesNew[resourceType];
 
    auto checkExists =
        [&typedResources] (const QString &filename) {
            return typedResources.contains(filename);
        };
 
    const QString newFilename =
        KisStorageVersioningHelper::chooseUniqueName(resource, 0, checkExists);
 
    if (newFilename.isEmpty()) return false;
 
    resource->setFilename(newFilename);
 
    StoredResource storedResource;
    storedResource.timestamp = QDateTime::currentDateTime();
    storedResource.data.reset(new QByteArray());
    QBuffer buffer(storedResource.data.data());
    buffer.open(QIODevice::WriteOnly);
    bool result = resource->saveToDevice(&buffer);
    buffer.close();
    if (!result) {
        storedResource.resource = resource;
    }
 
    typedResources.insert(newFilename, storedResource);
 
    return true;
}

References KisStorageVersioningHelper::chooseUniqueName(), d, StoredResource::data, StoredResource::resource, KisStoragePlugin::resource(), and StoredResource::timestamp.

setMetaData()

void KisMemoryStorage::setMetaData ( const QString & key, const QVariant & value )

overridevirtual

Reimplemented from KisStoragePlugin.

Definition at line 373 of file KisMemoryStorage.cpp.

{
    d->metadata[key] = value;
}

References d, and value().

tags()

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

overridevirtual

Implements KisStoragePlugin.

Definition at line 368 of file KisMemoryStorage.cpp.

{
    return QSharedPointer<KisResourceStorage::TagIterator>(new MemoryTagIterator(d->tags[resourceType]));
}

References d.

testingAddTag()

bool KisMemoryStorage::testingAddTag ( const QString & resourceType, KisTagSP tag )

private

Definition at line 292 of file KisMemoryStorage.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_NOOP(resourceType == tag->resourceType());
 
    QVector<KisTagSP> &typedTags = d->tags[resourceType];
 
    auto existingIt = std::find_if(typedTags.begin(), typedTags.end(), kismpl::mem_equal_to(&KisTag::url, tag->url()));
    if (existingIt != typedTags.end()) {
        typedTags.erase(existingIt);
    }
 
    typedTags.append(tag);
 
    return true;
}

References d, KIS_SAFE_ASSERT_RECOVER_NOOP, kismpl::mem_equal_to(), and KisTag::url().

testingRemoveResource()

bool KisMemoryStorage::testingRemoveResource ( const QString & url )

private

Definition at line 279 of file KisMemoryStorage.cpp.

{
    auto parsedUrl = detail::splitResourceUrl(url);
    if (!parsedUrl) return false;
    auto [resourceType, resourceFilename] = *parsedUrl;
 
    if (d->resourcesNew.contains(resourceType)) {
        return d->resourcesNew[resourceType].remove(resourceFilename) > 0;
    }
 
    return false;
}

References d, and detail::splitResourceUrl().

testingRemoveTag()

bool KisMemoryStorage::testingRemoveTag ( const QString & resourceType, const QString & tagUrl )

private

Definition at line 308 of file KisMemoryStorage.cpp.

{
    QVector<KisTagSP> &typedTags = d->tags[resourceType];
 
    auto existingIt = std::find_if(typedTags.begin(), typedTags.end(), kismpl::mem_equal_to(&KisTag::url, tagUrl));
    if (existingIt != typedTags.end()) {
        typedTags.erase(existingIt);
        return true;
    }
 
    return false;
}

References d, kismpl::mem_equal_to(), and KisTag::url().

Friends And Related Symbol Documentation

TestMemoryStorage

friend class TestMemoryStorage

friend

Definition at line 49 of file KisMemoryStorage.h.

TestResourceLocator

friend class TestResourceLocator

friend

Definition at line 50 of file KisMemoryStorage.h.

TestStorageWrapper

friend class TestStorageWrapper

friend

Definition at line 51 of file KisMemoryStorage.h.

Member Data Documentation

d

QScopedPointer<Private> KisMemoryStorage::d

private

Definition at line 58 of file KisMemoryStorage.h.

---

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

• libs/resources/KisMemoryStorage.h
• libs/resources/KisMemoryStorage.cpp