-
Notifications
You must be signed in to change notification settings - Fork 396
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Convert ApacheNoticeResourceTransformer * Convert PropertiesFileTransformer
- Loading branch information
Showing
4 changed files
with
405 additions
and
482 deletions.
There are no files selected for viewing
178 changes: 178 additions & 0 deletions
178
...om/github/jengelman/gradle/plugins/shadow/transformers/ApacheNoticeResourceTransformer.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,178 @@ | ||
package com.github.jengelman.gradle.plugins.shadow.transformers | ||
|
||
import java.io.PrintWriter | ||
import java.nio.charset.Charset | ||
import java.text.SimpleDateFormat | ||
import java.util.Date | ||
import java.util.TreeSet | ||
import org.apache.tools.zip.ZipEntry | ||
import org.apache.tools.zip.ZipOutputStream | ||
import org.gradle.api.file.FileTreeElement | ||
import org.gradle.api.tasks.Input | ||
import org.gradle.api.tasks.Optional | ||
|
||
/** | ||
* Merges `META-INF/NOTICE.TXT` files. | ||
* | ||
* Modified from `org.apache.maven.plugins.shade.resource.ApacheNoticeResourceTransformer.java` | ||
* | ||
* @author John Engelman | ||
*/ | ||
open class ApacheNoticeResourceTransformer : Transformer { | ||
private val entries = mutableSetOf<String>() | ||
private val organizationEntries = mutableMapOf<String, MutableSet<String>>() | ||
private val charset get() = if (encoding.isNullOrEmpty()) Charsets.UTF_8 else Charset.forName(encoding) | ||
|
||
/** | ||
* MSHADE-101 :: NullPointerException when projectName is missing | ||
*/ | ||
@get:Input | ||
var projectName: String = "" | ||
|
||
@get:Input | ||
var addHeader: Boolean = true | ||
|
||
@get:Input | ||
var preamble1: String = """ | ||
// ------------------------------------------------------------------ | ||
// NOTICE file corresponding to the section 4d of The Apache License, | ||
// Version 2.0, in this case for | ||
""".trimIndent() | ||
|
||
@get:Input | ||
var preamble2: String = "\n// ------------------------------------------------------------------\n" | ||
|
||
@get:Input | ||
var preamble3: String = "This product includes software developed at\n" | ||
|
||
@get:Input | ||
var organizationName: String = "The Apache Software Foundation" | ||
|
||
@get:Input | ||
var organizationURL: String = "http://www.apache.org/" | ||
|
||
@get:Input | ||
var inceptionYear: String = "2006" | ||
|
||
@get:Optional | ||
@get:Input | ||
var copyright: String? = null | ||
|
||
/** | ||
* The file encoding of the `NOTICE` file. | ||
*/ | ||
@get:Optional | ||
@get:Input | ||
var encoding: String? = null | ||
|
||
override fun canTransformResource(element: FileTreeElement): Boolean { | ||
val path = element.relativePath.pathString | ||
return NOTICE_PATH.equals(path, ignoreCase = true) || NOTICE_TXT_PATH.equals(path, ignoreCase = true) | ||
} | ||
|
||
override fun transform(context: TransformerContext) { | ||
if (entries.isEmpty()) { | ||
val year = SimpleDateFormat("yyyy").format(Date()).let { | ||
if (inceptionYear != it) "$inceptionYear-$it" else it | ||
} | ||
// add headers | ||
if (addHeader) { | ||
entries.add("$preamble1$projectName$preamble2") | ||
} else { | ||
entries.add("") | ||
} | ||
// fake second entry, we'll look for a real one later | ||
entries.add("$projectName\nCopyright $year $organizationName\n") | ||
entries.add("$preamble3$organizationName ($organizationURL).\n") | ||
} | ||
|
||
val reader = context.inputStream.bufferedReader(charset) | ||
var line = reader.readLine() | ||
val sb = StringBuffer() | ||
var currentOrg: MutableSet<String>? = null | ||
var lineCount = 0 | ||
while (line != null) { | ||
val trimmedLine = line.trim() | ||
if (!trimmedLine.startsWith("//")) { | ||
if (trimmedLine.isNotEmpty()) { | ||
if (trimmedLine.startsWith("- ")) { | ||
// resource-bundle 1.3 mode | ||
if (lineCount == 1 && sb.toString().contains("This product includes/uses software(s) developed by")) { | ||
currentOrg = organizationEntries.getOrPut(sb.toString().trim()) { TreeSet() } | ||
sb.setLength(0) | ||
} else if (sb.isNotEmpty() && currentOrg != null) { | ||
currentOrg.add(sb.toString()) | ||
sb.setLength(0) | ||
} | ||
} | ||
sb.append(line).append("\n") | ||
lineCount++ | ||
} else { | ||
val entry = sb.toString() | ||
if (entry.startsWith(projectName) && entry.contains("Copyright ")) { | ||
copyright = entry | ||
} | ||
if (currentOrg == null) { | ||
entries.add(entry) | ||
} else { | ||
currentOrg.add(entry) | ||
} | ||
sb.setLength(0) | ||
lineCount = 0 | ||
currentOrg = null | ||
} | ||
} | ||
|
||
line = reader.readLine() | ||
} | ||
if (sb.isNotEmpty()) { | ||
if (currentOrg == null) { | ||
entries.add(sb.toString()) | ||
} else { | ||
currentOrg.add(sb.toString()) | ||
} | ||
} | ||
} | ||
|
||
override fun hasTransformedResource(): Boolean = true | ||
|
||
override fun modifyOutputStream(os: ZipOutputStream, preserveFileTimestamps: Boolean) { | ||
val zipEntry = ZipEntry(NOTICE_PATH) | ||
zipEntry.time = TransformerContext.getEntryTimestamp(preserveFileTimestamps, zipEntry.time) | ||
os.putNextEntry(zipEntry) | ||
|
||
val writer = PrintWriter(os.writer(charset)) | ||
|
||
var count = 0 | ||
for (line in entries) { | ||
count++ | ||
if (line == copyright && count != 2) continue | ||
if (count == 2 && copyright != null) { | ||
writer.print(copyright) | ||
writer.print('\n') | ||
} else { | ||
writer.print(line) | ||
writer.print('\n') | ||
} | ||
if (count == 3) { | ||
// do org stuff | ||
for ((key, value) in organizationEntries) { | ||
writer.print(key) | ||
writer.print('\n') | ||
for (l in value) { | ||
writer.print(l) | ||
} | ||
writer.print('\n') | ||
} | ||
} | ||
} | ||
|
||
writer.flush() | ||
entries.clear() | ||
} | ||
|
||
private companion object { | ||
private const val NOTICE_PATH = "META-INF/NOTICE" | ||
private const val NOTICE_TXT_PATH = "META-INF/NOTICE.txt" | ||
} | ||
} |
Oops, something went wrong.