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 java.io.File; 019import java.io.PrintWriter; 020import java.io.BufferedReader; 021import java.io.IOException; 022import java.nio.charset.CharacterCodingException; // 6.3.1.0 (2015/06/28) 023import java.util.Map ; 024import java.util.LinkedHashMap ; 025 026import org.opengion.fukurou.system.OgRuntimeException ; // 6.4.2.0 (2016/01/29) 027import org.opengion.fukurou.util.Argument; 028import org.opengion.fukurou.util.FileUtil; 029import org.opengion.fukurou.system.Closer; // 8.5.4.2 (2024/01/12) PMD 7.0.0 CloseResource 対応 030import org.opengion.fukurou.system.LogWriter; 031import org.opengion.fukurou.util.CommentLineParser; 032import org.opengion.fukurou.util.FileInfo; // 6.4.0.2 (2015/12/11) 033 034/** 035 * Process_FileCopy は、上流から受け取った FileLineModel を処理する、 036 * ChainProcess インターフェースの実装クラスです。 037 * 038 * 上流から受け取った FileLineModel の ファイルから、inPath の共通パス 039 * 以下のファイルを、outPath の共通パス以下にコピーします。 040 * コピーの種類は、バイナリか、テキストで、テキストの場合は、エンコード 041 * 変換も行うことが可能です。 042 * inPath と outPath が同じ、または、outPath が未設定の場合は、入力と出力が 043 * 同じですので、自分自身のエンコード変換処理を行うことになります。 044 * 045 * コピーされるファイルのファイル名は、入力ファイル名と同一です。保存される 046 * フォルダが異なります。(同一にすることも可能です。) 047 * 048 * useOmitCmnt=true に設定すると、ファイル中のコメントを除外してコピーします。 049 * ただし、使用できるのは、アスキーファイル(binary=false)の時だけです。 050 * 051 * 上流プロセスでは、Name 属性として、『File』を持ち、値は、Fileオブジェクト 052 * である、Process_FileSearch を使用するのが、便利です。それ以外のクラスを 053 * 使用する場合でも、Name属性と、File オブジェクトを持つ LineModel を受け渡し 054 * できれば、使用可能です。 055 * 056 * 引数文字列中に空白を含む場合は、ダブルコーテーション("") で括って下さい。 057 * 引数文字列の 『=』 の前後には、空白は挟めません。必ず、-key=value の様に 058 * 繋げてください。 059 * 060 * @og.formSample 061 * Process_FileCopy -inPath=入力共通パス -inEncode=Windows-31J -outPath=出力共通パス -outEncode=UTF-8 062 * 063 * -inPath=入力共通パス ：上流で検索されたファイルパスの共通部分 064 * [ -inEncode=入力エンコード ] ：入力ファイルのエンコードタイプ 065 * [ -outPath=出力共通パス ] ：出力するファイルパスの共通部分 066 * [ -outEncode=出力エンコード ] ：出力ファイルのエンコードタイプ 067 * [ -binary=[false/true] ] ：trueは、バイナリファイルのコピー(初期値:false) 068 * [ -changeCrLf=[false/true] ] ：trueは、バイナリファイルのコピー時にCR+LFに変換します(初期値:false) 069 * [ -keepTimeStamp=[false/true]] ：trueは、コピー元のファイルのタイムスタンプで作成します(初期値:false) 070 * [ -useOmitCmnt=[false/true] ] ：ファイル中のコメントを除外してコピーを行うかどうかを指定(初期値:false) 071 * [ -display=[false/true] ] ：trueは、コピー状況を表示します(初期値:false) 072 * [ -debug=[false/true] ] ：デバッグ情報を標準出力に表示する(true)かしない(false)か(初期値:false[表示しない]) 073 * 074 * @version 4.0 075 * @author Kazuhiko Hasegawa 076 * @since JDK5.0, 077 */ 078public class Process_FileCopy extends AbstractProcess implements ChainProcess { 079 private File tempFile ; 080 081 private String inPath ; 082 private String inEncode ; 083 private String outPath ; 084 private String outEncode ; 085 private boolean binary ; 086 private boolean changeCrLf ; // 4.2.2.0 (2008/05/10) 087 private boolean keepTimeStamp ; // 5.1.5.0 (2010/04/01) 088 private boolean useOmitCmnt ; // 5.7.4.0 (2014/03/07) 089 private boolean display ; 090 private boolean debug ; // 5.7.3.0 (2014/02/07) デバッグ情報 091 092 private int inPathLen ; 093 private boolean isEquals ; 094 private int inCount ; 095 096 /** staticイニシャライザ後、読み取り専用にするので、ConcurrentHashMap を使用しません。 */ 097 private static final Map<String,String> MUST_PROPARTY ; // ［プロパティ］必須チェック用 Map 098 /** staticイニシャライザ後、読み取り専用にするので、ConcurrentHashMap を使用しません。 */ 099 private static final Map<String,String> USABLE_PROPARTY ; // ［プロパティ］整合性チェック Map 100 101 static { 102 MUST_PROPARTY = new LinkedHashMap<>(); 103 MUST_PROPARTY.put( "inPath", "コピー元のファイル基準パス" ); 104 105 USABLE_PROPARTY = new LinkedHashMap<>(); 106 USABLE_PROPARTY.put( "inEncode", "コピー元のファイルのエンコードタイプ" ); 107 USABLE_PROPARTY.put( "outPath", "コピー先のファイル基準パス" ); 108 USABLE_PROPARTY.put( "outEncode", "コピー先のファイルのエンコードタイプ" ); 109 USABLE_PROPARTY.put( "binary", "trueは、バイナリファイルをコピーします(初期値:false)" ); 110 USABLE_PROPARTY.put( "changeCrLf", "trueは、バイナリファイルのコピー時にCR+LFに変換します(初期値:false)" ); // 4.2.2.0 (2008/05/10) 111 USABLE_PROPARTY.put( "keepTimeStamp","trueは、コピー元のファイルのタイムスタンプで作成します(初期値:false)" ); // 5.1.5.0 (2010/04/01) 112 USABLE_PROPARTY.put( "useOmitCmnt" ,"ファイル中のコメントを除外してコピーを行うかどうかを指定(初期値:false)" ); // 5.7.4.0 (2014/03/07) 113 USABLE_PROPARTY.put( "display", "trueは、コピー状況を表示します(初期値:false)" ); 114 USABLE_PROPARTY.put( "debug", "デバッグ情報を標準出力に表示する(true)かしない(false)か" + 115 CR + "(初期値:false:表示しない)" ); // 5.7.3.0 (2014/02/07) デバッグ情報 116 } 117 118 /** 119 * デフォルトコンストラクター。 120 * このクラスは、動的作成されます。デフォルトコンストラクターで、 121 * super クラスに対して、必要な初期化を行っておきます。 122 * 123 */ 124 public Process_FileCopy() { 125 super( "org.opengion.fukurou.process.Process_FileCopy",MUST_PROPARTY,USABLE_PROPARTY ); 126 } 127 128 /** 129 * プロセスの初期化を行います。初めに一度だけ、呼び出されます。 130 * 初期処理(ファイルオープン、ＤＢオープン等)に使用します。 131 * 132 * @og.rev 4.2.2.0 (2008/05/10) changeCrLf 属性対応 133 * @og.rev 5.1.5.0 (2010/04/01) keepTimeStamp 属性の追加 134 * 135 * @param paramProcess データベースの接続先情報などを持っているオブジェクト 136 */ 137 public void init( final ParamProcess paramProcess ) { 138 final Argument arg = getArgument(); 139 140 inPath = arg.getProparty( "inPath" ); 141 outPath = arg.getProparty( "outPath" ); 142 inEncode = arg.getProparty( "inEncode" ,System.getProperty("file.encoding") ); 143 outEncode = arg.getProparty( "outEncode" ,System.getProperty("file.encoding") ); 144 binary = arg.getProparty( "binary" ,binary ); 145 changeCrLf = arg.getProparty( "changeCrLf" ,changeCrLf ); // 4.2.2.0 (2008/05/10) 146 keepTimeStamp = arg.getProparty( "keepTimeStamp" ,keepTimeStamp ); // 5.1.5.0 (2010/04/01) 147 useOmitCmnt = arg.getProparty( "useOmitCmnt" ,useOmitCmnt ); // 5.7.4.0 (2014/03/07) 148 display = arg.getProparty( "display" ,display ); 149 debug = arg.getProparty( "debug" ,debug ); // 5.7.3.0 (2014/02/07) デバッグ情報 150 151 // 入力と出力が同じか？ 152 isEquals = outPath == null || inPath.equalsIgnoreCase( outPath ); 153 inPathLen = inPath.length(); 154 155 if( binary ) { 156 // 4.2.2.0 (2008/05/10) 判定ミスの修正 157 if( ! inEncode.equalsIgnoreCase( outEncode ) ) { 158 final String errMsg = "バイナリコピー時には、入出力のエンコードは同じ必要があります。" + CR 159 + " inEncode=[" + inEncode + "] , outEncode=[" + outEncode + "]" ; 160 throw new OgRuntimeException( errMsg ); 161 } 162 if( isEquals ) { 163 final String errMsg = "入出力が同じファイルのバイナリコピーはできません。" + CR 164 + " inPath=[" + inPath + "] , outPath=[" + outPath + "]" ; 165 throw new OgRuntimeException( errMsg ); 166 } 167 // 5.7.4.0 (2014/03/07) コメント部分を削除する機能は、binary では使えません。 168 if( useOmitCmnt ) { 169 final String errMsg = "コメント部分を削除する機能(useOmitCmnt=true)は、バイナリコピーでは使えません。" + CR 170 + " inPath=[" + inPath + "] , outPath=[" + outPath + "]" ; 171 throw new OgRuntimeException( errMsg ); 172 } 173 } 174 175 // 入力と出力が同じ場合は、中間ファイルを作成します。 176 if( isEquals ) { 177 try { 178 tempFile = File.createTempFile( "X", ".tmp", new File( outPath ) ); 179 tempFile.deleteOnExit(); 180 } 181 catch( final IOException ex ) { 182 final String errMsg = "中間ファイル作成でエラーが発生しました。" + CR 183 + " outPath=[" + outPath + "]" ; 184 throw new OgRuntimeException( errMsg,ex ); 185 } 186 } 187 } 188 189 /** 190 * プロセスの終了を行います。最後に一度だけ、呼び出されます。 191 * 終了処理(ファイルクローズ、ＤＢクローズ等)に使用します。 192 * 193 * @param isOK トータルで、OKだったかどうか[true:成功/false:失敗] 194 */ 195 public void end( final boolean isOK ) { 196 tempFile = null; 197 } 198 199 /** 200 * 引数の LineModel を処理するメソッドです。 201 * 変換処理後の LineModel を返します。 202 * 後続処理を行わない場合(データのフィルタリングを行う場合)は、 203 * null データを返します。つまり、null データは、後続処理を行わない 204 * フラグの代わりにも使用しています。 205 * なお、変換処理後の LineModel と、オリジナルの LineModel が、 206 * 同一か、コピー(クローン)かは、各処理メソッド内で決めています。 207 * ドキュメントに明記されていない場合は、副作用が問題になる場合は、 208 * 各処理ごとに自分でコピー(クローン)して下さい。 209 * 210 * @og.rev 4.0.0.0 (2007/11/28) メソッドの戻り値をチェックします。 211 * @og.rev 4.2.2.0 (2008/05/10) changeCrLf 属性対応 212 * @og.rev 4.2.3.0 (2008/05/26) LineModel が FileLineModel でない場合の処理 213 * @og.rev 5.1.5.0 (2010/04/01) keepTimeStamp 属性の追加 214 * @og.rev 5.1.6.0 (2010/05/01) changeCrLf 属性が、.FileUtil#changeCrLfcopy メソッドへの移動に伴う対応 215 * @og.rev 5.7.2.2 (2014/01/24) エラー時にデータも出力します。 216 * @og.rev 6.3.1.0 (2015/06/28) nioを使用すると UTF-8とShuft-JISで、エラーになる。 217 * @og.rev 6.4.0.2 (2015/12/11) CommentLineParser 改造。 218 * @og.rev 6.4.7.1 (2016/06/17) エンコードエラーの緩和。 219 * @og.rev 8.5.3.2 (2023/10/13) JDK21対応。FileLineModel の修正に伴う変更。 220 * @og.rev 8.5.4.2 (2024/01/12) PMD 7.0.0 CloseResource 対応 221 * 222 * @param data オリジナルのLineModel 223 * 224 * @return 処理変換後のLineModel 225 */ 226 @Override // ChainProcess 227 public LineModel action( final LineModel data ) { 228 inCount++ ; 229 final FileLineModel fileData ; 230 if( data instanceof FileLineModel ) { 231 fileData = (FileLineModel)data ; 232 } 233 else { 234 // LineModel が FileLineModel でない場合、オブジェクトを作成します。 235 fileData = new FileLineModel( data ); 236 fileData.copyLineModel( data ); // 8.5.3.2 (2023/10/13) JDK21対応 237 } 238 239 if( debug ) { println( "Before:" + data.dataLine() ); } // 5.1.2.0 (2010/01/01) display の条件変更 240 241 final File inFile = fileData.getFile() ; 242 if( ! inFile.isFile() ) { 243 if( display ) { println( data.dataLine() ); } // 5.1.2.0 (2010/01/01) display の条件変更 244 return data; 245 } 246 247 // ファイル名を作成します。 248 // ファイル名は、引数ファイル名 から、inPath を引き、outPath を加えます。 249 final File outFile = new File( outPath, inFile.getAbsolutePath().substring( inPathLen ) ); 250 fileData.setFile( outFile ); 251 252 // 入出力が異なる場合 253 if( !isEquals ) { 254 tempFile = outFile; 255 final File parent = outFile.getParentFile(); 256 if( parent != null && ! parent.exists() && !parent.mkdirs() ) { 257 final String errMsg = "所定のフォルダが作成できませんでした。[" + parent + "]" + CR 258 + " inCount=[" + inCount + "]件" + CR 259 + " data=[" + data.dataLine() + "]" + CR ; // 5.7.2.2 (2014/01/24) エラー時にデータも出力します。 260 throw new OgRuntimeException( errMsg ); 261 } 262 } 263 264 if( binary ) { 265 // 5.1.6.0 (2010/05/01) changeCrLfcopy 対応 266 if( changeCrLf ) { FileUtil.changeCrLfcopy( inFile,tempFile ); } 267 else { FileUtil.copy( inFile,tempFile,keepTimeStamp ); } 268 } 269 else { 270 // 8.5.4.2 (2024/01/12) PMD 7.0.0 CloseResource 対応 271 final BufferedReader reader = FileUtil.getBufferedReader( inFile ,inEncode ); 272 final PrintWriter writer = FileUtil.getPrintWriter( tempFile ,outEncode ); 273 274 try { 275 // try ( BufferedReader reader = FileUtil.getBufferedReader( inFile ,inEncode ); 276 // PrintWriter writer = FileUtil.getPrintWriter( tempFile ,outEncode ) ) { 277 String line1; 278 if( useOmitCmnt ) { // 5.7.4.0 (2014/03/07) コメント部分を削除してコピー 279 // 6.4.0.2 (2015/12/11) CommentLineParser 改造 280 final CommentLineParser clp = new CommentLineParser( FileInfo.getSUFIX( inFile ) ); 281 while((line1 = reader.readLine()) != null) { 282 line1 = clp.line( line1 ); 283 if( line1 != null ) { 284 writer.println( line1 ); 285 } 286 } 287 } 288 else { 289 // 従来のコピー。ループ中で、if するのが嫌だったので、分離しました。 290 while((line1 = reader.readLine()) != null) { 291 writer.println( line1 ); 292 } 293 } 294 } 295 // 6.3.1.0 (2015/06/28) nioを使用すると UTF-8とShuft-JISで、エラーになる。 296 catch( final CharacterCodingException ex ) { 297 final String errMsg = "文字のエンコード・エラーが発生しました。" + CR 298 + " ファイルのエンコードが指定のエンコードと異なります。" + CR 299 + " [" + inFile.getPath() + "] , Encode=[" + inEncode + "]" + CR 300 + ex.getMessage(); 301 // 6.4.7.1 (2016/06/17) エンコードエラーの緩和。 302 // throw new OgRuntimeException( errMsg,ex ); 303 System.err.println( errMsg ); 304 return null; // 後続の処理を中断する。 305 } 306 catch( final IOException ex ) { 307 final String errMsg = "ファイルコピー中に例外が発生しました。[" + data.getRowNo() + "]件目" + CR 308 + " inFile=[" + inFile + "] , tempFile=[" + tempFile + "]" + CR 309 + " data=[" + data.dataLine() + "]" + CR ; // 5.7.2.2 (2014/01/24) エラー時にデータも出力します。 310 throw new OgRuntimeException( errMsg,ex ); 311 } 312 finally { 313 Closer.ioClose( reader ) ; 314 Closer.ioClose( writer ) ; 315 } 316 } 317 318 if( isEquals ) { 319 if( !outFile.delete() ) { 320 final String errMsg = "所定のファイルを削除できませんでした。[" + outFile + "]" + CR 321 + " inCount=[" + inCount + "]件" + CR 322 + " data=[" + data.dataLine() + "]" + CR ; // 5.7.2.2 (2014/01/24) エラー時にデータも出力します。 323 throw new OgRuntimeException( errMsg ); 324 } 325 326 if( !tempFile.renameTo( outFile ) ) { 327 final String errMsg = "所定のファイルをリネームできませんでした。[" + tempFile + "]" + CR 328 + " inCount=[" + inCount + "]件" + CR 329 + " data=[" + data.dataLine() + "]" + CR ; // 5.7.2.2 (2014/01/24) エラー時にデータも出力します。 330 throw new OgRuntimeException( errMsg ); 331 } 332 } 333 334 // 5.1.5.0 (2010/04/01) keepTimeStamp 属性の追加 335 // 6.0.0.1 (2014/04/25) These nested if statements could be combined 336 337 if( keepTimeStamp && !outFile.setLastModified( inFile.lastModified() ) ) { 338 final String errMsg = "lastModified 時間の設定が、できませんでした。[" + outFile + "]" + CR 339 + " inCount=[" + inCount + "]件" + CR 340 + " data=[" + data.dataLine() + "]" + CR ; // 5.7.2.2 (2014/01/24) エラー時にデータも出力します。 341 throw new OgRuntimeException( errMsg ); 342 } 343 344 if( display ) { println( data.dataLine() ); } // 5.1.2.0 (2010/01/01) display の条件変更 345 return data ; 346 } 347 348 /** 349 * プロセスの処理結果のレポート表現を返します。 350 * 処理プログラム名、入力件数、出力件数などの情報です。 351 * この文字列をそのまま、標準出力に出すことで、結果レポートと出来るような 352 * 形式で出してください。 353 * 354 * @return 処理結果のレポート 355 */ 356 public String report() { 357 // 7.2.9.5 (2020/11/28) PMD:Consider simply returning the value vs storing it in local variable 'XXXX' 358 return "[" + getClass().getName() + "]" + CR 359// final String report = "[" + getClass().getName() + "]" + CR 360 + TAB + "Copy Count : " + inCount + CR 361 + TAB + "inPath : " + inPath + CR 362 + TAB + "inEncode : " + inEncode + CR 363 + TAB + "outPath : " + outPath + CR 364 + TAB + "outEncode : " + outEncode + CR 365 + TAB + "binary : " + binary ; 366 367// return report ; 368 } 369 370 /** 371 * このクラスの使用方法を返します。 372 * 373 * @return このクラスの使用方法 374 * @og.rtnNotNull 375 */ 376 public String usage() { 377 final StringBuilder buf = new StringBuilder( BUFFER_LARGE ) 378 .append( "Process_FileCopy は、上流から受け取った FileLineModelを処理する、" ).append( CR ) 379 .append( "ChainProcess インターフェースの実装クラスです。" ).append( CR ) 380 .append( CR ) 381 .append( "上流から受け取った FileLineModel の ファイルから、inPath の共通パス" ).append( CR ) 382 .append( "以下のファイルを、outPath の共通パス以下にコピーします。" ).append( CR ) 383 .append( "コピーの種類は、バイナリか、テキストで、テキストの場合は、エンコード" ).append( CR ) 384 .append( "変換も行うことが可能です。" ).append( CR ) 385 .append( "inPath と outPath が同じ、または、outPath が未設定の場合は、入力と出力が" ).append( CR ) 386 .append( "同じですので、自分自身のエンコード変換処理を行うことになります。" ).append( CR ) 387 .append( CR ) 388 .append( "コピーされるファイルのファイル名は、入力ファイル名と同一です。保存される" ).append( CR ) 389 .append( "フォルダが異なります。(同一にすることも可能です。)" ).append( CR ) 390 .append( CR ) 391// .append( "上流プロセスでは、Name 属性として、『File』を持ち、値は、Fileオブジェクト" ).append( CR ) 392// .append( "である、Process_FileSearch を使用するのが、便利です。それ以外のクラスを" ).append( CR ) 393// .append( "使用する場合でも、Name属性と、File オブジェクトを持つ LineModel を受け渡し" ).append( CR ) 394// .append( "できれば、使用可能です。" ).append( CR ) 395 .append( CHAIN_FILE_USAGE ) // 8.5.6.1 (2024/03/29) 継承元使用 ※ 位置も変更します。 396 .append( CR ) 397// .append( "引数文字列中に空白を含む場合は、ダブルコーテーション(\"\") で括って下さい。" ).append( CR ) 398// .append( "引数文字列の 『=』 の前後には、空白は挟めません。必ず、-key=value の様に" ).append( CR ) 399// .append( "繋げてください。" ).append( CR ) 400 .append( PROCESS_PARAM_USAGE ) // 8.5.6.1 (2024/03/29) 継承元使用 401 .append( CR ).append( CR ) 402 .append( getArgument().usage() ).append( CR ); 403 404 return buf.toString(); 405 } 406 407 /** 408 * このクラスは、main メソッドから実行できません。 409 * 410 * @param args コマンド引数配列 411 */ 412 public static void main( final String[] args ) { 413 LogWriter.log( new Process_FileCopy().usage() ); 414 } 415}