com.atlassian.bamboo.util

Class BambooFileUtils

java.lang.Object

com.atlassian.bamboo.util.BambooFileUtils

public class BambooFileUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static Supplier<File>	JAVA_IO_SHORT_TMPDIR The value of SystemUtils.JAVA_IO_TMPDIR.

Method Summary

Modifier and Type	Method and Description
static String	calculateRelativePath(File directory, File file) Calculates a relative path to a file from the given directory.
static void	cleanDirectory(File directory) Deprecated. since 5.10 try using BambooPathUtils.cleanDirectory(Path)) instead
static boolean	contains(File file, Pattern pattern) This method checks whether given pattern occurs in a file.
static boolean	containsRegex(File file, String regexToMatch) Convenience method.
static void	createDirectoryIfNotExists(File directory) Create directory if not present.
static Supplier<File>	createDirectorySupplier(File directory)
static Supplier<File>	createDirectorySupplier(Supplier<File> delegate) Supplies directory.
static void	createFileWithSize(File file, long size) Creates a file of exact size (in bytes).
static File	createSafeTempFile(String name, File dir) Deprecated. since 5.4 use SecureTemporaryFiles class
static File	createSafeTempFile(String prefix, String suffix) Deprecated. since 5.4 use SecureTemporaryFiles class
static File	createSafeTempFile(String prefix, String suffix, File dir) Deprecated. since 5.4 use SecureTemporaryFiles class
static File	createTempDirectory(File parentDir, String prefix) Deprecated. since 6.4 use java.nio.file.Files.createTempDirectory() instead
static File	createTempDirectory(Object client)
static File	createTempDirectory(String prefix)
static void	deleteDirectory(File directory) Deprecated. since 5.10 use BambooPathUtils.deleteDirectory(Path)
static boolean	deleteQuietly(File fileOrDir) Deprecated. since 5.10 use BambooPathUtils.deleteQuietly(Path) instead
static void	forceDelete(File file) Deprecated. since 5.10 use instead
static Iterable<File>	getFilesFromFileSet(org.apache.tools.ant.types.FileSet fileSet) Returns an Iterable of Files converted from Apache's FileSet of FileResources.
static File	getSharedTemporaryFile(SharedTemporaryFiles.SharedTemporaryFileSpec temporaryFileSpec) Deprecated. since 5.4 use SharedTemporaryFiles.create(com.atlassian.bamboo.util.SharedTemporaryFiles.SharedTemporaryFileSpec)
static File	getSharedTemporaryFile(String content, String prefix, String suffix, boolean executable, File directory) Deprecated. since 4.4 use SharedTemporaryFiles.create(com.atlassian.bamboo.util.SharedTemporaryFiles.SharedTemporaryFileSpec)
static File	getSingleFileFromDirectory(File directory) Obtain a single file from a directory.
static boolean	isContainsDirectoryTraversalString(String name) Deprecated. since 5.10 use BambooFilenameUtils.containsDirectoryTraversalString(String)
static boolean	isDirectoryImportant(File directory) Checks a path against a defined list of directories to see if it is important (and should not be deleted)
static boolean	isDirectoryOrLinkToDirectory(File file) Checks whether a File is a directory or a link to a directory.
static void	moveDirectoryContentToDirectory(File src, File destDir, boolean createDestDir) Moves directory content to destination directory.
static File	newFileUnderParent(File parent, String child) Deprecated. since 5.12 use BambooFiles.resolvePathUnderParent(Path, String) instead
static String	pathFromComponents(String... pathComponents)
static Supplier<File>	persistentFileSupplier(Supplier<File> fileSupplier) Supplies Files.
static org.apache.commons.io.filefilter.IOFileFilter	regexPathFilter(String pathPattern) Returns an IOFileFilter that performs a full path match against the supplied pattern.
static String	relativizePath(File rootDirectory, File workingDirectory, String path) Given parent and child directories, and a path relative to parent directory, return path relative to the child directory.
static void	renameTo(File from, File to) Renames a file or directory.
static File	safeWriteStringToFile(String string, String prefix, String suffix, File directory) Writes a string to a newly created temporary file in as safe manner as possible.
static boolean	setExecutableByOwnerOnly(File file) Sets the file permissions so that only the owner can execute a file
static boolean	setReadableByOwnerOnly(File file) Deprecated. since 6.4 use BambooFiles.setAccessibleOnlyByOwner(Path)
static boolean	setWritableByOwnerOnly(File file) Deprecated. since 6.4 use BambooFiles.setAccessibleOnlyByOwner(Path)
static List<String>	splitPathToComponents(String path)

