Bump version to 1.4.7 and centralize track ID validation logic

Author: LabyStudio

build.gradle

@@ -4,7 +4,7 @@ plugins {
 }
 
 group 'de.labystudio'
-version '1.4.6'
+version '1.4.7'
 
 compileJava {
     sourceCompatibility = '1.8'

src/main/java/de/labystudio/spotifyapi/model/Track.java

@@ -9,6 +9,8 @@
  */
 public class Track {
 
+    public static final int ID_LENGTH = 22;
+
     private final String id;
     private final String name;
     private final String artist;
@@ -31,6 +33,10 @@ public Track(
         this.coverArt = coverArt;
     }
 
+    public boolean isIdValid() {
+        return isTrackIdValid(this.id);
+    }
+
     public String getId() {
         return this.id;
     }
@@ -65,4 +71,28 @@ public int hashCode() {
     public String toString() {
         return String.format("[%s] %s - %s", this.id, this.name, this.artist);
     }
+
+    /**
+     * Checks if the given track ID is valid.
+     * A track ID is valid if there are no characters with a value of zero.
+     * It also has to be exactly 22 characters long.
+     *
+     * @param trackId The track ID to check.
+     * @return True if the track ID is valid, false otherwise.
+     */
+    public static boolean isTrackIdValid(String trackId) {
+        if (trackId == null) {
+            return false;
+        }
+
+        for (char c : trackId.toCharArray()) {
+            boolean isValidCharacter = c >= 'a' && c <= 'z'
+                    || c >= 'A' && c <= 'Z'
+                    || c >= '0' && c <= '9';
+            if (!isValidCharacter) {
+                return false;
+            }
+        }
+        return !trackId.contains(" ") && trackId.length() == ID_LENGTH;
+    }
 }

src/main/java/de/labystudio/spotifyapi/open/Cache.java

@@ -42,6 +42,13 @@ public void setCacheSize(int cacheSize) {
      * @param key The key of the entry
      */
     public void push(String key, T value) {
+        if (key == null) {
+            throw new IllegalArgumentException("Key cannot be null");
+        }
+        if (value == null) {
+            throw new IllegalArgumentException("Value cannot be null");
+        }
+
         // Remove entry from cache if cache is full
         if (this.cacheQueue.size() > this.cacheSize) {
             String urlToRemove = this.cacheQueue.remove(0);

src/main/java/de/labystudio/spotifyapi/open/OpenSpotifyAPI.java

@@ -166,6 +166,10 @@ public void requestImageAsync(Track track, Consumer<BufferedImage> callback) {
      * @param callback Response with the buffered image track. It won't be called on an error.
      */
     public void requestImageAsync(String trackId, Consumer<BufferedImage> callback) {
+        if (!Track.isTrackIdValid(trackId)) {
+            throw new IllegalArgumentException("Invalid track ID: " + trackId);
+        }
+
         this.executor.execute(() -> {
             try {
                 BufferedImage image = this.requestImage(trackId);
@@ -250,6 +254,10 @@ public BufferedImage requestImage(Track track) throws IOException {
      * @throws IOException if the request failed
      */
     public BufferedImage requestImage(String trackId) throws IOException {
+        if (!Track.isTrackIdValid(trackId)) {
+            throw new IllegalArgumentException("Invalid track ID: " + trackId);
+        }
+
         // Try to get image from cache by track id
         BufferedImage cachedImage = this.imageCache.get(trackId);
         if (cachedImage != null) {

src/main/java/de/labystudio/spotifyapi/platform/windows/WinSpotifyAPI.java

@@ -95,7 +95,7 @@ protected void onTick() {
 
         // Read track id and check if track id is valid
         String trackId = this.process.readTrackId();
-        if (!this.process.isTrackIdValid(trackId)) {
+        if (!Track.isTrackIdValid(trackId)) {
             throw new IllegalStateException("Invalid track ID: " + trackId);
         }
 

src/main/java/de/labystudio/spotifyapi/platform/windows/api/spotify/SpotifyProcess.java

@@ -1,5 +1,6 @@
 package de.labystudio.spotifyapi.platform.windows.api.spotify;
 
+import de.labystudio.spotifyapi.model.Track;
 import de.labystudio.spotifyapi.platform.windows.api.WinProcess;
 import de.labystudio.spotifyapi.platform.windows.api.jna.Psapi;
 import de.labystudio.spotifyapi.platform.windows.api.jna.WindowsMediaControl;
@@ -91,7 +92,7 @@ private long findTrackIdAddress() {
 
             // Check if the hardcoded offset is valid
             long targetAddressTrackId = chromeElfAddress + trackIdOffset;
-            if (this.isTrackIdValid(this.readTrackId(targetAddressTrackId))) {
+            if (Track.isTrackIdValid(this.readTrackId(targetAddressTrackId))) {
                 // If the offset works, exit the loop
                 addressTrackId = targetAddressTrackId;
                 break;
@@ -108,7 +109,7 @@ private long findTrackIdAddress() {
             long scanAddressFrom = chromeElfAddress + minTrackIdOffset - threshold;
             long scanAddressTo = chromeElfAddress + maxTrackIdOffset + threshold;
             addressTrackId = this.findAddressOfText(scanAddressFrom, scanAddressTo, PREFIX_SPOTIFY_TRACK, (address, index) -> {
-                return this.isTrackIdValid(this.readTrackId(address));
+                return Track.isTrackIdValid(this.readTrackId(address));
             });
         }
 
@@ -150,23 +151,4 @@ public String readTrackId() {
     public PlaybackAccessor getPlaybackAccessor() {
         return this.playbackAccessor;
     }
-
-    /**
-     * Checks if the given track ID is valid.
-     * A track ID is valid if there are no characters with a value of zero.
-     *
-     * @param trackId The track ID to check.
-     * @return True if the track ID is valid, false otherwise.
-     */
-    public boolean isTrackIdValid(String trackId) {
-        for (char c : trackId.toCharArray()) {
-            boolean isValidCharacter = c >= 'a' && c <= 'z'
-                    || c >= 'A' && c <= 'Z'
-                    || c >= '0' && c <= '9';
-            if (!isValidCharacter) {
-                return false;
-            }
-        }
-        return true;
-    }
 }