org.pentaho.platform.repository

Class RepositoryFilenameUtils

java.lang.Object

org.pentaho.platform.repository.RepositoryFilenameUtils

public class RepositoryFilenameUtils
extends Object

General filename and filepath manipulation utilities for the Pentaho Repository. NOTE: these methods will work independently of the underlying operating system. Most methods will translate a backslash (\) to a forward slash (/) but should be be depended upon to make that translation.

This class defines six components within a filename (example /dev/project/file.txt):

• the prefix - /
• the path - dev/project/
• the full path - /dev/project/
• the name - file.txt
• the base name - file
• the extension - txt

Note that this class works best if directory filenames end with a separator. If you omit the last separator, it is impossible to determine if the filename corresponds to a file or a directory. As a result, we have chosen to say it corresponds to a file.

This class only supports Pentaho Repository (Unix) style names. Prefixes are matched as follows:

 a/b/c.txt           --> ""          --> relative
 /a/b/c.txt          --> "/"         --> absolute
 

Origin of code: Apache Commons IO 2.1

Since:

Pentaho 5.0

Author:

David M. Kincade

Method Summary

Methods

Modifier and Type	Method and Description
static String	concat(String basePath, String fullFilenameToAdd) Concatenates a filename to a base path using normal command line style rules.
static boolean	equals(String filename1, String filename2) Checks whether two filenames are equal exactly.
static boolean	equalsNormalized(String filename1, String filename2) Checks whether two filenames are equal after both have been normalized.
static String	escape(String name, List<Character> reservedChars) Performs percent-encoding (as specified in IUnifiedRepository) on given name, only encoding the characters given in reservedChars.
static String	getBaseName(String filename) Gets the base name, minus the full path and extension, from a full filename.
static String	getExtension(String filename) Gets the extension of a filename.
static String	getFullPath(String filename) Gets the full path from a full filename, which is the prefix + path.
static String	getFullPathNoEndSeparator(String filename) Gets the full path from a full filename, which is the prefix + path, and also excluding the final directory separator.
static String	getName(String filename) Gets the name minus the path from a full filename.
static String	getPath(String filename) Gets the path from a full filename, which excludes the prefix.
static String	getPathNoEndSeparator(String filename) Gets the path from a full filename, which excludes the prefix, and also excluding the final directory separator.
static String	getPrefix(String filename) Gets the prefix from a full filename.
static int	getPrefixLength(String filename) Returns the length of the filename prefix, The prefix length includes the first slash in the full filename if applicable.
static int	indexOfExtension(String filename) Returns the index of the last extension separator character, which is a dot.
static int	indexOfLastSeparator(String filename) Returns the index of the last directory separator character.
static boolean	isExtension(String filename, Collection extensions) Checks whether the extension of the filename is one of those specified.
static boolean	isExtension(String filename, String extension) Checks whether the extension of the filename is that specified.
static boolean	isExtension(String filename, String[] extensions) Checks whether the extension of the filename is one of those specified.
static String	normalize(String filename) Normalizes a path, removing double and single dot path steps.
static String	normalize(String filename, boolean leadingSlash) Normalizes a path, removing double and single dot path steps.
static String	normalizeNoEndSeparator(String filename) Normalizes a path, removing double and single dot path steps, and removing any final directory separator.
static String	removeExtension(String filename) Removes the extension from a filename.
static String	separatorsToRepository(String path) Converts all separators to the Repository (Unix) separator of forward slash.
static String	unescape(String name) Reverts modifications of #escape(String) such that for all Strings t, t.equals(unescape(escape(t))).
static boolean	wildcardMatch(String filename, String wildcardMatcher) Checks a filename to see if it matches the specified wildcard matcher, always testing case-sensitive.

Methods inherited from class java.lang.Object

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

Method Detail

normalize

public static String normalize(String filename)

Normalizes a path, removing double and single dot path steps.

This method normalizes a path to a standard format.

A trailing slash will be retained. A double slash will be merged to a single slash (but UNC names are handled). A single dot path segment will be removed. A double dot will cause that path segment and the one before to be removed. If the double dot has no parent path segment to work with, null is returned.

