core/src/commonMain/kotlin/licensee/LicenseeLicenseInfoRepository.kt
author Da Risk <da_risk@geekorum.com>
Thu, 03 Apr 2025 16:08:10 -0400
changeset 28 19cf2e8a0627
child 29 b6b62004b1e7
permissions -rw-r--r--
core: add LicenseeLicenseInfoRepository
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
 *
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     5
 * Copyright (C) 2023 by Frederic-Charles Barthelery.
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 kotlinx.serialization.Serializable
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    28
import kotlinx.serialization.json.Json
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    29
import okio.Source
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    30
import okio.buffer
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    31
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    32
class LicenseeLicenseInfoRepository(
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    33
    private val produceInput: suspend () -> Source,
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    34
    private val mainCoroutineDispatcher: CoroutineDispatcher,
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    35
    private val ioCoroutineDispatcher: CoroutineDispatcher,
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
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    38
    private var licensesInfo: Map<String, String>? = null
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    39
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    40
    suspend fun getLicensesInfo(): Map<String, String> = withContext(mainCoroutineDispatcher) {
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    41
        parseLicenses()
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    42
        checkNotNull(licensesInfo)
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    43
    }
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    44
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    45
    suspend fun getLicenseFor(dependency: String): String = withContext(mainCoroutineDispatcher) {
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    46
        parseLicenses()
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    47
        checkNotNull(licensesInfo).let {
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    48
            return@withContext it[dependency] ?: error("Dependency not found")
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    49
        }
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    50
    }
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    51
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    52
    @OptIn(ExperimentalSerializationApi::class)
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    53
    private suspend fun parseLicenses() = withContext(mainCoroutineDispatcher) {
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    54
        if (licensesInfo == null) {
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    55
            val licenses = withContext(ioCoroutineDispatcher) {
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    56
                LicenseeParser(produceInput()).use {
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    57
                    it.readLicensee()
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
            licensesInfo = licenses
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    61
        }
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    62
    }
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    63
}
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    64
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    65
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    66
private class LicenseeParser(
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    67
    input: Source
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    68
): AutoCloseable {
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    69
    private val buffered = input.buffer()
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    70
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    71
    fun readLicensee(): Map<String, String> {
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    72
        val json = Json {
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    73
            ignoreUnknownKeys = true
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    74
        }
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    75
        val items: List<LicenseItem> = json.decodeFromString(buffered.readUtf8())
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    76
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    77
        return items.associate {
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    78
            val name = it.name ?: "${it.groupId}:${it.artifactId}"
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    79
            val license = it.spdxLicenses.firstNotNullOfOrNull {
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    80
                "${it.name}\n\n${it.url}"
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    81
            } ?: it.unknownLicenses.firstNotNullOf {
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    82
                "${it.name}\n\n${it.url}"
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    83
            }
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    84
            name to license
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    85
        }
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    86
    }
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    87
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    88
    override fun close() {
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    89
        buffered.close()
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    90
    }
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    91
}
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    92
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    93
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    94
@Serializable
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    95
private data class LicenseItem(
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    96
    val groupId: String,
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    97
    val artifactId: String,
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    98
    val version: String,
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    99
    val spdxLicenses: List<SpdxLicense> = emptyList(),
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   100
    val unknownLicenses: List<UnknownLicense> = emptyList(),
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   101
    val name: String? = null,
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   102
    val scm: Scm? = null,
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   103
)
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   104
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   105
@Serializable
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   106
private data class SpdxLicense(
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   107
    val identifier: String,
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   108
    val name: String,
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   109
    val url: String,
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   110
)
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   111
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   112
@Serializable
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   113
private data class UnknownLicense(
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   114
    val name: String,
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   115
    val url: String
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   116
)
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   117
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   118
@Serializable
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   119
private data class Scm(
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   120
    val url: String,
19cf2e8a0627 core: add LicenseeLicenseInfoRepository
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   121
)