Merge branch 'release/0.1' into senpai

.github/workflows/build.yml

@@ -0,0 +1,88 @@
+name: Build-and-Publish
+
+on:
+  # triggers on pushes with tag
+  push:
+    tags:
+      - '*.*'
+
+jobs:
+  # build the apk for release
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # check out repo with submodules
+      - name: Checkout Repo
+        uses: actions/checkout@v2
+        with:
+          ref: senpai
+          submodules: recursive
+
+      # setup jdk 1.8
+      - name: Set up JDK
+        uses: actions/setup-java@v1
+        with:
+          java-version: 1.8
+
+      # make gradlew executeable
+      - name: Make Gradle Executable
+        run: chmod +x ./gradlew
+
+      # build using gradle
+      - name: Build with Gradle
+        run: ./gradlew build
+
+      # build apk
+      - name: Build Release APK
+        run: ./gradlew assembleRelease
+
+      # sign APK
+      - name: Sign APK
+        id: sign_apk
+        uses: r0adkll/sign-android-release@v1
+        with:
+          releaseDirectory: app/build/outputs/apk/release
+          signingKeyBase64: ${{ secrets.SIGNING_KEY }}
+          alias: ${{ secrets.ALIAS }}
+          keyStorePassword: ${{ secrets.KEY_STORE_PASSWORD }}
+          keyPassword: ${{ secrets.KEY_PASSWORD }}
+
+      # rename signed apk
+      - name: Rename Signed APK
+        run: mv ${{ steps.sign_apk.outputs.signedReleaseFile }} ./tenshi-content.apk
+
+      # upload artifact
+      - name: Upload APK Artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: apk-build
+          path: ./tenshi-content.apk
+
+  # upload the built apk to github release
+  upload_github:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      # download artifact from previous step
+      - name: Download APK Artifact
+        uses: actions/download-artifact@v2
+        with:
+          name: apk-build
+          path: ./
+
+      # generate apk checksum
+      - name: "Generate APK Checksum"
+        run: sha256sum ./tenshi-content.apk > tenshi-content.sha256
+
+      # add apk to release
+      - name: Add APK to release
+        uses: softprops/action-gh-release@v1
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          body: automatic build
+          files: |
+            ./tenshi-content.apk
+            ./tenshi-content.sha256
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}     
+

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "Extensions-Lib"]
+	path = Extensions-Lib
+	url = https://github.com/Tenshiorg/Extensions-Lib.git

CONTRIBUTING.MD

