RemoveGraphicsByColor.java

package mkl.testarea.itext7.content;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.List;
import java.util.function.Predicate;

import org.junit.BeforeClass;
import org.junit.Test;

import com.itextpdf.kernel.colors.CalRgb;
import com.itextpdf.kernel.colors.Color;
import com.itextpdf.kernel.colors.ColorConstants;
import com.itextpdf.kernel.colors.DeviceRgb;
import com.itextpdf.kernel.colors.IccBased;
import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfLiteral;
import com.itextpdf.kernel.pdf.PdfObject;
import com.itextpdf.kernel.pdf.PdfReader;
import com.itextpdf.kernel.pdf.PdfWriter;
import com.itextpdf.kernel.pdf.canvas.parser.PdfCanvasProcessor;

/**
 * @author mkl
 */
public class RemoveGraphicsByColor {
    final static File RESULT_FOLDER = new File("target/test-outputs", "content");

    @BeforeClass
    public static void setUpBeforeClass() throws Exception {
        RESULT_FOLDER.mkdirs();
    }

    /**
     * <a href="https://stackoverflow.com/questions/58029533/traverse-whole-pdf-and-remove-underlines-of-hyperlinks-annotations-only-itex">
     * Traverse whole PDF and Remove underlines of hyperlinks (annotations) only + iText
     * </a>
     * <br/>
     * <a href="https://raad-dev-test.s3.ap-south-1.amazonaws.com/36/2019-08-30/Control_of_nitrosamine_impurities_in_sartans__rev.pdf">
     * Control_of_nitrosamine_impurities_in_sartans__rev.pdf
     * </a>
     * <p>
     * This test uses the {@link PdfGraphicsRemoverByColor} to remove
     * blue underlines from the given document. This content editor
     * actually drops any path stroking or filling of a given color.
     * </p>
     * @throws IOException
     */
    @Test
    public void testRemoveBlueLinesFromControlOfNitrosamineImpuritiesInSartansRev() throws IOException {
        try (   InputStream resource = getClass().getResourceAsStream("Control_of_nitrosamine_impurities_in_sartans__rev.pdf");
                PdfReader pdfReader = new PdfReader(resource);
                OutputStream result = new FileOutputStream(new File(RESULT_FOLDER, "Control_of_nitrosamine_impurities_in_sartans__rev-RemoveBlueLines.pdf"));
                PdfWriter pdfWriter = new PdfWriter(result);
                PdfDocument pdfDocument = new PdfDocument(pdfReader, pdfWriter) )
        {
            PdfCanvasEditor editor = new PdfGraphicsRemoverByColor(ColorConstants.BLUE);
            for (int i = 1; i <= pdfDocument.getNumberOfPages(); i++)
            {
                editor.editPage(pdfDocument, i);
            }
        }
    }

    /**
     * <a href="https://stackoverflow.com/questions/58029533/traverse-whole-pdf-and-remove-underlines-of-hyperlinks-annotations-only-itex">
     * Traverse whole PDF and Remove underlines of hyperlinks (annotations) only + iText
     * </a>
     * <br/>
     * <a href="https://raad-dev-test.s3.ap-south-1.amazonaws.com/36/2019-08-30/EDQM_reports_issues_of_non-compliance_with_tooth__Mac.pdf">
     * EDQM_reports_issues_of_non-compliance_with_tooth__Mac.pdf
     * </a>
     * <p>
     * This test uses the {@link PdfGraphicsRemoverByColor} to remove
     * blue underlines from the given document. This content editor
     * actually drops any path stroking or filling of a given color.
     * </p>
     * @throws IOException
     */
    @Test
    public void testRemoveBlueLinesFromEDQMReportsIssuesOfNonComplianceWithToothMac() throws IOException {
        try (   InputStream resource = getClass().getResourceAsStream("EDQM_reports_issues_of_non-compliance_with_tooth__Mac.pdf");
                PdfReader pdfReader = new PdfReader(resource);
                OutputStream result = new FileOutputStream(new File(RESULT_FOLDER, "EDQM_reports_issues_of_non-compliance_with_tooth__Mac-RemoveBlueLines.pdf"));
                PdfWriter pdfWriter = new PdfWriter(result);
                PdfDocument pdfDocument = new PdfDocument(pdfReader, pdfWriter) )
        {
            PdfCanvasEditor editor = new PdfGraphicsRemoverByColor(ColorConstants.BLUE);
            for (int i = 1; i <= pdfDocument.getNumberOfPages(); i++)
            {
                editor.editPage(pdfDocument, i);
            }
        }
    }

