-
Notifications
You must be signed in to change notification settings - Fork 191
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use own copy of PercentCodec for URI path encoding
Adapted from Apache HttpComponents HttpCore v5's https://github.com/apache/httpcomponents-core/blob/e009a923eefe79cf3593efbb0c18a3525ae63669/httpcore5/src/main/java/org/apache/hc/core5/net/PercentCodec.java Signed-off-by: Thomas Farr <[email protected]>
- Loading branch information
Showing
6 changed files
with
282 additions
and
118 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
193 changes: 193 additions & 0 deletions
193
java-client/src/main/java/org/opensearch/client/util/PercentCodec.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,193 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
|
|
||
| package org.opensearch.client.util; | ||
|
|
||
| import java.nio.ByteBuffer; | ||
| import java.nio.CharBuffer; | ||
| import java.nio.charset.Charset; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.util.BitSet; | ||
|
|
||
| /** | ||
| * Percent-encoding. | ||
| * <p> | ||
| * Adapted from Apache HttpComponents HttpCore v5's <a href="https://github.com/apache/httpcomponents-core/blob/e009a923eefe79cf3593efbb0c18a3525ae63669/httpcore5/src/main/java/org/apache/hc/core5/net/PercentCodec.java">PercentCodec.java</a> | ||
| * </p> | ||
| */ | ||
| public class PercentCodec { | ||
| private static final BitSet RFC3986_GEN_DELIMS_CHARS = new BitSet(256); | ||
| private static final BitSet RFC3986_SUB_DELIMS_CHARS = new BitSet(256); | ||
| private static final BitSet RFC3986_UNRESERVED_CHARS = new BitSet(256); | ||
| private static final BitSet RFC3986_PATHSAFE_NC_CHARS = new BitSet(256); | ||
| private static final BitSet RFC3986_PATHSAFE_CHARS = new BitSet(256); | ||
| private static final BitSet RFC3986_URIC_CHARS = new BitSet(256); | ||
|
|
||
| static { | ||
| RFC3986_GEN_DELIMS_CHARS.set(':'); | ||
| RFC3986_GEN_DELIMS_CHARS.set('/'); | ||
| RFC3986_GEN_DELIMS_CHARS.set('?'); | ||
| RFC3986_GEN_DELIMS_CHARS.set('#'); | ||
| RFC3986_GEN_DELIMS_CHARS.set('['); | ||
| RFC3986_GEN_DELIMS_CHARS.set(']'); | ||
| RFC3986_GEN_DELIMS_CHARS.set('@'); | ||
|
|
||
| RFC3986_SUB_DELIMS_CHARS.set('!'); | ||
| RFC3986_SUB_DELIMS_CHARS.set('$'); | ||
| RFC3986_SUB_DELIMS_CHARS.set('&'); | ||
| RFC3986_SUB_DELIMS_CHARS.set('\''); | ||
| RFC3986_SUB_DELIMS_CHARS.set('('); | ||
| RFC3986_SUB_DELIMS_CHARS.set(')'); | ||
| RFC3986_SUB_DELIMS_CHARS.set('*'); | ||
| RFC3986_SUB_DELIMS_CHARS.set('+'); | ||
| RFC3986_SUB_DELIMS_CHARS.set(','); | ||
| RFC3986_SUB_DELIMS_CHARS.set(';'); | ||
| RFC3986_SUB_DELIMS_CHARS.set('='); | ||
|
|
||
| for (int i = 'a'; i <= 'z'; i++) { | ||
| RFC3986_UNRESERVED_CHARS.set(i); | ||
| } | ||
| for (int i = 'A'; i <= 'Z'; i++) { | ||
| RFC3986_UNRESERVED_CHARS.set(i); | ||
| } | ||
| // numeric characters | ||
| for (int i = '0'; i <= '9'; i++) { | ||
| RFC3986_UNRESERVED_CHARS.set(i); | ||
| } | ||
| RFC3986_UNRESERVED_CHARS.set('-'); | ||
| RFC3986_UNRESERVED_CHARS.set('.'); | ||
| RFC3986_UNRESERVED_CHARS.set('_'); | ||
| RFC3986_UNRESERVED_CHARS.set('~'); | ||
|
|
||
| RFC3986_PATHSAFE_NC_CHARS.or(RFC3986_UNRESERVED_CHARS); | ||
| RFC3986_PATHSAFE_NC_CHARS.or(RFC3986_SUB_DELIMS_CHARS); | ||
| RFC3986_PATHSAFE_NC_CHARS.set('@'); | ||
|
|
||
| RFC3986_PATHSAFE_CHARS.or(RFC3986_PATHSAFE_NC_CHARS); | ||
| RFC3986_PATHSAFE_CHARS.set(':'); | ||
|
|
||
| RFC3986_URIC_CHARS.or(RFC3986_SUB_DELIMS_CHARS); | ||
| RFC3986_URIC_CHARS.or(RFC3986_UNRESERVED_CHARS); | ||
| } | ||
|
|
||
| private static final BitSet RFC5987_UNRESERVED_CHARS = new BitSet(256); | ||
|
|
||
| static { | ||
| // Alphanumeric characters | ||
| for (int i = 'a'; i <= 'z'; i++) { | ||
| RFC5987_UNRESERVED_CHARS.set(i); | ||
| } | ||
| for (int i = 'A'; i <= 'Z'; i++) { | ||
| RFC5987_UNRESERVED_CHARS.set(i); | ||
| } | ||
| for (int i = '0'; i <= '9'; i++) { | ||
| RFC5987_UNRESERVED_CHARS.set(i); | ||
| } | ||
|
|
||
| // Additional characters as per RFC 5987 attr-char | ||
| RFC5987_UNRESERVED_CHARS.set('!'); | ||
| RFC5987_UNRESERVED_CHARS.set('#'); | ||
| RFC5987_UNRESERVED_CHARS.set('$'); | ||
| RFC5987_UNRESERVED_CHARS.set('&'); | ||
| RFC5987_UNRESERVED_CHARS.set('+'); | ||
| RFC5987_UNRESERVED_CHARS.set('-'); | ||
| RFC5987_UNRESERVED_CHARS.set('.'); | ||
| RFC5987_UNRESERVED_CHARS.set('^'); | ||
| RFC5987_UNRESERVED_CHARS.set('_'); | ||
| RFC5987_UNRESERVED_CHARS.set('`'); | ||
| RFC5987_UNRESERVED_CHARS.set('|'); | ||
| RFC5987_UNRESERVED_CHARS.set('~'); | ||
| } | ||
|
|
||
| private static final int RADIX = 16; | ||
|
|
||
| private static void encode( | ||
| final StringBuilder buf, | ||
| final CharSequence content, | ||
| final Charset charset, | ||
| final BitSet safeChars, | ||
| final boolean blankAsPlus | ||
| ) { | ||
| if (content == null) { | ||
| return; | ||
| } | ||
| final CharBuffer cb = CharBuffer.wrap(content); | ||
| final ByteBuffer bb = (charset != null ? charset : StandardCharsets.UTF_8).encode(cb); | ||
| while (bb.hasRemaining()) { | ||
| final int b = bb.get() & 0xff; | ||
| if (safeChars.get(b)) { | ||
| buf.append((char) b); | ||
| } else if (blankAsPlus && b == ' ') { | ||
| buf.append("+"); | ||
| } else { | ||
| buf.append("%"); | ||
| final char hex1 = Character.toUpperCase(Character.forDigit((b >> 4) & 0xF, RADIX)); | ||
| final char hex2 = Character.toUpperCase(Character.forDigit(b & 0xF, RADIX)); | ||
| buf.append(hex1); | ||
| buf.append(hex2); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private static String decode(final CharSequence content, final Charset charset, final boolean plusAsBlank) { | ||
| if (content == null) { | ||
| return null; | ||
| } | ||
| final ByteBuffer bb = ByteBuffer.allocate(content.length()); | ||
| final CharBuffer cb = CharBuffer.wrap(content); | ||
| while (cb.hasRemaining()) { | ||
| final char c = cb.get(); | ||
| if (c == '%' && cb.remaining() >= 2) { | ||
| final char uc = cb.get(); | ||
| final char lc = cb.get(); | ||
| final int u = Character.digit(uc, RADIX); | ||
| final int l = Character.digit(lc, RADIX); | ||
| if (u != -1 && l != -1) { | ||
| bb.put((byte) ((u << 4) + l)); | ||
| } else { | ||
| bb.put((byte) '%'); | ||
| bb.put((byte) uc); | ||
| bb.put((byte) lc); | ||
| } | ||
| } else if (plusAsBlank && c == '+') { | ||
| bb.put((byte) ' '); | ||
| } else { | ||
| bb.put((byte) c); | ||
| } | ||
| } | ||
| bb.flip(); | ||
| return (charset != null ? charset : StandardCharsets.UTF_8).decode(bb).toString(); | ||
| } | ||
|
|
||
| public static final PercentCodec RFC3986_UNRESERVED = new PercentCodec(RFC3986_UNRESERVED_CHARS); | ||
| public static final PercentCodec RFC3986_PATHSAFE = new PercentCodec(RFC3986_PATHSAFE_CHARS); | ||
| public static final PercentCodec RFC5987_UNRESERVED = new PercentCodec(RFC5987_UNRESERVED_CHARS); | ||
|
|
||
| private final BitSet unreserved; | ||
|
|
||
| private PercentCodec(final BitSet unreserved) { | ||
| this.unreserved = unreserved; | ||
| } | ||
|
|
||
| public void encode(final StringBuilder buf, final CharSequence content) { | ||
| encode(buf, content, StandardCharsets.UTF_8, unreserved, false); | ||
| } | ||
|
|
||
| public String encode(final CharSequence content) { | ||
| if (content == null) { | ||
| return null; | ||
| } | ||
| final StringBuilder buf = new StringBuilder(); | ||
| encode(buf, content, StandardCharsets.UTF_8, unreserved, false); | ||
| return buf.toString(); | ||
| } | ||
|
|
||
| public String decode(final CharSequence content) { | ||
| return decode(content, StandardCharsets.UTF_8, false); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
44 changes: 0 additions & 44 deletions
44
java-client/src/test/java/org/opensearch/client/util/PathEncoderTest.java
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.