forked from KyoriPowered/adventure-platform
-
Notifications
You must be signed in to change notification settings - Fork 0
/
BukkitAudiencesImpl.java
286 lines (255 loc) · 11 KB
/
BukkitAudiencesImpl.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
/*
* This file is part of adventure-platform, licensed under the MIT License.
*
* Copyright (c) 2018-2020 KyoriPowered
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package net.kyori.adventure.platform.bukkit;
import com.google.common.collect.ImmutableList;
import com.google.common.graph.MutableGraph;
import java.lang.invoke.MethodHandle;
import java.lang.reflect.Field;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.logging.Level;
import net.kyori.adventure.audience.Audience;
import net.kyori.adventure.identity.Identity;
import net.kyori.adventure.platform.facet.FacetAudienceProvider;
import net.kyori.adventure.platform.facet.Knob;
import net.kyori.adventure.pointer.Pointered;
import net.kyori.adventure.text.flattener.ComponentFlattener;
import net.kyori.adventure.text.renderer.ComponentRenderer;
import net.kyori.adventure.translation.GlobalTranslator;
import net.kyori.adventure.translation.Translator;
import org.bukkit.Bukkit;
import org.bukkit.block.Block;
import org.bukkit.command.CommandSender;
import org.bukkit.command.ConsoleCommandSender;
import org.bukkit.command.ProxiedCommandSender;
import org.bukkit.entity.Entity;
import org.bukkit.entity.Player;
import org.bukkit.event.Event;
import org.bukkit.event.EventPriority;
import org.bukkit.event.Listener;
import org.bukkit.event.player.PlayerEvent;
import org.bukkit.event.player.PlayerJoinEvent;
import org.bukkit.event.player.PlayerQuitEvent;
import org.bukkit.plugin.Plugin;
import org.bukkit.plugin.PluginDescriptionFile;
import org.bukkit.plugin.PluginManager;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import static java.util.Objects.requireNonNull;
import static net.kyori.adventure.platform.bukkit.MinecraftReflection.findClass;
import static net.kyori.adventure.platform.bukkit.MinecraftReflection.findMethod;
import static net.kyori.adventure.platform.bukkit.MinecraftReflection.needField;
import static net.kyori.adventure.platform.facet.Knob.logError;
@SuppressWarnings("unchecked")
final class BukkitAudiencesImpl extends FacetAudienceProvider<CommandSender, BukkitAudience> implements BukkitAudiences, Listener {
static {
Knob.OUT = message -> Bukkit.getLogger().log(Level.INFO, message);
Knob.ERR = (message, error) -> Bukkit.getLogger().log(Level.WARNING, message, error);
}
private static final Map<String, BukkitAudiences> INSTANCES = Collections.synchronizedMap(new HashMap<>(4));
static Builder builder(final @NotNull Plugin plugin) {
return new Builder(plugin);
}
static BukkitAudiences instanceFor(final @NotNull Plugin plugin) {
return builder(plugin).build();
}
private final Plugin plugin;
BukkitAudiencesImpl(final @NotNull Plugin plugin, final @NotNull ComponentRenderer<Pointered> componentRenderer) {
super(componentRenderer);
this.plugin = requireNonNull(plugin, "plugin");
final CommandSender console = this.plugin.getServer().getConsoleSender();
this.addViewer(console);
for (final Player player : this.plugin.getServer().getOnlinePlayers()) {
this.addViewer(player);
}
this.registerEvent(PlayerJoinEvent.class, EventPriority.LOWEST, event ->
this.addViewer(event.getPlayer()));
this.registerEvent(PlayerQuitEvent.class, EventPriority.MONITOR, event ->
this.removeViewer(event.getPlayer()));
this.registerLocaleEvent(EventPriority.MONITOR, (viewer, locale) -> {
final @Nullable BukkitAudience audience = this.viewers.get(viewer);
if (audience != null) audience.locale(locale);
});
}
@Override
public @NotNull Audience sender(final @NotNull CommandSender sender) {
if (sender instanceof Player) {
return this.player((Player) sender);
} else if (sender instanceof ConsoleCommandSender) {
return this.console();
} else if (sender instanceof ProxiedCommandSender) {
return this.sender(((ProxiedCommandSender) sender).getCallee());
} else if (sender instanceof Entity || sender instanceof Block) {
return Audience.empty();
}
return this.createAudience(Collections.singletonList(sender));
}
@Override
public @NotNull Audience player(final @NotNull Player player) {
return this.player(player.getUniqueId());
}
@Override
protected @NotNull BukkitAudience createAudience(final @NotNull Collection<CommandSender> viewers) {
return new BukkitAudience(this.plugin, this, viewers);
}
@Override
public void close() {
INSTANCES.remove(this.plugin.getName());
super.close();
}
@Override
public @NotNull ComponentFlattener flattener() {
return BukkitComponentSerializer.FLATTENER;
}
static final class Builder implements BukkitAudiences.Builder {
private final @NotNull Plugin plugin;
private ComponentRenderer<Pointered> componentRenderer;
Builder(final @NotNull Plugin plugin) {
this.plugin = requireNonNull(plugin, "plugin");
this.componentRenderer(ptr -> ptr.getOrDefault(Identity.LOCALE, DEFAULT_LOCALE), GlobalTranslator.renderer());
}
@Override
public @NotNull Builder componentRenderer(final @NotNull ComponentRenderer<Pointered> componentRenderer) {
this.componentRenderer = requireNonNull(componentRenderer, "component renderer");
return this;
}
@Override
public BukkitAudiences.@NotNull Builder partition(final @NotNull Function<Pointered, ?> partitionFunction) {
requireNonNull(partitionFunction, "partitionFunction"); // unused
return this;
}
@Override
public @NotNull BukkitAudiences build() {
return INSTANCES.computeIfAbsent(this.plugin.getName(), name -> {
this.softDepend("ViaVersion");
return new BukkitAudiencesImpl(this.plugin, this.componentRenderer);
});
}
/**
* Add the provided plugin as a soft-depend of ourselves.
*
* <p>This removes the PluginClassLoader warning added by Spigot without
* requiring every user to add ViaVersion to their own plugin.yml.</p>
*
* <p>We do assume here that each copy of Adventure belongs to a JavaPlugin.
* If that is not true, we will silently fail to inject.</p>
*
* @param pluginName a plugin name
*/
@SuppressWarnings("unchecked")
private void softDepend(final @NotNull String pluginName) {
final PluginDescriptionFile file = this.plugin.getDescription();
if (file.getName().equals(pluginName)) return;
try {
final Field softDepend = needField(file.getClass(), "softDepend");
final List<String> dependencies = (List<String>) softDepend.get(file);
if (!dependencies.contains(pluginName)) {
final List<String> newList = ImmutableList.<String>builder().addAll(dependencies).add(pluginName).build();
softDepend.set(file, newList);
}
} catch (final Throwable error) {
logError(error, "Failed to inject softDepend in plugin.yml: %s %s", this.plugin, pluginName);
}
try {
final PluginManager manager = this.plugin.getServer().getPluginManager();
final Field dependencyGraphField = needField(manager.getClass(), "dependencyGraph");
final MutableGraph<String> graph = (MutableGraph<String>) dependencyGraphField.get(manager);
graph.putEdge(file.getName(), pluginName);
} catch (final Throwable error) {
// Fail silently, dependency graphs were added in 1.15, but the previous method still works
}
}
}
/**
* Registers an event listener as a callback.
*
* <p>Cancelled events will be ignored.</p>
*
* @param type an event type
* @param priority a listener priority
* @param callback a callback
* @param <T> an event type
*/
@SuppressWarnings("unchecked")
private <T extends Event> void registerEvent(final @NotNull Class<T> type, final @NotNull EventPriority priority, final @NotNull Consumer<T> callback) {
requireNonNull(callback, "callback");
this.plugin.getServer().getPluginManager().registerEvent(type, this, priority, (listener, event) -> callback.accept((T) event), this.plugin, true);
}
/**
* Registers a callback to listen for {@code PlayerLocaleChangeEvent}.
*
* <p>Bukkit has history of multiple versions of this event, so some
* reflection work is needed to detect the right one.</p>
*
* @param priority a priority
* @param callback a callback
*/
private void registerLocaleEvent(final EventPriority priority, final @NotNull BiConsumer<Player, Locale> callback) {
Class<?> eventClass = findClass("org.bukkit.event.player.PlayerLocaleChangeEvent");
if (eventClass == null) {
eventClass = findClass("com.destroystokyo.paper.event.player.PlayerLocaleChangeEvent");
}
MethodHandle getMethod = findMethod(eventClass, "getLocale", String.class);
if (getMethod == null) {
getMethod = findMethod(eventClass, "getNewLocale", String.class);
}
if (getMethod != null && PlayerEvent.class.isAssignableFrom(eventClass)) {
final Class<? extends PlayerEvent> localeEvent = (Class<? extends PlayerEvent>) eventClass;
final MethodHandle getLocale = getMethod;
this.registerEvent(localeEvent, priority, event -> {
final Player player = event.getPlayer();
final String locale;
try {
locale = (String) getLocale.invoke(event);
} catch (final Throwable error) {
logError(error, "Failed to accept %s: %s", localeEvent.getName(), player);
return;
}
callback.accept(player, BukkitAudiencesImpl.toLocale(locale));
});
}
}
/**
* Converts a raw locale given by the client to a nicer Locale object.
*
* @param string a raw locale
* @return a parsed locale
*/
private static @NotNull Locale toLocale(final @Nullable String string) {
if (string != null) {
final Locale locale = Translator.parseLocale(string);
if (locale != null) {
return locale;
}
}
return Locale.US;
}
}