aboutsummaryrefslogtreecommitdiffstats
path: root/poi-ooxml/src/test/java/org/apache/poi/ooxml/TestXMLPropertiesTextExtractor.java
blob: 7c28d149f7f31198d2ae891b7a36402c312972e3 (plain)
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
/* ====================================================================
   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.ooxml;

import org.apache.poi.POIDataSamples;
import org.apache.poi.ooxml.extractor.POIXMLPropertiesTextExtractor;
import org.apache.poi.ooxml.util.PackageHelper;
import org.apache.poi.openxml4j.opc.OPCPackage;
import org.apache.poi.xslf.usermodel.XSLFSlideShow;
import org.apache.poi.xssf.extractor.XSSFExcelExtractor;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import org.junit.jupiter.api.Test;

import static org.apache.poi.POITestCase.assertContains;
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.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;

public final class TestXMLPropertiesTextExtractor {
    private static final POIDataSamples _ssSamples = POIDataSamples.getSpreadSheetInstance();
    private static final POIDataSamples _slSamples = POIDataSamples.getSlideShowInstance();

    @Test
    void testGetFromMainExtractor() throws Exception {
        OPCPackage pkg = PackageHelper.open(_ssSamples.openResourceAsStream("ExcelWithAttachments.xlsm"));

        XSSFWorkbook wb = new XSSFWorkbook(pkg);

        XSSFExcelExtractor ext = new XSSFExcelExtractor(wb);
        POIXMLPropertiesTextExtractor textExt = ext.getMetadataTextExtractor();

        // Check basics
        assertNotNull(textExt);
        assertTrue(textExt.getText().length() > 0);

        // Check some of the content
        String text = textExt.getText();
        String cText = textExt.getCorePropertiesText();

        assertContains(text, "LastModifiedBy = Yury Batrakov");
        assertContains(cText, "LastModifiedBy = Yury Batrakov");

        textExt.close();
        ext.close();
    }

    @Test
    void testCore() throws Exception {
        OPCPackage pkg = PackageHelper.open(
                _ssSamples.openResourceAsStream("ExcelWithAttachments.xlsm")
        );
        XSSFWorkbook wb = new XSSFWorkbook(pkg);

        POIXMLPropertiesTextExtractor ext = new POIXMLPropertiesTextExtractor(wb);
        ext.getText();

        // Now check
        String text = ext.getText();
        String cText = ext.getCorePropertiesText();

        assertContains(text, "LastModifiedBy = Yury Batrakov");
        assertContains(cText, "LastModifiedBy = Yury Batrakov");

        ext.close();
    }

    @Test
    void testExtended() throws Exception {
        OPCPackage pkg = OPCPackage.open(
                _ssSamples.openResourceAsStream("ExcelWithAttachments.xlsm")
        );
        XSSFWorkbook wb = new XSSFWorkbook(pkg);

        POIXMLPropertiesTextExtractor ext = new POIXMLPropertiesTextExtractor(wb);
        ext.getText();

        // Now check
        String text = ext.getText();
        String eText = ext.getExtendedPropertiesText();

        assertContains(text, "Application = Microsoft Excel");
        assertContains(text, "Company = Mera");
        assertContains(eText, "Application = Microsoft Excel");
        assertContains(eText, "Company = Mera");

        ext.close();
    }

    @Test
    void testCustom() throws Exception {
        OPCPackage pkg = OPCPackage.open(
                _ssSamples.openResourceAsStream("ExcelWithAttachments.xlsm")
        );
        XSSFWorkbook wb = new XSSFWorkbook(pkg);

        POIXMLPropertiesTextExtractor ext = new POIXMLPropertiesTextExtractor(wb);
        ext.getText();

        // Now check
        String text = ext.getText();
        String cText = ext.getCustomPropertiesText();

        assertContains(text, "description = another value");
        assertContains(cText, "description = another value");

        ext.close();
    }

    /**
     * Bug #49386 - some properties, especially
     * dates can be null
     */
    @Test
    void testWithSomeNulls() throws Exception {
        try (
                OPCPackage pkg = OPCPackage.open(
                        _slSamples.openResourceAsStream("49386-null_dates.pptx")
                );
                XSLFSlideShow sl = new XSLFSlideShow(pkg);
                POIXMLPropertiesTextExtractor ext = new POIXMLPropertiesTextExtractor(sl)
        ) {
            String text = ext.getText();
            assertFalse(text.contains("Created =")); // With date is null
            assertContains(text, "CreatedString = "); // Via string is blank
            assertContains(text, "LastModifiedBy = IT Client Services");
        }
    }

    /**
     * Bug #65946 - a bug led to Category being added twice
     */
    @Test
    void testCategoryProperty() throws Exception {
        try (
                OPCPackage pkg = OPCPackage.open(
                        _slSamples.openResourceAsStream("rain.pptx")
                );
                XSLFSlideShow sl = new XSLFSlideShow(pkg);
                POIXMLPropertiesTextExtractor ext = new POIXMLPropertiesTextExtractor(sl)
        ) {
            String text = ext.getText();
            int idx0 = text.indexOf("Category =");
            assertNotEquals(-1, idx0);
            int idx1 = text.indexOf("Category =", idx0 + 1);
            assertEquals(-1, idx1);
            assertContains(text, "Category = rain"); // Via string is blank
        }
    }
}