You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tika.apache.org by ta...@apache.org on 2022/09/14 16:28:17 UTC
[tika] branch main updated: TIKA-3853 -- allow configuration of digests via tika-config
This is an automated email from the ASF dual-hosted git repository.
tallison pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tika.git
The following commit(s) were added to refs/heads/main by this push:
new 96efebfd3 TIKA-3853 -- allow configuration of digests via tika-config
96efebfd3 is described below
commit 96efebfd34f1e93db5500a5d085df1ff04a14b94
Author: tallison <ta...@apache.org>
AuthorDate: Wed Sep 14 12:28:01 2022 -0400
TIKA-3853 -- allow configuration of digests via tika-config
---
.../src/main/java/org/apache/tika/cli/TikaCLI.java | 2 +
.../org/apache/tika/parser/AutoDetectParser.java | 10 ++++-
.../apache/tika/parser/AutoDetectParserConfig.java | 12 +++++-
.../org/apache/tika/parser/DigestingParser.java | 8 ++++
.../tika/parser/digestutils/CommonsDigester.java | 12 +++++-
.../parser/digestutils/CommonsDigesterFactory.java | 45 ++++++++++++++++++++++
.../tika/parser/AutoDetectParserConfigTest.java | 25 ++++++++++++
.../test/resources/configs/tika-config-digests.xml | 35 +++++++++++++++++
.../apache/tika/server/core/TikaServerConfig.java | 2 +
9 files changed, 148 insertions(+), 3 deletions(-)
diff --git a/tika-app/src/main/java/org/apache/tika/cli/TikaCLI.java b/tika-app/src/main/java/org/apache/tika/cli/TikaCLI.java
index 651ba7c11..d6f5aacd8 100644
--- a/tika-app/src/main/java/org/apache/tika/cli/TikaCLI.java
+++ b/tika-app/src/main/java/org/apache/tika/cli/TikaCLI.java
@@ -718,6 +718,8 @@ public class TikaCLI {
parser = new AutoDetectParser(config);
if (digester != null) {
parser = new DigestingParser(parser, digester);
+ LOG.info("As of Tika 2.5.0, you can set the digester via the AutoDetectParserConfig in " +
+ "tika-config.xml. We plan to remove this commandline option in 2.7.0");
}
}
detector = config.getDetector();
diff --git a/tika-core/src/main/java/org/apache/tika/parser/AutoDetectParser.java b/tika-core/src/main/java/org/apache/tika/parser/AutoDetectParser.java
index 9ae5b8522..0a6a5e6dc 100644
--- a/tika-core/src/main/java/org/apache/tika/parser/AutoDetectParser.java
+++ b/tika-core/src/main/java/org/apache/tika/parser/AutoDetectParser.java
@@ -88,11 +88,19 @@ public class AutoDetectParser extends CompositeParser {
}
public AutoDetectParser(TikaConfig config) {
- super(config.getMediaTypeRegistry(), config.getParser());
+ super(config.getMediaTypeRegistry(), getParser(config));
setDetector(config.getDetector());
setAutoDetectParserConfig(config.getAutoDetectParserConfig());
}
+ private static Parser getParser(TikaConfig config) {
+ if (config.getAutoDetectParserConfig().getDigesterFactory() == null) {
+ return config.getParser();
+ }
+ return new DigestingParser(config.getParser(),
+ config.getAutoDetectParserConfig().getDigesterFactory().build());
+ }
+
/**
* Returns the type detector used by this parser to auto-detect the type
* of a document.
diff --git a/tika-core/src/main/java/org/apache/tika/parser/AutoDetectParserConfig.java b/tika-core/src/main/java/org/apache/tika/parser/AutoDetectParserConfig.java
index 8980dbce5..0bc89919a 100644
--- a/tika-core/src/main/java/org/apache/tika/parser/AutoDetectParserConfig.java
+++ b/tika-core/src/main/java/org/apache/tika/parser/AutoDetectParserConfig.java
@@ -95,6 +95,8 @@ public class AutoDetectParserConfig extends ConfigBase implements Serializable {
private ContentHandlerDecoratorFactory contentHandlerDecoratorFactory =
NOOP_CONTENT_HANDLER_DECORATOR_FACTORY;
+ private DigestingParser.DigesterFactory digesterFactory = null;
+
/**
* Creates a SecureContentHandlerConfig using the passed in parameters.
*
@@ -185,6 +187,14 @@ public class AutoDetectParserConfig extends ConfigBase implements Serializable {
return contentHandlerDecoratorFactory;
}
+ public void setDigesterFactory(DigestingParser.DigesterFactory digesterFactory) {
+ this.digesterFactory = digesterFactory;
+ }
+
+ public DigestingParser.DigesterFactory getDigesterFactory() {
+ return this.digesterFactory;
+ }
+
@Override
public String toString() {
return "AutoDetectParserConfig{" + "spoolToDisk=" + spoolToDisk + ", outputThreshold=" +
@@ -193,7 +203,7 @@ public class AutoDetectParserConfig extends ConfigBase implements Serializable {
maximumPackageEntryDepth + ", metadataWriteFilterFactory=" +
metadataWriteFilterFactory + ", embeddedDocumentExtractorFactory=" +
embeddedDocumentExtractorFactory + ", contentHandlerDecoratorFactory=" +
- contentHandlerDecoratorFactory + '}';
+ contentHandlerDecoratorFactory + ", digesterFactory=" + digesterFactory + '}';
}
}
diff --git a/tika-core/src/main/java/org/apache/tika/parser/DigestingParser.java b/tika-core/src/main/java/org/apache/tika/parser/DigestingParser.java
index 6cabb85e6..a36785fdf 100644
--- a/tika-core/src/main/java/org/apache/tika/parser/DigestingParser.java
+++ b/tika-core/src/main/java/org/apache/tika/parser/DigestingParser.java
@@ -59,6 +59,14 @@ public class DigestingParser extends ParserDecorator {
}
/**
+ * This is used in {@link AutoDetectParserConfig} to (optionally)
+ * wrap the parser in a digesting parser.
+ */
+ public interface DigesterFactory {
+ Digester build();
+ }
+
+ /**
* Interface for digester. See
* org.apache.parser.utils.CommonsDigester in tika-parsers for an
* implementation.
diff --git a/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-digest-commons/src/main/java/org/apache/tika/parser/digestutils/CommonsDigester.java b/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-digest-commons/src/main/java/org/apache/tika/parser/digestutils/CommonsDigester.java
index 19352cfc0..7dd27cf25 100644
--- a/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-digest-commons/src/main/java/org/apache/tika/parser/digestutils/CommonsDigester.java
+++ b/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-digest-commons/src/main/java/org/apache/tika/parser/digestutils/CommonsDigester.java
@@ -21,6 +21,7 @@ import java.util.List;
import java.util.Locale;
import org.apache.commons.codec.binary.Base32;
+import org.apache.commons.codec.binary.Base64;
import org.apache.commons.codec.binary.Hex;
import org.apache.tika.metadata.TikaCoreProperties;
@@ -135,8 +136,10 @@ public class CommonsDigester extends CompositeDigester {
encoder = new HexEncoder();
} else if (parts[1].equals("32")) {
encoder = new Base32Encoder();
+ } else if (parts[1].equals("64")) {
+ encoder = new Base64Encoder();
} else {
- throw new IllegalArgumentException("Value must be '16' or '32'");
+ throw new IllegalArgumentException("Value must be '16', '32' or '64'");
}
} else {
encoder = new HexEncoder();
@@ -182,4 +185,11 @@ public class CommonsDigester extends CompositeDigester {
return new Base32().encodeToString(bytes);
}
}
+
+ private static class Base64Encoder implements DigestingParser.Encoder {
+ @Override
+ public String encode(byte[] bytes) {
+ return new Base64().encodeToString(bytes);
+ }
+ }
}
diff --git a/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-digest-commons/src/main/java/org/apache/tika/parser/digestutils/CommonsDigesterFactory.java b/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-digest-commons/src/main/java/org/apache/tika/parser/digestutils/CommonsDigesterFactory.java
new file mode 100644
index 000000000..17d0765bc
--- /dev/null
+++ b/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-digest-commons/src/main/java/org/apache/tika/parser/digestutils/CommonsDigesterFactory.java
@@ -0,0 +1,45 @@
+/*
+ * 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.digestutils;
+
+import org.apache.tika.config.Field;
+import org.apache.tika.parser.DigestingParser;
+
+/**
+ * Simple factory for {@link CommonsDigester} with
+ * default markLimit = 1000000 and md5 digester.
+ */
+public class CommonsDigesterFactory implements DigestingParser.DigesterFactory {
+
+ private int markLimit = 1000000;
+ private String algorithmString = "md5";
+
+ @Override
+ public DigestingParser.Digester build() {
+ return new CommonsDigester(markLimit, algorithmString);
+ }
+
+ @Field
+ public void setMarkLimit(int markLimit) {
+ this.markLimit = markLimit;
+ }
+
+ @Field
+ public void setAlgorithmString(String algorithmString) {
+ this.algorithmString = algorithmString;
+ }
+}
diff --git a/tika-parsers/tika-parsers-standard/tika-parsers-standard-package/src/test/java/org/apache/tika/parser/AutoDetectParserConfigTest.java b/tika-parsers/tika-parsers-standard/tika-parsers-standard-package/src/test/java/org/apache/tika/parser/AutoDetectParserConfigTest.java
index 38c0ea95f..96b213a68 100644
--- a/tika-parsers/tika-parsers-standard/tika-parsers-standard-package/src/test/java/org/apache/tika/parser/AutoDetectParserConfigTest.java
+++ b/tika-parsers/tika-parsers-standard/tika-parsers-standard-package/src/test/java/org/apache/tika/parser/AutoDetectParserConfigTest.java
@@ -16,6 +16,8 @@
*/
package org.apache.tika.parser;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
import java.io.InputStream;
import java.util.List;
@@ -96,4 +98,27 @@ public class AutoDetectParserConfigTest extends TikaTest {
assertContainsCount("THE APACHE TIKA PROJECT WAS FORMALLY", txt, 2);
assertContainsCount("15.9.2007 11:02", txt, 2);
}
+
+ @Test
+ public void testDigests() throws Exception {
+ //test to make sure that the decorator is only applied once for
+ //legacy (e.g. not RecursiveParserWrapperHandler) parsing
+ TikaConfig tikaConfig = null;
+ try (InputStream is = OOXMLParserTest.class.getResourceAsStream(
+ "/configs/tika-config-digests.xml")) {
+ tikaConfig = new TikaConfig(is);
+ }
+ Parser p = new AutoDetectParser(tikaConfig);
+ List<Metadata> metadataList = getRecursiveMetadata("testPPT_EmbeddedPDF.pptx", p);
+ assertEquals("SO67W5OGGMOFPMFQTHTNL5YU5EQXWPMNEPU7HKOZX2ULHRQICRZA====",
+ metadataList.get(0).get("X-TIKA:digest:SHA256"));
+
+ assertEquals("a16f14215ebbfa47bd995e799f03cb18",
+ metadataList.get(0).get("X-TIKA:digest:MD5"));
+
+ assertEquals("Q7D3RFV6DNGZ4BQIS6UKNWX4CDIKPIGDU2D7ADBUDVOBYSZHF7FQ====",
+ metadataList.get(6).get("X-TIKA:digest:SHA256"));
+ assertEquals("90a8b249a6d6b6cb127c59e01cef3aaa",
+ metadataList.get(6).get("X-TIKA:digest:MD5"));
+ }
}
diff --git a/tika-parsers/tika-parsers-standard/tika-parsers-standard-package/src/test/resources/configs/tika-config-digests.xml b/tika-parsers/tika-parsers-standard/tika-parsers-standard-package/src/test/resources/configs/tika-config-digests.xml
new file mode 100644
index 000000000..0f71a3072
--- /dev/null
+++ b/tika-parsers/tika-parsers-standard/tika-parsers-standard-package/src/test/resources/configs/tika-config-digests.xml
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ 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.
+-->
+<properties>
+ <parsers>
+ <parser class="org.apache.tika.parser.DefaultParser"/>
+ </parsers>
+ <autoDetectParserConfig>
+ <params>
+ <spoolToDisk>1000000</spoolToDisk>
+ <outputThreshold>1000000</outputThreshold>
+ </params>
+ <digesterFactory
+ class="org.apache.tika.parser.digestutils.CommonsDigesterFactory">
+ <params>
+ <markLimit>100000</markLimit>
+ <algorithmString>sha256:32,md5</algorithmString>
+ </params>
+ </digesterFactory>
+ </autoDetectParserConfig>
+</properties>
diff --git a/tika-server/tika-server-core/src/main/java/org/apache/tika/server/core/TikaServerConfig.java b/tika-server/tika-server-core/src/main/java/org/apache/tika/server/core/TikaServerConfig.java
index aa3d7c242..1cc309ad4 100644
--- a/tika-server/tika-server-core/src/main/java/org/apache/tika/server/core/TikaServerConfig.java
+++ b/tika-server/tika-server-core/src/main/java/org/apache/tika/server/core/TikaServerConfig.java
@@ -510,6 +510,8 @@ public class TikaServerConfig extends ConfigBase {
}
public void setDigest(String digest) {
+ LOG.info("As of Tika 2.5.0, you can set the digester via the AutoDetectParserConfig in " +
+ "tika-config.xml. We plan to remove this commandline option in 2.7.0");
this.digest = digest;
}