#include <KisResourceStorage.h>

Classes
class	Private

struct	ResourceItem
	A resource item is simply an entry in the storage,. More...

class	ResourceIterator

class	TagIterator

Public Types
enum class	StorageType : int { Unknown = 1 , Folder = 2 , Bundle = 3 , AdobeBrushLibrary = 4 , AdobeStyleLibrary = 5 , Memory = 6 , FontStorage = 7 }

Public Member Functions
bool	addResource (KoResourceSP resource)

bool	addTag (const QString &resourceType, KisTagSP tag)

KisResourceStorageSP	clone () const

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

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

	KisResourceStorage (const KisResourceStorage &rhs)

	KisResourceStorage (const QString &location)

	KisResourceStorage (const QString &location, KisResourceStorage::StorageType storageType)

bool	loadVersionedResource (KoResourceSP resource)
	Reloads the given resource from the persistent storage.

QString	location () const
	The absolute location of the storage.

QVariant	metaData (const QString &key) const

QStringList	metaDataKeys () const

QString	name () const

KisResourceStorage &	operator= (const KisResourceStorage &rhs)

KoResourceSP	resource (const QString &url)
	The loaded resource for an entry in the storage.

QString	resourceFilePath (const QString &url)

ResourceItem	resourceItem (const QString &url)
	And entry in the storage; this is not the loaded resource.

QString	resourceMd5 (const QString &url)
	The MD5 checksum of the resource in the storage.

QSharedPointer< ResourceIterator >	resources (const QString &resourceType) const
	An iterator over all the resources in the storage.

bool	saveAsNewVersion (KoResourceSP resource)
	Creates a new version of the given resource.

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

bool	supportsVersioning () const

QSharedPointer< TagIterator >	tags (const QString &resourceType) const
	An iterator over all the tags in the resource.

QImage	thumbnail () const
	The icond for the storage.

QDateTime	timestamp () const

QDateTime	timeStampForResource (const QString &resourceType, const QString &filename) const

StorageType	type () const
	The type of the storage.

bool	valid () const
	true if the storage exists and can be used

	~KisResourceStorage ()

Static Public Member Functions
static QString	storageTypeToString (StorageType storageType)

static QString	storageTypeToUntranslatedString (StorageType storageType)

Static Public Attributes
static const QString	s_meta_author

static const QString	s_meta_creation_date

static const QString	s_meta_creator

static const QString	s_meta_dc_date

static const QString	s_meta_description

static const QString	s_meta_email

static const QString	s_meta_generator

static const QString	s_meta_initial_creator

static const QString	s_meta_license

static const QString	s_meta_name

static const QString	s_meta_title

static const QString	s_meta_user_defined

static const QString	s_meta_value

static const QString	s_meta_version

static const QString	s_meta_website

static const QString	s_xmlns_dc

static const QString	s_xmlns_meta

Private Member Functions
void	setStorageId (int storageId)

int	storageId ()

KisStoragePlugin *	testingGetStoragePlugin ()

Private Attributes
QScopedPointer< Private >	d

Friends
class	KisResourceCacheDb

class	KisResourceLocator

class	KisStorageModel

class	TestResourceLocator

Detailed Description

The KisResourceStorage class is the base class for places where resources can be stored. Examples are folders, bundles or Adobe resource libraries like ABR files.

Definition at line 51 of file KisResourceStorage.h.

Member Enumeration Documentation

◆ StorageType

enum class KisResourceStorage::StorageType : int

strong

Enumerator
Unknown
Folder
Bundle
AdobeBrushLibrary
AdobeStyleLibrary
Memory
FontStorage

Definition at line 104 of file KisResourceStorage.h.

                           : int {
        Unknown = 1,
        Folder = 2,
        Bundle = 3,
        AdobeBrushLibrary = 4,
        AdobeStyleLibrary = 5,
        Memory = 6,
        FontStorage = 7
    };

Constructor & Destructor Documentation

◆ KisResourceStorage() [1/3]

KisResourceStorage::KisResourceStorage	(	const QString &	location,
		KisResourceStorage::StorageType	storageType )

