freenet.support.io

Class FileUtil

java.lang.Object

freenet.support.io.FileUtil

public final class FileUtil
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileUtil.CPUArchitecture
static class	FileUtil.OperatingSystem

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUFFER_SIZE
static FileUtil.CPUArchitecture	detectedArch Caveat: Sometimes this may not be entirely accurate, e.g.
static FileUtil.OperatingSystem	detectedOS

Constructor Summary

Constructors

Constructor and Description
FileUtil()

Method Summary

Modifier and Type	Method and Description
static void	copy(java.io.InputStream source, java.io.OutputStream destination, long length) Copies length bytes from the source input stream to the destination output stream.
static boolean	copyFile(java.io.File copyFrom, java.io.File copyTo)
static java.io.File	createTempFile(java.lang.String prefix, java.lang.String suffix, java.io.File directory) Create a temp file in a specific directory.
static boolean	equals(java.io.File a, java.io.File b)
static boolean	equalStreams(java.io.InputStream a, java.io.InputStream b, long size)
static long	estimateUsage(java.io.File file, long flen) Guesstimate real disk usage for a file with a given filename, of a given length.
static void	fill(java.io.OutputStream os, long length) Write hard to identify random data to the OutputStream.
static void	fill(java.io.OutputStream os, java.util.Random random, long length) Deprecated.
static long	findLength(java.io.InputStream source) Find the length of an input stream.
static java.io.File	getCanonicalFile(java.io.File file)
static java.nio.charset.Charset	getFileEncodingCharset() Returns the Charset which is equal to the "file.encoding" property.
static LineReadingInputStream	getLogTailReader(java.io.File logfile, long byteLimit) Returns a line reading stream for the content of logfile.
static boolean	isParent(java.io.File poss, java.io.File filename) Is possParent a parent of filename? Why doesn't java provide this? :(
static boolean	moveTo(java.io.File orig, java.io.File dest, boolean overwrite) Like renameTo(), but can move across filesystems, by copying the data.
static java.lang.StringBuilder	readUTF(java.io.File file) Reads the entire content of a file as UTF-8 and returns it.
static java.lang.StringBuilder	readUTF(java.io.File file, long offset) Reads the content of a file as UTF-8, starting at a specified offset, and returns it.
static java.lang.StringBuilder	readUTF(java.io.InputStream stream) Reads the entire content of a stream as UTF-8 and returns it.
static java.lang.StringBuilder	readUTF(java.io.InputStream stream, long offset) Reads the content of a stream as UTF-8, starting at a specified offset, and returns it.
static boolean	removeAll(java.io.File wd) Delete everything in a directory.
static boolean	renameTo(java.io.File orig, java.io.File dest)
static java.lang.String	sanitize(java.lang.String fileName)
static java.lang.String	sanitize(java.lang.String filename, java.lang.String mimeType)
static java.lang.String	sanitizeFileName(java.lang.String fileName, FileUtil.OperatingSystem targetOS, java.lang.String extraChars) Sanitizes the given filename to be valid on the given operating system.
static java.lang.String	sanitizeFileNameWithExtras(java.lang.String fileName, java.lang.String extraChars)
static void	secureDelete(java.io.File file)
static void	secureDelete(java.io.File file, java.util.Random random) Deprecated.
static boolean	secureDeleteAll(java.io.File wd)
static boolean	setOwnerPerm(java.io.File f, boolean r, boolean w, boolean x) Set owner-only permissions on the given file.
static boolean	setOwnerRW(java.io.File f) Set owner-only RW on the given file.
static boolean	setOwnerRWX(java.io.File f) Set owner-only RWX on the given file.
static void	skipFully(java.io.InputStream is, long skip) Reliably skip a number of bytes or throw.
static boolean	writeTo(java.io.InputStream input, java.io.File target)

Methods inherited from class java.lang.Object

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

Field Detail

BUFFER_SIZE

public static final int BUFFER_SIZE

See Also:

Constant Field Values

detectedOS

public static final FileUtil.OperatingSystem detectedOS

detectedArch

public static final FileUtil.CPUArchitecture detectedArch

Caveat: Sometimes this may not be entirely accurate, e.g. we may not be able to distinguish 32-bit from 64-bit, we may be using the wrong JVM for the platform, we may be using an x86 wrapper or JVM on an IA64 system etc. This *should* be the version the JVM is running.

Constructor Detail

FileUtil

public FileUtil()

Method Detail

getLogTailReader

public static LineReadingInputStream getLogTailReader(java.io.File logfile,
                                                      long byteLimit)
                                               throws java.io.IOException

Returns a line reading stream for the content of logfile. The stream will contain at most byteLimit bytes. If byteLimit is less than the size of logfile, the first part of the file will be skipped. If this leaves a partial line at the beginning of the content to read, that partial line will also be skipped.

Parameters:

logfile - The file to open

byteLimit - The maximum number of bytes to read

Returns:

A line reader for the trailing portion of the file

Throws:

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

getFileEncodingCharset

public static java.nio.charset.Charset getFileEncodingCharset()

Returns the Charset which is equal to the "file.encoding" property. This property is set to the users configured system language on windows for example. If any error occurs, the default Charset is returned. Therefore this function should never throw.

estimateUsage

public static long estimateUsage(java.io.File file,
                                 long flen)

Guesstimate real disk usage for a file with a given filename, of a given length.

isParent

public static boolean isParent(java.io.File poss,
                               java.io.File filename)

Is possParent a parent of filename? Why doesn't java provide this? :(

getCanonicalFile

public static java.io.File getCanonicalFile(java.io.File file)

