| author | Da Risk <da_risk@geekorum.com> | 
| Sat, 01 Nov 2025 00:00:48 -0400 | |
| changeset 111 | f42cdc67a8e7 | 
| parent 34 | ce299aacc068 | 
| permissions | -rw-r--r-- | 
| 0 | 1  | 
/*  | 
2  | 
* AboutOss is a utility library to retrieve and display  | 
|
3  | 
* opensource licenses in Android applications.  | 
|
4  | 
*  | 
|
| 
34
 
ce299aacc068
build: update license headers
 
Da Risk <da_risk@geekorum.com> 
parents: 
11 
diff
changeset
 | 
5  | 
* Copyright (C) 2023-2025 by Frederic-Charles Barthelery.  | 
| 0 | 6  | 
*  | 
7  | 
* This file is part of AboutOss.  | 
|
8  | 
*  | 
|
9  | 
* AboutOss is free software: you can redistribute it and/or modify  | 
|
10  | 
* it under the terms of the GNU General Public License as published by  | 
|
11  | 
* the Free Software Foundation, either version 3 of the License, or  | 
|
12  | 
* (at your option) any later version.  | 
|
13  | 
*  | 
|
14  | 
* AboutOss is distributed in the hope that it will be useful,  | 
|
15  | 
* but WITHOUT ANY WARRANTY; without even the implied warranty of  | 
|
16  | 
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the  | 
|
17  | 
* GNU General Public License for more details.  | 
|
18  | 
*  | 
|
19  | 
* You should have received a copy of the GNU General Public License  | 
|
20  | 
* along with AboutOss. If not, see <http://www.gnu.org/licenses/>.  | 
|
21  | 
*/  | 
|
22  | 
package com.geekorum.build  | 
|
23  | 
||
24  | 
import com.android.build.api.dsl.AndroidSourceSet  | 
|
25  | 
import com.android.build.gradle.BaseExtension  | 
|
26  | 
import com.android.build.gradle.DynamicFeaturePlugin  | 
|
| 
111
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
27  | 
import com.android.build.gradle.TestPlugin  | 
| 0 | 28  | 
import com.hierynomus.gradle.license.LicenseBasePlugin  | 
29  | 
import com.hierynomus.gradle.license.tasks.LicenseCheck  | 
|
30  | 
import com.hierynomus.gradle.license.tasks.LicenseFormat  | 
|
31  | 
import nl.javadude.gradle.plugins.license.License  | 
|
32  | 
import nl.javadude.gradle.plugins.license.LicenseExtension  | 
|
33  | 
import nl.javadude.gradle.plugins.license.LicensePlugin  | 
|
34  | 
import org.gradle.api.NamedDomainObjectContainer  | 
|
35  | 
import org.gradle.api.Project  | 
|
36  | 
import org.gradle.api.file.FileTree  | 
|
37  | 
import org.gradle.api.tasks.TaskProvider  | 
|
38  | 
import org.gradle.kotlin.dsl.*  | 
|
39  | 
import org.jetbrains.kotlin.gradle.dsl.KotlinProjectExtension  | 
|
40  | 
import org.jetbrains.kotlin.gradle.plugin.KotlinAndroidPluginWrapper  | 
|
41  | 
import org.jetbrains.kotlin.gradle.plugin.KotlinJsPluginWrapper  | 
|
42  | 
import org.jetbrains.kotlin.gradle.plugin.KotlinMultiplatformPluginWrapper  | 
|
| 
111
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
43  | 
import java.util.Locale  | 
| 0 | 44  | 
|
45  | 
internal fun Project.configureSourceLicenseChecker() {
 | 
|
46  | 
apply<LicensePlugin>()  | 
|
47  | 
||
48  | 
    configure<LicenseExtension> {
 | 
|
49  | 
        header = file("$rootDir/config/license/header.txt")
 | 
|
50  | 
        mapping("java", "SLASHSTAR_STYLE")
 | 
|
51  | 
        mapping("kt", "SLASHSTAR_STYLE")
 | 
|
52  | 
||
53  | 
        excludes(listOf("**/*.webp", "**/*.png"))
 | 
|
54  | 
}  | 
|
55  | 
||
56  | 
// the LicensePlugin doesn't configure itself properly on DynamicFeaturePlugin  | 
|
57  | 
// Copied the code to configure it  | 
|
58  | 
    plugins.withType(DynamicFeaturePlugin::class.java) {
 | 
|
59  | 
configureAndroid()  | 
|
60  | 
}  | 
|
| 
111
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
61  | 
|
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
62  | 
// the LicensePlugin doesn't configure itself properly on Android Test plugin  | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
63  | 
// Copied the code to configure it  | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
64  | 
    plugins.withType(TestPlugin::class.java) {
 | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
65  | 
configureAndroid()  | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
66  | 
}  | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
67  | 
|
| 0 | 68  | 
// make the license tasks looks for kotlin files in an Android project  | 
69  | 
    plugins.withType(KotlinAndroidPluginWrapper::class.java) {
 | 
|
70  | 
configureKotlinAndroid()  | 
|
71  | 
}  | 
|
72  | 
||
73  | 
// make the license tasks for kotlin js project  | 
|
74  | 
    plugins.withType(KotlinJsPluginWrapper::class.java) {
 | 
|
75  | 
configureKotlin()  | 
|
76  | 
}  | 
|
77  | 
||
78  | 
    plugins.withType(KotlinMultiplatformPluginWrapper::class.java) {
 | 
|
79  | 
configureKotlin()  | 
|
80  | 
}  | 
|
81  | 
}  | 
|
82  | 
||
83  | 
@OptIn(ExperimentalStdlibApi::class)  | 
|
84  | 
private fun Project.configureKotlin() {
 | 
|
85  | 
val kotlin = the<KotlinProjectExtension>()  | 
|
86  | 
val taskInfix = ""  | 
|
87  | 
    kotlin.sourceSets.configureEach {
 | 
|
88  | 
val kotlinSource = this  | 
|
89  | 
val sourceSetTaskName =  | 
|
| 11 | 90  | 
            "${LicenseBasePlugin.getLICENSE_TASK_BASE_NAME()}${taskInfix}${name.capitalize()}"
 | 
| 
111
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
91  | 
        if (name.startsWith("generated")) {
 | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
92  | 
            logger.info("Skip sourceSet $name because it's generated code")
 | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
93  | 
return@configureEach  | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
94  | 
}  | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
95  | 
        val configureLicenseCheckTaskLambda: LicenseCheck.() -> Unit = {
 | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
96  | 
source(kotlinSource.kotlin)  | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
97  | 
            exclude {
 | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
98  | 
// exclude generated files, notably protobuf, ksp, hilt  | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
99  | 
"/generated/" in it.file.path  | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
100  | 
}  | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
101  | 
}  | 
| 0 | 102  | 
        if (sourceSetTaskName in tasks.names) {
 | 
103  | 
// tasks may have already been added by configuration for the Android plugin  | 
|
| 
111
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
104  | 
            logger.info("Tasks $sourceSetTaskName already exists. configure it")
 | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
105  | 
tasks.named(sourceSetTaskName, LicenseCheck::class.java, configureLicenseCheckTaskLambda)  | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
106  | 
        } else {
 | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
107  | 
            logger.info("Adding ${project.name}:$sourceSetTaskName task for sourceSet ${kotlinSource.name}")
 | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
108  | 
tasks.register(sourceSetTaskName, LicenseCheck::class.java, configureLicenseCheckTaskLambda)  | 
| 0 | 109  | 
}  | 
| 
111
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
110  | 
|
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
111  | 
        val configureLicenseFormatTaskLambda: LicenseFormat.() -> Unit = {
 | 
| 0 | 112  | 
source(kotlinSource.kotlin)  | 
| 
111
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
113  | 
            exclude {
 | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
114  | 
// exclude generated files, notably protobuf, ksp, hilt  | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
115  | 
"/generated/" in it.file.path  | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
116  | 
}  | 
| 0 | 117  | 
}  | 
118  | 
val sourceSetFormatTaskName =  | 
|
| 11 | 119  | 
            "${LicenseBasePlugin.getFORMAT_TASK_BASE_NAME()}${taskInfix}${name.capitalize()}"
 | 
| 
111
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
120  | 
        if (sourceSetFormatTaskName in tasks.names) {
 | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
121  | 
// tasks may have already been added by configuration for the Android plugin  | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
122  | 
            logger.info("Tasks $sourceSetFormatTaskName already exists. configure it")
 | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
123  | 
tasks.named(sourceSetFormatTaskName, LicenseFormat::class.java, configureLicenseFormatTaskLambda)  | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
124  | 
        } else {
 | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
125  | 
            logger.info("Adding ${project.name}:$sourceSetFormatTaskName task for sourceSet ${kotlinSource.name}")
 | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
126  | 
tasks.register(sourceSetFormatTaskName, LicenseFormat::class.java, configureLicenseFormatTaskLambda)  | 
| 0 | 127  | 
}  | 
128  | 
}  | 
|
129  | 
}  | 
|
130  | 
||
131  | 
@OptIn(ExperimentalStdlibApi::class)  | 
|
132  | 
private fun Project.configureKotlinAndroid() {
 | 
|
133  | 
val kotlin = the<KotlinProjectExtension>()  | 
|
134  | 
val android = the<BaseExtension>()  | 
|
135  | 
val taskInfix = "Android"  | 
|
136  | 
    android.sourceSets.configureEach {
 | 
|
137  | 
val kotlinSource = kotlin.sourceSets[name]  | 
|
138  | 
        logger.info("Adding kotlin sources from sourceSet $name to License plugin tasks")
 | 
|
139  | 
val sourceSetTaskName =  | 
|
| 11 | 140  | 
            "${LicenseBasePlugin.getLICENSE_TASK_BASE_NAME()}${taskInfix}${name.capitalize()}"
 | 
| 0 | 141  | 
        tasks.named(sourceSetTaskName, LicenseCheck::class.java) {
 | 
142  | 
source(kotlinSource.kotlin, manifest.srcFile)  | 
|
| 
111
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
143  | 
            exclude {
 | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
144  | 
// exclude generated files, notably protobuf  | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
145  | 
"/generated/" in it.file.path  | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
146  | 
}  | 
| 0 | 147  | 
}  | 
148  | 
val sourceSetFormatTaskName =  | 
|
| 11 | 149  | 
            "${LicenseBasePlugin.getFORMAT_TASK_BASE_NAME()}${taskInfix}${name.capitalize()}"
 | 
| 0 | 150  | 
        tasks.named(sourceSetFormatTaskName, LicenseFormat::class.java) {
 | 
151  | 
source(kotlinSource.kotlin, manifest.srcFile)  | 
|
| 
111
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
152  | 
            exclude {
 | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
153  | 
// exclude generated files, notably protobuf  | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
154  | 
"/generated/" in it.file.path  | 
| 
 
f42cdc67a8e7
build: SourceLicenseChecker exclude checks on generated files
 
Da Risk <da_risk@geekorum.com> 
parents: 
34 
diff
changeset
 | 
155  | 
}  | 
| 0 | 156  | 
}  | 
157  | 
}  | 
|
158  | 
}  | 
|
159  | 
||
160  | 
||
161  | 
private fun Project.configureAndroid() {
 | 
|
162  | 
val android = the<BaseExtension>()  | 
|
163  | 
    configureSourceSetRule(android.sourceSets, "Android") { ss ->
 | 
|
164  | 
        @Suppress("DEPRECATION")
 | 
|
165  | 
        when (ss) {
 | 
|
166  | 
// the dsl.AndroidSourceSet don't expose any getter, so we still need to cast it  | 
|
167  | 
            is com.android.build.gradle.api.AndroidSourceSet -> {
 | 
|
168  | 
ss.java.getSourceFiles() + ss.res.getSourceFiles() + fileTree(ss.manifest.srcFile)  | 
|
169  | 
}  | 
|
170  | 
else -> fileTree()  | 
|
171  | 
}  | 
|
172  | 
}  | 
|
173  | 
}  | 
|
174  | 
||
175  | 
/**  | 
|
176  | 
* Dynamically create a task for each sourceSet, and register with check  | 
|
177  | 
*/  | 
|
178  | 
@Suppress("DefaultLocale")
 | 
