de.florianmichael.rclasses.common

Class FileUtils

java.lang.Object

de.florianmichael.rclasses.common.FileUtils

public class FileUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
FileUtils()

Method Summary

Modifier and Type	Method and Description
static void	deleteFolder(java.io.File folder) Deletes a folder and all its content
static java.io.File	downloadFile(java.lang.String url, java.io.File output) Downloads a file from the internet and saves it to the given output file.
static java.io.File	downloadFile(java.lang.String url, java.lang.String agent, java.io.File output) Downloads a file from the internet and saves it to the given output file.
static void	extractFile(java.util.zip.ZipInputStream zipIn, java.lang.String filePath) Extracts a file from the given zip input stream to the given file path.
static void	unzip(java.lang.String zipFilePath, java.lang.String destDirectory) Unzips the given zip file to the given target directory.
static void	unzipFolder(java.io.File source, java.nio.file.Path target) Unzips the given zip file to the given target directory.
static java.nio.file.Path	zipSlipProtect(java.util.zip.ZipEntry zipEntry, java.nio.file.Path targetDir) Protects against zip slip vulnerability.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileUtils

public FileUtils()

Method Detail

downloadFile

public static java.io.File downloadFile(java.lang.String url,
                                        java.io.File output)
                                 throws java.lang.Throwable

Downloads a file from the internet and saves it to the given output file.

Parameters:

url - The url to download the file from.

output - The file to save the downloaded file to.

Returns:

The output file.

Throws:

java.lang.Throwable - If an error occurs while downloading the file.

downloadFile

public static java.io.File downloadFile(java.lang.String url,
                                        java.lang.String agent,
                                        java.io.File output)
                                 throws java.lang.Throwable

Downloads a file from the internet and saves it to the given output file.

Parameters:

url - The url to download the file from.

agent - The user agent to use.

output - The file to save the downloaded file to.

Returns:

The output file.

Throws:

java.lang.Throwable - If an error occurs while downloading the file.

unzipFolder

public static void unzipFolder(java.io.File source,
                               java.nio.file.Path target)
                        throws java.io.IOException

Unzips the given zip file to the given target directory.

Parameters:

source - the zip file

target - the target directory

Throws:

java.io.IOException - if an I/O error occurs

unzip

public static void unzip(java.lang.String zipFilePath,
                         java.lang.String destDirectory)
                  throws java.io.IOException

Unzips the given zip file to the given target directory.

Parameters:

zipFilePath - the zip file

destDirectory - the target directory

Throws:

java.io.IOException - if an I/O error occurs

extractFile

public static void extractFile(java.util.zip.ZipInputStream zipIn,
                               java.lang.String filePath)
                        throws java.io.IOException

Extracts a file from the given zip input stream to the given file path.

Parameters:

zipIn - the zip input stream

filePath - the file path

Throws:

java.io.IOException - if an I/O error occurs

zipSlipProtect

public static java.nio.file.Path zipSlipProtect(java.util.zip.ZipEntry zipEntry,
                                                java.nio.file.Path targetDir)
                                         throws java.io.IOException

Protects against zip slip vulnerability.

Parameters:

zipEntry - the zip entry

targetDir - the target directory

Returns:

the normalized path

Throws:

java.io.IOException - if an I/O error occurs

deleteFolder

public static void deleteFolder(java.io.File folder)
                         throws java.io.IOException

Deletes a folder and all its content

Parameters:

folder - the folder to delete

Throws:

java.io.IOException - if an I/O error occurs