Merge branch 'release/v4.6.0'

Author: Valandur

build.gradle

@@ -53,6 +53,7 @@ dependencies {
     compileOnly files("lib/Nucleus-1.1.3-LTS-api.jar")
     compileOnly files("lib/HuskyCrates-v1.7.2.jar")
     compileOnly files("lib/Nations-2.8-S6.1-MC1.11.2.jar")
+    compileOnly files("lib/MMCTickets-1.4.0-API-5.2-7.X.jar")
 }
 
 shadowJar {

docs/API.md

@@ -5,6 +5,7 @@ other plugins to provide their own endpoints for data without much effort.
 
 
 ## Table of Contents
+1. [Setup](#setup)
 1. [Servlets](#servlets)
     1. [Example](#servlet-example)
 1. [Endpoints](#endpoints)
@@ -13,6 +14,33 @@ other plugins to provide their own endpoints for data without much effort.
 1. [Responses](#responses)
 
 
+<a name="setup"></a>
+## Setup
+
+> You have to register any servlets you create with the WebAPI
+
+The easiest way to do this is to use `WebAPIAPI.getServletService()`, which will return an optional
+containing the ServletService. If the optional is empty than the WebAPI plugin is not present or 
+loaded on the server. If the ServletService is present you can use 
+`service.registerServlet(Class<? extends WebAPIBaseServlet> servlet)` to register your servlet class
+with the WebAPI.
+```java
+public void onInitialization(GameInitializationEvent event) {
+    ...
+    
+    Optional<IServletService> optSrv = WebAPIAPI.getServletService();
+    if (optSrv.isPresent()) {
+        IServletService srv = optSrv.get();
+        srv.registerServlet(MyServlet.class);
+    }
+    
+    ...
+}
+```
+
+> This should be done in the initialization phase of your plugin, before the server starts!
+
+
 <a name="servlets"></a>
 ## Servlets
 Servlets are a collection of routes. This allows you to easily group all data that belongs together.
@@ -33,6 +61,17 @@ tells the Web-API that your class is indeed a valid servlet, and which base rout
 - The `basePath` specifies at which path your servlet will be available, and all the other 
 routes in your servlet will be relative to this route.The `basePath` does **not** require any slashes `/` and may **not** contain any path parameters (see below).
 
+Servlets may define a `public static void onRegister()` method which will get called by the WebAPI
+when the servlet is registered. This is only done once, even if the user reloads the plugins
+on the server. This is the best place to register any custom serializers that your servlets uses:
+```java
+public static void onRegister() {
+    JsonService json = WebAPI.getJsonService();
+    json.registerSerializer(MyData.class, MyDataSerializer.class);
+}
+```
+
+
 <a name="servlet-example"></a>
 ### Example
 

gradle.properties

@@ -1,3 +1,3 @@
-version=4.5.0
+version=4.6.0
 minecraftVersion=1.11.2
 spongeVersion=6.1

lib/MMCTickets-1.4.0-API-5.2-7.X.jar

@@ -75,6 +75,7 @@
 import valandur.webapi.hook.WebHookSerializer;
 import valandur.webapi.hook.WebHookService;
 import valandur.webapi.integration.huskycrates.HuskyCratesServlet;
+import valandur.webapi.integration.mmctickets.MMCTicketsServlet;
 import valandur.webapi.integration.nations.NationsServlet;
 import valandur.webapi.integration.nucleus.NucleusServlet;
 import valandur.webapi.integration.webbhooks.WebBookServlet;
@@ -335,9 +336,9 @@ public void onInitialization(GameInitializationEvent event) {
         } catch (ClassNotFoundException ignored) { }
 
         try {
-            Class.forName("io.github.nucleuspowered.nucleus.api.NucleusAPI");
-            logger.info("  Integrating with Nucleus...");
-            servletService.registerServlet(NucleusServlet.class);
+            Class.forName("net.moddedminecraft.mmctickets.Main");
+            logger.info("  Integrating with MMCTickets...");
+            servletService.registerServlet(MMCTicketsServlet.class);
         } catch (ClassNotFoundException ignored) { }
 
         try {
@@ -346,6 +347,12 @@ public void onInitialization(GameInitializationEvent event) {
             servletService.registerServlet(NationsServlet.class);
         } catch (ClassNotFoundException ignored) { }
 
+        try {
+            Class.forName("io.github.nucleuspowered.nucleus.api.NucleusAPI");
+            logger.info("  Integrating with Nucleus...");
+            servletService.registerServlet(NucleusServlet.class);
+        } catch (ClassNotFoundException ignored) { }
+
         try {
             Class.forName("de.dosmike.sponge.WebBooks.WebBooks");
             logger.info("  Integrating with WebBooks...");

src/main/java/valandur/webapi/WebAPI.java

@@ -32,6 +32,7 @@
 import valandur.webapi.api.cache.plugin.ICachedPluginContainer;
 import valandur.webapi.api.cache.tileentity.ICachedTileEntity;
 import valandur.webapi.api.cache.world.ICachedWorld;
+import valandur.webapi.api.permission.IPermissionService;
 import valandur.webapi.cache.chat.CachedChatMessage;
 import valandur.webapi.cache.command.CachedCommand;
 import valandur.webapi.cache.command.CachedCommandCall;
@@ -45,7 +46,6 @@
 import valandur.webapi.cache.world.CachedChunk;
 import valandur.webapi.cache.world.CachedWorld;
 import valandur.webapi.json.JsonService;
-import valandur.webapi.permission.PermissionService;
 import valandur.webapi.util.Util;
 
 import java.lang.reflect.Field;
@@ -54,6 +54,7 @@
 import java.util.*;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentLinkedQueue;
+import java.util.function.Predicate;
 
 public class CacheService implements ICacheService {
 
@@ -259,6 +260,25 @@ public Collection<ICachedPlayer> getPlayers() {
         return new ArrayList<>(players.values());
     }
     @Override
+    public Optional<ICachedPlayer> getPlayer(String nameOrUuid) {
+        if (Util.isValidUUID(nameOrUuid)) {
+            return getPlayer(UUID.fromString(nameOrUuid));
+        }
+
+        Optional<CachedPlayer> player = players.values().stream().filter(p -> p.getName().equalsIgnoreCase(nameOrUuid)).findAny();
+        if (player.isPresent())
+            return player.flatMap(p -> getPlayer(p.getUUID()));
+
+        return WebAPI.runOnMain(() -> {
+            Optional<UserStorageService> optSrv = Sponge.getServiceManager().provide(UserStorageService.class);
+            if (!optSrv.isPresent())
+                return null;
+
+            Optional<User> optUser = optSrv.get().get(nameOrUuid);
+            return optUser.<ICachedPlayer>map(CachedPlayer::new).orElse(null);
+        });
+    }
+    @Override
     public Optional<ICachedPlayer> getPlayer(UUID uuid) {
         if (!players.containsKey(uuid)) {
             return WebAPI.runOnMain(() -> {
@@ -267,10 +287,8 @@ public Optional<ICachedPlayer> getPlayer(UUID uuid) {
                     return null;
 
                 Optional<User> optUser = optSrv.get().get(uuid);
-                if (!optUser.isPresent())
-                    return null;
+                return optUser.<ICachedPlayer>map(CachedPlayer::new).orElse(null);
 
-               return new CachedPlayer(optUser.get());
             });
         }
 
@@ -411,32 +429,47 @@ public ICachedCommand updateCommand(CommandMapping command) {
     }
 
     @Override
-    public Optional<Collection<ICachedTileEntity>> getTileEntities() {
+    public Optional<Collection<ICachedTileEntity>> getTileEntities(Predicate<TileEntity> predicate, int limit) {
         return WebAPI.runOnMain(() -> {
             Collection<ICachedTileEntity> entities = new LinkedList<>();
 
-            for (World world : Sponge.getServer().getWorlds()) {
-                Collection<TileEntity> ents = world.getTileEntities();
+            int i = 0;
+            Collection<World> worlds = Sponge.getServer().getWorlds();
+            for (World world : worlds) {
+                Collection<TileEntity> ents = world.getTileEntities(predicate);
                 for (TileEntity te : ents) {
+                    if (!te.isValid()) continue;
                     entities.add(new CachedTileEntity(te));
+
+                    i++;
+                    if (limit > 0 && i >= limit)
+                        break;
                 }
+
+                if (limit > 0 && i >= limit)
+                    break;
             }
 
             return entities;
         });
     }
     @Override
-    public Optional<Collection<ICachedTileEntity>> getTileEntities(ICachedWorld world) {
+    public Optional<Collection<ICachedTileEntity>> getTileEntities(ICachedWorld world, Predicate<TileEntity> predicate, int limit) {
         return WebAPI.runOnMain(() -> {
             Optional<?> w = world.getLive();
             if (!w.isPresent())
                 return null;
 
+            int i = 0;
             Collection<ICachedTileEntity> entities = new LinkedList<>();
-            Collection<TileEntity> ents = ((World)w.get()).getTileEntities();
+            Collection<TileEntity> ents = ((World)w.get()).getTileEntities(predicate);
             for (TileEntity te : ents) {
                 if (!te.isValid()) continue;
                 entities.add(new CachedTileEntity(te));
+
+                i++;
+                if (limit > 0 && i >= limit)
+                    break;
             }
 
             return entities;
@@ -533,7 +566,7 @@ public Tuple<Map<String, JsonNode>, Map<String, JsonNode>> getExtraData(ICachedO
 
                 try {
                     Object res = field.get().get(obj);
-                    fields.put(fieldName, json.toJson(res, true, PermissionService.permitAllNode()));
+                    fields.put(fieldName, json.toJson(res, true, IPermissionService.permitAllNode()));
                 } catch (IllegalAccessException e) {
                     fields.put(fieldName, TextNode.valueOf("ERROR: " + e.toString()));
                 }
@@ -559,7 +592,7 @@ public Tuple<Map<String, JsonNode>, Map<String, JsonNode>> getExtraData(ICachedO
 
                 try {
                     Object res = method.get().invoke(obj);
-                    methods.put(methodName, json.toJson(res, true, PermissionService.permitAllNode()));
+                    methods.put(methodName, json.toJson(res, true, IPermissionService.permitAllNode()));
                 } catch (IllegalAccessException | InvocationTargetException e) {
                     methods.put(methodName, TextNode.valueOf("ERROR: " + e.toString()));
                 }

src/main/java/valandur/webapi/cache/CacheService.java

@@ -25,6 +25,12 @@ public Vector3d getPosition() {
     }
 
 
+    public CachedLocation(ICachedWorld world, double x, double y, double z) {
+        super(null);
+
+        this.world = world;
+        this.position = new Vector3d(x, y, z);
+    }
     public CachedLocation(Location<World> location) {
         super(null);
 

src/main/java/valandur/webapi/cache/misc/CachedLocation.java

@@ -1,6 +1,5 @@
 package valandur.webapi.extension;
 
-import io.sentry.Sentry;
 import org.slf4j.Logger;
 import valandur.webapi.WebAPI;
 import valandur.webapi.api.extension.IExtensionService;
@@ -30,11 +29,15 @@ public class ExtensionService implements IExtensionService {
     public void init() {
         // Relocated packages
         relocatedPackages.clear();
-        relocatedPackages.put("import org.eclipse.jetty",     "import valandur.webapi.shadow.org.eclipse.jetty");
-        relocatedPackages.put("import com.fasterxml.jackson", "import valandur.webapi.shadow.fasterxml.jackson");
-        relocatedPackages.put("import javax.servlet",         "import valandur.webapi.shadow.javax.servlet");
-        relocatedPackages.put("import org.reflections",       "import valandur.webapi.shadow.org.reflections");
-        relocatedPackages.put("import net.jodah",             "import valandur.webapi.shadow.net.jodah");
+        relocatedPackages.put("import io.sentry",       "import valandur.webapi.shadow.io.sentry");
+        relocatedPackages.put("import org.eclipse",     "import valandur.webapi.shadow.org.eclipse");
+        relocatedPackages.put("import com.fasterxml",   "import valandur.webapi.shadow.fasterxml");
+        relocatedPackages.put("import javax.servlet",   "import valandur.webapi.shadow.javax.servlet");
+        relocatedPackages.put("import net.jodah",       "import valandur.webapi.shadow.net.jodah");
+        relocatedPackages.put("import org.mindrot",     "import valandur.webapi.shadow.org.mindrot");
+        relocatedPackages.put("import edu.umdh",        "import valandur.webapi.shadow.edu.umd");
+        relocatedPackages.put("import javassist",       "import valandur.webapi.shadow.javassist");
+        relocatedPackages.put("import net.jcip",        "import valandur.webapi.shadow.net.jcip");
     }
 
     public <T> void loadPlugins(String pkg, Class<T> baseClass, Consumer<Class<T>> done) {

src/main/java/valandur/webapi/extension/ExtensionService.java

@@ -3,8 +3,8 @@
 import valandur.webapi.api.hook.IWebHook;
 import valandur.webapi.api.hook.WebAPIBaseFilter;
 import valandur.webapi.api.hook.WebHookHeader;
+import valandur.webapi.api.permission.IPermissionService;
 import valandur.webapi.api.util.TreeNode;
-import valandur.webapi.permission.PermissionService;
 
 import java.util.List;
 
@@ -40,7 +40,7 @@ public boolean includeDetails() {
         return details;
     }
 
-    private TreeNode<String, Boolean> permissions = PermissionService.emptyNode();
+    private TreeNode<String, Boolean> permissions = IPermissionService.emptyNode();
     public TreeNode<String, Boolean> getPermissions() {
         return permissions;
     }

src/main/java/valandur/webapi/hook/WebHook.java

@@ -8,8 +8,8 @@
 import valandur.webapi.WebAPI;
 import valandur.webapi.api.hook.WebAPIBaseFilter;
 import valandur.webapi.api.hook.WebHookHeader;
+import valandur.webapi.api.permission.IPermissionService;
 import valandur.webapi.api.util.TreeNode;
-import valandur.webapi.permission.PermissionService;
 
 import java.lang.reflect.Constructor;
 import java.lang.reflect.InvocationTargetException;
@@ -37,7 +37,7 @@ public WebHook deserialize(TypeToken<?> type, ConfigurationNode value) throws Ob
         String filterName = filterBase.getNode("name").getString();
         ConfigurationNode filterConfig = filterBase.getNode("config");
 
-        TreeNode<String, Boolean> permissions = PermissionService.permitAllNode();
+        TreeNode<String, Boolean> permissions = IPermissionService.permitAllNode();
 
         if (!enabled) {
             logger.info("    -> Disabled");