The KisAllresourcesModel class provides access to the cache database for a particular resource type. Instances should be retrieved using KisResourceModelProvider. All resources are part of this model, active and inactive, from all storages, active and inactive. More...

#include <KisResourceModel.h>

Inheritance diagram for KisAllResourcesModel:

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.

int	columnCount (const QModelIndex &parent=QModelIndex()) const override

QVariant	data (const QModelIndex &index, int role) const override

bool	exportResource (KoResourceSP resource, QIODevice *device) override
	exportResource exports a resource into a QIODevice

Qt::ItemFlags	flags (const QModelIndex &index) const override

QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override

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

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.

bool	resourceExists (const QString &md5, const QString &filename, const QString &name)
	resourceExists checks whether there is a resource with, in order, the given md5, the filename or the resource name.

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 (const QString &name) const

QHash< int, QByteArray >	roleNames () const override

int	rowCount (const QModelIndex &parent=QModelIndex()) const override

bool	setData (const QModelIndex &index, const QVariant &value, int role) override

bool	setResourceActive (const QModelIndex &index, bool value) override
	setResourceActive changes 'active' state of the resource

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

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.

	~KisAllResourcesModel () override

Public Member Functions inherited from KisAbstractResourceModel
bool	setResourceInactive (const QModelIndex &index)

virtual	~KisAbstractResourceModel ()

Private Slots
void	beginExternalResourceImport (const QString &resourceType, int numResources)

void	beginExternalResourceRemove (const QString &resourceType, const QVector< int > &resourceId)

void	endExternalResourceImport (const QString &resourceType)

void	endExternalResourceRemove (const QString &resourceType)

void	slotResourceActiveStateChanged (const QString &resourceType, int resourceId)

void	storageActiveStateChanged (const QString &location)

void	storageResynchronized (const QString &storage, bool isBulkResynchronization)

void	storagesBulkSynchronizationFinished ()

Private Member Functions
void	closeQuery ()

	KisAllResourcesModel (const QString &resourceType, QObject *parent=0)

bool	prepareQuery ()

bool	resetQuery ()

Private Attributes
Private *const	d

Friends
class	KisResourceModel

class	KisResourceModelProvider

class	KisResourceQueryMapper

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...

Detailed Description

The KisAllresourcesModel class provides access to the cache database for a particular resource type. Instances should be retrieved using KisResourceModelProvider. All resources are part of this model, active and inactive, from all storages, active and inactive.

Definition at line 248 of file KisResourceModel.h.

Constructor & Destructor Documentation

◆ KisAllResourcesModel()

KisAllResourcesModel::KisAllResourcesModel	(	const QString &	resourceType,
		QObject *	parent = 0 )

private

we don't handle KisResourceLocator::storage{Added,Removed} signals here, we use per-resource notifications from KisResourceLocator instead

Definition at line 33 of file KisResourceModel.cpp.

    : QAbstractTableModel(parent)
    , d(new Private)
{
 
 
    connect(KisStorageModel::instance(), &KisStorageModel::storageEnabled, this, &KisAllResourcesModel::storageActiveStateChanged);
    connect(KisStorageModel::instance(), &KisStorageModel::storageDisabled, this, &KisAllResourcesModel::storageActiveStateChanged);
    connect(KisStorageModel::instance(), &KisStorageModel::storageResynchronized, this, &KisAllResourcesModel::storageResynchronized);
    connect(KisStorageModel::instance(), &KisStorageModel::storagesBulkSynchronizationFinished, this, &KisAllResourcesModel::storagesBulkSynchronizationFinished);
 
    connect(KisResourceLocator::instance(), &KisResourceLocator::beginExternalResourceImport, this, &KisAllResourcesModel::beginExternalResourceImport);
    connect(KisResourceLocator::instance(), &KisResourceLocator::endExternalResourceImport, this, &KisAllResourcesModel::endExternalResourceImport);
    connect(KisResourceLocator::instance(), &KisResourceLocator::beginExternalResourceRemove, this, &KisAllResourcesModel::beginExternalResourceRemove);
    connect(KisResourceLocator::instance(), &KisResourceLocator::endExternalResourceRemove, this, &KisAllResourcesModel::endExternalResourceRemove);
    connect(KisResourceLocator::instance(), &KisResourceLocator::resourceActiveStateChanged, this, &KisAllResourcesModel::slotResourceActiveStateChanged);
 
    d->resourceType = resourceType;
 
    prepareQuery();
    resetQuery();
}

