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
|
/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==================================================================== */
package org.apache.poi.xwpf.usermodel;
import static org.apache.poi.POITestCase.assertContains;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import org.apache.poi.xwpf.XWPFTestDataSamples;
import org.junit.jupiter.api.Test;
public final class TestXWPFSDT {
/**
* Test text extraction from nested SDTs
*/
@Test
void testNestedSDTs() throws Exception {
try (XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("Bug64561.docx")) {
XWPFAbstractSDT sdt = extractAllSDTs(doc).get(0);
assertEquals("Subject", sdt.getContent().getText(), "extracted text");
}
}
/**
* Test simple tag and title extraction from SDT
*/
@Test
void testTagTitle() throws Exception {
try (XWPFDocument doc =XWPFTestDataSamples.openSampleDocument("Bug54849.docx")) {
String tag = null;
String title = null;
List<XWPFAbstractSDT> sdts = extractAllSDTs(doc);
for (XWPFAbstractSDT sdt : sdts) {
if (sdt.getContent().toString().equals("Rich_text")) {
tag = "MyTag";
title = "MyTitle";
break;
}
}
assertEquals(13, sdts.size(), "controls size");
assertEquals("MyTag", tag, "tag");
assertEquals("MyTitle", title, "title");
}
}
@Test
void testGetSDTs() throws Exception {
String[] contents = new String[]{
"header_rich_text",
"Rich_text",
"Rich_text_pre_table\nRich_text_cell1\t\t\t\n\t\t\t\n\t\t\t\n\nRich_text_post_table",
"Plain_text_no_newlines",
"Plain_text_with_newlines1\nplain_text_with_newlines2",
"Watermelon",
"Dirt",
"4/16/2013",
"Rich_text_in_cell",
"rich_text_in_paragraph_in_cell",
"Footer_rich_text",
"Footnote_sdt",
"Endnote_sdt"
};
try (XWPFDocument doc =XWPFTestDataSamples.openSampleDocument("Bug54849.docx")) {
List<XWPFAbstractSDT> sdts = extractAllSDTs(doc);
assertEquals(contents.length, sdts.size(), "number of sdts");
for (int i = 0; i < contents.length; i++) {
XWPFAbstractSDT sdt = sdts.get(i);
assertEquals(contents[i], sdt.getContent().toString(), i + ": " + contents[i]);
}
}
}
/**
* POI-54771 and TIKA-1317
*/
@Test
void testSDTAsCell() throws Exception {
//Bug54771a.docx and Bug54771b.docx test slightly
//different recursion patterns. Keep both!
try (XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("Bug54771a.docx")) {
List<XWPFAbstractSDT> sdts = extractAllSDTs(doc);
String text = sdts.get(0).getContent().getText();
assertEquals(2, sdts.size());
assertContains(text, "Test");
text = sdts.get(1).getContent().getText();
assertContains(text, "Test Subtitle");
assertContains(text, "Test User");
assertTrue(text.indexOf("Test") < text.indexOf("Test Subtitle"));
}
try (XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("Bug54771b.docx")) {
List<XWPFAbstractSDT> sdts = extractAllSDTs(doc);
assertEquals(3, sdts.size());
assertContains(sdts.get(0).getContent().getText(), "Test");
assertContains(sdts.get(1).getContent().getText(), "Test Subtitle");
assertContains(sdts.get(2).getContent().getText(), "Test User");
}
}
/**
* POI-55142 and Tika 1130
*/
@Test
void testNewLinesBetweenRuns() throws Exception {
try (XWPFDocument doc =XWPFTestDataSamples.openSampleDocument("Bug55142.docx")) {
List<XWPFAbstractSDT> sdts = extractAllSDTs(doc);
List<String> targs = new ArrayList<>();
//these test newlines and tabs in paragraphs/body elements
targs.add("Rich-text1 abcdefghi");
targs.add("Rich-text2 abcd\t\tefgh");
targs.add("Rich-text3 abcd\nefg");
targs.add("Rich-text4 abcdefg");
targs.add("Rich-text5 abcdefg\nhijk");
targs.add("Plain-text1 abcdefg");
targs.add("Plain-text2 abcdefg\nhijk\nlmnop");
//this tests consecutive runs within a cell (not a paragraph)
//this test case was triggered by Tika-1130
targs.add("sdt_incell2 abcdefg");
for (int i = 0; i < sdts.size(); i++) {
XWPFAbstractSDT sdt = sdts.get(i);
assertEquals(targs.get(i), sdt.getContent().getText());
}
}
}
@Test
void test60341() throws IOException {
//handle sdtbody without an sdtpr
try (XWPFDocument doc =XWPFTestDataSamples.openSampleDocument("Bug60341.docx")) {
List<XWPFAbstractSDT> sdts = extractAllSDTs(doc);
assertEquals(1, sdts.size());
assertEquals("", sdts.get(0).getTag());
assertEquals("", sdts.get(0).getTitle());
}
}
@Test
void test62859() throws IOException {
//this doesn't test the exact code path for this issue, but
//it does test for a related issue, and the fix fixes both.
//We should try to add the actual triggering document
//to our test suite.
try (XWPFDocument doc =XWPFTestDataSamples.openSampleDocument("Bug62859.docx")) {
List<XWPFAbstractSDT> sdts = extractAllSDTs(doc);
assertEquals(1, sdts.size());
assertEquals("", sdts.get(0).getTag());
assertEquals("", sdts.get(0).getTitle());
}
}
private List<XWPFAbstractSDT> extractAllSDTs(XWPFDocument doc) {
List<XWPFAbstractSDT> sdts = new ArrayList<>();
List<XWPFHeader> headers = doc.getHeaderList();
for (XWPFHeader header : headers) {
sdts.addAll(extractSDTsFromBodyElements(header.getBodyElements()));
}
sdts.addAll(extractSDTsFromBodyElements(doc.getBodyElements()));
List<XWPFFooter> footers = doc.getFooterList();
for (XWPFFooter footer : footers) {
sdts.addAll(extractSDTsFromBodyElements(footer.getBodyElements()));
}
for (XWPFFootnote footnote : doc.getFootnotes()) {
sdts.addAll(extractSDTsFromBodyElements(footnote.getBodyElements()));
}
for (XWPFEndnote footnote : doc.getEndnotes()) {
sdts.addAll(extractSDTsFromBodyElements(footnote.getBodyElements()));
}
return sdts;
}
private List<XWPFAbstractSDT> extractSDTsFromBodyElements(List<IBodyElement> elements) {
List<XWPFAbstractSDT> sdts = new ArrayList<>();
for (IBodyElement e : elements) {
if (e instanceof XWPFSDT) {
XWPFSDT sdt = (XWPFSDT) e;
sdts.add(sdt);
} else if (e instanceof XWPFParagraph) {
XWPFParagraph p = (XWPFParagraph) e;
for (IRunElement e2 : p.getIRuns()) {
if (e2 instanceof XWPFSDT) {
XWPFSDT sdt = (XWPFSDT) e2;
sdts.add(sdt);
}
}
} else if (e instanceof XWPFTable) {
XWPFTable table = (XWPFTable) e;
sdts.addAll(extractSDTsFromTable(table));
}
}
return sdts;
}
private List<XWPFAbstractSDT> extractSDTsFromTable(XWPFTable table) {
List<XWPFAbstractSDT> sdts = new ArrayList<>();
for (XWPFTableRow r : table.getRows()) {
for (ICell c : r.getTableICells()) {
if (c instanceof XWPFSDTCell) {
sdts.add((XWPFSDTCell) c);
} else if (c instanceof XWPFTableCell) {
sdts.addAll(extractSDTsFromBodyElements(((XWPFTableCell) c).getBodyElements()));
}
}
}
return sdts;
}
}
|
