Merge pull request #138 from solrudev/develop

0.15.2

Author: solrudev

README.md

@@ -35,7 +35,7 @@ Ackpine depends on Jetpack libraries, so it's also necessary to add the `google(
 
 ```toml
 [versions]
-ackpine = "0.15.1"
+ackpine = "0.15.2"
 
 [libraries]
 ackpine-core = { module = "ru.solrudev.ackpine:ackpine-core", version.ref = "ackpine" }
@@ -76,7 +76,7 @@ ackpine = [
 
 ```kotlin
 dependencies {
-    val ackpineVersion = "0.15.1"
+    val ackpineVersion = "0.15.2"
     implementation("ru.solrudev.ackpine:ackpine-core:$ackpineVersion")
 
     // optional - Kotlin extensions and Coroutines support

ackpine-api/api-main/src/main/kotlin/ru/solrudev/ackpine/SdkIntWrapper.kt

@@ -16,6 +16,9 @@
 
 package ru.solrudev.ackpine
 
+import androidx.annotation.RestrictTo
+
+@RestrictTo(RestrictTo.Scope.LIBRARY)
 internal object SdkIntWrapper {
 	@JvmSynthetic
 	fun get() = try {

ackpine-splits/compress-android/build.gradle.kts

@@ -18,11 +18,12 @@ import ru.solrudev.ackpine.gradle.versioning.ackpineVersion
 
 description = "Fork of Apache Commons Compress, compatible with Android API 19+. " +
 		"Contains only a subset of Compress API."
-version = "1.27.1-${ackpineVersion.get()}"
+version = "1.28.0-${ackpineVersion.get()}"
 
 plugins {
 	id("ru.solrudev.ackpine.library.base")
 	id("ru.solrudev.ackpine.library-publish")
+	id("ru.solrudev.ackpine.optional-dependencies")
 }
 
 ackpine {
@@ -142,4 +143,6 @@ mavenPublishing {
 dependencies {
 	implementation(androidx.core)
 	implementation(libs.apache.commons.io)
+	optional(libs.zstd)
+	optional(libs.xz)
 }

ackpine-splits/compress-android/src/main/java/ru/solrudev/ackpine/compress/CompressException.java

@@ -0,0 +1,69 @@
+/*
+ * 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
+ *
+ *   https://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 ru.solrudev.ackpine.compress;
+
+import java.io.IOException;
+
+/**
+ * Signals that a Pack200 Compress exception of some sort has occurred.
+ *
+ * @since 1.28.0
+ */
+public class CompressException extends IOException {
+
+	/** Serial. */
+	private static final long serialVersionUID = 1;
+
+	/**
+	 * Constructs an {@code CompressException} with {@code null} as its error detail message.
+	 */
+	public CompressException() {
+		// empty
+	}
+
+	/**
+	 * Constructs a new exception with the specified detail message. The cause is not initialized.
+	 *
+	 * @param message The message (which is saved for later retrieval by the {@link #getMessage()} method).
+	 */
+	public CompressException(final String message) {
+		super(message);
+	}
+
+	/**
+	 * Constructs a new exception with the specified detail message and cause.
+	 *
+	 * @param message The message (which is saved for later retrieval by the {@link #getMessage()} method).
+	 * @param cause   The cause (which is saved for later retrieval by the {@link #getCause()} method). A null value indicates that the cause is nonexistent or
+	 *                unknown.
+	 */
+	public CompressException(final String message, final Throwable cause) {
+		super(message, cause);
+	}
+
+	/**
+	 * Constructs a {@code CompressException} with the specified cause and a detail message.
+	 *
+	 * @param cause The cause (which is saved for later retrieval by the {@link #getCause()} method). (A null value is permitted, and indicates that the cause
+	 *              is nonexistent or unknown.)
+	 */
+	public CompressException(final Throwable cause) {
+		super(cause);
+	}
+}

ackpine-splits/compress-android/src/main/java/ru/solrudev/ackpine/compress/MemoryLimitException.java

@@ -18,45 +18,82 @@
  */
 package ru.solrudev.ackpine.compress;
 
-import java.io.IOException;
-
 /**
  * If a stream checks for estimated memory allocation, and the estimate goes above the memory limit, this is thrown. This can also be thrown if a stream tries
  * to allocate a byte array that is larger than the allowable limit.
  *
  * @since 1.14
  */
-public class MemoryLimitException extends IOException {
+public class MemoryLimitException extends CompressException {
 
 	private static final long serialVersionUID = 1L;
 
 	private static String buildMessage(final long memoryNeededInKb, final int memoryLimitInKb) {
-		return memoryNeededInKb + " kb of memory would be needed; limit was " + memoryLimitInKb + " kb. "
-				+ "If the file is not corrupt, consider increasing the memory limit.";
+		return String.format("%,d KiB of memory would be needed; limit was %,d KiB. If the file is not corrupt, consider increasing the memory limit.",
+				memoryNeededInKb, memoryLimitInKb);
 	}
 
 	/** A long instead of int to account for overflow for corrupt files. */
-	private final long memoryNeededInKb;
+	private final long memoryNeededKiB;
+	private final int memoryLimitKiB;
 
-	private final int memoryLimitInKb;
+	/**
+	 * Constructs a new instance.
+	 *
+	 * @param memoryNeededKiB The memory needed in kibibytes (KiB).
+	 * @param memoryLimitKiB  The memory limit in kibibytes (KiB).
+	 */
+	public MemoryLimitException(final long memoryNeededKiB, final int memoryLimitKiB) {
+		super(buildMessage(memoryNeededKiB, memoryLimitKiB));
+		this.memoryNeededKiB = memoryNeededKiB;
+		this.memoryLimitKiB = memoryLimitKiB;
+	}
 
-	public MemoryLimitException(final long memoryNeededInKb, final int memoryLimitInKb) {
-		super(buildMessage(memoryNeededInKb, memoryLimitInKb));
-		this.memoryNeededInKb = memoryNeededInKb;
-		this.memoryLimitInKb = memoryLimitInKb;
+	/**
+	 * Constructs a new instance.
+	 *
+	 * @param memoryNeededKiB The memory needed in kibibytes (KiB).
+	 * @param memoryLimitKiB  The memory limit in kibibytes (KiB).
+	 * @param cause            The cause (which is saved for later retrieval by the {@link #getCause()} method). (A null value is permitted, and indicates that
+	 *                         the cause is nonexistent or unknown.)
+	 * @deprecated Use {@link #MemoryLimitException(long, int, Throwable)}.
+	 */
+	@Deprecated
+	public MemoryLimitException(final long memoryNeededKiB, final int memoryLimitKiB, final Exception cause) {
+		super(buildMessage(memoryNeededKiB, memoryLimitKiB), cause);
+		this.memoryNeededKiB = memoryNeededKiB;
+		this.memoryLimitKiB = memoryLimitKiB;
 	}
 
-	public MemoryLimitException(final long memoryNeededInKb, final int memoryLimitInKb, final Exception e) {
-		super(buildMessage(memoryNeededInKb, memoryLimitInKb), e);
-		this.memoryNeededInKb = memoryNeededInKb;
-		this.memoryLimitInKb = memoryLimitInKb;
+	/**
+	 * Constructs a new instance.
+	 *
+	 * @param memoryNeededKiB The memory needed in kibibytes (KiB).
+	 * @param memoryLimitKiB  The memory limit in kibibytes (KiB).
+	 * @param cause            The cause (which is saved for later retrieval by the {@link #getCause()} method). (A null value is permitted, and indicates that
+	 *                         the cause is nonexistent or unknown.)
+	 */
+	public MemoryLimitException(final long memoryNeededKiB, final int memoryLimitKiB, final Throwable cause) {
+		super(buildMessage(memoryNeededKiB, memoryLimitKiB), cause);
+		this.memoryNeededKiB = memoryNeededKiB;
+		this.memoryLimitKiB = memoryLimitKiB;
 	}
 
+	/**
+	 * Gets the memory limit in kibibytes (KiB).
+	 *
+	 * @return the memory limit in kibibytes (KiB).
+	 */
 	public int getMemoryLimitInKb() {
-		return memoryLimitInKb;
+		return memoryLimitKiB;
 	}
 
+	/**
+	 * Gets the memory needed in kibibytes (KiB).
+	 *
+	 * @return the memory needed in kibibytes (KiB).
+	 */
 	public long getMemoryNeededInKb() {
-		return memoryNeededInKb;
+		return memoryNeededKiB;
 	}
 }

ackpine-splits/compress-android/src/main/java/ru/solrudev/ackpine/compress/archivers/ArchiveInputStream.java

@@ -27,14 +27,15 @@
 import org.apache.commons.io.input.NullInputStream;
 
 /**
- * Archive input streams <b>MUST</b> override the {@link #read(byte[], int, int)} - or {@link #read()} - method so that reading from the stream generates EOF
- * for the end of data in each entry as well as at the end of the file proper.
+ * Archive input streams <strong>MUST</strong> override the {@link #read(byte[], int, int)} - or {@link #read()} - method so that reading from the stream
+ * generates EOF for the end of data in each entry as well as at the end of the file proper.
  * <p>
  * The {@link #getNextEntry()} method is used to reset the input stream ready for reading the data from the next entry.
  * </p>
  * <p>
  * The input stream classes must also implement a method with the signature:
  * </p>
+ *
  * <pre>
  * public static boolean matches(byte[] signature, int length)
  * </pre>
@@ -50,16 +51,17 @@ public abstract class ArchiveInputStream<E extends ArchiveEntry> extends FilterI
 
 	private final byte[] single = new byte[1];
 
-	/** The number of bytes read in this stream */
+	/** The number of bytes read in this stream. */
 	private long bytesRead;
 
 	private Charset charset;
 
 	/**
 	 * Constructs a new instance.
 	 */
+	@SuppressWarnings("resource")
 	public ArchiveInputStream() {
-		this(NullInputStream.INSTANCE, Charset.defaultCharset());
+		this(new NullInputStream(), Charset.defaultCharset());
 	}
 
 	/**
@@ -87,33 +89,32 @@ protected ArchiveInputStream(final InputStream inputStream, final String charset
 	}
 
 	/**
-	 * Whether this stream is able to read the given entry.
+	 * Tests whether this stream is able to read the given entry.
 	 * <p>
 	 * Some archive formats support variants or details that are not supported (yet).
 	 * </p>
 	 *
-	 * @param archiveEntry the entry to test
+	 * @param archiveEntry the entry to test.
 	 * @return This implementation always returns true.
-	 *
 	 * @since 1.1
 	 */
 	public boolean canReadEntryData(final ArchiveEntry archiveEntry) {
 		return true;
 	}
 
 	/**
-	 * Increments the counter of already read bytes. Doesn't increment if the EOF has been hit (read == -1)
+	 * Increments the counter of already read bytes. Doesn't increment if the EOF has been hit (read == -1).
 	 *
-	 * @param read the number of bytes read
+	 * @param read the number of bytes read.
 	 */
 	protected void count(final int read) {
 		count((long) read);
 	}
 
 	/**
-	 * Increments the counter of already read bytes. Doesn't increment if the EOF has been hit (read == -1)
+	 * Increments the counter of already read bytes. Doesn't increment if the EOF has been hit (read == -1).
 	 *
-	 * @param read the number of bytes read
+	 * @param read the number of bytes read.
 	 * @since 1.1
 	 */
 	protected void count(final long read) {
@@ -133,9 +134,9 @@ public long getBytesRead() {
 	}
 
 	/**
-	 * Gets the Charest.
+	 * Gets the Charset.
 	 *
-	 * @return the Charest.
+	 * @return the Charset.
 	 */
 	public Charset getCharset() {
 		return charset;
@@ -144,7 +145,7 @@ public Charset getCharset() {
 	/**
 	 * Gets the current number of bytes read from this stream.
 	 *
-	 * @return the number of read bytes
+	 * @return the number of read.
 	 * @deprecated this method may yield wrong results for large archives, use {@link #getBytesRead()} instead.
 	 */
 	@Deprecated
@@ -162,8 +163,9 @@ public int getCount() {
 
 	/**
 	 * Does nothing.
-	 *
+	 * <p>
 	 * TODO [COMPRESS-670] Support mark() and reset() in ArchiveInputStream.
+	 * </p>
 	 *
 	 * @param readlimit ignored.
 	 */
@@ -174,8 +176,9 @@ public synchronized void mark(final int readlimit) {
 
 	/**
 	 * Always returns false.
-	 *
+	 * <p>
 	 * TODO [COMPRESS-670] Support mark() and reset() in ArchiveInputStream.
+	 * </p>
 	 *
 	 * @return Always returns false.
 	 */
@@ -196,13 +199,15 @@ protected void pushedBackBytes(final long pushedBack) {
 
 	/**
 	 * Reads a byte of data. This method will block until enough input is available.
-	 *
+	 * <p>
 	 * Simply calls the {@link #read(byte[], int, int)} method.
-	 *
+	 * </p>
+	 * <p>
 	 * MUST be overridden if the {@link #read(byte[], int, int)} method is not overridden; may be overridden otherwise.
+	 * </p>
 	 *
-	 * @return the byte read, or -1 if end of input is reached
-	 * @throws IOException if an I/O error has occurred
+	 * @return the byte read, or -1 if end of input is reached.
+	 * @throws IOException if an I/O error has occurred.
 	 */
 	@Override
 	public int read() throws IOException {
@@ -212,8 +217,9 @@ public int read() throws IOException {
 
 	/**
 	 * Does nothing.
-	 *
+	 * <p>
 	 * TODO [COMPRESS-670] Support mark() and reset() in ArchiveInputStream.
+	 * </p>
 	 *
 	 * @throws IOException not thrown here but may be thrown from a subclass.
 	 */

ackpine-splits/compress-android/src/main/java/ru/solrudev/ackpine/compress/archivers/zip/AbstractUnicodeExtraField.java

@@ -96,7 +96,7 @@ public ZipShort getCentralDirectoryLength() {
 		if (data == null) {
 			assembleData();
 		}
-		return new ZipShort(data != null ? data.length : 0);
+		return ZipShort.lengthOf(data);
 	}
 
 	@Override