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.File;
021import java.util.Locale;
022import java.util.concurrent.ConcurrentMap;                                              // 6.4.3.3 (2016/03/04)
023import java.util.Arrays;
024import java.util.Map;                                                                                   // 6.9.9.0 (2018/08/20)
025
026import org.opengion.fukurou.business.ArrayTableModel;
027import org.opengion.fukurou.model.DataModel;                                    // 6.7.9.1 (2017/05/19) ArrayTableModel を、DataModel I/F に変更
028import org.opengion.fukurou.business.BizLogicHelper;
029import org.opengion.fukurou.db.Transaction;
030import org.opengion.fukurou.util.ErrMsg;
031import org.opengion.fukurou.util.ErrorMessage;
032import org.opengion.fukurou.util.HybsLoader;
033import org.opengion.fukurou.util.HybsLoaderConfig;
034import org.opengion.fukurou.util.HybsLoaderFactory;
035import org.opengion.fukurou.util.StringUtil;
036import org.opengion.fukurou.util.ToString;                                              // 6.1.1.0 (2015/01/17)
037import org.opengion.hayabusa.common.HybsSystem;
038import org.opengion.hayabusa.common.HybsSystemException;
039import org.opengion.hayabusa.db.DBTableModel;
040
041/**
042 * 業務ロジックを呼び出すためのタグです。
043 *
044 * logics属性に呼び出す業務ロジックのクラス名を記述します。
045 * このタグでは、複数の業務ロジックを1度に呼び出すことができ、
046 * DB接続のcommit,rollbackは一番最後に、1度のみ実行されます。
047 * 各業務ロジックは、記述した順番に呼び出されます。
048 *
049 * 業務ロジックは、{@link org.opengion.fukurou.business.AbstractBizLogic AbstractBizLogic}を
050 * 継承したサブクラスである必要があります。
051 * 標準サブクラスとして、BizLogic_ENTRYとBizLogic_TABLE を用意しています。
052 * BizLogic_ENTRY は、パラメーターのみを使用する業務ロジックです。
053 * BizLogic_TABLE は、配列型テーブルモデルをメインカーソルとした業務ロジックです。
054 *   配列型テーブルモデルでは、初期処理、ループ処理、後処理とメソッドがコールされます。
055 *
056 *  fstchk()          変更区分に関わらず   処理を始める前に呼び出し
057 *  first()           変更区分に関わらず   最初の行でのみ呼び出し
058 *    useLoop == true
059 *      befall( int row ) 変更区分に関わらず  各行について呼び出し(insert,modify,deleteの前に呼び出し)
060 *      insert( int row ) 変更区分が"A"の場合 各行について呼び出し
061 *      modify( int row ) 変更区分が"C"の場合 各行について呼び出し
062 *      delete( int row ) 変更区分が"D"の場合 各行について呼び出し
063 *      allrow( int row ) 変更区分に関わらず  各行について呼び出し(insert,modify,deleteの後に呼び出し)
064 *  last()            変更区分に関わらず   最後の行でのみ呼び出し
065 *
066 * 業務ロジッククラスについては、ホットデプロイ機能により、動的コンパイル、クラスロードが
067 * 行われます。
068 *
069 * 業務ロジックのソースディレクトリは、システムリソースの BIZLOGIC_SRC_PATH で定義されます。
070 * また、同様にクラスディレクトリは、システムリソースの BIZLOGIC_CLASS_PATH で定義されます。
071 * さらに、システムリソースの BIZLOGIC_HOTDEPLOY を false に設定することで、動的コンパイル
072 * 、クラスロードを行わなくすることもできます。
073 * この場合、予めコンパイルされたクラスを、初回呼び出し時に1回のみロードされます。
074 *
075 * SystemData の USE_SQL_INJECTION_CHECK が true か、quotCheck 属性が true の場合は、
076 * SQLインジェクション対策用のシングルクォートチェックを行います。リクエスト引数に
077 * シングルクォート(')が含まれると、エラーになります。
078 * 同様にUSE_XSS_CHECKがtrueか、xssCheck属性がtrueの場合は、
079 * クロスサイトススクリプティング(XSS)対策のためless/greater than signのチェックを行います。
080 *
081 * ※ このタグは、Transaction タグの対象です。
082 *
083 * @og.formSample
084 * ●形式:
085 *       ・<og:bizLog
086 *             logics       = "業務ロジックのクラス名"
087 *             command      = "ENTRY"
088 *             scope        = "session"
089 *             dbid         = "DEFAULT"
090 *             tableId      = "DEFAULT"
091 *             selectedAll  = "false"
092 *             modifyType   = "A"
093 *             keys         = "SYSTEM_ID"
094 *             vals         = "{@SYSTEM_ID}"
095 *        />
096 * ●body:なし
097 *
098 * ●Tag定義:
099 *   <og:bizLogic
100 *       logics           ○【TAG】実行する業務ロジック名を指定します (必須)
101 *       command            【TAG】コマンドをセットします (初期値:ENTRY)
102 *       scope              【TAG】キャッシュする場合のスコープ[request/page/session/application]を指定します (初期値:session)
103 *       dbid               【TAG】(通常は使いません)Queryオブジェクトを作成する時のDB接続IDを指定します (初期値:null)
104 *       tableId            【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します
105 *       selectedAll        【TAG】データを全件選択済みとして処理するかどうか[true/false]を指定します (初期値:false)
106 *       modifyType         【TAG】DB検索時の モディファイタイプを指定します[A:追加/C:更新/D:削除]
107 *       keys               【TAG】リンク先に渡すキーをCSV形式で複数指定します
108 *       vals               【TAG】リンク先に渡す値をCSV形式で複数指定します
109 *       stopError          【TAG】処理エラーの時に処理を中止するかどうか[true/false]を設定します (初期値:true)
110 *       dispError          【TAG】エラー時にメッセージを表示するか[true/false]を設定します。通常はstopErrorと併用 (初期値:true)
111 *       quotCheck          【TAG】リクエスト情報の シングルクォート(') 存在チェックを実施するかどうか[true/false]を設定します (初期値:USE_SQL_INJECTION_CHECK[=true])
112 *       xssCheck           【TAG】リクエスト情報の HTMLTag開始/終了文字(><) 存在チェックを実施するかどうか[true/false]を設定します (初期値:USE_XSS_CHECK[=true])
113 *       multi              【TAG】vals属性でパラメーターを取得する際、複数件存在する場合に、値を連結するかどうかを指定します (初期値:false)
114 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します (初期値:false)
115 *   />
116 *
117 * ●使用例
118 *     <!-- 業務ロジックの呼び出しを行います -->
119 *     <og:bizLogic logics="org.opengion.logic.gf9110.BizLogic_0001" keys="SYSTEM_ID" vals="{@MEM.SYSTEM_ID}" />
120 *
121 * @og.rev 5.1.1.0 (2009/12/01) 新規作成
122 * @og.group 業務ロジック
123 *
124 * @version     5.0
125 * @author      Hiroki Nakamura
126 * @since       JDK1.6,
127 */
128public class BizLogicTag extends CommonTagSupport {
129        /** このプログラムのVERSION文字列を設定します。   {@value} */
130        private static final String VERSION = "8.3.1.0 (2022/10/14)" ;
131        private static final long serialVersionUID = 831020221014L ;
132
133        /** command 引数に渡す事の出来る コマンド エントリー {@value} */
134        public static final String CMD_ENTRY            = "ENTRY";                                              // 5.1.9.0 (2010/08/01)
135        private static final String ERR_MSG_ID          = HybsSystem.ERR_MSG_KEY;
136
137        private                         String          command         = CMD_ENTRY;
138        private                         String[]        logics          ;
139        private                         String          dbid            ;
140        private transient       DBTableModel table              ;
141        private                         String          tableId         = HybsSystem.TBL_MDL_KEY;
142        private                         boolean         selectedAll     ;
143        private                         String          modifyType      ;
144        private                         String[]        keys            ;
145        private                         String[]        vals            ;
146
147        private                         boolean         stopError       = true;
148        private                         boolean         quotCheck       = HybsSystem.sysBool( "USE_SQL_INJECTION_CHECK" );      // 4.0.0 (2005/08/31)
149        private                         boolean         xssCheck        = HybsSystem.sysBool( "USE_XSS_CHECK" );                        // 5.0.0.2 (2009/09/15)
150
151        private transient       ErrorMessage errMessage ;
152        private                         int             errCode                 = ErrorMessage.OK;
153        private                         int             executeCount    = -1;
154        private transient       DataModel<String>       arrTable;                                                       // 6.7.9.1 (2017/05/19) ArrayTableModel を、DataModel I/F に変更
155        private transient       HybsLoader                      loader  ;                                                       // 6.3.9.0 (2015/11/06) transient 追加
156
157        // 8.0.2.0 (2021/11/30) static定義するので、Tomcat再起動が必要
158        private static final String SRC_PATH            = HybsSystem.sys( "REAL_PATH" ) + HybsSystem.sys( "BIZLOGIC_SRC_PATH" );
159        private static final String CLS_PATH            = HybsSystem.sys( "REAL_PATH" ) + HybsSystem.sys( "BIZLOGIC_CLASS_PATH" );
160        private static final String WEB_LIB                     = HybsSystem.sys( "REAL_PATH" ) + "WEB-INF" + File.separator + "lib";
161        private static final String WEB_CLS                     = HybsSystem.sys( "REAL_PATH" ) + "WEB-INF" + File.separator + "classes";
162
163//      private                         String  srcDir                  = HybsSystem.sys( "REAL_PATH" ) + HybsSystem.sys( "BIZLOGIC_SRC_PATH" );
164        private                         String  srcDir                  = SRC_PATH;                                             // 8.0.2.0 (2021/11/30)
165//      private                         String  classDir                = HybsSystem.sys( "REAL_PATH" ) + HybsSystem.sys( "BIZLOGIC_CLASS_PATH" );
166        private                         String  classDir                = CLS_PATH;                                             // 8.0.2.0 (2021/11/30)
167        private                         boolean isAutoCompile   = HybsSystem.sysBool( "BIZLOGIC_AUTO_COMPILE" );
168        private                         boolean isHotDeploy             = HybsSystem.sysBool( "BIZLOGIC_HOT_DEPLOY" );
169        private                         boolean isMulti                 ;                                                               // 5.1.8.0 (2010/07/01) 追加
170
171        // 5.9.26.1 (2017/11/10) 実行エラーの際に、エラーを画面に出力するかどうか。
172        private                         boolean dispError               = true;
173
174        private static final String     CLASS_PATH;
175
176        // HotDeploy機能を使用する場合に、Javaクラスをコンパイルするためのクラスパスを設定します。
177        // 対象となるクラスパスは、WEB-INF/classes 及び WEB-INF/lib/*.jar です。
178
179        static {
180                final StringBuilder sb = new StringBuilder( BUFFER_MIDDLE )
181                        .append( '.' ).append( File.pathSeparatorChar );
182//              final File lib = new File( HybsSystem.sys( "REAL_PATH" ) + "WEB-INF" + File.separator + "lib" );
183                final File lib = new File( WEB_LIB );                                                                   // 8.0.2.0 (2021/11/30)
184                final File[] libFiles = lib.listFiles();
185                // 6.3.9.0 (2015/11/06) null になっている可能性がある(findbugs)
186                if( libFiles != null ) {
187                        for( final File file : libFiles ) {
188                                // 5.1.1.2 (2009/12/10) File.pathSeparatorCharを使用
189                                // 5.1.8.0 (2010/07/01) libの検索パスの不具合対応
190                                sb.append( file.getAbsolutePath() ).append( File.pathSeparatorChar );
191                        }
192                }
193//              sb.append( HybsSystem.sys( "REAL_PATH" ) + "WEB-INF" + File.separator + "classes" )
194                sb.append( WEB_CLS )                                                                                                    // 8.0.2.0 (2021/11/30)
195                        .append( File.pathSeparatorChar )
196                        // 5.1.8.0 (2010/07/01) bizの下も検索パスに追加
197//                      .append( HybsSystem.sys( "REAL_PATH" ) + HybsSystem.sys( "BIZLOGIC_CLASS_PATH" ) ).append( File.pathSeparatorChar );
198                        .append( CLS_PATH ).append( File.pathSeparatorChar );                           // 8.0.2.0 (2021/11/30)
199
200                CLASS_PATH = sb.toString();
201        }
202
203        /**
204         * デフォルトコンストラクター
205         *
206         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
207         */
208        public BizLogicTag() { super(); }               // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
209
210        /**
211         * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
212         *
213         * @og.rev 5.3.4.0 (2011/04/01) command=ENTRY以外ではDBTableModelの処理を行わない。
214         * @og.rev 6.4.8.1 (2016/07/02) xssCheckを、doStartTag に移動
215         *
216         * @return      後続処理の指示(SKIP_BODY)
217         */
218        @Override
219        public int doStartTag() {
220                useXssCheck( xssCheck );                                                                                                // 6.4.8.1 (2016/07/02)
221
222                // 5.3.4.0 (2011/04/01)
223                if( CMD_ENTRY.equals( command ) ) {
224                        startQueryTransaction( tableId );
225                }
226
227                return SKIP_BODY ;
228        }
229
230        /**
231         * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
232         *
233         * @og.rev 5.1.8.0 (2010/07/01) isMulti対応
234         * @og.rev 5.3.4.0 (2011/04/01) command=ENTRY以外ではDBTableModelの処理を行わない。
235         * @og.rev 6.4.8.1 (2016/07/02) xssCheckを、doStartTag に移動
236         * @og.rev 5.9.26.1 (2017/11/10) dispErrorの処理追加
237         * @og.rev 8.3.1.0 (2022/10/14) 正常終了時、過去のエラーメッセージが消えない不具合対応
238         *
239         * @return      後続処理の指示
240         */
241        @Override
242        public int doEndTag() {
243                debugPrint();
244
245                // 5.3.4.0 (2011/04/01)
246                useQuotCheck( quotCheck );
247
248                makeVals();
249                execute();
250
251                final String err = TaglibUtil.makeHTMLErrorTable( errMessage,getResource() );
252                if( err != null && err.length() > 0 ) {
253                        setSessionAttribute( ERR_MSG_ID,errMessage );
254                }
255                // 8.3.1.0 (2022/10/14) Add
256                else {
257                        removeSessionAttribute( ERR_MSG_ID );
258                }
259
260                if( table != null && ! commitTableObject( tableId, table ) ) {
261                        jspPrint( "BizLoicTag 処理が割り込まれました。DBTableModel は登録しません。" );
262                        return SKIP_PAGE;
263                }
264
265                // 5.9.26.1 (2017/11/10) エラーメッセージをリクエスト変数で持つようにしておく
266                setRequestAttribute( "DB.ERR_MSG", err );
267                // 5.9.26.1 (2017/11/10) dispErrorで表示をコントロール
268                if( dispError ) {
269                        jspPrint( err );
270                }
271
272                if( errCode >= ErrorMessage.NG && stopError ) {
273                        return SKIP_PAGE;
274                }
275                else {
276                        return EVAL_PAGE;
277                }
278        }
279
280        /**
281         * タグリブオブジェクトをリリースします。
282         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
283         *
284         * @og.rev 5.1.8.0 (2010/07/01) isMultiを追加
285         * @og.rev 5.1.9.0 (2010/08/01) Transaction 対応
286         * @og.rev 5.9.26.1 (2017/11/10) dispError追加
287         * @og.rev 8.0.2.0 (2021/11/30) srcDir,classDir static定義定数を使用
288         */
289        @Override
290        protected void release2() {
291                super.release2();
292                command                 = CMD_ENTRY;
293                logics                  = null;
294                dbid                    = null;
295                table                   = null;
296                tableId                 = HybsSystem.TBL_MDL_KEY;
297                selectedAll             = false;
298                modifyType              = null;
299                keys                    = null;
300                vals                    = null;
301                stopError               = true;
302                quotCheck               = HybsSystem.sysBool( "USE_SQL_INJECTION_CHECK" );
303                xssCheck                = HybsSystem.sysBool( "USE_XSS_CHECK" );
304                errMessage              = null;
305                errCode                 = ErrorMessage.OK;
306                executeCount    = -1;
307                arrTable                = null;
308                loader                  = null;
309//              srcDir                  = HybsSystem.sys( "REAL_PATH" ) + HybsSystem.sys( "BIZLOGIC_SRC_PATH" );
310                srcDir                  = SRC_PATH;                                                                                             // 8.0.2.0 (2021/11/30)
311//              classDir                = HybsSystem.sys( "REAL_PATH" ) + HybsSystem.sys( "BIZLOGIC_CLASS_PATH" );
312                classDir                = CLS_PATH;                                                                                             // 8.0.2.0 (2021/11/30)
313                isAutoCompile   = HybsSystem.sysBool( "BIZLOGIC_AUTO_COMPILE" );
314                isHotDeploy             = HybsSystem.sysBool( "BIZLOGIC_HOT_DEPLOY" );
315                isMulti                 = false;                                                                                                // 5.1.8.0 (2010/07/01) 追加
316                dispError               = true;                                                                                                 // 5.9.26.1 (2017/11/10) 追加
317        }
318
319        /**
320         * 業務ロジックを実行します。
321         *
322         * @og.rev 5.1.9.0 (2010/08/01) Transaction 対応
323         * @og.rev 5.3.4.0 (2011/04/01) command=ENTRY以外ではDBTableModelの処理を行わない。
324         * @og.rev 5.3.7.0 (2011/07/01) TransactionReal の引数変更 、Transaction対応で、close処理を入れる。
325         * @og.rev 5.6.0.3 (2012/01/24) arrTable に変更された値を、table に書き戻す処理を追加
326         * @og.rev 6.3.6.1 (2015/08/28) Transaction でAutoCloseableを使用したtry-with-resources構築に対応。
327         * @og.rev 6.3.6.1 (2015/08/28) Transaction でAutoCloseableを使用したtry-with-resources構築に対応。
328         * @og.rev 6.4.3.3 (2016/03/04) Map#forEach で対応する。
329         * @og.rev 6.7.9.1 (2017/05/19) ArrayTableModel を、DataModel I/F に変更
330         */
331        private void execute() {
332
333                // 5.3.4.0 (2011/04/01)
334                if( CMD_ENTRY.equals( command ) ) {
335                        table = (DBTableModel)getObject( tableId );
336                }
337
338                final int[] rowNos;
339                if( table != null ) {
340                        rowNos = getParameterRows();
341                        String[][] tblVals = new String[rowNos.length][table.getColumnCount()];
342                        String[] modTypes = new String[rowNos.length];
343                        for( int i=0; i<rowNos.length; i++ ) {
344                                tblVals[i]  = table.getValues( rowNos[i] );
345                                modTypes[i] = table.getModifyType( rowNos[i] );
346                        }
347                        arrTable = new ArrayTableModel( table.getNames(), tblVals, modTypes );
348                }
349                else {
350                        return;
351                }
352
353                // 5.1.9.0 (2010/08/01) Transaction 対応
354                // 5.3.7.0 (2011/07/01) Transaction対応で、close処理を入れる。
355        //              conn = ConnectionFactory.connection( dbid, null );
356                // 6.3.6.1 (2015/08/28) Transaction でAutoCloseableを使用したtry-with-resources構築に対応。
357                try( Transaction tran = getTransaction() ) {
358                        errMessage = new ErrorMessage();
359                        loader = HybsLoaderFactory.getLoader(
360                                                new HybsLoaderConfig( srcDir, classDir, isAutoCompile, isHotDeploy, CLASS_PATH )
361                                        );
362
363                        boolean rtn = false;
364                        for( int i=0; i<logics.length; i++ ) {
365        //                      BizLogic logic = (BizLogic)loader.newInstance( logics[i] );
366        //                      rtn = call( logic );
367        //                      rtn = call( logics[i] );
368                                rtn = call( logics[i] , tran );                                                                 // 5.1.9.0 (2010/08/01) Transaction 対応
369                                if( !rtn ) { break; }
370                        }
371
372                        // 5.6.0.3 (2012/01/24) arrTable に変更された値を、table に書き戻す処理
373                        // 6.9.7.0 (2018/05/14) PMD These nested if statements could be combined
374//                      if( arrTable != null ) {
375//                              // 6.4.3.3 (2016/03/04) 変更が無い場合は、nulllではなく、空のConcurrentMapを返しましす。
376//                              // 6.7.9.1 (2017/05/19) ArrayTableModel を、DataModel I/F に変更
377//                              if( arrTable instanceof ArrayTableModel ) {
378                        // 6.9.8.0 (2018/05/28) FindBugs:常に true を返す instanceof
379//                      if( arrTable != null && arrTable instanceof ArrayTableModel ) {
380                        if( arrTable != null ) {
381                                // 6.4.3.3 (2016/03/04) 変更が無い場合は、nulllではなく、空のConcurrentMapを返しましす。
382                                // 6.7.9.1 (2017/05/19) ArrayTableModel を、DataModel I/F に変更
383                                        final ConcurrentMap<Integer,String[]> valMap = ((ArrayTableModel)arrTable).getModifyVals();
384                                        valMap.forEach( (seq,vals) -> table.setValues( vals , rowNos[seq] ) );
385//                              }
386
387                                // 8.2.1.1 (2022/07/19) DELETE だけ特別に処置する(論理削除で)
388                                for( int i=0; i<rowNos.length; i++ ) {
389                                        if( DataModel.DELETE_TYPE.equals( arrTable.getModifyType(i) ) ) {
390                                                // 論理削除…後で物理削除している。
391                                                table.rowDelete( rowNos[i] );
392                                        }
393                                }
394                        }
395
396                        executeCount = rowNos.length;
397                        errCode = errMessage.getKekka();
398                        setRequestAttribute( "DB.COUNT"   , String.valueOf( executeCount ) );
399                        setRequestAttribute( "DB.ERR_CODE", String.valueOf( errCode ) );
400
401                        if( errCode < ErrorMessage.NG ) {
402        //                      Closer.commit( conn );
403                                tran.commit();                                                                                                  // 5.1.9.0 (2010/08/01) Transaction 対応
404
405        //                      if( table != null && rowNos.length > 0 ) {
406                                        for( int j=rowNos.length-1; j>=0; j-- ) {
407                                                final int row = rowNos[j];
408                                                if( DBTableModel.DELETE_TYPE.equals( table.getModifyType( row ) ) ) {
409                                                        table.removeValue( row );
410                                                }
411                                                else {
412                                                        table.resetModify( row );
413                                                }
414                                        }
415        //                      }
416                        }
417                        else {
418        //                      Closer.rollback( conn );
419                                tran.rollback();                                                                                                // 5.1.9.0 (2010/08/01) Transaction 対応
420                        }
421        //              ConnectionFactory.close( conn, dbid );
422                }
423
424                // エラーメッセージの行番号を元の選択行に戻します。
425                final ErrMsg[] errs = errMessage.toArray();
426                final ErrorMessage errMsgTmp = new ErrorMessage();
427                for( int i=0; i<errs.length; i++ ) {
428                        if( table != null && rowNos.length > 0 ) {
429                                errMsgTmp.addMessage( errs[i].copy( rowNos[errs[i].getNo()] + 1 ) );
430                        }
431                        else {
432                                errMsgTmp.addMessage( errs[i].copy( errs[i].getNo() + 1 ) );
433                        }
434                }
435                errMessage = errMsgTmp;
436        }
437
438        /**
439         * 業務ロジックをCallします。
440         *
441         * @og.rev 5.1.9.0 (2010/08/01) Transaction 対応
442         * @og.rev 5.1.9.0 (2010/08/01) DBIDをセット、ConnectonではなくTransactionを渡すように変更
443         * @og.rev 5.6.7.0 (2013/07/27) Exception を throw するとき、一旦、errMsg 変数にセットします。
444         * @og.rev 6.7.9.1 (2017/05/19) RETURN を返す変数が、logicName + .RETURN にします。
445         * @og.rev 6.9.9.0 (2018/08/20) 戻り値を返せるようにします。
446         *
447         * @param       logicName       業務ロジック名
448         * @param       tran            ランザクションオブジェクト
449         *
450         * @return      業務ロジックの呼び出しが成功したかどうか
451         */
452        private boolean call( final String logicName , final Transaction tran ) {
453                final BizLogicHelper logicHp = new BizLogicHelper( logicName, loader );
454
455                if( logicHp.isRequireTable() ) {
456                        if( arrTable == null ) {
457                                // 5.6.7.0 (2013/07/27) Exception を throw するとき、一旦、errMsg 変数にセットします。
458                                final String errMsg = "TableModelが存在しません。logic=[" + logicName + "]" ;
459                                throw new HybsSystemException( errMsg );
460                        }
461                        else if( arrTable.getRowCount() == 0 ) { return true; } // 0件のときは呼び出ししない
462                        else { logicHp.setTable( arrTable ); }
463                }
464                logicHp.setTransaction( tran );
465                logicHp.setDbid( dbid );                                                                                                // 5.1.9.0 (2010/08/01) DBIDをセット
466                logicHp.setKeys( keys );
467                logicHp.setVals( vals );
468                logicHp.setUserId( getUser().getUserID() );
469                logicHp.setParentPgId( getGUIInfoAttri( "KEY" ) );
470                logicHp.setLoader( loader );
471                if( isDebug() ) { logicHp.setDebug(); }
472
473                boolean rtn = false;
474                try {
475                        rtn = logicHp.exec();
476                }
477                catch( final Throwable th ) {
478                        tran.rollback();                // 5.1.9.0 (2010/08/01) Transaction 対応
479                        // 5.6.7.0 (2013/07/27) Exception を throw するとき、一旦、errMsg 変数にセットします。
480                        final String errMsg = "業務ロジックの処理中にエラーが発生しました。" + th.getMessage() ;
481                        throw new HybsSystemException( errMsg,th );
482                }
483                errMessage.append( logicHp.getErrMsg() );
484
485                // 6.7.9.1 (2017/05/19) RETURN を返す変数が、logicName + .RETURN にします。
486                // 現状は、BizLogicHelper.RETURN なので、本来は、分けて使いたかったはずなので。
487                setRequestAttribute( logicName + ".RETURN"   , logicHp.getReturn() );
488                setRequestAttribute( "RETURN", logicHp.getReturn() );
489
490                // 6.9.9.0 (2018/08/20) 戻り値を返せるようにします。
491                final Map<String,String> rtnMap = logicHp.getReturnMap();
492                if( rtnMap != null ) {
493                        rtnMap.forEach( (k,v) -> setRequestAttribute( k,v ) );
494                }
495
496                if( isDebug() ) { jspPrint( logicHp.getDebugMsg() ); }
497
498                return rtn;
499        }
500
501        /**
502         * Valsの配列を生成します。
503         *
504         * @og.rev 5.1.8.0 (2010/07/01) 新規作成-
505         * @og.rev 5.6.7.0 (2013/07/27) Exception を throw するとき、一旦、errMsg 変数にセットします。
506         */
507        private void makeVals() {
508                if( keys != null && keys.length > 0 ) {
509                        final boolean isSetVal = vals != null && vals.length > 0 ;
510                        if( isSetVal ) {
511                                if( keys.length != vals.length ) {
512                                        // 5.6.7.0 (2013/07/27) Exception を throw するとき、一旦、errMsg 変数にセットします。
513                                        final String errMsg = "keysとValsの個数が異なります。"  + CR
514                                                                + "  keys=" + Arrays.toString( keys ) + CR
515                                                                + "  vals=" + Arrays.toString( vals ) ;
516                                        throw new HybsSystemException( errMsg );
517                                }
518                        }
519                        else {
520                                vals = new String[keys.length];
521                        }
522                        for( int i=0; i<keys.length; i++ ) {
523                                if( isSetVal ) {
524                                        if( isMulti )   { vals[i] = StringUtil.array2csv( getRequestParameterValues( vals[i] ) );}
525                                        else                    { vals[i] = getRequestParameter( vals[i] ); }
526                                }
527                                else {
528                                        if( isMulti )   { vals[i] = StringUtil.array2csv( getRequestValues( keys[i] ) );}
529                                        else                    { vals[i] = getRequestValue( keys[i] ); }
530                                }
531                        }
532                }
533        }
534
535        /**
536         * 【TAG】コマンドをセットします(初期値:ENTRY)。
537         *
538         * @og.tag
539         * command=ENTRY以外ではDBTableModelの処理を行いません。
540         * コマンドは、HTMLから[get/post]指定されますので、CMD_xxx で設定される
541         * フィールド定数値のいづれかを、指定できます。
542         *
543         * @param       cmd     コマンド (public static final 宣言されている文字列)
544         * @see         <a href="../../../../constant-values.html#org.opengion.hayabusa.taglib.BizLogicTag.CMD_ENTRY">コマンド定数</a>
545         */
546        public void setCommand( final String cmd ) {
547                final String cmd2 = getRequestParameter( cmd );
548                if( cmd2 != null && cmd2.length() >= 0 ) { command = cmd2.toUpperCase(Locale.JAPAN); }
549        }
550
551        /**
552         * 【TAG】実行する業務ロジック名を指定します。
553         *
554         * @og.tag
555         * 実行する業務ロジック名を指定します。業務ロジック名は、クラス名を指定します。
556         * クラス名については、クラス自身の名称のみを指定することができます。
557         * (パッケージ名を含めた完全な形のクラス名を指定することもできます)
558         * また、CSV形式で、複数指定することもできます。
559         * この場合、指定した順番に処理されます。
560         *
561         * @param       lgs     業務ロジック名
562         */
563        public void setLogics( final String lgs ) {
564                logics = getCSVParameter( lgs );
565        }
566
567        /**
568         * 【TAG】(通常は使いません)Queryオブジェクトを作成する時のDB接続IDを指定します(初期値:null)。
569         *
570         * @og.tag
571         * Queryオブジェクトを作成する時のDB接続IDを指定します。
572         * これは、システムリソースで、DEFAULT_DB_URL 等で指定している データベース接続先
573         * 情報に、XX_DB_URL を定義することで、 dbid="XX" とすると、この 接続先を使用して
574         * データベースにアクセスできます。
575         *
576         * @param       id      データベース接続ID
577         */
578        public void setDbid( final String id ) {
579                dbid = nval( getRequestParameter( id ),dbid );
580        }
581
582        /**
583         * 【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します
584         *              (初期値:HybsSystem#TBL_MDL_KEY[={@og.value HybsSystem#TBL_MDL_KEY}])。
585         *
586         * @og.tag
587         * 検索結果より、DBTableModelオブジェクトを作成します。これを、下流のviewタグ等に
588         * 渡す場合に、通常は、session を利用します。その場合の登録キーです。
589         * query タグを同時に実行して、結果を求める場合、同一メモリに配置される為、
590         * この tableId 属性を利用して、メモリ空間を分けます。
591         * (初期値:HybsSystem#TBL_MDL_KEY[={@og.value HybsSystem#TBL_MDL_KEY}])。
592         *
593         * @param       id      テーブルID (sessionに登録する時のID)
594         */
595        public void setTableId( final String id ) {
596                tableId = nval( getRequestParameter( id ),tableId );
597        }
598
599        /**
600         * 【TAG】データを全件選択済みとして処理するかどうか[true/false]を指定します(初期値:false)。
601         *
602         * @og.tag
603         * 全てのデータを選択済みデータとして扱って処理します。
604         * 全件処理する場合に、(true/false)を指定します。
605         * 初期値は false です。
606         *
607         * @param       all     データを全件選択済み [true:全件選択済み/false:通常]
608         */
609        public void setSelectedAll( final String all ) {
610                selectedAll = nval( getRequestParameter( all ),selectedAll );
611        }
612
613        /**
614         * 【TAG】DB検索時の モディファイタイプを指定します[A:追加/C:更新/D:削除]。
615         *
616         * @og.tag
617         * DB検索時に、そのデータをA(追加)、C(更新)、D(削除)のモディファイタイプを
618         * つけた状態にします。
619         * その状態で、そのまま、update する事が可能になります。
620         *
621         * @param       type    モディファイタイプ [A:追加/C:更新/D:削除]
622         */
623        public void setModifyType( final String type ) {
624                modifyType = nval( getRequestParameter( type ),modifyType );
625        }
626
627        /**
628         * 【TAG】リンク先に渡すキーをCSV形式で複数指定します。
629         *
630         * @og.tag
631         * リンク先に渡すキーを指定します。
632         * Keysだけを指定して、Valsを指定しない場合、Keysで指定された項目名に対応するパラメーターを取得し、
633         * Valsとして使用します。
634         *
635         * @og.rev 3.5.6.2 (2004/07/05) CommonTagSupport#getCSVParameter を使用
636         *
637         * @param       key     リンク先に渡すキー(CSV形式)
638         */
639        public void setKeys( final String key ) {
640                keys = getCSVParameter( getRequestParameter( key ) );
641        }
642
643        /**
644         * 【TAG】リンク先に渡す値をCSV形式で複数指定します。
645         *
646         * @og.tag
647         * リンク先に渡す値を指定します。
648         * Keysだけを指定して、Valsを指定しない場合、Keysで指定された項目名に対応するパラメーターを取得し、
649         * Valsとして使用します。
650         * 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。
651         * こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。
652         *
653         * @og.rev 3.5.6.2 (2004/07/05) CommonTagSupport#getCSVParameter を使用
654         * @og.rev 5.1.8.0 (2010/07/01) isMuitl対応
655         *
656         * @param       val     リンク先に渡す値(CSV形式)
657         */
658        public void setVals( final String val ) {
659                vals = StringUtil.csv2Array( val );
660        }
661
662        /**
663         * 【TAG】処理エラーの時に処理を中止するかどうか[true/false]を設定します(初期値:true)。
664         *
665         * @og.tag
666         * false(中止しない)に設定する場合、後続処理では、{&#064;DB.ERR_CODE}の値により、
667         * PLSQL/SQLの異常/正常終了によって分岐処理は可能となります。
668         * 初期値は、true(中止する)です。
669         *
670         * @param       flag    処理の中止 [true:中止する/false:中止しない]
671         */
672        public void setStopError( final String flag ) {
673                stopError = nval( getRequestParameter( flag ),stopError );
674        }
675
676        /**
677         * 【TAG】PLSQL/SQL処理エラーの時にエラーを画面表示するか[true/false]を設定します(初期値:true)。
678         *
679         * @og.tag
680         * false(表示しない)に設定する場合、後続処理では、{&#064;DB.ERR_MSG}の値により、
681         * 本来表示されるはずだったメッセージを取得可能です。
682         * stopErrorと併用して、JSON形式でエラーを返す場合等に利用します。
683         * 初期値は、true(表示する)です。
684         *
685         * @og.rev 5.9.26.1 (2017/11/10) 新規追加
686         *
687         * @param       flag    [true:表示する/false:表示しない]
688         */
689        public void setDispError( final String flag ) {
690                dispError = nval( getRequestParameter( flag ),dispError );
691        }
692
693        /**
694         * 【TAG】リクエスト情報の シングルクォート(') 存在チェックを実施するかどうか[true/false]を設定します
695         *              (初期値:USE_SQL_INJECTION_CHECK[={@og.value SystemData#USE_SQL_INJECTION_CHECK}])。
696         *
697         * @og.tag
698         * SQLインジェクション対策の一つとして、暫定的ではありますが、SQLのパラメータに
699         * 渡す文字列にシングルクォート(') を許さない設定にすれば、ある程度は防止できます。
700         * 数字タイプの引数には、 or 5=5 などのシングルクォートを使用しないコードを埋めても、
701         * 数字チェックで検出可能です。文字タイプの場合は、必ず (')をはずして、
702         * ' or 'A' like 'A のような形式になる為、(')チェックだけでも有効です。
703         * (') が含まれていたエラーにする(true)/かノーチェックか(false)を指定します。
704         * (初期値:システム定数のUSE_SQL_INJECTION_CHECK[={@og.value SystemData#USE_SQL_INJECTION_CHECK}])。
705         *
706         * @param       flag    クォートチェック [true:する/それ以外:しない]
707         * @see         org.opengion.hayabusa.common.SystemData#USE_SQL_INJECTION_CHECK
708         */
709        public void setQuotCheck( final String flag ) {
710                quotCheck = nval( getRequestParameter( flag ),quotCheck );
711        }
712
713        /**
714         * 【TAG】リクエスト情報の HTMLTag開始/終了文字(&gt;&lt;) 存在チェックを実施するかどうか[true/false]を設定します
715         *              (初期値:USE_XSS_CHECK[={@og.value SystemData#USE_XSS_CHECK}])。
716         *
717         * @og.tag
718         * クロスサイトスクリプティング(XSS)対策の一環としてless/greater than signについてのチェックを行います。
719         * (&gt;&lt;) が含まれていたエラーにする(true)/かノーチェックか(false)を指定します。
720         * (初期値:システム定数のUSE_XSS_CHECK[={@og.value SystemData#USE_XSS_CHECK}])。
721         *
722         * @param       flag    XSSチェックする [true:チェックする/false:しない]
723         * @see         org.opengion.hayabusa.common.SystemData#USE_XSS_CHECK
724         */
725        public void setXssCheck( final String flag ) {
726                xssCheck = nval( getRequestParameter( flag ),xssCheck );
727        }
728
729        /**
730         * 【TAG】vals属性でパラメーターを取得する際、複数件存在する場合に、値を連結するかどうかを指定します(初期値:false)。
731         *
732         * @og.tag
733         * この属性がtrueに指定された場合、パラメーターが複数存在する場合に、カンマで連結します。
734         * 初期値は、false(連結しない)です。
735         *
736         * @og.rev 5.1.8.0 (2010/07/01) 新規作成
737         *
738         * @param       flag    値連結 [true:する/false:しない]
739         */
740        public void setMulti( final String flag ) {
741                isMulti = nval( getRequestParameter( flag ),isMulti );
742        }
743
744        /**
745         * 表示データの HybsSystem.ROW_SEL_KEY を元に、選ばれた 行を処理の対象とします。
746         *
747         * @return      選択行の配列
748         */
749        @Override
750        protected int[] getParameterRows() {
751                final int[] rowNo ;
752                if( selectedAll ) {
753                        final int rowCnt = table.getRowCount();
754                        rowNo = new int[ rowCnt ];
755                        for( int i=0; i<rowCnt; i++ ) {
756                                rowNo[i] = i;
757                        }
758                } else {
759                        rowNo = super.getParameterRows();
760                }
761                return rowNo ;
762        }
763
764        /**
765         * このオブジェクトの文字列表現を返します。
766         * 基本的にデバッグ目的に使用します。
767         *
768         * @return このクラスの文字列表現
769         * @og.rtnNotNull
770         */
771        @Override
772        public String toString() {
773                return ToString.title( this.getClass().getName() )
774                                .println( "VERSION"                     ,VERSION                )
775                                .println( "command"                     ,command                )
776                                .println( "logics"                      ,logics                 )
777                                .println( "dbid"                        ,dbid                   )
778                                .println( "tableId"                     ,tableId                )
779                                .println( "selectedAll"         ,selectedAll    )
780                                .println( "modifyType"          ,modifyType             )
781                                .println( "keys"                        ,keys                   )
782                                .println( "vals"                        ,vals                   )
783                                .println( "stopError"           ,stopError              )
784                                .println( "quotCheck"           ,quotCheck              )
785                                .println( "xssCheck"            ,xssCheck               )
786                                .println( "executeCount"        ,executeCount   )
787                                .println( "errCode"                     ,errCode                )
788                                .println( "Other..."            ,getAttributes().getAttribute() )
789                                .fixForm().toString() ;
790        }
791}