okhttp3.FormBody.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of okhttp Show documentation
null
There is a newer version: 5.0.0-alpha.14
/*
 * Copyright (C) 2014 Square, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package okhttp3

import okhttp3.HttpUrl.Companion.FORM_ENCODE_SET
import okhttp3.HttpUrl.Companion.percentDecode
import okhttp3.internal.Util
import okio.Buffer
import okio.BufferedSink
import java.io.IOException
import java.nio.charset.Charset

class FormBody internal constructor(
  encodedNames: List,
  encodedValues: List
) : RequestBody() {
  private val encodedNames: List = Util.immutableList(encodedNames)
  private val encodedValues: List = Util.immutableList(encodedValues)

  /** The number of key-value pairs in this form-encoded body.  */
  fun size(): Int = encodedNames.size

  fun encodedName(index: Int) = encodedNames[index]

  fun name(index: Int) = percentDecode(encodedName(index), true)

  fun encodedValue(index: Int) = encodedValues[index]

  fun value(index: Int) = percentDecode(encodedValue(index), true)

  override fun contentType() = CONTENT_TYPE

  override fun contentLength() = writeOrCountBytes(null, true)

  @Throws(IOException::class)
  override fun writeTo(sink: BufferedSink) {
    writeOrCountBytes(sink, false)
  }

  /**
   * Either writes this request to `sink` or measures its content length. We have one method
   * do double-duty to make sure the counting and content are consistent, particularly when it comes
   * to awkward operations like measuring the encoded length of header strings, or the
   * length-in-digits of an encoded integer.
   */
  private fun writeOrCountBytes(sink: BufferedSink?, countBytes: Boolean): Long {
    var byteCount = 0L
    val buffer: Buffer = if (countBytes) Buffer() else sink!!.buffer

    for (i in 0 until encodedNames.size) {
      if (i > 0) buffer.writeByte('&'.toInt())
      buffer.writeUtf8(encodedNames[i])
      buffer.writeByte('='.toInt())
      buffer.writeUtf8(encodedValues[i])
    }

    if (countBytes) {
      byteCount = buffer.size
      buffer.clear()
    }

    return byteCount
  }

  class Builder @JvmOverloads constructor(private val charset: Charset? = null) {
    private val names = mutableListOf()
    private val values = mutableListOf()

    fun add(name: String, value: String) = apply {
      names += HttpUrl.canonicalize(name, FORM_ENCODE_SET, false, false, true, true, charset)
      values += HttpUrl.canonicalize(value, FORM_ENCODE_SET, false, false, true, true, charset)
    }

    fun addEncoded(name: String, value: String) = apply {
      names += HttpUrl.canonicalize(name, FORM_ENCODE_SET, true, false, true, true, charset)
      values += HttpUrl.canonicalize(value, FORM_ENCODE_SET, true, false, true, true, charset)
    }

    fun build(): FormBody = FormBody(names, values)
  }

  companion object {
    private val CONTENT_TYPE: MediaType = MediaType.get("application/x-www-form-urlencoded")
  }
}