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.DBConstValue;
021import org.opengion.fukurou.util.StringUtil ;
022import org.opengion.fukurou.util.ToString;                                              // 6.1.1.0 (2015/01/17)
023
024import static org.opengion.fukurou.util.StringUtil.nval ;
025
026import java.util.Map;
027import java.util.LinkedHashMap;
028import java.util.Locale ;                                                                               // 6.4.1.2 (2016/01/22)
029
030/**
031 * TableUpdateTag にパラメーターを渡す為のタグクラスです。
032 *
033 * 汎用的なデータベース登録処理を行えるタグ tableUpdate タグを新規作成します。
034 * これは、具体的なSLQを作成する tableUpdateParam タグと組み合わせて使用できます。
035 * tableUpdate タグは、queryType に JDBCTableUpdate を指定します。基本的にこれだけ
036 * です。tableUpdateParam では、sqlType に、INSERT,COPY,UPDATE,MODIFY,DELETE の
037 * どれかを指定する事で、SQL文のタイプを指定します。COPY,MODIFY は command と
038 * 関連を持たす為に追加しているタイプで、INSERTやUPDATE と同じ処理を行います。
039 * tableUpdateParam の table には、作成したい SQL のテーブルを指定します。
040 * where 属性は、検索結果の DBTableModel の更新時に使用する条件を指定します。
041 *
042 * @og.formSample
043 * ●形式:<og:tableUpdate command="{@command}" queryType="JDBCTableUpdate" >
044 *            <og:tableUpdateParam
045 *                sqlType       = "{@sqlType}"       // INSERT,COPY,UPDATE,MODIFY,DELETE
046 *                table         = "{@TABLE_NAME}"    // 処理対象のテーブル名
047 *                names         = "{@names}"         // 処理対象のカラム名
048 *                omitNames     = "{@omitNames}"     // 処理対象外のカラム名
049 *                where         = "{@where}"         // 処理対象を特定するキー
050 *                whereNames    = "{@whereNames}"    // 処理対象を特定するキー条件(where句)をCSV形式
051 *                constKeys     = "{@constKeys}"     // 処理カラム名の中の固定情報カラム名
052 *                constVals     = "{@constVals}"     // 処理カラム名の中の固定情報設定値
053 *                asNames       = "{@asNames}"       // 別名を付けたカラム名(select A as B from TBL の B を指定)
054 *                orgNames      = "{@orgNames}"      // tableの実際のカラム名(select A as B from TBL の A を指定)
055 *                funcKeys      = "{@funcKeys}"      // 関数等を設定するカラム名
056 *                funcVals      = "{@funcVals}"      // 関数等の設定値
057 *                logicalDelete = "{@logicalDelete}" // sqlTypeがDELETEの場合にもUPDATE文を発行
058 *            />
059 *         </og:tableUpdate>
060 *
061 * ●body:なし
062 *
063 * ●Tag定義:
064 *   <og:tableUpdateParam
065 *       sqlType          ○【TAG】BODY部に書かれている SQLタイプを指定します(必須)
066 *       table            ○【TAG】処理対象のテーブル名を指定します(必須)
067 *       names              【TAG】処理対象のカラム名をCSV形式で複数指定します
068 *       omitNames          【TAG】処理対象外のカラム名をCSV形式で複数指定します
069 *       where              【TAG】処理対象を特定するキー条件(where句)を指定します
070 *       whereNames         【TAG】処理対象を特定するキー条件(where句)をCSV形式で複数指定します
071 *       constKeys          【TAG】設定値を固定値と置き換える対象となるカラム名をCSV形式で複数指定します
072 *       constVals          【TAG】設定値を固定値と置き換える対象となる設定値をCSV形式で複数指定します
073 *       funcKeys           【TAG】関数等を設定するカラム名をCSV形式で複数指定します
074 *       funcVals           【TAG】関数等の設定値をCSV形式で複数指定します
075 *       asNames            【TAG】別名を付けたカラム名(select A as B from TBL の B を指定)をCSV形式で複数指定します
076 *       orgNames           【TAG】tableの実際のカラム名(select A as B from TBL の A を指定)をCSV形式で複数指定します
077 *       quotCheck          【TAG】リクエスト情報の シングルクォート(') 存在チェックを実施するかどうか[true/false]を設定します (初期値:USE_SQL_INJECTION_CHECK[=true])
078 *       constObjKey        【TAG】固定情報カラムの処理オブジェクトを特定するキーを設定します(初期値:SYSTEM_ID)
079 *       logicalDelete      【TAG】sqlType="DELETE"の場合に論理削除(UPDATE)を行うかどうかを指定します(初期値:false)
080 *       caseKey            【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null)
081 *       caseVal            【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null)
082 *       caseNN             【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:判定しない)
083 *       caseNull           【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:判定しない)
084 *       caseIf             【TAG】指定の値が、true/TRUE文字列の場合は、このタグは使用されます(初期値:判定しない)
085 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
086 *   />
087 *
088 * ●使用例
089 *    ・【entry.jsp】
090 *         <og:tableUpdate command="{@command}" queryType="JDBCTableUpdate" >
091 *            <og:tableUpdateParam
092 *               sqlType  = "{@sqlType}"
093 *               table    = "{@MEM.TABLE_NAME}"
094 *               where    = "ROWID = [ROWID]"
095 *            />
096 *         </og:tableUpdate>
097 *
098 * @og.rev 3.8.8.0 (2007/12/22) 新規作成
099 * @og.rev 4.1.2.0 (2008/03/12) 実装の大幅な修正
100 * @og.group DB登録
101 *
102 * @version  4.0
103 * @author   Kazuhiko Hasegawa
104 * @since    JDK5.0,
105 */
106public class TableUpdateParamTag extends CommonTagSupport {
107        /** このプログラムのVERSION文字列を設定します。   {@value} */
108        private static final String VERSION = "6.4.2.0 (2016/01/29)" ;
109        private static final long serialVersionUID = 642020160129L ;
110
111        /** sqlType属性に設定できる値                    {@value} */
112        public static final String SQL_TYPE  = "|INSERT|COPY|UPDATE|MODIFY|DELETE|" ;
113
114        // 3.8.0.4 (2005/08/08) 印刷時に使用するシステムID
115        private static final String SYSTEM_ID =HybsSystem.sys( "SYSTEM_ID" );
116
117        // 4.3.6.0 (2009/05/01) デフォルトで利用するconstObjのシステムリソース名
118        private static final String DEFAULT_CONST_OBJ = HybsSystem.sys( "DEFAULT_CONST_CLASS" );
119
120        private String          sqlType         ;                               // INSERT,COPY,UPDATE,MODIFY,DELETE
121        private String          table           ;                               // 処理対象のテーブル名
122        private String[]        names           ;                               // 処理対象のカラム名
123        private String          omitNames       = ",ROWID,ROWNUM,WRITABLE,";            // 処理対象外のカラム名
124        private String          where           ;                               // 処理対象を特定するキー
125        private String          whereNames      ;                               // 5.5.8.5 (2012/11/27) 処理対象を特定するCSV形式のカラム名
126        private String[]        constKeys       ;                               // 処理カラム名の中の固定情報カラム名
127        private String[]        constVals       ;                               // 処理カラム名の中の固定情報設定値
128        private String[]        funcKeys        ;                               // 5.5.1.9 (2012/04/19) 関数等を設定するカラム名
129        private String[]        funcVals        ;                               // 5.5.1.9 (2012/04/19) 関数等の設定値
130        private String[]        asNames         ;                               // 5.5.1.9 (2012/04/19) 別名を付けたカラム名(select A as B from TBL の B を指定)
131        private String[]        orgNames        ;                               // 5.5.1.9 (2012/04/19) tableの実際のカラム名(select A as B from TBL の A を指定)
132        private String          constObjKey     = SYSTEM_ID;    // 固定情報カラムの処理オブジェクトを特定するキー
133        private boolean         quotCheck       = HybsSystem.sysBool( "USE_SQL_INJECTION_CHECK" );
134        private boolean         logicalDelete;                          // 4.3.7.0 (2009/06/01) sqlTypeがDELETEの場合にもUPDATE文を発行
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 TableUpdateParamTag() { super(); }               // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
142
143        /**
144         * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
145         *
146         * @og.rev 5.5.1.9 (2012/04/19) エラーチェックを先に行います。
147         * @og.rev 6.3.4.0 (2015/08/01) caseKey,caseVal,caseNN,caseNull,caseIf 属性対応
148         *
149         * @return      後続処理の指示( SKIP_BODY )
150         */
151        @Override
152        public int doStartTag() {
153                if( !useTag() ) { return SKIP_BODY ; }  // 6.3.4.0 (2015/08/01)
154
155                // constKeys,constVals の個数チェック
156                if( constKeys != null ) {
157                        if( constVals == null || constKeys.length != constVals.length ) {
158                                final String errMsg = "<b>constKeys と、constVals の個数が異なります。</b><br />"
159                                                                        + " constKeys=[" + StringUtil.array2csv( constKeys ) + "]"
160                                                                        + " constVals=[" + StringUtil.array2csv( constVals ) + "]" ;
161                                throw new HybsSystemException( errMsg );
162                        }
163                }
164
165                // funcKeys,funcVals の個数チェック
166                if( funcKeys != null ) {
167                        if( funcVals == null || funcKeys.length != funcVals.length ) {
168                                final String errMsg = "<b>funcKeys と、funcVals の個数が異なります。</b><br />"
169                                                                        + " funcKeys=[" + StringUtil.array2csv( funcKeys ) + "]"
170                                                                        + " funcVals=[" + StringUtil.array2csv( funcVals ) + "]" ;
171                                throw new HybsSystemException( errMsg );
172                        }
173                }
174
175                // asNames,orgNames の個数チェック
176                if( orgNames != null ) {
177                        if( asNames == null || orgNames.length != asNames.length ) {
178                                final String errMsg = "<b>orgNames と、asNames の個数が異なります。</b><br />"
179                                                                        + " orgNames=[" + StringUtil.array2csv( orgNames ) + "]"
180                                                                        + " asNames=[" + StringUtil.array2csv( asNames ) + "]" ;
181                                throw new HybsSystemException( errMsg );
182                        }
183                }
184
185                return SKIP_BODY ;                              // Body を評価しない
186        }
187
188        /**
189         * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
190         *
191         * @og.rev 4.3.7.0 (2009/06/01) 論理削除対応
192         * @og.rev 6.3.4.0 (2015/08/01) caseKey,caseVal,caseNN,caseNull,caseIf 属性対応
193         *
194         * @return      後続処理の指示
195         */
196        @Override
197        public int doEndTag() {
198                debugPrint();
199                if( !useTag() ) { return EVAL_PAGE ; }  // 6.3.4.0 (2015/08/01)
200
201                final TableUpdateTag updateTag = (TableUpdateTag)findAncestorWithClass( this,TableUpdateTag.class );
202                if( updateTag == null ) {
203                        final String errMsg = "<b>" + getTagName() + "タグは、TableUpdateTagの内側(要素)に記述してください。</b>";
204                        throw new HybsSystemException( errMsg );
205                }
206
207                final String upSqlType = updateTag.getSqlType() ;
208                if( upSqlType == null || upSqlType.equals( sqlType ) ) {
209                        // 通常の names カラム配列を設定します。
210                        if( names == null ) { names = updateTag.getNames(); }
211                        final NamesData namesData = makeNamesData( names );
212
213                        String query = null;
214                        if( "INSERT".equalsIgnoreCase( sqlType ) || "COPY".equalsIgnoreCase( sqlType ) ) {
215                                query = getInsertSQL( namesData );
216                        }
217                        else if( "UPDATE".equalsIgnoreCase( sqlType ) || "MODIFY".equalsIgnoreCase( sqlType )
218                                        || ( "DELETE".equalsIgnoreCase( sqlType ) && logicalDelete ) ) { // 4.3.7.0 (2009/06/01)
219                                query = getUpdateSQL( namesData );
220                        }
221                        else if( "DELETE".equalsIgnoreCase( sqlType ) ) {
222                                query = getDeleteSQL();
223                        }
224
225                        jspPrint( query );
226                }
227
228                return EVAL_PAGE ;
229        }
230
231        /**
232         * タグリブオブジェクトをリリースします。
233         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
234         *
235         * @og.rev 4.3.7.0 (2009/06/01) logicalDelete属性追加
236         * @og.rev 5.5.1.9 (2012/04/19) asNames、orgNames、funcKeys、funcVals属性追加
237         * @og.rev 5.5.8.5 (2012/11/27) 処理対象を特定するCSV形式のカラム名
238         */
239        @Override
240        protected void release2() {
241                super.release2();                       // 3.5.6.0 (2004/06/18) 追加(抜けていた)
242                sqlType         = null;                 // INSERT,COPY,UPDATE,MODIFY,DELETE
243                table           = null;                 // 処理対象のテーブル名
244                names           = null;                 // 処理対象のカラム名
245                omitNames       = ",ROWID,ROWNUM,WRITABLE,";            // 処理対象外のカラム名
246                where           = null;                 // 処理対象を特定するキー
247                whereNames      = null;                 // 5.5.8.5 (2012/11/27) 処理対象を特定するCSV形式のカラム名
248                constKeys       = null;                 // 処理カラム名の中の固定情報カラム名
249                constVals       = null;                 // 処理カラム名の中の固定情報設定値
250                quotCheck       = HybsSystem.sysBool( "USE_SQL_INJECTION_CHECK" );
251                constObjKey     = SYSTEM_ID;    // 固定情報カラムの処理オブジェクトを特定するキー
252                logicalDelete = false;          // 4.3.7.0 (2009/06/01)
253                funcKeys        = null;                 // 5.5.1.9 (2012/04/19) 関数等を設定するカラム名
254                funcVals        = null;                 // 5.5.1.9 (2012/04/19) 関数等の設定値
255                asNames         = null;                 // 5.5.1.9 (2012/04/19) 別名を付けたカラム名(select A as B from TBL の B を指定)
256                orgNames        = null;                 // 5.5.1.9 (2012/04/19) tableの実際のカラム名(select A as B from TBL の A を指定)
257        }
258
259        /**
260         * 【TAG】BODY部に書かれている SQLタイプを指定します。
261         *
262         * @og.tag
263         * SQLタイプは、INSERT,COPY,UPDATE,MODIFY,DELETE の中から指定する
264         * 必要があります。これらは、内部に書かれるSQLの形式を指定するのに使用します。
265         * 内部処理は、DBTableModelの改廃コード(A,C,D)に対して使用される
266         * SQL を選択する場合の情報に使用されます。
267         * なお、COPY と MODIFY は、command で指定できる簡易機能として用意しています。
268         * 上位の TableUpdateTag の sqlType 属性 と同じsqlType 属性の場合のみ、SQL文を
269         * 合成・出力します。(上位のsqlTypeがnullの場合は、無条件実行します。)
270         * 指定のタイプが、異なる場合は、なにも処理を行いません。
271         *
272         * @param       type SQLタイプ [INSERT/COPY/UPDATE/MODIFY/DELETE]
273         */
274        public void setSqlType( final String type ) {
275                sqlType = nval( getRequestParameter( type ),sqlType );
276                if( sqlType != null && SQL_TYPE.indexOf( "|" + sqlType + "|" ) < 0 ) {
277                        sqlType = null;
278        //      final String errMsg = "sqlType属性には、" + SQL_TYPE + "以外設定できません。"
279        //                                      + " typeIn=[" + type + "]"
280        //                                      + " sqlType=[" + sqlType + "]" ;
281        //              throw new HybsSystemException( errMsg );
282                }
283        }
284
285        /**
286         * 【TAG】処理対象のテーブル名を指定します。
287         *
288         * @og.tag
289         * テーブル名を指定することで、sqlTypeに応じた QUERYを生成することが出来ます。
290         * 生成する場合のカラムを特定する場合は、names 属性で指定できます。
291         * また、WHERE条件は、where属性で指定します。
292         *
293         * @param       tbl テーブル名
294         * @see         #setNames( String )
295         * @see         #setWhere( String )
296         * @see         #setSqlType( String )
297         */
298        public void setTable( final String tbl ) {
299                table = nval( getRequestParameter( tbl ),table );
300        }
301
302        /**
303         * 【TAG】処理対象のカラム名をCSV形式で複数指定します。
304         *
305         * @og.tag
306         * 生成するQUERYのカラム名をCSV形式(CSV)で複数指定します。
307         * 指定がない場合は、DBTableModel の全カラム(※)を使用して、QUERYを構築します。
308         * 一般に、テーブル結合してDBTableModelを構築した場合は、登録すべきカラムを
309         * 指定する必要があります。
310         * (※)正確には、DBTableModel の全カラムのうち、ROWID,ROWNUM,WRITABLE カラムは
311         * 無視します。
312         * 分解方法は、通常のパラメータ取得後に、CSV分解します。
313         *
314         * @og.rev 3.8.8.5 (2007/03/09) 通常のパラメータ取得後に、CSV分解に戻します。
315         *
316         * @param       nms カラム名 (CSV形式)
317         * @see         #setTable( String )
318         * @see         #setOmitNames( String )
319         */
320        public void setNames( final String nms ) {
321                names = StringUtil.csv2Array( getRequestParameter( nms ) );
322                if( names.length == 0 ) { names = null; }
323        }
324
325        /**
326         * 【TAG】処理対象外のカラム名をCSV形式で複数指定します。
327         *
328         * @og.tag
329         * 生成するQUERYのカラム名に指定しないカラム名をCSV形式(CSV)で複数指定します。
330         * 指定がない場合は、DBTableModel の全カラム(※)を使用して、QUERYを構築します。
331         * テーブル結合などで、処理したくないカラム数の方が少ない場合に、names ですべてを
332         * 指定するより少ない記述ですみます。
333         * (※)正確には、DBTableModel の全カラムのうち、ROWID,ROWNUM,WRITABLE カラムは
334         * 無視します。
335         *
336         * @param       nms カラム名 (CSV形式)
337         * @see         #setTable( String )
338         * @see         #setNames( String )
339         */
340        public void setOmitNames( final String nms ) {
341                omitNames = omitNames + nval( getRequestParameter( nms ),"" ) + ",";
342        }
343
344        /**
345         * 【TAG】処理対象を特定するキー条件(where句)を指定します。
346         *
347         * @og.tag
348         * 生成するQUERYのwhere 句を指定します。通常の WHERE 句の書き方と同じで、
349         * DBTableModelの値を割り当てたい箇所に[カラム名] を記述します。
350         * 文字列の場合、設定値をセットするときに、シングルコーテーションを
351         * 使用しますが、[カラム名]で指定する場合は、その前後に、(')シングル
352         * コーテーションは、不要です。
353         * {&#064;XXXX}変数を使用する場合は、パース時に固定文字に置き換えられる為、
354         * 文字列指定時の(')シングルコーテーションが必要になります。
355         * ※ 5.5.8.5 (2012/11/27) whereNames 属性と併用した場合は、where が、and を付けて、文字列結合されます。
356         * 例:FGJ='1' and CLM=[CLM] and SYSTEM_ID in ([SYSID],'**') and KBSAKU='{&#064;KBSAKU}'
357         *
358         * @param       wr 検索条件 (where句)
359         */
360        public void setWhere( final String wr ) {
361                where = nval( getRequestParameter( wr ),where );
362        }
363
364        /**
365         * 【TAG】処理対象を特定するキー条件(where句)をCSV形式で複数指定します。
366         *
367         * @og.tag
368         * 生成するQUERYのwhere 句を指定する方法として、複数のカラム名をCSV指定し、内部で
369         * KEY=[KEY] 文字列を作成します。
370         * ここでは、カラム名は、データベースのカラム名と同じで、かつ、DBTableModel にも
371         * 同じカラムのデータが存在していること、という条件付きとします。
372         * また、where 条件との併用を行いますが、こちらの条件が先に使用され、where 条件は、
373         * and を付けて、文字列結合されます。
374         * 例: CLM,SYSTEM_ID,KBSAKU   ⇒   CLM=[CLM] and SYSTEM_ID=[SYSTEM_ID] and KBSAKU=[KBSAKU]
375         *
376         * @og.rev 5.5.8.5 (2012/11/27) 新規追加
377         *
378         * @param       wrnm 検索条件カラム (where句)作成のためのカラム名(CSV形式)
379         */
380        public void setWhereNames( final String wrnm ) {
381                whereNames = nval( getRequestParameter( wrnm ),whereNames );
382        }
383
384        /**
385         * 【TAG】設定値を固定値と置き換える対象となるカラム名をCSV形式で複数指定します。
386         *
387         * @og.tag
388         * names 属性のカラムや table 属性より、QUERYを作成して、DBTableModelの値を
389         * 割り当てる場合、DBTableModelの値ではなく、外部から指定した固定値を
390         * 割り当てたい場合に、そのカラム名をCSV形式(CSV)で複数指定します。
391         * 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。
392         * こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。
393         *
394         * @param       keys 固定値カラム (CSV形式)
395         * @see         #setConstVals( String )
396         */
397        public void setConstKeys( final String keys ) {
398                constKeys = getCSVParameter( keys );
399        }
400
401        /**
402         * 【TAG】設定値を固定値と置き換える対象となる設定値をCSV形式で複数指定します。
403         *
404         * @og.tag
405         * names 属性のカラムや table 属性より、QUERYを作成して、DBTableModelの
406         * 値を割り当てる場合、DBTableModelの値ではなく、外部から指定した固定値を
407         * 割り当てたい場合に、そのカラム名に対応する設定値をCSV形式(CSV)で
408         * 複数指定します。ここで指定する設定値は、constKeys 属性と対応させます。
409         * 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。
410         * こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。
411         *
412         * @param       vals 設定値(CSV形式)
413         * @see         #setConstKeys( String )
414         */
415        public void setConstVals( final String vals ) {
416                constVals = getCSVParameter( vals );
417        }
418
419        /**
420         * 【TAG】関数等を設定するカラム名をCSV形式で複数指定します。
421         *
422         * @og.tag
423         * constVals 属性で設定する値は、必ずシングルクオートが付与されます。
424         * その場合、関数などを設定したい場合でも、文字列として設定しようとします。
425         * ここで指定するカラム名(funcKeys)自身は、constKeys と同じ書式です。
426         * 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。
427         * こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。
428         *
429         * @og.rev 5.5.1.9 (2012/04/19) 新規追加
430         *
431         * @param       keys 関数カラム (CSV形式)
432         * @see         #setFuncVals( String )
433         */
434        public void setFuncKeys( final String keys ) {
435                funcKeys = getCSVParameter( keys );
436        }
437
438        /**
439         * 【TAG】関数等の設定値をCSV形式で複数指定します。
440         *
441         * @og.tag
442         * funcKeys 属性に対応する 関数などの設定値を割り当てます。
443         * constVals 属性との違いは、funcVals の設定値は、そのままの形で、SQL文の
444         * 構築に使われます。
445         * 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。
446         * こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。
447         *
448         * @og.rev 5.5.1.9 (2012/04/19) 新規追加
449         *
450         * @param       vals 関数設定値 (CSV形式)
451         * @see         #setFuncKeys( String )
452         */
453        public void setFuncVals( final String vals ) {
454                funcVals = getCSVParameter( vals );
455        }
456
457        /**
458         * 【TAG】別名を付けたカラム名(select A as B from TBL の B を指定)をCSV形式で複数指定します。
459         *
460         * @og.tag
461         * SELECT 文を記述したとき、別名を付けていたり、SELECTしたテーブルと別のテーブルに
462         * DBTableModelの値を書き込む場合、DBTableModel の持っているカラム名と、実際に
463         * 書き込むカラム名が異なります。そのようなケースに、元の別名カラムを指定します。
464         * orgNames属性の並び順と、asNames属性の並び順を合わせておく必要があります。
465         * このカラム名は、DBTableModel には持っているが、テーブル側には持っていない値
466         * なので、内部的に omitNames 属性に値を設定します。利用者は、omitNames に
467         * 書き込む必要はありません。
468         * 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。
469         * こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。
470         *
471         * @og.rev 5.5.1.9 (2012/04/19) 新規追加
472         *
473         * @param       keys 別名カラム (CSV形式)
474         * @see         #setOrgNames( String )
475         */
476        public void setAsNames( final String keys ) {
477                asNames = getCSVParameter( keys );
478        }
479
480        /**
481         * 【TAG】tableの実際のカラム名(select A as B from TBL の A を指定)をCSV形式で複数指定します。
482         *
483         * @og.tag
484         * SELECT 文を記述したとき、別名を付けていたり、SELECTしたテーブルと別のテーブルに
485         * DBTableModelの値を書き込む場合、DBTableModel の持っているカラム名と、実際に
486         * 書き込むカラム名が異なります。そのようなケースに、テーブルの実カラムを指定します。
487         * orgNames属性の並び順と、asNames属性の並び順を合わせておく必要があります。
488         * このカラム名は、DBTableModel には持っていませんが、テーブル側には持っている値
489         * なので、このカラム名で、SQL文を構築します。 UPDATE TBL SET A=[B] WHERE … となります。
490         * 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。
491         * こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。
492         *
493         * @og.rev 5.5.1.9 (2012/04/19) 新規追加
494         *
495         * @param       keys 実カラム (CSV形式)
496         * @see         #setAsNames( String )
497         */
498        public void setOrgNames( final String keys ) {
499                orgNames = getCSVParameter( keys );
500        }
501
502        /**
503         * 【TAG】リクエスト情報の シングルクォート(') 存在チェックを実施するかどうか[true/false]を設定します
504         *              (初期値:USE_SQL_INJECTION_CHECK[={@og.value SystemData#USE_SQL_INJECTION_CHECK}])。
505         *
506         * @og.tag
507         * SQLインジェクション対策の一つとして、暫定的ではありますが、SQLのパラメータに
508         * 渡す文字列にシングルクォート(') を許さない設定にすれば、ある程度は防止できます。
509         * 数字タイプの引数には、 or 5=5 などのシングルクォートを使用しないコードを埋めても、
510         * 数字チェックで検出可能です。文字タイプの場合は、必ず (')をはずして、
511         * ' or 'A' like 'A のような形式になる為、(')チェックだけでも有効です。
512         * (') が含まれていたエラーにする(true)/かノーチェックか(false)を指定します。
513         * (初期値:システム定数のUSE_SQL_INJECTION_CHECK[={@og.value SystemData#USE_SQL_INJECTION_CHECK}])。
514         *
515         * @param   flag クォートチェック [true:する/それ以外:しない]
516         * @see         org.opengion.hayabusa.common.SystemData#USE_SQL_INJECTION_CHECK
517         */
518        public void setQuotCheck( final String flag ) {
519                quotCheck = nval( getRequestParameter( flag ),quotCheck );
520        }
521
522        /**
523         * 【TAG】固定情報カラムの処理オブジェクトを特定するキーを設定します(初期値:SYSTEM_ID)。
524         *
525         * @og.tag
526         * 固定情報カラム をシステム単位にJavaクラスで管理できます。
527         * そのクラスオブジェクトは、org.opengion.hayabusa.db.DBConstValue インターフェースを
528         * 継承した、plugin クラスになります。
529         * そのクラスを特定するキーワードを指定します。
530         * 初期値は、SYSTEM_ID でシステム単位にクラスを作成します。
531         * もし、他のシステムと共通の場合は、継承だけさせることも可能です。
532         * 対応したDBConstValueクラスがプラグインとして存在しない場合は、
533         * システムリソースのDEFAULT_CONST_CLASSで指定されたクラスが利用されます。
534         *
535         * 初期値は、SYSTEM_ID です。
536         *
537         * @param   key 固定カラムキー
538         */
539        public void setConstObjKey( final String key ) {
540                constObjKey = nval( getRequestParameter( key ),constObjKey );
541        }
542
543        /**
544         * 【TAG】sqlType="DELETE"の場合に論理削除(UPDATE)を行うかどうかを指定します(初期値:false)。
545         *
546         * @og.tag
547         * sqlType="DELETE"の場合に論理削除(UPDATE)を行うかどうかを指定します。
548         * trueが指定された場合は、DELETE文ではなく、UPDATE文が発行されます。
549         * falseが指定された場合は、DELETE文が発行されます。
550         * さらに論理削除を行う場合、org.opengion.hayabusa.db.DBConstValue インターフェースに
551         * 定義されている、getLogicalDeleteKeys()及びgetLogicalDeleteValsを実装することで、
552         * 論理削除する際のフラグの更新方法を統一的に管理することが可能になります。
553         * 初期値は、false(物理削除する)です
554         *
555         * @param   flag 論理削除可否 [true:UPDATE文/false:DELETE文]
556         */
557        public void setLogicalDelete( final String flag ) {
558                logicalDelete = nval( getRequestParameter( flag ),logicalDelete );
559        }
560
561        /**
562         * データをインサートする場合に使用するSQL文を作成します。
563         *
564         * @og.rev 4.1.2.1 (2008/03/17) DBConstValue による固定値セットを採用
565         * @og.rev 4.3.6.4 (2009/05/01) デフォルト設定をシステムリソースで設定可能にする
566         * @og.rev 5.3.4.0 (2011/04/01) DEFAULT_CONST_OBJの初期値変更(null→ゼロ文字列)
567         * @og.rev 6.2.3.0 (2015/05/01) CSV形式の作成を、String#join( CharSequence , CharSequence... )を使用。
568         *
569         * @param   namesData NamesDataオブジェクト
570         *
571         * @return  インサートSQL
572         * @og.rtnNotNull
573         */
574        private String getInsertSQL( final NamesData namesData ) {
575                String cls = HybsSystem.sys( "DBConstValue_" + constObjKey ) ;
576
577                // 4.3.6.4 (2009/05/01) 標準の追加
578                if( cls == null){
579                        cls = DEFAULT_CONST_OBJ;
580                }
581
582                if( cls != null && !cls.isEmpty() ) {
583                        final DBConstValue constVal = HybsSystem.newInstance( cls );
584                        // 4.2.1.0 (2008/04/16) 初期化追加
585                        constVal.init( table,getUser().getUserID(),getGUIInfoAttri( "KEY" ) );
586                        final String[] keys = constVal.getInsertKeys();
587                        final String[] vals = constVal.getInsertVals();
588                        namesData.add( keys,vals );
589                }
590
591                final String[] nms = namesData.getNames();
592                final String[] vls = namesData.getVals();
593
594                // 6.2.3.0 (2015/05/01) CSV形式の作成を、String#join( CharSequence , CharSequence... )を使用。
595                final StringBuilder sql = new StringBuilder( BUFFER_MIDDLE )
596                        .append( "INSERT INTO " ).append( table )
597                        .append( " ( " )
598                        .append( String.join( "," , nms ) )             // 6.2.3.0 (2015/05/01)
599                        .append( " ) VALUES ( " )
600                        .append( String.join( "," , vls ) )             // 6.2.3.0 (2015/05/01)
601                        .append( " )" );
602
603                return sql.toString();
604        }
605
606        /**
607         * データをアップデートする場合に使用するSQL文を作成します。
608         *
609         * where と whereNames が同時に指定された場合は、whereNames が先に処理され
610         * where 条件は、and 結合されます。
611         *
612         * @og.rev 4.1.2.1 (2008/03/17) DBConstValue による固定値セットを採用
613         * @og.rev 4.3.6.4 (2009/05/01) デフォルト設定をシステムリソースで設定可能にする
614         * @og.rev 4.3.7.0 (2009/06/01) 論理削除対応
615         * @og.rev 5.3.7.0 (2011/07/01) DEFAULT_CONST_OBJの初期値変更(null→ゼロ文字列) 対応忘れ
616         * @og.rev 5.5.8.5 (2012/11/27) whereNames 対応
617         *
618         * @param   namesData NamesDataオブジェクト
619         *
620         * @return  アップデートSQL
621         * @og.rtnNotNull
622         */
623        private String getUpdateSQL( final NamesData namesData ) {
624                String cls = HybsSystem.sys( "DBConstValue_" + constObjKey ) ;
625
626                // 4.3.6.4 (2009/05/01) 標準の追加
627                if( cls == null){
628                        cls = DEFAULT_CONST_OBJ;
629                }
630
631                if( cls != null && !cls.isEmpty() ) {           // 5.3.7.0 (2011/07/01)
632                        final DBConstValue constVal = HybsSystem.newInstance( cls );
633                        // 4.2.1.0 (2008/04/16) 初期化追加
634                        constVal.init( table,getUser().getUserID(),getGUIInfoAttri( "KEY" ) );
635                        // 4.3.7.0 (2009/06/01) 論理削除対応
636                        String[] keys = null;
637                        String[] vals = null;
638                        if( "DELETE".equalsIgnoreCase( sqlType ) ) {
639                                keys = constVal.getLogicalDeleteKeys();
640                                vals = constVal.getLogicalDeleteVals();
641                        }
642                        else {
643                                keys = constVal.getUpdateKeys();
644                                vals = constVal.getUpdateVals();
645                        }
646                        namesData.add( keys,vals );
647                }
648
649                final String[] nms = namesData.getNames();
650                final String[] vls = namesData.getVals();
651
652                final StringBuilder sql = new StringBuilder( BUFFER_MIDDLE )
653                        .append( "UPDATE " ).append( table ).append( " SET " )
654                        .append( nms[0] ).append( '=' ).append( vls[0] );                       // 6.0.2.5 (2014/10/31) char を append する。
655
656                for( int i=1; i<nms.length; i++ ) {
657                        sql.append( ',' ).append( nms[i] ).append( '=' ).append( vls[i] );              // 6.0.2.5 (2014/10/31) char を append する。
658                }
659
660                // 5.5.8.5 (2012/11/27) whereNames 対応
661                String whereAnd = " WHERE " ;
662                if( whereNames != null && whereNames.length() > 0 ) {
663                        final String[] wnms = whereNames.split(",");
664                        sql.append( whereAnd ).append( wnms[0] ).append( "=[" ).append( wnms[0] ).append( ']' );                // 6.0.2.5 (2014/10/31) char を append する。
665
666                        for( int i=1; i<wnms.length; i++ ) {
667                                sql.append( " AND " ).append( wnms[i] ).append( "=[" ).append( wnms[i] ).append( ']' );         // 6.0.2.5 (2014/10/31) char を append する。
668                        }
669                        whereAnd = " AND " ;            // whereNames 優先。ここを通らなければ、初期値のまま、" WHERE " が使われる
670                }
671
672                // 5.5.8.5 (2012/11/27) whereNames 対応。whereNames が登録されていれば、AND で繋げる。
673                if( where != null && where.length() > 0 ) {
674                        sql.append( whereAnd ).append( where );
675                }
676
677                return sql.toString();
678        }
679
680        /**
681         * データをデリートする場合に使用するSQL文を作成します。
682         *
683         * where と whereNames が同時に指定された場合は、whereNames が先に処理され
684         * where 条件は、and 結合されます。
685         *
686         * @og.rev 5.5.8.5 (2012/11/27) whereNames 対応
687         *
688         * @return  デリートSQL
689         * @og.rtnNotNull
690         */
691        private String getDeleteSQL() {
692                final StringBuilder sql = new StringBuilder( BUFFER_MIDDLE );
693                sql.append( "DELETE FROM " ).append( table );
694
695                // 5.5.8.5 (2012/11/27) whereNames 対応
696                String whereAnd = " WHERE " ;
697                if( whereNames != null && whereNames.length() > 0 ) {
698                        final String[] wnms = whereNames.split(",");
699                        sql.append( whereAnd ).append( wnms[0] ).append( "=[" ).append( wnms[0] ).append( ']' );                // 6.0.2.5 (2014/10/31) char を append する。
700
701                        for( int i=1; i<wnms.length; i++ ) {
702                                sql.append( " AND " ).append( wnms[i] ).append( "=[" ).append( wnms[i] ).append( ']' );         // 6.0.2.5 (2014/10/31) char を append する。
703                        }
704                        whereAnd = " AND " ;            // whereNames 優先。ここを通らなければ、初期値のまま、" WHERE " が使われる
705                }
706
707                // 5.5.8.5 (2012/11/27) whereNames 対応。whereNames が登録されていれば、AND で繋げる。
708                if( where != null && where.length() > 0 ) {
709                        sql.append( whereAnd ).append( where );
710                }
711                return sql.toString();
712        }
713
714        /**
715         * names,constKeys,omitNames から、必要なキー情報と、属性情報を持った NamesData を作成します。
716         *
717         * @og.rev 4.1.2.1 (2008/03/17) 固定値の constVals の前後に、"'" を入れる。
718         * @og.rev 5.5.1.9 (2012/04/19) asNames、orgNames、funcKeys、funcVals属性追加
719         *
720         * @param   nms カラム名配列(可変長引数)
721         *
722         * @return      属性情報を持ったNamesData
723         */
724        private NamesData makeNamesData( final String... nms ) {
725
726                final NamesData namesData = new NamesData();
727
728                // 5.5.1.9 (2012/04/19) omitNames に、asNames配列の値を設定しておきます。
729                if( asNames != null ) {
730                        for( int i=0; i<asNames.length; i++ ) {
731                                if( asNames[i] != null && asNames[i].length() > 0 ) {
732                                        omitNames = omitNames + asNames[i] + ",";
733                                }
734                        }
735                }
736
737                // names で指定されたカラム名
738                for( int i=0; i<nms.length; i++ ) {
739                        final String nm = nms[i];
740                        if( nm != null && nm.length() > 0 && omitNames.indexOf( "," + nm + "," ) < 0 ) {
741                                namesData.add( nm,"[" + nm + "]" ) ;
742                        }
743                }
744
745                // 固定値の constKeys カラム配列を設定します。
746                if( constKeys != null && constKeys.length > 0 ) {
747                        for( int j=0; j<constKeys.length; j++ ) {
748                                final String nm = constKeys[j];
749                                if( nm != null && nm.length() > 0 ) {
750                                        namesData.add( nm,"'" + constVals[j] + "'" ) ;  // constVals は、シングルクオートで囲います。
751                                }
752                        }
753                }
754
755                // 関数値の funcKeys カラム配列を設定します。
756                if( funcKeys != null && funcKeys.length > 0 ) {
757                        for( int j=0; j<funcKeys.length; j++ ) {
758                                final String nm = funcKeys[j];
759                                if( nm != null && nm.length() > 0 ) {
760                                        namesData.add( nm, funcVals[j] ) ;              // funcVals は、シングルクオートで囲いません。
761                                }
762                        }
763                }
764
765                // 別名の asNames,orgNames カラム配列を設定します。
766                if( orgNames != null && orgNames.length > 0 ) {
767                        for( int j=0; j<orgNames.length; j++ ) {
768                                final String onm = orgNames[j];
769                                if( onm != null && onm.length() > 0 ) {
770                                        namesData.add( onm,"[" + asNames[j] + "]" ) ;
771                                }
772                        }
773                }
774
775                return namesData ;
776        }
777
778        /**
779         * 内部データを受け渡す為の、簡易クラスです。
780         * 更新するカラム名と値のセット配列を管理しています。
781         *
782         * @og.rev 6.3.9.1 (2015/11/27) 修飾子を、なし → private に変更。
783         *    ※ classのfinal化と変数のprivate化、メソッドの修飾子なし(パッケージプライベート)化を行います。
784         * @og.rev 6.4.1.2 (2016/01/22) nameの値を、大文字小文字の区別をなくすために、常に大文字で登録します。
785         */
786        private static final class NamesData {
787                private final Map<String,String> nameMap = new LinkedHashMap<>() ;
788
789                /**
790                 * キーと値のセットを追加します。
791                 *
792                 * @og.rev 6.3.9.1 (2015/11/27) 修飾子を、なし → private に変更。
793                 * @og.rev 6.4.1.2 (2016/01/22) nameの値を、大文字小文字の区別をなくすために、常に大文字で登録します。。
794                 *
795                 * @param   nm  キー(大文字のみ。内部で変換しておきます。)
796                 * @param   val 値
797                 */
798                /* default */ void add( final String nm,final String val ) {
799                        nameMap.put( nm.toUpperCase(Locale.JAPAN),val );
800                }
801
802                /**
803                 * キー配列と対応する、値配列のセットを追加します。
804                 *
805                 * @og.rev 6.3.9.1 (2015/11/27) 修飾子を、なし → private に変更。
806                 *
807                 * @param   nms  キー配列
808                 * @param   vals 値配列
809                 */
810                /* default */ void add( final String[] nms,final String[] vals ) {
811                        if( nms != null ) {
812                                for( int i=0; i<nms.length; i++ ) {
813                                        nameMap.put( nms[i].toUpperCase(Locale.JAPAN),vals[i] );
814                                }
815                        }
816                }
817
818                /**
819                 * キー配列を返します。
820                 *
821                 * @og.rev 6.3.9.1 (2015/11/27) 修飾子を、なし → private に変更。
822                 *
823                 * @return      キー配列
824                 * @og.rtnNotNull
825                 */
826                /* default */ String[] getNames() {
827                        return nameMap.keySet().toArray( new String[nameMap.size()] );
828                }
829
830                /**
831                 * 値配列を返します。
832                 *
833                 * @og.rev 6.3.9.1 (2015/11/27) 修飾子を、なし → private に変更。
834                 *
835                 * @return      値配列
836                 * @og.rtnNotNull
837                 */
838                /* default */ String[] getVals()  {
839                        return nameMap.values().toArray( new String[nameMap.size()] );
840                }
841        }
842
843        /**
844         * このオブジェクトの文字列表現を返します。
845         * 基本的にデバッグ目的に使用します。
846         *
847         * @return このクラスの文字列表現
848         * @og.rtnNotNull
849         */
850        @Override
851        public String toString() {
852                return ToString.title( this.getClass().getName() )
853                                .println( "VERSION"                     ,VERSION                )
854                                .println( "sqlType"                     ,sqlType                )
855                                .println( "table"                       ,table                  )
856                                .println( "names"                       ,names                  )
857                                .println( "omitNames"           ,omitNames              )
858                                .println( "where"                       ,where                  )
859                                .println( "whereNames"          ,whereNames             )
860                                .println( "constKeys"           ,constKeys              )
861                                .println( "constVals"           ,constVals              )
862                                .println( "logicalDelete"       ,logicalDelete  )
863                                .fixForm().toString() ;
864        }
865}