org.docx4j.template.WordprocessingMLDocxTemplate.java Source code

Introduction

Here is the source code for org.docx4j.template.WordprocessingMLDocxTemplate.java

Source

/*
 * Copyright (c) 2018, vindell (https://github.com/vindell).
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package org.docx4j.template;

import java.io.File;
import java.io.FileNotFoundException;
import java.util.HashMap;
import java.util.Map;

import org.apache.commons.io.FileUtils;
import org.apache.commons.lang3.StringUtils;
import org.docx4j.Docx4jProperties;
import org.docx4j.openpackaging.packages.WordprocessingMLPackage;
import org.docx4j.template.fonts.FontMapperHolder;
import org.docx4j.template.utils.WmlZipUtils;

/**
 * ?WordprocessingMLPackage??????????WordprocessingMLPackage
 * @author <a href="https://github.com/vindell">vindell</a>
 */
public class WordprocessingMLDocxTemplate extends WordprocessingMLTemplate {

    protected static final String PATH_TO_CONTENT = "word/document.xml";
    protected File sourceDocx;
    protected File outputDocx;
    protected File unzipDir;
    /**
     * ?????${
     */
    protected String placeholderStart = "${";
    /**
     * ??????}
     */
    protected String placeholderEnd = "}";
    /**
     * ??? UTF-8
     */
    protected String inputEncoding = Docx4jConstants.DEFAULT_CHARSETNAME;
    /**
     * ?? UTF-8
     */
    protected String outputEncoding = Docx4jConstants.DEFAULT_CHARSETNAME;
    /**
     * ??
     */
    protected boolean autoDelete = false;

    public WordprocessingMLDocxTemplate() {
        //??
        this.inputEncoding = StringUtils.defaultString(this.inputEncoding,
                Docx4jProperties.getProperty("docx4j.docx.input.encoding", Docx4jConstants.DEFAULT_CHARSETNAME));
        this.outputEncoding = StringUtils.defaultString(this.outputEncoding,
                Docx4jProperties.getProperty("docx4j.docx.output.encoding", Docx4jConstants.DEFAULT_CHARSETNAME));
        this.placeholderStart = StringUtils.defaultString(this.placeholderStart,
                Docx4jProperties.getProperty("docx4j.docx.placeholderStart", "${"));
        this.placeholderEnd = StringUtils.defaultString(this.placeholderEnd,
                Docx4jProperties.getProperty("docx4j.docx.placeholderEnd", "}"));
        this.autoDelete = Docx4jProperties.getProperty("docx4j.docx.source.delete", false);
    }

    public WordprocessingMLPackage process(File sourceDocx, String template, Map<String, Object> variables,
            File outputDocx) throws Exception {
        this.sourceDocx = sourceDocx;
        this.outputDocx = outputDocx;
        return this.process(template, variables);
    }

    /**
     * ??????word?
     * @param template ?
     * @param variables ??
     * @return {@link WordprocessingMLPackage} 
     * @throws Exception 
     */
    @Override
    public WordprocessingMLPackage process(String template, Map<String, Object> variables) throws Exception {

        //?
        this.unzipDir = new File(this.sourceDocx.getParentFile(),
                Docx4jProperties.getProperty("docx4j.docx.tmpdir", "unzip_tmpdir"));
        if (!this.unzipDir.exists() || this.unzipDir.isFile()) {
            this.unzipDir.setReadable(true);
            this.unzipDir.setWritable(true);
            this.unzipDir.mkdir();
        }

        /*
        WordprocessingMLPackage wordMLPackage = WordprocessingMLPackage.load(sourceDocx);
        MainDocumentPart documentPart = wordMLPackage.getMainDocumentPart();  
          //??????
          HashMap<String, String> staticMap = getStaticData(variables);
          // ???  
          documentPart.variableReplace(staticMap);  
          */
        //
        WmlZipUtils.unzip(this.sourceDocx, this.unzipDir);
        //?
        File contentXmlFile = new File(this.unzipDir, PATH_TO_CONTENT);
        if (!contentXmlFile.exists()) {
            throw new FileNotFoundException(contentXmlFile.getAbsolutePath());
        }
        //???
        //String template = FileUtils.readFileToString(contentXmlFile, this.inputEncoding );
        for (Map.Entry<String, Object> entry : variables.entrySet()) {
            //???
            template = StringUtils.replace(template, this.placeholderStart + entry.getKey() + this.placeholderEnd,
                    String.valueOf(entry.getValue()));
        }
        /*if(this.sourceDel){
           //?
           this.sourceDocx.delete();
        }*/
        //
        String sourceDocxPath = this.sourceDocx.getPath();
        String tempDocxPath = sourceDocxPath.substring(0, sourceDocxPath.lastIndexOf(".")) + "_bak";
        File tempDir = new File(tempDocxPath);
        //
        FileUtils.deleteDirectory(tempDir);
        //?
        FileUtils.copyDirectory(this.unzipDir, tempDir);
        //??
        FileUtils.writeStringToFile(new File(tempDir, PATH_TO_CONTENT), template, this.outputEncoding);
        //?????
        WmlZipUtils.zipDir(tempDir, this.outputDocx, false);
        //
        FileUtils.deleteDirectory(tempDir);
        //WordprocessingMLPackage
        return FontMapperHolder.useFontMapper(WordprocessingMLPackage.load(this.outputDocx));
    }

    /*
      * ????
      */
    protected HashMap<String, String> getStaticData(Map<String, Object> variables) {
        //????
        HashMap<String, String> dataMap = new HashMap<String, String>();
        if (variables != null) {
            for (String key : variables.keySet()) {
                Object val = variables.get(key);
                dataMap.put(key, val == null ? "" : val.toString());
            }
        }
        return dataMap;
    }

    public File getSourceDocx() {
        return sourceDocx;
    }

    public void setSourceDocx(File sourceDocx) {
        this.sourceDocx = sourceDocx;
    }

    public File getOutputDocx() {
        return outputDocx;
    }

    public void setOutputDocx(File outputDocx) {
        this.outputDocx = outputDocx;
    }

    public String getPlaceholderStart() {
        return placeholderStart;
    }

    public void setPlaceholderStart(String placeholderStart) {
        this.placeholderStart = placeholderStart;
    }

    public String getPlaceholderEnd() {
        return placeholderEnd;
    }

    public void setPlaceholderEnd(String placeholderEnd) {
        this.placeholderEnd = placeholderEnd;
    }

    public String getInputEncoding() {
        return inputEncoding;
    }

    public void setInputEncoding(String inputEncoding) {
        this.inputEncoding = inputEncoding;
    }

    public String getOutputEncoding() {
        return outputEncoding;
    }

    public void setOutputEncoding(String outputEncoding) {
        this.outputEncoding = outputEncoding;
    }

    public boolean isAutoDelete() {
        return autoDelete;
    }

    public void setAutoDelete(boolean autoDelete) {
        this.autoDelete = autoDelete;
    }

}