diff --git a/android/app/src/main/java/eu/lixko/ts3j/client/android/ServerController.kt b/android/app/src/main/java/eu/lixko/ts3j/client/android/ServerController.kt index f5460de..8fd9ea9 100644 --- a/android/app/src/main/java/eu/lixko/ts3j/client/android/ServerController.kt +++ b/android/app/src/main/java/eu/lixko/ts3j/client/android/ServerController.kt @@ -174,6 +174,10 @@ class ServerController internal constructor( fun setAway(away: Boolean) = session.setAway(away, null) + /** Asks for talk power giving [reason], or withdraws the request with null. */ + fun setTalkRequest(reason: String?) = + if (reason == null) session.cancelTalkRequest() else session.requestTalkPower(reason) + // ---- channels and clients ---- fun joinChannel(channelId: Int, password: String? = null) { @@ -291,6 +295,8 @@ class ServerController internal constructor( val canKickFromChannel: Boolean get() = session.canKickFromChannel() val canKickFromServer: Boolean get() = session.canKickFromServer() val canBanClients: Boolean get() = session.canBanClients() + val canGrantTalkPower: Boolean get() = session.canGrantTalkPower() + val canRequestTalkPower: Boolean get() = session.canRequestTalkPower() val canViewBanList: Boolean get() = session.canViewBanList() val canBrowseFiles: Boolean get() = session.canBrowseFiles() val canCreateBans: Boolean get() = session.isConnected && conn.model.permits("b_client_ban_create") @@ -306,6 +312,10 @@ class ServerController internal constructor( if (session.isConnected) conn.kickFromServer(clientIds, reason) } + fun setTalker(clientIds: Collection, talker: Boolean) { + if (session.isConnected) conn.setTalker(clientIds, talker) + } + /** Bans a client for [seconds], or for good with 0. */ fun ban(clientId: Int, seconds: Long, reason: String) { if (session.isConnected) conn.banClient(clientId, seconds, reason) diff --git a/android/app/src/main/java/eu/lixko/ts3j/client/android/ServerTree.kt b/android/app/src/main/java/eu/lixko/ts3j/client/android/ServerTree.kt index 9729bd2..2bdbc23 100644 --- a/android/app/src/main/java/eu/lixko/ts3j/client/android/ServerTree.kt +++ b/android/app/src/main/java/eu/lixko/ts3j/client/android/ServerTree.kt @@ -138,6 +138,9 @@ data class ServerTree( country = c.country.orEmpty(), serverGroupIds = c.serverGroupIds.toList(), channelGroupId = c.channelGroupId, + talker = c.talker, + lacksTalkPower = model.lacksTalkPower(c), + talkRequest = c.talkRequest, ) } } @@ -189,4 +192,10 @@ data class ClientItem( val country: String, val serverGroupIds: List, val channelGroupId: Int, + /** Granted talk power. */ + val talker: Boolean, + /** Short of the channel's needed talk power, so kept from talking. */ + val lacksTalkPower: Boolean, + /** Waiting for talk power. */ + val talkRequest: Boolean, ) diff --git a/android/app/src/main/java/eu/lixko/ts3j/client/android/ui/ChannelTree.kt b/android/app/src/main/java/eu/lixko/ts3j/client/android/ui/ChannelTree.kt index edfca66..21ba35d 100644 --- a/android/app/src/main/java/eu/lixko/ts3j/client/android/ui/ChannelTree.kt +++ b/android/app/src/main/java/eu/lixko/ts3j/client/android/ui/ChannelTree.kt @@ -350,7 +350,11 @@ private fun ClientRow( color = MaterialTheme.colorScheme.onSurfaceVariant, maxLines = 1, overflow = TextOverflow.Ellipsis) } } + // TeamSpeak's order: talk power ahead of the groups, a talk request after them. + if (client.talker) PackIcon("IS_TALKER", "Talk power granted", size = ICON) + else if (client.lacksTalkPower) PackIcon("INPUT_MUTED", "Insufficient talk power", size = ICON) for (id in client.groupIconIds) ServerIcon(id, size = ICON) + if (client.talkRequest) PackIcon("TALK_POWER_REQUEST", "Talk power requested", size = ICON) // The country's flag comes last, at the row's edge. if (countryFlags) CountryFlag(client.country) } diff --git a/android/app/src/main/java/eu/lixko/ts3j/client/android/ui/Moderation.kt b/android/app/src/main/java/eu/lixko/ts3j/client/android/ui/Moderation.kt index 37851e4..94015d9 100644 --- a/android/app/src/main/java/eu/lixko/ts3j/client/android/ui/Moderation.kt +++ b/android/app/src/main/java/eu/lixko/ts3j/client/android/ui/Moderation.kt @@ -183,7 +183,7 @@ fun GroupsDialog( } /** - * The kicks, the ban and the groups of [client], as far as we may use them; [onDone] once one went out. + * Talk power, the kicks, the ban and the groups of [client], as far as we may use them; [onDone] once one went out. * Null when there is none of them. */ @Composable @@ -193,11 +193,12 @@ fun clientModeration(server: ServerController, client: ClientItem, onDone: () -> val kickChannel = !client.self && server.canKickFromChannel val kickServer = !client.self && server.canKickFromServer val ban = !client.self && server.canBanClients + val talker = server.canGrantTalkPower && (client.talker || client.lacksTalkPower) val showServerGroups = serverGroups.any { it.allowed() } val showChannelGroups = channelGroups.any { it.allowed() && !it.assigned() } - if (!(kickChannel || kickServer || ban || showServerGroups || showChannelGroups)) return null + if (!(talker || kickChannel || kickServer || ban || showServerGroups || showChannelGroups)) return null return { - ClientModeration(server, client, serverGroups, channelGroups, kickChannel, kickServer, ban, + ClientModeration(server, client, serverGroups, channelGroups, talker, kickChannel, kickServer, ban, showServerGroups, showChannelGroups, onDone) } } @@ -208,6 +209,7 @@ private fun ClientModeration( client: ClientItem, serverGroups: List, channelGroups: List, + talker: Boolean, kickChannel: Boolean, kickServer: Boolean, ban: Boolean, @@ -219,6 +221,10 @@ private fun ClientModeration( var banning by remember { mutableStateOf(false) } var groups by remember { mutableStateOf(null) } + if (talker) { + if (client.talker) Action("TALK_POWER_REVOKE", "Revoke talk power") { server.setTalker(listOf(client.id), false); onDone() } + else Action("TALK_POWER_GRANT", "Grant talk power") { server.setTalker(listOf(client.id), true); onDone() } + } if (kickChannel) Action("KICK_FROM_CHANNEL", "Kick from channel") { kick = false } if (kickServer) Action("KICK_FROM_SERVER", "Kick from server") { kick = true } if (ban) Action("BAN_CLIENT", "Ban") { banning = true } diff --git a/android/app/src/main/java/eu/lixko/ts3j/client/android/ui/ServerScreen.kt b/android/app/src/main/java/eu/lixko/ts3j/client/android/ui/ServerScreen.kt index a1e27c5..cfb1397 100644 --- a/android/app/src/main/java/eu/lixko/ts3j/client/android/ui/ServerScreen.kt +++ b/android/app/src/main/java/eu/lixko/ts3j/client/android/ui/ServerScreen.kt @@ -433,6 +433,9 @@ fun ServerScreen( onPoke = { server.poke(id, it); clientSheet = null }, onVolume = { server.setClientVolume(id, it) }, onAway = { server.setAway(it); clientSheet = null }, + onTalkRequest = if (client.self && (client.talkRequest || server.canRequestTalkPower)) { + { server.setTalkRequest(it); clientSheet = null } + } else null, onAddContact = { server.addContact(id, it) }, onEditContact = { clientSheet = null; onEditContact(client.uniqueId) }, onConnectionInfo = { clientSheet = null; connectionInfo = id }, diff --git a/android/app/src/main/java/eu/lixko/ts3j/client/android/ui/Sheets.kt b/android/app/src/main/java/eu/lixko/ts3j/client/android/ui/Sheets.kt index 504358d..46c4efd 100644 --- a/android/app/src/main/java/eu/lixko/ts3j/client/android/ui/Sheets.kt +++ b/android/app/src/main/java/eu/lixko/ts3j/client/android/ui/Sheets.kt @@ -64,6 +64,8 @@ fun ClientSheet( onPoke: (String) -> Unit, onVolume: (Double) -> Unit, onAway: (Boolean) -> Unit, + /** Asks for talk power with a reason, or withdraws the request with null; null when we may not ask. */ + onTalkRequest: ((String?) -> Unit)?, onAddContact: (ContactType) -> Unit, onEditContact: () -> Unit, onConnectionInfo: () -> Unit, @@ -80,6 +82,7 @@ fun ClientSheet( moderation: (@Composable () -> Unit)? = null, ) { var poking by remember { mutableStateOf(false) } + var requesting by remember { mutableStateOf(false) } val sheetState = rememberModalBottomSheetState() val scope = rememberCoroutineScope() // A half-open sheet would fold the admin actions out below the screen's edge. @@ -112,6 +115,10 @@ fun ClientSheet( onFindInTree?.let { Action("CHANNEL_SWITCH", "Find client in channel tree", onClick = it) } if (client.self) { Action("AWAY", if (away) "Back" else "Away") { onAway(!away) } + onTalkRequest?.let { request -> + if (client.talkRequest) Action("TALK_POWER_CANCEL_REQUEST", "Cancel talk power request") { request(null) } + else Action("TALK_POWER_REQUEST", "Request talk power") { requesting = true } + } moderation?.let { adminActions { it() } } } else { Action("PLAYER_CHAT", "Send message", onClick = onMessage) @@ -157,6 +164,15 @@ fun ClientSheet( onConfirm = { poking = false; onPoke(it) }, ) } + if (requesting) { + TextPrompt( + title = "Request talk power", + label = "Reason", + confirm = "Request", + onDismiss = { requesting = false }, + onConfirm = { requesting = false; onTalkRequest?.invoke(it.trim()) }, + ) + } } /** What can be done with a channel: join it, whether to hear who is in it, whisper to it, its files, and editing it. */ diff --git a/ts3-client/README.md b/ts3-client/README.md index bd99179..5946286 100644 --- a/ts3-client/README.md +++ b/ts3-client/README.md @@ -66,6 +66,10 @@ Android app in [`../android`](../android) does. on demand); selecting a client shows its **server groups** and **channel group** (names resolved from the server's group lists), talk power, platform and version. - **Server-group badge** next to each client's nickname in the tree. +- **Talk power** — request it (Self menu, with a reason, or a hotkey); grant or revoke + it from a client's menu, or grant the next request in our channel by hotkey. The + tree marks granted clients, those short of the channel's needed talk power, and + pending requests, whose reason shows in the info panel. - **Spacer channels** — TS3 `[spacer]`/`[*spacer]`/`[c/l/r spacer]` names render as non-interactive separators (fill, centred, aligned). - Double-click a channel to **join**; right-click a client to **poke**, open a @@ -314,7 +318,7 @@ swing/ eu.lixko.ts3j.client - Whisper is received/played but not yet **sendable** from the UI. - Hotkey actions TeamSpeak offers but this client does not perform yet (listed but greyed out in the dialog): capture/playback/hotkey profiles and sound packs, - whisper and push-to-whisper, recording, plugins, server groups, talk power, 3D + whisper and push-to-whisper, recording, plugins, server groups, 3D sound, hardware ("local") microphone mute and the channel-traversal variants beyond "Switch to Channel". - Global hotkeys cover Linux and Windows; **macOS has no backend**, so hotkeys there are diff --git a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/hotkey/HotkeyAction.java b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/hotkey/HotkeyAction.java index 23c3b03..d87b55a 100644 --- a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/hotkey/HotkeyAction.java +++ b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/hotkey/HotkeyAction.java @@ -198,11 +198,11 @@ public enum HotkeyAction { // ----- Misc ----- TALK_POWER_GRANT_NEXT(Category.MISC, 0x01b0, "GrantNextTalkPower", - "Grant Next User Talk Power", true, Argument.NONE, false), + "Grant Next User Talk Power", true, Argument.NONE, true), TALK_POWER_REQUEST(Category.MISC, 0x01b0, "RequestTalkPower", - "Request Talk Power", true, Argument.NONE, false), + "Request Talk Power", true, Argument.NONE, true), TALK_POWER_REVOKE_ALL_GRANT_NEXT(Category.MISC, 0x01b0, "RevokeAllAndGrantNext", - "Revoke All And Grant Next User Talk Power", true, Argument.NONE, false), + "Revoke All And Grant Next User Talk Power", true, Argument.NONE, true), FILEBROWSER(Category.MISC, 0x01d0, "Filebrowser", "Open Filebrowser on Channel", true, Argument.NONE, true), diff --git a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ChannelNode.java b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ChannelNode.java index d6b71b0..08267c9 100644 --- a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ChannelNode.java +++ b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ChannelNode.java @@ -19,6 +19,8 @@ public final class ChannelNode { public volatile boolean hasPassword; public volatile boolean permanent; public volatile int maxClients = -1; + /** The talk power a client needs to talk here ({@code channel_needed_talk_power}). */ + public volatile int neededTalkPower; /** Id of the channel's custom icon in the server's file repository, or 0 for none. */ public volatile long iconId; /** Whether the server sends us this channel's client list; set from the subscription events. */ diff --git a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ClientEntry.java b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ClientEntry.java index 4eae3ed..2deaaa2 100644 --- a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ClientEntry.java +++ b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ClientEntry.java @@ -18,6 +18,12 @@ public final class ClientEntry { public volatile int talkPower; /** Waiting for a moderator to grant talk power ({@code client_talk_request}). */ public volatile boolean talkRequest; + /** When the request was made, in epoch seconds; 0 when unknown or there is none. */ + public volatile long talkRequestTime; + /** The reason given with the request ({@code client_talk_request_msg}). */ + public volatile String talkRequestMessage = ""; + /** Granted talk power: may talk whatever the channel needs ({@code client_is_talker}). */ + public volatile boolean talker; public volatile int[] serverGroupIds = new int[0]; public volatile int channelGroupId; diff --git a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ConnectionEventHandler.java b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ConnectionEventHandler.java index 99eb2f2..2411035 100644 --- a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ConnectionEventHandler.java +++ b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ConnectionEventHandler.java @@ -38,7 +38,8 @@ final class ConnectionEventHandler implements TS3Listener { ClientEntry c = conn.getModel().putClient(e.getClientId(), e.getClientNickname(), e.getClientTargetId()); c.type = safeInt(e, "client_type"); c.talkPower = e.getClientTalkPower(); - c.talkRequest = talkRequested(e); + applyTalkRequest(c, e); + c.talker = e.getBoolean("client_is_talker"); c.phoneticNickname = TeamspeakConnection.orEmpty(e.get("client_nickname_phonetic")); c.inputMuted = e.isClientInputMuted(); c.outputMuted = e.isClientOutputMuted(); @@ -330,7 +331,8 @@ final class ConnectionEventHandler implements TS3Listener { c.awayMessage = TeamspeakConnection.orEmpty(e.get("client_away_message")); } if (has(e, "client_talk_power")) c.talkPower = e.getInt("client_talk_power"); - if (has(e, "client_talk_request")) c.talkRequest = talkRequested(e); + if (has(e, "client_talk_request")) applyTalkRequest(c, e); + if (has(e, "client_is_talker")) c.talker = e.getBoolean("client_is_talker"); if (reported(e, "client_nickname_phonetic")) { c.phoneticNickname = TeamspeakConnection.orEmpty(e.get("client_nickname_phonetic")); } @@ -378,10 +380,13 @@ final class ConnectionEventHandler implements TS3Listener { } if (has(e, "client_talk_request") && talkRequested(e) && !self) { conn.sound(SoundEvent.CLIENT_REQUESTED_TALK_POWER, vars); + conn.log(conn.clientLink(c.id) + " requested talk power"); } - if (self && has(e, "client_is_talker")) { - conn.sound(e.getBoolean("client_is_talker") - ? SoundEvent.YOU_WERE_GRANTED_TALK_POWER : SoundEvent.YOU_WERE_REVOKED_TALK_POWER, vars); + // Leaving the channel drops the grant too, but without an invoker: that is no news. + if (self && has(e, "client_is_talker") && has(e, "invokerid")) { + boolean granted = e.getBoolean("client_is_talker"); + conn.sound(granted ? SoundEvent.YOU_WERE_GRANTED_TALK_POWER : SoundEvent.YOU_WERE_REVOKED_TALK_POWER, vars); + conn.log("Talk Power " + (granted ? "granted" : "revoked") + " by " + invokerName(e)); } if (!self && has(e, "client_is_recording")) { boolean recording = e.getBoolean("client_is_recording"); @@ -462,6 +467,7 @@ final class ConnectionEventHandler implements TS3Listener { if (has(e, "channel_icon_id")) ch.iconId = TeamspeakConnection.safeLong(e, "channel_icon_id"); if (has(e, "channel_flag_password")) ch.hasPassword = e.getBoolean("channel_flag_password"); if (has(e, "channel_flag_permanent")) ch.permanent = e.getBoolean("channel_flag_permanent"); + if (has(e, "channel_needed_talk_power")) ch.neededTalkPower = safeInt(e, "channel_needed_talk_power"); if (has(e, "channel_flag_maxclients_unlimited") && e.getBoolean("channel_flag_maxclients_unlimited")) { ch.maxClients = -1; } else if (has(e, "channel_maxclients")) { @@ -709,6 +715,12 @@ final class ConnectionEventHandler implements TS3Listener { return v != null && !v.isBlank() && !v.trim().equals("0"); } + private static void applyTalkRequest(ClientEntry c, BaseEvent e) { + c.talkRequest = talkRequested(e); + c.talkRequestTime = c.talkRequest ? TeamspeakConnection.safeLong(e, "client_talk_request") : 0; + c.talkRequestMessage = c.talkRequest ? TeamspeakConnection.orEmpty(e.get("client_talk_request_msg")) : ""; + } + private static int safeInt(BaseEvent e, String key) { try { String v = e.get(key); diff --git a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/Details.java b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/Details.java index b937157..3392dab 100644 --- a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/Details.java +++ b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/Details.java @@ -40,6 +40,7 @@ public record Details(String title, List fields, String description, bool } private static final DateTimeFormatter DATE = DateTimeFormatter.ofPattern("yyyy-MM-dd"); + private static final DateTimeFormatter TIME = DateTimeFormatter.ofPattern("HH:mm"); public static Details server(ServerModel model, String address) { List fields = new ArrayList<>(); @@ -98,7 +99,9 @@ public record Details(String title, List fields, String description, bool ? new Field("Channel group", channelGroup.name, List.of(channelGroup)) : new Field("Channel group", "#" + cl.channelGroupId)); - if (cl.talkPower != 0) fields.add(Field.minor("Talk power", Integer.toString(cl.talkPower))); + if (cl.talker) fields.add(new Field("Talk power", cl.talkPower + ", granted")); + else if (cl.talkPower != 0) fields.add(Field.minor("Talk power", Integer.toString(cl.talkPower))); + if (cl.talkRequest) fields.add(new Field("Talk request", talkRequest(cl))); if (!cl.version.isEmpty()) { fields.add(Field.minor("Version", cl.version + (cl.platform.isEmpty() ? "" : " on " + cl.platform))); } else if (!cl.platform.isEmpty()) { @@ -115,6 +118,13 @@ public record Details(String title, List fields, String description, bool return new Details(name, fields, cl.description == null ? "" : cl.description, false); } + private static String talkRequest(ClientEntry cl) { + String message = cl.talkRequestMessage.trim(); + if (cl.talkRequestTime <= 0) return message.isEmpty() ? "pending" : message; + String time = TIME.format(Instant.ofEpochSecond(cl.talkRequestTime).atZone(ZoneId.systemDefault())); + return message.isEmpty() ? "since " + time : message + " (" + time + ")"; + } + private static long parseLong(String s) { try { return s.isEmpty() ? 0 : Long.parseLong(s.trim()); diff --git a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ServerModel.java b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ServerModel.java index e0228d7..eff383d 100644 --- a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ServerModel.java +++ b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ServerModel.java @@ -540,6 +540,34 @@ public final class ServerModel { return new ArrayList<>(clients.values()); } + /** + * Whether a client is kept from talking: short of its channel's needed talk power and not granted + * any. Only then will the server take a request from them, or a grant for them. + */ + public synchronized boolean lacksTalkPower(ClientEntry client) { + ChannelNode channel = channels.get(client.channelId); + return channel != null && !client.talker && client.talkPower < channel.neededTalkPower; + } + + /** The client in a channel who has waited longest for talk power, or null when nobody is asking. */ + public synchronized ClientEntry nextTalkRequest(int channelId) { + ClientEntry next = null; + for (ClientEntry c : clients.values()) { + if (c.channelId != channelId || !c.talkRequest) continue; + if (next == null || c.talkRequestTime < next.talkRequestTime) next = c; + } + return next; + } + + /** The clients in a channel who were granted talk power. */ + public synchronized List talkersIn(int channelId) { + List out = new ArrayList<>(); + for (ClientEntry c : clients.values()) { + if (c.channelId == channelId && c.talker) out.add(c); + } + return out; + } + public synchronized ClientEntry findClientByUniqueId(String uniqueId) { if (uniqueId == null || uniqueId.isEmpty()) return null; for (ClientEntry c : clients.values()) { diff --git a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/TeamspeakConnection.java b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/TeamspeakConnection.java index aaa9dee..3b25c40 100644 --- a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/TeamspeakConnection.java +++ b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/TeamspeakConnection.java @@ -993,13 +993,49 @@ public final class TeamspeakConnection implements TS3Listener { /** @param message the reason shown to moderators; ignored when withdrawing the request */ public void setTalkRequest(boolean request, String message) { - updateSelf(self -> self.talkRequest = request); + updateSelf(self -> { + self.talkRequest = request; + self.talkRequestMessage = request ? message : ""; + if (!request) self.talkRequestTime = 0; + }); selfUpdate(cmd -> { cmd.add(new CommandSingleParameter("client_talk_request", request ? "1" : "0")); if (request) cmd.add(new CommandSingleParameter("client_talk_request_msg", message)); }, "Talk power request failed"); } + /** Grants or revokes clients' talk power, which lets them talk whatever their channel needs. */ + public void setTalker(Collection clientIds, boolean talker) { + if (clientIds.isEmpty()) return; + act(talker ? "Error granting talk power: " : "Error revoking talk power: ", sock -> { + for (int id : clientIds) setTalker(sock, id, talker); + }); + } + + /** + * Grants talk power to whoever in our channel has waited longest for it, first revoking + * it from everyone who has it there when {@code revokeOthers}. + */ + public void grantNextTalkPower(boolean revokeOthers) { + ClientEntry self = model.getClient(selfClientId); + if (self == null) return; + ClientEntry next = model.nextTalkRequest(self.channelId); + List talkers = revokeOthers ? model.talkersIn(self.channelId) : List.of(); + if (next == null && talkers.isEmpty()) return; + act("Error granting talk power: ", sock -> { + for (ClientEntry c : talkers) { + if (c != next) setTalker(sock, c.id, false); + } + if (next != null) setTalker(sock, next.id, true); + }); + } + + private static void setTalker(LocalTeamspeakClientSocket sock, int clientId, boolean talker) throws Exception { + sock.executeCommand(new SingleCommand("clientedit", ProtocolRole.CLIENT, + new CommandSingleParameter("clid", Integer.toString(clientId)), + new CommandSingleParameter("client_is_talker", talker ? "1" : "0"))).complete(); + } + public void setPhoneticNickname(String phoneticNickname) { updateSelf(self -> self.phoneticNickname = phoneticNickname); selfUpdate(cmd -> cmd.add(new CommandSingleParameter("client_nickname_phonetic", phoneticNickname)), diff --git a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/session/ServerSession.java b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/session/ServerSession.java index 8f3f222..836584d 100644 --- a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/session/ServerSession.java +++ b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/session/ServerSession.java @@ -377,13 +377,18 @@ public final class ServerSession { /** @param message the reason shown to moderators, may be empty */ public void requestTalkPower(String message) { - if (conn.isConnected()) conn.setTalkRequest(true, message); + if (conn.isConnected() && canRequestTalkPower()) conn.setTalkRequest(true, message); } public void cancelTalkRequest() { if (conn.isConnected()) conn.setTalkRequest(false, ""); } + /** Grants talk power to whoever in our channel asked first, after revoking everyone else's when {@code revokeOthers}. */ + public void grantNextTalkPower(boolean revokeOthers) { + if (conn.isConnected()) conn.grantNextTalkPower(revokeOthers); + } + public String phoneticNickname() { ClientEntry self = self(); return self == null ? "" : self.phoneticNickname; @@ -666,6 +671,20 @@ public final class ServerSession { return self != null && !self.avatarFlag.isEmpty(); } + /** + * Whether we may ask for talk power: the server lets us ({@code b_client_request_talker}, offered + * while unknown), and we lack it in our channel, as it refuses the request otherwise. + */ + public boolean canRequestTalkPower() { + ClientEntry self = self(); + return permits("b_client_request_talker") && self != null && conn.getModel().lacksTalkPower(self); + } + + /** Whether the server lets us grant and revoke talk power ({@code b_client_set_flag_talker}); offered while unknown. */ + public boolean canGrantTalkPower() { + return permits("b_client_set_flag_talker"); + } + public boolean canMoveClients() { return hasPower("i_client_move_power"); } diff --git a/ts3-client/core/src/test/java/eu/lixko/ts3j/client/net/ConnectionEventHandlerTest.java b/ts3-client/core/src/test/java/eu/lixko/ts3j/client/net/ConnectionEventHandlerTest.java index cba0eb7..e28bef9 100644 --- a/ts3-client/core/src/test/java/eu/lixko/ts3j/client/net/ConnectionEventHandlerTest.java +++ b/ts3-client/core/src/test/java/eu/lixko/ts3j/client/net/ConnectionEventHandlerTest.java @@ -208,4 +208,35 @@ class ConnectionEventHandlerTest { events.onChannelDeleted(new ChannelDeletedEvent(fields("notifychanneldeleted cid=2"))); assertNull(model.getChannel(2)); } + + @Test + void talkRequestsAndGrantsAsTheServerWordsThem() { + model.putChannel(1, "Lobby", 0, 0); + events.onChannelEdit(new ChannelEditedEvent(fields("notifychanneledited cid=1 reasonid=10 invokerid=2 invokername=admin channel_needed_talk_power=50"))); + join(5, "alice", 1); + ClientEntry alice = model.getClient(5); + assertEquals(50, model.getChannel(1).neededTalkPower); + assertTrue(model.lacksTalkPower(alice)); + + events.onClientChanged(new ClientUpdatedEvent(fields( + "notifyclientupdated clid=5 client_talk_request=1791680640 client_talk_request_msg=let\\sme\\stalk"))); + assertTrue(alice.talkRequest); + assertEquals(1791680640L, alice.talkRequestTime); + assertEquals("let me talk", alice.talkRequestMessage); + assertEquals(alice, model.nextTalkRequest(1)); + + // A grant withdraws the request in the same update. + events.onClientChanged(new ClientUpdatedEvent(fields("notifyclientupdated clid=5 client_talk_request=0" + + " client_talk_request_msg client_is_talker=1 invokerid=2 invokername=admin invokeruid=x"))); + assertFalse(alice.talkRequest); + assertEquals("", alice.talkRequestMessage); + assertTrue(alice.talker); + assertFalse(model.lacksTalkPower(alice)); + assertNull(model.nextTalkRequest(1)); + assertEquals(List.of(alice), model.talkersIn(1)); + + // Leaving the channel drops it, without an invoker. + events.onClientChanged(new ClientUpdatedEvent(fields("notifyclientupdated clid=5 client_is_talker=0"))); + assertFalse(alice.talker); + } } diff --git a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ClientMenu.java b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ClientMenu.java index 8ac0a51..a03c88e 100644 --- a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ClientMenu.java +++ b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ClientMenu.java @@ -66,6 +66,15 @@ final class ClientMenu { menu.add(me); } menu.addSeparator(); + if (actions.canGrantTalkPower() && client.talker) { + JMenuItem revoke = new JMenuItem("Revoke Talk Power", Icons.of("TALK_POWER_REVOKE")); + revoke.addActionListener(a -> actions.setTalker(List.of(client), false)); + menu.add(revoke); + } else if (actions.canGrantTalkPower() && model.lacksTalkPower(client)) { + JMenuItem grant = new JMenuItem("Grant Talk Power", Icons.of("TALK_POWER_GRANT")); + grant.addActionListener(a -> actions.setTalker(List.of(client), true)); + menu.add(grant); + } menu.add(buildServerGroupMenu(client, model, groupIcons, actions)); menu.add(buildChannelGroupMenu(client, model, groupIcons, actions)); menu.addSeparator(); @@ -118,6 +127,18 @@ final class ClientMenu { moveHere.setEnabled(others); moveHere.addActionListener(a -> actions.moveClientsToOwnChannel(clients)); menu.add(moveHere); + if (actions.canGrantTalkPower()) { + menu.addSeparator(); + JMenuItem grant = new JMenuItem("Grant Talk Power", Icons.of("TALK_POWER_GRANT")); + List silent = clients.stream().filter(model::lacksTalkPower).toList(); + grant.setEnabled(!silent.isEmpty()); + grant.addActionListener(a -> actions.setTalker(silent, true)); + menu.add(grant); + JMenuItem revoke = new JMenuItem("Revoke Talk Power", Icons.of("TALK_POWER_REVOKE")); + revoke.setEnabled(clients.stream().anyMatch(c -> c.talker)); + revoke.addActionListener(a -> actions.setTalker(clients.stream().filter(c -> c.talker).toList(), false)); + menu.add(revoke); + } return menu; } diff --git a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/DropIndicatorTree.java b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/DropIndicatorTree.java index ea48caa..c6d8e4d 100644 --- a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/DropIndicatorTree.java +++ b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/DropIndicatorTree.java @@ -22,6 +22,7 @@ import java.awt.Rectangle; import java.awt.RenderingHints; import java.awt.event.MouseAdapter; import java.awt.event.MouseEvent; +import java.util.ArrayList; import java.util.Collections; import java.util.List; import java.util.Set; @@ -316,6 +317,11 @@ final class DropIndicatorTree extends JTree { } } + private static void addIcon(List icons, String key) { + Icon icon = key == null ? null : Icons.of(key); + if (icon != null) icons.add(icon); + } + /** The icon strip a row shows on its right, empty when it has none (yet). */ private List badgesOf(DefaultMutableTreeNode treeNode) { Object node = treeNode.getUserObject(); @@ -325,8 +331,12 @@ final class DropIndicatorTree extends JTree { } if (node instanceof ClientEntry) { ClientEntry cl = (ClientEntry) node; - List icons = groupIcons.iconsOf( - model.serverGroupsOf(cl.serverGroupIds), model.channelGroup(cl.channelGroupId)); + List icons = new ArrayList<>(); + // TeamSpeak's order: talk power ahead of the groups, a talk request after them. + addIcon(icons, cl.talker ? "IS_TALKER" : model.lacksTalkPower(cl) ? "INPUT_MUTED" : null); + icons.addAll(groupIcons.iconsOf( + model.serverGroupsOf(cl.serverGroupIds), model.channelGroup(cl.channelGroupId))); + addIcon(icons, cl.talkRequest ? "TALK_POWER_REQUEST" : null); // The country's flag comes last, at the row's edge, as in TeamSpeak. Icon flag = settings.countryFlags ? CountryFlagIcons.of(cl.country) : null; if (flag != null) icons.add(flag); diff --git a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/HotkeyActions.java b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/HotkeyActions.java index 0065ce8..ff3a8f1 100644 --- a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/HotkeyActions.java +++ b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/HotkeyActions.java @@ -99,6 +99,10 @@ final class HotkeyActions implements HotkeyEngine.Handler { for (ServerTab tab : targets) tab.session().stopRecording(); } + case TALK_POWER_REQUEST -> toggleTalkRequest(targets); + case TALK_POWER_GRANT_NEXT -> grantNextTalkPower(targets, false); + case TALK_POWER_REVOKE_ALL_GRANT_NEXT -> grantNextTalkPower(targets, true); + case FILEBROWSER -> frame.browseCurrentChannel(); case SKIN_RELOAD -> frame.reloadSkin(); case BRING_TO_FRONT -> frame.bringToFront(); @@ -139,6 +143,19 @@ final class HotkeyActions implements HotkeyEngine.Handler { frame.refreshAfterHotkey(); } + /** Asks without a reason, as there is nobody to type one. */ + private void toggleTalkRequest(List targets) { + boolean requested = targets.stream().anyMatch(t -> t.session().isTalkRequested()); + for (ServerTab tab : targets) { + if (requested) tab.session().cancelTalkRequest(); + else tab.session().requestTalkPower(""); + } + } + + private void grantNextTalkPower(List targets, boolean revokeOthers) { + for (ServerTab tab : targets) tab.session().grantNextTalkPower(revokeOthers); + } + private static boolean anyMicMuted(List tabs) { return tabs.stream().anyMatch(t -> t.session().isMicMuted()); } diff --git a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/MainFrame.java b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/MainFrame.java index cefba6e..4a874c2 100644 --- a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/MainFrame.java +++ b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/MainFrame.java @@ -277,6 +277,11 @@ public final class MainFrame extends JFrame implements ServerTabPane.Listener { return selected != null && selected.session().isTalkRequested(); } + @Override + public boolean canRequestTalkPower() { + return selected != null && selected.session().canRequestTalkPower(); + } + @Override public void onRequestTalkPower() { requestTalkPower(); diff --git a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/MainMenuBar.java b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/MainMenuBar.java index f0bf986..f2bb870 100644 --- a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/MainMenuBar.java +++ b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/MainMenuBar.java @@ -57,6 +57,9 @@ final class MainMenuBar extends JMenuBar { /** Whether our talk power request is pending; asked as the Self menu opens. */ boolean isTalkPowerRequested(); + /** Whether the current server lets us ask for talk power; asked as the Self menu opens. */ + boolean canRequestTalkPower(); + /** Requests talk power, or withdraws a pending request. */ void onRequestTalkPower(); @@ -246,7 +249,9 @@ final class MainMenuBar extends JMenuBar { self.addMenuListener(new MenuListener() { @Override public void menuSelected(MenuEvent e) { - showTalkPowerRequested(listener.isTalkPowerRequested()); + boolean requested = listener.isTalkPowerRequested(); + showTalkPowerRequested(requested); + talkPowerItem.setVisible(requested || listener.canRequestTalkPower()); avatarItem.setVisible(!avatarItem.isEnabled() || listener.canSetAvatar()); deleteAvatarItem.setVisible(listener.hasAvatar()); } diff --git a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ServerTabTreeActions.java b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ServerTabTreeActions.java index 1e58e10..f278dd9 100644 --- a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ServerTabTreeActions.java +++ b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ServerTabTreeActions.java @@ -233,6 +233,16 @@ final class ServerTabTreeActions implements ServerTreePanel.Actions { return tab.session().canDeleteOtherAvatars(); } + @Override + public boolean canGrantTalkPower() { + return tab.session().canGrantTalkPower(); + } + + @Override + public void setTalker(List clients, boolean talker) { + conn.setTalker(ids(clients), talker); + } + @Override public void deleteClientAvatar(ClientEntry client) { tab.avatar().deleteOf(client); diff --git a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ServerTreePanel.java b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ServerTreePanel.java index 845ccf9..eccf1dd 100644 --- a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ServerTreePanel.java +++ b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ServerTreePanel.java @@ -130,6 +130,11 @@ public final class ServerTreePanel extends JPanel { /** Whether we may delete other clients' avatars. */ boolean canDeleteOtherAvatars(); + /** Whether we may grant and revoke talk power. */ + boolean canGrantTalkPower(); + + void setTalker(List clients, boolean talker); + void deleteClientAvatar(ClientEntry client); /** A new nickname for ourselves, typed into the tree row. */