References KisResourceLocator::beginExternalResourceImport(), beginExternalResourceImport(), beginExternalResourceRemove(), KisResourceLocator::beginExternalResourceRemove(), d, KisResourceLocator::endExternalResourceImport(), endExternalResourceImport(), KisResourceLocator::endExternalResourceRemove(), endExternalResourceRemove(), KisResourceLocator::instance(), KisStorageModel::instance(), prepareQuery(), resetQuery(), KisResourceLocator::resourceActiveStateChanged(), KisAllResourcesModel::Private::resourceType, slotResourceActiveStateChanged(), storageActiveStateChanged(), KisStorageModel::storageDisabled(), KisStorageModel::storageEnabled(), storageResynchronized(), KisStorageModel::storageResynchronized(), storagesBulkSynchronizationFinished(), and KisStorageModel::storagesBulkSynchronizationFinished().

◆ ~KisAllResourcesModel()

KisAllResourcesModel::~KisAllResourcesModel ( )

override

Definition at line 58 of file KisResourceModel.cpp.

{
    delete d;
}

References d.

Member Function Documentation

◆ addResource()

bool KisAllResourcesModel::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 468 of file KisResourceModel.cpp.

{
    if (!resource || !resource->valid()) {
        qWarning() << "Cannot add resource. Resource is null or not valid";
        return false;
    }
 
    bool r = true;
    beginInsertRows(QModelIndex(), rowCount(), rowCount());
    if (!KisResourceLocator::instance()->addResource(d->resourceType, resource, storageId)) {
        qWarning() << "Failed to add resource" << resource->name();
        r = false;
    }
    resetQuery();
    endInsertRows();
 
    return r;
}

References addResource(), d, KisResourceLocator::instance(), resetQuery(), KisAllResourcesModel::Private::resourceType, and rowCount().

◆ addResourceDeduplicateFileName()

bool KisAllResourcesModel::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 487 of file KisResourceModel.cpp.

{
    if (!resource || !resource->valid()) {
        qWarning() << "Cannot add resource. Resource is null or not valid";
        return false;
    }
 
    bool r = true;
    beginInsertRows(QModelIndex(), rowCount(), rowCount());
    if (!KisResourceLocator::instance()->addResourceDeduplicateFileName(d->resourceType, resource, storageId)) {
        qWarning() << "Failed to add resource with name deduplication" << resource->name();
        r = false;
    }
    resetQuery();
    endInsertRows();
 
    return r;
}

References addResourceDeduplicateFileName(), d, KisResourceLocator::instance(), resetQuery(), KisAllResourcesModel::Private::resourceType, and rowCount().

◆ beginExternalResourceImport

void KisAllResourcesModel::beginExternalResourceImport	(	const QString &	resourceType,
		int	numResources )

privateslot

A special connection for KisResourceLocator, which can import a resource on its own (all other places are supposed to do that via KisResourceModel). This call is needed to make sure the internal query in the model is reset.

WARNING: the resource is expected to be added to the end of the model, that is, its resourceId is expected to be greater than any existing resource.

Definition at line 740 of file KisResourceModel.cpp.

{
    if (resourceType != d->resourceType) return;
 
    beginInsertRows(QModelIndex(), rowCount(), rowCount() + numResources - 1);
}

References d, KisAllResourcesModel::Private::resourceType, and rowCount().

◆ beginExternalResourceRemove

void KisAllResourcesModel::beginExternalResourceRemove	(	const QString &	resourceType,
		const QVector< int > &	resourceId )

privateslot

A special connection for KisResourceLocator, which can remove the resource while importing something with overwrite. In such a case the locator will Q_EMIT both, remove and insert signals for both the resources.

Definition at line 755 of file KisResourceModel.cpp.

{
    if (resourceType != d->resourceType) return;
 
    Q_FOREACH (int resourceId, resourceIds) {
        const QModelIndex index = indexForResourceId(resourceId);
        if (index.isValid()) {
            beginRemoveRows(QModelIndex(), index.row(), index.row());
            d->externalResourcesRemovedCount++;
        } else {
            // it's fine if the index is invalid; it probably means it's one of the duplicates (another resource with the same type and content was already in the database)
            dbgResources << "KisAllResourcesModel::beginExternalResourceRemove got invalid index" << index << "for resourceId" << resourceId
                         << "of type" << resourceType << "(possibly the resource was deduplicated via sql query and that's why it doesn't appear in the model)";
        }
    }
}

References d, dbgResources, KisAllResourcesModel::Private::externalResourcesRemovedCount, indexForResourceId(), and KisAllResourcesModel::Private::resourceType.

◆ closeQuery()

void KisAllResourcesModel::closeQuery ( )

private

Definition at line 604 of file KisResourceModel.cpp.

{
    d->resourcesQuery.clear();
}

References d, and KisAllResourcesModel::Private::resourcesQuery.

◆ columnCount()

int KisAllResourcesModel::columnCount ( const QModelIndex & parent = QModelIndex() ) const

override

Definition at line 63 of file KisResourceModel.cpp.

{
    if (parent.isValid()) {
        return 0;
    }
 
    return d->columnCount;
}

References KisAllResourcesModel::Private::columnCount, and d.

◆ data()

QVariant KisAllResourcesModel::data	(	const QModelIndex &	index,
		int	role ) const

override

