/**
 * ${jpp:disclaimer}
 *
 * ${jpp:copyright}
**/
package report;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;

import com.inet.pdfc.PDFComparer;
import com.inet.pdfc.error.PdfcException;
import com.inet.pdfc.presenter.BasePresenter;
import com.inet.pdfc.presenter.ReportPresenter;
import com.inet.pdfc.results.ResultModel;

import util.SampleUtil;

/**
 * A Sample for export to pdf file the comparing between 2 PDF Files,
 * for the case to change the export path.
 *
 * Expected 3 arguments: the path of the 2 PDF files that will be compared
 * and the path for the export file. If the export file does not exist,
 * a new file will be created.
 *
 * Similar to CompareAndExportToSpecificFilename
 */
public class ReportingToSpecificFilename {

    public static void main( String[] args ) {
        SampleUtil.init();
        File[] files = getFileOfArguments( args );
        File exportFile = checkAndCreateFile( args[2] );

        //Use the current i-net PDFC configuration. If no configuration has been previously set then the default configuration will be used.
        ReportPresenter reportPDFPresenter = new PersonalReportPDFPresenter( false, false, exportFile );

        PDFComparer pdfComparer = new PDFComparer().addPresenter( reportPDFPresenter );
        try ( ResultModel result = pdfComparer.compare( files[1], files[0] ) ) {
            SampleUtil.showPresenterError( pdfComparer );
        } catch( PdfcException e ) {
            e.printStackTrace();
        }
    }

    /**
     * Modified presenter for export the pdf as report
     */
    public static class PersonalReportPDFPresenter extends ReportPresenter{

        /**
         * Export File
         */
        private File exportFile  = null;

        public PersonalReportPDFPresenter( boolean detailed, boolean appendSettings, File export ) {
            super( detailed, appendSettings, "pdf", null, true );
            exportFile =  export;
        }

        /**
         * The import method to change the path of the export file
         * @return stream for export file
         * @throws IOException
         */
        @Override
        protected OutputStream getExportStream() throws IOException {
            if(exportFile == null) {
                return super.getExportStream();
            }else{
                return new FileOutputStream(exportFile);
            }
        }
        

        /**
         * {@inheritDoc}
         */
        @Override
        public BasePresenter spawn( boolean spawnWithParent ) {
            // Create the current instance since the default implementation with return a new ReportPDFPresenter
            // NOTE: Not suitable for for batch comparisons! For a batch, create a new instance of PersonalReportPDFPresenter here
            // and create a separate export stream for each comparison.
            return this;
        }
    }

    /**
     * Get 2 files that are to be checked
     *
     * @param args the arguments
     * @return 2 Files
     */
    public static File[] getFileOfArguments(final String[] args){
        if (args == null || args.length != 3  ) {
            throw new IllegalArgumentException( "Usage: ReportingToSpecificFilename <PDF-File1> <PDF-File2> <PDF-File-Output>" );
        }
        return new File[]{ SampleUtil.checkAndGetFile( args[0] ), SampleUtil.checkAndGetFile( args[1] )};
    }

    /**
     * Returns a File object based on a string path
     * The file must not be null and must not be a directory
     * If the file not exist, it will be created
     *
     * @param file location to the file
     * @return The File object
     */
    public static File checkAndCreateFile( final String file){
        final File fileObject = new File( file );

        try {
            fileObject.createNewFile();
        } catch( IOException e ) {
            e.printStackTrace();
            throw new IllegalArgumentException( "the export file can not will create" );
        }

        if( fileObject.isDirectory()){
            throw new IllegalArgumentException( "The file is a folder and not a pdf file.\n parameter = " + file );
        }

        return  fileObject;
    }
}