Definition at line 109 of file KisResourceStorage.cpp.

    : d(new Private())
{
    d->location = location;
 
    auto createMemoryStorage = [this] (const QString &location, bool isValid) {
        d->name = location;
        d->storageType = StorageType::Memory;
        d->storagePlugin.reset(KisStoragePluginRegistry::instance()->m_storageFactoryMap[StorageType::Memory]->create(location));
        d->valid = isValid;
    };
 
    switch (storageType) {
        case StorageType::Folder: {
            QFileInfo fi(d->location);
            if (fi.isDir()) {
                d->name = fi.fileName();
                d->storageType = StorageType::Folder;
                d->storagePlugin.reset(KisStoragePluginRegistry::instance()->m_storageFactoryMap[StorageType::Folder]->create(location));
                d->valid = fi.isWritable();
            } else {
                createMemoryStorage(location, false);
            }
            break;
        }
        case StorageType::Bundle: {
            QFileInfo fi(d->location);
            d->name = fi.fileName();
            d->storageType = StorageType::Bundle;
            d->storagePlugin.reset(KisStoragePluginRegistry::instance()->m_storageFactoryMap[StorageType::Bundle]->create(location));
            // XXX: should we also check whether there's a valid metadata entry? Or is this enough?
            d->valid = (fi.isReadable() && QuaZip(d->location).open(QuaZip::mdUnzip));
            break;
        }
        case StorageType::AdobeBrushLibrary: {
            QFileInfo fi(d->location);
            d->name = fi.fileName();
            d->storageType = StorageType::AdobeBrushLibrary;
            d->storagePlugin.reset(KisStoragePluginRegistry::instance()->m_storageFactoryMap[StorageType::AdobeBrushLibrary]->create(location));
            d->valid = fi.isReadable();
            break;
        }
        case StorageType::AdobeStyleLibrary: {
            QFileInfo fi(d->location);
            d->name = fi.fileName();
            d->storageType = StorageType::AdobeStyleLibrary;
            d->storagePlugin.reset(KisStoragePluginRegistry::instance()->m_storageFactoryMap[StorageType::AdobeStyleLibrary]->create(location));
            d->valid = d->storagePlugin->isValid();
            break;
        }
        case StorageType::Unknown:
            createMemoryStorage(location, false);
            break;
        case StorageType::Memory:
            createMemoryStorage(location, true);
            break;
        case StorageType::FontStorage: {
            auto factory = KisStoragePluginRegistry::instance()->m_storageFactoryMap[StorageType::FontStorage];
            if (factory) {
                d->name = location;
                d->storageType = StorageType::FontStorage;
                d->storagePlugin.reset(factory->create(location));
                d->valid = true;
            } else {
                createMemoryStorage(location, false);
            }
            break;
        }
    }
}

References AdobeBrushLibrary, AdobeStyleLibrary, Bundle, d, Folder, FontStorage, KisStoragePluginRegistry::instance(), location(), KisStoragePluginRegistry::m_storageFactoryMap, Memory, and Unknown.

◆ KisResourceStorage() [2/3]

KisResourceStorage::KisResourceStorage ( const QString & location )

Definition at line 180 of file KisResourceStorage.cpp.

    : KisResourceStorage(location, autoDetectStorageType(location))
{
}

◆ ~KisResourceStorage()

KisResourceStorage::~KisResourceStorage ( )

Definition at line 185 of file KisResourceStorage.cpp.

186{

187}

◆ KisResourceStorage() [3/3]

KisResourceStorage::KisResourceStorage ( const KisResourceStorage & rhs )

Definition at line 189 of file KisResourceStorage.cpp.

    : d(new Private)
{
    *this = rhs;
}

Member Function Documentation

◆ addResource()

bool KisResourceStorage::addResource ( KoResourceSP resource )

Adds the given resource to the storage. If there is already a resource with the given filename of the given type, this should return false and saveAsNewVersion should be used.

Definition at line 295 of file KisResourceStorage.cpp.

{
    if (!resource) return false;
 
    return d->storagePlugin->addResource(resource->resourceType().first, resource);
}

References d, and resource().

◆ addTag()

bool KisResourceStorage::addTag	(	const QString &	resourceType,
		KisTagSP	tag )

Adds a tag to the storage, however, it does not store the links between tags and resources.

◆ clone()

KisResourceStorageSP KisResourceStorage::clone ( ) const

Definition at line 214 of file KisResourceStorage.cpp.

{
    return KisResourceStorageSP(new KisResourceStorage(*this));
}

References KisResourceStorage().

◆ exportResource()

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

Copies the given resource from the storage into device

Parameters

url	is the URL of the resource inside the storage, which is usually resource_type/resource_filename.ext

Definition at line 307 of file KisResourceStorage.cpp.

{
    return d->storagePlugin->exportResource(url, device);
}

