KisResourceModel Class Reference

The KisResourceModel class provides the main access to resources. It is possible to filter the resources returned by the active status flag of the resources and the storages. More...

#include <KisResourceModel.h>

Inheritance diagram for KisResourceModel:

Classes
struct	Private

Public Member Functions
bool	addResource (KoResourceSP resource, const QString &storageId=QString("")) override
	addResource adds the given resource to the database and storage. If the resource already exists in the given storage with md5, filename or name, the existing resource will be updated instead. If the existing resource was inactive, it will be active (undeleted).
bool	addResourceDeduplicateFileName (KoResourceSP resource, const QString &storageId=QString("")) override
	addResource adds the given resource to the database and storage. If the resource already exists in the given storage with the same filename, the resource will be renamed.
bool	exportResource (KoResourceSP resource, QIODevice *device) override
	exportResource exports a resource into a QIODevice
KoResourceSP	importResource (const QString &filename, QIODevice *device, const bool allowOverwrite, const QString &storageId=QString("")) override
	importResource imports a resource from a QIODevice
KoResourceSP	importResourceFile (const QString &filename, const bool allowOverwrite, const QString &storageId=QString("")) override
	importResourceFile
bool	importWillOverwriteResource (const QString &fileName, const QString &storageLocation=QString()) const override
	importWillOverwriteResource checks is importing a resource with this filename will overwrite anything
QModelIndex	indexForResource (KoResourceSP resource) const override
	indexFromResource
QModelIndex	indexForResourceId (int resourceId) const override
	indexFromResource
	KisResourceModel (const QString &type, QObject *parent=0)
bool	reloadResource (KoResourceSP resource) override
	reloadResource
bool	renameResource (KoResourceSP resource, const QString &name) override
	renameResource name the given resource. The resource will have its name field reset, will be saved to the storage and there will be a new version created in the database.
KoResourceSP	resourceForId (int id) const
KoResourceSP	resourceForIndex (QModelIndex index=QModelIndex()) const override
	resourceForIndex returns a properly versioned and id'ed resource object
QVector< KoResourceSP >	resourcesForFilename (QString fileName) const
QVector< KoResourceSP >	resourcesForMD5 (const QString md5sum) const
QVector< KoResourceSP >	resourcesForName (QString name) const
bool	setResourceActive (const QModelIndex &index, bool value) override
	setResourceActive changes 'active' state of the resource
void	setResourceFilter (ResourceFilter filter) override
bool	setResourceMetaData (KoResourceSP resource, QMap< QString, QVariant > metadata) override
	setResourceMetaData
void	setStorageFilter (StorageFilter filter) override
void	showOnlyUntaggedResources (bool showOnlyUntagged)
QVector< KisTagSP >	tagsForResource (int resourceId) const
bool	updateResource (KoResourceSP resource) override
	updateResource creates a new version of the resource in the storage and in the database. This will also set the resource to active if it was inactive.
	~KisResourceModel () override
Public Member Functions inherited from KisAbstractResourceModel
bool	setResourceInactive (const QModelIndex &index)
virtual	~KisAbstractResourceModel ()
Public Member Functions inherited from KisAbstractResourceFilterInterface
virtual	~KisAbstractResourceFilterInterface ()

Protected Member Functions
bool	filterAcceptsColumn (int source_column, const QModelIndex &source_parent) const override
bool	filterAcceptsRow (int source_row, const QModelIndex &source_parent) const override
bool	lessThan (const QModelIndex &source_left, const QModelIndex &source_right) const override

Private Member Functions
QVector< KoResourceSP >	filterByColumn (const QString filter, KisAllResourcesModel::Columns column) const
bool	filterResource (const QModelIndex &idx) const

Private Attributes
Private *const	d

