plugins/docx/org.eclipse.papyrus.model2doc.docx/src/org/eclipse/papyrus/model2doc/docx/internal/transcription/DocxTranscription.java - papyrus/org.eclipse.papyrus-model2doc - Git at Google

 /*****************************************************************************
  * Copyright (c) 2020, 2021 CEA LIST.
  *
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
  * which accompanies this distribution, and is available at
  * https://www.eclipse.org/legal/epl-2.0/
  *
  * SPDX-License-Identifier: EPL-2.0
  *
  * Contributors:
  * 	 Pauline DEVILLE (CEA LIST) pauline.deville@cea.fr - Initial API and implementation
  *   Vincent LORENZO (CEA LIST) vincent.lorenzo@cea.fr - bug 569059
  * 	 Pauline DEVILLE (CEA LIST) pauline.deville@cea.fr - Bug 569249
  *   Vincent Lorenzo (CEA LIST) vincent.lorenzo@cea.fr - bug 569817
  *   Pauline DEVILLE (CEA LIST) pauline.deville@cea.fr - Bug 570290
  *   Vincent Lorenzo (CEA LIST) vincent.lorenzo@cea.fr - bug 570803
  *   Yoann Farre (CIL4Sys Engineering) yoann.farre@cil4sys.com - Bug 571508
  *****************************************************************************/
 package org.eclipse.papyrus.model2doc.docx.internal.transcription;

 import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.math.BigInteger;
 import java.net.URL;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Iterator;
 import java.util.List;

 import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
 import org.apache.poi.openxml4j.opc.OPCPackage;
 import org.apache.poi.xwpf.usermodel.Document;
 import org.apache.poi.xwpf.usermodel.TableWidthType;
 import org.apache.poi.xwpf.usermodel.XWPFParagraph;
 import org.apache.poi.xwpf.usermodel.XWPFRun;
 import org.apache.poi.xwpf.usermodel.XWPFTable;
 import org.apache.poi.xwpf.usermodel.XWPFTableCell;
 import org.eclipse.core.runtime.Assert;
 import org.eclipse.core.runtime.IPath;
 import org.eclipse.core.runtime.Path;
 import org.eclipse.emf.common.util.URI;
 import org.eclipse.osgi.util.NLS;
 import org.eclipse.papyrus.model2doc.core.author.IAuthor;
 import org.eclipse.papyrus.model2doc.core.builtintypes.AbstractList;
 import org.eclipse.papyrus.model2doc.core.builtintypes.AbstractTable;
 import org.eclipse.papyrus.model2doc.core.builtintypes.BasicList;
 import org.eclipse.papyrus.model2doc.core.builtintypes.Cell;
 import org.eclipse.papyrus.model2doc.core.builtintypes.FileReferenceCell;
 import org.eclipse.papyrus.model2doc.core.builtintypes.IFileReference;
 import org.eclipse.papyrus.model2doc.core.builtintypes.ListItem;
 import org.eclipse.papyrus.model2doc.core.builtintypes.Row;
 import org.eclipse.papyrus.model2doc.core.builtintypes.TextCell;
 import org.eclipse.papyrus.model2doc.core.builtintypes.TextListItem;
 import org.eclipse.papyrus.model2doc.core.builtintypes.accessors.IInputFileAccessor;
 import org.eclipse.papyrus.model2doc.core.generatorconfiguration.IDocumentGeneratorConfiguration;
 import org.eclipse.papyrus.model2doc.core.generatorconfiguration.accessors.IOutputFileAccessor;
 import org.eclipse.papyrus.model2doc.core.styles.BooleanNamedStyle;
 import org.eclipse.papyrus.model2doc.core.styles.NamedStyleConstants;
 import org.eclipse.papyrus.model2doc.core.transcription.CoverPage;
 import org.eclipse.papyrus.model2doc.core.transcription.ImageDescription;
 import org.eclipse.papyrus.model2doc.core.transcription.Transcription;
 import org.eclipse.papyrus.model2doc.docx.Activator;
 import org.eclipse.papyrus.model2doc.docx.Messages;
 import org.eclipse.papyrus.model2doc.docx.internal.poi.CustomXWPFDocument;
 import org.eclipse.papyrus.model2doc.docx.internal.poi.CustomXWPFParagraph;
 import org.eclipse.papyrus.model2doc.docx.internal.poi.CustomXWPFTable;
 import org.eclipse.papyrus.model2doc.docx.internal.services.StyleServiceImpl;
 import org.eclipse.papyrus.model2doc.docx.internal.util.ImageUtils;
 import org.eclipse.papyrus.model2doc.docx.internal.util.TextUtils;
 import org.eclipse.papyrus.model2doc.docx.services.StyleService;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTR;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTRPr;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSimpleField;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTText;

 public class DocxTranscription implements Transcription {

 	private static final String DOTX_SCHEMA = "application/vnd.openxmlformats-officedocument.wordprocessingml.template.main+xml";//$NON-NLS-1$

 	private static final String DOCX_SCHEMA = "application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml";//$NON-NLS-1$

 	private IDocumentGeneratorConfiguration docxGeneratorConfig;

 	private CustomXWPFDocument document;

 	protected StyleService styleService;

 	private int imageIndex = 1;

 	private static final String ECORE_URI_FILE_SEPARATOR = "/";//$NON-NLS-1$

 	private static final String DOCX_FILE_EXTENTION = "docx";//$NON-NLS-1$

 	private static final String ECORE_FILE_PREFIX = "file:"; //$NON-NLS-1$

 	private static final String EMPTY_STRING = ""; //$NON-NLS-1$

 	private static final String WHITE_SPACE = " "; //$NON-NLS-1$

 	public DocxTranscription(IDocumentGeneratorConfiguration dgc) {
 		this.docxGeneratorConfig = dgc;
 		this.styleService = new StyleServiceImpl();
 		try {
 			final InputStream templateInputStream = getFileWithTemplateLoaded();
 			if (templateInputStream != null) {
 				// bug 569059 - see https://stackoverflow.com/questions/16264247/create-document-from-dotx-template-with-apache-poi-hwpf for solution
 				this.document = new CustomXWPFDocument(templateInputStream);
 				templateInputStream.close();
 			}
 		} catch (IOException e) {
 			Activator.log.warn("Cannot apply the template file"); //$NON-NLS-1$
 		} catch (InvalidFormatException e1) {
 			Activator.log.error("Cannot apply the template file", e1);//$NON-NLS-1$
 		}
 		if (this.document == null) {
 			this.document = new CustomXWPFDocument();
 		}
 	}

 	/**
 	 * This method open the destination file and replace it by the the template
 	 *
 	 * @return an inputStream on the destination file
 	 * @throws IOException
 	 * @throws InvalidFormatException
 	 */
 	private InputStream getFileWithTemplateLoaded() throws IOException, InvalidFormatException {
 		final URL templateURL = this.docxGeneratorConfig.createTemplateFileInputAccessor().createInputFileURL();

 		if (templateURL != null) {
 			final IOutputFileAccessor outputAccessor = this.docxGeneratorConfig.createDocumentOutputAccessor();
 			final URL destURL = outputAccessor.createOutputFileURL(docxGeneratorConfig.getDocumentName(), DOCX_FILE_EXTENTION);

 			String destURI = outputAccessor.urlToPathString(destURL, true);
 			// create intermediate folder when they don't exist.
 			// TODO : make common method with image generation and odt
 			// TODO : what to do when dest project doesn't yet exist ?
 			final Path targetPath = new Path(destURI);
 			// we check all folders tree already exists, and we create them if not
 			if (targetPath.segmentCount() > 1) {
 				final IPath folderPath = targetPath.removeLastSegments(1);
 				final File folder = folderPath.toFile();
 				if (false == folder.exists()) {
 					folder.mkdirs();
 				}
 			}

 			InputStream templateIS = templateURL.openStream();
 			FileOutputStream destIS = new FileOutputStream(destURI);

 			OPCPackage pkg = OPCPackage.open(templateIS);
 			pkg.replaceContentType(DOTX_SCHEMA, DOCX_SCHEMA);
 			pkg.save(destIS);

 			templateIS.close();
 			destIS.close();

 			return destURL.openStream();
 		}
 		return null;
 	}

 	@Override
 	public void writeCoverPage(CoverPage coverPage) {
 		// TODO Auto-generated method stub

 	}

 	@Override
 	public void writeTableOfContents(String tocTitle) {
 		XWPFParagraph p = document.createParagraph();
 		XWPFRun run = p.createRun();
 		run.setText(tocTitle);

 		document.createTOC();
 	}

 	@Override
 	public void writeTableOfFigures(String tofTitle) {
 		XWPFParagraph p = document.createParagraph();
 		XWPFRun run = p.createRun();
 		run.setText(tofTitle);

 		document.createTOF();
 	}

 	@Override
 	public void refreshTablesOfIndexes() {
 		// TODO Auto-generated method stub

 	}

 	@Override
 	public void writeDocumentMainTitle(String documentTitle) {
 		XWPFParagraph p = document.createParagraph();
 		styleService.applyDocumentMainTitleStyle(p);

 		XWPFRun run = p.createRun();
 		run.setText(documentTitle);
 	}

 	@Override
 	public void writeAuthors(Collection<IAuthor> authors) {
 		setDocumentAuthorsProperty(authors);
 	}

 	@Override
 	public void writeVersion(String version) {
 		setDocumentVersionProperty(version);
 	}

 	@Override
 	public void writeSectionTitle(String sectionTitle, int sectionLevel) {
 		XWPFParagraph paragraph = document.createParagraph();
 		styleService.applySectionTitleStyle(paragraph, sectionLevel);

 		XWPFRun run = paragraph.createRun();
 		run.setText(sectionTitle);
 	}

 	@Override
 	public void writeParagraph(String paragraph, boolean processRichText) {
 		XWPFParagraph p = document.createParagraph();
 		TextUtils.fillParagraph(p, paragraph);
 	}

 	@Override
 	public void writeList(AbstractList abstractList, boolean processRichText) {
 		if (false == abstractList instanceof BasicList) {
 			Activator.log.warn(NLS.bind("The list of type {0} is not supported by {1}.", abstractList.eClass().getName(), getClass().getName())); //$NON-NLS-1$
 			return;
 		}
 		final BasicList basicList = (BasicList) abstractList;
 		final Iterator<ListItem> iter = basicList.getItems().iterator();
 		while (iter.hasNext()) {
 			writeListItem(iter.next());
 		}
 	}

 	/**
 	 * Write the list for the given item
 	 *
 	 * @param listItem
 	 *            the item to write
 	 */
 	private void writeListItem(ListItem listItem) {
 		final int itemLevel = listItem.getLevel();
 		if (false == listItem instanceof TextListItem) {
 			Activator.log.warn(NLS.bind("The list item  of type {0} is not supported by {1}.", listItem.eClass().getName(), getClass().getName())); //$NON-NLS-1$
 			return;
 		}
 		XWPFParagraph paragraph = document.createParagraph();
 		paragraph.setNumID(BigInteger.ONE); // this correspond to the id of the abstractNum which is in the numbering file it start at 1
 		if (paragraph instanceof CustomXWPFParagraph) {
 			((CustomXWPFParagraph) paragraph).setItemLevel(itemLevel - 1);
 		}
 		XWPFRun run = paragraph.createRun();
 		run.setText(((TextListItem) listItem).getText());

 		styleService.applyListStyle(paragraph);

 		final Iterator<ListItem> subItemIterator = listItem.getSubItems().iterator();
 		while (subItemIterator.hasNext()) {
 			writeListItem(subItemIterator.next());
 		}
 	}

 	@Override
 	public void writeTable(AbstractTable table) {
 		// do some check
 		int rowsNumber = table.getRowsNumber();
 		int colNumbers = table.getColumnsNumber();

 		if (rowsNumber <= 0 || colNumbers <= 0) {
 			return;
 		}

 		final List<Cell> allCells = table.getAllCells();

 		final int totalCells = allCells.size();
 		if (rowsNumber * colNumbers != totalCells) {
 			Activator.log.warn(NLS.bind("The number of cells in the table is not as excepted. We won't manage the table {0}.", table.getCaption())); //$NON-NLS-1$
 			return;
 		}

 		// create and fill the table
 		XWPFTable xwpfTable = document.createTable(rowsNumber, colNumbers);
 		Iterator<Row> rowIter = table.getRows().iterator();
 		int rowIndex = 0;
 		while (rowIter.hasNext()) {
 			Row row = rowIter.next();
 			Iterator<Cell> cellIter = row.getCells().iterator();
 			int cellIndex = 0;
 			while (cellIter.hasNext()) {
 				Cell cell = cellIter.next();
 				if (cell instanceof TextCell) {
 					TextCell textCell = (TextCell) cell;
 					XWPFParagraph paragraph = xwpfTable.getRow(rowIndex).getCell(cellIndex).getParagraphArray(0);
 					if (null != paragraph) {
 						TextUtils.fillParagraph(paragraph, textCell.getText());
 					}
 				} else if (cell instanceof FileReferenceCell) {
 					XWPFTableCell xwpfCell = xwpfTable.getRow(rowIndex).getCell(cellIndex);
 					insertFileInTableCell(((FileReferenceCell) cell).getFileReference(), xwpfCell);
 				}
 				cellIndex++;
 			}
 			rowIndex++;
 		}

 		// apply styles
 		rowIter = table.getRows().iterator();
 		List<Cell> verticalMergedCells = new ArrayList<>();
 		while (rowIter.hasNext()) {
 			Row row = rowIter.next();
 			Iterator<Cell> cellIter = row.getCells().iterator();
 			while (cellIter.hasNext()) {
 				Cell cell = cellIter.next();

 				// Horizontal cell merge
 				BooleanNamedStyle style = (BooleanNamedStyle) cell.getNamedStyle(NamedStyleConstants.MERGED_WITH_RIGHT_CELL);
 				if (null != style && style.isValue()) {
 					Cell lastMergedCell = findLastHorizontalMergedCell(cellIter);

 					if (lastMergedCell != null && xwpfTable instanceof CustomXWPFTable) {
 						((CustomXWPFTable) xwpfTable).horizontalCellMerge(
 								table.getRows().indexOf(row),
 								row.getCells().indexOf(cell),
 								row.getCells().indexOf(lastMergedCell));
 					}
 				}

 				// Vertical cell merge
 				style = (BooleanNamedStyle) cell.getNamedStyle(NamedStyleConstants.MERGED_WITH_BOTTOM_CELL);
 				if (null != style && style.isValue()) {
 					if (false == verticalMergedCells.contains(cell)) { // otherwise it is already managed
 						Row lastMergedRow = findVerticalMergedCells(table, row, cell, verticalMergedCells);
 						if (lastMergedRow != null && xwpfTable instanceof CustomXWPFTable) {
 							((CustomXWPFTable) xwpfTable).verticalCellMerge(
 									row.getCells().indexOf(cell),
 									table.getRows().indexOf(row),
 									table.getRows().indexOf(lastMergedRow));
 						}
 					}
 				}
 			}
 		}

 		xwpfTable.setWidthType(TableWidthType.PCT); // resize table to use the page width
 		styleService.applyTableStyle(xwpfTable, document, table);
 	}

 	/**
 	 * Find the first cell following the iterator which does not have the {@link NamedStyleConstants.MERGED_WITH_RIGHT_CELL} style
 	 *
 	 * @param cellIter
 	 *            the start of the research
 	 * @return the last cell concerning by the merge
 	 */
 	private Cell findLastHorizontalMergedCell(Iterator<Cell> cellIter) {
 		while (cellIter.hasNext()) {
 			Cell cell = cellIter.next();
 			BooleanNamedStyle style = (BooleanNamedStyle) cell.getNamedStyle(NamedStyleConstants.MERGED_WITH_RIGHT_CELL);
 			if (null != style && style.isValue()) {
 				continue;
 			} else {
 				return cell;
 			}
 		}
 		return null;
 	}

 	/**
 	 * This method add every cells that must be merged with the firstCell (according to the {@link NamedStyleConstants.MERGED_WITH_BOTTOM_CELL} style)
 	 * to the mergedCells collection then it return the row of the laster merged cell
 	 *
 	 * @param table
 	 *            the table
 	 * @param row
 	 *            the row of the first cell of the merge
 	 * @param firstCell
 	 *            the first cell of the merge
 	 * @param mergedCells
 	 *            the list of merged cells
 	 * @return the row of the last merged cell
 	 */
 	private Row findVerticalMergedCells(final AbstractTable table, final Row row, final Cell firstCell, List<Cell> mergedCells) {
 		int columnIndex = row.getCells().indexOf(firstCell);
 		int rowIndex = table.getRows().indexOf(row) + 1;

 		while (rowIndex < table.getRowsNumber()) {
 			Cell cell = table.getRows().get(rowIndex).getCells().get(columnIndex);

 			BooleanNamedStyle style = (BooleanNamedStyle) cell.getNamedStyle(NamedStyleConstants.MERGED_WITH_BOTTOM_CELL);
 			if (null != style && style.isValue()) {
 				mergedCells.add(cell);
 			} else {
 				mergedCells.add(cell);
 				return table.getRows().get(rowIndex);
 			}
 			rowIndex++;
 		}

 		return null;
 	}

 	/**
 	 * @see org.eclipse.papyrus.model2doc.core.transcription.Transcription#insertFile(org.eclipse.papyrus.model2doc.core.builtintypes.IFileReference)
 	 *
 	 * @param fileReference
 	 */
 	@Override
 	public void insertFile(IFileReference fileReference) {
 		try {
 			final IInputFileAccessor accessor = fileReference.getFileAccessor();
 			final URL url = accessor.createInputFileURL();
 			final String path = accessor.urlToPathString(url, true);
 			document.insertFile(path);
 		} catch (Exception e) {
 			Activator.log.warn(NLS.bind("The {0} file can not be inserted", fileReference.getFilePath())); //$NON-NLS-1$
 		}
 	}

 	/**
 	 * Insert the contents of a file in table cell
 	 *
 	 * @param fileReference
 	 *            a reference to a file
 	 * @param cell
 	 *            the cell receiving the file
 	 */
 	private void insertFileInTableCell(IFileReference fileReference, XWPFTableCell xwpfCell) {
 		final IInputFileAccessor accessor = fileReference.getFileAccessor();
 		final URL url = accessor.createInputFileURL();
 		if (url != null) {
 			final String path = accessor.urlToPathString(url, true);
 			try {
 				for (int i = 0; i < xwpfCell.getParagraphs().size(); i++) {
 					// when the cell is created, a paragraph is also created, to avoid a useless blank line we remove it
 					xwpfCell.removeParagraph(i);
 				}
 				String id = document.importFile(path);
 				xwpfCell.getCTTc().addNewAltChunk().setId(id);
 			} catch (InvalidFormatException | IOException e) {
 				Activator.log.warn(NLS.bind("The {0} file can not be inserted", fileReference.getFilePath())); //$NON-NLS-1$
 			}
 		}
 	}

 	@Override
 	public void writeImage(String imagePath, String caption) {
 		Assert.isTrue(false == imagePath.endsWith("svg"));//$NON-NLS-1$
 		imagePath = imagePath.replaceFirst(ECORE_FILE_PREFIX, EMPTY_STRING);
 		// insert the picture
 		XWPFParagraph imageParagraph = document.createParagraph();
 		XWPFRun imageRun = imageParagraph.createRun();
 		FileInputStream inputStream;
 		try {
 			inputStream = new FileInputStream(imagePath);
 			String[] path = imagePath.split(ECORE_URI_FILE_SEPARATOR);

 			int[] size = ImageUtils.getImageSize(imagePath, document);
 			imageRun.addPicture(inputStream, Document.PICTURE_TYPE_PNG, path[path.length - 1], size[0], size[1]);
 			inputStream.close();
 		} catch (IOException | InvalidFormatException e) {
 			Activator.log.error(e);
 		}

 		// Write caption
 		XWPFParagraph captionParagraph = document.createParagraph();
 		styleService.applyCaptionStyle(captionParagraph, document);

 		XWPFRun captionRun = captionParagraph.createRun();
 		captionRun.setText(Messages.DocxTranscription_imageCaptionLabel + WHITE_SPACE);
 		CTSimpleField seq = captionParagraph.getCTP().addNewFldSimple();
 		seq.setInstr(" SEQ Figure \\* ARABIC "); //$NON-NLS-1$
 		CTR ctr = seq.addNewR();
 		CTRPr ctrpr = ctr.addNewRPr();
 		ctrpr.addNewNoProof();
 		CTText ctText = ctr.addNewT();
 		ctText.setStringValue(String.valueOf(imageIndex));
 		XWPFRun captionTextRun = captionParagraph.createRun();
 		captionTextRun.setText(": " + caption); //$NON-NLS-1$

 		imageIndex++;
 	}

 	// TODO : define clearly the kind of the returned String between docx and odt generator
 	@Override
 	public String save(String label) {
 		final IOutputFileAccessor accessor = docxGeneratorConfig.createDocumentOutputAccessor();
 		final URI ecoreURI = accessor.createOutputFileURI(docxGeneratorConfig.getDocumentName(), DOCX_FILE_EXTENTION);
 		final URL destURL = accessor.convertToURL(ecoreURI);
 		try {
 			String destPath = accessor.urlToPathString(destURL, true);
 			OutputStream outputStream = new FileOutputStream(destPath);
 			document.write(outputStream);
 			outputStream.close();
 			document.close();
 		} catch (IOException e) {
 			Activator.log.error(e);
 		}

 		return destURL.toString();
 	}

 	/**
 	 * @see org.eclipse.papyrus.model2doc.core.transcription.Transcription#insertEmptyLine()
 	 *
 	 */
 	@Override
 	public void insertEmptyLine() {
 		document.createParagraph();
 	}

 	@Override
 	public IDocumentGeneratorConfiguration getGeneratorConfig() {
 		// TODO Auto-generated method stub
 		return null;
 	}

 	@Override
 	public boolean canExecute() {
 		// TODO Auto-generated method stub
 		return false;
 	}

 	@Override
 	public void importImage(ImageDescription image, String caption) {
 		// FIXME This method should be removed
 	}

 	@Override
 	public void writeImageSubtitle(ImageDescription image) {
 		// FIXME This method should be removed
 	}

 	/**
 	 * @see org.eclipse.papyrus.model2doc.core.transcription.Transcription#setDocumentVersionProperty(java.lang.String)
 	 *
 	 * @param documentVersion
 	 */
 	@Override
 	public void setDocumentVersionProperty(String documentVersion) {
 		// TODO Auto-generated method stub

 	}

 	/**
 	 * @see org.eclipse.papyrus.model2doc.core.transcription.Transcription#setDocumentMaintTitleProperty(java.lang.String)
 	 *
 	 * @param documentTitle
 	 */
 	@Override
 	public void setDocumentMaintTitleProperty(String documentTitle) {
 		// TODO Auto-generated method stub

 	}

 	/**
 	 * @see org.eclipse.papyrus.model2doc.core.transcription.Transcription#setDocumentAuthorsProperty(java.util.Collection)
 	 *
 	 * @param authors
 	 */
 	@Override
 	public void setDocumentAuthorsProperty(Collection<IAuthor> authors) {
 		// TODO Auto-generated method stub

 	}

 }
	/*****************************************************************************
	* Copyright (c) 2020, 2021 CEA LIST.
	*
	* All rights reserved. This program and the accompanying materials
	* are made available under the terms of the Eclipse Public License 2.0
	* which accompanies this distribution, and is available at
	* https://www.eclipse.org/legal/epl-2.0/
	*
	* SPDX-License-Identifier: EPL-2.0
	*
	* Contributors:
	* Pauline DEVILLE (CEA LIST) pauline.deville@cea.fr - Initial API and implementation
	* Vincent LORENZO (CEA LIST) vincent.lorenzo@cea.fr - bug 569059
	* Pauline DEVILLE (CEA LIST) pauline.deville@cea.fr - Bug 569249
	* Vincent Lorenzo (CEA LIST) vincent.lorenzo@cea.fr - bug 569817
	* Pauline DEVILLE (CEA LIST) pauline.deville@cea.fr - Bug 570290
	* Vincent Lorenzo (CEA LIST) vincent.lorenzo@cea.fr - bug 570803
	* Yoann Farre (CIL4Sys Engineering) yoann.farre@cil4sys.com - Bug 571508
	*****************************************************************************/
	package org.eclipse.papyrus.model2doc.docx.internal.transcription;

	import java.io.File;
	import java.io.FileInputStream;
	import java.io.FileOutputStream;
	import java.io.IOException;
	import java.io.InputStream;
	import java.io.OutputStream;
	import java.math.BigInteger;
	import java.net.URL;
	import java.util.ArrayList;
	import java.util.Collection;
	import java.util.Iterator;
	import java.util.List;

	import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
	import org.apache.poi.openxml4j.opc.OPCPackage;
	import org.apache.poi.xwpf.usermodel.Document;
	import org.apache.poi.xwpf.usermodel.TableWidthType;
	import org.apache.poi.xwpf.usermodel.XWPFParagraph;
	import org.apache.poi.xwpf.usermodel.XWPFRun;
	import org.apache.poi.xwpf.usermodel.XWPFTable;
	import org.apache.poi.xwpf.usermodel.XWPFTableCell;
	import org.eclipse.core.runtime.Assert;
	import org.eclipse.core.runtime.IPath;
	import org.eclipse.core.runtime.Path;
	import org.eclipse.emf.common.util.URI;
	import org.eclipse.osgi.util.NLS;
	import org.eclipse.papyrus.model2doc.core.author.IAuthor;
	import org.eclipse.papyrus.model2doc.core.builtintypes.AbstractList;
	import org.eclipse.papyrus.model2doc.core.builtintypes.AbstractTable;
	import org.eclipse.papyrus.model2doc.core.builtintypes.BasicList;
	import org.eclipse.papyrus.model2doc.core.builtintypes.Cell;
	import org.eclipse.papyrus.model2doc.core.builtintypes.FileReferenceCell;
	import org.eclipse.papyrus.model2doc.core.builtintypes.IFileReference;
	import org.eclipse.papyrus.model2doc.core.builtintypes.ListItem;
	import org.eclipse.papyrus.model2doc.core.builtintypes.Row;
	import org.eclipse.papyrus.model2doc.core.builtintypes.TextCell;
	import org.eclipse.papyrus.model2doc.core.builtintypes.TextListItem;
	import org.eclipse.papyrus.model2doc.core.builtintypes.accessors.IInputFileAccessor;
	import org.eclipse.papyrus.model2doc.core.generatorconfiguration.IDocumentGeneratorConfiguration;
	import org.eclipse.papyrus.model2doc.core.generatorconfiguration.accessors.IOutputFileAccessor;
	import org.eclipse.papyrus.model2doc.core.styles.BooleanNamedStyle;
	import org.eclipse.papyrus.model2doc.core.styles.NamedStyleConstants;
	import org.eclipse.papyrus.model2doc.core.transcription.CoverPage;
	import org.eclipse.papyrus.model2doc.core.transcription.ImageDescription;
	import org.eclipse.papyrus.model2doc.core.transcription.Transcription;
	import org.eclipse.papyrus.model2doc.docx.Activator;
	import org.eclipse.papyrus.model2doc.docx.Messages;
	import org.eclipse.papyrus.model2doc.docx.internal.poi.CustomXWPFDocument;
	import org.eclipse.papyrus.model2doc.docx.internal.poi.CustomXWPFParagraph;
	import org.eclipse.papyrus.model2doc.docx.internal.poi.CustomXWPFTable;
	import org.eclipse.papyrus.model2doc.docx.internal.services.StyleServiceImpl;
	import org.eclipse.papyrus.model2doc.docx.internal.util.ImageUtils;
	import org.eclipse.papyrus.model2doc.docx.internal.util.TextUtils;
	import org.eclipse.papyrus.model2doc.docx.services.StyleService;
	import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTR;
	import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTRPr;
	import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSimpleField;
	import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTText;

	public class DocxTranscription implements Transcription {

	private static final String DOTX_SCHEMA = "application/vnd.openxmlformats-officedocument.wordprocessingml.template.main+xml";//$NON-NLS-1$

	private static final String DOCX_SCHEMA = "application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml";//$NON-NLS-1$

	private IDocumentGeneratorConfiguration docxGeneratorConfig;

	private CustomXWPFDocument document;

	protected StyleService styleService;

	private int imageIndex = 1;

	private static final String ECORE_URI_FILE_SEPARATOR = "/";//$NON-NLS-1$

	private static final String DOCX_FILE_EXTENTION = "docx";//$NON-NLS-1$

	private static final String ECORE_FILE_PREFIX = "file:"; //$NON-NLS-1$

	private static final String EMPTY_STRING = ""; //$NON-NLS-1$

	private static final String WHITE_SPACE = " "; //$NON-NLS-1$

	public DocxTranscription(IDocumentGeneratorConfiguration dgc) {
	this.docxGeneratorConfig = dgc;
	this.styleService = new StyleServiceImpl();
	try {
	final InputStream templateInputStream = getFileWithTemplateLoaded();
	if (templateInputStream != null) {
	// bug 569059 - see https://stackoverflow.com/questions/16264247/create-document-from-dotx-template-with-apache-poi-hwpf for solution
	this.document = new CustomXWPFDocument(templateInputStream);
	templateInputStream.close();
	}
	} catch (IOException e) {
	Activator.log.warn("Cannot apply the template file"); //$NON-NLS-1$
	} catch (InvalidFormatException e1) {
	Activator.log.error("Cannot apply the template file", e1);//$NON-NLS-1$
	}
	if (this.document == null) {
	this.document = new CustomXWPFDocument();
	}
	}

	/**
	* This method open the destination file and replace it by the the template
	*
	* @return an inputStream on the destination file
	* @throws IOException
	* @throws InvalidFormatException
	*/
	private InputStream getFileWithTemplateLoaded() throws IOException, InvalidFormatException {
	final URL templateURL = this.docxGeneratorConfig.createTemplateFileInputAccessor().createInputFileURL();

	if (templateURL != null) {
	final IOutputFileAccessor outputAccessor = this.docxGeneratorConfig.createDocumentOutputAccessor();
	final URL destURL = outputAccessor.createOutputFileURL(docxGeneratorConfig.getDocumentName(), DOCX_FILE_EXTENTION);

	String destURI = outputAccessor.urlToPathString(destURL, true);
	// create intermediate folder when they don't exist.
	// TODO : make common method with image generation and odt
	// TODO : what to do when dest project doesn't yet exist ?
	final Path targetPath = new Path(destURI);
	// we check all folders tree already exists, and we create them if not
	if (targetPath.segmentCount() > 1) {
	final IPath folderPath = targetPath.removeLastSegments(1);
	final File folder = folderPath.toFile();
	if (false == folder.exists()) {
	folder.mkdirs();
	}
	}

	InputStream templateIS = templateURL.openStream();
	FileOutputStream destIS = new FileOutputStream(destURI);

	OPCPackage pkg = OPCPackage.open(templateIS);
	pkg.replaceContentType(DOTX_SCHEMA, DOCX_SCHEMA);
	pkg.save(destIS);

	templateIS.close();
	destIS.close();

	return destURL.openStream();
	}
	return null;
	}

	@Override
	public void writeCoverPage(CoverPage coverPage) {
	// TODO Auto-generated method stub

	}

	@Override
	public void writeTableOfContents(String tocTitle) {
	XWPFParagraph p = document.createParagraph();
	XWPFRun run = p.createRun();
	run.setText(tocTitle);

	document.createTOC();
	}

	@Override
	public void writeTableOfFigures(String tofTitle) {
	XWPFParagraph p = document.createParagraph();
	XWPFRun run = p.createRun();
	run.setText(tofTitle);

	document.createTOF();
	}

	@Override
	public void refreshTablesOfIndexes() {
	// TODO Auto-generated method stub

	}

	@Override
	public void writeDocumentMainTitle(String documentTitle) {
	XWPFParagraph p = document.createParagraph();
	styleService.applyDocumentMainTitleStyle(p);

	XWPFRun run = p.createRun();
	run.setText(documentTitle);
	}

	@Override
	public void writeAuthors(Collection<IAuthor> authors) {
	setDocumentAuthorsProperty(authors);
	}

	@Override
	public void writeVersion(String version) {
	setDocumentVersionProperty(version);
	}

	@Override
	public void writeSectionTitle(String sectionTitle, int sectionLevel) {
	XWPFParagraph paragraph = document.createParagraph();
	styleService.applySectionTitleStyle(paragraph, sectionLevel);

	XWPFRun run = paragraph.createRun();
	run.setText(sectionTitle);
	}

	@Override
	public void writeParagraph(String paragraph, boolean processRichText) {
	XWPFParagraph p = document.createParagraph();
	TextUtils.fillParagraph(p, paragraph);
	}

	@Override
	public void writeList(AbstractList abstractList, boolean processRichText) {
	if (false == abstractList instanceof BasicList) {
	Activator.log.warn(NLS.bind("The list of type {0} is not supported by {1}.", abstractList.eClass().getName(), getClass().getName())); //$NON-NLS-1$
	return;
	}
	final BasicList basicList = (BasicList) abstractList;
	final Iterator<ListItem> iter = basicList.getItems().iterator();
	while (iter.hasNext()) {
	writeListItem(iter.next());
	}
	}

	/**
	* Write the list for the given item
	*
	* @param listItem
	* the item to write
	*/
	private void writeListItem(ListItem listItem) {
	final int itemLevel = listItem.getLevel();
	if (false == listItem instanceof TextListItem) {
	Activator.log.warn(NLS.bind("The list item of type {0} is not supported by {1}.", listItem.eClass().getName(), getClass().getName())); //$NON-NLS-1$
	return;
	}
	XWPFParagraph paragraph = document.createParagraph();
	paragraph.setNumID(BigInteger.ONE); // this correspond to the id of the abstractNum which is in the numbering file it start at 1
	if (paragraph instanceof CustomXWPFParagraph) {
	((CustomXWPFParagraph) paragraph).setItemLevel(itemLevel - 1);
	}
	XWPFRun run = paragraph.createRun();
	run.setText(((TextListItem) listItem).getText());

	styleService.applyListStyle(paragraph);

	final Iterator<ListItem> subItemIterator = listItem.getSubItems().iterator();
	while (subItemIterator.hasNext()) {
	writeListItem(subItemIterator.next());
	}
	}

	@Override
	public void writeTable(AbstractTable table) {
	// do some check
	int rowsNumber = table.getRowsNumber();
	int colNumbers = table.getColumnsNumber();

	if (rowsNumber <= 0 \|\| colNumbers <= 0) {
	return;
	}

	final List<Cell> allCells = table.getAllCells();

	final int totalCells = allCells.size();
	if (rowsNumber * colNumbers != totalCells) {
	Activator.log.warn(NLS.bind("The number of cells in the table is not as excepted. We won't manage the table {0}.", table.getCaption())); //$NON-NLS-1$
	return;
	}

	// create and fill the table
	XWPFTable xwpfTable = document.createTable(rowsNumber, colNumbers);
	Iterator<Row> rowIter = table.getRows().iterator();
	int rowIndex = 0;
	while (rowIter.hasNext()) {
	Row row = rowIter.next();
	Iterator<Cell> cellIter = row.getCells().iterator();
	int cellIndex = 0;
	while (cellIter.hasNext()) {
	Cell cell = cellIter.next();
	if (cell instanceof TextCell) {
	TextCell textCell = (TextCell) cell;
	XWPFParagraph paragraph = xwpfTable.getRow(rowIndex).getCell(cellIndex).getParagraphArray(0);
	if (null != paragraph) {
	TextUtils.fillParagraph(paragraph, textCell.getText());
	}
	} else if (cell instanceof FileReferenceCell) {
	XWPFTableCell xwpfCell = xwpfTable.getRow(rowIndex).getCell(cellIndex);
	insertFileInTableCell(((FileReferenceCell) cell).getFileReference(), xwpfCell);
	}
	cellIndex++;
	}
	rowIndex++;
	}

	// apply styles
	rowIter = table.getRows().iterator();
	List<Cell> verticalMergedCells = new ArrayList<>();
	while (rowIter.hasNext()) {
	Row row = rowIter.next();
	Iterator<Cell> cellIter = row.getCells().iterator();
	while (cellIter.hasNext()) {
	Cell cell = cellIter.next();

	// Horizontal cell merge
	BooleanNamedStyle style = (BooleanNamedStyle) cell.getNamedStyle(NamedStyleConstants.MERGED_WITH_RIGHT_CELL);
	if (null != style && style.isValue()) {
	Cell lastMergedCell = findLastHorizontalMergedCell(cellIter);

	if (lastMergedCell != null && xwpfTable instanceof CustomXWPFTable) {
	((CustomXWPFTable) xwpfTable).horizontalCellMerge(
	table.getRows().indexOf(row),
	row.getCells().indexOf(cell),
	row.getCells().indexOf(lastMergedCell));
	}
	}

	// Vertical cell merge
	style = (BooleanNamedStyle) cell.getNamedStyle(NamedStyleConstants.MERGED_WITH_BOTTOM_CELL);
	if (null != style && style.isValue()) {
	if (false == verticalMergedCells.contains(cell)) { // otherwise it is already managed
	Row lastMergedRow = findVerticalMergedCells(table, row, cell, verticalMergedCells);
	if (lastMergedRow != null && xwpfTable instanceof CustomXWPFTable) {
	((CustomXWPFTable) xwpfTable).verticalCellMerge(
	row.getCells().indexOf(cell),
	table.getRows().indexOf(row),
	table.getRows().indexOf(lastMergedRow));
	}
	}
	}
	}
	}

	xwpfTable.setWidthType(TableWidthType.PCT); // resize table to use the page width
	styleService.applyTableStyle(xwpfTable, document, table);
	}

	/**
	* Find the first cell following the iterator which does not have the {@link NamedStyleConstants.MERGED_WITH_RIGHT_CELL} style
	*
	* @param cellIter
	* the start of the research
	* @return the last cell concerning by the merge
	*/
	private Cell findLastHorizontalMergedCell(Iterator<Cell> cellIter) {
	while (cellIter.hasNext()) {
	Cell cell = cellIter.next();
	BooleanNamedStyle style = (BooleanNamedStyle) cell.getNamedStyle(NamedStyleConstants.MERGED_WITH_RIGHT_CELL);
	if (null != style && style.isValue()) {
	continue;
	} else {
	return cell;
	}
	}
	return null;
	}

	/**
	* This method add every cells that must be merged with the firstCell (according to the {@link NamedStyleConstants.MERGED_WITH_BOTTOM_CELL} style)
	* to the mergedCells collection then it return the row of the laster merged cell
	*
	* @param table
	* the table
	* @param row
	* the row of the first cell of the merge
	* @param firstCell
	* the first cell of the merge
	* @param mergedCells
	* the list of merged cells
	* @return the row of the last merged cell
	*/
	private Row findVerticalMergedCells(final AbstractTable table, final Row row, final Cell firstCell, List<Cell> mergedCells) {
	int columnIndex = row.getCells().indexOf(firstCell);
	int rowIndex = table.getRows().indexOf(row) + 1;

	while (rowIndex < table.getRowsNumber()) {
	Cell cell = table.getRows().get(rowIndex).getCells().get(columnIndex);

	BooleanNamedStyle style = (BooleanNamedStyle) cell.getNamedStyle(NamedStyleConstants.MERGED_WITH_BOTTOM_CELL);
	if (null != style && style.isValue()) {
	mergedCells.add(cell);
	} else {
	mergedCells.add(cell);
	return table.getRows().get(rowIndex);
	}
	rowIndex++;
	}

	return null;
	}

	/**
	* @see org.eclipse.papyrus.model2doc.core.transcription.Transcription#insertFile(org.eclipse.papyrus.model2doc.core.builtintypes.IFileReference)
	*
	* @param fileReference
	*/
	@Override
	public void insertFile(IFileReference fileReference) {
	try {
	final IInputFileAccessor accessor = fileReference.getFileAccessor();
	final URL url = accessor.createInputFileURL();
	final String path = accessor.urlToPathString(url, true);
	document.insertFile(path);
	} catch (Exception e) {
	Activator.log.warn(NLS.bind("The {0} file can not be inserted", fileReference.getFilePath())); //$NON-NLS-1$
	}
	}

	/**
	* Insert the contents of a file in table cell
	*
	* @param fileReference
	* a reference to a file
	* @param cell
	* the cell receiving the file
	*/
	private void insertFileInTableCell(IFileReference fileReference, XWPFTableCell xwpfCell) {
	final IInputFileAccessor accessor = fileReference.getFileAccessor();
	final URL url = accessor.createInputFileURL();
	if (url != null) {
	final String path = accessor.urlToPathString(url, true);
	try {
	for (int i = 0; i < xwpfCell.getParagraphs().size(); i++) {
	// when the cell is created, a paragraph is also created, to avoid a useless blank line we remove it
	xwpfCell.removeParagraph(i);
	}
	String id = document.importFile(path);
	xwpfCell.getCTTc().addNewAltChunk().setId(id);
	} catch (InvalidFormatException \| IOException e) {
	Activator.log.warn(NLS.bind("The {0} file can not be inserted", fileReference.getFilePath())); //$NON-NLS-1$
	}
	}
	}

	@Override
	public void writeImage(String imagePath, String caption) {
	Assert.isTrue(false == imagePath.endsWith("svg"));//$NON-NLS-1$
	imagePath = imagePath.replaceFirst(ECORE_FILE_PREFIX, EMPTY_STRING);
	// insert the picture
	XWPFParagraph imageParagraph = document.createParagraph();
	XWPFRun imageRun = imageParagraph.createRun();
	FileInputStream inputStream;
	try {
	inputStream = new FileInputStream(imagePath);
	String[] path = imagePath.split(ECORE_URI_FILE_SEPARATOR);

	int[] size = ImageUtils.getImageSize(imagePath, document);
	imageRun.addPicture(inputStream, Document.PICTURE_TYPE_PNG, path[path.length - 1], size[0], size[1]);
	inputStream.close();
	} catch (IOException \| InvalidFormatException e) {
	Activator.log.error(e);
	}

	// Write caption
	XWPFParagraph captionParagraph = document.createParagraph();
	styleService.applyCaptionStyle(captionParagraph, document);

	XWPFRun captionRun = captionParagraph.createRun();
	captionRun.setText(Messages.DocxTranscription_imageCaptionLabel + WHITE_SPACE);
	CTSimpleField seq = captionParagraph.getCTP().addNewFldSimple();
	seq.setInstr(" SEQ Figure \\* ARABIC "); //$NON-NLS-1$
	CTR ctr = seq.addNewR();
	CTRPr ctrpr = ctr.addNewRPr();
	ctrpr.addNewNoProof();
	CTText ctText = ctr.addNewT();
	ctText.setStringValue(String.valueOf(imageIndex));
	XWPFRun captionTextRun = captionParagraph.createRun();
	captionTextRun.setText(": " + caption); //$NON-NLS-1$

	imageIndex++;
	}

	// TODO : define clearly the kind of the returned String between docx and odt generator
	@Override
	public String save(String label) {
	final IOutputFileAccessor accessor = docxGeneratorConfig.createDocumentOutputAccessor();
	final URI ecoreURI = accessor.createOutputFileURI(docxGeneratorConfig.getDocumentName(), DOCX_FILE_EXTENTION);
	final URL destURL = accessor.convertToURL(ecoreURI);
	try {
	String destPath = accessor.urlToPathString(destURL, true);
	OutputStream outputStream = new FileOutputStream(destPath);
	document.write(outputStream);
	outputStream.close();
	document.close();
	} catch (IOException e) {
	Activator.log.error(e);
	}

	return destURL.toString();
	}

	/**
	* @see org.eclipse.papyrus.model2doc.core.transcription.Transcription#insertEmptyLine()
	*
	*/
	@Override
	public void insertEmptyLine() {
	document.createParagraph();
	}

	@Override
	public IDocumentGeneratorConfiguration getGeneratorConfig() {
	// TODO Auto-generated method stub
	return null;
	}

	@Override
	public boolean canExecute() {
	// TODO Auto-generated method stub
	return false;
	}

	@Override
	public void importImage(ImageDescription image, String caption) {
	// FIXME This method should be removed
	}

	@Override
	public void writeImageSubtitle(ImageDescription image) {
	// FIXME This method should be removed
	}

	/**
	* @see org.eclipse.papyrus.model2doc.core.transcription.Transcription#setDocumentVersionProperty(java.lang.String)
	*
	* @param documentVersion
	*/
	@Override
	public void setDocumentVersionProperty(String documentVersion) {
	// TODO Auto-generated method stub

	}

	/**
	* @see org.eclipse.papyrus.model2doc.core.transcription.Transcription#setDocumentMaintTitleProperty(java.lang.String)
	*
	* @param documentTitle
	*/
	@Override
	public void setDocumentMaintTitleProperty(String documentTitle) {
	// TODO Auto-generated method stub

	}

	/**
	* @see org.eclipse.papyrus.model2doc.core.transcription.Transcription#setDocumentAuthorsProperty(java.util.Collection)
	*
	* @param authors
	*/
	@Override
	public void setDocumentAuthorsProperty(Collection<IAuthor> authors) {
	// TODO Auto-generated method stub

	}

	}