Make channel access checks consistent (#2679)

discord-jda · May 12, 2024 · 46875ff · 46875ff
1 parent 087f68f
commit 46875ff
Show file tree

Hide file tree

Showing 7 changed files with 45 additions and 39 deletions.
diff --git a/src/main/java/net/dv8tion/jda/internal/entities/channel/concrete/PrivateChannelImpl.java b/src/main/java/net/dv8tion/jda/internal/entities/channel/concrete/PrivateChannelImpl.java
@@ -115,7 +115,7 @@ public boolean canTalk()
     }
 
     @Override
-    public void checkCanAccessChannel() {}
+    public void checkCanAccess() {}
 
     @Override
     public void checkCanSendMessage() {
@@ -158,8 +158,6 @@ public PrivateChannelImpl setLatestMessageIdLong(long latestMessageId)
         return this;
     }
 
-    // -- Object --
-
     @Override
     public int hashCode()
     {

diff --git a/src/main/java/net/dv8tion/jda/internal/entities/channel/concrete/VoiceChannelImpl.java b/src/main/java/net/dv8tion/jda/internal/entities/channel/concrete/VoiceChannelImpl.java
@@ -179,7 +179,7 @@ public String getStatus()
     public AuditableRestAction<Void> modifyStatus(@Nonnull String status)
     {
         Checks.notLonger(status, MAX_STATUS_LENGTH, "Voice Status");
-        checkCanAccessChannel();
+        checkCanAccess();
         if (this.equals(getGuild().getSelfMember().getVoiceState().getChannel()))
             checkPermission(Permission.VOICE_SET_STATUS);
         else

diff --git a/src/main/java/net/dv8tion/jda/internal/entities/channel/mixin/ChannelMixin.java b/src/main/java/net/dv8tion/jda/internal/entities/channel/mixin/ChannelMixin.java
@@ -42,4 +42,7 @@ default RestAction<Void> delete()
 
     // ---- State Accessors ----
     T setName(String name);
+
+    // ---- Hooks ----
+    void checkCanAccess();
 }
diff --git a/...ain/java/net/dv8tion/jda/internal/entities/channel/mixin/middleman/AudioChannelMixin.java b/...ain/java/net/dv8tion/jda/internal/entities/channel/mixin/middleman/AudioChannelMixin.java
@@ -17,8 +17,10 @@
 package net.dv8tion.jda.internal.entities.channel.mixin.middleman;
 
 import gnu.trove.map.TLongObjectMap;
+import net.dv8tion.jda.api.Permission;
 import net.dv8tion.jda.api.entities.Member;
 import net.dv8tion.jda.api.entities.channel.unions.AudioChannelUnion;
+import net.dv8tion.jda.api.exceptions.MissingAccessException;
 
 public interface AudioChannelMixin<T extends AudioChannelMixin<T>>
         extends AudioChannelUnion, StandardGuildChannelMixin<T>
@@ -31,4 +33,14 @@ public interface AudioChannelMixin<T extends AudioChannelMixin<T>>
     T setUserLimit(int userlimit);
 
     T setRegion(String region);
+
+    // AudioChannels also require connect permission to grant access
+    @Override
+    default void checkCanAccess()
+    {
+        if (!hasPermission(Permission.VIEW_CHANNEL))
+            throw new MissingAccessException(this, Permission.VIEW_CHANNEL);
+        if (!hasPermission(Permission.VOICE_CONNECT))
+            throw new MissingAccessException(this, Permission.VOICE_CONNECT);
+    }
 }
diff --git a/...ain/java/net/dv8tion/jda/internal/entities/channel/mixin/middleman/GuildChannelMixin.java b/...ain/java/net/dv8tion/jda/internal/entities/channel/mixin/middleman/GuildChannelMixin.java
@@ -21,6 +21,7 @@
 import net.dv8tion.jda.api.entities.channel.middleman.GuildChannel;
 import net.dv8tion.jda.api.entities.channel.unions.GuildChannelUnion;
 import net.dv8tion.jda.api.exceptions.InsufficientPermissionException;
+import net.dv8tion.jda.api.exceptions.MissingAccessException;
 import net.dv8tion.jda.api.requests.Route;
 import net.dv8tion.jda.api.requests.restaction.AuditableRestAction;
 import net.dv8tion.jda.internal.entities.channel.mixin.ChannelMixin;