Additional Inherited Members
Public Types inherited from KisAbstractResourceModel
enum	Columns {   Id = 0 , StorageId , Name , Filename ,   Tooltip , Thumbnail , Status , Location ,   ResourceType , Tags , MD5 , LargeThumbnail ,   Dirty , MetaData , ResourceActive , StorageActive ,   BrokenStatus , BrokenStatusMessage }
	The Columns enum indexes the columns in the model. To get the thumbnail for a particular resource, create the index with QModelIndex(row, Thumbnail). More...
Public Types inherited from KisAbstractResourceFilterInterface
enum	ResourceFilter { ShowInactiveResources = 0 , ShowActiveResources , ShowAllResources }
enum	StorageFilter { ShowInactiveStorages = 0 , ShowActiveStorages , ShowAllStorages }

Detailed Description

The KisResourceModel class provides the main access to resources. It is possible to filter the resources returned by the active status flag of the resources and the storages.

Definition at line 381 of file KisResourceModel.h.

Constructor & Destructor Documentation

KisResourceModel()

KisResourceModel::KisResourceModel	(	const QString &	type,
		QObject *	parent = 0 )

Definition at line 807 of file KisResourceModel.cpp.

    : QSortFilterProxyModel(parent)
    , d(new Private)
{
    setSourceModel(KisResourceModelProvider::resourceModel(type));
}

References KisResourceModelProvider::resourceModel().

~KisResourceModel()

KisResourceModel::~KisResourceModel ( )

override

Definition at line 814 of file KisResourceModel.cpp.

{
    delete d;
}

References d.

Member Function Documentation

addResource()

bool KisResourceModel::addResource ( KoResourceSP resource, const QString & storageId = QString("") )

overridevirtual

addResource adds the given resource to the database and storage. If the resource already exists in the given storage with md5, filename or name, the existing resource will be updated instead. If the existing resource was inactive, it will be active (undeleted).

Parameters

