core/src/commonMain/kotlin/gms/OssLicenseParser.kt
author Da Risk <da_risk@geekorum.com>
Thu, 03 Apr 2025 16:11:04 -0400
changeset 29 b6b62004b1e7
parent 24 f07de07b90c4
child 30 763a6573b900
permissions -rw-r--r--
core: extract LicenseeParser
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
24
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     1
/*
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     2
 * AboutOss is an utility library to retrieve and display
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     3
 * opensource licenses in Android applications.
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     4
 *
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     5
 * Copyright (C) 2023 by Frederic-Charles Barthelery.
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     6
 *
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     7
 * This file is part of AboutOss.
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     8
 *
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     9
 * AboutOss is free software: you can redistribute it and/or modify
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    10
 * it under the terms of the GNU General Public License as published by
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    11
 * the Free Software Foundation, either version 3 of the License, or
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    12
 * (at your option) any later version.
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    13
 *
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    14
 * AboutOss is distributed in the hope that it will be useful,
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    15
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    17
 * GNU General Public License for more details.
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    18
 *
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    19
 * You should have received a copy of the GNU General Public License
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    20
 * along with AboutOss.  If not, see <http://www.gnu.org/licenses/>.
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    21
 */
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    22
package com.geekorum.aboutoss.core.gms
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    23
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    24
import okio.ByteString
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    25
import okio.Source
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    26
import okio.buffer
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    27
import okio.use
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    28
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    29
/**
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    30
 * Parse licences data generated by the "com.google.android.gms.oss-licenses-plugin" gradle plugin.
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    31
 */
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    32
class OssLicenseParser {
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    33
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    34
    /**
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    35
     * Parse licenses
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    36
     * @param [thirdPartyLicensesInput] is usually res/raw/third_party_licenses file
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    37
     * @param [thirdPartyLicensesMetadataInput] is usually res/raw/third_party_license_metadata file
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    38
     */
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    39
    fun parseLicenses(
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    40
        thirdPartyLicensesInput: Source, thirdPartyLicensesMetadataInput: Source
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    41
    ): Map<String, String> {
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    42
        val licenses = readLicensesFile(thirdPartyLicensesInput)
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    43
        return buildLicenseInfo(licenses, thirdPartyLicensesMetadataInput)
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    44
    }
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    45
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    46
    private fun readLicensesFile(thirdPartyLicensesInput: Source): ByteString {
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    47
        return thirdPartyLicensesInput.buffer().use {
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    48
            it.readByteString()
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    49
        }
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    50
    }
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    51
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    52
    private fun buildLicenseInfo(license: ByteString, thirdPartyLicensesMetadataInput: Source): Map<String, String> {
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    53
        return thirdPartyLicensesMetadataInput.buffer().use {
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    54
            buildMap {
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    55
                while (true) {
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    56
                    val line = it.readUtf8Line() ?: break
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    57
                    if (line.isNotBlank()) {
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    58
                        with(line.toLineParser()) {
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    59
                            val start = readStartIdx()
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    60
                            val length = readLength()
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    61
                            val dependency = readName()
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    62
                            val licenseTxt = license.substring(
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    63
                                beginIndex = start,
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    64
                                endIndex = start + length + 1
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    65
                            ).utf8()
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    66
                            put(dependency, licenseTxt)
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    67
                        }
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    68
                    }
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    69
                }
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    70
            }
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    71
        }
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    72
    }
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    73
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    74
    companion object
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    75
}
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    76
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    77
private class LicenseMetadataLineParser(
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    78
    private val line: String
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    79
) {
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    80
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    81
    private var idx = 0
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    82
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    83
    fun readStartIdx(): Int {
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    84
        val end = line.indexOf(':', startIndex = idx)
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    85
        val result = line.substring(idx, end).toInt()
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    86
        idx = end + 1
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    87
        return result
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    88
    }
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    89
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    90
    fun readLength(): Int {
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    91
        val end = line.indexOf(' ', startIndex = idx)
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    92
        val result = line.substring(idx, end).toInt()
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    93
        idx = end + 1
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    94
        return result
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    95
    }
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    96
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    97
    fun readName(): String {
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    98
        val result = line.substring(idx)
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    99
        idx = line.length + 1
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   100
        return result
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   101
    }
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   102
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   103
}
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   104
f07de07b90c4 core: port OssLicenseParser to multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
   105
private fun String.toLineParser() = LicenseMetadataLineParser(this)