1
0
mirror of https://github.com/InsanusMokrassar/TelegramBotAPI.git synced 2024-06-03 00:15:27 +00:00
tgbotapi/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/requests/abstracts/InputFile.kt

83 lines
2.7 KiB
Kotlin
Raw Normal View History

2020-10-04 11:06:30 +00:00
package dev.inmo.tgbotapi.requests.abstracts
2018-12-26 08:07:24 +00:00
2021-09-08 14:58:44 +00:00
import dev.inmo.micro_utils.common.MPPFile
2021-08-10 10:54:15 +00:00
import dev.inmo.tgbotapi.utils.*
import io.ktor.utils.io.ByteReadChannel
2021-09-08 14:58:44 +00:00
import io.ktor.utils.io.core.Input
2021-06-28 05:12:51 +00:00
import kotlinx.serialization.KSerializer
import kotlinx.serialization.Serializable
2020-08-18 06:50:11 +00:00
import kotlinx.serialization.descriptors.*
import kotlinx.serialization.encoding.Decoder
import kotlinx.serialization.encoding.Encoder
2018-12-26 08:07:24 +00:00
2021-09-08 15:13:42 +00:00
/**
* Common type for all files in Telegram Bot API which can be sent via requests like [dev.inmo.tgbotapi.requests.send.media.SendDocument].
* You may use methods like [MPPFile.asMultipartFile] when you want to send files from your file system, but you should
* remember about [restrictions][https://core.telegram.org/bots/api#sending-files] in Telegram for bots. In case you
* wish to send file by its url, use [FileId] and pass your url as [FileId.fileId]
*
* @see MPPFile.asMultipartFile
* @see ByteArray.asMultipartFile
* @see ByteReadChannel.asMultipartFile
* @see ByteReadChannelAllocator.asMultipartFile
*/
2019-04-13 02:15:25 +00:00
@Serializable(InputFileSerializer::class)
2018-12-26 08:07:24 +00:00
sealed class InputFile {
abstract val fileId: String
}
2020-11-02 07:51:20 +00:00
internal inline val InputFile.attachFileId
get() = "attach://$fileId"
internal inline val InputFile.fileIdToSend
get() = when (this) {
is FileId -> fileId
is MultipartFile -> attachFileId
}
2018-12-26 08:07:24 +00:00
// TODO:: add checks for file url/file id regex
/**
* Contains file id or file url
*/
2019-04-13 02:15:25 +00:00
@Serializable(InputFileSerializer::class)
2018-12-26 08:07:24 +00:00
data class FileId(
override val fileId: String
) : InputFile()
2020-02-07 16:12:18 +00:00
fun String.toInputFile() = FileId(this)
2018-12-26 08:07:24 +00:00
2021-05-29 09:34:14 +00:00
@RiskFeature
object InputFileSerializer : KSerializer<InputFile> {
2020-08-18 06:50:11 +00:00
override val descriptor: SerialDescriptor = PrimitiveSerialDescriptor(FileId::class.toString(), PrimitiveKind.STRING)
2020-03-22 07:37:01 +00:00
override fun serialize(encoder: Encoder, value: InputFile) = encoder.encodeString(value.fileId)
2019-02-21 06:21:33 +00:00
override fun deserialize(decoder: Decoder): FileId = FileId(decoder.decodeString())
2018-12-26 08:07:24 +00:00
}
// TODO:: add checks for files size
/**
* Contains info about file for sending
2021-08-10 10:54:15 +00:00
*
* @see asMultipartFile
2018-12-26 08:07:24 +00:00
*/
2019-04-13 02:15:25 +00:00
@Serializable(InputFileSerializer::class)
2018-12-26 08:07:24 +00:00
data class MultipartFile (
2019-02-21 06:09:04 +00:00
val file: StorageFile,
2022-04-11 15:00:56 +00:00
val filename: String = file.fileName
2018-12-26 08:07:24 +00:00
) : InputFile() {
2022-04-11 15:00:56 +00:00
override val fileId: String = file.generateCustomName()
2018-12-26 08:07:24 +00:00
}
2021-08-10 10:54:15 +00:00
2021-08-13 05:45:21 +00:00
@Suppress("NOTHING_TO_INLINE", "unused")
inline fun StorageFile.asMultipartFile() = MultipartFile(this)
2021-08-10 10:54:15 +00:00
@Suppress("NOTHING_TO_INLINE", "unused")
suspend inline fun ByteReadChannel.asMultipartFile(
2021-08-13 08:02:39 +00:00
fileName: String
) = MultipartFile(asStorageFile(fileName))
2021-08-10 10:54:15 +00:00
@Suppress("NOTHING_TO_INLINE", "unused")
suspend inline fun ByteReadChannelAllocator.asMultipartFile(
2021-08-13 08:02:39 +00:00
fileName: String
) = this.invoke().asMultipartFile(fileName)
2021-09-08 14:58:44 +00:00
expect suspend fun MPPFile.asMultipartFile(): MultipartFile