RarParserTest.java

/*
 * 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.tika.parser.pkg;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;

import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;

import org.apache.commons.io.IOUtils;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
import org.xml.sax.ContentHandler;

import org.apache.tika.exception.EncryptedDocumentException;
import org.apache.tika.io.TikaInputStream;
import org.apache.tika.metadata.Metadata;
import org.apache.tika.metadata.TikaCoreProperties;
import org.apache.tika.parser.ParseContext;
import org.apache.tika.parser.Parser;
import org.apache.tika.parser.PasswordProvider;
import org.apache.tika.sax.BodyContentHandler;

/**
 * Test case for parsing rar files.
 */
public class RarParserTest extends AbstractPkgTest {

    /**
     * Tests that the ParseContext parser is correctly
     * fired for all the embedded entries.
     */
    @Test
    public void testEmbedded() throws Exception {
        ContentHandler handler = new BodyContentHandler();
        Metadata metadata = new Metadata();

        try (TikaInputStream tis = getResourceAsStream("/test-documents/test-documents.rar")) {
            AUTO_DETECT_PARSER.parse(tis, handler, metadata, trackingContext);
        }

        // Should have found all 9 documents, but not the directory
        assertEquals(9, tracker.filenames.size());
        assertEquals(9, tracker.mediatypes.size());
        assertEquals(9, tracker.modifiedAts.size());

        // Should have names but not content types, as rar doesn't
        //  store the content types
        assertEquals("test-documents/testEXCEL.xls", tracker.filenames.get(0));
        assertEquals("test-documents/testHTML.html", tracker.filenames.get(1));
        assertEquals("test-documents/testOpenOffice2.odt", tracker.filenames.get(2));
        assertEquals("test-documents/testPDF.pdf", tracker.filenames.get(3));
        assertEquals("test-documents/testPPT.ppt", tracker.filenames.get(4));
        assertEquals("test-documents/testRTF.rtf", tracker.filenames.get(5));
        assertEquals("test-documents/testTXT.txt", tracker.filenames.get(6));
        assertEquals("test-documents/testWORD.doc", tracker.filenames.get(7));
        assertEquals("test-documents/testXML.xml", tracker.filenames.get(8));

        for (String type : tracker.mediatypes) {
            assertNull(type);
        }
        for (String crt : tracker.createdAts) {
            assertNull(crt);
        }
        for (String mod : tracker.modifiedAts) {
            assertNotNull(mod);
            assertTrue(mod.startsWith("20"), "Modified at " + mod);
        }

        // Should have filenames in the content string
        String content = handler.toString();
        assertContains("test-documents/testHTML.html", content);
        assertContains("test-documents/testEXCEL.xls", content);
        assertContains("test-documents/testOpenOffice2.odt", content);
        assertContains("test-documents/testPDF.pdf", content);
        assertContains("test-documents/testPPT.ppt", content);
        assertContains("test-documents/testRTF.rtf", content);
        assertContains("test-documents/testTXT.txt", content);
        assertContains("test-documents/testWORD.doc", content);
        assertContains("test-documents/testXML.xml", content);
    }

    @Test
    public void testCorruptEntryKeepsLaterEntries(@TempDir Path tmp) throws Exception {
        byte[] rar;
        try (TikaInputStream tis = getResourceAsStream("/test-documents/test-documents.rar")) {
            rar = IOUtils.toByteArray(tis);
        }
        // testEXCEL.xls, the first entry, has its packed data at 80..2885
        rar[1500] ^= 0x5A;
        Path corrupt = tmp.resolve("corrupt.rar");
        Files.write(corrupt, rar);

        List<Metadata> metadataList = getRecursiveMetadata(corrupt, new ParseContext(), false);
        assertContains("testEXCEL.xls",
                metadataList.get(0).get(TikaCoreProperties.TIKA_META_EXCEPTION_EMBEDDED_STREAM));
        assertContains("test-documents/testXML.xml",
                metadataList.get(0).get(TikaCoreProperties.TIKA_CONTENT));
        assertTrue(hasEmbeddedPath(metadataList, "/testEXCEL.xls"));
        assertTrue(hasEmbeddedPath(metadataList, "/testXML.xml"));
    }

    private static boolean hasEmbeddedPath(List<Metadata> metadataList, String path) {
        return metadataList.stream()
                .anyMatch(m -> path.equals(m.get(TikaCoreProperties.EMBEDDED_RESOURCE_PATH)));
    }

    /**
     * Note - we don't currently support Encrypted RAR files,
     * so all we can do is throw a helpful exception
     */
    @Test
    public void testEncryptedRar() throws Exception {
        Parser parser = new RarParser();

        try (TikaInputStream tis = getResourceAsStream("/test-documents/test-documents-enc.rar")) {
            Metadata metadata = new Metadata();
            ContentHandler handler = new BodyContentHandler();
            ParseContext context = new ParseContext();
            context.set(PasswordProvider.class, new PasswordProvider() {
                @Override
                public String getPassword(Metadata metadata) {
                    return "ApacheTika";
                }
            });

            // Note - we don't currently support encrypted RAR
            // files so we can't check the contents
            parser.parse(tis, handler, metadata, trackingContext);
            fail("No support yet for Encrypted RAR files");
        } catch (EncryptedDocumentException e) {
            // Good, as expected right now
        }
    }
}