use spotify client id & secret for searching

Author: topi314

README.md

@@ -120,14 +120,16 @@ plugins:
       yandexmusic: false # Enable Yandex Music lyrics source
       vkmusic: false # Enable Vk Music lyrics source
     spotify:
-      clientId: "your client id"
-      clientSecret: "your client secret"
+      # clientId & clientSecret are required for using spsearch
+#      clientId: "your client id"
+#      clientSecret: "your client secret"
       # spDc: "your sp dc cookie" # the sp dc cookie used for accessing the spotify lyrics api
       countryCode: "US" # the country code you want to use for filtering the artists top tracks. See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
       playlistLoadLimit: 6 # The number of pages at 100 tracks each
       albumLoadLimit: 6 # The number of pages at 50 tracks each
       resolveArtistsInSearch: true # Whether to resolve artists in track search results (can be slow)
       localFiles: false # Enable local files support with Spotify playlists. Please note `uri` & `isrc` will be `null` & `identifier` will be `"local"`
+      preferAnonymousToken: true # Whether to use the anonymous token for resolving tracks, artists and albums. Playlists are always resolved with the anonymous token to support autogenerated playlists.
     applemusic:
       countryCode: "US" # the country code you want to use for filtering the artists top tracks and language. See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
       mediaAPIToken: "your apple music api token" # apple music api token

application.example.yml

@@ -24,14 +24,16 @@ plugins:
       yandexmusic: false # Enable Yandex Music lyrics source
       vkmusic: false # Enable Vk Music lyrics source
     spotify:
-      clientId: "your client id"
-      clientSecret: "your client secret"
+      # clientId & clientSecret are required for using spsearch
+#      clientId: "your client id"
+#      clientSecret: "your client secret"
       # spDc: "your sp dc cookie" # the sp dc cookie used for accessing the spotify lyrics api
       countryCode: "US" # the country code you want to use for filtering the artists top tracks. See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
       playlistLoadLimit: 6 # The number of pages at 100 tracks each
       albumLoadLimit: 6 # The number of pages at 50 tracks each
       resolveArtistsInSearch: true # Whether to resolve artists in track search results (can be slow)
       localFiles: false # Enable local files support with Spotify playlists. Please note `uri` & `isrc` will be `null` & `identifier` will be `"local"`
+      preferAnonymousToken: true # Whether to use the anonymous token for resolving tracks, artists and albums. Playlists are always resolved with the anonymous token to support autogenerated playlists.
     applemusic:
       countryCode: "US" # the country code you want to use for filtering the artists top tracks and language. See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
       mediaAPIToken: "your apple music api token" # apple music api token

main/src/main/java/com/github/topi314/lavasrc/spotify/SpotifySourceManager.java

@@ -56,12 +56,13 @@ public class SpotifySourceManager extends MirroringAudioSourceManager implements
 	private static final Logger log = LoggerFactory.getLogger(SpotifySourceManager.class);
 
 	private final HttpInterfaceManager httpInterfaceManager = HttpClientTools.createDefaultThreadLocalManager();
-	private SpotifyTokenTracker tokenTracker;
+	private final SpotifyTokenTracker tokenTracker;
 	private final String countryCode;
 	private int playlistPageLimit = 6;
 	private int albumPageLimit = 6;
 	private boolean localFiles;
 	private boolean resolveArtistsInSearch = true;