Definition at line 72 of file KisResourceModel.cpp.

{
 
    QVariant v;
    if (!index.isValid()) return v;
 
    if (index.row() > rowCount()) return v;
    if (index.column() > d->columnCount) return v;
 
    bool pos = const_cast<KisAllResourcesModel*>(this)->d->resourcesQuery.seek(index.row());
 
    if (pos) {
        v = KisResourceQueryMapper::variantFromResourceQuery(d->resourcesQuery, index.column(), role, false);
    }
 
    return v;
}

References KisAllResourcesModel::Private::columnCount, d, KisAllResourcesModel::Private::resourcesQuery, rowCount(), v, and KisResourceQueryMapper::variantFromResourceQuery().

◆ endExternalResourceImport

void KisAllResourcesModel::endExternalResourceImport ( const QString & resourceType )

privateslot

See also: beginExternalResourceImport

Definition at line 747 of file KisResourceModel.cpp.

{
    if (resourceType != d->resourceType) return;
 
    resetQuery();
    endInsertRows();
}

References d, resetQuery(), and KisAllResourcesModel::Private::resourceType.

◆ endExternalResourceRemove

void KisAllResourcesModel::endExternalResourceRemove ( const QString & resourceType )

privateslot

See also: beginExternalResourceRemove

Definition at line 772 of file KisResourceModel.cpp.

{
    if (resourceType != d->resourceType) return;
 
    if (d->externalResourcesRemovedCount > 0) {
        resetQuery();
    }
    for (int i = 0; i < d->externalResourcesRemovedCount; i++) {
        endRemoveRows();
    }
 
    d->externalResourcesRemovedCount = 0;
}

References d, KisAllResourcesModel::Private::externalResourcesRemovedCount, resetQuery(), and KisAllResourcesModel::Private::resourceType.

◆ exportResource()

bool KisAllResourcesModel::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 459 of file KisResourceModel.cpp.

{
    bool res = KisResourceLocator::instance()->exportResource(resource, device);
    if (!res) {
        qWarning() << "Failed to export resource" << resource->signature();
    }
    return res;
}

References KisResourceLocator::exportResource(), and KisResourceLocator::instance().

◆ flags()

Qt::ItemFlags KisAllResourcesModel::flags ( const QModelIndex & index ) const

override

Definition at line 151 of file KisResourceModel.cpp.

{
    if (!index.isValid()) {
        return Qt::NoItemFlags;
    }
    return QAbstractTableModel::flags(index) | Qt::ItemIsEditable | Qt::ItemNeverHasChildren;
}

◆ headerData()

QVariant KisAllResourcesModel::headerData	(	int	section,
		Qt::Orientation	orientation,
		int	role = Qt::DisplayRole ) const

override

Definition at line 90 of file KisResourceModel.cpp.

{
    if (role != Qt::DisplayRole) {
        return {};
    }
    if (orientation == Qt::Horizontal) {
        switch (section) {
        case Id:
            return i18n("Id");
        case StorageId:
            return i18n("Storage ID");
        case Name:
            return i18n("Name");
        case Filename:
            return i18n("File Name");
        case Tooltip:
            return i18n("Tooltip");
        case Thumbnail:
            return i18n("Image");
        case Status:
            return i18n("Status");
        case Location:
            return i18n("Location");
        case ResourceType:
            return i18n("Resource Type");
        case ResourceActive:
            return i18n("Active");
        case StorageActive:
            return i18n("Storage Active");
        case MD5:
            return i18n("md5sum");
        case Tags:
            return i18n("Tags");
        case LargeThumbnail:
            return i18n("Large Thumbnail");
        case Dirty:
            return i18n("Dirty");
        case MetaData:
            return i18n("Metadata");
        case BrokenStatus:
            return i18n("Broken Status");
        case BrokenStatusMessage:
            return i18n("Broken Status Message");
        default:
            return QString::number(section);
        }
    }
    return {};
}

◆ importResource()

KoResourceSP KisAllResourcesModel::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 442 of file KisResourceModel.cpp.

{
    KoResourceSP importedResource = KisResourceLocator::instance()->importResource(d->resourceType, filename, device, allowOverwrite, storageId);
 
    if (!importedResource) {
        qWarning() << "Failed to import resource" << filename;
    }
    resetQuery();
 
    return importedResource;
}

References d, KisResourceLocator::importResource(), KisResourceLocator::instance(), resetQuery(), and KisAllResourcesModel::Private::resourceType.

◆ importResourceFile()

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

overridevirtual

importResourceFile

Parameters

filename

Returns

Implements KisAbstractResourceModel.

Definition at line 430 of file KisResourceModel.cpp.

{
    KoResourceSP importedResource = KisResourceLocator::instance()->importResourceFromFile(d->resourceType, filename, allowOverwrite, storageId);
 
    if (!importedResource) {
        qWarning() << "Failed to import resource" << filename;
    }
    resetQuery();
 
    return importedResource;
}

