001/*
002 * Copyright (c) 2009 The openGion Project.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
013 * either express or implied. See the License for the specific language
014 * governing permissions and limitations under the License.
015 */
016package org.opengion.fukurou.xml;
017
018import org.opengion.fukurou.system.OgRuntimeException ;         // 6.4.2.0 (2016/01/29)
019import org.opengion.fukurou.system.ThrowUtil;                                                   // 6.4.2.0 (2016/01/29)
020import org.opengion.fukurou.util.FileUtil ;                                                     // 6.0.0.0 (2014/04/11) ログ関係を Writer で管理します。
021import org.opengion.fukurou.system.Closer ;
022import static org.opengion.fukurou.system.HybsConst.CR;                         // 6.1.0.0 (2014/12/26) refactoring
023
024import java.sql.Connection;
025import java.sql.SQLException;
026
027import java.io.Reader;
028import java.io.BufferedReader;
029import java.io.InputStreamReader;
030import java.io.FileInputStream;
031import java.io.InputStream;
032import java.io.IOException;
033import java.io.File;
034import java.io.UnsupportedEncodingException;
035import java.io.Writer;                                                          // 6.0.0.0 (2014/04/11) ログ関係を Writer で管理します。
036
037import java.util.Arrays;
038import java.util.List;
039import java.util.Map;
040import java.util.ArrayList;
041import java.util.Enumeration;
042import java.util.jar.JarFile;
043import java.util.jar.JarEntry;
044import java.net.URL;
045
046/**
047 * ORACLE XDK 形式のXMLファイルを読み取って、データベースに登録します。
048 *
049 * これは、Ver5の時は、org.opengion.hayabusa.common.InitFileLoader として
050 * 使用されていたクラスを改造したものです。
051 * InitFileLoader は、Ver6 では廃止されていますので、ご注意ください。
052 *
053 * 登録の実行有無の判断は、ファイルの更新時刻より判断します。(useTimeStamp=true の場合)
054 * これは、読み取りファイルの更新時刻が、0でない場合、読み取りを行います。
055 * 読み取りが完了した場合は、更新時刻を 0 に設定します。
056 * 読み取るファイルは、クラスローダーのリソースや、指定のフォルダ以下のファイル、そして、
057 * zip 圧縮されたファイルの中から、拡張子が xml で、UTF-8でエンコードされている
058 * 必要があります。通常は、ファイル名がテーブル名と同一にしておく必要がありますが、
059 * ROWSETのtable属性にテーブル名をセットしておくことも可能です。
060 * ファイルの登録順は、原則、クラスローダーの検索順に、見つかった全てのファイルを
061 * 登録します。データそのものは、INSERT のみ対応していますので、原則登録順は無視されます。
062 * ただし、拡張XDK 形式で、EXEC_SQL タグを使用した場合は、登録順が影響する可能性があります。
063 * 例:GE12.xml GE12 テーブルに登録するXMLファイル
064 * 登録時に、既存のデータの破棄が必要な場合は、拡張XDK 形式のXMLファイルを
065 * 作成してください。これは、EXEC_SQL タグに書き込んだSQL文を実行します。
066 * 詳細は、{@link org.opengion.fukurou.xml.HybsXMLHandler HybsXMLHandler} クラスを参照してください。
067 *
068 *   <ROWSET tableName="XX" >
069 *       <EXEC_SQL>                    最初に記載して、初期処理(データクリア等)を実行させる。
070 *           delete from GEXX where YYYYY
071 *       </EXEC_SQL>
072 *       <ROW num="1">
073 *           <カラム1>値1</カラム1>
074 *             ・・・
075 *           <カラムn>値n</カラムn>
076 *       </ROW>
077 *        ・・・
078 *       <ROW num="n">
079 *          ・・・
080 *       </ROW>
081 *       <EXEC_SQL>                    最後に記載して、項目の設定(整合性登録)を行う。
082 *           update GEXX set AA='XX' , BB='XX' where YYYYY
083 *       </EXEC_SQL>
084 *   <ROWSET>
085 *
086 * @og.rev 4.0.0.0 (2004/12/31) 新規作成(org.opengion.hayabusa.common.InitFileLoader)
087 * @og.rev 6.0.0.0 (2014/04/11) パッケージ、クラスファイル変更
088 *
089 * @version  6.0
090 * @author   Kazuhiko Hasegawa
091 * @since    JDK7.0,
092 */
093public final class XMLFileLoader {
094        private final Connection connection ;
095        private final boolean useTimeStamp ;
096
097        // 6.0.0.0 (2014/04/11) ログ関係を Writer で管理します。
098        private Writer log = FileUtil.getLogWriter( "System.out" );
099
100        // 6.0.0.0 (2014/04/11) タイムスタンプのゼロクリア対象のファイルを管理するリスト
101        private final List<File> fileList = new ArrayList<>();
102
103        // 6.0.0.0 (2014/04/11) setAfterMap メソッドの対応
104        /** 6.4.3.1 (2016/02/12) 作成元のMapを、HashMap から ConcurrentHashMap に置き換え。  */
105        private Map<String,String> afterMap     ;
106
107        // 6.0.0.0 (2014/04/11) 追加,更新,削除,実行 の各実行時のカウントの総数
108        private final int[] crudCnt = new int[] { 0,0,0,0 };    // CRUD カウントですが、配列の順番は追加,更新,削除,実行
109
110        /** getCRUDCount() で返される カウント数の配列番号 */
111        public static final int INS = 0;
112        public static final int DEL = 1;
113        public static final int UPD = 2;
114        public static final int DDL = 3;
115
116        /**
117         * コネクションを引数にする、コンストラクターです。
118         * classPath="resource" で初期化された XMLFileLoader を作成します。
119         * useTimeStamp 属性を true に設定すると、このファイルを読み取る都度
120         * タイムスタンプを、クリアします。
121         * また、タイムスタンプがクリアされたファイルは読み込みませんので、機能的に
122         * 一度しか読み込まないという事になります。
123         *
124         * @param       conn            登録用コネクション
125         * @param useTimeStamp  タイムスタンプの管理を行うかどうか[true:行う/false:行わない]
126         */
127        public XMLFileLoader( final Connection conn , final boolean useTimeStamp ) {
128                connection                      = conn ;
129                this.useTimeStamp       = useTimeStamp;
130        }
131
132        /**
133         * ログ出力を行う 内部ログ(Writer) を指定します。
134         * 
135         * 内部ログ(Writer) の初期値は、null とします。
136         * 内部ログ(Writer)が null の場合は、なにもしません。
137         *
138         * @og.rev 6.0.0.0 (2014/04/11) ログ関係を Writer で管理します。
139         *
140         * @param log Writerオブジェクト
141         */
142        public void setLogWriter( final Writer log ) {
143                this.log = log ;
144        }
145
146        /**
147         * XMLファイルを読み取った後で指定するカラムと値のペア(マップ)情報をセットします。
148         *
149         * このカラムと値のペアのマップは、オブジェクト構築後に設定される為、
150         * XMLファイルのキーの存在に関係なく、Mapのキーと値が使用されます。(Map優先)
151         * null を設定した場合は、なにも処理されません。
152         *
153         * @og.rev 6.0.0.0 (2014/04/11) 新規追加
154         *
155         * @param map   後設定するカラムデータマップ
156         */
157        public void setAfterMap( final Map<String,String> map ) {
158                afterMap = map;
159        }
160
161        /**
162         * XMLファイルを登録後の、追加,更新,削除,実行 のカウント配列を返します。
163         *
164         * 簡易的に処理したいために、配列に設定しています。
165         * 順番に、追加,更新,削除,実行 のカウント値になります。
166         *
167         * @og.rev 6.0.0.0 (2014/04/11) 新規追加
168         *
169         * @return 追加,更新,削除,実行 のカウント配列
170         * @og.rtnNotNull
171         */
172        public int[] getCRUDCount() {
173                // 6.0.2.5 (2014/10/31) refactoring
174                return crudCnt.clone();
175        }
176
177        /**
178         * 対象となるファイル群を ClassLoader の指定パスから、検索します。
179         * 
180         * 対象ファイルは、指定フォルダに テーブル名.xml 形式で格納しておきます。
181         * このフォルダのファイルをピックアップします。
182         * useTimeStamp 属性を true に設定すると、このファイルを読み取る都度
183         * タイムスタンプを、クリアします。
184         * また、タイムスタンプがクリアされたファイルは読み込みませんので、機能的に
185         * 一度しか読み込まないという事になります。
186         *
187         * @og.rev 6.0.0.0 (2014/04/11) 新規追加
188         * @og.rev 6.4.0.4 (2015/12/26) Writer(ログ)のCloseは、ここでは行わない。
189         * @og.rev 6.8.5.1 (2018/01/15) ファイル名は、##バージョン番号を変換しておく必要がある。
190         *
191         * @param path 対象となるファイル群を検索する、クラスパス
192         */
193        public void loadClassPathFiles( final String path ) {
194                try {
195                        final ClassLoader loader = Thread.currentThread().getContextClassLoader();
196                        final Enumeration<URL> enume = loader.getResources( path );
197                        while( enume.hasMoreElements() ) {
198                                final URL url = enume.nextElement();
199                                // jar:file:/実ディレクトリ または、file:/実ディレクトリ
200                                println( "      XMLFileLoader Scan:[ " + url + " ]" );                  // 6.0.0.0 (2014/04/11) ログ関係を Writer で管理
201//                              final String dir = url.getFile();
202                                final String dir = url.getFile().replaceAll( "%23%23","##" );   // 6.8.5.1 (2018/01/15)
203
204                                if( "jar".equals( url.getProtocol() ) ) {
205                                        // dir = file:/C:/webapps/gf/WEB-INF/lib/resource2.jar!/resource 形式です。
206                                        final String jar = dir.substring(dir.indexOf( ':' )+1,dir.lastIndexOf( '!' ));
207                                        // jar = /C:/webapps/gf/WEB-INF/lib/resource2.jar 形式に切り出します。
208
209                                        // 5.6.6.1 (2013/07/12) jarファイルも、タイムスタンプ管理の対象
210                                        loadJarFile( new File( jar ) );
211                                }
212                                else {
213                                        // 5.3.6.0 (2011/06/01) 実フォルダの場合、フォルダ階層を下る処理を追加
214                                        // dir = /C:/webapps/gf/WEB-INF/classes/resource/ 形式です。
215                                        loadXMLDir( new File( dir ) );
216                                }
217                        }
218                        Closer.commit( connection );
219                }
220                catch( final SQLException ex ) {
221                        final String errMsg = "SQL実行時にエラーが発生しました。"
222                                        + CR + ex.getMessage();
223                        Closer.rollback( connection );
224                        throw new OgRuntimeException( errMsg,ex );
225                }
226                catch( final IOException ex ) {
227                        final String errMsg = "XMLファイル読み取り時にエラーが発生しました。"
228                                        + CR + ex.getMessage();
229                        throw new OgRuntimeException( errMsg,ex );
230                }
231                finally {
232                        // 6.4.0.4 (2015/12/26) Writer(ログ)のCloseは、ここでは行わない。
233                        setZeroTimeStamp();                             // 6.0.0.0 (2014/04/11) タイムスタンプの書き換えをメソッド化
234                }
235        }
236
237        /**
238         * 対象となるファイル群を ファイル単体、フォルダ階層以下、ZIPファイル から、検索します。
239         * 
240         * 対象ファイルは、テーブル名.xml 形式で格納しておきます。
241         * この処理では、ファイル単体(*.xml)、フォルダ階層以下、ZIPファイル(*.jar , *.zip) は混在できません。
242         * 最初に判定した形式で、個々の処理に振り分けています。
243         *
244         * @og.rev 6.0.0.0 (2014/04/11) 新規追加
245         * @og.rev 6.4.0.4 (2015/12/26) Writer(ログ)のCloseは、ここでは行わない。
246         *
247         * @param       fileObj                 読取元のファイルオブジェクト
248         * @see         #loadClassPathFiles( String )
249         */
250        public void loadXMLFiles( final File fileObj ) {
251                try {
252                        // nullでなく、ファイル/フォルダが存在することが前提
253                        if( fileObj != null && fileObj.exists() ) {
254                                println( "      XMLFileLoader Scan:[ " + fileObj + " ]" );      // 6.0.0.0 (2014/04/11) ログ関係を Writer で管理
255                                loadXMLDir( fileObj );                  // ファイルかディレクトリ
256                        }
257                        Closer.commit( connection );
258                }
259                catch( final SQLException ex ) {
260                        final String errMsg = "SQL実行時にエラーが発生しました。"
261                                        + CR + ex.getMessage();
262                        Closer.rollback( connection );
263                        throw new OgRuntimeException( errMsg,ex );
264                }
265                catch( final IOException ex ) {
266                        final String errMsg = "XMLファイル読み取り時にエラーが発生しました。"
267                                        + CR + ex.getMessage();
268                        throw new OgRuntimeException( errMsg,ex );
269                }
270                finally {
271                        // 6.4.0.4 (2015/12/26) Writer(ログ)のCloseは、ここでは行わない。
272                        setZeroTimeStamp();                             // 6.0.0.0 (2014/04/11) タイムスタンプの書き換えをメソッド化
273                }
274        }
275
276        /**
277         * XMLフォルダ/ファイルを読み取り、データベースに追加(INSERT)するメソッドをコールします。
278         *
279         * ここでは、フォルダ階層を下るための再起処理を行っています。
280         * XMLファイルは、ORACLE XDK拡張ファイルです。テーブル名を指定することで、
281         * XMLファイルをデータベースに登録することが可能です。
282         * ORACLE XDK拡張ファイルや、EXEC_SQLタグなどの詳細は、{@link org.opengion.fukurou.xml.HybsXMLSave}
283         * を参照願います。
284         *
285         * @og.rev 5.3.6.0 (2011/06/01) 実フォルダの場合、フォルダ階層を下る処理を追加
286         *
287         * @param       jarObj                  読取元のJarファイルオブジェクト
288         * @throws SQLException,IOException  データベースアクセスエラー、または、データ入出力エラー
289         */
290        private void loadJarFile( final File jarObj ) throws SQLException,IOException {
291                if( ! useTimeStamp || jarObj.lastModified() > 0 ) {
292                        JarFile jarFile = null;
293                        try {
294                                jarFile = new JarFile( jarObj );
295                                final Enumeration<JarEntry> flEnum = jarFile.entries() ;                // 4.3.3.6 (2008/11/15) Generics警告対応
296                                while( flEnum.hasMoreElements() ) {
297                                        final JarEntry ent = flEnum.nextElement();                              // 4.3.3.6 (2008/11/15) Generics警告対応
298                                        final String file = ent.getName();
299                                        if( ! ent.isDirectory() && file.endsWith( ".xml" ) ) {
300                                                // 5.6.6.1 (2013/07/12) jarファイルの中身のタイムスタンプは見ない。
301                                                final String table = file.substring( file.lastIndexOf('/')+1,file.lastIndexOf('.') );
302                                                InputStream stream = null;
303                                                try {
304                                                        stream = jarFile.getInputStream( ent ) ;
305                                                        loadXML( stream,table,file );
306                                                }
307                                                finally {
308                                                        Closer.ioClose( stream );
309                                                }
310                                        }
311                                }
312                                fileList.add( jarObj );                 // 5.6.6.1 (2013/07/12) jarファイルも、タイムスタンプ管理の対象
313                        }
314                        finally {
315                                Closer.zipClose( jarFile );             // 5.5.2.6 (2012/05/25) findbugs対応
316                        }
317                }
318        }
319
320        /**
321         * XMLフォルダ/ファイルを読み取り、データベースに追加(INSERT)するメソッドをコールします。
322         *
323         * ここでは、フォルダ階層を下るための再起処理を行っています。
324         * XMLファイルは、ORACLE XDK拡張ファイルです。テーブル名を指定することで、
325         * XMLファイルをデータベースに登録することが可能です。
326         * ORACLE XDK拡張ファイルや、EXEC_SQLタグなどの詳細は、{@link org.opengion.fukurou.xml.HybsXMLSave}
327         * を参照願います。
328         *
329         * @og.rev 5.3.6.0 (2011/06/01) 実フォルダの場合、フォルダ階層を下る処理を追加
330         *
331         * @param       fileObj                 読取元のファイルオブジェクト
332         * @throws SQLException,IOException  データベースアクセスエラー、または、データ入出力エラー
333         */
334        private void loadXMLDir( final File fileObj ) throws SQLException,IOException {
335                if( fileObj.isDirectory() ) {
336                        final File[] list = fileObj.listFiles();
337                        // 6.3.9.0 (2015/11/06) null になっている可能性がある(findbugs)
338                        if( list != null ) {
339                                Arrays.sort( list );
340                                for( final File file : list ) {
341                                        loadXMLDir( file );
342                                }
343                        }
344                }
345                else if( ! useTimeStamp || fileObj.lastModified() > 0 ) {
346                        final String name = fileObj.getName() ;
347                        if( name.endsWith( ".xml" ) ) {
348                                final String table = name.substring( name.lastIndexOf('/')+1,name.lastIndexOf('.') );
349                                InputStream stream = null;
350                                try {
351                                        println( "        " + fileObj );                // 6.0.0.0 (2014/04/11) ログ関係を Writer で管理
352                                        stream = new FileInputStream( fileObj ) ;
353                                        loadXML( stream,table,fileObj.getPath() );
354                                        fileList.add( fileObj );                                // 正常に処理が終われば、リストに追加します。
355                                }
356                                finally {
357                                        Closer.ioClose( stream );
358                                }
359                        }
360                        else if( name.endsWith( ".zip" ) || name.endsWith( ".jar" ) ) {
361                                loadJarFile( fileObj );
362                        }
363                }
364        }
365
366        /**
367         * XMLファイルを読み取り、データベースに追加(INSERT)します。
368         *
369         * XMLファイルは、ORACLE XDK拡張ファイルです。テーブル名を指定することで、
370         * XMLファイルをデータベースに登録することが可能です。
371         * ORACLE XDK拡張ファイルや、EXEC_SQLタグなどの詳細は、{@link org.opengion.fukurou.xml.HybsXMLSave}
372         * を参照願います。
373         *
374         * @og.rev 5.6.6.1 (2013/07/12) 更新カウント数も取得します。
375         * @og.rev 5.6.7.0 (2013/07/27) HybsXMLSave の DDL(データ定義言語:Data Definition Language)の処理件数追加
376         * @og.rev 5.6.9.2 (2013/10/18) EXEC_SQL のエラー時に Exception を発行しない。
377         * @og.rev 6.2.0.0 (2015/02/27) try ~ finally 構文
378         *
379         * @param       stream  XMLファイルを読み取るInputStream
380         * @param       table   テーブル名(ROWSETタグのtable属性が未設定時に使用)
381         * @param       file    ログ出力用のファイル名
382         * @see org.opengion.fukurou.xml.HybsXMLSave
383         */
384        private void loadXML( final InputStream stream, final String table, final String file )
385                                                                        throws SQLException,UnsupportedEncodingException {
386                // 6.2.0.0 (2015/02/27) try ~ finally 構文
387                Reader reader = null;
388                try {
389                        // InputStream より、XMLファイルを読み取り、table に追加(INSERT)します。
390                        reader = new BufferedReader( new InputStreamReader( stream,"UTF-8" ) );
391                        final HybsXMLSave save = new HybsXMLSave( connection,table );
392                        save.onExecErrException( false );               // 5.6.9.2 (2013/10/18) EXEC_SQL のエラー時に Exception を発行しない。
393                        save.setAfterMap( afterMap );                   // 6.0.0.0 (2014/04/11) 新規追加
394                        save.insertXML( reader );
395
396                        final int insCnt = save.getInsertCount();
397                        final int delCnt = save.getDeleteCount();
398                        final int updCnt = save.getUpdateCount();               // 5.6.6.1 (2013/07/12) 更新カウント数も取得
399                        final int ddlCnt = save.getDDLCount();                  // 5.6.7.0 (2013/07/27) DDL処理件数追加
400
401                        crudCnt[INS] += insCnt ;
402                        crudCnt[DEL] += delCnt ;
403                        crudCnt[UPD] += updCnt ;
404                        crudCnt[DDL] += ddlCnt ;
405
406                        final String tableName = save.getTableName() ;
407
408                        // 6.0.0.0 (2014/04/11) ログ関係を Writer で管理
409                        println( "          File=[" + file + "] TABLE=[" + tableName + "] DEL=["+ delCnt +"] INS=[" + insCnt + "] UPD=[" + updCnt + "] DDL=[" + ddlCnt + "]" );
410                }
411                finally {
412                        Closer.ioClose( reader );
413                }
414        }
415
416        /**
417         * 指定のリストのファイルのタイムスタンプをゼロに設定します。
418         * useTimeStamp=true の時に、XMLファイルのロードに成功したファイルの
419         * タイムスタンプをゼロに設定することで、2回目の処理が避けられます。
420         *
421         * @og.rev 6.0.0.0 (2014/04/11) 新規追加
422         */
423        private void setZeroTimeStamp() {
424                if( useTimeStamp ) {
425                        for( final File file : fileList ) {
426                                if( !file.setLastModified( 0L ) ) {
427                                        final String errMsg = "タイムスタンプの書き換えに失敗しました。"
428                                                                        + "file=" + file ;
429                                        System.err.println( errMsg );
430                                }
431                        }
432                }
433        }
434
435        /**
436         * 登録されている ログ(Writer) に、メッセージを書き込みます。
437         * メッセージの最後に改行を挿入します。
438         *
439         * 内部ログ(Writer)が null の場合は、なにもしません。
440         * 内部ログ(Writer) の初期値は、標準出力(System.out) から作成された Writerです。
441         *
442         * @og.rev 6.0.0.0 (2014/04/11) ログ関係を Writer で管理
443         * @og.rev 6.4.2.0 (2016/01/29) ex.printStackTrace() を、ThrowUtil#ogStackTrace(Throwable) に置き換え。
444         *
445         * @param       msg 書き出すメッセージ
446         */
447        private void println( final String msg ) {
448                if( log != null ) {
449                        try {
450                                log.write( msg );
451                                log.write( CR );
452                        }
453                        catch( final IOException ex ) {
454                                // ファイルが書き込めなかった場合
455                                final String errMsg = msg + " が、書き込めませんでした。"
456                                                                        + ex.getMessage() ;
457                                System.err.println( errMsg );
458                                System.err.println( ThrowUtil.ogStackTrace( ex ) );                             // 6.4.2.0 (2016/01/29)
459                        }
460                }
461        }
462}