readUTF

public static java.lang.StringBuilder readUTF(java.io.File file)
                                       throws java.io.FileNotFoundException,
                                              java.io.IOException

Reads the entire content of a file as UTF-8 and returns it.

Parameters:

file - The file to read

Returns:

The content of file

Throws:

java.io.FileNotFoundException - if file cannot be opened

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

readUTF

public static java.lang.StringBuilder readUTF(java.io.File file,
                                              long offset)
                                       throws java.io.FileNotFoundException,
                                              java.io.IOException

Reads the content of a file as UTF-8, starting at a specified offset, and returns it.

Parameters:

file - The file to read

offset - The point in file at which to start reading

Returns:

The content of file, starting at offset

Throws:

java.io.FileNotFoundException - if file cannot be opened

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

readUTF

public static java.lang.StringBuilder readUTF(java.io.InputStream stream)
                                       throws java.io.IOException

Reads the entire content of a stream as UTF-8 and returns it.

Parameters:

stream - The stream to read

Returns:

The content of stream

Throws:

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

readUTF

public static java.lang.StringBuilder readUTF(java.io.InputStream stream,
                                              long offset)
                                       throws java.io.IOException

Reads the content of a stream as UTF-8, starting at a specified offset, and returns it.

Parameters:

stream - The stream to read

offset - The point in stream at which to start reading

Returns:

The content of stream, starting at offset

Throws:

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

skipFully

public static void skipFully(java.io.InputStream is,
                             long skip)
                      throws java.io.IOException

Reliably skip a number of bytes or throw.

Throws:

java.io.IOException

writeTo

public static boolean writeTo(java.io.InputStream input,
                              java.io.File target)
                       throws java.io.FileNotFoundException,
                              java.io.IOException

Throws:

java.io.FileNotFoundException

java.io.IOException

renameTo

public static boolean renameTo(java.io.File orig,
                               java.io.File dest)

moveTo

public static boolean moveTo(java.io.File orig,
                             java.io.File dest,
                             boolean overwrite)

Like renameTo(), but can move across filesystems, by copying the data.

Parameters:

orig -

dest -

overwrite -

sanitizeFileName

public static java.lang.String sanitizeFileName(java.lang.String fileName,
                                                FileUtil.OperatingSystem targetOS,
                                                java.lang.String extraChars)

Sanitizes the given filename to be valid on the given operating system. If OperatingSystem.Unknown is specified this function will generate a filename which fullfils the restrictions of all known OS, currently this is MacOS, Unix and Windows.

sanitize

public static java.lang.String sanitize(java.lang.String fileName)

sanitizeFileNameWithExtras

public static java.lang.String sanitizeFileNameWithExtras(java.lang.String fileName,
                                                          java.lang.String extraChars)

sanitize

public static java.lang.String sanitize(java.lang.String filename,
                                        java.lang.String mimeType)

findLength

public static long findLength(java.io.InputStream source)
                       throws java.io.IOException

Find the length of an input stream. This method will consume the complete input stream until its InputStream.read(byte[]) method returns -1, thus signalling the end of the stream.

Parameters:

source - The input stream to find the length of

Returns:

The numbe of bytes that can be read from the stream

Throws:

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

copy

public static void copy(java.io.InputStream source,
                        java.io.OutputStream destination,
                        long length)
                 throws java.io.IOException

Copies length bytes from the source input stream to the destination output stream. If length is -1 as much bytes as possible will be copied (i.e. until InputStream.read() returns -1 to signal the end of the stream).

Parameters:

source - The input stream to read from

destination - The output stream to write to

length - The number of bytes to copy

Throws:

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

secureDeleteAll

public static boolean secureDeleteAll(java.io.File wd)
                               throws java.io.IOException

Throws:

java.io.IOException

removeAll

public static boolean removeAll(java.io.File wd)

Delete everything in a directory. Only use this when we are *very sure* there is no important data below it!

secureDelete

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

Throws:

java.io.IOException

secureDelete

@Deprecated
public static void secureDelete(java.io.File file,
                                            java.util.Random random)
                                     throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

setOwnerRW

public static boolean setOwnerRW(java.io.File f)

Set owner-only RW on the given file.

setOwnerRWX

public static boolean setOwnerRWX(java.io.File f)

Set owner-only RWX on the given file.

setOwnerPerm

public static boolean setOwnerPerm(java.io.File f,
                                   boolean r,
                                   boolean w,
                                   boolean x)

Set owner-only permissions on the given file.

equals

public static boolean equals(java.io.File a,
                             java.io.File b)

createTempFile

public static java.io.File createTempFile(java.lang.String prefix,
                                          java.lang.String suffix,
                                          java.io.File directory)
                                   throws java.io.IOException

Create a temp file in a specific directory. Null = ".".

Throws:

java.io.IOException

copyFile

public static boolean copyFile(java.io.File copyFrom,
                               java.io.File copyTo)

fill

public static void fill(java.io.OutputStream os,
                        long length)
                 throws java.io.IOException

Write hard to identify random data to the OutputStream. Does not drain the global secure random number generator, and is significantly faster than it.

Parameters:

os - The stream to write to.

length - The number of bytes to write.

Throws:

java.io.IOException - If unable to write to the stream.

fill

@Deprecated
public static void fill(java.io.OutputStream os,
                                    java.util.Random random,
                                    long length)
                             throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

equalStreams

public static boolean equalStreams(java.io.InputStream a,
                                   java.io.InputStream b,
                                   long size)
                            throws java.io.IOException

Throws:

java.io.IOException