//
//  BU_PAG_IESGurdCacheManager.h
//  PAG_IESGurdKit
//
//  Created by willorfang on 2017/11/2.
//
//

#import "PAG_IESGeckoResourceModel.h"
#import "PAG_IESGeckoDefines.h"
#import "PAG_IESGurdPackagesConfigRequest.h"

@class PAG_IESGurdCacheConfiguration;

NS_ASSUME_NONNULL_BEGIN

@interface PAG_IESGurdCacheManager : NSObject


/**
 * @brief 将所有未激活的缓存进行激活
 */
+ (void)applyAllInactiveCacheWithCompletion:(IESGurdSyncStatusBlock)completion;

/**
 * @brief 将指定accesskey & channel下未激活的缓存进行激活
 */
+ (void)applyInactiveCacheForAccessKey:(NSString *)accessKey
                               channel:(NSString *)channel
                            completion:(IESGurdSyncStatusBlock)completion;

/**
1）请求最新的package配置信息
2）下载最新package包
*/
+ (void)downloadResourcesWithRequest:(PAG_IESGurdPackagesConfigRequest *)request
                          completion:(IESGurdSyncAccessKeyStatusDictionaryBlock)completion;

/**
 1）请求最新的package配置信息
 2）下载最新package包，解压、激活
 */
+ (void)syncResourcesWithRequest:(PAG_IESGurdPackagesConfigRequest *)request
                      completion:(IESGurdSyncAccessKeyStatusDictionaryBlock)completion;

/**
 异步加载指定资源
 */
+ (void)loadResourceForAccessKey:(NSString *)accessKey
                         channel:(NSString *)channel
                            path:(NSString *)path
                          option:(IESGurdLoadResourceOption)option
                    customParams:(NSDictionary * _Nullable)customParams
                      completion:(IESGurdLoadResourceCompletion)completion;

#pragma mark - Cache management

/**
 * @brief 是否有缓存
 *
 * @param path      文件相对路径
 * @param accessKey 包名
 * @param channel   渠道名
 *                  文件绝对路径：Library/Caches/IESWebCache/<accessKey>/<channel>/<path>
 */
+ (BOOL)hasCacheForPath:(NSString *)path accessKey:(NSString *)accessKey channel:(NSString *)channel;

/**
* @brief 读取缓存数据
*/
+ (NSData *)dataForPath:(NSString *)path accessKey:(NSString *)accessKey channel:(NSString *)channel options:(NSDataReadingOptions)options;

/**
* @brief 异步读取缓存数据
*/
+ (void)asyncGetDataForPath:(NSString *)path
                  accessKey:(NSString *)accessKey
                    channel:(NSString *)channel
                 completion:(IESGurdAccessResourceCompletion)completion;

/**
 * @brief 返回文件类型；如果文件未激活，则返回-1
 */
+ (IESGurdChannelFileType)fileTypeForAccessKey:(NSString *)accessKey channel:(NSString *)channel;

/**
* @brief 返回文件版本；如果文件未激活，则返回0
*/
+ (uint64_t)packageVersionForAccessKey:(NSString *)accessKey channel:(NSString *)channel;

/**
 * @brief 获取指定accessKey根目录
 */
+ (NSString *)rootDirForAccessKey:(NSString *)accessKey;

/**
 * @brief 获取指定channel根目录
 */
+ (NSString *)rootDirForAccessKey:(NSString *)accessKey channel:(NSString *)channel;

/**
 返回channel缓存的状态
 */
+ (IESGurdChannelCacheStatus)cacheStatusForAccessKey:(NSString *)accessKey channel:(NSString *)channel;

/**
 * @brief 清除cache
 */
+ (void)cleanCache;

/**
 根据accessKey和channel清理对应的缓存;
 */
+ (void)cleanCacheForAccessKey:(NSString *)accessKey
                       channel:(NSString *)channel;

/**
 清理临时文件
*/
+ (void)cleanTempFiles;

#pragma mark - Clean

/**
 设置缓存策略
 */
+ (void)setCacheConfiguration:(PAG_IESGurdCacheConfiguration *)configuration
                 forAccessKey:(NSString *)accessKey;

/**
 添加channel白名单，不被清理
 */
+ (void)addChannelsWhitelist:(NSArray<NSString *> *)channels
                forAccessKey:(NSString *)accessKey;

@end

NS_ASSUME_NONNULL_END