resource	the resource itself
storageId	the id of the storage (could be "memory" for temporary resources, the document's storage id for document storages or empty to save to the default resources folder

Returns

true if adding the resource succeeded.

Implements KisAbstractResourceModel.

Definition at line 915 of file KisResourceModel.cpp.

{
    KisAllResourcesModel *source = qobject_cast<KisAllResourcesModel*>(sourceModel());
    bool updateInsteadOfAdd = false;
    bool result = false;
 
    // Check whether the resource already existed, in that case, we will update
    // and possibly reactivate the resource
    QSqlQuery q;
 
    if (!q.prepare("SELECT resources.id\n"
                   ",      resources.md5sum\n"
                   ",      storages.location\n"
                   ",      resource_types.name\n"
                   "FROM   resources\n"
                   ",      storages\n"
                   ",      resource_types\n"
                   "WHERE  resources.name             = :name\n"
                   "AND    resources.storage_id       = storages.id\n"
                   "AND    resources.resource_type_id = resource_types.id\n"
                   "AND    resources.status           = 0")) {
        qWarning() << "Could not create KisResourceModel::addResource query" << q.lastError();
    }
 
    q.bindValue(":name", resource->name());
 
    if (!q.exec()) {
        qWarning() << "Could not execute KisResourceModel::addResource query" << q.lastError();
    }
 
    while (q.next()) {
        int id = q.value(0).toInt();
        QString md5sum = q.value(1).toString();
        QString storageLocation = q.value(2).toString();
        QString resourceType = q.value(3).toString();
 
 
        QSqlQuery q2;
 
        if (!q2.prepare("SELECT MAX(version)\n"
                       "FROM   versioned_resources\n"
                       "WHERE  resource_id = :id")) {
            qWarning() << "Could not prepare versioned_resources query" << q.lastError();
        }
 
        q2.bindValue(":id", id);
 
        if (!q2.exec()) {
            qWarning() << "Could not execute versioned_resources query" << q.lastError();
        }
 
        if (!q2.first()) {
            qWarning() << "No resource version found with id" << id;
        }
 
        q.first();
 
        int version = q2.value(0).toInt();
 
        if (resourceType == resource->resourceType().first) {
            resource->setResourceId(id);
            resource->setVersion(version);
            resource->setMD5Sum(md5sum);
            resource->setActive(true);
            resource->setStorageLocation(storageLocation);
            bool result = updateResource(resource);
            updateInsteadOfAdd = result;
            break;
        }
    }
 
    if (!updateInsteadOfAdd) {
        result = source->addResource(resource, storageId);
    }
 
    if (result) {
        invalidate();
    }
 
    return result;
}

References q2, source(), and updateResource().

addResourceDeduplicateFileName()

bool KisResourceModel::addResourceDeduplicateFileName ( KoResourceSP resource, const QString & storageId = QString("") )

overridevirtual

addResource adds the given resource to the database and storage. If the resource already exists in the given storage with the same filename, the resource will be renamed.

Parameters

resource	the resource itself
storageId	the id of the storage (could be "memory" for temporary resources, the document's storage id for document storages or empty to save to the default resources folder

Returns

true if adding the resource succeeded.

Implements KisAbstractResourceModel.

Definition at line 997 of file KisResourceModel.cpp.

{
    KisAllResourcesModel *source = qobject_cast<KisAllResourcesModel*>(sourceModel());
 
    const bool result = source->addResourceDeduplicateFileName(resource, storageId);
 
    if (result) {
        invalidate();
    }
 
    return result;
}

References source().

exportResource()

bool KisResourceModel::exportResource ( KoResourceSP resource, QIODevice * device )

overridevirtual

exportResource exports a resource into a QIODevice

Exporting a resource as a binary blob is the only way to guarantee that its MD5 checksum is kept persistent. The underlying storage will just copy bytes into the device without doing any conversions

Parameters

resource	the resource to be exported
device	device where the resource should be written to

Returns

true if export operation has been successful

Implements KisAbstractResourceModel.

Definition at line 905 of file KisResourceModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    bool res = false;
    if (source) {
        res = source->exportResource(resource, device);
    }
    return res;
}

References source().

filterAcceptsColumn()

bool KisResourceModel::filterAcceptsColumn ( int source_column, const QModelIndex & source_parent ) const

overrideprotected

Definition at line 1046 of file KisResourceModel.cpp.

{
    return true;
}

filterAcceptsRow()

bool KisResourceModel::filterAcceptsRow ( int source_row, const QModelIndex & source_parent ) const

overrideprotected

Definition at line 1051 of file KisResourceModel.cpp.

{
    QModelIndex idx = sourceModel()->index(source_row, 0, source_parent);
 
    if (idx.isValid()) {
        int id = idx.data(Qt::UserRole + KisAbstractResourceModel::Id).toInt();
 
        if (d->showOnlyUntaggedResources) {
 
            QString queryString = ("SELECT COUNT(*)\n"
                                   "FROM   resources\n"
                                   ",      storages\n"
                                   "WHERE  resources.id IN (select resource_id FROM resource_tags WHERE active = 1)\n"
                                   "AND    storages.id  = resources.storage_id\n"
                                   "AND    resources.id = :resource_id\n");
 
            if (d->resourceFilter == ShowActiveResources) {
                queryString.append("AND    resources.status > 0\n");
            }
            else if (d->resourceFilter == ShowInactiveResources) {
                queryString.append("AND    resources.status = 0\n");
            }
 
            if (d->storageFilter == ShowActiveStorages) {
                queryString.append("AND    storages.active > 0\n");
            }
            else if (d->storageFilter == ShowInactiveStorages) {
                queryString.append("AND    storages.active = 0\n");
            }
 
            QSqlQuery q;
 
            if (!q.prepare((queryString))) {
                qWarning() << "KisResourceModel: Could not prepare resource_tags query" << q.lastError();
            }
 
            q.bindValue(":resource_id", id);
 
            if (!q.exec()) {
                qWarning() << "KisResourceModel: Could not execute resource_tags query" << q.lastError() << q.boundValues();
            }
 
            q.first();
            if (q.value(0).toInt() > 0) {
                return false;
            }
        }
    }
 
    return filterResource(idx);
}

References d, filterResource(), KisAbstractResourceModel::Id, KisResourceModel::Private::resourceFilter, KisAbstractResourceFilterInterface::ShowActiveResources, KisAbstractResourceFilterInterface::ShowActiveStorages, KisAbstractResourceFilterInterface::ShowInactiveResources, KisAbstractResourceFilterInterface::ShowInactiveStorages, KisResourceModel::Private::showOnlyUntaggedResources, and KisResourceModel::Private::storageFilter.

filterByColumn()

QVector< KoResourceSP > KisResourceModel::filterByColumn ( const QString filter, KisAllResourcesModel::Columns column ) const

private

Definition at line 1111 of file KisResourceModel.cpp.

{
    QVector<KoResourceSP> resources;
    for (int i = 0; i < rowCount(); ++i) {
        QModelIndex idx = index(i, 0);
        if (idx.isValid() && data(idx, Qt::UserRole + column).toString() == filter) {
            resources << resourceForIndex(idx);
        }
    }
 
    return resources;
}

References resourceForIndex().

filterResource()

bool KisResourceModel::filterResource ( const QModelIndex & idx ) const

private

Definition at line 1124 of file KisResourceModel.cpp.

{
    if (d->resourceFilter == ShowAllResources && d->storageFilter == ShowAllStorages) {
        return true;
    }
 
    ResourceFilter resourceActive = (ResourceFilter)sourceModel()->data(idx, Qt::UserRole + KisAbstractResourceModel::ResourceActive).toInt();
    StorageFilter storageActive =  (StorageFilter)sourceModel()->data(idx, Qt::UserRole + KisAbstractResourceModel::StorageActive).toInt();
 
    if (d->resourceFilter == ShowAllResources) {
        if (storageActive == d->storageFilter) {
            return true;
        }
    }
 
    if (d->storageFilter == ShowAllStorages) {
        if (resourceActive == d->resourceFilter) {
            return true;
        }
    }
 
    if ((storageActive == d->storageFilter) && (resourceActive == d->resourceFilter)) {
        return true;
    }
 
    return false;
}

References d, KisAbstractResourceModel::ResourceActive, KisResourceModel::Private::resourceFilter, KisAbstractResourceFilterInterface::ShowAllResources, KisAbstractResourceFilterInterface::ShowAllStorages, KisAbstractResourceModel::StorageActive, and KisResourceModel::Private::storageFilter.

importResource()

KoResourceSP KisResourceModel::importResource ( const QString & filename, QIODevice * device, const bool allowOverwrite, const QString & storageId = QString("") )

overridevirtual

importResource imports a resource from a QIODevice

Importing a resource from a binary blob is the only way to guarantee that its MD5 checksum is kept persistent. The underlying storage will just copy bytes into its location.

Parameters

filename	file name of the resource if preset. File name may be used for addressing the resource, so it is usually preferred to preserve it.
device	device where the resource should be read from

Returns

the loaded resource object

Implements KisAbstractResourceModel.

Definition at line 888 of file KisResourceModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    KoResourceSP res;
    if (source) {
        res = source->importResource(filename, device, allowOverwrite, storageId);
    }
    invalidate();
    return res;
}

