-
Notifications
You must be signed in to change notification settings - Fork 0
/
DocBookUtilities.java
720 lines (586 loc) · 22 KB
/
DocBookUtilities.java
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
package com.redhat.ecs.commonutils;
import java.io.ByteArrayInputStream;
import java.util.ArrayList;
import java.util.List;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.w3c.dom.Text;
import org.xml.sax.SAXException;
/**
* A collection of static variables and functions that can be used when working
* with DocBook
*/
public class DocBookUtilities
{
/** The name of the section tag */
public static final String TOPIC_ROOT_NODE_NAME = "section";
/** The name of the id attribute */
public static final String TOPIC_ROOT_ID_ATTRIBUTE = "id";
/** The name of the title tag */
public static final String TOPIC_ROOT_TITLE_NODE_NAME = "title";
/**
* Finds the first title element in a DocBook XML file.
*
* @param xml The docbook xml file to find the title from.
* @return The first title found in the xml.
*/
public static String findTitle(final String xml)
{
/* Convert the string to a document to make it easier to get the proper title */
Document doc = null;
try {
doc = XMLUtilities.convertStringToDocument(xml);
} catch (SAXException ex) {
ExceptionUtilities.handleException(ex);
}
return findTitle(doc);
}
/**
* Finds the first title element in a DocBook XML file.
*
* @param doc The docbook xml transformed into a DOM Document to find the title from.
* @return The first title found in the xml.
*/
public static String findTitle(final Document doc)
{
if (doc == null) return null;
/* loop through the child nodes until the title element is found */
final NodeList childNodes = doc.getDocumentElement().getChildNodes();
for (int i = 0; i < childNodes.getLength(); i++)
{
Node node = childNodes.item(i);
/* check if the node is the title and if its parent is the document root element */
if (node.getNodeName().equals(TOPIC_ROOT_TITLE_NODE_NAME) && node.getParentNode().equals(doc.getDocumentElement()))
{
return ((Element) node).getTextContent();
}
}
return null;
}
/**
* Escapes a title so that it is alphanumeric or has a fullstop, underscore or hyphen only.
* It also removes anything from the front of the title that isn't alphanumeric.
*
* @param title The title to be escaped
* @return The escaped title string.
*/
public static String escapeTitle(final String title)
{
return title.replaceAll(" ", "_").replaceAll("^[^A-Za-z0-9]*", "").replaceAll("[^A-Za-z0-9\\._-]", "");
}
public static void setSectionTitle(final String titleValue, final Document doc)
{
assert doc != null : "The doc parameter can not be null";
final Element newTitle = doc.createElement(DocBookUtilities.TOPIC_ROOT_TITLE_NODE_NAME);
newTitle.appendChild(doc.createTextNode(titleValue));
final Element docElement = doc.getDocumentElement();
if (docElement != null && docElement.getNodeName().equals(DocBookUtilities.TOPIC_ROOT_NODE_NAME))
{
/* remove any id attributes from the section */
docElement.removeAttribute("id");
final NodeList titleNodes = docElement.getElementsByTagName(DocBookUtilities.TOPIC_ROOT_TITLE_NODE_NAME);
/* see if we have a title node whose parent is the section */
if (titleNodes.getLength() != 0 && titleNodes.item(0).getParentNode().equals(docElement))
{
final Node title = titleNodes.item(0);
title.getParentNode().replaceChild(newTitle, title);
}
else
{
final Node firstNode = docElement.getFirstChild();
if (firstNode != null)
docElement.insertBefore(newTitle, firstNode);
else
docElement.appendChild(newTitle);
}
}
}
public static String buildChapter(final String contents, final String title)
{
return buildChapter(contents, title, null);
}
public static String buildChapter(final String contents, final String title, final String id)
{
final String titleContents = title==null||title.length()==0?"":title;
final String chapterContents = contents==null||contents.length()==0?"":contents;
final String idAttribute = id==null||id.length()==0?"":" id=\"" + id + "\"";
return "<chapter" + idAttribute + "><title>" + titleContents + "</title>" + chapterContents + "</chapter>";
}
public static String buildAppendix(final String contents, final String title)
{
return buildAppendix(contents, title, null);
}
public static String buildAppendix(final String contents, final String title, final String id)
{
final String titleContents = title==null||title.length()==0?"":title;
final String chapterContents = contents==null||contents.length()==0?"":contents;
final String idAttribute = id==null||id.length()==0?"":" id=\"" + id + "\"";
return "<appendix" + idAttribute + "><title>" + titleContents + "</title>" + chapterContents + "</appendix>";
}
public static String buildCleanSection(final String contents, final String title)
{
return buildCleanSection(contents, title, null);
}
public static String buildCleanSection(final String contents, final String title, final String id)
{
final String titleContents = title==null||title.length()==0?"":title;
final String chapterContents = contents==null||contents.length()==0?"":contents;
final String idAttribute = id==null||id.length()==0?"":" id=\"" + id + "\"";
return "<section" + idAttribute + "><title>" + titleContents + "</title>" + chapterContents + "</section>";
}
public static String addXMLBoilerplate(final String xml)
{
return "<?xml version='1.0' encoding='UTF-8' ?>\n" +
"<!DOCTYPE chapter PUBLIC \"-//OASIS//DTD DocBook XML V4.5//EN\" \"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd\" [\n" +
"<!ENTITY % BOOK_ENTITIES SYSTEM \"Book.ent\">\n" +
"%BOOK_ENTITIES;\n" +
"]>\n\n" +
xml;
}
public static String buildXRefListItem(final String xref, final String role)
{
final String roleAttribute = role==null||role.length()==0?"":" role=\"" + role + "\"";
return "<listitem><para><xref" + roleAttribute + " linkend=\"" + xref + "\"/></para></listitem>";
}
public static List<Element> buildXRef(final Document xmlDoc, final String xref)
{
return buildXRef(xmlDoc, xref, null);
}
public static List<Element> buildXRef(final Document xmlDoc, final String xref, final String xrefStyle)
{
final List<Element> retValue = new ArrayList<Element>();
final Element xrefItem = xmlDoc.createElement("xref");
xrefItem.setAttribute("linkend", xref);
if (xrefStyle != null && !xrefStyle.isEmpty())
{
xrefItem.setAttribute("xrefstyle", xrefStyle);
}
retValue.add(xrefItem);
return retValue;
}
public static String buildXRef(final String xref)
{
return "<xref linkend=\"" + xref + "\" />";
}
public static String buildXRef(final String xref, final String xrefStyle)
{
return "<xref linkend=\"" + xref + "\" xrefstyle=\"" + xrefStyle + "\" />";
}
public static List<Element> buildULink(final Document xmlDoc, final String url, final String label)
{
final List<Element> retValue = new ArrayList<Element>();
final Element ulinkItem = xmlDoc.createElement("ulink");
ulinkItem.setAttribute("url", url);
final Text labelElement = xmlDoc.createTextNode(label);
ulinkItem.appendChild(labelElement);
retValue.add(ulinkItem);
return retValue;
}
public static String buildULink(final String url, final String label)
{
return "<ulink url=\"" + url + "\">" + label + "</ulink>";
}
public static String buildULinkListItem(final String url, final String label)
{
return "<listitem><para><ulink url=\"" + url + "\">" + label + "</ulink></para></listitem>";
}
public static List<Element> buildEmphasisPrefixedXRef(final Document xmlDoc, final String prefix, final String xref)
{
final List<Element> retValue = new ArrayList<Element>();
final Element emphasis = xmlDoc.createElement("emphasis");
emphasis.setTextContent(prefix);
retValue.add(emphasis);
final Element xrefItem = xmlDoc.createElement("xref");
xrefItem.setAttribute("linkend", xref);
retValue.add(xrefItem);
return retValue;
}
public static List<Element> buildEmphasisPrefixedULink(final Document xmlDoc, final String prefix, final String url, final String label)
{
final List<Element> retValue = new ArrayList<Element>();
final Element emphasis = xmlDoc.createElement("emphasis");
emphasis.setTextContent(prefix);
retValue.add(emphasis);
final Element xrefItem = xmlDoc.createElement("ulink");
xrefItem.setAttribute("url", url);
retValue.add(xrefItem);
final Text labelElement = xmlDoc.createTextNode(label);
xrefItem.appendChild(labelElement);
return retValue;
}
public static Node buildDOMXRefLinkListItem(final String xref, final String title, final Document xmlDoc)
{
final Element listItem = xmlDoc.createElement("listitem");
final Element paraItem = xmlDoc.createElement("para");
listItem.appendChild(paraItem);
final Element linkItem = xmlDoc.createElement("link");
linkItem.setAttribute("linkend", xref);
linkItem.setTextContent(title);
paraItem.appendChild(linkItem);
return listItem;
}
public static Node buildDOMLinkListItem(final List<Node> children, final Document xmlDoc)
{
final Element listItem = xmlDoc.createElement("listitem");
final Element paraItem = xmlDoc.createElement("para");
listItem.appendChild(paraItem);
for (final Node node : children)
paraItem.appendChild(node);
return listItem;
}
public static Node buildDOMXRef(final String xref, final String title, final Document xmlDoc)
{
final Element linkItem = xmlDoc.createElement("link");
linkItem.setAttribute("linkend", xref);
linkItem.setTextContent(title);
return linkItem;
}
public static Node buildDOMText(final String title, final Document xmlDoc)
{
final Node textNode = xmlDoc.createTextNode(title);
return textNode;
}
public static String buildListItem(final String text)
{
return "<listitem><para>" + text + "</para></listitem>\n";
}
public static Element buildDOMListItem(final Document doc, final String text)
{
final Element listItem = doc.createElement("listitem");
final Element para = doc.createElement("para");
para.setTextContent(text);
listItem.appendChild(para);
return listItem;
}
public static String buildSection(final String contents, final String title, final String build)
{
return buildSection(contents, title, build, null, null, null);
}
public static String buildSection(final String contents, final String title, final String build, final String id)
{
return buildSection(contents, title, build, id, null, null);
}
public static String buildSection(final String contents, final String title, final String build, final String id, final String titleRole)
{
return buildSection(contents, title, build, id, titleRole, null);
}
public static String buildSection(final String contents, final String title, final String build, final String id, final String titleRole, final String xreflabel)
{
final String idAttribute = id==null||id.length()==0?"":" id=\"" + id + "\"";
final String xreflabelAttribute = xreflabel==null||xreflabel.length()==0?"":" xreflabel=\"" + xreflabel + "\"";
final String titleRoleAttribute = titleRole==null||titleRole.length()==0?"":" role=\"" + titleRole + "\"";
return "<section" + idAttribute + xreflabelAttribute + ">\n" +
"<title" + titleRoleAttribute + ">" + title + "</title>\n" +
contents + "\n" +
" <simplesect>\n" +
" <title></title>\n" +
" <para>\n" +
" <remark>Built with Skynet version " + build + "</remark>\n" +
" </para>\n" +
" </simplesect>" +
"</section>\n";
}
public static String wrapInListItem(final String content)
{
return "<listitem>" + content + "</listitem>";
}
public static String wrapListItems(final List<String> listItems)
{
return wrapListItems(listItems, null, null);
}
public static String wrapListItems(final List<String> listItems, final String title)
{
return wrapListItems(listItems, title, null);
}
public static String wrapListItems(final List<String> listItems, final String title, final String id)
{
final String idAttribute = id != null && id.length() != 0 ? " id=\"" + id + "\" " : "";
final String titleElement = title == null || title.length() == 0 ? "" : "<title>" + title + "</title>";
String retValue = "<itemizedlist" + idAttribute + ">" + titleElement;
for (final String listItem : listItems)
retValue += listItem;
retValue += "</itemizedlist>";
return retValue;
}
public static String wrapListItemsInPara(final String listItems)
{
if (listItems.length() != 0)
{
return
"<para>" +
"<itemizedlist>\n" + listItems + "</itemizedlist>" +
"</para>";
}
return "";
}
public static String wrapInPara(final String contents)
{
return wrapInPara(contents, null, null);
}
public static String wrapInPara(final String contents, final String role)
{
return wrapInPara(contents, role, null);
}
public static String wrapInPara(final String contents, final String role, final String id)
{
final String idAttribute = id==null||id.length()==0?"":" id=\"" + id + "\"";
final String roleAttribute = role==null||role.length()==0?"":" role=\"" + role + "\"";
return
"<para" + idAttribute + roleAttribute + ">" +
contents +
"</para>";
}
public static List<Element> wrapItemizedListItemsInPara(final Document xmlDoc, final List<List<Element>> items)
{
final List<Element> retValue = new ArrayList<Element>();
final Element para = xmlDoc.createElement("para");
final Element itemizedlist = xmlDoc.createElement("itemizedlist");
para.appendChild(itemizedlist);
for (final List<Element> itemSequence : items)
{
final Element listitem = xmlDoc.createElement("listitem");
itemizedlist.appendChild(listitem);
final Element listItemPara = xmlDoc.createElement("para");
listitem.appendChild(listItemPara);
for (final Element item : itemSequence)
{
listItemPara.appendChild(item);
}
}
retValue.add(para);
return retValue;
}
public static List<Element> wrapOrderedListItemsInPara(final Document xmlDoc, final List<List<Element>> items)
{
final List<Element> retValue = new ArrayList<Element>();
final Element para = xmlDoc.createElement("para");
final Element orderedlist = xmlDoc.createElement("orderedlist");
para.appendChild(orderedlist);
for (final List<Element> itemSequence : items)
{
final Element listitem = xmlDoc.createElement("listitem");
orderedlist.appendChild(listitem);
final Element listItemPara = xmlDoc.createElement("para");
listitem.appendChild(listItemPara);
for (final Element item : itemSequence)
{
listItemPara.appendChild(item);
}
}
retValue.add(para);
return retValue;
}
public static List<Element> wrapItemsInListItems(final Document xmlDoc, final List<List<Element>> items)
{
final List<Element> retValue = new ArrayList<Element>();
for (final List<Element> itemSequence : items)
{
final Element listitem = xmlDoc.createElement("listitem");
final Element listItemPara = xmlDoc.createElement("para");
listitem.appendChild(listItemPara);
for (final Element item : itemSequence)
{
listItemPara.appendChild(item);
}
retValue.add(listitem);
}
return retValue;
}
public static String wrapInSimpleSect(final String contents)
{
return wrapInSimpleSect(contents, null, null);
}
public static String wrapInSimpleSect(final String contents, final String role)
{
return wrapInSimpleSect(contents, null, null);
}
public static String wrapInSimpleSect(final String contents, final String role, final String id)
{
final String roleAttribute = role==null||role.length()==0?"":" role=\"" + role + "\"";
final String idAttribute = id==null||id.length()==0?"":" id=\"" + id + "\"";
return
"<simplesect" + idAttribute + roleAttribute + ">\n"+
"\t<title></title>\n" +
contents + "\n" +
"</simplesect>";
}
public static Element wrapListItems(final Document xmlDoc, final List<Node> listItems)
{
return wrapListItems(xmlDoc, listItems, null);
}
public static Element wrapListItems(final Document xmlDoc, final List<Node> listItems, final String title)
{
final Element paraElement = xmlDoc.createElement("para");
final Element itemizedlistElement = xmlDoc.createElement("itemizedlist");
paraElement.appendChild(itemizedlistElement);
if (title != null)
{
final Element titleElement = xmlDoc.createElement("title");
itemizedlistElement.appendChild(titleElement);
titleElement.setTextContent(title);
}
for (final Node listItem : listItems)
itemizedlistElement.appendChild(listItem);
return paraElement;
}
public static void insertNodeAfter(final Node reference, final Node insert)
{
final Node parent = reference.getParentNode();
final Node nextSibling = reference.getNextSibling();
if (parent == null)
return;
if (nextSibling != null)
parent.insertBefore(insert, nextSibling);
else
parent.appendChild(insert);
}
public static Node createRelatedTopicXRef(final Document xmlDoc, final String xref, final Node parent)
{
final Element listItem = xmlDoc.createElement("listitem");
if (parent != null)
parent.appendChild(listItem);
final Element paraItem = xmlDoc.createElement("para");
listItem.appendChild(paraItem);
final Element xrefItem = xmlDoc.createElement("xref");
xrefItem.setAttribute("linkend", xref);
paraItem.appendChild(xrefItem);
return listItem;
}
public static Node createRelatedTopicXRef(final Document xmlDoc, final String xref)
{
return createRelatedTopicXRef(xmlDoc, xref, null);
}
public static Node createRelatedTopicULink(final Document xmlDoc, final String url, final String title, final Node parent)
{
final Element listItem = xmlDoc.createElement("listitem");
if (parent != null)
parent.appendChild(listItem);
final Element paraItem = xmlDoc.createElement("para");
listItem.appendChild(paraItem);
final Element xrefItem = xmlDoc.createElement("ulink");
xrefItem.setAttribute("url", url);
paraItem.appendChild(xrefItem);
/*
* Attempt to parse the title as XML. If this fails
* then just set the title as plain text.
*/
try
{
final DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
final DocumentBuilder docBuilder = factory.newDocumentBuilder();
final Document doc = docBuilder.parse(new ByteArrayInputStream(("<title>" + title + "</title>").getBytes("UTF-8")));
final Node titleEle = xmlDoc.importNode(doc.getDocumentElement(), true);
/* Add the child elements to the ulink node */
final NodeList nodes = titleEle.getChildNodes();
while (nodes.getLength() > 0)
{
xrefItem.appendChild(nodes.item(0));
}
}
catch (Exception e)
{
final Text labelElement = xmlDoc.createTextNode(title);
xrefItem.appendChild(labelElement);
}
return listItem;
}
public static Node createRelatedTopicULink(final Document xmlDoc, final String url, final String title)
{
return createRelatedTopicULink(xmlDoc, url, title, null);
}
public static Node createRelatedTopicItemizedList(final Document xmlDoc, final String title)
{
final Node itemizedlist = xmlDoc.createElement("itemizedlist");
final Node itemizedlistTitle = xmlDoc.createElement("title");
itemizedlistTitle.setTextContent(title);
itemizedlist.appendChild(itemizedlistTitle);
return itemizedlist;
}
public static Document wrapDocumentInSection(final Document doc)
{
if (!doc.getDocumentElement().getNodeName().equals("section"))
{
DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();
DocumentBuilder dBuilder;
Document newDoc = null;
try
{
dBuilder = dbFactory.newDocumentBuilder();
newDoc = dBuilder.newDocument();
}
catch(ParserConfigurationException ex)
{
ExceptionUtilities.handleException(ex);
}
Element section = newDoc.createElement("section");
section.appendChild(newDoc.importNode(doc.getDocumentElement(), true));
newDoc.appendChild(section);
return newDoc;
}
else
{
return doc;
}
}
/**
* Wrap a list of Strings in a {@code<row>} element. Each string
* is also wrapped in a {@code<entry>} element.
*
* @param items The list of items to be set in the table row.
* @return The strings wrapped in row and entry elements.
*/
public static String wrapInTableRow(final List<String> items)
{
final StringBuilder output = new StringBuilder("<row>");
for (final String entry : items)
{
output.append("<entry>" + entry + "</entry>");
}
output.append("</row>");
return output.toString();
}
public static String wrapInTable(final String title, final List<List<String>> rows)
{
return wrapInTable(title, null, null, rows);
}
public static String wrapInTable(final String title, final List<String> headers, final List<List<String>> rows)
{
return wrapInTable(title, headers, null, rows);
}
public static String wrapInTable(final String title, final List<String> headers, final List<String> footers, final List<List<String>> rows)
{
final StringBuilder output = new StringBuilder("<table>\n");
output.append("\t<title>" + title + "</title>\n");
final int numColumns = headers == null ? (rows == null || rows.size() == 0 ? 0 : rows.get(0).size()) : Math.max(headers.size(), (rows == null || rows.size() == 0 ? 0 : rows.get(0).size()));
output.append("\t<tgroup cols=\"" + numColumns + "\">\n");
// Add the headers
if (headers != null && !headers.isEmpty())
{
output.append("\t\t<thead>\n");
output.append("\t\t\t" + wrapInTableRow(headers));
output.append("\t\t</thead>\n");
}
// Add the footer
if (footers != null && !footers.isEmpty())
{
output.append("\t\t<tfoot>\n");
output.append("\t\t\t" + wrapInTableRow(footers));
output.append("\t\t</tfoot>\n");
}
// Create the table body
output.append("\t\t<tbody>\n");
for (final List<String> row : rows)
{
output.append("\t\t\t" + wrapInTableRow(row));
}
output.append("\t\t</tbody>\n");
output.append("\t</tgroup>\n");
output.append("</table>\n");
return output.toString();
}
}