Methods inherited from class java.lang.Object

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

Field Detail

JAVA_IO_SHORT_TMPDIR

public static final Supplier<File> JAVA_IO_SHORT_TMPDIR

The value of SystemUtils.JAVA_IO_TMPDIR. On Windows, it will be shortened to 8.3 format.

Method Detail

isDirectoryImportant

public static boolean isDirectoryImportant(@Nullable
                                           File directory)

Checks a path against a defined list of directories to see if it is important (and should not be deleted)

Parameters:

directory -

Returns:

important

isDirectoryOrLinkToDirectory

public static boolean isDirectoryOrLinkToDirectory(File file)

Checks whether a File is a directory or a link to a directory.

Parameters:

file - File expected to be a directory.

Returns:

true if the file is a directory or a link to a directory, false otherwise.

createTempDirectory

public static File createTempDirectory(@NotNull
                                       Object client)
                                throws IOException

Throws:

IOException

createTempDirectory

@Deprecated
public static File createTempDirectory(@Nullable
                                                   File parentDir,
                                                   @NotNull
                                                   String prefix)
                                            throws IOException

Deprecated. since 6.4 use java.nio.file.Files.createTempDirectory() instead

Create a temporary directory in specified location.

Parameters:

parentDir - null indicates default tmp directory

prefix - filename prefix

Returns:

temporary directory in specified location

Throws:

IOException

createTempDirectory

public static File createTempDirectory(@NotNull
                                       String prefix)
                                throws IOException

Throws:

IOException

createSafeTempFile

@Deprecated
public static File createSafeTempFile(@NotNull
                                                  String name,
                                                  @Nullable
                                                  File dir)
                                           throws IOException

Deprecated. since 5.4 use SecureTemporaryFiles class

Throws:

IOException

createSafeTempFile

@Deprecated
public static File createSafeTempFile(@NotNull
                                                  String prefix,
                                                  @Nullable
                                                  String suffix)
                                           throws IOException

Deprecated. since 5.4 use SecureTemporaryFiles class

see File.createTempFile(java.lang.String, java.lang.String, java.io.File) and createSafeTempFile(String, File)

Parameters:

prefix -

suffix -

Throws:

IOException

createSafeTempFile

@Deprecated
public static File createSafeTempFile(@NotNull
                                                  String prefix,
                                                  @Nullable
                                                  String suffix,
                                                  @Nullable
                                                  File dir)
                                           throws IOException

Deprecated. since 5.4 use SecureTemporaryFiles class

see File.createTempFile(java.lang.String, java.lang.String, java.io.File) and createSafeTempFile(String, java.io.File)

Parameters:

prefix -

suffix -

Throws:

IOException

setWritableByOwnerOnly

@Deprecated
public static boolean setWritableByOwnerOnly(File file)

Deprecated. since 6.4 use BambooFiles.setAccessibleOnlyByOwner(Path)

Sets the file permissions so that only the owner can write to a file

Parameters:

file -

Returns:

if permission change was successful

setReadableByOwnerOnly

@Deprecated
public static boolean setReadableByOwnerOnly(File file)

Deprecated. since 6.4 use BambooFiles.setAccessibleOnlyByOwner(Path)

Sets the file permissions so that only the owner can read from a file

Parameters:

file -

Returns:

if permission change was successful, always false on Windows

setExecutableByOwnerOnly

public static boolean setExecutableByOwnerOnly(File file)

Sets the file permissions so that only the owner can execute a file

Parameters:

file -

Returns:

if permission change was successful

safeWriteStringToFile

@NotNull
public static File safeWriteStringToFile(@NotNull
                                                  String string,
                                                  @NotNull
                                                  String prefix,
                                                  @Nullable
                                                  String suffix,
                                                  @Nullable
                                                  File directory)
                                           throws IOException

Writes a string to a newly created temporary file in as safe manner as possible. On Windows, the file content can still be hijacked by a member of the same group as the user creating the file. The fact that this method exists does not mean that you should use it, unless absolutely necessary.

Parameters:

string - the string to write

Returns:

the created file, should be deleted after use

Throws:

IOException

See Also:

File#createTempFile(String, String, File))

splitPathToComponents

@NotNull
public static List<String> splitPathToComponents(@NotNull
                                                          String path)

pathFromComponents

@NotNull
public static String pathFromComponents(@NotNull
                                                 String... pathComponents)