    /**
     * <a href="https://stackoverflow.com/questions/58029533/traverse-whole-pdf-and-remove-underlines-of-hyperlinks-annotations-only-itex">
     * Traverse whole PDF and Remove underlines of hyperlinks (annotations) only + iText
     * </a>
     * <br/>
     * <a href="https://raad-dev-test.s3.ap-south-1.amazonaws.com/36/2019-08-30/originalFile.pdf">
     * originalFile.pdf
     * </a>
     * <p>
     * This test uses the {@link PdfGraphicsRemoverByColor} to remove
     * blue underlines from the given document. This content editor
     * actually drops any path stroking or filling of a given color.
     * </p>
     * @throws IOException
     */
    @Test
    public void testRemoveBlueLinesFromOriginalFile() throws IOException {
        try (   InputStream resource = getClass().getResourceAsStream("originalFile.pdf");
                PdfReader pdfReader = new PdfReader(resource);
                OutputStream result = new FileOutputStream(new File(RESULT_FOLDER, "originalFile-RemoveBlueLines.pdf"));
                PdfWriter pdfWriter = new PdfWriter(result);
                PdfDocument pdfDocument = new PdfDocument(pdfReader, pdfWriter) )
        {
            PdfCanvasEditor editor = new PdfGraphicsRemoverByColor(ColorConstants.BLUE);
            for (int i = 1; i <= pdfDocument.getNumberOfPages(); i++)
            {
                editor.editPage(pdfDocument, i);
            }
        }
    }

    /**
     * This content editor drops any path stroking or filling of a given color.
     *
     * @see RemoveGraphicsByColor#testRemoveBlueLinesFromControlOfNitrosamineImpuritiesInSartansRev()
     * @see RemoveGraphicsByColor#testRemoveBlueLinesFromEDQMReportsIssuesOfNonComplianceWithToothMac()
     * @see RemoveGraphicsByColor#testRemoveBlueLinesFromOriginalFile()
     */
    class PdfGraphicsRemoverByColor extends PdfCanvasEditor {
        public PdfGraphicsRemoverByColor(Color color) {
            this.color = color;
        }

        @Override
        protected void write(PdfCanvasProcessor processor, PdfLiteral operator, List<PdfObject> operands)
        {
            String operatorString = operator.toString();

            if (color.equals(getGraphicsState().getFillColor())) {
                switch (operatorString) {
                case "f":
                case "f*":
                case "F":
                    operatorString = "n";
                    break;
                case "b":
                case "b*":
                    operatorString = "s";
                    break;
                case "B":
                case "B*":
                    operatorString = "S";
                    break;
                }
            }

            if (color.equals(getGraphicsState().getStrokeColor())) {
                switch (operatorString) {
                case "s":
                case "S":
                    operatorString = "n";
                    break;
                case "b":
                case "B":
                    operatorString = "f";
                    break;
                case "b*":
                case "B*":
                    operatorString = "f*";
                    break;
                }
            }

            operator = new PdfLiteral(operatorString);
            operands.set(operands.size() - 1, operator);
            super.write(processor, operator, operands);
        }

        final Color color;
    }


