File indexing completed on 2024-05-12 15:59:49

 /*
  * SPDX-FileCopyrightText: 2018 Boudewijn Rempt <boud@valdyas.org>
  *
  * SPDX-License-Identifier: LGPL-2.0-or-later
  */
 
 #ifndef KISRESOURCECACHEDB_H
 #define KISRESOURCECACHEDB_H
 
 #include <QObject>
 
 #include <kritaresources_export.h>
 
 #include <KisResourceStorage.h>
 
 /**
  * @brief The KisResourceCacheDb class encapsulates the database that
  * caches information about the resources available to the user.
  *
  * KisApplication creates and initializes the database. All other methods
  * are static and can be used from anywhere.
  */
 class KRITARESOURCES_EXPORT KisResourceCacheDb
 {
 public:
 
     static const QString resourceCacheDbFilename; ///< filename of the database
     static const QString databaseVersion; ///< current schema version
     static QStringList storageTypes; ///< kinds of places where resources can be stored
     static QStringList disabledBundles; ///< the list of compatibility bundles that need to inactive by default
 
     /**
      * @brief isValid
      * @return true if the database has been correctly created, false if the database cannot be used
      */
     static bool isValid();
 
     /**
      * @brief lastError returns the last SQL error.
      */
     static QString lastError();
 
     /**
      * @brief initializes the database and updates the scheme if necessary. Does not actually
      * fill the database with pointers to resources.
      *
      * @param location the location of the database
      * @return true if the database has been initialized correctly
      */
     static bool initialize(const QString &location);
 
     /// Delete all storages that are Unknown or Memory and all resources that are marked temporary or belong to Unknown or Memory storages
     static void deleteTemporaryResources();
 
 private:
 
     friend class KisResourceLocator;
     friend class TestResourceLocator;
     friend class TestResourceCacheDb;
     friend class KisAllTagsModel;
     friend class KisResourceLoaderRegistry;
     friend class KisResourceUserOperations;
     friend class KisDocument;
     friend class KisAllResourcesModel;
 
     explicit KisResourceCacheDb(); // Deleted
     ~KisResourceCacheDb(); // Deleted
     KisResourceCacheDb operator=(const KisResourceCacheDb&); // Deleted
     /**
      * @brief registerResourceType registers this resource type in the database
      * @param resourceType the string that represents the type
      * @return true if the type was registered or had already been registered
      */
     static bool registerResourceType(const QString &resourceType);
 
     static QVector<int> resourcesForStorage(const QString &resourceType, const QString &storageLocation);
     static int resourceIdForResource(const QString &resourceFileName, const QString &resourceType, const QString &storageLocation);
     static bool resourceNeedsUpdating(int resourceId, QDateTime timestamp);
 
     /**
      * @brief addResourceVersion adds a new version of the resource to the database.
      * The resource itself already should be updated with the updated filename and version.
      * @param resourceId unique identifier for the resource
      * @param timestamp
      * @param storage
      * @param resource
      * @return true if the database was successfully updated
      */
     static bool addResourceVersion(int resourceId, QDateTime timestamp, KisResourceStorageSP storage, KoResourceSP resource);
 
     static bool addResourceVersionImpl(int resourceId, QDateTime timestamp, KisResourceStorageSP storage, KoResourceSP resource);
     static bool removeResourceVersionImpl(int resourceId, int version, KisResourceStorageSP storage);
 
     static bool updateResourceTableForResourceIfNeeded(int resourceId, const QString &resourceType, KisResourceStorageSP storage);
     static bool makeResourceTheCurrentVersion(int resourceId, KoResourceSP resource);
     static bool removeResourceCompletely(int resourceId);
 
     /// The function will find the resource only if it is the latest version
     static bool getResourceIdFromFilename(QString filename, QString resourceType, QString storageLocation, int &outResourceId);
     /// Note that here you can put even the original filename - any filename from the versioned_resources - and it will still find it
     static bool getResourceIdFromVersionedFilename(QString filename, QString resourceType, QString storageLocation, int& outResourceId);
     static bool getAllVersionsLocations(int resourceId, QStringList &outVersionsLocationsList);
 
 
     static bool addResource(KisResourceStorageSP storage, QDateTime timestamp, KoResourceSP resource, const QString &resourceType);
     static bool addResources(KisResourceStorageSP storage, QString resourceType);
 
     /// Make this resource active or inactive; this does not remove the resource from disk or from the database
     static bool setResourceActive(int resourceId, bool active = false);
 
     static bool tagResource(const QString &resourceFileName, KisTagSP tag, const QString &resourceType);
     static bool hasTag(const QString &url, const QString &resourceType);
     static bool linkTagToStorage(const QString &url, const QString &resourceType, const QString &storageLocation);
     static bool addTag(const QString &resourceType, const QString storageLocation, KisTagSP tag);
     static bool addTags(KisResourceStorageSP storage, QString resourceType);
 
     static bool addStorage(KisResourceStorageSP storage, bool preinstalled);
     static bool addStorageTags(KisResourceStorageSP storage);
 
     /// Actually delete the storage and all its resources from the database (i.e., nothing is set to inactive, it's deleted)
     static bool deleteStorage(KisResourceStorageSP storage);
     /// Actually delete the storage and all its resources from the database (i.e., nothing is set to inactive, it's deleted)
     ///  location - relative
     static bool deleteStorage(QString location);
     static bool synchronizeStorage(KisResourceStorageSP storage);
 
     /**
      * @brief metaDataForId
      * @param id
      * @param tableName
      * @return
      */
     static QMap<QString, QVariant> metaDataForId(int id, const QString &tableName);
 
     /**
      * @brief setMetaDataForId removes all metadata for the given id and table name,
      *  and inserts the metadata in the metadata table.
      * @param id
      * @param tableName
      * @return true if successful, false if not
      */
     static bool updateMetaDataForId(const QMap<QString, QVariant> map, int id, const QString &tableName);
     static bool addMetaDataForId(const QMap<QString, QVariant> map, int id, const QString &tableName);
 
     static bool s_valid;
     static QString s_lastError;
 };
 
 #endif // KISRESOURCECACHEDB_H