├── settings.gradle.kts
├── gradle
    └── wrapper
    │   ├── gradle-wrapper.jar
    │   └── gradle-wrapper.properties
├── src
    └── main
    │   ├── resources
    │       └── config.yml
    │   └── java
    │       └── me
    │           └── tech
    │               └── packetlogger
    │                   ├── Constants.java
    │                   ├── PacketLoggerPlugin.java
    │                   ├── BatchedPacketsService.java
    │                   └── BukkitMetrics.java
├── .gitignore
├── LICENSE
├── README.md
├── gradlew.bat
├── scripts
    └── graph.py
└── gradlew


/settings.gradle.kts:
--------------------------------------------------------------------------------
1 | rootProject.name = "packet-logger"
2 | 
3 | 


--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/DebitCardz/packet-logger/HEAD/gradle/wrapper/gradle-wrapper.jar


--------------------------------------------------------------------------------
/src/main/resources/config.yml:
--------------------------------------------------------------------------------
1 | # Amount of time until all queued packets are flushed to DB
2 | flush-seconds: 5
3 | 
4 | # How often to purge the logs
5 | purge-days: 14


--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | #Sun Nov 24 11:05:09 EST 2024
2 | distributionBase=GRADLE_USER_HOME
3 | distributionPath=wrapper/dists
4 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip
5 | zipStoreBase=GRADLE_USER_HOME
6 | zipStorePath=wrapper/dists
7 | 


--------------------------------------------------------------------------------
/src/main/java/me/tech/packetlogger/Constants.java:
--------------------------------------------------------------------------------
 1 | package me.tech.packetlogger;
 2 | 
 3 | import java.time.Instant;
 4 | import java.time.ZoneId;
 5 | import java.time.format.DateTimeFormatter;
 6 | 
 7 | public final class Constants {
 8 |     /** The time the plugin started. */
 9 |     public static final Instant NOW = Instant.now();
10 | 
11 |     /** The format for the folder the SQLite DB is contained in. */
12 |     public static final String DB_FOLDER_NAME = DateTimeFormatter.ofPattern("yyyy-MM-dd")
13 |         .withZone(ZoneId.systemDefault())
14 |         .format(NOW);
15 | 
16 |     /** The format for the SQLite file name. */
17 |     public static final String SQLITE_FILE_NAME = "packets_%s.sqlite".formatted(NOW.toEpochMilli());
18 | }
19 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | .gradle
 2 | build/
 3 | !gradle/wrapper/gradle-wrapper.jar
 4 | !**/src/main/**/build/
 5 | !**/src/test/**/build/
 6 | 
 7 | ### IntelliJ IDEA ###
 8 | .idea/modules.xml
 9 | .idea/jarRepositories.xml
10 | .idea/compiler.xml
11 | .idea/libraries/
12 | *.iws
13 | *.iml
14 | *.ipr
15 | out/
16 | !**/src/main/**/out/
17 | !**/src/test/**/out/
18 | 
19 | ### Eclipse ###
20 | .apt_generated
21 | .classpath
22 | .factorypath
23 | .project
24 | .settings
25 | .springBeans
26 | .sts4-cache
27 | bin/
28 | !**/src/main/**/bin/
29 | !**/src/test/**/bin/
30 | 
31 | ### NetBeans ###
32 | /nbproject/private/
33 | /nbbuild/
34 | /dist/
35 | /nbdist/
36 | /.nb-gradle/
37 | 
38 | ### VS Code ###
39 | .vscode/
40 | 
41 | ### Mac OS ###
42 | .DS_Store
43 | 
44 | ### Other ###
45 | .idea/


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright (c) 2024-2024 Tech
 2 | 
 3 | Permission is hereby granted, free of charge, to any person obtaining
 4 | a copy of this software and associated documentation files (the
 5 | "Software"), to deal in the Software without restriction, including
 6 | without limitation the rights to use, copy, modify, merge, publish,
 7 | distribute, sublicense, and/or sell copies of the Software, and to
 8 | permit persons to whom the Software is furnished to do so, subject to
 9 | the following conditions:
10 | 
11 | The above copyright notice and this permission notice shall be
12 | included in all copies or substantial portions of the Software.
13 | 
14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18 | LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20 | WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # packet-logger
 2 | 
 3 | packet-logger is a plugin that simply tracks the packets coming and going from your server and
 4 | displays it in a digestible and easy graph.
 5 | 
 6 | ---
 7 | 
 8 | ### 🛠 How Does It Work?
 9 | packet-logger collects anonymous packet data from your server and the clients connected to your server