References d.

◆ importResource()

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

Copies the given file into this storage. Implementations should not overwrite an existing resource with the same filename, but return false.

Parameters

url	is the URL of the resource inside the storage, which is usually resource_type/resource_filename.ext

Definition at line 302 of file KisResourceStorage.cpp.

{
    return d->storagePlugin->importResource(url, device);
}

References d.

◆ loadVersionedResource()

bool KisResourceStorage::loadVersionedResource ( KoResourceSP resource )

Reloads the given resource from the persistent storage.

Definition at line 317 of file KisResourceStorage.cpp.

{
    return d->storagePlugin->loadVersionedResource(resource);
}

References d, and resource().

◆ location()

QString KisResourceStorage::location ( ) const

The absolute location of the storage.

Definition at line 224 of file KisResourceStorage.cpp.

{
    return d->location;
}

References d.

◆ metaData()

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

Definition at line 337 of file KisResourceStorage.cpp.

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

References d.

◆ metaDataKeys()

QStringList KisResourceStorage::metaDataKeys ( ) const

Definition at line 332 of file KisResourceStorage.cpp.

{
    return d->storagePlugin->metaDataKeys();
}

References d.

◆ name()

QString KisResourceStorage::name ( ) const

The filename of the storage if it's a bundle or Adobe Library. This can also be empty (for the folder storage) or "memory" for the storage for temporary resources, a UUID for storages associated with documents.

Definition at line 219 of file KisResourceStorage.cpp.

{
    return d->name;
}

References d.

◆ operator=()

KisResourceStorage & KisResourceStorage::operator= ( const KisResourceStorage & rhs )

Definition at line 195 of file KisResourceStorage.cpp.

{
    if (this != &rhs) {
        d->name = rhs.d->name;
        d->location = rhs.d->location;
        d->storageType = rhs.d->storageType;
        if (d->storageType == StorageType::Memory) {
            const QSharedPointer<KisMemoryStorage> memoryStorage = rhs.d->storagePlugin.dynamicCast<KisMemoryStorage>();
            KIS_ASSERT(memoryStorage);
            d->storagePlugin = QSharedPointer<KisMemoryStorage>(new KisMemoryStorage(*memoryStorage));
        }
        else {
            d->storagePlugin = rhs.d->storagePlugin;
        }
        d->valid = false;
    }
    return *this;
}

References d, KIS_ASSERT, Memory, and name().

◆ resource()

KoResourceSP KisResourceStorage::resource ( const QString & url )

The loaded resource for an entry in the storage.

Definition at line 263 of file KisResourceStorage.cpp.

{
    return d->storagePlugin->resource(url);
}

References d.

◆ resourceFilePath()

QString KisResourceStorage::resourceFilePath ( const QString & url )

If the resource is present on the filesystem as a distinct fine, returns the full file path of it, otherwise returns an empty string.

Never manipulate the file in any way directly! It will destroy the resources database. Use this file path only for informational purposes.

Definition at line 273 of file KisResourceStorage.cpp.

{
    return d->storagePlugin->resourceFilePath(url);
}

References d.

◆ resourceItem()

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

And entry in the storage; this is not the loaded resource.

Definition at line 258 of file KisResourceStorage.cpp.

{
    return d->storagePlugin->resourceItem(url);
}

References d.

◆ resourceMd5()

QString KisResourceStorage::resourceMd5 ( const QString & url )

The MD5 checksum of the resource in the storage.

Definition at line 268 of file KisResourceStorage.cpp.

{
    return d->storagePlugin->resourceMd5(url);
}

References d.

◆ resources()

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

An iterator over all the resources in the storage.

Definition at line 278 of file KisResourceStorage.cpp.

{
    return d->storagePlugin->resources(resourceType);
}

References d.

◆ saveAsNewVersion()

bool KisResourceStorage::saveAsNewVersion ( KoResourceSP resource )

Creates a new version of the given resource.

Definition at line 288 of file KisResourceStorage.cpp.

{
    if (!resource) return false;
 
    return d->storagePlugin->saveAsNewVersion(resource->resourceType().first, resource);
}

References d, and resource().

◆ setMetaData()

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

Definition at line 322 of file KisResourceStorage.cpp.

{
    d->storagePlugin->setMetaData(key, value);
}

References d, and value().

◆ setStorageId()

void KisResourceStorage::setStorageId ( int storageId )

private

Definition at line 342 of file KisResourceStorage.cpp.

