001/*
002 * Copyright (c) 2017 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.fukurou.fileexec;
017
018import java.util.Locale;
019import java.util.Date;
020import java.text.DateFormat;
021import java.text.SimpleDateFormat;
022
023/**
024 * StringUtilは、共通的に使用される文字列処理に関する、ユーティリティークラスです。
025 *
026 * @og.rev 7.0.0.0 (2017/07/07) 新規作成
027 *
028 * @version  7.0
029 * @author   Kazuhiko Hasegawa
030 * @since    JDK1.8,
031 */
032public final class StringUtil {
033        /** システム依存の改行記号(String)。        */
034        public static final String CR = System.getProperty("line.separator");
035
036        private static final int        BUFFER_MIDDLE    = 200 ;        // 7.2.9.5 (2020/11/28)
037
038        /**
039         * デフォルトコンストラクターをprivateにして、
040         * オブジェクトの生成をさせないようにする。
041         */
042        private StringUtil() {}
043
044        /**
045         * 指定の文字列が nullか、ゼロ文字列 の場合は、2番目以降の引数から、null でない最初の値を返します。
046         * 2番目以降の引数には、ゼロ文字列の指定も可能です。
047         *
048         * @param       val 判定する文字列
049         * @param       def 初期値の可変長引数
050         * @return      指定の値で、最初にnullでない値。最後まで、無ければ、val を返します。
051         */
052        public static String nval( final String val , final String... def ) {
053                if( val == null || val.trim().isEmpty() ) {
054                        for( final String str : def ) {
055                                if( str != null ) { return str.trim(); }                        // ゼロ文字列 の場合も、返します。
056                        }
057                }
058
059                return val;             // 最後まで null以外の値が見つからない場合なので、val が null の場合もありうる。
060        }
061
062        /**
063         * 指定の数値型文字列が nullか、ゼロ文字列 の場合は、2番目の初期値を返します。
064         *
065         * そうでない場合は、指定の文字列を、Integer.parseInt( String ) した値を返します。
066         *
067         * @param       val 判定する数値型文字列
068         * @param       def 初期値の数値
069         * @return      指定の文字列が nullか、ゼロ文字列でない場合は、数値に変換し、そうでなければ、初期値の数値を返します。
070         * @throws      NumberFormatException   文字列が解析可能な整数型を含まない場合。
071         */
072        public static int nval( final String val , final int def ) {
073                return val == null || val.trim().isEmpty() ? def : Integer.parseInt( val.trim() );
074        }
075
076        /**
077         * LOGファイルのフォーマットに対応した日付、時刻文字列を作成します。
078         *
079         * yyyyMMddHHmmss 形式のフォーマットで、返します。
080         *
081         * @return      現在の日付、時刻文字列
082         */
083        public static String getTimeFormat() {
084                return getTimeFormat( "yyyyMMddHHmmss" );
085        }
086
087        /**
088         * 指定のフォーマットに対応した日付、時刻文字列を作成します。
089         *
090         * 例えば、LOGフォーマットの場合は、yyyyMMdd HH:mm:ss 形式です。
091         *
092         * @param format        日付、時刻文字列のフォーマット
093         * @return      指定のフォーマットに対応した現在の日付、時刻文字列
094         */
095        public static String getTimeFormat( final String format ) {
096                final DateFormat formatter = new SimpleDateFormat( format , Locale.getDefault() );
097                return formatter.format( new Date() );
098        }
099
100        /**
101         * 指定のフォーマットに対応した日付、時刻文字列を作成します。
102         *
103         * 例えば、LOGフォーマットの場合は、yyyyMMdd HH:mm:ss 形式です。
104         *
105         * @param date          フォーマットする日付情報
106         * @param format        日付、時刻文字列のフォーマット
107         * @return      指定のフォーマットに対応した指定の日付、時刻文字列
108         */
109        public static String getTimeFormat( final long date , final String format ) {
110                final DateFormat formatter = new SimpleDateFormat( format , Locale.getDefault() );
111                return formatter.format( new Date( date ) );
112        }
113
114        /**
115         * EUROMAPの日付、時間文字列から、openGion系日付時刻文字列を作成します。
116         *
117         * 日付は、yyyyMMdd 形式で、時間は、HH:mm:ss 形式を標準としますが、
118         * 数字以外の文字列を削除して、連結した文字列を作成します。
119         * その場合、14桁数字文字列 になります。
120         *
121         * その形式に合わない場合は、現在時刻 を返します。
122         * ただし、日付の整合性チェックは、行っていません。
123         *
124         * @og.rev 7.0.5.1 (2019/09/27) 日付指定がない場合に、無条件に1秒待つ仕様を廃止。ロジックミス修正
125         * @og.rev 7.2.5.0 (2020/06/01) 日付と時間を分けて取得します。
126         * @og.rev 7.4.1.0 (2021/04/23) 1秒待つ仕様を復活。あくまで現在時刻を設定した場合のみ待ちます。
127         *
128         * @param       ymd EUROMAPの日付(yyyyMMdd形式の8桁数字)
129         * @param       hms EUROMAPの時間(HH:mm:ss形式の8桁数字)
130         * @return      openGion系日付時刻文字列(yyyyMMddHHmmss形式の14桁数字)
131         */
132        public static String getTime( final String ymd , final String hms ) {
133                final StringBuilder buf = new StringBuilder( BUFFER_MIDDLE );
134
135                // yyyyMMdd形式のはずだが、数字以外を削除する。
136                // 7.4.1.0 (2021/04/23) 仕様変更。null 出なければ、数字項目を削除してから、桁数を判定する。
137//              if( ymd != null && ymd.length() == 8 ) {
138                if( ymd != null ) {
139                        for( int i=0; i<ymd.length(); i++ ) {
140                                final char ch = ymd.charAt( i );
141                                if( '0' <= ch && ch <= '9' ) { buf.append( ch ); }      // 数字のみ許可
142                        }
143                }
144//              else {
145//                      buf.append( getTimeFormat( "yyyyMMdd" ) );      // 現在の年月日
146//              }
147
148                final int ymdLen = buf.length();
149                // 8桁以上の場合は、8桁に切る。
150                if( ymdLen > 8 ) {
151                        buf.setLength( 8 );
152                }
153                // 8桁未満の場合は、現在の年月日を後ろから埋める。つまり、年月しか指定されていなければ、日だけ現在になる。
154                else if( ymdLen < 8 ) {
155                        buf.append( getTimeFormat( "yyyyMMdd" ).substring( ymdLen ) );
156                }
157                // 8桁の場合は、日付として不正でも無条件で信頼する。
158
159                // HH:mm:ss形式のはずだが、数字以外を削除する。
160//              if( hms != null && hms.length() == 8 ) {
161                if( hms != null ) {
162                        for( int i=0; i<hms.length(); i++ ) {
163                                // HH:mm:ss形式から、':'を取り除く
164                                final char ch = hms.charAt( i );
165                                if( '0' <= ch && ch <= '9' ) { buf.append( ch ); }      // 数字のみ許可
166                        }
167                }
168//              else {
169//                      buf.append( getTimeFormat( "HHmmss" ) );        // 現在の時分秒
170//              }
171
172                final int ymdhmsLen = buf.length();
173                // 14桁以上の場合は、14桁に切る。
174                if( ymdhmsLen > 14 ) {
175                        buf.setLength( 14 );
176                }
177                // 14桁未満の場合は、現在の現在時刻を後ろから埋める。日付は埋めているので、日時の不足分を補完する。
178                else if( ymdhmsLen < 14 ) {
179                        buf.append( getTimeFormat().substring( ymdhmsLen ) );
180
181                        // 現在時刻を後ろから埋めた場合は、無条件に1秒待ちます。
182                        // これは、テスト用に日付無しのDATデータを用意して登録する場合に使用します。
183//                      try{ Thread.sleep( 1000 ); } catch( final InterruptedException ex ){}
184                        try{ Thread.sleep( 1100 ); } catch( final InterruptedException ex ){}           // 7.4.4.0 (2021/06/30) 何となく重複エラーが出るので
185                }
186
187//              // 14桁でなければ、現在時刻を設定します。日付の整合性チェックは行いません。
188//              if( buf.length() != 14 ) {
189//                      buf.append( getTimeFormat() );                          // 現在時刻
190//              }
191
192//              // 1秒待たないので、時刻が重複するとエラーになる可能性があります。
193                return buf.toString();
194        }
195
196//      public static String getTime( final String ymd , final String hms ) {
197//              if( ymd != null && hms != null ) {
198//                      if( ymd.length() == 8 && hms.length() == 8 ) {
199//                              return ymd + hms.substring(0,2) + hms.substring(3,5) + hms.substring(6);
200//                      }
201//                      else {
202//                              final StringBuilder buf = new StringBuilder();
203//                              for( int i=0; i<ymd.length(); i++ ) {
204//                                      final char ch = ymd.charAt( i );
205////                                    if( '0' <= ch && ch < '9' ) { buf.append( ch ); }       // 数字のみ許可
206//                                      if( '0' <= ch && ch <= '9' ) { buf.append( ch ); }      // 数字のみ許可               7.0.5.1 (2019/09/27)
207//                              }
208//
209//                              for( int i=0; i<hms.length(); i++ ) {
210//                                      final char ch = hms.charAt( i );
211////                                    if( '0' <= ch && ch < '9' ) { buf.append( ch ); }       // 数字のみ許可
212//                                      if( '0' <= ch && ch <= '9' ) { buf.append( ch ); }      // 数字のみ許可               7.0.5.1 (2019/09/27)
213//                              }
214//
215//                              if( buf.length() == 14 ) {
216//                                      return buf.toString();
217//                              }
218//                      }
219//              }
220//
221//              // 引数が存在しない場合は、無条件に1秒待ちます。
222//              // これは、テスト用に日付無しのDATデータを用意して登録する場合に使用します。
223////            try{ Thread.sleep( 1000 ); } catch( final InterruptedException ex ){}
224//
225//              return getTimeFormat() ;                // 現在時刻
226//      }
227
228        /**
229         * すべての引数をスペースで連結してtrim()した文字列を返します。
230         *
231         * 各引数は、それぞれ、trim()した後、スペースで連結します。
232         * ただし、引数が、nullの場合は、ゼロ文字列に変換します。
233         * すべてを連結して、trim() した結果が、ゼロ文字列の場合は、defVal を返します。
234         *
235         * @og.rev 7.2.5.0 (2020/06/01) 日付と時間を分けて取得します。
236         *
237         * @param       defVal 結果が、ゼロ文字列の場合に返す文字列
238         * @param       keys 連結したいキーの可変長文字列配列
239         * @return      合成した文字列。
240         */
241        public static String keyAppend( final String defVal , final String... keys ) {
242                final StringBuilder buf = new StringBuilder( BUFFER_MIDDLE );
243                for( final String key : keys ) {
244//                      buf.append( nval( key , "" ).trim() ).append( ' ' );
245                        final String key2 = nval( key , "" ).trim();
246                        if( !key2.isEmpty() ) { buf.append( key2 ).append( ' ' ); }             // keyがゼロ文字列でなければ連結する。
247                }
248
249                return nval( buf.toString().trim() , defVal );          // 最後のスペースを削除
250        }
251
252        /**
253         * 指定の文字列を、引数の文字で、前後に分割します。
254         * キー=値 や、キー,値 などの文字列を分割して、キーと値の配列を返します。
255         * 1番目の配列[0] は、キー(chの左側)、2番目の配列[1] は、値(chの右側) です。
256         * キーも値も、前後のスペースを削除:trim() します。
257         * キー(1番目の配列[0])は、空文字列を許可しません。
258         *
259//       * 分割文字を含まない場合や、キーが、空文字列の場合は、null を返します。
260         * 分割文字を含まない場合や、キーが、空文字列の場合は、長さゼロの配列 を返します。
261         * nullで無い場合は、配列は、必ず2個存在しそのどちらの値も、null を含みません。
262         *
263         * @og.rev 7.3.0.0 (2021/01/06) SpotBugs:null ではなく長さが0の配列を返すことを検討する
264         *
265         * @param       line    1行分の文字列
266         * @param       ch      分割する文字
267         * @return      キーと値の配列。無ければ、長さゼロの配列
268         * @og.rtnNotNull
269         */
270        public static String[] split( final String line , final char ch ) {
271                final int ad = line.indexOf( ch );
272                if( ad > 0 ) {          // ch が先頭は無視
273                        final String key = line.substring( 0,ad ).trim();
274
275                        if( !key.isEmpty() ) {
276                                final String val = line.substring( ad+1 ).trim();
277                                return new String[] { key , val };
278                        }
279                }
280//              return null;
281                return new String[0];
282        }
283
284        /**
285         * 数字型文字列の一致をチェックします。
286         *
287         * 処理としては、数字型文字列以外を判定条件に入れても、同一文字列の場合は、
288         * true になります。
289         * ここでは、どちらかの文字列の末尾が、".0" などの場合に、同じかどうかを
290         * 数値に変換して、判定します。
291         * どちらかが、null の場合は、必ず false になります。両方とも、null でも false です。
292         *
293         * @param       val1 判定用の引数1
294         * @param       val2 判定用の引数2
295         * @return      判定結果(一致する場合は、true)
296         */
297        public static boolean numEquals( final String val1 , final String val2 ) {
298                if( val1 == null || val2 == null ) { return false; }
299
300                if( val1.equals( val2 ) ) {
301                        return true;
302                }
303                else {
304                        try {
305//                              return Double.parseDouble( val1 ) == Double.parseDouble( val2 );
306
307                                // 6.9.8.0 (2018/05/28) FindBugs:浮動小数点の等価性のためのテスト
308                                // FindBugs では、等価性のための比較は、if (Math.abs(x - y) < .0000001) が推奨されています。
309                                // return Math.abs( Double.parseDouble( val1 ) - Double.parseDouble( val2 ) ) < .0000001 ;
310                                return Double.compare( Double.parseDouble( val1 ) , Double.parseDouble( val2 ) ) == 0 ;
311                        }
312                        catch( final NumberFormatException ex ) {
313                                System.err.println( ex.getMessage() );  // 8.0.0.0 (2021/07/31)
314//                              ;       // 数値変換できなかった場合は、無視します。
315                        }
316                }
317
318                return false;
319        }
320
321        /**
322         * 変数の置き換え処理を行います。
323         *
324         * これは、org.opengion.fukurou.util.StringUtil#replaceText( String ,String ,String ,UnaryOperator&lt;String&gt; ) の簡易版です。
325         *
326         * これは、単純な変数ではなく、${env.XXX}または、{&#064;ENV..XXX} の XXX を環境変数に置き換えたり、
327         * {&#064;DATE.XXXX} を、日付文字列に置き換えたりする場合に、使用できます。
328         *
329         * fukurou.util.StringUtil#replaceText 版との違いは、1回のみの変換と、ENV と DATE を決め打ちで処理していることです。
330         * fileexec パッケージに、util  パッケージと同じクラス名のStringUtil を作ったのがそもそもの間違いで、
331         * fileexec パッケージ単独で使用していたものを、統合するにあたり、統合しきれなかったメソッドが
332         * 悪さしています。
333         *
334         * @og.rev 7.2.5.0 (2020/06/01) 新規追加
335         *
336         * @param  orgTxt 変換元の文字列
337         * @return  置換処理したテキスト
338         */
339        public static String replaceText( final String orgTxt ) {
340                // null か、ゼロ文字列か、'{' を含んでいない場合は、そのまま返します。
341                if( orgTxt == null || orgTxt.isEmpty() || orgTxt.indexOf( '{' ) < 0 ) { return orgTxt; }
342
343                final StringBuilder buf = new StringBuilder( orgTxt );
344
345                // 環境変数の処理
346                int st1 = buf.indexOf( "${env." );
347                if( st1 < 0 ) { st1 = buf.indexOf( "{@ENV." ); }                                // どちらか
348                if( st1 >= 0 ) {                                                                                                // 環境変数の処理がある
349                        final int ed1 = buf.indexOf( "}",st1+6 );
350                        final String envKey = buf.substring( st1+6,ed1 );
351                        final String envVal = nval( System.getenv( envKey ), "" );      // 未定義の場合は、ゼロ文字列
352                        buf.replace( st1,ed1+1,envVal );
353                }
354                else {                                                                                                                  // どちらか
355                        // 日付文字列の処理
356                        st1 = buf.indexOf( "{@DATE." );
357                        if( st1 >= 0 ) {                                                                                        // 日付文字列の処理がある
358                                final int ed1 = buf.indexOf( "}",st1+7 );
359                                final String dateKey = buf.substring( st1+7,ed1 );
360                                final String dateVal = getTimeFormat( dateKey );                // 未定義の場合は、ゼロ文字列
361                                buf.replace( st1,ed1+1,dateVal );
362                        }
363                }
364
365                return buf.toString();
366        }
367}