Date: Sat, 13 Apr 2024 08:30:26 -0400
Subject: [PATCH 47/99] Refactor common data
---
.../apache/commons/codec/binary/Base64.java | 2 -
.../org/apache/commons/codec/net/BCodec.java | 47 ++-----------------
.../org/apache/commons/codec/net/QCodec.java | 39 +--------------
.../commons/codec/net/RFC1522Codec.java | 33 +++++++++++++
.../commons/codec/net/RFC1522CodecTest.java | 6 +++
...dec.java => RFC1522OverrideTestCodec.java} | 7 ++-
6 files changed, 52 insertions(+), 82 deletions(-)
rename src/test/java/org/apache/commons/codec/net/{CustomRFC1522Codec.java => RFC1522OverrideTestCodec.java} (91%)
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64.java b/src/main/java/org/apache/commons/codec/binary/Base64.java
index a53cb8b071..9046259a03 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -241,7 +241,6 @@ public static byte[] encodeBase64(final byte[] binaryData, final boolean isChunk
if (BinaryCodec.isEmpty(binaryData)) {
return binaryData;
}
-
// Create this so can use the super-class method
// Also ensures that the same roundings are performed by the ctor and the code
final Base64 b64 = isChunked ? new Base64(urlSafe) : new Base64(0, CHUNK_SEPARATOR, urlSafe);
@@ -252,7 +251,6 @@ public static byte[] encodeBase64(final byte[] binaryData, final boolean isChunk
") than the specified maximum size of " +
maxResultSize);
}
-
return b64.encode(binaryData);
}
diff --git a/src/main/java/org/apache/commons/codec/net/BCodec.java b/src/main/java/org/apache/commons/codec/net/BCodec.java
index 3f66e557e7..fae4520e03 100644
--- a/src/main/java/org/apache/commons/codec/net/BCodec.java
+++ b/src/main/java/org/apache/commons/codec/net/BCodec.java
@@ -54,11 +54,6 @@ public class BCodec extends RFC1522Codec implements StringEncoder, StringDecoder
*/
private static final CodecPolicy DECODING_POLICY_DEFAULT = CodecPolicy.LENIENT;
- /**
- * The default Charset used for string decoding and encoding.
- */
- private final Charset charset;
-
/**
* If true then decoding should throw an exception for impossible combinations of bits at the
* end of the byte input. The default is to decode as much of them as possible.
@@ -96,7 +91,7 @@ public BCodec(final Charset charset) {
* @since 1.15
*/
public BCodec(final Charset charset, final CodecPolicy decodingPolicy) {
- this.charset = charset;
+ super(charset);
this.decodingPolicy = decodingPolicy;
}
@@ -133,9 +128,7 @@ public Object decode(final Object value) throws DecoderException {
if (value instanceof String) {
return decode((String) value);
}
- throw new DecoderException("Objects of type " +
- value.getClass().getName() +
- " cannot be decoded using BCodec");
+ throw new DecoderException("Objects of type " + value.getClass().getName() + " cannot be decoded using BCodec");
}
/**
@@ -190,9 +183,7 @@ public Object encode(final Object value) throws EncoderException {
if (value instanceof String) {
return encode((String) value);
}
- throw new EncoderException("Objects of type " +
- value.getClass().getName() +
- " cannot be encoded using BCodec");
+ throw new EncoderException("Objects of type " + value.getClass().getName() + " cannot be encoded using BCodec");
}
/**
@@ -206,10 +197,7 @@ public Object encode(final Object value) throws EncoderException {
*/
@Override
public String encode(final String strSource) throws EncoderException {
- if (strSource == null) {
- return null;
- }
- return encode(strSource, this.getCharset());
+ return encode(strSource, getCharset());
}
/**
@@ -225,9 +213,6 @@ public String encode(final String strSource) throws EncoderException {
* @since 1.7
*/
public String encode(final String strSource, final Charset sourceCharset) throws EncoderException {
- if (strSource == null) {
- return null;
- }
return encodeText(strSource, sourceCharset);
}
@@ -243,35 +228,13 @@ public String encode(final String strSource, final Charset sourceCharset) throws
* thrown if a failure condition is encountered during the encoding process.
*/
public String encode(final String strSource, final String sourceCharset) throws EncoderException {
- if (strSource == null) {
- return null;
- }
try {
- return this.encodeText(strSource, sourceCharset);
+ return encodeText(strSource, sourceCharset);
} catch (final UnsupportedCharsetException e) {
throw new EncoderException(e.getMessage(), e);
}
}
- /**
- * Gets the default Charset name used for string decoding and encoding.
- *
- * @return the default Charset name
- * @since 1.7
- */
- public Charset getCharset() {
- return this.charset;
- }
-
- /**
- * Gets the default Charset name used for string decoding and encoding.
- *
- * @return the default Charset name
- */
- public String getDefaultCharset() {
- return this.charset.name();
- }
-
@Override
protected String getEncoding() {
return "B";
diff --git a/src/main/java/org/apache/commons/codec/net/QCodec.java b/src/main/java/org/apache/commons/codec/net/QCodec.java
index cbb4c941eb..3dad9bdefc 100644
--- a/src/main/java/org/apache/commons/codec/net/QCodec.java
+++ b/src/main/java/org/apache/commons/codec/net/QCodec.java
@@ -104,11 +104,6 @@ public class QCodec extends RFC1522Codec implements StringEncoder, StringDecoder
private static final byte UNDERSCORE = 95;
- /**
- * The default Charset used for string decoding and encoding.
- */
- private final Charset charset;
-
private boolean encodeBlanks;
/**
@@ -128,7 +123,7 @@ public QCodec() {
* @since 1.7
*/
public QCodec(final Charset charset) {
- this.charset = charset;
+ super(charset);
}
/**
@@ -246,9 +241,7 @@ public Object encode(final Object obj) throws EncoderException {
if (obj instanceof String) {
return encode((String) obj);
}
- throw new EncoderException("Objects of type " +
- obj.getClass().getName() +
- " cannot be encoded using Q codec");
+ throw new EncoderException("Objects of type " + obj.getClass().getName() + " cannot be encoded using Q codec");
}
/**
@@ -262,9 +255,6 @@ public Object encode(final Object obj) throws EncoderException {
*/
@Override
public String encode(final String sourceStr) throws EncoderException {
- if (sourceStr == null) {
- return null;
- }
return encode(sourceStr, getCharset());
}
@@ -281,9 +271,6 @@ public String encode(final String sourceStr) throws EncoderException {
* @since 1.7
*/
public String encode(final String sourceStr, final Charset sourceCharset) throws EncoderException {
- if (sourceStr == null) {
- return null;
- }
return encodeText(sourceStr, sourceCharset);
}
@@ -299,9 +286,6 @@ public String encode(final String sourceStr, final Charset sourceCharset) throws
* thrown if a failure condition is encountered during the encoding process.
*/
public String encode(final String sourceStr, final String sourceCharset) throws EncoderException {
- if (sourceStr == null) {
- return null;
- }
try {
return encodeText(sourceStr, sourceCharset);
} catch (final UnsupportedCharsetException e) {
@@ -309,25 +293,6 @@ public String encode(final String sourceStr, final String sourceCharset) throws
}
}
- /**
- * Gets the default Charset name used for string decoding and encoding.
- *
- * @return the default Charset name
- * @since 1.7
- */
- public Charset getCharset() {
- return this.charset;
- }
-
- /**
- * Gets the default Charset name used for string decoding and encoding.
- *
- * @return the default Charset name
- */
- public String getDefaultCharset() {
- return this.charset.name();
- }
-
@Override
protected String getEncoding() {
return "Q";
diff --git a/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java b/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java
index c0e63a9ed0..39064c52a6 100644
--- a/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java
+++ b/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java
@@ -20,6 +20,7 @@
import java.io.UnsupportedEncodingException;
import java.nio.charset.Charset;
import java.nio.charset.UnsupportedCharsetException;
+import java.util.Objects;
import org.apache.commons.codec.DecoderException;
import org.apache.commons.codec.EncoderException;
@@ -51,6 +52,15 @@ abstract class RFC1522Codec {
/** Postfix. */
protected static final String PREFIX = "=?";
+ /**
+ * The default Charset used for string decoding and encoding.
+ */
+ protected final Charset charset;
+
+ RFC1522Codec(final Charset charset) {
+ this.charset = Objects.requireNonNull(charset, "charset");
+ }
+
/**
* Applies an RFC 1522 compliant decoding scheme to the given string of text.
*
@@ -171,9 +181,32 @@ protected String encodeText(final String text, final Charset charset) throws Enc
* @see Charset
*/
protected String encodeText(final String text, final String charsetName) throws EncoderException {
+ if (text == null) {
+ // Don't attempt charsetName conversion.
+ return null;
+ }
return encodeText(text, Charset.forName(charsetName));
}
+ /**
+ * Gets the default Charset name used for string decoding and encoding.
+ *
+ * @return the default Charset name
+ * @since 1.7
+ */
+ public Charset getCharset() {
+ return charset;
+ }
+
+ /**
+ * Gets the default Charset name used for string decoding and encoding.
+ *
+ * @return the default Charset name
+ */
+ public String getDefaultCharset() {
+ return charset.name();
+ }
+
/**
* Returns the codec name (referred to as encoding in the RFC 1522).
*
diff --git a/src/test/java/org/apache/commons/codec/net/RFC1522CodecTest.java b/src/test/java/org/apache/commons/codec/net/RFC1522CodecTest.java
index b115600039..9e566a814d 100644
--- a/src/test/java/org/apache/commons/codec/net/RFC1522CodecTest.java
+++ b/src/test/java/org/apache/commons/codec/net/RFC1522CodecTest.java
@@ -20,6 +20,8 @@
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
+import java.nio.charset.StandardCharsets;
+
import org.apache.commons.codec.CharEncoding;
import org.apache.commons.codec.DecoderException;
import org.junit.jupiter.api.Test;
@@ -31,6 +33,10 @@ public class RFC1522CodecTest {
static class RFC1522TestCodec extends RFC1522Codec {
+ RFC1522TestCodec() {
+ super(StandardCharsets.UTF_8);
+ }
+
@Override
protected byte[] doDecoding(final byte[] bytes) {
return bytes;
diff --git a/src/test/java/org/apache/commons/codec/net/CustomRFC1522Codec.java b/src/test/java/org/apache/commons/codec/net/RFC1522OverrideTestCodec.java
similarity index 91%
rename from src/test/java/org/apache/commons/codec/net/CustomRFC1522Codec.java
rename to src/test/java/org/apache/commons/codec/net/RFC1522OverrideTestCodec.java
index 1c99d4aac9..c643d9da8b 100644
--- a/src/test/java/org/apache/commons/codec/net/CustomRFC1522Codec.java
+++ b/src/test/java/org/apache/commons/codec/net/RFC1522OverrideTestCodec.java
@@ -19,6 +19,7 @@
import java.io.UnsupportedEncodingException;
import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
import org.apache.commons.codec.DecoderException;
import org.apache.commons.codec.EncoderException;
@@ -26,7 +27,11 @@
/**
* Tests overriding the package private RFC1522Codec.
*/
-public class CustomRFC1522Codec extends RFC1522Codec {
+class RFC1522OverrideTestCodec extends RFC1522Codec {
+
+ RFC1522OverrideTestCodec() {
+ super(StandardCharsets.UTF_8);
+ }
@Override
protected String decodeText(final String text) throws DecoderException, UnsupportedEncodingException {
From ab84d0d4faafb7c8eb34e35f909a001c2477ddcc Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Sat, 13 Apr 2024 08:33:16 -0400
Subject: [PATCH 48/99] Javadoc
Format tweaks
---
.../codec/net/QuotedPrintableCodec.java | 21 +++++++------------
1 file changed, 7 insertions(+), 14 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java b/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java
index 03fbc13f62..6dd8007723 100644
--- a/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java
+++ b/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java
@@ -149,7 +149,7 @@ public static final byte[] decodeQuotedPrintable(final byte[] bytes) throws Deco
}
/**
- * Write a byte to the buffer.
+ * Encodes a byte in the buffer.
*
* @param b
* byte to write
@@ -159,8 +159,7 @@ public static final byte[] decodeQuotedPrintable(final byte[] bytes) throws Deco
* the buffer to write to
* @return the number of bytes that have been written to the buffer
*/
- private static int encodeByte(final int b, final boolean encode,
- final ByteArrayOutputStream buffer) {
+ private static int encodeByte(final int b, final boolean encode, final ByteArrayOutputStream buffer) {
if (encode) {
return encodeQuotedPrintable(b, buffer);
}
@@ -388,8 +387,7 @@ public QuotedPrintableCodec(final Charset charset, final boolean strict) {
*
* @since 1.7 throws UnsupportedCharsetException if the named Charset is unavailable
*/
- public QuotedPrintableCodec(final String charsetName)
- throws IllegalCharsetNameException, IllegalArgumentException, UnsupportedCharsetException {
+ public QuotedPrintableCodec(final String charsetName) throws IllegalCharsetNameException, IllegalArgumentException, UnsupportedCharsetException {
this(Charset.forName(charsetName), false);
}
@@ -434,9 +432,7 @@ public Object decode(final Object obj) throws DecoderException {
if (obj instanceof String) {
return decode((String) obj);
}
- throw new DecoderException("Objects of type " +
- obj.getClass().getName() +
- " cannot be quoted-printable decoded");
+ throw new DecoderException("Objects of type " + obj.getClass().getName() + " cannot be quoted-printable decoded");
}
/**
@@ -489,8 +485,7 @@ public String decode(final String sourceStr, final Charset sourceCharset) throws
* @throws UnsupportedEncodingException
* Thrown if Charset is not supported
*/
- public String decode(final String sourceStr, final String sourceCharset)
- throws DecoderException, UnsupportedEncodingException {
+ public String decode(final String sourceStr, final String sourceCharset) throws DecoderException, UnsupportedEncodingException {
if (sourceStr == null) {
return null;
}
@@ -535,9 +530,7 @@ public Object encode(final Object obj) throws EncoderException {
if (obj instanceof String) {
return encode((String) obj);
}
- throw new EncoderException("Objects of type " +
- obj.getClass().getName() +
- " cannot be quoted-printable encoded");
+ throw new EncoderException("Objects of type " + obj.getClass().getName() + " cannot be quoted-printable encoded");
}
/**
@@ -558,7 +551,7 @@ public Object encode(final Object obj) throws EncoderException {
*/
@Override
public String encode(final String sourceStr) throws EncoderException {
- return this.encode(sourceStr, getCharset());
+ return encode(sourceStr, getCharset());
}
/**
From 3d1a286b2ad52dfabb4e34e3d71350bfba7d9aef Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Sat, 13 Apr 2024 08:37:03 -0400
Subject: [PATCH 49/99] Javadoc
Format tweaks
---
.../java/org/apache/commons/codec/net/PercentCodec.java | 7 ++-----
1 file changed, 2 insertions(+), 5 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/net/PercentCodec.java b/src/main/java/org/apache/commons/codec/net/PercentCodec.java
index e10c978e02..ee87cf97b6 100644
--- a/src/main/java/org/apache/commons/codec/net/PercentCodec.java
+++ b/src/main/java/org/apache/commons/codec/net/PercentCodec.java
@@ -42,7 +42,6 @@ public class PercentCodec implements BinaryEncoder, BinaryDecoder {
/**
* The escape character used by the Percent-Encoding in order to introduce an encoded character.
*/
-
private static final byte ESCAPE_CHAR = '%';
/**
@@ -97,7 +96,7 @@ private boolean containsSpace(final byte[] bytes) {
}
/**
- * Decode bytes encoded with Percent-Encoding based on RFC 3986. The reverse process is performed in order to
+ * Decodes bytes encoded with Percent-Encoding based on RFC 3986. The reverse process is performed in order to
* decode the encoded characters to Unicode.
*/
@Override
@@ -105,7 +104,6 @@ public byte[] decode(final byte[] bytes) throws DecoderException {
if (bytes == null) {
return null;
}
-
final ByteBuffer buffer = ByteBuffer.allocate(expectedDecodingBytes(bytes));
for (int i = 0; i < bytes.length; i++) {
final byte b = bytes[i];
@@ -175,7 +173,6 @@ public byte[] encode(final byte[] bytes) throws EncoderException {
if (bytes == null) {
return null;
}
-
final int expectedEncodingBytes = expectedEncodingBytes(bytes);
final boolean willEncode = expectedEncodingBytes != bytes.length;
if (willEncode || plusForSpace && containsSpace(bytes)) {
@@ -244,7 +241,7 @@ private void insertAlwaysEncodeChar(final byte b) {
}
/**
- * Adds the byte array into a BitSet for faster lookup
+ * Inserts the byte array into a BitSet for faster lookup.
*
* @param alwaysEncodeCharsArray
*/
From 7f93e43583a84bdd3686f15ac137f609fbcc1baf Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Sat, 13 Apr 2024 08:45:14 -0400
Subject: [PATCH 50/99] Make release notes Markdown friendly
These will look nicer in places like GitHub
---
RELEASE-NOTES.txt | 148 +++++++++++++++++++----------------
src/changes/release-notes.vm | 23 ++++--
2 files changed, 95 insertions(+), 76 deletions(-)
diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt
index 6137cdb113..cada46ab2c 100644
--- a/RELEASE-NOTES.txt
+++ b/RELEASE-NOTES.txt
@@ -1,5 +1,5 @@
-Apache Commons Codec 1.16.1
-RELEASE NOTES
+Apache Commons Codec 1.16.1 RELEASE NOTES
+-----------------------------------------
The Apache Commons Codec component contains encoder and decoders for
various formats such as Base16, Base32, Base64, digest, and Hexadecimal. In addition to these
@@ -8,36 +8,40 @@ collection of phonetic encoding utilities.
Feature and fix release. Requires a minimum of Java 8.
-Changes in this version include:
-
-New features:
-o Add Maven property project.build.outputTimestamp for build reproducibility. Thanks to Gary Gregory.
-
-Fixed Bugs:
-o CODEC-295: Test clean ups. Thanks to Gary Gregory.
-o [StepSecurity] ci: Harden GitHub Actions #187. Thanks to step-security-bot, Gary Gregory.
-o CODEC-295: Correct error in Base64 Javadoc #188. Thanks to Evan Saulpaugh.
-o CODEC-295: Add minimum Java version in changes.xml #186. Thanks to Olivier Jaquemet, Gary Gregory.
-o CODEC-310: Documentation update for the org.apache.commons.codec.digest.* package #208. Thanks to Yakov Shafranovich.
-o Precompile regular expression in UnixCrypt.crypt(byte[], String). Thanks to Gary Gregory.
-o CODEC-315: Fix possible IndexOutOfBoundException in PhoneticEngine.encode method #223. Thanks to Arthur Chan, Gary Gregory.
-o CODEC-313: Fix possible ArrayIndexOutOfBoundsException in QuotedPrintableCodec.encodeQuotedPrintable() method #221. Thanks to Arthur Chan, Gary Gregory.
-o CODEC-312: Fix possible StringIndexOutOfBoundException in MatchRatingApproachEncoder.encode() method #220. Thanks to Arthur Chan, Gary Gregory.
-o CODEC-311: Fix possible ArrayIndexOutOfBoundException in RefinedSoundex.getMappingCode() #219. Thanks to Arthur Chan, Gary Gregory.
-o CODEC-314: Fix possible IndexOutOfBoundsException in PercentCodec.insertAlwaysEncodeChars() method #222. Thanks to Arthur Chan, Gary Gregory.
-o Deprecate UnixCrypt 0-argument constructor. Thanks to Gary Gregory.
-o Deprecate Md5Crypt 0-argument constructor. Thanks to Gary Gregory.
-o Deprecate Crypt 0-argument constructor. Thanks to Gary Gregory.
-o Deprecate StringUtils 0-argument constructor. Thanks to Gary Gregory.
-o Deprecate Resources 0-argument constructor. Thanks to Gary Gregory.
-o Deprecate Charsets 0-argument constructor. Thanks to Gary Gregory.
-o Deprecate CharEncoding 0-argument constructor. Thanks to Gary Gregory.
-o Add missing version for animal-sniffer-maven-plugin. Thanks to Gary Gregory.
-
-Changes:
-o Bump commons-parent from 58 to 66. Thanks to Dependabot, Gary Gregory.
-o Bump commons-lang3 from 3.12.0 to 3.14.0. Thanks to Gary Gregory.
-o Bump commons-io from 2.13.0 to 2.15.1. Thanks to Gary Gregory.
+New features
+------------
+
+* Add Maven property project.build.outputTimestamp for build reproducibility. Thanks to Gary Gregory.
+
+Fixed Bugs
+----------
+
+* CODEC-295: Test clean ups. Thanks to Gary Gregory.
+* [StepSecurity] ci: Harden GitHub Actions #187. Thanks to step-security-bot, Gary Gregory.
+* CODEC-295: Correct error in Base64 Javadoc #188. Thanks to Evan Saulpaugh.
+* CODEC-295: Add minimum Java version in changes.xml #186. Thanks to Olivier Jaquemet, Gary Gregory.
+* CODEC-310: Documentation update for the org.apache.commons.codec.digest.* package #208. Thanks to Yakov Shafranovich.
+* Precompile regular expression in UnixCrypt.crypt(byte[], String). Thanks to Gary Gregory.
+* CODEC-315: Fix possible IndexOutOfBoundException in PhoneticEngine.encode method #223. Thanks to Arthur Chan, Gary Gregory.
+* CODEC-313: Fix possible ArrayIndexOutOfBoundsException in QuotedPrintableCodec.encodeQuotedPrintable() method #221. Thanks to Arthur Chan, Gary Gregory.
+* CODEC-312: Fix possible StringIndexOutOfBoundException in MatchRatingApproachEncoder.encode() method #220. Thanks to Arthur Chan, Gary Gregory.
+* CODEC-311: Fix possible ArrayIndexOutOfBoundException in RefinedSoundex.getMappingCode() #219. Thanks to Arthur Chan, Gary Gregory.
+* CODEC-314: Fix possible IndexOutOfBoundsException in PercentCodec.insertAlwaysEncodeChars() method #222. Thanks to Arthur Chan, Gary Gregory.
+* Deprecate UnixCrypt 0-argument constructor. Thanks to Gary Gregory.
+* Deprecate Md5Crypt 0-argument constructor. Thanks to Gary Gregory.
+* Deprecate Crypt 0-argument constructor. Thanks to Gary Gregory.
+* Deprecate StringUtils 0-argument constructor. Thanks to Gary Gregory.
+* Deprecate Resources 0-argument constructor. Thanks to Gary Gregory.
+* Deprecate Charsets 0-argument constructor. Thanks to Gary Gregory.
+* Deprecate CharEncoding 0-argument constructor. Thanks to Gary Gregory.
+* Add missing version for animal-sniffer-maven-plugin. Thanks to Gary Gregory.
+
+Changes
+-------
+
+* Bump commons-parent from 58 to 66. Thanks to Dependabot, Gary Gregory.
+* Bump commons-lang3 from 3.12.0 to 3.14.0. Thanks to Gary Gregory.
+* Bump commons-io from 2.13.0 to 2.15.1. Thanks to Gary Gregory.
For complete information on Apache Commons Codec, including instructions on how to submit bug reports,
@@ -60,42 +64,48 @@ Feature and fix release.
Changes in this version include:
-New features:
-o CODEC-296: Add support for Blake3 family of hashes. Thanks to Matt Sicker.
-o Add github/codeql-action.
-
-Fixed Bugs:
-o CODEC-295: Minor improvements #67. Thanks to Arturo Bernal.
-o Remove duplicated words from Javadocs. Thanks to James Gan.
-o CODEC-301: Simplify assertion #84. Thanks to Alexander Pinske, Alex Herbert.
-o CODEC-300: Simplify assertion #84. Thanks to Arturo Bernal.
-o CODEC-298: Use Standard Charset object #82. Thanks to Arturo Bernal.
-o Use String.contains() functions #125. Thanks to Arturo Bernal.
-o Avoid use toString() or substring() in favor of a simplified expression #126. Thanks to Arturo Bernal.
-o CODEC-305: Fix byte-skipping in Base16 decoding #135. Thanks to Florian.
-o Fix several typos, improve writing in some javadocs #139. Thanks to Marc Wrobel.
-o BaseNCodecOutputStream.eof() should not throw IOException. Thanks to Gary Gregory.
-o Javadoc improvements and cleanups. Thanks to Gary Gregory.
-o Deprecate BaseNCodec.isWhiteSpace(byte) and use Character.isWhitespace(int). Thanks to Gary Gregory.
-
-Changes:
-o Bump actions/cache from v2 to v3.0.10 #75, #99, #119, #138, #149, #152. Thanks to Dependabot, Gary Gregory.
-o Bump actions/setup-java from v1.4.1 to 3.5.1 #60, #62, #121. Thanks to Dependabot, Gary Gregory.
-o Bump actions/checkout from 2.3.2 to 3.1.0 #65, #98, #114, #153. Thanks to Dependabot, Gary Gregory.
-o Bump commons-parent from 52 to 58, #147, #165, #170. Thanks to Dependabot, Gary Gregory.
-o CODEC-285: Bump junit from 4.13.1 to 5.9.1 #76, #39, #140, #148. Thanks to Dependabot, John Patrick.
-o Bump Java 7 to 8. Thanks to Gary Gregory.
-o Bump japicmp-maven-plugin from 0.14.3 to 0.17.1. Thanks to Gary Gregory.
-o Bump jacoco-maven-plugin from 0.8.5 to 0.8.8 (Fixes Java 15 builds). Thanks to Gary Gregory.
-o Bump maven-surefire-plugin from 2.22.2 to 3.0.0-M7 #122, #134. Thanks to Gary Gregory.
-o Bump maven-javadoc-plugin from 3.2.0 to 3.4.1. Thanks to Gary Gregory.
-o Bump animal-sniffer-maven-plugin from 1.19 to 1.22. Thanks to Gary Gregory.
-o Bump maven-pmd-plugin from 3.13.0 to 3.19.0, #133, #142, #145. Thanks to Gary Gregory, Dependabot.
-o Bump pmd from 6.47.0 to 6.52.0. Thanks to Gary Gregory.
-o Bump maven-checkstyle-plugin from 2.17 to 3.2.0 #143. Thanks to Gary Gregory.
-o Bump checkstyle from 8.45.1 to 9.3 #97, #100, #101, #103. Thanks to Dependabot.
-o Bump taglist-maven-plugin from 2.4 to 3.0.0 #102. Thanks to Dependabot.
-o Bump jacoco-maven-plugin from 0.8.7 to 0.8.8. Thanks to Gary Gregory.
+New features
+------------
+
+* CODEC-296: Add support for Blake3 family of hashes. Thanks to Matt Sicker.
+* Add github/codeql-action.
+
+Fixed Bugs
+----------
+
+* CODEC-295: Minor improvements #67. Thanks to Arturo Bernal.
+* Remove duplicated words from Javadocs. Thanks to James Gan.
+* CODEC-301: Simplify assertion #84. Thanks to Alexander Pinske, Alex Herbert.
+* CODEC-300: Simplify assertion #84. Thanks to Arturo Bernal.
+* CODEC-298: Use Standard Charset object #82. Thanks to Arturo Bernal.
+* Use String.contains() functions #125. Thanks to Arturo Bernal.
+* Avoid use toString() or substring() in favor of a simplified expression #126. Thanks to Arturo Bernal.
+* CODEC-305: Fix byte-skipping in Base16 decoding #135. Thanks to Florian.
+* Fix several typos, improve writing in some javadocs #139. Thanks to Marc Wrobel.
+* BaseNCodecOutputStream.eof() should not throw IOException. Thanks to Gary Gregory.
+* Javadoc improvements and cleanups. Thanks to Gary Gregory.
+* Deprecate BaseNCodec.isWhiteSpace(byte) and use Character.isWhitespace(int). Thanks to Gary Gregory.
+
+Changes
+-------
+
+* Bump actions/cache from v2 to v3.0.10 #75, #99, #119, #138, #149, #152. Thanks to Dependabot, Gary Gregory.
+* Bump actions/setup-java from v1.4.1 to 3.5.1 #60, #62, #121. Thanks to Dependabot, Gary Gregory.
+* Bump actions/checkout from 2.3.2 to 3.1.0 #65, #98, #114, #153. Thanks to Dependabot, Gary Gregory.
+* Bump commons-parent from 52 to 58, #147, #165, #170. Thanks to Dependabot, Gary Gregory.
+* CODEC-285: Bump junit from 4.13.1 to 5.9.1 #76, #39, #140, #148. Thanks to Dependabot, John Patrick.
+* Bump Java 7 to 8. Thanks to Gary Gregory.
+* Bump japicmp-maven-plugin from 0.14.3 to 0.17.1. Thanks to Gary Gregory.
+* Bump jacoco-maven-plugin from 0.8.5 to 0.8.8 (Fixes Java 15 builds). Thanks to Gary Gregory.
+* Bump maven-surefire-plugin from 2.22.2 to 3.0.0-M7 #122, #134. Thanks to Gary Gregory.
+* Bump maven-javadoc-plugin from 3.2.0 to 3.4.1. Thanks to Gary Gregory.
+* Bump animal-sniffer-maven-plugin from 1.19 to 1.22. Thanks to Gary Gregory.
+* Bump maven-pmd-plugin from 3.13.0 to 3.19.0, #133, #142, #145. Thanks to Gary Gregory, Dependabot.
+* Bump pmd from 6.47.0 to 6.52.0. Thanks to Gary Gregory.
+* Bump maven-checkstyle-plugin from 2.17 to 3.2.0 #143. Thanks to Gary Gregory.
+* Bump checkstyle from 8.45.1 to 9.3 #97, #100, #101, #103. Thanks to Dependabot.
+* Bump taglist-maven-plugin from 2.4 to 3.0.0 #102. Thanks to Dependabot.
+* Bump jacoco-maven-plugin from 0.8.7 to 0.8.8. Thanks to Gary Gregory.
For complete information on Apache Commons Codec, including instructions on how to submit bug reports,
@@ -104,3 +114,5 @@ patches, or suggestions for improvement, see the Apache Commons Codec website:
https://commons.apache.org/proper/commons-codec/
Download page: https://commons.apache.org/proper/commons-codec/download_codec.cgi
+
+---------------------------------------------------------------------------------
diff --git a/src/changes/release-notes.vm b/src/changes/release-notes.vm
index cce5c5a738..92fe6ee805 100644
--- a/src/changes/release-notes.vm
+++ b/src/changes/release-notes.vm
@@ -14,8 +14,8 @@
## KIND, either express or implied. See the License for the
## specific language governing permissions and limitations
## under the License.
-${project.name} ${version}
-RELEASE NOTES
+${project.name} ${version} RELEASE NOTES
+-----------------------------------------
$introduction.replaceAll("(?
Date: Mon, 15 Apr 2024 23:53:07 +0200
Subject: [PATCH 51/99] Custom alphabet for Base64 (#266)
* add custom alphabet for Base64
* checkstyle
* revert table name, improve javadoc, add constants
* Add missing Javadoc tag
---------
Co-authored-by: Gary Gregory
---
.../apache/commons/codec/binary/Base64.java | 89 +++++++++++++++++--
.../commons/codec/binary/Base64Test.java | 50 +++++++++++
2 files changed, 131 insertions(+), 8 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64.java b/src/main/java/org/apache/commons/codec/binary/Base64.java
index 9046259a03..7fffc9f942 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -18,6 +18,7 @@
package org.apache.commons.codec.binary;
import java.math.BigInteger;
+import java.util.Arrays;
import java.util.Objects;
import org.apache.commons.codec.CodecPolicy;
@@ -63,6 +64,8 @@ public class Base64 extends BaseNCodec {
private static final int BITS_PER_ENCODED_BYTE = 6;
private static final int BYTES_PER_UNENCODED_BLOCK = 3;
private static final int BYTES_PER_ENCODED_BLOCK = 4;
+ private static final int ALPHABET_LENGTH = 64;
+ private static final int DECODING_TABLE_LENGTH = 256;
/**
* This array is a lookup table that translates 6-bit positive integer index values into their "Base64 Alphabet"
@@ -413,14 +416,17 @@ static byte[] toIntegerBytes(final BigInteger bigInt) {
}
/**
- * Encode table to use: either STANDARD or URL_SAFE. Note: the DECODE_TABLE above remains static because it is able
+ * Encode table to use: either STANDARD or URL_SAFE or custom.
+ * Note: the DECODE_TABLE above remains static because it is able
* to decode both STANDARD and URL_SAFE streams, but the encodeTable must be a member variable so we can switch
* between the two modes.
*/
private final byte[] encodeTable;
- /** Only one decode table currently; keep for consistency with Base32 code. */
- private final byte[] decodeTable = DECODE_TABLE;
+ /**
+ * Decode table to use.
+ */
+ private final byte[] decodeTable;
/**
* Line separator for encoding. Not used when decoding. Only used if lineLength > 0.
@@ -550,7 +556,19 @@ public Base64(final int lineLength, final byte[] lineSeparator) {
* @since 1.4
*/
public Base64(final int lineLength, final byte[] lineSeparator, final boolean urlSafe) {
- this(lineLength, lineSeparator, urlSafe, DECODING_POLICY_DEFAULT);
+ this(lineLength, lineSeparator, urlSafe ? URL_SAFE_ENCODE_TABLE : STANDARD_ENCODE_TABLE, DECODING_POLICY_DEFAULT);
+ }
+
+
+ /**
+ * Creates a Base64 codec used for decoding and encoding with non-standard encodeTable-table
+ *
+ * @param encodeTable
+ * The manual encodeTable - a byte array of 64 chars
+ * @since 1.17.0
+ */
+ public Base64(byte[] encodeTable) {
+ this(0, CHUNK_SEPARATOR, encodeTable, DECODING_POLICY_DEFAULT);
}
/**
@@ -581,13 +599,54 @@ public Base64(final int lineLength, final byte[] lineSeparator, final boolean ur
* Thrown when the {@code lineSeparator} contains Base64 characters.
* @since 1.15
*/
- public Base64(final int lineLength, final byte[] lineSeparator, final boolean urlSafe,
+ public Base64(final int lineLength, final byte[] lineSeparator, boolean urlSafe,
+ final CodecPolicy decodingPolicy) {
+ this(lineLength, lineSeparator, urlSafe ? URL_SAFE_ENCODE_TABLE : STANDARD_ENCODE_TABLE, decodingPolicy);
+ }
+
+ /**
+ * Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
+ *
+ * When encoding the line length and line separator are given in the constructor, and the encoding table is
+ * STANDARD_ENCODE_TABLE.
+ *
+ *
+ * Line lengths that aren't multiples of 4 will still essentially end up being multiples of 4 in the encoded data.
+ *
+ *
+ * When decoding all variants are supported.
+ *
+ *
+ * @param lineLength
+ * Each line of encoded data will be at most of the given length (rounded down to the nearest multiple of
+ * 4). If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when
+ * decoding.
+ * @param lineSeparator
+ * Each line of encoded data will end with this sequence of bytes.
+ * @param encodeTable
+ * The manual encodeTable - a byte array of 64 chars.
+ * @param decodingPolicy The decoding policy.
+ * @throws IllegalArgumentException
+ * Thrown when the {@code lineSeparator} contains Base64 characters.
+ * @since 1.17.0
+ */
+ public Base64(final int lineLength, final byte[] lineSeparator, final byte[] encodeTable,
final CodecPolicy decodingPolicy) {
super(BYTES_PER_UNENCODED_BLOCK, BYTES_PER_ENCODED_BLOCK,
lineLength,
lineSeparator == null ? 0 : lineSeparator.length,
PAD_DEFAULT,
decodingPolicy);
+ this.encodeTable = encodeTable;
+
+ if (encodeTable == STANDARD_ENCODE_TABLE || encodeTable == URL_SAFE_ENCODE_TABLE) {
+ decodeTable = DECODE_TABLE;
+ } else {
+ if (encodeTable.length != ALPHABET_LENGTH) {
+ throw new IllegalArgumentException("encodeTable must be exactly 64 bytes long");
+ }
+ decodeTable = calculateDecodeTable(encodeTable);
+ }
// TODO could be simplified if there is no requirement to reject invalid line sep when length <=0
// @see test case Base64Test.testConstructors()
if (lineSeparator != null) {
@@ -607,7 +666,6 @@ public Base64(final int lineLength, final byte[] lineSeparator, final boolean ur
this.lineSeparator = null;
}
this.decodeSize = this.encodeSize - 1;
- this.encodeTable = urlSafe ? URL_SAFE_ENCODE_TABLE : STANDARD_ENCODE_TABLE;
}
// Implementation of the Encoder Interface
@@ -653,8 +711,8 @@ void decode(final byte[] input, int inPos, final int inAvail, final Context cont
context.eof = true;
break;
}
- if (b >= 0 && b < DECODE_TABLE.length) {
- final int result = DECODE_TABLE[b];
+ if (b >= 0 && b < decodeTable.length) {
+ final int result = decodeTable[b];
if (result >= 0) {
context.modulus = (context.modulus + 1) % BYTES_PER_ENCODED_BLOCK;
context.ibitWorkArea = (context.ibitWorkArea << BITS_PER_ENCODED_BYTE) + result;
@@ -802,6 +860,21 @@ protected boolean isInAlphabet(final byte octet) {
return octet >= 0 && octet < decodeTable.length && decodeTable[octet] != -1;
}
+ /**
+ * Calculates a decode table for a given encode table.
+ *
+ * @param encodeTable that is used to determine decode lookup table
+ * @return decodeTable
+ */
+ private byte[] calculateDecodeTable(byte[] encodeTable) {
+ byte[] decodeTable = new byte[DECODING_TABLE_LENGTH];
+ Arrays.fill(decodeTable, (byte) -1);
+ for (int i = 0; i < encodeTable.length; i++) {
+ decodeTable[encodeTable[i]] = (byte) i;
+ }
+ return decodeTable;
+ }
+
/**
* Returns our current encode mode. True if we're URL-SAFE, false otherwise.
*
diff --git a/src/test/java/org/apache/commons/codec/binary/Base64Test.java b/src/test/java/org/apache/commons/codec/binary/Base64Test.java
index 7919ea8859..6626a9188d 100644
--- a/src/test/java/org/apache/commons/codec/binary/Base64Test.java
+++ b/src/test/java/org/apache/commons/codec/binary/Base64Test.java
@@ -167,6 +167,56 @@ public void testBase64() {
assertEquals("Hello World", decodeString, "decode hello world");
}
+ @Test
+ public void testCustomEncodingAlphabet_illegal() {
+ byte[] encodeTable = {
+ '.', '-', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M'
+ };
+ assertThrows(IllegalArgumentException.class, () -> new Base64(encodeTable));
+ }
+
+ @Test
+ public void testCustomEncodingAlphabet() {
+ // created a duplicate of STANDARD_ENCODE_TABLE and replaced two chars with
+ // custom values not already present in table
+ // A => . B => -
+ byte[] encodeTable = {
+ '.', '-', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M',
+ 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z',
+ 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm',
+ 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z',
+ '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '+', '/'
+ };
+
+ // two instances: one with default table and one with adjusted encoding table
+ Base64 b64 = new Base64();
+ Base64 b64customEncoding = new Base64(encodeTable);
+
+ final String content = "! Hello World - this §$%";
+
+ byte[] encodedBytes = b64.encode(StringUtils.getBytesUtf8(content));
+ String encodedContent = StringUtils.newStringUtf8(encodedBytes);
+
+ byte[] encodedBytesCustom = b64customEncoding.encode(StringUtils.getBytesUtf8(content));
+ String encodedContentCustom = StringUtils.newStringUtf8(encodedBytesCustom);
+
+ assertTrue(
+ encodedContent.contains("A") && encodedContent.contains("B"), "testing precondition not met - ecodedContent should contain parts of modified table");
+
+ assertEquals(
+ encodedContent
+ .replaceAll("A", ".").replaceAll("B", "-") // replace alphabet adjustments
+ .replaceAll("=", "") // remove padding (not default alphabet)
+ , encodedContentCustom);
+
+
+ // try decode encoded content
+ final byte[] decode = b64customEncoding.decode(encodedBytesCustom);
+ final String decodeString = StringUtils.newStringUtf8(decode);
+
+ assertEquals(content, decodeString);
+ }
+
@Test
public void testBase64AtBufferEnd() {
testBase64InBuffer(100, 0);
From d2b2bf599c8320c4fd4fa44b30fb8c032d1985dc Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Mon, 15 Apr 2024 17:54:16 -0400
Subject: [PATCH 52/99] Allow custom alphabets for Base64 #266
---
src/changes/changes.xml | 1 +
1 file changed, 1 insertion(+)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index fce3fe9570..8dc5fb1cbc 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -46,6 +46,7 @@ The type attribute can be add,update,fix,remove.
Add override org.apache.commons.codec.language.bm.Rule.PhonemeExpr.size().
+ Allow custom alphabets for Base64 #266.
Optimize memory allocation in PhoneticEngine.
BCodec and QCodec encode() methods throw UnsupportedCharsetException instead of EncoderException.
From 17d28c19bb872b7cffcb35831e4c15fc27417da1 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Mon, 15 Apr 2024 17:56:39 -0400
Subject: [PATCH 53/99] Sort members
---
.../apache/commons/codec/binary/Base64.java | 54 +++++-----
.../commons/codec/binary/Base64Test.java | 100 +++++++++---------
2 files changed, 77 insertions(+), 77 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64.java b/src/main/java/org/apache/commons/codec/binary/Base64.java
index 7fffc9f942..a5383d0f60 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -478,6 +478,17 @@ public Base64(final boolean urlSafe) {
this(MIME_CHUNK_SIZE, CHUNK_SEPARATOR, urlSafe);
}
+ /**
+ * Creates a Base64 codec used for decoding and encoding with non-standard encodeTable-table
+ *
+ * @param encodeTable
+ * The manual encodeTable - a byte array of 64 chars
+ * @since 1.17.0
+ */
+ public Base64(byte[] encodeTable) {
+ this(0, CHUNK_SEPARATOR, encodeTable, DECODING_POLICY_DEFAULT);
+ }
+
/**
* Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
*
@@ -528,6 +539,7 @@ public Base64(final int lineLength, final byte[] lineSeparator) {
this(lineLength, lineSeparator, false);
}
+
/**
* Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
*
@@ -559,18 +571,6 @@ public Base64(final int lineLength, final byte[] lineSeparator, final boolean ur
this(lineLength, lineSeparator, urlSafe ? URL_SAFE_ENCODE_TABLE : STANDARD_ENCODE_TABLE, DECODING_POLICY_DEFAULT);
}
-
- /**
- * Creates a Base64 codec used for decoding and encoding with non-standard encodeTable-table
- *
- * @param encodeTable
- * The manual encodeTable - a byte array of 64 chars
- * @since 1.17.0
- */
- public Base64(byte[] encodeTable) {
- this(0, CHUNK_SEPARATOR, encodeTable, DECODING_POLICY_DEFAULT);
- }
-
/**
* Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
*
@@ -670,6 +670,21 @@ public Base64(final int lineLength, final byte[] lineSeparator, final byte[] enc
// Implementation of the Encoder Interface
+ /**
+ * Calculates a decode table for a given encode table.
+ *
+ * @param encodeTable that is used to determine decode lookup table
+ * @return decodeTable
+ */
+ private byte[] calculateDecodeTable(byte[] encodeTable) {
+ byte[] decodeTable = new byte[DECODING_TABLE_LENGTH];
+ Arrays.fill(decodeTable, (byte) -1);
+ for (int i = 0; i < encodeTable.length; i++) {
+ decodeTable[encodeTable[i]] = (byte) i;
+ }
+ return decodeTable;
+ }
+
/**
*
* Decodes all of the provided data, starting at inPos, for inAvail bytes. Should be called at least twice: once
@@ -860,21 +875,6 @@ protected boolean isInAlphabet(final byte octet) {
return octet >= 0 && octet < decodeTable.length && decodeTable[octet] != -1;
}
- /**
- * Calculates a decode table for a given encode table.
- *
- * @param encodeTable that is used to determine decode lookup table
- * @return decodeTable
- */
- private byte[] calculateDecodeTable(byte[] encodeTable) {
- byte[] decodeTable = new byte[DECODING_TABLE_LENGTH];
- Arrays.fill(decodeTable, (byte) -1);
- for (int i = 0; i < encodeTable.length; i++) {
- decodeTable[encodeTable[i]] = (byte) i;
- }
- return decodeTable;
- }
-
/**
* Returns our current encode mode. True if we're URL-SAFE, false otherwise.
*
diff --git a/src/test/java/org/apache/commons/codec/binary/Base64Test.java b/src/test/java/org/apache/commons/codec/binary/Base64Test.java
index 6626a9188d..b4c35d76ec 100644
--- a/src/test/java/org/apache/commons/codec/binary/Base64Test.java
+++ b/src/test/java/org/apache/commons/codec/binary/Base64Test.java
@@ -167,56 +167,6 @@ public void testBase64() {
assertEquals("Hello World", decodeString, "decode hello world");
}
- @Test
- public void testCustomEncodingAlphabet_illegal() {
- byte[] encodeTable = {
- '.', '-', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M'
- };
- assertThrows(IllegalArgumentException.class, () -> new Base64(encodeTable));
- }
-
- @Test
- public void testCustomEncodingAlphabet() {
- // created a duplicate of STANDARD_ENCODE_TABLE and replaced two chars with
- // custom values not already present in table
- // A => . B => -
- byte[] encodeTable = {
- '.', '-', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M',
- 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z',
- 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm',
- 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z',
- '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '+', '/'
- };
-
- // two instances: one with default table and one with adjusted encoding table
- Base64 b64 = new Base64();
- Base64 b64customEncoding = new Base64(encodeTable);
-
- final String content = "! Hello World - this §$%";
-
- byte[] encodedBytes = b64.encode(StringUtils.getBytesUtf8(content));
- String encodedContent = StringUtils.newStringUtf8(encodedBytes);
-
- byte[] encodedBytesCustom = b64customEncoding.encode(StringUtils.getBytesUtf8(content));
- String encodedContentCustom = StringUtils.newStringUtf8(encodedBytesCustom);
-
- assertTrue(
- encodedContent.contains("A") && encodedContent.contains("B"), "testing precondition not met - ecodedContent should contain parts of modified table");
-
- assertEquals(
- encodedContent
- .replaceAll("A", ".").replaceAll("B", "-") // replace alphabet adjustments
- .replaceAll("=", "") // remove padding (not default alphabet)
- , encodedContentCustom);
-
-
- // try decode encoded content
- final byte[] decode = b64customEncoding.decode(encodedBytesCustom);
- final String decodeString = StringUtils.newStringUtf8(decode);
-
- assertEquals(content, decodeString);
- }
-
@Test
public void testBase64AtBufferEnd() {
testBase64InBuffer(100, 0);
@@ -465,6 +415,56 @@ public void testConstructors() {
assertNotNull(base64);
}
+ @Test
+ public void testCustomEncodingAlphabet() {
+ // created a duplicate of STANDARD_ENCODE_TABLE and replaced two chars with
+ // custom values not already present in table
+ // A => . B => -
+ byte[] encodeTable = {
+ '.', '-', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M',
+ 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z',
+ 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm',
+ 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z',
+ '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '+', '/'
+ };
+
+ // two instances: one with default table and one with adjusted encoding table
+ Base64 b64 = new Base64();
+ Base64 b64customEncoding = new Base64(encodeTable);
+
+ final String content = "! Hello World - this §$%";
+
+ byte[] encodedBytes = b64.encode(StringUtils.getBytesUtf8(content));
+ String encodedContent = StringUtils.newStringUtf8(encodedBytes);
+
+ byte[] encodedBytesCustom = b64customEncoding.encode(StringUtils.getBytesUtf8(content));
+ String encodedContentCustom = StringUtils.newStringUtf8(encodedBytesCustom);
+
+ assertTrue(
+ encodedContent.contains("A") && encodedContent.contains("B"), "testing precondition not met - ecodedContent should contain parts of modified table");
+
+ assertEquals(
+ encodedContent
+ .replaceAll("A", ".").replaceAll("B", "-") // replace alphabet adjustments
+ .replaceAll("=", "") // remove padding (not default alphabet)
+ , encodedContentCustom);
+
+
+ // try decode encoded content
+ final byte[] decode = b64customEncoding.decode(encodedBytesCustom);
+ final String decodeString = StringUtils.newStringUtf8(decode);
+
+ assertEquals(content, decodeString);
+ }
+
+ @Test
+ public void testCustomEncodingAlphabet_illegal() {
+ byte[] encodeTable = {
+ '.', '-', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M'
+ };
+ assertThrows(IllegalArgumentException.class, () -> new Base64(encodeTable));
+ }
+
private void testDecodeEncode(final String encodedText) {
final String decodedText = StringUtils.newStringUsAscii(Base64.decodeBase64(encodedText));
final String encodedText2 = Base64.encodeBase64String(StringUtils.getBytesUtf8(decodedText));
From 0856a13762c2f2a60a081064d37af2ff92c8b6d4 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Mon, 15 Apr 2024 18:00:34 -0400
Subject: [PATCH 54/99] Use final
- Use better APIs
- Formatting
---
.../apache/commons/codec/binary/Base64.java | 8 ++---
.../commons/codec/binary/Base64Test.java | 31 +++++++++----------
2 files changed, 19 insertions(+), 20 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64.java b/src/main/java/org/apache/commons/codec/binary/Base64.java
index a5383d0f60..79b3172131 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -485,7 +485,7 @@ public Base64(final boolean urlSafe) {
* The manual encodeTable - a byte array of 64 chars
* @since 1.17.0
*/
- public Base64(byte[] encodeTable) {
+ public Base64(final byte[] encodeTable) {
this(0, CHUNK_SEPARATOR, encodeTable, DECODING_POLICY_DEFAULT);
}
@@ -599,7 +599,7 @@ public Base64(final int lineLength, final byte[] lineSeparator, final boolean ur
* Thrown when the {@code lineSeparator} contains Base64 characters.
* @since 1.15
*/
- public Base64(final int lineLength, final byte[] lineSeparator, boolean urlSafe,
+ public Base64(final int lineLength, final byte[] lineSeparator, final boolean urlSafe,
final CodecPolicy decodingPolicy) {
this(lineLength, lineSeparator, urlSafe ? URL_SAFE_ENCODE_TABLE : STANDARD_ENCODE_TABLE, decodingPolicy);
}
@@ -676,8 +676,8 @@ public Base64(final int lineLength, final byte[] lineSeparator, final byte[] enc
* @param encodeTable that is used to determine decode lookup table
* @return decodeTable
*/
- private byte[] calculateDecodeTable(byte[] encodeTable) {
- byte[] decodeTable = new byte[DECODING_TABLE_LENGTH];
+ private byte[] calculateDecodeTable(final byte[] encodeTable) {
+ final byte[] decodeTable = new byte[DECODING_TABLE_LENGTH];
Arrays.fill(decodeTable, (byte) -1);
for (int i = 0; i < encodeTable.length; i++) {
decodeTable[encodeTable[i]] = (byte) i;
diff --git a/src/test/java/org/apache/commons/codec/binary/Base64Test.java b/src/test/java/org/apache/commons/codec/binary/Base64Test.java
index b4c35d76ec..4b6d377392 100644
--- a/src/test/java/org/apache/commons/codec/binary/Base64Test.java
+++ b/src/test/java/org/apache/commons/codec/binary/Base64Test.java
@@ -419,37 +419,36 @@ public void testConstructors() {
public void testCustomEncodingAlphabet() {
// created a duplicate of STANDARD_ENCODE_TABLE and replaced two chars with
// custom values not already present in table
- // A => . B => -
- byte[] encodeTable = {
+ // A => . B => -
+ // @formatter:off
+ final byte[] encodeTable = {
'.', '-', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M',
'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z',
'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm',
'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z',
'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '+', '/'
};
+ // @formatter:on
// two instances: one with default table and one with adjusted encoding table
- Base64 b64 = new Base64();
- Base64 b64customEncoding = new Base64(encodeTable);
+ final Base64 b64 = new Base64();
+ final Base64 b64customEncoding = new Base64(encodeTable);
final String content = "! Hello World - this §$%";
- byte[] encodedBytes = b64.encode(StringUtils.getBytesUtf8(content));
- String encodedContent = StringUtils.newStringUtf8(encodedBytes);
+ final byte[] encodedBytes = b64.encode(StringUtils.getBytesUtf8(content));
+ final String encodedContent = StringUtils.newStringUtf8(encodedBytes);
- byte[] encodedBytesCustom = b64customEncoding.encode(StringUtils.getBytesUtf8(content));
- String encodedContentCustom = StringUtils.newStringUtf8(encodedBytesCustom);
+ final byte[] encodedBytesCustom = b64customEncoding.encode(StringUtils.getBytesUtf8(content));
+ final String encodedContentCustom = StringUtils.newStringUtf8(encodedBytesCustom);
- assertTrue(
- encodedContent.contains("A") && encodedContent.contains("B"), "testing precondition not met - ecodedContent should contain parts of modified table");
+ assertTrue(encodedContent.contains("A") && encodedContent.contains("B"),
+ "testing precondition not met - ecodedContent should contain parts of modified table");
- assertEquals(
- encodedContent
- .replaceAll("A", ".").replaceAll("B", "-") // replace alphabet adjustments
- .replaceAll("=", "") // remove padding (not default alphabet)
+ assertEquals(encodedContent.replace('A', '.').replace('B', '-') // replace alphabet adjustments
+ .replace("=", "") // remove padding (not default alphabet)
, encodedContentCustom);
-
// try decode encoded content
final byte[] decode = b64customEncoding.decode(encodedBytesCustom);
final String decodeString = StringUtils.newStringUtf8(decode);
@@ -459,7 +458,7 @@ public void testCustomEncodingAlphabet() {
@Test
public void testCustomEncodingAlphabet_illegal() {
- byte[] encodeTable = {
+ final byte[] encodeTable = {
'.', '-', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M'
};
assertThrows(IllegalArgumentException.class, () -> new Base64(encodeTable));
From d9d45f676ea2f01b6f5803fd0facbc840b937aa0 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Mon, 15 Apr 2024 18:06:53 -0400
Subject: [PATCH 55/99] Refactor instance variables that act like temps into
locals
---
.../java/org/apache/commons/codec/binary/Base32.java | 11 +----------
1 file changed, 1 insertion(+), 10 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/Base32.java b/src/main/java/org/apache/commons/codec/binary/Base32.java
index 9c3ac7ee32..3bc44f082b 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32.java
@@ -132,12 +132,6 @@ public class Base32 extends BaseNCodec {
// The private member fields below are used with the new streaming approach, which requires
// some state be preserved between calls of encode() and decode().
- /**
- * Convenience variable to help us determine when our buffer is going to run out of room and needs resizing. {@code decodeSize = {@link
- * #BYTES_PER_ENCODED_BLOCK} - 1 + lineSeparator.length;}
- */
- private final int decodeSize;
-
/**
* Decode table to use.
*/
@@ -318,8 +312,6 @@ public Base32(final int lineLength, final byte[] lineSeparator, final boolean us
this.encodeSize = BYTES_PER_ENCODED_BLOCK;
this.lineSeparator = null;
}
- this.decodeSize = this.encodeSize - 1;
-
if (isInAlphabet(padding) || Character.isWhitespace(padding)) {
throw new IllegalArgumentException("pad must not be in alphabet or whitespace");
}
@@ -347,13 +339,13 @@ public Base32(final int lineLength, final byte[] lineSeparator, final boolean us
@Override
void decode(final byte[] input, int inPos, final int inAvail, final Context context) {
// package protected for access from I/O streams
-
if (context.eof) {
return;
}
if (inAvail < 0) {
context.eof = true;
}
+ final int decodeSize = this.encodeSize - 1;
for (int i = 0; i < inAvail; i++) {
final byte b = input[inPos++];
if (b == pad) {
@@ -378,7 +370,6 @@ void decode(final byte[] input, int inPos, final int inAvail, final Context cont
}
}
}
-
// Two forms of EOF as far as Base32 decoder is concerned: actual
// EOF (-1) and first time '=' character is encountered in stream.
// This approach makes the '=' padding characters completely optional.
From 19bb1933490cd315d2cb739661c6d5bca6e56624 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Mon, 15 Apr 2024 18:07:01 -0400
Subject: [PATCH 56/99] Refactor instance variables that act like temps into
locals
---
src/main/java/org/apache/commons/codec/binary/Base64.java | 8 +-------
1 file changed, 1 insertion(+), 7 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64.java b/src/main/java/org/apache/commons/codec/binary/Base64.java
index 79b3172131..775a75a7ac 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -433,12 +433,6 @@ static byte[] toIntegerBytes(final BigInteger bigInt) {
*/
private final byte[] lineSeparator;
- /**
- * Convenience variable to help us determine when our buffer is going to run out of room and needs resizing.
- * {@code decodeSize = 3 + lineSeparator.length;}
- */
- private final int decodeSize;
-
/**
* Convenience variable to help us determine when our buffer is going to run out of room and needs resizing.
* {@code encodeSize = 4 + lineSeparator.length;}
@@ -665,7 +659,6 @@ public Base64(final int lineLength, final byte[] lineSeparator, final byte[] enc
this.encodeSize = BYTES_PER_ENCODED_BLOCK;
this.lineSeparator = null;
}
- this.decodeSize = this.encodeSize - 1;
}
// Implementation of the Encoder Interface
@@ -718,6 +711,7 @@ void decode(final byte[] input, int inPos, final int inAvail, final Context cont
if (inAvail < 0) {
context.eof = true;
}
+ final int decodeSize = this.encodeSize - 1;
for (int i = 0; i < inAvail; i++) {
final byte[] buffer = ensureBufferSize(decodeSize, context);
final byte b = input[inPos++];
From 25c95b1b9863973283600bc8f980f4bf92e9829f Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Tue, 16 Apr 2024 09:40:26 -0400
Subject: [PATCH 57/99] Add Base64.Builder (allows custom alphabets)
---
src/changes/changes.xml | 3 +-
.../apache/commons/codec/binary/Base64.java | 135 ++++++++++++++----
.../commons/codec/binary/Base64Test.java | 47 ++++--
3 files changed, 149 insertions(+), 36 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 8dc5fb1cbc..a609aaeef8 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -46,7 +46,8 @@ The type attribute can be add,update,fix,remove.
Add override org.apache.commons.codec.language.bm.Rule.PhonemeExpr.size().
- Allow custom alphabets for Base64 #266.
+ Add support for Base64 custom alphabets #266.
+ Add Base64.Builder (allows custom alphabets).
Optimize memory allocation in PhoneticEngine.
BCodec and QCodec encode() methods throw UnsupportedCharsetException instead of EncoderException.
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64.java b/src/main/java/org/apache/commons/codec/binary/Base64.java
index 775a75a7ac..76db3ddb60 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -20,6 +20,7 @@
import java.math.BigInteger;
import java.util.Arrays;
import java.util.Objects;
+import java.util.function.Supplier;
import org.apache.commons.codec.CodecPolicy;
@@ -56,6 +57,80 @@
*/
public class Base64 extends BaseNCodec {
+ /**
+ * Builds {@link Base64} instances.
+ *
+ * @since 1.17.0
+ */
+ public static class Builder implements Supplier {
+
+ private int lineLength;
+ private byte[] lineSeparator = CHUNK_SEPARATOR;
+ private byte[] encodeTable = STANDARD_ENCODE_TABLE;
+ private CodecPolicy decodingPolicy = DECODING_POLICY_DEFAULT;
+
+ @Override
+ public Base64 get() {
+ return new Base64(lineLength, lineSeparator, encodeTable, decodingPolicy);
+ }
+
+ /**
+ * Sets the decoding policy.
+ *
+ * @param decodingPolicy the decoding policy, null resets to the default.
+ * @return this.
+ */
+ public Builder setDecodingPolicy(final CodecPolicy decodingPolicy) {
+ this.decodingPolicy = decodingPolicy != null ? decodingPolicy : DECODING_POLICY_DEFAULT;
+ return this;
+ }
+
+ /**
+ * Sets the encode table.
+ *
+ * @param encodeTable the encode table, null resets to the default.
+ * @return this.
+ */
+ public Builder setEncodeTable(final byte... encodeTable) {
+ this.encodeTable = encodeTable != null ? encodeTable : STANDARD_ENCODE_TABLE;
+ return this;
+ }
+
+ /**
+ * Sets the line length.
+ *
+ * @param lineLength the line length, less than 0 resets to the default.
+ * @return this.
+ */
+ public Builder setLineLength(final int lineLength) {
+ this.lineLength = Math.max(0, lineLength);
+ return this;
+ }
+
+ /**
+ * Sets the line separator.
+ *
+ * @param lineSeparator the line separator, null resets to the default.
+ * @return this.
+ */
+ public Builder setLineSeparator(final byte... lineSeparator) {
+ this.lineSeparator = lineSeparator != null ? lineSeparator : CHUNK_SEPARATOR;
+ return this;
+ }
+
+ /**
+ * Sets the URL-safe encoding policy.
+ *
+ * @param urlSafe URL-safe encoding policy, null resets to the default.
+ * @return this.
+ */
+ public Builder setUrlSafe(final boolean urlSafe) {
+ this.encodeTable = toUrlSafeEncodeTable(urlSafe);
+ return this;
+ }
+
+ }
+
/**
* BASE64 characters are 6 bits in length.
* They are formed by taking a block of 3 octets to form a 24-bit string,
@@ -121,19 +196,29 @@ public class Base64 extends BaseNCodec {
41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51 // 70-7a p-z
};
- // The static final fields above are used for the original static byte[] methods on Base64.
- // The private member fields below are used with the new streaming approach, which requires
- // some state be preserved between calls of encode() and decode().
-
/**
* Base64 uses 6-bit fields.
*/
/** Mask used to extract 6 bits, used when encoding */
private static final int MASK_6BITS = 0x3f;
+
+ // The static final fields above are used for the original static byte[] methods on Base64.
+ // The private member fields below are used with the new streaming approach, which requires
+ // some state be preserved between calls of encode() and decode().
+
/** Mask used to extract 4 bits, used when decoding final trailing character. */
private static final int MASK_4BITS = 0xf;
/** Mask used to extract 2 bits, used when decoding final trailing character. */
private static final int MASK_2BITS = 0x3;
+ /**
+ * Creates a new Builder.
+ *
+ * @return a new Builder.
+ * @since 1.17.0
+ */
+ public static Builder builder() {
+ return new Builder();
+ }
/**
* Decodes Base64 data into octets.
@@ -415,6 +500,10 @@ static byte[] toIntegerBytes(final BigInteger bigInt) {
return resizedBytes;
}
+ private static byte[] toUrlSafeEncodeTable(final boolean urlSafe) {
+ return urlSafe ? URL_SAFE_ENCODE_TABLE : STANDARD_ENCODE_TABLE;
+ }
+
/**
* Encode table to use: either STANDARD or URL_SAFE or custom.
* Note: the DECODE_TABLE above remains static because it is able
@@ -472,17 +561,6 @@ public Base64(final boolean urlSafe) {
this(MIME_CHUNK_SIZE, CHUNK_SEPARATOR, urlSafe);
}
- /**
- * Creates a Base64 codec used for decoding and encoding with non-standard encodeTable-table
- *
- * @param encodeTable
- * The manual encodeTable - a byte array of 64 chars
- * @since 1.17.0
- */
- public Base64(final byte[] encodeTable) {
- this(0, CHUNK_SEPARATOR, encodeTable, DECODING_POLICY_DEFAULT);
- }
-
/**
* Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
*
@@ -506,6 +584,7 @@ public Base64(final int lineLength) {
this(lineLength, CHUNK_SEPARATOR);
}
+
/**
* Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
*
@@ -533,7 +612,6 @@ public Base64(final int lineLength, final byte[] lineSeparator) {
this(lineLength, lineSeparator, false);
}
-
/**
* Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
*
@@ -562,7 +640,7 @@ public Base64(final int lineLength, final byte[] lineSeparator) {
* @since 1.4
*/
public Base64(final int lineLength, final byte[] lineSeparator, final boolean urlSafe) {
- this(lineLength, lineSeparator, urlSafe ? URL_SAFE_ENCODE_TABLE : STANDARD_ENCODE_TABLE, DECODING_POLICY_DEFAULT);
+ this(lineLength, lineSeparator, toUrlSafeEncodeTable(urlSafe), DECODING_POLICY_DEFAULT);
}
/**
@@ -595,7 +673,7 @@ public Base64(final int lineLength, final byte[] lineSeparator, final boolean ur
*/
public Base64(final int lineLength, final byte[] lineSeparator, final boolean urlSafe,
final CodecPolicy decodingPolicy) {
- this(lineLength, lineSeparator, urlSafe ? URL_SAFE_ENCODE_TABLE : STANDARD_ENCODE_TABLE, decodingPolicy);
+ this(lineLength, lineSeparator, toUrlSafeEncodeTable(urlSafe), decodingPolicy);
}
/**
@@ -622,16 +700,10 @@ public Base64(final int lineLength, final byte[] lineSeparator, final boolean ur
* @param decodingPolicy The decoding policy.
* @throws IllegalArgumentException
* Thrown when the {@code lineSeparator} contains Base64 characters.
- * @since 1.17.0
*/
- public Base64(final int lineLength, final byte[] lineSeparator, final byte[] encodeTable,
- final CodecPolicy decodingPolicy) {
- super(BYTES_PER_UNENCODED_BLOCK, BYTES_PER_ENCODED_BLOCK,
- lineLength,
- lineSeparator == null ? 0 : lineSeparator.length,
- PAD_DEFAULT,
- decodingPolicy);
- this.encodeTable = encodeTable;
+ private Base64(final int lineLength, final byte[] lineSeparator, final byte[] encodeTable, final CodecPolicy decodingPolicy) {
+ super(BYTES_PER_UNENCODED_BLOCK, BYTES_PER_ENCODED_BLOCK, lineLength, lineSeparator == null ? 0 : lineSeparator.length, PAD_DEFAULT, decodingPolicy);
+ this.encodeTable = Objects.requireNonNull(encodeTable, "encodeTable");
if (encodeTable == STANDARD_ENCODE_TABLE || encodeTable == URL_SAFE_ENCODE_TABLE) {
decodeTable = DECODE_TABLE;
@@ -857,6 +929,15 @@ void encode(final byte[] in, int inPos, final int inAvail, final Context context
}
}
+ /**
+ * Gets the line separator (for testing only).
+ *
+ * @return the line separator.
+ */
+ byte[] getLineSeparator() {
+ return lineSeparator;
+ }
+
/**
* Returns whether or not the {@code octet} is in the Base64 alphabet.
*
diff --git a/src/test/java/org/apache/commons/codec/binary/Base64Test.java b/src/test/java/org/apache/commons/codec/binary/Base64Test.java
index 4b6d377392..3710082457 100644
--- a/src/test/java/org/apache/commons/codec/binary/Base64Test.java
+++ b/src/test/java/org/apache/commons/codec/binary/Base64Test.java
@@ -46,6 +46,10 @@
*/
public class Base64Test {
+ private static final String FOX_BASE64 = "VGhlIH@$#$@%F1aWN@#@#@@rIGJyb3duIGZve\n\r\t%#%#%#%CBqd##$#$W1wZWQgb3ZlciB0aGUgbGF6eSBkb2dzLg==";
+
+ private static final String FOX_TEXT = "The quick brown fox jumped over the lazy dogs.";
+
private static final Charset CHARSET_UTF8 = StandardCharsets.UTF_8;
/**
@@ -216,6 +220,36 @@ private void testBase64InBuffer(final int startPasSize, final int endPadSize) {
assertEquals("SGVsbG8gV29ybGQ=", encodedContent, "encoding hello world");
}
+ @Test
+ public void testBuilderCodecPolicy() {
+ assertEquals(CodecPolicy.LENIENT, Base64.builder().get().getCodecPolicy());
+ assertEquals(CodecPolicy.LENIENT, Base64.builder().setDecodingPolicy(CodecPolicy.LENIENT).get().getCodecPolicy());
+ assertEquals(CodecPolicy.STRICT, Base64.builder().setDecodingPolicy(CodecPolicy.STRICT).get().getCodecPolicy());
+ assertEquals(CodecPolicy.LENIENT, Base64.builder().setDecodingPolicy(CodecPolicy.STRICT).setDecodingPolicy(null).get().getCodecPolicy());
+ assertEquals(CodecPolicy.LENIENT, Base64.builder().setDecodingPolicy(null).get().getCodecPolicy());
+ }
+
+ @Test
+ public void testBuilderLineAttributes() {
+ assertNull(Base64.builder().get().getLineSeparator());
+ assertNull(Base64.builder().setLineSeparator(BaseNCodec.CHUNK_SEPARATOR).get().getLineSeparator());
+ assertArrayEquals(BaseNCodec.CHUNK_SEPARATOR, Base64.builder().setLineLength(4).setLineSeparator(BaseNCodec.CHUNK_SEPARATOR).get().getLineSeparator());
+ assertArrayEquals(BaseNCodec.CHUNK_SEPARATOR, Base64.builder().setLineLength(4).setLineSeparator(null).get().getLineSeparator());
+ assertArrayEquals(BaseNCodec.CHUNK_SEPARATOR, Base64.builder().setLineLength(10).setLineSeparator(null).get().getLineSeparator());
+ assertNull(Base64.builder().setLineLength(-1).setLineSeparator(null).get().getLineSeparator());
+ assertNull(Base64.builder().setLineLength(0).setLineSeparator(null).get().getLineSeparator());
+ assertArrayEquals(new byte[] { 1 }, Base64.builder().setLineLength(4).setLineSeparator((byte) 1).get().getLineSeparator());
+ assertEquals("Zm94\r\n", Base64.builder().setLineLength(4).get().encodeToString("fox".getBytes(CHARSET_UTF8)));
+ }
+
+ @Test
+ public void testBuilderUrlSafe() {
+ assertFalse(Base64.builder().get().isUrlSafe());
+ assertFalse(Base64.builder().setUrlSafe(false).get().isUrlSafe());
+ assertFalse(Base64.builder().setUrlSafe(true).setUrlSafe(false).get().isUrlSafe());
+ assertTrue(Base64.builder().setUrlSafe(false).setUrlSafe(true).get().isUrlSafe());
+ }
+
@Test
public void testByteToStringVariations() throws DecoderException {
final Base64 base64 = new Base64(0);
@@ -432,7 +466,7 @@ public void testCustomEncodingAlphabet() {
// two instances: one with default table and one with adjusted encoding table
final Base64 b64 = new Base64();
- final Base64 b64customEncoding = new Base64(encodeTable);
+ final Base64 b64customEncoding = Base64.builder().setEncodeTable(encodeTable).get();
final String content = "! Hello World - this §$%";
@@ -461,7 +495,7 @@ public void testCustomEncodingAlphabet_illegal() {
final byte[] encodeTable = {
'.', '-', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M'
};
- assertThrows(IllegalArgumentException.class, () -> new Base64(encodeTable));
+ assertThrows(IllegalArgumentException.class, () -> Base64.builder().setEncodeTable(encodeTable).get());
}
private void testDecodeEncode(final String encodedText) {
@@ -632,10 +666,7 @@ public void testHugeLineSeparator() {
@Test
public void testIgnoringNonBase64InDecode() throws Exception {
- assertEquals("The quick brown fox jumped over the lazy dogs.",
- new String(Base64.decodeBase64(
- "VGhlIH@$#$@%F1aWN@#@#@@rIGJyb3duIGZve\n\r\t%#%#%#%CBqd##$#$W1wZWQgb3ZlciB0aGUgbGF6eSBkb2dzLg=="
- .getBytes(CHARSET_UTF8))));
+ assertEquals(FOX_TEXT, new String(Base64.decodeBase64(FOX_BASE64.getBytes(CHARSET_UTF8))));
}
@Test
@@ -692,7 +723,7 @@ public void testIsUrlSafe() {
@Test
public void testKnownDecodings() {
- assertEquals("The quick brown fox jumped over the lazy dogs.", new String(Base64.decodeBase64(
+ assertEquals(FOX_TEXT, new String(Base64.decodeBase64(
"VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wZWQgb3ZlciB0aGUgbGF6eSBkb2dzLg==".getBytes(CHARSET_UTF8))));
assertEquals("It was the best of times, it was the worst of times.", new String(Base64.decodeBase64(
"SXQgd2FzIHRoZSBiZXN0IG9mIHRpbWVzLCBpdCB3YXMgdGhlIHdvcnN0IG9mIHRpbWVzLg==".getBytes(CHARSET_UTF8))));
@@ -708,7 +739,7 @@ public void testKnownDecodings() {
@Test
public void testKnownEncodings() {
assertEquals("VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wZWQgb3ZlciB0aGUgbGF6eSBkb2dzLg==", new String(
- Base64.encodeBase64("The quick brown fox jumped over the lazy dogs.".getBytes(CHARSET_UTF8))));
+ Base64.encodeBase64(FOX_TEXT.getBytes(CHARSET_UTF8))));
assertEquals(
"YmxhaCBibGFoIGJsYWggYmxhaCBibGFoIGJsYWggYmxhaCBibGFoIGJsYWggYmxhaCBibGFoIGJs\r\nYWggYmxhaCBibGFoIGJsYWggYmxhaCBibGFoIGJsYWggYmxhaCBibGFoIGJsYWggYmxhaCBibGFo\r\nIGJsYWggYmxhaCBibGFoIGJsYWggYmxhaCBibGFoIGJsYWggYmxhaCBibGFoIGJsYWggYmxhaCBi\r\nbGFoIGJsYWg=\r\n",
new String(Base64.encodeBase64Chunked(
From d35d3e7e35a751fa73fe7ec485f80989434b78c0 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Tue, 16 Apr 2024 09:53:50 -0400
Subject: [PATCH 58/99] Set the bar for JaCoCo checks
---
pom.xml | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/pom.xml b/pom.xml
index 4a9e31b1a7..445fe313ce 100644
--- a/pom.xml
+++ b/pom.xml
@@ -108,6 +108,14 @@ limitations under the License.
scm:svn:https://dist.apache.org/repos/dist/dev/commons/${commons.componentid}
2024-02-08T21:29:14Z
0.8.12
+
+ true
+ 0.92
+ 0.91
+ 0.87
+ 0.86
+ 0.89
+ 0.84
clean verify apache-rat:check japicmp:cmp checkstyle:check javadoc:javadoc
From b9e6d691ac27cbd73046ddc7d2a23c39dd3b66fc Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Tue, 16 Apr 2024 09:59:02 -0400
Subject: [PATCH 59/99] Javadoc
---
.../apache/commons/codec/binary/Base16.java | 6 +++---
.../codec/binary/Base16InputStream.java | 8 ++++----
.../codec/binary/Base16OutputStream.java | 8 ++++----
.../apache/commons/codec/binary/Base32.java | 18 +++++++++---------
.../codec/binary/Base32InputStream.java | 8 ++++----
.../codec/binary/Base32OutputStream.java | 8 ++++----
.../apache/commons/codec/binary/Base64.java | 14 +++++++-------
.../codec/binary/Base64InputStream.java | 8 ++++----
.../codec/binary/Base64OutputStream.java | 8 ++++----
.../commons/codec/binary/BaseNCodec.java | 9 +++++++++
.../codec/binary/BaseNCodecInputStream.java | 2 +-
.../codec/binary/BaseNCodecOutputStream.java | 2 ++
12 files changed, 55 insertions(+), 44 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/Base16.java b/src/main/java/org/apache/commons/codec/binary/Base16.java
index 492d1d3802..9d210dd794 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base16.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base16.java
@@ -114,14 +114,14 @@ public class Base16 extends BaseNCodec {
private final byte[] encodeTable;
/**
- * Creates a Base16 codec used for decoding and encoding.
+ * Constructs a Base16 codec used for decoding and encoding.
*/
public Base16() {
this(false);
}
/**
- * Creates a Base16 codec used for decoding and encoding.
+ * Constructs a Base16 codec used for decoding and encoding.
*
* @param lowerCase if {@code true} then use a lower-case Base16 alphabet.
*/
@@ -130,7 +130,7 @@ public Base16(final boolean lowerCase) {
}
/**
- * Creates a Base16 codec used for decoding and encoding.
+ * Constructs a Base16 codec used for decoding and encoding.
*
* @param lowerCase if {@code true} then use a lower-case Base16 alphabet.
* @param decodingPolicy Decoding policy.
diff --git a/src/main/java/org/apache/commons/codec/binary/Base16InputStream.java b/src/main/java/org/apache/commons/codec/binary/Base16InputStream.java
index de580a1503..5c0448271a 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base16InputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base16InputStream.java
@@ -33,7 +33,7 @@
public class Base16InputStream extends BaseNCodecInputStream {
/**
- * Creates a Base16InputStream such that all data read is Base16-decoded from the original provided InputStream.
+ * Constructs a Base16InputStream such that all data read is Base16-decoded from the original provided InputStream.
*
* @param inputStream InputStream to wrap.
*/
@@ -42,7 +42,7 @@ public Base16InputStream(final InputStream inputStream) {
}
/**
- * Creates a Base16InputStream such that all data read is either Base16-encoded or Base16-decoded from the original
+ * Constructs a Base16InputStream such that all data read is either Base16-encoded or Base16-decoded from the original
* provided InputStream.
*
* @param inputStream InputStream to wrap.
@@ -53,7 +53,7 @@ public Base16InputStream(final InputStream inputStream, final boolean doEncode)
}
/**
- * Creates a Base16InputStream such that all data read is either Base16-encoded or Base16-decoded from the original
+ * Constructs a Base16InputStream such that all data read is either Base16-encoded or Base16-decoded from the original
* provided InputStream.
*
* @param inputStream InputStream to wrap.
@@ -66,7 +66,7 @@ public Base16InputStream(final InputStream inputStream, final boolean doEncode,
}
/**
- * Creates a Base16InputStream such that all data read is either Base16-encoded or Base16-decoded from the original
+ * Constructs a Base16InputStream such that all data read is either Base16-encoded or Base16-decoded from the original
* provided InputStream.
*
* @param inputStream InputStream to wrap.
diff --git a/src/main/java/org/apache/commons/codec/binary/Base16OutputStream.java b/src/main/java/org/apache/commons/codec/binary/Base16OutputStream.java
index 18e28764e4..7e653a372d 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base16OutputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base16OutputStream.java
@@ -33,7 +33,7 @@
public class Base16OutputStream extends BaseNCodecOutputStream {
/**
- * Creates a Base16OutputStream such that all data written is Hex-encoded to the original provided OutputStream.
+ * Constructs a Base16OutputStream such that all data written is Hex-encoded to the original provided OutputStream.
*
* @param outputStream OutputStream to wrap.
*/
@@ -42,7 +42,7 @@ public Base16OutputStream(final OutputStream outputStream) {
}
/**
- * Creates a Base16OutputStream such that all data written is either Hex-encoded or Hex-decoded to the
+ * Constructs a Base16OutputStream such that all data written is either Hex-encoded or Hex-decoded to the
* original provided OutputStream.
*
* @param outputStream OutputStream to wrap.
@@ -53,7 +53,7 @@ public Base16OutputStream(final OutputStream outputStream, final boolean doEncod
}
/**
- * Creates a Base16OutputStream such that all data written is either Hex-encoded or Hex-decoded to the
+ * Constructs a Base16OutputStream such that all data written is either Hex-encoded or Hex-decoded to the
* original provided OutputStream.
*
* @param outputStream OutputStream to wrap.
@@ -65,7 +65,7 @@ public Base16OutputStream(final OutputStream outputStream, final boolean doEncod
}
/**
- * Creates a Base16OutputStream such that all data written is either Hex-encoded or Hex-decoded to the
+ * Constructs a Base16OutputStream such that all data written is either Hex-encoded or Hex-decoded to the
* original provided OutputStream.
*
* @param outputStream OutputStream to wrap.
diff --git a/src/main/java/org/apache/commons/codec/binary/Base32.java b/src/main/java/org/apache/commons/codec/binary/Base32.java
index 3bc44f082b..bfcb23aad3 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32.java
@@ -154,7 +154,7 @@ public class Base32 extends BaseNCodec {
private final byte[] lineSeparator;
/**
- * Creates a Base32 codec used for decoding and encoding.
+ * Constructs a Base32 codec used for decoding and encoding.
*
* When encoding the line length is 0 (no chunking).
*
@@ -164,7 +164,7 @@ public Base32() {
}
/**
- * Creates a Base32 codec used for decoding and encoding.
+ * Constructs a Base32 codec used for decoding and encoding.
*
* When encoding the line length is 0 (no chunking).
*
@@ -176,7 +176,7 @@ public Base32(final boolean useHex) {
}
/**
- * Creates a Base32 codec used for decoding and encoding.
+ * Constructs a Base32 codec used for decoding and encoding.
*
* When encoding the line length is 0 (no chunking).
*
@@ -189,7 +189,7 @@ public Base32(final boolean useHex, final byte padding) {
}
/**
- * Creates a Base32 codec used for decoding and encoding.
+ * Constructs a Base32 codec used for decoding and encoding.
*
* When encoding the line length is 0 (no chunking).
*
@@ -201,7 +201,7 @@ public Base32(final byte pad) {
}
/**
- * Creates a Base32 codec used for decoding and encoding.
+ * Constructs a Base32 codec used for decoding and encoding.
*
* When encoding the line length is given in the constructor, the line separator is CRLF.
*
@@ -214,7 +214,7 @@ public Base32(final int lineLength) {
}
/**
- * Creates a Base32 codec used for decoding and encoding.
+ * Constructs a Base32 codec used for decoding and encoding.
*
* When encoding the line length and line separator are given in the constructor.
*
@@ -232,7 +232,7 @@ public Base32(final int lineLength, final byte[] lineSeparator) {
}
/**
- * Creates a Base32 / Base32 Hex codec used for decoding and encoding.
+ * Constructs a Base32 / Base32 Hex codec used for decoding and encoding.
*
* When encoding the line length and line separator are given in the constructor.
*
@@ -251,7 +251,7 @@ public Base32(final int lineLength, final byte[] lineSeparator, final boolean us
}
/**
- * Creates a Base32 / Base32 Hex codec used for decoding and encoding.
+ * Constructs a Base32 / Base32 Hex codec used for decoding and encoding.
*
* When encoding the line length and line separator are given in the constructor.
*
@@ -271,7 +271,7 @@ public Base32(final int lineLength, final byte[] lineSeparator, final boolean us
}
/**
- * Creates a Base32 / Base32 Hex codec used for decoding and encoding.
+ * Constructs a Base32 / Base32 Hex codec used for decoding and encoding.
*
* When encoding the line length and line separator are given in the constructor.
*
diff --git a/src/main/java/org/apache/commons/codec/binary/Base32InputStream.java b/src/main/java/org/apache/commons/codec/binary/Base32InputStream.java
index 82091760ab..51adce23db 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32InputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32InputStream.java
@@ -55,7 +55,7 @@
public class Base32InputStream extends BaseNCodecInputStream {
/**
- * Creates a Base32InputStream such that all data read is Base32-decoded from the original provided InputStream.
+ * Constructs a Base32InputStream such that all data read is Base32-decoded from the original provided InputStream.
*
* @param inputStream
* InputStream to wrap.
@@ -65,7 +65,7 @@ public Base32InputStream(final InputStream inputStream) {
}
/**
- * Creates a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original
+ * Constructs a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original
* provided InputStream.
*
* @param inputStream
@@ -78,7 +78,7 @@ public Base32InputStream(final InputStream inputStream, final boolean doEncode)
}
/**
- * Creates a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original
+ * Constructs a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original
* provided InputStream.
*
* @param inputStream
@@ -98,7 +98,7 @@ public Base32InputStream(final InputStream inputStream, final boolean doEncode,
}
/**
- * Creates a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original
+ * Constructs a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original
* provided InputStream.
*
* @param inputStream
diff --git a/src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java b/src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java
index c0bc740c6e..5977ae9d81 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java
@@ -59,7 +59,7 @@
public class Base32OutputStream extends BaseNCodecOutputStream {
/**
- * Creates a Base32OutputStream such that all data written is Base32-encoded to the original provided OutputStream.
+ * Constructs a Base32OutputStream such that all data written is Base32-encoded to the original provided OutputStream.
*
* @param outputStream
* OutputStream to wrap.
@@ -69,7 +69,7 @@ public Base32OutputStream(final OutputStream outputStream) {
}
/**
- * Creates a Base32OutputStream such that all data written is either Base32-encoded or Base32-decoded to the
+ * Constructs a Base32OutputStream such that all data written is either Base32-encoded or Base32-decoded to the
* original provided OutputStream.
*
* @param outputStream
@@ -82,7 +82,7 @@ public Base32OutputStream(final OutputStream outputStream, final boolean doEncod
}
/**
- * Creates a Base32OutputStream such that all data written is either Base32-encoded or Base32-decoded to the
+ * Constructs a Base32OutputStream such that all data written is either Base32-encoded or Base32-decoded to the
* original provided OutputStream.
*
* @param outputStream
@@ -102,7 +102,7 @@ public Base32OutputStream(final OutputStream outputStream, final boolean doEncod
}
/**
- * Creates a Base32OutputStream such that all data written is either Base32-encoded or Base32-decoded to the
+ * Constructs a Base32OutputStream such that all data written is either Base32-encoded or Base32-decoded to the
* original provided OutputStream.
*
* @param outputStream
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64.java b/src/main/java/org/apache/commons/codec/binary/Base64.java
index 76db3ddb60..4e7f5d25f2 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -529,7 +529,7 @@ private static byte[] toUrlSafeEncodeTable(final boolean urlSafe) {
private final int encodeSize;
/**
- * Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
+ * Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
*
* When encoding the line length is 0 (no chunking), and the encoding table is STANDARD_ENCODE_TABLE.
*
@@ -543,7 +543,7 @@ public Base64() {
}
/**
- * Creates a Base64 codec used for decoding (all modes) and encoding in the given URL-safe mode.
+ * Constructs a Base64 codec used for decoding (all modes) and encoding in the given URL-safe mode.
*
* When encoding the line length is 76, the line separator is CRLF, and the encoding table is STANDARD_ENCODE_TABLE.
*
@@ -562,7 +562,7 @@ public Base64(final boolean urlSafe) {
}
/**
- * Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
+ * Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
*
* When encoding the line length is given in the constructor, the line separator is CRLF, and the encoding table is
* STANDARD_ENCODE_TABLE.
@@ -586,7 +586,7 @@ public Base64(final int lineLength) {
/**
- * Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
+ * Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
*
* When encoding the line length and line separator are given in the constructor, and the encoding table is
* STANDARD_ENCODE_TABLE.
@@ -613,7 +613,7 @@ public Base64(final int lineLength, final byte[] lineSeparator) {
}
/**
- * Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
+ * Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
*
* When encoding the line length and line separator are given in the constructor, and the encoding table is
* STANDARD_ENCODE_TABLE.
@@ -644,7 +644,7 @@ public Base64(final int lineLength, final byte[] lineSeparator, final boolean ur
}
/**
- * Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
+ * Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
*
* When encoding the line length and line separator are given in the constructor, and the encoding table is
* STANDARD_ENCODE_TABLE.
@@ -677,7 +677,7 @@ public Base64(final int lineLength, final byte[] lineSeparator, final boolean ur
}
/**
- * Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
+ * Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
*
* When encoding the line length and line separator are given in the constructor, and the encoding table is
* STANDARD_ENCODE_TABLE.
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64InputStream.java b/src/main/java/org/apache/commons/codec/binary/Base64InputStream.java
index 6a96217bf9..45ce8b41c0 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64InputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64InputStream.java
@@ -59,7 +59,7 @@
public class Base64InputStream extends BaseNCodecInputStream {
/**
- * Creates a Base64InputStream such that all data read is Base64-decoded from the original provided InputStream.
+ * Constructs a Base64InputStream such that all data read is Base64-decoded from the original provided InputStream.
*
* @param inputStream
* InputStream to wrap.
@@ -69,7 +69,7 @@ public Base64InputStream(final InputStream inputStream) {
}
/**
- * Creates a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original
+ * Constructs a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original
* provided InputStream.
*
* @param inputStream
@@ -82,7 +82,7 @@ public Base64InputStream(final InputStream inputStream, final boolean doEncode)
}
/**
- * Creates a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original
+ * Constructs a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original
* provided InputStream.
*
* @param inputStream
@@ -102,7 +102,7 @@ public Base64InputStream(final InputStream inputStream, final boolean doEncode,
}
/**
- * Creates a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original
+ * Constructs a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original
* provided InputStream.
*
* @param inputStream
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java b/src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java
index 492610dae9..43b87da5ca 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java
@@ -63,7 +63,7 @@
public class Base64OutputStream extends BaseNCodecOutputStream {
/**
- * Creates a Base64OutputStream such that all data written is Base64-encoded to the original provided OutputStream.
+ * Constructs a Base64OutputStream such that all data written is Base64-encoded to the original provided OutputStream.
*
* @param outputStream
* OutputStream to wrap.
@@ -73,7 +73,7 @@ public Base64OutputStream(final OutputStream outputStream) {
}
/**
- * Creates a Base64OutputStream such that all data written is either Base64-encoded or Base64-decoded to the
+ * Constructs a Base64OutputStream such that all data written is either Base64-encoded or Base64-decoded to the
* original provided OutputStream.
*
* @param outputStream
@@ -86,7 +86,7 @@ public Base64OutputStream(final OutputStream outputStream, final boolean doEncod
}
/**
- * Creates a Base64OutputStream such that all data written is either Base64-encoded or Base64-decoded to the
+ * Constructs a Base64OutputStream such that all data written is either Base64-encoded or Base64-decoded to the
* original provided OutputStream.
*
* @param outputStream
@@ -106,7 +106,7 @@ public Base64OutputStream(final OutputStream outputStream, final boolean doEncod
}
/**
- * Creates a Base64OutputStream such that all data written is either Base64-encoded or Base64-decoded to the
+ * Constructs a Base64OutputStream such that all data written is either Base64-encoded or Base64-decoded to the
* original provided OutputStream.
*
* @param outputStream
diff --git a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
index b0e64622d6..3a73e4ee2a 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
@@ -312,8 +312,11 @@ private static byte[] resizeBuffer(final Context context, final int minCapacity)
private final CodecPolicy decodingPolicy;
/**
+ * Constructs a new instance.
+ *
* Note {@code lineLength} is rounded down to the nearest multiple of the encoded block size.
* If {@code chunkSeparatorLength} is zero, then chunking is disabled.
+ *
*
* @param unencodedBlockSize the size of an unencoded block (e.g. Base64 = 3)
* @param encodedBlockSize the size of an encoded block (e.g. Base64 = 4)
@@ -326,8 +329,11 @@ protected BaseNCodec(final int unencodedBlockSize, final int encodedBlockSize,
}
/**
+ * Constructs a new instance.
+ *
* Note {@code lineLength} is rounded down to the nearest multiple of the encoded block size.
* If {@code chunkSeparatorLength} is zero, then chunking is disabled.
+ *
*
* @param unencodedBlockSize the size of an unencoded block (e.g. Base64 = 3)
* @param encodedBlockSize the size of an encoded block (e.g. Base64 = 4)
@@ -341,8 +347,11 @@ protected BaseNCodec(final int unencodedBlockSize, final int encodedBlockSize,
}
/**
+ * Constructs a new instance.
+ *
* Note {@code lineLength} is rounded down to the nearest multiple of the encoded block size.
* If {@code chunkSeparatorLength} is zero, then chunking is disabled.
+ *
*
* @param unencodedBlockSize the size of an unencoded block (e.g. Base64 = 3)
* @param encodedBlockSize the size of an encoded block (e.g. Base64 = 4)
diff --git a/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java b/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java
index ac1471836e..bf0feb4727 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java
@@ -44,7 +44,7 @@ public class BaseNCodecInputStream extends FilterInputStream {
private final Context context = new Context();
/**
- * Create an instance.
+ * Constructs a new instance.
*
* @param inputStream the input stream
* @param baseNCodec the codec
diff --git a/src/main/java/org/apache/commons/codec/binary/BaseNCodecOutputStream.java b/src/main/java/org/apache/commons/codec/binary/BaseNCodecOutputStream.java
index b3f141ab46..1964759384 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodecOutputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodecOutputStream.java
@@ -48,6 +48,8 @@ public class BaseNCodecOutputStream extends FilterOutputStream {
private final Context context = new Context();
/**
+ * Constructs a new instance.
+ *
* TODO should this be protected?
*
* @param outputStream the underlying output or null.
From 3b36a60aaedd976b0726b4451195e8851059921e Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Tue, 16 Apr 2024 10:00:31 -0400
Subject: [PATCH 60/99] Javadoc
---
src/main/java/org/apache/commons/codec/binary/Base32.java | 1 -
1 file changed, 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/Base32.java b/src/main/java/org/apache/commons/codec/binary/Base32.java
index bfcb23aad3..9a5876364d 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32.java
@@ -38,7 +38,6 @@
*
*
* @see RFC 4648
- *
* @since 1.5
*/
public class Base32 extends BaseNCodec {
From 3a9efd27f54cd2d3794e95d638aa2e90bc082c05 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Tue, 16 Apr 2024 10:06:20 -0400
Subject: [PATCH 61/99] Format tweaks
Use this in constructor
---
src/main/java/org/apache/commons/codec/cli/Digest.java | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/cli/Digest.java b/src/main/java/org/apache/commons/codec/cli/Digest.java
index e111c35340..2bfc794c5a 100644
--- a/src/main/java/org/apache/commons/codec/cli/Digest.java
+++ b/src/main/java/org/apache/commons/codec/cli/Digest.java
@@ -52,9 +52,9 @@ public class Digest {
public static void main(final String[] args) throws IOException {
new Digest(args).run();
}
+
private final String algorithm;
private final String[] args;
-
private final String[] inputs;
private Digest(final String[] args) {
@@ -67,11 +67,11 @@ private Digest(final String[] args) {
String.format("Usage: java %s [algorithm] [FILE|DIRECTORY|string] ...", Digest.class.getName()));
}
this.args = args;
- algorithm = args[0];
+ this.algorithm = args[0];
if (argsLength <= 1) {
- inputs = null;
+ this.inputs = null;
} else {
- inputs = Arrays.copyOfRange(args, 1, argsLength);
+ this.inputs = Arrays.copyOfRange(args, 1, argsLength);
}
}
From a670ba8675f6643ad4cff6eae6cd40f206958bd1 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Tue, 16 Apr 2024 10:11:32 -0400
Subject: [PATCH 62/99] Use Objects#requireNonNull()
---
src/main/java/org/apache/commons/codec/cli/Digest.java | 5 ++---
src/test/java/org/apache/commons/codec/cli/DigestTest.java | 2 +-
2 files changed, 3 insertions(+), 4 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/cli/Digest.java b/src/main/java/org/apache/commons/codec/cli/Digest.java
index 2bfc794c5a..20b3684a34 100644
--- a/src/main/java/org/apache/commons/codec/cli/Digest.java
+++ b/src/main/java/org/apache/commons/codec/cli/Digest.java
@@ -22,6 +22,7 @@
import java.security.MessageDigest;
import java.util.Arrays;
import java.util.Locale;
+import java.util.Objects;
import org.apache.commons.codec.binary.Hex;
import org.apache.commons.codec.digest.DigestUtils;
@@ -58,9 +59,7 @@ public static void main(final String[] args) throws IOException {
private final String[] inputs;
private Digest(final String[] args) {
- if (args == null) {
- throw new IllegalArgumentException("args");
- }
+ Objects.requireNonNull(args);
final int argsLength = args.length;
if (argsLength == 0) {
throw new IllegalArgumentException(
diff --git a/src/test/java/org/apache/commons/codec/cli/DigestTest.java b/src/test/java/org/apache/commons/codec/cli/DigestTest.java
index c00cba7bdd..a45fba6443 100644
--- a/src/test/java/org/apache/commons/codec/cli/DigestTest.java
+++ b/src/test/java/org/apache/commons/codec/cli/DigestTest.java
@@ -38,6 +38,6 @@ public void testEmptyArguments() {
*/
@Test
public void testNullArguments() {
- assertThrows(IllegalArgumentException.class, () -> Digest.main(null));
+ assertThrows(NullPointerException.class, () -> Digest.main(null));
}
}
From c29d6f7eeccbbfad2193cc975b1c56623f39b346 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Tue, 16 Apr 2024 18:30:39 -0400
Subject: [PATCH 63/99] Set Javadoc link to latest Java API LTS version
Modern Javadoc versions redirect automatically anyway to Java 22
---
pom.xml | 1 +
src/changes/changes.xml | 1 +
2 files changed, 2 insertions(+)
diff --git a/pom.xml b/pom.xml
index 445fe313ce..8290eefd12 100644
--- a/pom.xml
+++ b/pom.xml
@@ -108,6 +108,7 @@ limitations under the License.
scm:svn:https://dist.apache.org/repos/dist/dev/commons/${commons.componentid}
2024-02-08T21:29:14Z
0.8.12
+ ${commons.javadoc21.java.link}
true
0.92
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index a609aaeef8..4ba569ba3e 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -51,6 +51,7 @@ The type attribute can be add,update,fix,remove.
Optimize memory allocation in PhoneticEngine.
BCodec and QCodec encode() methods throw UnsupportedCharsetException instead of EncoderException.
+ Set Javadoc link to latest Java API LTS version.
Bump org.apache.commons:commons-parent from 66 to 69 #250, #261.
Bump commons-io:commons-io from 2.15.1 to 2.16.1 #258, #265.
From 3e27d960f6b38efeab36bde4afde703fd44f2a45 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Tue, 16 Apr 2024 18:31:34 -0400
Subject: [PATCH 64/99] Pull-up common Builder attributes to BaseNCodec
---
.../apache/commons/codec/binary/Base32.java | 32 ++++++--
.../apache/commons/codec/binary/Base64.java | 46 +----------
.../commons/codec/binary/BaseNCodec.java | 79 ++++++++++++++++++-
3 files changed, 104 insertions(+), 53 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/Base32.java b/src/main/java/org/apache/commons/codec/binary/Base32.java
index 9a5876364d..abbc6bba1d 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32.java
@@ -288,14 +288,30 @@ public Base32(final int lineLength, final byte[] lineSeparator, final boolean us
* @since 1.15
*/
public Base32(final int lineLength, final byte[] lineSeparator, final boolean useHex, final byte padding, final CodecPolicy decodingPolicy) {
- super(BYTES_PER_UNENCODED_BLOCK, BYTES_PER_ENCODED_BLOCK, lineLength, lineSeparator == null ? 0 : lineSeparator.length, padding, decodingPolicy);
- if (useHex) {
- this.encodeTable = HEX_ENCODE_TABLE;
- this.decodeTable = HEX_DECODE_TABLE;
- } else {
- this.encodeTable = ENCODE_TABLE;
- this.decodeTable = DECODE_TABLE;
- }
+ this(lineLength, lineSeparator, useHex ? HEX_ENCODE_TABLE : ENCODE_TABLE, padding, decodingPolicy);
+ }
+
+ /**
+ * Constructs a Base32 / Base32 Hex codec used for decoding and encoding.
+ *
+ * When encoding the line length and line separator are given in the constructor.
+ *
+ *
+ * Line lengths that aren't multiples of 8 will still essentially end up being multiples of 8 in the encoded data.
+ *
+ *
+ * @param lineLength Each line of encoded data will be at most of the given length (rounded down to the nearest multiple of 8). If lineLength <= 0,
+ * then the output will not be divided into lines (chunks). Ignored when decoding.
+ * @param lineSeparator Each line of encoded data will end with this sequence of bytes.
+ * @param encodeTable A Base32 alphabet.
+ * @param padding byte used as padding byte.
+ * @param decodingPolicy The decoding policy.
+ * @throws IllegalArgumentException Thrown when the {@code lineSeparator} contains Base32 characters. Or the lineLength > 0 and lineSeparator is null.
+ */
+ private Base32(final int lineLength, final byte[] lineSeparator, final byte[] encodeTable, final byte padding, final CodecPolicy decodingPolicy) {
+ super(BYTES_PER_UNENCODED_BLOCK, BYTES_PER_ENCODED_BLOCK, lineLength, toLength(lineSeparator), padding, decodingPolicy);
+ this.encodeTable = encodeTable;
+ this.decodeTable = encodeTable == HEX_ENCODE_TABLE ? HEX_DECODE_TABLE : DECODE_TABLE;
if (lineLength > 0) {
if (lineSeparator == null) {
throw new IllegalArgumentException("lineLength " + lineLength + " > 0, but lineSeparator is null");
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64.java b/src/main/java/org/apache/commons/codec/binary/Base64.java
index 4e7f5d25f2..4fc3f93889 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -20,7 +20,6 @@
import java.math.BigInteger;
import java.util.Arrays;
import java.util.Objects;
-import java.util.function.Supplier;
import org.apache.commons.codec.CodecPolicy;
@@ -62,27 +61,13 @@ public class Base64 extends BaseNCodec {
*
* @since 1.17.0
*/
- public static class Builder implements Supplier {
+ public static class Builder extends AbstractBuilder {
- private int lineLength;
- private byte[] lineSeparator = CHUNK_SEPARATOR;
private byte[] encodeTable = STANDARD_ENCODE_TABLE;
- private CodecPolicy decodingPolicy = DECODING_POLICY_DEFAULT;
@Override
public Base64 get() {
- return new Base64(lineLength, lineSeparator, encodeTable, decodingPolicy);
- }
-
- /**
- * Sets the decoding policy.
- *
- * @param decodingPolicy the decoding policy, null resets to the default.
- * @return this.
- */
- public Builder setDecodingPolicy(final CodecPolicy decodingPolicy) {
- this.decodingPolicy = decodingPolicy != null ? decodingPolicy : DECODING_POLICY_DEFAULT;
- return this;
+ return new Base64(getLineLength(), getLineSeparator(), encodeTable, getDecodingPolicy());
}
/**
@@ -96,28 +81,6 @@ public Builder setEncodeTable(final byte... encodeTable) {
return this;
}
- /**
- * Sets the line length.
- *
- * @param lineLength the line length, less than 0 resets to the default.
- * @return this.
- */
- public Builder setLineLength(final int lineLength) {
- this.lineLength = Math.max(0, lineLength);
- return this;
- }
-
- /**
- * Sets the line separator.
- *
- * @param lineSeparator the line separator, null resets to the default.
- * @return this.
- */
- public Builder setLineSeparator(final byte... lineSeparator) {
- this.lineSeparator = lineSeparator != null ? lineSeparator : CHUNK_SEPARATOR;
- return this;
- }
-
/**
* Sets the URL-safe encoding policy.
*
@@ -561,6 +524,7 @@ public Base64(final boolean urlSafe) {
this(MIME_CHUNK_SIZE, CHUNK_SEPARATOR, urlSafe);
}
+
/**
* Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
*
@@ -584,7 +548,6 @@ public Base64(final int lineLength) {
this(lineLength, CHUNK_SEPARATOR);
}
-
/**
* Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
*
@@ -702,9 +665,8 @@ public Base64(final int lineLength, final byte[] lineSeparator, final boolean ur
* Thrown when the {@code lineSeparator} contains Base64 characters.
*/
private Base64(final int lineLength, final byte[] lineSeparator, final byte[] encodeTable, final CodecPolicy decodingPolicy) {
- super(BYTES_PER_UNENCODED_BLOCK, BYTES_PER_ENCODED_BLOCK, lineLength, lineSeparator == null ? 0 : lineSeparator.length, PAD_DEFAULT, decodingPolicy);
+ super(BYTES_PER_UNENCODED_BLOCK, BYTES_PER_ENCODED_BLOCK, lineLength, toLength(lineSeparator), PAD_DEFAULT, decodingPolicy);
this.encodeTable = Objects.requireNonNull(encodeTable, "encodeTable");
-
if (encodeTable == STANDARD_ENCODE_TABLE || encodeTable == URL_SAFE_ENCODE_TABLE) {
decodeTable = DECODE_TABLE;
} else {
diff --git a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
index 3a73e4ee2a..9ae5bbcc69 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
@@ -19,6 +19,7 @@
import java.util.Arrays;
import java.util.Objects;
+import java.util.function.Supplier;
import org.apache.commons.codec.BinaryDecoder;
import org.apache.commons.codec.BinaryEncoder;
@@ -51,12 +52,75 @@
*/
public abstract class BaseNCodec implements BinaryEncoder, BinaryDecoder {
+ /**
+ * Builds {@link Base64} instances.
+ *
+ * @param the codec type to build.
+ * @param the codec builder subtype.
+ * @since 1.17.0
+ */
+ public abstract static class AbstractBuilder> implements Supplier {
+
+ private CodecPolicy decodingPolicy = DECODING_POLICY_DEFAULT;
+ private int lineLength;
+ private byte[] lineSeparator = CHUNK_SEPARATOR;
+
+ @SuppressWarnings("unchecked")
+ B asThis() {
+ return (B) this;
+ }
+
+ CodecPolicy getDecodingPolicy() {
+ return decodingPolicy;
+ }
+
+ int getLineLength() {
+ return lineLength;
+ }
+
+ byte[] getLineSeparator() {
+ return lineSeparator;
+ }
+
+ /**
+ * Sets the decoding policy.
+ *
+ * @param decodingPolicy the decoding policy, null resets to the default.
+ * @return this.
+ */
+ public B setDecodingPolicy(final CodecPolicy decodingPolicy) {
+ this.decodingPolicy = decodingPolicy != null ? decodingPolicy : DECODING_POLICY_DEFAULT;
+ return asThis();
+ }
+
+ /**
+ * Sets the line length.
+ *
+ * @param lineLength the line length, less than 0 resets to the default.
+ * @return this.
+ */
+ public B setLineLength(final int lineLength) {
+ this.lineLength = Math.max(0, lineLength);
+ return asThis();
+ }
+
+ /**
+ * Sets the line separator.
+ *
+ * @param lineSeparator the line separator, null resets to the default.
+ * @return this.
+ */
+ public B setLineSeparator(final byte... lineSeparator) {
+ this.lineSeparator = lineSeparator != null ? lineSeparator : CHUNK_SEPARATOR;
+ return asThis();
+ }
+
+ }
+
/**
* Holds thread context so classes can be thread-safe.
*
* This class is not itself thread-safe; each thread must allocate its own copy.
- *
- * @since 1.7
*/
static class Context {
@@ -110,7 +174,6 @@ static class Context {
*
* @return a String useful for debugging.
*/
- @SuppressWarnings("boxing") // OK to ignore boxing here
@Override
public String toString() {
return String.format("%s[buffer=%s, currentLinePos=%s, eof=%s, ibitWorkArea=%s, lbitWorkArea=%s, " +
@@ -263,6 +326,16 @@ private static byte[] resizeBuffer(final Context context, final int minCapacity)
return b;
}
+ /**
+ * Gets the array length or 0 if null.
+ *
+ * @param array the array or null.
+ * @return the array length or 0 if null.
+ */
+ static int toLength(final byte[] array) {
+ return array == null ? 0 : array.length;
+ }
+
/**
* @deprecated Use {@link #pad}. Will be removed in 2.0.
*/
From f6deb133ea9896091de9040dc77db23ba9566b49 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Tue, 16 Apr 2024 18:38:48 -0400
Subject: [PATCH 65/99] Pull-up common Builder attributes to BaseNCodec
---
.../apache/commons/codec/binary/Base64.java | 23 +++++++------------
.../commons/codec/binary/BaseNCodec.java | 23 +++++++++++++++++++
2 files changed, 31 insertions(+), 15 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64.java b/src/main/java/org/apache/commons/codec/binary/Base64.java
index 4fc3f93889..e38f08be33 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -63,22 +63,16 @@ public class Base64 extends BaseNCodec {
*/
public static class Builder extends AbstractBuilder {
- private byte[] encodeTable = STANDARD_ENCODE_TABLE;
+ /**
+ * Constructs a new instance.
+ */
+ public Builder() {
+ super(STANDARD_ENCODE_TABLE);
+ }
@Override
public Base64 get() {
- return new Base64(getLineLength(), getLineSeparator(), encodeTable, getDecodingPolicy());
- }
-
- /**
- * Sets the encode table.
- *
- * @param encodeTable the encode table, null resets to the default.
- * @return this.
- */
- public Builder setEncodeTable(final byte... encodeTable) {
- this.encodeTable = encodeTable != null ? encodeTable : STANDARD_ENCODE_TABLE;
- return this;
+ return new Base64(getLineLength(), getLineSeparator(), getEncodeTable(), getDecodingPolicy());
}
/**
@@ -88,8 +82,7 @@ public Builder setEncodeTable(final byte... encodeTable) {
* @return this.
*/
public Builder setUrlSafe(final boolean urlSafe) {
- this.encodeTable = toUrlSafeEncodeTable(urlSafe);
- return this;
+ return setEncodeTable(toUrlSafeEncodeTable(urlSafe));
}
}
diff --git a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
index 9ae5bbcc69..9c377641c3 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
@@ -64,6 +64,14 @@ public abstract static class AbstractBuilder>
private CodecPolicy decodingPolicy = DECODING_POLICY_DEFAULT;
private int lineLength;
private byte[] lineSeparator = CHUNK_SEPARATOR;
+ private final byte[] defaultEncodeTable;
+ private byte[] encodeTable;
+
+
+ AbstractBuilder(final byte[] defaultEncodeTable) {
+ this.defaultEncodeTable = defaultEncodeTable;
+ this.encodeTable = defaultEncodeTable;
+ }
@SuppressWarnings("unchecked")
B asThis() {
@@ -74,6 +82,10 @@ CodecPolicy getDecodingPolicy() {
return decodingPolicy;
}
+ byte[] getEncodeTable() {
+ return encodeTable;
+ }
+
int getLineLength() {
return lineLength;
}
@@ -93,6 +105,17 @@ public B setDecodingPolicy(final CodecPolicy decodingPolicy) {
return asThis();
}
+ /**
+ * Sets the encode table.
+ *
+ * @param encodeTable the encode table, null resets to the default.
+ * @return this.
+ */
+ public B setEncodeTable(final byte... encodeTable) {
+ this.encodeTable = encodeTable != null ? encodeTable : defaultEncodeTable;
+ return asThis();
+ }
+
/**
* Sets the line length.
*
From 02235dfce2cb0eee214663804f8bc526435c33fb Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Tue, 16 Apr 2024 19:07:38 -0400
Subject: [PATCH 66/99] Add Base32.Builder (allows custom alphabets)
---
src/changes/changes.xml | 1 +
.../apache/commons/codec/binary/Base32.java | 62 +++++++++++++++++--
.../apache/commons/codec/binary/Base64.java | 1 +
.../commons/codec/binary/Base32Test.java | 35 +++++++++++
4 files changed, 95 insertions(+), 4 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 4ba569ba3e..d8f530dd5c 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -48,6 +48,7 @@ The type attribute can be add,update,fix,remove.
Add override org.apache.commons.codec.language.bm.Rule.PhonemeExpr.size().
Add support for Base64 custom alphabets #266.
Add Base64.Builder (allows custom alphabets).
+ Add Base32.Builder (allows custom alphabets).
Optimize memory allocation in PhoneticEngine.
BCodec and QCodec encode() methods throw UnsupportedCharsetException instead of EncoderException.
diff --git a/src/main/java/org/apache/commons/codec/binary/Base32.java b/src/main/java/org/apache/commons/codec/binary/Base32.java
index abbc6bba1d..8b54b8b77c 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32.java
@@ -42,14 +42,49 @@
*/
public class Base32 extends BaseNCodec {
+ /**
+ * Builds {@link Base32} instances.
+ *
+ * @since 1.17.0
+ */
+ public static class Builder extends AbstractBuilder {
+
+ /** Padding byte. */
+ private byte padding = PAD_DEFAULT;
+
+ /**
+ * Constructs a new instance.
+ */
+ public Builder() {
+ super(ENCODE_TABLE);
+ }
+
+ @Override
+ public Base32 get() {
+ return new Base32(getLineLength(), getLineSeparator(), getEncodeTable(), padding, getDecodingPolicy());
+ }
+
+ /**
+ * Sets the padding byte.
+ *
+ * @param padding the padding byte.
+ * @return this.
+ */
+ public Builder setPadding(final byte padding) {
+ this.padding = padding;
+ return this;
+ }
+
+ }
+
/**
* BASE32 characters are 5 bits in length. They are formed by taking a block of five octets to form a 40-bit string, which is converted into eight BASE32
* characters.
*/
private static final int BITS_PER_ENCODED_BYTE = 5;
+
private static final int BYTES_PER_ENCODED_BLOCK = 8;
private static final int BYTES_PER_UNENCODED_BLOCK = 5;
-
/**
* This array is a lookup table that translates Unicode characters drawn from the "Base32 Alphabet" (as specified in Table 3 of RFC 4648) into their 5-bit
* positive integer equivalents. Characters that are not in the Base32 alphabet but fall within the bounds of the array are translated to -1.
@@ -127,6 +162,16 @@ public class Base32 extends BaseNCodec {
/** Mask used to extract 1 bits, used when decoding final trailing character. */
private static final long MASK_1BITS = 0x01L;
+ /**
+ * Creates a new Builder.
+ *
+ * @return a new Builder.
+ * @since 1.17.0
+ */
+ public static Builder builder() {
+ return new Builder();
+ }
+
// The static final fields above are used for the original static byte[] methods on Base32.
// The private member fields below are used with the new streaming approach, which requires
// some state be preserved between calls of encode() and decode().
@@ -262,7 +307,7 @@ public Base32(final int lineLength, final byte[] lineSeparator, final boolean us
* then the output will not be divided into lines (chunks). Ignored when decoding.
* @param lineSeparator Each line of encoded data will end with this sequence of bytes.
* @param useHex if {@code true}, then use Base32 Hex alphabet, otherwise use Base32 alphabet
- * @param padding byte used as padding byte.
+ * @param padding padding byte.
* @throws IllegalArgumentException Thrown when the {@code lineSeparator} contains Base32 characters. Or the lineLength > 0 and lineSeparator is null.
*/
public Base32(final int lineLength, final byte[] lineSeparator, final boolean useHex, final byte padding) {
@@ -282,7 +327,7 @@ public Base32(final int lineLength, final byte[] lineSeparator, final boolean us
* then the output will not be divided into lines (chunks). Ignored when decoding.
* @param lineSeparator Each line of encoded data will end with this sequence of bytes.
* @param useHex if {@code true}, then use Base32 Hex alphabet, otherwise use Base32 alphabet
- * @param padding byte used as padding byte.
+ * @param padding padding byte.
* @param decodingPolicy The decoding policy.
* @throws IllegalArgumentException Thrown when the {@code lineSeparator} contains Base32 characters. Or the lineLength > 0 and lineSeparator is null.
* @since 1.15
@@ -304,7 +349,7 @@ public Base32(final int lineLength, final byte[] lineSeparator, final boolean us
* then the output will not be divided into lines (chunks). Ignored when decoding.
* @param lineSeparator Each line of encoded data will end with this sequence of bytes.
* @param encodeTable A Base32 alphabet.
- * @param padding byte used as padding byte.
+ * @param padding padding byte.
* @param decodingPolicy The decoding policy.
* @throws IllegalArgumentException Thrown when the {@code lineSeparator} contains Base32 characters. Or the lineLength > 0 and lineSeparator is null.
*/
@@ -554,6 +599,15 @@ void encode(final byte[] input, int inPos, final int inAvail, final Context cont
}
}
+ /**
+ * Gets the line separator (for testing only).
+ *
+ * @return the line separator.
+ */
+ byte[] getLineSeparator() {
+ return lineSeparator;
+ }
+
/**
* Returns whether or not the {@code octet} is in the Base32 alphabet.
*
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64.java b/src/main/java/org/apache/commons/codec/binary/Base64.java
index e38f08be33..cd55201ada 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -166,6 +166,7 @@ public Builder setUrlSafe(final boolean urlSafe) {
private static final int MASK_4BITS = 0xf;
/** Mask used to extract 2 bits, used when decoding final trailing character. */
private static final int MASK_2BITS = 0x3;
+
/**
* Creates a new Builder.
*
diff --git a/src/test/java/org/apache/commons/codec/binary/Base32Test.java b/src/test/java/org/apache/commons/codec/binary/Base32Test.java
index de2cd67e14..0414914496 100644
--- a/src/test/java/org/apache/commons/codec/binary/Base32Test.java
+++ b/src/test/java/org/apache/commons/codec/binary/Base32Test.java
@@ -355,6 +355,41 @@ public void testBase32SamplesNonDefaultPadding() throws Exception {
}
}
+ @Test
+ public void testBuilderCodecPolicy() {
+ assertEquals(CodecPolicy.LENIENT, Base32.builder().get().getCodecPolicy());
+ assertEquals(CodecPolicy.LENIENT, Base32.builder().setDecodingPolicy(CodecPolicy.LENIENT).get().getCodecPolicy());
+ assertEquals(CodecPolicy.STRICT, Base32.builder().setDecodingPolicy(CodecPolicy.STRICT).get().getCodecPolicy());
+ assertEquals(CodecPolicy.LENIENT, Base32.builder().setDecodingPolicy(CodecPolicy.STRICT).setDecodingPolicy(null).get().getCodecPolicy());
+ assertEquals(CodecPolicy.LENIENT, Base32.builder().setDecodingPolicy(null).get().getCodecPolicy());
+ }
+
+ @Test
+ public void testBuilderLineAttributes() {
+ assertNull(Base32.builder().get().getLineSeparator());
+ assertNull(Base32.builder().setLineSeparator(BaseNCodec.CHUNK_SEPARATOR).get().getLineSeparator());
+ assertArrayEquals(BaseNCodec.CHUNK_SEPARATOR, Base32.builder().setLineLength(4).setLineSeparator(BaseNCodec.CHUNK_SEPARATOR).get().getLineSeparator());
+ assertArrayEquals(BaseNCodec.CHUNK_SEPARATOR, Base32.builder().setLineLength(4).setLineSeparator(null).get().getLineSeparator());
+ assertArrayEquals(BaseNCodec.CHUNK_SEPARATOR, Base32.builder().setLineLength(10).setLineSeparator(null).get().getLineSeparator());
+ assertNull(Base32.builder().setLineLength(-1).setLineSeparator(null).get().getLineSeparator());
+ assertNull(Base32.builder().setLineLength(0).setLineSeparator(null).get().getLineSeparator());
+ assertArrayEquals(new byte[] { 1 }, Base32.builder().setLineLength(4).setLineSeparator((byte) 1).get().getLineSeparator());
+ assertEquals("MZXXQ===", Base32.builder().setLineLength(4).get().encodeToString("fox".getBytes(CHARSET_UTF8)));
+ }
+
+ @Test
+ public void testBuilderPadingByte() {
+ assertNull(Base32.builder().get().getLineSeparator());
+ assertNull(Base32.builder().setLineSeparator(BaseNCodec.CHUNK_SEPARATOR).get().getLineSeparator());
+ assertArrayEquals(BaseNCodec.CHUNK_SEPARATOR, Base32.builder().setLineLength(4).setLineSeparator(BaseNCodec.CHUNK_SEPARATOR).get().getLineSeparator());
+ assertArrayEquals(BaseNCodec.CHUNK_SEPARATOR, Base32.builder().setLineLength(4).setLineSeparator(null).get().getLineSeparator());
+ assertArrayEquals(BaseNCodec.CHUNK_SEPARATOR, Base32.builder().setLineLength(10).setLineSeparator(null).get().getLineSeparator());
+ assertNull(Base32.builder().setLineLength(-1).setLineSeparator(null).get().getLineSeparator());
+ assertNull(Base32.builder().setLineLength(0).setLineSeparator(null).get().getLineSeparator());
+ assertArrayEquals(new byte[] { 1 }, Base32.builder().setLineLength(4).setLineSeparator((byte) 1).get().getLineSeparator());
+ assertEquals("MZXXQ___", Base32.builder().setLineLength(4).setPadding((byte) '_').get().encodeToString("fox".getBytes(CHARSET_UTF8)));
+ }
+
@Test
public void testCodec200() {
final Base32 codec = new Base32(true, (byte) 'W'); // should be allowed
From 4791d3b33f7513b11bc025e594aa747a258d3e70 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Tue, 16 Apr 2024 19:42:03 -0400
Subject: [PATCH 67/99] Pull-up common Builder attribute to BaseNCodec
---
.../apache/commons/codec/binary/Base32.java | 16 +---------------
.../commons/codec/binary/BaseNCodec.java | 18 +++++++++++++++++-
2 files changed, 18 insertions(+), 16 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/Base32.java b/src/main/java/org/apache/commons/codec/binary/Base32.java
index 8b54b8b77c..61ca1140fd 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32.java
@@ -49,9 +49,6 @@ public class Base32 extends BaseNCodec {
*/
public static class Builder extends AbstractBuilder {
- /** Padding byte. */
- private byte padding = PAD_DEFAULT;
-
/**
* Constructs a new instance.
*/
@@ -61,18 +58,7 @@ public Builder() {
@Override
public Base32 get() {
- return new Base32(getLineLength(), getLineSeparator(), getEncodeTable(), padding, getDecodingPolicy());
- }
-
- /**
- * Sets the padding byte.
- *
- * @param padding the padding byte.
- * @return this.
- */
- public Builder setPadding(final byte padding) {
- this.padding = padding;
- return this;
+ return new Base32(getLineLength(), getLineSeparator(), getEncodeTable(), getPadding(), getDecodingPolicy());
}
}
diff --git a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
index 9c377641c3..df68641a44 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
@@ -66,7 +66,8 @@ public abstract static class AbstractBuilder>
private byte[] lineSeparator = CHUNK_SEPARATOR;
private final byte[] defaultEncodeTable;
private byte[] encodeTable;
-
+ /** Padding byte. */
+ private byte padding = PAD_DEFAULT;
AbstractBuilder(final byte[] defaultEncodeTable) {
this.defaultEncodeTable = defaultEncodeTable;
@@ -94,6 +95,10 @@ byte[] getLineSeparator() {
return lineSeparator;
}
+ byte getPadding() {
+ return padding;
+ }
+
/**
* Sets the decoding policy.
*
@@ -138,6 +143,17 @@ public B setLineSeparator(final byte... lineSeparator) {
return asThis();
}
+ /**
+ * Sets the padding byte.
+ *
+ * @param padding the padding byte.
+ * @return this.
+ */
+ public B setPadding(final byte padding) {
+ this.padding = padding;
+ return asThis();
+ }
+
}
/**
From 3d6d334705a6a90899b4646aa888087643ef7c9a Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Tue, 16 Apr 2024 19:54:23 -0400
Subject: [PATCH 68/99] Add Base64 support for a custom padding byte (like
Base32)
---
src/changes/changes.xml | 3 ++-
.../org/apache/commons/codec/binary/Base64.java | 14 +++++++-------
.../apache/commons/codec/binary/Base64Test.java | 14 ++++++++++++++
3 files changed, 23 insertions(+), 8 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index d8f530dd5c..024f3d9250 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -48,7 +48,8 @@ The type attribute can be add,update,fix,remove.
Add override org.apache.commons.codec.language.bm.Rule.PhonemeExpr.size().
Add support for Base64 custom alphabets #266.
Add Base64.Builder (allows custom alphabets).
- Add Base32.Builder (allows custom alphabets).
+ Add Base32.Builder (allows custom alphabets).
+ Add Base64 support for a custom padding byte (like Base32).
Optimize memory allocation in PhoneticEngine.
BCodec and QCodec encode() methods throw UnsupportedCharsetException instead of EncoderException.
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64.java b/src/main/java/org/apache/commons/codec/binary/Base64.java
index cd55201ada..57a650533a 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -72,7 +72,7 @@ public Builder() {
@Override
public Base64 get() {
- return new Base64(getLineLength(), getLineSeparator(), getEncodeTable(), getDecodingPolicy());
+ return new Base64(getLineLength(), getLineSeparator(), getPadding(), getEncodeTable(), getDecodingPolicy());
}
/**
@@ -597,7 +597,7 @@ public Base64(final int lineLength, final byte[] lineSeparator) {
* @since 1.4
*/
public Base64(final int lineLength, final byte[] lineSeparator, final boolean urlSafe) {
- this(lineLength, lineSeparator, toUrlSafeEncodeTable(urlSafe), DECODING_POLICY_DEFAULT);
+ this(lineLength, lineSeparator, PAD_DEFAULT, toUrlSafeEncodeTable(urlSafe), DECODING_POLICY_DEFAULT);
}
/**
@@ -628,9 +628,8 @@ public Base64(final int lineLength, final byte[] lineSeparator, final boolean ur
* Thrown when the {@code lineSeparator} contains Base64 characters.
* @since 1.15
*/
- public Base64(final int lineLength, final byte[] lineSeparator, final boolean urlSafe,
- final CodecPolicy decodingPolicy) {
- this(lineLength, lineSeparator, toUrlSafeEncodeTable(urlSafe), decodingPolicy);
+ public Base64(final int lineLength, final byte[] lineSeparator, final boolean urlSafe, final CodecPolicy decodingPolicy) {
+ this(lineLength, lineSeparator, PAD_DEFAULT, toUrlSafeEncodeTable(urlSafe), decodingPolicy);
}
/**
@@ -652,14 +651,15 @@ public Base64(final int lineLength, final byte[] lineSeparator, final boolean ur
* decoding.
* @param lineSeparator
* Each line of encoded data will end with this sequence of bytes.
+ * @param padding padding byte.
* @param encodeTable
* The manual encodeTable - a byte array of 64 chars.
* @param decodingPolicy The decoding policy.
* @throws IllegalArgumentException
* Thrown when the {@code lineSeparator} contains Base64 characters.
*/
- private Base64(final int lineLength, final byte[] lineSeparator, final byte[] encodeTable, final CodecPolicy decodingPolicy) {
- super(BYTES_PER_UNENCODED_BLOCK, BYTES_PER_ENCODED_BLOCK, lineLength, toLength(lineSeparator), PAD_DEFAULT, decodingPolicy);
+ private Base64(final int lineLength, final byte[] lineSeparator, final byte padding, final byte[] encodeTable, final CodecPolicy decodingPolicy) {
+ super(BYTES_PER_UNENCODED_BLOCK, BYTES_PER_ENCODED_BLOCK, lineLength, toLength(lineSeparator), padding, decodingPolicy);
this.encodeTable = Objects.requireNonNull(encodeTable, "encodeTable");
if (encodeTable == STANDARD_ENCODE_TABLE || encodeTable == URL_SAFE_ENCODE_TABLE) {
decodeTable = DECODE_TABLE;
diff --git a/src/test/java/org/apache/commons/codec/binary/Base64Test.java b/src/test/java/org/apache/commons/codec/binary/Base64Test.java
index 3710082457..e801c919a3 100644
--- a/src/test/java/org/apache/commons/codec/binary/Base64Test.java
+++ b/src/test/java/org/apache/commons/codec/binary/Base64Test.java
@@ -242,6 +242,20 @@ public void testBuilderLineAttributes() {
assertEquals("Zm94\r\n", Base64.builder().setLineLength(4).get().encodeToString("fox".getBytes(CHARSET_UTF8)));
}
+ @Test
+ public void testBuilderPadingByte() {
+ assertNull(Base64.builder().get().getLineSeparator());
+ assertNull(Base64.builder().setLineSeparator(BaseNCodec.CHUNK_SEPARATOR).get().getLineSeparator());
+ assertArrayEquals(BaseNCodec.CHUNK_SEPARATOR, Base64.builder().setLineLength(4).setLineSeparator(BaseNCodec.CHUNK_SEPARATOR).get().getLineSeparator());
+ assertArrayEquals(BaseNCodec.CHUNK_SEPARATOR, Base64.builder().setLineLength(4).setLineSeparator(null).get().getLineSeparator());
+ assertArrayEquals(BaseNCodec.CHUNK_SEPARATOR, Base64.builder().setLineLength(10).setLineSeparator(null).get().getLineSeparator());
+ assertNull(Base64.builder().setLineLength(-1).setLineSeparator(null).get().getLineSeparator());
+ assertNull(Base64.builder().setLineLength(0).setLineSeparator(null).get().getLineSeparator());
+ assertArrayEquals(new byte[] { 1 }, Base64.builder().setLineLength(4).setLineSeparator((byte) 1).get().getLineSeparator());
+ assertEquals("VGhlIGJyb3duIGZveA==", Base64.builder().get().encodeToString("The brown fox".getBytes(CHARSET_UTF8)));
+ assertEquals("VGhlIGJyb3duIGZveA__", Base64.builder().setPadding((byte) '_').get().encodeToString("The brown fox".getBytes(CHARSET_UTF8)));
+ }
+
@Test
public void testBuilderUrlSafe() {
assertFalse(Base64.builder().get().isUrlSafe());
From d55b092d5f72aa9e039e122370332a16aa7f8f5f Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Tue, 16 Apr 2024 20:00:39 -0400
Subject: [PATCH 69/99] Internal refactoring
---
.../apache/commons/codec/binary/Base16.java | 22 ++++++++++++-------
1 file changed, 14 insertions(+), 8 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/Base16.java b/src/main/java/org/apache/commons/codec/binary/Base16.java
index 9d210dd794..65f75c42e0 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base16.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base16.java
@@ -133,17 +133,23 @@ public Base16(final boolean lowerCase) {
* Constructs a Base16 codec used for decoding and encoding.
*
* @param lowerCase if {@code true} then use a lower-case Base16 alphabet.
+ * @param encodeTable the encode table.
* @param decodingPolicy Decoding policy.
*/
- public Base16(final boolean lowerCase, final CodecPolicy decodingPolicy) {
+ private Base16(final boolean lowerCase, final byte[] encodeTable, final CodecPolicy decodingPolicy) {
super(BYTES_PER_UNENCODED_BLOCK, BYTES_PER_ENCODED_BLOCK, 0, 0, PAD_DEFAULT, decodingPolicy);
- if (lowerCase) {
- this.encodeTable = LOWER_CASE_ENCODE_TABLE;
- this.decodeTable = LOWER_CASE_DECODE_TABLE;
- } else {
- this.encodeTable = UPPER_CASE_ENCODE_TABLE;
- this.decodeTable = UPPER_CASE_DECODE_TABLE;
- }
+ this.encodeTable = encodeTable;
+ this.decodeTable = encodeTable == LOWER_CASE_ENCODE_TABLE ? LOWER_CASE_DECODE_TABLE : UPPER_CASE_DECODE_TABLE;
+ }
+
+ /**
+ * Constructs a Base16 codec used for decoding and encoding.
+ *
+ * @param lowerCase if {@code true} then use a lower-case Base16 alphabet.
+ * @param decodingPolicy Decoding policy.
+ */
+ public Base16(final boolean lowerCase, final CodecPolicy decodingPolicy) {
+ this(lowerCase, lowerCase ? LOWER_CASE_ENCODE_TABLE : UPPER_CASE_ENCODE_TABLE, decodingPolicy);
}
@Override
From ca8c427f3d0b671af266aba076d4ab4ce066a26f Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Wed, 17 Apr 2024 22:34:07 -0400
Subject: [PATCH 70/99] Javadoc
---
.../org/apache/commons/codec/binary/Base32.java | 12 ++++++++++++
.../org/apache/commons/codec/binary/Base64.java | 13 +++++++++++++
2 files changed, 25 insertions(+)
diff --git a/src/main/java/org/apache/commons/codec/binary/Base32.java b/src/main/java/org/apache/commons/codec/binary/Base32.java
index 61ca1140fd..ea03aacd29 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32.java
@@ -36,6 +36,18 @@
*
* This class is thread-safe.
*
+ *
+ * You can configure instances with the {@link Builder}.
+ *
+ *
+ * Base32 base32 = Base32.builder()
+ * .setDecodingPolicy(DecodingPolicy.LENIENT) // default is lenient
+ * .setEncodeTable(customEncodeTable)
+ * .setLineLength(0) // default is none
+ * .setLineSeparator('\r', '\n') // default is CR LF
+ * .setPadding('=') // default is =
+ * .get()
+ *
*
* @see RFC 4648
* @since 1.5
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64.java b/src/main/java/org/apache/commons/codec/binary/Base64.java
index 57a650533a..1654b40d9c 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -50,6 +50,19 @@
*
* This class is thread-safe.
*
+ *
+ * You can configure instances with the {@link Builder}.
+ *
+ *
+ * Base64 base64 = Base64.builder()
+ * .setDecodingPolicy(DecodingPolicy.LENIENT) // default is lenient, null resets to default
+ * .setEncodeTable(customEncodeTable) // default is built in, null resets to default
+ * .setLineLength(0) // default is none
+ * .setLineSeparator('\r', '\n') // default is CR LF, null resets to default
+ * .setPadding('=') // default is =
+ * .setUrlSafe(false) // default is false
+ * .get()
+ *
*
* @see RFC 2045
* @since 1.0
From 09c7a8ad23a60b60c8cc82812e238a6cd2f91b11 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Thu, 18 Apr 2024 15:21:42 -0400
Subject: [PATCH 71/99] Javadoc: Close HTML tags
---
src/main/java/org/apache/commons/codec/binary/Base32.java | 2 +-
src/main/java/org/apache/commons/codec/binary/Base64.java | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/Base32.java b/src/main/java/org/apache/commons/codec/binary/Base32.java
index ea03aacd29..47f136f8b5 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32.java
@@ -38,7 +38,7 @@
*
*
* You can configure instances with the {@link Builder}.
- *
+ *
*
* Base32 base32 = Base32.builder()
* .setDecodingPolicy(DecodingPolicy.LENIENT) // default is lenient
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64.java b/src/main/java/org/apache/commons/codec/binary/Base64.java
index 1654b40d9c..0d99df7e9b 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -52,7 +52,7 @@
*
*
* You can configure instances with the {@link Builder}.
- *
+ *
*
* Base64 base64 = Base64.builder()
* .setDecodingPolicy(DecodingPolicy.LENIENT) // default is lenient, null resets to default
From 7a96c0da42ada5c36d6aab31704eb61c779e2da3 Mon Sep 17 00:00:00 2001
From: Elliotte Rusty Harold
Date: Thu, 18 Apr 2024 19:21:56 +0000
Subject: [PATCH 72/99] [CODEC-263] test for user reported issue (#240)
* test for user reported issue
* test isBase64
* Add Javadoc
* Fix whitespace
---------
Co-authored-by: Gary Gregory
---
.../java/org/apache/commons/codec/binary/Base64Test.java | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/src/test/java/org/apache/commons/codec/binary/Base64Test.java b/src/test/java/org/apache/commons/codec/binary/Base64Test.java
index e801c919a3..0c1cbb929e 100644
--- a/src/test/java/org/apache/commons/codec/binary/Base64Test.java
+++ b/src/test/java/org/apache/commons/codec/binary/Base64Test.java
@@ -1403,6 +1403,14 @@ public void testUrlSafe() {
}
+ /**
+ * Tests CODEC-263.
+ */
+ public void testCodec263() {
+ Base64.decodeBase64("publishMessage");
+ assertTrue(Base64.isBase64("publishMessage"));
+ }
+
/**
* Base64 encoding of UUID's is a common use-case, especially in URL-SAFE
* mode. This test case ends up being the "URL-SAFE" JUnit's.
From 448bd190566690a0cebce6680ef86b7c2670a556 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Thu, 18 Apr 2024 15:22:36 -0400
Subject: [PATCH 73/99] Sort members
---
.../apache/commons/codec/binary/Base64Test.java | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/src/test/java/org/apache/commons/codec/binary/Base64Test.java b/src/test/java/org/apache/commons/codec/binary/Base64Test.java
index 0c1cbb929e..e96e9fa790 100644
--- a/src/test/java/org/apache/commons/codec/binary/Base64Test.java
+++ b/src/test/java/org/apache/commons/codec/binary/Base64Test.java
@@ -305,6 +305,14 @@ public void testCodec112() { // size calculation assumes always chunked
// TODO Assert??
}
+ /**
+ * Tests CODEC-263.
+ */
+ public void testCodec263() {
+ Base64.decodeBase64("publishMessage");
+ assertTrue(Base64.isBase64("publishMessage"));
+ }
+
/**
* Test for CODEC-265: Encode a 1GiB file.
*
@@ -1403,14 +1411,6 @@ public void testUrlSafe() {
}
- /**
- * Tests CODEC-263.
- */
- public void testCodec263() {
- Base64.decodeBase64("publishMessage");
- assertTrue(Base64.isBase64("publishMessage"));
- }
-
/**
* Base64 encoding of UUID's is a common use-case, especially in URL-SAFE
* mode. This test case ends up being the "URL-SAFE" JUnit's.
From 457e5cced55c2fd4ab4c68293edf29e89de7daae Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Thu, 18 Apr 2024 15:26:16 -0400
Subject: [PATCH 74/99] Update URL
---
.../java/org/apache/commons/codec/language/DoubleMetaphone.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java b/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
index 18c3c8f286..1597fc3093 100644
--- a/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
+++ b/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
@@ -31,7 +31,7 @@
* of the value between threads, and must not invoke {@link #setMaxCodeLen(int)} after initial setup.
*
*
- * @see Original Article
+ * @see Original Article
* @see https://en.wikipedia.org/wiki/Metaphone
*/
public class DoubleMetaphone implements StringEncoder {
From 000817ee10b1aee72f2cc3ab9ea844afcaea466e Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Thu, 18 Apr 2024 15:27:05 -0400
Subject: [PATCH 75/99] Better link text
---
.../org/apache/commons/codec/language/DoubleMetaphone.java | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java b/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
index 1597fc3093..f7f84d72c5 100644
--- a/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
+++ b/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
@@ -31,8 +31,8 @@
* of the value between threads, and must not invoke {@link #setMaxCodeLen(int)} after initial setup.
*
*
- * @see Original Article
- * @see https://en.wikipedia.org/wiki/Metaphone
+ * @see Dr. Dobbs Original Article
+ * @see Wikipedia Metaphone
*/
public class DoubleMetaphone implements StringEncoder {
From 5c7fac8b95c609bffe0aed1e4a0bf3f23d3926ff Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Thu, 18 Apr 2024 15:39:04 -0400
Subject: [PATCH 76/99] Format and no need to throw
---
.../apache/commons/codec/language/DoubleMetaphoneTest.java | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/test/java/org/apache/commons/codec/language/DoubleMetaphoneTest.java b/src/test/java/org/apache/commons/codec/language/DoubleMetaphoneTest.java
index ab75fd04e6..bc4de19fa0 100644
--- a/src/test/java/org/apache/commons/codec/language/DoubleMetaphoneTest.java
+++ b/src/test/java/org/apache/commons/codec/language/DoubleMetaphoneTest.java
@@ -1061,14 +1061,14 @@ public void testCCedilla() {
}
@Test
- public void testCodec184() throws Throwable {
+ public void testCodec184() {
assertTrue(new DoubleMetaphone().isDoubleMetaphoneEqual("", "", false));
assertTrue(new DoubleMetaphone().isDoubleMetaphoneEqual("", "", true));
assertFalse(new DoubleMetaphone().isDoubleMetaphoneEqual("aa", "", false));
assertFalse(new DoubleMetaphone().isDoubleMetaphoneEqual("aa", "", true));
assertFalse(new DoubleMetaphone().isDoubleMetaphoneEqual("", "aa", false));
assertFalse(new DoubleMetaphone().isDoubleMetaphoneEqual("", "aa", true));
- }
+ }
@Test
public void testDoubleMetaphone() {
From f01b7329ce99e33819eda1e3c3d8dca458ebb1f5 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Thu, 18 Apr 2024 15:43:36 -0400
Subject: [PATCH 77/99] List fixes first
---
src/changes/changes.xml | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 024f3d9250..8db327adef 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -44,16 +44,16 @@ The type attribute can be add,update,fix,remove.
+
+ Optimize memory allocation in PhoneticEngine.
+ BCodec and QCodec encode() methods throw UnsupportedCharsetException instead of EncoderException.
+ Set Javadoc link to latest Java API LTS version.
Add override org.apache.commons.codec.language.bm.Rule.PhonemeExpr.size().
Add support for Base64 custom alphabets #266.
Add Base64.Builder (allows custom alphabets).
Add Base32.Builder (allows custom alphabets).
Add Base64 support for a custom padding byte (like Base32).
-
- Optimize memory allocation in PhoneticEngine.
- BCodec and QCodec encode() methods throw UnsupportedCharsetException instead of EncoderException.
- Set Javadoc link to latest Java API LTS version.
Bump org.apache.commons:commons-parent from 66 to 69 #250, #261.
Bump commons-io:commons-io from 2.15.1 to 2.16.1 #258, #265.
From beb39d4e003d0d9e8e3eff02c3529c87e7a4af03 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Thu, 18 Apr 2024 15:49:46 -0400
Subject: [PATCH 78/99] Wrong output of DoubleMetaphone in 1.16.1
---
src/changes/changes.xml | 1 +
.../org/apache/commons/codec/language/DoubleMetaphone.java | 1 +
.../apache/commons/codec/language/DoubleMetaphoneTest.java | 5 +++++
3 files changed, 7 insertions(+)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 8db327adef..359a4155ba 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -45,6 +45,7 @@ The type attribute can be add,update,fix,remove.
+ Wrong output of DoubleMetaphone in 1.16.1.
Optimize memory allocation in PhoneticEngine.
BCodec and QCodec encode() methods throw UnsupportedCharsetException instead of EncoderException.
Set Javadoc link to latest Java API LTS version.
diff --git a/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java b/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
index f7f84d72c5..4dd8fd3376 100644
--- a/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
+++ b/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
@@ -617,6 +617,7 @@ private int handleG(final String value, final DoubleMetaphoneResult result, int
private int handleGH(final String value, final DoubleMetaphoneResult result, int index) {
if (index > 0 && !isVowel(charAt(value, index - 1))) {
result.append('K');
+ index += 2;
} else if (index == 0) {
if (charAt(value, index + 2) == 'I') {
result.append('J');
diff --git a/src/test/java/org/apache/commons/codec/language/DoubleMetaphoneTest.java b/src/test/java/org/apache/commons/codec/language/DoubleMetaphoneTest.java
index bc4de19fa0..0efcfb85b8 100644
--- a/src/test/java/org/apache/commons/codec/language/DoubleMetaphoneTest.java
+++ b/src/test/java/org/apache/commons/codec/language/DoubleMetaphoneTest.java
@@ -1070,6 +1070,11 @@ public void testCodec184() {
assertFalse(new DoubleMetaphone().isDoubleMetaphoneEqual("", "aa", true));
}
+ @Test
+ public void testCodec320() {
+ assertTrue(new DoubleMetaphone().isDoubleMetaphoneEqual("ANGHELINA", "ANKL", false));
+ }
+
@Test
public void testDoubleMetaphone() {
assertDoubleMetaphone("TSTN", "testing");
From 35c9e80599053c32ed3a77eb7791fe8fb1fd1e98 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Fri, 19 Apr 2024 07:58:29 -0400
Subject: [PATCH 79/99] Whitespace
---
.../org/apache/commons/codec/binary/CharSequenceUtils.java | 5 -----
1 file changed, 5 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/CharSequenceUtils.java b/src/main/java/org/apache/commons/codec/binary/CharSequenceUtils.java
index 43e99fb39f..1868b0b2e6 100644
--- a/src/main/java/org/apache/commons/codec/binary/CharSequenceUtils.java
+++ b/src/main/java/org/apache/commons/codec/binary/CharSequenceUtils.java
@@ -59,26 +59,21 @@ static boolean regionMatches(final CharSequence cs, final boolean ignoreCase, fi
int index1 = thisStart;
int index2 = start;
int tmpLen = length;
-
while (tmpLen-- > 0) {
final char c1 = cs.charAt(index1++);
final char c2 = substring.charAt(index2++);
-
if (c1 == c2) {
continue;
}
-
if (!ignoreCase) {
return false;
}
-
// The same check as in String.regionMatches():
if (Character.toUpperCase(c1) != Character.toUpperCase(c2) &&
Character.toLowerCase(c1) != Character.toLowerCase(c2)) {
return false;
}
}
-
return true;
}
}
From 78e08b914a9e2663453af5c7986d6d0ab3b9dc9b Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Fri, 19 Apr 2024 07:59:20 -0400
Subject: [PATCH 80/99] Whitespace
---
src/main/java/org/apache/commons/codec/binary/Hex.java | 10 ++--------
1 file changed, 2 insertions(+), 8 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/Hex.java b/src/main/java/org/apache/commons/codec/binary/Hex.java
index 6dfc28ee8a..968e85bbc9 100644
--- a/src/main/java/org/apache/commons/codec/binary/Hex.java
+++ b/src/main/java/org/apache/commons/codec/binary/Hex.java
@@ -54,14 +54,12 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
/**
* Used to build output as hex.
*/
- private static final char[] DIGITS_LOWER = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd',
- 'e', 'f' };
+ private static final char[] DIGITS_LOWER = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
/**
* Used to build output as hex.
*/
- private static final char[] DIGITS_UPPER = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D',
- 'E', 'F' };
+ private static final char[] DIGITS_UPPER = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F' };
/**
* Converts an array of characters representing hexadecimal values into an array of bytes of those same values. The
@@ -92,16 +90,13 @@ public static byte[] decodeHex(final char[] data) throws DecoderException {
*/
public static int decodeHex(final char[] data, final byte[] out, final int outOffset) throws DecoderException {
final int len = data.length;
-
if ((len & 0x01) != 0) {
throw new DecoderException("Odd number of characters.");
}
-
final int outLen = len >> 1;
if (out.length - outOffset < outLen) {
throw new DecoderException("Output array is not large enough to accommodate decoded data.");
}
-
// two characters form the hex value.
for (int i = outOffset, j = 0; j < len; i++) {
int f = toDigit(data[j], j) << 4;
@@ -110,7 +105,6 @@ public static int decodeHex(final char[] data, final byte[] out, final int outOf
j++;
out[i] = (byte) (f & 0xFF);
}
-
return outLen;
}
From 873ecaa7a291c81ed7c418c7b187ff9e99abbc89 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Fri, 19 Apr 2024 08:13:03 -0400
Subject: [PATCH 81/99] Internal refactoring
---
.../org/apache/commons/codec/binary/Hex.java | 19 +++++++------------
1 file changed, 7 insertions(+), 12 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/Hex.java b/src/main/java/org/apache/commons/codec/binary/Hex.java
index 968e85bbc9..754e74457b 100644
--- a/src/main/java/org/apache/commons/codec/binary/Hex.java
+++ b/src/main/java/org/apache/commons/codec/binary/Hex.java
@@ -161,9 +161,7 @@ public static char[] encodeHex(final byte[] data, final boolean toLowerCase) {
*/
protected static char[] encodeHex(final byte[] data, final char[] toDigits) {
final int dataLength = data.length;
- final char[] out = new char[dataLength << 1];
- encodeHex(data, 0, dataLength, toDigits, out, 0);
- return out;
+ return encodeHex(data, 0, dataLength, toDigits, new char[dataLength << 1], 0);
}
/**
@@ -177,11 +175,8 @@ protected static char[] encodeHex(final byte[] data, final char[] toDigits) {
* upper- or lower-case hex.
* @since 1.15
*/
- public static char[] encodeHex(final byte[] data, final int dataOffset, final int dataLen,
- final boolean toLowerCase) {
- final char[] out = new char[dataLen << 1];
- encodeHex(data, dataOffset, dataLen, toLowerCase ? DIGITS_LOWER : DIGITS_UPPER, out, 0);
- return out;
+ public static char[] encodeHex(final byte[] data, final int dataOffset, final int dataLen, final boolean toLowerCase) {
+ return encodeHex(data, dataOffset, dataLen, toLowerCase ? DIGITS_LOWER : DIGITS_UPPER, new char[dataLen << 1], 0);
}
/**
@@ -195,8 +190,7 @@ public static char[] encodeHex(final byte[] data, final int dataOffset, final in
* @param outOffset the position within {@code out} at which to start writing the encoded characters.
* @since 1.15
*/
- public static void encodeHex(final byte[] data, final int dataOffset, final int dataLen,
- final boolean toLowerCase, final char[] out, final int outOffset) {
+ public static void encodeHex(final byte[] data, final int dataOffset, final int dataLen, final boolean toLowerCase, final char[] out, final int outOffset) {
encodeHex(data, dataOffset, dataLen, toLowerCase ? DIGITS_LOWER : DIGITS_UPPER, out, outOffset);
}
@@ -209,14 +203,15 @@ public static void encodeHex(final byte[] data, final int dataOffset, final int
* @param toDigits the output alphabet (must contain at least 16 chars)
* @param out a char[] which will hold the resultant appropriate characters from the alphabet.
* @param outOffset the position within {@code out} at which to start writing the encoded characters.
+ * @return the given {@code out}.
*/
- private static void encodeHex(final byte[] data, final int dataOffset, final int dataLen, final char[] toDigits,
- final char[] out, final int outOffset) {
+ private static char[] encodeHex(final byte[] data, final int dataOffset, final int dataLen, final char[] toDigits, final char[] out, final int outOffset) {
// two characters form the hex value.
for (int i = dataOffset, j = outOffset; i < dataOffset + dataLen; i++) {
out[j++] = toDigits[(0xF0 & data[i]) >>> 4];
out[j++] = toDigits[0x0F & data[i]];
}
+ return out;
}
/**
From 86d10456047e21f7135f5de7f96e8adfc941cd39 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Fri, 19 Apr 2024 08:24:40 -0400
Subject: [PATCH 82/99] Internal refactoring
---
.../org/apache/commons/codec/binary/Hex.java | 18 ++++++++++++++----
1 file changed, 14 insertions(+), 4 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/Hex.java b/src/main/java/org/apache/commons/codec/binary/Hex.java
index 754e74457b..dc6d0806b6 100644
--- a/src/main/java/org/apache/commons/codec/binary/Hex.java
+++ b/src/main/java/org/apache/commons/codec/binary/Hex.java
@@ -145,7 +145,7 @@ public static char[] encodeHex(final byte[] data) {
* @since 1.4
*/
public static char[] encodeHex(final byte[] data, final boolean toLowerCase) {
- return encodeHex(data, toLowerCase ? DIGITS_LOWER : DIGITS_UPPER);
+ return encodeHex(data, toAlphabet(toLowerCase));
}
/**
@@ -176,7 +176,7 @@ protected static char[] encodeHex(final byte[] data, final char[] toDigits) {
* @since 1.15
*/
public static char[] encodeHex(final byte[] data, final int dataOffset, final int dataLen, final boolean toLowerCase) {
- return encodeHex(data, dataOffset, dataLen, toLowerCase ? DIGITS_LOWER : DIGITS_UPPER, new char[dataLen << 1], 0);
+ return encodeHex(data, dataOffset, dataLen, toAlphabet(toLowerCase), new char[dataLen << 1], 0);
}
/**
@@ -191,7 +191,7 @@ public static char[] encodeHex(final byte[] data, final int dataOffset, final in
* @since 1.15
*/
public static void encodeHex(final byte[] data, final int dataOffset, final int dataLen, final boolean toLowerCase, final char[] out, final int outOffset) {
- encodeHex(data, dataOffset, dataLen, toLowerCase ? DIGITS_LOWER : DIGITS_UPPER, out, outOffset);
+ encodeHex(data, dataOffset, dataLen, toAlphabet(toLowerCase), out, outOffset);
}
/**
@@ -244,7 +244,7 @@ public static char[] encodeHex(final ByteBuffer data) {
* @since 1.11
*/
public static char[] encodeHex(final ByteBuffer data, final boolean toLowerCase) {
- return encodeHex(data, toLowerCase ? DIGITS_LOWER : DIGITS_UPPER);
+ return encodeHex(data, toAlphabet(toLowerCase));
}
/**
@@ -321,6 +321,16 @@ public static String encodeHexString(final ByteBuffer data, final boolean toLowe
return new String(encodeHex(data, toLowerCase));
}
+ /**
+ * Converts a boolean to an alphabet.
+ *
+ * @param toLowerCase true for lowercase, false for uppercase.
+ * @return an alphabet.
+ */
+ private static char[] toAlphabet(final boolean toLowerCase) {
+ return toLowerCase ? DIGITS_LOWER : DIGITS_UPPER;
+ }
+
/**
* Convert the byte buffer to a byte array. All bytes identified by
* {@link ByteBuffer#remaining()} will be used.
From 0c7c76fed2c5b1c675fdf5b7e809175fa7b0bede Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Fri, 19 Apr 2024 08:27:31 -0400
Subject: [PATCH 83/99] Javadoc
Whitespace
---
.../apache/commons/codec/binary/BaseNCodecInputStream.java | 5 +----
1 file changed, 1 insertion(+), 4 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java b/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java
index bf0feb4727..1a4c72c4ef 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java
@@ -70,7 +70,6 @@ public int available() throws IOException {
// as long as we have not reached EOF, indicate that there is more
// data available. As we do not know for sure how much data is left,
// just return 1 as a safe guess.
-
return context.eof ? 0 : 1;
}
@@ -209,6 +208,7 @@ public int read(final byte[] array, final int offset, final int len) throws IOEx
* Repositions this stream to the position at the time the mark method was last called on this input stream.
*
* The {@link #reset} method of {@link BaseNCodecInputStream} does nothing except throw an {@link IOException}.
+ *
*
* @throws IOException if this method is invoked
* @since 1.7
@@ -229,11 +229,9 @@ public long skip(final long n) throws IOException {
if (n < 0) {
throw new IllegalArgumentException("Negative skip length: " + n);
}
-
// skip in chunks of 512 bytes
final byte[] b = new byte[512];
long todo = n;
-
while (todo > 0) {
int len = (int) Math.min(b.length, todo);
len = this.read(b, 0, len);
@@ -242,7 +240,6 @@ public long skip(final long n) throws IOException {
}
todo -= len;
}
-
return n - todo;
}
}
From cfa7c4188ad67f08ae9cfb9007e234bca26a7bf7 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Fri, 19 Apr 2024 08:30:47 -0400
Subject: [PATCH 84/99] Javadoc
Whitespace
---
src/main/java/org/apache/commons/codec/binary/Base64.java | 2 --
1 file changed, 2 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64.java b/src/main/java/org/apache/commons/codec/binary/Base64.java
index 0d99df7e9b..dc5c2b3bc5 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -503,7 +503,6 @@ private static byte[] toUrlSafeEncodeTable(final boolean urlSafe) {
*
* When encoding the line length is 0 (no chunking), and the encoding table is STANDARD_ENCODE_TABLE.
*
- *
*
* When decoding all variants are supported.
*
@@ -517,7 +516,6 @@ public Base64() {
*
* When encoding the line length is 76, the line separator is CRLF, and the encoding table is STANDARD_ENCODE_TABLE.
*
- *
*
* When decoding all variants are supported.
*
From 249037646efcc70b09495f2ff3e79b6ab3bc6460 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Fri, 19 Apr 2024 08:32:53 -0400
Subject: [PATCH 85/99] Fix indentation
---
.../org/apache/commons/codec/digest/B64.java | 24 +++++++++----------
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/digest/B64.java b/src/main/java/org/apache/commons/codec/digest/B64.java
index a0973f5bdf..5627570d62 100644
--- a/src/main/java/org/apache/commons/codec/digest/B64.java
+++ b/src/main/java/org/apache/commons/codec/digest/B64.java
@@ -66,18 +66,18 @@ static void b64from24bit(final byte b2, final byte b1, final byte b0, final int
}
}
- /**
- * Generates a string of random chars from the B64T set.
- *
- * The salt is generated with {@link SecureRandom}.
- *
- *
- * @param num Number of chars to generate.
- * @return a random salt {@link String}.
- */
- static String getRandomSalt(final int num) {
- return getRandomSalt(num, new SecureRandom());
- }
+ /**
+ * Generates a string of random chars from the B64T set.
+ *
+ * The salt is generated with {@link SecureRandom}.
+ *
+ *
+ * @param num Number of chars to generate.
+ * @return a random salt {@link String}.
+ */
+ static String getRandomSalt(final int num) {
+ return getRandomSalt(num, new SecureRandom());
+ }
/**
* Generates a string of random chars from the B64T set.
From be58b03b926e6472454ba87af39672005da488a5 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Fri, 19 Apr 2024 08:45:19 -0400
Subject: [PATCH 86/99] Format tweaks
Longer lines
---
.../apache/commons/codec/digest/Blake3.java | 42 +++----
.../commons/codec/digest/HmacUtils.java | 2 -
.../commons/codec/digest/PureJavaCrc32.java | 118 +++++++++---------
3 files changed, 77 insertions(+), 85 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/digest/Blake3.java b/src/main/java/org/apache/commons/codec/digest/Blake3.java
index dcbc6ea8b4..ba6cceedf4 100644
--- a/src/main/java/org/apache/commons/codec/digest/Blake3.java
+++ b/src/main/java/org/apache/commons/codec/digest/Blake3.java
@@ -76,6 +76,7 @@
public final class Blake3 {
private static final class ChunkState {
+
private int[] chainingValue;
private final long chunkCounter;
private final int flags;
@@ -209,20 +210,20 @@ private void reset() {
state = new ChunkState(key, 0, flags);
}
}
+
/**
* Represents the state just prior to either producing an eight word chaining value or any number of output bytes
* when the ROOT flag is set.
*/
private static final class Output {
+
private final int[] inputChainingValue;
private final int[] blockWords;
private final long counter;
private final int blockLength;
private final int flags;
- private Output(
- final int[] inputChainingValue, final int[] blockWords, final long counter, final int blockLength,
- final int flags) {
+ private Output(final int[] inputChainingValue, final int[] blockWords, final long counter, final int blockLength, final int flags) {
this.inputChainingValue = inputChainingValue;
this.blockWords = blockWords;
this.counter = counter;
@@ -231,8 +232,7 @@ private Output(
}
private int[] chainingValue() {
- return Arrays
- .copyOf(compress(inputChainingValue, blockWords, blockLength, counter, flags), CHAINING_VALUE_INTS);
+ return Arrays.copyOf(compress(inputChainingValue, blockWords, blockLength, counter, flags), CHAINING_VALUE_INTS);
}
private void rootOutputBytes(final byte[] out, int offset, int length) {
@@ -240,8 +240,7 @@ private void rootOutputBytes(final byte[] out, int offset, int length) {
while (length > 0) {
int chunkLength = Math.min(OUT_LEN * 2, length);
length -= chunkLength;
- final int[] words =
- compress(inputChainingValue, blockWords, blockLength, outputBlockCounter++, flags | ROOT);
+ final int[] words = compress(inputChainingValue, blockWords, blockLength, outputBlockCounter++, flags | ROOT);
int wordCounter = 0;
while (chunkLength > 0) {
final int wordLength = Math.min(Integer.BYTES, chunkLength);
@@ -252,35 +251,33 @@ private void rootOutputBytes(final byte[] out, int offset, int length) {
}
}
}
+
private static final int BLOCK_LEN = 64;
private static final int BLOCK_INTS = BLOCK_LEN / Integer.BYTES;
private static final int KEY_LEN = 32;
private static final int KEY_INTS = KEY_LEN / Integer.BYTES;
-
private static final int OUT_LEN = 32;
-
private static final int CHUNK_LEN = 1024;
private static final int CHAINING_VALUE_INTS = 8;
+
/**
* Standard hash key used for plain hashes; same initialization vector as Blake2s.
*/
- private static final int[] IV =
- { 0x6A09E667, 0xBB67AE85, 0x3C6EF372, 0xA54FF53A, 0x510E527F, 0x9B05688C, 0x1F83D9AB, 0x5BE0CD19 };
+ private static final int[] IV = { 0x6A09E667, 0xBB67AE85, 0x3C6EF372, 0xA54FF53A, 0x510E527F, 0x9B05688C, 0x1F83D9AB, 0x5BE0CD19 };
+
// domain flags
private static final int CHUNK_START = 1;
private static final int CHUNK_END = 1 << 1;
private static final int PARENT = 1 << 2;
private static final int ROOT = 1 << 3;
-
private static final int KEYED_HASH = 1 << 4;
-
private static final int DERIVE_KEY_CONTEXT = 1 << 5;
-
private static final int DERIVE_KEY_MATERIAL = 1 << 6;
/**
* Pre-permuted for all 7 rounds; the second row (2,6,3,...) indicates the base permutation.
*/
+ // @formatter:off
private static final byte[][] MSG_SCHEDULE = {
{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 },
{ 2, 6, 3, 10, 7, 0, 4, 13, 1, 11, 12, 5, 9, 14, 15, 8 },
@@ -290,6 +287,7 @@ private void rootOutputBytes(final byte[] out, int offset, int length) {
{ 9, 14, 11, 5, 8, 12, 15, 1, 13, 3, 0, 10, 2, 6, 4, 7 },
{ 11, 15, 5, 0, 1, 9, 8, 6, 14, 10, 2, 12, 3, 4, 7, 13 }
};
+ // @formatter:on
private static void checkBufferArgs(final byte[] buffer, final int offset, final int length) {
Objects.requireNonNull(buffer);
@@ -301,14 +299,11 @@ private static void checkBufferArgs(final byte[] buffer, final int offset, final
}
final int bufferLength = buffer.length;
if (offset > bufferLength - length) {
- throw new IndexOutOfBoundsException(
- "Offset " + offset + " and length " + length + " out of bounds with buffer length " + bufferLength);
+ throw new IndexOutOfBoundsException("Offset " + offset + " and length " + length + " out of bounds with buffer length " + bufferLength);
}
}
- private static int[] compress(
- final int[] chainingValue, final int[] blockWords, final int blockLength, final long counter,
- final int flags) {
+ private static int[] compress(final int[] chainingValue, final int[] blockWords, final int blockLength, final long counter, final int flags) {
final int[] state = Arrays.copyOf(chainingValue, BLOCK_INTS);
System.arraycopy(IV, 0, state, 8, 4);
state[12] = (int) counter;
@@ -329,8 +324,7 @@ private static int[] compress(
/**
* The mixing function, G, which mixes either a column or a diagonal.
*/
- private static void g(
- final int[] state, final int a, final int b, final int c, final int d, final int mx, final int my) {
+ private static void g(final int[] state, final int a, final int b, final int c, final int d, final int mx, final int my) {
state[a] += state[b] + mx;
state[d] = Integer.rotateRight(state[d] ^ state[a], 16);
state[c] += state[d];
@@ -414,13 +408,11 @@ private static void packInt(final int value, final byte[] dst, final int off, fi
}
}
- private static int[] parentChainingValue(
- final int[] leftChildCV, final int[] rightChildCV, final int[] key, final int flags) {
+ private static int[] parentChainingValue(final int[] leftChildCV, final int[] rightChildCV, final int[] key, final int flags) {
return parentOutput(leftChildCV, rightChildCV, key, flags).chainingValue();
}
- private static Output parentOutput(
- final int[] leftChildCV, final int[] rightChildCV, final int[] key, final int flags) {
+ private static Output parentOutput(final int[] leftChildCV, final int[] rightChildCV, final int[] key, final int flags) {
final int[] blockWords = Arrays.copyOf(leftChildCV, BLOCK_INTS);
System.arraycopy(rightChildCV, 0, blockWords, 8, CHAINING_VALUE_INTS);
return new Output(key.clone(), blockWords, 0, BLOCK_LEN, flags | PARENT);
diff --git a/src/main/java/org/apache/commons/codec/digest/HmacUtils.java b/src/main/java/org/apache/commons/codec/digest/HmacUtils.java
index 1f298349d9..38cb141011 100644
--- a/src/main/java/org/apache/commons/codec/digest/HmacUtils.java
+++ b/src/main/java/org/apache/commons/codec/digest/HmacUtils.java
@@ -196,11 +196,9 @@ public static Mac getInitializedMac(final HmacAlgorithms algorithm, final byte[]
* when a {@link NoSuchAlgorithmException} is caught or key is null or key is invalid.
*/
public static Mac getInitializedMac(final String algorithm, final byte[] key) {
-
if (key == null) {
throw new IllegalArgumentException("Null key");
}
-
try {
final SecretKeySpec keySpec = new SecretKeySpec(key, algorithm);
final Mac mac = Mac.getInstance(algorithm);
diff --git a/src/main/java/org/apache/commons/codec/digest/PureJavaCrc32.java b/src/main/java/org/apache/commons/codec/digest/PureJavaCrc32.java
index c0845e64aa..5cb3a48830 100644
--- a/src/main/java/org/apache/commons/codec/digest/PureJavaCrc32.java
+++ b/src/main/java/org/apache/commons/codec/digest/PureJavaCrc32.java
@@ -49,6 +49,7 @@ public class PureJavaCrc32 implements Checksum {
* CRC-32 lookup tables generated by the polynomial 0xEDB88320.
* See also TestPureJavaCrc32.Table.
*/
+ // @formatter:off
private static final int[] T = {
/* T8_0 */
0x00000000, 0x77073096, 0xEE0E612C, 0x990951BA,
@@ -571,74 +572,75 @@ public class PureJavaCrc32 implements Checksum {
0x2C8E0FFF, 0xE0240F61, 0x6EAB0882, 0xA201081C,
0xA8C40105, 0x646E019B, 0xEAE10678, 0x264B06E6
};
+ // @formatter:on
- /** The current CRC value, bit-flipped */
- private int crc;
+ /** The current CRC value, bit-flipped */
+ private int crc;
- /** Create a new PureJavaCrc32 object. */
- public PureJavaCrc32() {
- resetCrc();
- }
+ /** Create a new PureJavaCrc32 object. */
+ public PureJavaCrc32() {
+ resetCrc();
+ }
+
+ @Override
+ public long getValue() {
+ return ~crc & 0xffffffffL;
+ }
+
+ @Override
+ public void reset() {
+ resetCrc();
+ }
- @Override
- public long getValue() {
- return ~crc & 0xffffffffL;
- }
+ // called by ctor, so must not be overrideable
+ private void resetCrc() {
+ crc = 0xffffffff;
+ }
- @Override
- public void reset() {
- resetCrc();
- }
+ @Override
+ public void update(final byte[] b, final int offset, final int len) {
+ int localCrc = crc;
- // called by ctor, so must not be overrideable
- private void resetCrc() {
- crc = 0xffffffff;
- }
+ final int remainder = len & 0x7;
+ int i = offset;
+ for (final int end = offset + len - remainder; i < end; i += 8) {
+ final int x = localCrc ^
+ (b[i] << 24 >>> 24) + (b[i + 1] << 24 >>> 16) +
+ (b[i + 2] << 24 >>> 8) + (b[i + 3] << 24);
- @Override
- public void update(final byte[] b, final int offset, final int len) {
- int localCrc = crc;
+ localCrc = T[(x << 24 >>> 24) + 0x700] ^ T[(x << 16 >>> 24) + 0x600] ^
+ T[(x << 8 >>> 24) + 0x500] ^ T[ (x >>> 24) + 0x400] ^
+ T[(b[i + 4] << 24 >>> 24) + 0x300] ^ T[(b[i + 5] << 24 >>> 24) + 0x200] ^
+ T[(b[i + 6] << 24 >>> 24) + 0x100] ^ T[b[i + 7] << 24 >>> 24];
+ }
- final int remainder = len & 0x7;
- int i = offset;
- for (final int end = offset + len - remainder; i < end; i += 8) {
- final int x = localCrc ^
- (b[i] << 24 >>> 24) + (b[i + 1] << 24 >>> 16) +
- (b[i + 2] << 24 >>> 8) + (b[i + 3] << 24);
+ /* loop unroll - duff's device style */
+ switch (remainder) {
+ case 7:
+ localCrc = localCrc >>> 8 ^ T[(localCrc ^ b[i++]) << 24 >>> 24];
+ case 6:
+ localCrc = localCrc >>> 8 ^ T[(localCrc ^ b[i++]) << 24 >>> 24];
+ case 5:
+ localCrc = localCrc >>> 8 ^ T[(localCrc ^ b[i++]) << 24 >>> 24];
+ case 4:
+ localCrc = localCrc >>> 8 ^ T[(localCrc ^ b[i++]) << 24 >>> 24];
+ case 3:
+ localCrc = localCrc >>> 8 ^ T[(localCrc ^ b[i++]) << 24 >>> 24];
+ case 2:
+ localCrc = localCrc >>> 8 ^ T[(localCrc ^ b[i++]) << 24 >>> 24];
+ case 1:
+ localCrc = localCrc >>> 8 ^ T[(localCrc ^ b[i++]) << 24 >>> 24];
+ default:
+ /* nothing */
+ }
- localCrc = T[(x << 24 >>> 24) + 0x700] ^ T[(x << 16 >>> 24) + 0x600] ^
- T[(x << 8 >>> 24) + 0x500] ^ T[ (x >>> 24) + 0x400] ^
- T[(b[i + 4] << 24 >>> 24) + 0x300] ^ T[(b[i + 5] << 24 >>> 24) + 0x200] ^
- T[(b[i + 6] << 24 >>> 24) + 0x100] ^ T[b[i + 7] << 24 >>> 24];
+ // Publish crc out to object
+ crc = localCrc;
}
- /* loop unroll - duff's device style */
- switch (remainder) {
- case 7:
- localCrc = localCrc >>> 8 ^ T[(localCrc ^ b[i++]) << 24 >>> 24];
- case 6:
- localCrc = localCrc >>> 8 ^ T[(localCrc ^ b[i++]) << 24 >>> 24];
- case 5:
- localCrc = localCrc >>> 8 ^ T[(localCrc ^ b[i++]) << 24 >>> 24];
- case 4:
- localCrc = localCrc >>> 8 ^ T[(localCrc ^ b[i++]) << 24 >>> 24];
- case 3:
- localCrc = localCrc >>> 8 ^ T[(localCrc ^ b[i++]) << 24 >>> 24];
- case 2:
- localCrc = localCrc >>> 8 ^ T[(localCrc ^ b[i++]) << 24 >>> 24];
- case 1:
- localCrc = localCrc >>> 8 ^ T[(localCrc ^ b[i++]) << 24 >>> 24];
- default:
- /* nothing */
+ @Override
+ final public void update(final int b) {
+ crc = crc >>> 8 ^ T[(crc ^ b) << 24 >>> 24];
}
- // Publish crc out to object
- crc = localCrc;
- }
-
- @Override
- final public void update(final int b) {
- crc = crc >>> 8 ^ T[(crc ^ b) << 24 >>> 24];
- }
-
}
From 2ae86f1f38e2467898d9c61d5248ef1e88170364 Mon Sep 17 00:00:00 2001
From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com>
Date: Fri, 19 Apr 2024 11:55:39 -0400
Subject: [PATCH 87/99] Bump actions/upload-artifact from 4.3.1 to 4.3.2 (#268)
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 4.3.1 to 4.3.2.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](https://github.com/actions/upload-artifact/compare/5d5d22a31266ced268874388b861e4b58bb5c2f3...1746f4ab65b179e0ea60a494b83293b640dd5bba)
---
updated-dependencies:
- dependency-name: actions/upload-artifact
dependency-type: direct:production
update-type: version-update:semver-patch
...
Signed-off-by: dependabot[bot]
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
---
.github/workflows/scorecards-analysis.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/workflows/scorecards-analysis.yml b/.github/workflows/scorecards-analysis.yml
index 10125bdc19..c325c7f39b 100644
--- a/.github/workflows/scorecards-analysis.yml
+++ b/.github/workflows/scorecards-analysis.yml
@@ -57,7 +57,7 @@ jobs:
publish_results: true
- name: "Upload artifact"
- uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
+ uses: actions/upload-artifact@1746f4ab65b179e0ea60a494b83293b640dd5bba # v4.3.2
with:
name: SARIF file
path: results.sarif
From 52c151d5bf804a7a60e50bcbb855931a4126633a Mon Sep 17 00:00:00 2001
From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com>
Date: Fri, 19 Apr 2024 11:55:49 -0400
Subject: [PATCH 88/99] Bump actions/checkout from 4.1.2 to 4.1.3 (#270)
Bumps [actions/checkout](https://github.com/actions/checkout) from 4.1.2 to 4.1.3.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/9bb56186c3b09b4f86b1c65136769dd318469633...1d96c772d19495a3b5c517cd2bc0cb401ea0529f)
---
updated-dependencies:
- dependency-name: actions/checkout
dependency-type: direct:production
update-type: version-update:semver-patch
...
Signed-off-by: dependabot[bot]
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
---
.github/workflows/codeql-analysis.yml | 2 +-
.github/workflows/coverage.yml | 2 +-
.github/workflows/maven.yml | 2 +-
.github/workflows/scorecards-analysis.yml | 2 +-
4 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
index cc0fe4424a..6d1a13166b 100644
--- a/.github/workflows/codeql-analysis.yml
+++ b/.github/workflows/codeql-analysis.yml
@@ -45,7 +45,7 @@ jobs:
steps:
- name: Checkout repository
- uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # 4.1.2
+ uses: actions/checkout@1d96c772d19495a3b5c517cd2bc0cb401ea0529f # 4.1.3
with:
persist-credentials: false
- uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
index 3c7173aed6..1f3beb86ce 100644
--- a/.github/workflows/coverage.yml
+++ b/.github/workflows/coverage.yml
@@ -29,7 +29,7 @@ jobs:
java: [ 8 ]
steps:
- - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # 4.1.2
+ - uses: actions/checkout@1d96c772d19495a3b5c517cd2bc0cb401ea0529f # 4.1.3
with:
persist-credentials: false
- uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml
index 30ea8b61ac..3b5054ac74 100644
--- a/.github/workflows/maven.yml
+++ b/.github/workflows/maven.yml
@@ -34,7 +34,7 @@ jobs:
experimental: true
steps:
- - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # 4.1.2
+ - uses: actions/checkout@1d96c772d19495a3b5c517cd2bc0cb401ea0529f # 4.1.3
with:
persist-credentials: false
- uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
diff --git a/.github/workflows/scorecards-analysis.yml b/.github/workflows/scorecards-analysis.yml
index c325c7f39b..8f31f206ca 100644
--- a/.github/workflows/scorecards-analysis.yml
+++ b/.github/workflows/scorecards-analysis.yml
@@ -40,7 +40,7 @@ jobs:
steps:
- name: "Checkout code"
- uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # 4.1.2
+ uses: actions/checkout@1d96c772d19495a3b5c517cd2bc0cb401ea0529f # 4.1.3
with:
persist-credentials: false
From e80ddb7b0788ab2a730dab7098fe578f56ac4de1 Mon Sep 17 00:00:00 2001
From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com>
Date: Fri, 19 Apr 2024 11:55:59 -0400
Subject: [PATCH 89/99] Bump github/codeql-action from 3.24.10 to 3.25.1 (#269)
Bumps [github/codeql-action](https://github.com/github/codeql-action) from 3.24.10 to 3.25.1.
- [Release notes](https://github.com/github/codeql-action/releases)
- [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md)
- [Commits](https://github.com/github/codeql-action/compare/4355270be187e1b672a7a1c7c7bae5afdc1ab94a...c7f9125735019aa87cfc361530512d50ea439c71)
---
updated-dependencies:
- dependency-name: github/codeql-action
dependency-type: direct:production
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot]
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
---
.github/workflows/codeql-analysis.yml | 6 +++---
.github/workflows/scorecards-analysis.yml | 2 +-
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
index 6d1a13166b..5f3a488e4f 100644
--- a/.github/workflows/codeql-analysis.yml
+++ b/.github/workflows/codeql-analysis.yml
@@ -57,7 +57,7 @@ jobs:
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
- uses: github/codeql-action/init@4355270be187e1b672a7a1c7c7bae5afdc1ab94a # 3.24.10
+ uses: github/codeql-action/init@c7f9125735019aa87cfc361530512d50ea439c71 # 3.25.1
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
@@ -68,7 +68,7 @@ jobs:
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
- uses: github/codeql-action/autobuild@4355270be187e1b672a7a1c7c7bae5afdc1ab94a # 3.24.10
+ uses: github/codeql-action/autobuild@c7f9125735019aa87cfc361530512d50ea439c71 # 3.25.1
# âšī¸ Command-line programs to run using the OS shell.
# đ https://git.io/JvXDl
@@ -82,4 +82,4 @@ jobs:
# make release
- name: Perform CodeQL Analysis
- uses: github/codeql-action/analyze@4355270be187e1b672a7a1c7c7bae5afdc1ab94a # 3.24.10
+ uses: github/codeql-action/analyze@c7f9125735019aa87cfc361530512d50ea439c71 # 3.25.1
diff --git a/.github/workflows/scorecards-analysis.yml b/.github/workflows/scorecards-analysis.yml
index 8f31f206ca..c22ee1c0e1 100644
--- a/.github/workflows/scorecards-analysis.yml
+++ b/.github/workflows/scorecards-analysis.yml
@@ -64,6 +64,6 @@ jobs:
retention-days: 5
- name: "Upload to code-scanning"
- uses: github/codeql-action/upload-sarif@4355270be187e1b672a7a1c7c7bae5afdc1ab94a # 3.24.10
+ uses: github/codeql-action/upload-sarif@c7f9125735019aa87cfc361530512d50ea439c71 # 3.25.1
with:
sarif_file: results.sarif
From c6c5f11eae145d8e8c655e622f0fc5dd74e6db2a Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Sat, 20 Apr 2024 11:13:37 -0400
Subject: [PATCH 90/99] Base64 constructor makes a better defensive copy of the
line separator array
---
src/changes/changes.xml | 1 +
.../java/org/apache/commons/codec/binary/Base64.java | 11 ++++++-----
2 files changed, 7 insertions(+), 5 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 359a4155ba..018e6f41d6 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -49,6 +49,7 @@ The type attribute can be add,update,fix,remove.
Optimize memory allocation in PhoneticEngine.
BCodec and QCodec encode() methods throw UnsupportedCharsetException instead of EncoderException.
Set Javadoc link to latest Java API LTS version.
+ Base64 constructor makes a better defensive copy of the line separator array.
Add override org.apache.commons.codec.language.bm.Rule.PhonemeExpr.size().
Add support for Base64 custom alphabets #266.
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64.java b/src/main/java/org/apache/commons/codec/binary/Base64.java
index dc5c2b3bc5..5f927b053a 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -661,7 +661,7 @@ public Base64(final int lineLength, final byte[] lineSeparator, final boolean ur
* 4). If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when
* decoding.
* @param lineSeparator
- * Each line of encoded data will end with this sequence of bytes.
+ * Each line of encoded data will end with this sequence of bytes; the constructor makes a defensive copy.
* @param padding padding byte.
* @param encodeTable
* The manual encodeTable - a byte array of 64 chars.
@@ -683,13 +683,14 @@ private Base64(final int lineLength, final byte[] lineSeparator, final byte padd
// TODO could be simplified if there is no requirement to reject invalid line sep when length <=0
// @see test case Base64Test.testConstructors()
if (lineSeparator != null) {
- if (containsAlphabetOrPad(lineSeparator)) {
- final String sep = StringUtils.newStringUtf8(lineSeparator);
+ final byte[] lineSeparatorCopy = lineSeparator.clone();
+ if (containsAlphabetOrPad(lineSeparatorCopy)) {
+ final String sep = StringUtils.newStringUtf8(lineSeparatorCopy);
throw new IllegalArgumentException("lineSeparator must not contain base64 characters: [" + sep + "]");
}
if (lineLength > 0) { // null line-sep forces no chunking rather than throwing IAE
- this.encodeSize = BYTES_PER_ENCODED_BLOCK + lineSeparator.length;
- this.lineSeparator = lineSeparator.clone();
+ this.encodeSize = BYTES_PER_ENCODED_BLOCK + lineSeparatorCopy.length;
+ this.lineSeparator = lineSeparatorCopy;
} else {
this.encodeSize = BYTES_PER_ENCODED_BLOCK;
this.lineSeparator = null;
From 55043334240eb2a1838e37ea1c8a6e434d328fdf Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Sat, 20 Apr 2024 11:15:02 -0400
Subject: [PATCH 91/99] Better exception message
---
src/main/java/org/apache/commons/codec/binary/Base64.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64.java b/src/main/java/org/apache/commons/codec/binary/Base64.java
index 5f927b053a..df72909f40 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -676,7 +676,7 @@ private Base64(final int lineLength, final byte[] lineSeparator, final byte padd
decodeTable = DECODE_TABLE;
} else {
if (encodeTable.length != ALPHABET_LENGTH) {
- throw new IllegalArgumentException("encodeTable must be exactly 64 bytes long");
+ throw new IllegalArgumentException("encodeTable must have exactly 64 entries.");
}
decodeTable = calculateDecodeTable(encodeTable);
}
From ebe805a2730ad38886f9f04bd4d242e0a8c9caaa Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Sat, 20 Apr 2024 13:40:04 -0400
Subject: [PATCH 92/99] Base64 constructor makes a defensive copy of a custom
alphabet array
---
src/changes/changes.xml | 3 +-
.../apache/commons/codec/binary/Base64.java | 44 +++++++++----------
2 files changed, 24 insertions(+), 23 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 018e6f41d6..c88d2d7c4a 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -49,7 +49,8 @@ The type attribute can be add,update,fix,remove.
Optimize memory allocation in PhoneticEngine.
BCodec and QCodec encode() methods throw UnsupportedCharsetException instead of EncoderException.
Set Javadoc link to latest Java API LTS version.
- Base64 constructor makes a better defensive copy of the line separator array.
+ Base64 constructor makes a defensive copy of the line separator array.
+ Base64 constructor makes a defensive copy of a custom alphabet array.
Add override org.apache.commons.codec.language.bm.Rule.PhonemeExpr.size().
Add support for Base64 custom alphabets #266.
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64.java b/src/main/java/org/apache/commons/codec/binary/Base64.java
index df72909f40..f482db9d7b 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -498,6 +498,8 @@ private static byte[] toUrlSafeEncodeTable(final boolean urlSafe) {
*/
private final int encodeSize;
+ private final boolean isUrlSafe;
+
/**
* Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
*
@@ -646,8 +648,7 @@ public Base64(final int lineLength, final byte[] lineSeparator, final boolean ur
/**
* Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
*
- * When encoding the line length and line separator are given in the constructor, and the encoding table is
- * STANDARD_ENCODE_TABLE.
+ * When encoding the line length and line separator are given in the constructor, and the encoding table is STANDARD_ENCODE_TABLE.
*
*
* Line lengths that aren't multiples of 4 will still essentially end up being multiples of 4 in the encoded data.
@@ -656,29 +657,28 @@ public Base64(final int lineLength, final byte[] lineSeparator, final boolean ur
* When decoding all variants are supported.
*
*
- * @param lineLength
- * Each line of encoded data will be at most of the given length (rounded down to the nearest multiple of
- * 4). If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when
- * decoding.
- * @param lineSeparator
- * Each line of encoded data will end with this sequence of bytes; the constructor makes a defensive copy.
- * @param padding padding byte.
- * @param encodeTable
- * The manual encodeTable - a byte array of 64 chars.
+ * @param lineLength Each line of encoded data will be at most of the given length (rounded down to the nearest multiple of 4). If lineLength <= 0,
+ * then the output will not be divided into lines (chunks). Ignored when decoding.
+ * @param lineSeparator Each line of encoded data will end with this sequence of bytes; the constructor makes a defensive copy. May be null.
+ * @param padding padding byte.
+ * @param encodeTable The manual encodeTable - a byte array of 64 chars.
* @param decodingPolicy The decoding policy.
- * @throws IllegalArgumentException
- * Thrown when the {@code lineSeparator} contains Base64 characters.
+ * @throws IllegalArgumentException Thrown when the {@code lineSeparator} contains Base64 characters.
*/
private Base64(final int lineLength, final byte[] lineSeparator, final byte padding, final byte[] encodeTable, final CodecPolicy decodingPolicy) {
super(BYTES_PER_UNENCODED_BLOCK, BYTES_PER_ENCODED_BLOCK, lineLength, toLength(lineSeparator), padding, decodingPolicy);
- this.encodeTable = Objects.requireNonNull(encodeTable, "encodeTable");
- if (encodeTable == STANDARD_ENCODE_TABLE || encodeTable == URL_SAFE_ENCODE_TABLE) {
+ Objects.requireNonNull(encodeTable, "encodeTable");
+ if (encodeTable.length != ALPHABET_LENGTH) {
+ throw new IllegalArgumentException("encodeTable must have exactly 64 entries.");
+ }
+ this.isUrlSafe = encodeTable == URL_SAFE_ENCODE_TABLE;
+ if (encodeTable == STANDARD_ENCODE_TABLE || this.isUrlSafe) {
decodeTable = DECODE_TABLE;
+ // No need of a defensive copy of an internal table.
+ this.encodeTable = encodeTable;
} else {
- if (encodeTable.length != ALPHABET_LENGTH) {
- throw new IllegalArgumentException("encodeTable must have exactly 64 entries.");
- }
- decodeTable = calculateDecodeTable(encodeTable);
+ this.encodeTable = encodeTable.clone();
+ this.decodeTable = calculateDecodeTable(this.encodeTable);
}
// TODO could be simplified if there is no requirement to reject invalid line sep when length <=0
// @see test case Base64Test.testConstructors()
@@ -919,13 +919,13 @@ protected boolean isInAlphabet(final byte octet) {
}
/**
- * Returns our current encode mode. True if we're URL-SAFE, false otherwise.
+ * Returns our current encode mode. True if we're URL-safe, false otherwise.
*
- * @return true if we're in URL-SAFE mode, false otherwise.
+ * @return true if we're in URL-safe mode, false otherwise.
* @since 1.4
*/
public boolean isUrlSafe() {
- return this.encodeTable == URL_SAFE_ENCODE_TABLE;
+ return isUrlSafe;
}
/**
From fcc70e6fa1271158dd8f3a90350fa2589713f257 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Sat, 20 Apr 2024 13:44:17 -0400
Subject: [PATCH 93/99] Base32 constructor makes a defensive copy of the line
separator array
---
src/changes/changes.xml | 1 +
.../java/org/apache/commons/codec/binary/Base32.java | 9 +++++----
2 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index c88d2d7c4a..01ee6076e9 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -49,6 +49,7 @@ The type attribute can be add,update,fix,remove.
Optimize memory allocation in PhoneticEngine.
BCodec and QCodec encode() methods throw UnsupportedCharsetException instead of EncoderException.
Set Javadoc link to latest Java API LTS version.
+ Base32 constructor makes a defensive copy of the line separator array.
Base64 constructor makes a defensive copy of the line separator array.
Base64 constructor makes a defensive copy of a custom alphabet array.
diff --git a/src/main/java/org/apache/commons/codec/binary/Base32.java b/src/main/java/org/apache/commons/codec/binary/Base32.java
index 47f136f8b5..ebbb57e353 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32.java
@@ -359,13 +359,14 @@ private Base32(final int lineLength, final byte[] lineSeparator, final byte[] en
if (lineSeparator == null) {
throw new IllegalArgumentException("lineLength " + lineLength + " > 0, but lineSeparator is null");
}
+ final byte[] lineSeparatorCopy = lineSeparator.clone();
// Must be done after initializing the tables
- if (containsAlphabetOrPad(lineSeparator)) {
- final String sep = StringUtils.newStringUtf8(lineSeparator);
+ if (containsAlphabetOrPad(lineSeparatorCopy)) {
+ final String sep = StringUtils.newStringUtf8(lineSeparatorCopy);
throw new IllegalArgumentException("lineSeparator must not contain Base32 characters: [" + sep + "]");
}
- this.encodeSize = BYTES_PER_ENCODED_BLOCK + lineSeparator.length;
- this.lineSeparator = lineSeparator.clone();
+ this.encodeSize = BYTES_PER_ENCODED_BLOCK + lineSeparatorCopy.length;
+ this.lineSeparator = lineSeparatorCopy;
} else {
this.encodeSize = BYTES_PER_ENCODED_BLOCK;
this.lineSeparator = null;
From d2215d5dec3031f819c3bb514587d92a6aec8eff Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Sat, 20 Apr 2024 13:46:13 -0400
Subject: [PATCH 94/99] Base32 constructor fails-fast with a
NullPointerException if the custom alphabet array is null
---
src/changes/changes.xml | 1 +
src/main/java/org/apache/commons/codec/binary/Base32.java | 3 +++
2 files changed, 4 insertions(+)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 01ee6076e9..c1e7f5e6a4 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -49,6 +49,7 @@ The type attribute can be add,update,fix,remove.
Optimize memory allocation in PhoneticEngine.
BCodec and QCodec encode() methods throw UnsupportedCharsetException instead of EncoderException.
Set Javadoc link to latest Java API LTS version.
+ Base32 constructor fails-fast with a NullPointerException if the custom alphabet array is null.
Base32 constructor makes a defensive copy of the line separator array.
Base64 constructor makes a defensive copy of the line separator array.
Base64 constructor makes a defensive copy of a custom alphabet array.
diff --git a/src/main/java/org/apache/commons/codec/binary/Base32.java b/src/main/java/org/apache/commons/codec/binary/Base32.java
index ebbb57e353..ad39da408c 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32.java
@@ -17,6 +17,8 @@
package org.apache.commons.codec.binary;
+import java.util.Objects;
+
import org.apache.commons.codec.CodecPolicy;
/**
@@ -353,6 +355,7 @@ public Base32(final int lineLength, final byte[] lineSeparator, final boolean us
*/
private Base32(final int lineLength, final byte[] lineSeparator, final byte[] encodeTable, final byte padding, final CodecPolicy decodingPolicy) {
super(BYTES_PER_UNENCODED_BLOCK, BYTES_PER_ENCODED_BLOCK, lineLength, toLength(lineSeparator), padding, decodingPolicy);
+ Objects.requireNonNull(encodeTable, "encodeTable");
this.encodeTable = encodeTable;
this.decodeTable = encodeTable == HEX_ENCODE_TABLE ? HEX_DECODE_TABLE : DECODE_TABLE;
if (lineLength > 0) {
From c56b95664913aab406f768c66f9264481b28c1bb Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Sat, 20 Apr 2024 13:48:12 -0400
Subject: [PATCH 95/99] Bullet-proof internals
---
src/main/java/org/apache/commons/codec/binary/Base16.java | 3 +++
1 file changed, 3 insertions(+)
diff --git a/src/main/java/org/apache/commons/codec/binary/Base16.java b/src/main/java/org/apache/commons/codec/binary/Base16.java
index 65f75c42e0..c3dfe8180d 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base16.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base16.java
@@ -17,6 +17,8 @@
package org.apache.commons.codec.binary;
+import java.util.Objects;
+
import org.apache.commons.codec.CodecPolicy;
/**
@@ -138,6 +140,7 @@ public Base16(final boolean lowerCase) {
*/
private Base16(final boolean lowerCase, final byte[] encodeTable, final CodecPolicy decodingPolicy) {
super(BYTES_PER_UNENCODED_BLOCK, BYTES_PER_ENCODED_BLOCK, 0, 0, PAD_DEFAULT, decodingPolicy);
+ Objects.requireNonNull(encodeTable, "encodeTable");
this.encodeTable = encodeTable;
this.decodeTable = encodeTable == LOWER_CASE_ENCODE_TABLE ? LOWER_CASE_DECODE_TABLE : UPPER_CASE_DECODE_TABLE;
}
From 8714b5f62bb5fa5950aa5e8908bd0d8d3334dba5 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Sat, 20 Apr 2024 13:48:45 -0400
Subject: [PATCH 96/99] Remove dead comment
---
src/main/java/org/apache/commons/codec/binary/Base64.java | 2 --
1 file changed, 2 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64.java b/src/main/java/org/apache/commons/codec/binary/Base64.java
index f482db9d7b..443ccc6612 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -701,8 +701,6 @@ private Base64(final int lineLength, final byte[] lineSeparator, final byte padd
}
}
- // Implementation of the Encoder Interface
-
/**
* Calculates a decode table for a given encode table.
*
From 5f0cfd46c89df69b579f37562ff1eded7ffd4b5c Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Sat, 20 Apr 2024 13:56:58 -0400
Subject: [PATCH 97/99] Longer lines
- Whitespace
- Simplify if
---
.../apache/commons/codec/binary/Base16.java | 29 ++-----------------
.../apache/commons/codec/binary/Base32.java | 2 --
.../commons/codec/binary/BaseNCodec.java | 24 ++++++---------
3 files changed, 11 insertions(+), 44 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/Base16.java b/src/main/java/org/apache/commons/codec/binary/Base16.java
index c3dfe8180d..2968944215 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base16.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base16.java
@@ -68,12 +68,7 @@ public class Base16 extends BaseNCodec {
* This array is a lookup table that translates 4-bit positive integer index values into their "Base16 Alphabet" equivalents as specified in Table 5 of RFC
* 4648.
*/
- // @formatter:off
- private static final byte[] UPPER_CASE_ENCODE_TABLE = {
- '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
- 'A', 'B', 'C', 'D', 'E', 'F'
- };
- // @formatter:on
+ private static final byte[] UPPER_CASE_ENCODE_TABLE = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F' };
/**
* This array is a lookup table that translates Unicode characters drawn from the a lower-case "Base16 Alphabet" into their 4-bit positive integer
@@ -95,12 +90,7 @@ public class Base16 extends BaseNCodec {
/**
* This array is a lookup table that translates 4-bit positive integer index values into their "Base16 Alphabet" lower-case equivalents.
*/
- // @formatter:off
- private static final byte[] LOWER_CASE_ENCODE_TABLE = {
- '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
- 'a', 'b', 'c', 'd', 'e', 'f'
- };
- // @formatter:on
+ private static final byte[] LOWER_CASE_ENCODE_TABLE = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
/** Mask used to extract 4 bits, used when decoding character. */
private static final int MASK_4BITS = 0x0f;
@@ -164,42 +154,33 @@ void decode(final byte[] data, int offset, final int length, final Context conte
}
return;
}
-
final int dataLen = Math.min(data.length - offset, length);
final int availableChars = (context.ibitWorkArea != 0 ? 1 : 0) + dataLen;
-
// small optimization to short-cut the rest of this method when it is fed byte-by-byte
if (availableChars == 1 && availableChars == dataLen) {
// store 1/2 byte for next invocation of decode, we offset by +1 as empty-value is 0
context.ibitWorkArea = decodeOctet(data[offset]) + 1;
return;
}
-
// we must have an even number of chars to decode
final int charsToProcess = availableChars % BYTES_PER_ENCODED_BLOCK == 0 ? availableChars : availableChars - 1;
final int end = offset + dataLen;
-
final byte[] buffer = ensureBufferSize(charsToProcess / BYTES_PER_ENCODED_BLOCK, context);
-
int result;
if (dataLen < availableChars) {
// we have 1/2 byte from previous invocation to decode
result = context.ibitWorkArea - 1 << BITS_PER_ENCODED_BYTE;
result |= decodeOctet(data[offset++]);
-
buffer[context.pos++] = (byte) result;
-
// reset to empty-value for next invocation!
context.ibitWorkArea = 0;
}
-
final int loopEnd = end - 1;
while (offset < loopEnd) {
result = decodeOctet(data[offset++]) << BITS_PER_ENCODED_BYTE;
result |= decodeOctet(data[offset++]);
buffer[context.pos++] = (byte) result;
}
-
// we have one char of a hex-pair left over
if (offset < end) {
// store 1/2 byte for next invocation of decode, we offset by +1 as empty-value is 0
@@ -212,11 +193,9 @@ private int decodeOctet(final byte octet) {
if ((octet & 0xff) < decodeTable.length) {
decoded = decodeTable[octet];
}
-
if (decoded == -1) {
throw new IllegalArgumentException("Invalid octet in encoded value: " + (int) octet);
}
-
return decoded;
}
@@ -225,19 +204,15 @@ void encode(final byte[] data, final int offset, final int length, final Context
if (context.eof) {
return;
}
-
if (length < 0) {
context.eof = true;
return;
}
-
final int size = length * BYTES_PER_ENCODED_BLOCK;
if (size < 0) {
throw new IllegalArgumentException("Input length exceeds maximum size for encoded data: " + length);
}
-
final byte[] buffer = ensureBufferSize(size, context);
-
final int end = offset + length;
for (int i = offset; i < end; i++) {
final int value = data[i];
diff --git a/src/main/java/org/apache/commons/codec/binary/Base32.java b/src/main/java/org/apache/commons/codec/binary/Base32.java
index ad39da408c..06ecec4736 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32.java
@@ -437,7 +437,6 @@ void decode(final byte[] input, int inPos, final int inAvail, final Context cont
// This approach makes the '=' padding characters completely optional.
if (context.eof && context.modulus > 0) { // if modulus == 0, nothing to do
final byte[] buffer = ensureBufferSize(decodeSize, context);
-
// We ignore partial bytes, i.e. only multiples of 8 count.
// Any combination not part of a valid encoding is either partially decoded
// or will raise an exception. Possible trailing characters are 2, 4, 5, 7.
@@ -507,7 +506,6 @@ void decode(final byte[] input, int inPos, final int inAvail, final Context cont
@Override
void encode(final byte[] input, int inPos, final int inAvail, final Context context) {
// package protected for access from I/O streams
-
if (context.eof) {
return;
}
diff --git a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
index df68641a44..c598abc3d1 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
@@ -359,7 +359,6 @@ private static byte[] resizeBuffer(final Context context, final int minCapacity)
if (Integer.compareUnsigned(newCapacity, MAX_BUFFER_SIZE) > 0) {
newCapacity = createPositiveCapacity(minCapacity);
}
-
final byte[] b = Arrays.copyOf(context.buffer, newCapacity);
context.buffer = b;
return b;
@@ -435,8 +434,7 @@ static int toLength(final byte[] array) {
* @param lineLength if > 0, use chunking with a length {@code lineLength}
* @param chunkSeparatorLength the chunk separator length, if relevant
*/
- protected BaseNCodec(final int unencodedBlockSize, final int encodedBlockSize,
- final int lineLength, final int chunkSeparatorLength) {
+ protected BaseNCodec(final int unencodedBlockSize, final int encodedBlockSize, final int lineLength, final int chunkSeparatorLength) {
this(unencodedBlockSize, encodedBlockSize, lineLength, chunkSeparatorLength, PAD_DEFAULT);
}
@@ -453,8 +451,7 @@ protected BaseNCodec(final int unencodedBlockSize, final int encodedBlockSize,
* @param chunkSeparatorLength the chunk separator length, if relevant
* @param pad byte used as padding byte.
*/
- protected BaseNCodec(final int unencodedBlockSize, final int encodedBlockSize,
- final int lineLength, final int chunkSeparatorLength, final byte pad) {
+ protected BaseNCodec(final int unencodedBlockSize, final int encodedBlockSize, final int lineLength, final int chunkSeparatorLength, final byte pad) {
this(unencodedBlockSize, encodedBlockSize, lineLength, chunkSeparatorLength, pad, DECODING_POLICY_DEFAULT);
}
@@ -473,9 +470,8 @@ protected BaseNCodec(final int unencodedBlockSize, final int encodedBlockSize,
* @param decodingPolicy Decoding policy.
* @since 1.15
*/
- protected BaseNCodec(final int unencodedBlockSize, final int encodedBlockSize,
- final int lineLength, final int chunkSeparatorLength, final byte pad,
- final CodecPolicy decodingPolicy) {
+ protected BaseNCodec(final int unencodedBlockSize, final int encodedBlockSize, final int lineLength, final int chunkSeparatorLength, final byte pad,
+ final CodecPolicy decodingPolicy) {
this.unencodedBlockSize = unencodedBlockSize;
this.encodedBlockSize = encodedBlockSize;
final boolean useChunking = lineLength > 0 && chunkSeparatorLength > 0;
@@ -505,12 +501,11 @@ int available(final Context context) { // package protected for access from I/O
* @return {@code true} if any byte is a valid character in the alphabet or PAD; {@code false} otherwise
*/
protected boolean containsAlphabetOrPad(final byte[] arrayOctet) {
- if (arrayOctet == null) {
- return false;
- }
- for (final byte element : arrayOctet) {
- if (pad == element || isInAlphabet(element)) {
- return true;
+ if (arrayOctet != null) {
+ for (final byte element : arrayOctet) {
+ if (pad == element || isInAlphabet(element)) {
+ return true;
+ }
}
}
return false;
@@ -672,7 +667,6 @@ protected byte[] ensureBufferSize(final int size, final Context context) {
context.buffer = new byte[Math.max(size, getDefaultBufferSize())];
context.pos = 0;
context.readPos = 0;
-
// Overflow-conscious:
// x + y > z == x + y - z > 0
} else if (context.pos + size - context.buffer.length > 0) {
From 9a59c1c47b02ca795270b758c8d0591f5925b10f Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Sat, 20 Apr 2024 18:05:13 +0000
Subject: [PATCH 98/99] Prepare for the next release candidate
---
README.md | 4 +--
RELEASE-NOTES.txt | 48 ++++++++++++++++++++++++++++++++
src/changes/changes.xml | 2 +-
src/site/xdoc/download_codec.xml | 26 ++++++++---------
4 files changed, 64 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
index 66cda56ccc..6ad95c8878 100644
--- a/README.md
+++ b/README.md
@@ -46,7 +46,7 @@ Apache Commons Codec
[](https://github.com/apache/commons-codec/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-codec)
[](https://maven-badges.herokuapp.com/maven-central/commons-codec/commons-codec/?gav=true)
-[](https://javadoc.io/doc/commons-codec/commons-codec/1.16.1)
+[](https://javadoc.io/doc/commons-codec/commons-codec/1.17.0)
[](https://github.com/apache/commons-codec/actions/workflows/codeql-analysis.yml)
[](https://api.securityscorecards.dev/projects/github.com/apache/commons-codec)
@@ -72,7 +72,7 @@ Alternatively, you can pull it from the central Maven repositories:
commons-codec
commons-codec
- 1.16.1
+ 1.17.0
```
diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt
index cada46ab2c..ee1f2a3c34 100644
--- a/RELEASE-NOTES.txt
+++ b/RELEASE-NOTES.txt
@@ -1,3 +1,51 @@
+Apache Commons Codec 1.17.0 RELEASE NOTES
+-----------------------------------------
+
+The Apache Commons Codec component contains encoder and decoders for
+various formats such as Base16, Base32, Base64, digest, and Hexadecimal. In addition to these
+widely used encoders and decoders, the codec package also maintains a
+collection of phonetic encoding utilities.
+
+Feature and fix release. Requires a minimum of Java 8.
+
+
+New features
+------------
+
+* Add override org.apache.commons.codec.language.bm.Rule.PhonemeExpr.size(). Thanks to Gary Gregory.
+* Add support for Base64 custom alphabets #266. Thanks to Chris Kocel, Gary Gregory.
+* Add Base64.Builder (allows custom alphabets). Thanks to Gary Gregory.
+* Add Base32.Builder (allows custom alphabets). Thanks to Gary Gregory.
+* Add Base64 support for a custom padding byte (like Base32). Thanks to Gary Gregory.
+
+Fixed Bugs
+----------
+
+* CODEC-320: Wrong output of DoubleMetaphone in 1.16.1. Thanks to Martin Frydl, Gary Gregory.
+* Optimize memory allocation in PhoneticEngine. Thanks to Gary Gregory.
+* BCodec and QCodec encode() methods throw UnsupportedCharsetException instead of EncoderException. Thanks to Gary Gregory.
+* Set Javadoc link to latest Java API LTS version. Thanks to Gary Gregory.
+* Base32 constructor fails-fast with a NullPointerException if the custom alphabet array is null. Thanks to Gary Gregory.
+* Base32 constructor makes a defensive copy of the line separator array. Thanks to Gary Gregory.
+* Base64 constructor makes a defensive copy of the line separator array. Thanks to Gary Gregory.
+* Base64 constructor makes a defensive copy of a custom alphabet array. Thanks to Gary Gregory.
+
+Changes
+-------
+
+* Bump org.apache.commons:commons-parent from 66 to 69 #250, #261. Thanks to Dependabot, Gary Gregory.
+* Bump commons-io:commons-io from 2.15.1 to 2.16.1 #258, #265. Thanks to Dependabot, Gary Gregory.
+
+
+For complete information on Apache Commons Codec, including instructions on how to submit bug reports,
+patches, or suggestions for improvement, see the Apache Commons Codec website:
+
+https://commons.apache.org/proper/commons-codec/
+
+Download page: https://commons.apache.org/proper/commons-codec/download_codec.cgi
+
+---------------------------------------------------------------------------------
+
Apache Commons Codec 1.16.1 RELEASE NOTES
-----------------------------------------
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index c1e7f5e6a4..a8a65fdc09 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -43,7 +43,7 @@ The type attribute can be add,update,fix,remove.
Apache Commons Developers
-
+
Wrong output of DoubleMetaphone in 1.16.1.
Optimize memory allocation in PhoneticEngine.
diff --git a/src/site/xdoc/download_codec.xml b/src/site/xdoc/download_codec.xml
index 2b5813df7d..21317e594b 100644
--- a/src/site/xdoc/download_codec.xml
+++ b/src/site/xdoc/download_codec.xml
@@ -113,32 +113,32 @@ limitations under the License.
-
+
From 5d809fe3d729bde9b507a51d2b2ed659da053692 Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Sat, 20 Apr 2024 18:09:25 +0000
Subject: [PATCH 99/99] Prepare for the next release candidate
---
pom.xml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/pom.xml b/pom.xml
index 8290eefd12..9a407f652b 100644
--- a/pom.xml
+++ b/pom.xml
@@ -28,7 +28,7 @@ limitations under the License.
commons-codec
commons-codec
- 1.17.0-SNAPSHOT
+ 1.17.0
Apache Commons Codec
2002
@@ -106,7 +106,7 @@ limitations under the License.
RC1
true
scm:svn:https://dist.apache.org/repos/dist/dev/commons/${commons.componentid}
- 2024-02-08T21:29:14Z
+ 2024-04-20T18:05:56Z
0.8.12
${commons.javadoc21.java.link}