KisStoragePlugin Class Reference

#include <KisStoragePlugin.h>

Inheritance diagram for KisStoragePlugin:

Classes
class	Private

Public Member Functions
virtual bool	addResource (const QString &resourceType, KoResourceSP resource)
virtual bool	exportResource (const QString &url, QIODevice *device)
virtual bool	importResource (const QString &url, QIODevice *device)
virtual bool	isValid () const
	KisStoragePlugin (const QString &location)
virtual bool	loadVersionedResource (KoResourceSP resource)=0
virtual QVariant	metaData (const QString &key) const
virtual QStringList	metaDataKeys () const
virtual KoResourceSP	resource (const QString &url)
virtual QString	resourceFilePath (const QString &url)
virtual KisResourceStorage::ResourceItem	resourceItem (const QString &url)=0
virtual QString	resourceMd5 (const QString &url)
virtual QSharedPointer< KisResourceStorage::ResourceIterator >	resources (const QString &resourceType)=0
virtual bool	saveAsNewVersion (const QString &resourceType, KoResourceSP resource)
virtual void	setMetaData (const QString &key, const QVariant &value)
virtual bool	supportsVersioning () const
virtual QSharedPointer< KisResourceStorage::TagIterator >	tags (const QString &resourceType)=0
virtual QImage	thumbnail () const
QDateTime	timestamp ()
virtual	~KisStoragePlugin ()

Protected Member Functions
QString	location () const
void	sanitizeResourceFileNameCase (KoResourceSP resource, const QDir &parentDir)

Private Attributes
QScopedPointer< Private >	d

Friends
class	TestBundleStorage

Detailed Description

The KisStoragePlugin class is the base class for storage plugins. A storage plugin is used by KisResourceStorage to locate resources and tags in a kind of storage, like a folder, a bundle or an adobe resource library.

Definition at line 25 of file KisStoragePlugin.h.

Constructor & Destructor Documentation

KisStoragePlugin()

KisStoragePlugin::KisStoragePlugin

(

const QString &

location

)

Definition at line 22 of file KisStoragePlugin.cpp.

    : d(new Private())
{
    d->location = location;
 
    if (!QFileInfo(d->location).exists()) {
        d->timestamp = QDateTime::currentDateTime();
    }
}

References d, and location().

~KisStoragePlugin()

KisStoragePlugin::~KisStoragePlugin ( )

virtual

Definition at line 32 of file KisStoragePlugin.cpp.

{
}

Member Function Documentation

addResource()

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

inlinevirtual

Reimplemented in KisAslStorage, KisFolderStorage, and KisMemoryStorage.

Definition at line 46 of file KisStoragePlugin.h.

{Q_UNUSED(resourceType); Q_UNUSED(resource); return false;}

exportResource()

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

inlinevirtual

Reimplemented in KisBundleStorage, KisFolderStorage, and KisMemoryStorage.

Definition at line 45 of file KisStoragePlugin.h.

{Q_UNUSED(url); Q_UNUSED(device); return false;}

importResource()

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

inlinevirtual

Reimplemented in KisFolderStorage, and KisMemoryStorage.

Definition at line 44 of file KisStoragePlugin.h.

{Q_UNUSED(url); Q_UNUSED(device); return false;}

isValid()

bool KisStoragePlugin::isValid ( ) const

virtual

Reimplemented in KoFontStorage, and KisAslStorage.

Definition at line 108 of file KisStoragePlugin.cpp.

{
    qWarning() << "Storage plugins should implement their own checks!";
    return true;
}

loadVersionedResource()

virtual bool KisStoragePlugin::loadVersionedResource ( KoResourceSP resource )

pure virtual

Implemented in KisAbrStorage, KoFontStorage, KisAslStorage, KisBundleStorage, KisFolderStorage, and KisMemoryStorage.

location()

QString KisStoragePlugin::location ( ) const

protected

Definition at line 91 of file KisStoragePlugin.cpp.

{
    return d->location;
}

References d.

metaData()

virtual QVariant KisStoragePlugin::metaData ( const QString & key ) const

inlinevirtual

Reimplemented in KisBundleStorage, KisFolderStorage, and KisMemoryStorage.

Definition at line 51 of file KisStoragePlugin.h.

{ Q_UNUSED(key); return QString(); }

metaDataKeys()

virtual QStringList KisStoragePlugin::metaDataKeys ( ) const

inlinevirtual

Reimplemented in KisBundleStorage, KisFolderStorage, and KisMemoryStorage.

Definition at line 50 of file KisStoragePlugin.h.

{ return QStringList(); }

resource()

KoResourceSP KisStoragePlugin::resource ( const QString & url )

virtual

Retrieve the given resource. The url is the unique identifier of the resource, for instance resourcetype plus filename.

Reimplemented in KisAbrStorage, KoFontStorage, and KisAslStorage.