@@ -40,6 +41,7 @@ public interface GuildChannelMixin<T extends GuildChannelMixin<T>> extends
     @CheckReturnValue
     default AuditableRestAction<Void> delete()
     {
+        checkCanAccess();
         checkCanManage();
 
         Route.CompiledRoute route = Route.Channels.DELETE_CHANNEL.compile(getId());
@@ -70,4 +72,11 @@ default void checkCanManage()
     {
         checkPermission(Permission.MANAGE_CHANNEL);
     }
+
+    // Overridden by AudioChannelMixin
+    default void checkCanAccess()
+    {
+        if (!hasPermission(Permission.VIEW_CHANNEL))
+            throw new MissingAccessException(this, Permission.VIEW_CHANNEL);
+    }
 }
diff --git a/...a/net/dv8tion/jda/internal/entities/channel/mixin/middleman/GuildMessageChannelMixin.java b/...a/net/dv8tion/jda/internal/entities/channel/mixin/middleman/GuildMessageChannelMixin.java
@@ -46,6 +46,7 @@ public interface GuildMessageChannelMixin<T extends GuildMessageChannelMixin<T>>
     @CheckReturnValue
     default RestAction<Void> deleteMessagesByIds(@Nonnull Collection<String> messageIds)
     {
+        checkCanAccess();
         checkPermission(Permission.MESSAGE_MANAGE, "Must have MESSAGE_MANAGE in order to bulk delete messages in this channel regardless of author.");
 
         if (messageIds.size() < 2 || messageIds.size() > 100)
@@ -66,6 +67,7 @@ default RestAction<Void> removeReactionById(@Nonnull String messageId, @Nonnull
         Checks.notNull(emoji, "Emoji");
         Checks.notNull(user, "User");
 
+        checkCanAccess();
         if (!getJDA().getSelfUser().equals(user))
             checkPermission(Permission.MESSAGE_MANAGE);
 
@@ -85,6 +87,7 @@ default RestAction<Void> clearReactionsById(@Nonnull String messageId)
     {
         Checks.isSnowflake(messageId, "Message ID");
 
+        checkCanAccess();
         checkPermission(Permission.MESSAGE_MANAGE);
 
         final Route.CompiledRoute route = Route.Messages.REMOVE_ALL_REACTIONS.compile(getId(), messageId);
@@ -98,6 +101,7 @@ default RestAction<Void> clearReactionsById(@Nonnull String messageId, @Nonnull
         Checks.notNull(messageId, "Message ID");
         Checks.notNull(emoji, "Emoji");
 
+        checkCanAccess();
         checkPermission(Permission.MESSAGE_MANAGE);
 
         Route.CompiledRoute route = Route.Messages.CLEAR_EMOJI_REACTIONS.compile(getId(), messageId, emoji.getAsReactionCode());
@@ -108,21 +112,17 @@ default RestAction<Void> clearReactionsById(@Nonnull String messageId, @Nonnull
     @Override
     default MessageCreateAction sendStickers(@Nonnull Collection<? extends StickerSnowflake> stickers)
     {
-        checkCanAccessChannel();
         checkCanSendMessage();
         Checks.notEmpty(stickers, "Stickers");
         Checks.noneNull(stickers, "Stickers");
         return new MessageCreateActionImpl(this).setStickers(stickers);
     }
 
     // ---- Default implementation of parent mixins hooks ----
-    default void checkCanAccessChannel()
-    {
-        checkPermission(Permission.VIEW_CHANNEL);
-    }
 
     default void checkCanSendMessage()
     {
+        checkCanAccess();
         if (getType().isThread())
             checkPermission(Permission.MESSAGE_SEND_IN_THREADS);
         else
@@ -131,32 +131,38 @@ default void checkCanSendMessage()
 
     default void checkCanSendMessageEmbeds()
     {
+        checkCanAccess();
         checkPermission(Permission.MESSAGE_EMBED_LINKS);
     }
 
     default void checkCanSendFiles()
     {
+        checkCanAccess();
         checkPermission(Permission.MESSAGE_ATTACH_FILES);
     }
 
     default void checkCanViewHistory()
     {
+        checkCanAccess();
         checkPermission(Permission.MESSAGE_HISTORY);
     }
 
     default void checkCanAddReactions()
     {
+        checkCanAccess();
         checkPermission(Permission.MESSAGE_ADD_REACTION);
         checkPermission(Permission.MESSAGE_HISTORY, "You need MESSAGE_HISTORY to add reactions to a message");
     }
 
     default void checkCanRemoveReactions()
     {
+        checkCanAccess();
         checkPermission(Permission.MESSAGE_HISTORY, "You need MESSAGE_HISTORY to remove reactions from a message");
     }
 
     default void checkCanControlMessagePins()
     {
+        checkCanAccess();
         checkPermission(Permission.MESSAGE_MANAGE, "You need MESSAGE_MANAGE to pin or unpin messages.");
     }