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
|
/* ====================================================================
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.openxml4j.opc.compliance;
import static org.apache.poi.openxml4j.opc.PackagingURIHelper.createPartName;
import static org.apache.poi.openxml4j.opc.PackagingURIHelper.isValidPartName;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.net.URI;
import java.net.URISyntaxException;
import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
import org.apache.poi.openxml4j.opc.PackagePartName;
import org.junit.jupiter.api.Test;
/**
* Test part name Open Packaging Convention compliance.
*
* (Open Packaging Convention 8.1.1 Part names) :
*
* The part name grammar is defined as follows:
*
* part_name = 1*( "/" segment )
*
* segment = 1*( pchar )
*
* pchar is defined in RFC 3986.
*
* The part name grammar implies the following constraints. The package
* implementer shall neither create any part that violates these constraints nor
* retrieve any data from a package as a part if the purported part name
* violates these constraints.
*
* A part name shall not be empty. [M1.1]
*
* A part name shall not have empty segments. [M1.3]
*
* A part name shall start with a forward slash ("/") character. [M1.4]
*
* A part name shall not have a forward slash as the last character. [M1.5]
*
* A segment shall not hold any characters other than pchar characters. [M1.6]
*
* Part segments have the following additional constraints. The package
* implementer shall neither create any part with a part name comprised of a
* segment that violates these constraints nor retrieve any data from a package
* as a part if the purported part name contains a segment that violates these
* constraints.
*
* A segment shall not contain percent-encoded forward slash ("/"), or backward
* slash ("\") characters. [M1.7]
*
* A segment shall not contain percent-encoded unreserved characters. [M1.8]
*
* A segment shall not end with a dot (".") character. [M1.9]
*
* A segment shall include at least one non-dot character. [M1.10]
*
* A package implementer shall neither create nor recognize a part with a part
* name derived from another part name by appending segments to it. [M1.11]
*
* Part name equivalence is determined by comparing part names as
* case-insensitive ASCII strings. [M1.12]
*/
public final class TestOPCCompliancePartName {
/**
* Test some common invalid names.
*
* A segment shall not contain percent-encoded unreserved characters. [M1.8]
*/
@Test
void testInvalidPartNames() {
String[] invalidNames = { "/", "/xml./doc.xml", "[Content_Types].xml", "//xml/." };
for (String s : invalidNames) {
URI uri = null;
try {
uri = new URI(s);
} catch (URISyntaxException e) {
assertEquals("[Content_Types].xml", s);
continue;
}
assertFalse(isValidPartName(uri), "This part name SHOULD NOT be valid: " + s);
}
}
/**
* Test some common valid names.
*/
@Test
void testValidPartNames() throws URISyntaxException {
String[] validNames = { "/xml/item1.xml", "/document.xml", "/a/%D1%86.xml" };
for (String s : validNames) {
assertTrue(isValidPartName(new URI(s)), "This part name SHOULD be valid: " + s);
}
}
/**
* A part name shall not be empty. [M1.1]
*/
@Test
void testEmptyPartNameFailure() {
assertThrows(InvalidFormatException.class, () -> createPartName(new URI("")),
"A part name shall not be empty. [M1.1]");
}
/**
* A part name shall not have empty segments. [M1.3]
*
* A segment shall not end with a dot ('.') character. [M1.9]
*
* A segment shall include at least one non-dot character. [M1.10]
*/
@Test
void testPartNameWithInvalidSegmentsFailure() throws URISyntaxException {
String[] invalidNames = { "//document.xml", "//word/document.xml",
"/word//document.rels", "/word//rels//document.rels",
"/xml./doc.xml", "/document.", "/./document.xml",
"/word/./doc.rels", "/%2F/document.xml" };
for (String s : invalidNames) {
assertFalse(isValidPartName(new URI(s)), "A part name shall not have empty segments. [M1.3]");
}
}
/**
* A segment shall not hold any characters other than ipchar (RFC 3987) characters.
* [M1.6].
*/
@Test
void testPartNameWithNonPCharCharacters() throws URISyntaxException {
String[] validNames = { "/doc&.xml" };
for (String s : validNames) {
assertTrue(isValidPartName(new URI(s)),
"A segment shall not contain non pchar characters [M1.6] : " + s);
}
}
/**
* A segment shall not contain percent-encoded unreserved characters [M1.8].
*/
@Test
void testPartNameWithUnreservedEncodedCharactersFailure() throws URISyntaxException {
String[] invalidNames = { "/a/docum%65nt.xml" };
for (String s : invalidNames) {
assertFalse(isValidPartName(new URI(s)), "A segment shall not contain percent-encoded unreserved characters [M1.8] : " + s);
}
}
/**
* A part name shall start with a forward slash ('/') character. [M1.4]
*/
@Test
void testPartNameStartsWithAForwardSlashFailure() {
assertThrows(InvalidFormatException.class, () -> createPartName(new URI("document.xml")),
"A part name shall start with a forward slash ('/') character. [M1.4]");
}
/**
* A part name shall not have a forward slash as the last character. [M1.5]
*/
@Test
void testPartNameEndsWithAForwardSlashFailure() {
assertThrows(InvalidFormatException.class, () -> createPartName(new URI("/document.xml/")),
"A part name shall not have a forward slash as the last character. [M1.5]");
}
/**
* Part name equivalence is determined by comparing part names as
* case-insensitive ASCII strings. [M1.12]
*/
@Test
void testPartNameComparaison() throws Exception {
String[] partName1 = { "/word/document.xml", "/docProps/core.xml", "/rels/.rels" };
String[] partName2 = { "/WORD/DocUment.XML", "/docProps/core.xml", "/rels/.rels" };
for (int i = 0; i < partName1.length || i < partName2.length; ++i) {
PackagePartName p1 = createPartName(partName1[i]);
PackagePartName p2 = createPartName(partName2[i]);
assertEquals(p1, p2);
assertEquals(0, p1.compareTo(p2));
assertEquals(p1.hashCode(), p2.hashCode());
}
}
/**
* Part name equivalence is determined by comparing part names as
* case-insensitive ASCII strings. [M1.12].
*
* All the comparisons MUST FAIL !
*/
@Test
void testPartNameComparaisonFailure() throws Exception {
String[] partName1 = { "/word/document.xml", "/docProps/core.xml", "/rels/.rels" };
String[] partName2 = { "/WORD/DocUment.XML2", "/docProp/core.xml", "/rels/rels" };
for (int i = 0; i < partName1.length || i < partName2.length; ++i) {
PackagePartName p1 = createPartName(partName1[i]);
PackagePartName p2 = createPartName(partName2[i]);
assertNotEquals(p1, p2);
assertNotEquals(0, p1.compareTo(p2));
assertNotEquals(p1.hashCode(), p2.hashCode());
}
}
}
|
