commonMain.io.ktor.http.content.Multipart.kt Maven / Gradle / Ivy
/*
* Copyright 2014-2021 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
*/
package io.ktor.http.content
import io.ktor.http.*
import io.ktor.http.content.PartData.*
import io.ktor.utils.io.*
import io.ktor.utils.io.core.*
/**
* Represents a multipart/form-data entry. Could be a [FormItem] or [FileItem]
* @property dispose to be invoked when this part is no longed needed
* @property headers of this part, could be inaccurate on some engines
*/
public sealed class PartData(public val dispose: () -> Unit, public val headers: Headers) {
/**
* Represents a multipart form item
* @property value of this field
*/
public class FormItem(public val value: String, dispose: () -> Unit, partHeaders: Headers) :
PartData(dispose, partHeaders)
/**
* Represents a file item
* @property provider of content bytes
*/
public class FileItem(
public val provider: () -> Input,
dispose: () -> Unit,
partHeaders: Headers
) : PartData(dispose, partHeaders) {
/**
* Original file name if present
*/
public val originalFileName: String? = contentDisposition?.parameter(ContentDisposition.Parameters.FileName)
}
/**
* Represents a binary item
* @property provider of content bytes
*/
public class BinaryItem(
public val provider: () -> Input,
dispose: () -> Unit,
partHeaders: Headers
) : PartData(dispose, partHeaders)
/**
* Represents a binary part with a provider that supplies [ByteReadChannel]
* @property provider supplies a channel to read data from
*/
public class BinaryChannelItem(
public val provider: () -> ByteReadChannel,
partHeaders: Headers
) : PartData({}, partHeaders)
/**
* Parsed `Content-Disposition` header or `null` if missing
*/
public val contentDisposition: ContentDisposition? by lazy(LazyThreadSafetyMode.NONE) {
headers[HttpHeaders.ContentDisposition]?.let { ContentDisposition.parse(it) }
}
/**
* Parsed `Content-Type` header or `null` if missing
*/
public val contentType: ContentType? by lazy(LazyThreadSafetyMode.NONE) {
headers[HttpHeaders.ContentType]?.let {
ContentType.parse(
it
)
}
}
/**
* Optional part name based on `Content-Disposition` header
*/
public val name: String? get() = contentDisposition?.name
@Suppress("KDocMissingDocumentation", "unused")
@Deprecated(
"Use name property instead",
ReplaceWith("name"),
level = DeprecationLevel.ERROR
)
public val partName: String?
get() = name
@Suppress("KDocMissingDocumentation", "unused")
@Deprecated(
"Use headers property instead",
ReplaceWith("headers"),
level = DeprecationLevel.ERROR
)
public val partHeaders: Headers
get() = headers
}
/**
* Represents a multipart data stream that could be received from a call
*/
public interface MultiPartData {
/**
* Reads next part data or `null` if end of multipart stream encountered
*/
public suspend fun readPart(): PartData?
/**
* An empty multipart data stream
*/
public object Empty : MultiPartData {
override suspend fun readPart(): PartData? {
return null
}
}
}
/**
* Parse multipart data stream and invoke [partHandler] for each [PartData] encountered
* @param partHandler to be invoked for every part item
*/
public suspend fun MultiPartData.forEachPart(partHandler: suspend (PartData) -> Unit) {
while (true) {
val part = readPart() ?: break
partHandler(part)
}
}
/**
* Parse multipart data stream and put all parts into a list
* @return a list of part data
*/
public suspend fun MultiPartData.readAllParts(): List {
var part = readPart() ?: return emptyList()
val parts = ArrayList()
parts.add(part)
do {
part = readPart() ?: break
parts.add(part)
} while (true)
return parts
}