    /**
     * <a href="https://stackoverflow.com/questions/58029533/traverse-whole-pdf-and-remove-underlines-of-hyperlinks-annotations-only-itex">
     * Traverse whole PDF and Remove underlines of hyperlinks (annotations) only + iText
     * </a>
     * <br/>
     * <a href="https://raad-dev-test.s3.ap-south-1.amazonaws.com/36/2019-08-30/Control_of_nitrosamine_impurities_in_sartans__rev.pdf">
     * Control_of_nitrosamine_impurities_in_sartans__rev.pdf
     * </a>
     * <p>
     * This test uses the {@link PdfGraphicsRemoverByColorPredicate}
     * to remove blue underlines from the given document. This content
     * editor actually drops any path stroking or filling of a matched
     * color.
     * </p>
     * @throws IOException
     */
    @Test
    public void testRemoveAllBlueLinesFromControlOfNitrosamineImpuritiesInSartansRev() throws IOException {
        try (   InputStream resource = getClass().getResourceAsStream("Control_of_nitrosamine_impurities_in_sartans__rev.pdf");
                PdfReader pdfReader = new PdfReader(resource);
                OutputStream result = new FileOutputStream(new File(RESULT_FOLDER, "Control_of_nitrosamine_impurities_in_sartans__rev-RemoveAllBlueLines.pdf"));
                PdfWriter pdfWriter = new PdfWriter(result);
                PdfDocument pdfDocument = new PdfDocument(pdfReader, pdfWriter) )
        {
            PdfCanvasEditor editor = new PdfGraphicsRemoverByColorPredicate(RemoveGraphicsByColor::isRgbBlue);
            for (int i = 1; i <= pdfDocument.getNumberOfPages(); i++)
            {
                editor.editPage(pdfDocument, i);
            }
        }
    }

    /**
     * <a href="https://stackoverflow.com/questions/58029533/traverse-whole-pdf-and-remove-underlines-of-hyperlinks-annotations-only-itex">
     * Traverse whole PDF and Remove underlines of hyperlinks (annotations) only + iText
     * </a>
     * <br/>
     * <a href="https://raad-dev-test.s3.ap-south-1.amazonaws.com/36/2019-08-30/EDQM_reports_issues_of_non-compliance_with_tooth__Mac.pdf">
     * EDQM_reports_issues_of_non-compliance_with_tooth__Mac.pdf
     * </a>
     * <p>
     * This test uses the {@link PdfGraphicsRemoverByColorPredicate}
     * to remove blue underlines from the given document. This content
     * editor actually drops any path stroking or filling of a matched
     * color.
     * </p>
     * @throws IOException
     */
    @Test
    public void testRemoveAllBlueLinesFromEDQMReportsIssuesOfNonComplianceWithToothMac() throws IOException {
        try (   InputStream resource = getClass().getResourceAsStream("EDQM_reports_issues_of_non-compliance_with_tooth__Mac.pdf");
                PdfReader pdfReader = new PdfReader(resource);
                OutputStream result = new FileOutputStream(new File(RESULT_FOLDER, "EDQM_reports_issues_of_non-compliance_with_tooth__Mac-RemoveAllBlueLines.pdf"));
                PdfWriter pdfWriter = new PdfWriter(result);
                PdfDocument pdfDocument = new PdfDocument(pdfReader, pdfWriter) )
        {
            PdfCanvasEditor editor = new PdfGraphicsRemoverByColorPredicate(RemoveGraphicsByColor::isRgbBlue);
            for (int i = 1; i <= pdfDocument.getNumberOfPages(); i++)
            {
                editor.editPage(pdfDocument, i);
            }
        }
    }

    /**
     * <a href="https://stackoverflow.com/questions/58029533/traverse-whole-pdf-and-remove-underlines-of-hyperlinks-annotations-only-itex">
     * Traverse whole PDF and Remove underlines of hyperlinks (annotations) only + iText
     * </a>
     * <br/>
     * <a href="https://raad-dev-test.s3.ap-south-1.amazonaws.com/36/2019-08-30/originalFile.pdf">
     * originalFile.pdf
     * </a>
     * <p>
     * This test uses the {@link PdfGraphicsRemoverByColorPredicate}
     * to remove blue underlines from the given document. This content
     * editor actually drops any path stroking or filling of a matched
     * color.
     * </p>
     * @throws IOException
     */
    @Test
    public void testRemoveAllBlueLinesFromOriginalFile() throws IOException {
        try (   InputStream resource = getClass().getResourceAsStream("originalFile.pdf");
                PdfReader pdfReader = new PdfReader(resource);
                OutputStream result = new FileOutputStream(new File(RESULT_FOLDER, "originalFile-RemoveAllBlueLines.pdf"));
                PdfWriter pdfWriter = new PdfWriter(result);
                PdfDocument pdfDocument = new PdfDocument(pdfReader, pdfWriter) )
        {
            PdfCanvasEditor editor = new PdfGraphicsRemoverByColorPredicate(RemoveGraphicsByColor::isRgbBlue);
            for (int i = 1; i <= pdfDocument.getNumberOfPages(); i++)
            {
                editor.editPage(pdfDocument, i);
            }
        }
    }