@@ -0,0 +1,163 @@
+# Contributing
+
+# Prerequisites
+
+Before you start, please note that you should be able to use the following technologies. Existing contributors will not actively teach them to you.
+
+- Basic Android developement
+- Java
+- Web Scraping
+    - HTML
+    - JavaScript*
+    - JSoup*
+
+\* maybe not required depending on your implementation
+
+## Tools
+
+- [Android Studio](https://developer.android.com/studio)
+- Emulator or phone ready for development and Tenshi installed
+- Google Chrome on the host machine (useful when debugging Web Adapters)
+
+
+# Getting Help
+
+Theres currently no discord or anything setup, so please refer to existing Content Adapters for examples.<br>
+If required, you can also write a issue
+
+# Writing a Content Adapter
+
+Content Adapters are a way to provide content, like episode streams, to Tenshi.<br>
+Adapters are implemented as Android Services with a [AIDL](https://developer.android.com/guide/components/aidl) interface.
+
+
+There are two ways of writing a Content Adapter:
+
+# Web Adapters
+
+A Web Adapter is essentially just a WebView with Javascript injected into the page. <br>
+A Web Adapter consists of a [json definition](https://github.com/Tenshiorg/Tenshi-Content/blob/kohai/webadapters/adapter-definitions.json) and a [payload](https://github.com/Tenshiorg/Tenshi-Content/tree/kohai/webadapters/payloads) that is injected into the page.
+
+
+To start developing a Web Adapter, clone this repository and set [DEBUG_MODE](https://github.com/Tenshiorg/Tenshi-Content/blob/kohai/app/src/main/java/io/github/shadow578/tenshicontent/webadapter/Constants.java#L14) to true. <br>
+
+## Definition
+
+The definition of a Web Adapter is loaded every time the WebAdapterService is initialized.<br>
+When in debug mode, write your definition in the file in [raw/debug_definition.json](https://github.com/Tenshiorg/Tenshi-Content/blob/kohai/app/src/main/res/raw/debug_definition.json).
+
+
+### Format
+
+```json
+[
+  {
+    "name": "fouranime.web",
+    "displayName": "4Anime",
+    "storagePattern": null,
+    "searchUrl": "https://4anime.to/?s=%s",
+    "episodeUrl": "https://4anime.to/%s-episode-%02d",
+    "payload": "webadapters/payloads/4anime.json",
+    "userAgentOverride": null,
+    "domStorageEnabled": null,
+    "allowContentAccess": null
+  }
+]
+```
+
+Property    | Description
+------------|------------
+name        | a unique name for your adapter
+displayName | the name shown to the user
+storagePattern  | a regex pattern to validate the persistent storage. null to disable
+searchUrl       | search url used when persistent storage is empty. %s is replaced with the name of the anime, url- escaped
+episodeUrl      | url to directly go to a episode. %s is replaced with the contents of persistent storage, %d with the episode number
+payload         | javascript payload of this adapter, relative to [PAYLOAD_ROOT](https://github.com/Tenshiorg/Tenshi-Content/blob/kohai/app/src/main/java/io/github/shadow578/tenshicontent/webadapter/Constants.java)
+userAgentOverride   | controls the [user agent](https://developer.android.com/reference/android/webkit/WebSettings#setUserAgentString(java.lang.String)) of the webview. left default if null
+domStorageEnabled   | controls [dom storage](https://developer.android.com/reference/android/webkit/WebSettings#setDomStorageEnabled(boolean)). left default if null
+allowContentAccess  | controls [content access](https://developer.android.com/reference/android/webkit/WebSettings#setAllowContentAccess(boolean)). left default if null
+
+
+## Payload
+
+The payload of a Web Adapter is loaded every time it is injected into the page.<br>
+When in debug mode, write your definition in the file in [raw/debug_payload.js](https://github.com/Tenshiorg/Tenshi-Content/blob/kohai/app/src/main/res/raw/debug_payload.js). 
+
+
+Writing the payload is, of course, highly dependent on the page you are writing it for. <br>
+See [webadapter/payloads](https://github.com/Tenshiorg/Tenshi-Content/tree/kohai/webadapters/payloads) for examples.
+
+The general goals:
+- write something to persistent storage that, in combination with the episodeUrl of the definition, gets the user to the episode page as direct as possible
+- get the video url from the page
+- block (disruptive) ads
+
+### Javascript interface
+
+The following functions are accessible to Payloads:
+
+App.            | Description
+----------------|-------------
+toast(String)   | make a toast
+log(String)     | write a message to Log.d, tag "JSInterface"
+logE(String)    | write a message to Log.e, tag "JSInterface"
+
+\* see [JSInterface](https://github.com/Tenshiorg/Extensions-Lib/blob/kohai/extensionsLib/src/main/java/io/github/shadow578/tenshi/extensionslib/content/util/WebViewAdapterActivity.java#L178)
+
+
+Tenshi.                 | Description
+------------------------|-------------
+getUniqueName()         | the current unique name
+getAnimeTitle()         | the (english) anime title
+getAnimeTitleJp()       | the (japanese) anime title
+getMalId()              | the MAL id of the anime
+getPersistentStorage()  | get the contents of persistent storage
+setPersistentStorage(String)  | set the contents of persistent storage
+finish(String)          | closes the webview and forwards the argument as stream url to Tenshi
+
+\* see [WebAdapterJs](https://github.com/Tenshiorg/Tenshi-Content/blob/kohai/app/src/main/java/io/github/shadow578/tenshicontent/webadapter/WebAdapterActivity.java#L211)
+
+
+## Debugging
+
+When running a debug build with DEBUG_MODE enabled, the WebAdapterActivity will enable [Web Contents Debugging](https://developer.android.com/reference/android/webkit/WebView#setWebContentsDebuggingEnabled(boolean)), allowing you to (kinda) open full Chrome DevTools on your webview by opening chrome://inspect on your host PC with the phone or emulator connected to it.
+
+Quick Note: Chrome is (at least for me) sometimes very slow to connect to the webview. So bring patience when debugging.
+
+
+# Native Adapters
+
+A native adapter gives you more control over how things work, and also allows you to create a adapter without a ui (or a custom one). <br>
+
+The most barebone Content Adapter just extends [Service](https://developer.android.com/reference/android/app/Service) and returns a implementation of [IContentAdapter.Stub](https://github.com/Tenshiorg/Extensions-Lib/blob/kohai/extensionsLib/src/main/aidl/io/github/shadow578/tenshi/extensionslib/content/IContentAdapter.aidl) in onBind().
+
+If you need a activity for your adapter, you can use a [ActivityAdapterService](https://github.com/Tenshiorg/Extensions-Lib/blob/kohai/extensionsLib/src/main/java/io/github/shadow578/tenshi/extensionslib/content/util/ActivityAdapterService.java).
+
+
+After writing your Content Adapter Service, you have to add it to your manifest like so:
+
+```xml
+<service
+    android:name=".webadapter.WebAdapterService"
+    android:exported="true">
+
+    <intent-filter>
+        <action android:name="io.github.shadow578.tenshi.content.ADAPTER" />
+        <category android:name="io.github.shadow578.tenshi.content.ADAPTER" />
+    </intent-filter>
+
+    <meta-data
+        android:name="io.github.shadow578.tenshi.content.ADAPTER_VERSION"
+        android:value="2" />
+</service>
+```
+
+the service __must__:
+- be exported (android:exported="true")
+- define a intent filter with action and category set to "io.github.shadow578.tenshi.content.ADAPTER"
+- contain meta-data "io.github.shadow578.tenshi.content.ADAPTER_VERSION" with value set to the same value as in the used extension lib (see IContentAdapter or Constants).
+
+
+## Debugging
+
+Debugging of Content Adapters is easiest done using the [TestActivity](https://github.com/Tenshiorg/Tenshi-Content/blob/kohai/app/src/main/java/io/github/shadow578/tenshicontent/TestActivity.java). This uses the same logic to bind the adapters and allows for you to set breakpoints.

README.md

@@ -1,10 +1,16 @@
 # ![App Icon](.github/res/app-icon.png) Tenshi Content
-Tenshi is a free & open source client for [MyAnimeList](https://myanimelist.net) for Android 6.0 and above.
+
+Tenshi-Content contains content adapters for [Tenshi](https://github.com/Tenshiorg/Tenshi), a free & open source client for [MyAnimeList](https://myanimelist.net)
+
+If you want to contribute, have a look [here](CONTRIBUTING.md)
+
 
 
 ⚠ This Page is under Construction ⚠
 
 
+
+
 ## License
 > Copyright 2021 shadow578
 > 
@@ -19,3 +25,7 @@ Tenshi is a free & open source client for [MyAnimeList](https://myanimelist.net)
 > WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or > implied.
 > See the License for the specific language governing permissions > and
 > limitations under the License.
+
+## Disclaimer
+
+The developers of this application do not have any affiliation with the available content providers.

app/build.gradle

@@ -11,7 +11,7 @@ android {
         minSdkVersion 23
         targetSdkVersion 30
         versionCode 1
-        versionName "1.0"
+        versionName "0.1"
     }
 
     buildTypes {
@@ -31,5 +31,15 @@ dependencies {
     implementation 'com.google.android.material:material:1.3.0'
     implementation 'androidx.constraintlayout:constraintlayout:2.0.4'
 
+    // jsoup
     implementation 'org.jsoup:jsoup:1.11.1'
+
+    // retrofit + gson for webadapter
+    implementation 'com.squareup.retrofit2:retrofit:2.9.0'
+    implementation 'com.squareup.retrofit2:converter-scalars:2.9.0'
+    implementation 'com.squareup.retrofit2:converter-gson:2.9.0'
+    implementation 'com.google.code.gson:gson:2.8.6'
+
+    // Tenshi ExtensionsLib
+    implementation project(":extensionsLib")
 }

app/src/debug/AndroidManifest.xml

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="io.github.shadow578.tenshicontent">
+
+    <uses-permission android:name="android.permission.INTERNET" />
+
+    <application
+        android:allowBackup="true"
+        android:icon="@mipmap/ic_launcher"
+        android:label="@string/app_name"
+        android:roundIcon="@mipmap/ic_launcher_round"
+        android:supportsRtl="true"
+        android:theme="@style/Theme.TenshiContent">
+
+        <!-- testing activity -->
+        <activity android:name=".TestActivity">
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN" />
+                <category android:name="android.intent.category.LAUNCHER" />
+            </intent-filter>
+        </activity>
+
+        <!-- Web Adapter -->
+        <service
+            android:name=".webadapter.WebAdapterService"
+            android:exported="true">
+            <intent-filter>
+                <action android:name="io.github.shadow578.tenshi.content.ADAPTER" />
+                <category android:name="io.github.shadow578.tenshi.content.ADAPTER" />
+            </intent-filter>
+
+            <meta-data
+                android:name="io.github.shadow578.tenshi.content.ADAPTER_VERSION"
+                android:value="2" />
+        </service>
+        <activity
+            android:name=".webadapter.WebAdapterActivity"
+            android:label="@string/webadapter_title" />
+    </application>
+</manifest>