Add SubScene and change subtitle API

Co-authored-by: Aymanbest <51868001+aymanbest@users.noreply.github.com>

app/src/main/java/com/lagradost/cloudstream3/subtitles/AbstractSubProvider.kt

@@ -1,11 +1,22 @@
 package com.lagradost.cloudstream3.subtitles
 
 import androidx.annotation.WorkerThread
+import androidx.core.net.toUri
+import com.lagradost.cloudstream3.app
 import com.lagradost.cloudstream3.subtitles.AbstractSubtitleEntities.SubtitleEntity
 import com.lagradost.cloudstream3.subtitles.AbstractSubtitleEntities.SubtitleSearch
 import com.lagradost.cloudstream3.syncproviders.AuthAPI
+import com.lagradost.cloudstream3.ui.player.SubtitleOrigin
+import okio.BufferedSource
+import okio.buffer
+import okio.sink
+import okio.source
+import java.io.File
+import java.util.zip.ZipInputStream
 
 interface AbstractSubProvider {
+    val idPrefix: String
+
     @WorkerThread
     suspend fun search(query: SubtitleSearch): List<SubtitleEntity>? {
         throw NotImplementedError()
@@ -15,6 +26,94 @@ interface AbstractSubProvider {
     suspend fun load(data: SubtitleEntity): String? {
         throw NotImplementedError()
     }
+
+    @WorkerThread
+    suspend fun SubtitleResource.getResources(data: SubtitleEntity) {
+        this.addUrl(load(data))
+    }
+
+    @WorkerThread
+    suspend fun getResource(data: SubtitleEntity): SubtitleResource {
+        return SubtitleResource().apply {
+            this.getResources(data)
+        }
+    }
+}
+
+/**
+ * A builder for subtitle files.
+ * @see addUrl
+ * @see addFile
+ */
+class SubtitleResource {
+    fun downloadFile(source: BufferedSource): File {
+        val file = File.createTempFile("temp-subtitle", ".tmp").apply {
+            deleteOnExit()
+        }
+        val sink = file.sink().buffer()
+        sink.writeAll(source)
+        sink.close()
+        source.close()
+
+        return file
+    }
+
+    fun unzip(file: File): List<Pair<String, File>> {
+        val entries = mutableListOf<Pair<String, File>>()
+
+        ZipInputStream(file.inputStream()).use { zipInputStream ->
+            var zipEntry = zipInputStream.nextEntry
+
+            while (zipEntry != null) {
+                val tempFile = File.createTempFile("unzipped-subtitle", ".tmp").apply {
+                    deleteOnExit()
+                }
+                entries.add(zipEntry.name to tempFile)
+
+                tempFile.sink().buffer().use { buffer ->
+                    buffer.writeAll(zipInputStream.source())
+                }
+
+                zipEntry = zipInputStream.nextEntry
+            }
+        }
+        return entries
+    }
+
+    data class SingleSubtitleResource(
+        val name: String?,
+        val url: String,
+        val origin: SubtitleOrigin
+    )
+
+    private var resources: MutableList<SingleSubtitleResource> = mutableListOf()
+
+    fun getSubtitles(): List<SingleSubtitleResource> {
+        return resources.toList()
+    }
+
+    fun addUrl(url: String?, name: String? = null) {
+        if (url == null) return
+        this.resources.add(
+            SingleSubtitleResource(name, url, SubtitleOrigin.URL)
+        )
+    }
+
+    fun addFile(file: File, name: String? = null) {
+        this.resources.add(
+            SingleSubtitleResource(name, file.toUri().toString(), SubtitleOrigin.DOWNLOADED_FILE)
+        )
+        file.deleteOnExit() // Remove?
+    }
+
+    suspend fun addZipUrl(url: String, nameGenerator: (String, File) -> String? = { _, _ -> null }) {
+        val source = app.get(url).okhttpResponse.body.source()
+        val zip = downloadFile(source)
+        val realFiles = unzip(zip)
+        realFiles.forEach { (name, subtitleFile) ->
+            addFile(subtitleFile, nameGenerator(name, subtitleFile))
+        }
+    }
 }
 
 interface AbstractSubApi : AbstractSubProvider, AuthAPI

app/src/main/java/com/lagradost/cloudstream3/syncproviders/AccountManager.kt

@@ -3,6 +3,7 @@ package com.lagradost.cloudstream3.syncproviders
 import com.lagradost.cloudstream3.AcraApplication.Companion.getKey
 import com.lagradost.cloudstream3.AcraApplication.Companion.removeKeys
 import com.lagradost.cloudstream3.AcraApplication.Companion.setKey
+import com.lagradost.cloudstream3.syncproviders.providers.SubScene
 import com.lagradost.cloudstream3.syncproviders.providers.*
 import java.util.concurrent.TimeUnit
 
@@ -14,6 +15,7 @@ abstract class AccountManager(private val defIndex: Int) : AuthAPI {
         val simklApi = SimklApi(0)
         val indexSubtitlesApi = IndexSubtitleApi()
         val addic7ed = Addic7ed()
+        val subScene = SubScene()
         val localListApi = LocalList()
 
         // used to login via app intent
@@ -41,7 +43,8 @@ abstract class AccountManager(private val defIndex: Int) : AuthAPI {
             get() = listOf(
                 openSubtitlesApi,
                 indexSubtitlesApi, // they got anti scraping measures in place :(
-                addic7ed
+                addic7ed,
+                subScene
             )
 
         const val appString = "cloudstreamapp"

app/src/main/java/com/lagradost/cloudstream3/syncproviders/providers/IndexSubtitleApi.kt

@@ -23,6 +23,47 @@ class IndexSubtitleApi : AbstractSubApi {
     companion object {
         const val host = "https://indexsubtitle.com"
         const val TAG = "INDEXSUBS"
+
+        fun getOrdinal(num: Int?): String? {
+            return when (num) {
+                1 -> "First"
+                2 -> "Second"
+                3 -> "Third"
+                4 -> "Fourth"
+                5 -> "Fifth"
+                6 -> "Sixth"
+                7 -> "Seventh"
+                8 -> "Eighth"
+                9 -> "Ninth"
+                10 -> "Tenth"
+                11 -> "Eleventh"
+                12 -> "Twelfth"
+                13 -> "Thirteenth"
+                14 -> "Fourteenth"
+                15 -> "Fifteenth"
+                16 -> "Sixteenth"
+                17 -> "Seventeenth"
+                18 -> "Eighteenth"
+                19 -> "Nineteenth"
+                20 -> "Twentieth"
+                21 -> "Twenty-First"
+                22 -> "Twenty-Second"
+                23 -> "Twenty-Third"
+                24 -> "Twenty-Fourth"
+                25 -> "Twenty-Fifth"
+                26 -> "Twenty-Sixth"
+                27 -> "Twenty-Seventh"
+                28 -> "Twenty-Eighth"
+                29 -> "Twenty-Ninth"
+                30 -> "Thirtieth"
+                31 -> "Thirty-First"
+                32 -> "Thirty-Second"
+                33 -> "Thirty-Third"
+                34 -> "Thirty-Fourth"
+                35 -> "Thirty-Fifth"
+                else -> null
+            }
+        }
     }
 
     private fun fixUrl(url: String): String {
@@ -44,47 +85,6 @@ class IndexSubtitleApi : AbstractSubApi {
         }
     }
 
-    private fun getOrdinal(num: Int?): String? {
-        return when (num) {
-            1 -> "First"
-            2 -> "Second"
-            3 -> "Third"
-            4 -> "Fourth"
-            5 -> "Fifth"
-            6 -> "Sixth"
-            7 -> "Seventh"
-            8 -> "Eighth"
-            9 -> "Ninth"
-            10 -> "Tenth"
-            11 -> "Eleventh"
-            12 -> "Twelfth"
-            13 -> "Thirteenth"
-            14 -> "Fourteenth"
-            15 -> "Fifteenth"
-            16 -> "Sixteenth"
-            17 -> "Seventeenth"
-            18 -> "Eighteenth"
-            19 -> "Nineteenth"
-            20 -> "Twentieth"
-            21 -> "Twenty-First"
-            22 -> "Twenty-Second"
-            23 -> "Twenty-Third"
-            24 -> "Twenty-Fourth"
-            25 -> "Twenty-Fifth"
-            26 -> "Twenty-Sixth"
-            27 -> "Twenty-Seventh"
-            28 -> "Twenty-Eighth"
-            29 -> "Twenty-Ninth"
-            30 -> "Thirtieth"
-            31 -> "Thirty-First"
-            32 -> "Thirty-Second"
-            33 -> "Thirty-Third"
-            34 -> "Thirty-Fourth"
-            35 -> "Thirty-Fifth"
-            else -> null
-        }
-    }
-
     private fun isRightEps(text: String, seasonNum: Int?, epNum: Int?): Boolean {
         val FILTER_EPS_REGEX =
             Regex("(?i)((Chapter\\s?0?${epNum})|((Season)?\\s?0?${seasonNum}?\\s?(Episode)\\s?0?${epNum}[^0-9]))|(?i)((S?0?${seasonNum}?E0?${epNum}[^0-9])|(0?${seasonNum}[a-z]0?${epNum}[^0-9]))")

app/src/main/java/com/lagradost/cloudstream3/syncproviders/providers/SubScene.kt

@@ -0,0 +1,118 @@
+package com.lagradost.cloudstream3.syncproviders.providers
+
+import com.lagradost.cloudstream3.app
+import com.lagradost.cloudstream3.mvvm.debugPrint
+import com.lagradost.cloudstream3.subtitles.AbstractSubProvider
+import com.lagradost.cloudstream3.subtitles.AbstractSubtitleEntities
+import com.lagradost.cloudstream3.subtitles.SubtitleResource
+import com.lagradost.cloudstream3.syncproviders.providers.IndexSubtitleApi.Companion.getOrdinal
+import com.lagradost.cloudstream3.utils.SubtitleHelper
+
+class SubScene : AbstractSubProvider {
+    val mainUrl = "https://subscene.com"
+    val name = "Subscene"
+    override val idPrefix = "subscene"
+
+    override suspend fun search(query: AbstractSubtitleEntities.SubtitleSearch): List<AbstractSubtitleEntities.SubtitleEntity>? {
+        val seasonName =
+            query.seasonNumber?.let { number ->
+                // Need to translate "7" to "Seventh Season"
+                getOrdinal(number)?.let { words -> " - $words Season" }
+            } ?: ""
+
+        val fullQuery = query.query + seasonName
+
+        val doc = app.post(
+            "$mainUrl/subtitles/searchbytitle",
+            data = mapOf("query" to fullQuery, "l" to "")
+        ).document
+
+        return doc.select("div.title a").map { element ->
+            val href = "$mainUrl${element.attr("href")}"
+            val title = element.text()
+
+            AbstractSubtitleEntities.SubtitleEntity(
+                idPrefix = idPrefix,
+                name = title,
+                source = name,
+                data = href,
+                lang = query.lang ?: "en",
+                epNumber = query.epNumber
+            )
+        }.distinctBy { it.data }
+    }
+
+    override suspend fun SubtitleResource.getResources(data: AbstractSubtitleEntities.SubtitleEntity) {
+        val resultDoc = app.get(data.data).document
+        val queryLanguage = SubtitleHelper.fromTwoLettersToLanguage(data.lang) ?: "English"
+
+        val results = resultDoc.select("table tbody tr").mapNotNull { element ->
+            val anchor = element.select("a")
+            val href = anchor.attr("href") ?: return@mapNotNull null
+            val fixedHref = "$mainUrl${href}"
+            val spans = anchor.select("span")
+            val language = spans.firstOrNull()?.text()
+            val title = spans.getOrNull(1)?.text()
+            val isPositive = anchor.select("span.positive-icon").isNotEmpty()
+
+            TableElement(title, language, fixedHref, isPositive)
+        }.sortedBy {
+            it.getScore(queryLanguage, data.epNumber)
+        }
+
+        debugPrint { "$name found subtitles: ${results.takeLast(3)}" }
+        // Last = highest score
+        val selectedResult = results.lastOrNull() ?: return
+
+        val subtitleDocument = app.get(selectedResult.href).document
+        val subtitleDownloadUrl =
+            "$mainUrl${subtitleDocument.select("div.download a").attr("href")}"
+
+        this.addZipUrl(subtitleDownloadUrl) { name, _ ->
+            name
+        }
+    }
+
+    /**
+     * Class to manage the various different subtitle results and rank them.
+     */
+    data class TableElement(
+        val title: String?,
+        val language: String?,
+        val href: String,
+        val isPositive: Boolean
+    ) {
+        private fun matchesLanguage(other: String): Boolean {
+            return language != null && (language.contains(other, ignoreCase = true) ||
+                    other.contains(language, ignoreCase = true))
+        }
+
+        /**
+         * Scores in this order:
+         * Preferred Language > Episode number > Positive rating > English Language
+         */
+        fun getScore(queryLanguage: String, episodeNum: Int?): Int {
+            var score = 0
+            if (this.matchesLanguage(queryLanguage)) {
+                score += 8
+            }
+            // Matches Episode 7 using "E07" with any number of leading zeroes
+            if (episodeNum != null && title != null && title.contains(
+                    Regex(
+                        """E0*${episodeNum}""",
+                        RegexOption.IGNORE_CASE
+                    )
+                )
+            ) {
+                score += 4
+            }
+            if (isPositive) {
+                score += 2
+            }
+            if (this.matchesLanguage("English")) {
+                score += 1
+            }
+            return score
+        }
+    }
+}

app/src/main/java/com/lagradost/cloudstream3/ui/player/GeneratorPlayer.kt

@@ -30,6 +30,7 @@ import com.lagradost.cloudstream3.databinding.FragmentPlayerBinding
 import com.lagradost.cloudstream3.databinding.PlayerSelectSourceAndSubsBinding
 import com.lagradost.cloudstream3.databinding.PlayerSelectTracksBinding
 import com.lagradost.cloudstream3.mvvm.*
+import com.lagradost.cloudstream3.subtitles.AbstractSubApi
 import com.lagradost.cloudstream3.subtitles.AbstractSubtitleEntities
 import com.lagradost.cloudstream3.syncproviders.AccountManager.Companion.subtitleProviders
 import com.lagradost.cloudstream3.ui.player.CS3IPlayer.Companion.preferredAudioTrackLanguage
@@ -69,7 +70,10 @@ class GeneratorPlayer : FullScreenPlayer() {
         }
 
         val subsProviders
-            get() = subtitleProviders.filter { !it.requiresLogin || it.loginInfo() != null }
+            get() = subtitleProviders.filter { provider ->
+                (provider as? AbstractSubApi)?.let { !it.requiresLogin || it.loginInfo() != null }
+                    ?: true
+            }
         val subsProvidersIsActive
             get() = subsProviders.isNotEmpty()
     }
@@ -147,7 +151,7 @@ class GeneratorPlayer : FullScreenPlayer() {
     }
 
     override fun playerStatusChanged() {
-        if(player.getIsPlaying()){
+        if (player.getIsPlaying()) {
             viewModel.forceClearCache = false
         }
     }
@@ -473,17 +477,21 @@ class GeneratorPlayer : FullScreenPlayer() {
             currentSubtitle?.let { currentSubtitle ->
                 providers.firstOrNull { it.idPrefix == currentSubtitle.idPrefix }?.let { api ->
                     ioSafe {
-                        val url = api.load(currentSubtitle) ?: return@ioSafe
+                        val subtitles =
-                        val subtitle = SubtitleData(
+                            api.getResource(currentSubtitle).getSubtitles().map { resource ->
-                            name = getName(currentSubtitle, true),
+                                SubtitleData(
-                            url = url,
+                                    name = resource.name ?: getName(currentSubtitle, true),
-                            origin = SubtitleOrigin.URL,
+                                    url = resource.url,
-                            mimeType = url.toSubtitleMimeType(),
+                                    origin = resource.origin,
-                            headers = currentSubtitle.headers,
+                                    mimeType = resource.url.toSubtitleMimeType(),
-                            currentSubtitle.lang
+                                    headers = currentSubtitle.headers,
-                        )
+                                    currentSubtitle.lang
-                        runOnMainThread {
+                                )
-                            addAndSelectSubtitles(subtitle)
+                            }
+                        if (subtitles.isNotEmpty()) {
+                            runOnMainThread {
+                                addAndSelectSubtitles(*subtitles.toTypedArray())
+                            }
                         }
                     }
                 }
@@ -521,7 +529,11 @@ class GeneratorPlayer : FullScreenPlayer() {
         }
     }
 
-    private fun addAndSelectSubtitles(subtitleData: SubtitleData) {
+    private fun addAndSelectSubtitles(
+        vararg subtitleData: SubtitleData
+    ) {
+        if (subtitleData.isEmpty()) return
+        val selectedSubtitle = subtitleData.first()
         val ctx = context ?: return
 
         val subs = currentSubs + subtitleData
@@ -533,13 +545,13 @@ class GeneratorPlayer : FullScreenPlayer() {
         player.saveData()
         player.reloadPlayer(ctx)
 
-        setSubtitles(subtitleData)
+        setSubtitles(selectedSubtitle)
-        viewModel.addSubtitles(setOf(subtitleData))
+        viewModel.addSubtitles(subtitleData.toSet())
 
         selectSourceDialog?.dismissSafe()
 
         showToast(
-            String.format(ctx.getString(R.string.player_loaded_subtitles), subtitleData.name),
+            String.format(ctx.getString(R.string.player_loaded_subtitles), selectedSubtitle.name),
             Toast.LENGTH_LONG
         )
     }
@@ -919,7 +931,7 @@ class GeneratorPlayer : FullScreenPlayer() {
 
     override fun playerError(exception: Throwable) {
         Log.i(TAG, "playerError = $currentSelectedLink")
-        if(!hasNextMirror()){
+        if (!hasNextMirror()) {
             viewModel.forceClearCache = true
         }
         super.playerError(exception)