References d, KisResourceLocator::importResourceFromFile(), KisResourceLocator::instance(), resetQuery(), and KisAllResourcesModel::Private::resourceType.

◆ importWillOverwriteResource()

bool KisAllResourcesModel::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 454 of file KisResourceModel.cpp.

{
    return KisResourceLocator::instance()->importWillOverwriteResource(d->resourceType, fileName, storageLocation);
}

References d, KisResourceLocator::importWillOverwriteResource(), KisResourceLocator::instance(), and KisAllResourcesModel::Private::resourceType.

◆ indexForResource()

QModelIndex KisAllResourcesModel::indexForResource ( KoResourceSP resource ) const

overridevirtual

indexFromResource

Parameters

resource

Returns

Implements KisAbstractResourceModel.

Definition at line 392 of file KisResourceModel.cpp.

{
    if (!resource || !resource->valid() || resource->resourceId() < 0) return QModelIndex();
 
    // For now a linear seek to find the first resource with the right id
    return indexForResourceId(resource->resourceId());
}

References indexForResourceId().

◆ indexForResourceId()

QModelIndex KisAllResourcesModel::indexForResourceId ( int resourceId ) const

overridevirtual

indexFromResource

Parameters

resourceId resource id for which we want to get an index

Returns

Implements KisAbstractResourceModel.

Definition at line 400 of file KisResourceModel.cpp.

{
    if (!d->resourcesQuery.first()) {
        return QModelIndex();
    }
 
    do {
        if (d->resourcesQuery.value("id").toInt() == resourceId) {
            return index(d->resourcesQuery.at(), 0);
        }
    } while (d->resourcesQuery.next());
 
    return QModelIndex();
}

References d, and KisAllResourcesModel::Private::resourcesQuery.

◆ prepareQuery()

bool KisAllResourcesModel::prepareQuery ( )

private

Definition at line 570 of file KisResourceModel.cpp.

{
    bool r = d->resourcesQuery.prepare(
        "SELECT resources.id\n"
        ",      resources.storage_id\n"
        ",      resources.name\n"
        ",      resources.filename\n"
        ",      resources.tooltip\n"
        ",      resources.status\n"
        ",      resources.md5sum\n"
        ",      storages.location\n"
        ",      resource_types.name as resource_type\n"
        ",      resources.status as resource_active\n"
        ",      storages.active as storage_active\n"
        "FROM   resources\n"
        ",      resource_types\n"
        ",      storages\n"
        "WHERE  resources.resource_type_id = resource_types.id\n"
        "AND    resources.storage_id = storages.id\n"
        "AND    resource_types.name = :resource_type\n"
        "GROUP BY resources.name\n"
        ",        resources.filename\n"
        ",        resources.md5sum\n"
        "ORDER BY resources.id");
 
    if (!r) {
        qWarning() << "Could not prepare KisAllResourcesModel query" << d->resourcesQuery.lastError();
        return false;
    }
 
    d->resourcesQuery.bindValue(":resource_type", d->resourceType);
    return true;
}

References d, KisAllResourcesModel::Private::resourcesQuery, and KisAllResourcesModel::Private::resourceType.

◆ reloadResource()

bool KisAllResourcesModel::reloadResource ( KoResourceSP resource )

overridevirtual

reloadResource

Parameters

resource

Returns

We don't have to call reset query here, because reloading a resource doesn't change any database content.

Implements KisAbstractResourceModel.

Definition at line 523 of file KisResourceModel.cpp.

{
    if (!resource || !resource->valid()) {
        qWarning() << "Cannot reload resource. Resource is null or not valid";
        return false;
    }
 
    if (!KisResourceLocator::instance()->reloadResource(d->resourceType, resource)) {
        qWarning() << "Failed to reload resource" << resource;
        return false;
    }
 
    QModelIndex index = indexForResource(resource);
    Q_EMIT dataChanged(index, index);
    return true;
}

References d, indexForResource(), KisResourceLocator::instance(), reloadResource(), and KisAllResourcesModel::Private::resourceType.

◆ renameResource()

bool KisAllResourcesModel::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 545 of file KisResourceModel.cpp.

{
    if (!resource || !resource->valid() || name.isEmpty()) {
        qWarning() << "Cannot rename resources. Resource is NULL or not valid or name is empty";
        return false;
    }
    resource->setName(name);
    if (!KisResourceLocator::instance()->updateResource(d->resourceType, resource)) {
        qWarning() << "Failed to rename resource" << resource << name;
        return false;
    }
    bool r = resetQuery();
    QModelIndex index = indexForResource(resource);
    Q_EMIT dataChanged(index, index);
    return r;
}

References d, indexForResource(), KisResourceLocator::instance(), resetQuery(), KisAllResourcesModel::Private::resourceType, and updateResource().

◆ resetQuery()

bool KisAllResourcesModel::resetQuery ( )

private