The output will be the same on both Unix and Windows except for the separator character.

 /foo//               -->   /foo/
 /foo/./              -->   /foo/
 /foo/../bar          -->   /bar
 /foo/../bar/         -->   /bar/
 /foo/../bar/../baz   -->   /baz
 //foo//./bar         -->   /foo/bar
 /../                 -->   null
 ../foo               -->   null
 foo/bar/..           -->   foo/
 foo/../../bar        -->   null
 foo/../bar           -->   bar
 

Parameters:

filename - the filename to normalize, null returns null

Returns:

the normalized filename, or null if invalid

normalize

public static String normalize(String filename,
               boolean leadingSlash)

Normalizes a path, removing double and single dot path steps.

This method normalizes a path to a standard format.

A trailing slash will be retained. A double slash will be merged to a single slash (but UNC names are handled). A single dot path segment will be removed. A double dot will cause that path segment and the one before to be removed. If the double dot has no parent path segment to work with, null is returned.

The output will be the same on both Unix and Windows except for the separator character.

 /foo//               -->   /foo/
 /foo/./              -->   /foo/
 /foo/../bar          -->   /bar
 /foo/../bar/         -->   /bar/
 /foo/../bar/../baz   -->   /baz
 //foo//./bar         -->   /foo/bar
 /../                 -->   null
 ../foo               -->   null
 foo/bar/..           -->   foo/
 foo/../../bar        -->   null
 foo/../bar           -->   bar
 

Parameters:

filename - the filename to normalize, null returns null

leadingSlash - will ensue there is a leading slash on the result if true

Returns:

the normalized filename, or null if invalid

normalizeNoEndSeparator

public static String normalizeNoEndSeparator(String filename)

Normalizes a path, removing double and single dot path steps, and removing any final directory separator.

This method normalizes a path to a standard format.

A trailing slash will be removed. A double slash will be merged to a single slash (but UNC names are handled). A single dot path segment will be removed. A double dot will cause that path segment and the one before to be removed. If the double dot has no parent path segment to work with, null is returned.

The output will be the same on both Unix and Windows except for the separator character.

 /foo//               -->   /foo
 /foo/./              -->   /foo
 /foo/../bar          -->   /bar
 /foo/../bar/         -->   /bar
 /foo/../bar/../baz   -->   /baz
 //foo//./bar         -->   /foo/bar
 /../                 -->   null
 ../foo               -->   null
 foo/bar/..           -->   foo
 foo/../../bar        -->   null
 foo/../bar           -->   bar
 

Parameters:

filename - the filename to normalize, null returns null

Returns:

the normalized filename, or null if invalid

concat

public static String concat(String basePath,
            String fullFilenameToAdd)

Concatenates a filename to a base path using normal command line style rules.

The effect is equivalent to resultant directory after changing directory to the first argument, followed by changing directory to the second argument.

The first argument is the base path, the second is the path to concatenate. The returned path is always normalized via normalize(String), thus .. is handled.

If pathToAdd is absolute (has an absolute prefix), then it will be normalized and returned. Otherwise, the paths will be joined, normalized and returned.

 /foo/ + bar          -->   /foo/bar
 /foo + bar           -->   /foo/bar
 /foo + /bar          -->   /bar
 /foo/a/ + ../bar     -->   foo/bar
 /foo/ + ../../bar    -->   null
 /foo/ + /bar         -->   /bar
 /foo/.. + /bar       -->   /bar
 /foo + bar/c.txt     -->   /foo/bar/c.txt
 /foo/c.txt + bar     -->   /foo/c.txt/bar (!)
 

(!) Note that the first parameter must be a path. If it ends with a name, then the name will be built into the concatenated path. If this might be a problem, use getFullPath(String) on the base path argument.

Parameters:

basePath - the base path to attach to, always treated as a path

fullFilenameToAdd - the filename (or path) to attach to the base

Returns:

the concatenated path, or null if invalid

separatorsToRepository

public static String separatorsToRepository(String path)

Converts all separators to the Repository (Unix) separator of forward slash.

Parameters:

path - the path to be changed, null ignored

Returns:

the updated path

getPrefixLength

public static int getPrefixLength(String filename)

Returns the length of the filename prefix,

The prefix length includes the first slash in the full filename if applicable. Thus, it is possible that the length returned is greater than the length of the input string.

 a/b/c.txt           --> ""          --> relative
 /a/b/c.txt          --> "/"         --> absolute
 

Parameters:

