org.sejda.conversion.PdfFileSourceAdapter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of sejda-conversion Show documentation
sejda core model conversion services
There is a newer version: 5.1.2
package org.sejda.conversion;

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

import org.apache.commons.lang3.StringUtils;
import org.sejda.conversion.exception.ConversionException;
import org.sejda.model.input.PdfFileSource;

/**
 * 
 * Adapter for {@link PdfFileSourceAdapter}. Main role is to be a string-based constructor for the underlying model object
 * 
 * @author Eduard Weissmann
 * 
 */
public class PdfFileSourceAdapter {
    public static final String PASSWORD_SEPARATOR_CHARACTER = ":";
    private static final String PDF_EXTENSION = ".pdf";
    private static final String PDF_EXTENSION_AND_PASSWORD_SEPARATOR = PDF_EXTENSION + PASSWORD_SEPARATOR_CHARACTER;

    private final PdfFileSource pdfFileSource;

    /**
     * Constructor for a {@link PdfFileSourceAdapter}. Supports pdf files that are password protected
     *
     * If file has no password protection, input parameter is the path to the file. Eg: {@code /path/to/file.pdf}
     *
     * For password protected files, input is concatenation of file path and password, using {@value #PASSWORD_SEPARATOR_CHARACTER} as delimiter. Eg:
     * {@code /path/to/file.pdf:secret123}
     * 
     * @param filePathAndPassword
     *            file path concatenated using {@value #PASSWORD_SEPARATOR_CHARACTER} with (optional) password
     */
    public PdfFileSourceAdapter(String filePathAndPassword) {

        File file = new File(extractFilePath(filePathAndPassword));
        String password = extractPassword(filePathAndPassword);

        if (!file.exists()) {
            throw new ConversionException("File '" + file.getPath() + "' does not exist");
        }

        this.pdfFileSource = StringUtils.isBlank(password) ? PdfFileSource.newInstanceNoPassword(file) : PdfFileSource
                .newInstanceWithPassword(file, password);
    }

    /**
     * @return the pdfFileSource
     */
    public PdfFileSource getPdfFileSource() {
        return pdfFileSource;
    }

    /**
     * Extracts the file path part from the specified input
     * 
     * @param filePathAndPassword
     *            input containing file path concatenated using {@value #PASSWORD_SEPARATOR_CHARACTER} with (optional) password
     * @return file path part
     */
    static String extractFilePath(String filePathAndPassword) {
        if (!StringUtils.containsIgnoreCase(filePathAndPassword, PDF_EXTENSION_AND_PASSWORD_SEPARATOR)) {
            return filePathAndPassword;
        }
        return filePathAndPassword.substring(0,
                StringUtils.indexOfIgnoreCase(filePathAndPassword, PDF_EXTENSION_AND_PASSWORD_SEPARATOR)
                        + PDF_EXTENSION.length());
    }

    /**
     * Extracts the password part from the specified input
     * 
     * @param filePathAndPassword
     *            input containing file path concatenated using {@value #PASSWORD_SEPARATOR_CHARACTER} with (optional) password
     * @return the password part
     */
    static String extractPassword(String filePathAndPassword) {
        if (!StringUtils.containsIgnoreCase(filePathAndPassword, PDF_EXTENSION_AND_PASSWORD_SEPARATOR)) {
            return "";
        }
        return filePathAndPassword.substring(StringUtils.indexOfIgnoreCase(filePathAndPassword,
                PDF_EXTENSION_AND_PASSWORD_SEPARATOR) + 1 + PDF_EXTENSION.length());
    }

    /**
     * Factory method for transforming a collection of filenames to {@link PdfFileSource}s
     * Password protected file support included
     * 
     * @param filenames
     * @return a list of {@link PdfFileSource}s built from the filenames specified
     */
    static List fromStrings(List filenames) {
        List result = new ArrayList<>();
        for (String filename : filenames) {
            result.add(new PdfFileSourceAdapter(StringUtils.trim(filename)).getPdfFileSource());
        }

        return result;
    }
}