10 | which is then saved into a SQLite file every 5 seconds by default.
11 | 
12 | You can then simply download the SQLite file and parse it using the provided Python script
13 | to analyze the amount of packets and size of those packets.
14 | 
15 | ---
16 | 
17 | ### 🐍 Analyze Using the Python Script
18 | > [!NOTE]
19 | > This script was tested with Python 3.11.4 and Plotly 5.24.1
20 | 
21 | To analyze your data simply use the [Python Script](https://raw.githubusercontent.com/DebitCardz/packet-logger/refs/heads/main/scripts/graph.py) 
22 | to parse your SQLite file. And use `pip install plotly` so we can create the graphs.
23 | 
24 | Execute your Python Script by using `python <script>.py --file <file>` or place your script
25 | in the same directory as your SQLite file and rename your SQLite file to `packet.sqlite` for it to parse.
26 | 
27 | After you've executed the command you'll be prompted to enter whether you want to see all packets, only incoming or only outgoing then
28 | whether you want to see the packets every minute or every hour. After that it'll parse the SQLite file and you'll be greeted
29 | with a visualized representation of your server and client packets.
30 | 
31 | ![Viewer Screenshot](https://github.com/user-attachments/assets/5229b879-de55-4224-ac1d-474f14355587)


--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
 1 | @rem
 2 | @rem Copyright 2015 the original author or authors.
 3 | @rem
 4 | @rem Licensed under the Apache License, Version 2.0 (the "License");
 5 | @rem you may not use this file except in compliance with the License.
 6 | @rem You may obtain a copy of the License at
 7 | @rem
 8 | @rem      https://www.apache.org/licenses/LICENSE-2.0
 9 | @rem
10 | @rem Unless required by applicable law or agreed to in writing, software
11 | @rem distributed under the License is distributed on an "AS IS" BASIS,
12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | @rem See the License for the specific language governing permissions and
14 | @rem limitations under the License.
15 | @rem
16 | 
17 | @if "%DEBUG%" == "" @echo off
18 | @rem ##########################################################################
19 | @rem
20 | @rem  Gradle startup script for Windows
21 | @rem
22 | @rem ##########################################################################
23 | 
24 | @rem Set local scope for the variables with windows NT shell
25 | if "%OS%"=="Windows_NT" setlocal
26 | 
27 | set DIRNAME=%~dp0
28 | if "%DIRNAME%" == "" set DIRNAME=.
29 | set APP_BASE_NAME=%~n0
30 | set APP_HOME=%DIRNAME%
31 | 
32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter.
33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
34 | 
35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
37 | 
38 | @rem Find java.exe
39 | if defined JAVA_HOME goto findJavaFromJavaHome
40 | 
41 | set JAVA_EXE=java.exe
42 | %JAVA_EXE% -version >NUL 2>&1
43 | if "%ERRORLEVEL%" == "0" goto execute
44 | 
45 | echo.
46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
47 | echo.
48 | echo Please set the JAVA_HOME variable in your environment to match the
49 | echo location of your Java installation.
50 | 
51 | goto fail
52 | 
53 | :findJavaFromJavaHome
54 | set JAVA_HOME=%JAVA_HOME:"=%
55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
56 | 
57 | if exist "%JAVA_EXE%" goto execute
58 | 
59 | echo.
60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
61 | echo.
62 | echo Please set the JAVA_HOME variable in your environment to match the
63 | echo location of your Java installation.
64 | 
65 | goto fail
66 | 
67 | :execute
68 | @rem Setup the command line
69 | 
70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
71 | 
72 | 
73 | @rem Execute Gradle
74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
75 | 
76 | :end
77 | @rem End local scope for the variables with windows NT shell
78 | if "%ERRORLEVEL%"=="0" goto mainEnd
79 | 
80 | :fail
81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
82 | rem the _cmd.exe /c_ return code!
83 | if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
84 | exit /b 1
85 | 
86 | :mainEnd
87 | if "%OS%"=="Windows_NT" endlocal
88 | 
89 | :omega
90 | 


--------------------------------------------------------------------------------
/src/main/java/me/tech/packetlogger/PacketLoggerPlugin.java:
--------------------------------------------------------------------------------
  1 | package me.tech.packetlogger;
  2 | 
  3 | import com.github.retrooper.packetevents.PacketEvents;
  4 | import com.github.retrooper.packetevents.event.*;
  5 | import io.github.retrooper.packetevents.factory.spigot.SpigotPacketEventsBuilder;
  6 | import org.bukkit.event.Listener;
  7 | import org.bukkit.plugin.java.JavaPlugin;
  8 | import org.slf4j.Logger;
  9 | import org.slf4j.LoggerFactory;
 10 | 
 11 | import java.io.File;
 12 | import java.time.LocalDate;
 13 | import java.time.LocalDateTime;
 14 | import java.time.format.DateTimeFormatter;
 15 | import java.time.temporal.ChronoUnit;
 16 | 
 17 | public final class PacketLoggerPlugin extends JavaPlugin implements Listener {
 18 |     private static final Logger log = LoggerFactory.getLogger(PacketLoggerPlugin.class);
 19 | 
 20 |     private static final int SERVICE_ID = 24008;
 21 |     private static final DateTimeFormatter FOLDER_FORMAT = DateTimeFormatter.ofPattern("yyyy-MM-dd");
 22 | 
 23 |     private BatchedPacketsService batchedPacketsService;
 24 |     private BukkitMetrics metrics;
 25 | 
 26 |     @Override
 27 |     public void onEnable() {
 28 |         saveDefaultConfig();
 29 | 
 30 |         metrics = new BukkitMetrics(this, SERVICE_ID);
 31 |         purge();
 32 | 
 33 |         this.batchedPacketsService = new BatchedPacketsService(this);
 34 |         batchedPacketsService.startPublish();
 35 | 
 36 |         PacketEvents.getAPI().getEventManager().registerListener(new PacketListener() {
 37 |             @Override
 38 |             public void onPacketSend(PacketSendEvent event) {
 39 |                 batchedPacketsService.add(event);
 40 |             }
 41 | 
 42 |             @Override
 43 |             public void onPacketReceive(PacketReceiveEvent event) {
 44 |                 batchedPacketsService.add(event);
 45 |             }
 46 |         }, PacketListenerPriority.MONITOR);
 47 |     }
 48 | 
 49 |     @Override
 50 |     public void onDisable() {
 51 |         getServer().getAsyncScheduler().cancelTasks(this);
 52 |         metrics.shutdown();
 53 | 
 54 |         batchedPacketsService.flush();
 55 |     }
 56 | 
 57 |     /**
 58 |      * Purge old packet logs.
 59 |      */
 60 |     private void purge() {
 61 |         final var purgeDays = getConfig().getInt("purge-days", 14);
 62 |         log.info("Packet Logs will be purged after {} days.", purgeDays);
 63 | 
 64 |         final var now = LocalDateTime.now();
 65 |         final var files = getDataFolder().listFiles();
 66 |         if(files == null) {
 67 |             log.warn("No files were found in data folder to purge.");
 68 |             return;
 69 |         }
 70 | 
 71 |         for(final var folder : files) {
 72 |             if(!folder.isDirectory()) {
 73 |                 continue;
 74 |             }
 75 | 
 76 |             final var date = LocalDate.parse(folder.getName(), FOLDER_FORMAT);
 77 |             final var daysBetween = ChronoUnit.DAYS.between(date, now);
 78 | 
 79 |             if(daysBetween < purgeDays) {
 80 |                 continue;
 81 |             }
 82 | 
 83 |             getServer().getScheduler().runTaskAsynchronously(this, () -> {
 84 |                 deleteRecursively(folder);
 85 |                 folder.delete();
 86 |             });
 87 |             log.info("Purged {}", folder.getName());
 88 |         }
 89 |     }
 90 | 
 91 |     /**
 92 |      * Recursively delete a folder
 93 |      * @param file the parent
 94 |      */
 95 |     private void deleteRecursively(final File file) {
 96 |         if(file.isDirectory()) {
 97 |             for(final var child : file.listFiles()) {
 98 |                 deleteRecursively(child);
 99 |             }
100 |         }
101 |         if(!file.delete()) {
102 |             log.error("Unable to delete {}", file.getName());
103 |         }
104 |     }
105 | }
106 | 


--------------------------------------------------------------------------------
/scripts/graph.py:
--------------------------------------------------------------------------------
  1 | import argparse
  2 | import sqlite3
  3 | import plotly.graph_objects as go
  4 | 
  5 | 
  6 | def get_packet_totals(db_file, time_granularity="minute", outgoing_filter=None, sort_by='amount'):
  7 |     """
  8 |     Fetch packet totals and sizes per time unit (minute or hour) for each packet name.
  9 |     Args:
 10 |         db_file (str): Path to the SQLite file.
 11 |         time_granularity (str): Either 'minute' or 'hour' for the time grouping.
 12 |         outgoing_filter (str): Optional filter ('outgoing', 'incoming', or None for all packets).
 13 |         sort_by (str): Sort method - 'amount' or 'size'
 14 |     Returns:
 15 |         dict: A dictionary containing packet totals, sorted as specified.
 16 |     """
 17 |     with sqlite3.connect(db_file) as conn:
 18 |         cursor = conn.cursor()
 19 |         time_format = '%Y-%m-%d %H:%M' if time_granularity == "minute" else '%Y-%m-%d %H'
 20 |         query = f"""
 21 |             SELECT
 22 |                 batched_packets.packet_name,
 23 |                 SUM(batched_packets.amount) AS total_amount,
 24 |                 SUM(batched_packets.amount * batched_packets.size_bytes) / 1e6 AS total_mb,
 25 |                 strftime('{time_format}', datetime(batched_packets.collected_at / 1000, 'unixepoch')) AS time_period
 26 |             FROM batched_packets
 27 |             JOIN packet_bound ON batched_packets.packet_name = packet_bound.packet_name
 28 |         """
 29 |         if outgoing_filter == "outgoing":
 30 |             query += " WHERE packet_bound.outgoing = 1 "
 31 |         elif outgoing_filter == "incoming":
 32 |             query += " WHERE packet_bound.outgoing = 0 "
 33 | 
 34 |         query += f" GROUP BY batched_packets.packet_name, time_period"
 35 | 
 36 |         if sort_by == 'amount':
 37 |             query += " ORDER BY total_amount DESC"
 38 |         elif sort_by == 'size':
 39 |             query += " ORDER BY total_mb DESC"
 40 | 
 41 |         cursor.execute(query)
 42 |         rows = cursor.fetchall()
 43 | 
 44 |     packet_totals = {}
 45 |     for row in rows:
 46 |         packet_name = row[0]
 47 |         total_amount = row[1]
 48 |         total_mb = row[2]
 49 |         time_period = row[3]
 50 |         if time_period not in packet_totals:
 51 |             packet_totals[time_period] = {}
 52 |         packet_totals[time_period][packet_name] = {
 53 |             'amount': total_amount,
 54 |             'mb': total_mb
 55 |         }
 56 | 
 57 |     return packet_totals
 58 | 
 59 | 
 60 | def plot_packet_totals(packet_totals, time_granularity="minute", sort_by='amount'):
 61 |     """
 62 |     Plot the packet totals for each packet name over time with sorting options.
 63 |     Args:
 64 |         packet_totals (dict): A dictionary of packet totals.
 65 |         time_granularity (str): Either 'minute' or 'hour' for the time granularity of the x-axis.
 66 |         sort_by (str): Sort method - 'amount' or 'size'
 67 |     """
 68 |     packet_names = set()
 69 |     for time_data in packet_totals.values():
 70 |         packet_names.update(time_data.keys())
 71 | 
 72 |     times = sorted(packet_totals.keys())
 73 | 
 74 |     trace_data_amount = []
 75 |     trace_data_mb = []
 76 | 
 77 |     for packet_name in packet_names:
 78 |         amount_values = [
 79 |             packet_totals[time].get(packet_name, {}).get('amount', 0)
 80 |             for time in times
 81 |         ]
 82 |         amount_trace = go.Bar(
 83 |             x=times,
 84 |             y=amount_values,
 85 |             name=f"{packet_name} (Count)",
 86 |             visible=True if sort_by == 'amount' else False,
 87 |             hovertemplate=(
 88 |                 f"<b>Packet Name:</b> {packet_name}<br>"
 89 |                 "<b>Time:</b> %{x}<br>"
 90 |                 "<b>Total Packets:</b> %{y:,.0f}<br>"
 91 |                 "<b>Total MB:</b> " + "%{customdata[0]:,.2f} MB<extra></extra>"
 92 |             ),
 93 |             customdata=[[packet_totals[time].get(
 94 |                 packet_name, {}).get('mb', 0)] for time in times],
 95 |             marker=dict(line=dict(color='rgba(255,255,255,0.3)'))
 96 |         )
 97 |         trace_data_amount.append(amount_trace)
 98 | 
 99 |         mb_values = [
100 |             packet_totals[time].get(packet_name, {}).get('mb', 0)
101 |             for time in times
102 |         ]
103 |         mb_trace = go.Bar(
104 |             x=times,
105 |             y=mb_values,
106 |             name=f"{packet_name} (MB)",
107 |             visible=True if sort_by == 'size' else False,
108 |             hovertemplate=(
109 |                 f"<b>Packet Name:</b> {packet_name}<br>"
110 |                 "<b>Time:</b> %{x}<br>"
111 |                 "<b>Total MB:</b> %{y:,.2f} MB<br>"
112 |                 "<b>Total Packets:</b> %{customdata[0]:,.0f}<extra></extra>"
113 |             ),
114 |             customdata=[[packet_totals[time].get(
115 |                 packet_name, {}).get('amount', 0)] for time in times],
116 |             marker=dict(line=dict(color='rgba(255,255,255,0.3)'))
117 |         )
118 |         trace_data_mb.append(mb_trace)
119 | 
120 |     traces = trace_data_amount + trace_data_mb
121 | 
122 |     fig = go.Figure(data=traces)
123 | 
124 |     fig.update_layout(
125 |         updatemenus=[
126 |             dict(
127 |                 buttons=list([
128 |                     dict(
129 |                         args=[{"visible": [
130 |                             *[True]*len(trace_data_amount),
131 |                             *[False]*len(trace_data_mb)
132 |                         ]}],
133 |                         label="Sort by Packet Count",
134 |                         method="update"
135 |                     ),
136 |                     dict(
137 |                         args=[{"visible": [
138 |                             *[False]*len(trace_data_amount),
139 |                             *[True]*len(trace_data_mb)
140 |                         ]}],
141 |                         label="Sort by Total MB",
142 |                         method="update"
143 |                     )
144 |                 ]),
145 |                 direction="down",
146 |                 pad={"r": 10, "t": 10},
147 |                 showactive=True,
148 |                 x=0.5,
149 |                 xanchor="right",
150 |                 y=1.1,
151 |                 yanchor="top"
152 |             )
153 |         ],
154 |         title=f"Packet Totals Sent Per {time_granularity.capitalize()}",
155 |         xaxis_title=f"Time ({time_granularity.capitalize()})",
156 |         yaxis_title="Total Packets / MB Sent",
157 |         barmode="stack",
158 |         xaxis=dict(
159 |             tickmode="array",
160 |             tickvals=times,
161 |             ticktext=times,
162 |             tickformat='%Y-%m-%d %H:%M' if time_granularity == 'minute' else '%Y-%m-%d %H'
163 |         ),
164 |         showlegend=True,
165 |         legend=dict(
166 |             x=1,
167 |             y=1,
168 |             traceorder='normal',
169 |             orientation='v',
170 |             font=dict(size=10),
171 |             bgcolor='rgba(255, 255, 255, 0.7)',
172 |             bordercolor='rgba(255, 255, 255, 0.5)',
173 |             borderwidth=1,
174 |             itemclick="toggleothers",
175 |             itemsizing='constant',
176 |             xanchor='left',
177 |             yanchor='top',
178 |             tracegroupgap=3,
179 |         ),
180 |         plot_bgcolor="white",
181 |         height=1080,
182 |         width=1920
183 |     )
184 | 
185 |     fig.show()
186 | 
187 | 
188 | if __name__ == "__main__":
189 |     parser = argparse.ArgumentParser(description="Packet Analyzer")
190 |     parser.add_argument(
191 |         "--file", type=str, default="packet.sqlite", help="Path to the database file")
192 |     args = parser.parse_args()
193 | 
194 |     db_file = args.file
195 |     outgoing_filter = input(
196 |         "Enter packet type filter ('all', 'outgoing', 'incoming'): ").strip().lower()
197 |     time_granularity = input(
198 |         "Enter time granularity ('minute' or 'hour'): ").strip().lower()
199 | 
200 |     if outgoing_filter not in ["all", "outgoing", "incoming"]:
201 |         print("Invalid input. Please enter 'all', 'outgoing', or 'incoming'.")
202 |     elif time_granularity not in ["minute", "hour"]:
203 |         print("Invalid input. Please enter 'minute' or 'hour'.")
204 |     else:
205 |         packet_totals = get_packet_totals(
206 |             db_file,
207 |             time_granularity=time_granularity,
208 |             outgoing_filter=outgoing_filter,
209 |             sort_by='amount'
210 |         )
211 | 
212 |         plot_packet_totals(
213 |             packet_totals,
214 |             time_granularity=time_granularity,
215 |             sort_by='amount'
216 |         )
217 | 


--------------------------------------------------------------------------------
/src/main/java/me/tech/packetlogger/BatchedPacketsService.java:
--------------------------------------------------------------------------------
  1 | package me.tech.packetlogger;
  2 | 
  3 | import com.github.retrooper.packetevents.event.ProtocolPacketEvent;
  4 | import com.github.retrooper.packetevents.netty.buffer.ByteBufHelper;
  5 | import com.github.retrooper.packetevents.protocol.PacketSide;
  6 | import org.slf4j.Logger;
  7 | import org.slf4j.LoggerFactory;
  8 | 
  9 | import java.io.IOException;
 10 | import java.nio.file.Files;
 11 | import java.nio.file.Path;
 12 | import java.sql.Connection;
 13 | import java.sql.DriverManager;
 14 | import java.sql.SQLException;
 15 | import java.time.Instant;
 16 | import java.util.Map;
 17 | import java.util.Set;
 18 | import java.util.concurrent.ConcurrentHashMap;
 19 | import java.util.concurrent.ExecutorService;
 20 | import java.util.concurrent.Executors;
 21 | import java.util.concurrent.TimeUnit;
 22 | import java.util.concurrent.atomic.AtomicInteger;
 23 | import java.util.concurrent.atomic.AtomicLong;
 24 | 
 25 | public final class BatchedPacketsService {
 26 |     private static final Logger log = LoggerFactory.getLogger(BatchedPacketsService.class);
 27 | 
 28 |     private final PacketLoggerPlugin plugin;
 29 |     private final Path dataFolderPath;
 30 |     private final ExecutorService executor;
 31 | 
 32 |     private final Set<String> packetBoundCache = ConcurrentHashMap.newKeySet();
 33 |     private final Map<String, PacketRecord> packetQueue = new ConcurrentHashMap<>();
 34 | 
 35 |     public BatchedPacketsService(
 36 |         final PacketLoggerPlugin plugin
 37 |     ) {
 38 |         this.plugin = plugin;
 39 |         this.dataFolderPath = plugin.getDataFolder().toPath();
 40 |         this.executor = Executors.newSingleThreadExecutor();
 41 | 
 42 |         createSqlite();
 43 |     }
 44 | 
 45 |     /**
 46 |      * Add a packet to the queue.
 47 |      * @param event the dispatched packet event
 48 |      */
 49 |     public void add(ProtocolPacketEvent event) {
 50 |         final String packetName = event.getPacketType().getName();
 51 |         final int size = ByteBufHelper.readableBytes(event.getByteBuf());
 52 |         final boolean outgoing = event.getPacketType().getSide() == PacketSide.SERVER;
 53 | 
 54 |         if(!packetBoundCache.contains(packetName)) {
 55 |             packetBoundCache.add(packetName);
 56 |             // quickly add to db.
 57 |             executor.submit(() -> addPacketBound(packetName, outgoing));
 58 |         }
 59 | 
 60 |         final var record = packetQueue.computeIfAbsent(packetName, (k) -> new PacketRecord());
 61 |         record.amount.getAndIncrement();
 62 |         record.size.getAndAdd(size);
 63 |     }
 64 | 
 65 |     /**
 66 |      * Start publishing packet batches to the SQLite database.
 67 |      */
 68 |     public void startPublish() {
 69 |         final var flushSeconds = plugin.getConfig().getInt("flush-seconds", 5);
 70 | 
 71 |         final var scheduler = plugin.getServer().getAsyncScheduler();
 72 |         scheduler.runAtFixedRate(plugin, (task) -> {
 73 |             executor.submit(this::flush);
 74 |         }, 0L, flushSeconds, TimeUnit.SECONDS);
 75 |     }
 76 | 
 77 |     /**
 78 |      * Flush the contents of the queue into SQLite.
 79 |      */
 80 |     public void flush() {
 81 |         try(final var conn = getConnection()) {
 82 |             conn.setAutoCommit(false);
 83 |             final String sql = "INSERT INTO batched_packets (packet_name, amount, size_bytes, collected_at) VALUES (?, ?, ?, ?)";
 84 | 
 85 |             final var counter = new AtomicInteger();
 86 |             final var nowMs = Instant.now().toEpochMilli();
 87 | 
 88 |             try(final var statement = conn.prepareStatement(sql)) {
 89 |                 for(final var packet : packetQueue.keySet()) {
 90 |                     final var record = packetQueue.get(packet);
 91 |                     final var amount = record.amount.get();
 92 |                     final var size = record.size.get();
 93 | 
 94 |                     statement.setObject(1, packet);
 95 |                     statement.setObject(2, amount);
 96 |                     statement.setObject(3, size);
 97 |                     statement.setObject(4, nowMs);
 98 |                     statement.addBatch();
 99 | 
100 |                     if(counter.getAndIncrement() % 15 == 0) {
101 |                         statement.executeBatch();
102 |                         conn.commit();
103 |                     }
104 |                 }
105 | 
106 |                 // flush final batch
107 |                 statement.executeBatch();
108 |                 conn.commit();
109 |             } catch(SQLException ex) {
110 |                 conn.rollback();
111 |                 ex.printStackTrace();
112 |             } finally {
113 |                 conn.setAutoCommit(true);
114 |             }
115 |         } catch(SQLException ex) {
116 |             ex.printStackTrace();
117 |         }
118 | 
119 |         packetQueue.clear();
120 |     }
121 | 
122 |     /**
123 |      * Add a packet bound to the SQLite database.
124 |      * @param packetName the packet name
125 |      * @param outgoing whether it's incoming or outgoing
126 |      */
127 |     private void addPacketBound(String packetName, boolean outgoing) {
128 |         try(final var conn = getConnection()) {
129 |             final String sql = "INSERT INTO packet_bound (packet_name, outgoing) VALUES (?, ?)";
130 | 
131 |             try(final var statement = conn.prepareStatement(sql)) {
132 |                 statement.setString(1, packetName);
133 |                 statement.setBoolean(2, outgoing);
134 | 
135 |                 statement.executeUpdate();
136 |             } catch(SQLException ex) {
137 |                 ex.printStackTrace();
138 |             }
139 |         } catch(SQLException ex) {
140 |             ex.printStackTrace();
141 |         }
142 |     }
143 | 
144 |     /**
145 |      * Create the SQLite Database
146 |      * This method will create the `batched_packets` table which contains the actual
147 |      * packet information
148 |      * And this method will create the `packet_bound` table which contains whether a packet is
149 |      * incoming or outgoing which will then be joined into the graph.
150 |      */
151 |     private void createSqlite() {
152 |         final var dbFolder = dataFolderPath.resolve(Constants.DB_FOLDER_NAME);
153 |         if(!Files.exists(dbFolder)) {
154 |             try {
155 |                 Files.createDirectory(dbFolder);
156 |             } catch (IOException e) {
157 |                 throw new RuntimeException(e);
158 |             }
159 |         }
160 | 
161 |         final var dbFile = dataFolderPath.resolve(Constants.DB_FOLDER_NAME)
162 |             .resolve(Constants.SQLITE_FILE_NAME);
163 |         if(!Files.exists(dbFile)) {
164 |             try {
165 |                 Files.createFile(dbFile);
166 |             } catch (IOException e) {
167 |                 throw new RuntimeException(e);
168 |             }
169 |         }
170 | 
171 |         try (var conn = getConnection()) {
172 |             conn.createStatement()
173 |                 .execute("CREATE TABLE IF NOT EXISTS batched_packets (" +
174 |                     "id INTEGER PRIMARY KEY AUTOINCREMENT, " +
175 |                     "packet_name TEXT NOT NULL, " +
176 |                     "amount INTEGER NOT NULL," +
177 |                     "size_bytes INTEGER NOT NULL, " +
178 |                     "collected_at INTEGER NOT NULL" +
179 |                     ");");
180 | 
181 |             conn.createStatement()
182 |                     .execute("CREATE TABLE IF NOT EXISTS packet_bound (" +
183 |                         "id INTEGER PRIMARY KEY AUTOINCREMENT, " +
184 |                         "packet_name TEXT NOT NULL, " +
185 |                         "outgoing INTEGER NOT NULL " +
186 |                         ");");
187 |             log.info("Created batched_packets table in SQLite DB.");
188 |         } catch (SQLException ex) {
189 |             throw new RuntimeException(ex);
190 |         }
191 |     }
192 | 
193 |     /**
194 |      * Grab a new SQLite Connection
195 |      * @return the {@link Connection}
196 |      * @throws SQLException if the driver manager failed
197 |      */
198 |     private Connection getConnection() throws SQLException {
199 |         return DriverManager.getConnection(
200 |             "jdbc:sqlite:%s".formatted(getDBFilePath().toAbsolutePath())
201 |         );
202 |     }
203 | 
204 |     /**
205 |      * Get the path to the SQLite file
206 |      * @return the {@link Path} to the SQLite file
207 |      */
208 |     private Path getDBFilePath() {
209 |         return dataFolderPath.resolve(Constants.DB_FOLDER_NAME)
210 |             .resolve(Constants.SQLITE_FILE_NAME);
211 |     }
212 | 
213 |     private record PacketRecord(AtomicInteger amount, AtomicLong size) {
214 |         public PacketRecord() {
215 |             this(new AtomicInteger(0), new AtomicLong(0));
216 |         }
217 |     }
218 | }
219 | 


--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
  1 | #!/bin/sh
  2 | 
  3 | #
  4 | # Copyright © 2015-2021 the original authors.
  5 | #
  6 | # Licensed under the Apache License, Version 2.0 (the "License");
  7 | # you may not use this file except in compliance with the License.
  8 | # You may obtain a copy of the License at
  9 | #
 10 | #      https://www.apache.org/licenses/LICENSE-2.0
 11 | #
 12 | # Unless required by applicable law or agreed to in writing, software
 13 | # distributed under the License is distributed on an "AS IS" BASIS,
 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 15 | # See the License for the specific language governing permissions and
 16 | # limitations under the License.
 17 | #
 18 | 
 19 | ##############################################################################
 20 | #
 21 | #   Gradle start up script for POSIX generated by Gradle.
 22 | #
 23 | #   Important for running:
 24 | #
 25 | #   (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
 26 | #       noncompliant, but you have some other compliant shell such as ksh or
 27 | #       bash, then to run this script, type that shell name before the whole
 28 | #       command line, like:
 29 | #
 30 | #           ksh Gradle
 31 | #
 32 | #       Busybox and similar reduced shells will NOT work, because this script
 33 | #       requires all of these POSIX shell features:
 34 | #         * functions;
 35 | #         * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
 36 | #           «${var#prefix}», «${var%suffix}», and «$( cmd )»;
 37 | #         * compound commands having a testable exit status, especially «case»;
 38 | #         * various built-in commands including «command», «set», and «ulimit».
 39 | #
 40 | #   Important for patching:
 41 | #
 42 | #   (2) This script targets any POSIX shell, so it avoids extensions provided
 43 | #       by Bash, Ksh, etc; in particular arrays are avoided.
 44 | #
 45 | #       The "traditional" practice of packing multiple parameters into a
 46 | #       space-separated string is a well documented source of bugs and security
 47 | #       problems, so this is (mostly) avoided, by progressively accumulating
 48 | #       options in "$@", and eventually passing that to Java.
 49 | #
 50 | #       Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
 51 | #       and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
 52 | #       see the in-line comments for details.
 53 | #
 54 | #       There are tweaks for specific operating systems such as AIX, CygWin,
 55 | #       Darwin, MinGW, and NonStop.
 56 | #
 57 | #   (3) This script is generated from the Groovy template
 58 | #       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 59 | #       within the Gradle project.
 60 | #
 61 | #       You can find Gradle at https://github.com/gradle/gradle/.
 62 | #
 63 | ##############################################################################
 64 | 
 65 | # Attempt to set APP_HOME
 66 | 
 67 | # Resolve links: $0 may be a link
 68 | app_path=$0
 69 | 
 70 | # Need this for daisy-chained symlinks.
 71 | while
 72 |     APP_HOME=${app_path%"${app_path##*/}"}  # leaves a trailing /; empty if no leading path
 73 |     [ -h "$app_path" ]
 74 | do
 75 |     ls=$( ls -ld "$app_path" )
 76 |     link=${ls#*' -> '}
 77 |     case $link in             #(
 78 |       /*)   app_path=$link ;; #(
 79 |       *)    app_path=$APP_HOME$link ;;
 80 |     esac
 81 | done
 82 | 
 83 | APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
 84 | 
 85 | APP_NAME="Gradle"
 86 | APP_BASE_NAME=${0##*/}
 87 | 
 88 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 89 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 90 | 
 91 | # Use the maximum available, or set MAX_FD != -1 to use that value.
 92 | MAX_FD=maximum
 93 | 
 94 | warn () {
 95 |     echo "$*"
 96 | } >&2
 97 | 
 98 | die () {
 99 |     echo
100 |     echo "$*"
101 |     echo
102 |     exit 1
103 | } >&2
104 | 
105 | # OS specific support (must be 'true' or 'false').
106 | cygwin=false
107 | msys=false
108 | darwin=false
109 | nonstop=false
110 | case "$( uname )" in                #(
111 |   CYGWIN* )         cygwin=true  ;; #(
112 |   Darwin* )         darwin=true  ;; #(
113 |   MSYS* | MINGW* )  msys=true    ;; #(
114 |   NONSTOP* )        nonstop=true ;;
115 | esac
116 | 
117 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
118 | 
119 | 
120 | # Determine the Java command to use to start the JVM.
121 | if [ -n "$JAVA_HOME" ] ; then
122 |     if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
123 |         # IBM's JDK on AIX uses strange locations for the executables
124 |         JAVACMD=$JAVA_HOME/jre/sh/java
125 |     else
126 |         JAVACMD=$JAVA_HOME/bin/java
127 |     fi
128 |     if [ ! -x "$JAVACMD" ] ; then
129 |         die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
130 | 
131 | Please set the JAVA_HOME variable in your environment to match the
132 | location of your Java installation."
133 |     fi
134 | else
135 |     JAVACMD=java
136 |     which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
137 | 
138 | Please set the JAVA_HOME variable in your environment to match the
139 | location of your Java installation."
140 | fi
141 | 
142 | # Increase the maximum file descriptors if we can.
143 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
144 |     case $MAX_FD in #(
145 |       max*)
146 |         MAX_FD=$( ulimit -H -n ) ||
147 |             warn "Could not query maximum file descriptor limit"
148 |     esac
149 |     case $MAX_FD in  #(
150 |       '' | soft) :;; #(
151 |       *)
152 |         ulimit -n "$MAX_FD" ||
153 |             warn "Could not set maximum file descriptor limit to $MAX_FD"
154 |     esac
155 | fi
156 | 
157 | # Collect all arguments for the java command, stacking in reverse order:
158 | #   * args from the command line
159 | #   * the main class name
160 | #   * -classpath
161 | #   * -D...appname settings
162 | #   * --module-path (only if needed)
163 | #   * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
164 | 
165 | # For Cygwin or MSYS, switch paths to Windows format before running java
166 | if "$cygwin" || "$msys" ; then
167 |     APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
168 |     CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
169 | 
170 |     JAVACMD=$( cygpath --unix "$JAVACMD" )
171 | 
172 |     # Now convert the arguments - kludge to limit ourselves to /bin/sh
173 |     for arg do
174 |         if
175 |             case $arg in                                #(
176 |               -*)   false ;;                            # don't mess with options #(
177 |               /?*)  t=${arg#/} t=/${t%%/*}              # looks like a POSIX filepath
178 |                     [ -e "$t" ] ;;                      #(
179 |               *)    false ;;
180 |             esac
181 |         then
182 |             arg=$( cygpath --path --ignore --mixed "$arg" )
183 |         fi
184 |         # Roll the args list around exactly as many times as the number of
185 |         # args, so each arg winds up back in the position where it started, but
186 |         # possibly modified.
187 |         #
188 |         # NB: a `for` loop captures its iteration list before it begins, so
189 |         # changing the positional parameters here affects neither the number of
190 |         # iterations, nor the values presented in `arg`.
191 |         shift                   # remove old arg
192 |         set -- "$@" "$arg"      # push replacement arg
193 |     done
194 | fi
195 | 
196 | # Collect all arguments for the java command;
197 | #   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
198 | #     shell script including quotes and variable substitutions, so put them in
199 | #     double quotes to make sure that they get re-expanded; and
200 | #   * put everything else in single quotes, so that it's not re-expanded.
201 | 
202 | set -- \
203 |         "-Dorg.gradle.appname=$APP_BASE_NAME" \
204 |         -classpath "$CLASSPATH" \
205 |         org.gradle.wrapper.GradleWrapperMain \
206 |         "$@"
207 | 
208 | # Use "xargs" to parse quoted args.
209 | #
210 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed.
211 | #
212 | # In Bash we could simply go:
213 | #
214 | #   readarray ARGS < <( xargs -n1 <<<"$var" ) &&
215 | #   set -- "${ARGS[@]}" "$@"
216 | #
217 | # but POSIX shell has neither arrays nor command substitution, so instead we
218 | # post-process each arg (as a line of input to sed) to backslash-escape any
219 | # character that might be a shell metacharacter, then use eval to reverse
220 | # that process (while maintaining the separation between arguments), and wrap
221 | # the whole thing up as a single "set" statement.
222 | #
223 | # This will of course break if any of these variables contains a newline or
224 | # an unmatched quote.
225 | #
226 | 
227 | eval "set -- $(
228 |         printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
229 |         xargs -n1 |
230 |         sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
231 |         tr '\n' ' '
232 |     )" '"$@"'
233 | 
234 | exec "$JAVACMD" "$@"
235 | 


