Add optional filter for Soundcloud preview tracks (#181)

* Add optional filter for Soundcloud preview tracks

* Ignore preview filter from already loaded track

Author: freyacodes

main/src/main/java/com/sedmelluq/discord/lavaplayer/source/soundcloud/SoundCloudAudioSourceManager.java

@@ -18,6 +18,7 @@
 import org.apache.http.client.utils.URIBuilder;
 import org.apache.http.impl.client.HttpClientBuilder;
 import org.apache.http.util.EntityUtils;
+import org.jetbrains.annotations.Nullable;
 
 import java.io.DataInput;
 import java.io.DataOutput;
@@ -27,6 +28,7 @@
 import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Objects;
 import java.util.function.Consumer;
 import java.util.function.Function;
 import java.util.regex.Matcher;
@@ -51,6 +53,7 @@ public class SoundCloudAudioSourceManager implements AudioSourceManager, HttpCon
     private static final String SEARCH_PREFIX = "scsearch";
     private static final String SEARCH_PREFIX_DEFAULT = "scsearch:";
     private static final String SEARCH_REGEX = SEARCH_PREFIX + "\\[([0-9]{1,9}),([0-9]{1,9})\\]:\\s*(.*)\\s*";
+    private static final String FULL_TRACK_UNAVAILABLE_MARKER = "SUB_HIGH_TIER";
 
     private static final Pattern mobileUrlPattern = Pattern.compile(MOBILE_URL_REGEX);
     private static final Pattern trackUrlPattern = Pattern.compile(TRACK_URL_REGEX);
@@ -67,14 +70,20 @@ public class SoundCloudAudioSourceManager implements AudioSourceManager, HttpCon
     private final HttpInterfaceManager httpInterfaceManager;
     private final SoundCloudClientIdTracker clientIdTracker;
     private final boolean allowSearch;
+    private final boolean filterOutPreviewTracks;
 
     public static SoundCloudAudioSourceManager createDefault() {
         SoundCloudDataReader dataReader = new DefaultSoundCloudDataReader();
         SoundCloudDataLoader dataLoader = new DefaultSoundCloudDataLoader();
         SoundCloudFormatHandler formatHandler = new DefaultSoundCloudFormatHandler();
 
-        return new SoundCloudAudioSourceManager(true, dataReader, dataLoader, formatHandler,
-            new DefaultSoundCloudPlaylistLoader(dataLoader, dataReader, formatHandler));
+        return new SoundCloudAudioSourceManager(true,
+            dataReader,
+            dataLoader,
+            formatHandler,
+            new DefaultSoundCloudPlaylistLoader(dataLoader, dataReader, formatHandler),
+            false
+        );
     }
 
     public static Builder builder() {
@@ -91,13 +100,15 @@ public SoundCloudAudioSourceManager(
         SoundCloudDataReader dataReader,
         SoundCloudDataLoader dataLoader,
         SoundCloudFormatHandler formatHandler,
-        SoundCloudPlaylistLoader playlistLoader
+        SoundCloudPlaylistLoader playlistLoader,
+        boolean filterOutPreviewTracks
     ) {
         this.allowSearch = allowSearch;
         this.dataReader = dataReader;
         this.dataLoader = dataLoader;
         this.formatHandler = formatHandler;
         this.playlistLoader = playlistLoader;
+        this.filterOutPreviewTracks = filterOutPreviewTracks;
 
         httpInterfaceManager = HttpClientTools.createDefaultThreadLocalManager();
         clientIdTracker = new SoundCloudClientIdTracker(httpInterfaceManager);
@@ -209,7 +220,13 @@ private AudioItem processAsLikedTracks(AudioReference reference) {
         }
     }
 
+    @Nullable
     public AudioTrack loadTrack(String trackWebUrl) {
+        return loadTrack(trackWebUrl, true);
+    }
+
+    @Nullable
+    public AudioTrack loadTrack(String trackWebUrl, boolean honorPreviewFilter) {
         try (HttpInterface httpInterface = getHttpInterface()) {
             JsonBrowser rootData = dataLoader.load(httpInterface, trackWebUrl);
             JsonBrowser trackData = dataReader.findTrackData(rootData);
@@ -218,6 +235,10 @@ public AudioTrack loadTrack(String trackWebUrl) {
                 throw new FriendlyException("This track is not available", COMMON, null);
             }
 
+            if (honorPreviewFilter && filterOutPreviewTracks && Objects.equals(trackData.get("monetization_model").text(), FULL_TRACK_UNAVAILABLE_MARKER)) {
+                return null;
+            }
+
             return loadFromTrackData(trackData);
         } catch (IOException e) {
             throw new FriendlyException("Loading track from SoundCloud failed.", SUSPICIOUS, e);
@@ -363,6 +384,7 @@ public static class Builder {
         private SoundCloudFormatHandler formatHandler;
         private SoundCloudPlaylistLoader playlistLoader;
         private PlaylistLoaderFactory playlistLoaderFactory;
+        private boolean filterOutPreviewTracks = false;
 
         public Builder withAllowSearch(boolean allowSearch) {
             this.allowSearch = allowSearch;
@@ -394,6 +416,16 @@ public Builder withPlaylistLoaderFactory(PlaylistLoaderFactory playlistLoaderFac
             return this;
         }
 
+        /**
+         * Whether to filter out short preview tracks that are only fully available with a Soundcloud subscription.
+         * Lavaplayer does not support getting the full track. Only affects new AudioTracks being loaded by this source,
+         *   with no effect on deserialized tracks.
+         */
+        public Builder withFilterOutPreviewTracks(boolean filterOutPreviewTracks) {
+            this.filterOutPreviewTracks = filterOutPreviewTracks;
+            return this;
+        }
+
         public SoundCloudAudioSourceManager build() {
             SoundCloudDataReader usedDataReader = dataReader;
 
@@ -432,7 +464,8 @@ public SoundCloudAudioSourceManager build() {
                 usedDataReader,
                 usedDataLoader,
                 usedFormatHandler,
-                usedPlaylistLoader
+                usedPlaylistLoader,
+                filterOutPreviewTracks
             );
         }
 

main/src/main/java/com/sedmelluq/discord/lavaplayer/source/soundcloud/SoundCloudAudioTrack.java

@@ -63,7 +63,8 @@ private void playFromIdentifier(
 
         if (!recursion) {
             // Old "track ID" entry? Let's "load" it to get url.
-            AudioTrack track = sourceManager.loadTrack(trackInfo.uri);
+            AudioTrack track = sourceManager.loadTrack(trackInfo.uri, false);
+            //noinspection DataFlowIssue
             playFromIdentifier(httpInterface, track.getIdentifier(), true, localExecutor);
         }
     }