{
    d->storageId = storageId;
}

References d, and storageId().

◆ storageId()

int KisResourceStorage::storageId ( )

private

Definition at line 347 of file KisResourceStorage.cpp.

{
    return d->storageId;
}

References d.

◆ storageTypeToString()

static QString KisResourceStorage::storageTypeToString ( StorageType storageType )

inlinestatic

Definition at line 114 of file KisResourceStorage.h.

                                                                {
        switch (storageType) {
        case StorageType::Unknown:
            return i18n("Unknown");
        case StorageType::Folder:
            return i18n("Folder");
        case StorageType::Bundle:
            return i18n("Bundle");
        case StorageType::AdobeBrushLibrary:
            return i18n("Adobe Brush Library");
        case StorageType::AdobeStyleLibrary:
            return i18n("Adobe Style Library");
        case StorageType::FontStorage:
            return i18n("Font Storage");
        case StorageType::Memory:
            return i18n("Memory");
        default:
            return i18n("Invalid");
        }
    }

◆ storageTypeToUntranslatedString()

static QString KisResourceStorage::storageTypeToUntranslatedString ( StorageType storageType )

inlinestatic

Definition at line 136 of file KisResourceStorage.h.

                                                                            {
        switch (storageType) {
        case StorageType::Unknown:
            return ("Unknown");
        case StorageType::Folder:
            return ("Folder");
        case StorageType::Bundle:
            return ("Bundle");
        case StorageType::AdobeBrushLibrary:
            return ("Adobe Brush Library");
        case StorageType::AdobeStyleLibrary:
            return ("Adobe Style Library");
        case StorageType::FontStorage:
            return ("Font Storage");
        case StorageType::Memory:
            return ("Memory");
        default:
            return ("Invalid");
        }
    }

◆ supportsVersioning()

bool KisResourceStorage::supportsVersioning ( ) const

Returns true if the storage supports versioning of the resources. It enables loadVersionedResource() call.

Definition at line 312 of file KisResourceStorage.cpp.

{
    return d->storagePlugin->supportsVersioning();
}

References d.

◆ tags()

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

An iterator over all the tags in the resource.

Definition at line 283 of file KisResourceStorage.cpp.

{
    return d->storagePlugin->tags(resourceType);
}

References d.

◆ testingGetStoragePlugin()

KisStoragePlugin * KisResourceStorage::testingGetStoragePlugin ( )

private

Definition at line 352 of file KisResourceStorage.cpp.

{
    return d->storagePlugin.data();
}

References d.

◆ thumbnail()

QImage KisResourceStorage::thumbnail ( ) const

The icond for the storage.

Definition at line 234 of file KisResourceStorage.cpp.

{
    return d->storagePlugin->thumbnail();
}

References d.

◆ timestamp()

QDateTime KisResourceStorage::timestamp ( ) const

The time and date when the storage was last modified, or created for memory storages.

Definition at line 239 of file KisResourceStorage.cpp.

{
    return d->storagePlugin->timestamp();
}

References d.

◆ timeStampForResource()

QDateTime KisResourceStorage::timeStampForResource	(	const QString &	resourceType,
		const QString &	filename ) const

The time and date when the resource was last modified For filestorage

Definition at line 244 of file KisResourceStorage.cpp.

{
    QFileInfo li(d->location);
    if (li.suffix().toLower() == "bundle") {
        QFileInfo bf(d->location + "_modified/" + resourceType + "/" + filename);
        if (bf.exists()) {
            return bf.lastModified();
        }
    } else if (QFileInfo(d->location + "/" + resourceType + "/" + filename).exists()) {
        return QFileInfo(d->location + "/" + resourceType + "/" + filename).lastModified();
    }
    return this->timestamp();
}

References d, and timestamp().

◆ type()

KisResourceStorage::StorageType KisResourceStorage::type ( ) const

The type of the storage.

Definition at line 229 of file KisResourceStorage.cpp.

{
    return d->storageType;
}

References d.

◆ valid()

bool KisResourceStorage::valid ( ) const

true if the storage exists and can be used

Definition at line 327 of file KisResourceStorage.cpp.

{
    return d->valid;
}

References d.

Friends And Related Symbol Documentation

◆ KisResourceCacheDb

friend class KisResourceCacheDb

friend

Definition at line 275 of file KisResourceStorage.h.

◆ KisResourceLocator

friend class KisResourceLocator

friend

Definition at line 274 of file KisResourceStorage.h.