contains

public static boolean contains(File file,
                               Pattern pattern)
                        throws IOException

This method checks whether given pattern occurs in a file. Empty pattern is always found. File is assumed to be UTF8. Malformed, non-utf character sequences will be ignored.

Parameters:

file - the file to check

pattern - the pattern to search for

Returns:

true if pattern is found

Throws:

IOException - in case of file access problems

containsRegex

public static boolean containsRegex(@NotNull
                                    File file,
                                    @NotNull
                                    String regexToMatch)
                             throws IOException

Convenience method.

Throws:

IOException

See Also:

contains(File, Pattern)

relativizePath

public static String relativizePath(@NotNull
                                    File rootDirectory,
                                    @NotNull
                                    File workingDirectory,
                                    @Nullable
                                    String path)

Given parent and child directories, and a path relative to parent directory, return path relative to the child directory.

Parameters:

rootDirectory - root directory

workingDirectory - working directory (must be inside root directory)

path - path relative to root directory

Returns:

path relative to working directory

calculateRelativePath

public static String calculateRelativePath(@NotNull
                                           File directory,
                                           @NotNull
                                           File file)

Calculates a relative path to a file from the given directory. The file must exist inside the directory, otherwise the absolute path to the file will be returned.

Example:

     directory:       /home/user/
     file:            /home/user/documents/credits.txt
     ...
     relative path:   documents/credits.txt
 

Parameters:

directory - the directory from which the path should be calculated

file - the file to which the path should be calculated; can be a directory too

Returns:

relative path to the file

renameTo

public static void renameTo(File from,
                            File to)
                     throws IOException

Renames a file or directory. Supports cases when a rename would cause the source file to be moved between volumes regardless of support in the underlying platform.

Parameters:

from - the source file/directory

to - the new location of source file

Throws:

IOException - if the destination file/directory already exists or move operation fails for other reason

moveDirectoryContentToDirectory

public static void moveDirectoryContentToDirectory(@NotNull
                                                   File src,
                                                   @NotNull
                                                   File destDir,
                                                   boolean createDestDir)
                                            throws IOException

Moves directory content to destination directory.

Parameters:

src - - the directory which content should be moved

destDir - - the destination directory

createDestDir - - If true create the destination directory, otherwise if false throw an IOException

Throws:

NullPointerException - - if source or destination is null

org.apache.commons.io.FileExistsException - - if the directory or file exists in the destination directory

IOException - - if source or destination is invalid

IOException - - if an IO error occurs moving the file

getSharedTemporaryFile

@Deprecated
public static File getSharedTemporaryFile(@NotNull
                                                      String content,
                                                      @NotNull
                                                      String prefix,
                                                      @Nullable
                                                      String suffix,
                                                      boolean executable,
                                                      @Nullable
                                                      File directory)
                                               throws IOException

Deprecated. since 4.4 use SharedTemporaryFiles.create(com.atlassian.bamboo.util.SharedTemporaryFiles.SharedTemporaryFileSpec)

Returns a file with given prefix, suffix and content in the specified directory. If the file already exists and was not created using this method, it's first deleted, otherwise an existing handle will be returned and no I/O will take place. Do not cache the returned reference or file name for a long time: the file will exist for 5 minutes after the call to this method is made. Repeated calls to this method with the same parameters reset the remaining file lifetime to 5 minutes.

Parameters:

content - the content that the file should have

prefix - the file name prefix

suffix - the file name suffix

executable - whether or not make the file executable

directory - the directory in which to create file (temp directory unless specified otherwise)

Returns:

Throws:

IOException

getSharedTemporaryFile

@Deprecated
public static File getSharedTemporaryFile(@NotNull
                                                      SharedTemporaryFiles.SharedTemporaryFileSpec temporaryFileSpec)
                                               throws IOException

Deprecated. since 5.4 use SharedTemporaryFiles.create(com.atlassian.bamboo.util.SharedTemporaryFiles.SharedTemporaryFileSpec)

Returns a file with given prefix, suffix and content in the specified directory. If the file already exists and was not created using this method, it's first deleted, otherwise an existing handle will be returned and no I/O will take place. Do not cache the returned reference or file name for a long time: the file will exist for 5 minutes after the call to this method is made. Repeated calls to this method with the same parameters reset the remaining file lifetime to 5 minutes.

Parameters:

temporaryFileSpec - the directory in which to create file (temp directory unless specified otherwise)

Returns:

a file with given prefix, suffix and content in the specified directory

