pro.verron.officestamper.experimental.PowerpointVisitor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of engine Show documentation
Office-stamper is a Java template engine for docx documents, forked from org.wickedsource.docx-stamper
The newest version!
package pro.verron.officestamper.experimental;

import org.docx4j.dml.CTRegularTextRun;
import org.docx4j.dml.CTTextBody;
import org.docx4j.dml.CTTextParagraph;
import org.docx4j.openpackaging.exceptions.Docx4JException;
import org.docx4j.openpackaging.packages.PresentationMLPackage;
import org.docx4j.openpackaging.parts.*;
import org.docx4j.openpackaging.parts.PresentationML.*;
import org.docx4j.openpackaging.parts.WordprocessingML.ImageJpegPart;
import org.pptx4j.pml.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.lang.Nullable;
import pro.verron.officestamper.api.OfficeStamperException;

import java.util.List;
import java.util.Map;
import java.util.Set;

import static java.util.Arrays.stream;

abstract class PowerpointVisitor {

    private static final Logger logger = LoggerFactory.getLogger(PowerpointVisitor.class);

    private static void unexpectedVisit(Object object) {
        var env = System.getenv();
        var throwOnUnexpectedVisit = Boolean.parseBoolean(env.getOrDefault("throw-on-unexpected-visit", "false"));
        var message = "Unknown case : %s %s".formatted(object, object.getClass());
        if (throwOnUnexpectedVisit)
            throw new OfficeStamperException(message);
        else
            logger.debug(message);
    }

    private static void ignore(@Nullable Object ignored) {
        logger.trace("ignored visit of '{}' object", ignored);
    }

    /**
     * Signal the visited object through the before method,
     * then apply logic to know the visit next elements or ignore deeper nesting
     * based on the object type.
     *
     * @param object the object to visit
     */
    public final void visit(@Nullable Object object) {
        before(object);
        try {
            if (object instanceof PresentationMLPackage element) visit(element.getParts());
            else if (object instanceof PartName ignored) ignore(ignored);
            else if (object instanceof Parts element) visit(element.getParts());
            else if (object instanceof SlideLayoutPart ignored) ignore(ignored);
            else if (object instanceof ImageJpegPart ignored) ignore(ignored);
            else if (object instanceof ThemePart ignored) ignore(ignored);
            else if (object instanceof DocPropsCorePart ignored) ignore(ignored);
            else if (object instanceof DocPropsExtendedPart ignored) ignore(ignored);
            else if (object instanceof SlideMasterPart ignored) ignore(ignored);
            else if (object instanceof ViewPropertiesPart ignored) ignore(ignored);
            else if (object instanceof PresentationPropertiesPart ignored) ignore(ignored);
            else if (object instanceof TableStylesPart ignored) ignore(ignored);
            else if (object instanceof MainPresentationPart element) visit(element.getContents());

            else if (object instanceof SlidePart element) visit(element.getContents());
            else if (object instanceof Sld element) visit(element.getCSld());
            else if (object instanceof CommonSlideData element) visit(element.getSpTree());
            else if (object instanceof GroupShape element) visit(element.getSpOrGrpSpOrGraphicFrame());
            else if (object instanceof Shape element) visit(element.getTxBody());
            else if (object instanceof CTTextBody element) visit(element.getP());
            else if (object instanceof CTTextParagraph element) visit(element.getEGTextRun());
            else if (object instanceof CTRegularTextRun ignored) ignore(ignored);
            else if (object instanceof Presentation.SldSz ignored) ignore(ignored);
            else if (object instanceof Presentation ignored) ignore(ignored);

            else if (object instanceof List element) element.forEach(this::visit);
            else if (object instanceof Set element) element.forEach(this::visit);
            else if (object instanceof Map element) visit(element.entrySet());
            else if (object instanceof Map.Entry element) visit(element.getKey(), element.getValue());

            else if (object == null) ignore(null);
            else unexpectedVisit(object);
        } catch (Docx4JException e) {
            throw new OfficeStamperException(e);
        }
    }

    private void visit(Object... objs) {
        stream(objs).forEach(this::visit);
    }

    /**
     * This abstract method is responsible for executing some tasks before a specific operation.
     * It is intended to be implemented by subclasses.
     *
     * @param object The optional object that can be used as a parameter for the pre-operation tasks.
     */
    protected abstract void before(@Nullable Object object);

}