◆ KisStorageModel

friend class KisStorageModel

friend

Definition at line 273 of file KisResourceStorage.h.

◆ TestResourceLocator

friend class TestResourceLocator

friend

Definition at line 276 of file KisResourceStorage.h.

Member Data Documentation

◆ d

QScopedPointer<Private> KisResourceStorage::d

private

Definition at line 284 of file KisResourceStorage.h.

◆ s_meta_author

const QString KisResourceStorage::s_meta_author

static

Definition at line 252 of file KisResourceStorage.h.

◆ s_meta_creation_date

const QString KisResourceStorage::s_meta_creation_date

static

Definition at line 257 of file KisResourceStorage.h.

◆ s_meta_creator

const QString KisResourceStorage::s_meta_creator

static

Definition at line 256 of file KisResourceStorage.h.

◆ s_meta_dc_date

const QString KisResourceStorage::s_meta_dc_date

static

Definition at line 258 of file KisResourceStorage.h.

◆ s_meta_description

const QString KisResourceStorage::s_meta_description

static

Definition at line 254 of file KisResourceStorage.h.

◆ s_meta_email

const QString KisResourceStorage::s_meta_email

static

Definition at line 264 of file KisResourceStorage.h.

◆ s_meta_generator

const QString KisResourceStorage::s_meta_generator

static

Definition at line 251 of file KisResourceStorage.h.

◆ s_meta_initial_creator

const QString KisResourceStorage::s_meta_initial_creator

static

Definition at line 255 of file KisResourceStorage.h.

◆ s_meta_license

const QString KisResourceStorage::s_meta_license

static

Definition at line 263 of file KisResourceStorage.h.

◆ s_meta_name

const QString KisResourceStorage::s_meta_name

static

Definition at line 260 of file KisResourceStorage.h.

◆ s_meta_title

const QString KisResourceStorage::s_meta_title

static

Definition at line 253 of file KisResourceStorage.h.

◆ s_meta_user_defined

const QString KisResourceStorage::s_meta_user_defined

static

Definition at line 259 of file KisResourceStorage.h.

◆ s_meta_value

const QString KisResourceStorage::s_meta_value

static

Definition at line 261 of file KisResourceStorage.h.

◆ s_meta_version

const QString KisResourceStorage::s_meta_version

static

Definition at line 262 of file KisResourceStorage.h.

◆ s_meta_website

const QString KisResourceStorage::s_meta_website

static

Definition at line 265 of file KisResourceStorage.h.

◆ s_xmlns_dc

const QString KisResourceStorage::s_xmlns_dc

static

Definition at line 249 of file KisResourceStorage.h.

◆ s_xmlns_meta

const QString KisResourceStorage::s_xmlns_meta

static

Definition at line 248 of file KisResourceStorage.h.

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

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ StorageType

Constructor & Destructor Documentation

◆ KisResourceStorage() [1/3]

◆ KisResourceStorage() [2/3]

◆ ~KisResourceStorage()

◆ KisResourceStorage() [3/3]

Member Function Documentation

◆ addResource()

◆ addTag()

◆ clone()

◆ exportResource()

◆ importResource()

◆ loadVersionedResource()

◆ location()

◆ metaData()

◆ metaDataKeys()

◆ name()

◆ operator=()

◆ resource()

◆ resourceFilePath()

◆ resourceItem()

◆ resourceMd5()

◆ resources()

◆ saveAsNewVersion()

◆ setMetaData()

◆ setStorageId()

◆ storageId()

◆ storageTypeToString()

◆ storageTypeToUntranslatedString()

◆ supportsVersioning()

◆ tags()

◆ testingGetStoragePlugin()

◆ thumbnail()

◆ timestamp()

◆ timeStampForResource()

◆ type()

◆ valid()

Friends And Related Symbol Documentation

◆ KisResourceCacheDb

◆ KisResourceLocator

◆ KisStorageModel

◆ TestResourceLocator

Member Data Documentation

◆ d

◆ s_meta_author

◆ s_meta_creation_date

◆ s_meta_creator

◆ s_meta_dc_date

◆ s_meta_description

◆ s_meta_email

◆ s_meta_generator

◆ s_meta_initial_creator

◆ s_meta_license

◆ s_meta_name

◆ s_meta_title

◆ s_meta_user_defined

◆ s_meta_value

◆ s_meta_version

◆ s_meta_website

◆ s_xmlns_dc

◆ s_xmlns_meta