/*
このファイルの中身は、NTT オープンソースライセンス　バージョン 1.0（「本
契約」という）の適用を受けます。
本契約を遵守しない限り、このファイルを使用してはなりません。
本契約のコピーは、次のＵＲＬから入手できます。
【配布サイトのURL】 http://www.oss.ecl.ntt.co.jp/lms/

本契約に基づき頒布されるソフトウェアは、現状のまま、明示又は黙示のあらゆ
る種類の保証なしで、頒布されます。本契約に基づく権利及び制限を律する特定
の文言については、本契約を参照してください。

「オリジナルコード」は、 NTT Cyber Space Laboratories Code です。 
「オリジナルコード」の「初期開発者」は、日本電信電話株式会社です。  
日本電信電話株式会社により創作された部分は、Copyright (C) 2004 
日本電信電話株式会社 です。
全ての権利が留保されます。 
「コントリビュータ」：_____________________________________ 


The contents of this file are subject to the NTT Opensource License
Version 1.0 (the License); you may not use this file except in
compliance with the License. You may obtain a copy of the License at
【配布サイトのURL】 http://www.oss.ecl.ntt.co.jp/lms/

Software distributed under the License is distributed on an AS IS
basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
License for the specific language governing rights and limitations
under the License.

The Original Code is NTT Cyber Space Laboratories Code .

The Initial Developer of the Original Code is NIPPON TELEGRAPH AND 
TELEPHONE CORPORATION.
Portions created by the NIPPON TELEGRAPH AND TELEPHONE CORPORATION 
are Copyright (C) 2004 NIPPON TELEGRAPH AND TELEPHONE CORPORATION. 
All Rights Reserved.

Contributor(s) ______________________________________.
*/
package jp.co.ntt.lms.installer.core.util;

import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Reader;
import java.io.Writer;
import java.util.logging.Logger;

import jp.co.ntt.lms.installer.core.InstallerException;
import jp.co.ntt.lms.installer.core.InstallerValues;
import jp.co.ntt.lms.installer.util.FileUtil;
import jp.co.ntt.lms.installer.util.LoggerUtil;

/**
 * ファイルに関連するユーティリティ・クラス。
 * @author T.Nishiki
 */
public class InstallerFileUtil {
	/**
	 * ログ出力オブジェクト。
	 */
	private static Logger _logger;

	/**
	 * スタティック・イニシャライザ。<br>
	 * ログ出力オブジェクトを取得します。
	 */
	static {
		_logger = LoggerUtil.getLogger(InstallerFileUtil.class);
	}

	/**
	 * ファイルをコピーします。<br>
	 * @param fromFile コピー元のファイル。
	 * @param toFile コピー先ファイル。
	 * @throws InstallerException コピーに失敗した場合。
	 */
	public static void copyFile(File fromFile, File toFile)
			throws InstallerException {
		// メソッド開始タグ
		String logMessge = null;
		if (LoggerUtil.isLoggableMethod(_logger)) {
			logMessge = "copyFile(" + fromFile + "," + toFile + ")";
			LoggerUtil.methodHead(_logger, logMessge);
		}

		try {
			FileUtil.copyFile(fromFile, toFile);
		}
		catch (Exception e) {
			LoggerUtil.throwable(_logger, e);
			throw new InstallerException(e);
		}
		// メソッド終了タグ
		if (LoggerUtil.isLoggableMethod(_logger)) {
			LoggerUtil.methodTail(_logger, logMessge);
		}
	}

	/**
	 * 指定したディレクトリ内を空にします。
	 * @param directory 空にするディレクトリを表すFile。
	 * @throws InstallerException 削除に失敗した場合。
	 */
	public static void cleanDirectory(File directory)
			throws InstallerException {
		// メソッド開始タグ
		LoggerUtil.methodHead(_logger, "cleanDirectory(" + directory + ")");

		File[] children = directory.listFiles();
		for (int i = 0; i < children.length; i++) {
			delete(children[i]);
		}
		// メソッド終了タグ
		LoggerUtil.methodTail(_logger, "cleanDirectory(" + directory + ")");
	}

