core/src/commonMain/kotlin/licensee/LicenseeLicenseInfoRepository.kt
author Da Risk <da_risk@geekorum.com>
Mon, 05 May 2025 02:56:41 -0400
changeset 79 79794afbbf95
parent 46 c40e90a1b0fa
permissions -rw-r--r--
core: add a few more kdocs

/*
 * AboutOss is an utility library to retrieve and display
 * opensource licenses in Android applications.
 *
 * Copyright (C) 2023-2025 by Frederic-Charles Barthelery.
 *
 * This file is part of AboutOss.
 *
 * AboutOss is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * AboutOss is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with AboutOss.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.geekorum.aboutoss.core.licensee

import com.geekorum.aboutoss.core.LicenseInfoRepository
import kotlinx.coroutines.CoroutineDispatcher
import kotlinx.coroutines.withContext
import kotlinx.serialization.ExperimentalSerializationApi
import okio.Source

/**
 * Retrieve license information produced by [licensee](https://github.com/cashapp/licensee)
 */
class LicenseeLicenseInfoRepository(
    private val produceInput: suspend () -> Source,
    private val mainCoroutineDispatcher: CoroutineDispatcher,
    private val ioCoroutineDispatcher: CoroutineDispatcher,
) : LicenseInfoRepository {

    private var licensesInfo: Map<String, String>? = null

    override suspend fun getLicensesInfo(): Map<String, String> = withContext(mainCoroutineDispatcher) {
        parseLicenses()
        checkNotNull(licensesInfo)
    }

    override suspend fun getLicenseFor(dependency: String): String = withContext(mainCoroutineDispatcher) {
        parseLicenses()
        checkNotNull(licensesInfo).let {
            return@withContext it[dependency] ?: error("Dependency not found")
        }
    }

    @OptIn(ExperimentalSerializationApi::class)
    private suspend fun parseLicenses() = withContext(mainCoroutineDispatcher) {
        if (licensesInfo == null) {
            val licenses = withContext(ioCoroutineDispatcher) {
                LicenseeParser(produceInput()).use {
                    it.readLicensee()
                }
            }
            licensesInfo = licenses
        }
    }
}