core/src/commonMain/kotlin/licensee/LicenseeParser.kt
author Da Risk <da_risk@geekorum.com>
Mon, 05 May 2025 12:48:39 -0400
changeset 82 8a915338c80d
parent 79 79794afbbf95
permissions -rw-r--r--
ui:material2: add more kdocs
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
29
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     1
/*
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     2
 * AboutOss is an utility library to retrieve and display
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     3
 * opensource licenses in Android applications.
b6b62004b1e7 core: extract LicenseeParser
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.
29
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     6
 *
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     7
 * This file is part of AboutOss.
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     8
 *
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     9
 * AboutOss is free software: you can redistribute it and/or modify
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    10
 * it under the terms of the GNU General Public License as published by
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    11
 * the Free Software Foundation, either version 3 of the License, or
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    12
 * (at your option) any later version.
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    13
 *
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    14
 * AboutOss is distributed in the hope that it will be useful,
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    15
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    17
 * GNU General Public License for more details.
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    18
 *
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    19
 * You should have received a copy of the GNU General Public License
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    20
 * along with AboutOss.  If not, see <http://www.gnu.org/licenses/>.
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    21
 */
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    22
package com.geekorum.aboutoss.core.licensee
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    23
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    24
import kotlinx.serialization.Serializable
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    25
import kotlinx.serialization.json.Json
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    26
import okio.Source
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    27
import okio.buffer
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    28
79
79794afbbf95 core: add a few more kdocs
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
    29
/**
79794afbbf95 core: add a few more kdocs
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
    30
 * Parse licences data generated by the [licensee](https://github.com/cashapp/licensee) gradle plugin.
79794afbbf95 core: add a few more kdocs
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
    31
 */
29
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    32
class LicenseeParser(
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    33
    input: Source
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    34
): AutoCloseable {
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    35
    private val buffered = input.buffer()
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    36
79
79794afbbf95 core: add a few more kdocs
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
    37
    /**
79794afbbf95 core: add a few more kdocs
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
    38
     * Read licensee data
79794afbbf95 core: add a few more kdocs
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
    39
     *
79794afbbf95 core: add a few more kdocs
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
    40
     * @return a map of dependency name to license
79794afbbf95 core: add a few more kdocs
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
    41
     */
29
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    42
    fun readLicensee(): Map<String, String> {
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    43
        val json = Json {
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    44
            ignoreUnknownKeys = true
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    45
        }
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    46
        val items: List<LicenseItem> = json.decodeFromString(buffered.readUtf8())
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    47
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    48
        return items.associate {
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    49
            val name = it.name ?: "${it.groupId}:${it.artifactId}"
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    50
            val license = it.spdxLicenses.firstNotNullOfOrNull {
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    51
                "${it.name}\n\n${it.url}"
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    52
            } ?: it.unknownLicenses.firstNotNullOf {
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    53
                "${it.name}\n\n${it.url}"
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    54
            }
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    55
            name to license
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    56
        }
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    57
    }
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    58
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    59
    override fun close() {
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    60
        buffered.close()
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    61
    }
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    62
}
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    63
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    64
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    65
@Serializable
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    66
private data class LicenseItem(
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    67
    val groupId: String,
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    68
    val artifactId: String,
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    69
    val version: String,
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    70
    val spdxLicenses: List<SpdxLicense> = emptyList(),
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    71
    val unknownLicenses: List<UnknownLicense> = emptyList(),
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    72
    val name: String? = null,
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    73
    val scm: Scm? = null,
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    74
)
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    75
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    76
@Serializable
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    77
private data class SpdxLicense(
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    78
    val identifier: String,
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    79
    val name: String,
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    80
    val url: String,
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    81
)
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    82
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    83
@Serializable
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    84
private data class UnknownLicense(
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    85
    val name: String,
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    86
    val url: String
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    87
)
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    88
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    89
@Serializable
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    90
private data class Scm(
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    91
    val url: String,
b6b62004b1e7 core: extract LicenseeParser
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    92
)