	/**
	 * 指定されたファイルまたはディレクトリを削除します。<br>
	 * ディレクトリの場合、先に子ファイル／ディレクトリを削除します。
	 * @param file 削除対象のディレクトリ。
	 * @throws InstallerException 削除に失敗した場合。
	 */
	public static void delete(File file) throws InstallerException {
		// メソッド開始タグ
		LoggerUtil.methodHead(_logger, "delete(" + file + ")");

		try {
			FileUtil.delete(file);
		}
		catch (Exception e) {
			LoggerUtil.throwable(_logger, e);
			throw new InstallerException(e);
		}
		// メソッド終了タグ
		LoggerUtil.methodTail(_logger, "delete(" + file + ")");
	}

	/**
	 * 入力ストリームを閉じます。<br>
	 * 指定された入力ストリームのクローズを試みます。
	 * その際、例外がスローされた場合、引数の指定により、
	 * このメソッドから例外をスローするか否か判断します。<br>
	 * @param stream クローズを試みる入力ストリーム。
	 * @param throwFlag クローズで例外が発生した場合、このメソッドが例外を
	 *         スローする場合はtrueを、スローさせない場合はfalseを指定します。
	 * @throws InstallerException クローズ中に例外が発生し、かつ、
	 *          throwFlagがtrueの場合。
	 */
	public static void close(InputStream stream, boolean throwFlag)
		throws InstallerException {

		try {
			FileUtil.close(stream, throwFlag);
		}
		catch (Exception e) {
			LoggerUtil.throwable(_logger, e);
			throw new InstallerException(e);
		}
	}

	/**
	 * 出力ストリームを閉じます。<br>
	 * 指定された出力ストリームのクローズを試みます。
	 * その際、例外がスローされた場合、引数の指定により、
	 * このメソッドから例外をスローするか否か判断します。<br>
	 * @param stream クローズを試みる出力ストリーム。
	 * @param throwFlag クローズで例外が発生した場合、このメソッドが例外を
	 *         スローする場合はtrueを、スローさせない場合はfalseを指定します。
	 * @throws InstallerException クローズ中に例外が発生し、かつ、
	 *          throwFlagがtrueの場合。
	 */
	public static void close(OutputStream stream, boolean throwFlag)
		throws InstallerException {

		try {
			FileUtil.close(stream, throwFlag);
		}
		catch (Exception e) {
			LoggerUtil.throwable(_logger, e);
			throw new InstallerException(e);
		}
	}

	/**
	 * 入出力ストリームを閉じます。<br>
	 * 指定された入力ストリームと出力ストリームのクローズを試みます。
	 * その際、例外がスローされた場合、引数の指定により、
	 * このメソッドから例外をスローするか否か判断します。<br>
	 * @param inStream クローズを試みる入力ストリーム。
	 * @param outStream クローズを試みる出力ストリーム。
	 * @param throwFlag クローズで例外が発生した場合、このメソッドが例外を
	 *         スローする場合はtrueを、スローさせない場合はfalseを指定します。
	 * @throws InstallerException クローズ中に例外が発生し、かつ、
	 *          throwFlagがtrueの場合。
	 */
	public static void close(
		InputStream inStream, OutputStream outStream, boolean throwFlag)
		throws InstallerException {

		InstallerException thrown = null;
		// 入力ストリームのクローズ
		try {
			close(inStream, throwFlag);
		}
		catch (InstallerException e) {
			thrown = e;
		}
		// 出力ストリームのクローズ
		try {
			close(outStream, throwFlag);
		}
		catch (InstallerException e) {
			if (thrown == null) {
				thrown = e;
			}
		}
		// どちらか一方から例外が発生した場合、スローします。
		if ( thrown != null ) {
			throw thrown;
		}
	}

	/**
	 * 文字入力ストリームを閉じます。<br>
	 * 指定された文字入力ストリームのクローズを試みます。
	 * その際、例外がスローされた場合、引数の指定により、
	 * このメソッドから例外をスローするか否か判断します。<br>
	 * @param reader クローズを試みる文字入力ストリーム。
	 * @param throwFlag クローズで例外が発生した場合、このメソッドが例外を
	 *         スローする場合はtrueを、スローさせない場合はfalseを指定します。
	 * @throws InstallerException クローズ中に例外が発生し、かつ、
	 *          throwFlagがtrueの場合。
	 */
	public static void close(Reader reader, boolean throwFlag)
		throws InstallerException {

		try {
			FileUtil.close(reader, throwFlag);
		}
		catch (Exception e) {
			LoggerUtil.throwable(_logger, e);
			throw new InstallerException(e);
		}
	}