+	private boolean preferAnonymousToken = false;
 
 	public SpotifySourceManager(String[] providers, String clientId, String clientSecret, String countryCode, AudioPlayerManager audioPlayerManager) {
 		this(clientId, clientSecret, null, countryCode, unused -> audioPlayerManager, new DefaultMirroringAudioTrackResolver(providers));
@@ -80,6 +81,10 @@ public SpotifySourceManager(String clientId, String clientSecret, String country
 	}
 
 	public SpotifySourceManager(String clientId, String clientSecret, String spDc, String countryCode, Function<Void, AudioPlayerManager> audioPlayerManager, MirroringAudioTrackResolver mirroringAudioTrackResolver) {
+		this(clientId, clientSecret, false, spDc, countryCode, audioPlayerManager, mirroringAudioTrackResolver);
+	}
+
+	public SpotifySourceManager(String clientId, String clientSecret, boolean preferAnonymousToken, String spDc, String countryCode, Function<Void, AudioPlayerManager> audioPlayerManager, MirroringAudioTrackResolver mirroringAudioTrackResolver) {
 		super(audioPlayerManager, mirroringAudioTrackResolver);
 
 		this.tokenTracker = new SpotifyTokenTracker(this, clientId, clientSecret, spDc);
@@ -88,6 +93,7 @@ public SpotifySourceManager(String clientId, String clientSecret, String spDc, S
 			countryCode = "US";
 		}
 		this.countryCode = countryCode;
+		this.preferAnonymousToken = preferAnonymousToken;
 	}
 
 	public void setPlaylistPageLimit(int playlistPageLimit) {
@@ -114,6 +120,10 @@ public void setSpDc(String spDc) {
 		this.tokenTracker.setSpDc(spDc);
 	}
 
+	public void setPreferAnonymousToken(boolean preferAnonymousToken) {
+		this.preferAnonymousToken = preferAnonymousToken;
+	}
+
 	@NotNull
 	@Override
 	public String getSourceName() {
@@ -270,9 +280,10 @@ public AudioItem loadItem(String identifier, boolean preview) {
 		return null;
 	}
 
-	public JsonBrowser getJson(String uri) throws IOException {
+	public JsonBrowser getJson(String uri, boolean anonymous, boolean preferAnonymous) throws IOException {
 		var request = new HttpGet(uri);
-		request.addHeader("Authorization", "Bearer " + this.tokenTracker.getAccessToken());
+		var accessToken = anonymous ? this.tokenTracker.getAnonymousAccessToken() : this.tokenTracker.getAccessToken(preferAnonymous);
+		request.addHeader("Authorization", "Bearer " + accessToken);
 		return LavaSrcTools.fetchResponseAsJson(this.httpInterfaceManager.getInterface(), request);
 	}
 
@@ -281,7 +292,7 @@ private AudioSearchResult getAutocomplete(String query, Set<AudioSearchResult.Ty
 			types = SEARCH_TYPES;
 		}
 		var url = API_BASE + "search?q=" + URLEncoder.encode(query, StandardCharsets.UTF_8) + "&type=" + types.stream().map(AudioSearchResult.Type::getName).collect(Collectors.joining(","));
-		var json = this.getJson(url);
+		var json = this.getJson(url, false, false);
 		if (json == null) {
 			return AudioSearchResult.EMPTY;
 		}
@@ -331,14 +342,14 @@ private AudioSearchResult getAutocomplete(String query, Set<AudioSearchResult.Ty
 	}
 
 	public AudioItem getSearch(String query, boolean preview) throws IOException {
-		var json = this.getJson(API_BASE + "search?q=" + URLEncoder.encode(query, StandardCharsets.UTF_8) + "&type=track");
+		var json = this.getJson(API_BASE + "search?q=" + URLEncoder.encode(query, StandardCharsets.UTF_8) + "&type=track", false, false);
 		if (json == null || json.get("tracks").get("items").values().isEmpty()) {
 			return AudioReference.NO_TRACK;
 		}
 
 		if (this.resolveArtistsInSearch) {
 			var artistIds = json.get("tracks").get("items").values().stream().map(track -> track.get("artists").index(0).get("id").text()).collect(Collectors.joining(","));
-			var artistJson = this.getJson(API_BASE + "artists?ids=" + artistIds);
+			var artistJson = this.getJson(API_BASE + "artists?ids=" + artistIds, false, false);
 			if (artistJson != null) {
 				for (var artist : artistJson.get("artists").values()) {
 					for (var track : json.get("tracks").get("items").values()) {
@@ -354,7 +365,7 @@ public AudioItem getSearch(String query, boolean preview) throws IOException {
 	}
 
 	public AudioItem getRecommendations(String query, boolean preview) throws IOException {
-		var json = this.getJson(API_BASE + "recommendations?" + query);
+		var json = this.getJson(API_BASE + "recommendations?" + query, false, false);
 		if (json == null || json.get("tracks").values().isEmpty()) {
 			return AudioReference.NO_TRACK;
 		}
@@ -363,12 +374,12 @@ public AudioItem getRecommendations(String query, boolean preview) throws IOExce
 	}
 
 	public AudioItem getAlbum(String id, boolean preview) throws IOException {
-		var json = this.getJson(API_BASE + "albums/" + id);
+		var json = this.getJson(API_BASE + "albums/" + id, false, this.preferAnonymousToken);
 		if (json == null) {
 			return AudioReference.NO_TRACK;
 		}
 
-		var artistJson = this.getJson(API_BASE + "artists/" + json.get("artists").index(0).get("id").text());
+		var artistJson = this.getJson(API_BASE + "artists/" + json.get("artists").index(0).get("id").text(), false, this.preferAnonymousToken);
 		if (artistJson == null) {
 			artistJson = JsonBrowser.newMap();
 		}
@@ -379,10 +390,10 @@ public AudioItem getAlbum(String id, boolean preview) throws IOException {
 		var offset = 0;
 		var pages = 0;
 		do {
-			page = this.getJson(API_BASE + "albums/" + id + "/tracks?limit=" + ALBUM_MAX_PAGE_ITEMS + "&offset=" + offset);
+			page = this.getJson(API_BASE + "albums/" + id + "/tracks?limit=" + ALBUM_MAX_PAGE_ITEMS + "&offset=" + offset, false, this.preferAnonymousToken);
 			offset += ALBUM_MAX_PAGE_ITEMS;
 
-			var tracksPage = this.getJson(API_BASE + "tracks/?ids=" + page.get("items").values().stream().map(track -> track.get("id").text()).collect(Collectors.joining(",")));
+			var tracksPage = this.getJson(API_BASE + "tracks/?ids=" + page.get("items").values().stream().map(track -> track.get("id").text()).collect(Collectors.joining(",")), false, this.preferAnonymousToken);
 
 			for (var track : tracksPage.get("tracks").values()) {
 				var albumJson = JsonBrowser.newMap();
@@ -407,7 +418,7 @@ public AudioItem getAlbum(String id, boolean preview) throws IOException {
 	}
 
 	public AudioItem getPlaylist(String id, boolean preview) throws IOException {
-		var json = this.getJson(API_BASE + "playlists/" + id);
+		var json = this.getJson(API_BASE + "playlists/" + id, true, false);
 		if (json == null) {
 			return AudioReference.NO_TRACK;
 		}
@@ -417,7 +428,7 @@ public AudioItem getPlaylist(String id, boolean preview) throws IOException {
 		var offset = 0;
 		var pages = 0;
 		do {
-			page = this.getJson(API_BASE + "playlists/" + id + "/tracks?limit=" + PLAYLIST_MAX_PAGE_ITEMS + "&offset=" + offset);
+			page = this.getJson(API_BASE + "playlists/" + id + "/tracks?limit=" + PLAYLIST_MAX_PAGE_ITEMS + "&offset=" + offset, true, false);
 			offset += PLAYLIST_MAX_PAGE_ITEMS;
 
 			for (var value : page.get("items").values()) {
@@ -440,12 +451,12 @@ public AudioItem getPlaylist(String id, boolean preview) throws IOException {
 	}
 
 	public AudioItem getArtist(String id, boolean preview) throws IOException {
-		var json = this.getJson(API_BASE + "artists/" + id);
+		var json = this.getJson(API_BASE + "artists/" + id, false, this.preferAnonymousToken);
 		if (json == null) {
 			return AudioReference.NO_TRACK;
 		}
 
-		var tracksJson = this.getJson(API_BASE + "artists/" + id + "/top-tracks?market=" + this.countryCode);
+		var tracksJson = this.getJson(API_BASE + "artists/" + id + "/top-tracks?market=" + this.countryCode, false, this.preferAnonymousToken);
 		if (tracksJson == null || tracksJson.get("tracks").values().isEmpty()) {
 			return AudioReference.NO_TRACK;
 		}
@@ -458,12 +469,12 @@ public AudioItem getArtist(String id, boolean preview) throws IOException {
 	}
 
 	public AudioItem getTrack(String id, boolean preview) throws IOException {
-		var json = this.getJson(API_BASE + "tracks/" + id);
+		var json = this.getJson(API_BASE + "tracks/" + id, false, this.preferAnonymousToken);
 		if (json == null) {
 			return AudioReference.NO_TRACK;
 		}
 
-		var artistJson = this.getJson(API_BASE + "artists/" + json.get("artists").index(0).get("id").text());
+		var artistJson = this.getJson(API_BASE + "artists/" + json.get("artists").index(0).get("id").text(), false, this.preferAnonymousToken);
 		if (artistJson != null) {
 			json.get("artists").index(0).put("images", artistJson.get("images"));
 		}

main/src/main/java/com/github/topi314/lavasrc/spotify/SpotifyTokenTracker.java

@@ -5,7 +5,6 @@
 import org.apache.http.client.methods.CloseableHttpResponse;
 import org.apache.http.client.methods.HttpGet;
 import org.apache.http.client.methods.HttpPost;
-import org.apache.http.client.methods.HttpUriRequest;
 import org.apache.http.impl.client.CloseableHttpClient;
 import org.apache.http.impl.client.HttpClients;
 import org.apache.http.message.BasicNameValuePair;
@@ -43,6 +42,9 @@ public class SpotifyTokenTracker {
 	private String accessToken;
 	private Instant expires;
 
+	private String anonymousAccessToken;
+	private Instant anonymousExpires;
+
 	private String spDc;
 	private String accountToken;
 	private Instant accountTokenExpire;
@@ -54,8 +56,6 @@ public SpotifyTokenTracker(SpotifySourceManager source, String clientId, String
 
 		if (!hasValidCredentials()) {
 			log.debug("Missing/invalid credentials, falling back to public token.");
-		} else {
-			log.debug("Valid credentials found, ready to request access token.");
 		}
 
 		this.spDc = spDc;
@@ -72,7 +72,14 @@ public void setClientIDS(String clientId, String clientSecret) {
 		this.expires = null;
 	}
 
-	public String getAccessToken() throws IOException {
+	private boolean hasValidCredentials() {
+		return clientId != null && !clientId.isEmpty() && clientSecret != null && !clientSecret.isEmpty();
+	}
+
+	public String getAccessToken(boolean preferAnonymousToken) throws IOException {
+		if (preferAnonymousToken || !hasValidCredentials()) {
+			return this.getAnonymousAccessToken();
+		}
 		if (this.accessToken == null || this.expires == null || this.expires.isBefore(Instant.now())) {
 			synchronized (this) {
 				if (accessToken == null || this.expires == null || this.expires.isBefore(Instant.now())) {
@@ -85,40 +92,48 @@ public String getAccessToken() throws IOException {
 	}
 
 	private void refreshAccessToken() throws IOException {
-		boolean usePublicToken = !hasValidCredentials();
-		HttpUriRequest request;
-
-		if (!usePublicToken) {
-			request = new HttpPost("https://accounts.spotify.com/api/token");
-			request.addHeader("Authorization", "Basic " + Base64.getEncoder().encodeToString((this.clientId + ":" + this.clientSecret).getBytes(StandardCharsets.UTF_8)));
-			((HttpPost) request).setEntity(new UrlEncodedFormEntity(List.of(new BasicNameValuePair("grant_type", "client_credentials")), StandardCharsets.UTF_8));
-		} else {
-			request = new HttpGet(generateGetAccessTokenURL());
-		}
+		var request = new HttpPost("https://accounts.spotify.com/api/token");
+		request.addHeader("Authorization", "Basic " + Base64.getEncoder().encodeToString((this.clientId + ":" + this.clientSecret).getBytes(StandardCharsets.UTF_8)));
+		request.setEntity(new UrlEncodedFormEntity(List.of(new BasicNameValuePair("grant_type", "client_credentials")), StandardCharsets.UTF_8));
 
-		try {
-			var json = LavaSrcTools.fetchResponseAsJson(sourceManager.getHttpInterface(), request);
-			if (!json.get("error").isNull()) {
-				String error = json.get("error").text();
-				log.error("Error while fetching access token: {}", error);
-				throw new RuntimeException("Error while fetching access token: " + error);
-			}
+		var json = LavaSrcTools.fetchResponseAsJson(sourceManager.getHttpInterface(), request);
+		if (json == null) {
+			throw new RuntimeException("No response from Spotify API");
+		}
+		if (!json.get("error").isNull()) {
+			var error = json.get("error").text();
+			throw new RuntimeException("Error while fetching access token: " + error);
+		}
+		accessToken = json.get("access_token").text();
+		expires = Instant.now().plusSeconds(json.get("expires_in").asLong(0));
+	}
 
-			if (!usePublicToken) {
-				accessToken = json.get("access_token").text();
-				expires = Instant.now().plusSeconds(json.get("expires_in").asLong(0));
-			} else {
-				accessToken = json.get("accessToken").text();
-				expires = Instant.ofEpochMilli(json.get("accessTokenExpirationTimestampMs").asLong(0));
+	public String getAnonymousAccessToken() throws IOException {
+		if (this.anonymousAccessToken == null || this.anonymousExpires == null || this.anonymousExpires.isBefore(Instant.now())) {
+			synchronized (this) {
+				if (this.anonymousAccessToken == null || this.anonymousExpires == null || this.anonymousExpires.isBefore(Instant.now())) {
+					log.debug("Anonymous access token is invalid or expired, refreshing token...");
+					this.refreshAnonymousAccessToken();
+				}
 			}
-		} catch (IOException e) {
-			log.error("Access token refreshing failed.", e);
-			throw new RuntimeException("Access token refreshing failed", e);
 		}
+		return this.anonymousAccessToken;
 	}
 
-	private boolean hasValidCredentials() {
-		return clientId != null && !clientId.isEmpty() && clientSecret != null && !clientSecret.isEmpty();
+	private void refreshAnonymousAccessToken() throws IOException {
+		var request = new HttpGet(generateGetAccessTokenURL());
+
+		var json = LavaSrcTools.fetchResponseAsJson(sourceManager.getHttpInterface(), request);
+		if (json == null) {
+			throw new RuntimeException("No response from Spotify API");
+		}
+		if (!json.get("error").isNull()) {
+			var error = json.get("error").text();
+			throw new RuntimeException("Error while fetching access token: " + error);
+		}
+
+		anonymousAccessToken = json.get("accessToken").text();
+		anonymousExpires = Instant.ofEpochMilli(json.get("accessTokenExpirationTimestampMs").asLong(0));
 	}
 
 	public void setSpDc(String spDc) {
@@ -292,4 +307,5 @@ private static byte[] hexStringToByteArray(String s) {
 		}
 		return data;
 	}
+
 }

plugin/src/main/java/com/github/topi314/lavasrc/plugin/LavaSrcPlugin.java

@@ -68,7 +68,7 @@ public LavaSrcPlugin(
 		this.lyricsSourcesConfig = lyricsSourcesConfig;
 
 		if (sourcesConfig.isSpotify() || lyricsSourcesConfig.isSpotify()) {
-			this.spotify = new SpotifySourceManager(spotifyConfig.getClientId(), spotifyConfig.getClientSecret(), spotifyConfig.getSpDc(), spotifyConfig.getCountryCode(), unused -> manager, new DefaultMirroringAudioTrackResolver(pluginConfig.getProviders()));
+			this.spotify = new SpotifySourceManager(spotifyConfig.getClientId(), spotifyConfig.getClientSecret(), spotifyConfig.isPreferAnonymousToken(), spotifyConfig.getSpDc(), spotifyConfig.getCountryCode(), unused -> manager, new DefaultMirroringAudioTrackResolver(pluginConfig.getProviders()));
 			if (spotifyConfig.getPlaylistLoadLimit() > 0) {
 				this.spotify.setPlaylistPageLimit(spotifyConfig.getPlaylistLoadLimit());
 			}
@@ -273,6 +273,9 @@ public void updateConfig(@RequestBody Config config) {
 			if (spotifyConfig.getClientId() != null && spotifyConfig.getClientSecret() != null) {
 				this.spotify.setClientIDSecret(spotifyConfig.getClientId(), spotifyConfig.getClientSecret());
 			}
+			if (spotifyConfig.getPreferAnonymousToken() != null) {
+				this.spotify.setPreferAnonymousToken(spotifyConfig.getPreferAnonymousToken());
+			}
 		}
 
 		var appleMusicConfig = config.getAppleMusic();

plugin/src/main/java/com/github/topi314/lavasrc/plugin/config/SpotifyConfig.java

@@ -15,6 +15,7 @@ public class SpotifyConfig {
 	private int albumLoadLimit = 6;
 	private boolean resolveArtistsInSearch = true;
 	private boolean localFiles = false;
+	private boolean preferAnonymousToken = false;
 
 	public String getClientId() {
 		return this.clientId;
@@ -79,4 +80,12 @@ public boolean isLocalFiles() {
 	public void setLocalFiles(boolean localFiles) {
 		this.localFiles = localFiles;
 	}
+
+	public boolean isPreferAnonymousToken() {
+		return this.preferAnonymousToken;
+	}
+
+	public void setPreferAnonymousToken(boolean preferAnonymousToken) {
+		this.preferAnonymousToken = preferAnonymousToken;
+	}
 }

protocol/src/commonMain/kotlin/com/github/topi314/lavasrc/protocol/Config.kt

@@ -18,6 +18,7 @@ data class SpotifyConfig(
     val clientId: String? = null,
     val clientSecret: String? = null,
     val spDc: String? = null,
+    val preferAnonymousToken: Boolean? = null,
 )
 
 @Serializable