    /**
     * <a href="https://stackoverflow.com/questions/58029533/traverse-whole-pdf-and-remove-underlines-of-hyperlinks-annotations-only-itex">
     * Traverse whole PDF and Remove underlines of hyperlinks (annotations) only + iText
     * </a>
     * <br/>
     * <a href="https://raad-dev-test.s3.ap-south-1.amazonaws.com/36/2019-08-30/021549Orig1s025_aprepitant_clinpharm_prea_Mac.pdf">
     * 021549Orig1s025_aprepitant_clinpharm_prea_Mac.pdf
     * </a>
     * <p>
     * This test uses the {@link PdfGraphicsRemoverByColorPredicate}
     * to remove blue underlines from the given document. This content
     * editor actually drops any path stroking or filling of a matched
     * color; check in particular page 41. But also see the graph on
     * page 42.
     * </p>
     * @throws IOException
     */
    @Test
    public void testRemoveAllBlueLinesFrom021549Orig1s025AprepitantClinpharmPreaMac() throws IOException {
        try (   InputStream resource = getClass().getResourceAsStream("021549Orig1s025_aprepitant_clinpharm_prea_Mac.pdf");
                PdfReader pdfReader = new PdfReader(resource);
                OutputStream result = new FileOutputStream(new File(RESULT_FOLDER, "021549Orig1s025_aprepitant_clinpharm_prea_Mac-RemoveAllBlueLines.pdf"));
                PdfWriter pdfWriter = new PdfWriter(result);
                PdfDocument pdfDocument = new PdfDocument(pdfReader, pdfWriter) )
        {
            PdfCanvasEditor editor = new PdfGraphicsRemoverByColorPredicate(RemoveGraphicsByColor::isRgbBlue);
            for (int i = 1; i <= pdfDocument.getNumberOfPages(); i++)
            {
                editor.editPage(pdfDocument, i);
            }
        }
    }

    /**
     * <a href="https://stackoverflow.com/questions/58029533/traverse-whole-pdf-and-remove-underlines-of-hyperlinks-annotations-only-itex">
     * Traverse whole PDF and Remove underlines of hyperlinks (annotations) only + iText
     * </a>
     * <br/>
     * <a href="https://raad-dev-test.s3.ap-south-1.amazonaws.com/36/2019-08-30/400_206494S5_avibactam_and_ceftazidine_unireview_prea_Mac.pdf">
     * 400_206494S5_avibactam_and_ceftazidine_unireview_prea_Mac.pdf
     * </a>
     * <p>
     * This test uses the {@link PdfGraphicsRemoverByColorPredicate}
     * to remove blue underlines from the given document. This content
     * editor actually drops any path stroking or filling of a matched
     * color; check in particular page 60.
     * </p>
     * @throws IOException
     */
    @Test
    public void testRemoveAllBlueLinesFrom400206494S5AvibactamAndCeftazidineUnireviewPreaMac() throws IOException {
        try (   InputStream resource = getClass().getResourceAsStream("400_206494S5_avibactam_and_ceftazidine_unireview_prea_Mac.pdf");
                PdfReader pdfReader = new PdfReader(resource);
                OutputStream result = new FileOutputStream(new File(RESULT_FOLDER, "400_206494S5_avibactam_and_ceftazidine_unireview_prea_Mac-RemoveAllBlueLines.pdf"));
                PdfWriter pdfWriter = new PdfWriter(result);
                PdfDocument pdfDocument = new PdfDocument(pdfReader, pdfWriter) )
        {
            PdfCanvasEditor editor = new PdfGraphicsRemoverByColorPredicate(RemoveGraphicsByColor::isRgbBlue);
            for (int i = 1; i <= pdfDocument.getNumberOfPages(); i++)
            {
                editor.editPage(pdfDocument, i);
            }
        }
    }

