diff --git a/ts3-client/AUDIT-STRUCTURE.md b/ts3-client/AUDIT-STRUCTURE.md index f492d32..30e57d4 100644 --- a/ts3-client/AUDIT-STRUCTURE.md +++ b/ts3-client/AUDIT-STRUCTURE.md @@ -8,8 +8,8 @@ Items are worked through in the order below. Status: open, done (commit), or clo | # | Finding | Status | |---|---|---| -| 1 | Request failures reach frontends as strings, so they guess the kind by substring (`BanListDialog`, `ServerLogDialog`) and core needs a sentinel message (`SEARCH_NOT_PERMITTED`); success is signalled by a `null` error, here and in Android's `ServerController` (`String?`) | done: requests return `CompletableFuture`, failing with `RequestException` (kind + message); `Replies`/`Edt` split success and failure; Android uses `Result` | -| 2 | Client properties parsed twice: `ConnectionEventHandler.onClientJoin` sets every field, `onClientChanged` the same ones again; channels already share `applyChannelProperties` | open | +| 1 | Request failures reach frontends as strings, so they guess the kind by substring (`BanListDialog`, `ServerLogDialog`) and core needs a sentinel message (`SEARCH_NOT_PERMITTED`); success is signalled by a `null` error, here and in Android's `ServerController` (`String?`) | done (`0552ed8`): requests return `CompletableFuture`, failing with `RequestException` (kind + message); `Replies`/`Edt` split success and failure; Android uses `Result` | +| 2 | Client properties parsed twice: `ConnectionEventHandler.onClientJoin` sets every field, `onClientChanged` the same ones again; channels already share `applyChannelProperties` | done: one `applyClientProperties`. It also fixed a joining channel commander shown as none, and picks up the description a client enters with | | 3 | What we may do is answered in five places: `ServerSession.can*`, `ServerModel.can*/permits/mayHavePower`, `TeamspeakConnection.canSendOfflineMessages/canTransferFiles`, and raw permission names in Swing dialogs and `ServerController.canCreateBans` | open | | 4 | `TeamspeakConnection` (2,157 lines) still does lifecycle, mic/speaker, recording, chat logs, log/sound text, contacts, avatars, icons, file transfers, myTeamSpeak and job plumbing. The `*Admin` helpers take the whole connection, which forwards ~90 methods to them | open | | 5 | Two front doors: frontends use both `ServerSession` and `session.connection()` with no rule for which | open | 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 2411035..fa5823d 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 @@ -7,6 +7,7 @@ import eu.lixko.ts3j.client.sound.SoundEvent; import eu.lixko.ts3j.client.sound.SoundNotifier; import java.util.Map; +import java.util.Objects; /** * The {@link TS3Listener} side of a connection: keeps {@link ServerModel} in sync with @@ -36,25 +37,7 @@ final class ConnectionEventHandler implements TS3Listener { @Override public void onClientJoin(ClientJoinEvent e) { ClientEntry c = conn.getModel().putClient(e.getClientId(), e.getClientNickname(), e.getClientTargetId()); - c.type = safeInt(e, "client_type"); - c.talkPower = e.getClientTalkPower(); - 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(); - c.inputHardware = e.isClientUsingHardwareInput(); - c.outputHardware = e.isClientUsingHardwareOutput(); - c.away = e.isClientAway(); - c.awayMessage = TeamspeakConnection.orEmpty(e.get("client_away_message")); - c.uniqueId = TeamspeakConnection.orEmpty(e.getUniqueClientIdentifier()); - c.myTeamSpeakId = TeamspeakConnection.orEmpty(e.get("client_myteamspeak_id")); - c.avatarFlag = TeamspeakConnection.orEmpty(e.get("client_flag_avatar")); - c.country = TeamspeakConnection.orEmpty(e.get("client_country")); - c.databaseId = e.getClientDatabaseId(); - c.serverGroupIds = parseIntList(e.getClientServerGroups()); - c.channelGroupId = e.getClientChannelGroupId(); - c.unreadMessages = safeInt(e, "client_unread_messages"); + applyClientProperties(c, e); c.self = (e.getClientId() == conn.getSelfClientId()); // Query clients stay out of sight, as they do in the tree and in TS3's log. if (!c.self && !c.isQuery()) { @@ -315,9 +298,37 @@ final class ConnectionEventHandler implements TS3Listener { public void onClientChanged(ClientUpdatedEvent e) { ClientEntry c = conn.getModel().getClient(e.getClientId()); if (c == null) return; - boolean renamed = has(e, "client_nickname") && !e.get("client_nickname").equals(c.nickname); String oldName = c.nickname; - if (renamed) c.nickname = e.get("client_nickname"); + int unreadBefore = c.unreadMessages; + applyClientProperties(c, e); + boolean renamed = !Objects.equals(c.nickname, oldName); + // The answers to clientgetvariables and to a description request. + if (reported(e, "client_description") || has(e, "client_version") || has(e, "client_platform")) { + conn.ui.onInfoUpdated(); + } + if (reported(e, "client_myteamspeak_id") && !c.self && !c.isQuery()) conn.applyContact(c); + if (has(e, "client_unread_messages") && c.id == conn.getSelfClientId()) conn.unreadMessagesChanged(unreadBefore); + announceClientUpdate(e, c, renamed, oldName); + conn.ui.onModelChanged(); + } + + /** + * The properties a client event carries that the model keeps; each only when present, so + * the full set a client enters with and a partial update share one mapping. + */ + private static void applyClientProperties(ClientEntry c, BaseEvent e) { + if (has(e, "client_nickname")) c.nickname = e.get("client_nickname"); + if (reported(e, "client_nickname_phonetic")) { + c.phoneticNickname = TeamspeakConnection.orEmpty(e.get("client_nickname_phonetic")); + } + if (reported(e, "client_unique_identifier")) { + c.uniqueId = TeamspeakConnection.orEmpty(e.get("client_unique_identifier")); + } + if (reported(e, "client_myteamspeak_id")) c.myTeamSpeakId = TeamspeakConnection.orEmpty(e.get("client_myteamspeak_id")); + if (has(e, "client_database_id")) c.databaseId = safeInt(e, "client_database_id"); + if (has(e, "client_type")) c.type = safeInt(e, "client_type"); + if (has(e, "client_servergroups")) c.serverGroupIds = parseIntList(e.get("client_servergroups")); + if (has(e, "client_channel_group_id")) c.channelGroupId = safeInt(e, "client_channel_group_id"); if (has(e, "client_input_muted")) c.inputMuted = e.getBoolean("client_input_muted"); if (has(e, "client_output_muted")) c.outputMuted = e.getBoolean("client_output_muted"); if (has(e, "client_input_hardware")) c.inputHardware = e.getBoolean("client_input_hardware"); @@ -330,41 +341,22 @@ final class ConnectionEventHandler implements TS3Listener { } else if (reported(e, "client_away_message")) { 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_power")) c.talkPower = safeInt(e, "client_talk_power"); 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")); - } - if (reported(e, "client_description")) { - c.description = TeamspeakConnection.orEmpty(e.get("client_description")); - conn.ui.onInfoUpdated(); - } - // The answer to clientgetvariables. - if (has(e, "client_version") || has(e, "client_platform")) { - if (has(e, "client_version")) c.version = e.get("client_version"); - if (has(e, "client_platform")) c.platform = e.get("client_platform"); - conn.ui.onInfoUpdated(); - } - if (has(e, "client_month_bytes_downloaded")) - c.monthBytesDownloaded = TeamspeakConnection.safeLong(e, "client_month_bytes_downloaded"); - if (has(e, "client_month_bytes_uploaded")) - c.monthBytesUploaded = TeamspeakConnection.safeLong(e, "client_month_bytes_uploaded"); - if (has(e, "client_is_channel_commander")) - c.channelCommander = e.getBoolean("client_is_channel_commander"); + if (has(e, "client_is_channel_commander")) c.channelCommander = e.getBoolean("client_is_channel_commander"); + if (reported(e, "client_description")) c.description = TeamspeakConnection.orEmpty(e.get("client_description")); + if (has(e, "client_version")) c.version = e.get("client_version"); + if (has(e, "client_platform")) c.platform = e.get("client_platform"); if (reported(e, "client_flag_avatar")) c.avatarFlag = TeamspeakConnection.orEmpty(e.get("client_flag_avatar")); if (reported(e, "client_country")) c.country = TeamspeakConnection.orEmpty(e.get("client_country")); - if (reported(e, "client_myteamspeak_id")) { - c.myTeamSpeakId = TeamspeakConnection.orEmpty(e.get("client_myteamspeak_id")); - if (!c.self && !c.isQuery()) conn.applyContact(c); + if (has(e, "client_month_bytes_downloaded")) { + c.monthBytesDownloaded = TeamspeakConnection.safeLong(e, "client_month_bytes_downloaded"); } - if (has(e, "client_unread_messages")) { - int before = c.unreadMessages; - c.unreadMessages = safeInt(e, "client_unread_messages"); - if (c.id == conn.getSelfClientId()) conn.unreadMessagesChanged(before); + if (has(e, "client_month_bytes_uploaded")) { + c.monthBytesUploaded = TeamspeakConnection.safeLong(e, "client_month_bytes_uploaded"); } - announceClientUpdate(e, c, renamed, oldName); - conn.ui.onModelChanged(); + if (has(e, "client_unread_messages")) c.unreadMessages = safeInt(e, "client_unread_messages"); } /** Renames, talk-power changes and recording flags all arrive as a client update. */ 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 e28bef9..73fed2c 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 @@ -115,6 +115,18 @@ class ConnectionEventHandlerTest { assertEquals(1, modelChanges); } + @Test + void aJoiningCommanderIsShownAsOne() { + model.putChannel(1, "Lobby", 0, 0); + events.onClientJoin(new ClientJoinEvent(fields("notifycliententerview cfid=0 ctid=1 reasonid=0 clid=6" + + " client_unique_identifier=uid6== client_nickname=bob client_is_channel_commander=1" + + " client_description=hello"))); + + ClientEntry bob = model.getClient(6); + assertTrue(bob.channelCommander); + assertEquals("hello", bob.description); + } + @Test void movesAndLeaves() { model.putChannel(1, "Lobby", 0, 0);