core/src/commonMain/kotlin/licensee/LicenseeLicenseInfoRepository.kt
author Da Risk <da_risk@geekorum.com>
Tue, 22 Apr 2025 14:19:23 -0400
changeset 34 ce299aacc068
parent 29 b6b62004b1e7
child 46 c40e90a1b0fa
permissions -rw-r--r--
build: update license headers
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
28
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     1
/*
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     2
 * AboutOss is an utility library to retrieve and display
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     3
 * opensource licenses in Android applications.
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     4
 *
34
ce299aacc068 build: update license headers
Da Risk <da_risk@geekorum.com>
parents: 29
diff changeset
     5
 * Copyright (C) 2023-2025 by Frederic-Charles Barthelery.
28
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     6
 *
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     7
 * This file is part of AboutOss.
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     8
 *
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     9
 * AboutOss is free software: you can redistribute it and/or modify
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    10
 * it under the terms of the GNU General Public License as published by
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    11
 * the Free Software Foundation, either version 3 of the License, or
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    12
 * (at your option) any later version.
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    13
 *
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    14
 * AboutOss is distributed in the hope that it will be useful,
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    15
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    17
 * GNU General Public License for more details.
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    18
 *
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    19
 * You should have received a copy of the GNU General Public License
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    20
 * along with AboutOss.  If not, see <http://www.gnu.org/licenses/>.
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    21
 */
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    22
package com.geekorum.aboutoss.core.licensee
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    23
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    24
import kotlinx.coroutines.CoroutineDispatcher
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    25
import kotlinx.coroutines.withContext
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    26
import kotlinx.serialization.ExperimentalSerializationApi
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    27
import okio.Source
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    28
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    29
class LicenseeLicenseInfoRepository(
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    30
    private val produceInput: suspend () -> Source,
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    31
    private val mainCoroutineDispatcher: CoroutineDispatcher,
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    32
    private val ioCoroutineDispatcher: CoroutineDispatcher,
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    33
) {
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    34
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    35
    private var licensesInfo: Map<String, String>? = null
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    36
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    37
    suspend fun getLicensesInfo(): Map<String, String> = withContext(mainCoroutineDispatcher) {
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    38
        parseLicenses()
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    39
        checkNotNull(licensesInfo)
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    40
    }
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    41
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    42
    suspend fun getLicenseFor(dependency: String): String = withContext(mainCoroutineDispatcher) {
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    43
        parseLicenses()
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    44
        checkNotNull(licensesInfo).let {
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    45
            return@withContext it[dependency] ?: error("Dependency not found")
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    46
        }
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    47
    }
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    48
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    49
    @OptIn(ExperimentalSerializationApi::class)
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    50
    private suspend fun parseLicenses() = withContext(mainCoroutineDispatcher) {
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    51
        if (licensesInfo == null) {
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    52
            val licenses = withContext(ioCoroutineDispatcher) {
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    53
                LicenseeParser(produceInput()).use {
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    54
                    it.readLicensee()
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    55
                }
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    56
            }
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    57
            licensesInfo = licenses
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    58
        }
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    59
    }
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    60
}
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    61