/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */

#import <Foundation/Foundation.h>

#import <FBControlCore/FBFuture.h>
#import <FBControlCore/FBProcess.h>

NS_ASSUME_NONNULL_BEGIN

/**
 An enum representing the compression types available.
 */
typedef NS_ENUM(NSUInteger, FBCompressionFormat) {
  FBCompressionFormatGZIP = 1,
  FBCompressionFormatZSTD = 2,
};

@class FBProcessInput;

/**
 Operations of Zip/Tar Archives
 */
@interface FBArchiveOperations : NSObject

/**
 Extracts a tar, or zip file archive to a directory.
 The file can be a:
 - An uncompressed tar.
 - A gzipped tar.
 - A zip.

 @param path the path to the archive.
 @param extractPath the extraction path.
 @param overrideMTime if YES the archive contests' `mtime` will be ignored. Current timestamp will be used as mtime of extracted files/directories.
 @param queue the queue to do work on.
 @param logger the logger to log to.
 @return a Future wrapping the extracted tar destination.
 */
+ (FBFuture<NSString *> *)extractArchiveAtPath:(NSString *)path toPath:(NSString *)extractPath overrideModificationTime:(BOOL)overrideMTime queue:(dispatch_queue_t)queue logger:(id<FBControlCoreLogger>)logger;

/**
 Extracts a tar, or zip stream archive to a directory.
 The stream can be a:
 - An uncompressed tar.
 - A gzipped tar.
 - A zstd compressed tar
 - A zip.

 @param stream the stream of the archive.
 @param extractPath the extraction path
 @param overrideMTime if YES the archive contests' `mtime` will be ignored. Current timestamp will be used as mtime of extracted files/directories.
 @param queue the queue to do work on
 @param logger the logger to log to
 @param compression compression format used by client
 @return a Future wrapping the extracted tar destination.
 */
+ (FBFuture<NSString *> *)extractArchiveFromStream:(FBProcessInput *)stream toPath:(NSString *)extractPath overrideModificationTime:(BOOL)overrideMTime queue:(dispatch_queue_t)queue logger:(id<FBControlCoreLogger>)logger compression:(FBCompressionFormat)compression;

/**
 Extracts a gzip from a stream to a single file.
 A plain gzip wrapping a single file is preferred when there's only a single file to transfer.

 @param stream the stream of the gzip archive.
 @param extractPath the extraction path.
 @param queue the queue to do work on
 @param logger the logger to log to
 @return a Future wrapping the extracted tar destination.
 */
+ (FBFuture<NSString *> *)extractGzipFromStream:(FBProcessInput *)stream toPath:(NSString *)extractPath queue:(dispatch_queue_t)queue logger:(id<FBControlCoreLogger>)logger;

/**
 Creates a gzipped archive compressing the data provided.

 @param input the data to be compressed.
 @param logger the logger to log to.
 @return a Future wrapping the archive data.
 */
+ (FBFuture<FBProcess<id, NSData *, id> *> *)createGzipDataFromProcessInput:(FBProcessInput *)input logger:(id<FBControlCoreLogger>)logger;

/**
 Creates a gzips archive, returning an task that has an NSInputStream attached to stdout.
 A plain gzip wrapping a single file is preferred when there's only a single file to transfer.
 Read the input stream to obtain all of the gzip output of the file.
 To confirm that the stream has been correctly written, the caller should check the exit code of the returned task upon completion.

 @param path the path to archive.
 @param queue the queue to do work on
 @param logger the logger to log to.
 @return a Future containing a task with an NSInputStream attached to stdout.
 */
+ (FBFuture<FBProcess<NSNull *, NSInputStream *, id> *> *)createGzipForPath:(NSString *)path queue:(dispatch_queue_t)queue logger:(id<FBControlCoreLogger>)logger;

/**
 Creates a gzipped tar archive, returning an task that has an NSInputStream attached to stdout.
 Read the input stream to obtain the gzipped tar output.
 To confirm that the stream has been correctly written, the caller should check the exit code of the returned task upon completion.

 @param path the path to archive.
 @param logger the logger to log to.
 @return a Future containing a task with an NSInputStream attached to stdout.
 */
+ (FBFuture<FBProcess<NSNull *, NSInputStream *, id> *> *)createGzippedTarForPath:(NSString *)path logger:(id<FBControlCoreLogger>)logger;

/**
 Creates a gzipped tar archive, returning an the data of the tar.

 @param path the path to archive.
 @param queue the queue to do work on
 @param logger the logger to log to.
 @return a Future containing the tar output.
 */
+ (FBFuture<NSData *> *)createGzippedTarDataForPath:(NSString *)path queue:(dispatch_queue_t)queue logger:(id<FBControlCoreLogger>)logger;

@end

NS_ASSUME_NONNULL_END