diff --git a/ts3-client/core/src/main/java/com/ts3client/myts/MyTeamSpeak.java b/ts3-client/core/src/main/java/com/ts3client/myts/MyTeamSpeak.java index d435aae..4bfaf40 100644 --- a/ts3-client/core/src/main/java/com/ts3client/myts/MyTeamSpeak.java +++ b/ts3-client/core/src/main/java/com/ts3client/myts/MyTeamSpeak.java @@ -4,6 +4,7 @@ import com.ts3client.proto.ProtobufReader; import com.ts3client.proto.ProtobufWriter; import com.ts3client.teamspeak.SyncItem; import com.ts3client.teamspeak.SyncItemDecoder; +import com.ts3client.teamspeak.SyncOrder; import java.io.IOException; import java.net.URI; @@ -181,7 +182,7 @@ public final class MyTeamSpeak { } if (item != null) items.add(item); } - return items; + return SyncOrder.sorted(items); } /** diff --git a/ts3-client/core/src/main/java/com/ts3client/teamspeak/SyncItem.java b/ts3-client/core/src/main/java/com/ts3client/teamspeak/SyncItem.java index 47fc5fc..854f6af 100644 --- a/ts3-client/core/src/main/java/com/ts3client/teamspeak/SyncItem.java +++ b/ts3-client/core/src/main/java/com/ts3client/teamspeak/SyncItem.java @@ -14,14 +14,17 @@ public sealed interface SyncItem { /** UUID of the {@link Folder} the item sits in, or empty at the top level. */ String parentUuid(); - record Folder(String uuid, String parentUuid, String name) implements SyncItem { + /** UUID of the item just above it in its folder, or empty when it is the first. */ + String previousUuid(); + + record Folder(String uuid, String parentUuid, String previousUuid, String name) implements SyncItem { } /** * @param identity the key in TeamSpeak's obfuscated {@code V} identity form * @param nickname the nickname used with this identity when a bookmark names none */ - record Identity(String uuid, String parentUuid, String identity, String name, + record Identity(String uuid, String parentUuid, String previousUuid, String identity, String name, String nickname, String phoneticNickname, boolean isDefault) implements SyncItem { } @@ -31,7 +34,7 @@ public sealed interface SyncItem { * @param defaultChannel channel path to join, "/"-separated; empty for the server default * @param defaultChannelId the same channel by id, {@code 0} when unknown */ - record Bookmark(String uuid, String parentUuid, String name, String address, int port, + record Bookmark(String uuid, String parentUuid, String previousUuid, String name, String address, int port, String nickname, String phoneticNickname, String identityUuid, String serverPassword, String defaultChannel, String defaultChannelPassword, long defaultChannelId, boolean autoconnect) implements SyncItem { diff --git a/ts3-client/core/src/main/java/com/ts3client/teamspeak/SyncItemDecoder.java b/ts3-client/core/src/main/java/com/ts3client/teamspeak/SyncItemDecoder.java index e767661..207d99b 100644 --- a/ts3-client/core/src/main/java/com/ts3client/teamspeak/SyncItemDecoder.java +++ b/ts3-client/core/src/main/java/com/ts3client/teamspeak/SyncItemDecoder.java @@ -26,6 +26,7 @@ public final class SyncItemDecoder { public static SyncItem decode(byte[] blob) throws IOException { String uuid = ""; String parent = ""; + String previous = ""; boolean deleted = false; ProtobufReader content = null; int contentField = 0; @@ -36,6 +37,7 @@ public final class SyncItemDecoder { case 2 -> uuid = r.readString(); case 4 -> deleted = r.readVarint() == ITEM_DELETED; case 7 -> parent = r.readString(); + case 8 -> previous = r.readString(); case 16, 17, 22 -> { contentField = r.fieldNumber(); content = r.readMessage(); @@ -46,13 +48,13 @@ public final class SyncItemDecoder { if (deleted || content == null) return null; if (parent.equals(ROOT_PARENT)) parent = ""; return switch (contentField) { - case 16 -> bookmark(uuid, parent, content); - case 17 -> identity(uuid, parent, content); - default -> folder(uuid, parent, content); + case 16 -> bookmark(uuid, parent, previous, content); + case 17 -> identity(uuid, parent, previous, content); + default -> folder(uuid, parent, previous, content); }; } - private static SyncItem.Bookmark bookmark(String uuid, String parent, ProtobufReader r) throws IOException { + private static SyncItem.Bookmark bookmark(String uuid, String parent, String previous, ProtobufReader r) throws IOException { String name = "", address = "", nickname = "", phonetic = "", identity = ""; String serverPassword = "", channel = "", channelPassword = ""; int port = 9987; @@ -74,11 +76,11 @@ public final class SyncItemDecoder { default -> r.skip(); } } - return new SyncItem.Bookmark(uuid, parent, name, address, port, nickname, phonetic, identity, + return new SyncItem.Bookmark(uuid, parent, previous, name, address, port, nickname, phonetic, identity, serverPassword, channel, channelPassword, channelId, autoconnect); } - private static SyncItem.Identity identity(String uuid, String parent, ProtobufReader r) throws IOException { + private static SyncItem.Identity identity(String uuid, String parent, String previous, ProtobufReader r) throws IOException { String identity = "", name = "", nickname = "", phonetic = ""; boolean isDefault = false; while (r.next()) { @@ -91,15 +93,15 @@ public final class SyncItemDecoder { default -> r.skip(); } } - return new SyncItem.Identity(uuid, parent, identity, name, nickname, phonetic, isDefault); + return new SyncItem.Identity(uuid, parent, previous, identity, name, nickname, phonetic, isDefault); } - private static SyncItem.Folder folder(String uuid, String parent, ProtobufReader r) throws IOException { + private static SyncItem.Folder folder(String uuid, String parent, String previous, ProtobufReader r) throws IOException { String name = ""; while (r.next()) { if (r.fieldNumber() == 1) name = r.readString(); else r.skip(); } - return new SyncItem.Folder(uuid, parent, name); + return new SyncItem.Folder(uuid, parent, previous, name); } } diff --git a/ts3-client/core/src/main/java/com/ts3client/teamspeak/SyncOrder.java b/ts3-client/core/src/main/java/com/ts3client/teamspeak/SyncOrder.java new file mode 100644 index 0000000..1d0215a --- /dev/null +++ b/ts3-client/core/src/main/java/com/ts3client/teamspeak/SyncOrder.java @@ -0,0 +1,69 @@ +package com.ts3client.teamspeak; + +import java.util.ArrayDeque; +import java.util.ArrayList; +import java.util.HashSet; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.Set; + +/** + * Puts sync items in the order the TeamSpeak client lists them. The store keeps them in the + * order they were created; each item names the one above it in its folder, so a reorder only + * rewrites those links. + */ +public final class SyncOrder { + + private SyncOrder() { + } + + /** + * The items top to bottom, each folder's contents right after the folder. Items whose + * links lead nowhere, or whose folder is missing, come last in their stored order. + */ + public static List sorted(List items) { + Map> byFolder = new LinkedHashMap<>(); + for (SyncItem item : items) byFolder.computeIfAbsent(item.parentUuid(), k -> new ArrayList<>()).add(item); + + List out = new ArrayList<>(items.size()); + Set placed = new HashSet<>(); + appendFolder("", byFolder, placed, out); + for (List stray : byFolder.values()) { + for (SyncItem item : stray) { + if (!placed.contains(item)) appendFolder(item.parentUuid(), byFolder, placed, out); + } + } + return out; + } + + private static void appendFolder(String folder, Map> byFolder, Set placed, + List out) { + List members = byFolder.getOrDefault(folder, List.of()); + Map> byPrevious = new LinkedHashMap<>(); + for (SyncItem item : members) byPrevious.computeIfAbsent(item.previousUuid(), k -> new ArrayList<>()).add(item); + + List chain = new ArrayList<>(members.size()); + follow(byPrevious.getOrDefault("", List.of()), byPrevious, placed, chain); + // Broken links: the rest start chains of their own. + for (SyncItem item : members) follow(List.of(item), byPrevious, placed, chain); + for (SyncItem item : chain) { + out.add(item); + if (item instanceof SyncItem.Folder) appendFolder(item.uuid(), byFolder, placed, out); + } + } + + /** Appends {@code heads} and, after each, the items below it, depth first. */ + private static void follow(List heads, Map> byPrevious, Set placed, + List chain) { + ArrayDeque stack = new ArrayDeque<>(); + for (int i = heads.size() - 1; i >= 0; i--) stack.push(heads.get(i)); + while (!stack.isEmpty()) { + SyncItem item = stack.pop(); + if (!placed.add(item)) continue; + chain.add(item); + List below = byPrevious.getOrDefault(item.uuid(), List.of()); + for (int i = below.size() - 1; i >= 0; i--) stack.push(below.get(i)); + } + } +} diff --git a/ts3-client/core/src/main/java/com/ts3client/teamspeak/TeamSpeakSettingsDb.java b/ts3-client/core/src/main/java/com/ts3client/teamspeak/TeamSpeakSettingsDb.java index 8c2c80a..23a6790 100644 --- a/ts3-client/core/src/main/java/com/ts3client/teamspeak/TeamSpeakSettingsDb.java +++ b/ts3-client/core/src/main/java/com/ts3client/teamspeak/TeamSpeakSettingsDb.java @@ -63,7 +63,7 @@ public final class TeamSpeakSettingsDb { } /** - * The synchronised items in database order. Rows that are not items — the + * The synchronised items in the order the client lists them. Rows that are not items — the * table's checksum, unmodelled classes, pending deletions — are left out. * * @throws IOException when the file is not a readable SQLite database @@ -80,7 +80,7 @@ public final class TeamSpeakSettingsDb { } if (item != null) items.add(item); } - return items; + return SyncOrder.sorted(items); } /** The {@code value} column of a key/value table, in row order; empty when the table is absent. */ diff --git a/ts3-client/core/src/test/java/com/ts3client/teamspeak/SyncOrderTest.java b/ts3-client/core/src/test/java/com/ts3client/teamspeak/SyncOrderTest.java new file mode 100644 index 0000000..2e3a663 --- /dev/null +++ b/ts3-client/core/src/test/java/com/ts3client/teamspeak/SyncOrderTest.java @@ -0,0 +1,55 @@ +package com.ts3client.teamspeak; + +import org.junit.jupiter.api.Test; + +import java.io.File; +import java.util.List; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +class SyncOrderTest { + + /** + * Written by the official client: Charlie, Alpha and Bravo added in that order, Bravo dragged + * to the top, Charlie removed, then a folder with Delta and Echo added below TeamSpeak Public. + */ + @Test + void readsBookmarksInTheOrderTheOfficialClientListsThem() throws Exception { + File db = new File(SyncOrderTest.class.getResource("/teamspeak/reordered.db").getFile()); + assertEquals(List.of("Bravo", "TeamSpeak Public", "[New Folder]", "Delta", "Echo", "Alpha"), + names(TeamSpeakSettingsDb.readSyncItems(db))); + } + + @Test + void putsItemsWithBrokenLinksLastInStoredOrder() { + List items = List.of( + folder("f", "", "b"), + bookmark("x", "", "lost"), + bookmark("c", "f", ""), + bookmark("a", "", ""), + bookmark("y", "gone", ""), + bookmark("b", "", "a")); + assertEquals(List.of("a", "b", "[f]", "c", "x", "y"), names(SyncOrder.sorted(items))); + } + + @Test + void survivesALoop() { + List items = List.of(bookmark("a", "", "b"), bookmark("b", "", "a")); + assertEquals(List.of("a", "b"), names(SyncOrder.sorted(items))); + } + + private static SyncItem.Bookmark bookmark(String uuid, String parent, String previous) { + return new SyncItem.Bookmark(uuid, parent, previous, uuid, uuid + ".example", 9987, "", "", "", "", "", "", + 0, false); + } + + private static SyncItem.Folder folder(String uuid, String parent, String previous) { + return new SyncItem.Folder(uuid, parent, previous, uuid); + } + + private static List names(List items) { + return items.stream().map(i -> i instanceof SyncItem.Bookmark b ? b.name() + : i instanceof SyncItem.Folder f ? "[" + f.name() + "]" : null) + .filter(n -> n != null).toList(); + } +} diff --git a/ts3-client/core/src/test/java/com/ts3client/teamspeak/TeamSpeakImporterTest.java b/ts3-client/core/src/test/java/com/ts3client/teamspeak/TeamSpeakImporterTest.java index 526a445..30d88f1 100644 --- a/ts3-client/core/src/test/java/com/ts3client/teamspeak/TeamSpeakImporterTest.java +++ b/ts3-client/core/src/test/java/com/ts3client/teamspeak/TeamSpeakImporterTest.java @@ -84,7 +84,7 @@ class TeamSpeakImporterTest { Bookmarks bookmarks = new Bookmarks(); SyncItem.Identity identity = TeamSpeakSettingsDb.readSyncItems(SyncItemsTest.fixture()).stream() .filter(SyncItem.Identity.class::isInstance).map(SyncItem.Identity.class::cast).findFirst().orElseThrow(); - SyncItem.Bookmark bookmark = new SyncItem.Bookmark("b", "", "Server", "example.com", 9987, "", "", + SyncItem.Bookmark bookmark = new SyncItem.Bookmark("b", "", "", "Server", "example.com", 9987, "", "", identity.name(), "", "", "", 0, false); new TeamSpeakImporter(identities, bookmarks, settings).importAll(List.of(bookmark, identity)); diff --git a/ts3-client/core/src/test/resources/teamspeak/reordered.db b/ts3-client/core/src/test/resources/teamspeak/reordered.db new file mode 100644 index 0000000..31f0078 Binary files /dev/null and b/ts3-client/core/src/test/resources/teamspeak/reordered.db differ