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.resource;
017
018import java.util.Collections;
019import java.util.Map;                                                                                                                   // 7.2.6.0 (2020/06/30)
020import java.util.LinkedHashMap;                                                                                                 // 7.2.6.0 (2020/06/30)
021import java.util.StringJoiner;                                                                                                  // 8.3.0.1 (2022/08/12)
022
023import org.opengion.fukurou.db.DBUtil;
024import org.opengion.fukurou.db.ApplicationInfo;
025import org.opengion.fukurou.util.StringUtil;
026import org.opengion.hayabusa.common.HybsSystem;
027import static org.opengion.fukurou.system.HybsConst.BUFFER_MIDDLE;                              // 8.0.0.0 (2021/10/01)
028
029/**
030 * systemId と lang に対応した画面データを作成するデータロードクラスです。
031 *
032 * 画面データは、画面ID(GUIKEY)に対して、各種画面情報を持っています。
033 * 従来と異なるのは、同一画面IDに対して、アドレスやロールズを変えた情報を持てると言う
034 * 事です。これは、カスタマイズ時に、画面IDは変えずに、実際のアクセスされるアドレスを
035 * 変える事で、他のアプリケーションへの影響を最小限にして開発できます。
036 * linkタグや、submit などの gamenID を指定するカスタムタグでは、実際のアクセス先は、
037 * ログインユーザーのロールズでアクセス可能な画面のアドレスに転送されます。
038 * 作番毎のカスタマイズや、ユーザーロールに応じた飛び先変更などにも使用できます。
039 *
040 * 画面データでは、複数階層持てるように、画面階層(GUILVL)を持っています。このレベルに
041 * 応じて、分類(CLASSIFY)の表示方法が変わります。(擬似階層構造)
042 *
043 * 画面データでは、言語(LANG)は、条件から消えました。実際に名称を表示させる時は、
044 * 画面カラムID(LABEL_CLM)に対応する ラベル定義より、言語に応じたラベルを取得します。
045 * エンジン内部で使用している GUIInfo オブジェクト構築時に割り当てます。
046 * 分類(CLASSIFY)は、コードリソースに登録します。
047 *
048 * 画面データを作成する場合は、同一画面IDで、作成区分(KBSAKU)違いの場合は、
049 * 最も大きな作成区分を持つ画面情報を使用します。
050 * 作成区分(KBSAKU)='0' のデータは、マスタリソースとして、エンジンとともに
051 * 配布されるリソースになります。
052 *
053 * 画面データは、カラム定義のような、読込フラグ(FGLOAD)はありません。
054 * 画面情報(GUIInfo)は、ユーザーログイン毎に作成されます。(キャッシュは
055 * セッション情報に登録されます。)
056 * これは、画面アクセス条件を、ログイン時に済ますことで、高速化を図っています。
057 * 画面IDの件数が少ないことと、画面IDを自動作成した場合でも、
058 * ほとんどのケースで、すべて使用される可能性が非常に高い為です。
059 *
060 * SYSTEM_ID='**' は、共通リソースです。
061 * これは、システム間で共通に使用されるリソース情報を登録しておきます。
062 *
063 * @og.rev 4.0.0.0 (2004/12/31) 新規作成
064 * @og.group リソース管理
065 *
066 * @version     4.0
067 * @author      Kazuhiko Hasegawa
068 * @since       JDK5.0,
069 */
070final class GUIDataLoader {
071        // リソースの接続先を、取得します。
072        private final String DBID = HybsSystem.sys( "RESOURCE_DBID" );
073
074        // DBリソースの初期一括読み込みのクエリー
075        // ソート順は、画面IDオブジェクトの優先順(後優先)で、画面表示順ではありません。
076        // 5.6.4.3 (2013/05/24) FAQ追加 現段階ではシステムコードは考慮しない
077        // 6.3.8.4 (2015/10/09) GE80(FAQテーブル)の取得は廃止。(helpタグで行う)
078        // 6.3.9.0 (2015/11/06) コンパイル時に静的な値に初期化されるフィールドは static フィールドにしてください(findbugs)。
079
080        // 7.3.1.3 (2021/03/09)
081//      private static final String SEL_CLM = "select GUIKEY,GUILVL,LABEL_CLM,ADDRESS,SEQNO,GROUPS"
082//                                                                      + ",'' as CLASSIFY,ROLES,RWMODE,TARGET,PARAM,KBLINK,DYUPD,SYSTEM_ID"
083//                                                                      + ",KBSAKU" ;
084
085        // 7.3.1.3 (2021/03/09)
086        // 7.4.5.0 (2021/08/31) Firebird 対応
087//      private static final String QUERY = "select a.* from ("
088//                                                                      +       SEL_CLM + ",0 as SNO"
089//                                                                      + " from GEA11 where SYSTEM_ID='**' and FGJ='1'"                // エンジン共通
090//                                                                      + " union all "
091//                                                                      +  SEL_CLM + ",1 as SNO"
092//                                                                      + " from GEA11 where SYSTEM_ID IN (?,?) and FGJ='1'"    // RESOURCE_BASE_SYSTEM_ID , 最上位ののSYSTEM_ID
093//                                                                      + " ) a "               // 8.0.0.0 (2021/08/31)
094//                                                                      + " order by a.SNO,a.KBSAKU,a.SEQNO,a.GUIKEY" ;
095
096        // 8.0.0.0 (2021/10/01) RESOURCE_BASE_SYSTEM_ID は、SYSTEM_IDの配列で複数指定できる。
097//      private static final String QUERY = "select GUIKEY,GUILVL,LABEL_CLM,ADDRESS,SEQNO,GROUPS"
098//                                                                      + ",'' as CLASSIFY,ROLES,RWMODE,TARGET,PARAM,KBLINK,DYUPD,SYSTEM_ID,KBSAKU"
099//                                                                      + " from GEA11 where SYSTEM_ID = ? and FGJ='1'"                 // 8.0.0.0 注意 IN (?,?) → = ? に変更
100//                                                                      + " order by KBSAKU,SEQNO,GUIKEY" ;
101
102        // 8.3.0.1 (2022/08/12) CLASSIFYが正しく表示されない不具合対応
103        private static final String QUERY1 = "select GUIKEY,GUILVL,LABEL_CLM,ADDRESS,SEQNO,GROUPS"
104                                                                        + ",'' as CLASSIFY,ROLES,RWMODE,TARGET,PARAM,KBLINK,DYUPD,SYSTEM_ID,KBSAKU";
105        private static final String QUERY2 = "from GEA11 where SYSTEM_ID in (" ;
106        private static final String QUERY3 = ") and FGJ='1'"
107                                                                        + " order by KBSAKU,SEQNO,GUIKEY,SYSID_SEQ DESC" ;
108
109        // 7.2.6.0 (2020/06/30) "**"以外にベースとなるSYSTEM_ID(RESOURCE_BASE_SYSTEM_ID)設定の対応
110        /** 7.2.9.1 (2020/10/23) Collections.synchronizedMap で同期処理を行います。 */
111        private final Map<String,GUIData> guiMap = Collections.synchronizedMap( new LinkedHashMap<>() );        // 集約するキーは、GUIKEY+ROLES         // 7.2.9.4 (2020/11/20) private 追加
112
113        /** 8.0.0.0 (2021/10/01) RESOURCE_BASE_SYSTEM_ID は、SYSTEM_IDの配列で複数指定できる。 */
114//      private final String SYSTEM_ID ;                                                                                        // システムID
115//      private final String BASE_SYS_ID ;                                                                                      // 7.2.9.2 (2020/10/30) ベースシステムID
116        private final String[] SYS_ARRAY;                                                                                       // 8.0.0.0 (2021/10/01)
117
118        /** コネクションにアプリケーション情報を追記するかどうか指定 */
119        public static final boolean USE_DB_APPLICATION_INFO = HybsSystem.sysBool( "USE_DB_APPLICATION_INFO" ) ;
120
121        /** 3.8.7.0 (2006/12/15) アクセスログ取得の為、ApplicationInfoオブジェクトを設定 */
122        private final ApplicationInfo appInfo;
123
124        /**
125         *  SystemId 毎に ファクトリオブジェクトを作成します。
126         *
127         * @og.rev 7.2.9.2 (2020/10/30) ベースとなるSYSTEM_ID(RESOURCE_BASE_SYSTEM_ID)の取得
128         * @og.rev 8.0.0.0 (2021/10/01) RESOURCE_BASE_SYSTEM_ID は、SYSTEM_IDの配列で複数指定できる。
129         *
130//       * @param       systemId        システムID
131//       * @param       baseSys         ベースとなるSYSTEM_ID
132         * @param       sysAry          階層リソースの元となるSYSTEM_IDの配列(前方優先)
133         */
134//      GUIDataLoader( final String systemId,final String baseSys ) {
135        /* default */ GUIDataLoader( final String[] sysAry ) {
136//              SYSTEM_ID   = systemId;
137//              BASE_SYS_ID = baseSys ;                 // 7.2.9.2 (2020/10/30)
138                SYS_ARRAY       = sysAry ;                      // 8.0.0.0 (2021/10/01)
139
140                // 3.8.7.0 (2006/12/15) アクセスログ取得の為、ApplicationInfoオブジェクトを設定
141                if( USE_DB_APPLICATION_INFO ) {
142                        appInfo = new ApplicationInfo();
143                        // ユーザーID、IPアドレス、ホスト名
144//                      appInfo.setClientInfo( SYSTEM_ID,HybsSystem.HOST_ADRS,HybsSystem.HOST_NAME );
145                        appInfo.setClientInfo( SYS_ARRAY[0],HybsSystem.HOST_ADRS,HybsSystem.HOST_NAME );
146                        // 画面ID、操作、プログラムID
147                        appInfo.setModuleInfo( "GUIDataLoader",null,null );
148                }
149                else {
150                        appInfo = null;
151                }
152
153                // ApplicationInfo の設定が終わってから実行します。
154                loadDBResource();
155        }
156
157        /**
158         * DBリソースより 画面データを取得、設定します。
159         * DBリソースは、GUIKEY,GUILVL,LABEL_CLM,ADDRESS,SEQNO,GROUPS,
160         * CLASSIFY,ROLES,RWMODE,TARGET,PARAM,KBLINK,DYUPD の順番で、GUIKEY の重複を許します。
161         * 重複している場合(ロール違い等)は、一つのオブジェクトとして作成され、
162         * 個々のログインユーザー毎にユニークになるように、設定する必要があります。
163         *
164         * ※ 以下のロジックは、後方優先であり、SYSTEM_IDの配列は前方優先なので逆順で回します。
165         *
166         * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為、ApplicationInfoオブジェクトを設定
167         * @og.rev 4.0.0.0 (2007/10/31) ロールの継承機能の追加・分類の取得を追加(暫定対応)
168         * @og.rev 5.3.1.0 (2011/01/01) 通常画面に対してアドレスを設定しない場合にロールが効かないバグを修正します。
169         * @og.rev 5.3.1.0 (2011/01/01) ロール継承機能廃止
170         * @og.rev 7.2.6.1 (2020/07/17) "**"以外にベースとなるSYSTEM_ID(RESOURCE_BASE_SYSTEM_ID)設定の対応
171         * @og.rev 8.3.0.1 (2022/08/12) CLASSIFYが正しく表示されない不具合対応 (8.0.0.0対応改善)
172         */
173        private void loadDBResource() {
174                final int size = SYS_ARRAY.length;
175
176//              final int[] cnt = new int[size];        // 各SYSTEM_ID の個数       // 8.3.0.1 (2022/08/12) Delete
177                int selCnt = 0;
178
179                // 8.3.0.1 (2022/08/12) CLASSIFYが正しく表示されない不具合対応
180                final StringBuilder buf1 = new StringBuilder(BUFFER_MIDDLE);
181                final StringJoiner sj = new StringJoiner(",");
182                buf1.append( QUERY1 )                                                                                                   // select句
183                        .append( ",case" );
184                for( int j=0; j<size; j++ ) {
185                        buf1.append( " when '" ).append( SYS_ARRAY[j] ).append( "' = SYSTEM_ID THEN " ).append( j );
186                        sj.add( "?" );
187                }
188                buf1.append( " else 99 end as SYSID_SEQ " )
189                        .append( QUERY2 )                                                                                                       // from句
190                        .append( sj.toString() )                                                                                        // バインド変数
191                        .append( QUERY3 );                                                                                                      // order by句
192
193//              for( int j=size-1; j>=0; j-- ) {        // SYSTEM_IDの配列は、前方優先なので、逆順で回す必要がある。8.3.0.1 (2022/08/12) Delete
194//                      final String sysId = SYS_ARRAY[j];                                                                      // 8.3.0.1 (2022/08/12) Delete
195//                      final String[] args = new String[] { BASE_SYS_ID,SYSTEM_ID };           // 7.2.6.1 (2020/07/17)
196//                      final String[] args = new String[] { sysId } ;                                          // 8.3.0.1 (2022/08/12) Delete
197
198                        // 8.3.0.1 (2022/08/12) CLASSIFYが正しく表示されない不具合対応
199//                      final String[][] gea11 = DBUtil.dbExecute( QUERY,args,appInfo,DBID );
200                        final String[][] gea11 = DBUtil.dbExecute( buf1.toString(),SYS_ARRAY,appInfo,DBID );
201//                      final int[] cnt = new int[3];   // **,BASE_SYS_ID,SYSTEM_ID の個数
202
203                        // 7.2.6.0 (2020/06/30) "**"以外にベースとなるSYSTEM_ID(RESOURCE_BASE_SYSTEM_ID)設定の対応
204                        final int len = gea11.length;
205                        selCnt += len;
206                        String classify = "";
207                        for( int i=0; i<len; i++ ) {
208                                final String[] vals = gea11[i];
209//                              final int idx = Integer.parseInt( vals[GUIData.SNO] );
210
211                                // ロールの継承対応
212                                final int level = Integer.parseInt( vals[GUIData.GUILVL] );
213                                // 小分類
214                                if( level == 2 ) {
215                                        classify = vals[GUIData.GUIKEY];                // 暫定対応
216                                }
217                                // 通常
218                                else if( level >= 3 ) {
219                                        vals[GUIData.CLASSIFY] = classify;              // 暫定対応
220                                }
221
222                                // 5.3.1.0 (2011/01/01) 通常画面に対してアドレスを設定しない場合にロールが効かないバグを修正します。
223                                if( ( level == 1 || level == 2 ) && StringUtil.isEmpty( vals[GUIData.ADDRESS] ) ) {
224                                        vals[GUIData.ROLES] = null;
225                                }
226
227//                              final String key = vals[GUIData.GUIKEY] + "_" + vals[GUIData.ROLES] ;
228//                              guiMap.put( key,new GUIData( vals ) );          // GUIKEY+ROLES が同一の画面リソースは、後設定が有効となる。
229                                guiMap.put( vals[GUIData.GUIKEY], new GUIData( vals ) );                // 8.3.0.1 (2022/08/12) Modify
230
231//                              cnt[idx]++ ;
232//                              cnt[j]++ ;                                                                                                              // 8.3.0.1 (2022/08/12) Delete
233                        }
234//              }                                                                                                                                               // 8.3.0.1 (2022/08/12) Delete
235//              final int guiSize = guiMap.size();
236
237//              System.out.println( "  GUIDataLoader [" + guiSize + "] "
238//                      +       " ** [" + cnt[0] + "] " + BASE_SYS_ID + " [" + cnt[1] + "] " + SYSTEM_ID + " [" + cnt[2] + "] loaded" );
239
240                // 8.5.4.2 (2024/01/12) PMD 7.0.0 ConsecutiveLiteralAppends 対応
241                final StringBuilder buf = new StringBuilder( BUFFER_MIDDLE )
242                        .append( "  " ).append( SYS_ARRAY[0] ).append( "  GUIDataLoader [" ).append( selCnt )
243                        .append( "] Map=[" ).append( guiMap.size() ).append( "] loaded." );
244//              for( int j=0; j<size; j++ ) {                                                                                                   // 8.3.0.1 (2022/08/12) Delete
245//                      buf.append( SYS_ARRAY[j] ).append( "=[" ).append( cnt[j] ).append( "] " );      // 8.3.0.1 (2022/08/12) Delete
246//              }                                                                                                                                                               // 8.3.0.1 (2022/08/12) Delete
247                System.out.println( buf );
248        }
249
250        /**
251         * すべてのGUIData オブジェクト配列を取得します。
252         * プールに持っているすべてのキャッシュを、GUIData オブジェクト配列
253         * にして返します。
254         * このリソースは、List で管理しており、読み込み時にすべてキャッシュされます。
255         *
256         * @og.rev 7.2.6.0 (2020/06/30) "**"以外にベースとなるSYSTEM_ID(RESOURCE_BASE_SYSTEM_ID)設定の対応
257         *
258         * @return      すべてのGUIDataオブジェクト配列
259         */
260        public GUIData[] getAllData() {
261                synchronized( guiMap ) {                                                                                                // 7.2.6.0 (2020/06/30)
262                        if( guiMap.isEmpty() ) { loadDBResource(); }
263//                      return guiMap.values().toArray( new GUIData[guiMap.size()] );
264                        return guiMap.values().toArray( new GUIData[0] );       // 8.5.4.2 (2024/01/12) PMD 7.0.0 OptimizableToArrayCall 対応
265                }
266        }
267
268        /**
269         * GUIData オブジェクトのキャッシュをクリアします。
270         *
271         * @og.rev 7.2.6.0 (2020/06/30) "**"以外にベースとなるSYSTEM_ID(RESOURCE_BASE_SYSTEM_ID)設定の対応
272         */
273        public void clear() {
274                synchronized( guiMap ) {                                                                                                // 7.2.6.0 (2020/06/30)
275                        guiMap.clear();
276                }
277        }
278}