utils.common

Class IOUtils

java.lang.Object

utils.common.IOUtils

@Singleton
public class IOUtils
extends java.lang.Object

Utility class that handles access to the system's file system.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REGEX_ILLEGAL_IN_FILENAME Regular expression of illegal characters or strings in file or directory names '/', '\n', '\r', * '//', '\t', '\0', '\f', '`', '?', '*', '\\', '<', '>', '|', '\"', ':', '~', '!', '§', '$', '%', '&'
static java.io.File	TMP_DIR

Constructor Summary

Constructors

Constructor and Description
IOUtils()

Method Summary

Modifier and Type	Method and Description
boolean	checkFileInStudyAssetsDirExists(java.lang.String dirName, java.lang.String filePath)
static boolean	checkFilename(java.lang.String filename)
boolean	checkStudyAssetsDirExists(java.lang.String dirName)
java.lang.String	cloneComponentHtmlFile(java.lang.String studyAssetsDirName, java.lang.String htmlFilePath) Copies a component's HTML file.
java.lang.String	cloneStudyAssetsDirectory(java.lang.String srcDirName) Copies study assets' directory.
static void	createDir(java.io.File file) Creates the given File as a directory, including necessary and non-existent parent directories.
void	createStudyAssetsDir(java.lang.String dirName) Creates a study assets dir.
boolean	existsAndSecure(java.lang.String path, java.lang.String filePath) Checks filePath for path traversal attacks and existence
java.io.File[]	findDirectories(java.io.File dir) Returns all directories within this directory.
java.io.File[]	findFiles(java.io.File dir, java.lang.String prefix, java.lang.String suffix) Returns all files within this directory that have the prefix and the suffix.
java.lang.String	findNonExistingStudyAssetsDirName(java.lang.String dirName)
java.lang.String	generateFileName(java.lang.String rawName) Generates a filename from a name in a specified length.
java.lang.String	generateFileName(java.lang.String rawName, java.lang.String suffix) Generates a filename from a name in a specified length and adds the suffix.
java.lang.String	generateStudyAssetsPath(java.lang.String dirName) Generates a study assets directory path.
java.nio.file.Path	getAssetsFilePath(java.lang.String filepath, java.lang.String filename, Study study) Get a Path to a file in a study assets directory.
java.io.File	getExistingFileInStudyAssetsDir(java.lang.String dirName, java.lang.String filePath) Gets the File object which resides under filePath within the study assets' directory.
java.io.File	getExistingFileSecurely(java.lang.String path, java.lang.String filePath) Gets the File object while preventing a path traversal attack and checks whether the file exists and is no directory.
java.io.File	getFileInStudyAssetsDir(java.lang.String dirName, java.lang.String filePath) Gets the File object which resides under filePath within the study assets' directory.
static java.lang.String	getResultsPath(java.lang.Long studyResultId, java.lang.Long componentResultId) Path to result files in file system (after unpacking - so using the OS' file separator)
static java.lang.String	getResultsPathForZip(java.lang.Long studyResultId, java.lang.Long componentResultId) Path to result files in zip package with '/' as file separator
long	getResultUploadDirSize(java.lang.Long studyResultId) Returns the disk size in Bytes of all uploaded files belonging to the given study result ID.
java.io.File	getResultUploadFileSecurely(java.lang.Long studyResultId, java.lang.Long componentResultId, java.lang.String filename)
static java.lang.String	getResultUploadsDir(java.lang.Long studyResultId) Path to result uploads folder where JATOS stores the uploaded result files
static java.lang.String	getResultUploadsDir(java.lang.Long studyResultId, java.lang.Long componentResultId) Path to result uploads folder where JATOS stores the uploaded result files
java.io.File	getStudyAssetsDir(java.lang.String dirName) Gets the study assets with the given directory name.
long	getStudyAssetsDirSize(java.lang.String dirName) Returns the disk size in Bytes of all files inside the given study assets directory.
void	moveStudyAssetsDir(java.io.File srcDir, java.lang.String targetDirName) Moves study assets dir into the assets root dir.
java.lang.String	readFile(java.io.File file) Reads the given file and returns the content as String.
void	removeResultUploadsDir(java.lang.Long studyResultId)
void	removeResultUploadsDir(java.lang.Long studyResultId, java.lang.Long componentResultId)
void	removeStudyAssetsDir(java.lang.String dirName) Remove study assets' directory if exists.
void	renameHtmlFile(java.lang.String oldHtmlFilePath, java.lang.String newHtmlFilePath, java.lang.String studyAssetName) Renames a component's HTML file.
void	renameStudyAssetsDir(java.lang.String oldDirName, java.lang.String newDirName) Renames a study assets dir.

Methods inherited from class java.lang.Object

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

Field Detail

REGEX_ILLEGAL_IN_FILENAME

public static final java.lang.String REGEX_ILLEGAL_IN_FILENAME

Regular expression of illegal characters or strings in file or directory names '/', '\n', '\r', * '//', '\t', '\0', '\f', '`', '?', '*', '\\', '<', '>', '|', '\"', ':', '~', '!', '§', '$', '%', '&'

See Also:

Constant Field Values

TMP_DIR

public static final java.io.File TMP_DIR

Constructor Detail

IOUtils

public IOUtils()

Method Detail

readFile

public java.lang.String readFile(java.io.File file)
                          throws java.io.IOException

Reads the given file and returns the content as String.

Throws:

java.io.IOException

checkStudyAssetsDirExists

public boolean checkStudyAssetsDirExists(java.lang.String dirName)

checkFileInStudyAssetsDirExists

public boolean checkFileInStudyAssetsDirExists(java.lang.String dirName,
                                               java.lang.String filePath)

getExistingFileSecurely

public java.io.File getExistingFileSecurely(java.lang.String path,
                                            java.lang.String filePath)
                                     throws java.io.IOException

Gets the File object while preventing a path traversal attack and checks whether the file exists and is no directory.

Throws:

java.io.IOException

existsAndSecure

public boolean existsAndSecure(java.lang.String path,
                               java.lang.String filePath)

Checks filePath for path traversal attacks and existence

getFileInStudyAssetsDir

public java.io.File getFileInStudyAssetsDir(java.lang.String dirName,
                                            java.lang.String filePath)
                                     throws java.io.IOException

Gets the File object which resides under filePath within the study assets' directory.

Throws:

java.io.IOException

getExistingFileInStudyAssetsDir

public java.io.File getExistingFileInStudyAssetsDir(java.lang.String dirName,
                                                    java.lang.String filePath)

Gets the File object which resides under filePath within the study assets' directory.

getStudyAssetsDir

public java.io.File getStudyAssetsDir(java.lang.String dirName)
                               throws java.io.IOException

Gets the study assets with the given directory name.

Throws:

java.io.IOException

generateFileName

public java.lang.String generateFileName(java.lang.String rawName,
                                         java.lang.String suffix)

Generates a filename from a name in a specified length and adds the suffix.

checkFilename

public static boolean checkFilename(java.lang.String filename)

generateFileName

public java.lang.String generateFileName(java.lang.String rawName)

Generates a filename from a name in a specified length.

generateStudyAssetsPath

public java.lang.String generateStudyAssetsPath(java.lang.String dirName)

Generates a study assets directory path.

removeStudyAssetsDir

public void removeStudyAssetsDir(java.lang.String dirName)
                          throws java.io.IOException

Remove study assets' directory if exists.

Throws:

java.io.IOException

getAssetsFilePath

public java.nio.file.Path getAssetsFilePath(java.lang.String filepath,
                                            java.lang.String filename,
                                            Study study)
                                     throws java.io.IOException

Get a Path to a file in a study assets directory.

Parameters:

filepath - Filepath to the file. If it points to a directory (indicated by a trailing '/') the returned Path consists of filepath + filename. If it does not point to a directory it is treated as Path to a file and returned as Path (without the filename parameter). This parameter is optional and can be null to signal the Path to the file is supposed to be in the root of the study assets directory. If it has a leading '/' it gets removed. It can be URL encoded but doesn't have to be.

filename - Filename of the file (without path).

study - Study where the study assets belong to

Returns:

Path to the file in the study assets

Throws:

java.io.IOException

cloneComponentHtmlFile

public java.lang.String cloneComponentHtmlFile(java.lang.String studyAssetsDirName,
                                               java.lang.String htmlFilePath)
                                        throws java.io.IOException

Copies a component's HTML file.

Parameters:

studyAssetsDirName - Name of the study assets

htmlFilePath - Local file path to the HTML file. The file can be in a subdirectory of the study assets directory.

Returns:

Name of the new file.

Throws:

java.io.IOException

cloneStudyAssetsDirectory

public java.lang.String cloneStudyAssetsDirectory(java.lang.String srcDirName)
                                           throws java.io.IOException

Copies study assets' directory. Adds suffix '_clone' to the name of the new assets dir. If a dir with suffix '_clone' already exists it adds '_' + number instead.

Throws:

java.io.IOException

findNonExistingStudyAssetsDirName

public java.lang.String findNonExistingStudyAssetsDirName(java.lang.String dirName)

moveStudyAssetsDir

public void moveStudyAssetsDir(java.io.File srcDir,
                               java.lang.String targetDirName)
                        throws java.io.IOException

Moves study assets dir into the assets root dir.

Parameters:

srcDir - The source dir File can be anywhere in the file system.

targetDirName - Name of the target dir within the assets root dir

Throws:

java.io.IOException

createStudyAssetsDir

public void createStudyAssetsDir(java.lang.String dirName)
                          throws java.io.IOException

Creates a study assets dir.

Parameters:

dirName - Name of the new study assets dir.

Throws:

java.io.IOException

findFiles

public java.io.File[] findFiles(java.io.File dir,
                                java.lang.String prefix,
                                java.lang.String suffix)

Returns all files within this directory that have the prefix and the suffix.

findDirectories

public java.io.File[] findDirectories(java.io.File dir)

Returns all directories within this directory.

renameStudyAssetsDir

public void renameStudyAssetsDir(java.lang.String oldDirName,
                                 java.lang.String newDirName)
                          throws java.io.IOException

Renames a study assets dir.

Throws:

java.io.IOException

getStudyAssetsDirSize

public long getStudyAssetsDirSize(java.lang.String dirName)

Returns the disk size in Bytes of all files inside the given study assets directory. It does not count the size of directories themselves (e.g., on Linux, each directory takes 4kB).

renameHtmlFile

public void renameHtmlFile(java.lang.String oldHtmlFilePath,
                           java.lang.String newHtmlFilePath,
                           java.lang.String studyAssetName)
                    throws java.io.IOException

Renames a component's HTML file. This file can be in a subdirectory of the study assets directory.

Parameters:

oldHtmlFilePath - The current local file path within the study assets

newHtmlFilePath - The new local file path within the study assets

studyAssetName - The name (not the path) of the study assets

Throws:

java.io.IOException

createDir

public static void createDir(java.io.File file)
                      throws java.io.IOException

Creates the given File as a directory, including necessary and non-existent parent directories. If the file already exists it will be deleted before.

Throws:

java.io.IOException

getResultUploadsDir

public static java.lang.String getResultUploadsDir(java.lang.Long studyResultId)

Path to result uploads folder where JATOS stores the uploaded result files

getResultUploadsDir

public static java.lang.String getResultUploadsDir(java.lang.Long studyResultId,
                                                   java.lang.Long componentResultId)

Path to result uploads folder where JATOS stores the uploaded result files

getResultsPathForZip

public static java.lang.String getResultsPathForZip(java.lang.Long studyResultId,
                                                    java.lang.Long componentResultId)

Path to result files in zip package with '/' as file separator

getResultsPath

public static java.lang.String getResultsPath(java.lang.Long studyResultId,
                                              java.lang.Long componentResultId)

Path to result files in file system (after unpacking - so using the OS' file separator)

getResultUploadDirSize

public long getResultUploadDirSize(java.lang.Long studyResultId)

Returns the disk size in Bytes of all uploaded files belonging to the given study result ID. It does not count the size of directories themselves (e.g. on Linux each directory takes 4kB).

getResultUploadFileSecurely

public java.io.File getResultUploadFileSecurely(java.lang.Long studyResultId,
                                                java.lang.Long componentResultId,
                                                java.lang.String filename)
                                         throws java.io.IOException

Throws:

java.io.IOException

removeResultUploadsDir

public void removeResultUploadsDir(java.lang.Long studyResultId)
                            throws java.io.IOException

Throws:

java.io.IOException

removeResultUploadsDir

public void removeResultUploadsDir(java.lang.Long studyResultId,
                                   java.lang.Long componentResultId)
                            throws java.io.IOException

Throws:

java.io.IOException