References source().

importResourceFile()

KoResourceSP KisResourceModel::importResourceFile ( const QString & filename, const bool allowOverwrite, const QString & storageId = QString("") )

overridevirtual

importResourceFile

Parameters

filename

Returns

Implements KisAbstractResourceModel.

Definition at line 877 of file KisResourceModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    KoResourceSP res;
    if (source) {
        res = source->importResourceFile(filename, allowOverwrite, storageId);
    }
    invalidate();
    return res;
}

References source().

importWillOverwriteResource()

bool KisResourceModel::importWillOverwriteResource ( const QString & fileName, const QString & storageLocation = QString() ) const

overridevirtual

importWillOverwriteResource checks is importing a resource with this filename will overwrite anything

If this function returns true, then importResource() is guaranteed to fail with 'allowOverwrite' set to false.

Parameters

filename

file name of the resource if preset. File name may be used for addressing the resource, so it is usually preferred to preserve it.

Returns

true if the some existing will be overwritten while importing

Implements KisAbstractResourceModel.

Definition at line 899 of file KisResourceModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    return source && source->importWillOverwriteResource(fileName, storageLocation);
}

References source().

indexForResource()

QModelIndex KisResourceModel::indexForResource ( KoResourceSP resource ) const

overridevirtual

indexFromResource

