top.kagg886.pixko.account.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pixko Show documentation
An api accesser for pixiv writed by kotlin
There is a newer version: 2.1
package top.kagg886.pixko

import io.ktor.client.*
import io.ktor.client.engine.okhttp.*
import io.ktor.client.plugins.*
import io.ktor.client.plugins.contentnegotiation.*
import io.ktor.client.plugins.logging.*
import io.ktor.client.request.*
import io.ktor.serialization.kotlinx.json.*
import okhttp3.Dns
import okhttp3.OkHttpClient
import top.kagg886.pixko.TokenType.ACCESS
import top.kagg886.pixko.TokenType.REFRESH
import top.kagg886.pixko.internal.TokenAutoRefreshPlugin
import kotlin.collections.set

/**
 * # Token类型
 * @property ACCESS
 * @property REFRESH
 */
enum class TokenType {
    ACCESS, REFRESH
}

/**
 * # Token存储器
 * @see InMemoryTokenStorage
 */
interface TokenStorage {
    fun getToken(type: TokenType): String?
    fun setToken(type: TokenType, token: String)
}

/**
 * # 将token存入内存的Token存储器
 */
class InMemoryTokenStorage : TokenStorage {
    private val map = mutableMapOf()
    override fun getToken(type: TokenType): String? = map[type]

    override fun setToken(type: TokenType, token: String) {
        map[type] = token
    }
}

/**
 * # Pixiv账号配置
 * @see PixivAccount
 * @property storage token存储器
 * @property loggerLevel 日志配置
 * @property language 语言配置，置null则为日文。
 */
class PixivAccountConfig {
    enum class LoggerLevel(
        val level: LogLevel,
    ) {
        ALL(LogLevel.ALL),
        INFO(LogLevel.INFO),
        NONE(LogLevel.NONE)
    }

    var storage: TokenStorage = InMemoryTokenStorage()
    var loggerLevel: LoggerLevel = LoggerLevel.NONE
    var language: String? = "zh-CN"
    var engine: OkHttpClient.Builder.() -> Unit = {}
}

/**
 * # PixivAPP Client
 * 内部仅包含程序的核心部分，api定义在[top.kagg886.pixko.module]中
 *
 * @see PixivAccountFactory
 */
class PixivAccount internal constructor(private val config: PixivAccountConfig) :
    AutoCloseable {

    internal val client = HttpClient(OkHttp) {
        engine {
            config {
                config.engine(this)
            }
        }
        install(ContentNegotiation) {
            json(top.kagg886.pixko.internal.json)
        }


        install(TokenAutoRefreshPlugin) {
            tokenStorage = config.storage
        }

        install(Logging) {
            logger = Logger.DEFAULT
            level = config.loggerLevel.level
        }

        install(HttpTimeout)

        defaultRequest {
            url("https://app-api.pixiv.net/")
            header("Accept-Language", config.language)
        }
    }

    override fun close() {
        client.close()
    }
}