Throws:

IOException

persistentFileSupplier

public static Supplier<File> persistentFileSupplier(Supplier<File> fileSupplier)

Supplies Files. If the file supplied in the previous call exists, it's returned. If it no longer exists, it's recreated.

createDirectorySupplier

public static Supplier<File> createDirectorySupplier(Supplier<File> delegate)

Supplies directory. Makes sure that directory exists.

createDirectorySupplier

public static Supplier<File> createDirectorySupplier(File directory)

regexPathFilter

public static org.apache.commons.io.filefilter.IOFileFilter regexPathFilter(@NotNull
                                                                            String pathPattern)

Returns an IOFileFilter that performs a full path match against the supplied pattern.

newFileUnderParent

@Deprecated
public static File newFileUnderParent(@NotNull
                                                  File parent,
                                                  @NotNull
                                                  String child)
                                           throws IOException

Deprecated. since 5.12 use BambooFiles.resolvePathUnderParent(Path, String) instead

Fulfills the general contract of File.File(java.io.File, String). The returned file is always in canonical format and always rooted under the parent argument. Attempts to traverse out of the parent directory will result in IllegalArgumentException being thrown.

Parameters:

parent - parent directory

child - child under parent directory. Relative paths are allowed as long as the result is under the parent directory

Returns:

a canonical child File rooted under parent directory

Throws:

IOException - if a problem occurred during directory tree access

isContainsDirectoryTraversalString

@Deprecated
public static boolean isContainsDirectoryTraversalString(@Nullable
                                                                     String name)

Deprecated. since 5.10 use BambooFilenameUtils.containsDirectoryTraversalString(String)

Basic validation of a String to see if it contains directory traversal chars. Prefer using BambooPathUtils#resolvePathUnderParent(Path, String) but can use when that is not practical

createFileWithSize

public static void createFileWithSize(@NotNull
                                      File file,
                                      long size)
                               throws IOException

Creates a file of exact size (in bytes).

The file may exist prior to calling this method - in such case it's content will be overwritten.

The size has to be a non-negative value. The parent directory of the file must exist.

Parameters:

file - file to create

size - size of the file (in bytes)

Throws:

IOException

createDirectoryIfNotExists

public static void createDirectoryIfNotExists(File directory)
                                       throws IllegalStateException

Create directory if not present.

Parameters:

directory - to be created

Throws:

IllegalStateException - if directory can't be created

getFilesFromFileSet

@NotNull
public static Iterable<File> getFilesFromFileSet(@NotNull
                                                          org.apache.tools.ant.types.FileSet fileSet)

Returns an Iterable of Files converted from Apache's FileSet of FileResources.

The resulting iterable relies on the iterator of the FileSet, which means that it's lazy loaded. Creating a new Collection from this Iterable might cause problems due to potential high memory consumption.

Parameters:

fileSet - a file set

Returns:

a lazy loaded iterable of files from the given file set

getSingleFileFromDirectory

@NotNull
public static File getSingleFileFromDirectory(@NotNull
                                                       File directory)
                                                throws IOException

Obtain a single file from a directory. The directory has to exist and must contain exactly one file.

Parameters:

directory - a directory

Returns:

a single file within the directory, which can be a directory as well

Throws:

IOException - if any filesystem operation fails

IllegalArgumentException - if the argument is invalid, e.g. the directory doesn't exist, the file is not a directory, the directory contains more than one file or no files

deleteDirectory

@Deprecated
public static void deleteDirectory(@NotNull
                                               File directory)
                                        throws IOException

Deprecated. since 5.10 use BambooPathUtils.deleteDirectory(Path)

Throws:

IOException

See Also:

FileUtils.deleteDirectory(File)

cleanDirectory

@Deprecated
public static void cleanDirectory(@NotNull
                                              File directory)
                                       throws IOException

Deprecated. since 5.10 try using BambooPathUtils.cleanDirectory(Path)) instead

Throws:

IOException

See Also:

FileUtils.cleanDirectory(File)

deleteQuietly

@Deprecated
public static boolean deleteQuietly(@Nullable
                                                File fileOrDir)

Deprecated. since 5.10 use BambooPathUtils.deleteQuietly(Path) instead

See Also:

FileUtils.deleteQuietly(File)

forceDelete

@Deprecated
public static void forceDelete(@NotNull
                                           File file)
                                    throws IOException

Deprecated. since 5.10 use instead

Throws:

IOException

See Also:

FileUtils.forceDelete(File)