Add resource manager for data packs

Add packs

Updates to resources
I did most of this a few months ago. I don't remember all the specifics.

Remove leftover empty file from rebase

Fix compile errors related to PluginContainer

Add some missing javadocs

Convert PackVersion to a standard catalog type

More edits to javadocs

Fix licenses

Make proper register events for ResourceReloadListener and PackDiscoverer

Add a reload method to Engine to reload resources.

Tweaks to API for common impl

Update to use kyori text

Update for API changes

Implement resource events
API: rename the register event method

Update for registry changes

ResourcePath now wraps ResourceKey

Update for latest api-8.

Signed-off-by: Chris Sanders <[email protected]>

Fixup more naming convention

- Remove the need for a Closeablelist by turning it into Stream (which
auto closes) in ResourceManager.

Signed-off-by: Chris Sanders <[email protected]>

More refactoring

- PackInfo -> PackInformation
- Establish that `Pack` is engine-scoped. It is not the intention of
this API to instill that client resources should be loaded server side
nor should server data be loaded client side. That does not mean that a
plugin couldn't take it upon themselves to do so (they are simply files
after all) but it is the goal of the API to correctly establish what a
developer *should* be doing ultimately.
- Per the former, move retrieval of a PluginContainer's pack to
ResourceManager
- Migrate PackVersion/PackType to enums. There is no reason a developer
should be creating additional versions or types via the API.

Signed-off-by: Chris Sanders <[email protected]>

Move the information manager to the resource manager.

Plugins should grab their information first. If they want a pack, they
can call it off the information object.

Signed-off-by: Chris Sanders <[email protected]>

Update for feedback/refactoring

- Remove exposing listeners, not really a goal of this API unless we one
 day add the ability to do additional plugin provided packs
- Move PackRepository up to engine, this is not tied to resource
managers
- Various method name fixes/javadoc fixes (needs an overall javadoc
pass)

Signed-off-by: Chris Sanders <[email protected]>

Name isn't very helpful.

Signed-off-by: Chris Sanders <[email protected]>

More updates to the resource packs API based on feedback.

Signed-off-by: Chris Sanders <[email protected]>

More updates based on discussion

- Toss PackOrder
- Toss PackVersion
- Add PackStatus (makes way more sense than order)
- Toss PackContentsMetadata (way too tied to Vanilla)
- Adjust more javadocs

Signed-off-by: Chris Sanders <[email protected]>

Further work after implementing the resource pack API

Signed-off-by: Chris Sanders <[email protected]>

Enforce that this is an id (and not a name)

Signed-off-by: Chris Sanders <[email protected]>

Add requireResource method to Pack

* Add #close override to resource related AutoClosables to match what is expected in Vanilla to reduce unnecessary checked exceptions (and FindBugs warnings)

Update based on comments in PR

Co-authored-by: Chris Sanders <[email protected]>
Co-authored-by: Daniel Naylor <[email protected]>

Author: 3 people

src/main/java/org/spongepowered/api/Engine.java

@@ -26,8 +26,15 @@
 
 import org.spongepowered.api.event.CauseStackManager;
 import org.spongepowered.api.registry.RegistryHolder;
+import org.spongepowered.api.resource.Resource;
+import org.spongepowered.api.resource.ResourceManager;
+import org.spongepowered.api.resource.pack.Pack;
+import org.spongepowered.api.resource.pack.PackContents;
+import org.spongepowered.api.resource.pack.PackRepository;
 import org.spongepowered.api.scheduler.Scheduler;
 
+import java.util.concurrent.CompletableFuture;
+
 /**
  * Shared functionality between {@link Client} and {@link Server} engines.
  */
@@ -48,6 +55,16 @@ public interface Engine extends RegistryHolder {
      */
     CauseStackManager causeStackManager();
 
+    /**
+     * @return The {@link PackRepository pack repository}
+     */
+    PackRepository packRepository();
+
+    /**
+     * @return The {@link ResourceManager resource manager}
+     */
+    ResourceManager resourceManager();
+
     /**
      * Gets the {@link Scheduler} used to schedule sync tasks on this {@link Engine}.
      *
@@ -61,4 +78,13 @@ public interface Engine extends RegistryHolder {
      * @return {@code true} if main thread, {@code false} if not
      */
     boolean onMainThread();
+
+    /**
+     * Rediscovers all {@link Resource resources} within all {@link Pack pack's} {@link PackContents contents}.
+     *
+     * <p>On the server, the future will always be completed.</p>
+     *
+     * @return A future that completes when reloading is complete
+     */
+    CompletableFuture<Void> reloadResources();
 }

src/main/java/org/spongepowered/api/Game.java

@@ -25,7 +25,6 @@
 package org.spongepowered.api;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
-import org.spongepowered.api.asset.AssetManager;
 import org.spongepowered.api.config.ConfigManager;
 import org.spongepowered.api.data.DataManager;
 import org.spongepowered.api.data.persistence.DataBuilder;
@@ -160,13 +159,6 @@ default Client client() {
      */
     EventManager eventManager();
 
-    /**
-     * Gets the {@link AssetManager}.
-     *
-     * @return The asset manager
-     */
-    AssetManager assetManager();
-
     /**
      * Gets the {@link ConfigManager} used to load and manage configuration files
      * for plugins.
@@ -197,7 +189,7 @@ default Client client() {
      * @return The {@link SqlManager} instance.
      */
     SqlManager sqlManager();
-    
+
     /**
      * Gets the {@link ServiceProvider.GameScoped}, used to provide Sponge
      * services that plugins may provide. Services provided here are

src/main/java/org/spongepowered/api/Sponge.java

@@ -26,7 +26,6 @@
 
 import com.google.inject.Inject;
 import org.checkerframework.checker.nullness.qual.Nullable;
-import org.spongepowered.api.asset.AssetManager;
 import org.spongepowered.api.config.ConfigManager;
 import org.spongepowered.api.data.DataManager;
 import org.spongepowered.api.event.EventManager;
@@ -96,15 +95,6 @@ public static EventManager eventManager() {
         return Sponge.game().eventManager();
     }
 
-    /**
-     * Gets the {@link AssetManager} instance.
-     *
-     * @return The asset manager instance
-     */
-    public static AssetManager assetManager() {
-        return Sponge.game().assetManager();
-    }
-
     /**
      * Gets the {@link ConfigManager} used to load and manage configuration files
      * for plugins.

src/main/java/org/spongepowered/api/asset/Asset.java

@@ -0,0 +1,58 @@
+/*
+ * This file is part of SpongeAPI, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * Copyright (c) contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package org.spongepowered.api.resource;
+
+import org.spongepowered.api.util.annotation.DoNotStore;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Optional;
+
+/**
+ * A resource can represent any kind of loaded data. It can be a file on the
+ * filesystem, a network location, or even generated at runtime. Use
+ * {@link #inputStream()} to retrieve the data.
+ */
+@DoNotStore
+public interface Resource extends AutoCloseable {
+
+    /**
+     * @return The {@link ResourcePath path}
+     */
+    ResourcePath path();
+
+    /**
+     * Returns the {@link InputStream} of this resource. Multiple calls to this
+     * method will not return a new object. To get a new object, get a new
+     * resource.
+     *
+     * @return The input stream
+     */
+    InputStream inputStream();
+
+    @Override
+    void close() throws IOException;
+
+}