fix: optimised database to remove lingering issues on swaps; updated readme to cover remaining issues; deleted some (not all) unused code

Author: padraigfl

readme.md

@@ -48,6 +48,7 @@ I need to know the version of Java you're using and the output of the log panel
 
 ### Known Issues:
 
+1. A fresh install of all card data is required after each install currently [I'm guessing this is some kind of auto refresh function baked into the app]
 1. I raced through this so the UI is janky as hell. I expect frequent restarts. Some of it looks pretty bad with the Java 1.8 compilation settings but it'll do
 1. Logs aren't updating correctly; I think I need to add some multithreading functionality
 1. UI in general has weird lags tbh
@@ -63,8 +64,10 @@ I need to know the version of Java you're using and the output of the log panel
 1. Directly installs modified APK onto connected android device (requires ADB server instance)
 
 ## Future work:
+
+1. Alternative swap process using `level0` data (will not require fresh data downloads so future-proof but won't have 100% accurate card behaviour)
 1. Include associated baffler cards in playlist swaps
-1. Streamline process some more (can I launch the ADB server within the jar code?)
+1. Mod iOS app on M1 devices
 1. Verify working on Windows
 1. Tools for straightforward installing of APK without mods
 1. Mayyyyybe custom cards? This involves modifying the level0 assets file instead and injecting custom data files post-install so it's not so easy

src/model/AppState.java

@@ -110,9 +110,16 @@ byte[] loadFile() {
       throw new Error(e);
     }
   }
+  public void removePlaylistSwap(String p1) {
+    String p2 = this.playlistSwap.get(p1);
+    this.playlistSwap.remove(p1);
+    this.playlistSwap.remove(p2);
+  }
   public void setPlaylistSwap(String p1, String p2) throws Exception {
     if (p1.contains("---") || p2.contains("---")) {
       // for handling reset of field
+      this.playlistSwap.remove(p1);
+      this.playlistSwap.remove(p2);
       return;
     }
     if (this.playlistSwap.get(p1) != null || this.playlistSwap.get(p2) != null) {

src/model/CardDetail.java

@@ -93,40 +93,43 @@ public String getCardId() {
   private void setCardId(String newId) {
     this.cardData.put(CardDetail.SourceCID, newId);
   }
-  public String getCardSeason() {
-    return this.cardData.get(CardDetail.Season);
+  public int getCardSeason() {
+    try {
+      return Integer.parseInt(
+        this.cardData.get(CardDetail.Season).replaceAll("\"", "")
+      );
+    } catch (Exception e) {
+      return 0;
+    }
   }
-  public void setSourceCID(String newCardId, boolean preserveLength) {
-    String currentId = getCardId();
-    int songTitleLengthChangeRequired = currentId.length() - newCardId.length();
-    if (!preserveLength && songTitleLengthChangeRequired != 0) {
-      /*
+  private void shortedDBRowForModification(int changeRequired) {
+          /*
         SongRef would be preferable here as it will generally be longer but may cause issues with FX cards
         With this in mind it makes sense to use the Artist name instead
         TODO Investigate whether FX songRef values need to be swapped over when swap is applied
        */
-      String fieldToChange =
-        songTitleLengthChangeRequired < 0
-          && this.cardData.get(CardDetail.SongRef).length() < Math.abs(songTitleLengthChangeRequired) + 1
-          ? CardDetail.SongRef
-          : CardDetail.ArtistRef;
-      String songTitle = this.cardData.get(fieldToChange);
-      if (songTitleLengthChangeRequired > 0) {
-        songTitle = Helpers.rPad(songTitle, songTitle.length() + Math.abs(songTitleLengthChangeRequired), ' ');
-      } else {
-        songTitle = songTitle.substring(0, songTitle.length() - Math.abs(songTitleLengthChangeRequired) );
-      }
-      this.cardData.put(fieldToChange, songTitle);
+    String fieldToChange =
+      changeRequired < 0
+        && this.cardData.get(CardDetail.SongRef).length() < Math.abs(changeRequired) + 1
+        ? CardDetail.SongRef
+        : CardDetail.ArtistRef;
+    String songTitle = this.cardData.get(fieldToChange);
+    if (changeRequired > 0) {
+      songTitle = Helpers.rPad(songTitle, songTitle.length() + Math.abs(changeRequired), ' ');
+    } else {
+      songTitle = songTitle.substring(0, songTitle.length() - Math.abs(changeRequired) );
     }
-    this.setCardId(newCardId);
+    this.cardData.put(fieldToChange, songTitle);
   }
-  public String rowToDataString() {
-    ArrayList<String> sb = new ArrayList<>();
-    for (String h: heading) {
-      sb.add(cardData.get(h));
+  public void setSourceCID(String newCardId, boolean preserveLength) {
+    String currentId = getCardId();
+    int songTitleLengthChangeRequired = currentId.length() - newCardId.length();
+    if (!preserveLength && songTitleLengthChangeRequired != 0) {
+      shortedDBRowForModification(songTitleLengthChangeRequired);
     }
-    return String.join(",", sb);
+    this.setCardId(newCardId);
   }
+
   public String toString() {
     StringBuilder sb = new StringBuilder();
     for (String heading: CardDetail.heading) {

src/model/DropmixSharedAssets.java

@@ -63,44 +63,26 @@ public byte[] applySwap(TreeMap<String, String> cardSwaps) {
       CardDetail c2 = modifiedAssets.cards.get(s2);
       String c1CardId = c1.getCardId();
       String c2CardId = c2.getCardId();
+
       if (!alreadySwapped.contains(c1CardId) && !alreadySwapped.contains(c2CardId)) {
+
+        changedSeasons.add("" + c1.getCardSeason());
+        changedSeasons.add("" + c2.getCardSeason());
         // if both are from the same season there's no need to worry about the output table length
-        boolean isSameSeason = c1.getCardSeason().equals(c2.getCardSeason());
+        boolean isSameSeason = c1.getCardSeason() == (c2.getCardSeason());
         c1.setSourceCID(c2CardId, isSameSeason);
         c2.setSourceCID(c1CardId, isSameSeason);
         alreadySwapped.add(c1CardId);
         alreadySwapped.add(c2CardId);
-        changedSeasons.add(c1.getCardSeason());
-        changedSeasons.add(c2.getCardSeason());
       }
     });
     Counter databaseModified = new Counter(0);
     Counter databaseSize = new Counter(0);
     modifiedAssets.seasons.forEach(new BiConsumer<Integer, SeasonTable>() {
       @Override
       public void accept(Integer seasonIdx, SeasonTable seasonTable) {
-        String seasonArray = SeasonTable.csvWriter(seasonTable.toNestedString(), ",", "\"", seasonIdx);
-        byte[] seasonByteArray = new byte[seasonArray.length() + 4];
-        for (int i = 0; i < 4; i++) {
-          seasonByteArray[i] = seasonTable.rawDb[i];
-        }
-        char[] seasonCharArray = seasonArray.toCharArray();
-        for (int i = 0; i < seasonArray.length(); i++) {
-          seasonByteArray[i + 4] = (byte) seasonCharArray[i];
-        }
-        if (seasonByteArray.length != seasonTable.length) {
-          if (seasonIdx == 0) {
-            StringBuilder sb = new StringBuilder();
-            for (byte b: seasonTable.rawDb) {
-              sb.append((char) b);
-            }
-          }
+        byte[] seasonByteArray = seasonTable.backToByteArray(false);
 
-          // TODO be consistent about lengths and start indexes
-          if (seasonByteArray.length != seasonTable.rawDb.length) {
-            throw new RuntimeException("modified-database-size-wrong:" + seasonByteArray.length + " " + seasonTable.rawDb.length);
-          }
-        }
         databaseSize.iterate(seasonTable.length);
         for (int i = 0; i < seasonByteArray.length; i++) {
           int currentIdx = seasonTable.startIdx + i;
@@ -112,6 +94,34 @@ public void accept(Integer seasonIdx, SeasonTable seasonTable) {
       }
     });
     System.out.printf("Updated %d Seasons; %d of %d (%.2f) bytes", changedSeasons.size(), databaseModified.getCounter(), databaseSize.getCounter(), ((double) databaseModified.getCounter() / (double) databaseSize.getCounter()));
+    int sCount = 0;
+    for (SeasonTable s: modifiedAssets.seasons.values()) {
+      int size = s.length;
+      StringBuilder start = new StringBuilder();
+      StringBuilder end = new StringBuilder();
+      StringBuilder all = new StringBuilder();
+      StringBuilder old = new StringBuilder();
+      int printRange = 1600;
+      if (s.length < printRange) {
+        continue;
+      }
+      for (int i = 0; i < printRange; i++) {
+        all.append((char) s.rawDb[i]);
+      }
+      SeasonTable oldS= seasons.get(sCount);
+      for (int i = 0; i < size; i++) {
+        try {
+          all.append((char) s.rawDb[i]);
+          old.append((char) oldS.rawDb[i]);
+        } catch (ArrayIndexOutOfBoundsException | NullPointerException e) {}
+      }
+    }
+    DropmixSharedAssets ds = new DropmixSharedAssets(clonedAssetsFile);
+    for (int i = 0; i < 3; i++) {
+      SeasonTable s1 = modifiedAssets.seasons.get(i);
+      SeasonTable s2 = ds.seasons.get(i);
+      System.out.printf("\nSize: %d %d; db len: %d %d", s1.length, s2.length, s1.rawDb.length, s2.rawDb.length);
+    }
     return clonedAssetsFile;
   }
   public static int getStartIndex(byte[] rawData, byte[] startSequence) {

src/model/DropmixSharedAssetsTest.java

@@ -54,6 +54,56 @@ void applySwap() {
     Assertions.assertNotEquals(moddedFile, dropmixSharedAssets.rawData);
   }
 
+  @Test
+  void applySwapOfPlaylists() {
+
+    AppState as = AppState.getInstance();
+    as.assetsHandler = dropmixSharedAssets;
+    TreeMap<String, String> playlists = new TreeMap<>();
+    String[] names = new String[]{"derby", "ouroboros", "mirrors", "astro", "energy", "city", "flora", "verdant", "rhymer", "phase", "instinct", "fantastic" };
+    for (int i=0; i< names.length; i++) {
+      playlists.put(names[i], names[names.length - 1 -i]);
+    }
+    TreeMap<String, String> swapCards = AppState.getCardSwapFromPlaylist(playlists);
+
+    int oldLength = dropmixSharedAssets.rawData.length;
+    byte[] moddedFile = dropmixSharedAssets.applySwap(swapCards);
+    DropmixSharedAssets newVersion = new DropmixSharedAssets(moddedFile);
+    Assertions.assertEquals(moddedFile.length, oldLength);
+    Assertions.assertNotEquals(moddedFile, dropmixSharedAssets.rawData);
+    for (int i = 0; i < 3; i++) {
+      SeasonTable s1 = dropmixSharedAssets.seasons.get(i);
+      SeasonTable s2 = newVersion.seasons.get(i);
+      byte[] original = Helpers.getNRange(s1.rawDb, 4, s1.rawDb.length - 4);
+      byte[] modified = s2.backToByteArray(i == 2);
+      Assertions.assertEquals(s1.length, s2.length);
+      Assertions.assertEquals(s1.startIdx, s2.startIdx);
+      Assertions.assertNotEquals(original, modified);
+      int range = 80;
+      byte[] endRangeA = Helpers.getNRange(original, original.length - range, range);
+      byte[] endRangeB = Helpers.getNRange(modified, modified.length - range, range);
+      int lastIdx = 0;
+      for (int k = 0; k < original.length; k++) {
+        if (original[k] != modified[k] && (k - lastIdx) > range) {
+          lastIdx = k;
+          byte[] r1 = Helpers.getNRange(original, k - range, range * 2);
+          byte[] r2 = Helpers.getNRange(modified, k - range, range * 2);
+          StringBuilder a1 = new StringBuilder();
+          StringBuilder a2 = new StringBuilder();
+          for (int l = 0; l < range*2; l++) {
+            a1.append((char) r1[l]);
+            a2.append((char) r2[l]);
+          }
+          System.out.println(a1);
+          System.out.println(a2);
+          return;
+        }
+      }
+      System.out.println(endRangeA[0]);
+      System.out.println(endRangeB[0]);
+      Assertions.assertArrayEquals(endRangeA, endRangeB);
+    }
+  }
   @Test
   void replaceRogueCommas() {
     String rt = "\"Flo Rida\",\"I Don't Like It, I Love It (ft. Robin Thicke, Verdine White)\",\"Loop\"";

src/model/SeasonTable.java

@@ -38,27 +38,29 @@ public SeasonTable(byte[] rawTableData, byte[] startHeader, int startIdx, int se
     }
   }
 
-  public byte[] backToByteArray() {
-    byte[] newByteArray = this.rawDb.clone();
-
-    int counter = 4;
-
-    String heading = String.join(",", this.columns);
-    for (int i = 0; i < heading.length(); i++) {
-      newByteArray[counter] = (byte) heading.charAt(i);
-      counter++;
+  public byte[] backToByteArray(boolean includeEndNewLine) {
+    String seasonCSV = SeasonTable.csvWriter(toNestedString(), ",", "\"", cards[0].getCardSeason());
+    byte[] seasonByteArray = new byte[rawDb.length];
+    // insert DB length
+    for (int i = 0; i < 4; i++) {
+      seasonByteArray[i] = rawDb[i];
     }
-    for (CardDetail card: this.cards) {
-      String cardRow = card.rowToDataString();
-      for (int i = 0; i < cardRow.length(); i++) {
-        newByteArray[counter] = (byte) cardRow.charAt(i);
-        counter++;
-      }
+    System.out.println("size diff: " + rawDb.length + ", " + seasonCSV.length());
+    // build out byte array
+    for (int i = 0; i < seasonCSV.length(); i++) {
+      seasonByteArray[i + 4] = (byte) seasonCSV.charAt(i);
+    }
+    for (int i = seasonCSV.length() + 4; i < rawDb.length; i++) {
+      seasonByteArray[i] = rawDb[i];
     }
-    if (newByteArray.length != this.rawDb.length) {
-      throw new Error("database-length-error");
+    return seasonByteArray;
+  }
+  static String getDb(byte[] b) {
+    StringBuilder sb = new StringBuilder();
+    for (byte a: b) {
+      sb.append((char) a);
     }
-    return newByteArray;
+    return sb.toString();
   }
   /**/
   public String[][] toNestedString() {
@@ -126,6 +128,10 @@ public static String csvWriter(String[][] csv, String delimiter, String textQual
     for (String[] row: csv) {
       int currentColIdx = 0;
       for (String cell: row) {
+        boolean hasComma = cell.contains("£") || cell.contains(",");
+        if (cell.contains("ays Ahead")) {
+          System.out.println(cell);
+        }
         String formattedString = cell.replaceAll("£", ",");
         boolean isLikelyString = true;
         try {
@@ -137,11 +143,11 @@ public static String csvWriter(String[][] csv, String delimiter, String textQual
           }
         }
         if (
-          currentRowIdx != 0
-          && (
-            (isLikelyString && allStringsTextQualifier)
-            || (isSeasonFieldString && Objects.equals(csv[0][currentColIdx], CardDetail.Season))
-          )
+          (currentRowIdx != 0
+            && (
+              (isLikelyString && allStringsTextQualifier)
+              || (isSeasonFieldString && Objects.equals(csv[0][currentColIdx], CardDetail.Season))
+          )) || (hasComma)
         ){
           formattedString = textQualifier + formattedString + textQualifier;
         }

src/ui/UIPlaylistsPanel.java

@@ -85,7 +85,13 @@ public JComboBox<String> getPlaylistComboBox(String playlist) {
       public void itemStateChanged(ItemEvent event) {
         if (event.getStateChange() == ItemEvent.SELECTED) {
           try {
-            AppState.getInstance().setPlaylistSwap(playlist, event.getItem().toString());
+            System.out.println(event.getItem() + "<-->" + playlist);
+            // clear both fields if this value is selected
+            if (event.getItem().toString().contains("---")) {
+              AppState.getInstance().removePlaylistSwap(playlist);
+            } else {
+              AppState.getInstance().setPlaylistSwap(playlist, event.getItem().toString());
+            }
             // box.setSelectedItem(event.getItem());
             oldSelectionItem = event.getItem();
             that.setGrid();

src/util/Helpers.java

@@ -34,6 +34,24 @@ public static String rPad(String str, int length, char car) {
   public static byte[] get4Range(byte[] field, int idx) {
     return Arrays.copyOfRange(field, idx, idx + 4);
   }
+  public static byte[] getNRange(byte[] field, int idx, int len) {
+    return Arrays.copyOfRange(field, idx, idx + len);
+  }
+  public static char[] byteToChars(byte[] field) {
+    char[] chars = new char[field.length];
+    int i = 0;
+    for (byte b: field) {
+      chars[i++] = (char) b;
+    }
+    return chars;
+  }
+  public static String bytetoString(byte[] field) {
+    StringBuilder sb = new StringBuilder();
+    for (byte b: field) {
+      sb.append((char) b);
+    }
+    return sb.toString();
+  }
 
   public static byte[] loadLocalFile(String strPath) {
     try {