Parameters

resource

Returns

Implements KisAbstractResourceModel.

Definition at line 850 of file KisResourceModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    if (source) {
        return mapFromSource(source->indexForResource(resource));
    }
    return QModelIndex();
}

References source().

indexForResourceId()

QModelIndex KisResourceModel::indexForResourceId ( int resourceId ) const

overridevirtual

indexFromResource

Parameters

resourceId

resource id for which we want to get an index

Returns

Implements KisAbstractResourceModel.

Definition at line 859 of file KisResourceModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    if (source) {
        return mapFromSource(source->indexForResourceId(resourceId));
    }
    return QModelIndex();
}

References source().

lessThan()

bool KisResourceModel::lessThan ( const QModelIndex & source_left, const QModelIndex & source_right ) const

overrideprotected

Definition at line 1103 of file KisResourceModel.cpp.

{
    QString nameLeft = sourceModel()->data(source_left, Qt::UserRole + KisAbstractResourceModel::Name).toString();
    QString nameRight = sourceModel()->data(source_right, Qt::UserRole + KisAbstractResourceModel::Name).toString();
 
    return nameLeft.toLower() < nameRight.toLower();
}

References KisAbstractResourceModel::Name.

reloadResource()

bool KisResourceModel::reloadResource ( KoResourceSP resource )

overridevirtual

reloadResource

Parameters

resource

Returns

Implements KisAbstractResourceModel.

Definition at line 1019 of file KisResourceModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    if (source) {
        return source->reloadResource(resource);
    }
    return false;
}

References source().

renameResource()

bool KisResourceModel::renameResource ( KoResourceSP resource, const QString & name )

overridevirtual

renameResource name the given resource. The resource will have its name field reset, will be saved to the storage and there will be a new version created in the database.

Parameters

resource	The resource to rename
name	The new name

Returns

true if the operation succeeded.

Implements KisAbstractResourceModel.

Definition at line 1028 of file KisResourceModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    if (source) {
        return source->renameResource(resource, name);
    }
    return false;
}

References source().

resourceForId()

KoResourceSP KisResourceModel::resourceForId

(

int

id

)

const

Definition at line 1153 of file KisResourceModel.cpp.

{
    KoResourceSP res = static_cast<KisAllResourcesModel*>(sourceModel())->resourceForId(id);
    QModelIndex idx = indexForResource(res);
    if (idx.isValid()) {
        return res;
    }
    return 0;
}

References indexForResource(), and resourceForId().

resourceForIndex()

KoResourceSP KisResourceModel::resourceForIndex ( QModelIndex index = QModelIndex() ) const

overridevirtual

resourceForIndex returns a properly versioned and id'ed resource object

Implements KisAbstractResourceModel.

Definition at line 841 of file KisResourceModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    if (source) {
        return source->resourceForIndex(mapToSource(index));
    }
    return 0;
}

References source().

resourcesForFilename()

QVector< KoResourceSP > KisResourceModel::resourcesForFilename

(

QString

fileName

)

const

resourceForFilename returns the resources with the given filename that fit the current filters. Note that the filename does not include a path to the storage.

Returns

a resource if one is found, or 0 if none are found

Definition at line 1163 of file KisResourceModel.cpp.

{
    return filterByColumn(filename, KisAllResourcesModel::Filename);
 
}

References KisAbstractResourceModel::Filename, and filterByColumn().