    /**
     * <a href="https://stackoverflow.com/questions/58029533/traverse-whole-pdf-and-remove-underlines-of-hyperlinks-annotations-only-itex">
     * Traverse whole PDF and Remove underlines of hyperlinks (annotations) only + iText
     * </a>
     * <br/>
     * <a href="https://raad-dev-test.s3.ap-south-1.amazonaws.com/raw/WebScraping/RegulatoryInformation/dev/North+America/USA/2019-10-31/2841/_FDA_Requires_Use_of_eCTD_Format_and_Standardized_Study_Data_in_Future_Regulatory_Submissions__Sept.pdf">
     * _FDA_Requires_Use_of_eCTD_Format_and_Standardized_Study_Data_in_Future_Regulatory_Submissions__Sept.pdf
     * </a>
     * <p>
     * This test uses the {@link PdfGraphicsRemoverByColorPredicate}
     * to remove blue underlines from the given document. This content
     * editor actually drops any path stroking or filling of a matched
     * color. The OP reported that the red dotted line on page 1 did
     * vanish. This cannot be reproduced like this.
     * </p>
     */
    @Test
    public void testRemoveAllBlueLinesFromFdaRequiresUseOfEctdFormatAndStandardizedStudyDataInFutureRegulatorySubmissionsSept() throws IOException {
        try (   InputStream resource = getClass().getResourceAsStream("_FDA_Requires_Use_of_eCTD_Format_and_Standardized_Study_Data_in_Future_Regulatory_Submissions__Sept.pdf");
                PdfReader pdfReader = new PdfReader(resource);
                OutputStream result = new FileOutputStream(new File(RESULT_FOLDER, "_FDA_Requires_Use_of_eCTD_Format_and_Standardized_Study_Data_in_Future_Regulatory_Submissions__Sept-RemoveAllBlueLines.pdf"));
                PdfWriter pdfWriter = new PdfWriter(result);
                PdfDocument pdfDocument = new PdfDocument(pdfReader, pdfWriter) )
        {
            PdfCanvasEditor editor = new PdfGraphicsRemoverByColorPredicate(RemoveGraphicsByColor::isRgbBlue);
            for (int i = 1; i <= pdfDocument.getNumberOfPages(); i++)
            {
                editor.editPage(pdfDocument, i);
            }
        }
    }

    /**
     * This {@link Predicate} checks whether a color is of a RGB color
     * type and represents some blue.
     */
    public static boolean isRgbBlue(Color color) {
        if (color instanceof CalRgb || color instanceof DeviceRgb || (color instanceof IccBased && color.getNumberOfComponents() == 3)) {
            float[] components = color.getColorValue();
            float r = components[0];
            float g = components[1];
            float b = components[2];
            return b > .5f && r < .9f*b && g < .9f*b;
        }
        return false;
    }

    /**
     * This content editor drops any path stroking or filling of a
     * matching color.
     *
     * @see RemoveGraphicsByColor#testRemoveAllBlueLinesFromControlOfNitrosamineImpuritiesInSartansRev()
     * @see RemoveGraphicsByColor#testRemoveAllBlueLinesFromEDQMReportsIssuesOfNonComplianceWithToothMac()
     * @see RemoveGraphicsByColor#testRemoveAllBlueLinesFromOriginalFile()
     */
    class PdfGraphicsRemoverByColorPredicate extends PdfCanvasEditor {
        public PdfGraphicsRemoverByColorPredicate(Predicate<Color> colorPredicate) {
            this.colorPredicate = colorPredicate;
        }

        @Override
        protected void write(PdfCanvasProcessor processor, PdfLiteral operator, List<PdfObject> operands)
        {
            String operatorString = operator.toString();

            if (colorPredicate.test(getGraphicsState().getFillColor())) {
                switch (operatorString) {
                case "f":
                case "f*":
                case "F":
                    operatorString = "n";
                    break;
                case "b":
                case "b*":
                    operatorString = "s";
                    break;
                case "B":
                case "B*":
                    operatorString = "S";
                    break;
                }
            }

            if (colorPredicate.test(getGraphicsState().getStrokeColor())) {
                switch (operatorString) {
                case "s":
                case "S":
                    operatorString = "n";
                    break;
                case "b":
                case "B":
                    operatorString = "f";
                    break;
                case "b*":
                case "B*":
                    operatorString = "f*";
                    break;
                }
            }

            operator = new PdfLiteral(operatorString);
            operands.set(operands.size() - 1, operator);
            super.write(processor, operator, operands);
        }

        final Predicate<Color> colorPredicate;
    }
}