├── library
├── .gitignore
├── src
│ └── main
│ │ ├── AndroidManifest.xml
│ │ └── java
│ │ ├── android
│ │ └── content
│ │ │ └── Context.java
│ │ ├── eu
│ │ └── kanade
│ │ │ └── tachiyomi
│ │ │ ├── source
│ │ │ ├── model
│ │ │ │ ├── MangasPage.kt
│ │ │ │ ├── UpdateStrategy.kt
│ │ │ │ ├── FilterList.kt
│ │ │ │ ├── Page.kt
│ │ │ │ ├── SChapter.kt
│ │ │ │ ├── SManga.kt
│ │ │ │ └── Filter.kt
│ │ │ ├── ConfigurableSource.kt
│ │ │ ├── UnmeteredSource.kt
│ │ │ ├── SourceFactory.kt
│ │ │ ├── CatalogueSource.kt
│ │ │ ├── Source.kt
│ │ │ └── online
│ │ │ │ ├── ParsedHttpSource.kt
│ │ │ │ └── HttpSource.kt
│ │ │ ├── network
│ │ │ ├── NetworkHelper.kt
│ │ │ ├── OkHttpExtensions.kt
│ │ │ ├── JavaScriptEngine.kt
│ │ │ ├── interceptor
│ │ │ │ ├── RateLimitInterceptor.kt
│ │ │ │ └── SpecificHostRateLimitInterceptor.kt
│ │ │ └── Requests.kt
│ │ │ ├── util
│ │ │ └── JsoupExtensions.kt
│ │ │ └── AppInfo.kt
│ │ └── androidx
│ │ └── preference
│ │ ├── CheckBoxPreference.java
│ │ ├── SwitchPreferenceCompat.java
│ │ ├── PreferenceScreen.java
│ │ ├── DialogPreference.java
│ │ ├── EditTextPreference.java
│ │ ├── TwoStatePreference.java
│ │ ├── MultiSelectListPreference.java
│ │ ├── ListPreference.java
│ │ └── Preference.java
├── proguard-rules.pro
└── build.gradle
├── settings.gradle.kts
├── .jitpack.yml
├── .gitignore
├── gradle
└── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── README.md
├── gradle.properties
├── gradlew.bat
├── gradlew
└── LICENSE
/library/.gitignore:
--------------------------------------------------------------------------------
1 | /build
2 |
--------------------------------------------------------------------------------
/settings.gradle.kts:
--------------------------------------------------------------------------------
1 | include(":library")
2 |
--------------------------------------------------------------------------------
/library/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/.jitpack.yml:
--------------------------------------------------------------------------------
1 | jdk:
2 | - openjdk17
3 | install:
4 | - ./gradlew build :library:publishToMavenLocal
5 |
--------------------------------------------------------------------------------
/library/src/main/java/android/content/Context.java:
--------------------------------------------------------------------------------
1 | package android.content;
2 |
3 | public class Context {}
4 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | .gradle
2 | /local.properties
3 | /.idea/workspace.xml
4 | .DS_Store
5 | /build
6 | .idea/
7 | *iml
8 | *.iml
9 | */build
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/tachiyomiorg/extensions-lib/HEAD/gradle/wrapper/gradle-wrapper.jar
--------------------------------------------------------------------------------
/library/src/main/java/eu/kanade/tachiyomi/source/model/MangasPage.kt:
--------------------------------------------------------------------------------
1 | package eu.kanade.tachiyomi.source.model
2 |
3 | data class MangasPage(val mangas: List, val hasNextPage: Boolean)
--------------------------------------------------------------------------------
/library/src/main/java/eu/kanade/tachiyomi/source/model/UpdateStrategy.kt:
--------------------------------------------------------------------------------
1 | package eu.kanade.tachiyomi.source.model
2 |
3 | @Suppress("unused")
4 | enum class UpdateStrategy {
5 | ALWAYS_UPDATE,
6 | ONLY_FETCH_ONCE
7 | }
8 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | The extensions library used in Tachiyomi.
2 |
3 | ```
4 | ext {
5 | libVersion = '1.4'
6 | }
7 |
8 | dependencies {
9 | compileOnly "com.github.tachiyomiorg:extensions-lib:$libVersion"
10 | }
11 | ```
12 |
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | distributionBase=GRADLE_USER_HOME
2 | distributionPath=wrapper/dists
3 | distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip
4 | zipStoreBase=GRADLE_USER_HOME
5 | zipStorePath=wrapper/dists
6 |
--------------------------------------------------------------------------------
/library/src/main/java/eu/kanade/tachiyomi/source/ConfigurableSource.kt:
--------------------------------------------------------------------------------
1 | package eu.kanade.tachiyomi.source
2 |
3 | import androidx.preference.PreferenceScreen
4 |
5 | @Suppress("unused")
6 | interface ConfigurableSource {
7 |
8 | fun setupPreferenceScreen(screen: PreferenceScreen)
9 |
10 | }
11 |
--------------------------------------------------------------------------------
/library/src/main/java/eu/kanade/tachiyomi/source/UnmeteredSource.kt:
--------------------------------------------------------------------------------
1 | package eu.kanade.tachiyomi.source
2 |
3 | /**
4 | * A source that explicitly doesn't require traffic considerations.
5 | *
6 | * This typically applies for self-hosted sources.
7 | */
8 | @Suppress("unused")
9 | interface UnmeteredSource
10 |
--------------------------------------------------------------------------------
/library/src/main/java/eu/kanade/tachiyomi/source/model/FilterList.kt:
--------------------------------------------------------------------------------
1 | package eu.kanade.tachiyomi.source.model
2 |
3 | @Suppress("unused")
4 | data class FilterList(val list: List>) : List> by list {
5 |
6 | constructor(vararg fs: Filter<*>) : this(if (fs.isNotEmpty()) fs.asList() else emptyList())
7 |
8 | }
--------------------------------------------------------------------------------
/library/src/main/java/eu/kanade/tachiyomi/source/model/Page.kt:
--------------------------------------------------------------------------------
1 | package eu.kanade.tachiyomi.source.model
2 |
3 | import android.net.Uri
4 |
5 | @Suppress("unused")
6 | class Page(
7 | val index: Int,
8 | val url: String = "",
9 | var imageUrl: String? = null,
10 | var uri: Uri? = null
11 | )
12 |
--------------------------------------------------------------------------------
/library/src/main/java/androidx/preference/CheckBoxPreference.java:
--------------------------------------------------------------------------------
1 | package androidx.preference;
2 |
3 | import android.content.Context;
4 |
5 | public class CheckBoxPreference extends TwoStatePreference {
6 |
7 | public CheckBoxPreference(Context context) {
8 | super(context);
9 | throw new RuntimeException("Stub!");
10 | }
11 |
12 | }
13 |
--------------------------------------------------------------------------------
/library/src/main/java/eu/kanade/tachiyomi/network/NetworkHelper.kt:
--------------------------------------------------------------------------------
1 | package eu.kanade.tachiyomi.network
2 |
3 | import android.content.Context
4 | import okhttp3.OkHttpClient
5 |
6 | class NetworkHelper(context: Context) {
7 |
8 | val client: OkHttpClient = throw Exception("Stub!")
9 |
10 | val cloudflareClient: OkHttpClient = throw Exception("Stub!")
11 | }
--------------------------------------------------------------------------------
/library/src/main/java/androidx/preference/SwitchPreferenceCompat.java:
--------------------------------------------------------------------------------
1 | package androidx.preference;
2 |
3 | import android.content.Context;
4 |
5 | public class SwitchPreferenceCompat extends TwoStatePreference {
6 |
7 | public SwitchPreferenceCompat(Context context) {
8 | super(context);
9 | throw new RuntimeException("Stub!");
10 | }
11 |
12 | }
13 |
--------------------------------------------------------------------------------
/library/src/main/java/eu/kanade/tachiyomi/source/SourceFactory.kt:
--------------------------------------------------------------------------------
1 | package eu.kanade.tachiyomi.source
2 |
3 | /**
4 | * A factory for creating sources at runtime.
5 | */
6 | @Suppress("unused")
7 | interface SourceFactory {
8 | /**
9 | * Create a new copy of the sources
10 | * @return The created sources
11 | */
12 | fun createSources(): List
13 | }
14 |
--------------------------------------------------------------------------------
/library/src/main/java/androidx/preference/PreferenceScreen.java:
--------------------------------------------------------------------------------
1 | package androidx.preference;
2 |
3 | import android.content.Context;
4 |
5 | public class PreferenceScreen {
6 |
7 | public boolean addPreference(Preference preference) {
8 | throw new RuntimeException("Stub!");
9 | }
10 |
11 | public Context getContext() {
12 | throw new RuntimeException("Stub!");
13 | }
14 |
15 | }
16 |
--------------------------------------------------------------------------------
/library/src/main/java/eu/kanade/tachiyomi/network/OkHttpExtensions.kt:
--------------------------------------------------------------------------------
1 | package eu.kanade.tachiyomi.network
2 |
3 | import okhttp3.Call
4 | import okhttp3.Response
5 | import rx.Observable
6 |
7 | fun Call.asObservable(): Observable = throw Exception("Stub!")
8 |
9 | fun Call.asObservableSuccess(): Observable = throw Exception("Stub!")
10 |
11 | suspend fun Call.await(): Response = throw Exception("Stub!")
12 |
--------------------------------------------------------------------------------
/library/src/main/java/eu/kanade/tachiyomi/util/JsoupExtensions.kt:
--------------------------------------------------------------------------------
1 | package eu.kanade.tachiyomi.util
2 |
3 | import okhttp3.Response
4 | import org.jsoup.nodes.Document
5 |
6 | /**
7 | * Returns a Jsoup document for this response.
8 | * @param html the body of the response. Use only if the body was read before calling this method.
9 | */
10 | fun Response.asJsoup(html: String? = null): Document {
11 | throw Exception("Stub!")
12 | }
--------------------------------------------------------------------------------
/library/src/main/java/eu/kanade/tachiyomi/source/model/SChapter.kt:
--------------------------------------------------------------------------------
1 | package eu.kanade.tachiyomi.source.model
2 |
3 | @Suppress("unused")
4 | interface SChapter {
5 |
6 | var url: String
7 |
8 | var name: String
9 |
10 | var date_upload: Long
11 |
12 | var chapter_number: Float
13 |
14 | var scanlator: String?
15 |
16 | companion object {
17 | fun create(): SChapter {
18 | throw Exception("Stub!")
19 | }
20 | }
21 | }
--------------------------------------------------------------------------------
/library/src/main/java/eu/kanade/tachiyomi/network/JavaScriptEngine.kt:
--------------------------------------------------------------------------------
1 | package eu.kanade.tachiyomi.network
2 |
3 | import android.content.Context
4 |
5 | /**
6 | * Util for evaluating JavaScript in sources.
7 | */
8 | class JavaScriptEngine(context: Context) {
9 |
10 | /**
11 | * Evaluate arbitrary JavaScript code and get the result as a primtive type
12 | * (e.g., String, Int).
13 | *
14 | * @since extensions-lib 1.4
15 | * @param script JavaScript to execute.
16 | * @return Result of JavaScript code as a primitive type.
17 | */
18 | suspend fun evaluate(script: String): T = throw Exception("Stub!")
19 | }
--------------------------------------------------------------------------------
/library/src/main/java/androidx/preference/DialogPreference.java:
--------------------------------------------------------------------------------
1 | package androidx.preference;
2 |
3 | public abstract class DialogPreference extends Preference {
4 |
5 | public CharSequence getDialogTitle() {
6 | throw new RuntimeException("Stub!");
7 | }
8 |
9 | public void setDialogTitle(CharSequence dialogTitle) {
10 | throw new RuntimeException("Stub!");
11 | }
12 |
13 | public CharSequence getDialogMessage() {
14 | throw new RuntimeException("Stub!");
15 | }
16 |
17 | public void setDialogMessage(CharSequence dialogMessage) {
18 | throw new RuntimeException("Stub!");
19 | }
20 |
21 | }
22 |
--------------------------------------------------------------------------------
/library/proguard-rules.pro:
--------------------------------------------------------------------------------
1 | # Add project specific ProGuard rules here.
2 | # By default, the flags in this file are appended to flags specified
3 | # in C:\Users\len\AppData\Local\Android\Sdk/tools/proguard/proguard-android.txt
4 | # You can edit the include path and order by changing the proguardFiles
5 | # directive in build.gradle.
6 | #
7 | # For more details, see
8 | # http://developer.android.com/guide/developing/tools/proguard.html
9 |
10 | # Add any project specific keep options here:
11 |
12 | # If your project uses WebView with JS, uncomment the following
13 | # and specify the fully qualified class name to the JavaScript interface
14 | # class:
15 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview {
16 | # public *;
17 | #}
18 |
--------------------------------------------------------------------------------
/library/src/main/java/eu/kanade/tachiyomi/AppInfo.kt:
--------------------------------------------------------------------------------
1 | package eu.kanade.tachiyomi
2 |
3 | object AppInfo {
4 | /**
5 | * Version code of the host application. May be useful for sharing as User-Agent information.
6 | * Note that this value differs between forks so logic should not rely on it.
7 | *
8 | * @since extension-lib 1.3
9 | */
10 | fun getVersionCode(): Int = throw Exception("Stub!")
11 |
12 | /**
13 | * Version name of the host application. May be useful for sharing as User-Agent information.
14 | * Note that this value differs between forks so logic should not rely on it.
15 | *
16 | * @since extension-lib 1.3
17 | */
18 | fun getVersionName(): String = throw Exception("Stub!")
19 | }
20 |
--------------------------------------------------------------------------------
/gradle.properties:
--------------------------------------------------------------------------------
1 | # Project-wide Gradle settings.
2 |
3 | # IDE (e.g. Android Studio) users:
4 | # Gradle settings configured through the IDE *will override*
5 | # any settings specified in this file.
6 |
7 | # For more details on how to configure your build environment visit
8 | # http://www.gradle.org/docs/current/userguide/build_environment.html
9 |
10 | # Specifies the JVM arguments used for the daemon process.
11 | # The setting is particularly useful for tweaking memory settings.
12 | org.gradle.jvmargs=-Xmx1536m
13 |
14 | # When configured, Gradle will run in incubating parallel mode.
15 | # This option should only be used with decoupled projects. More details, visit
16 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
17 | # org.gradle.parallel=true
18 |
--------------------------------------------------------------------------------
/library/src/main/java/eu/kanade/tachiyomi/source/model/SManga.kt:
--------------------------------------------------------------------------------
1 | package eu.kanade.tachiyomi.source.model
2 |
3 | @Suppress("unused")
4 | interface SManga {
5 |
6 | var url: String
7 |
8 | var title: String
9 |
10 | var artist: String?
11 |
12 | var author: String?
13 |
14 | var description: String?
15 |
16 | var genre: String?
17 |
18 | var status: Int
19 |
20 | var thumbnail_url: String?
21 |
22 | var update_strategy: UpdateStrategy
23 |
24 | var initialized: Boolean
25 |
26 | companion object {
27 | const val UNKNOWN = 0
28 | const val ONGOING = 1
29 | const val COMPLETED = 2
30 | const val LICENSED = 3
31 | const val PUBLISHING_FINISHED = 4
32 | const val CANCELLED = 5
33 | const val ON_HIATUS = 6
34 |
35 | fun create(): SManga {
36 | throw Exception("Stub!")
37 | }
38 | }
39 | }
--------------------------------------------------------------------------------
/library/src/main/java/eu/kanade/tachiyomi/network/interceptor/RateLimitInterceptor.kt:
--------------------------------------------------------------------------------
1 | package eu.kanade.tachiyomi.network.interceptor
2 |
3 | import okhttp3.OkHttpClient
4 | import java.util.concurrent.TimeUnit
5 |
6 | /**
7 | * An OkHttp interceptor that handles rate limiting.
8 | *
9 | * Examples:
10 | *
11 | * permits = 5, period = 1, unit = seconds => 5 requests per second
12 | * permits = 10, period = 2, unit = minutes => 10 requests per 2 minutes
13 | *
14 | * @since extension-lib 1.3
15 | *
16 | * @param permits {Int} Number of requests allowed within a period of units.
17 | * @param period {Long} The limiting duration. Defaults to 1.
18 | * @param unit {TimeUnit} The unit of time for the period. Defaults to seconds.
19 | */
20 | fun OkHttpClient.Builder.rateLimit(
21 | permits: Int,
22 | period: Long = 1,
23 | unit: TimeUnit = TimeUnit.SECONDS,
24 | ): OkHttpClient.Builder = throw Exception("Stub!")
--------------------------------------------------------------------------------
/library/src/main/java/androidx/preference/EditTextPreference.java:
--------------------------------------------------------------------------------
1 | package androidx.preference;
2 |
3 | import android.content.Context;
4 | import android.widget.EditText;
5 |
6 | public class EditTextPreference extends DialogPreference {
7 |
8 | public EditTextPreference(Context context) {
9 | throw new RuntimeException("Stub!");
10 | }
11 |
12 | public String getText() {
13 | throw new RuntimeException("Stub!");
14 | }
15 |
16 | public void setText(String text) {
17 | throw new RuntimeException("Stub!");
18 | }
19 |
20 | public void setOnBindEditTextListener(OnBindEditTextListener onBindEditTextListener) {
21 | throw new RuntimeException("Stub!");
22 | }
23 |
24 | OnBindEditTextListener getOnBindEditTextListener() {
25 | throw new RuntimeException("Stub!");
26 | }
27 |
28 | public interface OnBindEditTextListener {
29 | void onBindEditText(EditText editText);
30 | }
31 | }
32 |
--------------------------------------------------------------------------------
/library/src/main/java/androidx/preference/TwoStatePreference.java:
--------------------------------------------------------------------------------
1 | package androidx.preference;
2 |
3 | import android.content.Context;
4 |
5 | public class TwoStatePreference extends Preference {
6 |
7 | public TwoStatePreference(Context context) { throw new RuntimeException("Stub!"); }
8 |
9 | public boolean isChecked() { throw new RuntimeException("Stub!"); }
10 |
11 | public void setChecked(boolean checked) { throw new RuntimeException("Stub!"); }
12 |
13 | public CharSequence getSummaryOn() { throw new RuntimeException("Stub!"); }
14 |
15 | public void setSummaryOn(CharSequence summary) { throw new RuntimeException("Stub!"); }
16 |
17 | public CharSequence getSummaryOff() { throw new RuntimeException("Stub!"); }
18 |
19 | public void setSummaryOff(CharSequence summary) { throw new RuntimeException("Stub!"); }
20 |
21 | public boolean getDisableDependentsState() { throw new RuntimeException("Stub!"); }
22 |
23 | public void setDisableDependentsState(boolean disableDependentsState) { throw new RuntimeException("Stub!"); }
24 |
25 | }
26 |
--------------------------------------------------------------------------------
/library/src/main/java/eu/kanade/tachiyomi/network/Requests.kt:
--------------------------------------------------------------------------------
1 | package eu.kanade.tachiyomi.network
2 |
3 | import okhttp3.CacheControl
4 | import okhttp3.Headers
5 | import okhttp3.HttpUrl
6 | import okhttp3.Request
7 | import okhttp3.RequestBody
8 |
9 | private val DEFAULT_CACHE_CONTROL: CacheControl = throw Exception("Stub!")
10 | private val DEFAULT_HEADERS: Headers = throw Exception("Stub!")
11 | private val DEFAULT_BODY: RequestBody = throw Exception("Stub!")
12 |
13 | fun GET(url: String,
14 | headers: Headers = DEFAULT_HEADERS,
15 | cache: CacheControl = DEFAULT_CACHE_CONTROL): Request {
16 |
17 | throw Exception("Stub!")
18 | }
19 |
20 | /**
21 | * @since extensions-lib 1.4
22 | */
23 | fun GET(url: HttpUrl,
24 | headers: Headers = DEFAULT_HEADERS,
25 | cache: CacheControl = DEFAULT_CACHE_CONTROL): Request {
26 |
27 | throw Exception("Stub!")
28 | }
29 |
30 | fun POST(url: String,
31 | headers: Headers = DEFAULT_HEADERS,
32 | body: RequestBody = DEFAULT_BODY,
33 | cache: CacheControl = DEFAULT_CACHE_CONTROL): Request {
34 |
35 | throw Exception("Stub!")
36 | }
37 |
--------------------------------------------------------------------------------
/library/src/main/java/androidx/preference/MultiSelectListPreference.java:
--------------------------------------------------------------------------------
1 | package androidx.preference;
2 |
3 | import android.content.Context;
4 |
5 | import java.util.Set;
6 |
7 | public class MultiSelectListPreference extends DialogPreference {
8 |
9 | public MultiSelectListPreference(Context context) {
10 | throw new RuntimeException("Stub!");
11 | }
12 |
13 | public void setEntries(CharSequence[] entries) {
14 | throw new RuntimeException("Stub!");
15 | }
16 |
17 | public CharSequence[] getEntries() {
18 | throw new RuntimeException("Stub!");
19 | }
20 |
21 | public void setEntryValues(CharSequence[] entryValues) {
22 | throw new RuntimeException("Stub!");
23 | }
24 |
25 | public CharSequence[] getEntryValues() {
26 | throw new RuntimeException("Stub!");
27 | }
28 |
29 | public void setValues(Set values) {
30 | throw new RuntimeException("Stub!");
31 | }
32 |
33 | public Set getValues() {
34 | throw new RuntimeException("Stub!");
35 | }
36 |
37 | public int findIndexOfValue(String value) {
38 | throw new RuntimeException("Stub!");
39 | }
40 | }
41 |
--------------------------------------------------------------------------------
/library/src/main/java/androidx/preference/ListPreference.java:
--------------------------------------------------------------------------------
1 | package androidx.preference;
2 |
3 | import android.content.Context;
4 |
5 | public class ListPreference extends Preference {
6 |
7 | public ListPreference(Context context) {
8 | throw new RuntimeException("Stub!");
9 | }
10 |
11 | public CharSequence[] getEntries() {
12 | throw new RuntimeException("Stub!");
13 | }
14 |
15 | public void setEntries(CharSequence[] entries) {
16 | throw new RuntimeException("Stub!");
17 | }
18 |
19 | public int findIndexOfValue(String value) {
20 | throw new RuntimeException("Stub!");
21 | }
22 |
23 | public CharSequence[] getEntryValues() {
24 | throw new RuntimeException("Stub!");
25 | }
26 |
27 | public void setEntryValues(CharSequence[] entryValues) {
28 | throw new RuntimeException("Stub!");
29 | }
30 |
31 | public void setValueIndex(int index) {
32 | throw new RuntimeException("Stub!");
33 | }
34 |
35 | public String getValue() {
36 | throw new RuntimeException("Stub!");
37 | }
38 |
39 | public void setValue(String value) {
40 | throw new RuntimeException("Stub!");
41 | }
42 |
43 | }
44 |
--------------------------------------------------------------------------------
/library/src/main/java/eu/kanade/tachiyomi/network/interceptor/SpecificHostRateLimitInterceptor.kt:
--------------------------------------------------------------------------------
1 | package eu.kanade.tachiyomi.network.interceptor
2 |
3 | import okhttp3.HttpUrl
4 | import okhttp3.OkHttpClient
5 | import java.util.concurrent.TimeUnit
6 |
7 | /**
8 | * An OkHttp interceptor that handles given url host's rate limiting.
9 | *
10 | * Examples:
11 | *
12 | * httpUrl = "api.manga.com".toHttpUrlOrNull(), permits = 5, period = 1, unit = seconds => 5 requests per second to api.manga.com
13 | * httpUrl = "imagecdn.manga.com".toHttpUrlOrNull(), permits = 10, period = 2, unit = minutes => 10 requests per 2 minutes to imagecdn.manga.com
14 | *
15 | * @since extension-lib 1.3
16 | *
17 | * @param httpUrl {HttpUrl} The url host that this interceptor should handle. Will get url's host by using HttpUrl.host()
18 | * @param permits {Int} Number of requests allowed within a period of units.
19 | * @param period {Long} The limiting duration. Defaults to 1.
20 | * @param unit {TimeUnit} The unit of time for the period. Defaults to seconds.
21 | */
22 | fun OkHttpClient.Builder.rateLimitHost(
23 | httpUrl: HttpUrl,
24 | permits: Int,
25 | period: Long = 1,
26 | unit: TimeUnit = TimeUnit.SECONDS,
27 | ): OkHttpClient.Builder = throw Exception("Stub!")
28 |
--------------------------------------------------------------------------------
/library/build.gradle:
--------------------------------------------------------------------------------
1 | plugins {
2 | id 'com.android.library'
3 | id 'kotlin-android'
4 | id 'maven-publish'
5 | }
6 |
7 | android {
8 | compileSdk 34
9 |
10 | defaultConfig {
11 | minSdk 21
12 | targetSdk 34
13 | }
14 |
15 | buildTypes {
16 | release {
17 | minifyEnabled false
18 | }
19 | }
20 |
21 | compileOptions {
22 | sourceCompatibility JavaVersion.VERSION_17
23 | targetCompatibility JavaVersion.VERSION_17
24 | }
25 |
26 | kotlinOptions {
27 | jvmTarget = JavaVersion.VERSION_17.toString()
28 | }
29 | }
30 |
31 | dependencies {
32 | implementation "com.squareup.okhttp3:okhttp:5.0.0-alpha.11"
33 | implementation "io.reactivex:rxjava:1.3.8"
34 | implementation "io.reactivex:rxandroid:1.2.1"
35 | implementation "org.jsoup:jsoup:1.15.3"
36 | implementation "com.github.inorichi.injekt:injekt-core:65b0440"
37 | }
38 |
39 | task androidSourcesJar(type: Jar) {
40 | classifier 'sources'
41 | from android.sourceSets.main.java.srcDirs
42 | }
43 |
44 | project.afterEvaluate {
45 | publishing {
46 | publications {
47 | release(MavenPublication) {
48 | from components.release
49 | artifact androidSourcesJar
50 | }
51 | }
52 | }
53 | }
54 |
--------------------------------------------------------------------------------
/library/src/main/java/eu/kanade/tachiyomi/source/model/Filter.kt:
--------------------------------------------------------------------------------
1 | package eu.kanade.tachiyomi.source.model
2 |
3 | @Suppress("unused")
4 | sealed class Filter(val name: String, var state: T) {
5 | open class Header(name: String) : Filter(name, 0)
6 | open class Separator(name: String = "") : Filter(name, 0)
7 | abstract class Select(name: String, val values: Array, state: Int = 0) : Filter(name, state)
8 | abstract class Text(name: String, state: String = "") : Filter(name, state)
9 | abstract class CheckBox(name: String, state: Boolean = false) : Filter(name, state)
10 | abstract class TriState(name: String, state: Int = STATE_IGNORE) : Filter(name, state) {
11 | fun isIgnored() = state == STATE_IGNORE
12 | fun isIncluded() = state == STATE_INCLUDE
13 | fun isExcluded() = state == STATE_EXCLUDE
14 |
15 | companion object {
16 | const val STATE_IGNORE = 0
17 | const val STATE_INCLUDE = 1
18 | const val STATE_EXCLUDE = 2
19 | }
20 | }
21 | abstract class Group(name: String, state: List): Filter>(name, state)
22 |
23 | abstract class Sort(name: String, val values: Array, state: Selection? = null)
24 | : Filter(name, state) {
25 | data class Selection(val index: Int, val ascending: Boolean)
26 | }
27 |
28 | }
--------------------------------------------------------------------------------
/library/src/main/java/eu/kanade/tachiyomi/source/CatalogueSource.kt:
--------------------------------------------------------------------------------
1 | package eu.kanade.tachiyomi.source
2 |
3 | import eu.kanade.tachiyomi.source.model.FilterList
4 | import eu.kanade.tachiyomi.source.model.MangasPage
5 | import rx.Observable
6 |
7 | @Suppress("unused")
8 | interface CatalogueSource : Source {
9 |
10 | /**
11 | * An ISO 639-1 compliant language code (two letters in lower case).
12 | */
13 | val lang: String
14 |
15 | /**
16 | * Whether the source has support for latest updates.
17 | */
18 | val supportsLatest: Boolean
19 |
20 | /**
21 | * Returns an observable containing a page with a list of manga.
22 | *
23 | * @param page the page number to retrieve.
24 | */
25 | fun fetchPopularManga(page: Int): Observable
26 |
27 | /**
28 | * Returns an observable containing a page with a list of manga.
29 | *
30 | * @param page the page number to retrieve.
31 | * @param query the search query.
32 | * @param filters the list of filters to apply.
33 | */
34 | fun fetchSearchManga(page: Int, query: String, filters: FilterList): Observable
35 |
36 | /**
37 | * Returns an observable containing a page with a list of latest manga updates.
38 | *
39 | * @param page the page number to retrieve.
40 | */
41 | fun fetchLatestUpdates(page: Int): Observable
42 |
43 | /**
44 | * Returns the list of filters for the source.
45 | */
46 | fun getFilterList(): FilterList
47 | }
--------------------------------------------------------------------------------
/library/src/main/java/androidx/preference/Preference.java:
--------------------------------------------------------------------------------
1 | package androidx.preference;
2 |
3 | public class Preference {
4 |
5 | public void setOnPreferenceChangeListener(OnPreferenceChangeListener onPreferenceChangeListener) {
6 | throw new RuntimeException("Stub!");
7 | }
8 |
9 | public void setOnPreferenceClickListener(OnPreferenceClickListener onPreferenceClickListener) {
10 | throw new RuntimeException("Stub!");
11 | }
12 |
13 | public CharSequence getTitle() {
14 | throw new RuntimeException("Stub!");
15 | }
16 |
17 | public void setTitle(CharSequence title) {
18 | throw new RuntimeException("Stub!");
19 | }
20 |
21 | public CharSequence getSummary() {
22 | throw new RuntimeException("Stub!");
23 | }
24 |
25 | public void setSummary(CharSequence summary) {
26 | throw new RuntimeException("Stub!");
27 | }
28 |
29 | public void setEnabled(boolean enabled) {
30 | throw new RuntimeException("Stub!");
31 | }
32 |
33 | public void setVisible(boolean visible) {
34 | throw new RuntimeException("Stub!");
35 | }
36 |
37 | public String getKey() {
38 | throw new RuntimeException("Stub!");
39 | }
40 |
41 | public void setKey(String key) {
42 | throw new RuntimeException("Stub!");
43 | }
44 |
45 | public void setDefaultValue(Object defaultValue) {
46 | throw new RuntimeException("Stub!");
47 | }
48 |
49 | public interface OnPreferenceChangeListener {
50 | boolean onPreferenceChange(Preference preference, Object newValue);
51 | }
52 |
53 | public interface OnPreferenceClickListener {
54 | boolean onPreferenceClick(Preference preference);
55 | }
56 |
57 | }
58 |
--------------------------------------------------------------------------------
/library/src/main/java/eu/kanade/tachiyomi/source/Source.kt:
--------------------------------------------------------------------------------
1 | package eu.kanade.tachiyomi.source
2 |
3 | import eu.kanade.tachiyomi.source.model.Page
4 | import eu.kanade.tachiyomi.source.model.SChapter
5 | import eu.kanade.tachiyomi.source.model.SManga
6 | import rx.Observable
7 |
8 | /**
9 | * A basic interface for creating a source. It could be an online source, a local source, etc...
10 | */
11 | @Suppress("unused")
12 | interface Source {
13 |
14 | /**
15 | * Id for the source. Must be unique.
16 | */
17 | val id: Long
18 |
19 | /**
20 | * Name of the source.
21 | */
22 | val name: String
23 |
24 | /**
25 | * Get the updated details for a manga.
26 | *
27 | * @since extensions-lib 1.4
28 | * @param manga the manga to update.
29 | * @return the updated manga.
30 | */
31 | suspend fun getMangaDetails(manga: SManga): SManga = throw Exception("Stub!")
32 |
33 | /**
34 | * Get all the available chapters for a manga.
35 | *
36 | * @since extensions-lib 1.4
37 | * @param manga the manga to update.
38 | * @return the chapters for the manga.
39 | */
40 | suspend fun getChapterList(manga: SManga): List = throw Exception("Stub!")
41 |
42 | /**
43 | * Get the list of pages a chapter has. Pages should be returned
44 | * in the expected order; the index is ignored.
45 | *
46 | * @param chapter the chapter.
47 | * @return the pages for the chapter.
48 | */
49 | fun fetchPageList(chapter: SChapter): Observable>
50 |
51 | @Deprecated(
52 | "Use the non-RxJava API instead",
53 | ReplaceWith("getMangaDetails"),
54 | )
55 | fun fetchMangaDetails(manga: SManga): Observable = throw Exception("Stub!")
56 |
57 | @Deprecated(
58 | "Use the non-RxJava API instead",
59 | ReplaceWith("getChapterList"),
60 | )
61 | fun fetchChapterList(manga: SManga): Observable> = throw Exception("Stub!")
62 | }
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @if "%DEBUG%" == "" @echo off
2 | @rem ##########################################################################
3 | @rem
4 | @rem Gradle startup script for Windows
5 | @rem
6 | @rem ##########################################################################
7 |
8 | @rem Set local scope for the variables with windows NT shell
9 | if "%OS%"=="Windows_NT" setlocal
10 |
11 | set DIRNAME=%~dp0
12 | if "%DIRNAME%" == "" set DIRNAME=.
13 | set APP_BASE_NAME=%~n0
14 | set APP_HOME=%DIRNAME%
15 |
16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
17 | set DEFAULT_JVM_OPTS=
18 |
19 | @rem Find java.exe
20 | if defined JAVA_HOME goto findJavaFromJavaHome
21 |
22 | set JAVA_EXE=java.exe
23 | %JAVA_EXE% -version >NUL 2>&1
24 | if "%ERRORLEVEL%" == "0" goto init
25 |
26 | echo.
27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
28 | echo.
29 | echo Please set the JAVA_HOME variable in your environment to match the
30 | echo location of your Java installation.
31 |
32 | goto fail
33 |
34 | :findJavaFromJavaHome
35 | set JAVA_HOME=%JAVA_HOME:"=%
36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
37 |
38 | if exist "%JAVA_EXE%" goto init
39 |
40 | echo.
41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
42 | echo.
43 | echo Please set the JAVA_HOME variable in your environment to match the
44 | echo location of your Java installation.
45 |
46 | goto fail
47 |
48 | :init
49 | @rem Get command-line arguments, handling Windows variants
50 |
51 | if not "%OS%" == "Windows_NT" goto win9xME_args
52 |
53 | :win9xME_args
54 | @rem Slurp the command line arguments.
55 | set CMD_LINE_ARGS=
56 | set _SKIP=2
57 |
58 | :win9xME_args_slurp
59 | if "x%~1" == "x" goto execute
60 |
61 | set CMD_LINE_ARGS=%*
62 |
63 | :execute
64 | @rem Setup the command line
65 |
66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
67 |
68 | @rem Execute Gradle
69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
70 |
71 | :end
72 | @rem End local scope for the variables with windows NT shell
73 | if "%ERRORLEVEL%"=="0" goto mainEnd
74 |
75 | :fail
76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
77 | rem the _cmd.exe /c_ return code!
78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
79 | exit /b 1
80 |
81 | :mainEnd
82 | if "%OS%"=="Windows_NT" endlocal
83 |
84 | :omega
85 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env sh
2 |
3 | ##############################################################################
4 | ##
5 | ## Gradle start up script for UN*X
6 | ##
7 | ##############################################################################
8 |
9 | # Attempt to set APP_HOME
10 | # Resolve links: $0 may be a link
11 | PRG="$0"
12 | # Need this for relative symlinks.
13 | while [ -h "$PRG" ] ; do
14 | ls=`ls -ld "$PRG"`
15 | link=`expr "$ls" : '.*-> \(.*\)$'`
16 | if expr "$link" : '/.*' > /dev/null; then
17 | PRG="$link"
18 | else
19 | PRG=`dirname "$PRG"`"/$link"
20 | fi
21 | done
22 | SAVED="`pwd`"
23 | cd "`dirname \"$PRG\"`/" >/dev/null
24 | APP_HOME="`pwd -P`"
25 | cd "$SAVED" >/dev/null
26 |
27 | APP_NAME="Gradle"
28 | APP_BASE_NAME=`basename "$0"`
29 |
30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
31 | DEFAULT_JVM_OPTS=""
32 |
33 | # Use the maximum available, or set MAX_FD != -1 to use that value.
34 | MAX_FD="maximum"
35 |
36 | warn () {
37 | echo "$*"
38 | }
39 |
40 | die () {
41 | echo
42 | echo "$*"
43 | echo
44 | exit 1
45 | }
46 |
47 | # OS specific support (must be 'true' or 'false').
48 | cygwin=false
49 | msys=false
50 | darwin=false
51 | nonstop=false
52 | case "`uname`" in
53 | CYGWIN* )
54 | cygwin=true
55 | ;;
56 | Darwin* )
57 | darwin=true
58 | ;;
59 | MINGW* )
60 | msys=true
61 | ;;
62 | NONSTOP* )
63 | nonstop=true
64 | ;;
65 | esac
66 |
67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
68 |
69 | # Determine the Java command to use to start the JVM.
70 | if [ -n "$JAVA_HOME" ] ; then
71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
72 | # IBM's JDK on AIX uses strange locations for the executables
73 | JAVACMD="$JAVA_HOME/jre/sh/java"
74 | else
75 | JAVACMD="$JAVA_HOME/bin/java"
76 | fi
77 | if [ ! -x "$JAVACMD" ] ; then
78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
79 |
80 | Please set the JAVA_HOME variable in your environment to match the
81 | location of your Java installation."
82 | fi
83 | else
84 | JAVACMD="java"
85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
86 |
87 | Please set the JAVA_HOME variable in your environment to match the
88 | location of your Java installation."
89 | fi
90 |
91 | # Increase the maximum file descriptors if we can.
92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
93 | MAX_FD_LIMIT=`ulimit -H -n`
94 | if [ $? -eq 0 ] ; then
95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
96 | MAX_FD="$MAX_FD_LIMIT"
97 | fi
98 | ulimit -n $MAX_FD
99 | if [ $? -ne 0 ] ; then
100 | warn "Could not set maximum file descriptor limit: $MAX_FD"
101 | fi
102 | else
103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
104 | fi
105 | fi
106 |
107 | # For Darwin, add options to specify how the application appears in the dock
108 | if $darwin; then
109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
110 | fi
111 |
112 | # For Cygwin, switch paths to Windows format before running java
113 | if $cygwin ; then
114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
116 | JAVACMD=`cygpath --unix "$JAVACMD"`
117 |
118 | # We build the pattern for arguments to be converted via cygpath
119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120 | SEP=""
121 | for dir in $ROOTDIRSRAW ; do
122 | ROOTDIRS="$ROOTDIRS$SEP$dir"
123 | SEP="|"
124 | done
125 | OURCYGPATTERN="(^($ROOTDIRS))"
126 | # Add a user-defined pattern to the cygpath arguments
127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129 | fi
130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
131 | i=0
132 | for arg in "$@" ; do
133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135 |
136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138 | else
139 | eval `echo args$i`="\"$arg\""
140 | fi
141 | i=$((i+1))
142 | done
143 | case $i in
144 | (0) set -- ;;
145 | (1) set -- "$args0" ;;
146 | (2) set -- "$args0" "$args1" ;;
147 | (3) set -- "$args0" "$args1" "$args2" ;;
148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154 | esac
155 | fi
156 |
157 | # Escape application args
158 | save () {
159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
160 | echo " "
161 | }
162 | APP_ARGS=$(save "$@")
163 |
164 | # Collect all arguments for the java command, following the shell quoting and substitution rules
165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
166 |
167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
169 | cd "$(dirname "$0")"
170 | fi
171 |
172 | exec "$JAVACMD" "$@"
173 |
--------------------------------------------------------------------------------
/library/src/main/java/eu/kanade/tachiyomi/source/online/ParsedHttpSource.kt:
--------------------------------------------------------------------------------
1 | package eu.kanade.tachiyomi.source.online
2 |
3 | import eu.kanade.tachiyomi.source.model.MangasPage
4 | import eu.kanade.tachiyomi.source.model.Page
5 | import eu.kanade.tachiyomi.source.model.SChapter
6 | import eu.kanade.tachiyomi.source.model.SManga
7 | import okhttp3.Response
8 | import org.jsoup.nodes.Document
9 | import org.jsoup.nodes.Element
10 |
11 | /**
12 | * A simple implementation for sources from a website using Jsoup, an HTML parser.
13 | */
14 | @Suppress("unused")
15 | abstract class ParsedHttpSource : HttpSource() {
16 |
17 | /**
18 | * Parses the response from the site and returns a [MangasPage] object.
19 | *
20 | * @param response the response from the site.
21 | */
22 | override fun popularMangaParse(response: Response): MangasPage {
23 | throw Exception("Stub!")
24 | }
25 |
26 | /**
27 | * Returns the Jsoup selector that returns a list of [Element] corresponding to each manga.
28 | */
29 | protected abstract fun popularMangaSelector(): String
30 |
31 | /**
32 | * Returns a manga from the given [element]. Most sites only show the title and the url, it's
33 | * totally fine to fill only those two values.
34 | *
35 | * @param element an element obtained from [popularMangaSelector].
36 | */
37 | protected abstract fun popularMangaFromElement(element: Element): SManga
38 |
39 | /**
40 | * Returns the Jsoup selector that returns the tag linking to the next page, or null if
41 | * there's no next page.
42 | */
43 | protected abstract fun popularMangaNextPageSelector(): String?
44 |
45 | /**
46 | * Parses the response from the site and returns a [MangasPage] object.
47 | *
48 | * @param response the response from the site.
49 | */
50 | override fun searchMangaParse(response: Response): MangasPage {
51 | throw Exception("Stub!")
52 | }
53 |
54 | /**
55 | * Returns the Jsoup selector that returns a list of [Element] corresponding to each manga.
56 | */
57 | protected abstract fun searchMangaSelector(): String
58 |
59 | /**
60 | * Returns a manga from the given [element]. Most sites only show the title and the url, it's
61 | * totally fine to fill only those two values.
62 | *
63 | * @param element an element obtained from [searchMangaSelector].
64 | */
65 | protected abstract fun searchMangaFromElement(element: Element): SManga
66 |
67 | /**
68 | * Returns the Jsoup selector that returns the tag linking to the next page, or null if
69 | * there's no next page.
70 | */
71 | protected abstract fun searchMangaNextPageSelector(): String?
72 |
73 | /**
74 | * Parses the response from the site and returns a [MangasPage] object.
75 | *
76 | * @param response the response from the site.
77 | */
78 | override fun latestUpdatesParse(response: Response): MangasPage {
79 | throw Exception("Stub!")
80 | }
81 |
82 | /**
83 | * Returns the Jsoup selector that returns a list of [Element] corresponding to each manga.
84 | */
85 | protected abstract fun latestUpdatesSelector(): String
86 |
87 | /**
88 | * Returns a manga from the given [element]. Most sites only show the title and the url, it's
89 | * totally fine to fill only those two values.
90 | *
91 | * @param element an element obtained from [latestUpdatesSelector].
92 | */
93 | protected abstract fun latestUpdatesFromElement(element: Element): SManga
94 |
95 | /**
96 | * Returns the Jsoup selector that returns the tag linking to the next page, or null if
97 | * there's no next page.
98 | */
99 | protected abstract fun latestUpdatesNextPageSelector(): String?
100 |
101 | /**
102 | * Parses the response from the site and returns the details of a manga.
103 | *
104 | * @param response the response from the site.
105 | */
106 | override fun mangaDetailsParse(response: Response): SManga {
107 | throw Exception("Stub!")
108 | }
109 |
110 | /**
111 | * Returns the details of the manga from the given [document].
112 | *
113 | * @param document the parsed document.
114 | */
115 | protected abstract fun mangaDetailsParse(document: Document): SManga
116 |
117 | /**
118 | * Parses the response from the site and returns a list of chapters.
119 | *
120 | * @param response the response from the site.
121 | */
122 | override fun chapterListParse(response: Response): List {
123 | throw Exception("Stub!")
124 | }
125 |
126 | /**
127 | * Returns the Jsoup selector that returns a list of [Element] corresponding to each chapter.
128 | */
129 | protected abstract fun chapterListSelector(): String
130 |
131 | /**
132 | * Returns a chapter from the given element.
133 | *
134 | * @param element an element obtained from [chapterListSelector].
135 | */
136 | protected abstract fun chapterFromElement(element: Element): SChapter
137 |
138 | /**
139 | * Parses the response from the site and returns the page list.
140 | *
141 | * @param response the response from the site.
142 | */
143 | override fun pageListParse(response: Response): List {
144 | throw Exception("Stub!")
145 | }
146 |
147 | /**
148 | * Returns a page list from the given document.
149 | *
150 | * @param document the parsed document.
151 | */
152 | protected abstract fun pageListParse(document: Document): List
153 |
154 | /**
155 | * Parse the response from the site and returns the absolute url to the source image.
156 | *
157 | * @param response the response from the site.
158 | */
159 | override fun imageUrlParse(response: Response): String {
160 | throw Exception("Stub!")
161 | }
162 |
163 | /**
164 | * Returns the absolute url to the source image from the document.
165 | *
166 | * @param document the parsed document.
167 | */
168 | protected abstract fun imageUrlParse(document: Document): String
169 | }
170 |
--------------------------------------------------------------------------------
/library/src/main/java/eu/kanade/tachiyomi/source/online/HttpSource.kt:
--------------------------------------------------------------------------------
1 | package eu.kanade.tachiyomi.source.online
2 |
3 | import eu.kanade.tachiyomi.network.NetworkHelper
4 | import eu.kanade.tachiyomi.source.CatalogueSource
5 | import eu.kanade.tachiyomi.source.model.*
6 | import okhttp3.Headers
7 | import okhttp3.OkHttpClient
8 | import okhttp3.Request
9 | import okhttp3.Response
10 | import rx.Observable
11 |
12 | /**
13 | * A simple implementation for sources from a website.
14 | */
15 | @Suppress("unused", "unused_parameter")
16 | abstract class HttpSource : CatalogueSource {
17 |
18 | /**
19 | * Network service.
20 | */
21 | protected val network: NetworkHelper = throw Exception("Stub!")
22 |
23 | /**
24 | * Base url of the website without the trailing slash, like: http://mysite.com
25 | */
26 | abstract val baseUrl: String
27 |
28 | /**
29 | * Version id used to generate the source id. If the site completely changes and urls are
30 | * incompatible, you may increase this value and it'll be considered as a new source.
31 | */
32 | open val versionId: Int = throw Exception("Stub!")
33 |
34 | /**
35 | * Id of the source. By default it uses a generated id using the first 16 characters (64 bits)
36 | * of the MD5 of the string: sourcename/language/versionId
37 | * Note the generated id sets the sign bit to 0.
38 | */
39 | override val id: Long = throw Exception("Stub!")
40 |
41 | /**
42 | * Headers used for requests.
43 | */
44 | val headers: Headers = throw Exception("Stub!")
45 |
46 | /**
47 | * Default network client for doing requests.
48 | */
49 | open val client: OkHttpClient = throw Exception("Stub!")
50 |
51 | /**
52 | * Headers builder for requests. Implementations can override this method for custom headers.
53 | */
54 | open protected fun headersBuilder(): Headers.Builder {
55 | throw Exception("Stub!")
56 | }
57 |
58 | /**
59 | * Visible name of the source.
60 | */
61 | override fun toString(): String {
62 | throw Exception("Stub!")
63 | }
64 |
65 | /**
66 | * Returns an observable containing a page with a list of manga. Normally it's not needed to
67 | * override this method.
68 | *
69 | * @param page the page number to retrieve.
70 | */
71 | override fun fetchPopularManga(page: Int): Observable {
72 | throw Exception("Stub!")
73 | }
74 |
75 | /**
76 | * Returns the request for the popular manga given the page.
77 | *
78 | * @param page the page number to retrieve.
79 | */
80 | protected abstract fun popularMangaRequest(page: Int): Request
81 |
82 | /**
83 | * Parses the response from the site and returns a [MangasPage] object.
84 | *
85 | * @param response the response from the site.
86 | */
87 | protected abstract fun popularMangaParse(response: Response): MangasPage
88 |
89 | /**
90 | * Returns an observable containing a page with a list of manga. Normally it's not needed to
91 | * override this method.
92 | *
93 | * @param page the page number to retrieve.
94 | * @param query the search query.
95 | * @param filters the list of filters to apply.
96 | */
97 | override fun fetchSearchManga(page: Int, query: String, filters: FilterList): Observable {
98 | throw Exception("Stub!")
99 | }
100 |
101 | /**
102 | * Returns the request for the search manga given the page.
103 | *
104 | * @param page the page number to retrieve.
105 | * @param query the search query.
106 | * @param filters the list of filters to apply.
107 | */
108 | protected abstract fun searchMangaRequest(page: Int, query: String, filters: FilterList): Request
109 |
110 | /**
111 | * Parses the response from the site and returns a [MangasPage] object.
112 | *
113 | * @param response the response from the site.
114 | */
115 | protected abstract fun searchMangaParse(response: Response): MangasPage
116 |
117 | /**
118 | * Returns an observable containing a page with a list of latest manga updates.
119 | *
120 | * @param page the page number to retrieve.
121 | */
122 | override fun fetchLatestUpdates(page: Int): Observable {
123 | throw Exception("Stub!")
124 | }
125 |
126 | /**
127 | * Returns the request for latest manga given the page.
128 | *
129 | * @param page the page number to retrieve.
130 | */
131 | protected abstract fun latestUpdatesRequest(page: Int): Request
132 |
133 | /**
134 | * Parses the response from the site and returns a [MangasPage] object.
135 | *
136 | * @param response the response from the site.
137 | */
138 | protected abstract fun latestUpdatesParse(response: Response): MangasPage
139 |
140 | /**
141 | * Returns an observable with the updated details for a manga. Normally it's not needed to
142 | * override this method.
143 | *
144 | * @param manga the manga to be updated.
145 | */
146 | override fun fetchMangaDetails(manga: SManga): Observable {
147 | throw Exception("Stub!")
148 | }
149 |
150 | /**
151 | * Returns the request for the details of a manga. Override only if it's needed to change the
152 | * url, send different headers or request method like POST.
153 | *
154 | * @param manga the manga to be updated.
155 | */
156 | open fun mangaDetailsRequest(manga: SManga): Request {
157 | throw Exception("Stub!")
158 | }
159 |
160 | /**
161 | * Parses the response from the site and returns the details of a manga.
162 | *
163 | * @param response the response from the site.
164 | */
165 | protected abstract fun mangaDetailsParse(response: Response): SManga
166 |
167 | /**
168 | * Returns an observable with the updated chapter list for a manga. Normally it's not needed to
169 | * override this method.
170 | *
171 | * @param manga the manga to look for chapters.
172 | */
173 | override fun fetchChapterList(manga: SManga): Observable> {
174 | throw Exception("Stub!")
175 | }
176 |
177 | /**
178 | * Returns the request for updating the chapter list. Override only if it's needed to override
179 | * the url, send different headers or request method like POST.
180 | *
181 | * @param manga the manga to look for chapters.
182 | */
183 | open protected fun chapterListRequest(manga: SManga): Request {
184 | throw Exception("Stub!")
185 | }
186 |
187 | /**
188 | * Parses the response from the site and returns a list of chapters.
189 | *
190 | * @param response the response from the site.
191 | */
192 | protected abstract fun chapterListParse(response: Response): List
193 |
194 | /**
195 | * Returns an observable with the page list for a chapter.
196 | *
197 | * @param chapter the chapter whose page list has to be fetched.
198 | */
199 | override fun fetchPageList(chapter: SChapter): Observable> {
200 | throw Exception("Stub!")
201 | }
202 |
203 | /**
204 | * Returns the request for getting the page list. Override only if it's needed to override the
205 | * url, send different headers or request method like POST.
206 | *
207 | * @param chapter the chapter whose page list has to be fetched.
208 | */
209 | open protected fun pageListRequest(chapter: SChapter): Request {
210 | throw Exception("Stub!")
211 | }
212 |
213 | /**
214 | * Parses the response from the site and returns a list of pages.
215 | *
216 | * @param response the response from the site.
217 | */
218 | protected abstract fun pageListParse(response: Response): List
219 |
220 | /**
221 | * Returns an observable with the page containing the source url of the image. If there's any
222 | * error, it will return null instead of throwing an exception.
223 | *
224 | * @param page the page whose source image has to be fetched.
225 | */
226 | open fun fetchImageUrl(page: Page): Observable {
227 | throw Exception("Stub!")
228 | }
229 |
230 | /**
231 | * Returns the request for getting the url to the source image. Override only if it's needed to
232 | * override the url, send different headers or request method like POST.
233 | *
234 | * @param page the chapter whose page list has to be fetched
235 | */
236 | open protected fun imageUrlRequest(page: Page): Request {
237 | throw Exception("Stub!")
238 | }
239 |
240 | /**
241 | * Parses the response from the site and returns the absolute url to the source image.
242 | *
243 | * @param response the response from the site.
244 | */
245 | protected abstract fun imageUrlParse(response: Response): String
246 |
247 | /**
248 | * Returns an observable with the response of the source image.
249 | *
250 | * @param page the page whose source image has to be downloaded.
251 | */
252 | fun fetchImage(page: Page): Observable {
253 | throw Exception("Stub!")
254 | }
255 |
256 | /**
257 | * Returns the request for getting the source image. Override only if it's needed to override
258 | * the url, send different headers or request method like POST.
259 | *
260 | * @param page the chapter whose page list has to be fetched
261 | */
262 | open protected fun imageRequest(page: Page): Request {
263 | throw Exception("Stub!")
264 | }
265 |
266 | /**
267 | * Assigns the url of the chapter without the scheme and domain. It saves some redundancy from
268 | * database and the urls could still work after a domain change.
269 | *
270 | * @param url the full url to the chapter.
271 | */
272 | fun SChapter.setUrlWithoutDomain(url: String) {
273 | throw Exception("Stub!")
274 | }
275 |
276 | /**
277 | * Assigns the url of the manga without the scheme and domain. It saves some redundancy from
278 | * database and the urls could still work after a domain change.
279 | *
280 | * @param url the full url to the manga.
281 | */
282 | fun SManga.setUrlWithoutDomain(url: String) {
283 | throw Exception("Stub!")
284 | }
285 |
286 | /**
287 | * Returns the url of the given string without the scheme and domain.
288 | *
289 | * @param orig the full url.
290 | */
291 | private fun getUrlWithoutDomain(orig: String): String {
292 | throw Exception("Stub!")
293 | }
294 |
295 | /**
296 | * Returns the url of the provided manga
297 | *
298 | * @since extensions-lib 1.4
299 | * @param manga the manga
300 | * @return url of the manga
301 | */
302 | open fun getMangaUrl(manga: SManga): String {
303 | throw Exception("Stub!")
304 | }
305 |
306 | /**
307 | * Returns the url of the provided chapter
308 | *
309 | * @since extensions-lib 1.4
310 | * @param chapter the chapter
311 | * @return url of the chapter
312 | */
313 | open fun getChapterUrl(chapter: SChapter): String {
314 | throw Exception("Stub!")
315 | }
316 |
317 | /**
318 | * Called before inserting a new chapter into database. Use it if you need to override chapter
319 | * fields, like the title or the chapter number. Do not change anything to [manga].
320 | *
321 | * @param chapter the chapter to be added.
322 | * @param manga the manga of the chapter.
323 | */
324 | open fun prepareNewChapter(chapter: SChapter, manga: SManga) {}
325 |
326 | /**
327 | * Returns the list of filters for the source.
328 | */
329 | override fun getFilterList(): FilterList {
330 | throw Exception("Stub!")
331 | }
332 | }
333 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "{}"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright {yyyy} {name of copyright owner}
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------