Skip to content

Add compression level argument #332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add compression level argument #332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,14 @@ import { MainBundlePath, DocumentDirectoryPath } from 'react-native-fs'

## API

**`zip(source: string | string[], target: string): Promise<string>`**
**`zip(source: string | string[], target: string, compressionLevel?: number): Promise<string>`**

> zip source to target

***NOTE: the string version of source is for folder, the string[] version is for file, so if you want to zip a single file, use zip([file]) instead of zip(file)***

***NOTE: customizing the compression level is not supported on iOS with a files source and will be ignored, use a directory source instead.

Example

```js
Expand All @@ -75,13 +77,15 @@ zip(sourcePath, targetPath)
})
```

**`zipWithPassword(source: string | string[], target: string, password: string, encryptionType: string): Promise<string>`**
**`zipWithPassword(source: string | string[], target: string, password: string, encryptionType?: string, compressionLevel?: number): Promise<string>`**

> zip source to target

***NOTE: the string version of source is for folder, the string[] version is for file, so if you want to zip a single file, use zip([file]) instead of zip(file)***

***NOTE: encryptionType is not supported on iOS yet, so it would be igonred on that platform.***
***NOTE: encryptionType is not supported on iOS yet, so it would be ignored on that platform.***

***NOTE: customizing the compression level is not supported on iOS with a files source and will be ignored, use a directory source instead.

Example

Expand Down
59 changes: 42 additions & 17 deletions android/src/main/java/com/rnziparchive/RNZipArchiveModule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,39 +283,37 @@ public void run() {
}

