package com.ntsky.pool;

import java.io.*;
import java.sql.*;
import java.util.*;

import com.ntsky.common.*;

/**
 * <p>Title: NTsky新聞發布v1.0正式版</p>
 * <p>Description: 數據庫連接池</p>
 * <p>Copyright: Copyright (c) 2003</p>
 * <p>Company: NTsky</p>
 * @authory 姚君林
 * @version 1.0
 */

public class DBConnectionManager {
    static private DBConnectionManager instance; //唯一實例的引用
    static private int clients; //客戶端的連接數目
    private Vector drivers = new Vector();
    private Hashtable pools = new Hashtable(); //創建一個Hashtable對象

    class DBConnectionPool { //定義一個DBConnectionPool類[如果DBConnectionManager要訪問DBConnectionPool必須創建DBConnectionPool的對象]

        private int checkedOut; //判斷是否還有可用的連接
        private Vector freeConnections = new Vector();//創建一個freeConnections的數組
        private int maxConn; //最大連接數
        private String name; //數據庫連接池名
        private String user; //訪問數據庫用戶名
        private String password; //訪問數據庫密碼
        private String URL; //數據庫地址
        private PrintWriter log; //日志
        /**
         * 配置文件各項參數
         * @param name
         * @param url
         * @param user
         * @param password
         * @param maxConn
         */
        public DBConnectionPool(String name, String url, String user,
                                String password, int maxConn) {
            /**
             *配置文件
             */
            this.name = name; //poolname 連接池名
            this.URL = url; //地址
            this.user = user; //用戶名
            this.password = password; //密碼
            this.maxConn = maxConn; //最大的連接數
            //寫日志
            this.log = new PrintWriter(System.err);
            Debug.writeLog("poolname" + this.name); //7、"poolname" + Connection
            Debug.writeLog("URL: " + this.URL); //8、jdbc:mysql://127.0.0.1:3306/nt
            Debug.writeLog("user: " + this.user); //9、user: skyyjl
            Debug.writeLog("password: " + this.password); //10、password: abc
            Debug.writeLog("maxConn: " + this.maxConn); //11、maxConn: 100
        }

        /**
         * 把空閑的連接登記到連接池由的freeConnection()方法實現
         * 它的參數為返回給連接池的連接對象。該對象被加入到freeConnections向量的末尾，然后減少已使用連接計數。
         * 調用notifyAll()是為了通知其它正在等待可用連接的線程。
         * @param Conn
         */
        public synchronized void freeConnection(Connection Conn) {
            freeConnections.addElement(Conn);
            checkedOut--;
            notifyAll();
        }

        /**
         * 如連接池中存在可用連接，則直接返回，否則創建新的連接并返回。
         * 如果沒有可用連接且已有連接總數等于最大限制數，第一個方法將直接返回null，
         * 而第二個方法將等待直到有可用連接為止
         * 所有的可用連接對象均登記在名為freeConnections的向量（Vector）中。
         * 如果向量中有多于一個的連接，getConnection()總是選取第一個。
         * 由于新的可用連接總是從尾部加入向量，從而使得數據庫連接由于長時間閑置而被關閉的風險減低到最小程度。
         *
         * @return Connection
         */
        public synchronized Connection getConnection() {
            Connection con = null;
            if (freeConnections.size() > 0) { //獲取向量中第一個可用連接
                con = (Connection) freeConnections.firstElement(); //創建第一個connection，并用設置為Connection
                freeConnections.removeElementAt(0);
                try {
                    /**
                     * 第一個getConnection()在返回可用連接給客戶程序之前，調用了isClosed()方法驗證連接仍舊有效。
                     * 如果該連接被關閉或觸發異常，getConnection()遞歸地調用自己以嘗試獲取另外的可用連接。
                     */
                    if (con.isClosed()) { //判斷連接是否關閉
                        Debug.writeLog("從連接池" + name + "刪除一個無效連接");
                        con = getConnection(); //遞歸調用自己,嘗試再次獲取可用連接
                    }
                }
                catch (SQLException e) {
                    Debug.writeLog("從連接池" + name + "刪除一個無效連接"); // 遞歸調用自己,嘗試再次獲取可用連接
                    con = getConnection();
                }
            }
            /**
             * 如果在向量freeConnections中不存在任何可用連接，getConnection()方法檢查是否已經指定最大連接數限制。
             * 如已經指定，則檢查當前連接數是否已經到達極限。此處maxConn為0表示沒有限制。
             * 如果沒有指定最大連接數限制或當前連接數小于該值，該方法嘗試創建新的連接。
             * 如創建成功，則增加已使用連接的計數(checkout)并返回，否則返回空值。
             */
            else if (maxConn == 0 || checkedOut < maxConn) {
                con = newConnection(); //創建連接(數量由maxConn決定)
            }
            if (con != null) { //如果conn(連接數)不為空，判斷就加
                checkedOut++;
            }
            if (con == null) { //如果為空就將con為空寫入日志
                Debug.writeLog(
                    "DBConnectionPool getConnection(), The Returned Con is null");
            }
            return con; //返回連接
        }