In case the query has been previously closed, try to restart it (used in unittests mostly)

Definition at line 609 of file KisResourceModel.cpp.

{
    if (!d->resourcesQuery.isValid()) {
        d->resourcesQuery.clear();
        prepareQuery();
    }
 
    bool r = d->resourcesQuery.exec();
    if (!r) {
        qWarning() << "Could not select" << d->resourceType << "resources" << d->resourcesQuery.lastError() << d->resourcesQuery.boundValues();
    }
    d->cachedRowCount = -1;
 
    return r;
}

References KisAllResourcesModel::Private::cachedRowCount, d, prepareQuery(), KisAllResourcesModel::Private::resourcesQuery, and KisAllResourcesModel::Private::resourceType.

◆ resourceExists()

bool KisAllResourcesModel::resourceExists	(	const QString &	md5,
		const QString &	filename,
		const QString &	name )

resourceExists checks whether there is a resource with, in order, the given md5, the filename or the resource name.

Definition at line 205 of file KisResourceModel.cpp.

{
    QSqlQuery q;
 
    // md5
 
    if (!md5.isEmpty()) {
 
        bool r = q.prepare("SELECT resources.id AS id\n"
                           "FROM   resources\n"
                           "WHERE  md5sum = :md5sum");
        if (!r) {
            qWarning() << "Could not prepare find resourceExists by md5 query"  << q.lastError();
        }
 
        q.bindValue(":mdsum", md5);
 
        r = q.exec();
 
        if (!r) {
            qWarning() << "Could not execute resourceExists by md5 query" << q.lastError();
        }
 
        if (q.first()) {
            return true;
        }
    }
 
    // filename
 
    if (!filename.isEmpty()) {
 
        bool r = q.prepare("SELECT resources.id AS id\n"
                      "FROM   resources\n"
                      "WHERE  filename = :filename");
        if (!r) {
            qWarning() << "Could not prepare find resourceExists by filename query"  << q.lastError();
        }
 
        q.bindValue(":filename", filename);
 
        r = q.exec();
 
        if (!r) {
            qWarning() << "Could not execute resourceExists by filename query" << q.lastError();
        }
 
        if (q.first()) {
            return true;
        }
    }
 
    // name
 
    if (!name.isEmpty()) {
 
        bool r = q.prepare("SELECT resources.id AS id\n"
                      "FROM   resources\n"
                      "WHERE  name = :name");
        if (!r) {
            qWarning() << "Could not prepare find resourceExists by name query"  << q.lastError();
        }
 
        q.bindValue(":name", name);
 
        r = q.exec();
        if (!r) {
            qWarning() << "Could not execute resourceExists by name query" << q.lastError();
        }
 
        if (q.first()) {
            return true;
        }
    }
 
    // failure
 
    return false;
}

◆ resourceForId()

KoResourceSP KisAllResourcesModel::resourceForId ( int id ) const

Definition at line 200 of file KisResourceModel.cpp.

{
    return KisResourceLocator::instance()->resourceForId(id);
}

References KisResourceLocator::instance(), and KisResourceLocator::resourceForId().

◆ resourceForIndex()

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

overridevirtual

resourceForIndex returns a properly versioned and id'ed resource object

Implements KisAbstractResourceModel.

Definition at line 184 of file KisResourceModel.cpp.

{
    KoResourceSP resource = 0;
 
    if (!index.isValid()) return resource;
    if (index.row() > rowCount()) return resource;
    if (index.column() > d->columnCount) return resource;
 
    bool pos = const_cast<KisAllResourcesModel*>(this)->d->resourcesQuery.seek(index.row());
    if (pos) {
        int id = d->resourcesQuery.value("id").toInt();
        resource = resourceForId(id);
    }
    return resource;
}

References KisAllResourcesModel::Private::columnCount, d, resourceForId(), KisAllResourcesModel::Private::resourcesQuery, and rowCount().

◆ resourcesForFilename()

QVector< KoResourceSP > KisAllResourcesModel::resourcesForFilename ( QString filename ) const

resourceForFilename returns the first resource with the given filename that is active and is in an active store. Note that the filename does not include a path to the storage, and if there are resources with the same filename in several active storages, only one resource is returned.

Parameters

filename	the filename we're looking for
checkDependentResources	check whether we should try to find a resource embedded in a resource that's not been loaded yet in the metadata table.

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

Definition at line 285 of file KisResourceModel.cpp.

