diff --git a/ts3-client/README.md b/ts3-client/README.md index 32cd2be..063b838 100644 --- a/ts3-client/README.md +++ b/ts3-client/README.md @@ -49,7 +49,8 @@ Android app in [`../android`](../android) does. has learned carries over between talk bursts. - **Playback mixing** — each speaker gets their own Opus decoder and audio line (a stream of their own in the PipeWire mixer), so one slow decode never blocks the others. -- **Whisper receive** — targeted voice is decoded and played like normal voice. +- **Whisper receive** — targeted voice is decoded and played like normal voice; + **Block Incoming Whispers** (toolbar button or hotkey) mutes all of it per server. - Per-client **mute**, master **deafen**, adjustable mic gain / playback volume. - **On-the-fly Opus tuning** — bitrate, complexity, VBR, FEC and voice/music codec can all be changed live from the options dialog and take effect on the running @@ -126,8 +127,12 @@ Android app in [`../android`](../android) does. - Change your nickname, mute/deafen from the toolbar. - **Customize Toolbar** (right-click the toolbar), as in TeamSpeak 3: pick, order and separate the buttons from ~70 actions (connection, self, dialogs, permissions, - recording, and channel/client actions on the tree's selection); search, drag and drop, - Reset to Defaults. + recording, channel/client actions on the tree's selection, server); search, drag and + drop, Reset to Defaults. The same menu hides the server tab strip. +- **Server Connection Info** (server's context menu or toolbar), as in TeamSpeak 3: the + server's version, uptime, ping, loss and In/Out traffic, live. +- **ServerQuery clients** are hidden in the tree unless toggled on (toolbar, or "Show + ServerQuery clients" in the bookmark), remembered per bookmarked server. ### Hotkeys - **Global hotkeys**, as in TeamSpeak 3: single keys or combinations (any key can act diff --git a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/config/Bookmark.java b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/config/Bookmark.java index f84fbcc..c4a20c2 100644 --- a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/config/Bookmark.java +++ b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/config/Bookmark.java @@ -28,6 +28,8 @@ public final class Bookmark { public boolean myTeamSpeakFeatures = true; /** Offer whispering in this server's menus. */ public boolean showWhisperControls = false; + /** List the server's ServerQuery clients in the tree. */ + public boolean showQueryClients = false; /** The server's icon as last seen there, 0 for none or not yet known. */ public long iconId = 0; @@ -52,6 +54,7 @@ public final class Bookmark { b.connectOnStartup = connectOnStartup; b.myTeamSpeakFeatures = myTeamSpeakFeatures; b.showWhisperControls = showWhisperControls; + b.showQueryClients = showQueryClients; b.iconId = iconId; return b; } diff --git a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/config/Bookmarks.java b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/config/Bookmarks.java index 2d85d0b..c1a9ed5 100644 --- a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/config/Bookmarks.java +++ b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/config/Bookmarks.java @@ -47,6 +47,31 @@ public final class Bookmarks { return changed; } + /** Whether a bookmark leading to the server lists its ServerQuery clients. */ + public boolean showsQueryClients(String address, int port) { + for (Bookmark b : entries) { + if (b.pointsAt(address, port) && b.showQueryClients) return true; + } + return false; + } + + /** + * Has every bookmark leading to the server list its ServerQuery clients, or not. + * + * @return whether any bookmark changed, and so needs saving + */ + public boolean rememberQueryClients(String address, int port, boolean show) { + if (address == null || address.isBlank()) return false; + boolean changed = false; + for (Bookmark b : entries) { + if (b.pointsAt(address, port) && b.showQueryClients != show) { + b.showQueryClients = show; + changed = true; + } + } + return changed; + } + /** The bookmark with this {@link Bookmark#id}, or null. */ public Bookmark find(String id) { for (Bookmark b : entries) { @@ -90,6 +115,7 @@ public final class Bookmarks { bm.connectOnStartup = Boolean.parseBoolean(p.getProperty(prefix + "connectOnStartup", "false")); bm.myTeamSpeakFeatures = Boolean.parseBoolean(p.getProperty(prefix + "myTeamSpeakFeatures", "true")); bm.showWhisperControls = Boolean.parseBoolean(p.getProperty(prefix + "showWhisperControls", "false")); + bm.showQueryClients = Boolean.parseBoolean(p.getProperty(prefix + "showQueryClients", "false")); bm.iconId = parseLong(p.getProperty(prefix + "iconId")); if (bm.address != null && !bm.address.isBlank()) b.entries.add(bm); } @@ -114,6 +140,7 @@ public final class Bookmarks { p.setProperty(prefix + "connectOnStartup", Boolean.toString(bm.connectOnStartup)); p.setProperty(prefix + "myTeamSpeakFeatures", Boolean.toString(bm.myTeamSpeakFeatures)); p.setProperty(prefix + "showWhisperControls", Boolean.toString(bm.showWhisperControls)); + p.setProperty(prefix + "showQueryClients", Boolean.toString(bm.showQueryClients)); p.setProperty(prefix + "iconId", Long.toString(bm.iconId)); } try { diff --git a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/config/Settings.java b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/config/Settings.java index f96b7a9..e12248e 100644 --- a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/config/Settings.java +++ b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/config/Settings.java @@ -218,6 +218,8 @@ public final class Settings { // ---- window chrome ---- /** Whether the status bar at the bottom of the window is shown. */ public final Setting showStatusBar = flag("showStatusBar", true); + /** The strip of server tabs while more than one server is open; hidden, only the one on screen shows. */ + public final Setting showServerTabs = flag("showServerTabs", true); /** The main toolbar's buttons in order, comma-separated action ids with "-" for a separator; empty for the default set. */ public final Setting toolbarLayout = text("toolbarLayout", ""); /** Whether the Master Volume slider is shown on the toolbar. */ 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 0d8b339..4b27031 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 @@ -145,11 +145,11 @@ public enum HotkeyAction { WHISPER_REPLY_DEACTIVATE(Category.SELF, 0x0180, "DeactivateReply", "Deactivate Reply to a Whisper", true, Argument.NONE, false), WHISPER_BLOCK_ACTIVATE(Category.SELF, 0x0180, "ActivateBlock", - "Activate Block Incoming Whispers", true, Argument.NONE, false), + "Activate Block Incoming Whispers", true, Argument.NONE, true), WHISPER_BLOCK_DEACTIVATE(Category.SELF, 0x0180, "DeactivateBlock", - "Deactivate Block Incoming Whispers", true, Argument.NONE, false), + "Deactivate Block Incoming Whispers", true, Argument.NONE, true), WHISPER_BLOCK_TOGGLE(Category.SELF, 0x0180, "ToggleBlock", - "Toggle Block Incoming Whispers", true, Argument.NONE, false), + "Toggle Block Incoming Whispers", true, Argument.NONE, true), RECORDING_START(Category.SELF, 0x01c0, "Activate", "Start Recording", true, Argument.NONE, false), 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 eb01d72..1b95608 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 @@ -691,6 +691,7 @@ final class ConnectionEventHandler implements TS3Listener { else if ("notifytokenadd".equals(e.getCommand())) conn.privilegeKeys.onAdded(e); else if ("notifycomplainlist".equals(e.getCommand())) conn.complaints.onListEntry(e); else if ("notifyserverlog".equals(e.getCommand())) conn.serverLog.onLine(e); + else if ("notifyserverconnectioninfo".equals(e.getCommand())) conn.serverStats.onReport(e); else conn.offlineMessages.onReply(e); } diff --git a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ConnectionStatsFormat.java b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ConnectionStatsFormat.java index 1d6238b..678c084 100644 --- a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ConnectionStatsFormat.java +++ b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ConnectionStatsFormat.java @@ -4,8 +4,13 @@ import eu.lixko.ts3j.client.audio.VoiceReceiveStats; import eu.lixko.ts3j.client.text.ByteSize; import java.text.DecimalFormat; +import java.time.Instant; +import java.time.ZoneId; +import java.time.format.DateTimeFormatter; import java.util.ArrayList; import java.util.List; +import java.util.regex.Matcher; +import java.util.regex.Pattern; /** * Renders {@link ConnectionStats} the way the official Connection Info window does: a @@ -43,6 +48,12 @@ public final class ConnectionStatsFormat { new Tab("Keep Alive", ConnectionStats.Kind.KEEPALIVE), new Tab("Control", ConnectionStats.Kind.CONTROL)); + /** The server window's traffic table headings. */ + public static final List SERVER_COLUMNS = List.of("In", "Out"); + + private static final Pattern BUILD = Pattern.compile("^(.*?)\\s*\\[Build: (\\d+)]\\s*$"); + private static final DateTimeFormatter BUILD_DATE = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"); + public static final String QUOTA_TAB = "Quota"; public static final String VOICE_TAB = "Voice received"; @@ -112,6 +123,50 @@ public final class ConnectionStatsFormat { new Row("Remaining " + direction + " this month:", remaining)); } + /** The server window's facts; {@code s} is {@link ServerStats#UNKNOWN} while loading. */ + public static List serverSummaryRows(ServerModel model, String address, ServerStats s) { + return List.of( + new Row("Name", model.getServerName()), + new Row("Version", versionWithBuildDate(model.serverProperty("virtualserver_version"))), + new Row("Platform", orUnknown(model.serverProperty("virtualserver_platform"))), + new Row("Uptime", uptime(s.uptimeSeconds())), + new Row("Address", address), + new Row("Average ping", s.pingMs() < 0 ? UNKNOWN : Math.round(s.pingMs()) + " ms"), + new Row("Average packetloss", loss(s.packetLoss()))); + } + + /** The server window's table, under {@link #SERVER_COLUMNS}; {@code total} is left empty. */ + public static List serverTrafficRows(ServerStats s) { + return List.of( + new TrafficRow("Packets transferred", "", count(s.packetsIn()), count(s.packetsOut())), + new TrafficRow("Bytes transferred", "", ByteSize.format(s.bytesIn()), ByteSize.format(s.bytesOut())), + new TrafficRow("Bandwidth last second", "", + ByteSize.rate(s.bandwidthInLastSecond()), ByteSize.rate(s.bandwidthOutLastSecond())), + new TrafficRow("Bandwidth last minute", "", + ByteSize.rate(s.bandwidthInLastMinute()), ByteSize.rate(s.bandwidthOutLastMinute())), + new TrafficRow("File transfer bandwidth", "", + ByteSize.rate(s.fileTransferBandwidthIn()), ByteSize.rate(s.fileTransferBandwidthOut())), + new TrafficRow("File transfer bytes transferred", "", + ByteSize.format(s.fileTransferBytesIn()), ByteSize.format(s.fileTransferBytesOut()))); + } + + /** {@code 3.13.7 [Build: 1655727713]} as {@code 3.13.7 (2022-06-20 12:21:53)}, the build being its time. */ + public static String versionWithBuildDate(String version) { + if (version == null || version.isBlank()) return UNKNOWN; + Matcher m = BUILD.matcher(version); + if (!m.matches()) return version; + try { + Instant built = Instant.ofEpochSecond(Long.parseLong(m.group(2))); + return m.group(1) + " (" + BUILD_DATE.format(built.atZone(ZoneId.systemDefault())) + ")"; + } catch (RuntimeException e) { + return version; + } + } + + private static String orUnknown(String value) { + return value == null || value.isBlank() ? UNKNOWN : value; + } + /** The voice our playback received; every value is a dash when nothing was heard. */ public static List voiceRows(VoiceReceiveStats v) { VoiceReceiveStats s = v == null ? VoiceReceiveStats.NONE : v; @@ -158,6 +213,15 @@ public final class ConnectionStatsFormat { return count(n) + " (" + new DecimalFormat("0.0").format(100.0 * n / of) + " %)"; } + /** {@code 0 hours 3 minutes 55 seconds}, with days in front from a day on. */ + public static String uptime(long seconds) { + if (seconds < 0) return UNKNOWN; + long days = seconds / 86400; + String rest = (seconds % 86400) / 3600 + " hours " + (seconds % 3600) / 60 + " minutes " + + seconds % 60 + " seconds"; + return days > 0 ? days + " days " + rest : rest; + } + /** {@code 04:34}, or {@code 15:35:17} from an hour on. */ public static String duration(long ms) { if (ms < 0) return UNKNOWN; diff --git a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/Permissions.java b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/Permissions.java index 3283c2b..4ee1278 100644 --- a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/Permissions.java +++ b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/Permissions.java @@ -157,6 +157,10 @@ public final class Permissions { return permits("b_virtualserver_log_view"); } + public boolean canViewServerConnectionInfo() { + return permits("b_virtualserver_connectioninfo_view"); + } + public boolean canListPrivilegeKeys() { return permits("b_virtualserver_token_list"); } 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 ee92dfc..f768428 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 @@ -31,6 +31,8 @@ public final class ServerModel { private int defaultChannelGroupId; /** The channel new clients land in, and kicked ones go back to; 0 until the server names it. */ private int defaultChannelId; + /** Whether {@link #buildTree} lists ServerQuery clients; a view setting, so kept by {@link #clear}. */ + private boolean showQueryClients; public synchronized void clear() { channels.clear(); @@ -458,7 +460,7 @@ public final class ServerModel { } } for (ClientEntry cl : clients.values()) { - if (cl.isQuery()) continue; // hide server-query clients from the tree + if (cl.isQuery() && !showQueryClients) continue; if (channels.containsKey(cl.channelId)) { inside.computeIfAbsent(cl.channelId, id -> new ArrayList<>()).add(cl); } @@ -507,6 +509,14 @@ public final class ServerModel { siblings.addAll(ordered); } + public synchronized boolean showsQueryClients() { + return showQueryClients; + } + + public synchronized void setShowQueryClients(boolean show) { + showQueryClients = show; + } + public synchronized int channelCount() { return channels.size(); } diff --git a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ServerStats.java b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ServerStats.java new file mode 100644 index 0000000..70cada3 --- /dev/null +++ b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ServerStats.java @@ -0,0 +1,60 @@ +package eu.lixko.ts3j.client.net; + +import java.util.Map; + +/** + * The virtual server's connection figures, from {@code notifyserverconnectioninfo}: everything + * it exchanged with all its clients. Seen from the server, as the official window shows them: + * in is what it received, out what it sent. Unreported values are {@code -1}. + * + * @param packetLoss a fraction 0..1 + */ +public record ServerStats(long uptimeSeconds, double pingMs, double packetLoss, + long packetsIn, long packetsOut, long bytesIn, long bytesOut, + long bandwidthInLastSecond, long bandwidthOutLastSecond, + long bandwidthInLastMinute, long bandwidthOutLastMinute, + long fileTransferBandwidthIn, long fileTransferBandwidthOut, + long fileTransferBytesIn, long fileTransferBytesOut) { + + /** Nothing known yet. */ + public static final ServerStats UNKNOWN = parse(Map.of()); + + static ServerStats parse(Map m) { + return new ServerStats( + number(m, "connection_connected_time"), + decimal(m, "connection_ping"), + decimal(m, "connection_packetloss_total"), + number(m, "connection_packets_received_total"), + number(m, "connection_packets_sent_total"), + number(m, "connection_bytes_received_total"), + number(m, "connection_bytes_sent_total"), + number(m, "connection_bandwidth_received_last_second_total"), + number(m, "connection_bandwidth_sent_last_second_total"), + number(m, "connection_bandwidth_received_last_minute_total"), + number(m, "connection_bandwidth_sent_last_minute_total"), + number(m, "connection_filetransfer_bandwidth_received"), + number(m, "connection_filetransfer_bandwidth_sent"), + number(m, "connection_filetransfer_bytes_received_total"), + number(m, "connection_filetransfer_bytes_sent_total")); + } + + private static long number(Map m, String key) { + String v = m.get(key); + if (v == null) return -1; + try { + return Long.parseLong(v.trim()); + } catch (NumberFormatException e) { + return -1; + } + } + + private static double decimal(Map m, String key) { + String v = m.get(key); + if (v == null) return -1; + try { + return Double.parseDouble(v.trim()); + } catch (NumberFormatException e) { + return -1; + } + } +} diff --git a/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ServerStatsAdmin.java b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ServerStatsAdmin.java new file mode 100644 index 0000000..1affd55 --- /dev/null +++ b/ts3-client/core/src/main/java/eu/lixko/ts3j/client/net/ServerStatsAdmin.java @@ -0,0 +1,41 @@ +package eu.lixko.ts3j.client.net; + +import com.github.manevolent.ts3j.command.SingleCommand; +import com.github.manevolent.ts3j.event.UnknownTeamspeakEvent; +import com.github.manevolent.ts3j.protocol.ProtocolRole; + +import java.util.concurrent.CompletableFuture; + +/** + * Asks for the virtual server's connection figures with {@code serverrequestconnectioninfo}, + * which the server answers with a {@code notifyserverconnectioninfo} ahead of the command's + * result. Needs {@code b_virtualserver_connectioninfo_view}. + * + *

Requests run in the background and fail with a {@link RequestException}. + */ +public final class ServerStatsAdmin { + + private final Uplink uplink; + private volatile ServerStats latest; + + ServerStatsAdmin(Uplink uplink) { + this.uplink = uplink; + } + + public CompletableFuture read() { + return uplink.request(() -> { + synchronized (this) { + latest = null; + uplink.socket().executeCommand(new SingleCommand("serverrequestconnectioninfo", ProtocolRole.CLIENT)) + .complete(); + uplink.awaitEventsProcessed(); + ServerStats stats = latest; + return stats == null ? ServerStats.UNKNOWN : stats; + } + }); + } + + void onReport(UnknownTeamspeakEvent e) { + latest = ServerStats.parse(e.getMap()); + } +} 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 6e00fb8..5367e31 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 @@ -82,6 +82,7 @@ public final class TeamspeakConnection { final PrivilegeKeyAdmin privilegeKeys = new PrivilegeKeyAdmin(uplink); final ComplaintAdmin complaints; final ServerLogAdmin serverLog = new ServerLogAdmin(uplink); + final ServerStatsAdmin serverStats = new ServerStatsAdmin(uplink); final OfflineMessageAdmin offlineMessages; private final AvatarAdmin avatarAdmin; /** Ourselves: devices and status flags; package-private for {@link ConnectionEventHandler}. */ @@ -94,6 +95,8 @@ public final class TeamspeakConnection { */ /** The client whose whisper we heard last, to reply to; 0 for none yet. */ private volatile int lastWhisperer; + /** Whether incoming whispers go unheard, whoever sends them; kept across reconnects. */ + private volatile boolean whispersBlocked; private volatile LocalIdentity identity; /** * The connect in progress. A disconnect clears it and a newer connect replaces it, which @@ -282,7 +285,7 @@ public final class TeamspeakConnection { client.addListener(events); client.setVoiceHandler(playback::handleVoice); client.setWhisperHandler(whisper -> { - if (!contacts.isWhisperAllowed(whisper.getClientId())) return; + if (whispersBlocked || !contacts.isWhisperAllowed(whisper.getClientId())) return; lastWhisperer = whisper.getClientId(); playback.handleWhisper(whisper); }); @@ -643,6 +646,10 @@ public final class TeamspeakConnection { return serverLog; } + public ServerStatsAdmin serverStats() { + return serverStats; + } + /** Our offline message inbox, sending offline messages and finding their recipients. */ public OfflineMessageAdmin offlineMessages() { return offlineMessages; @@ -745,6 +752,14 @@ public final class TeamspeakConnection { sock.setWhisperTarget(target); } + public boolean areWhispersBlocked() { + return whispersBlocked; + } + + public void setWhispersBlocked(boolean blocked) { + whispersBlocked = blocked; + } + /** The client who whispered to us last, if still on the server. */ public ClientEntry lastWhisperer() { int id = lastWhisperer; 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 de79f2b..141c5a4 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 @@ -38,6 +38,7 @@ import eu.lixko.ts3j.client.net.PrivilegeKeyAdmin; import eu.lixko.ts3j.client.net.Recording; import eu.lixko.ts3j.client.net.Replies; import eu.lixko.ts3j.client.net.ServerLogAdmin; +import eu.lixko.ts3j.client.net.ServerStatsAdmin; import eu.lixko.ts3j.client.net.TeamspeakConnection; import eu.lixko.ts3j.client.net.Whisper; import eu.lixko.ts3j.client.recording.VoiceRecorder; @@ -198,6 +199,16 @@ public final class ServerSession { return conn.getModel(); } + public boolean showsQueryClients() { + return conn.getModel().showsQueryClients(); + } + + /** Lists the server's ServerQuery clients in the tree too, or hides them again. */ + public void setShowQueryClients(boolean show) { + conn.getModel().setShowQueryClients(show); + listener.onModelChanged(); + } + /** Our client id on the server, or -1 while not connected. */ public int selfClientId() { return conn.getSelfClientId(); @@ -590,6 +601,16 @@ public final class ServerSession { return whisper != null && targets != null && targets.isEmpty(); } + /** Whether incoming whispers are blocked here, whatever the contacts allow. */ + public boolean areWhispersBlocked() { + return conn.areWhispersBlocked(); + } + + public void setWhispersBlocked(boolean blocked) { + conn.setWhispersBlocked(blocked); + listener.onSessionChanged(); + } + /** The client who whispered to us last, to whisper back to; null when none is on. */ public ClientEntry lastWhisperer() { return conn.isConnected() ? conn.lastWhisperer() : null; @@ -850,6 +871,10 @@ public final class ServerSession { return conn.serverLog(); } + public ServerStatsAdmin serverStats() { + return conn.serverStats(); + } + public OfflineMessageAdmin offlineMessages() { return conn.offlineMessages(); } diff --git a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/MainCommands.java b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/MainCommands.java index 5ea2047..875e04f 100644 --- a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/MainCommands.java +++ b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/MainCommands.java @@ -271,6 +271,14 @@ public final class MainCommands { forEach(targets, s -> s.setCommander(commander)); } + void toggleWhispersBlocked() { + setWhispersBlocked(currentConnected(), !connectedTab().map(t -> t.session().areWhispersBlocked()).orElse(false)); + } + + public void setWhispersBlocked(List targets, boolean blocked) { + forEach(targets, s -> s.setWhispersBlocked(blocked)); + } + /** Asks for a new nickname, used on every server. */ public void changeNickname() { String nickname = JOptionPane.showInputDialog(frame, "New nickname:", settings.nickname.get()); @@ -374,6 +382,14 @@ public final class MainCommands { onTab(ServerTab::showServerLog); } + void showServerConnectionInfo() { + onTab(ServerTab::showServerConnectionInfo); + } + + void toggleQueryClients() { + connectedTab().ifPresent(tab -> frame.setShowQueryClients(tab, !tab.session().showsQueryClients())); + } + void showPrivilegeKeys() { onTab(ServerTab::showPrivilegeKeys); } 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 d81f49f..f1eb3c4 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 @@ -177,6 +177,8 @@ public final class MainFrame extends JFrame implements ServerTabPane.Listener { // Switching the icon pack in the options dialog re-decorates the whole window. IconTheme.get().addListener(() -> SwingUtilities.invokeLater(this::rebuildIcons)); add(tabPane, BorderLayout.CENTER); + tabPane.setStripShown(settings.showServerTabs.get()); + settings.showServerTabs.addListener(tabPane::setStripShown); // The tree and the chat each claim Ctrl+F for themselves while they have the focus; // from anywhere else it searches the chat. getRootPane().getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW) @@ -357,9 +359,16 @@ public final class MainFrame extends JFrame implements ServerTabPane.Listener { public void tabConnected(ServerTab tab) { if (!tabs.contains(tab)) return; sessions.connected(tab.session()); + tab.session().setShowQueryClients(bookmarks.showsQueryClients(tab.session().address(), tab.session().port())); tabUpdated(tab); } + /** Lists the ServerQuery clients on {@code tab}, or hides them, from now on whenever it is bookmarked. */ + void setShowQueryClients(ServerTab tab, boolean show) { + tab.session().setShowQueryClients(show); + if (bookmarks.rememberQueryClients(tab.session().address(), tab.session().port(), show)) bookmarks.save(); + } + public void tabDisconnected(ServerTab tab) { if (!tabs.contains(tab)) return; sessions.disconnected(tab.session()); diff --git a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/MainToolbar.java b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/MainToolbar.java index 3bfc376..57698c7 100644 --- a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/MainToolbar.java +++ b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/MainToolbar.java @@ -122,6 +122,13 @@ final class MainToolbar extends JToolBar { private JPopupMenu buildContextMenu() { JPopupMenu menu = new JPopupMenu(); + JCheckBoxMenuItem tabsItem = new JCheckBoxMenuItem("Show Server Tabs", settings.showServerTabs.get()); + tabsItem.addActionListener(e -> { + settings.showServerTabs.set(tabsItem.isSelected()); + settings.save(); + }); + settings.showServerTabs.addListener(tabsItem::setSelected); + JCheckBoxMenuItem statusBarItem = new JCheckBoxMenuItem("Show Status Bar", settings.showStatusBar.get()); statusBarItem.addActionListener(e -> { settings.showStatusBar.set(statusBarItem.isSelected()); @@ -144,6 +151,7 @@ final class MainToolbar extends JToolBar { JMenuItem customize = new JMenuItem("Customize Toolbar…"); customize.addActionListener(e -> CustomizeToolbarDialog.show(this, settings, actions)); + menu.add(tabsItem); menu.add(statusBarItem); menu.add(volumeItem); menu.addSeparator(); diff --git a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ServerTabPane.java b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ServerTabPane.java index 397f7a4..027cd8f 100644 --- a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ServerTabPane.java +++ b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ServerTabPane.java @@ -27,7 +27,7 @@ import java.util.List; * Container for the open server connections. With a single connection the * server view fills the window as it always did; from the second connection on * the views move into a {@link JTabbedPane} whose tab strip sits directly under - * the toolbar. + * the toolbar. With the strip turned off, the selected view fills the window alone. */ final class ServerTabPane extends JPanel { @@ -42,8 +42,11 @@ final class ServerTabPane extends JPanel { private final List tabs = new ArrayList<>(); private final TabDragReorder dragReorder = new TabDragReorder(tabbed, this::moveTab); - /** True while the tab strip is in use, i.e. more than one connection is open. */ + /** True while the tab strip is in use, i.e. more than one connection is open and it is wanted. */ private boolean tabbedMode; + private boolean stripShown = true; + /** The tab on screen; the one shown alone while there is no strip. */ + private ServerTab selected; /** Suppresses selection callbacks while we rearrange the pane ourselves. */ private boolean updating; /** Remembered so a drag-reorder can rebuild the tab labels without the caller's help. */ @@ -114,12 +117,29 @@ final class ServerTabPane extends JPanel { void removeTab(ServerTab tab) { tabs.remove(tab); + if (selected == tab) selected = null; relayout(); } + /** Shows or hides the tab strip; without it, tabs are switched by hotkeys or the menus. */ + void setStripShown(boolean shown) { + if (stripShown == shown) return; + stripShown = shown; + relayout(); + if (tabbedMode && selected != null) setSelected(selected); + refresh(lastMicTab); + } + void setSelected(ServerTab tab) { int i = tabs.indexOf(tab); - if (!tabbedMode || i < 0 || tabbed.getSelectedIndex() == i) return; + if (i < 0) return; + ServerTab previous = selected; + selected = tab; + if (!tabbedMode) { + if (previous != tab) relayout(); + return; + } + if (tabbed.getSelectedIndex() == i) return; updating = true; try { tabbed.setSelectedIndex(i); @@ -145,7 +165,7 @@ final class ServerTabPane extends JPanel { * keeping whatever is currently selected on screen. */ private void relayout() { - boolean wantTabs = tabs.size() > 1; + boolean wantTabs = stripShown && tabs.size() > 1; updating = true; try { removeAll(); @@ -154,7 +174,7 @@ final class ServerTabPane extends JPanel { for (ServerTab tab : tabs) tabbed.addTab(tab.session().title(), tab.component()); add(tabbed, BorderLayout.CENTER); } else if (!tabs.isEmpty()) { - add(tabs.get(0).component(), BorderLayout.CENTER); + add((selected != null ? selected : tabs.get(0)).component(), BorderLayout.CENTER); } tabbedMode = wantTabs; } finally { diff --git a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ToolbarAction.java b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ToolbarAction.java index c005451..21041aa 100644 --- a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ToolbarAction.java +++ b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ToolbarAction.java @@ -30,6 +30,7 @@ final class ToolbarAction { RECORDING("Recording"), CHANNEL("Channel"), CLIENT("Client"), + SERVER("Server"), MISC("Misc"); final String label; diff --git a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ToolbarActions.java b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ToolbarActions.java index b1fbc80..9362098 100644 --- a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ToolbarActions.java +++ b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/ToolbarActions.java @@ -44,6 +44,7 @@ final class ToolbarActions { addRecording(); addChannel(); addClient(); + addServer(); addMisc(); } @@ -112,6 +113,10 @@ final class ToolbarActions { .enabledWhen(() -> is(ServerSession::hasAvatar)); add("giantPtt", Category.SELF, "Giant PTT", commands::showGiantPtt, "CAPTURE"); add("soundboard", Category.SELF, "Soundboard", commands::showSoundboard, "SOUNDPACK", "MUSIC"); + add("blockWhispers", Category.SELF, "Toggle Block Incoming Whispers", commands::toggleWhispersBlocked, + "TOGGLE_BLOCK_INCOMING_WHISPERS") + .toggle(() -> is(ServerSession::areWhispersBlocked)) + .enabledWhen(this::connected); } private void addDialogs() { @@ -257,6 +262,16 @@ final class ToolbarActions { .enabledWhen(() -> anyClient().isPresent()); } + private void addServer() { + add("serverConnectionInfo", Category.SERVER, "Server Connection Info", commands::showServerConnectionInfo, + "SERVER_GREEN") + .enabledWhen(() -> permitted(Permissions::canViewServerConnectionInfo)); + add("toggleQueryClients", Category.SERVER, "Toggle ServerQuery Clients", commands::toggleQueryClients, + "TOGGLE_SERVER_QUERY_CLIENTS", "SERVER_QUERY") + .toggle(() -> is(ServerSession::showsQueryClients)) + .enabledWhen(this::connected); + } + private void addMisc() { add("collapseAll", Category.MISC, "Collapse All", () -> collapseAll(true), "CHANNEL_COLLAPSE_ALL") .enabledWhen(this::connected); diff --git a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/hotkey/HotkeyActions.java b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/hotkey/HotkeyActions.java index 9e9a80f..9309db6 100644 --- a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/hotkey/HotkeyActions.java +++ b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/hotkey/HotkeyActions.java @@ -100,6 +100,11 @@ public final class HotkeyActions implements HotkeyEngine.Handler { else commands.changeNickname(hotkey.argument); } + case WHISPER_BLOCK_ACTIVATE -> commands.setWhispersBlocked(targets, true); + case WHISPER_BLOCK_DEACTIVATE -> commands.setWhispersBlocked(targets, false); + case WHISPER_BLOCK_TOGGLE -> + commands.setWhispersBlocked(targets, !any(targets, ServerSession::areWhispersBlocked)); + case RECORDING_START -> commands.startRecording(targets, false); case RECORDING_START_MULTITRACK -> commands.startRecording(targets, true); case RECORDING_STOP -> commands.stopRecording(targets); diff --git a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/manage/BookmarksDialog.java b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/manage/BookmarksDialog.java index 30625aa..08b30f4 100644 --- a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/manage/BookmarksDialog.java +++ b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/manage/BookmarksDialog.java @@ -69,6 +69,7 @@ public final class BookmarksDialog extends JDialog { private final JPasswordField channelPassword = new JPasswordField(); private final JCheckBox connectOnStartup = new JCheckBox("Connect on startup"); private final JCheckBox myTeamSpeakFeatures = new JCheckBox("Enable myTeamSpeak features"); + private final JCheckBox showQueryClients = new JCheckBox("Show ServerQuery clients"); private final IdentityChooser identity; private final JPanel details; @@ -145,6 +146,12 @@ public final class BookmarksDialog extends JDialog { connectOnStartup.setToolTipText("Connect to this server automatically when the client starts. " + "Several bookmarks may be flagged; each opens its own tab."); + // Takes effect at once on the server, when we are on it, as the toolbar's toggle would. + showQueryClients.addActionListener(e -> { + ServerSession on = sessionHere(); + if (on != null) on.setShowQueryClients(showQueryClients.isSelected()); + }); + thisChannel.setToolTipText("This channel"); if (thisChannel.getIcon() == null) thisChannel.setText("This channel"); thisChannel.addActionListener(e -> { @@ -168,6 +175,7 @@ public final class BookmarksDialog extends JDialog { addRow(panel, row++, "Identity:", identity); addRow(panel, row++, "", connectOnStartup); addRow(panel, row++, "", myTeamSpeakFeatures); + addRow(panel, row++, "", showQueryClients); GridBagConstraints filler = new GridBagConstraints(); filler.gridx = 0; @@ -235,6 +243,7 @@ public final class BookmarksDialog extends JDialog { channelPassword.setText(b == null ? "" : nullToEmpty(b.channelPassword)); connectOnStartup.setSelected(b != null && b.connectOnStartup); myTeamSpeakFeatures.setSelected(b == null || b.myTeamSpeakFeatures); + showQueryClients.setSelected(b != null && b.showQueryClients); identity.setSelectedIdentityId(b == null ? "" : nullToEmpty(b.identityId)); updateThisChannel(); } @@ -288,6 +297,7 @@ public final class BookmarksDialog extends JDialog { editing.identityId = identity.getSelectedIdentityId(); editing.connectOnStartup = connectOnStartup.isSelected(); editing.myTeamSpeakFeatures = myTeamSpeakFeatures.isSelected(); + editing.showQueryClients = showQueryClients.isSelected(); list.repaint(); } diff --git a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/ConnectionInfoDialog.java b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/ConnectionInfoDialog.java index cb06ba3..1ea897d 100644 --- a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/ConnectionInfoDialog.java +++ b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/ConnectionInfoDialog.java @@ -4,7 +4,6 @@ import com.formdev.flatlaf.util.ScaledEmptyBorder; import com.formdev.flatlaf.util.UIScale; import eu.lixko.ts3j.client.net.ClientEntry; import eu.lixko.ts3j.client.net.ConnectionStats; -import eu.lixko.ts3j.client.net.ConnectionStatsFormat.Row; import eu.lixko.ts3j.client.net.ConnectionStatsFormat.TrafficRow; import eu.lixko.ts3j.client.net.ConnectionStatsFormat; import eu.lixko.ts3j.client.net.avatar.Avatar; @@ -22,7 +21,6 @@ import javax.swing.JComponent; import javax.swing.JDialog; import javax.swing.JLabel; import javax.swing.JPanel; -import javax.swing.JSeparator; import javax.swing.JTabbedPane; import javax.swing.SwingConstants; import javax.swing.SwingUtilities; @@ -55,7 +53,7 @@ public final class ConnectionInfoDialog extends JDialog { private static final int AVATAR_SIZE = 80; /** Sample texts sizing the columns, as the official window does, so they don't jitter. */ private static final String TOTAL_SAMPLE = "100.00 %"; - private static final String VALUE_SAMPLE = "1023.00 KiB/s"; + private static final String VALUE_SAMPLE = Figures.VALUE_SAMPLE; private final ServerSession session; private final int clientId; @@ -212,85 +210,6 @@ public final class ConnectionInfoDialog extends JDialog { return new ImageIcon(icon.getImage().getScaledInstance(size.width, size.height, Image.SCALE_SMOOTH)); } - // ---- figures ---- - - private static JLabel label(String text) { - JLabel l = new JLabel(text); - l.setFont(Theme.uiFont()); - return l; - } - - /** Pins a label's width to that of {@code sample}, so a growing figure doesn't resize the window. */ - private static JLabel sized(JLabel l, String sample) { - Dimension pref = l.getPreferredSize(); - int width = l.getFontMetrics(l.getFont()).stringWidth(sample); - l.setPreferredSize(new Dimension(Math.max(pref.width, width), pref.height)); - return l; - } - - private static GridBagConstraints cell(int x, int y, int anchor, Insets insets) { - GridBagConstraints c = new GridBagConstraints(); - c.gridx = x; - c.gridy = y; - c.anchor = anchor; - c.insets = UIScale.scale(insets); - return c; - } - - /** - * Labelled figures, one per row, in groups set apart by a rule; refreshed in place, and - * rows an update leaves out hide. - */ - private static final class Figures extends JPanel { - private final List> groups = new ArrayList<>(); - private int lastRow; - - Figures(List> rows, boolean valuesRight) { - super(new GridBagLayout()); - setOpaque(false); - int y = 0; - for (List group : rows) { - if (y > 0) { - GridBagConstraints rule = cell(0, y++, GridBagConstraints.WEST, new Insets(6, 0, 6, 0)); - rule.gridwidth = 2; - rule.fill = GridBagConstraints.HORIZONTAL; - add(new JSeparator(), rule); - } - List labels = new ArrayList<>(); - for (Row row : group) { - JLabel key = label(row.label()); - JLabel value = label(row.value()); - labels.add(new JLabel[]{key, value}); - add(key, cell(0, y, GridBagConstraints.WEST, new Insets(3, 0, 3, 16))); - GridBagConstraints vc = cell(1, y, valuesRight ? GridBagConstraints.EAST : GridBagConstraints.WEST, - new Insets(3, 0, 3, 0)); - vc.weightx = 1; - add(value, vc); - lastRow = y++; - } - groups.add(labels); - } - } - - /** Puts {@code c} after the last row's value. */ - void addTrailing(JComponent c) { - add(c, cell(2, lastRow, GridBagConstraints.EAST, new Insets(0, 6, 0, 0))); - } - - void update(List> rows) { - for (int g = 0; g < groups.size(); g++) { - List labels = groups.get(g); - List group = rows.get(g); - for (int i = 0; i < labels.size(); i++) { - boolean shown = i < group.size(); - labels.get(i)[0].setVisible(shown); - labels.get(i)[1].setVisible(shown); - if (shown) labels.get(i)[1].setText(group.get(i).value()); - } - } - } - } - /** One traffic category: a row per figure under Total / In / Out headings. */ private static final class TrafficTable extends JPanel { private final ConnectionStats.Kind kind; @@ -304,7 +223,7 @@ public final class ConnectionInfoDialog extends JDialog { List columns = ConnectionStatsFormat.COLUMNS; for (int c = 0; c < columns.size(); c++) { - JLabel heading = label(columns.get(c)); + JLabel heading = Figures.label(columns.get(c)); heading.setFont(heading.getFont().deriveFont(Font.ITALIC)); add(heading, column(c + 1, 0)); } @@ -312,19 +231,19 @@ public final class ConnectionInfoDialog extends JDialog { cells = new JLabel[rows.size()][]; for (int r = 0; r < rows.size(); r++) { TrafficRow row = rows.get(r); - add(label(row.label()), cell(0, r + 1, GridBagConstraints.WEST, new Insets(3, 0, 3, 8))); + add(Figures.label(row.label()), Figures.cell(0, r + 1, GridBagConstraints.WEST, new Insets(3, 0, 3, 8))); cells[r] = new JLabel[]{ - sized(label(row.total()), TOTAL_SAMPLE), sized(label(row.in()), VALUE_SAMPLE), - sized(label(row.out()), VALUE_SAMPLE)}; + Figures.sized(Figures.label(row.total()), TOTAL_SAMPLE), Figures.sized(Figures.label(row.in()), VALUE_SAMPLE), + Figures.sized(Figures.label(row.out()), VALUE_SAMPLE)}; for (int c = 0; c < cells[r].length; c++) add(cells[r][c], column(c + 1, r + 1)); } - GridBagConstraints filler = cell(0, rows.size() + 1, GridBagConstraints.WEST, new Insets(0, 0, 0, 0)); + GridBagConstraints filler = Figures.cell(0, rows.size() + 1, GridBagConstraints.WEST, new Insets(0, 0, 0, 0)); filler.weighty = 1; add(Box.createGlue(), filler); } private static GridBagConstraints column(int x, int y) { - GridBagConstraints c = cell(x, y, GridBagConstraints.WEST, new Insets(3, 8, 3, 8)); + GridBagConstraints c = Figures.cell(x, y, GridBagConstraints.WEST, new Insets(3, 8, 3, 8)); c.weightx = 1; return c; } diff --git a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/Figures.java b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/Figures.java new file mode 100644 index 0000000..ceb710d --- /dev/null +++ b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/Figures.java @@ -0,0 +1,110 @@ +package eu.lixko.ts3j.client.ui.server; + +import com.formdev.flatlaf.util.UIScale; +import eu.lixko.ts3j.client.net.ConnectionStatsFormat.Row; +import eu.lixko.ts3j.client.ui.Theme; + +import javax.swing.JComponent; +import javax.swing.JLabel; +import javax.swing.JPanel; +import javax.swing.JSeparator; +import java.awt.Dimension; +import java.awt.GridBagConstraints; +import java.awt.GridBagLayout; +import java.awt.Insets; +import java.util.ArrayList; +import java.util.List; + +/** + * Labelled figures, one per row, in groups set apart by a rule; refreshed in place, and + * rows an update leaves out hide. The connection info windows' summaries. + */ +final class Figures extends JPanel { + /** A wide traffic figure, to size value columns by so they don't jitter. */ + static final String VALUE_SAMPLE = "1023.00 KiB/s"; + + private final List> groups = new ArrayList<>(); + private int lastRow; + + Figures(List> rows, boolean valuesRight) { + super(new GridBagLayout()); + setOpaque(false); + int y = 0; + for (List group : rows) { + if (y > 0) { + GridBagConstraints rule = cell(0, y++, GridBagConstraints.WEST, new Insets(6, 0, 6, 0)); + rule.gridwidth = 2; + rule.fill = GridBagConstraints.HORIZONTAL; + add(new JSeparator(), rule); + } + List labels = new ArrayList<>(); + for (Row row : group) { + JLabel key = label(row.label()); + JLabel value = label(row.value()); + labels.add(new JLabel[]{key, value}); + add(key, cell(0, y, GridBagConstraints.WEST, new Insets(3, 0, 3, 16))); + GridBagConstraints vc = cell(1, y, valuesRight ? GridBagConstraints.EAST : GridBagConstraints.WEST, + new Insets(3, 0, 3, 0)); + vc.weightx = 1; + add(value, vc); + lastRow = y++; + } + groups.add(labels); + } + } + + /** Puts {@code c} after the last row's value. */ + void addTrailing(JComponent c) { + add(c, cell(2, lastRow, GridBagConstraints.EAST, new Insets(0, 6, 0, 0))); + } + + /** Puts {@code c} after the value of row {@code index}, counting rows across groups. */ + void addTrailing(int index, JComponent c) { + int y = 0; + for (int g = 0; g < groups.size(); g++) { + if (g > 0) y++; // the rule + if (index < groups.get(g).size()) { + add(c, cell(2, y + index, GridBagConstraints.EAST, new Insets(0, 6, 0, 0))); + return; + } + index -= groups.get(g).size(); + y += groups.get(g).size(); + } + } + + void update(List> rows) { + for (int g = 0; g < groups.size(); g++) { + List labels = groups.get(g); + List group = rows.get(g); + for (int i = 0; i < labels.size(); i++) { + boolean shown = i < group.size(); + labels.get(i)[0].setVisible(shown); + labels.get(i)[1].setVisible(shown); + if (shown) labels.get(i)[1].setText(group.get(i).value()); + } + } + } + + static JLabel label(String text) { + JLabel l = new JLabel(text); + l.setFont(Theme.uiFont()); + return l; + } + + /** Pins a label's width to that of {@code sample}, so a growing figure doesn't resize the window. */ + static JLabel sized(JLabel l, String sample) { + Dimension pref = l.getPreferredSize(); + int width = l.getFontMetrics(l.getFont()).stringWidth(sample); + l.setPreferredSize(new Dimension(Math.max(pref.width, width), pref.height)); + return l; + } + + static GridBagConstraints cell(int x, int y, int anchor, Insets insets) { + GridBagConstraints c = new GridBagConstraints(); + c.gridx = x; + c.gridy = y; + c.anchor = anchor; + c.insets = UIScale.scale(insets); + return c; + } +} diff --git a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/ServerConnectionInfoDialog.java b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/ServerConnectionInfoDialog.java new file mode 100644 index 0000000..4662d52 --- /dev/null +++ b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/ServerConnectionInfoDialog.java @@ -0,0 +1,173 @@ +package eu.lixko.ts3j.client.ui.server; + +import com.formdev.flatlaf.util.ScaledEmptyBorder; +import com.formdev.flatlaf.util.UIScale; +import eu.lixko.ts3j.client.net.ConnectionStatsFormat; +import eu.lixko.ts3j.client.net.ConnectionStatsFormat.TrafficRow; +import eu.lixko.ts3j.client.net.RequestException; +import eu.lixko.ts3j.client.net.ServerStats; +import eu.lixko.ts3j.client.session.ServerSession; +import eu.lixko.ts3j.client.ui.Theme; +import eu.lixko.ts3j.client.ui.icons.Icons; +import eu.lixko.ts3j.client.ui.widget.Dialogs; + +import javax.swing.Box; +import javax.swing.BoxLayout; +import javax.swing.JButton; +import javax.swing.JDialog; +import javax.swing.JLabel; +import javax.swing.JOptionPane; +import javax.swing.JPanel; +import javax.swing.JSeparator; +import javax.swing.SwingUtilities; +import java.awt.BorderLayout; +import java.awt.Font; +import java.awt.Frame; +import java.awt.GridBagConstraints; +import java.awt.GridBagLayout; +import java.awt.Insets; +import java.awt.Toolkit; +import java.awt.datatransfer.StringSelection; +import java.awt.event.WindowAdapter; +import java.awt.event.WindowEvent; +import java.util.List; +import java.util.concurrent.atomic.AtomicBoolean; + +/** + * Live "Server Connection Info" window, laid out as TeamSpeak 3's: the server's name, + * version, uptime, address, ping and loss, above an In / Out table of everything the + * server exchanged with its clients. Polls once a second while open. + */ +final class ServerConnectionInfoDialog extends JDialog { + + private static final int REFRESH_MS = 1000; + private static final int ADDRESS_ROW = 4; + + private final ServerSession session; + private final javax.swing.Timer timer; + private final AtomicBoolean inFlight = new AtomicBoolean(); + private final Figures summary; + private final JLabel[][] cells; + + ServerConnectionInfoDialog(Frame owner, ServerSession session) { + super(owner, "Server Connection Info", false); + this.session = session; + summary = new Figures(List.of(summaryRows(ServerStats.UNKNOWN)), false); + + JButton copy = new JButton(Icons.of("COPY")); + copy.setToolTipText("Copy server address to clipboard"); + copy.setMargin(UIScale.scale(new Insets(1, 1, 1, 1))); + copy.addActionListener(e -> Toolkit.getDefaultToolkit().getSystemClipboard() + .setContents(new StringSelection(address()), null)); + summary.addTrailing(ADDRESS_ROW, copy); + + List rows = ConnectionStatsFormat.serverTrafficRows(ServerStats.UNKNOWN); + cells = new JLabel[rows.size()][]; + + JPanel content = new JPanel(new BorderLayout(0, UIScale.scale(12))); + content.setBackground(Theme.windowBg()); + content.setBorder(new ScaledEmptyBorder(10, 10, 10, 10)); + content.add(summary, BorderLayout.NORTH); + content.add(buildTable(rows), BorderLayout.CENTER); + content.add(buildButtons(), BorderLayout.SOUTH); + setContentPane(content); + + Dialogs.closeOnEscape(this); + // Disposing is what stops the refresh timer, so the window button must not merely hide. + setDefaultCloseOperation(DISPOSE_ON_CLOSE); + pack(); + setLocationRelativeTo(owner); + + addWindowListener(new WindowAdapter() { + @Override + public void windowClosed(WindowEvent e) { + timer.stop(); + } + }); + timer = new javax.swing.Timer(REFRESH_MS, e -> refresh()); + timer.setInitialDelay(0); + timer.start(); + } + + private JPanel buildTable(List rows) { + JPanel table = new JPanel(new GridBagLayout()); + table.setOpaque(false); + List columns = ConnectionStatsFormat.SERVER_COLUMNS; + for (int c = 0; c < columns.size(); c++) { + JLabel heading = Figures.label(columns.get(c)); + heading.setFont(heading.getFont().deriveFont(Font.ITALIC)); + table.add(heading, column(c + 1, 0)); + } + GridBagConstraints rule = Figures.cell(0, 1, GridBagConstraints.WEST, new Insets(2, 0, 4, 0)); + rule.gridwidth = columns.size() + 1; + rule.fill = GridBagConstraints.HORIZONTAL; + table.add(new JSeparator(), rule); + for (int r = 0; r < rows.size(); r++) { + TrafficRow row = rows.get(r); + table.add(Figures.label(row.label()), Figures.cell(0, r + 2, GridBagConstraints.WEST, new Insets(3, 0, 3, 16))); + cells[r] = new JLabel[]{Figures.sized(Figures.label(row.in()), Figures.VALUE_SAMPLE), + Figures.sized(Figures.label(row.out()), Figures.VALUE_SAMPLE)}; + for (int c = 0; c < cells[r].length; c++) table.add(cells[r][c], column(c + 1, r + 2)); + } + return table; + } + + private static GridBagConstraints column(int x, int y) { + GridBagConstraints c = Figures.cell(x, y, GridBagConstraints.WEST, new Insets(3, 0, 3, 16)); + c.weightx = 1; + return c; + } + + private JPanel buildButtons() { + JPanel bar = new JPanel(); + bar.setLayout(new BoxLayout(bar, BoxLayout.X_AXIS)); + bar.setOpaque(false); + bar.add(Box.createHorizontalGlue()); + JButton close = new JButton("Close", Icons.of("CLOSE")); + close.addActionListener(e -> dispose()); + bar.add(close); + return bar; + } + + private void refresh() { + if (!session.isConnected()) { + timer.stop(); + return; + } + if (!inFlight.compareAndSet(false, true)) return; // a previous poll is still running + session.serverStats().read().whenComplete((stats, failure) -> SwingUtilities.invokeLater(() -> { + inFlight.set(false); + if (failure == null) apply(stats); + else failed(RequestException.of(failure)); + })); + } + + private void apply(ServerStats stats) { + if (!isDisplayable()) return; + summary.update(List.of(summaryRows(stats))); + List rows = ConnectionStatsFormat.serverTrafficRows(stats); + for (int r = 0; r < rows.size(); r++) { + cells[r][0].setText(rows.get(r).in()); + cells[r][1].setText(rows.get(r).out()); + } + // The uptime gains days, the version shows once known; grow rather than cut them off. + if (getPreferredSize().width > getWidth()) pack(); + } + + /** A refusal won't change by asking again, so it ends the polling; a lost connection already has. */ + private void failed(RequestException failure) { + if (!isDisplayable() || failure.kind() == RequestException.Kind.NOT_CONNECTED) return; + timer.stop(); + JOptionPane.showMessageDialog(this, failure.getMessage(), "Error requesting server connection info", + JOptionPane.ERROR_MESSAGE); + dispose(); + } + + private List summaryRows(ServerStats stats) { + return ConnectionStatsFormat.serverSummaryRows(session.model(), address(), stats); + } + + private String address() { + return session.address() + ":" + session.port(); + } +} diff --git a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/ServerMenu.java b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/ServerMenu.java index 69bc9d2..ba0cb82 100644 --- a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/ServerMenu.java +++ b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/ServerMenu.java @@ -24,6 +24,11 @@ final class ServerMenu { spacer.setToolTipText("Create a new spacer"); spacer.addActionListener(a -> actions.createSpacer()); menu.add(spacer); + menu.addSeparator(); + JMenuItem info = new JMenuItem("Server Connection Info", Icons.of("SERVER_GREEN")); + info.setEnabled(actions.canViewServerConnectionInfo()); + info.addActionListener(a -> actions.showServerConnectionInfo()); + menu.add(info); return menu; } } diff --git a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/ServerTab.java b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/ServerTab.java index 006734f..e84db5f 100644 --- a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/ServerTab.java +++ b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/ServerTab.java @@ -67,6 +67,7 @@ public final class ServerTab { /** The one open ban list window for this server, if any. */ /** The open ban list, complaints and other list windows, one of each kind. */ private final Map, AbstractServerListDialog> listWindows = new HashMap<>(); + private ServerConnectionInfoDialog serverInfoWindow; /** The unread count last reported, to tell new mail from messages being read. */ private int unreadMessages; @@ -211,6 +212,16 @@ public final class ServerTab { showListWindow(ServerLogDialog.class, () -> new ServerLogDialog(host, session, settings)); } + /** Opens the server's connection figures, or brings the already open window forward. */ + public void showServerConnectionInfo() { + if (!session.isConnected()) return; + if (serverInfoWindow == null || !serverInfoWindow.isDisplayable()) { + serverInfoWindow = new ServerConnectionInfoDialog(host, session); + } + serverInfoWindow.setVisible(true); + serverInfoWindow.toFront(); + } + public void showPrivilegeKeys() { showListWindow(PrivilegeKeysDialog.class, () -> new PrivilegeKeysDialog(host, session, groupIcons)); } diff --git a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/ServerTabTreeActions.java b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/ServerTabTreeActions.java index b828002..4d05cc9 100644 --- a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/ServerTabTreeActions.java +++ b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/ServerTabTreeActions.java @@ -203,6 +203,16 @@ final class ServerTabTreeActions implements ServerTreePanel.Actions { treePanel.selectClient(client.id); } + @Override + public boolean canViewServerConnectionInfo() { + return session.permissions().canViewServerConnectionInfo(); + } + + @Override + public void showServerConnectionInfo() { + tab.showServerConnectionInfo(); + } + @Override public void showConnectionInfo(ClientEntry client) { if (!session.isConnected()) return; diff --git a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/ServerTreePanel.java b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/ServerTreePanel.java index 4353b9c..f05a28d 100644 --- a/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/ServerTreePanel.java +++ b/ts3-client/swing/src/main/java/eu/lixko/ts3j/client/ui/server/ServerTreePanel.java @@ -157,6 +157,11 @@ public final class ServerTreePanel extends JPanel { /** Opens the per-client volume dialog. */ void changeClientVolume(ClientEntry client); + + /** Whether we may see the server's connection figures. */ + boolean canViewServerConnectionInfo(); + + void showServerConnectionInfo(); } private final DropIndicatorTree tree;