/*
 * Copyright (c) 2009 The openGion Project.
 *
 * 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.opengion.fukurou.db;

import java.sql.CallableStatement;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.ResultSetMetaData;
import java.sql.SQLException;
import java.sql.Types;
import java.util.ArrayList;
import java.util.Locale;

import org.opengion.fukurou.util.ApplicationInfo;
import org.opengion.fukurou.util.Closer;
import org.opengion.fukurou.util.StringUtil;

/**
 * データベース関連の便利なメソッドを集めた簡易ユーティリティークラスです。
 * 全てのメソッドは、static メソッドになっています。
 *
 * @og.rev 2.1.1.1 (2002/11/15) Serializable インターフェースを削除する。
 * @og.rev 4.0.0.0 (2007/10/16) DBアクセス関係のメソッドのみをパッケージ移動(hayabusa/db > fukurou/db)
 * @og.group ＤＢ/Shell制御
 *
 * @version  4.0
 * @author   Kazuhiko Hasegawa
 * @since    JDK5.0,
 */
public final class DBUtil {

	/** システム依存の改行記号をセットします。4.0.0.0(2007/10/17) */
	private static final String CR = System.getProperty( "line.separator" );


	/**
	 * インスタンスを作らないので、コンストラクタは、private に設定します。
	 */
	private DBUtil() {}

	/**
	 * 移動対象
	 *
	 * 初期データベースに接続して、Queryを実行します。
	 * ステートメントと引数により、Prepared クエリーの検索のみ実行します。
	 * 結果は,すべて文字列に変換されて格納されます。
	 * <del>検索するデータベースは、DEFAULT です。</del>
	 *
	 * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfo オブジェクトを設定
	 * @og.rev 4.0.0.0 (2007/10/10) dbid の初期値を、"DEFAULT" から null に変更
	 *
	 * @param   stmt ステートメント文字列
	 * @param   args オブジェクトの引数配列
	 * @param   appInfo ApplicationInfo
	 * @return  検索結果の配列
	 */
	public static String[][] dbExecute( final String stmt ,final String[] args ,final ApplicationInfo appInfo ) {
	//	return dbExecute( stmt ,args,appInfo,"DEFAULT" );
		return dbExecute( stmt ,args,appInfo,null );
	}

	/**
	 * 移動対象
	 *
	 * 検索するデータベースを指定して、Queryを実行します。
	 * ステートメントと引数により、Prepared クエリーの検索のみ実行します。
	 * 結果は,すべて文字列に変換されて格納されます。
	 * 追加：検索以外のSQLも実行できます。結果は、null を返します。
	 *
	 * @og.rev 3.0.0.0 (2002/12/25) 検索のみのクエリーから、何でもありのクエリーに変更
	 * @og.rev 2.3.1.3 (2003/01/28) Open Cursor が、大量に残る件の対応。ResultSet を close()
	 * @og.rev 3.8.0.8 (2005/10/03) エラーメッセージの出力順をメッセージ＋Queryに変更します。
	 * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfo オブジェクトを設定
	 * @og.rev 4.0.0.1 (2007/12/03) try ～ catch ～ finally をきちんと行う。
	 *
	 * @param   stmt ステートメント文字列
	 * @param   args オブジェクトの引数配列
	 * @param   appInfo ApplicationInfo
	 * @param   dbid 接続先ID
	 * @return  検索結果の配列
	 */
	public static String[][] dbExecute( final String stmt ,final String[] args, final ApplicationInfo appInfo, final String dbid ) {
		return dbExecute( stmt ,args, appInfo, dbid, false );
	}

	/**
	 * 移動対象
	 *
	 * 検索するデータベースを指定して、Queryを実行します。
	 * ステートメントと引数により、Prepared クエリーの検索のみ実行します。
	 * 結果は,すべて文字列に変換されて格納されます。
	 * 追加：検索以外のSQLも実行できます。結果は、null を返します。
	 *
	 * @og.rev 4.3.7.0 (2009/06/01) 新規作成
	 *
	 * @param   stmt ステートメント文字列
	 * @param   args オブジェクトの引数配列
	 * @param   appInfo ApplicationInfo
	 * @param   dbid 接続先ID
	 * @param   useHeader 1行目にヘッダーを含めるか
	 * @return  検索結果の配列
	 */
	public static String[][] dbExecute( final String stmt ,final String[] args, final ApplicationInfo appInfo, final String dbid, final boolean useHeader ) {
		Connection conn = null;
		PreparedStatement pstmt = null;
		ResultSet resultSet = null;
		String[][] rtn = null;
		boolean errFlag = true;
		try {
			conn = ConnectionFactory.connection( dbid,appInfo );
			pstmt = conn.prepareStatement( stmt );
			if( args != null ) {
				for( int i=0; i<args.length; i++ ) {
					pstmt.setObject( i+1,args[i] );
				}
			}
			boolean status = pstmt.execute();
			if( status ) {
				resultSet = pstmt.getResultSet();
//				rtn = DBUtil.resultToArray( resultSet,false );
				rtn = DBUtil.resultToArray( resultSet,useHeader ); // 4.3.7.0 (2009/06/01)
			}
			else {
				conn.commit();
			}
			errFlag = false;	// エラーでない
		}
		catch ( SQLException ex ) {
			Closer.rollback( conn );
			String errMsg = ex.getMessage() + ":" + ex.getSQLState() + CR
						+ "SQL=[" + stmt + "]" + CR
						+ "ARG=[" + StringUtil.array2csv( args ) + "]" + CR
						+ "DBID=[" + dbid + "]" + CR;
			throw new RuntimeException( errMsg,ex );
		}
		finally {
			Closer.resultClose( resultSet );
			Closer.stmtClose( pstmt );

			if( errFlag ) { ConnectionFactory.remove( conn,dbid ); }
			else {			ConnectionFactory.close( conn,dbid );  }
		}
		return rtn;
	}