{
    QVector<KoResourceSP> resources;
 
    if (filename.isEmpty()) return resources;
 
    QSqlQuery q;
    bool r = q.prepare("SELECT resources.id AS id\n"
                       "FROM   resources\n"
                       ",      resource_types\n"
                       "WHERE  resources.resource_type_id = resource_types.id\n"
                       "AND    resources.filename = :resource_filename\n"
                       "AND    resource_types.name = :resource_type\n");
    if (!r) {
        qWarning() << "Could not prepare KisAllResourcesModel query for resource name" << q.lastError();
    }
    q.bindValue(":resource_filename", filename);
    q.bindValue(":resource_type", d->resourceType);
 
    r = q.exec();
    if (!r) {
        qWarning() << "Could not select" << d->resourceType << "resources by filename" << q.lastError() << q.boundValues();
    }
 
    while (q.next()) {
        int id = q.value("id").toInt();
        KoResourceSP resource = KisResourceLocator::instance()->resourceForId(id);
        if (resource) {
            resources << resource;
        }
 
    }
 
    return resources;
}

References d, KisResourceLocator::instance(), KisResourceLocator::resourceForId(), and KisAllResourcesModel::Private::resourceType.

◆ resourcesForMD5()

QVector< KoResourceSP > KisAllResourcesModel::resourcesForMD5 ( const QString & md5sum ) const

Definition at line 360 of file KisResourceModel.cpp.

{
    QVector<KoResourceSP> resources;
 
    if (md5sum.isEmpty()) return resources;
 
    KoResourceSP resource = 0;
 
    QSqlQuery q;
    bool r = q.prepare("SELECT resource_id AS id\n"
                       "FROM   versioned_resources\n"
                       "WHERE  md5sum = :md5sum");
    if (!r) {
        qWarning() << "Could not prepare KisAllResourcesModel query for resource md5" << q.lastError();
    }
    q.bindValue(":md5sum", md5sum);
 
    r = q.exec();
    if (!r) {
        qWarning() << "Could not select" << d->resourceType << "resources by md5" << q.lastError() << q.boundValues();
    }
 
    while (q.next()) {
        int id = q.value("id").toInt();
        resource = KisResourceLocator::instance()->resourceForId(id);
        if (resource) {
            resources << resource;
        }
    }
    return resources;
}

References d, KisResourceLocator::instance(), KisResourceLocator::resourceForId(), and KisAllResourcesModel::Private::resourceType.

◆ resourcesForName()

QVector< KoResourceSP > KisAllResourcesModel::resourcesForName ( const QString & name ) const

resourceForName returns the first resource with the given name that is active and is in an active store. Note that if there are resources with the same name in several active storages, only one resource is returned.

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

Definition at line 321 of file KisResourceModel.cpp.

{
    QVector<KoResourceSP> resources;
 
    if (name.isEmpty()) return resources;
 
    KoResourceSP resource = 0;
 
    QSqlQuery q;
    bool r = q.prepare("SELECT resources.id AS id\n"
                       "FROM   resources\n"
                       ",      resource_types\n"
                       "WHERE  resources.resource_type_id = resource_types.id\n"
                       "AND    resources.name = :resource_name\n"
                       "AND    resource_types.name = :resource_type\n");
    if (!r) {
        qWarning() << "Could not prepare KisAllResourcesModel query for resource name" << q.lastError();
    }
 
    q.bindValue(":resource_type", d->resourceType);
    q.bindValue(":resource_name", name);
 
    r = q.exec();
    if (!r) {
        qWarning() << "Could not select" << d->resourceType << "resources by name" << q.lastError() << q.boundValues();
    }
 
    while (q.next()) {
        int id = q.value("id").toInt();
        resource = KisResourceLocator::instance()->resourceForId(id);
        if (resource) {
            resources << resource;
        }
    }
 
    return resources;
}

References d, KisResourceLocator::instance(), KisResourceLocator::resourceForId(), and KisAllResourcesModel::Private::resourceType.

◆ roleNames()

QHash< int, QByteArray > KisAllResourcesModel::roleNames ( ) const

override

Definition at line 159 of file KisResourceModel.cpp.

{
    QHash<int, QByteArray> roles = QAbstractItemModel::roleNames();
    roles[Qt::UserRole + Id] = "id";
    roles[Qt::UserRole + StorageId] = "storageId";
    roles[Qt::UserRole + Name] = "name";
    roles[Qt::UserRole + Filename] = "filename";
    //roles[Qt::UserRole + Tooltip] = "tooltip";
    roles[Qt::UserRole + Thumbnail] = "thumbnail";
    roles[Qt::UserRole + Status] = "status";
    roles[Qt::UserRole + Location] = "location";
    roles[Qt::UserRole + ResourceType] = "resourcetype";
    roles[Qt::UserRole + MD5] = "md5";
    roles[Qt::UserRole + Tags] = "tags";
    roles[Qt::UserRole + LargeThumbnail] = "largethumbnail";
    roles[Qt::UserRole + Dirty] = "dirty";
    roles[Qt::UserRole + MetaData] = "metadata";
    roles[Qt::UserRole + ResourceActive] = "resourceactive";
    roles[Qt::UserRole + StorageActive] = "storageactive";
    roles[Qt::UserRole + BrokenStatus] = "brokenstatus";
    roles[Qt::UserRole + BrokenStatusMessage] = "brokenstatusmessage";
 
    return roles;
}