filename - the filename to find the prefix in, null returns -1

Returns:

the length of the prefix, -1 if invalid or null

indexOfLastSeparator

public static int indexOfLastSeparator(String filename)

Returns the index of the last directory separator character.

The position of the last forward or backslash is returned.

Parameters:

filename - the filename to find the last path separator in, null returns -1

Returns:

the index of the last separator character, or -1 if there is no such character

indexOfExtension

public static int indexOfExtension(String filename)

Returns the index of the last extension separator character, which is a dot.

This method also checks that there is no directory separator after the last dot. To do this it uses indexOfLastSeparator(String)

Parameters:

filename - the filename to find the last path separator in, null returns -1

Returns:

the index of the last separator character, or -1 if there is no such character

getPrefix

public static String getPrefix(String filename)

Gets the prefix from a full filename.

The prefix includes the first slash in the full filename where applicable.

 a/b/c.txt           --> ""          --> relative
 /a/b/c.txt          --> "/"         --> absolute
 

Parameters:

filename - the filename to query, null returns null

Returns:

the prefix of the file, null if invalid

getPath

public static String getPath(String filename)

Gets the path from a full filename, which excludes the prefix.

The method is entirely text based, and returns the text before and including the last forward or backslash.

 a.txt        --> ""
 a/b/c        --> a/b/
 a/b/c/       --> a/b/c/
 /a.txt       --> ""
 /a/b/c       --> a/b/
 /a/b/c/      --> a/b/c/
 

This method drops the prefix from the result. See getFullPath(String) for the method that retains the prefix.

Parameters:

filename - the filename to query, null returns null

Returns:

the path of the file, an empty string if none exists, null if invalid

getPathNoEndSeparator

public static String getPathNoEndSeparator(String filename)

Gets the path from a full filename, which excludes the prefix, and also excluding the final directory separator.

The method is entirely text based, and returns the text before the last forward or backslash.

 a.txt        --> ""
 a/b/c        --> a/b
 a/b/c/       --> a/b/c
 /a.txt       --> ""
 /a/b/c       --> a/b
 /a/b/c/      --> a/b/c
 

This method drops the prefix from the result. See getFullPathNoEndSeparator(String) for the method that retains the prefix.

Parameters:

filename - the filename to query, null returns null

Returns:

the path of the file, an empty string if none exists, null if invalid

getFullPath

public static String getFullPath(String filename)

Gets the full path from a full filename, which is the prefix + path.

The method is entirely text based, and returns the text before and including the last forward or backslash.

 a.txt        --> ""
 a/b/c        --> a/b/
 a/b/c/       --> a/b/c/
 /a.txt       --> /
 /a/b/c       --> /a/b/
 /a/b/c/      --> /a/b/c/
 

The output will be the same irrespective of the machine that the code is running on.

Parameters:

filename - the filename to query, null returns null

Returns:

the path of the file, an empty string if none exists, null if invalid

getFullPathNoEndSeparator

public static String getFullPathNoEndSeparator(String filename)

Gets the full path from a full filename, which is the prefix + path, and also excluding the final directory separator.

This method will handle a file in either Unix or Windows format. The method is entirely text based, and returns the text before the last forward or backslash.

 a.txt        --> ""
 a/b/c        --> a/b
 a/b/c/       --> a/b/c
 /a.txt       --> /
 /a/b/c       --> /a/b
 /a/b/c/      --> /a/b/c
 

The output will be the same irrespective of the machine that the code is running on.

Parameters:

filename - the filename to query, null returns null

Returns:

the path of the file, an empty string if none exists, null if invalid

getName

public static String getName(String filename)

Gets the name minus the path from a full filename.

The text after the last forward or backslash is returned.

 a/b/c.txt --> c.txt
 a.txt     --> a.txt
 a/b/c     --> c
 a/b/c/    --> ""
 

Parameters:

filename - the filename to query, null returns null

Returns:

the name of the file without the path, or an empty string if none exists

getBaseName

public static String getBaseName(String filename)

Gets the base name, minus the full path and extension, from a full filename.

The text after the last forward or backslash and before the last dot is returned.

 a/b/c.txt --> c
 a.txt     --> a
 a/b/c     --> c
 a/b/c/    --> ""
 

Parameters:

filename - the filename to query, null returns null

Returns:

