Add SetCacheDir API to customize disk cache directory. (#3225)

Author: illidanstormrange

android/libpag/src/main/java/org/libpag/PAGDiskCache.java

@@ -31,6 +31,16 @@
  * Defines methods to manage the disk cache capabilities.
  */
 public class PAGDiskCache {
+    /**
+     * Sets the disk cache directory. This should be called before any disk cache operations.
+     * If the directory does not exist, it will be created automatically.
+     * Note: Changing the cache directory after cache operations have started may cause
+     * existing cached files to become inaccessible.
+     * @param dir The absolute path of the cache directory. Pass null or empty string to use the
+     * platform default cache directory.
+     */
+    public static native void SetCacheDir(String dir);
+
     /**
      * Returns the size limit of the disk cache in bytes. The default value is 1 GB.
      */

include/pag/c/pag_disk_cache.h

@@ -22,6 +22,13 @@
 
 PAG_C_PLUS_PLUS_BEGIN_GUARD
 
+/**
+ * Sets the disk cache directory. This should be called before any disk cache operations.
+ * @param dir The absolute path of the cache directory. Pass NULL or empty string to use the
+ * platform default cache directory.
+ */
+PAG_EXPORT void pag_disk_cache_set_cache_dir(const char* dir);
+
 PAG_EXPORT size_t pag_disk_cache_get_max_disk_size();
 
 PAG_EXPORT void pag_disk_cache_set_max_disk_size(size_t maxDiskSize);

include/pag/pag.h

@@ -1678,6 +1678,16 @@ class PAG_API PAGDecoder {
  */
 class PAG_API PAGDiskCache {
  public:
+  /**
+   * Sets the disk cache directory. This should be called before any disk cache operations.
+   * If the directory does not exist, it will be created automatically.
+   * Note: Changing the cache directory after cache operations have started may cause
+   * existing cached files to become inaccessible.
+   * @param dir The absolute path of the cache directory. Pass an empty string to use the
+   * platform default cache directory.
+   */
+  static void SetCacheDir(const std::string& dir);
+
   /**
    * Returns the size limit of the disk cache in bytes. The default value is 1 GB.
    */

src/c/pag_disk_cache.cpp

@@ -19,6 +19,10 @@
 #include "pag/c/pag_disk_cache.h"
 #include "pag/pag.h"
 
+void pag_disk_cache_set_cache_dir(const char* dir) {
+  pag::PAGDiskCache::SetCacheDir(dir ? dir : "");
+}
+
 size_t pag_disk_cache_get_max_disk_size() {
   return pag::PAGDiskCache::MaxDiskSize();
 }

src/platform/android/JPAGDiskCache.cpp

@@ -29,7 +29,8 @@ void JPAGDiskCache::InitJNI(JNIEnv* env) {
     LOGE("Could not run PAGDiskCache.InitJNI(), PAGClass is not found!");
     return;
   }
-  PAG_GetCacheDir = env->GetStaticMethodID(PAGClass.get(), "GetCacheDir", "()Ljava/lang/String;");
+  PAG_GetCacheDir =
+      env->GetStaticMethodID(PAGClass.get(), "GetCacheDir", "()Ljava/lang/String;");
 }
 
 std::string JPAGDiskCache::GetCacheDir() {
@@ -48,6 +49,11 @@ std::string JPAGDiskCache::GetCacheDir() {
 }  // namespace pag
 
 extern "C" {
+PAG_API void JNICALL Java_org_libpag_PAGDiskCache_SetCacheDir(JNIEnv* env, jclass, jstring dir) {
+  auto cacheDir = pag::SafeConvertToStdString(env, dir);
+  pag::PAGDiskCache::SetCacheDir(cacheDir);
+}
+
 PAG_API jlong JNICALL Java_org_libpag_PAGDiskCache_MaxDiskSize(JNIEnv*, jclass) {
   return static_cast<jlong>(pag::PAGDiskCache::MaxDiskSize());
 }

src/platform/cocoa/PAGDiskCache.h

@@ -24,6 +24,16 @@
  */
 PAG_API @interface PAGDiskCache : NSObject
 
+/**
+ * Sets the disk cache directory. This should be called before any disk cache operations.
+ * If the directory does not exist, it will be created automatically.
+ * Note: Changing the cache directory after cache operations have started may cause
+ * existing cached files to become inaccessible.
+ * @param dir The absolute path of the cache directory. Pass nil or empty string to use the
+ * platform default cache directory.
+ */
++ (void)SetCacheDir:(NSString*)dir;
+
 /**
  * Returns the size limit of the disk cache in bytes. The default value is 1 GB.
  */

src/platform/cocoa/PAGDiskCache.m

@@ -21,6 +21,10 @@
 
 @implementation PAGDiskCache
 
++ (void)SetCacheDir:(NSString*)dir {
+  [PAGDiskCacheImpl SetCacheDir:dir];
+}
+
 + (size_t)MaxDiskSize {
   return [PAGDiskCacheImpl MaxDiskSize];
 }

src/platform/cocoa/private/PAGDiskCacheImpl.h

@@ -20,6 +20,8 @@
 
 @interface PAGDiskCacheImpl : NSObject
 
++ (void)SetCacheDir:(NSString*)dir;
+
 + (size_t)MaxDiskSize;
 
 + (void)SetMaxDiskSize:(size_t)size;

src/platform/cocoa/private/PAGDiskCacheImpl.mm

@@ -22,6 +22,11 @@
 
 @implementation PAGDiskCacheImpl
 
++ (void)SetCacheDir:(NSString*)dir {
+  std::string cacheDir = dir ? [dir UTF8String] : "";
+  pag::PAGDiskCache::SetCacheDir(cacheDir);
+}
+
 + (size_t)MaxDiskSize {
   return pag::PAGDiskCache::MaxDiskSize();
 }

src/rendering/caches/DiskCache.cpp

@@ -25,6 +25,7 @@
 #include "tgfx/core/Stream.h"
 
 namespace pag {
+
 class FileInfo {
  public:
   FileInfo(std::string cacheKey, uint32_t fileID, size_t fileSize = 0)
@@ -37,6 +38,10 @@ class FileInfo {
   std::list<std::shared_ptr<FileInfo>>::iterator cachedPosition;
 };
 
+void PAGDiskCache::SetCacheDir(const std::string& dir) {
+  DiskCache::GetInstance()->setCacheDir(dir);
+}
+
 size_t PAGDiskCache::MaxDiskSize() {
   return DiskCache::GetInstance()->getMaxDiskSize();
 }
@@ -49,6 +54,24 @@ void PAGDiskCache::RemoveAll() {
   DiskCache::GetInstance()->removeAll();
 }
 
+std::string DiskCache::getCacheDir() {
+  if (!customCacheDir.empty()) {
+    return customCacheDir;
+  }
+  return Platform::Current()->getCacheDir();
+}
+
+void DiskCache::setCacheDir(const std::string& dir) {
+  std::lock_guard<std::mutex> autoLock(locker);
+  customCacheDir = dir;
+  // Update cache paths
+  auto cacheDir = dir.empty() ? Platform::Current()->getCacheDir() : dir;
+  if (!cacheDir.empty()) {
+    configPath = Directory::JoinPath(cacheDir, "cache.cfg");
+    cacheFolder = Directory::JoinPath(cacheDir, "files");
+  }
+}
+
 DiskCache* DiskCache::GetInstance() {
   static auto& diskCache = *new DiskCache();
   return &diskCache;
@@ -69,7 +92,7 @@ bool DiskCache::WriteFile(const std::string& key, std::shared_ptr<tgfx::Data> da
 }
 
 DiskCache::DiskCache() {
-  auto cacheDir = Platform::Current()->getCacheDir();
+  auto cacheDir = getCacheDir();
   if (!cacheDir.empty()) {
     configPath = Directory::JoinPath(cacheDir, "cache.cfg");
     cacheFolder = Directory::JoinPath(cacheDir, "files");