add option to hide channels that you cannot join

Author: Mindgamesnl

.tool-versions

@@ -1 +1 @@
-java openjdk-21
+java openjdk-18.0.2.1

api/dependency-reduced-pom.xml

@@ -95,8 +95,8 @@
     </dependency>
   </dependencies>
   <properties>
-    <java.version>1.8</java.version>
     <delombok.output>${project.build.directory}/delombok</delombok.output>
+    <java.version>1.8</java.version>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <sourcepath>src/main/java</sourcepath>
   </properties>

api/src/main/java/com/craftmend/openaudiomc/api/channels/VoiceChannel.java

@@ -73,4 +73,10 @@ public interface VoiceChannel {
      * @param client the client to remove
      */
     void removeMember(Client client);
+
+    /**
+     * Check if the channel requires permission to see
+     * @return true if the channel requires permission to see
+     */
+    boolean requiresPermissionToSee();
 }

modules/jutils/dependency-reduced-pom.xml

@@ -84,7 +84,7 @@
     </plugins>
   </build>
   <properties>
-    <maven.compiler.source>8</maven.compiler.source>
     <maven.compiler.target>8</maven.compiler.target>
+    <maven.compiler.source>8</maven.compiler.source>
   </properties>
 </project>

plugin/src/main/java/com/craftmend/openaudiomc/spigot/modules/voicechat/VoiceChannelService.java

@@ -1,6 +1,7 @@
 package com.craftmend.openaudiomc.spigot.modules.voicechat;
 
 import com.craftmend.openaudiomc.api.EventApi;
+import com.craftmend.openaudiomc.api.channels.ChannelJoinResponse;
 import com.craftmend.openaudiomc.api.channels.VoiceChannel;
 import com.craftmend.openaudiomc.api.channels.events.ChannelCreatedEvent;
 import com.craftmend.openaudiomc.api.channels.events.ChannelDeletedEvent;
@@ -22,11 +23,13 @@
 import com.craftmend.openaudiomc.generic.storage.enums.StorageKey;
 import com.craftmend.openaudiomc.generic.user.User;
 import com.craftmend.openaudiomc.spigot.modules.voicechat.channels.Channel;
+import com.craftmend.openaudiomc.spigot.modules.voicechat.channels.ChannelEnterResponse;
 import com.craftmend.openaudiomc.spigot.modules.voicechat.commands.*;
 import org.bukkit.Bukkit;
 import org.bukkit.event.Listener;
 import org.bukkit.permissions.Permission;
 
+import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.Map;
@@ -108,6 +111,12 @@ public VoiceChannelService(
                         requirePermission ? permission : null,
                         this
                 );
+
+                Object permissionViabilityBoolean = obj.get("requirePermissionToSee");
+                if (permissionViabilityBoolean != null && permissionViabilityBoolean instanceof Boolean) {
+                    staticChannel.setRequiresPermissionToSee((boolean) permissionViabilityBoolean);
+                }
+
                 channelMap.put(staticChannel.getName(), staticChannel);
                 OpenAudioLogger.info("Created static channel: " + staticChannel.getName());
 
@@ -189,8 +198,11 @@ public void onClientConnect(VoicechatReadyEvent event) {
             return;
         }
         User<?> user = (User<?>) event.getClient().getActor();
-        PacketClientChannelsDisplayPacket packet = new PacketClientChannelsDisplayPacket(new ClientChannelsDisplayPayload(channelMap.values(), user, ClientChannelsDisplayPayload.ClientChannelOperation.ALL));
+        Collection<Channel> visibleChannels = new ArrayList<>(channelMap.values());
 
+        // filter out channels that require permission to see, and we don't have the permission
+        visibleChannels.removeIf(channel -> channel.isRequiresPermissionToSee() && channel.attemptEnter(user) != ChannelEnterResponse.OK);
+        PacketClientChannelsDisplayPacket packet = new PacketClientChannelsDisplayPacket(new ClientChannelsDisplayPayload(visibleChannels, user, ClientChannelsDisplayPayload.ClientChannelOperation.ALL));
         ClientConnection client = (ClientConnection) event.getClient();
         client.sendPacket(packet);
     }