the name of the file without the path, or an empty string if none exists

getExtension

public static String getExtension(String filename)

Gets the extension of a filename.

This method returns the textual part of the filename after the last dot. There must be no directory separator after the dot.

 foo.txt      --> "txt"
 a/b/c.jpg    --> "jpg"
 a/b.txt/c    --> ""
 a/b/c        --> ""
 

Parameters:

filename - the filename to retrieve the extension of.

Returns:

the extension of the file or an empty string if none exists.

removeExtension

public static String removeExtension(String filename)

Removes the extension from a filename.

This method returns the textual part of the filename before the last dot. There must be no directory separator after the dot.

 foo.txt    --> foo
 a/b/c.jpg  --> a/b/c
 a/b/c      --> a/b/c
 a.b/c      --> a.b/c
 

Parameters:

filename - the filename to query, null returns null

Returns:

the filename minus the extension

equals

public static boolean equals(String filename1,
             String filename2)

Checks whether two filenames are equal exactly.

No processing is performed on the filenames other than comparison, thus this is merely a null-safe case-sensitive equals.

Parameters:

filename1 - the first filename to query, may be null

filename2 - the second filename to query, may be null

Returns:

true if the filenames are equal, null equals null

See Also:

IOCase.SENSITIVE

equalsNormalized

public static boolean equalsNormalized(String filename1,
                       String filename2)

Checks whether two filenames are equal after both have been normalized.

Both filenames are first passed to normalize(String). The check is then performed in a case-sensitive manner.

Parameters:

filename1 - the first filename to query, may be null

filename2 - the second filename to query, may be null

Returns:

true if the filenames are equal, null equals null

See Also:

IOCase.SENSITIVE

isExtension

public static boolean isExtension(String filename,
                  String extension)

Checks whether the extension of the filename is that specified.

This method obtains the extension as the textual part of the filename after the last dot. There must be no directory separator after the dot. The extension check is case-sensitive on all platforms.

Parameters:

filename - the filename to query, null returns false

extension - the extension to check for, null or empty checks for no extension

Returns:

true if the filename has the specified extension

isExtension

public static boolean isExtension(String filename,
                  String[] extensions)

Checks whether the extension of the filename is one of those specified.

This method obtains the extension as the textual part of the filename after the last dot. There must be no directory separator after the dot. The extension check is case-sensitive on all platforms.

Parameters:

filename - the filename to query, null returns false

extensions - the extensions to check for, null checks for no extension

Returns:

true if the filename is one of the extensions

isExtension

public static boolean isExtension(String filename,
                  Collection extensions)

Checks whether the extension of the filename is one of those specified.

This method obtains the extension as the textual part of the filename after the last dot. There must be no directory separator after the dot. The extension check is case-sensitive on all platforms.

Parameters:

filename - the filename to query, null returns false

extensions - the extensions to check for, null checks for no extension

Returns:

true if the filename is one of the extensions

wildcardMatch

public static boolean wildcardMatch(String filename,
                    String wildcardMatcher)

Checks a filename to see if it matches the specified wildcard matcher, always testing case-sensitive.

The wildcard matcher uses the characters '?' and '*' to represent a single or multiple wildcard characters. This is the same as often found on Dos/Unix command lines. The check is case-sensitive always.

 wildcardMatch("c.txt", "*.txt")      --> true
 wildcardMatch("c.txt", "*.jpg")      --> false
 wildcardMatch("a/b/c.txt", "a/b/*")  --> true
 wildcardMatch("c.txt", "*.???")      --> true
 wildcardMatch("c.txt", "*.????")     --> false
 

Parameters:

filename - the filename to match on

wildcardMatcher - the wildcard string to match against

Returns:

true if the filename matches the wildcard string

See Also:

IOCase.SENSITIVE

escape

public static String escape(String name,
            List<Character> reservedChars)

Performs percent-encoding (as specified in IUnifiedRepository) on given name, only encoding the characters given in reservedChars. Assumes only ASCII characters in reservedChars.

Parameters:

name - name to escape

reservedChars - chars within name to escape

Returns:

escaped name

unescape

public static String unescape(String name)

Reverts modifications of #escape(String) such that for all Strings t, t.equals(unescape(escape(t))). Assumes only ASCII characters have been escaped.

Parameters:

name - name to unescape

Returns:

unescaped name