SpdxLicenseAliasMapping.kt

/*
 * Copyright (C) 2017-2019 HERE Europe B.V.
 *
 * 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
 *
 *     http://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 com.here.ort.spdx

import com.here.ort.spdx.SpdxLicense.*
import com.here.ort.spdx.SpdxLicenseException.*

/**
 * A mapping from varied SPDX license names to valid SPDX expressions.
 */
object SpdxLicenseAliasMapping {
    /**
     * The map of custom license names associated with their corresponding SPDX expression.
     */
    private val customNames = mapOf(
        "AFLv2.1" to AFL_2_1,
        "ALv2" to APACHE_2_0,
        "APL2" to APACHE_2_0,
        "APLv2.0" to APACHE_2_0,
        "ASL" to APACHE_2_0,
        "Apache" to APACHE_2_0,
        "Apache-2" to APACHE_2_0,
        "Apache2" to APACHE_2_0,
        "BOOST" to BSL_1_0,
        "BSD" to BSD_2_CLAUSE,
        "BSD-3" to BSD_3_CLAUSE,
        "BSD-Style" to BSD_3_CLAUSE,
        "BSD-like" to BSD_3_CLAUSE,
        "BSD-style" to BSD_3_CLAUSE,
        "BSD2" to BSD_2_CLAUSE,
        "BSD3" to BSD_3_CLAUSE,
        "CC0" to CC0_1_0,
        "CDDL" to CDDL_1_0,
        "CPL" to CPL_1_0,
        "EDL-1.0" to BSD_3_CLAUSE,
        "EPL" to EPL_1_0,
        "FreeBSD" to BSD_2_CLAUSE_FREEBSD,
        "GPL" to GPL_2_0_ONLY,
        "GPL-2" to GPL_2_0_ONLY,
        "GPL2" to GPL_2_0_ONLY,
        "GPLv2" to GPL_2_0_ONLY,
        "GPLv3" to GPL_3_0_ONLY,
        "LGPL" to LGPL_2_1_ONLY,
        "LGPL-3" to LGPL_3_0_ONLY,
        "LGPL3" to LGPL_3_0_ONLY,
        "LGPLv3" to LGPL_3_0_ONLY,
        "MIT-like" to MIT,
        "MIT-style" to MIT,
        "MPL" to MPL_2_0,
        "MPLv2.0" to MPL_2_0,
        "Ruby's" to RUBY,
        "UNLICENSE" to UNLICENSE,
        "UNLICENSED" to UNLICENSE,
        "boost" to BSL_1_0,
        "lgpl" to LGPL_2_1_ONLY,
        "ruby" to RUBY,
        "wtfpl" to WTFPL,
        "zlib" to ZLIB
    ).mapValues { (_, v) -> v.toExpression() }

    /**
     * The map of deprecated SPDX license names associated with their current SPDX expression.
     */
    private val deprecatedLicenses = mapOf(
        "AGPL-1.0" to AGPL_1_0_ONLY,
        "AGPL-1.0+" to AGPL_1_0_OR_LATER,
        "AGPL-3.0" to AGPL_3_0_ONLY,
        "AGPL-3.0+" to AGPL_3_0_OR_LATER,
        "GFDL-1.1" to GFDL_1_1_ONLY,
        "GFDL-1.1+" to GFDL_1_1_OR_LATER,
        "GFDL-1.2" to GFDL_1_2_ONLY,
        "GFDL-1.2+" to GFDL_1_2_OR_LATER,
        "GFDL-1.3" to GFDL_1_3_ONLY,
        "GFDL-1.3+" to GFDL_1_3_OR_LATER,
        "GPL-1.0" to GPL_1_0_ONLY,
        "GPL-1.0+" to GPL_1_0_OR_LATER,
        "GPL-2.0" to GPL_2_0_ONLY,
        "GPL-2.0+" to GPL_2_0_OR_LATER,
        "GPL-3.0" to GPL_3_0_ONLY,
        "GPL-3.0+" to GPL_3_0_OR_LATER,
        "LGPL-2.0" to LGPL_2_0_ONLY,
        "LGPL-2.0+" to LGPL_2_0_OR_LATER,
        "LGPL-2.1" to LGPL_2_1_ONLY,
        "LGPL-2.1+" to LGPL_2_1_OR_LATER,
        "LGPL-3.0" to LGPL_3_0_ONLY,
        "LGPL-3.0+" to LGPL_3_0_OR_LATER
    ).mapValues { (_, v) -> v.toExpression() }

    /**
     * The map of deprecated SPDX license exception names associated with their current compound SPDX expression.
     */
    private val deprecatedExceptions = mapOf(
        "GPL-2.0-with-autoconf-exception" to (GPL_2_0_ONLY with AUTOCONF_EXCEPTION_2_0),
        "GPL-2.0-with-bison-exception" to (GPL_2_0_ONLY with BISON_EXCEPTION_2_2),
        "GPL-2.0-with-classpath-exception" to (GPL_2_0_ONLY with CLASSPATH_EXCEPTION_2_0),
        "GPL-2.0-with-font-exception" to (GPL_2_0_ONLY with FONT_EXCEPTION_2_0),
        "GPL-2.0-with-GCC-exception" to (GPL_2_0_ONLY with GCC_EXCEPTION_2_0),
        "GPL-3.0-with-autoconf-exception" to (GPL_3_0_ONLY with AUTOCONF_EXCEPTION_3_0),
        "GPL-3.0-with-GCC-exception" to (GPL_3_0_ONLY with GCC_EXCEPTION_3_1)
    )

    /**
     * The map of varied SPDX license names associated with their corresponding SPDX expression.
     */
    val mapping = customNames + deprecatedLicenses + deprecatedExceptions

    /**
     * Return the [SpdxExpression] the [license] name maps to, or null if there is no corresponding expression. If
     * [mapDeprecated] is true, license names marked as deprecated in the SPDX standard are mapped to their
     * corresponding current expression, otherwise they are mapped to their corresponding deprecated expression.
     */
    fun map(license: String, mapDeprecated: Boolean = true) =
        (if (mapDeprecated) mapping else customNames)[license] ?: SpdxLicense.forId(license)?.toExpression()
}