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