xref: /applications/standard/launcher/common/src/main/ets/default/cache/AppResourceCacheManager.ts

/**
 * Copyright (c) 2021-2022 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { Log } from '../utils/Log';
import LruCache from './LruCache';
import DiskLruCache from './DiskLruCache';

const TAG = 'AppResourceCacheManager';

/**
 * A Manager class that provides get/set/clear cache methods for app image data.
 */
export default class AppResourceCacheManager {
  private readonly memoryCache;
  private readonly diskCache;
  private KEY_ICON: string = 'icon';
  private DISK_CACHE_MISS: number = -1;

  constructor() {
    this.memoryCache = new LruCache();
    this.diskCache = new DiskLruCache();
  }

  /**
   * Get cache from disk or memory.
   *
   * @param {string} cacheKey - cacheKey of the cache map
   * @return {object} - cache get from memory or disk
   */
  getCache(cacheKey: string, cacheType: string) {
    const cache = this.getCacheFromMemory(cacheKey, cacheType);
    if (cache == undefined || cache == null || cache == '') {
      if (cacheType === this.KEY_ICON) {
        const cacheFromDisk = this.getCacheFromDisk(cacheKey, cacheType);
        this.setCacheToMemory(cacheKey, cacheType, cacheFromDisk);
        return cacheFromDisk;
      }
      return null;
    } else {
      return cache;
    }
  }

  /**
   * Set cache to disk or memory.
   *
   * @param {string} cacheKey - cacheKey of the cache map
   * @param {object} value - value of the cache map
   */
  setCache(cacheKey: string, cacheType: string, value: object | string) {
    Log.showDebug(TAG, `setCache cacheKey: ${cacheKey}, cacheType: ${cacheType}`);
    this.setCacheToMemory(cacheKey, cacheType, value);
    if (cacheType === this.KEY_ICON) {
      this.setCacheToDisk(cacheKey, cacheType, value);
    }
  }

  /**
   * Clear cache of both disk and memory.
   */
  clearCache(): void {
    Log.showDebug(TAG, 'clearCache');
    this.memoryCache.clear();
  }

  deleteCache(cacheKey: string, cacheType: string): void {
    this.memoryCache.remove(cacheKey);
    if (cacheType === this.KEY_ICON) {
      this.diskCache.remove(cacheKey);
    }
  }

  private getCacheFromMemory(cacheKey: string, cacheType: string) {
    const cache = this.memoryCache.getCache(cacheKey);
    if (cache == undefined || cache == null || cache == '' || cache === -1) {
      return null;
    } else if (cache[cacheType] == undefined || cache[cacheType] == null || cache[cacheType] == '') {
      return null;
    } else {
      return cache[cacheType];
    }
  }

  private setCacheToMemory(cacheKey: string, cacheType: string, value: object | string): void {
    let cache = this.memoryCache.getCache(cacheKey);
    if (cache == undefined || cache == null || cache == '' || cache === -1) {
      cache = {};
      cache[cacheType] = value;
    } else {
      cache[cacheType] = value;
    }
    this.memoryCache.putCache(cacheKey, cache);
  }

  private getCacheFromDisk(cacheKey: string, cacheType: string) {
    const data = this.diskCache.getCache(cacheKey);
    return data !== this.DISK_CACHE_MISS ? data : null;
  }

  private setCacheToDisk(cacheKey: string, cacheType: string, value: object | string): void {
    this.diskCache.putCache(cacheKey, value);
  }
}