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