	/**
	 * 文字出力ストリームを閉じます。<br>
	 * 指定された文字出力ストリームのクローズを試みます。
	 * その際、例外がスローされた場合、引数の指定により、
	 * このメソッドから例外をスローするか否か判断します。<br>
	 * @param writer クローズを試みる文字出力ストリーム。
	 * @param throwFlag クローズで例外が発生した場合、このメソッドが例外を
	 *         スローする場合はtrueを、スローさせない場合はfalseを指定します。
	 * @throws InstallerException クローズ中に例外が発生し、かつ、
	 *          throwFlagがtrueの場合。
	 */
	public static void close(Writer writer, boolean throwFlag)
		throws InstallerException {

		try {
			FileUtil.close(writer, throwFlag);
		}
		catch (Exception e) {
			LoggerUtil.throwable(_logger, e);
			throw new InstallerException(e);
		}
	}

	/**
	 * 文字入出力ストリームを閉じます。<br>
	 * 指定された文字入力ストリームと文字出力ストリームのクローズを試みます。
	 * その際、例外がスローされた場合、引数の指定により、
	 * このメソッドから例外をスローするか否か判断します。<br>
	 * @param reader クローズを試みる文字入力ストリーム。
	 * @param writer クローズを試みる文字出力ストリーム。
	 * @param throwFlag クローズで例外が発生した場合、このメソッドが例外を
	 *         スローする場合はtrueを、スローさせない場合はfalseを指定します。
	 * @throws InstallerException クローズ中に例外が発生し、かつ、
	 *          throwFlagがtrueの場合。
	 */
	public static void close(
		Reader reader, Writer writer, boolean throwFlag)
		throws InstallerException {

		InstallerException thrown = null;
		// 入力ストリームのクローズ
		try {
			close(reader, throwFlag);
		}
		catch (InstallerException e) {
			thrown = e;
		}
		// 出力ストリームのクローズ
		try {
			close(writer, throwFlag);
		}
		catch (InstallerException e) {
			if (thrown == null) {
				thrown = e;
			}
		}
		// どちらか一方から例外が発生した場合、スローします。
		if ( thrown != null ) {
			throw thrown;
		}
	}

	/**
	 * 指定したリソースファイルの内容を実ファイルにコピーします。<br>
	 * @param values インストーラ共通データオブジェクト。
	 * @param file コピー先となるリソースファイル。
	 * @param targetFileKey 取得するリソースファイル
	 * @throws InstallerException ファイルコピー中にエラーが発生した場合。
	 */
	public static void loadFile(InstallerValues values,
			File file, String targetFileKey)
		throws InstallerException {
		// メソッド開始タグ
		LoggerUtil.methodHead(_logger,
			"loadFile(" + file + "," + targetFileKey + ")");

		// リソースからの入力ストリーム
		InputStream inStream = null;
		// コピー先となる出力ストリーム
		OutputStream outStream = null;
		// 成功フラグ（成功した場合にtrueに変更）
		boolean successFlag = false;
		try {
			// 入力ストリームの生成
			inStream = values.getResourceKeyStream(targetFileKey);
			// コピー先の出力ストリームの生成
			outStream = new BufferedOutputStream(new FileOutputStream(file));
			// コピー開始
			while (true) {
				byte[] buffer = new byte[1024 * 10];
				int length = inStream.read(buffer);
				if (length <= 0) {
					break;
				}
				outStream.write(buffer, 0, length);
			}
			// tryブロックの最後まで到達したら、成功扱い
			successFlag = true;
		}
		catch (InstallerException e) {
			throw e;
		}
		catch (Exception e) {
			LoggerUtil.throwable(_logger, e);
			throw new InstallerException(e);
		}
		finally {
			close(inStream, outStream, successFlag);
		}
		// メソッド終了タグ
		LoggerUtil.methodTail(_logger,
			"loadFile(" + file + "," + targetFileKey + ")");
	}
}