@ReactMethod
public void zipFiles(final ReadableArray files, final String destDirectory, final Promise promise) {
zip(files.toArrayList(), destDirectory, promise);
public void zipFiles(final ReadableArray files, final String destDirectory, final double compressionLevel, final Promise promise) {
zip(files.toArrayList(), destDirectory, compressionLevel, promise);
}

@ReactMethod
public void zipFolder(final String folder, final String destFile, final Promise promise) {
public void zipFolder(final String folder, final String destFile, final double compressionLevel, final Promise promise) {
ArrayList<Object> folderAsArrayList = new ArrayList<>();
folderAsArrayList.add(folder);
zip(folderAsArrayList, destFile, promise);
zip(folderAsArrayList, destFile, compressionLevel, promise);
}

@ReactMethod
public void zipFilesWithPassword(final ReadableArray files, final String destFile, final String password,
String encryptionMethod, Promise promise) {
zipWithPassword(files.toArrayList(), destFile, password, encryptionMethod, promise);
String encryptionMethod, final double compressionLevel, Promise promise) {
zipWithPassword(files.toArrayList(), destFile, password, encryptionMethod, compressionLevel, promise);
}


@ReactMethod
public void zipFolderWithPassword(final String folder, final String destFile, final String password,
String encryptionMethod, Promise promise) {
String encryptionMethod, final double compressionLevel, Promise promise) {
ArrayList<Object> folderAsArrayList = new ArrayList<>();
folderAsArrayList.add(folder);
zipWithPassword(folderAsArrayList, destFile, password, encryptionMethod, promise);
zipWithPassword(folderAsArrayList, destFile, password, encryptionMethod, compressionLevel, promise);
}

private void zipWithPassword(final ArrayList<Object> filesOrDirectory, final String destFile, final String password,
String encryptionMethod, Promise promise) {
String encryptionMethod, final double compressionLevel, Promise promise) {
try{

ZipParameters parameters = new ZipParameters();
parameters.setCompressionMethod(CompressionMethod.DEFLATE);
parameters.setCompressionLevel(CompressionLevel.NORMAL);
parameters.setCompressionLevel(getCompressionLevel(compressionLevel));

String encParts[] = encryptionMethod.split("-");

Expand Down Expand Up @@ -347,15 +345,13 @@ private void zipWithPassword(final ArrayList<Object> filesOrDirectory, final Str
promise.reject(null, ex.getMessage());
return;
}

}

private void zip(final ArrayList<Object> filesOrDirectory, final String destFile, final Promise promise) {
private void zip(final ArrayList<Object> filesOrDirectory, final String destFile, final double compressionLevel, final Promise promise) {
try{

ZipParameters parameters = new ZipParameters();
parameters.setCompressionMethod(CompressionMethod.DEFLATE);
parameters.setCompressionLevel(CompressionLevel.NORMAL);
parameters.setCompressionLevel(getCompressionLevel(compressionLevel));

processZip(filesOrDirectory, destFile, parameters, promise, null);

Expand Down Expand Up @@ -473,6 +469,36 @@ private long getUncompressedSize(String zipFilePath, String charset) {
return totalSize;
}

private static CompressionLevel getCompressionLevel(double compressionLevel) {
switch (compressionLevel) {
case -1:
return CompressionLevel.NORMAL;
case 0:
return CompressionLevel.NO_COMPRESSION;
case 1:
return CompressionLevel.FASTEST;
case 2:
return CompressionLevel.FASTER;
case 3:
return CompressionLevel.FAST;
case 4:
return CompressionLevel.MEDIUM_FAST;
case 5:
return CompressionLevel.NORMAL;
case 6:
return CompressionLevel.HIGHER;
case 7:
return CompressionLevel.MAXIMUM;
case 8:
return CompressionLevel.PRE_ULTRA;
case 9:
return CompressionLevel.ULTRA;
default:
Log.w(TAG, "Unsupported compression level: " + level + ", defaulting to NORMAL (5)");
return CompressionLevel.NORMAL;
}
}

/**
* Returns the exception stack trace as a string
*/
Expand All @@ -492,5 +518,4 @@ public void addListener(String eventName) {
public void removeListeners(Integer count) {
// Keep: Required for RN built in Event Emitter Calls.
}

}
24 changes: 19 additions & 5 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,27 @@
declare module 'react-native-zip-archive' {
declare module "react-native-zip-archive" {
enum EncryptionMethods {
STANDARD = "STANDARD",
AES_128 = "AES-128",
AES_256 = "AES-256"
AES_256 = "AES-256",
}
import { NativeEventSubscription } from 'react-native';
import { NativeEventSubscription } from "react-native";
export const DEFAULT_COMPRESSION: number;
export const NO_COMPRESSION: number;
export const BEST_SPEED: number;
export const BEST_COMPRESSION: number;
export function isPasswordProtected(source: string): Promise<boolean>;
export function zip(source: string | string[], target: string): Promise<string>;
export function zipWithPassword(source: string | string[], target: string, password: string, encryptionMethod?: encryptionMethods): Promise<string>;
export function zip(
source: string | string[],
target: string,
compressionLevel: number = DEFAULT_COMPRESSION
): Promise<string>;
export function zipWithPassword(
source: string | string[],
target: string,
password: string,
encryptionMethod?: EncryptionMethods,
compressionLevel: number = DEFAULT_COMPRESSION
): Promise<string>;
export function unzip(source: string, target: string, charset?: string): Promise<string>;
export function unzipWithPassword(assetPath: string, target: string, password: string): Promise<string>;
export function unzipAssets(assetPath: string, target: string): Promise<string>;
Expand Down
23 changes: 17 additions & 6 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,19 @@ const rnzaEmitter = new NativeEventEmitter(RNZipArchive);
const normalizeFilePath = (path) =>
path.startsWith("file://") ? path.slice(7) : path;

export const DEFAULT_COMPRESSION = -1;
export const NO_COMPRESSION = 0;
export const BEST_SPEED = 1;
export const BEST_COMPRESSION = 9;

export const unzip = (source, target, charset = "UTF-8") => {
return RNZipArchive.unzip(
normalizeFilePath(source),
normalizeFilePath(target),
charset
);
};

export const isPasswordProtected = (source) => {
return RNZipArchive.isPasswordProtected(normalizeFilePath(source)).then(
(isEncrypted) => !!isEncrypted
Expand All @@ -34,32 +40,37 @@ export const zipWithPassword = (
source,
target,
password,
encryptionMethod = ""
encryptionMethod = "",
compressionLevel = DEFAULT_COMPRESSION,
) => {
return Array.isArray(source)
? RNZipArchive.zipFilesWithPassword(
source.map(normalizeFilePath),
normalizeFilePath(target),
password,
encryptionMethod
encryptionMethod,
compressionLevel
)
: RNZipArchive.zipFolderWithPassword(
normalizeFilePath(source),
normalizeFilePath(target),
password,
encryptionMethod
encryptionMethod,
compressionLevel
);
};

export const zip = (source, target) => {
export const zip = (source, target, compressionLevel = DEFAULT_COMPRESSION) => {
return Array.isArray(source)
? RNZipArchive.zipFiles(
source.map(normalizeFilePath),
normalizeFilePath(target)
normalizeFilePath(target),
compressionLevel
)
: RNZipArchive.zipFolder(
normalizeFilePath(source),
normalizeFilePath(target)
normalizeFilePath(target),
compressionLevel
);
};

Expand Down
21 changes: 18 additions & 3 deletions ios/RNZipArchive.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ -(void)stopObserving {

RCT_EXPORT_METHOD(zipFolder:(NSString *)from
destinationPath:(NSString *)destinationPath
compressionLevel:(double)compressionLevel
resolver:(RCTPromiseResolveBlock)resolve
rejecter:(RCTPromiseRejectBlock)reject) {
self.progress = 0.0;
Expand All @@ -106,7 +107,13 @@ -(void)stopObserving {
BOOL success;
[self setProgressHandler];

success = [SSZipArchive createZipFileAtPath:destinationPath withContentsOfDirectory:from keepParentDirectory:NO withPassword:nil andProgressHandler:self.progressHandler];
success = [SSZipArchive createZipFileAtPath:destinationPath
withContentsOfDirectory:from
keepParentDirectory:NO
compressionLevel:compressionLevel
password:nil
AES:NO
progressHandler:self.progressHandler];

self.progress = 1.0;
[self zipArchiveProgressEvent:1 total:1]; // force 100%
Expand All @@ -121,6 +128,7 @@ -(void)stopObserving {

RCT_EXPORT_METHOD(zipFiles:(NSArray<NSString *> *)from
destinationPath:(NSString *)destinationPath
compressionLevel:(double)compressionLevel
resolver:(RCTPromiseResolveBlock)resolve
rejecter:(RCTPromiseRejectBlock)reject) {
self.progress = 0.0;
Expand All @@ -143,11 +151,11 @@ -(void)stopObserving {
}
}


RCT_EXPORT_METHOD(zipFolderWithPassword:(NSString *)from
destinationPath:(NSString *)destinationPath
password:(NSString *)password
encryptionType:(NSString *)encryptionType
compressionLevel:(double)compressionLevel
resolver:(RCTPromiseResolveBlock)resolve
rejecter:(RCTPromiseRejectBlock)reject) {
self.progress = 0.0;
Expand All @@ -156,7 +164,13 @@ -(void)stopObserving {

BOOL success;
[self setProgressHandler];
success = [SSZipArchive createZipFileAtPath:destinationPath withContentsOfDirectory:from keepParentDirectory:NO withPassword:password andProgressHandler:self.progressHandler];
success = [SSZipArchive createZipFileAtPath:destinationPath
withContentsOfDirectory:from
keepParentDirectory:NO
compressionLevel:compressionLevel
password:password
AES:NO
progressHandler:self.progressHandler];

self.progress = 1.0;
[self zipArchiveProgressEvent:1 total:1]; // force 100%
Expand All @@ -173,6 +187,7 @@ -(void)stopObserving {
destinationPath:(NSString *)destinationPath
password:(NSString *)password
encryptionType:(NSString *)encryptionType
compressionLevel:(double)compressionLevel
resolver:(RCTPromiseResolveBlock)resolve
rejecter:(RCTPromiseRejectBlock)reject) {
self.progress = 0.0;
Expand Down