commonMain.com.apollographql.apollo.api.http.internal.UrlEncode.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of apollo-api-jvm Show documentation
Apollo GraphQL API classes
The newest version!
package com.apollographql.apollo.api.http.internal

import okio.Buffer

/**
 * Return true if the unicode code point is an unreserved char as in
 * https://datatracker.ietf.org/doc/html/rfc3986#section-2.3
 */
private fun Int.isUnreserved(): Boolean {
  return when (this) {
    in 'a'.code..'z'.code -> true
    in 'A'.code..'Z'.code -> true
    in '0'.code..'9'.code -> true
    '-'.code -> true
    '.'.code -> true
    '_'.code -> true
    '~'.code -> true
    else -> false
  }
}

/**
 * From https://datatracker.ietf.org/doc/html/rfc3986#autoid-12:
 *
 * ```
 *    When a new URI scheme defines a component that represents textual
 *    data consisting of characters from the Universal Character Set [UCS],
 *    the data should first be encoded as octets according to the UTF-8
 *    character encoding [STD63]; then only those octets that do not
 *    correspond to characters in the unreserved set should be percent-
 *    encoded.  For example, the character A would be represented as "A",
 *    the character LATIN CAPITAL LETTER A WITH GRAVE would be represented
 *    as "%C3%80", and the character KATAKANA LETTER A would be represented
 *    as "%E3%82%A2".
 * ```
 *
 * If I'm reading that right, data must be first encoded to UTF8 then percent-encoded
 * as needed.
 *
 * This is especially important for older iOS versions where NSURL(String) returns
 * null (and crashes with a NullPointerException) if invalid characters are
 * encountered
 *
 * Somewhere in 2023-2024, NSURL will begin percent-encoding those characters:
 * https://developer.apple.com/documentation/foundation/nsurl
 */
fun String.urlEncode(): String = buildString {
  [email protected]().forEach { byte ->
    val b = byte.toInt().and(0xff)

    if (b.isUnreserved()) {
      append(b.toChar())
    } else {
      append(b.percentEncode())
    }
  }
}

fun String.urlDecode(): String {
  val buffer = Buffer()

  var i = 0
  while (i < length) {
    val c = get(i)
    if (c == '%') {
      check(i + 3 <= length)
      buffer.writeByte(substring(i + 1, i + 3).toInt(16))
      i += 3
    } else {
      // XXX probably wrong if there is a surrogate pair
      buffer.writeUtf8CodePoint(c.code)
      i++
    }
  }

  return buffer.readUtf8()
}

private fun Int.percentEncode(): String {
  var hex = this.toString(16).uppercase()
  if (hex.length == 1) {
    hex = "0$hex"
  }
  return "%$hex"
}