1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
package org.zwobble.mammoth.internal.conversion;
import org.zwobble.mammoth.internal.documents.*;
import org.zwobble.mammoth.internal.html.Html;
import org.zwobble.mammoth.internal.html.HtmlNode;
import org.zwobble.mammoth.internal.results.InternalResult;
import org.zwobble.mammoth.internal.styles.HtmlPath;
import org.zwobble.mammoth.internal.styles.StyleMap;
import org.zwobble.mammoth.internal.util.Base64Encoding;
import org.zwobble.mammoth.internal.util.Lists;
import java.io.IOException;
import java.util.*;
import static org.zwobble.mammoth.internal.util.Lists.*;
import static org.zwobble.mammoth.internal.util.Maps.map;
public class DocumentToHtml {
public static InternalResult<List<HtmlNode>> convertToHtml(Document document, DocumentToHtmlOptions options) {
DocumentToHtml documentConverter = new DocumentToHtml(options);
return new InternalResult<>(
documentConverter.convertToHtml(document),
documentConverter.warnings);
}
private static List<Note> findNotes(Document document, Iterable<NoteReference> noteReferences) {
return eagerMap(
noteReferences,
// TODO: handle missing notes
reference -> document.getNotes().findNote(reference.getNoteType(), reference.getNoteId()).get());
}
public static InternalResult<List<HtmlNode>> convertToHtml(DocumentElement element, DocumentToHtmlOptions options) {
DocumentToHtml documentConverter = new DocumentToHtml(options);
return new InternalResult<>(
documentConverter.convertToHtml(element),
documentConverter.warnings);
}
private final String idPrefix;
private final boolean preserveEmptyParagraphs;
private final StyleMap styleMap;
private final List<NoteReference> noteReferences = new ArrayList<>();
private final Set<String> warnings = new HashSet<>();
private DocumentToHtml(DocumentToHtmlOptions options) {
this.idPrefix = options.idPrefix();
this.preserveEmptyParagraphs = options.shouldPreserveEmptyParagraphs();
this.styleMap = options.styleMap();
}
private List<HtmlNode> convertToHtml(Document document) {
List<HtmlNode> mainBody = convertChildrenToHtml(document);
// TODO: can you have note references inside a note?
List<Note> notes = findNotes(document, noteReferences);
if (notes.isEmpty()) {
return mainBody;
} else {
HtmlNode noteNode = Html.element("ol",
eagerMap(notes, this::convertToHtml));
return eagerConcat(mainBody, list(noteNode));
}
}
private HtmlNode convertToHtml(Note note) {
String id = generateNoteHtmlId(note.getNoteType(), note.getId());
String referenceId = generateNoteRefHtmlId(note.getNoteType(), note.getId());
List<HtmlNode> noteBody = convertToHtml(note.getBody());
// TODO: we probably want this to collapse more eagerly than other collapsible elements
// -- for instance, any paragraph will probably do, regardless of attributes. (Possible other elements will do too.)
HtmlNode backLink = Html.collapsibleElement("p", list(
Html.text(" "),
Html.element("a", map("href", "#" + referenceId), list(Html.text("↑")))));
return Html.element("li", map("id", id), eagerConcat(noteBody, list(backLink)));
}
private List<HtmlNode> convertToHtml(List<DocumentElement> elements) {
return eagerFlatMap(
elements,
this::convertToHtml);
}
private List<HtmlNode> convertChildrenToHtml(HasChildren element) {
return convertToHtml(element.getChildren());
}
private List<HtmlNode> convertToHtml(DocumentElement element) {
return element.accept(new DocumentElementVisitor<List<HtmlNode>>() {
@Override
public List<HtmlNode> visit(Paragraph paragraph) {
List<HtmlNode> content = convertChildrenToHtml(paragraph);
List<HtmlNode> children = preserveEmptyParagraphs ? cons(Html.FORCE_WRITE, content) : content;
HtmlPath mapping = styleMap.getParagraphHtmlPath(paragraph)
.orElseGet(() -> {
if (paragraph.getStyle().isPresent()) {
warnings.add("Unrecognised paragraph style: " + paragraph.getStyle().get().describe());
}
return HtmlPath.element("p");
});
return mapping.wrap(children);
}
@Override
public List<HtmlNode> visit(Run run) {
List<HtmlNode> nodes = convertChildrenToHtml(run);
if (run.isStrikethrough()) {
nodes = styleMap.getStrikethrough().orElse(HtmlPath.collapsibleElement("s")).wrap(nodes);
}
if (run.isUnderline()) {
nodes = styleMap.getUnderline().orElse(HtmlPath.EMPTY).wrap(nodes);
}
if (run.getVerticalAlignment() == VerticalAlignment.SUBSCRIPT) {
nodes = list(Html.collapsibleElement("sub", nodes));
}
if (run.getVerticalAlignment() == VerticalAlignment.SUPERSCRIPT) {
nodes = list(Html.collapsibleElement("sup", nodes));
}
if (run.isItalic()) {
nodes = styleMap.getItalic().orElse(HtmlPath.collapsibleElement("em")).wrap(nodes);
}
if (run.isBold()) {
nodes = styleMap.getBold().orElse(HtmlPath.collapsibleElement("strong")).wrap(nodes);
}
HtmlPath mapping = styleMap.getRunHtmlPath(run)
.orElseGet(() -> {
if (run.getStyle().isPresent()) {
warnings.add("Unrecognised run style: " + run.getStyle().get().describe());
}
return HtmlPath.EMPTY;
});
return mapping.wrap(nodes);
}
@Override
public List<HtmlNode> visit(Text text) {
if (text.getValue().isEmpty()) {
return list();
} else {
return list(Html.text(text.getValue()));
}
}
@Override
public List<HtmlNode> visit(Tab tab) {
return list(Html.text("\t"));
}
@Override
public List<HtmlNode> visit(LineBreak lineBreak) {
return list(Html.selfClosingElement("br"));
}
@Override
public List<HtmlNode> visit(Table table) {
return list(Html.element("table", convertChildrenToHtml(table)));
}
@Override
public List<HtmlNode> visit(TableRow tableRow) {
return list(Html.element("tr", convertChildrenToHtml(tableRow)));
}
@Override
public List<HtmlNode> visit(TableCell tableCell) {
return list(Html.element("td",
Lists.cons(Html.FORCE_WRITE, convertChildrenToHtml(tableCell))));
}
@Override
public List<HtmlNode> visit(Hyperlink hyperlink) {
Map<String, String> attributes = map("href", generateHref(hyperlink));
return list(Html.collapsibleElement("a", attributes, convertChildrenToHtml(hyperlink)));
}
private String generateHref(Hyperlink hyperlink) {
if (hyperlink.getHref().isPresent()) {
return hyperlink.getHref().get();
} else if (hyperlink.getAnchor().isPresent()) {
return "#" + generateId(hyperlink.getAnchor().get());
} else {
return "";
}
}
@Override
public List<HtmlNode> visit(Bookmark bookmark) {
return list(Html.element("a", map("id", generateId(bookmark.getName())), list(Html.FORCE_WRITE)));
}
@Override
public List<HtmlNode> visit(NoteReference noteReference) {
noteReferences.add(noteReference);
String noteAnchor = generateNoteHtmlId(noteReference.getNoteType(), noteReference.getNoteId());
String noteReferenceAnchor = generateNoteRefHtmlId(noteReference.getNoteType(), noteReference.getNoteId());
return list(Html.element("sup", list(
Html.element("a", map("href", "#" + noteAnchor, "id", noteReferenceAnchor), list(
Html.text("[" + noteReferences.size() + "]"))))));
}
@Override
public List<HtmlNode> visit(Image image) {
// TODO: custom image handlers
// TODO: handle empty content type
return image.getContentType()
.map(contentType -> {
try {
Map<String, String> attributes = new HashMap<>();
String base64 = Base64Encoding.streamToBase64(image::open);
String src = "data:" + contentType + ";base64," + base64;
attributes.put("src", src);
image.getAltText().ifPresent(altText -> attributes.put("alt", altText));
return list(Html.selfClosingElement("img", attributes));
} catch (IOException exception) {
warnings.add(exception.getMessage());
return Lists.<HtmlNode>list();
}
})
.orElse(list());
}
});
}
private String generateNoteHtmlId(NoteType noteType, String noteId) {
return generateId(noteTypeToIdFragment(noteType) + "-" + noteId);
}
private String generateNoteRefHtmlId(NoteType noteType, String noteId) {
return generateId(noteTypeToIdFragment(noteType) + "-ref-" + noteId);
}
private String noteTypeToIdFragment(NoteType noteType) {
switch (noteType) {
case FOOTNOTE:
return "footnote";
case ENDNOTE:
return "endnote";
default:
throw new UnsupportedOperationException();
}
}
private String generateId(String bookmarkName) {
return idPrefix + bookmarkName;
}
}
|