        /**
         * 用一個以毫秒為單位的時間參數，該參數表示客戶程序能夠等待的最長時間。
         * 建立連接的具體操作仍舊由第一個getConnection()方法實現。
         * 參見前一個getConnection()方法.
         * @param timeout 以毫秒計的等待時間限制
         */
        public synchronized Connection getConnection(long timeout) {
            long startTime = new java.util.Date().getTime(); //連接的初始時間
            Connection con;
            /**
             * 在while循環中嘗試獲得一個連接。如果失敗，則以給定的時間值為參數調用wait()。
             * wait()的返回可能是由于其它線程調用notify()或notifyAll()，也可能是由于預定時間已到。
             * 為找出wait()返回的真正原因，程序用當前時間減開始時間（startTime），
             * 如差值大于預定時間則返回空值，否則再次調用getConnection()。
             */
            while ( (con = getConnection()) == null) {
                try {
                    wait(timeout);
                }
                catch (InterruptedException e) {

                }
                if ( (new java.util.Date().getTime() - startTime) >= timeout) { //wait()返回的原因是超時
                    return null; //連接超時,釋放掉連接
                }
            }
            return con; //返回連接
        }

        private void log(String msg) {
            log.println(new java.util.Date() + ": " + msg);
        }

        /**
         * 將文本信息與異常寫入日志文件
         */
        private void log(Throwable e, String msg) {
            log.println(new java.util.Date() + ": " + msg);
            e.printStackTrace(log);
        }

        /**
         * 創建新連接由newConnection()方法實現。
         * 創建過程與是否已經指定數據庫帳號、密碼有關。
         * JDBC的DriverManager類提供多個getConnection()方法，這些方法要用到JDBC URL與其它一些參數，如用戶帳號和密碼等。
         * DriverManager將使用指定的JDBC URL確定適合于目標數據庫的驅動程序及建立連接。
         */
        private Connection newConnection() {
            Connection con = null;
            try {
                if (user == null) {
                    con = DriverManager.getConnection(URL); //保持數據庫連接加載數據庫驅動程序
                }
                else {
                    con = DriverManager.getConnection(URL, user, password);
                }
                Debug.writeLog("連接池" + name + "創建一個新的連接"); //21、如果有用戶連接就寫入日志說明有用戶創建了連接
            }
            catch (SQLException e) {
                Debug.writeLog("無法創建下列URL的連接: " + URL);
                e.printStackTrace(System.out);
                return null;
            }
            if (con == null) {
                Debug.writeLog(
                    "DBConnectionPool newConnection(), The Returned Con is null");
            }
            return con;
        }

        /**
         * 實現的release()方法供DBConnectionManager調用。
         * 該方法遍歷freeConnections向量并關閉所有連接，然后從向量中刪除這些連接。