resourcesForMD5()

QVector< KoResourceSP > KisResourceModel::resourcesForMD5

(

const QString

md5sum

)

const

Definition at line 1174 of file KisResourceModel.cpp.

{
    return filterByColumn(md5sum, KisAllResourcesModel::MD5);
}

References filterByColumn(), and KisAbstractResourceModel::MD5.

resourcesForName()

QVector< KoResourceSP > KisResourceModel::resourcesForName

(

QString

name

)

const

resourceForName returns the resources with the given name that fit the current filters.

Returns

a resource if one is found, or 0 if none are found

Definition at line 1169 of file KisResourceModel.cpp.

{
    return filterByColumn(name, KisAllResourcesModel::Name);
}

References filterByColumn(), and KisAbstractResourceModel::Name.

setResourceActive()

bool KisResourceModel::setResourceActive ( const QModelIndex & index, bool value )

overridevirtual

setResourceActive changes 'active' state of the resource

Parameters

index	the index of the resource
value	new 'active' state of the resource

Returns

true if the new state has been assigned successfully

Implements KisAbstractResourceModel.

Definition at line 868 of file KisResourceModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    if (source) {
        return source->setResourceActive(mapToSource(index), value);
    }
    return false;
}

References source(), and value().

setResourceFilter()

void KisResourceModel::setResourceFilter ( ResourceFilter filter )

overridevirtual

Select status of the resources that should be shown

Implements KisAbstractResourceFilterInterface.

Definition at line 819 of file KisResourceModel.cpp.

{
    if (d->resourceFilter != filter) {
        d->resourceFilter = filter;
        invalidateFilter();
    }
}

References d, and KisResourceModel::Private::resourceFilter.

setResourceMetaData()

bool KisResourceModel::setResourceMetaData ( KoResourceSP resource, QMap< QString, QVariant > metadata )

overridevirtual

setResourceMetaData

Parameters

metadata

Returns

Implements KisAbstractResourceModel.

Definition at line 1037 of file KisResourceModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    if (source) {
        return source->setResourceMetaData(resource, metadata);
    }
    return false;
}

References source().

setStorageFilter()

void KisResourceModel::setStorageFilter ( StorageFilter filter )

overridevirtual

Select status of the storages that should be shown

Implements KisAbstractResourceFilterInterface.

Definition at line 827 of file KisResourceModel.cpp.

{
    if (d->storageFilter != filter) {
        d->storageFilter = filter;
        invalidateFilter();
    }
}

References d, and KisResourceModel::Private::storageFilter.

showOnlyUntaggedResources()

void KisResourceModel::showOnlyUntaggedResources

(

bool

showOnlyUntagged

)

Definition at line 835 of file KisResourceModel.cpp.

{
    d->showOnlyUntaggedResources = showOnlyUntagged;
    invalidateFilter();
}

References d, and KisResourceModel::Private::showOnlyUntaggedResources.

tagsForResource()

QVector< KisTagSP > KisResourceModel::tagsForResource

(

int

resourceId

)

const

Definition at line 1179 of file KisResourceModel.cpp.

{
    return static_cast<KisAllResourcesModel*>(sourceModel())->tagsForResource(resourceId);
}

References tagsForResource().

updateResource()

bool KisResourceModel::updateResource ( KoResourceSP resource )

overridevirtual

updateResource creates a new version of the resource in the storage and in the database. This will also set the resource to active if it was inactive.

Note: if the storage does not support versioning, updating the resource will fail.

Parameters

resource

Returns

true if the resource was successful updated,

Implements KisAbstractResourceModel.

Definition at line 1010 of file KisResourceModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    if (source) {
        return source->updateResource(resource);
    }
    return false;
}

References source().

Member Data Documentation

d

Private* const KisResourceModel::d

private

Definition at line 447 of file KisResourceModel.h.

---

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

• libs/resources/KisResourceModel.h
• libs/resources/KisResourceModel.cpp