◆ rowCount()

int KisAllResourcesModel::rowCount ( const QModelIndex & parent = QModelIndex() ) const

override

SQLite doesn't support COUNT(DISTINCT ...) over multiple columns, so we need to concatenate them manually on the fly. But SQLite doesn't support CONCAT function either, therefore we should use concatenation operator it provides.

Definition at line 665 of file KisResourceModel.cpp.

{
    if (parent.isValid()) {
        return 0;
    }
 
    if (d->cachedRowCount < 0) {
        QSqlQuery q;
        bool r = q.prepare("SELECT COUNT(DISTINCT resources.name || resources.filename || resources.md5sum)\n"
                  "FROM   resources\n"
                  ",      resource_types\n"
                  "WHERE  resources.resource_type_id = resource_types.id\n"
                  "AND    resource_types.name = :resource_type\n");
        if (!r) {
            qWarning() << "Could not prepare all resources rowcount query" << q.lastError();
            return 0;
        }
        q.bindValue(":resource_type", d->resourceType);
        r = q.exec();
        if (!r) {
            qWarning() << "Could not execute all resources rowcount query" << q.lastError() << q.boundValues();
            return 0;
        }
        q.first();
 
        const_cast<KisAllResourcesModel*>(this)->d->cachedRowCount = q.value(0).toInt();
    }
 
    return d->cachedRowCount;
}

References KisAllResourcesModel::Private::cachedRowCount, d, and KisAllResourcesModel::Private::resourceType.

◆ setData()

bool KisAllResourcesModel::setData	(	const QModelIndex &	index,
		const QVariant &	value,
		int	role )

override

Definition at line 140 of file KisResourceModel.cpp.

{
    if (index.isValid() && role == Qt::CheckStateRole &&
            value.canConvert<bool>()) {
 
        return setResourceActive(index, value.toBool());
    }
 
    return true;
}

References setResourceActive(), and value().

◆ setResourceActive()

bool KisAllResourcesModel::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 415 of file KisResourceModel.cpp.

{
    if (index.row() > rowCount()) return false;
    if (index.column() > d->columnCount) return false;
 
    int resourceId = index.data(Qt::UserRole + Id).toInt();
    if (!KisResourceLocator::instance()->setResourceActive(resourceId, value)) {
        qWarning() << "Failed to change active state of the resource" << resourceId;
        return false;
    }
 
    return true;
}

References KisAllResourcesModel::Private::columnCount, d, KisAbstractResourceModel::Id, KisResourceLocator::instance(), rowCount(), setResourceActive(), and value().

◆ setResourceMetaData()

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

overridevirtual

setResourceMetaData

Parameters

metadata

Returns

Implements KisAbstractResourceModel.

Definition at line 564 of file KisResourceModel.cpp.

{
    Q_ASSERT(resource->resourceId() > -1);
    return KisResourceLocator::instance()->setMetaDataForResource(resource->resourceId(), metadata);
}

References KisResourceLocator::instance(), and KisResourceLocator::setMetaDataForResource().

◆ slotResourceActiveStateChanged

void KisAllResourcesModel::slotResourceActiveStateChanged	(	const QString &	resourceType,
		int	resourceId )

privateslot

A special connection for KisResourceLocator, which is triggered when the resource changes its 'active' state

Definition at line 786 of file KisResourceModel.cpp.

{
    if (resourceType != d->resourceType) return;
    if (resourceId < 0) return;
 
    resetQuery();
 
    QModelIndex index = indexForResourceId(resourceId);
 
    if (index.isValid()) {
        Q_EMIT dataChanged(index, index, {Qt::CheckStateRole, Qt::UserRole + KisAbstractResourceModel::ResourceActive});
    }
}

References d, indexForResourceId(), resetQuery(), KisAbstractResourceModel::ResourceActive, and KisAllResourcesModel::Private::resourceType.

◆ storageActiveStateChanged

void KisAllResourcesModel::storageActiveStateChanged ( const QString & location )

privateslot

Definition at line 703 of file KisResourceModel.cpp.

{
    const QVector<int> resourceIds = KisResourceCacheDb::resourcesForStorage(d->resourceType, location);
    if (resourceIds.isEmpty()) return;
 
    resetQuery();
 
    Q_FOREACH (int resourceId, resourceIds) {
        QModelIndex index = indexForResourceId(resourceId);
 
        if (index.isValid()) {
            Q_EMIT dataChanged(index, index, {Qt::UserRole + KisAbstractResourceModel::StorageActive});
        }
    }
}

References d, indexForResourceId(), resetQuery(), KisResourceCacheDb::resourcesForStorage(), KisAllResourcesModel::Private::resourceType, and KisAbstractResourceModel::StorageActive.

◆ storageResynchronized

void KisAllResourcesModel::storageResynchronized	(	const QString &	storage,
		bool	isBulkResynchronization )

privateslot

