org.sejda.impl.sambox.component.image.ImagesToPdfDocumentConverter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sejda-sambox Show documentation
Package containing tasks implemented using sambox.
There is a newer version: 5.1.7
/*
 * Copyright 2017 by Edi Weissmann ([email protected]).
 *
 * This file is part of the Sejda source code
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */
package org.sejda.impl.sambox.component.image;

import static org.sejda.core.notification.dsl.ApplicationEventsNotifier.notifyEvent;
import static org.sejda.core.support.io.IOUtils.createTemporaryBufferWithName;

import java.awt.Point;
import java.io.File;
import java.util.ArrayList;
import java.util.List;

import org.apache.commons.io.FilenameUtils;
import org.sejda.impl.sambox.component.PDDocumentHandler;
import org.sejda.impl.sambox.component.PageImageWriter;
import org.sejda.model.PageOrientation;
import org.sejda.model.PageSize;
import org.sejda.model.encryption.EncryptionAtRestPolicy;
import org.sejda.model.exception.TaskException;
import org.sejda.model.exception.TaskIOException;
import org.sejda.model.input.ImageMergeInput;
import org.sejda.model.input.MergeInput;
import org.sejda.model.input.PdfFileSource;
import org.sejda.model.input.PdfMergeInput;
import org.sejda.model.input.Source;
import org.sejda.model.parameter.BaseMergeParameters;
import org.sejda.model.task.TaskExecutionContext;
import org.sejda.sambox.pdmodel.PDPage;
import org.sejda.sambox.pdmodel.common.PDRectangle;
import org.sejda.sambox.pdmodel.graphics.image.PDImageXObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class ImagesToPdfDocumentConverter {

    private static final Logger LOG = LoggerFactory.getLogger(ImagesToPdfDocumentConverter.class);

    private PDDocumentHandler documentHandler;
    private PageImageWriter imageWriter;
    
    public ImagesToPdfDocumentConverter() {
        this.documentHandler = new PDDocumentHandler();
        documentHandler.setCreatorOnPDDocument();

        this.imageWriter = new PageImageWriter(documentHandler.getUnderlyingPDDocument());
    }

    public PDDocumentHandler addPage(Source source) throws TaskException {
        return addPage(source, null, PageOrientation.AUTO, 0);    
    }
    
    public PDDocumentHandler addPage(Source source, PDRectangle pageSize, PageOrientation pageOrientation, 
                                     float marginInches) throws TaskException {
        beforeImage(source);
        try {
            PDImageXObject image = PageImageWriter.toPDXImageObject(source);
            PDRectangle mediaBox = pageSize;
            if (mediaBox == null) {
                mediaBox = new PDRectangle(image.getWidth(), image.getHeight());
            }

            if (pageOrientation == PageOrientation.LANDSCAPE) {
                mediaBox = new PDRectangle(mediaBox.getHeight(), mediaBox.getWidth());
            } else if (pageOrientation == PageOrientation.AUTO) {
                if (image.getWidth() > image.getHeight() && image.getWidth() > mediaBox.getWidth()) {
                    LOG.debug("Switching to landscape, image dimensions are {}x{}", image.getWidth(),
                            image.getHeight());
                    mediaBox = new PDRectangle(mediaBox.getHeight(), mediaBox.getWidth());
                }
            }

            PDPage page = documentHandler.addBlankPage(mediaBox);

            // full page (scaled down only)
            float width = image.getWidth();
            float height = image.getHeight();

            if (width > mediaBox.getWidth()) {
                int targetWidth = (int) mediaBox.getWidth();
                LOG.debug("Scaling image down to fit by width {} vs {}", width, targetWidth);

                float ratio = width / targetWidth;
                width = targetWidth;
                height = Math.round(height / ratio);
            }

            if (height > mediaBox.getHeight()) {
                int targetHeight = (int) mediaBox.getHeight();
                LOG.debug("Scaling image down to fit by height {} vs {}", height, targetHeight);

                float ratio = height / targetHeight;
                height = targetHeight;
                width = Math.round(width / ratio);
            }

            if (marginInches > 0) {
                float newWidth = width - marginInches * 72;
                float newHeight = height * newWidth / width;
                width = newWidth;
                height = newHeight;
            }

            // centered on page
            float x = (mediaBox.getWidth() - width) / 2;
            float y = ((int) mediaBox.getHeight() - height) / 2;

            imageWriter.append(page, image, new Point((int) x, (int) y), width, height, null, 0);

            afterImage(image);
        } catch (TaskIOException e) {
            failedImage(source, e);
        }
        
        return this.documentHandler;
    }

    public void beforeImage(Source source) throws TaskException {

    }

    public void afterImage(PDImageXObject image) throws TaskException {

    }

    public void failedImage(Source source, TaskIOException e) throws TaskException {
        throw e;
    }

    public static void convertImageMergeInputToPdf(BaseMergeParameters parameters,
            TaskExecutionContext context) throws TaskException {
        // if images were supplied, convert them to PDF
        List newInputList = new ArrayList<>();
        for (MergeInput input : parameters.getInputList()) {
            if (input instanceof ImageMergeInput) {
                // collect all consecutive images and convert them to a PDF document
                newInputList.add(convertImagesToPdfMergeInput((ImageMergeInput) input, context));
            } else {
                newInputList.add(input);
            }
        }

        parameters.setInputList(newInputList);
    }
    
    public static PDRectangle toPDRectangle(PageSize pageSize) {
        return new PDRectangle(pageSize.getWidth(), pageSize.getHeight());
    }

    private static PdfMergeInput convertImagesToPdfMergeInput(ImageMergeInput image, TaskExecutionContext context)
            throws TaskException {
        ImagesToPdfDocumentConverter converter = new ImagesToPdfDocumentConverter() {
            @Override
            public void failedImage(Source source, TaskIOException e) throws TaskException {
                context.assertTaskIsLenient(e);
                notifyEvent(context.notifiableTaskMetadata()).taskWarning(
                        String.format("Image %s was skipped, could not be processed", source.getName()), e);
            }
        };

        PDRectangle pageSize = null;
        if (image.getPageSize() != null) {
            pageSize = toPDRectangle(image.getPageSize());    
        }
        if (image.isShouldPageSizeMatchImageSize()) {
            pageSize = null;
        }
        
        PDDocumentHandler converted = converter.addPage(image.getSource(), pageSize, image.getPageOrientation(), 0);
        String basename = FilenameUtils.getBaseName(image.getSource().getName());
        String filename = String.format("%s.pdf", basename);
        File convertedTmpFile = createTemporaryBufferWithName(filename);
        converted.setDocumentTitle(basename);

        EncryptionAtRestPolicy encryptionAtRestPolicy = image.getSource().getEncryptionAtRestPolicy();
        converted.savePDDocument(convertedTmpFile, encryptionAtRestPolicy);

        PdfMergeInput input = new PdfMergeInput(PdfFileSource.newInstanceNoPassword(convertedTmpFile));
        input.getSource().setEncryptionAtRestPolicy(encryptionAtRestPolicy);
        return input;
    }

    public PDDocumentHandler getDocumentHandler() {
        return documentHandler;
    }
}