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