@@ -204,6 +216,11 @@ public void onMembersUpdate(ChannelMembersUpdatedEvent event) {
         for (ClientConnection client : getService(NetworkingService.class).getClients()) {
             // are they connected and are they in voice chat?
             if (client.getRtcSessionManager().isReady()) {
+                // is this channel visible to the client?
+                if (event.getChannel().requiresPermissionToSee() && event.getChannel().joinPreconditionCheck(client) != ChannelJoinResponse.NO_PERMISSION) {
+                    continue;
+                }
+
                 PacketClientChannelsDisplayPacket packet = new PacketClientChannelsDisplayPacket(new ClientChannelsDisplayPayload(
                         Collections.singleton((Channel) event.getChannel()),
                         client.getUser(),
@@ -223,6 +240,10 @@ public void onChannelCreate(ChannelCreatedEvent event) {
         for (ClientConnection client : getService(NetworkingService.class).getClients()) {
             // are they connected and are they in voice chat?
             if (client.getRtcSessionManager().isReady()) {
+                if (event.getChannel().requiresPermissionToSee() && event.getChannel().joinPreconditionCheck(client) != ChannelJoinResponse.NO_PERMISSION) {
+                    continue;
+                }
+
                 PacketClientChannelsDisplayPacket packet = new PacketClientChannelsDisplayPacket(new ClientChannelsDisplayPayload(
                         Collections.singleton((Channel) event.getChannel()),
                         client.getUser(),
@@ -242,6 +263,10 @@ public void onChannelDelete(ChannelDeletedEvent event) {
         for (ClientConnection client : getService(NetworkingService.class).getClients()) {
             // are they connected and are they in voice chat?
             if (client.getRtcSessionManager().isReady()) {
+                if (event.getChannel().requiresPermissionToSee() && event.getChannel().joinPreconditionCheck(client) != ChannelJoinResponse.NO_PERMISSION) {
+                    continue;
+                }
+
                 PacketClientChannelsDisplayPacket packet = new PacketClientChannelsDisplayPacket(new ClientChannelsDisplayPayload(
                         Collections.singleton((Channel) event.getChannel()),
                         client.getUser(),

plugin/src/main/java/com/craftmend/openaudiomc/spigot/modules/voicechat/channels/Channel.java

@@ -14,6 +14,7 @@
 import com.craftmend.openaudiomc.generic.user.User;
 import com.craftmend.openaudiomc.spigot.modules.voicechat.VoiceChannelService;
 import lombok.Getter;
+import lombok.Setter;
 import org.jetbrains.annotations.Nullable;
 
 import java.util.*;
@@ -26,6 +27,8 @@ public class Channel implements VoiceChannel {
     private final Map<UUID, ClientConnection> members = new HashMap<>();
     private final VoiceChannelService voiceChannelService;
     private final String requiredPermission;
+    @Setter
+    @Getter private boolean requiresPermissionToSee = false;
     @Getter private final ChannelType type;
 
     public Channel(@Nullable User creator, String name, VoiceChannelService voiceChannelService) {
@@ -175,4 +178,9 @@ public void addMember(Client client) {
     public void removeMember(Client client) {
         removeMember(((ClientConnection) client).getUser());
     }
+
+    @Override
+    public boolean requiresPermissionToSee() {
+        return this.requiresPermissionToSee;
+    }
 }

plugin/src/main/java/com/craftmend/openaudiomc/spigot/modules/voicechat/commands/ChannelListCommand.java

@@ -11,6 +11,7 @@
 import com.craftmend.openaudiomc.generic.user.User;
 import com.craftmend.openaudiomc.spigot.modules.voicechat.VoiceChannelService;
 import com.craftmend.openaudiomc.spigot.modules.voicechat.channels.Channel;
+import com.craftmend.openaudiomc.spigot.modules.voicechat.channels.ChannelEnterResponse;
 import lombok.SneakyThrows;
 
 import java.util.Collection;
@@ -39,6 +40,11 @@ public void onExecute(User sender, String[] args) {
         sender.sendMessage(Platform.translateColors(StorageKey.MESSAGE_VOICE_CHANNEL_LIST_HEADER.getString()));
 
         for (Channel channel : channels) {
+            // is this player able to see this channel? if not, then continue
+            if (channel.isRequiresPermissionToSee() && channel.attemptEnter(sender) != ChannelEnterResponse.OK) {
+                continue;
+            }
+
             StringBuilder readableOccupants;
             Collection<Client> occupants = channel.getMembers();
             if (occupants.isEmpty()) {

plugin/src/main/java/com/craftmend/openaudiomc/spigot/modules/voicechat/tabcomplete/VoiceChannelTabCompleteProvider.java

@@ -5,14 +5,17 @@
 import com.craftmend.openaudiomc.generic.user.User;
 import com.craftmend.openaudiomc.spigot.modules.voicechat.VoiceChannelService;
 import com.craftmend.openaudiomc.spigot.modules.voicechat.channels.Channel;
+import com.craftmend.openaudiomc.spigot.modules.voicechat.channels.ChannelEnterResponse;
 
+import java.util.ArrayList;
 import java.util.Collection;
 
 public class VoiceChannelTabCompleteProvider implements TabCompleteProvider {
 
     @Override
     public String[] getOptions(User sender) {
-        Collection<Channel> channels = OpenAudioMc.getService(VoiceChannelService.class).getChannels();
+        Collection<Channel> channels = new ArrayList<>(OpenAudioMc.getService(VoiceChannelService.class).getChannels());
+        channels.removeIf(channel -> channel.isRequiresPermissionToSee() && channel.attemptEnter(sender) != ChannelEnterResponse.OK);
         String[] options = new String[channels.size()];
         int i = 0;
         for (Channel channel : channels) {

plugin/src/main/resources/config.yml

@@ -335,6 +335,12 @@ static-channels:
       permission: channels.staffchat
       requirePermission: true
 
+
+    - name: admin-chat
+      permission: channels.adminchat
+      requirePermission: true
+      requirePermissionToSee: true # hide this channel for players who don't have the permission
+
 # PlaceholderAPI
 papi:
   # Value to display when player is connected to the web client