/*
* Copyright 2004-2015 the Seasar Foundation and the Others.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/
package org.seasar.framework.util;
import java.io.File;
import java.io.FilterInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Enumeration;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;
/**
* リソースをトラバースするためのクラスです。
* <p>
* このクラスを直接使うより、{@link ResourcesUtil}を使用してください。
* </p>
*
* @author taedium
* @see ResourcesUtil
*/
public class ResourceTraversal {
/**
* リソースを処理するインターフェースです。
*
*/
public interface ResourceHandler {
/**
* リソースを処理します。
*
* @param path
* @param is
*/
void processResource(String path, InputStream is);
}
/**
* インスタンスを構築します。
*/
protected ResourceTraversal() {
}
/**
* ファイルシステムに含まれるリソースをトラバースします。
*
* @param rootDir
* ルートディレクトリ
* @param handler
* リソースを処理するハンドラ
*/
public static void forEach(final File rootDir, final ResourceHandler handler) {
forEach(rootDir, null, handler);
}
/**
* ファイルシステムに含まれるリソースをトラバースします。
* <p>
* ルートディレクトリ以下のリソースのうち、ベースディレクトリで始まるパスを持つリソースがトラバースの対象となります。
* リソースを処理するハンドラには、ルートディレクトリからの相対パスが渡されます。 例えばルートディレクトリが
* <code>/aaa/bbb</code>で、ベースディレクトリが<code>ccc/ddd</code>の場合、
* <code>/aaa/bbb/ccc/ddd/eee.txt</code>というリソースが存在すると、 ハンドラには
* <code>ccc/ddd/eee.txt</code>というパスが渡されます。
* </p>
*
* @param rootDir
* ルートディレクトリ
* @param baseDirectory
* ベースディレクトリ
* @param handler
* リソースを処理するハンドラ
*/
public static void forEach(final File rootDir, final String baseDirectory,
final ResourceHandler handler) {
final File baseDir = getBaseDir(rootDir, baseDirectory);
if (baseDir.exists()) {
traverseFileSystem(rootDir, baseDir, handler);
}
}
/**
* Jarファイル形式のファイルに含まれるリソースをトラバースします。
*
* @param jarFile
* jarファイル形式のファイル
* @param handler
* リソースを処理するハンドラ
*/
public static void forEach(final JarFile jarFile,
final ResourceHandler handler) {
forEach(jarFile, "", handler);
}
/**
* Jarファイル形式のファイルに含まれるリソースをトラバースします。
* <p>
* Jarファイル内のリソースのうち、接頭辞で始まるパスを持つリソースがトラバースの対象となります。
* リソースを処理するハンドラには、接頭辞を除くエントリ名が渡されます。 例えば接頭辞が <code>/aaa/bbb/</code>
* で、Jarファイル内に <code>/aaa/bbb/ccc/ddd/eee.txt</code>というリソースが存在すると、 ハンドラには
* <code>ccc/ddd/eee.txt</code>というパスが渡されます。
* </p>
*
* @param jarFile
* jarファイル形式のファイル
* @param prefix
* トラバースするリソースの名前が含む接頭辞。スラッシュ('/')で終了していなければなりません。
* @param handler
* リソースを処理するハンドラ
*/
public static void forEach(final JarFile jarFile, final String prefix,
final ResourceHandler handler) {
final int pos = prefix.length();
final Enumeration enumeration = jarFile.entries();
while (enumeration.hasMoreElements()) {
final JarEntry entry = (JarEntry) enumeration.nextElement();
if (!entry.isDirectory()) {
final String entryName = entry.getName().replace('\\', '/');
if (!entryName.startsWith(prefix)) {
continue;
}
final InputStream is = JarFileUtil.getInputStream(jarFile,
entry);
try {
handler.processResource(entryName.substring(pos), is);
} finally {
InputStreamUtil.close(is);
}
}
}
}
/**
* ZIPファイル形式の入力ストリームに含まれるリソースをトラバースします。
*
* @param zipInputStream
* ZIPファイル形式の入力ストリーム
* @param handler
* リソースを処理するハンドラ
*/
public static void forEach(final ZipInputStream zipInputStream,
final ResourceHandler handler) {
forEach(zipInputStream, "", handler);
}
/**
* ZIPファイル形式の入力ストリームに含まれるリソースをトラバースします。
* <p>
* 入力ストリーム内のリソースのうち、接頭辞で始まるパスを持つリソースがトラバースの対象となります。
* リソースを処理するハンドラには、接頭辞を除くエントリ名が渡されます。 例えば接頭辞が <code>/aaa/bbb/</code>
* で、入力ストリーム内に <code>/aaa/bbb/ccc/ddd/eee.txt</code>というリソースが存在すると、 ハンドラには
* <code>ccc/ddd/eee.txt</code>というパスが渡されます。
* </p>
*
* @param zipInputStream
* ZIPファイル形式の入力ストリーム
* @param prefix
* トラバースするリソースの名前が含む接頭辞。スラッシュ('/')で終了していなければなりません。
* @param handler
* リソースを処理するハンドラ
*/
public static void forEach(final ZipInputStream zipInputStream,
final String prefix, final ResourceHandler handler) {
final int pos = prefix.length();
ZipEntry entry = null;
while ((entry = ZipInputStreamUtil.getNextEntry(zipInputStream)) != null) {
if (!entry.isDirectory()) {
final String entryName = entry.getName().replace('\\', '/');
if (!entryName.startsWith(prefix)) {
continue;
}
handler.processResource(entryName.substring(pos),
new FilterInputStream(zipInputStream) {
public void close() throws IOException {
ZipInputStreamUtil.closeEntry(zipInputStream);
}
});
}
}
}
private static void traverseFileSystem(final File rootDir,
final File baseDir, final ResourceHandler handler) {
final File[] files = baseDir.listFiles();
for (int i = 0; i < files.length; ++i) {
final File file = files[i];
if (file.isDirectory()) {
traverseFileSystem(rootDir, file, handler);
} else {
final int pos = FileUtil.getCanonicalPath(rootDir).length();
final String filePath = FileUtil.getCanonicalPath(file);
final String resourcePath = filePath.substring(pos + 1)
.replace('\\', '/');
final InputStream is = FileInputStreamUtil.create(file);
try {
handler.processResource(resourcePath, is);
} finally {
InputStreamUtil.close(is);
}
}
}
}
private static File getBaseDir(final File rootDir,
final String baseDirectory) {
File baseDir = rootDir;
if (baseDirectory != null) {
final String[] names = baseDirectory.split("/");
for (int i = 0; i < names.length; i++) {
baseDir = new File(baseDir, names[i]);
}
}
return baseDir;
}
}