feat(reporter)!: Use the configured license fact providers

mnonnenmacher · mnonnenmacher · commit 7cad831b7417 · 2025-07-23T00:09:20.000+02:00
Change the `ReporterInput` to use a `LicenseFactProvider` instead of a
`LicenseTextProvider`.

The `ReporterCommand` now creates the license fact providers based on
the ORT configuration and support for the `--custom-license-texts-dir`
option is dropped. Instead, a custom license text directory now has to
be configured in the `config.yml`.

Templates for the Freemarker or AsciiDoc reporters must also be updated
to use `licenseFactProvider` instead of `licenseTextProvider`.

Signed-off-by: Martin Nonnenmacher &lt;martin.nonnenmacher@bosch.com&gt;
diff --git a/cli/build.gradle.kts b/cli/build.gradle.kts
@@ -49,6 +49,7 @@ dependencies {
     } else {
         "pluginClasspath"(platform(projects.plugins.advisors))
         "pluginClasspath"(platform(projects.plugins.commands))
+        "pluginClasspath"(platform(projects.plugins.licenseFactProviders))
         "pluginClasspath"(platform(projects.plugins.packageConfigurationProviders))
         "pluginClasspath"(platform(projects.plugins.packageCurationProviders))
         "pluginClasspath"(platform(projects.plugins.packageManagers))
diff --git a/plugins/commands/reporter/src/main/kotlin/ReportCommand.kt b/plugins/commands/reporter/src/main/kotlin/ReportCommand.kt
@@ -63,6 +63,8 @@ import org.ossreviewtoolkit.plugins.commands.api.utils.configurationGroup
 import org.ossreviewtoolkit.plugins.commands.api.utils.inputGroup
 import org.ossreviewtoolkit.plugins.commands.api.utils.outputGroup
 import org.ossreviewtoolkit.plugins.commands.api.utils.readOrtResult
+import org.ossreviewtoolkit.plugins.licensefactproviders.api.CompositeLicenseFactProvider
+import org.ossreviewtoolkit.plugins.licensefactproviders.api.LicenseFactProviderFactory
 import org.ossreviewtoolkit.plugins.packageconfigurationproviders.api.CompositePackageConfigurationProvider
 import org.ossreviewtoolkit.plugins.packageconfigurationproviders.api.SimplePackageConfigurationProvider
 import org.ossreviewtoolkit.plugins.packageconfigurationproviders.dir.DirPackageConfigurationProvider
@@ -126,17 +128,6 @@ class ReportCommand(descriptor: PluginDescriptor = ReportCommandFactory.descript
         .default(ortConfigDirectory.resolve(ORT_COPYRIGHT_GARBAGE_FILENAME))
         .configurationGroup()
 
-    private val customLicenseTextsDir by option(
-        "--custom-license-texts-dir",
-        help = "A directory which maps custom license IDs to license texts. It should contain one text file per " +
-            "license with the license ID as the filename. A custom license text is used only if its ID has a " +
-            "'$LICENSE_REF_PREFIX' prefix and if the respective license text is not known by ORT."
-    ).convert { it.expandTilde() }
-        .file(mustExist = false, canBeFile = false, canBeDir = true, mustBeWritable = false, mustBeReadable = false)
-        .convert { it.absoluteFile.normalize() }
-        .default(ortConfigDirectory.resolve(ORT_CUSTOM_LICENSE_TEXTS_DIRNAME))
-        .configurationGroup()
-
     private val howToFixTextProviderScript by option(
         "--how-to-fix-text-provider-script",
         help = "The path to a Kotlin script which returns an instance of a 'HowToFixTextProvider'. That provider " +
@@ -219,8 +210,6 @@ class ReportCommand(descriptor: PluginDescriptor = ReportCommandFactory.descript
             ortResult = ortResult.setResolutions(resolutionProvider)
         }
 
-        val licenseTextDirectories = listOfNotNull(customLicenseTextsDir.takeIf { it.isDirectory })
-
         val resolvedPackageConfigurations = ortResult.resolvedConfiguration.packageConfigurations
         val packageConfigurationProvider = when {
             resolvedPackageConfigurations != null && packageConfigurationsDir == null -> {
@@ -264,12 +253,20 @@ class ReportCommand(descriptor: PluginDescriptor = ReportCommandFactory.descript
             HowToFixTextProvider.fromKotlinScript(it.readText(), ortResult)
         } ?: HowToFixTextProvider.NONE
 
+        val licenseFactProviders = ortConfig.licenseFactProviders.map { (id, config)->
+            val factory = LicenseFactProviderFactory.ALL[id]
+            requireNotNull(factory) { "License fact provider '$id' is not available in the classpath." }
+            factory.create(config)
+        }
+
+        val licenseFactProvider = CompositeLicenseFactProvider(licenseFactProviders)
+
         outputDir.safeMkdirs()
 
         val input = ReporterInput(
             ortResult,
             ortConfig,
-            DefaultLicenseTextProvider(licenseTextDirectories),
+            licenseFactProvider,
             copyrightGarbage,
             licenseInfoResolver,
             licenseClassifications,
diff --git a/plugins/reporters/aosd/src/main/kotlin/Aosd20Reporter.kt b/plugins/reporters/aosd/src/main/kotlin/Aosd20Reporter.kt
@@ -106,7 +106,7 @@ private fun Package.toLicenses(input: ReporterInput): List<AOSD20.License> {
 
         return effectiveLicense?.decompose()?.map { licenseExpression ->
             val name = licenseExpression.toString()
-            val text = input.licenseTextProvider.getLicenseText(name)
+            val text = input.licenseFactProvider.getLicenseText(name)
 
             AOSD20.License(
                 name = name,
diff --git a/plugins/reporters/aosd/src/main/kotlin/Aosd21Reporter.kt b/plugins/reporters/aosd/src/main/kotlin/Aosd21Reporter.kt
@@ -94,7 +94,7 @@ private fun Map<Identifier, IndexedValue<CuratedPackage>>.toComponents(
             ?.takeUnless { it.offersChoice() }
 
         val licenseTexts = licenseExpression?.licenses().orEmpty().mapNotNullTo(mutableSetOf()) { license ->
-            input.licenseTextProvider.getLicenseText(license)
+            input.licenseFactProvider.getLicenseText(license)
         }.joinToString("\n--\n") { it.trimEnd() }
 
         with(pkg.metadata) {
diff --git a/plugins/reporters/asciidoc/src/main/resources/templates/asciidoc/disclosure_document.ftl b/plugins/reporters/asciidoc/src/main/resources/templates/asciidoc/disclosure_document.ftl
@@ -147,7 +147,7 @@ The following licenses and copyrights were found in the source code of this pack
 === ${resolvedLicense.license}
 
 ++++
-[#assign licenseText = licenseTextProvider.getLicenseText(resolvedLicense.license.simpleLicense())!""]
+[#assign licenseText = licenseFactProvider.getLicenseText(resolvedLicense.license.simpleLicense())!""]
 [#if licenseText?has_content]
 
 [#assign copyrights = resolvedLicense.getCopyrights(true)]
@@ -157,7 +157,7 @@ ${copyright}
 
 ${licenseText}
 
-[#assign exceptionText = licenseTextProvider.getLicenseText(resolvedLicense.license.exception()!"")!""]
+[#assign exceptionText = licenseFactProvider.getLicenseText(resolvedLicense.license.exception()!"")!""]
 [#if exceptionText?has_content]
 
 ${exceptionText}
diff --git a/plugins/reporters/asciidoc/src/main/resources/templates/freemarker_implicit.ftl b/plugins/reporters/asciidoc/src/main/resources/templates/freemarker_implicit.ftl
@@ -4,7 +4,7 @@
 [#-- @ftlvariable name="projects" type="kotlin.collections.Set<org.ossreviewtoolkit.plugins.reporters.freemarker.FreemarkerTemplateProcessor.PackageModel>" --]
 [#-- @ftlvariable name="packages" type="kotlin.collections.Set<org.ossreviewtoolkit.plugins.reporters.freemarker.FreemarkerTemplateProcessor.PackageModel>" --]
 [#-- @ftlvariable name="ortResult" type="org.ossreviewtoolkit.model.OrtResult" --]
-[#-- @ftlvariable name="licenseTextProvider" type="org.ossreviewtoolkit.reporter.LicenseTextProvider" --]
+[#-- @ftlvariable name="licenseFactProvider" type="org.ossreviewtoolkit.plugins.licensefactproviders.api.LicenseFactProvider" --]
 [#-- @ftlvariable name="LicenseView" type="org.ossreviewtoolkit.model.licenses.LicenseView" --]
 [#-- @ftlvariable name="helper" type="org.ossreviewtoolkit.plugins.reporters.freemarker.FreemarkerTemplateProcessor.TemplateHelper" --]
 [#-- @ftlvariable name="projectsAsPackages" type="kotlin.collections.Set<org.ossreviewtoolkit.model.Identifier>" --]
diff --git a/plugins/reporters/ctrlx/src/main/kotlin/CtrlXAutomationReporter.kt b/plugins/reporters/ctrlx/src/main/kotlin/CtrlXAutomationReporter.kt
@@ -94,7 +94,7 @@ class CtrlXAutomationReporter(
             var licenses = effectiveLicense?.decompose()?.map {
                 val name = it.toString()
                 val spdxId = SpdxLicense.forId(name)?.id
-                val text = input.licenseTextProvider.getLicenseText(name)
+                val text = input.licenseFactProvider.getLicenseText(name)
                 License(name = name, spdx = spdxId, text = text.orEmpty())
             }
 
diff --git a/plugins/reporters/cyclonedx/src/main/kotlin/Utils.kt b/plugins/reporters/cyclonedx/src/main/kotlin/Utils.kt
@@ -41,7 +41,7 @@ import org.ossreviewtoolkit.utils.spdx.SpdxLicense
 internal fun Collection<String>.mapNamesToLicenses(origin: String, input: ReporterInput): List<License> =
     map { licenseName ->
         val spdxId = SpdxLicense.forId(licenseName)?.id
-        val licenseText = input.licenseTextProvider.getLicenseText(licenseName)
+        val licenseText = input.licenseFactProvider.getLicenseText(licenseName)
 
         // Prefer to set the id in case of an SPDX "core" license and only use the name as a fallback, also
         // see https://github.com/CycloneDX/cyclonedx-core-java/issues/8.
diff --git a/plugins/reporters/freemarker/src/main/kotlin/FreemarkerTemplateProcessor.kt b/plugins/reporters/freemarker/src/main/kotlin/FreemarkerTemplateProcessor.kt
@@ -433,7 +433,7 @@ private fun createDataModel(input: ReporterInput): Map<String, Any> {
         "projects" to projects,
         "packages" to packages,
         "ortResult" to input.ortResult,
-        "licenseTextProvider" to input.licenseTextProvider,
+        "licenseFactProvider" to input.licenseFactProvider,
         "LicenseView" to LicenseView,
         "helper" to FreemarkerTemplateProcessor.TemplateHelper(input),
         "statistics" to input.statistics,
diff --git a/plugins/reporters/freemarker/src/main/resources/templates/freemarker_implicit.ftl b/plugins/reporters/freemarker/src/main/resources/templates/freemarker_implicit.ftl
@@ -4,7 +4,7 @@
 [#-- @ftlvariable name="projects" type="kotlin.collections.Set<org.ossreviewtoolkit.plugins.reporters.freemarker.FreemarkerTemplateProcessor.PackageModel>" --]
 [#-- @ftlvariable name="packages" type="kotlin.collections.Set<org.ossreviewtoolkit.plugins.reporters.freemarker.FreemarkerTemplateProcessor.PackageModel>" --]
 [#-- @ftlvariable name="ortResult" type="org.ossreviewtoolkit.model.OrtResult" --]
-[#-- @ftlvariable name="licenseTextProvider" type="org.ossreviewtoolkit.reporter.LicenseTextProvider" --]
+[#-- @ftlvariable name="licenseFactProvider" type="org.ossreviewtoolkit.plugins.licensefactproviders.api.LicenseFactProvider" --]
 [#-- @ftlvariable name="LicenseView" type="org.ossreviewtoolkit.model.licenses.LicenseView" --]
 [#-- @ftlvariable name="helper" type="org.ossreviewtoolkit.plugins.reporters.freemarker.FreemarkerTemplateProcessor.TemplateHelper" --]
 [#-- @ftlvariable name="projectsAsPackages" type="kotlin.collections.Set<org.ossreviewtoolkit.model.Identifier>" --]
diff --git a/plugins/reporters/freemarker/src/main/resources/templates/plain-text/NOTICE_DEFAULT.ftl b/plugins/reporters/freemarker/src/main/resources/templates/plain-text/NOTICE_DEFAULT.ftl
@@ -36,7 +36,7 @@
 [#assign filteredLicenses = helper.filterForCategory(mergedLicenses, noticeCategoryName)]
 [#list filteredLicenses as resolvedLicense]
     [#assign licenseName = resolvedLicense.license.simpleLicense()]
-    [#assign licenseText = licenseTextProvider.getLicenseText(licenseName)!]
+    [#assign licenseText = licenseFactProvider.getLicenseText(licenseName)!]
     [#if !licenseText?has_content][#continue][/#if]
     [#if !hasNoticeProjectLicenses]
 This software includes external packages and source code.
@@ -54,7 +54,7 @@ The applicable license information is listed below:
 ${copyrights?join("\n", "", "\n")}
 ${licenseText}
     [#assign exceptionName = resolvedLicense.license.exception()!]
-    [#assign exceptionText = licenseTextProvider.getLicenseText(exceptionName)!]
+    [#assign exceptionText = licenseFactProvider.getLicenseText(exceptionName)!]
     [#if exceptionText?has_content]
 ${exceptionText}
     [/#if]
@@ -105,7 +105,7 @@ ${copyrights?join("\n", "")}
     [#assign isFirst = true]
     [#list resolvedLicenses as resolvedLicense]
         [#assign licenseName = resolvedLicense.license.simpleLicense()]
-        [#assign licenseText = licenseTextProvider.getLicenseText(licenseName)!]
+        [#assign licenseText = licenseFactProvider.getLicenseText(licenseName)!]
         [#if !licenseText?has_content][#continue][/#if]
         [#if isFirst]
             [#if !hasNoticePackageLicenses]
@@ -127,7 +127,7 @@ The following copyrights and licenses were found in the source code of this pack
 ${copyrights?join("\n", "", "\n")}
 ${licenseText}
         [#assign exceptionName = resolvedLicense.license.exception()!]
-        [#assign exceptionText = licenseTextProvider.getLicenseText(exceptionName)!]
+        [#assign exceptionText = licenseFactProvider.getLicenseText(exceptionName)!]
         [#if exceptionText?has_content]
 ${exceptionText}
         [/#if]
diff --git a/plugins/reporters/freemarker/src/main/resources/templates/plain-text/NOTICE_SUMMARY.ftl b/plugins/reporters/freemarker/src/main/resources/templates/plain-text/NOTICE_SUMMARY.ftl
@@ -44,7 +44,7 @@ This project contains or depends on third-party software components pursuant to
     )]
     [#list mergedLicenses as resolvedLicense]
         [#assign licenseName = resolvedLicense.license.simpleLicense()]
-        [#assign licenseText = licenseTextProvider.getLicenseText(licenseName)!]
+        [#assign licenseText = licenseFactProvider.getLicenseText(licenseName)!]
         [#if !licenseText?has_content][#continue][/#if]
         [#if isFirst]
             [#assign isFirst = false]
@@ -58,7 +58,7 @@ This project contains or depends on third-party software components pursuant to
 ${copyrights?join("\n", "", "\n")}
 ${licenseText}
         [#assign exceptionName = resolvedLicense.license.exception()!]
-        [#assign exceptionText = licenseTextProvider.getLicenseText(exceptionName)!]
+        [#assign exceptionText = licenseFactProvider.getLicenseText(exceptionName)!]
         [#if exceptionText?has_content]
 ${exceptionText}
         [/#if]
diff --git a/plugins/reporters/opossum/src/main/kotlin/OpossumReporter.kt b/plugins/reporters/opossum/src/main/kotlin/OpossumReporter.kt
@@ -129,7 +129,7 @@ class OpossumReporter(
             addBaseUrl("/", input.ortResult.repository.vcs)
 
             SpdxLicense.entries.forEach {
-                val licenseText = input.licenseTextProvider.getLicenseText(it.id)
+                val licenseText = input.licenseFactProvider.getLicenseText(it.id)
                 frequentLicenses += OpossumFrequentLicense(it.id, it.fullName, licenseText)
             }
 
diff --git a/plugins/reporters/spdx/src/main/kotlin/Extensions.kt b/plugins/reporters/spdx/src/main/kotlin/Extensions.kt
@@ -44,7 +44,7 @@ import org.ossreviewtoolkit.model.licenses.LicenseView
 import org.ossreviewtoolkit.model.licenses.ResolvedLicenseInfo
 import org.ossreviewtoolkit.model.utils.FindingCurationMatcher
 import org.ossreviewtoolkit.model.utils.prependedPath
-import org.ossreviewtoolkit.reporter.LicenseTextProvider
+import org.ossreviewtoolkit.plugins.licensefactproviders.api.LicenseFactProvider
 import org.ossreviewtoolkit.utils.common.replaceCredentialsInUri
 import org.ossreviewtoolkit.utils.spdx.SpdxConstants
 import org.ossreviewtoolkit.utils.spdx.SpdxExpression
@@ -230,7 +230,7 @@ private fun OrtResult.getPackageVerificationCode(id: Identifier, type: SpdxPacka
 /**
  * Use [licenseTextProvider] to add the license texts for all packages to the [SpdxDocument].
  */
-internal fun SpdxDocument.addExtractedLicenseInfo(licenseTextProvider: LicenseTextProvider): SpdxDocument {
+internal fun SpdxDocument.addExtractedLicenseInfo(licenseFactProvider: LicenseFactProvider): SpdxDocument {
     val allLicenses = buildSet {
         packages.forEach {
             add(it.licenseConcluded)
@@ -242,7 +242,7 @@ internal fun SpdxDocument.addExtractedLicenseInfo(licenseTextProvider: LicenseTe
     val nonSpdxLicenses = allLicenses.filter { SpdxConstants.isPresent(it) && SpdxLicense.forId(it) == null }
 
     val extractedLicenseInfo = nonSpdxLicenses.sorted().mapNotNull { license ->
-        licenseTextProvider.getLicenseText(license)?.let { text ->
+        licenseFactProvider.getLicenseText(license)?.let { text ->
             SpdxExtractedLicenseInfo(
                 licenseId = license,
                 extractedText = text
diff --git a/plugins/reporters/spdx/src/main/kotlin/SpdxDocumentModelMapper.kt b/plugins/reporters/spdx/src/main/kotlin/SpdxDocumentModelMapper.kt
@@ -28,7 +28,7 @@ import org.ossreviewtoolkit.model.OrtResult
 import org.ossreviewtoolkit.model.SourceCodeOrigin.ARTIFACT
 import org.ossreviewtoolkit.model.SourceCodeOrigin.VCS
 import org.ossreviewtoolkit.model.licenses.LicenseInfoResolver
-import org.ossreviewtoolkit.reporter.LicenseTextProvider
+import org.ossreviewtoolkit.plugins.licensefactproviders.api.LicenseFactProvider
 import org.ossreviewtoolkit.utils.ort.ORT_NAME
 import org.ossreviewtoolkit.utils.ort.ORT_VERSION
 import org.ossreviewtoolkit.utils.spdx.SpdxConstants
@@ -46,7 +46,7 @@ internal object SpdxDocumentModelMapper {
     fun map(
         ortResult: OrtResult,
         licenseInfoResolver: LicenseInfoResolver,
-        licenseTextProvider: LicenseTextProvider,
+        licenseFactProvider: LicenseFactProvider,
         config: SpdxDocumentReporterConfig
     ): SpdxDocument {
         val nextFileIndex = AtomicInteger(1)
@@ -177,7 +177,7 @@ internal object SpdxDocumentModelMapper {
             packages = projectPackages + packages,
             relationships = relationships.sortedBy { it.spdxElementId },
             files = files
-        ).addExtractedLicenseInfo(licenseTextProvider)
+        ).addExtractedLicenseInfo(licenseFactProvider)
             .filterChecksums(config.wantSpdx23)
     }
 }
diff --git a/plugins/reporters/spdx/src/main/kotlin/SpdxDocumentReporter.kt b/plugins/reporters/spdx/src/main/kotlin/SpdxDocumentReporter.kt
@@ -118,7 +118,7 @@ class SpdxDocumentReporter(
         val spdxDocument = SpdxDocumentModelMapper.map(
             input.ortResult,
             input.licenseInfoResolver,
-            input.licenseTextProvider,
+            input.licenseFactProvider,
             config
         )
 
diff --git a/reporter/build.gradle.kts b/reporter/build.gradle.kts
@@ -28,6 +28,7 @@ plugins {
 dependencies {
     api(projects.model)
     api(projects.plugins.api)
+    api(projects.plugins.licenseFactProviders.licenseFactProviderApi)
 
     implementation(projects.utils.scriptingUtils)
     implementation(projects.utils.spdxUtils)
diff --git a/reporter/src/main/kotlin/ReporterInput.kt b/reporter/src/main/kotlin/ReporterInput.kt
@@ -27,6 +27,8 @@ import org.ossreviewtoolkit.model.config.createFileArchiver
 import org.ossreviewtoolkit.model.licenses.DefaultLicenseInfoProvider
 import org.ossreviewtoolkit.model.licenses.LicenseClassifications
 import org.ossreviewtoolkit.model.licenses.LicenseInfoResolver
+import org.ossreviewtoolkit.plugins.licensefactproviders.api.CompositeLicenseFactProvider
+import org.ossreviewtoolkit.plugins.licensefactproviders.api.LicenseFactProvider
 import org.ossreviewtoolkit.reporter.StatisticsCalculator.getStatistics
 
 /**
@@ -46,7 +48,7 @@ data class ReporterInput(
     /**
      * A [LicenseTextProvider], can be used to integrate licenses texts into reports.
      */
-    val licenseTextProvider: LicenseTextProvider = DefaultLicenseTextProvider(),
+    val licenseFactProvider: LicenseFactProvider = CompositeLicenseFactProvider(emptyList()),
 
     /**
      * A [CopyrightGarbage] container, can be used to clean up copyrights used in reports.

Original file line number	Diff line number	Diff line change
`@@ -94,7 +94,7 @@ class CtrlXAutomationReporter(`
`94`	`94`	`var licenses = effectiveLicense?.decompose()?.map {`
`95`	`95`	`val name = it.toString()`
`96`	`96`	`val spdxId = SpdxLicense.forId(name)?.id`
`97`		`- val text = input.licenseTextProvider.getLicenseText(name)`
	`97`	`+ val text = input.licenseFactProvider.getLicenseText(name)`
`98`	`98`	`License(name = name, spdx = spdxId, text = text.orEmpty())`
`99`	`99`	`}`
`100`	`100`