Update .gitignore

- Putting API classes under its own package.
- Moved API calls from AntiVPN into new FunkemunkyAPI class.
- Added QueryResponse object and FunkemunkyAPI#getQueryResponse get grab plan information.

.gitignore

@@ -13,6 +13,9 @@ local.properties
 .settings/
 .loadpath
 .recommenders
+*.iml
+
+.idea/
 
 # External tool builders
 .externalToolBuilders/

Assembly/dependency-reduced-pom.xml

@@ -3,7 +3,7 @@
   <parent>
     <artifactId>AntiVPN</artifactId>
     <groupId>dev.brighten.antivpn</groupId>
-    <version>1.7.1.1</version>
+    <version>1.8</version>
   </parent>
   <modelVersion>4.0.0</modelVersion>
   <artifactId>Assembly</artifactId>

Assembly/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>AntiVPN</artifactId>
         <groupId>dev.brighten.antivpn</groupId>
-        <version>1.7.1.1</version>
+        <version>1.8</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

Bukkit/dependency-reduced-pom.xml

@@ -3,7 +3,7 @@
   <parent>
     <artifactId>AntiVPN</artifactId>
     <groupId>dev.brighten.antivpn</groupId>
-    <version>1.7.1.1</version>
+    <version>1.8</version>
   </parent>
   <modelVersion>4.0.0</modelVersion>
   <artifactId>Bukkit</artifactId>
@@ -56,7 +56,7 @@
     <dependency>
       <groupId>dev.brighten.antivpn</groupId>
       <artifactId>Common</artifactId>
-      <version>1.7.1.1</version>
+      <version>1.8</version>
       <scope>provided</scope>
       <exclusions>
         <exclusion>

Bukkit/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>AntiVPN</artifactId>
         <groupId>dev.brighten.antivpn</groupId>
-        <version>1.7.1.1</version>
+        <version>1.8</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
@@ -69,7 +69,7 @@
         <dependency>
             <groupId>dev.brighten.antivpn</groupId>
             <artifactId>Common</artifactId>
-            <version>1.7.1.1</version>
+            <version>1.8</version>
             <scope>provided</scope>
         </dependency>
         <dependency>

Bukkit/src/main/java/dev/brighten/antivpn/bukkit/BukkitCommandExecutor.java