	/**
	 * 初期データベースに接続して、CallableStatement(PL/SQL)を実行します。
	 * ステートメントと引数により、CallableStatement クエリーを実行します。
	 * 結果は,ステータスとエラーメッセージを返します。便宜的に、String配列に
	 * 設定して返します。
	 * ステートメント文字列には、 { call PLSQL( ?,?,?･･･ ) } となります。
	 * 第一引数、第二引数は、OUT属性で、結果(STATUS)とエラー時の内容(ERR_CODE)を返します。
	 * 第三引数以降の ? には、オブジェクトの引数配列 が順に割り当てられます。
	 * <del>検索するデータベースは、DEFAULT です。</del>
	 *
	 * @og.rev 3.8.0.0 (2005/06/07) 新規追加
	 * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfo オブジェクトを設定
	 * @og.rev 4.0.0.0 (2007/10/10) dbid の初期値を、"DEFAULT" から null に変更
	 *
	 * @param   stmt ステートメント文字列
	 * @param   args オブジェクトの引数配列
	 * @param   appInfo ApplicationInfo
	 * @return  実行結果([0]=ステータス、[1]=エラーメッセージ
	 */
	public static String[] dbCallExecute( final String stmt ,final String[] args, final ApplicationInfo appInfo ) {
	//	return dbCallExecute( stmt ,args,appInfo,"DEFAULT" );
		return dbCallExecute( stmt ,args,appInfo,null );
	}

	/**
	 * 検索するデータベースを指定して、CallableStatement(PL/SQL)を実行します。
	 * ステートメントと引数により、CallableStatement クエリーを実行します。
	 * 結果は,ステータスとエラーメッセージを返します。便宜的に、String配列に
	 * 設定して返します。
	 * ステートメント文字列には、 { call PLSQL( ?,?,?･･･ ) } となります。
	 * 第一引数、第二引数は、OUT属性で、結果(STATUS)とエラー時の内容(ERR_CODE)を返します。
	 * 第三引数以降の ? には、オブジェクトの引数配列 が順に割り当てられます。
	 * 検索するデータベースは、DEFAULT です。
	 *
	 * @og.rev 3.8.0.0 (2005/06/07) 新規追加
	 * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfo オブジェクトを設定
	 * @og.rev 4.0.0.1 (2007/12/03) try ～ catch ～ finally をきちんと行う。
	 *
	 * @param   stmt ステートメント文字列
	 * @param   args オブジェクトの引数配列
	 * @param   appInfo ApplicationInfo
	 * @param   dbid 接続先ID
	 * @return  実行結果([0]=ステータス、[1]=エラーメッセージ
	 */
	public static String[] dbCallExecute( final String stmt ,final String[] args, final ApplicationInfo appInfo ,final String dbid ) {
		Connection conn = null ;
		CallableStatement callStmt = null ;

		String[] rtn = new String[2] ;

		boolean errFlag = true;
		try {
			conn = ConnectionFactory.connection( dbid,appInfo );
			callStmt = conn.prepareCall( stmt );

			callStmt.registerOutParameter( 1, Types.INTEGER );
			callStmt.registerOutParameter( 2, Types.VARCHAR );
			if( args != null ) {
				for( int i=0; i<args.length; i++ ) {
					callStmt.setObject( i+3,args[i] );
				}
			}
			callStmt.execute();

			rtn[0] = String.valueOf( callStmt.getInt(1) );	// 結果ステータス
			rtn[1] = callStmt.getString(2);					// 内容(エラーメッセージ)

			conn.commit();
			errFlag = false;	// エラーでない
		}
		catch ( SQLException ex ) {
			Closer.rollback( conn );
			String errMsg = ex.getMessage() + ":" + ex.getSQLState() + CR
						+ "SQL=[" + stmt + "]" + CR
						+ "ARG=[" + StringUtil.array2csv( args ) + "]" + CR
						+ "DBID=[" + dbid + "]" + CR;
			throw new RuntimeException( errMsg,ex );
		}
		finally {
			Closer.stmtClose( callStmt );
			if( errFlag ) { ConnectionFactory.remove( conn,dbid ); }
			else {			ConnectionFactory.close( conn,dbid );  }
		}
		return rtn;
	}

