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 org.opengion.hayabusa.common.HybsSystem;
019import org.opengion.hayabusa.common.HybsSystemException;
020import org.opengion.hayabusa.db.DBTableModel;
021import org.opengion.hayabusa.db.TableFilter;
022import org.opengion.fukurou.db.Transaction;
023import org.opengion.fukurou.util.ErrorMessage;
024import org.opengion.fukurou.util.StringUtil;
025import org.opengion.fukurou.util.ToString;                                              // 6.1.1.0 (2015/01/17)
026
027import static org.opengion.fukurou.util.StringUtil.nval ;
028
029import java.util.concurrent.ConcurrentMap;                                              // 6.4.3.3 (2016/03/04)
030
031/**
032 * TableFilter のサブクラスをCALLしてDBTableModelにアクセスするタグです。
033 *
034 * DBTableModel を TableFilter のサブクラス(classIdで指定)に渡して処理を実行します。
035 * クラスを作成する場合は、org.opengion.hayabusa.db.TableFilter インターフェースを継承した
036 * クラスにする必要があります。また、classId 属性には、システムリソース で
037 * 設定した TableFilter.XXXX の XXXX を指定します。
038 *
039 * BODY部分は、SQLを記述する為だけに使っていましたが、CSS定義形式の書式で、keys,vals を記述
040 * できるようにします。
041 * これは、下記のようなパラメータを、keys="KEY,KEY2,KEY3" vals='AAAA,"BB,CC,DD",EE' のような記述形式と
042 *   {
043 *        KEY1 : AAAA ;
044 *        KEY2 : BB,CC,DD ;
045 *        KEY3 : EE ;
046 *        ・・・・・・
047 *   }
048 * のような、CSS形式に類似の形式でも記述できるようにしました。
049 * keys,vals と CSS定義形式パラメータを同時に指定した場合は、両方とも有効です。
050 * ただし、キーが重複した場合は、不定と考えてください。
051 * 現時点では、CSS定義形式パラメータが優先されますが、これは、単に内部パラメータMapへの
052 * 登録順が、CSS定義形式パラメータが後の為、上書きされるためです。
053 *
054 * ※ このタグは、Transaction タグの対象です。
055 *
056 * @og.formSample
057 * ●形式:<og:tableFilter classId="…" />
058 * ●body:あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します)
059 *
060 * ●Tag定義:
061 *   <og:tableFilter
062 *       classId          ○【TAG】データベース処理を実行するクラスパスを指定します(必須)。
063 *       tableId            【TAG】(通常は使いません)DBTableModel sessionに登録されているキーを指定します
064 *       modifyType         【TAG】データ処理の方法(A:追加 C:更新 D:削除)を指定します
065 *       keys               【TAG】リンク先に渡すキーを指定します
066 *       vals               【TAG】keys属性に対応する値をCSV形式で複数指定します
067 *       selectedAll        【TAG】データを全件選択済みとして処理するかどうか[true/false]を指定します(初期値:false)
068 *       stopZero           【TAG】検索結果が0件のとき処理を続行するかどうか[true/false]を指定します(初期値:false[続行する])
069 *       scope              【TAG】キャッシュする場合のスコープ[request/page/session/application]を指定します(初期値:session)
070 *       dbid               【TAG】(通常は使いません)Queryオブジェクトを作成する時のDB接続IDを指定します
071 *       caseKey            【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null) 5.7.7.2 (2014/06/20)
072 *       caseVal            【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null) 5.7.7.2 (2014/06/20)
073 *       caseNN             【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:判定しない) 5.7.7.2 (2014/06/20)
074 *       caseNull           【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:判定しない) 5.7.7.2 (2014/06/20)
075 *       caseIf             【TAG】指定の値が、true/TRUE文字列の場合は、このタグは使用されます(初期値:判定しない)
076 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
077 *   >   ... Body ...
078 *   </og:tableFilter>
079 *
080 * ●使用例
081 *    ・引数/プロシジャーを直接書く場合
082 *    【entry.jsp】
083 *        <og:tableFilter
084 *            classId     = "WL_LOGICSET"         :TableFilter のサブクラス(実行クラス)
085 *            tableId     = "WL0000"              :登録元のDBTableModelのsession/request変数内の取得キー
086 *            keys        = "AA,BB,CC"            :実行クラスへの引数のキー
087 *            vals        = "{@AA},{@BB},{@CC}"   :実行クラスへの引数の値
088 *            selectedAll = "false/true"          :処理対象の行を全行選択するかどうか(初期値:false)
089 *            modifyType  = "A/C/D"               :処理の方法(A:追加 C:更新 D:削除)を指定します。初期値は自動です。
090 *        />
091 *
092 *    ・BODY部分に、CSS形式のパラメータ(keys,vals)を記述する例
093 *
094 *        <og:tableFilter
095 *            classId     = "WL_LOGICSET"         :TableFilter のサブクラス(実行クラス)
096 *            tableId     = "WL0000"              :登録元のDBTableModelのsession/request変数内の取得キー
097 *            selectedAll = "false/true"          :処理対象の行を全行選択するかどうか(初期値:false)
098 *            modifyType  = "A/C/D"               :処理の方法(A:追加 C:更新 D:削除)を指定します。初期値は自動です。
099 *        >
100 *               {
101 *                   AA    :  {@AA}
102 *                   BB    :  {@BB}
103 *                   CC    :  {@CC}
104 *               }
105 *        </og:tableFilter>
106 *
107 * @og.group その他
108 * @og.rev 3.8.5.0 (2006/03/20) 新規作成
109 *
110 * @version  0.9.0  2000/10/17
111 * @author   Kazuhiko Hasegawa
112 * @since    JDK1.1,
113 */
114public class TableFilterTag extends CommonTagSupport {
115        /** このプログラムのVERSION文字列を設定します。   {@value} */
116        private static final String VERSION = "6.4.3.3 (2016/03/04)" ;
117        private static final long serialVersionUID = 643320160304L ;
118
119        private static final String ERR_MSG_ID  = HybsSystem.ERR_MSG_KEY;               // 6.4.1.1 (2016/01/16) errMsgId  → ERR_MSG_ID  refactoring
120        private transient DBTableModel  table   ;
121
122        private String          tableId         = HybsSystem.TBL_MDL_KEY;
123        private String          classId         ;
124        private String          modifyType      ;
125        private String[]        keys            ;
126        private String[]        vals            ;
127
128        private   String        dbid            ; // 4.2.4.0 (2008/06/23)
129        private   String        sql                     ; // 5.6.5.2 (2013/06/21) bodyからSQL文のみを切り出す。
130        /** 6.4.3.1 (2016/02/12) PMD refactoring. 取り出し元を HashMap → ConcurrentHashMap に置き換え。  */
131        private   ConcurrentMap<String,String>  paramMap;       // 5.6.5.2 (2013/06/21) bodyからparamMapを取りだし。
132
133        private boolean         selectedAll     ;
134        private boolean         stopZero        ;       // 5.7.6.2 (2014/05/16) stopZero属性追加
135
136        /**
137         * デフォルトコンストラクター
138         *
139         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
140         */
141        public TableFilterTag() { super(); }            // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
142
143        /**
144         * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
145         *
146         * @og.rev 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加
147         *
148         * @return      後続処理の指示( EVAL_BODY_BUFFERED )
149         */
150        @Override
151        public int doStartTag() {
152                // 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加
153                if( !useTag() ) { return SKIP_BODY ; }
154
155                table = (DBTableModel)getObject( tableId );
156
157                if( keys != null && vals != null && keys.length != vals.length ) {
158                        final String errMsg = "keys と vals の設定値の数が異なります。: " + CR
159                                                + "keys.length=[" + keys.length + "] , "
160                                                + "keys.length=[" + StringUtil.array2line( keys,"," ) + "]"
161                                                + CR
162                                                + "vals.length=[" + vals.length + "] , "
163                                                + "vals.length=[" + StringUtil.array2line( vals,"," ) + "]";
164                        throw new HybsSystemException( errMsg );
165                }
166
167                startQueryTransaction( tableId );
168                return EVAL_BODY_BUFFERED ;             // Body を評価する
169        }
170
171        /**
172         * Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
173         *
174         * @og.rev 5.6.5.2 (2013/06/21) bodyローカル化、sql、paramMap 追加
175         *
176         * @return      後続処理の指示(SKIP_BODY)
177         */
178        @Override
179        public int doAfterBody() {
180                final String body = nval( getBodyString(),null );
181
182                // paramMapの取り出し
183                paramMap = StringUtil.cssParse( body );
184
185                // SQL文の切り出し classId="DBSELECT" の場合のみの処理
186                if( "DBSELECT".equalsIgnoreCase( classId ) && body != null ) {
187                        final int ad1 = body.indexOf( '{' );
188                        final int ad2 = body.indexOf( '}' );
189
190                        if( ad1 >= 0 && ad2 >= 0 ) {
191                                sql = body.substring( 0,ad1 ).trim() + body.substring( ad2+1 ).trim();
192                        }
193                        else {
194                                sql = body.trim();
195                        }
196                }
197
198                return SKIP_BODY ;
199        }
200
201        /**
202         * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
203         *
204         * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定
205         * @og.rev 4.2.3.0 (2008/06/23) DBIDとボディー部分の記述を下位クラスに渡す用に修正
206         * @og.rev 4.3.7.4 (2009/07/01) Resouceオブジェクトを下位クラスに渡す用に修正
207         * @og.rev 5.1.9.0 (2010/08/01) Transaction 対応
208         * @og.rev 5.2.1.0 (2010/10/01) debugPrint() メソッドの処理条件見直し
209         * @og.rev 5.3.7.0 (2011/07/01) TransactionReal の引数変更 、Transaction対応で、close処理を入れる。
210         * @og.rev 5.6.5.2 (2013/06/21) bodyローカル化、sql、paramMap 追加
211         * @og.rev 5.7.6.2 (2014/05/16) table件数が変わる場合、"DB.COUNT" キーでリクエストに再セットする。
212         * @og.rev 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加
213         * @og.rev 6.0.4.0 (2014/11/28) NullPointerException が発生するので、事前にチェックします。
214         * @og.rev 6.3.6.1 (2015/08/28) Transaction でAutoCloseableを使用したtry-with-resources構築に対応。
215         * @og.rev 6.4.3.3 (2016/03/04) HybsSystem.newInstance(String,String) への置き換え。
216         *
217         * @return      後続処理の指示
218         */
219        @Override
220        public int doEndTag() {
221                // デバッグ時には、オブジェクト内部情報を表示する。
222                debugPrint();   // 5.2.1.0 (2010/10/01) debugPrint() メソッド自体に、isDebug() が組み込まれている。
223
224                // 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加
225                if( !useTag() ) { return EVAL_PAGE ; }
226
227                int rtnCode = EVAL_PAGE;        // try ~ finally の関係で、変数化しておく
228
229                final int[] rowNo = getParameterRows();
230
231                // 5.1.9.0 (2010/08/01) Transaction 対応
232                // 5.3.7.0 (2011/07/01) Transaction対応で、close処理を入れる。
233
234                // 6.3.6.1 (2015/08/28) Transaction でAutoCloseableを使用したtry-with-resources構築に対応。
235                try( final Transaction tran = getTransaction() ) {
236
237                        final TableFilter filter = HybsSystem.newInstance( "TableFilter_" , classId );
238
239                        filter.setDBTableModel( table );
240                        filter.setParameterRows( rowNo );
241                        filter.setModifyType( modifyType );
242                        filter.setKeysVals( keys,vals );
243        //              filter.setApplicationInfo( getApplicationInfo() );      // 3.8.7.0 (2006/12/15)
244                        filter.setTransaction( tran );                                          // 5.1.9.0 (2010/08/01) Transaction 対応
245                        filter.setDebug( isDebug() );
246                        filter.setDbid( dbid );                                 // 4.2.4.0 (2008/06/23)
247                        filter.setSql( sql );                                   // 5.6.5.2 (2013/06/21) sql 追加
248                        filter.setParamMap( paramMap );                 // 5.6.5.2 (2013/06/21) paramMap 追加
249                        filter.setResource( getResource() );    // 4.3.7.4 (2009/07/01)
250
251                        // 6.4.1.1 (2016/01/16) PMD refactoring. Avoid declaring a variable if it is unreferenced before a possible exit point.
252                        final int rowCnt1 = table == null ? -1 : table.getRowCount();   // filter 処理の前の行件数をチェック
253
254                        table = filter.execute();
255
256                        // 5.7.6.2 (2014/05/16) table件数が変わる場合、"DB.COUNT" キーでリクエストに再セットする。
257                        final int rowCnt2 = table == null ? -1 : table.getRowCount();
258                        if( rowCnt1 != rowCnt2 ) {
259                                setRequestAttribute( "DB.COUNT" , String.valueOf( rowCnt2 ) );
260                        }
261
262                        final int errCode = filter.getErrorCode();
263
264                        if( errCode >= ErrorMessage.NG )  {     // 異常
265                                rtnCode = SKIP_PAGE;
266                        }
267
268                        // 5.7.6.2 (2014/05/16) 件数0件(または、table==null)かつ stopZero = true
269                        if( rowCnt2 <= 0 && stopZero ) { return SKIP_PAGE; }
270
271                        // 6.4.1.1 (2016/01/16) PMD refactoring. Avoid declaring a variable if it is unreferenced before a possible exit point.
272                        final ErrorMessage errMessage = filter.getErrorMessage();
273                        final String err = TaglibUtil.makeHTMLErrorTable( errMessage,getResource() );
274                        if( err != null && err.length() > 0 ) {
275                                jspPrint( err );
276                                setSessionAttribute( ERR_MSG_ID,errMessage );
277                        }
278                        else {
279                                removeSessionAttribute( ERR_MSG_ID );
280                        }
281                        tran.commit();                          // 6.3.6.1 (2015/08/28)
282                }
283
284                if( table != null && ! commitTableObject( tableId, table ) ) {
285                        rtnCode = SKIP_PAGE ;
286                }
287
288                return rtnCode ;
289        }
290
291        /**
292         * タグリブオブジェクトをリリースします。
293         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
294         *
295         * @og.rev 5.6.5.2 (2013/06/21) body廃止、sql、paramMap 追加
296         * @og.rev 5.7.6.2 (2014/05/16) stopZero属性追加
297         */
298        @Override
299        protected void release2() {
300                super.release2();
301                table           = null;
302                tableId         = HybsSystem.TBL_MDL_KEY;
303                classId         = null;
304                modifyType      = null;
305                keys            = null;
306                vals            = null;
307                selectedAll     = false;
308                stopZero        = false;        // 5.7.6.2 (2014/05/16) stopZero属性追加
309                dbid            = null;         // 4.2.4.0 (2008/06/23)
310                sql                     = null;         // 5.6.5.2 (2013/06/21) bodyからSQL文のみを切り出す。
311                paramMap        = null;         // 5.6.5.2 (2013/06/21) bodyからparamMapを取りだす。
312        }
313
314        /**
315         * 表示データの HybsSystem.ROW_SEL_KEY を元に、選ばれた 行を処理の対象とします。
316         *
317         * @og.rev 6.3.9.0 (2015/11/06) コンストラクタで初期化されていないフィールドを null チェックなしで利用している(findbugs)
318         *
319         * @return      選択行の配列
320         * @og.rtnNotNull
321         */
322        @Override
323        protected int[] getParameterRows() {
324                final int[] rowNo ;
325                // 6.3.9.0 (2015/11/06) コンストラクタで初期化されていないフィールドを null チェックなしで利用している(findbugs)
326                if( selectedAll && table != null ) {
327                        final int rowCnt = table.getRowCount();
328                        rowNo = new int[rowCnt];
329                        for( int i=0; i<rowCnt; i++ ) {
330                                rowNo[i] = i;
331                        }
332                } else {
333                        rowNo = super.getParameterRows();               // 4.0.0 (2005/01/31)
334                }
335                return rowNo;
336        }
337
338        /**
339         * 【TAG】データベース処理を実行するテーブルフィルターのクラスIDを指定します。
340         *
341         * @og.tag
342         * ここで指定するクラスIDは、システムリソース にて TableFilter の
343         * サブクラス(インターフェース継承)として指定する必要があります。
344         *
345         * クラス自身は、org.opengion.hayabusa.db.TableFilter インターフェースを継承している必要があります。
346         * {@og.doc03Link tableFilter TableFilter_**** クラス}
347         *
348         * @param       id 実行クラスID
349         * @see         org.opengion.hayabusa.db.TableFilter  TableFilter インターフェース
350         */
351        public void setClassId( final String id ) {
352                classId = nval( getRequestParameter( id ),classId );
353        }
354
355        /**
356         * 【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します
357         *              (初期値:HybsSystem#TBL_MDL_KEY[={@og.value HybsSystem#TBL_MDL_KEY}])。
358         *
359         * @og.tag
360         * 検索結果より、DBTableModelオブジェクトを作成します。これを、下流のviewタグ等に
361         * 渡す場合に、通常は、session を利用します。その場合の登録キーです。
362         * query タグを同時に実行して、結果を求める場合、同一メモリに配置される為、
363         * この tableId 属性を利用して、メモリ空間を分けます。
364         *              (初期値:HybsSystem#TBL_MDL_KEY[={@og.value HybsSystem#TBL_MDL_KEY}])。
365         *
366         * @param       id テーブルID (sessionに登録する時のID)
367         */
368        public void setTableId( final String id ) {
369                tableId = nval( getRequestParameter( id ),tableId );
370        }
371
372        /**
373         * 【TAG】データを全件選択済みとして処理するかどうか[true/false]を指定します(初期値:false)。
374         *
375         * @og.tag
376         * 全てのデータを選択済みデータとして扱って処理します。
377         * 全件処理する場合に、指定します。(true/false)
378         * デフォルト false です。
379         *
380         * @param  all 全件選択済み [true:全件選択済み/false:通常]
381         */
382        public void setSelectedAll( final String all ) {
383                selectedAll = nval( getRequestParameter( all ),selectedAll );
384        }
385
386        /**
387         * 【TAG】検索結果が0件のとき処理を停止するかどうか[true/false]を指定します(初期値:false[続行する])。
388         *
389         * @og.tag
390         * 初期値は、false(続行する)です。
391         *
392         * @og.rev 5.7.6.2 (2014/05/16) 新規追加
393         *
394         * @param  cmd 0件時停止可否 [true:処理を中止する/false:続行する]
395         */
396        public void setStopZero( final String cmd ) {
397                stopZero = nval( getRequestParameter( cmd ),stopZero );
398        }
399
400        /**
401         * 【TAG】データ処理の方法[A:追加/C:更新/D:削除]を指定します(初期値:自動判定)。
402         *
403         * @og.tag
404         * 通常は、DBTableModel に自動設定されている modifyType を元に、データ処理方法を
405         * 選別します。(A:追加 C:更新 D:削除)
406         * この場合、行単位で modifyType の値を取得して判別する必要がありますが、一般には
407         * 処理対象は、全件おなじ modifyType である可能性が高いです。
408         * また、selectedAll などで強制的に全件処理対象とする場合は、modifyType に値が
409         * 設定さていません。その様な場合に外部より modifyType を指定します。
410         * 初期値は、自動判定 です。
411         *
412         * @param  type 処理方法 [A:追加/C:更新/D:削除]
413         */
414        public void setModifyType( final String type ) {
415                modifyType = nval( getRequestParameter( type ),modifyType );
416
417                if( modifyType != null && !"A".equals( modifyType ) && !"C".equals( modifyType ) && !"D".equals( modifyType ) ) {
418                        final String errMsg = "modifyType は A:追加 C:更新 D:削除 のどれかを指定してください。: " + CR
419                                                + "modifyType=[" + modifyType + "]";
420                        throw new HybsSystemException( errMsg );
421                }
422        }
423
424        /**
425         * 【TAG】リンク先に渡すキーを指定します。
426         *
427         * @og.tag
428         * 戻る時に、検索時のキャッシュに指定した引数以外に指定したり、別の値に置き換えたり
429         * する場合のキーを設定できます。CSV形式で複数指定できます。
430         * vals 属性には、キーに対応する値を、設定してください。
431         * 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。
432         * こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。
433         *
434         * @param       key リンク先に渡すキー
435         */
436        public void setKeys( final String key ) {
437                keys = getCSVParameter( key );
438        }
439
440        /**
441         * 【TAG】names属性に対応する値をCSV形式で複数指定します。
442         *
443         * @og.tag
444         * キーに設定した値を、CSV形式で複数して出来ます。
445         * 指定順序は、キーと同じにしておいて下さい。
446         * 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。
447         * こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。
448         *
449         * @param       val names属性に対応する値 (CSV形式)
450         */
451        public void setVals( final String val ) {
452                vals = getCSVParameter( val );
453        }
454
455        /**
456         * 【TAG】(通常は使いません)Queryオブジェクトを作成する時のDB接続IDを指定します。
457         *
458         * @og.tag
459         * Queryオブジェクトを作成する時のDB接続IDを指定します。
460         * これは、システムリソースで、DEFAULT_DB_URL 等で指定している データベース接続先
461         * 情報に、XX_DB_URL を定義することで、 dbid="XX" とすると、この 接続先を使用して
462         * データベースにアクセスできます。
463         *
464         * @param       id データベース接続ID
465         */
466        public void setDbid( final String id ) {
467                dbid = nval( getRequestParameter( id ),dbid );
468        }
469
470        /**
471         * このオブジェクトの文字列表現を返します。
472         * 基本的にデバッグ目的に使用します。
473         *
474         * @return このクラスの文字列表現
475         * @og.rtnNotNull
476         */
477        @Override
478        public String toString() {
479                return ToString.title( this.getClass().getName() )
480                                .println( "VERSION"                     ,VERSION                )
481                                .println( "tableId"                     ,tableId                )
482                                .println( "classId"                     ,classId                )
483                                .println( "modifyType"          ,modifyType             )
484                                .println( "selectedAll"         ,selectedAll    )
485                                .println( "keys"                        ,keys                   )
486                                .println( "vals"                        ,vals                   )
487                                .println( "dbid"                        ,dbid                   ) // 4.2.4.0 (2008/06/23)
488                                .println( "sql"                         ,sql                    ) // 5.6.5.2 (2013/06/21)
489                                .fixForm().toString() ;
490        }
491}