@@ -16,8 +16,9 @@ public class BukkitCommandExecutor implements CommandExecutor {
     private final CommandSender sender;
 
     @Override
-    public void sendMessage(String message) {
-        sender.sendMessage(ChatColor.translateAlternateColorCodes('&', message));
+    public void sendMessage(String message, Object... objects) {
+        sender.sendMessage(ChatColor.translateAlternateColorCodes('&',
+                String.format(message, objects)));
     }
 
     @Override

Bungee/dependency-reduced-pom.xml

@@ -3,7 +3,7 @@
   <parent>
     <artifactId>AntiVPN</artifactId>
     <groupId>dev.brighten.antivpn</groupId>
-    <version>1.7.1.1</version>
+    <version>1.8</version>
   </parent>
   <modelVersion>4.0.0</modelVersion>
   <artifactId>Bungee</artifactId>
@@ -50,7 +50,7 @@
     <dependency>
       <groupId>dev.brighten.antivpn</groupId>
       <artifactId>Common</artifactId>
-      <version>1.7.1.1</version>
+      <version>1.8</version>
       <scope>provided</scope>
       <exclusions>
         <exclusion>

Bungee/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>AntiVPN</artifactId>
         <groupId>dev.brighten.antivpn</groupId>
-        <version>1.7.1.1</version>
+        <version>1.8</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
@@ -63,7 +63,7 @@
         <dependency>
             <groupId>dev.brighten.antivpn</groupId>
             <artifactId>Common</artifactId>
-            <version>1.7.1.1</version>
+            <version>1.8</version>
             <scope>provided</scope>
         </dependency>
         <dependency>

Bungee/src/main/java/dev/brighten/antivpn/bungee/command/BungeeCommandExecutor.java

@@ -17,9 +17,9 @@ public class BungeeCommandExecutor implements CommandExecutor {
     private final CommandSender sender;
 
     @Override
-    public void sendMessage(String message) {
+    public void sendMessage(String message, Object... objects) {
         sender.sendMessage(TextComponent.fromLegacyText(ChatColor
-                .translateAlternateColorCodes('&', message)));
+                .translateAlternateColorCodes('&', String.format(message, objects))));
     }
 
     @Override

Common/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>AntiVPN</artifactId>
         <groupId>dev.brighten.antivpn</groupId>
-        <version>1.7.1.1</version>
+        <version>1.8</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

Common/src/main/java/dev/brighten/antivpn/AntiVPN.java

@@ -12,13 +12,9 @@ import dev.brighten.antivpn.database.sql.MySqlVPN;
 import dev.brighten.antivpn.message.MessageHandler;
 import dev.brighten.antivpn.utils.ConfigDefault;
 import dev.brighten.antivpn.utils.MiscUtils;
-import dev.brighten.antivpn.utils.VPNResponse;
 import dev.brighten.antivpn.utils.config.Configuration;
 import dev.brighten.antivpn.utils.config.ConfigurationProvider;
 import dev.brighten.antivpn.utils.config.YamlConfiguration;
-import dev.brighten.antivpn.utils.json.JSONException;
-import dev.brighten.antivpn.utils.json.JSONObject;
-import dev.brighten.antivpn.utils.json.JsonReader;
 import lombok.AccessLevel;
 import lombok.Getter;
 import lombok.Setter;
@@ -160,15 +156,6 @@ public class AntiVPN {
         }
     }
 
-    public static VPNResponse getVPNResponse(String ip, String license, boolean cachedResults /* faster if set to true*/)
-            throws JSONException, IOException {
-        JSONObject result = JsonReader.readJsonFromUrl(String
-                .format("https://funkemunky.cc/vpn?ip=%s&license=%s&cache=%s",
-                        ip, license.length() == 0 ? "none" : license, cachedResults));
-
-        return VPNResponse.fromJson(result);
-    }
-
     private void registerCommands() {
         commands.add(new AntiVPNCommand());
     }

Common/src/main/java/dev/brighten/antivpn/api/VPNExecutor.java

@@ -2,8 +2,9 @@ package dev.brighten.antivpn.api;
 
 import dev.brighten.antivpn.AntiVPN;
 import dev.brighten.antivpn.utils.EvictingMap;
-import dev.brighten.antivpn.utils.VPNResponse;
+import dev.brighten.antivpn.web.objects.VPNResponse;
 import dev.brighten.antivpn.utils.json.JSONException;
+import dev.brighten.antivpn.web.FunkemunkyAPI;
 import lombok.Getter;
 
 import java.io.IOException;
@@ -49,7 +50,7 @@ public abstract class VPNExecutor {
                 if(cachedRes.isPresent()) return cachedRes.get();
                 else {
                     try {
-                        VPNResponse response =  AntiVPN
+                        VPNResponse response =  FunkemunkyAPI
                                 .getVPNResponse(ip, AntiVPN.getInstance().getVpnConfig().getLicense(), cachedResults);
 
                         if(response.isSuccess()) {
@@ -78,7 +79,7 @@ public abstract class VPNExecutor {
                 if(cachedRes.isPresent()) return cachedRes.get();
                 else {
                     try {
-                        VPNResponse response =  AntiVPN
+                        VPNResponse response =  FunkemunkyAPI
                                 .getVPNResponse(ip, AntiVPN.getInstance().getVpnConfig().getLicense(), cachedResults);
 
                         if(response.isSuccess()) {

Common/src/main/java/dev/brighten/antivpn/command/CommandExecutor.java

@@ -2,11 +2,12 @@ package dev.brighten.antivpn.command;
 
 import dev.brighten.antivpn.api.APIPlayer;
 
+import java.util.Objects;
 import java.util.Optional;
 
 public interface CommandExecutor {
 
-    void sendMessage(String message);
+    void sendMessage(String message, Object... objects);
     boolean hasPermission(String permission);
     Optional<APIPlayer> getPlayer();
     boolean isPlayer();

Common/src/main/java/dev/brighten/antivpn/command/impl/AntiVPNCommand.java

@@ -45,7 +45,7 @@ public class AntiVPNCommand extends Command {
     @Override
     public Command[] children() {
         return new Command[] {new LookupCommand(), new AllowlistCommand(), new AlertsCommand(),
-                new ClearCacheCommand()};
+                new ClearCacheCommand(), new PlanCommand()};
     }
 
     @Override

Common/src/main/java/dev/brighten/antivpn/command/impl/LookupCommand.java

@@ -67,13 +67,13 @@ public class LookupCommand extends Command {
                 executor.sendMessage(StringUtil.line("&8"));
                 executor.sendMessage("&6&l" + player.get().getName() + "&7&l's Connection Information");
                 executor.sendMessage("");
-                executor.sendMessage(String.format("&e%s&8: &f%s", "Proxy", result.isProxy()
-                        ? "&a" + result.getMethod() : "&cNo"));
-                executor.sendMessage(String.format("&e%s&8: &f%s", "ISP", result.getIsp()));
-                executor.sendMessage(String.format("&e%s&8: &f%s", "Country", result.getCountryName()));
-                executor.sendMessage(String.format("&e%s&8: &f%s", "City", result.getCity()));
-                executor.sendMessage(String.format("&e%s&8: &f%s", "Coordinates", result.getLatitude()
-                        + "&7/&f" + result.getLongitude()));
+                executor.sendMessage("&e%s&8: &f%s", "Proxy", result.isProxy()
+                        ? "&a" + result.getMethod() : "&cNo");
+                executor.sendMessage("&e%s&8: &f%s", "ISP", result.getIsp());
+                executor.sendMessage("&e%s&8: &f%s", "Country", result.getCountryName());
+                executor.sendMessage("&e%s&8: &f%s", "City", result.getCity());
+                executor.sendMessage("&e%s&8: &f%s", "Coordinates", result.getLatitude()
+                        + "&7/&f" + result.getLongitude());
                 executor.sendMessage(StringUtil.line("&8"));
             }
         });

Common/src/main/java/dev/brighten/antivpn/command/impl/PlanCommand.java

@@ -0,0 +1,100 @@
+package dev.brighten.antivpn.command.impl;
+
+import dev.brighten.antivpn.AntiVPN;
+import dev.brighten.antivpn.api.VPNExecutor;
+import dev.brighten.antivpn.command.Command;
+import dev.brighten.antivpn.command.CommandExecutor;
+import dev.brighten.antivpn.utils.StringUtil;
+import dev.brighten.antivpn.utils.json.JSONException;
+import dev.brighten.antivpn.web.FunkemunkyAPI;
+import dev.brighten.antivpn.web.objects.QueryResponse;
+
+import java.io.IOException;
+import java.util.List;
+
+public class PlanCommand extends Command {
+    @Override
+    public String permission() {
+        return "antivpn.command.plan";
+    }
+
+    @Override
+    public String name() {
+        return "plan";
+    }
+
+    @Override
+    public String[] aliases() {
+        return new String[] {"queries", "query"};
+    }
+
+    @Override
+    public String description() {
+        return "Info related to KauriVPN Plan";
+    }
+
+    @Override
+    public String usage() {
+        return "";
+    }
+
+    @Override
+    public String parent() {
+        return "antivpn";
+    }
+
+    @Override
+    public Command[] children() {
+        return new Command[0];
+    }
+
+    @Override
+    public String execute(CommandExecutor executor, String[] args) {
+        VPNExecutor.threadExecutor.execute(() -> {
+            QueryResponse result;
+            try {
+                if(AntiVPN.getInstance().getVpnConfig().getLicense().equals("")) {
+                    result = FunkemunkyAPI.getQueryResponse();
+                } else {
+                    result = FunkemunkyAPI.getQueryResponse(AntiVPN.getInstance().getVpnConfig().getLicense());
+
+                    if(!result.isValidPlan()) {
+                        executor.sendMessage("&cThe license &f%s &cis not a valid license, " +
+                                        "checking your Free plan information...",
+                                AntiVPN.getInstance().getVpnConfig().getLicense());
+
+                        result = FunkemunkyAPI.getQueryResponse();
+                    }
+                }
+
+                String plan = result.getPlanType();
+                if(plan.equals("IP")) plan+= " (Free)";
+
+                String queryMax = result.getQueriesMax() == Long.MAX_VALUE
+                        ? "Unlimited" : String.valueOf(result.getQueriesMax());
+
+                executor.sendMessage(StringUtil.line("&8"));
+                executor.sendMessage("&6&lKauriVPN Plan Information");
+                executor.sendMessage("");
+                executor.sendMessage("&e%s&8: &f%s", "Plan", plan);
+                executor.sendMessage("&e%s&8: &f%s&7/&f%s", "Queries Used",
+                        result.getQueries(), queryMax);
+                executor.sendMessage(StringUtil.line("&8"));
+            } catch(JSONException e) {
+                e.printStackTrace();
+                executor.sendMessage("&cThere was a JSONException thrown while looking up your query " +
+                        "information. Check console for more details.");
+            } catch (IOException e) {
+                e.printStackTrace();
+                executor.sendMessage("&cThere was a IOException thrown while looking up your query " +
+                        "information. Check console for more details.");
+            }
+        });
+        return "&7Looking up your query information...";
+    }
+
+    @Override
+    public List<String> tabComplete(CommandExecutor executor, String alias, String[] args) {
+        return null;
+    }
+}

Common/src/main/java/dev/brighten/antivpn/database/VPNDatabase.java

@@ -1,6 +1,6 @@
 package dev.brighten.antivpn.database;
 
-import dev.brighten.antivpn.utils.VPNResponse;
+import dev.brighten.antivpn.web.objects.VPNResponse;
 
 import java.util.List;
 import java.util.Optional;

Common/src/main/java/dev/brighten/antivpn/database/local/H2VPN.java

@@ -5,7 +5,7 @@ import dev.brighten.antivpn.api.VPNExecutor;
 import dev.brighten.antivpn.database.VPNDatabase;
 import dev.brighten.antivpn.database.sql.utils.MySQL;
 import dev.brighten.antivpn.database.sql.utils.Query;
-import dev.brighten.antivpn.utils.VPNResponse;
+import dev.brighten.antivpn.web.objects.VPNResponse;
 import lombok.SneakyThrows;
 
 import java.sql.ResultSet;

Common/src/main/java/dev/brighten/antivpn/database/mongo/MongoVPN.java

@@ -10,7 +10,7 @@ import com.mongodb.client.model.Indexes;
 import dev.brighten.antivpn.AntiVPN;
 import dev.brighten.antivpn.api.VPNExecutor;
 import dev.brighten.antivpn.database.VPNDatabase;
-import dev.brighten.antivpn.utils.VPNResponse;
+import dev.brighten.antivpn.web.objects.VPNResponse;
 import org.bson.Document;
 
 import java.util.*;

Common/src/main/java/dev/brighten/antivpn/database/sql/MySqlVPN.java

@@ -5,7 +5,7 @@ import dev.brighten.antivpn.api.VPNExecutor;
 import dev.brighten.antivpn.database.VPNDatabase;
 import dev.brighten.antivpn.database.sql.utils.MySQL;
 import dev.brighten.antivpn.database.sql.utils.Query;
-import dev.brighten.antivpn.utils.VPNResponse;
+import dev.brighten.antivpn.web.objects.VPNResponse;
 import lombok.SneakyThrows;
 
 import java.sql.ResultSet;

Common/src/main/java/dev/brighten/antivpn/web/FunkemunkyAPI.java

@@ -0,0 +1,59 @@
+package dev.brighten.antivpn.web;
+
+import dev.brighten.antivpn.web.objects.QueryResponse;
+import dev.brighten.antivpn.web.objects.VPNResponse;
+import dev.brighten.antivpn.utils.json.JSONException;
+import dev.brighten.antivpn.utils.json.JSONObject;
+import dev.brighten.antivpn.utils.json.JsonReader;
+
+import java.io.IOException;
+
+public class FunkemunkyAPI {
+
+    /**
+     *
+     * Queries https://funkemunky.cc/vpn API and returns information on the IP
+     *
+     * @param ip String
+     * @param license String
+     * @param cachedResults boolean
+     * @return VPNResponse
+     * @throws JSONException Throws when JSON response is not formatted properly.
+     * @throws IOException Throws when there is an error connecting to and processing information from API.
+     */
+    public static VPNResponse getVPNResponse(String ip, String license, boolean cachedResults /* faster if set to true*/)
+            throws JSONException, IOException {
+        JSONObject result = JsonReader.readJsonFromUrl(String
+                .format("https://funkemunky.cc/vpn?ip=%s&license=%s&cache=%s",
+                        ip, license.length() == 0 ? "none" : license, cachedResults));
+
+        return VPNResponse.fromJson(result);
+    }
+
+    /**
+     * Feeds into {@link FunkemunkyAPI#getQueryResponse(String)} using "none" as argument
+     * to grab query information based on the connecting IP address.
+     *
+     * @return QueryResponse
+     * @throws JSONException Throws when JSON response is not formatted properly.
+     * @throws IOException Throws when there is an error connecting to and processing information from API.
+     */
+    public static QueryResponse getQueryResponse() throws JSONException, IOException {
+        return getQueryResponse("none");
+    }
+
+    /**
+     * Queries https://funkemunky.cc/vpn/queryCheck and returns information based on the
+     * provided licence input.
+     *
+     * @param license String
+     * @return QueryResponse
+     * @throws JSONException Throws when JSON response is not formatted properly.
+     * @throws IOException Throws when there is an error connecting to and processing information from API.
+     */
+    public static QueryResponse getQueryResponse(String license) throws JSONException, IOException {
+        JSONObject result = JsonReader.readJsonFromUrl("https://funkemunky.cc/vpn/queryCheck?license=" + license);
+
+        return QueryResponse.fromJson(result);
+    }
+}

Common/src/main/java/dev/brighten/antivpn/web/objects/QueryResponse.java

@@ -0,0 +1,51 @@
+package dev.brighten.antivpn.web.objects;
+
+import dev.brighten.antivpn.utils.json.JSONException;
+import dev.brighten.antivpn.utils.json.JSONObject;
+import lombok.Builder;
+import lombok.Data;
+
+
+/**
+ * Used to format the JSON response from https://funkemunky.cc/vpn/queryCheck into an object for project use.
+ */
+@Data
+@Builder(toBuilder = true)
+public class QueryResponse {
+
+    private boolean validPlan;
+    private String planType;
+    private long queries;
+    private long queriesMax;
+
+    /**
+     * Takes a JSON String and feeds it into {@link QueryResponse#fromJson(JSONObject)}
+     *
+     * @param jsonString String (formatted in JSON)
+     * @return QueryResponse
+     * @throws JSONException Throws when JSON is not formatted properly.
+     */
+    public static QueryResponse fromJson(String jsonString) throws JSONException {
+        return fromJson(new JSONObject(jsonString));
+    }
+
+    /**
+     * Formats response from https://funkemunky.cc/vpn/queryCheck into {@link QueryResponse} for project use.
+     *
+     * @param object JSONObject
+     * @return QueryResponse
+     * @throws JSONException Throws when JSON is not formatted properly.
+     */
+    public static QueryResponse fromJson(JSONObject object) throws JSONException {
+        boolean validPlan = object.getBoolean("validPlan");
+
+        if(!validPlan) { // Nothing else will be returned from API if validPlan is false.
+            return QueryResponse.builder().validPlan(false).build();
+        }
+
+        return QueryResponse.builder().validPlan(object.getBoolean("validPlan"))
+                .planType(object.getString("planType"))
+                .queries(object.getLong("queries"))
+                .queriesMax(object.getLong("queryLimit")).build();
+    }
+}

Common/src/main/java/dev/brighten/antivpn/web/objects/VPNResponse.java

@@ -1,13 +1,11 @@
-package dev.brighten.antivpn.utils;
+package dev.brighten.antivpn.web.objects;
 
 import dev.brighten.antivpn.utils.json.JSONException;
 import dev.brighten.antivpn.utils.json.JSONObject;
 import lombok.*;
 
-@Getter
-@Setter
+@Data
 @AllArgsConstructor
-@RequiredArgsConstructor
 @Builder
 public class VPNResponse {
     private String asn, ip, countryName, countryCode, city, timeZone, method, isp, failureReason = "N/A";
@@ -29,34 +27,31 @@ public class VPNResponse {
         json.put("proxy", proxy);
         json.put("success", success);
         json.put("timeZone", timeZone);
-        json.put("success", true);
         json.put("queriesLeft", queriesLeft);
         json.put("cached", cached);
 
         return json;
     }
 
+    /**
+     * Feeds into {@link VPNResponse#fromJson(JSONObject)} formatting the JSON {@link String} into
+     * a {@link JSONObject}
+     *
+     * @param json String
+     * @return VPNResponse
+     * @throws JSONException
+     */
     public static VPNResponse fromJson(String json) throws JSONException {
-        JSONObject jsonObject = new JSONObject(json);
-
-        if(jsonObject.getBoolean("success")) {
-            return new VPNResponse(jsonObject.getString("asn"), jsonObject.getString("ip"),
-                    jsonObject.getString("countryName"), jsonObject.getString("countryCode"),
-                    jsonObject.getString("city"), jsonObject.getString("timeZone"),
-                    jsonObject.has("method") ? jsonObject.getString("method") : "N/A",
-                    jsonObject.getString("isp"), "N/A", jsonObject.getBoolean("proxy"),
-                    jsonObject.getBoolean("cached"), jsonObject.getBoolean("success"),
-                    jsonObject.getDouble("latitude"), jsonObject.getDouble("longitude"),
-                    jsonObject.getLong("lastAccess"), jsonObject.getInt("queriesLeft"));
-        } else {
-            VPNResponse response = new VPNResponse(false);
-
-            response.failureReason = jsonObject.getString("failureReason");
-
-            return response;
-        }
+        return fromJson(new JSONObject(json));
     }
 
+    /**
+     * Formats response from https://funkemunky.cc/vpn into {@link VPNResponse} for project use.
+     *
+     * @param jsonObject JSONObject
+     * @return VPNResponse
+     * @throws JSONException Throws when JSON is not formatted properly.
+     */
     public static VPNResponse fromJson(JSONObject jsonObject) throws JSONException {
         if(jsonObject.getBoolean("success")) {
             return new VPNResponse(jsonObject.getString("asn"), jsonObject.getString("ip"),
@@ -68,11 +63,8 @@ public class VPNResponse {
                     jsonObject.getDouble("latitude"), jsonObject.getDouble("longitude"),
                     jsonObject.getLong("lastAccess"), jsonObject.getInt("queriesLeft"));
         } else {
-            VPNResponse response = new VPNResponse(false);
-
-            response.failureReason = jsonObject.getString("failureReason");
-
-            return response;
+            return VPNResponse.builder().success(false)
+                    .failureReason(jsonObject.getString("failureReason")).build();
         }
     }
 }

Velocity/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>AntiVPN</artifactId>
         <groupId>dev.brighten.antivpn</groupId>
-        <version>1.7.1.1</version>
+        <version>1.8</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
@@ -33,7 +33,7 @@
         <dependency>
             <groupId>dev.brighten.antivpn</groupId>
             <artifactId>Common</artifactId>
-            <version>1.7.1.1</version>
+            <version>1.8</version>
             <scope>provided</scope>
         </dependency>
         <dependency>

Velocity/src/main/java/dev/brighten/antivpn/velocity/command/VelocityCommandExecutor.java

@@ -16,8 +16,9 @@ public class VelocityCommandExecutor implements CommandExecutor {
     private final CommandSource sender;
 
     @Override
-    public void sendMessage(String message) {
-        sender.sendMessage(LegacyComponentSerializer.builder().character('&').build().deserialize(message));
+    public void sendMessage(String message, Object... objects) {
+        sender.sendMessage(LegacyComponentSerializer.builder().character('&').build()
+                .deserialize(String.format(message, objects)));
     }
 
     @Override

pom.xml

@@ -7,7 +7,7 @@
     <groupId>dev.brighten.antivpn</groupId>
     <artifactId>AntiVPN</artifactId>
     <packaging>pom</packaging>
-    <version>1.7.1.1</version>
+    <version>1.8</version>
 
     <modules>
         <module>Common</module>