	/**
	 * SQL文の実行結果において、データの件数を取得します。
	 * ステートメントと引数により、Prepared クエリーの検索を実行します。
	 * 結果は、件数を数値で返します。
	 * あくまで、存在チェックに必要な処理のみ行っているため、通常の検索より高速です。
	 *
	 * @og.rev 3.5.0.0 (2003/09/17) 新規作成
	 * @og.rev 3.8.0.8 (2005/10/03) エラーメッセージの出力順をメッセージ＋Queryに変更します。
	 * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfo オブジェクトを設定
	 * @og.rev 4.0.0.1 (2007/12/03) try ～ catch ～ finally をきちんと行う。
	 *
	 * @param   stmt ステートメント文字列
	 * @param   args オブジェクトの引数配列
	 * @param   appInfo ApplicationInfo
	 * @param   dbid 接続先ID
	 * @return  検索結果（データの件数）
	 */
	public static int dbExist( final String stmt ,final String[] args, final ApplicationInfo appInfo , final String dbid ) {
		Connection conn = null;
		PreparedStatement pstmt = null;
		ResultSet resultSet = null;
		int rtnCnt = -1;

		boolean errFlag = true;
		try {
			conn = ConnectionFactory.connection( dbid,appInfo );
			pstmt = conn.prepareStatement( stmt );
			if( args != null ) {
				for( int i=0; i<args.length; i++ ) {
					pstmt.setObject( i+1,args[i] );
				}
			}

			resultSet = pstmt.executeQuery();
			if( resultSet.next() ) {
				rtnCnt = resultSet.getInt(1);
			}
			errFlag = false;	// エラーでない
		}
		catch ( SQLException ex ) {
			String errMsg = ex.getMessage() + ":" + ex.getSQLState() + CR
						+ "SQL=[" + stmt + "]" + CR
						+ "ARG=[" + StringUtil.array2csv( args ) + "]" + CR
						+ "DBID=[" + dbid + "]" + CR;
			throw new RuntimeException( errMsg,ex );		// 3.5.5.4 (2004/04/15) 引数の並び順変更
		}
		finally {
			Closer.resultClose( resultSet );
			Closer.stmtClose( pstmt );

			if( errFlag ) { ConnectionFactory.remove( conn,dbid ); }
			else {			ConnectionFactory.close( conn,dbid );  }
		}
		return rtnCnt;
	}

	/**
	 * 移動したメソッドで使われているのでこれも移動
	 *
	 * ResultSet より、結果の文字列配列を作成します。
	 * 結果は,すべて文字列に変換されて格納されます。
	 *
	 * @og.rev 3.1.0.0 (2003/03/20) Vector を使用している箇所で、非同期でも構わない箇所を、ArrayList に置換え。
	 * @og.rev 3.8.0.8 (2005/10/03) エラーメッセージの出力順をメッセージ＋Queryに変更します。
	 * @og.rev 4.0.0 (2005/01/31) private ⇒ public , ヘッダー情報の取得有無フラグの追加
	 *
	 * @param   resultSet ResultSet
	 * @param   useHeader boolean   true:ヘッダーを第一行に含める/false:含めない
	 * @return  ResultSet の検索結果配列
	 */
	public static String[][] resultToArray( final ResultSet resultSet,final boolean useHeader ) {
		ArrayList<String[]> data = new ArrayList<String[]>();
		try {
			ResultSetMetaData metaData  = resultSet.getMetaData();
			int numberOfColumns =  metaData.getColumnCount();

			if( useHeader ) {
				String[] columnNames = new String[numberOfColumns];
				for( int column = 0; column < numberOfColumns; column++ ) {
					columnNames[column]	 = ( metaData.getColumnLabel(column+1) ).toUpperCase(Locale.JAPAN) ;
				}
				data.add( columnNames );
			}

			while( resultSet.next() ) {
				String[] columnValues = new String[numberOfColumns];
				for( int i = 1; i <= numberOfColumns; i++ ) {
					Object obj = resultSet.getObject(i);
					if( obj == null ) {
						columnValues[i-1] = "";
					}
					else {
						columnValues[i-1] = String.valueOf( obj );
					}
				}
				data.add( columnValues );
			}
		}
		catch ( SQLException ex ) {
			String errMsg = "処理結果を実行できませんでした。"
						+ CR + ex.getMessage() ;
			throw new RuntimeException( errMsg,ex );		// 3.5.5.4 (2004/04/15) 引数の並び順変更
		}

		int size = data.size();
		String[][] rtn = new String[size][];
		for( int i=0; i<size; i++ ) {
			rtn[i] = data.get(i);
		}

		return rtn;
	}
}