Definition at line 719 of file KisResourceModel.cpp.

{
    Q_UNUSED(storage);
 
    // we handle bulk-synchronization separately in slotStoragesBulkSynchronizationFinished()
    if (isBulkResynchronization) return;
 
    // TODO: ideally, we should use more fine-grained updates for
    //       updating the storages, but let's keep it this
    beginResetModel();
    resetQuery();
    endResetModel();
}

References resetQuery().

◆ storagesBulkSynchronizationFinished

void KisAllResourcesModel::storagesBulkSynchronizationFinished ( )

privateslot

Definition at line 733 of file KisResourceModel.cpp.

{
    beginResetModel();
    resetQuery();
    endResetModel();
}

References resetQuery().

◆ tagsForResource()

QVector< KisTagSP > KisAllResourcesModel::tagsForResource ( int resourceId ) const

Definition at line 629 of file KisResourceModel.cpp.

{
    bool r;
 
    QSqlQuery q;
 
    r = q.prepare("SELECT tags.url\n"
                  "FROM   tags\n"
                  ",      resource_tags\n"
                  ",      resource_types\n"
                  "WHERE  tags.active > 0\n"                               // make sure the tag is active
                  "AND    tags.id = resource_tags.tag_id\n"                // join tags + resource_tags by tag_id
                  "AND    resource_tags.resource_id = :resource_id\n"
                  "AND    resource_types.id = tags.resource_type_id\n"     // make sure we're looking for tags for a specific resource
                  "AND    resource_tags.active = 1\n");                    // and the tag must be active
    if (!r)  {
        qWarning() << "Could not prepare TagsForResource query" << q.lastError();
    }
 
    q.bindValue(":resource_id", resourceId);
    r = q.exec();
    if (!r) {
        qWarning() << "Could not select tags for" << resourceId << q.lastError() << q.boundValues();
    }
 
    QVector<KisTagSP> tags;
    while (q.next()) {
        KisTagSP tag = KisResourceLocator::instance()->tagForUrl(q.value(0).toString(), d->resourceType);
        if (tag && tag->valid()) {
            tags << tag;
        }
    }
    return tags;
}

References d, KisResourceLocator::instance(), KisAllResourcesModel::Private::resourceType, and KisResourceLocator::tagForUrl().

◆ updateResource()

bool KisAllResourcesModel::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 506 of file KisResourceModel.cpp.

{
    if (!resource || !resource->valid()) {
        qWarning() << "Cannot update resource. Resource is null or not valid";
        return false;
    }
 
    if (!KisResourceLocator::instance()->updateResource(d->resourceType, resource)) {
        qWarning() << "Failed to update resource" << resource;
        return false;
    }
    bool r = resetQuery();
    QModelIndex index = indexForResource(resource);
    Q_EMIT dataChanged(index, index);
    return r;
}

References d, indexForResource(), KisResourceLocator::instance(), resetQuery(), KisAllResourcesModel::Private::resourceType, and updateResource().

Friends And Related Symbol Documentation

◆ KisResourceModel

friend class KisResourceModel

friend

Definition at line 254 of file KisResourceModel.h.

◆ KisResourceModelProvider

friend class KisResourceModelProvider

friend

Definition at line 253 of file KisResourceModel.h.

◆ KisResourceQueryMapper

friend class KisResourceQueryMapper

friend

Definition at line 255 of file KisResourceModel.h.

Member Data Documentation

◆ d

Private* const KisAllResourcesModel::d

private

Definition at line 372 of file KisResourceModel.h.

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

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

Classes

Public Member Functions

Private Slots

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisAllResourcesModel()

◆ ~KisAllResourcesModel()

Member Function Documentation

◆ addResource()

◆ addResourceDeduplicateFileName()

◆ beginExternalResourceImport

◆ beginExternalResourceRemove

◆ closeQuery()

◆ columnCount()

◆ data()

◆ endExternalResourceImport

◆ endExternalResourceRemove

◆ exportResource()

◆ flags()

◆ headerData()

◆ importResource()

◆ importResourceFile()

◆ importWillOverwriteResource()

◆ indexForResource()

◆ indexForResourceId()

◆ prepareQuery()

◆ reloadResource()

◆ renameResource()

◆ resetQuery()

◆ resourceExists()

◆ resourceForId()

◆ resourceForIndex()

◆ resourcesForFilename()

◆ resourcesForMD5()

◆ resourcesForName()

◆ roleNames()

◆ rowCount()

◆ setData()

◆ setResourceActive()

◆ setResourceMetaData()

◆ slotResourceActiveStateChanged

◆ storageActiveStateChanged

◆ storageResynchronized

◆ storagesBulkSynchronizationFinished

◆ tagsForResource()

◆ updateResource()

Friends And Related Symbol Documentation

◆ KisResourceModel

◆ KisResourceModelProvider

◆ KisResourceQueryMapper

Member Data Documentation

◆ d