toolkit.model.37.0.0.source-code.PackageCurationData.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of model Show documentation
Show all versions of model Show documentation
Part of the OSS Review Toolkit (ORT), a suite to automate software compliance checks.
/*
* Copyright (C) 2017 The ORT Project Authors (see )
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
* License-Filename: LICENSE
*/
package org.ossreviewtoolkit.model
import com.fasterxml.jackson.annotation.JsonInclude
import org.ossreviewtoolkit.utils.common.zip
import org.ossreviewtoolkit.utils.ort.DeclaredLicenseProcessor
import org.ossreviewtoolkit.utils.spdx.SpdxExpression
import org.ossreviewtoolkit.utils.spdx.SpdxExpression.Strictness.ALLOW_LICENSEREF_EXCEPTIONS
/**
* This class contains curation data for a package. It is used to amend the automatically detected metadata for a
* package with corrections. This is required because the metadata provided by a package can be wrong (e.g. outdated
* VCS data) or incomplete.
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
data class PackageCurationData(
/**
* A plain-text comment about this curation. Should contain information about how and why the curation was
* created.
*/
val comment: String? = null,
/**
* An additional identifier in [package URL syntax](https://github.com/package-url/purl-spec).
*/
val purl: String? = null,
/**
* An additional identifier in [CPE syntax](https://cpe.mitre.org/specification/).
*/
val cpe: String? = null,
/**
* The set of authors of the package.
*/
val authors: Set? = null,
/**
* The concluded license as an [SpdxExpression]. It can be used to override the [declared][Package.declaredLicenses]
* / [detected][LicenseFinding.license] licenses of the package.
*/
val concludedLicense: SpdxExpression? = null,
/**
* The description of the package, as provided by the package manager.
*/
val description: String? = null,
/**
* The homepage of the package.
*/
val homepageUrl: String? = null,
/**
* The remote artifact where the binary package can be downloaded.
*/
val binaryArtifact: RemoteArtifact? = null,
/**
* The remote artifact where the source package can be downloaded.
*/
val sourceArtifact: RemoteArtifact? = null,
/**
* VCS-related information.
*/
val vcs: VcsInfoCurationData? = null,
/**
* Whether the package is metadata only.
*/
val isMetadataOnly: Boolean? = null,
/**
* Whether the package is modified compared to the original source
*/
val isModified: Boolean? = null,
/**
* The declared license mapping entries to be added to the actual declared license mapping, which in turn gets
* applied by [DeclaredLicenseProcessor.process].
*/
@JsonInclude(JsonInclude.Include.NON_EMPTY)
val declaredLicenseMapping: Map = emptyMap(),
/**
* The considered source code origins in order of priority. If not null, this must not be empty and not contain any
* duplicates.
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
val sourceCodeOrigins: List? = null
) {
init {
declaredLicenseMapping.forEach { (key, value) ->
require(value.isValid(ALLOW_LICENSEREF_EXCEPTIONS)) {
"The declared license '$key' is configured to map to '$value' which is not a valid SPDX expression."
}
}
}
/**
* Apply this [PackageCuration] to [targetPackage] by overriding all values of [targetPackage] with non-null values
* of this [PackageCurationData], and return the resulting [CuratedPackage].
*/
fun apply(targetPackage: CuratedPackage): CuratedPackage {
val original = targetPackage.metadata
val vcsProcessed = vcs?.let {
// Curation data for VCS information is handled specially, so we can curate only individual properties.
VcsInfo(
type = it.type ?: original.vcsProcessed.type,
url = it.url ?: original.vcsProcessed.url,
revision = it.revision ?: original.vcsProcessed.revision,
path = it.path ?: original.vcsProcessed.path
).normalize()
} ?: original.vcsProcessed
val declaredLicenseMapping = targetPackage.getDeclaredLicenseMapping() + declaredLicenseMapping
val declaredLicensesProcessed = DeclaredLicenseProcessor.process(
original.declaredLicenses,
declaredLicenseMapping
)
val pkg = Package(
id = original.id,
purl = purl ?: original.purl,
cpe = cpe ?: original.cpe,
authors = authors ?: original.authors,
declaredLicenses = original.declaredLicenses,
declaredLicensesProcessed = declaredLicensesProcessed,
concludedLicense = concludedLicense ?: original.concludedLicense,
description = description ?: original.description,
homepageUrl = homepageUrl ?: original.homepageUrl,
binaryArtifact = binaryArtifact ?: original.binaryArtifact,
sourceArtifact = sourceArtifact ?: original.sourceArtifact,
vcs = original.vcs,
vcsProcessed = vcsProcessed,
isMetadataOnly = isMetadataOnly ?: original.isMetadataOnly,
isModified = isModified ?: original.isModified,
sourceCodeOrigins = sourceCodeOrigins ?: original.sourceCodeOrigins
)
val declaredLicenseMappingDiff = buildMap {
val previous = targetPackage.getDeclaredLicenseMapping().toList()
val current = declaredLicenseMapping.toList()
putAll(previous - current)
}
val curations = targetPackage.curations + PackageCurationResult(
base = original.diff(pkg).copy(declaredLicenseMapping = declaredLicenseMappingDiff),
curation = this
)
return CuratedPackage(pkg, curations)
}
/**
* Merge with [other] curation data. The `comment` properties are joined but probably need to be adjusted before
* further processing as their meaning might have been distorted by the merge. For properties that cannot be merged,
* data in this instance has precedence over data in the other instance.
*/
fun merge(other: PackageCurationData) =
PackageCurationData(
comment = setOfNotNull(comment, other.comment).joinToString("\n").takeIf { it.isNotEmpty() },
purl = purl ?: other.purl,
cpe = cpe ?: other.cpe,
authors = authors.orEmpty() + other.authors.orEmpty(),
concludedLicense = setOfNotNull(concludedLicense, other.concludedLicense).reduce(SpdxExpression::and),
description = description ?: other.description,
homepageUrl = homepageUrl ?: other.homepageUrl,
binaryArtifact = binaryArtifact ?: other.binaryArtifact,
sourceArtifact = sourceArtifact ?: other.sourceArtifact,
vcs = vcs?.merge(other.vcs ?: vcs) ?: other.vcs,
isMetadataOnly = isMetadataOnly ?: other.isMetadataOnly,
isModified = isModified ?: other.isModified,
declaredLicenseMapping = declaredLicenseMapping.zip(other.declaredLicenseMapping) { value, otherValue ->
@Suppress("UnsafeCallOnNullableType")
(value ?: otherValue)!!
},
sourceCodeOrigins = sourceCodeOrigins ?: other.sourceCodeOrigins
)
}