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.hayabusa.taglib;
017
018import static org.opengion.fukurou.util.StringUtil.nval;
019
020import java.io.IOException;
021import java.io.ObjectInputStream;
022import java.io.ObjectOutputStream;
023import java.util.Locale;
024
025import org.opengion.fukurou.db.DBUtil;
026import org.opengion.fukurou.db.Transaction;
027import org.opengion.fukurou.db.TransactionReal;
028import org.opengion.fukurou.util.ErrorMessage;
029import org.opengion.fukurou.util.StringUtil;
030import org.opengion.hayabusa.common.HybsSystem;
031import org.opengion.hayabusa.common.HybsSystemException;
032import org.opengion.hayabusa.db.DBColumn;
033import org.opengion.hayabusa.db.DBEditConfig;
034import org.opengion.hayabusa.db.DBTableModel;
035import org.opengion.hayabusa.db.Query;
036import org.opengion.hayabusa.db.QueryFactory;
037import org.opengion.hayabusa.resource.GUIInfo;
038
039/**
040 * データベースの検索を行うタグです。
041 *
042 * このタグの内容に、SQL文を記述します。 whereタグ、 andタグ を使うと引数に応じて
043 * 実行されるSQL文が異なります(使用例参照)。
044 * また、PL/SQLのSPで検索を行うときもこのタグを使います。
045 * SystemData の USE_SQL_INJECTION_CHECK が true か、quotCheck 属性が true の場合は、
046 * SQLインジェクション対策用のクォーティションチェックを行います。リクエスト引数に
047 * クォーティション(')が含まれると、エラーになります。
048 * 同様にUSE_XSS_CHECKがtrueか、xssCheck属性がtrueの場合は、
049 * クロスサイトススクリプティング(XSS)対策のためless/greater than signのチェックを行います。
050 *
051 * ※ このタグは、Transaction タグの対象です。
052 *
053 * @og.formSample
054 * ●形式:
055 *       ・<og:query command="NEW" >
056 *              SELECT文 
057 *         </og:query>
058 *       ・<og:query command="NEW" names="・・・" queryType="JDBCErrMsg" >
059 *              { call PL/SQL(?,?,?,? ) } 
060 *         </og:query>
061 * ●body:あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します)
062 *
063 * ●Tag定義:
064 *   <og:query
065 *       queryType          【TAG】Query を発行する為のクラスID(JDBC,JDBCCallable,JDBCErrMsg,JDBCUpdate)を指定します{@og.doc03Link queryType 初期値:JDBC})
066 *       command            【TAG】コマンド(NEW,RENEW)をセットします(PlsqlUpdateTag,UpdateTag の場合は、ENTRY)
067 *       scope              【TAG】キャッシュする場合のスコープ[request/page/session/applicaton]を指定します(初期値:session)
068 *       maxRowCount        【TAG】(通常は使いません)データの最大読み込み件数を指定します (初期値:DB_MAX_ROW_COUNT[=1000])(0:[無制限])
069 *       skipRowCount       【TAG】(通常は使いません)データの読み始めの初期値を指定します
070 *       displayMsg         【TAG】検索結果を画面上に表示するメッセージリソースIDを指定します (初期値:VIEW_DISPLAY_MSG[=])
071 *       overflowMsg        【TAG】検索データが最大検索数をオーバーした場合に表示するメッセージリソースIDを指定します (初期値:MSG0007[検索結果が、制限行数を超えましたので、残りはカットされました])
072 *       notfoundMsg        【TAG】検索結果がゼロ件の場合に表示するメッセージリソースIDを指定します(初期値:MSG0077[対象データはありませんでした])
073 *       names              【TAG】PL/SQLを利用する場合の引数にセットすべき データの名称をCSV形式で複数指定します
074 *       stopZero           【TAG】検索結果が0件のとき処理を続行するかどうか[true/false]を指定します(初期値:false[続行する])
075 *       tableId            【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します
076 *       dbid               【TAG】(通常は使いません)Queryオブジェクトを作成する時のDB接続IDを指定します
077 *       trace              【TAG】引数の SQL 文を EXPLAIN PLAN を[true:行う/それ以外:行わない]を指定します(初期値:false)
078 *       checkNames         【TAG】リクエスト変数の正規化を行うカラムをCSV形式で複数指定します
079 *       modifyType         【TAG】DB検索時の モディファイタイプを指定します[A:追加/C:更新/D:削除]
080 *       quotCheck          【TAG】リクエスト情報の クォーティション(') 存在チェックを実施するかどうか[true/false]を設定します(初期値:USE_SQL_INJECTION_CHECK)
081 *       stopError          【TAG】PLSQL/SQL処理エラーの時に処理を中止するかどうか[true/false]を設定します(初期値:true)
082 *       dispError                      【TAG】エラー時にメッセージを表示するか[true/false]を設定します。通常はstopErrorと併用(初期値:true)
083 *       xssCheck           【TAG】リクエスト情報の HTMLTag開始/終了文字(><) 存在チェックを実施するかどうか[true/false]を設定します (初期値:USE_XSS_CHECK[=true])
084 *       mainTrans          【TAG】(通常使いません)タグで処理される処理がメインとなるトランザクション処理かどうかを指定します(初期値:true)
085 *       caseKey            【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null)
086 *       caseVal            【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null)
087 *       caseNN             【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:true)
088 *       caseNull           【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:true)
089 *       useBeforeHtmlTag   【TAG】 処理時間(queryTime)などの情報出力[true:有効/false:無効]を指定します(初期値:true)
090 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
091 *   >   ... Body ...
092 *   </og:query>
093 *
094 * ●使用例
095 *     <og:query command="NEW">
096 *             select PN,YOBI,NMEN,HINM from XX01 where PN = '{@PN}' order by PN
097 *     </og:query>
098 *
099 *          ・検索条件が入力された時({@PN}がNOT NULLのとき)
100 *            作成されるSQL文⇒select PN,YOBI,NMEN,HINM from XX01 where PN = 'AAA' order by PN
101 *          ・検索条件が入力されなかった時({@PN}がNULLのとき)
102 *            作成されるSQL文⇒select PN,YOBI,NMEN,HINM from XX01 where PN = '' order by PN
103 *
104 *     <og:query command="NEW">
105 *             select PN,YOBI,NMEN,HINM from XX01
106 *         <og:where>
107 *             <og:and value="PN = '{@PN}%'" />
108 *             <og:and value="YOBI like '{@YOBI}%'" />
109 *         </og:where>
110 *             order by PN
111 *     </og:query>
112 *
113 *          ・検索条件が入力された時({@PN}がNOT NULLのとき)
114 *            作成されるSQL文⇒select PN,YOBI,NMEN,HINM from XX01 PN = 'AAA%' and YOBI like 'BBB%' order by PN
115 *          ・検索条件が入力されなかった時({@PN}がNULLのとき) WHERE句がなくなる。
116 *            作成されるSQL文⇒select PN,YOBI,NMEN,HINM from XX01 order by PN
117 *
118 *        注意:WhereTagを使った場合、下のようにはなりません。
119 *            select PN,YOBI,NMEN,HINM from XX01 PN = '' and YOBI like '%' order by PN
120 *
121 *     <og:query command="NEW">
122 *             select PN,YOBI,NMEN,HINM from XX01 where PN="11111"
123 *         <og:where startKey="and">
124 *             <og:and value="YOBI like '{@PN}%'" />
125 *         </og:where>
126 *             order by PN
127 *     </og:query>
128 *
129 *          ・検索条件が入力された時({@YOBI}がNOT NULLのとき)
130 *            作成されるSQL文⇒select PN,YOBI,NMEN,HINM from XX01 PN = '11111' and YOBI like 'BBB%' order by PN
131 *          ・検索条件が入力されなかった時({@YOBI}がNULLのとき) WHERE句がなくなる。
132 *            作成されるSQL文⇒select PN,YOBI,NMEN,HINM from XX01 PN = '11111' order by PN
133 *
134 *     <og:query
135 *          command    = "NEW"
136 *          names      = "SYSTEM_ID,LANG,CLM,NAME_JA,LABEL_NAME,KBSAKU,USER.ID"
137 *          checkNames = "CLM,NAME_JA"
138 *          queryType  = "JDBCErrMsg"
139 *          displayMsg = "">
140 *              {call TYPE3B01.TYPE3B01(?,?,?,?)}
141 *     </og:query>
142 *
143 *          ・queryType に JDBCErrMsg を指定して、PL/SQL をコールできます。
144 *            引数は、names 属性をキーにリクエスト変数から読み込みます。
145 *          ・checkNames にカラム名を指定すると、columns.valueSet による
146 *            リクエスト変数の正規化を行います。
147 *
148 * @og.group DB検索
149 * @og.group DB登録
150 *
151 * @version  4.0
152 * @author       Kazuhiko Hasegawa
153 * @since    JDK5.0,
154 */
155public class QueryTag extends CommonTagSupport {
156        //* このプログラムのVERSION文字列を設定します。   {@value} */
157        private static final String VERSION = "5.6.5.3 (2013/06/28)" ;
158
159        private static final long serialVersionUID = 565320130628L ;
160
161        /** command 引数に渡す事の出来る コマンド  新規 {@value} */
162        public static final String CMD_NEW       = "NEW" ;
163        /** command 引数に渡す事の出来る コマンド  再検索 {@value} */
164        public static final String CMD_RENEW = "RENEW" ;
165        /** command 引数に渡す事の出来る コマンド リスト  */
166        private static final String[] COMMAND_LIST = new String[] { CMD_NEW , CMD_RENEW };
167
168        /** エラーメッセージID {@value} */
169        protected static final String errMsgId   = HybsSystem.ERR_MSG_KEY;
170
171        private   String        queryType       = null;
172        // 4.0.0.0 (2007/10/10) dbid の初期値を、"DEFAULT" から null に変更
173//      private   String        dbid            = "DEFAULT";
174        private   String        dbid            = null ;
175        protected transient DBTableModel        table           = null;
176        protected transient ErrorMessage        errMessage      = null;
177        protected String        tableId         = HybsSystem.TBL_MDL_KEY;
178        protected String        command         = CMD_NEW;
179        protected int           skipRowCount = 0;
180        protected int           maxRowCount     = -1;
181        protected String        sql                     = null;
182        protected int           executeCount = -1;                      // 検索/実行件数
183        protected String        names           = null;
184        protected boolean       outMessage      = true;
185        protected int           errCode         = ErrorMessage.OK;
186        protected boolean       quotCheck       = HybsSystem.sysBool( "USE_SQL_INJECTION_CHECK" );      // 4.0.0 (2005/08/31)
187        private   boolean       trace           = false;                // 4.0.0 (2005/01/31) 廃止
188        private   boolean       stopZero        = false;
189        private   String        modifyType      = null;                 // 3.8.5.1 (2006/05/08) modifyType 属性を追加します。
190//      private   String        displayMsg      = "MSG0033";    //  件検索しました。
191        protected String        displayMsg      = HybsSystem.sys( "VIEW_DISPLAY_MSG" );
192        private   String        overflowMsg     = "MSG0007";    // 検索結果が、制限行数を超えましたので、残りはカットされました。
193        private   String        notfoundMsg     = "MSG0077";    // 対象データはありませんでした。
194        private   boolean       isMainTrans     = true;                 // 5.1.6.0 (2010/05/01) DBLastSqlの処理の見直し
195
196        // 3.5.4.7 (2004/02/06) 実行時間測定用のDIV要素を出力します。
197        protected long dyStart = 0;
198        // 4.3.3.0 (2008/09/22) PLSQL/SQL実行エラーの際に、処理を中止するかどうか。
199        protected boolean stopError             = true;
200        
201        // 5.9.26.1 (2017/11/10) 実行エラーの際に、エラーを画面に出力するかどうか。
202        protected boolean dispError             = true;
203
204        private StringBuilder debugMsg = null;          // 3.5.6.0 (2004/06/18)
205
206        // 3.8.0.5 (2005/08/20) リクエスト変数の正規化を行います。
207        private String                  checkNames      = null;
208
209        // 3.8.5.3 (2006/08/07) トレース時のメッセージ文字列を保存しておきます。
210        private String                  traceMsg        = null;
211
212        protected boolean       xssCheck        = HybsSystem.sysBool( "USE_XSS_CHECK" );        // 5.0.0.2 (2009/09/15)
213
214        // 5.3.5.0 (2011/05/01) 処理時間(queryTime)などの情報出力の有効/無効を指定します。
215        private boolean         useBeforeHtmlTag        = true ;
216
217        /**
218         * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
219         *
220         * @og.rev 3.5.4.7 (2004/02/06) 実行時間測定用に、開始時刻を取得します。
221         * @og.rev 3.5.6.5 (2004/08/09) 暫定的に、DBTableModelを先行削除します。
222         * @og.rev 3.6.0.0 (2004/09/24) DBTableModel の先行削除は、scope="session" の場合のみ。
223         * @og.rev 5.1.6.0 (2010/05/01) DBLastSqlの処理は、DBTableModelが新規作成された処理でのみ行う。
224         * @og.rev 5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応
225         *
226         * @return      後続処理の指示
227         */
228        @Override
229        public int doStartTag() {
230                // 5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応
231                if( useTag() ) {
232                        dyStart = System.currentTimeMillis();
233                        if( ! check( command, COMMAND_LIST ) ) { return(SKIP_BODY); }
234
235                        useMainTrans( isMainTrans );                    // 5.1.6.0 (2010/05/01) DBLastSqlの処理の見直し
236                        startQueryTransaction( tableId );               // 3.6.0.8 (2004/11/19)
237
238                        // 3.5.6.5 (2004/08/09) 削除するのは、セッションのオブジェクトでよい。
239                        // 3.6.0.0 (2004/09/24) 削除するのは、scope="session" の場合のみ。
240                        if( "session".equals( getScope() ) ) {
241                                removeSessionAttribute( tableId );
242                                removeSessionAttribute( HybsSystem.VIEWFORM_KEY );
243                        }
244
245                        return( EVAL_BODY_BUFFERED );   // Body を評価する。( extends BodyTagSupport 時)
246                }
247                return ( SKIP_BODY );                           // Body を評価しない
248        }
249
250        /**
251         * Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
252         *
253         * @og.rev 3.1.1.0 (2003/03/28) ボディの内容を取得する処理を、CommonTagSupport で行う。
254         * @og.rev 3.6.0.8 (2004/11/19) エラー発生時に確実にリリースされるように try finally 追加
255         * @og.rev 3.8.5.3 (2006/08/07) USER.LASTSQL へのSQL文の保存は、実行前に行っておきます。
256         * @og.rev 3.8.6.3 (2006/11/30) SQL 文の前後のスペースを取り除きます。
257         * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定
258         * @og.rev 4.0.0.0 (2005/01/31) lang ⇒ ResourceManager へ変更
259         * @og.rev 4.0.0.0 (2005/08/31) useQuotCheck() によるSQLインジェクション対策
260         * @og.rev 4.3.4.0 (2008/12/01) GE20(ユーザー定数)へ登録するかのフラグへの対応
261         * @og.rev 5.0.0.2 (2009/09/15) XSS対応
262         * @og.rev 5.1.6.0 (2010/05/01) DBLastSqlの処理は、DBTableModelが新規作成された処理でのみ行う。
263         * @og.rev 5.1.9.0 (2010/08/01) TransactionTag 対応。上位に TransactionTag があれば、そこからConnection をもらう。
264         * @og.rev 5.3.6.0 (2011/06/01) 集計、合計などのEdit機能に対応します。
265         * @og.rev 5.3.7.0 (2011/07/01) TransactionReal の引数変更
266         * @og.rev 5.3.7.0 (2011/07/01) PL/SQLかつscope="request"で正しく出力するためqueryType,namesも保存する。
267         * @og.rev 5.3.8.0 (2011/08/01) Transaction発生箇所でclose()
268         * @og.rev 5.5.3.4 (2012/06/19) trace 時は、実際の検索処理を行わない様に変更。
269         * @og.rev 5.6.5.3 (2013/06/28) LASTQUERYTYPE ⇒ LASTSQLTYPE 変更。
270         *
271         * @return      後続処理の指示(SKIP_BODY)
272         */
273        @Override
274        public int doAfterBody() {
275
276                // 4.0.0 (2005/08/31) useQuotCheck() によるSQLインジェクション対策
277                useQuotCheck( quotCheck );
278                // 5.0.0.2 (2009/09/15) XSS対策
279                useXssCheck( xssCheck );
280
281                sql = getBodyString().trim();
282
283                // 3.2.1.0 (2003/05/28) 最終SQL文を、UserInfo に、キャッシュしておく。
284//              setUserInfo( "LASTSQL", sql );
285                // 5.1.6.0 (2010/05/01) DBLastSqlの処理の見直し
286                if( isMainTrans ) {
287                        setUserInfo( "LASTSQL", sql, false );
288                        // 5.3.7.0 (2011/07/01) PL/SQLかつscope="request"で正しく出力するためqueryType,namesも保存する。
289//                      setUserInfo( "LASTQUERYTYPE", queryType, false );
290                        setUserInfo( "LASTSQLTYPE", queryType, false );                         // 5.6.5.3 (2013/06/28)
291                        setUserInfo( "LASTNAMES", names, false );
292                }
293
294                Query query = QueryFactory.newInstance( queryType );
295                Transaction tran = null;
296                try {
297                        if( maxRowCount < 0 ) {
298                                maxRowCount     = sysInt( "DB_MAX_ROW_COUNT" );
299                        }
300
301                        // 5.1.9.0 (2010/08/01) TransactionTag 対応
302//                      final Transaction tran ;
303                        TransactionTag tranTag = (TransactionTag)findAncestorWithClass( this,TransactionTag.class );
304                        if( tranTag == null ) {
305//                              tran = new TransactionReal( dbid,getApplicationInfo() );
306                                tran = new TransactionReal( getApplicationInfo() );             // 5.3.7.0 (2011/07/01) 引数変更
307                        }
308                        else {
309                                tran = tranTag.getTransaction();
310                        }
311                        query.setTransaction( dbid,tran );      // 5.1.9.0 (2010/08/01) TransactionTag 対応
312
313                        query.setSkipRowCount( skipRowCount );
314                        query.setMaxRowCount( maxRowCount );
315//                      query.setConnectionID( dbid );
316                        query.setResourceManager( getResource() );      // 4.0.0 (2005/01/31)
317
318                        if( trace ) {
319//                              traceMsg = traceQuery( sql );
320                                traceMsg = traceQuery( sql,tran );              // 5.1.9.0 (2010/08/01) TransactionTag 対応
321                                // 5.5.3.4 (2012/06/19) trace 時は、実際の検索処理を行わない様に変更
322//                              query.setMaxRowCount( 1 );
323                                return(SKIP_BODY);
324                        }
325                        query.setStatement( sql );
326//                      query.setApplicationInfo( getApplicationInfo() );       // 3.8.7.0 (2006/12/15)
327
328                        // 5.3.6.0 (2011/06/01) 集計、合計などのEdit機能に対応します。
329                        if( isMainTrans ) {
330                                String guikey = getGUIInfoAttri( "KEY" );
331                                String editName = getRequestValue( "editName" );
332                                DBEditConfig config = getUser().getEditConfig( guikey, editName );
333                                if( config != null ) {
334                                        query.setEditConfig( config );
335                                }
336                        }
337
338                        execute( query );
339
340                        executeCount = query.getExecuteCount();
341                        if( errCode < ErrorMessage.NG && executeCount >= 0 ) {            // 異常以外の場合
342                                table = query.getDBTableModel();
343                                // 3.8.5.1 (2006/05/08) modifyType 属性を追加します。
344                                if( modifyType != null ) {
345                                        for( int row=0; row<executeCount; row++ ) {
346                                                table.setModifyType( row,modifyType );
347                                        }
348                                }
349                        }
350                }
351                finally {
352//                      if( query != null ) { query.close(); }
353                        QueryFactory.close( query );
354                        if( tran != null ) { tran.close(); }            // 5.3.8.0 (2011/08/01) Transaction発生箇所でclose()
355                }
356                return(SKIP_BODY);
357        }
358
359        /**
360         * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
361         *
362         * @og.rev 2.0.0.8 (2002/10/09) command="NEW" のときのみ、displayMsg を表示させます。
363         * @og.rev 2.1.1.4 (2002/11/25) デバッグ時に最終SQLをユーザー情報をセットするように変更。
364         * @og.rev 2.1.2.1 (2002/11/27) ErrorMessage をクリアしないように変更。
365         * @og.rev 3.1.1.0 (2003/03/28) JspWriter オブジェクトの使用箇所を、jspPrint() を使用するように変更。
366         * @og.rev 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
367         * @og.rev 3.2.1.0 (2003/05/28) 最終SQL文を、UserInfo に、キャッシュしておく。
368         * @og.rev 3.3.3.3 (2003/08/06) 検索結果の件数を、"DB.COUNT" キーでリクエストにセットする。
369         * @og.rev 3.3.3.3 (2003/08/06) 検索結果を、"DB.ERR_CODE" キーでリクエストにセットする。
370         * @og.rev 3.5.4.7 (2004/02/06) 実行時間測定用のDIV要素を出力しておきます。
371         * @og.rev 3.5.4.9 (2004/02/25) 警告時に停止していましたが、継続処理させます。
372         * @og.rev 3.5.5.0 (2004/03/12) ErrorMessage オブジェクトを、query が成功した時にもクリアするように変更
373         * @og.rev 3.5.5.2 (2004/04/02) TaglibUtil.makeHTMLErrorTable メソッドを利用
374         * @og.rev 3.5.5.8 (2004/05/20) ErrorMessage オブジェクトを、コマンドが NEW の場合のみ、クリア
375         * @og.rev 3.5.6.0 (2004/06/18) debugMsg 属性を出力するように修正します。
376         * @og.rev 3.6.0.8 (2004/11/19) DBTableModel をセーブする時に、トランザクションチェックを行います。
377         * @og.rev 3.8.5.3 (2006/08/07) USER.LASTSQL へのSQL文の保存は、実行前に行っておきます。
378         * @og.rev 4.0.0.0 (2006/11/14) notfoundMsg 属性を追加。displayMsg は、VIEW_USE_DISPLAY_MSG で制御
379         * @og.rev 4.0.0.0 (2007/10/18) メッセージリソース統合( getResource().getMessage ⇒ getResource().getLabel )
380         * @og.rev 4.3.3.0 (2008/09/22) 属性 stopError の設定により、JSP処理を中止するかどうかを制御します。
381         * @og.rev 5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応
382         * @og.rev 5.3.5.0 (2011/05/01) 処理時間(queryTime)などの情報出力の有効/無効を指定します。
383         * @og.rev 5.5.0.3 (2012/03/13) オーバーフローメッセージが存在しないときは、何もしない。(改行も入れない)
384         * @og.rev 5.5.3.4 (2012/06/19) trace 時は、実際の検索処理を行わない様に変更。
385         * @og.rev 5.6.3.0 (2013/04/01) エラー時メッセージ変更
386         * @og.rev 5.9.16.1 (2017/11/10) dispErrorの動作追加
387         *
388         * @return      後続処理の指示
389         */
390        @Override
391        public int doEndTag() {
392                debugPrint();           // 4.0.0 (2005/02/28)
393                // 5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応
394                if( !useTag() ) { return(EVAL_PAGE); }
395
396                if( trace ) {
397                        jspPrint( traceMsg );
398                        return (SKIP_PAGE);             // 5.5.3.4 (2012/06/19) trace 時は、実際の検索処理を行わない様に変更。
399                }
400
401                String label  = "";                             // 4.0.0 (2005/11/30) 検索しなかった場合。
402                if( check( command, COMMAND_LIST ) ) {
403                        StringBuilder buf = new StringBuilder( HybsSystem.BUFFER_SMALL );
404
405                        // 実行件数の表示 command="NEW" のときのみ、displayMsg を表示させます。
406                        // 4.0.0 (2005/11/30) 出力順の変更。一番最初に出力します。
407//                      boolean useStatusBar = HybsSystem.sysBool( "VIEW_USE_DISPLAY_MSG" );
408                        if( CMD_NEW.equals( command ) ) {
409//                              if( useStatusBar && executeCount > 0 && displayMsg != null && displayMsg.length() > 0 ) {
410                                if( executeCount > 0 && displayMsg != null && displayMsg.length() > 0 ) {
411                                        buf.append( executeCount );
412//                                      buf.append( getResource().getMessage( displayMsg ) );
413                                        buf.append( getResource().getLabel( displayMsg ) );
414                                        buf.append( HybsSystem.BR );
415                                }
416                                else if( executeCount == 0 && notfoundMsg != null && notfoundMsg.length() > 0 ) {
417//                                      buf.append( getResource().getMessage( notfoundMsg ) );
418                                        buf.append( getResource().getLabel( notfoundMsg ) );
419                                        buf.append( HybsSystem.BR );
420                                }
421                        }
422
423                        // 3.3.3.3 (2003/08/06) 検索結果の件数を、"DB.COUNT" キーでリクエストにセットする。
424                        setRequestAttribute( "DB.COUNT"   , String.valueOf( executeCount ) );
425                        // 3.3.3.3 (2003/08/06) 検索結果を、"DB.ERR_CODE" キーでリクエストにセットする。
426                        setRequestAttribute( "DB.ERR_CODE", String.valueOf( errCode ) );
427
428                        // オーバーフロー時のメッセージを表示
429//                      if( table != null && table.isOverflow() ) {
430                        // 5.5.0.3 (2012/03/09) オーバーフローメッセージが存在しないときは、何もしない。(改行も入れない)
431                        if( table != null && table.isOverflow() && overflowMsg != null && overflowMsg.length() > 0  ) {
432//                              buf.append( getResource().getMessage( overflowMsg ) );
433                                buf.append( getResource().getLabel( overflowMsg ) );
434                                buf.append( HybsSystem.BR );
435                        }
436
437                        // 3.5.5.2 (2004/04/02) TaglibUtil.makeHTMLErrorTable メソッドを利用
438                        String err = TaglibUtil.makeHTMLErrorTable( errMessage,getResource() );
439                        if( err != null && err.length() > 0 ) {
440                                buf.append( err );
441                                setSessionAttribute( errMsgId,errMessage );
442                        }
443                        else if( CMD_NEW.equals( command ) ) {          // 3.5.5.8 (2004/05/20)
444                                removeSessionAttribute( errMsgId );
445                        }
446                        label = buf.toString();
447                        
448                        // 5.9.26.1 (2017/11/10) エラーメッセージをリクエスト変数で持つようにしておく
449                        setRequestAttribute( "DB.ERR_MSG", label );
450
451                        if( table != null && ! commitTableObject( tableId, table ) ) {
452                                // 3.6.0.8 (2004/11/19) トランザクションチェックを行います。
453                                // jspPrint( "QueryTag Query処理が割り込まれました。DBTableModel は登録しません。" );
454                                
455                                // 5.6.4.0 (2013/04/01) リソースから出力するように対応
456                                ErrorMessage errMsgObj = new ErrorMessage( "QueryTag Query Error!" );
457                                errMsgObj.addMessage( 0,ErrorMessage.NG,"ERR0041" );
458                                jspPrint( TaglibUtil.makeHTMLErrorTable( errMsgObj,getResource() ) );
459                                
460                                return (SKIP_PAGE);
461                        }
462                }
463                
464                // 5.9.26.1 (2017/11/10) dispErrorで表示をコントロール
465                if( dispError ) {
466                        jspPrint( label );
467                }
468
469                // 3.5.4.9 (2004/02/25) 警告時に停止していましたが、継続処理させます。
470//              int rtnCode = EVAL_PAGE;
471                final int rtnCode ;
472                if( errCode >= ErrorMessage.NG )  {  // 異常
473                        if( stopError ) {                               // 4.3.3.0 (2008/09/22) 属性 stopError の設定により、処理を中止するかを判断します。
474                                rtnCode = SKIP_PAGE;
475                        }
476                        else {
477                                rtnCode = EVAL_PAGE;
478                        }
479                }
480                else {
481                        // 件数0件かつ stopZero = true
482                        if( executeCount == 0 && stopZero )     {
483                                rtnCode = SKIP_PAGE;
484                        }
485                        else {
486                                rtnCode = EVAL_PAGE;
487                        }
488                }
489
490                // 3.5.4.7 (2004/02/06)
491                long dyTime = System.currentTimeMillis()-dyStart;
492
493                // 5.3.5.0 (2011/05/01) 処理時間(queryTime)などの情報出力の有効/無効を指定します。
494                if( useBeforeHtmlTag ) {
495                        jspPrint( "<div id=\"queryTime\" value=\"" + (dyTime) + "\"></div>" );      // 3.5.6.3 (2004/07/12)
496                }
497
498                // 4.0.0 (2005/01/31) セキュリティチェック(データアクセス件数登録)
499                GUIInfo guiInfo = (GUIInfo)getSessionAttribute( HybsSystem.GUIINFO_KEY );
500                if( guiInfo != null ) { guiInfo.addReadCount( executeCount,dyTime,sql ); }
501
502                return( rtnCode );
503        }
504
505        /**
506         * タグリブオブジェクトをリリースします。
507         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
508         *
509         * @og.rev 2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加
510         * @og.rev 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
511         * @og.rev 3.5.4.7 (2004/02/06) 実行時間測定用に、dyStart を追加します。
512         * @og.rev 3.5.6.0 (2004/06/18) debugMsg 属性を追加します。
513         * @og.rev 3.8.0.5 (2005/08/20) checkNames 属性を追加します。
514         * @og.rev 3.8.5.1 (2006/05/08) modifyType 属性を追加します。
515         * @og.rev 3.8.5.1 (2006/05/08) traceMsg 属性(トレース時のメッセージ文字列)を追加します。
516         * @og.rev 4.0.0.0 (2005/08/31) quotCheck 属性の追加
517         * @og.rev 4.0.0.0 (2007/10/10) dbid の初期値を、"DEFAULT" から null に変更
518         * @og.rev 4.3.3.0 (2008/09/22) stopError 属性の追加
519         * @og.rev 5.0.0.2 (2009/09/15) XSS対応
520         * @og.rev 5.1.6.0 (2010/05/01) DBLastSqlの処理は、DBTableModelが新規作成された処理でのみ行う。
521         * @og.rev 5.3.5.0 (2011/05/01) 処理時間(queryTime)などの情報出力の有効/無効を指定します。
522         * @og.rev 5.9.26.1 (2017/11/10) dispError追加
523         *
524         */
525        @Override
526        protected void release2() {
527                super.release2();
528                tableId                 = HybsSystem.TBL_MDL_KEY;
529                queryType               = null;
530//              dbid                    = "DEFAULT";
531                dbid                    = null;
532                command                 = CMD_NEW;
533                skipRowCount    = 0;
534                maxRowCount             = -1;
535                table                   = null;
536                sql                             = null;
537//              displayMsg              = "MSG0033";    //  件検索しました。
538                displayMsg              = HybsSystem.sys( "VIEW_DISPLAY_MSG" );
539                overflowMsg             = "MSG0007";    // 検索結果が、制限行数を超えましたので、残りはカットされました。
540                notfoundMsg             = "MSG0077";    // 対象データはありませんでした。
541                executeCount    = -1;                   // 検索/実行件数
542                names                   = null;
543                outMessage              = true;
544                trace                   = false;
545                errCode                 = ErrorMessage.OK;
546                errMessage              = null;
547                stopZero                = false;
548                stopError               = true;                 // 4.3.3.0 (2008/09/22)
549                dyStart                 = 0;
550                debugMsg                = null;                 // 3.5.6.0 (2004/06/18)
551                checkNames              = null;                 // 3.8.0.5 (2005/08/20)
552                quotCheck               = HybsSystem.sysBool( "USE_SQL_INJECTION_CHECK" );      // 4.0.0 (2005/08/31)
553                modifyType      = null;                 // 3.8.5.1 (2006/05/08)
554                traceMsg                = null;                 // 3.8.5.3 (2006/08/07)
555                xssCheck                = HybsSystem.sysBool( "USE_XSS_CHECK" );        // 5.0.0.2 (2009/09/15)
556                isMainTrans             = true;                 // 5.1.6.0 (2010/05/01) DBLastSqlの処理の見直し
557                useBeforeHtmlTag        = true ;        // 5.3.5.0 (2011/05/01)
558                dispError               = true;                 // 5.9.26.1 (2017/11/10) 
559        }
560
561        /**
562         * Query を実行します。
563         *
564         * @og.rev 2.1.2.3 (2002/12/02) データベース更新時に、更新フラグをセットするように変更
565         * @og.rev 3.4.0.0 (2003/09/01) 登録エラー時のキーと値を表示するように変更。
566         * @og.rev 3.5.6.0 (2004/06/18) デバッグ情報出力用に、printDebug メソッドを追加。
567         * @og.rev 3.6.1.0 (2005/01/05) エラーコードによる commit/rollback の判断追加
568         * @og.rev 5.3.7.0 (2011/07/01) nameの判定にゼロ文字列を付加
569         *
570         * @param       query オブジェクト
571         */
572        protected void execute( final Query query ) {
573                String[] nameArray = null;
574                String[] values    = null;
575                try {
576//                      if( names == null ) {
577                        if( names == null || names.length() == 0 ) {
578                                query.execute();
579                        }
580                        else {
581                                nameArray = StringUtil.csv2Array( names );
582                                values = getRequest( nameArray );
583                                // 3.5.6.0 (2004/06/18) デバッグ情報出力用
584                                if( isDebug() ) { printDebug( nameArray,values ); }
585                                query.execute( values );
586                        }
587                        errCode = query.getErrorCode();
588                        errMessage = query.getErrorMessage();
589                        // 3.6.1.0 (2005/01/05) エラーコードによる commit/rollback の判断追加
590//                      if( query.getUpdateFlag() ) {
591                        if( query.isUpdate() ) {
592                                if( errCode < ErrorMessage.NG ) {            // 異常以下の場合
593                                        query.commit();
594                                }
595                                else {
596                                        query.rollback();
597                                }
598                        }
599                }
600                catch( HybsSystemException ex ) {
601                        query.rollback();
602
603                        // 4.0.0 (2005/02/28) エラー時の表示とデバッグ時の表示を統一する。
604                        String errMsg = "DATABASE ERROR! " + HybsSystem.CR ;
605                        if( nameArray != null ) {
606                                printDebug( nameArray,values );
607                                errMsg += debugMsg;
608                        }
609                        throw new HybsSystemException( errMsg,ex );             // 3.5.5.4 (2004/04/15) 引数の並び順変更
610                }
611                finally {
612                        if( query != null ) { query.close(); }
613                }
614        }
615
616        /**
617         * デバッグ用に、配列データを書き出します。
618         *
619         * @og.rev 3.5.6.0 (2004/06/18) 新規追加
620         *
621         * @param       nms     引数 names の配列データ
622         * @param       vals    names に対応するリクエスト情報の配列
623         */
624        private void printDebug( final String[] nms,final String[] vals ) {
625                if( debugMsg == null ) { debugMsg = new StringBuilder(); }
626
627                debugMsg.append( "  names=[" );
628                debugMsg.append( StringUtil.array2csv( nms ) );
629                debugMsg.append( "]" );
630                debugMsg.append( HybsSystem.CR );
631                debugMsg.append( "  values=[" );
632                debugMsg.append( StringUtil.array2csv( vals ) );
633                debugMsg.append( "]" );
634                debugMsg.append( HybsSystem.CR );
635        }
636
637        /**
638         * 名称配列を元に、リクエスト情報のデータを取得します。
639         * checkNames 属性に設定されているカラムがあれば、値を正規化します。
640         *
641         * @og.rev 3.8.0.5 (2005/08/20) リクエスト変数の正規化(checkNames)対応
642         *
643         * @param       nameArray       キーとなる名称の配列
644         *
645         * @return      そのリクエスト情報の配列
646         */
647        protected String[] getRequest( final String[] nameArray ) {
648                String[] rtn = new String[nameArray.length];
649
650                for( int i=0; i<rtn.length; i++ ) {
651                        rtn[i] = getRequestValue( nameArray[i] );
652
653                        // 3.8.0.5 (2005/08/20) checkNames があり、rtn[i] がある場合。
654                        if( checkNames != null && checkNames.length() > 0 && rtn[i].length() > 0 ) {
655                                if( ( "," + checkNames + "," ).indexOf( "," + nameArray[i] + "," ) >= 0 ) {
656                                        DBColumn dbColumn = getDBColumn( nameArray[i] );
657                                        String val = dbColumn.valueSet( rtn[i] );
658                                        if( val != null ) { rtn[i] = val; }
659                                }
660                        }
661                }
662
663                return rtn;
664        }
665
666        /**
667         * 【TAG】(通常は使いません)データの読み始めの初期値を指定します。
668         *
669         * @og.tag
670         * データベース自体の検索は,指定されたSQLの全件を検索しますが,
671         * DBTableModelのデータとしては、スキップ件数分は登録されません。
672         * サーバーのメモリ資源と応答時間の確保の為です。
673         *
674         * @param       count 読み始めの初期値
675         */
676        public void setSkipRowCount( final String count ) {
677                skipRowCount = nval( getRequestParameter( count ),skipRowCount );
678        }
679
680        /**
681         * 【TAG】(通常は使いません)データの最大読み込み件数を指定します
682         *              (初期値:DB_MAX_ROW_COUNT[={@og.value org.opengion.hayabusa.common.SystemData#DB_MAX_ROW_COUNT}])。
683         *
684         * @og.tag
685         * データベース自体の検索は,指定されたSQLの全件を検索しますが,
686         * DBTableModelのデータとして登録する最大件数をこの値に設定します。
687         * サーバーのメモリ資源と応答時間の確保の為です。
688         * 0 をセットすると、無制限(Integer.MAX_VALUE)になります。
689         * (初期値:ユーザー定数のDB_MAX_ROW_COUNT[={@og.value org.opengion.hayabusa.common.SystemData#DB_MAX_ROW_COUNT}])。
690         *
691         * @og.rev 5.5.8.5 (2012/11/27) 0を無制限として処理します。
692         *
693         * @param       count 最大読み込み件数
694         * @see         org.opengion.hayabusa.common.SystemData#DB_MAX_ROW_COUNT
695         */
696        public void setMaxRowCount( final String count ) {
697                maxRowCount = nval( getRequestParameter( count ),maxRowCount );
698                if( maxRowCount == 0 ) { maxRowCount = Integer.MAX_VALUE ; }            // 5.5.8.5 (2012/11/27)
699        }
700
701        /**
702         * 【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します
703         *              (初期値:HybsSystem#TBL_MDL_KEY[={@og.value org.opengion.hayabusa.common.HybsSystem#TBL_MDL_KEY}])。
704         *
705         * @og.tag
706         * 検索結果より、DBTableModelオブジェクトを作成します。これを、下流のviewタグ等に
707         * 渡す場合に、通常は、session を利用します。その場合の登録キーです。
708         * query タグを同時に実行して、結果を求める場合、同一メモリに配置される為、
709         * この tableId 属性を利用して、メモリ空間を分けます。
710         *              (初期値:HybsSystem#TBL_MDL_KEY[={@og.value org.opengion.hayabusa.common.HybsSystem#TBL_MDL_KEY}])。
711         *
712         * @param       id sessionに登録する時の ID
713         */
714        public void setTableId( final String id ) {
715                tableId   = nval( getRequestParameter( id ),tableId );  // 3.8.0.9 (2005/10/17)
716        }
717
718        /**
719         * 【TAG】Query を発行する為のクラスID(JDBC,JDBCCallable,JDBCErrMsg,JDBCUpdate)を指定します({@og.doc03Link queryType 初期値:JDBC})。
720         *
721         * @og.tag
722         * 検索を実行する手段は、Query インターフェースの実装クラスになります。
723         * このタグでは、Query.execute( String[] ) メソッドが呼ばれます。
724         * 例えば、ストアドプロシージャ等を実行する場合に、queryType="JDBCErrMsg"
725         * を指定することができます。
726         * 初期値は、"JDBC" です。
727         * queryType は、システムリソースの Query_**** 宣言の **** を与えます。
728         * これらは、Query インターフェースを継承したサブクラスである必要があります。
729         * 標準で、org.opengion.hayabusa.db 以下の Query_**** クラスが、Query_**** 宣言 と
730         * して、定義されています。
731         * 属性クラス定義の {@link org.opengion.hayabusa.db.Query Query} を参照願います。
732         * {@og.doc03Link queryType Query_**** クラス}
733         *
734         * @param       id Query を発行する為の実クラス ID
735         * @see         org.opengion.hayabusa.db.Query  Queryのサブクラス
736         * @see         org.opengion.hayabusa.db.Query#execute( String[] )
737         */
738        public void setQueryType( final String id ) {
739                queryType = getRequestParameter( id );
740        }
741
742        /**
743         * 【TAG】(通常は使いません)Queryオブジェクトを作成する時のDB接続IDを指定します。
744         *
745         * @og.tag
746         * Queryオブジェクトを作成する時のDB接続IDを指定します。
747         * これは、システムリソースで、DEFAULT_DB_URL 等で指定している データベース接続先
748         * 情報に、XX_DB_URL を定義することで、 dbid="XX" とすると、この 接続先を使用して
749         * データベースにアクセスできます。
750         *
751         * @param       id データベース接続ID
752         */
753        public void setDbid( final String id ) {
754                dbid = nval( getRequestParameter( id ),dbid );
755        }
756
757        /**
758         * 【TAG】コマンド(NEW,RENEW)をセットします(PlsqlUpdateTag,UpdateTag の場合は、ENTRY)。
759         *
760         * @og.tag
761         * コマンドは,HTMLから(get/post)指定されますので,CMD_xxx で設定される
762         * フィールド定数値のいづれかを、指定できます。
763         *
764         * @param       cmd コマンド(public static final 宣言されている文字列)
765         * @see         <a href="../../../../constant-values.html#org.opengion.hayabusa.taglib.QueryTag.CMD_NEW">コマンド定数</a>
766         */
767        public void setCommand( final String cmd ) {
768                String cmd2 = getRequestParameter( cmd );
769                if( cmd2 != null && cmd2.length() >= 0 ) { command = cmd2.toUpperCase(Locale.JAPAN); }
770        }
771
772        /**
773         * 【TAG】検索結果が0件のとき処理を続行するかどうか[true/false]を指定します(初期値:false[続行する])。
774         *
775         * @og.tag
776         * 初期値は、false(続行する)です。
777         *
778         * @param  cmd 検索結果が0件のとき、[true:処理を中止する/false:続行する]
779         */
780        public void setStopZero( final String cmd ) {
781                stopZero = nval( getRequestParameter( cmd ),stopZero );
782        }
783
784        /**
785         * 【TAG】検索結果を画面上に表示するメッセージリソースIDを指定します
786         *              (初期値:VIEW_DISPLAY_MSG[={@og.value org.opengion.hayabusa.common.SystemData#VIEW_DISPLAY_MSG}])。
787         *
788         * @og.tag
789         * ここでは、検索結果の件数や登録された件数をまず出力し、
790         * その次に、ここで指定したメッセージをリソースから取得して表示します。
791         * 件数を表示させたい場合は、displayMsg = "MSG0033"[ 件検索しました] をセットしてください。
792         * 表示させたくない場合は, displayMsg = "" をセットしてください。
793         * (初期値:システム定数のVIEW_DISPLAY_MSG[={@og.value org.opengion.hayabusa.common.SystemData#VIEW_DISPLAY_MSG}])。
794         *
795         * @param       id ディスプレイに表示させるメッセージ ID
796         * @see         org.opengion.hayabusa.common.SystemData#VIEW_DISPLAY_MSG
797         */
798        public void setDisplayMsg( final String id ) {
799                String ids = getRequestParameter( id );
800                if( ids != null ) { displayMsg = ids; }
801        }
802
803        /**
804         * 【TAG】検索データが最大検索数をオーバーした場合に表示するメッセージリソースIDを指定します
805         *              (初期値:MSG0007[検索結果が、制限行数を超えましたので、残りはカットされました])。
806         *
807         * @og.tag
808         * 検索結果が、maxRowCount で設定された値より多い場合、何らかのデータは検索されず
809         * 切り捨てられたことになります。
810         * ここでは、displayMsg を表示した後、必要に応じて、このメッセージを表示します。
811         * 表示させたくない場合は, overflowMsg = "" をセットしてください。
812         * 初期値は、MSG0007[検索結果が、制限行数を超えましたので、残りはカットされました]です。
813         *
814         * @param       id ディスプレイに表示させるメッセージ ID
815         */
816        public void setOverflowMsg( final String id ) {
817                String ids = getRequestParameter( id );
818                if( ids != null ) { overflowMsg = ids; }
819        }
820
821        /**
822         * 【TAG】検索結果がゼロ件の場合に表示するメッセージリソースIDを指定します(初期値:MSG0077[対象データはありませんでした])。
823         *
824         * @og.tag
825         * ここでは、検索結果がゼロ件の場合のみ、特別なメッセージを表示させます。
826         * 従来は、displayMsg と兼用で、『0 件検索しました』という表示でしたが、
827         * displayMsg の初期表示は、OFF になりましたので、ゼロ件の場合のみ別に表示させます。
828         * 表示させたくない場合は, notfoundMsg = "" をセットしてください。
829         * 初期値は、MSG0077[対象データはありませんでした]です。
830         *
831         * @param       id ディスプレイに表示させるメッセージ ID
832         */
833        public void setNotfoundMsg( final String id ) {
834                String ids = getRequestParameter( id );
835                if( ids != null ) { notfoundMsg = ids; }
836        }
837
838        /**
839         * 【TAG】PL/SQLを利用する場合の引数にセットすべき データの名称をCSV形式で複数指定します。
840         *
841         * @og.tag
842         * 複数ある場合は、カンマ区切り文字で渡します。
843         * names 属性は、queryType に応じて設定可否が異なりますので、ご注意ください。
844         * names なし:JDBC,JDBCUpdate
845         * names あり:JDBCCallable,JDBCErrMsg,JDBCUpdate
846         * (JDBCUpdateは、names 属性のあり/なし両方に対応しています。)
847         *
848         * @og.rev 3.0.1.3 (2003/03/11) names 属性に null で渡す場合のバグを修正
849         *
850         * @param       nm 引数の名称(複数ある場合は、カンマ区切り文字)
851         */
852        public void setNames( final String nm ) {
853                names = nval( getRequestParameter( nm ),names );
854        }
855
856        /**
857         * 【TAG】検索結果のメッセージを表示する/しない[true/false]を指定します(初期値:true)。
858         *
859         * @og.tag
860         * 初期値は、表示する:true です。
861         *
862         * @param       flag  [true:表示する/それ以外:含めない]
863         */
864        public void setOutMessage( final String flag ) {
865                outMessage = nval( getRequestParameter( flag ),outMessage );
866        }
867
868        /**
869         * 【TAG】引数の SQL 文を EXPLAIN PLAN を[true:行う/それ以外:行わない]を指定します(初期値:false)。
870         *
871         * @og.tag
872         *
873         * ここでは、以下の処理を行います。
874         * 1.引数の SQL 文を画面に表示します。
875         * 2.引数の SQL 文を EXPLAIN PLAN した結果を、画面に表示します。
876         * なお、以前は、セッションのトレースを行っていましたが、その機能は、廃止いたします。
877         * 初期値は、行わない:false です。
878         *
879         * @param       flag トレース [true:行う/それ以外:行わない]
880         */
881        public void setTrace( final String flag ) {
882                trace = nval( getRequestParameter( flag ),trace );
883        }
884
885        /**
886         * 【TAG】リクエスト変数の正規化を行うカラムをCSV形式で複数指定します。
887         *
888         * @og.tag
889         * PL/SQLを利用する場合の引数にセットすべき データを、リクエスト変数の
890         * 値そのままではなく、カラムオブジェクトの valueSet メソッド経由で正規化
891         * した値を使用するようにします。
892         *
893         * @og.rev 3.8.0.5 (2005/08/20) 新規追加
894         *
895         * @param       nm リクエスト変数の正規化を行うカラム
896         */
897        public void setCheckNames( final String nm ) {
898                checkNames = nval( getRequestParameter( nm ),checkNames );
899        }
900
901        /**
902         * 【TAG】DB検索時の モディファイタイプを指定します[A:追加/C:更新/D:削除]。
903         *
904         * @og.tag
905         * DB検索時に、そのデータをA(追加)、C(更新)、D(削除)のモディファイタイプを
906         * つけた状態にします。
907         * その状態で、そのまま、update する事が可能になります。
908         *
909         * @og.rev 3.8.5.1 (2006/05/08) 新規追加
910         *
911         * @param   type DB検索時の モディファイタイプ [A:追加/C:更新/D:削除]
912         */
913        public void setModifyType( final String type ) {
914                modifyType = nval( getRequestParameter( type ),modifyType );
915        }
916
917        /**
918         * 【TAG】リクエスト情報の クォーティション(') 存在チェックを実施するかどうか[true/false]を設定します
919         *              (初期値:USE_SQL_INJECTION_CHECK[={@og.value org.opengion.hayabusa.common.SystemData#USE_SQL_INJECTION_CHECK}])。
920         *
921         * @og.tag
922         * SQLインジェクション対策の一つとして、暫定的ではありますが、SQLのパラメータに
923         * 渡す文字列にクォーティション(') を許さない設定にすれば、ある程度は防止できます。
924         * 数字タイプの引数には、 or 5=5 などのクォーティションを使用しないコードを埋めても、
925         * 数字チェックで検出可能です。文字タイプの場合は、必ず (')をはずして、
926         * ' or 'A' like 'A のような形式になる為、(')チェックだけでも有効です。
927         * (') が含まれていたエラーにする(true)/かノーチェックか(false)を指定します。
928         * 初期値は、SystemData#USE_SQL_INJECTION_CHECK です。
929         *
930         * @og.rev 4.0.0.0 (2005/08/31) 新規追加
931         *
932         * @param   flag クォーティションチェック [true:する/それ以外:しない]
933         */
934        public void setQuotCheck( final String flag ) {
935                quotCheck = nval( getRequestParameter( flag ),quotCheck );
936        }
937
938        /**
939         * 【TAG】リクエスト情報の HTMLTag開始/終了文字(&gt;&lt;) 存在チェックを実施するかどうか[true/false]を設定します
940         *              (初期値:USE_XSS_CHECK[={@og.value org.opengion.hayabusa.common.SystemData#USE_XSS_CHECK}])。
941         *
942         * @og.tag
943         * クロスサイトスクリプティング(XSS)対策の一環としてless/greater than signについてのチェックを行います。
944         * (&gt;&lt;) が含まれていたエラーにする(true)/かノーチェックか(false)を指定します。
945         * (初期値:システム定数のUSE_XSS_CHECK[={@og.value org.opengion.hayabusa.common.SystemData#USE_XSS_CHECK}])
946         *
947         * @og.rev 5.0.0.2 (2009/09/15) 新規追加
948         *
949         * @param       flag    XSSチェック [true:する/false:しない]
950         * @see         org.opengion.hayabusa.common.SystemData#USE_XSS_CHECK
951         */
952        public void setXssCheck( final String flag ) {
953                xssCheck = nval( getRequestParameter( flag ),xssCheck );
954        }
955
956        /**
957         * 【TAG】PLSQL/SQL処理エラーの時に処理を中止するかどうか[true/false]を設定します(初期値:true)。
958         *
959         * @og.tag
960         * false(中止しない)に設定する場合、後続処理では、{&#064;DB.ERR_CODE}の値により、
961         * PLSQL/SQLの異常/正常終了によって分岐処理は可能となります。
962         * 初期値は、true(中止する)です。
963         *
964         * @og.rev 4.3.3.0 (2008/09/22) 新規追加
965         *
966         * @param   flag  [true:中止する/false:中止しない]
967         */
968        public void setStopError( final String flag ) {
969                stopError = nval( getRequestParameter( flag ),stopError );
970        }
971        
972        /**
973         * 【TAG】PLSQL/SQL処理エラーの時にエラーを画面表示するか[true/false]を設定します(初期値:true)。
974         *
975         * @og.tag
976         * false(表示しない)に設定する場合、後続処理では、{&#064;DB.ERR_MSG}の値により、
977         * 本来表示されるはずだったメッセージを取得可能です。
978         * stopErrorと併用して、JSON形式でエラーを返す場合等に利用します。
979         * 初期値は、true(表示する)です。
980         * ※false指定の場合は件数や、overFlowメッセージ等も表示されなくなります。
981         *
982         * @og.rev 5.9.26.1 (2017/11/10) 新規追加
983         *
984         * @param   flag  [true:表示する/false:表示しない]
985         */
986        public void setDispError( final String flag ) {
987                dispError = nval( getRequestParameter( flag ),dispError );
988        }
989        
990
991        /**
992         * 引数の SQL 文を EXPLAIN PLAN します。
993         *
994         * ここでは、以下の処理を行います。
995         * 1.引数の SQL 文を画面に表示します。
996         * 2.引数の SQL 文を EXPLAIN PLAN した結果を、画面に表示します。
997         * なお、この処理は、ORACLE 専用処理です。
998         *
999         * @og.rev 3.8.5.3 (2006/08/07) 新規追加
1000         * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定
1001         * @og.rev 5.1.9.0 (2010/08/01) Transaction 対応します。
1002         * @og.rev 5.5.3.4 (2012/06/19) getUserInfo は、キー部分だけで処理します。
1003         *
1004         * @param   sql         EXPLAIN PLANするSQL 文
1005         * @param   tran        Transactionオブジェクト
1006         *
1007         * @return トレース結果の文字列
1008         */
1009//      private String traceQuery( final String sql ) {
1010        private String traceQuery( final String sql , final Transaction tran ) {
1011//              ApplicationInfo appInfo = getApplicationInfo();
1012
1013//              String userId = getUserInfo( "USER.ID" ) ;
1014                String userId = getUserInfo( "ID" ) ;                   // 5.5.3.4 (2012/06/19) getUserInfo は、キー部分だけで処理します。
1015
1016                String[] arg1 = new String[] { userId };
1017//              DBUtil.dbExecute( "DELETE FROM PLAN_TABLE WHERE STATEMENT_ID = ?",arg1,appInfo,dbid );
1018                DBUtil.dbExecute( "DELETE FROM PLAN_TABLE WHERE STATEMENT_ID = ?",arg1,tran,dbid );             // 5.1.9.0 (2010/08/01)
1019
1020                String explan1 = "EXPLAIN PLAN SET STATEMENT_ID = '" + userId + "' FOR " + sql ;
1021//              DBUtil.dbExecute( explan1,null,appInfo,dbid );
1022                DBUtil.dbExecute( explan1,null,tran,dbid );             // 5.1.9.0 (2010/08/01)
1023
1024                String[] arg2 = new String[] { userId,userId,userId };
1025//              String explan2 = "SELECT LEVEL,LPAD(' ',LEVEL,' ') || RTRIM( OPERATION ) || ' ' ||"
1026//                                              + " RTRIM( OPTIONS )   || ' ' || RTRIM( OBJECT_NAME )"
1027//                                              + " FROM PLAN_TABLE"
1028//                                              + " WHERE STATEMENT_ID = ?"
1029//                                              + " CONNECT BY PRIOR ID = PARENT_ID"
1030//                                              + "         AND STATEMENT_ID = ?"
1031//                                              + " START WITH ID = 0"
1032//                                              + "         AND STATEMENT_ID = ?" ;
1033                String explan2 = "select LEVEL as LVL"
1034                                                        + ",lpad(' ',LEVEL,' ') || rtrim( OPERATION ) || ' ' || rtrim( OPTIONS ) || ' ' || rtrim( OBJECT_NAME ) as EXECUTION_PLAN"
1035                                                        + ",OBJECT_NAME                 as OBJ_NAME"
1036                                                        + ",DECODE(INSTR(OBJECT_TYPE,' '),0,OBJECT_TYPE,SUBSTR(OBJECT_TYPE,1,INSTR(OBJECT_TYPE,' ')-1)) as OBJ_TYPE"
1037                                                        + ",OPTIMIZER                   as OPT"
1038                                                        + ",COST                                as CST"
1039                                                        + ",CARDINALITY                 as CARD"
1040                                                        + ",BYTES                               as BYTE"
1041                                                        + ",ACCESS_PREDICATES   as ACCS"
1042                                                        + ",FILTER_PREDICATES   as FILTER"
1043                                                + " from PLAN_TABLE"
1044                                                + " where STATEMENT_ID = ?"
1045                                                + " start with ID = 0"
1046                                                + "       and STATEMENT_ID = ?"
1047                                                + " connect by prior ID = PARENT_ID"
1048                                                + "       and STATEMENT_ID = ?" ;
1049//              String[][] plan = DBUtil.dbExecute( explan2,arg2,appInfo,dbid );
1050//              String[][] plan = DBUtil.dbExecute( explan2,arg2,tran,dbid );                   // 5.1.9.0 (2010/08/01)
1051
1052//              StringBuilder buf = new StringBuilder( HybsSystem.BUFFER_MIDDLE );
1053//              buf.append( "<pre>" ).append( sql ).append( "</pre>" ).append( HybsSystem.BR );
1054//              buf.append( "<table>" );
1055//              buf.append( "<tr  class=\"row_h\"><th>LEVEL</th><th>EXECUTION_PLAN</th></tr>" );
1056//              for( int i=0; i<plan.length; i++ ) {
1057//                      buf.append( "<tr class=\"row_" ).append( i%2 ).append( "\">" );
1058//                      buf.append( "<td>" ).append( plan[i][0] ).append( "</td>" );
1059//                      buf.append( "<td><pre>" ).append( plan[i][1] ).append( "</td></tr>" );
1060//              }
1061//              buf.append( "</table>" ).append( HybsSystem.BR );
1062
1063                String[][] plan = DBUtil.dbExecute( explan2,arg2,tran,dbid,true );                      // 5.5.3.4 (2012/06/19) ヘッダー情報も同時に取得する。
1064
1065                StringBuilder buf = new StringBuilder( HybsSystem.BUFFER_MIDDLE );
1066                buf.append( "<pre>" ).append( sql ).append( "</pre>" ).append( HybsSystem.BR );
1067                buf.append( "<table>" );
1068                // 1行目のヘッダーの出力
1069                int colsize = plan[0].length;
1070                buf.append( "<tr class=\"row_h\">" );
1071                for( int j=0; j<colsize; j++ ) {
1072                        buf.append( "<th>" ).append( plan[0][j] ).append( "</th>" );
1073                }
1074                buf.append( "</tr>" );
1075
1076                for( int i=1; i<plan.length; i++ ) {
1077                        buf.append( "<tr class=\"row_" ).append( i%2 ).append( "\">" );
1078                        for( int j=0; j<colsize; j++ ) {
1079                                if( j==1 ) {
1080                                        buf.append( "<td><pre>" ).append( plan[i][1] ).append( "</pre></td>" );
1081                                }
1082                                else {
1083                                        buf.append( "<td>" ).append( plan[i][j] ).append( "</td>" );
1084                                }
1085                        }
1086                        buf.append( "</tr>" );
1087                }
1088                buf.append( "</table>" ).append( HybsSystem.BR );
1089                return buf.toString();
1090        }
1091
1092        /**
1093         * 【TAG】(通常使いません)タグで処理される処理がメインとなるトランザクション処理かどうかを指定します(初期値:true)。
1094         *
1095         * @og.tag
1096         * この値は、ファイルダウンロード処理に影響します。この値がtrueに指定された時にcommitされたDBTableModelが
1097         * ファイルダウンロードの対象の表になります。
1098         *
1099         * このパラメーターは、通常、各タグにより実装され、ユーザーが指定する必要はありません。
1100         * 但し、1つのJSP内でDBTableModelが複数生成される場合に、前に処理したDBTableModelについてファイルダウンロードをさせたい
1101         * 場合は、後ろでDBTableModelを生成するタグで、明示的にこの値をfalseに指定することで、ファイルダウンロード処理の対象から
1102         * 除外することができます。
1103         *
1104         * @og.rev 5.1.6.0 (2010/05/01) 新規作成
1105         *
1106         * @param  flag メイントランザクションかどうか
1107         */
1108        public void setMainTrans( final String flag ) {
1109                isMainTrans = nval( getRequestParameter( flag ),isMainTrans );
1110        }
1111
1112        /**
1113         * 【TAG】 処理時間(queryTime)などの情報出力[true:有効/false:無効]を指定します(初期値:true)。
1114         *
1115         * @og.tag
1116         * Query で、検索する場合に、処理時間(queryTime)などの情報を出力していますが、
1117         * ViewForm で、CustomData などの 非HTML表示ビューを使用する場合、データとして、
1118         * 紛れ込んでしまうため、出力を抑制する必要があります。
1119         * true(有効)にすると、これらのHTMLが出力されます。false にすると、出力されません。
1120         * 初期値は、true(有効) です。
1121         *
1122         * @og.rev 5.3.5.0 (2011/05/01) 新規追加
1123         *
1124         * @param  useTag  情報出力の有効/無効を指定 [true:有効/false:無効]
1125         */
1126        public void setUseBeforeHtmlTag( final String useTag ) {
1127                useBeforeHtmlTag = nval( getRequestParameter( useTag ),useBeforeHtmlTag );
1128        }
1129
1130        /**
1131         * シリアライズ用のカスタムシリアライズ書き込みメソッド
1132         *
1133         * @og.rev 4.0.0.0 (2006/09/31) 新規追加
1134         * @serialData 一部のオブジェクトは、シリアライズされません。
1135         *
1136         * @param       strm    ObjectOutputStreamオブジェクト
1137         * @throws IOException  入出力エラーが発生した場合
1138         */
1139        private void writeObject( final ObjectOutputStream strm ) throws IOException {
1140                strm.defaultWriteObject();
1141        }
1142
1143        /**
1144         * シリアライズ用のカスタムシリアライズ読み込みメソッド
1145         *
1146         * ここでは、transient 宣言された内部変数の内、初期化が必要なフィールドのみ設定します。
1147         *
1148         * @og.rev 4.0.0.0 (2006/09/31) 新規追加
1149         * @serialData 一部のオブジェクトは、シリアライズされません。
1150         *
1151         * @param       strm    ObjectInputStreamオブジェクト
1152         * @see #release2()
1153         * @throws IOException  シリアライズに関する入出力エラーが発生した場合
1154         * @throws ClassNotFoundException       クラスを見つけることができなかった場合
1155         */
1156        private void readObject( final ObjectInputStream strm ) throws IOException , ClassNotFoundException {
1157                strm.defaultReadObject();
1158        }
1159
1160        /**
1161         * このオブジェクトの文字列表現を返します。
1162         * 基本的にデバッグ目的に使用します。
1163         *
1164         * @return このクラスの文字列表現
1165         */
1166        @Override
1167        public String toString() {
1168                return sql ;
1169
1170        //      return org.opengion.fukurou.util.ToString.title( this.getClass().getName() )
1171        //                      .println( "VERSION"                     ,VERSION                )
1172        //                      .println( "tableId"                     ,tableId                )
1173        //                      .println( "queryType"           ,queryType              )
1174        //                      .println( "dbid"                        ,dbid                   )
1175        //                      .println( "command"                     ,command                )
1176        //                      .println( "skipRowCount"        ,skipRowCount   )
1177        //                      .println( "maxRowCount"         ,maxRowCount    )
1178        //                      .println( "sql"                         ,sql                    )
1179        //                      .println( "displayMsg"          ,displayMsg             )
1180        //                      .println( "overflowMsg"         ,overflowMsg    )
1181        //                      .println( "executeCount"        ,executeCount   )
1182        //                      .println( "names"                       ,names                  )
1183        //                      .println( "outMessage"          ,outMessage             )
1184        //                      .println( "trace"                       ,trace                  )
1185        //                      .println( "errCode"                     ,errCode                )
1186        //                      .println( "stopZero"            ,stopZero               )
1187        //                      .println( "quotCheck"           ,quotCheck              )
1188        //                      .println( "dyStart"                     ,dyStart                )
1189        //                      .println( "checkNames"          ,checkNames             )
1190        //                      .println( "Other..."            ,getAttributes().getAttribute() )
1191        //                      .fixForm().toString() ;
1192        }
1193}