Extensible manifest format.

This commit is contained in:
2023-03-13 15:49:00 -07:00
parent 0478616f34
commit df8f755ff7
12 changed files with 115 additions and 15 deletions

View File

@ -6,3 +6,7 @@ dependencies {
implementation(project(":other-library"))
implementation(project(":bukkit-plugins:common-library"))
}
concrete {
dependency(project(":bukkit-plugins:goodbye-world"))
}

View File

@ -0,0 +1,12 @@
package gay.pizza.foundation.concrete
import org.gradle.api.DomainObjectSet
import org.gradle.api.Project
interface ConcretePluginExtension {
val dependencies: DomainObjectSet<Project>
fun dependency(project: Project) {
dependencies.add(project)
}
}

View File

@ -9,6 +9,8 @@ class ConcretePluginPlugin : ConcreteBaseBukkitPlugin() {
override fun apply(project: Project) {
super.apply(project)
project.extensions.create("concrete", ConcretePluginExtension::class.java)
project.plugins.apply("com.github.johnrengelman.shadow")
// During IDEA project import, if this code is active, it will print warnings.

View File

@ -2,7 +2,7 @@ package gay.pizza.foundation.concrete
import org.gradle.api.provider.Property
interface ConcreteExtension {
interface ConcreteRootExtension {
val paperServerVersionGroup: Property<String>
val paperApiVersion: Property<String>
val minecraftServerPath: Property<String>

View File

@ -9,7 +9,7 @@ import java.nio.file.Paths
class ConcreteRootPlugin : Plugin<Project> {
override fun apply(project: Project) {
project.apply(plugin = "base")
project.extensions.create<ConcreteExtension>("concrete")
project.extensions.create<ConcreteRootExtension>("concrete")
val setupPaperServer = project.tasks.create<SetupPaperServer>("setupPaperServer")
val runPaperServer = project.tasks.create<RunPaperServer>("runPaperServer")
runPaperServer.dependsOn(setupPaperServer)

View File

@ -0,0 +1,55 @@
package gay.pizza.foundation.concrete
/**
* The extensible update manifest format.
*/
data class ExtensibleManifest(
/**
* The items the manifest describes.
*/
val items: List<ExtensibleManifestItem>
)
/**
* An item in the update manifest.
*/
data class ExtensibleManifestItem(
/**
* The name of the item.
*/
val name: String,
/**
* The type of item, for example "bukkit-plugin"
*/
val type: String,
/**
* The version of the item.
*/
val version: String,
/**
* The dependencies of the item.
*/
val dependencies: List<String>,
/**
* The files that are required to install the item.
*/
val files: List<String>
)
/**
* A file built from the item.
*/
data class ExtensibleManifestItemFile(
/**
* The name of the file.
*/
val name: String,
/**
* A type of file. For example: "plugin-jar".
*/
val type: String,
/**
* The relative path to download the file.
*/
val path: String
)

View File

@ -1,7 +1,9 @@
package gay.pizza.foundation.concrete
import com.google.gson.Gson
import com.google.gson.GsonBuilder
object Globals {
val gson = Gson()
val gsonPretty: Gson = GsonBuilder().setPrettyPrinting().create()
val gson: Gson = Gson()
}

View File

@ -11,7 +11,7 @@ open class RunPaperServer : RunMinecraftServer() {
@Internal
override fun getServerDirectory(): File {
val concrete = project.extensions.getByType<ConcreteExtension>()
val concrete = project.extensions.getByType<ConcreteRootExtension>()
return project.file(concrete.minecraftServerPath.get())
}

View File

@ -34,7 +34,7 @@ abstract class SetupMinecraftServer : DefaultTask() {
Files.createSymbolicLink(pluginLinkFile.toPath(), pluginJarFile.toPath())
}
val concrete = project.extensions.getByType<ConcreteExtension>()
val concrete = project.extensions.getByType<ConcreteRootExtension>()
if (concrete.acceptServerEula.isPresent && concrete.acceptServerEula.get()) {
val writer = minecraftServerDirectory.resolve("eula.txt").bufferedWriter()
val properties = Properties()

View File

@ -18,7 +18,7 @@ open class SetupPaperServer : SetupMinecraftServer() {
@TaskAction
fun setupPaperServer() {
val concrete = project.extensions.getByType<ConcreteExtension>()
val concrete = project.extensions.getByType<ConcreteRootExtension>()
val minecraftServerDirectory = getServerDirectory()
val paperJarFile = project.file("${minecraftServerDirectory}/paper.jar")
if (!paperJarFile.exists() || shouldUpdatePaperServer) {
@ -50,7 +50,7 @@ open class SetupPaperServer : SetupMinecraftServer() {
@Internal
override fun getServerDirectory(): File {
val concrete = project.extensions.getByType<ConcreteExtension>()
val concrete = project.extensions.getByType<ConcreteRootExtension>()
return project.file(concrete.minecraftServerPath.get())
}
}

View File

@ -9,10 +9,10 @@ open class UpdateManifestTask : DefaultTask() {
@TaskAction
fun update() {
val manifestsDir = ensureManifestsDirectory()
val updateFile = manifestsDir.resolve("update.json")
val rootPath = project.rootProject.rootDir.toPath()
val updateManifest = project.findPluginProjects().mapNotNull { project ->
val rootPath = project.projectDir.toPath()
val legacyUpdateManifest = project.findPluginProjects().mapNotNull { project ->
val paths = project.shadowJarOutputs!!.allFilesRelativeToPath(rootPath)
if (paths.isNotEmpty()) {
project.name to mapOf(
"version" to project.version,
@ -21,7 +21,29 @@ open class UpdateManifestTask : DefaultTask() {
} else null
}.toMap()
Files.writeString(updateFile, Globals.gson.toJson(updateManifest))
val legacyUpdateFile = manifestsDir.resolve("update.json")
Files.writeString(legacyUpdateFile, Globals.gson.toJson(legacyUpdateManifest))
val extensibleUpdateManifestItems = project.findPluginProjects().mapNotNull { project ->
val paths = project.shadowJarOutputs!!.allFilesRelativeToPath(rootPath)
val dependencies = project.concretePluginExtension.dependencies.map { it.name }
ExtensibleManifestItem(
name = project.name,
type = "bukkit-plugin",
version = project.version.toString(),
dependencies = dependencies,
files = paths.map { it.toUnixString() }
)
}
val extensibleUpdateManifest = ExtensibleManifest(
items = extensibleUpdateManifestItems
)
val extensibleUpdateManifestFile = manifestsDir.resolve("manifest.json")
Files.writeString(
extensibleUpdateManifestFile, Globals.gsonPretty.toJson(extensibleUpdateManifest) + "\n")
}
private fun ensureManifestsDirectory(): Path {

View File

@ -30,20 +30,23 @@ internal val Project.shadowJarTask: ShadowJar?
internal val Project.shadowJarOutputs: TaskOutputs?
get() = shadowJarTask?.outputs
internal val Project.concreteRootExtension: ConcreteExtension
internal val Project.concreteRootExtension: ConcreteRootExtension
get() = findTargetParent(
valid = { extensions.findByType(ConcreteExtension::class.java) != null },
extract = { extensions.findByType(ConcreteExtension::class.java)!! },
valid = { extensions.findByType(ConcreteRootExtension::class.java) != null },
extract = { extensions.findByType(ConcreteRootExtension::class.java)!! },
error = { "Failed to find concrete root. Did you apply the concrete root plugin?" }
)
internal val Project.concretePluginExtension: ConcretePluginExtension
get() = extensions.getByType(ConcretePluginExtension::class.java)
/**
* Finds the concrete root project, which is the first project in the project hierarchy
* that has the concrete extension.
*/
internal val Project.concreteRootProject: Project
get() = findTargetParent(
valid = { extensions.findByType(ConcreteExtension::class.java) != null },
valid = { extensions.findByType(ConcreteRootExtension::class.java) != null },
extract = { this },
error = { "Failed to find concrete root. Did you apply the concrete root plugin?" }
)