Definition at line 36 of file KisStoragePlugin.cpp.

{
    if (!url.contains('/')) return nullptr;
 
    QStringList parts = url.split('/', Qt::SkipEmptyParts);
 
    if (parts.isEmpty()) return nullptr;
 
    const QString resourceType = parts[0];
    parts.removeFirst();
    const QString resourceFilename = parts.join('/');
 
    const QString mime = KisMimeDatabase::mimeTypeForSuffix(resourceFilename);
 
    KisResourceLoaderBase *loader = KisResourceLoaderRegistry::instance()->loader(resourceType, mime);
    if (!loader) {
        qWarning() << "Could not create loader for" << resourceType << resourceFilename << mime;
        return nullptr;
    }
 
    KoResourceSP resource = loader->create(resourceFilename);
    return loadVersionedResource(resource) ? resource : nullptr;
}

References KisResourceLoaderBase::create(), KisResourceLoaderRegistry::instance(), KisResourceLoaderRegistry::loader(), loadVersionedResource(), KisMimeDatabase::mimeTypeForSuffix(), and resource().

resourceFilePath()

QString KisStoragePlugin::resourceFilePath ( const QString & url )

virtual

Reimplemented in KisFolderStorage.

Definition at line 72 of file KisStoragePlugin.cpp.

{
    Q_UNUSED(url);
    return QString();
}

resourceItem()

virtual KisResourceStorage::ResourceItem KisStoragePlugin::resourceItem ( const QString & url )

pure virtual

Implemented in KisAbrStorage, KoFontStorage, KisAslStorage, KisBundleStorage, KisFolderStorage, and KisMemoryStorage.

resourceMd5()

QString KisStoragePlugin::resourceMd5 ( const QString & url )

virtual

Reimplemented in KisBundleStorage, KisFolderStorage, and KisMemoryStorage.

Definition at line 60 of file KisStoragePlugin.cpp.

{
    // a fallback implementation for the storages with
    // ephemeral resources
    KoResourceSP res = resource(url);
    if (res) {
        return res->md5Sum();
    } else {
        return QString();
    }
}

References resource().

resources()

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

pure virtual

Implemented in KisAbrStorage, KoFontStorage, KisAslStorage, KisBundleStorage, KisFolderStorage, and KisMemoryStorage.

sanitizeResourceFileNameCase()

void KisStoragePlugin::sanitizeResourceFileNameCase ( KoResourceSP resource, const QDir & parentDir )

protected

On some systems, e.g. Windows, the file names are case-insensitive, therefore URLs will fetch the resource even when the casing is not the same. The storage, when returning such a resource should make sure that its filename is set to the real filename, not the one with incorrect casing.

Definition at line 96 of file KisStoragePlugin.cpp.

{
    const QStringList result = parentDir.entryList({resource->filename()});
 
    if (result.size() == 1) {
        const QString realName = result.first();
        if (realName != resource->filename()) {
            resource->setFilename(result.first());
        }
    }
}

References resource().

saveAsNewVersion()

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

inlinevirtual

Reimplemented in KisAslStorage, KisBundleStorage, KisFolderStorage, and KisMemoryStorage.

Definition at line 43 of file KisStoragePlugin.h.

{Q_UNUSED(resourceType); Q_UNUSED(resource); return false;}

setMetaData()

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

inlinevirtual

Reimplemented in KisMemoryStorage.

Definition at line 49 of file KisStoragePlugin.h.

{Q_UNUSED(key); Q_UNUSED(value);}

References value().

supportsVersioning()

bool KisStoragePlugin::supportsVersioning ( ) const

virtual

Reimplemented in KisAbrStorage, KoFontStorage, and KisAslStorage.

Definition at line 78 of file KisStoragePlugin.cpp.

{
    return true;
}

tags()

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

pure virtual

Implemented in KisAbrStorage, KoFontStorage, KisAslStorage, KisBundleStorage, KisFolderStorage, and KisMemoryStorage.

thumbnail()

virtual QImage KisStoragePlugin::thumbnail ( ) const

inlinevirtual

Reimplemented in KisAbrStorage, and KisBundleStorage.

Definition at line 47 of file KisStoragePlugin.h.

{ return QImage(); }

timestamp()

QDateTime KisStoragePlugin::timestamp

(

)

Definition at line 83 of file KisStoragePlugin.cpp.

{
    if (d->timestamp.isNull()) {
        return QFileInfo(d->location).lastModified();
    }
    return d->timestamp;
}

References d.

Friends And Related Symbol Documentation

TestBundleStorage

friend class TestBundleStorage

friend

Definition at line 58 of file KisStoragePlugin.h.

Member Data Documentation

d

QScopedPointer<Private> KisStoragePlugin::d

private

Definition at line 72 of file KisStoragePlugin.h.

---

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

• libs/resources/KisStoragePlugin.h
• libs/resources/KisStoragePlugin.cpp