Deprecate isPreview method in decorate events (#8645)

This commit is contained in:
Jake Potrebic 2022-12-11 09:55:39 -08:00
parent cf2bb8381b
commit e74fb06010
2 changed files with 23 additions and 20 deletions

View File

@ -334,8 +334,9 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
+ +
+ private static final HandlerList HANDLER_LIST = new HandlerList(); + private static final HandlerList HANDLER_LIST = new HandlerList();
+ +
+ public AsyncChatCommandDecorateEvent(boolean async, @Nullable Player player, @NotNull Component originalMessage, boolean isPreview, @NotNull Component result) { + @ApiStatus.Internal
+ super(async, player, originalMessage, isPreview, result); + public AsyncChatCommandDecorateEvent(boolean async, @Nullable Player player, @NotNull Component originalMessage, @NotNull Component result) {
+ super(async, player, originalMessage, result);
+ } + }
+ +
+ @Override + @Override
@ -361,20 +362,16 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
+import org.bukkit.event.HandlerList; +import org.bukkit.event.HandlerList;
+import org.bukkit.event.server.ServerEvent; +import org.bukkit.event.server.ServerEvent;
+import org.jetbrains.annotations.ApiStatus; +import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable; +import org.jetbrains.annotations.Nullable;
+ +
+/** +/**
+ * This event is fired when the server decorates a component for chat purposes. It can be called + * This event is fired when the server decorates a component for chat purposes. This is called
+ * under the following circumstances: + * before {@link AsyncChatEvent} and the other chat events. It is recommended that you modify the
+ * <ul> + * message here, and use the chat events for modifying receivers and later the chat type. If you
+ * <li><b>Previewing:</b> If the client requests a preview response, this event is fired to decorate the component + * want to keep the message as "signed" for the clients who get it, be sure to include the entire
+ * before it is sent back to the client for signing.</li> + * original message somewhere in the final message.
+ * <li><b>Chat:</b> If the client sends a chat packet without having signed a preview (the client could have previews
+ * disabled or they sent the message too quickly) this event is fired to generated the decorated component. Note
+ * that when this is the case, the message will show up as modified as the decorated component wasn't signed
+ * by the client.</li>
+ * </ul>
+ * @see AsyncChatCommandDecorateEvent for the decoration of messages sent via commands + * @see AsyncChatCommandDecorateEvent for the decoration of messages sent via commands
+ */ + */
+@ApiStatus.Experimental +@ApiStatus.Experimental
@ -384,16 +381,14 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
+ +
+ private final Player player; + private final Player player;
+ private final Component originalMessage; + private final Component originalMessage;
+ private final boolean isPreview;
+ private Component result; + private Component result;
+ private boolean cancelled; + private boolean cancelled;
+ +
+ @ApiStatus.Internal + @ApiStatus.Internal
+ public AsyncChatDecorateEvent(final boolean async, final @Nullable Player player, final @NotNull Component originalMessage, final boolean isPreview, final @NotNull Component result) { + public AsyncChatDecorateEvent(final boolean async, final @Nullable Player player, final @NotNull Component originalMessage, final @NotNull Component result) {
+ super(async); + super(async);
+ this.player = player; + this.player = player;
+ this.originalMessage = originalMessage; + this.originalMessage = originalMessage;
+ this.isPreview = isPreview;
+ this.result = result; + this.result = result;
+ } + }
+ +
@ -443,9 +438,12 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
+ * If this decorating is part of a preview request/response. + * If this decorating is part of a preview request/response.
+ * + *
+ * @return true if part of previewing + * @return true if part of previewing
+ * @deprecated chat preview was removed in 1.19.2
+ */ + */
+ @Deprecated(forRemoval = true)
+ @Contract(value = "-> false", pure = true)
+ public boolean isPreview() { + public boolean isPreview() {
+ return this.isPreview; + return false;
+ } + }
+ +
+ @Override + @Override

View File

@ -157,13 +157,19 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
+ public CompletableFuture<ChatDecorator.Result> process() { + public CompletableFuture<ChatDecorator.Result> process() {
+ return CompletableFuture.supplyAsync(() -> { + return CompletableFuture.supplyAsync(() -> {
+ ChatDecorator.Result result = new ChatDecorator.ModernResult(this.originalMessage, true, false); + ChatDecorator.Result result = new ChatDecorator.ModernResult(this.originalMessage, true, false);
+ if (canYouHearMe(AsyncPlayerChatPreviewEvent.getHandlerList())) { + if (listenToLegacy()) {
+ result = this.processLegacy(result); + result = this.processLegacy(result);
+ } + }
+ return this.processModern(result); + return this.processModern(result);
+ }, this.server.chatExecutor); + }, this.server.chatExecutor);
+ } + }
+ +
+ @SuppressWarnings("deprecation")
+ private static boolean listenToLegacy() {
+ return canYouHearMe(AsyncPlayerChatPreviewEvent.getHandlerList());
+ }
+
+ @SuppressWarnings("deprecation")
+ private ChatDecorator.Result processLegacy(final ChatDecorator.Result input) { + private ChatDecorator.Result processLegacy(final ChatDecorator.Result input) {
+ if (this.player != null) { + if (this.player != null) {
+ final CraftPlayer player = this.player.getBukkitEntity(); + final CraftPlayer player = this.player.getBukkitEntity();
@ -188,12 +194,11 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
+ +
+ final Component initialResult = input.message().component(); + final Component initialResult = input.message().component();
+ final AsyncChatDecorateEvent event; + final AsyncChatDecorateEvent event;
+ //TODO
+ if (this.commandSourceStack != null) { + if (this.commandSourceStack != null) {
+ // TODO more command decorate context + // TODO more command decorate context
+ event = new AsyncChatCommandDecorateEvent(true, player, this.originalMessage, false, initialResult); + event = new AsyncChatCommandDecorateEvent(true, player, this.originalMessage, initialResult);
+ } else { + } else {
+ event = new AsyncChatDecorateEvent(true, player, this.originalMessage, false, initialResult); + event = new AsyncChatDecorateEvent(true, player, this.originalMessage, initialResult);
+ } + }
+ this.post(event); + this.post(event);
+ if (!event.isCancelled() && !event.result().equals(initialResult)) { + if (!event.isCancelled() && !event.result().equals(initialResult)) {