package org.hl7.fhir.utilities.xhtml;
/*
* #%L
* HAPI FHIR - Core Library
* %%
* Copyright (C) 2014 - 2017 University Health Network
* %%
* 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.
* #L%
*/
/*
Copyright (c) 2011+, HL7, Inc
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of HL7 nor the names of its contributors may be used to
endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/
import java.awt.Color;
import java.awt.image.BufferedImage;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.imageio.ImageIO;
import org.apache.commons.codec.binary.Base64;
import org.apache.commons.io.FileUtils;
import org.hl7.fhir.exceptions.FHIRException;
import org.hl7.fhir.utilities.Utilities;
public class HierarchicalTableGenerator {
public static final String TEXT_ICON_REFERENCE = "Reference to another Resource";
public static final String TEXT_ICON_PRIMITIVE = "Primitive Data Type";
public static final String TEXT_ICON_DATATYPE = "Data Type";
public static final String TEXT_ICON_RESOURCE = "Resource";
public static final String TEXT_ICON_ELEMENT = "Element";
public static final String TEXT_ICON_REUSE = "Reference to another Element";
public static final String TEXT_ICON_EXTENSION = "Extension";
public static final String TEXT_ICON_CHOICE = "Choice of Types";
public static final String TEXT_ICON_SLICE = "Slice Definition";
public static final String TEXT_ICON_EXTENSION_SIMPLE = "Simple Extension";
public static final String TEXT_ICON_PROFILE = "Profile";
public static final String TEXT_ICON_EXTENSION_COMPLEX = "Complex Extension";
private static Map<String, String> files = new HashMap<String, String>();
public class Piece {
private String tag;
private String reference;
private String text;
private String hint;
private String style;
private Map<String, String> attributes;
public Piece(String tag) {
super();
this.tag = tag;
}
public Piece(String reference, String text, String hint) {
super();
this.reference = reference;
this.text = text;
this.hint = hint;
}
public String getReference() {
return reference;
}
public void setReference(String value) {
reference = value;
}
public String getText() {
return text;
}
public String getHint() {
return hint;
}
public String getTag() {
return tag;
}
public String getStyle() {
return style;
}
public void setTag(String tag) {
this.tag = tag;
}
public void setText(String text) {
this.text = text;
}
public void setHint(String hint) {
this.hint = hint;
}
public Piece setStyle(String style) {
this.style = style;
return this;
}
public Piece addStyle(String style) {
if (this.style != null)
this.style = this.style+"; "+style;
else
this.style = style;
return this;
}
public void addToHint(String text) {
if (this.hint == null)
this.hint = text;
else
this.hint += (this.hint.endsWith(".") || this.hint.endsWith("?") ? " " : ". ")+text;
}
}
public class Cell {
private List<Piece> pieces = new ArrayList<HierarchicalTableGenerator.Piece>();
public Cell() {
}
public Cell(String prefix, String reference, String text, String hint, String suffix) {
super();
if (!Utilities.noString(prefix))
pieces.add(new Piece(null, prefix, null));
pieces.add(new Piece(reference, text, hint));
if (!Utilities.noString(suffix))
pieces.add(new Piece(null, suffix, null));
}
public List<Piece> getPieces() {
return pieces;
}
public Cell addPiece(Piece piece) {
pieces.add(piece);
return this;
}
// private List<Piece> htmlToParagraphPieces(String html) {
// List<Piece> myPieces = new ArrayList<Piece>();
// String[] paragraphs = html.replace("<p>", "").split("<\\/p>|<br \\/>");
// for (int i=0;i<paragraphs.length;i++) {
// if (!paragraphs[i].isEmpty()) {
// if (i!=0) {
// myPieces.add(new Piece("br"));
// myPieces.add(new Piece("br"));
// }
// myPieces.addAll(htmlFormattingToPieces(paragraphs[i]));
// }
// }
//
// return myPieces;
// }
// private List<Piece> htmlFormattingToPieces(String html) {
// List<Piece> myPieces = new ArrayList<Piece>();
// //Todo: At least handle bold and italics and turn them into formatted spans. (Will need to handle nesting though)
// myPieces.add(new Piece(null, html, null));
//
// return myPieces;
// }
public void addStyle(String style) {
for (Piece p : pieces)
p.addStyle(style);
}
public void addToHint(String text) {
for (Piece p : pieces)
p.addToHint(text);
}
public Piece addImage(String src, String hint, String alt, String fgColor, String bgColor) {
// Piece img = new Piece("img");
Piece img = new Piece(null, alt, hint);
img.addStyle("padding: 3px");
if (fgColor != null) {
img.addStyle("color: "+fgColor);
img.addStyle("background-color: "+bgColor);
}
// img.attributes = new HashMap<String, String>();
// img.attributes.put("src", src);
// img.attributes.put("alt", alt);
// img.hint = hint;
pieces.add(img);
return img;
}
public String text() {
StringBuilder b = new StringBuilder();
for (Piece p : pieces)
b.append(p.text);
return b.toString();
}
@Override
public String toString() {
return text();
}
}
public class Title extends Cell {
private int width;
public Title(String prefix, String reference, String text, String hint, String suffix, int width) {
super(prefix, reference, text, hint, suffix);
this.width = width;
}
}
public class Row {
private List<Row> subRows = new ArrayList<HierarchicalTableGenerator.Row>();
private List<Cell> cells = new ArrayList<HierarchicalTableGenerator.Cell>();
private String icon;
private String anchor;
private String hint;
private String color;
public List<Row> getSubRows() {
return subRows;
}
public List<Cell> getCells() {
return cells;
}
public String getIcon() {
return icon;
}
public void setIcon(String icon, String hint) {
this.icon = icon;
this.hint = hint;
}
public String getAnchor() {
return anchor;
}
public void setAnchor(String anchor) {
this.anchor = anchor;
}
public String getHint() {
return hint;
}
public String getColor() {
return color;
}
public void setColor(String color) {
this.color = color;
}
}
public class TableModel {
private List<Title> titles = new ArrayList<HierarchicalTableGenerator.Title>();
private List<Row> rows = new ArrayList<HierarchicalTableGenerator.Row>();
private String docoRef;
private String docoImg;
public List<Title> getTitles() {
return titles;
}
public List<Row> getRows() {
return rows;
}
public String getDocoRef() {
return docoRef;
}
public String getDocoImg() {
return docoImg;
}
public void setDocoRef(String docoRef) {
this.docoRef = docoRef;
}
public void setDocoImg(String docoImg) {
this.docoImg = docoImg;
}
}
private String dest;
/**
* There are circumstances where the table has to present in the absence of a stable supporting infrastructure.
* and the file paths cannot be guaranteed. For these reasons, you can tell the builder to inline all the graphics
* (all the styles are inlined anyway, since the table fbuiler has even less control over the styling
*
*/
private boolean inLineGraphics;
public HierarchicalTableGenerator() {
super();
}
public HierarchicalTableGenerator(String dest, boolean inlineGraphics) {
super();
this.dest = dest;
this.inLineGraphics = inlineGraphics;
}
public TableModel initNormalTable(String prefix, boolean isLogical) {
TableModel model = new TableModel();
model.setDocoImg(prefix+"help16.png");
model.setDocoRef(prefix+"formats.html#table");
model.getTitles().add(new Title(null, model.getDocoRef(), "Name", "The logical name of the element", null, 0));
model.getTitles().add(new Title(null, model.getDocoRef(), "Flags", "Information about the use of the element", null, 0));
model.getTitles().add(new Title(null, model.getDocoRef(), "Card.", "Minimum and Maximum # of times the the element can appear in the instance", null, 0));
model.getTitles().add(new Title(null, model.getDocoRef(), "Type", "Reference to the type of the element", null, 100));
model.getTitles().add(new Title(null, model.getDocoRef(), "Description & Constraints", "Additional information about the element", null, 0));
if (isLogical) {
model.getTitles().add(new Title(null, prefix+"structuredefinition.html#logical", "Implemented As", "How this logical data item is implemented in a concrete resource", null, 0));
}
return model;
}
public TableModel initGridTable(String prefix) {
TableModel model = new TableModel();
model.getTitles().add(new Title(null, model.getDocoRef(), "Name", "The name of the element (Slice name in brackets). Mouse-over provides definition", null, 0));
model.getTitles().add(new Title(null, model.getDocoRef(), "Card.", "Minimum and Maximum # of times the the element can appear in the instance. Super-scripts indicate additional constraints on appearance", null, 0));
model.getTitles().add(new Title(null, model.getDocoRef(), "Type", "Reference to the type of the element", null, 100));
model.getTitles().add(new Title(null, model.getDocoRef(), "Constraints and Usage", "Fixed values, length limits, vocabulary bindings and other usage notes", null, 0));
return model;
}
public XhtmlNode generate(TableModel model, String imagePath, int border) throws IOException, FHIRException {
checkModel(model);
XhtmlNode table = new XhtmlNode(NodeType.Element, "table").setAttribute("border", Integer.toString(border)).setAttribute("cellspacing", "0").setAttribute("cellpadding", "0");
table.setAttribute("style", "border: " + border + "px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;");
XhtmlNode tr = table.addTag("tr");
tr.setAttribute("style", "border: " + Integer.toString(1 + border) + "px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;");
XhtmlNode tc = null;
for (Title t : model.getTitles()) {
tc = renderCell(tr, t, "th", null, null, null, false, null, "white", imagePath, border);
if (t.width != 0)
tc.setAttribute("style", "width: "+Integer.toString(t.width)+"px");
}
if (tc != null && model.getDocoRef() != null)
tc.addTag("span").setAttribute("style", "float: right").addTag("a").setAttribute("title", "Legend for this format").setAttribute("href", model.getDocoRef()).addTag("img").setAttribute("alt", "doco").setAttribute("style", "background-color: inherit").setAttribute("src", model.getDocoImg());
for (Row r : model.getRows()) {
renderRow(table, r, 0, new ArrayList<Boolean>(), imagePath, border);
}
if (model.getDocoRef() != null) {
tr = table.addTag("tr");
tc = tr.addTag("td");
tc.setAttribute("class", "hierarchy");
tc.setAttribute("colspan", Integer.toString(model.getTitles().size()));
tc.addTag("br");
XhtmlNode a = tc.addTag("a").setAttribute("title", "Legend for this format").setAttribute("href", model.getDocoRef());
if (model.getDocoImg() != null)
a.addTag("img").setAttribute("alt", "doco").setAttribute("style", "background-color: inherit").setAttribute("src", model.getDocoImg());
a.addText(" Documentation for this format");
}
return table;
}
private void renderRow(XhtmlNode table, Row r, int indent, List<Boolean> indents, String imagePath, int border) throws IOException {
XhtmlNode tr = table.addTag("tr");
String color = "white";
if (r.getColor() != null)
color = r.getColor();
tr.setAttribute("style", "border: " + border + "px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: "+color+";");
boolean first = true;
for (Cell t : r.getCells()) {
renderCell(tr, t, "td", first ? r.getIcon() : null, first ? r.getHint() : null, first ? indents : null, !r.getSubRows().isEmpty(), first ? r.getAnchor() : null, color, imagePath, border);
first = false;
}
table.addText("\r\n");
for (int i = 0; i < r.getSubRows().size(); i++) {
Row c = r.getSubRows().get(i);
List<Boolean> ind = new ArrayList<Boolean>();
ind.addAll(indents);
if (i == r.getSubRows().size() - 1)
ind.add(true);
else
ind.add(false);
renderRow(table, c, indent+1, ind, imagePath, border);
}
}
private XhtmlNode renderCell(XhtmlNode tr, Cell c, String name, String icon, String hint, List<Boolean> indents, boolean hasChildren, String anchor, String color, String imagePath, int border) throws IOException {
XhtmlNode tc = tr.addTag(name);
tc.setAttribute("class", "hierarchy");
if (indents != null) {
tc.addTag("img").setAttribute("src", srcFor(imagePath, "tbl_spacer.png")).setAttribute("style", "background-color: inherit").setAttribute("class", "hierarchy").setAttribute("alt", ".");
tc.setAttribute("style", "vertical-align: top; text-align : left; background-color: "+color+"; border: "+ border +"px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url("+imagePath+checkExists(indents, hasChildren)+")");
for (int i = 0; i < indents.size()-1; i++) {
if (indents.get(i))
tc.addTag("img").setAttribute("src", srcFor(imagePath, "tbl_blank.png")).setAttribute("style", "background-color: inherit").setAttribute("class", "hierarchy").setAttribute("alt", ".");
else
tc.addTag("img").setAttribute("src", srcFor(imagePath, "tbl_vline.png")).setAttribute("style", "background-color: inherit").setAttribute("class", "hierarchy").setAttribute("alt", ".");
}
if (!indents.isEmpty())
if (indents.get(indents.size()-1))
tc.addTag("img").setAttribute("src", srcFor(imagePath, "tbl_vjoin_end.png")).setAttribute("style", "background-color: inherit").setAttribute("class", "hierarchy").setAttribute("alt", ".");
else
tc.addTag("img").setAttribute("src", srcFor(imagePath, "tbl_vjoin.png")).setAttribute("style", "background-color: inherit").setAttribute("class", "hierarchy").setAttribute("alt", ".");
}
else
tc.setAttribute("style", "vertical-align: top; text-align : left; background-color: "+color+"; border: "+ border +"px #F0F0F0 solid; padding:0px 4px 0px 4px");
if (!Utilities.noString(icon)) {
XhtmlNode img = tc.addTag("img").setAttribute("src", srcFor(imagePath, icon)).setAttribute("class", "hierarchy").setAttribute("style", "background-color: "+color+"; background-color: inherit").setAttribute("alt", ".");
if (hint != null)
img.setAttribute("title", hint);
tc.addText(" ");
}
for (Piece p : c.pieces) {
if (!Utilities.noString(p.getTag())) {
XhtmlNode tag = tc.addTag(p.getTag());
if (p.attributes != null)
for (String n : p.attributes.keySet())
tag.setAttribute(n, p.attributes.get(n));
if (p.getHint() != null)
tag.setAttribute("title", p.getHint());
addStyle(tag, p);
} else if (!Utilities.noString(p.getReference())) {
XhtmlNode a = addStyle(tc.addTag("a"), p);
a.setAttribute("href", p.getReference());
if (!Utilities.noString(p.getHint()))
a.setAttribute("title", p.getHint());
a.addText(p.getText());
addStyle(a, p);
} else {
if (!Utilities.noString(p.getHint())) {
XhtmlNode s = addStyle(tc.addTag("span"), p);
s.setAttribute("title", p.getHint());
s.addText(p.getText());
} else if (p.getStyle() != null) {
XhtmlNode s = addStyle(tc.addTag("span"), p);
s.addText(p.getText());
} else
tc.addText(p.getText());
}
}
if (!Utilities.noString(anchor))
tc.addTag("a").setAttribute("name", nmTokenize(anchor)).addText(" ");
return tc;
}
private XhtmlNode addStyle(XhtmlNode node, Piece p) {
if (p.getStyle() != null)
node.setAttribute("style", p.getStyle());
return node;
}
private String nmTokenize(String anchor) {
return anchor.replace("[", "_").replace("]", "_");
}
private String srcFor(String corePrefix, String filename) throws IOException {
if (inLineGraphics) {
if (files.containsKey(filename))
return files.get(filename);
StringBuilder b = new StringBuilder();
b.append("data: image/png;base64,");
byte[] bytes;
File file = new File(Utilities.path(dest, filename));
if (!file.exists()) // because sometime this is called real early before the files exist. it will be built again later because of this
bytes = new byte[0];
else
bytes = FileUtils.readFileToByteArray(file);
b.append(new String(Base64.encodeBase64(bytes)));
// files.put(filename, b.toString());
return b.toString();
}
return corePrefix+filename;
}
private void checkModel(TableModel model) throws FHIRException {
check(!model.getRows().isEmpty(), "Must have rows");
check(!model.getTitles().isEmpty(), "Must have titles");
for (Cell c : model.getTitles())
check(c);
int i = 0;
for (Row r : model.getRows()) {
check(r, "rows", model.getTitles().size(), Integer.toString(i));
i++;
}
}
private void check(Cell c) throws FHIRException {
boolean hasText = false;
for (Piece p : c.pieces)
if (!Utilities.noString(p.getText()))
hasText = true;
check(hasText, "Title cells must have text");
}
private void check(Row r, String string, int size, String path) throws FHIRException {
check(r.getCells().size() == size, "All rows must have the same number of columns ("+Integer.toString(size)+") as the titles but row "+path+" doesn't ("+r.getCells().get(0).text()+"): "+r.getCells());
int i = 0;
for (Row c : r.getSubRows()) {
check(c, "rows", size, path+"."+Integer.toString(i));
i++;
}
}
private String checkExists(List<Boolean> indents, boolean hasChildren) throws IOException {
String filename = makeName(indents);
StringBuilder b = new StringBuilder();
if (inLineGraphics) {
if (files.containsKey(filename))
return files.get(filename);
ByteArrayOutputStream bytes = new ByteArrayOutputStream();
genImage(indents, hasChildren, bytes);
b.append("data: image/png;base64,");
byte[] encodeBase64 = Base64.encodeBase64(bytes.toByteArray());
b.append(new String(encodeBase64));
files.put(filename, b.toString());
return b.toString();
}
b.append("tbl_bck");
for (Boolean i : indents)
b.append(i ? "0" : "1");
if (hasChildren)
b.append("1");
else
b.append("0");
b.append(".png");
String file = Utilities.path(dest, b.toString());
if (!new File(file).exists()) {
//FIXME resource leak
FileOutputStream stream = new FileOutputStream(file);
genImage(indents, hasChildren, stream);
}
return b.toString();
}
private void genImage(List<Boolean> indents, boolean hasChildren, OutputStream stream) throws IOException {
BufferedImage bi = new BufferedImage(800, 2, BufferedImage.TYPE_INT_ARGB);
// i have no idea why this works to make these pixels transparent. It defies logic.
// But this combination of INT_ARGB and filling with grey magically worked when nothing else did. So it stays as is.
Color grey = new Color(99,99,99,0);
for (int i = 0; i < 800; i++) {
bi.setRGB(i, 0, grey.getRGB());
bi.setRGB(i, 1, grey.getRGB());
}
Color black = new Color(0, 0, 0);
for (int i = 0; i < indents.size(); i++) {
if (!indents.get(i))
bi.setRGB(12+(i*16), 0, black.getRGB());
}
if (hasChildren)
bi.setRGB(12+(indents.size()*16), 0, black.getRGB());
ImageIO.write(bi, "PNG", stream);
}
private String makeName(List<Boolean> indents) {
StringBuilder b = new StringBuilder();
b.append("indents:");
for (Boolean i : indents)
b.append(i ? "1" : "0");
return b.toString();
}
private void check(boolean check, String message) throws FHIRException {
if (!check)
throw new FHIRException(message);
}
}