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.fukurou.process; 017 018import org.opengion.fukurou.system.OgRuntimeException ; // 6.4.2.0 (2016/01/29) 019import org.opengion.fukurou.security.HybsCryptography; 020import org.opengion.fukurou.util.Argument; 021import org.opengion.fukurou.util.StringUtil; 022import org.opengion.fukurou.system.LogWriter; 023 024import java.util.Map ; 025import java.util.LinkedHashMap ; 026 027/** 028 * Process_StringUtil は、上流から受け取ったデータをStringUtilクラスの特定の 029 * メソッドでデータ変換する、CainProcess インターフェースの実装クラスです。 030 * 031 * 上流(プロセスチェインのデータは上流から下流へと渡されます。)から 032 * LineModel を元に、指定のカラムの文字を、変換します。 033 * 034 * 現時点で利用できるStringUtil のメソッドは、下記の通りです。 035 * urlEncode : UTF-8 で、URLエンコードを行う。 036 * rTrim : 文字列の後ろのスペースを削除 037 * htmlFilter : HTML上のエスケープ文字を変換 038 * code39 : CODE39 の 文字列を作成(チェックデジット付き) 039 * getUnicodeEscape : HTML のエスケープ記号(&#xZZZZ;)に変換 040 * getReplaceEscape : HTML のエスケープ記号(&#xZZZZ;)を戻す 041 * spanCut : 引数からspanタグを取り除く 042 * 043 * HybsCryptography のメソッドも呼び出せます。 044 * getMD5 : MessageDigestにより、MD5 でハッシュした文字に変換 045 * encrypt : Hybs独自の暗号化を行います(Hybs内部設定の秘密鍵) 046 * decrypt : Hybs独自の復号化を行います(Hybs内部設定の秘密鍵) 047 * 048 * action=getMD5 等は、動的にメソッドを生成して bat 等で使用します。 049 * 050 * 引数文字列中にスペースを含む場合は、ダブルコーテーション("") で括って下さい。 051 * 引数文字列の 『=』の前後には、スペースは挟めません。必ず、-key=value の様に 052 * 繋げてください。 053 * 054 * @og.formSample 055 * Process_StringUtil -action=getMD5|encrypt|decrypt|code39|getUnicodeEscape|getReplaceEscape|・・・ -keys=AA,BB,CC 056 * 057 * -action=ESC|REV :StringUtilクラスの特定のメソッド名を指定します(必須)。 058 * urlEncode|rTrim|htmlFilter|getMD5|code39|getUnicodeEscape|getReplaceEscape|spanCut 059 * -keys=AA,BB,CC :変換するカラムをCSV形式で複数指定できます(必須)。 060 * [ -display=[false/true]] :結果を標準出力に表示する(true)かしない(false)か(初期値:false[表示しない]) 061 * [ -debug=[false/true] ] :デバッグ情報を標準出力に表示する(true)かしない(false)か(初期値:false[表示しない]) 062 * 063 * @og.rev 5.0.0.2 (2009/09/15) 新規クラス作成 064 * 065 * @version 0.9.0 2004/02/27 066 * @author Kazuhiko Hasegawa 067 * @since JDK5.0, 068 */ 069public class Process_StringUtil extends AbstractProcess implements ChainProcess { 070 071 private static final String STR_ACTION_BASE = "org.opengion.fukurou.process.Process_StringUtil$SU_" ; 072 073 private String keys ; // 変換するカラム名配列のアドレス 074 private int[] clmNos ; // 変換するカラム名配列のアドレス 075 private boolean display ; // 表示しない 076 private boolean debug ; // 5.7.3.0 (2014/02/07) デバッグ情報 077 078 private boolean firstRow = true; // 最初の一行目 079 private int count ; 080 private StrAction stAction ; // Ver 5.0.0.2 (2009/09/15) 081 082 /** staticイニシャライザ後、読み取り専用にするので、ConcurrentHashMap を使用しません。 */ 083 private static final Map<String,String> MUST_PROPARTY ; // [プロパティ]必須チェック用 Map 084 /** staticイニシャライザ後、読み取り専用にするので、ConcurrentHashMap を使用しません。 */ 085 private static final Map<String,String> USABLE_PROPARTY ; // [プロパティ]整合性チェック Map 086 087 static { 088 MUST_PROPARTY = new LinkedHashMap<>(); 089 MUST_PROPARTY.put( "action", "StringUtilの特定のメソッドを指定します(必須)" + 090 CR + "urlEncode , rTrim , htmlFilter , getMD5 , encrypt , decrypt , code39 , getUnicodeEscape , getReplaceEscape , spanCut" ); 091 092 MUST_PROPARTY.put( "keys", "変換するカラムをCSV形式で複数指定できます(必須)。" ); 093 094 USABLE_PROPARTY = new LinkedHashMap<>(); 095 USABLE_PROPARTY.put( "display", "結果を標準出力に表示する(true)かしない(false)か" + 096 CR + " (初期値:false[表示しない])" ); 097 USABLE_PROPARTY.put( "debug", "デバッグ情報を標準出力に表示する(true)かしない(false)か" + 098 CR + "(初期値:false:表示しない)" ); // 5.7.3.0 (2014/02/07) デバッグ情報 099 } 100 101 /** 102 * デフォルトコンストラクター。 103 * このクラスは、動的作成されます。デフォルトコンストラクターで、 104 * super クラスに対して、必要な初期化を行っておきます。 105 * 106 */ 107 public Process_StringUtil() { 108 super( "org.opengion.fukurou.process.Process_StringUtil",MUST_PROPARTY,USABLE_PROPARTY ); 109 } 110 111 /** 112 * プロセスの初期化を行います。初めに一度だけ、呼び出されます。 113 * 初期処理(ファイルオープン、DBオープン等)に使用します。 114 * 115 * @param paramProcess データベースの接続先情報などを持っているオブジェクト 116 */ 117 public void init( final ParamProcess paramProcess ) { 118 final Argument arg = getArgument(); 119 120 keys = arg.getProparty( "keys",keys ); 121 display = arg.getProparty( "display",display ); 122 debug = arg.getProparty("debug",debug); // 5.7.3.0 (2014/02/07) デバッグ情報 123 124 final String act = arg.getProparty( "action" ); 125 126 stAction = (StrAction)StringUtil.newInstance( STR_ACTION_BASE + act ); 127 } 128 129 /** 130 * 引数の LineModel を処理するメソッドです。 131 * 変換処理後の LineModel を返します。 132 * 後続処理を行わない場合(データのフィルタリングを行う場合)は、 133 * null データを返します。つまり、null データは、後続処理を行わない 134 * フラグの代わりにも使用しています。 135 * なお、変換処理後の LineModel と、オリジナルの LineModel が、 136 * 同一か、コピー(クローン)かは、各処理メソッド内で決めています。 137 * ドキュメントに明記されていない場合は、副作用が問題になる場合は、 138 * 各処理ごとに自分でコピー(クローン)して下さい。 139 * 140 * @param data オリジナルのLineModel 141 * 142 * @return 処理変換後のLineModel 143 */ 144 public LineModel action( final LineModel data ) { 145 count++ ; 146 try { 147 if( firstRow ) { 148 makeColumnNos( data ); 149 firstRow = false; 150 if( display ) { println( data.nameLine() ); } // 5.7.3.0 (2014/02/07) デバッグ情報 151 } 152 153 if( debug ) { println( "Before:" + data.dataLine() ); } // 5.1.2.0 (2010/01/01) display の条件変更 154 for( int i=0; i<clmNos.length; i++ ) { 155 final String val = (String)data.getValue( clmNos[i] ) ; 156 data.setValue( clmNos[i],stAction.change( val ) ); 157 } 158 159 if( debug ) { println( "After :" + data.dataLine() ); } // 5.1.2.0 (2010/01/01) display の条件変更 160 else if( display ) { println( data.dataLine() ); } // 5.1.2.0 (2010/01/01) display の条件変更 161 } 162 catch( final Throwable ex ) { 163 final String errMsg = "row=[" + count + "]" + CR + 164 " data=[" + data + "]" + CR ; 165 throw new OgRuntimeException( errMsg,ex ); 166 } 167 return data; 168 } 169 170 /** 171 * プロセスの終了を行います。最後に一度だけ、呼び出されます。 172 * 終了処理(ファイルクローズ、DBクローズ等)に使用します。 173 * 174 * @param isOK トータルで、OKだったかどうか[true:成功/false:失敗] 175 */ 176 public void end( final boolean isOK ) { 177 keys = null; // 変換するカラム名配列のアドレス 178 clmNos = null; // 変換するカラム名配列のアドレス 179 } 180 181 /** 182 * プロセスの処理結果のレポート表現を返します。 183 * 処理プログラム名、入力件数、出力件数などの情報です。 184 * この文字列をそのまま、標準出力に出すことで、結果レポートと出来るような 185 * 形式で出してください。 186 * 187 * @return 処理結果のレポート 188 */ 189 public String report() { 190 // 7.2.9.5 (2020/11/28) PMD:Consider simply returning the value vs storing it in local variable 'XXXX' 191 return "[" + getClass().getName() + "]" + CR 192// final String report = "[" + getClass().getName() + "]" + CR 193 + TAB + "Output Count : " + count ; 194 195// return report ; 196 } 197 198 /** 199 * カラム番号配列を取得します。 200 * 繰返し処理を行う場合に、事前にアドレスでアクセスできるように処理するカラム番号を 201 * キャッシュしておきます。 202 * 203 * @param data LineModelオブジェクト 204 */ 205 private void makeColumnNos( final LineModel data ) { 206 final String[] clms = StringUtil.csv2Array( keys ); 207 final int size = clms.length; 208 clmNos = new int[size]; 209 for( int i=0; i<size; i++ ) { 210 clmNos[i] = data.getColumnNo( clms[i] ); 211 } 212 } 213 214 /** 215 * このクラスの使用方法を返します。 216 * 217 * @return このクラスの使用方法 218 * @og.rtnNotNull 219 */ 220 public String usage() { 221 final StringBuilder buf = new StringBuilder( BUFFER_LARGE ) 222 .append( "Process_StringUtil は、上流から受け取ったデータをStringUtilクラスの特定の" ).append( CR ) 223 .append( "メソッドでデータ変換する、CainProcess インターフェースの実装クラスです。" ).append( CR ) 224 .append( CR ) 225 .append( "上流(プロセスチェインのデータは上流から下流へと渡されます。)から" ).append( CR ) 226 .append( " LineModel を元に、指定のカラムの文字を、変換します。" ).append( CR ) 227 .append( CR ) 228 .append( "現時点で利用できるStringUtil のメソッドは、下記の通りです。" ).append( CR ) 229 .append( " urlEncode : UTF-8 で、URLエンコードを行う。" ).append( CR ) 230 .append( " rTrim : 文字列の後ろのスペースを削除" ).append( CR ) 231 .append( " htmlFilter : HTML上のエスケープ文字を変換" ).append( CR ) 232 .append( " code39 : CODE39 の 文字列を作成(チェックデジット付き)" ).append( CR ) 233 .append( " getUnicodeEscape : HTML のエスケープ記号(&#xZZZZ;)に変換" ).append( CR ) 234 .append( " getReplaceEscape : HTML のエスケープ記号(&#xZZZZ;)を戻す" ).append( CR ) 235 .append( " spanCut : 引数からspanタグを取り除く" ).append( CR ) 236 .append( CR ) 237 .append( "HybsCryptography のメソッドも呼び出せます。" ).append( CR ) 238 .append( " getMD5 : MessageDigestにより、MD5 でハッシュした文字に変換" ).append( CR ) 239 .append( " encrypt : Hybs独自の暗号化を行います(Hybs内部設定の秘密鍵)" ).append( CR ) 240 .append( " decrypt : Hybs独自の復号化を行います(Hybs内部設定の秘密鍵)" ).append( CR ) 241 .append( CR ) 242 .append( "引数文字列中に空白を含む場合は、ダブルコーテーション(\"\") で括って下さい。" ).append( CR ) 243 .append( "引数文字列の 『=』の前後には、空白は挟めません。必ず、-key=value の様に" ).append( CR ) 244 .append( "繋げてください。" ).append( CR ) 245 .append( CR ).append( CR ) 246 .append( getArgument().usage() ).append( CR ); 247 248 return buf.toString(); 249 } 250 251 /** 252 * このクラスは、main メソッドから実行できません。 253 * 254 * @param args コマンド引数配列 255 */ 256 public static void main( final String[] args ) { 257 LogWriter.log( new Process_StringUtil().usage() ); 258 } 259 260 /** 261 * インナークラスとして、共通メソッドを定義します(I/Fの代わり)。 262 * 263 * ※ このクラスは継承されるため、final化しません。 264 */ 265 private static class StrAction { 266 /** 267 * 引数を変換します。 268 * 269 * @param val 引数 270 * @return 変換された文字列 271 */ 272 public String change( final String val ) { 273 return val; 274 } 275 } 276 277 /** 278 * UTF-8 で、URLエンコードを行います。 279 * 280 * acitonで指定されたキーワードで動的に生成され bat 等で使用します。 281 */ 282 private static final class SU_urlEncode extends StrAction { 283 /** 284 * 引数を変換します。 285 * 286 * @param val 引数 287 * @return 変換された文字列 288 */ 289 @Override 290 public String change( final String val ) { 291 return StringUtil.urlEncode( val ); 292 } 293 } 294 295 /** 296 * 文字列の後ろのスペースを削除します。 297 * 注意:'\u0020' (スペース文字) より小さい文字を切り取ります。 298 * 299 * acitonで指定されたキーワードで動的に生成され bat 等で使用します。 300 */ 301 private static final class SU_rTrim extends StrAction { 302 /** 303 * 引数を変換します。 304 * 305 * @param val 引数 306 * @return 変換された文字列 307 */ 308 @Override 309 public String change( final String val ) { 310 return StringUtil.rTrim( val ); 311 } 312 } 313 314 /** 315 * HTML上のエスケープ文字を変換します。 316 * 317 * acitonで指定されたキーワードで動的に生成され bat 等で使用します。 318 */ 319 private static final class SU_htmlFilter extends StrAction { 320 /** 321 * 引数を変換します。 322 * 323 * @param val 引数 324 * @return 変換された文字列 325 */ 326 @Override 327 public String change( final String val ) { 328 return StringUtil.htmlFilter( val ); 329 } 330 } 331 332 /** 333 * CODE39 の 文字列を作成します。(チェックデジット付き) 334 * 335 * acitonで指定されたキーワードで動的に生成され bat 等で使用します。 336 */ 337 private static final class SU_code39 extends StrAction { 338 /** 339 * 引数を変換します。 340 * 341 * @param val 引数 342 * @return 変換された文字列 343 */ 344 @Override 345 public String change( final String val ) { 346 return StringUtil.code39( val,true ); 347 } 348 } 349 350 /** 351 * Unicode文字列の値を HTML のエスケープ記号(&#xZZZZ;)に変換します。 352 * 353 * acitonで指定されたキーワードで動的に生成され bat 等で使用します。 354 */ 355 private static final class SU_getUnicodeEscape extends StrAction { 356 /** 357 * 引数を変換します。 358 * 359 * @param val 引数 360 * @return 変換された文字列 361 */ 362 @Override 363 public String change( final String val ) { 364 return StringUtil.getUnicodeEscape( val ); 365 } 366 } 367 368 /** 369 * HTML のエスケープ記号(&#xZZZZ;)をUnicode文字列に戻します。 370 * 371 * acitonで指定されたキーワードで動的に生成され bat 等で使用します。 372 */ 373 private static final class SU_getReplaceEscape extends StrAction { 374 /** 375 * 引数を変換します。 376 * 377 * @param val 引数 378 * @return 変換された文字列 379 */ 380 @Override 381 public String change( final String val ) { 382 return StringUtil.getReplaceEscape( val ); 383 } 384 } 385 386 /** 387 * 引数からspanタグを取り除いて返します。 388 * 389 * acitonで指定されたキーワードで動的に生成され bat 等で使用します。 390 */ 391 private static final class SU_spanCut extends StrAction { 392 /** 393 * 引数を変換します。 394 * 395 * @param val 引数 396 * @return 変換された文字列 397 */ 398 @Override 399 public String change( final String val ) { 400 return StringUtil.spanCut( val ); 401 } 402 } 403 404 /** 405 * MessageDigestにより、MD5 でハッシュした文字に変換します。 406 * 407 * acitonで指定されたキーワードで動的に生成され bat 等で使用します。 408 * 409 * @og.rev 5.2.2.0 (2010/11/01) util.StringUtil から security.HybsCryptography へ移動 410 * @og.rev 8.1.2.0 (2022/03/10) getMD5 メソッドを getHash メソッドに変更 411 * 412 */ 413 private static final class SU_getMD5 extends StrAction { 414 /** 415 * 引数を変換します。 416 * 417 * @param val 引数 418 * @return 変換された文字列 419 */ 420 @Override 421 public String change( final String val ) { 422// return HybsCryptography.getMD5( val ); // 8.1.2.0 (2022/03/10) Modify 423 return HybsCryptography.getHash( "MD5", val ); 424 } 425 } 426 427 /** 428 * Hybs独自の暗号化を行います(Hybs内部設定の秘密鍵) 429 * 430 * acitonで指定されたキーワードで動的に生成され bat 等で使用します。 431 * 432 * @og.rev 5.2.2.0 (2010/11/01) 新規追加 433 */ 434 private static final class SU_encrypt extends StrAction { 435 private HybsCryptography crpt ; 436 437 /** 438 * 引数を変換します。 439 * 440 * @param val 引数 441 * @return 変換された文字列 442 */ 443 @Override 444 public String change( final String val ) { 445 if( crpt == null ) { 446 crpt = new HybsCryptography(); 447 } 448 return crpt.encrypt( val ); 449 } 450 } 451 452 /** 453 * Hybs独自の復号化を行います(Hybs内部設定の秘密鍵) 454 * 455 * acitonで指定されたキーワードで動的に生成され bat 等で使用します。 456 * 457 * @og.rev 5.2.2.0 (2010/11/01) 新規追加 458 */ 459 private static final class SU_decrypt extends StrAction { 460 private HybsCryptography crpt ; 461 462 /** 463 * 引数を変換します。 464 * 465 * @param val 引数 466 * @return 変換された文字列 467 */ 468 @Override 469 public String change( final String val ) { 470 if( crpt == null ) { 471 crpt = new HybsCryptography(); 472 } 473 return crpt.decrypt( val ); 474 } 475 } 476}