File indexing completed on 2024-05-19 04:27:38

 /*
  * SPDX-FileCopyrightText: 2018 Boudewijn Rempt <boud@valdyas.org>
  *
  * SPDX-License-Identifier: LGPL-2.0-or-later
  */
 
 #include "KisResourceLocator.h"
 
 #include <QApplication>
 #include <QDebug>
 #include <QList>
 #include <QDir>
 #include <QDirIterator>
 #include <QFileInfo>
 #include <QMessageBox>
 #include <QVersionNumber>
 #include <QElapsedTimer>
 #include <QSqlQuery>
 #include <QSqlError>
 #include <QBuffer>
 
 #include <kconfig.h>
 #include <kconfiggroup.h>
 #include <ksharedconfig.h>
 #include <klocalizedstring.h>
 
 #include <KritaVersionWrapper.h>
 #include <KisMimeDatabase.h>
 #include <kis_assert.h>
 #include <kis_debug.h>
 #include <KisUsageLogger.h>
 
 #include "KoResourcePaths.h"
 #include "KisResourceStorage.h"
 #include "KisResourceCacheDb.h"
 #include "KisResourceLoaderRegistry.h"
 #include "KisMemoryStorage.h"
 #include "KisResourceModelProvider.h"
 #include <KisGlobalResourcesInterface.h>
 #include <KisStorageModel.h>
 #include <KoMD5Generator.h>
 #include <KoResourceLoadResult.h>
 #include <KisResourceThumbnailCache.h>
 
 #include "ResourceDebug.h"
 
 const QString KisResourceLocator::resourceLocationKey {"ResourceDirectory"};
 
 class KisResourceLocator::Private {
 public:
     QString resourceLocation;
     QMap<QString, KisResourceStorageSP> storages;
     QHash<QPair<QString, QString>, KoResourceSP> resourceCache;
     QMap<QPair<QString, QString>, KisTagSP> tagCache;
     QStringList errorMessages;
 };
 
 KisResourceLocator::KisResourceLocator(QObject *parent)
     : QObject(parent)
     , d(new Private())
 {
 }
 
 KisResourceLocator *KisResourceLocator::instance()
 {
     // Not a regular Q_GLOBAL_STATIC, because we want this deleted as
     // part of the app destructor.
     KisResourceLocator *locator = qApp->findChild<KisResourceLocator *>(QString());
     if (!locator) {
         locator = new KisResourceLocator(qApp);
     }
     return locator;
 }
 
 KisResourceLocator::~KisResourceLocator()
 {
 }
 
 KisResourceLocator::LocatorError KisResourceLocator::initialize(const QString &installationResourcesLocation)
 {
     InitializationStatus initializationStatus = InitializationStatus::Unknown;
 
     d->resourceLocation = KoResourcePaths::getAppDataLocation();
 
     if (!d->resourceLocation.endsWith('/')) d->resourceLocation += '/';
 
     QFileInfo fi(d->resourceLocation);
 
     if (!fi.exists()) {
         if (!QDir().mkpath(d->resourceLocation)) {
             d->errorMessages << i18n("1. Could not create the resource location at %1.", d->resourceLocation);
             return LocatorError::CannotCreateLocation;
         }
         initializationStatus = InitializationStatus::FirstRun;
     }
 
     if (!fi.isWritable()) {
         d->errorMessages << i18n("2. The resource location at %1 is not writable.", d->resourceLocation);
         return LocatorError::LocationReadOnly;
     }
 
     // Check whether we're updating from an older version
     if (initializationStatus != InitializationStatus::FirstRun) {
         QFile fi(d->resourceLocation + '/' + "KRITA_RESOURCE_VERSION");
         if (!fi.exists()) {
             initializationStatus = InitializationStatus::FirstUpdate;
         }
         else {
             fi.open(QFile::ReadOnly);
             QVersionNumber resource_version = QVersionNumber::fromString(QString::fromUtf8(fi.readAll()));
             QVersionNumber krita_version = QVersionNumber::fromString(KritaVersionWrapper::versionString());
             if (krita_version > resource_version) {
                 initializationStatus = InitializationStatus::Updating;
             }
             else {
                 initializationStatus = InitializationStatus::Initialized;
             }
         }
     }
 
     if (initializationStatus != InitializationStatus::Initialized) {
         KisResourceLocator::LocatorError res = firstTimeInstallation(initializationStatus, installationResourcesLocation);
         if (res != LocatorError::Ok) {
             return res;
         }
         initializationStatus = InitializationStatus::Initialized;
     }
 
     if (!synchronizeDb()) {
         return LocatorError::CannotSynchronizeDb;
     }
 
     return LocatorError::Ok;
 }
 
 QStringList KisResourceLocator::errorMessages() const
 {
     return d->errorMessages;
 }
 
 QString KisResourceLocator::resourceLocationBase() const
 {
     return d->resourceLocation;
 }
 
 bool KisResourceLocator::resourceCached(QString storageLocation, const QString &resourceType, const QString &filename) const
 {
     storageLocation = makeStorageLocationAbsolute(storageLocation);
     QPair<QString, QString> key = QPair<QString, QString> (storageLocation, resourceType + "/" + filename);
 
     return d->resourceCache.contains(key);
 }
 
 void KisResourceLocator::loadRequiredResources(KoResourceSP resource)
 {
     QList<KoResourceLoadResult> requiredResources = resource->requiredResources(KisGlobalResourcesInterface::instance());
 
     Q_FOREACH (KoResourceLoadResult res, requiredResources) {
         switch (res.type())
         {
         case KoResourceLoadResult::ExistingResource:
             KIS_SAFE_ASSERT_RECOVER_NOOP(res.resource()->resourceId() >= 0);
             break;
         case KoResourceLoadResult::EmbeddedResource: {
             KoResourceSignature sig = res.embeddedResource().signature();
             QByteArray data = res.embeddedResource().data();
             QBuffer buffer(&data);
             buffer.open(QBuffer::ReadOnly);
 
             importResource(sig.type, sig.filename, &buffer, false, "memory");
             break;
         }
         case KoResourceLoadResult::FailedLink:
             qWarning() << "Failed to load linked resource:" << res.signature();
             break;
         }
     }
 }
 
 KisTagSP KisResourceLocator::tagForUrl(const QString &tagUrl, const QString resourceType)
 {
     if (d->tagCache.contains(QPair<QString, QString>(resourceType, tagUrl))) {
         return d->tagCache[QPair<QString, QString>(resourceType, tagUrl)];
     }
 
     KisTagSP tag = tagForUrlNoCache(tagUrl, resourceType);
 
     if (tag && tag->valid()) {
         d->tagCache[QPair<QString, QString>(resourceType, tagUrl)] = tag;
     }
 
     return tag;
 }
 
 KisTagSP KisResourceLocator::tagForUrlNoCache(const QString &tagUrl, const QString resourceType)
 {
     QSqlQuery query;
     bool r = query.prepare("SELECT tags.id\n"
                            ",      tags.url\n"
                            ",      tags.active\n"
                            ",      tags.name\n"
                            ",      tags.comment\n"
                            ",      tags.filename\n"
                            ",      resource_types.name as resource_type\n"
                            ",      resource_types.id\n"
                            "FROM   tags\n"
                            ",      resource_types\n"
                            "WHERE  tags.resource_type_id = resource_types.id\n"
                            "AND    resource_types.name = :resource_type\n"
                            "AND    tags.url = :tag_url\n");
 
     if (!r) {
         qWarning() << "Could not prepare KisResourceLocator::tagForUrl query" << query.lastError();
         return KisTagSP();
     }
 
     query.bindValue(":resource_type", resourceType);
     query.bindValue(":tag_url", tagUrl);
 
     r = query.exec();
     if (!r) {
         qWarning() << "Could not execute KisResourceLocator::tagForUrl query" << query.lastError() << query.boundValues();
         return KisTagSP();
     }
 
     r = query.first();
     if (!r) {
         return KisTagSP();
     }
 
     KisTagSP tag(new KisTag());
 
     int tagId = query.value("tags.id").toInt();
     int resourceTypeId = query.value("resource_types.id").toInt();
 
     tag->setUrl(query.value("url").toString());
     tag->setResourceType(resourceType);
     tag->setId(query.value("id").toInt());
     tag->setActive(query.value("active").toBool());
     tag->setName(query.value("name").toString());
     tag->setComment(query.value("comment").toString());
     tag->setFilename(query.value("filename").toString());
     tag->setValid(true);
 
 
     QMap<QString, QString> names;
     QMap<QString, QString> comments;
 
     r = query.prepare("SELECT language\n"
                       ",      name\n"
                       ",      comment\n"
                       "FROM   tag_translations\n"
                       "WHERE  tag_id = :id");
 
     if (!r) {
         qWarning() << "Could not prepare KisResourceLocator::tagForUrl translation query" << query.lastError();
     }
 
     query.bindValue(":id", tag->id());
 
     if (!query.exec()) {
         qWarning() << "Could not execute KisResourceLocator::tagForUrl translation query" << query.lastError();
     }
 
     while (query.next()) {
         names[query.value(0).toString()] = query.value(1).toString();
         comments[query.value(0).toString()] = query.value(2).toString();
     }
 
     tag->setNames(names);
     tag->setComments(comments);
 
     QSqlQuery defaultResourcesQuery;
 
     if (!defaultResourcesQuery.prepare("SELECT resources.filename\n"
                                        "FROM   resources\n"
                                        ",      resource_tags\n"
                                        "WHERE  resource_tags.tag_id = :tag_id\n"
                                        "AND    resources.resource_type_id = :type_id\n"
                                        "AND    resource_tags.resource_id = resources.id\n"
                                        "AND    resource_tags.active = 1\n")) {
         qWarning() << "Could not prepare resource/tag query" << defaultResourcesQuery.lastError();
     }
 
     defaultResourcesQuery.bindValue(":tag_id", tagId);
     defaultResourcesQuery.bindValue(":type_id", resourceTypeId);
 
     if (!defaultResourcesQuery.exec()) {
         qWarning() << "Could not execute resource/tag query" << defaultResourcesQuery.lastError();
     }
 
     QStringList resourceFileNames;
 
     while (defaultResourcesQuery.next()) {
         resourceFileNames << defaultResourcesQuery.value("resources.filename").toString();
     }
 
     tag->setDefaultResources(resourceFileNames);
 
     return tag;
 }
 
 
 KoResourceSP KisResourceLocator::resource(QString storageLocation, const QString &resourceType, const QString &filename)
 {
     storageLocation = makeStorageLocationAbsolute(storageLocation);
 
     QPair<QString, QString> key = QPair<QString, QString> (storageLocation, resourceType + "/" + filename);
 
     KoResourceSP resource;
     if (d->resourceCache.contains(key)) {
         resource = d->resourceCache[key];
     }
     else {
         KisResourceStorageSP storage = d->storages[storageLocation];
         if (!storage) {
             qWarning() << "Could not find storage" << storageLocation;
             return 0;
         }
 
         resource = storage->resource(resourceType + "/" + filename);
 
         if (resource) {
             d->resourceCache[key] = resource;
             // load all the embedded resources into temporary "memory" storage
             loadRequiredResources(resource);
             resource->updateLinkedResourcesMetaData(KisGlobalResourcesInterface::instance());
         }
     }
 
     if (!resource) {
         qWarning() << "KoResourceSP KisResourceLocator::resource" << storageLocation << resourceType << filename << "was not found";
         return 0;
     }
 
     resource->setStorageLocation(storageLocation);
     Q_ASSERT(!resource->storageLocation().isEmpty());
 
     if (resource->resourceId() < 0 || resource->version() < 0) {
         QSqlQuery q;
         if (!q.prepare("SELECT resources.id\n"
                        ",      versioned_resources.version as version\n"
                        ",      versioned_resources.md5sum as md5sum\n"
                        ",      resources.name\n"
                        ",      resources.status\n"
                        "FROM   resources\n"
                        ",      storages\n"
                        ",      resource_types\n"
                        ",      versioned_resources\n"
                        "WHERE  storages.id = resources.storage_id\n"
                        "AND    storages.location = :storage_location\n"
                        "AND    resource_types.id = resources.resource_type_id\n"
                        "AND    resource_types.name = :resource_type\n"
                        "AND    resources.filename  = :filename\n"
                        "AND    versioned_resources.resource_id = resources.id\n"
                        "AND    versioned_resources.version = (SELECT MAX(version) FROM versioned_resources WHERE versioned_resources.resource_id = resources.id)")) {
             qWarning() << "Could not prepare id/version query" << q.lastError();
 
         }
 
         q.bindValue(":storage_location", makeStorageLocationRelative(storageLocation));
         q.bindValue(":resource_type", resourceType);
         q.bindValue(":filename", filename);
 
         if (!q.exec()) {
             qWarning() << "Could not execute id/version query" << q.lastError() << q.boundValues();
         }
 
         if (!q.first()) {
             qWarning() << "Could not find the resource in the database" << storageLocation << resourceType << filename;
         }
 
         resource->setResourceId(q.value(0).toInt());
         Q_ASSERT(resource->resourceId() >= 0);
 
         resource->setVersion(q.value(1).toInt());
         Q_ASSERT(resource->version() >= 0);
 
         resource->setMD5Sum(q.value(2).toString());
         Q_ASSERT(!resource->md5Sum().isEmpty());
 
         resource->setActive(q.value(4).toBool());
 
         // To override resources that use the filename for the name, which is versioned, and we don't want the version number in the name
         resource->setName(q.value(3).toString());;
     }
 
     if (!resource) {
         qWarning() << "Could not find resource" << resourceType + "/" + filename;
         return 0;
     }
 
     return resource;
 }
 
 KoResourceSP KisResourceLocator::resourceForId(int resourceId)
 {
     ResourceStorage rs = getResourceStorage(resourceId);
     KoResourceSP r = resource(rs.storageLocation, rs.resourceType, rs.resourceFileName);
     return r;
 }
 
 bool KisResourceLocator::setResourceActive(int resourceId, bool active)
 {
     // First remove the resource from the cache
     ResourceStorage rs = getResourceStorage(resourceId);
     QPair<QString, QString> key = QPair<QString, QString> (rs.storageLocation, rs.resourceType + "/" + rs.resourceFileName);
 
     d->resourceCache.remove(key);
     if (!active) {
         KisResourceThumbnailCache::instance()->remove(key);
     }
 
     bool result = KisResourceCacheDb::setResourceActive(resourceId, active);
 
     Q_EMIT resourceActiveStateChanged(rs.resourceType, resourceId);
 
     return result;
 }
 
 KoResourceSP KisResourceLocator::importResourceFromFile(const QString &resourceType, const QString &fileName, const bool allowOverwrite, const QString &storageLocation)
 {
     QFile f(fileName);
     if (!f.open(QFile::ReadOnly)) {
         qWarning() << "Could not open" << fileName << "for loading";
         return nullptr;
     }
 
     return importResource(resourceType, fileName, &f, allowOverwrite, storageLocation);
 }
 
 KoResourceSP KisResourceLocator::importResource(const QString &resourceType, const QString &fileName, QIODevice *device, const bool allowOverwrite, const QString &storageLocation)
 {
     KisResourceStorageSP storage = d->storages[makeStorageLocationAbsolute(storageLocation)];
 
     QByteArray resourceData = device->readAll();
     KoResourceSP resource;
 
     {
         QBuffer buf(&resourceData);
         buf.open(QBuffer::ReadOnly);
 
         KisResourceLoaderBase *loader = KisResourceLoaderRegistry::instance()->loader(resourceType, KisMimeDatabase::mimeTypeForFile(fileName));
 
         if (!loader) {
             qWarning() << "Could not import" << fileName << ": resource doesn't load.";
             return nullptr;
         }
 
         resource = loader->load(QFileInfo(fileName).fileName(), buf, KisGlobalResourcesInterface::instance());
     }
 
     if (!resource || !resource->valid()) {
         qWarning() << "Could not import" << fileName << ": resource doesn't load.";
         return nullptr;
     }
 
     const QString md5 = KoMD5Generator::generateHash(resourceData);
     const QString resourceUrl = resourceType + "/" + resource->filename();
 
     const KoResourceSP existingResource = storage->resource(resourceUrl);
 
     if (existingResource) {
         const QString existingResourceMd5Sum = storage->resourceMd5(resourceUrl);
 
         if (!allowOverwrite) {
             return nullptr;
         }
 
         if (existingResourceMd5Sum == md5 &&
             existingResource->filename() == resource->filename()) {
 
             /**
              * Make sure that this resource is the latest version of the
              * resource. Also, we cannot just return existingResource, because
              * it has uninitialized fields. It should go through the initialization
              * by the locator's caching system.
              */
 
             int existingResourceId = -1;
             bool r = KisResourceCacheDb::getResourceIdFromFilename(existingResource->filename(), resourceType, storageLocation, existingResourceId);
 
             if (r && existingResourceId > 0) {
                 return resourceForId(existingResourceId);
             }
         }
 
         qWarning() << "A resource with the same filename but a different MD5 already exists in the storage" << resourceType << fileName << storageLocation;
         if (storageLocation == "") {
             qWarning() << "Proceeding with overwriting the existing resource...";
             // remove all versions of the resource from the resource folder
             QStringList versionsLocations;
 
             // this resource has id -1, we need correct id
             int existingResourceId = -1;
             bool r = KisResourceCacheDb::getResourceIdFromVersionedFilename(existingResource->filename(), resourceType, storageLocation, existingResourceId);
 
             if (r && existingResourceId >= 0) {
                 if (KisResourceCacheDb::getAllVersionsLocations(existingResourceId, versionsLocations)) {
 
                     for (int i = 0; i < versionsLocations.size(); i++) {
                         QFileInfo fi(this->resourceLocationBase() + "/" + resourceType + "/" + versionsLocations[i]);
                         if (fi.exists()) {
                             r = QFile::remove(fi.filePath());
                             if (!r) {
                                 qWarning() << "KisResourceLocator::importResourceFromFile: Removal of " << fi.filePath()
                                            << "was requested, but it wasn't possible, something went wrong.";
                             }
                         } else {
                             qWarning() << "KisResourceLocator::importResourceFromFile: Removal of " << fi.filePath()
                                        << "was requested, but it doesn't exist.";
                         }
                     }
                 } else {
                     qWarning() << "KisResourceLocator::importResourceFromFile: Finding all locations for " << existingResourceId << "was requested, but it failed.";
                     return nullptr;
                 }
             } else {
                 qWarning() << "KisResourceLocator::importResourceFromFile: there is no resource file found in the location of " << storageLocation << resource->filename() << resourceType;
                 return nullptr;
             }
 
             Q_EMIT beginExternalResourceRemove(resourceType, {existingResourceId});
 
             // remove everything related to this resource from the database (remember about tags and versions!!!)
             r = KisResourceCacheDb::removeResourceCompletely(existingResourceId);
 
             Q_EMIT endExternalResourceRemove(resourceType);
 
             if (!r) {
                 qWarning() << "KisResourceLocator::importResourceFromFile: Removing resource with id " << existingResourceId << "completely from the database failed.";
                 return nullptr;
             }
 
         } else {
             qWarning() << "KisResourceLocator::importResourceFromFile: Overwriting of the resource was denied, aborting import.";
             return nullptr;
         }
     }
 
     QBuffer buf(&resourceData);
     buf.open(QBuffer::ReadOnly);
 
     if (storage->importResource(resourceUrl, &buf)) {
         resource = storage->resource(resourceUrl);
 
         if (!resource) {
             qWarning() << "Could not retrieve imported resource from the storage" << resourceType << fileName << storageLocation;
             return nullptr;
         }
 
         resource->setStorageLocation(storageLocation);
         resource->setMD5Sum(storage->resourceMd5(resourceUrl));
         resource->setVersion(0);
         resource->setDirty(false);
         resource->updateLinkedResourcesMetaData(KisGlobalResourcesInterface::instance());
 
         Q_EMIT beginExternalResourceImport(resourceType, 1);
 
         // Insert into the database
         const bool result = KisResourceCacheDb::addResource(storage,
                                                 storage->timeStampForResource(resourceType, resource->filename()),
                                                 resource,
                                                 resourceType);
 
         Q_EMIT endExternalResourceImport(resourceType);
 
         if (!result) {
             return nullptr;
         }
 
         // resourceCaches use absolute locations
         const QString absoluteStorageLocation = makeStorageLocationAbsolute(resource->storageLocation());
         const QPair<QString, QString> key = {absoluteStorageLocation, resourceType + "/" + resource->filename()};
         // Add to the cache
         d->resourceCache[key] = resource;
         KisResourceThumbnailCache::instance()->insert(key, resource->thumbnail());
 
         return resource;
     }
 
     return nullptr;
 }
 
 bool KisResourceLocator::importWillOverwriteResource(const QString &resourceType, const QString &fileName, const QString &storageLocation) const
 {
     KisResourceStorageSP storage = d->storages[makeStorageLocationAbsolute(storageLocation)];
 
     const QString resourceUrl = resourceType + "/" + QFileInfo(fileName).fileName();
 
     const KoResourceSP existingResource = storage->resource(resourceUrl);
 
     return existingResource;
 }
 
 bool KisResourceLocator::exportResource(KoResourceSP resource, QIODevice *device)
 {
     if (!resource || !resource->valid() || resource->resourceId() < 0) return false;
 
     const QString resourceUrl = resource->resourceType().first + "/" + resource->filename();
     KisResourceStorageSP storage = d->storages[makeStorageLocationAbsolute(resource->storageLocation())];
     return storage->exportResource(resourceUrl, device);
 }
 
 bool KisResourceLocator::addResource(const QString &resourceType, const KoResourceSP resource, const QString &storageLocation)
 {
     if (!resource || !resource->valid()) return false;
 
     KisResourceStorageSP storage = d->storages[makeStorageLocationAbsolute(storageLocation)];
     Q_ASSERT(storage);
 
     //If we have gotten this far and the resource still doesn't have a filename to save to, we should generate one.
     if (resource->filename().isEmpty()) {
         resource->setFilename(resource->name().split(" ").join("_") + resource->defaultFileExtension());
     }
 
     if (resource->version() != 0) { // Can happen with cloned resources
         resource->setVersion(0);
     }
 
     // Save the resource to the storage storage
     if (!storage->addResource(resource)) {
         qWarning() << "Could not add resource" << resource->filename() << "to the storage" << storageLocation;
         return false;
     }
 
     resource->setStorageLocation(storageLocation);
     resource->setMD5Sum(storage->resourceMd5(resourceType + "/" + resource->filename()));
     resource->setDirty(false);
     resource->updateLinkedResourcesMetaData(KisGlobalResourcesInterface::instance());
 
     d->resourceCache[QPair<QString, QString>(storageLocation, resourceType + "/" + resource->filename())] = resource;
 
     /// And to the database.
     ///
     /// The metadata will be set by KisResourceCacheDb, which is
     /// not very consistent with KisResourceLocator::updateResource(),
     /// but works :)
     const bool result = KisResourceCacheDb::addResource(storage,
                                                         storage->timeStampForResource(resourceType, resource->filename()),
                                                         resource,
                                                         resourceType);
     return result;
 }
 
 bool KisResourceLocator::updateResource(const QString &resourceType, const KoResourceSP resource)
 {
     QString storageLocation = makeStorageLocationAbsolute(resource->storageLocation());
 
     Q_ASSERT(d->storages.contains(storageLocation));
 
     if (resource->resourceId() < 0) {
         return addResource(resourceType, resource);
     }
 
     KisResourceStorageSP storage = d->storages[storageLocation];
 
     if (!storage->supportsVersioning()) return false;
 
     // remove older version
     KisResourceThumbnailCache::instance()->remove(storageLocation, resourceType, resource->filename());
 
     resource->updateThumbnail();
     resource->setVersion(resource->version() + 1);
     resource->setActive(true);
 
     if (!storage->saveAsNewVersion(resource)) {
         qWarning() << "Failed to save the new version of " << resource->name() << "to storage" << storageLocation;
         return false;
     }
 
     resource->setMD5Sum(storage->resourceMd5(resourceType + "/" + resource->filename()));
     resource->setDirty(false);
     resource->updateLinkedResourcesMetaData(KisGlobalResourcesInterface::instance());
 
     // The version needs already to have been incremented
     if (!KisResourceCacheDb::addResourceVersion(resource->resourceId(), QDateTime::currentDateTime(), storage, resource)) {
         qWarning() << "Failed to add a new version of the resource to the database" << resource->name();
         return false;
     }
 
     if (!setMetaDataForResource(resource->resourceId(), resource->metadata())) {
         qWarning() << "Failed to update resource metadata" << resource;
         return false;
     }
 
     // Update the resource in the cache
     QPair<QString, QString> key = QPair<QString, QString> (storageLocation, resourceType + "/" + resource->filename());
     d->resourceCache[key] = resource;
     KisResourceThumbnailCache::instance()->insert(key, resource->thumbnail());
 
     return true;
 }
 
 bool KisResourceLocator::reloadResource(const QString &resourceType, const KoResourceSP resource)
 {
     // This resource isn't in the database yet, so we cannot reload it
     if (resource->resourceId() < 0) return false;
 
     QString storageLocation = makeStorageLocationAbsolute(resource->storageLocation());
     Q_ASSERT(d->storages.contains(storageLocation));
 
     KisResourceStorageSP storage = d->storages[storageLocation];
 
     if (!storage->loadVersionedResource(resource)) {
         qWarning() << "Failed to reload the resource" << resource->name() << "from storage" << storageLocation;
         return false;
     }
 
     resource->setMD5Sum(storage->resourceMd5(resourceType + "/" + resource->filename()));
     resource->setDirty(false);
     resource->updateLinkedResourcesMetaData(KisGlobalResourcesInterface::instance());
 
     // We haven't changed the version of the resource, so the cache must be still valid
     QPair<QString, QString> key = QPair<QString, QString> (storageLocation, resourceType + "/" + resource->filename());
     Q_ASSERT(d->resourceCache[key] == resource);
 
     return true;
 }
 
 QMap<QString, QVariant> KisResourceLocator::metaDataForResource(int id) const
 {
     return KisResourceCacheDb::metaDataForId(id, "resources");
 }
 
 bool KisResourceLocator::setMetaDataForResource(int id, QMap<QString, QVariant> map) const
 {
     return KisResourceCacheDb::updateMetaDataForId(map, id, "resources");
 }
 
 QMap<QString, QVariant> KisResourceLocator::metaDataForStorage(const QString &storageLocation) const
 {
     QMap<QString, QVariant> metadata;
     if (!d->storages.contains(makeStorageLocationAbsolute(storageLocation))) {
         qWarning() << storageLocation << "not in" << d->storages.keys();
         return metadata;
     }
 
     KisResourceStorageSP st = d->storages[makeStorageLocationAbsolute(storageLocation)];
 
     if (d->storages[makeStorageLocationAbsolute(storageLocation)].isNull()) {
         return metadata;
     }
 
     Q_FOREACH(const QString key, st->metaDataKeys()) {
         metadata[key] = st->metaData(key);
     }
     return metadata;
 }
 
 void KisResourceLocator::setMetaDataForStorage(const QString &storageLocation, QMap<QString, QVariant> map) const
 {
     Q_ASSERT(d->storages.contains(storageLocation));
     Q_FOREACH(const QString &key, map.keys()) {
         d->storages[storageLocation]->setMetaData(key, map[key]);
     }
 }
 
 void KisResourceLocator::purge(const QString &storageLocation)
 {
     Q_FOREACH(const auto key, d->resourceCache.keys()) {
         if (key.first == storageLocation) {
             d->resourceCache.remove(key);
             KisResourceThumbnailCache::instance()->remove(key);
         }
     }
 }
 
 bool KisResourceLocator::addStorage(const QString &storageLocation, KisResourceStorageSP storage)
 {
     if (d->storages.contains(storageLocation)) {
         if (!removeStorage(storageLocation)) {
             qWarning() << "could not remove" << storageLocation;
             return false;
         }
     }
 
     QVector<std::pair<QString, int>> addedResources;
     Q_FOREACH(const QString &type, KisResourceLoaderRegistry::instance()->resourceTypes()) {
         int numAddedResources = 0;
 
         QSharedPointer<KisResourceStorage::ResourceIterator> it = storage->resources(type);
         while (it->hasNext()) {
             it->next();
             numAddedResources++;
         }
 
         if (numAddedResources > 0) {
             addedResources << std::make_pair(type, numAddedResources);
         }
     }
 
     Q_FOREACH (const auto &typedResources, addedResources) {
         Q_EMIT beginExternalResourceImport(typedResources.first, typedResources.second);
     }
 
     d->storages[storageLocation] = storage;
     if (!KisResourceCacheDb::addStorage(storage, false)) {
         d->errorMessages.append(i18n("Could not add %1 to the database", storage->location()));
         qWarning() << d->errorMessages;
         return false;
     }
 
     if (!KisResourceCacheDb::addStorageTags(storage)) {
         d->errorMessages.append(QString("Could not add tags for storage %1 to the cache database").arg(storage->location()));
         qWarning() << d->errorMessages;
         return false;
     }
 
     Q_FOREACH (const auto &typedResources, addedResources) {
         Q_EMIT endExternalResourceImport(typedResources.first);
     }
 
     Q_EMIT storageAdded(makeStorageLocationRelative(storage->location()));
     return true;
 }
 
 bool KisResourceLocator::removeStorage(const QString &storageLocation)
 {
     // Cloned documents have a document storage, but that isn't in the locator.
     if (!d->storages.contains(storageLocation)) {
         return true;
     }
 
     QVector<std::pair<QString, QVector<int>>> removedResources;
 
     Q_FOREACH(const QString &type, KisResourceLoaderRegistry::instance()->resourceTypes()) {
         const QVector<int> resources = KisResourceCacheDb::resourcesForStorage(type, storageLocation);
         if (!resources.isEmpty()) {
             removedResources << std::make_pair(type, resources);
         }
     }
 
     Q_FOREACH (const auto &typedResources, removedResources) {
         Q_EMIT beginExternalResourceRemove(typedResources.first, typedResources.second);
     }
 
     purge(storageLocation);
 
     KisResourceStorageSP storage = d->storages.take(storageLocation);
 
     if (!KisResourceCacheDb::deleteStorage(storage)) {
         d->errorMessages.append(i18n("Could not remove storage %1 from the database", storage->location()));
         qWarning() << d->errorMessages;
         return false;
     }
 
     Q_FOREACH (const auto &typedResources, removedResources) {
         Q_EMIT endExternalResourceRemove(typedResources.first);
     }
 
     Q_EMIT storageRemoved(makeStorageLocationRelative(storage->location()));
 
     return true;
 }
 
 bool KisResourceLocator::hasStorage(const QString &document)
 {
     return d->storages.contains(document);
 }
 
 void KisResourceLocator::saveTags()
 {
     QSqlQuery query;
 
     if (!query.prepare("SELECT tags.url \n"
                        ",      resource_types.name \n"
                        "FROM   tags\n"
                        ",      resource_types\n"
                        "WHERE  tags.resource_type_id = resource_types.id\n"))
     {
         qWarning() << "Could not prepare save tags query" << query.lastError();
         return;
     }
 
     if (!query.exec()) {
         qWarning() << "Could not execute save tags query" << query.lastError();
         return;
     }
 
     // this needs to use ResourcePaths because it is sometimes called during initialization
     // (when the database versions don't match up and tags need to be saved)
     QString resourceLocation = KoResourcePaths::getAppDataLocation() + "/";
 
     while (query.next()) {
         // Save tag...
         KisTagSP tag = tagForUrlNoCache(query.value("tags.url").toString(),
                                  query.value("resource_types.name").toString());
 
         if (!tag || !tag->valid()) {
             continue;
         }
 
 
         QString filename = tag->filename();
         if (filename.isEmpty() || QFileInfo(filename).suffix().isEmpty()) {
             filename = tag->url() + ".tag";
         }
 
 
         if (QFileInfo(filename).suffix() != "tag" && QFileInfo(filename).suffix() != "TAG") {
             // it's either .abr file, or maybe a .bundle
             // or something else, but not a tag file
             dbgResources << "Skipping saving tag " << tag->name(false) << filename << tag->resourceType();
             continue;
         }
 
         filename.remove(resourceLocation);
 
         QFile f(resourceLocation + "/" + tag->resourceType() + '/' + filename);
 
         if (!f.open(QFile::WriteOnly)) {
             qWarning () << "Could not open tag file for writing" << f.fileName();
             continue;
         }
 
         QBuffer buf;
         buf.open(QIODevice::WriteOnly);;
 
         if (!tag->save(buf)) {
             qWarning() << "Could not save tag to" << f.fileName();
             buf.close();
             f.close();
             continue;
         }
 
         f.write(buf.data());
         f.flush();
 
         f.close();
     }
 }
 
 void KisResourceLocator::purgeTag(const QString tagUrl, const QString resourceType)
 {
     d->tagCache.remove(QPair<QString, QString>(resourceType, tagUrl));
 }
 
 QString KisResourceLocator::filePathForResource(KoResourceSP resource)
 {
     const QString storageLocation = makeStorageLocationAbsolute(resource->storageLocation());
     KisResourceStorageSP storage = d->storages[storageLocation];
     if (!storage) {
         qWarning() << "Could not find storage" << storageLocation;
         return QString();
     }
 
     const QString resourceUrl = resource->resourceType().first + "/" + resource->filename();
 
     return storage->resourceFilePath(resourceUrl);
 }
 
 KisResourceLocator::LocatorError KisResourceLocator::firstTimeInstallation(InitializationStatus initializationStatus, const QString &installationResourcesLocation)
 {
     emit progressMessage(i18n("Krita is running for the first time. Initialization will take some time."));
     Q_UNUSED(initializationStatus);
 
     Q_FOREACH(const QString &folder, KisResourceLoaderRegistry::instance()->resourceTypes()) {
         QDir dir(d->resourceLocation + '/' + folder + '/');
         if (!dir.exists()) {
             if (!QDir().mkpath(d->resourceLocation + '/' + folder + '/')) {
                 d->errorMessages << i18n("3. Could not create the resource location at %1.", dir.path());
                 return LocatorError::CannotCreateLocation;
             }
         }
     }
 
     Q_FOREACH(const QString &folder, KisResourceLoaderRegistry::instance()->resourceTypes()) {
         QDir dir(installationResourcesLocation + '/' + folder + '/');
         if (dir.exists()) {
             Q_FOREACH(const QString &entry, dir.entryList(QDir::Files | QDir::Readable)) {
                 QFile f(dir.canonicalPath() + '/'+ entry);
                 if (!QFileInfo(d->resourceLocation + '/' + folder + '/' + entry).exists()) {
                     if (!f.copy(d->resourceLocation + '/' + folder + '/' + entry)) {
                         d->errorMessages << i18n("Could not copy resource %1 to %2", f.fileName(), d->resourceLocation + '/' + folder + '/' + entry);
                     }
                 }
             }
         }
     }
 
     // And add bundles and adobe libraries
     QStringList filters = QStringList() << "*.bundle" << "*.abr" << "*.asl";
     QDirIterator iter(installationResourcesLocation, filters, QDir::Files, QDirIterator::Subdirectories);
     while (iter.hasNext()) {
         iter.next();
         emit progressMessage(i18n("Installing the resources from bundle %1.", iter.filePath()));
         QFile f(iter.filePath());
         Q_ASSERT(f.exists());
         if (!f.copy(d->resourceLocation + '/' + iter.fileName())) {
             d->errorMessages << i18n("Could not copy resource %1 to %2", f.fileName(), d->resourceLocation);
         }
     }
 
     QFile f(d->resourceLocation + '/' + "KRITA_RESOURCE_VERSION");
     f.open(QFile::WriteOnly);
     f.write(KritaVersionWrapper::versionString().toUtf8());
     f.close();
 
     if (!initializeDb()) {
         return LocatorError::CannotInitializeDb;
     }
 
     return LocatorError::Ok;
 }
 
 bool KisResourceLocator::initializeDb()
 {
     emit progressMessage(i18n("Initializing the resources."));
     d->errorMessages.clear();
     findStorages();
 
     Q_FOREACH(auto loader, KisResourceLoaderRegistry::instance()->values()) {
         KisResourceCacheDb::registerResourceType(loader->resourceType());
     }
 
     Q_FOREACH(KisResourceStorageSP storage, d->storages) {
         if (!KisResourceCacheDb::addStorage(storage, (storage->type() == KisResourceStorage::StorageType::Folder ? false : true))) {
             d->errorMessages.append(QString("Could not add storage %1 to the cache database").arg(storage->location()));
         }
     }
 
     Q_FOREACH(KisResourceStorageSP storage, d->storages) {
         if (!KisResourceCacheDb::addStorageTags(storage)) {
             d->errorMessages.append(QString("Could not add tags for storage %1 to the cache database").arg(storage->location()));
         }
     }
     return (d->errorMessages.isEmpty());
 }
 
 void KisResourceLocator::findStorages()
 {
     d->storages.clear();
     d->resourceCache.clear();
 
     // Add the folder
     KisResourceStorageSP storage = QSharedPointer<KisResourceStorage>::create(d->resourceLocation);
     Q_ASSERT(storage->location() == d->resourceLocation);
     d->storages[d->resourceLocation] = storage;
 
     // Add the memory storage
     d->storages["memory"] = QSharedPointer<KisResourceStorage>::create("memory");
     d->storages["memory"]->setMetaData(KisResourceStorage::s_meta_name, i18n("Temporary Resources"));
 
     // And add bundles and adobe libraries
     QStringList filters = QStringList() << "*.bundle" << "*.abr" << "*.asl";
     QDirIterator iter(d->resourceLocation, filters, QDir::Files, QDirIterator::Subdirectories);
     while (iter.hasNext()) {
         iter.next();
         KisResourceStorageSP storage = QSharedPointer<KisResourceStorage>::create(iter.filePath());
         if (!storage->valid()) {
             // we still add the storage to the list and try to read whatever possible
             qWarning() << "KisResourceLocator::findStorages: the storage is invalid" << storage->location();
         }
         d->storages[storage->location()] = storage;
     }
 }
 
 QList<KisResourceStorageSP> KisResourceLocator::storages() const
 {
     return d->storages.values();
 }
 
 KisResourceStorageSP KisResourceLocator::storageByLocation(const QString &location) const
 {
     if (!d->storages.contains(location)) {
         qWarning() << "No" << location << "storage defined:" << d->storages.keys();
         return 0;
     }
     KisResourceStorageSP storage = d->storages[location];
     if (!storage || !storage->valid()) {
         qWarning() << "Could not retrieve the" << location << "storage object or the object is not valid";
         return 0;
     }
 
     return storage;
 }
 
 KisResourceStorageSP KisResourceLocator::folderStorage() const
 {
     return storageByLocation(d->resourceLocation);
 }
 
 KisResourceStorageSP KisResourceLocator::memoryStorage() const
 {
     return storageByLocation("memory");
 }
 
 KisResourceLocator::ResourceStorage KisResourceLocator::getResourceStorage(int resourceId) const
 {
     ResourceStorage rs;
 
     QSqlQuery q;
     bool r = q.prepare("SELECT storages.location\n"
                        ",      resource_types.name as resource_type\n"
                        ",      resources.filename\n"
                        "FROM   resources\n"
                        ",      storages\n"
                        ",      resource_types\n"
                        "WHERE  resources.id = :resource_id\n"
                        "AND    resources.storage_id = storages.id\n"
                        "AND    resource_types.id = resources.resource_type_id");
     if (!r) {
         qWarning() << "KisResourceLocator::removeResource: could not prepare query." << q.lastError();
         return rs;
     }
 
 
     q.bindValue(":resource_id", resourceId);
 
     r = q.exec();
     if (!r) {
         qWarning() << "KisResourceLocator::removeResource: could not execute query." << q.lastError();
         return rs;
     }
 
     q.first();
 
     QString storageLocation = q.value("location").toString();
     QString resourceType= q.value("resource_type").toString();
     QString resourceFilename = q.value("filename").toString();
 
     rs.storageLocation = makeStorageLocationAbsolute(storageLocation);
     rs.resourceType = resourceType;
     rs.resourceFileName = resourceFilename;
 
     return rs;
 }
 
 QString KisResourceLocator::makeStorageLocationAbsolute(QString storageLocation) const
 {
 //    debugResource << "makeStorageLocationAbsolute" << storageLocation;
 
     if (storageLocation.isEmpty()) {
         return resourceLocationBase();
     }
 
     if (QFileInfo(storageLocation).isRelative() && (storageLocation.endsWith(".bundle", Qt::CaseInsensitive)
                                              || storageLocation.endsWith(".asl", Qt::CaseInsensitive)
                                              || storageLocation.endsWith(".abr", Qt::CaseInsensitive))) {
         if (resourceLocationBase().endsWith('/') || resourceLocationBase().endsWith("\\")) {
             storageLocation = resourceLocationBase() + storageLocation;
         }
         else {
             storageLocation = resourceLocationBase() + '/' + storageLocation;
         }
     }
 
 //    debugResource  << "\t" << storageLocation;
     return storageLocation;
 }
 
 bool KisResourceLocator::synchronizeDb()
 {
     d->errorMessages.clear();
 
     // Add resource types that have been added since first-time installation.
     Q_FOREACH(auto loader, KisResourceLoaderRegistry::instance()->values()) {
         KisResourceCacheDb::registerResourceType(loader->resourceType());
     }
 
 
     findStorages();
     Q_FOREACH(const KisResourceStorageSP storage, d->storages) {
         if (!KisResourceCacheDb::synchronizeStorage(storage)) {
             d->errorMessages.append(i18n("Could not synchronize %1 with the database", storage->location()));
         }
     }
 
     Q_FOREACH(const KisResourceStorageSP storage, d->storages) {
         if (!KisResourceCacheDb::addStorageTags(storage)) {
             d->errorMessages.append(i18n("Could not synchronize %1 with the database", storage->location()));
         }
     }
 
     // now remove the storages that no longer exists
     KisStorageModel model;
 
     QList<QString> storagesToRemove;
     for (int i = 0; i < model.rowCount(); i++) {
         QModelIndex idx = model.index(i, 0);
         QString location = model.data(idx, Qt::UserRole + KisStorageModel::Location).toString();
         storagesToRemove << location;
     }
 
     for (int i = 0; i < storagesToRemove.size(); i++) {
         QString location = storagesToRemove[i];
         if (!d->storages.contains(this->makeStorageLocationAbsolute(location))) {
             if (!KisResourceCacheDb::deleteStorage(location)) {
                 d->errorMessages.append(i18n("Could not remove storage %1 from the database", this->makeStorageLocationAbsolute(location)));
                 qWarning() << d->errorMessages;
                 return false;
             }
             emit storageRemoved(this->makeStorageLocationAbsolute(location));
         }
     }
 
 
     d->errorMessages <<
         KisResourceLoaderRegistry::instance()->executeAllFixups();
 
     d->resourceCache.clear();
     return d->errorMessages.isEmpty();
 }
 
 
 QString KisResourceLocator::makeStorageLocationRelative(QString location) const
 {
 //    debugResource << "makeStorageLocationRelative" << location << "locationbase" << resourceLocationBase();
     return location.remove(resourceLocationBase());
 }