|
179  | 
private fun Project.configureSourceSetRule(androidSourceSetContainer: NamedDomainObjectContainer<out AndroidSourceSet>,  | 
|
180  | 
                                           taskInfix: String, sourceSetSources: (AndroidSourceSet) -> FileTree) {
 | 
|
181  | 
// This follows the other check task pattern  | 
|
182  | 
    androidSourceSetContainer.configureEach {
 | 
|
183  | 
        val sourceSetTaskName = "${LicenseBasePlugin.getLICENSE_TASK_BASE_NAME()}${taskInfix}${name.capitalize()}"
 | 
|
184  | 
        logger.info("Adding $sourceSetTaskName task for sourceSet $name")
 | 
|
185  | 
||
186  | 
val checkTask = tasks.register(sourceSetTaskName, LicenseCheck::class.java)  | 
|
187  | 
configureForSourceSet(this, checkTask, sourceSetSources)  | 
|
188  | 
||
189  | 
// Add independent license task, which will perform format  | 
|
190  | 
        val sourceSetFormatTaskName = "${LicenseBasePlugin.getFORMAT_TASK_BASE_NAME()}${taskInfix}${name.capitalize()}"
 | 
|
191  | 
val formatTask = tasks.register(sourceSetFormatTaskName, LicenseFormat::class.java)  | 
|
192  | 
configureForSourceSet(this, formatTask, sourceSetSources)  | 
|
193  | 
}  | 
|
194  | 
}  | 
|
195  | 
||
196  | 
private fun configureForSourceSet(sourceSet: AndroidSourceSet, task: TaskProvider<out License>, sourceSetSources: (AndroidSourceSet) -> FileTree) {
 | 
|
197  | 
    task.configure {
 | 
|
198  | 
// Explicitly set description  | 
|
199  | 
        description = "Scanning license on ${sourceSet.name} files"
 | 
|
200  | 
||
201  | 
// Default to all source files from SourceSet  | 
|
202  | 
source = sourceSetSources(sourceSet)  | 
|
203  | 
}  | 
|
204  | 
}  | 
|
| 11 | 205  | 
|
206  | 
private fun String.capitalize() = replaceFirstChar {
 | 
|
207  | 
if (it.isLowerCase()) it.titlecase(  | 
|
208  | 
Locale.ROOT  | 
|
209  | 
) else it.toString()  | 
|
210  | 
}  |