Unrar

Introduction

This library is adapted based on Unrar to ensure compatibility with OpenHarmony, while retaining its original usage and features. Unrar is a decompression library for RAR files. It provides the following capabilities:

• Checking whether a package is encrypted
• Decompressing a file to the specified path
• Decompressing an unencrypted or encrypted package

How to Install

ohpm install @ohos/unrar

For details about the OpenHarmony ohpm environment configuration, see OpenHarmony HAR.

Configuring the x86 Emulator

See Running Your App/Service on an Emulator.

How to Use

import unrar from '@ohos/unrar'

Checking Whether a Package Is Encrypted

// path: file path. Currently, only the sandbox path is supported.
unrar.isEncrypted(path)

Decompressing an Unencrypted File

unrar.RarFiles_Extract(path, globalThis.context.filesDir).then((value) => {
                let resultss;
                if (value = ='Decompression succeeded') {
                  resultss = 'The testRar5.rar file is decompressed successfully. The decompressed file is stored in:' + globalThis.context.filesDir;
                } else {
                  resultss = value;
                }
                this.tag = true;
                this.showDialog(resultss)
              }).catch((error) => {
                this.tag = true;
                this.showDialog('Decompression failed.')
              });

Decompressing an Encrypted File

unrar.RarFiles_Extract(path, globalThis.context.filesDir, passwords).then((value) => {
                  let resultss;
                  if (value = ='Decompression succeeded') {
                    resultss = 'The name_encrypted.rar file is decompressed successfully. The decompressed file is stored in:' + globalThis.context.filesDir;
                  } else {
                    resultss = 'Decompression failed.'
                  }
                  this.showDialog(resultss)
                }).catch((error) => {
                  this.showDialog('Decompression failed.')
                });

Available APIs

API	Parameter	Description
isEncrypted	(path:string)=>number	Checks whether a package is encrypted.
extract	(path: string, dest: string, password?: string)=>string	Synchronously decompresses a file.
RarFiles_Extract	(path: string, dest: string, callBack: ICallBack, password?: string)=>void	Asynchronously decompresses a file.

About obfuscation

• Code obfuscation, please seeCode Obfuscation
• If you want the unrar library not to be obfuscated during code obfuscation, you need to add corresponding exclusion rules in the obfuscation rule configuration file obfuscation-rules.txt：

-keep
./oh_modules/@ohos/unrar

Constraints

This project has been verified in the following versions:

DevEco Studio: NEXT Beta1-5.0.3.806, SDK: API12 Release(5.0.0.66)

• DevEco Studio: (5.0.3.122), SDK: API 12 (5.0.0.17)

Directory Structure

|---- ohosunrar
|     |---- entry  # Sample code
|     |---- library  # Unrar library
|           |---- src   #  Decompression core code of the unrar library
|                 |---- cpp # Core code of unrar
|     |---- README_EN.md  # Readme

How to Contribute

If you find any problem when using unrar, submit an issue or a PR.

License

This project is licensed under Apache License 2.0.