--------------------------------------------------------------------------------
/src/main/java/me/tech/packetlogger/BukkitMetrics.java:
--------------------------------------------------------------------------------
  1 | package me.tech.packetlogger;
  2 | 
  3 | import java.io.BufferedReader;
  4 | import java.io.ByteArrayOutputStream;
  5 | import java.io.DataOutputStream;
  6 | import java.io.File;
  7 | import java.io.IOException;
  8 | import java.io.InputStreamReader;
  9 | import java.lang.reflect.Method;
 10 | import java.net.URL;
 11 | import java.nio.charset.StandardCharsets;
 12 | import java.util.Arrays;
 13 | import java.util.Collection;
 14 | import java.util.HashSet;
 15 | import java.util.Map;
 16 | import java.util.Objects;
 17 | import java.util.Set;
 18 | import java.util.UUID;
 19 | import java.util.concurrent.Callable;
 20 | import java.util.concurrent.ScheduledExecutorService;
 21 | import java.util.concurrent.ScheduledThreadPoolExecutor;
 22 | import java.util.concurrent.TimeUnit;
 23 | import java.util.function.BiConsumer;
 24 | import java.util.function.Consumer;
 25 | import java.util.function.Supplier;
 26 | import java.util.logging.Level;
 27 | import java.util.stream.Collectors;
 28 | import java.util.zip.GZIPOutputStream;
 29 | import javax.net.ssl.HttpsURLConnection;
 30 | import org.bukkit.Bukkit;
 31 | import org.bukkit.configuration.file.YamlConfiguration;
 32 | import org.bukkit.entity.Player;
 33 | import org.bukkit.plugin.Plugin;
 34 | 
 35 | public final class BukkitMetrics {
 36 | 
 37 |     private final Plugin plugin;
 38 | 
 39 |     private final MetricsBase metricsBase;
 40 | 
 41 |     /**
 42 |      * Creates a new Metrics instance.
 43 |      *
 44 |      * @param plugin Your plugin instance.
 45 |      * @param serviceId The id of the service. It can be found at <a
 46 |      *     href="https://bstats.org/what-is-my-plugin-id">What is my plugin id?</a>
 47 |      */
 48 |     public BukkitMetrics(Plugin plugin, int serviceId) {
 49 |         this.plugin = plugin;
 50 |         // Get the config file
 51 |         File bStatsFolder = new File(plugin.getDataFolder().getParentFile(), "bStats");
 52 |         File configFile = new File(bStatsFolder, "config.yml");
 53 |         YamlConfiguration config = YamlConfiguration.loadConfiguration(configFile);
 54 |         if (!config.isSet("serverUuid")) {
 55 |             config.addDefault("enabled", true);
 56 |             config.addDefault("serverUuid", UUID.randomUUID().toString());
 57 |             config.addDefault("logFailedRequests", false);
 58 |             config.addDefault("logSentData", false);
 59 |             config.addDefault("logResponseStatusText", false);
 60 |             // Inform the server owners about bStats
 61 |             config
 62 |                 .options()
 63 |                 .header(
 64 |                     "bStats (https://bStats.org) collects some basic information for plugin authors, like how\n"
 65 |                         + "many people use their plugin and their total player count. It's recommended to keep bStats\n"
 66 |                         + "enabled, but if you're not comfortable with this, you can turn this setting off. There is no\n"
 67 |                         + "performance penalty associated with having metrics enabled, and data sent to bStats is fully\n"
 68 |                         + "anonymous.")
 69 |                 .copyDefaults(true);
 70 |             try {
 71 |                 config.save(configFile);
 72 |             } catch (IOException ignored) {
 73 |             }
 74 |         }
 75 |         // Load the data
 76 |         boolean enabled = config.getBoolean("enabled", true);
 77 |         String serverUUID = config.getString("serverUuid");
 78 |         boolean logErrors = config.getBoolean("logFailedRequests", false);
 79 |         boolean logSentData = config.getBoolean("logSentData", false);
 80 |         boolean logResponseStatusText = config.getBoolean("logResponseStatusText", false);
 81 |         boolean isFolia = false;
 82 |         try {
 83 |             isFolia = Class.forName("io.papermc.paper.threadedregions.RegionizedServer") != null;
 84 |         } catch (Exception e) {
 85 |         }
 86 |         metricsBase =
 87 |             new // See https://github.com/Bastian/bstats-metrics/pull/126
 88 |                 // See https://github.com/Bastian/bstats-metrics/pull/126
 89 |                 // See https://github.com/Bastian/bstats-metrics/pull/126
 90 |                 // See https://github.com/Bastian/bstats-metrics/pull/126
 91 |                 // See https://github.com/Bastian/bstats-metrics/pull/126
 92 |                 // See https://github.com/Bastian/bstats-metrics/pull/126
 93 |                 // See https://github.com/Bastian/bstats-metrics/pull/126
 94 |                 MetricsBase(
 95 |                 "bukkit",
 96 |                 serverUUID,
 97 |                 serviceId,
 98 |                 enabled,
 99 |                 this::appendPlatformData,
100 |                 this::appendServiceData,
101 |                 isFolia
102 |                     ? null
103 |                     : submitDataTask -> Bukkit.getScheduler().runTask(plugin, submitDataTask),
104 |                 plugin::isEnabled,
105 |                 (message, error) -> this.plugin.getLogger().log(Level.WARNING, message, error),
106 |                 (message) -> this.plugin.getLogger().log(Level.INFO, message),
107 |                 logErrors,
108 |                 logSentData,
109 |                 logResponseStatusText,
110 |                 false);
111 |     }
112 | 
113 |     /** Shuts down the underlying scheduler service. */
114 |     public void shutdown() {
115 |         metricsBase.shutdown();
116 |     }
117 | 
118 |     /**
119 |      * Adds a custom chart.
120 |      *
121 |      * @param chart The chart to add.
122 |      */
123 |     public void addCustomChart(CustomChart chart) {
124 |         metricsBase.addCustomChart(chart);
125 |     }
126 | 
127 |     private void appendPlatformData(JsonObjectBuilder builder) {
128 |         builder.appendField("playerAmount", getPlayerAmount());
129 |         builder.appendField("onlineMode", Bukkit.getOnlineMode() ? 1 : 0);
130 |         builder.appendField("bukkitVersion", Bukkit.getVersion());
131 |         builder.appendField("bukkitName", Bukkit.getName());
132 |         builder.appendField("javaVersion", System.getProperty("java.version"));
133 |         builder.appendField("osName", System.getProperty("os.name"));
134 |         builder.appendField("osArch", System.getProperty("os.arch"));
135 |         builder.appendField("osVersion", System.getProperty("os.version"));
136 |         builder.appendField("coreCount", Runtime.getRuntime().availableProcessors());
137 |     }
138 | 
139 |     private void appendServiceData(JsonObjectBuilder builder) {
140 |         builder.appendField("pluginVersion", plugin.getDescription().getVersion());
141 |     }
142 | 
143 |     private int getPlayerAmount() {
144 |         try {
145 |             // Around MC 1.8 the return type was changed from an array to a collection,
146 |             // This fixes java.lang.NoSuchMethodError:
147 |             // org.bukkit.Bukkit.getOnlinePlayers()Ljava/util/Collection;
148 |             Method onlinePlayersMethod = Class.forName("org.bukkit.Server").getMethod("getOnlinePlayers");
149 |             return onlinePlayersMethod.getReturnType().equals(Collection.class)
150 |                 ? ((Collection<?>) onlinePlayersMethod.invoke(Bukkit.getServer())).size()
151 |                 : ((Player[]) onlinePlayersMethod.invoke(Bukkit.getServer())).length;
152 |         } catch (Exception e) {
153 |             // Just use the new method if the reflection failed
154 |             return Bukkit.getOnlinePlayers().size();
155 |         }
156 |     }
157 | 
158 |     public static class MetricsBase {
159 | 
160 |         /** The version of the Metrics class. */
161 |         public static final String METRICS_VERSION = "3.1.0";
162 | 
163 |         private static final String REPORT_URL = "https://bStats.org/api/v2/data/%s";
164 | 
165 |         private final ScheduledExecutorService scheduler;
166 | 
167 |         private final String platform;
168 | 
169 |         private final String serverUuid;
170 | 
171 |         private final int serviceId;
172 | 
173 |         private final Consumer<JsonObjectBuilder> appendPlatformDataConsumer;
174 | 
175 |         private final Consumer<JsonObjectBuilder> appendServiceDataConsumer;
176 | 
177 |         private final Consumer<Runnable> submitTaskConsumer;
178 | 
179 |         private final Supplier<Boolean> checkServiceEnabledSupplier;
180 | 
181 |         private final BiConsumer<String, Throwable> errorLogger;
182 | 
183 |         private final Consumer<String> infoLogger;
184 | 
185 |         private final boolean logErrors;
186 | 
187 |         private final boolean logSentData;
188 | 
189 |         private final boolean logResponseStatusText;
190 | 
191 |         private final Set<CustomChart> customCharts = new HashSet<>();
192 | 
193 |         private final boolean enabled;
194 | 
195 |         /**
196 |          * Creates a new MetricsBase class instance.
197 |          *
198 |          * @param platform The platform of the service.
199 |          * @param serviceId The id of the service.
200 |          * @param serverUuid The server uuid.
201 |          * @param enabled Whether or not data sending is enabled.
202 |          * @param appendPlatformDataConsumer A consumer that receives a {@code JsonObjectBuilder} and
203 |          *     appends all platform-specific data.
204 |          * @param appendServiceDataConsumer A consumer that receives a {@code JsonObjectBuilder} and
205 |          *     appends all service-specific data.
206 |          * @param submitTaskConsumer A consumer that takes a runnable with the submit task. This can be
207 |          *     used to delegate the data collection to a another thread to prevent errors caused by
208 |          *     concurrency. Can be {@code null}.
209 |          * @param checkServiceEnabledSupplier A supplier to check if the service is still enabled.
210 |          * @param errorLogger A consumer that accepts log message and an error.
211 |          * @param infoLogger A consumer that accepts info log messages.
212 |          * @param logErrors Whether or not errors should be logged.
213 |          * @param logSentData Whether or not the sent data should be logged.
214 |          * @param logResponseStatusText Whether or not the response status text should be logged.
215 |          * @param skipRelocateCheck Whether or not the relocate check should be skipped.
216 |          */
217 |         public MetricsBase(
218 |             String platform,
219 |             String serverUuid,
220 |             int serviceId,
221 |             boolean enabled,
222 |             Consumer<JsonObjectBuilder> appendPlatformDataConsumer,
223 |             Consumer<JsonObjectBuilder> appendServiceDataConsumer,
224 |             Consumer<Runnable> submitTaskConsumer,
225 |             Supplier<Boolean> checkServiceEnabledSupplier,
226 |             BiConsumer<String, Throwable> errorLogger,
227 |             Consumer<String> infoLogger,
228 |             boolean logErrors,
229 |             boolean logSentData,
230 |             boolean logResponseStatusText,
231 |             boolean skipRelocateCheck) {
232 |             ScheduledThreadPoolExecutor scheduler =
233 |                 new ScheduledThreadPoolExecutor(
234 |                     1,
235 |                     task -> {
236 |                         Thread thread = new Thread(task, "bStats-Metrics");
237 |                         thread.setDaemon(true);
238 |                         return thread;
239 |                     });
240 |             // We want delayed tasks (non-periodic) that will execute in the future to be
241 |             // cancelled when the scheduler is shutdown.
242 |             // Otherwise, we risk preventing the server from shutting down even when
243 |             // MetricsBase#shutdown() is called
244 |             scheduler.setExecuteExistingDelayedTasksAfterShutdownPolicy(false);
245 |             this.scheduler = scheduler;
246 |             this.platform = platform;
247 |             this.serverUuid = serverUuid;
248 |             this.serviceId = serviceId;
249 |             this.enabled = enabled;
250 |             this.appendPlatformDataConsumer = appendPlatformDataConsumer;
251 |             this.appendServiceDataConsumer = appendServiceDataConsumer;
252 |             this.submitTaskConsumer = submitTaskConsumer;
253 |             this.checkServiceEnabledSupplier = checkServiceEnabledSupplier;
254 |             this.errorLogger = errorLogger;
255 |             this.infoLogger = infoLogger;
256 |             this.logErrors = logErrors;
257 |             this.logSentData = logSentData;
258 |             this.logResponseStatusText = logResponseStatusText;
259 |             if (!skipRelocateCheck) {
260 |                 checkRelocation();
261 |             }
262 |             if (enabled) {
263 |                 // WARNING: Removing the option to opt-out will get your plugin banned from
264 |                 // bStats
265 |                 startSubmitting();
266 |             }
267 |         }
268 | 
269 |         public void addCustomChart(CustomChart chart) {
270 |             this.customCharts.add(chart);
271 |         }
272 | 
273 |         public void shutdown() {
274 |             scheduler.shutdown();
275 |         }
276 | 
277 |         private void startSubmitting() {
278 |             final Runnable submitTask =
279 |                 () -> {
280 |                     if (!enabled || !checkServiceEnabledSupplier.get()) {
281 |                         // Submitting data or service is disabled
282 |                         scheduler.shutdown();
283 |                         return;
284 |                     }
285 |                     if (submitTaskConsumer != null) {
286 |                         submitTaskConsumer.accept(this::submitData);
287 |                     } else {
288 |                         this.submitData();
289 |                     }
290 |                 };
291 |             // Many servers tend to restart at a fixed time at xx:00 which causes an uneven
292 |             // distribution of requests on the
293 |             // bStats backend. To circumvent this problem, we introduce some randomness into
294 |             // the initial and second delay.
295 |             // WARNING: You must not modify and part of this Metrics class, including the
296 |             // submit delay or frequency!
297 |             // WARNING: Modifying this code will get your plugin banned on bStats. Just
298 |             // don't do it!
299 |             long initialDelay = (long) (1000 * 60 * (3 + Math.random() * 3));
300 |             long secondDelay = (long) (1000 * 60 * (Math.random() * 30));
301 |             scheduler.schedule(submitTask, initialDelay, TimeUnit.MILLISECONDS);
302 |             scheduler.scheduleAtFixedRate(
303 |                 submitTask, initialDelay + secondDelay, 1000 * 60 * 30, TimeUnit.MILLISECONDS);
304 |         }
305 | 
306 |         private void submitData() {
307 |             final JsonObjectBuilder baseJsonBuilder = new JsonObjectBuilder();
308 |             appendPlatformDataConsumer.accept(baseJsonBuilder);
309 |             final JsonObjectBuilder serviceJsonBuilder = new JsonObjectBuilder();
310 |             appendServiceDataConsumer.accept(serviceJsonBuilder);
311 |             JsonObjectBuilder.JsonObject[] chartData =
312 |                 customCharts.stream()
313 |                     .map(customChart -> customChart.getRequestJsonObject(errorLogger, logErrors))
314 |                     .filter(Objects::nonNull)
315 |                     .toArray(JsonObjectBuilder.JsonObject[]::new);
316 |             serviceJsonBuilder.appendField("id", serviceId);
317 |             serviceJsonBuilder.appendField("customCharts", chartData);
318 |             baseJsonBuilder.appendField("service", serviceJsonBuilder.build());
319 |             baseJsonBuilder.appendField("serverUUID", serverUuid);
320 |             baseJsonBuilder.appendField("metricsVersion", METRICS_VERSION);
321 |             JsonObjectBuilder.JsonObject data = baseJsonBuilder.build();
322 |             scheduler.execute(
323 |                 () -> {
324 |                     try {
325 |                         // Send the data
326 |                         sendData(data);
327 |                     } catch (Exception e) {
328 |                         // Something went wrong! :(
329 |                         if (logErrors) {
330 |                             errorLogger.accept("Could not submit bStats metrics data", e);
331 |                         }
332 |                     }
333 |                 });
334 |         }
335 | 
336 |         private void sendData(JsonObjectBuilder.JsonObject data) throws Exception {
337 |             if (logSentData) {
338 |                 infoLogger.accept("Sent bStats metrics data: " + data.toString());
339 |             }
340 |             String url = String.format(REPORT_URL, platform);
341 |             HttpsURLConnection connection = (HttpsURLConnection) new URL(url).openConnection();
342 |             // Compress the data to save bandwidth
343 |             byte[] compressedData = compress(data.toString());
344 |             connection.setRequestMethod("POST");
345 |             connection.addRequestProperty("Accept", "application/json");
346 |             connection.addRequestProperty("Connection", "close");
347 |             connection.addRequestProperty("Content-Encoding", "gzip");
348 |             connection.addRequestProperty("Content-Length", String.valueOf(compressedData.length));
349 |             connection.setRequestProperty("Content-Type", "application/json");
350 |             connection.setRequestProperty("User-Agent", "Metrics-Service/1");
351 |             connection.setDoOutput(true);
352 |             try (DataOutputStream outputStream = new DataOutputStream(connection.getOutputStream())) {
353 |                 outputStream.write(compressedData);
354 |             }
355 |             StringBuilder builder = new StringBuilder();
356 |             try (BufferedReader bufferedReader =
357 |                      new BufferedReader(new InputStreamReader(connection.getInputStream()))) {
358 |                 String line;
359 |                 while ((line = bufferedReader.readLine()) != null) {
360 |                     builder.append(line);
361 |                 }
362 |             }
363 |             if (logResponseStatusText) {
364 |                 infoLogger.accept("Sent data to bStats and received response: " + builder);
365 |             }
366 |         }
367 | 
368 |         /** Checks that the class was properly relocated. */
369 |         private void checkRelocation() {
370 |             // You can use the property to disable the check in your test environment
371 |             if (System.getProperty("bstats.relocatecheck") == null
372 |                 || !System.getProperty("bstats.relocatecheck").equals("false")) {
373 |                 // Maven's Relocate is clever and changes strings, too. So we have to use this
374 |                 // little "trick" ... :D
375 |                 final String defaultPackage =
376 |                     new String(new byte[] {'o', 'r', 'g', '.', 'b', 's', 't', 'a', 't', 's'});
377 |                 final String examplePackage =
378 |                     new String(new byte[] {'y', 'o', 'u', 'r', '.', 'p', 'a', 'c', 'k', 'a', 'g', 'e'});
379 |                 // We want to make sure no one just copy & pastes the example and uses the wrong
380 |                 // package names
381 |                 if (MetricsBase.class.getPackage().getName().startsWith(defaultPackage)
382 |                     || MetricsBase.class.getPackage().getName().startsWith(examplePackage)) {
383 |                     throw new IllegalStateException("bStats Metrics class has not been relocated correctly!");
384 |                 }
385 |             }
386 |         }
387 | 
388 |         /**
389 |          * Gzips the given string.
390 |          *
391 |          * @param str The string to gzip.
392 |          * @return The gzipped string.
393 |          */
394 |         private static byte[] compress(final String str) throws IOException {
395 |             if (str == null) {
396 |                 return null;
397 |             }
398 |             ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
399 |             try (GZIPOutputStream gzip = new GZIPOutputStream(outputStream)) {
400 |                 gzip.write(str.getBytes(StandardCharsets.UTF_8));
401 |             }
402 |             return outputStream.toByteArray();
403 |         }
404 |     }
405 | 
406 |     public static class AdvancedBarChart extends CustomChart {
407 | 
408 |         private final Callable<Map<String, int[]>> callable;
409 | 
410 |         /**
411 |          * Class constructor.
412 |          *
413 |          * @param chartId The id of the chart.
414 |          * @param callable The callable which is used to request the chart data.
415 |          */
416 |         public AdvancedBarChart(String chartId, Callable<Map<String, int[]>> callable) {
417 |             super(chartId);
418 |             this.callable = callable;
419 |         }
420 | 
421 |         @Override
422 |         protected JsonObjectBuilder.JsonObject getChartData() throws Exception {
423 |             JsonObjectBuilder valuesBuilder = new JsonObjectBuilder();
424 |             Map<String, int[]> map = callable.call();
425 |             if (map == null || map.isEmpty()) {
426 |                 // Null = skip the chart
427 |                 return null;
428 |             }
429 |             boolean allSkipped = true;
430 |             for (Map.Entry<String, int[]> entry : map.entrySet()) {
431 |                 if (entry.getValue().length == 0) {
432 |                     // Skip this invalid
433 |                     continue;
434 |                 }
435 |                 allSkipped = false;
436 |                 valuesBuilder.appendField(entry.getKey(), entry.getValue());
437 |             }
438 |             if (allSkipped) {
439 |                 // Null = skip the chart
440 |                 return null;
441 |             }
442 |             return new JsonObjectBuilder().appendField("values", valuesBuilder.build()).build();
443 |         }
444 |     }
445 | 
446 |     public static class SimplePie extends CustomChart {
447 | 
448 |         private final Callable<String> callable;
449 | 
450 |         /**
451 |          * Class constructor.
452 |          *
453 |          * @param chartId The id of the chart.
454 |          * @param callable The callable which is used to request the chart data.
455 |          */
456 |         public SimplePie(String chartId, Callable<String> callable) {
457 |             super(chartId);
458 |             this.callable = callable;
459 |         }
460 | 
461 |         @Override
462 |         protected JsonObjectBuilder.JsonObject getChartData() throws Exception {
463 |             String value = callable.call();
464 |             if (value == null || value.isEmpty()) {
465 |                 // Null = skip the chart
466 |                 return null;
467 |             }
468 |             return new JsonObjectBuilder().appendField("value", value).build();
469 |         }
470 |     }
471 | 
472 |     public static class DrilldownPie extends CustomChart {
473 | 
474 |         private final Callable<Map<String, Map<String, Integer>>> callable;
475 | 
476 |         /**
477 |          * Class constructor.
478 |          *
479 |          * @param chartId The id of the chart.
480 |          * @param callable The callable which is used to request the chart data.
481 |          */
482 |         public DrilldownPie(String chartId, Callable<Map<String, Map<String, Integer>>> callable) {
483 |             super(chartId);
484 |             this.callable = callable;
485 |         }
486 | 
487 |         @Override
488 |         public JsonObjectBuilder.JsonObject getChartData() throws Exception {
489 |             JsonObjectBuilder valuesBuilder = new JsonObjectBuilder();
490 |             Map<String, Map<String, Integer>> map = callable.call();
491 |             if (map == null || map.isEmpty()) {
492 |                 // Null = skip the chart
493 |                 return null;
494 |             }
495 |             boolean reallyAllSkipped = true;
496 |             for (Map.Entry<String, Map<String, Integer>> entryValues : map.entrySet()) {
497 |                 JsonObjectBuilder valueBuilder = new JsonObjectBuilder();
498 |                 boolean allSkipped = true;
499 |                 for (Map.Entry<String, Integer> valueEntry : map.get(entryValues.getKey()).entrySet()) {
500 |                     valueBuilder.appendField(valueEntry.getKey(), valueEntry.getValue());
501 |                     allSkipped = false;
502 |                 }
503 |                 if (!allSkipped) {
504 |                     reallyAllSkipped = false;
505 |                     valuesBuilder.appendField(entryValues.getKey(), valueBuilder.build());
506 |                 }
507 |             }
508 |             if (reallyAllSkipped) {
509 |                 // Null = skip the chart
510 |                 return null;
511 |             }
512 |             return new JsonObjectBuilder().appendField("values", valuesBuilder.build()).build();
513 |         }
514 |     }
515 | 
516 |     public static class SingleLineChart extends CustomChart {
517 | 
518 |         private final Callable<Integer> callable;
519 | 
520 |         /**
521 |          * Class constructor.
522 |          *
523 |          * @param chartId The id of the chart.
524 |          * @param callable The callable which is used to request the chart data.
525 |          */
526 |         public SingleLineChart(String chartId, Callable<Integer> callable) {
527 |             super(chartId);
528 |             this.callable = callable;
529 |         }
530 | 
531 |         @Override
532 |         protected JsonObjectBuilder.JsonObject getChartData() throws Exception {
533 |             int value = callable.call();
534 |             if (value == 0) {
535 |                 // Null = skip the chart
536 |                 return null;
537 |             }
538 |             return new JsonObjectBuilder().appendField("value", value).build();
539 |         }
540 |     }
541 | 
542 |     public static class MultiLineChart extends CustomChart {
543 | 
544 |         private final Callable<Map<String, Integer>> callable;
545 | 
546 |         /**
547 |          * Class constructor.
548 |          *
549 |          * @param chartId The id of the chart.
550 |          * @param callable The callable which is used to request the chart data.
551 |          */
552 |         public MultiLineChart(String chartId, Callable<Map<String, Integer>> callable) {
553 |             super(chartId);
554 |             this.callable = callable;
555 |         }
556 | 
557 |         @Override
558 |         protected JsonObjectBuilder.JsonObject getChartData() throws Exception {
559 |             JsonObjectBuilder valuesBuilder = new JsonObjectBuilder();
560 |             Map<String, Integer> map = callable.call();
561 |             if (map == null || map.isEmpty()) {
562 |                 // Null = skip the chart
563 |                 return null;
564 |             }
565 |             boolean allSkipped = true;
566 |             for (Map.Entry<String, Integer> entry : map.entrySet()) {
567 |                 if (entry.getValue() == 0) {
568 |                     // Skip this invalid
569 |                     continue;
570 |                 }
571 |                 allSkipped = false;
572 |                 valuesBuilder.appendField(entry.getKey(), entry.getValue());
573 |             }
574 |             if (allSkipped) {
575 |                 // Null = skip the chart
576 |                 return null;
577 |             }
578 |             return new JsonObjectBuilder().appendField("values", valuesBuilder.build()).build();
579 |         }
580 |     }
581 | 
582 |     public static class AdvancedPie extends CustomChart {
583 | 
584 |         private final Callable<Map<String, Integer>> callable;
585 | 
586 |         /**
587 |          * Class constructor.
588 |          *
589 |          * @param chartId The id of the chart.
590 |          * @param callable The callable which is used to request the chart data.
591 |          */
592 |         public AdvancedPie(String chartId, Callable<Map<String, Integer>> callable) {
593 |             super(chartId);
594 |             this.callable = callable;
595 |         }
596 | 
597 |         @Override
598 |         protected JsonObjectBuilder.JsonObject getChartData() throws Exception {
599 |             JsonObjectBuilder valuesBuilder = new JsonObjectBuilder();
600 |             Map<String, Integer> map = callable.call();
601 |             if (map == null || map.isEmpty()) {
602 |                 // Null = skip the chart
603 |                 return null;
604 |             }
605 |             boolean allSkipped = true;
606 |             for (Map.Entry<String, Integer> entry : map.entrySet()) {
607 |                 if (entry.getValue() == 0) {
608 |                     // Skip this invalid
609 |                     continue;
610 |                 }
611 |                 allSkipped = false;
612 |                 valuesBuilder.appendField(entry.getKey(), entry.getValue());
613 |             }
614 |             if (allSkipped) {
615 |                 // Null = skip the chart
616 |                 return null;
617 |             }
618 |             return new JsonObjectBuilder().appendField("values", valuesBuilder.build()).build();
619 |         }
620 |     }
621 | 
622 |     public abstract static class CustomChart {
623 | 
624 |         private final String chartId;
625 | 
626 |         protected CustomChart(String chartId) {
627 |             if (chartId == null) {
628 |                 throw new IllegalArgumentException("chartId must not be null");
629 |             }
630 |             this.chartId = chartId;
631 |         }
632 | 
633 |         public JsonObjectBuilder.JsonObject getRequestJsonObject(
634 |             BiConsumer<String, Throwable> errorLogger, boolean logErrors) {
635 |             JsonObjectBuilder builder = new JsonObjectBuilder();
636 |             builder.appendField("chartId", chartId);
637 |             try {
638 |                 JsonObjectBuilder.JsonObject data = getChartData();
639 |                 if (data == null) {
640 |                     // If the data is null we don't send the chart.
641 |                     return null;
642 |                 }
643 |                 builder.appendField("data", data);
644 |             } catch (Throwable t) {
645 |                 if (logErrors) {
646 |                     errorLogger.accept("Failed to get data for custom chart with id " + chartId, t);
647 |                 }
648 |                 return null;
649 |             }
650 |             return builder.build();
651 |         }
652 | 
653 |         protected abstract JsonObjectBuilder.JsonObject getChartData() throws Exception;
654 |     }
655 | 
656 |     public static class SimpleBarChart extends CustomChart {
657 | 
658 |         private final Callable<Map<String, Integer>> callable;
659 | 
660 |         /**
661 |          * Class constructor.
662 |          *
663 |          * @param chartId The id of the chart.
664 |          * @param callable The callable which is used to request the chart data.
665 |          */
666 |         public SimpleBarChart(String chartId, Callable<Map<String, Integer>> callable) {
667 |             super(chartId);
668 |             this.callable = callable;
669 |         }
670 | 
671 |         @Override
672 |         protected JsonObjectBuilder.JsonObject getChartData() throws Exception {
673 |             JsonObjectBuilder valuesBuilder = new JsonObjectBuilder();
674 |             Map<String, Integer> map = callable.call();
675 |             if (map == null || map.isEmpty()) {
676 |                 // Null = skip the chart
677 |                 return null;
678 |             }
679 |             for (Map.Entry<String, Integer> entry : map.entrySet()) {
680 |                 valuesBuilder.appendField(entry.getKey(), new int[] {entry.getValue()});
681 |             }
682 |             return new JsonObjectBuilder().appendField("values", valuesBuilder.build()).build();
683 |         }
684 |     }
685 | 
686 |     /**
687 |      * An extremely simple JSON builder.
688 |      *
689 |      * <p>While this class is neither feature-rich nor the most performant one, it's sufficient enough
690 |      * for its use-case.
691 |      */
692 |     public static class JsonObjectBuilder {
693 | 
694 |         private StringBuilder builder = new StringBuilder();
695 | 
696 |         private boolean hasAtLeastOneField = false;
697 | 
698 |         public JsonObjectBuilder() {
699 |             builder.append("{");
700 |         }
701 | 
702 |         /**
703 |          * Appends a null field to the JSON.
704 |          *
705 |          * @param key The key of the field.
706 |          * @return A reference to this object.
707 |          */
708 |         public JsonObjectBuilder appendNull(String key) {
709 |             appendFieldUnescaped(key, "null");
710 |             return this;
711 |         }
712 | 
713 |         /**
714 |          * Appends a string field to the JSON.
715 |          *
716 |          * @param key The key of the field.
717 |          * @param value The value of the field.
718 |          * @return A reference to this object.
719 |          */
720 |         public JsonObjectBuilder appendField(String key, String value) {
721 |             if (value == null) {
722 |                 throw new IllegalArgumentException("JSON value must not be null");
723 |             }
724 |             appendFieldUnescaped(key, "\"" + escape(value) + "\"");
725 |             return this;
726 |         }
727 | 
728 |         /**
729 |          * Appends an integer field to the JSON.
730 |          *
731 |          * @param key The key of the field.
732 |          * @param value The value of the field.
733 |          * @return A reference to this object.
734 |          */
735 |         public JsonObjectBuilder appendField(String key, int value) {
736 |             appendFieldUnescaped(key, String.valueOf(value));
737 |             return this;
738 |         }
739 | 
740 |         /**
741 |          * Appends an object to the JSON.
742 |          *
743 |          * @param key The key of the field.
744 |          * @param object The object.
745 |          * @return A reference to this object.
746 |          */
747 |         public JsonObjectBuilder appendField(String key, JsonObject object) {
748 |             if (object == null) {
749 |                 throw new IllegalArgumentException("JSON object must not be null");
750 |             }
751 |             appendFieldUnescaped(key, object.toString());
752 |             return this;
753 |         }
754 | 
755 |         /**
756 |          * Appends a string array to the JSON.
757 |          *
758 |          * @param key The key of the field.
759 |          * @param values The string array.
760 |          * @return A reference to this object.
761 |          */
762 |         public JsonObjectBuilder appendField(String key, String[] values) {
763 |             if (values == null) {
764 |                 throw new IllegalArgumentException("JSON values must not be null");
765 |             }
766 |             String escapedValues =
767 |                 Arrays.stream(values)
768 |                     .map(value -> "\"" + escape(value) + "\"")
769 |                     .collect(Collectors.joining(","));
770 |             appendFieldUnescaped(key, "[" + escapedValues + "]");
771 |             return this;
772 |         }
773 | 
774 |         /**
775 |          * Appends an integer array to the JSON.
776 |          *
777 |          * @param key The key of the field.
778 |          * @param values The integer array.
779 |          * @return A reference to this object.
780 |          */
781 |         public JsonObjectBuilder appendField(String key, int[] values) {
782 |             if (values == null) {
783 |                 throw new IllegalArgumentException("JSON values must not be null");
784 |             }
785 |             String escapedValues =
786 |                 Arrays.stream(values).mapToObj(String::valueOf).collect(Collectors.joining(","));
787 |             appendFieldUnescaped(key, "[" + escapedValues + "]");
788 |             return this;
789 |         }
790 | 
791 |         /**
792 |          * Appends an object array to the JSON.
793 |          *
794 |          * @param key The key of the field.
795 |          * @param values The integer array.
796 |          * @return A reference to this object.
797 |          */
798 |         public JsonObjectBuilder appendField(String key, JsonObject[] values) {
799 |             if (values == null) {
800 |                 throw new IllegalArgumentException("JSON values must not be null");
801 |             }
802 |             String escapedValues =
803 |                 Arrays.stream(values).map(JsonObject::toString).collect(Collectors.joining(","));
804 |             appendFieldUnescaped(key, "[" + escapedValues + "]");
805 |             return this;
806 |         }
807 | 
808 |         /**
809 |          * Appends a field to the object.
810 |          *
811 |          * @param key The key of the field.
812 |          * @param escapedValue The escaped value of the field.
813 |          */
814 |         private void appendFieldUnescaped(String key, String escapedValue) {
815 |             if (builder == null) {
816 |                 throw new IllegalStateException("JSON has already been built");
817 |             }
818 |             if (key == null) {
819 |                 throw new IllegalArgumentException("JSON key must not be null");
820 |             }
821 |             if (hasAtLeastOneField) {
822 |                 builder.append(",");
823 |             }
824 |             builder.append("\"").append(escape(key)).append("\":").append(escapedValue);
825 |             hasAtLeastOneField = true;
826 |         }
827 | 
828 |         /**
829 |          * Builds the JSON string and invalidates this builder.
830 |          *
831 |          * @return The built JSON string.
832 |          */
833 |         public JsonObject build() {
834 |             if (builder == null) {
835 |                 throw new IllegalStateException("JSON has already been built");
836 |             }
837 |             JsonObject object = new JsonObject(builder.append("}").toString());
838 |             builder = null;
839 |             return object;
840 |         }
841 | 
842 |         /**
843 |          * Escapes the given string like stated in https://www.ietf.org/rfc/rfc4627.txt.
844 |          *
845 |          * <p>This method escapes only the necessary characters '"', '\'. and '\u0000' - '\u001F'.
846 |          * Compact escapes are not used (e.g., '\n' is escaped as "\u000a" and not as "\n").
847 |          *
848 |          * @param value The value to escape.
849 |          * @return The escaped value.
850 |          */
851 |         private static String escape(String value) {
852 |             final StringBuilder builder = new StringBuilder();
853 |             for (int i = 0; i < value.length(); i++) {
854 |                 char c = value.charAt(i);
855 |                 if (c == '"') {
856 |                     builder.append("\\\"");
857 |                 } else if (c == '\\') {
858 |                     builder.append("\\\\");
859 |                 } else if (c <= '\u000F') {
860 |                     builder.append("\\u000").append(Integer.toHexString(c));
861 |                 } else if (c <= '\u001F') {
862 |                     builder.append("\\u00").append(Integer.toHexString(c));
863 |                 } else {
864 |                     builder.append(c);
865 |                 }
866 |             }
867 |             return builder.toString();
868 |         }
869 | 
870 |         /**
871 |          * A super simple representation of a JSON object.
872 |          *
873 |          * <p>This class only exists to make methods of the {@link JsonObjectBuilder} type-safe and not
874 |          * allow a raw string inputs for methods like {@link JsonObjectBuilder#appendField(String,
875 |          * JsonObject)}.
876 |          */
877 |         public static class JsonObject {
878 | 
879 |             private final String value;
880 | 
881 |             private JsonObject(String value) {
882 |                 this.value = value;
883 |             }
884 | 
885 |             @Override
886 |             public String toString() {
887 |                 return value;
888 |             }
889 |         }
890 |     }
891 | }


--------------------------------------------------------------------------------