Merge pull request #6576 from TeamNewPipe/release_0.21.6

Release 0.21.6

.github/CONTRIBUTING.md

@@ -3,9 +3,9 @@ NewPipe contribution guidelines
 
 ## Crash reporting
 
-Report crashes through the automated crash report system of NewPipe.
+Report crashes through the **automated crash report system** of NewPipe.
 This way all the data needed for debugging is included in your bugreport for GitHub.
-You'll see exactly what is sent, be able to add your comments, and then send it.
+You'll see *exactly* what is sent, be able to add **your comments**, and then send it.
 
 ## Issue reporting/feature requests
 
@@ -25,22 +25,57 @@ You'll see exactly what is sent, be able to add your comments, and then send it.
 
 ## Code contribution
 
-* If you want to help out with an existing bug report or feature request, leave a comment on that issue saying you want to try your hand at it.
-* If there is no existing issue for what you want to work on, open a new one describing your changes. This gives the team and the community a chance to give feedback before you spend time on something that is already in development, should be done differently, or should be avoided completely.
-* Stick to NewPipe's style conventions of [checkStyle](https://github.com/checkstyle/checkstyle). It runs each time you build the project.
-* Do not bring non-free software (e.g. binary blobs) into the project. Make sure you do not introduce Google
-  libraries.
+### Guidelines
+
+* Stick to NewPipe's *style conventions* of [checkStyle](https://github.com/checkstyle/checkstyle) and [ktlint](https://github.com/pinterest/ktlint). They run each time you build the project.
 * Stick to [F-Droid contribution guidelines](https://f-droid.org/wiki/page/Inclusion_Policy).
-* Make changes on a separate branch with a meaningful name, not on the _master_ branch or the _dev_ branch. This is commonly known as *feature branch workflow*. You may then send your changes as a pull request (PR) on GitHub.
-* Please test (compile and run) your code before submitting changes! Ideally, provide test feedback in the PR description. Untested code will **not** be merged!
-* Make sure your PR is up-to-date with the rest of the code. Often, a simple click on "Update branch" will do the job, but if not, you must rebase the dev branch manually and resolve the problems on your own. You can find help [on the wiki](https://github.com/TeamNewPipe/NewPipe/wiki/How-to-merge-a-PR). That makes the maintainers' jobs way easier.
-* Please show intention to maintain your features and code after you contribute a PR. Unmaintained code is a hassle for core developers. If you do not intend to maintain features you plan to contribute, please rethink your submission, or clearly state that in the PR description.
+* In particular **do not bring non-free software** (e.g. binary blobs) into the project. Make sure you do not introduce any closed-source library from Google.
+
+### Before starting development
+
+* If you want to help out with an existing bug report or feature request, **leave a comment** on that issue saying you want to try your hand at it.
+* If there is no existing issue for what you want to work on, **open a new one**  describing the changes you are planning to introduce. This gives the team and the community a chance to give **feedback** before you spend time on something that is already in development, should be done differently, or should be avoided completely.
+* Please show **intention to maintain your features** and code after you contribute a PR. Unmaintained code is a hassle for core developers. If you do not intend to maintain features you plan to contribute, please rethink your submission, or clearly state that in the PR description.
+* Create PRs that cover only **one specific issue/solution/bug**. Do not create PRs that are huge monoliths and could have been split into multiple independent contributions.
+* NewPipe uses [NewPipeExtractor](https://github.com/TeamNewPipe/NewPipeExtractor) to fetch data from services. If you need to change something there, you must test your changes in NewPipe. Telling NewPipe to use your extractor version can be accomplished by editing the `app/build.gradle` file: the comments under the "NewPipe libraries" section of `dependencies` will help you out.
+
+### Creating a Pull Request (PR)
+
+* Make changes on a **separate branch** with a meaningful name, not on the _master_ branch or the _dev_ branch. This is commonly known as *feature branch workflow*. You may then send your changes as a pull request (PR) on GitHub.
+* Please **test** (compile and run) your code before submitting changes! Ideally, provide test feedback in the PR description. Untested code will **not** be merged!
 * Respond if someone requests changes or otherwise raises issues about your PRs.
-* Send PRs that only cover one specific issue/solution/bug. Do not send PRs that are huge and consist of multiple independent solutions.
 * Try to figure out yourself why builds on our CI fail.
+* Make sure your PR is **up-to-date** with the rest of the code. Often, a simple click on "Update branch" will do the job, but if not, you must *rebase* your branch on the `dev` branch manually and resolve the conflicts on your own. You can find help [on the wiki](https://github.com/TeamNewPipe/NewPipe/wiki/How-to-merge-a-PR). Doing this makes the maintainers' job way easier.
+
+## IDE setup & building the app
+
+### Basic setup
+
+NewPipe is developed using [Android Studio](https://developer.android.com/studio/). Learn more about how to install it and how it works in the [official documentation](https://developer.android.com/studio/intro). In particular, make sure you have accepted Android Studio's SDK licences. Once Android Studio is ready, setting up the NewPipe project is fairly simple:
+- Clone the NewPipe repository with `git clone https://github.com/TeamNewPipe/NewPipe.git` (or use the link from your own fork, if you want to open a PR).
+- Open the folder you just cloned with Android Studio.
+- Build and run it just like you would do with any other app, with the green triangle in the top bar.
+
+You may find [SonarLint](https://www.sonarlint.org/intellij)'s **inspections** useful in helping you to write good code and prevent bugs.
+
+### checkStyle setup
+
+The [checkStyle](https://github.com/checkstyle/checkstyle) plugin verifies that Java code abides by the project style. It runs automatically each time you build the project. If you want to view errors directly in the editor, instead of having to skim through the build output, you can install an Android Studio plugin:
+- Go to `File -> Settings -> Plugins`, search for `checkstyle` and install `CheckStyle-IDEA`.
+- Go to `File -> Settings -> Tools -> Checkstyle`.
+- Add NewPipe's configuration file by clicking the `+` in the right toolbar of the "Configuration File" list.
+- Under the "Use a local Checkstyle file" bullet, click on `Browse` and pick the file named `checkstyle.xml` in the project's root folder.
+- Enable "Store relative to project location" so that moving the directory around does not create issues.
+- Insert a description in the top bar, then click `Next` and then `Finish`.
+- Activate the configuration file you just added by enabling the checkbox on the left.
+- Click `Ok` and you are done.
+
+### ktlint setup
+
+The [ktlint](https://github.com/pinterest/ktlint) plugin does the same job as checkStyle for Kotlin files. Installing the related plugin is as simple as going to `File -> Settings -> Plugins`, searching for `ktlint` and installing `Ktlint (unofficial)`.
 
 ## Communication
 
 * The #newpipe channel on Libera Chat (`ircs://irc.libera.chat:6697/newpipe`) has the core team and other developers in it. [Click here for webchat](https://web.libera.chat/#newpipe)!
-* You can also use a Matrix account to join the NewPipe channel at [#newpipe:libera.chat](https://matrix.to/#/#newpipe:libera.chat).
-* Post suggestions, changes, ideas etc. on GitHub or IRC.
+* You can also use a Matrix account to join the NewPipe channel at [#newpipe:libera.chat](https://matrix.to/#/#newpipe:libera.chat). Some convenient clients, available both for phone and desktop, are listed at that link.
+* You can post your suggestions, changes, ideas etc. on either GitHub or IRC.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -33,7 +33,7 @@ Oh no, a bug! It happens. Thanks for reporting an issue with NewPipe. To make it
 
 
 
-### Actual behaviour
+### Actual behavior
 <!-- Tell us what happens with the steps given above. -->
 
 

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,24 @@
+---
+name: Question
+about: Ask about anything NewPipe-related
+labels: question
+assignees: ''
+
+---
+
+<!-- IF YOU DON'T FILL IN THE TEMPLATE PROPERLY, YOUR ISSUE IS LIABLE TO BE CLOSED. If you feel tired/lazy right now, open your issue some other time. We'll wait. -->
+
+<!-- The comments between these brackets won't show up in the submitted issue (as you can see in the Preview). -->
+
+### Checklist
+<!-- This checklist is COMPULSORY. The first box has been checked for you to show you how it is done. -->
+
+- [x] I checked, but didn't find any duplicates (open OR closed) of this issue in the repo. <!-- Seriously, check. O_O (If there's already an issue but you'd like to see if something changed, just make a comment on the issue instead of opening a new one.) -->
+- [ ] I have read the contribution guidelines given at https://github.com/TeamNewPipe/NewPipe/blob/HEAD/.github/CONTRIBUTING.md.
+
+#### What's your question(s)?
+
+
+#### Additional context
+<!-- Add any other context, like screenshots or links, about the question here.
+Example: *Here's a photo of my cat!* -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -12,18 +12,23 @@
 - create clones
 - take over the world
 
+#### Before/After Screenshots/Screen Record
+<!-- If your PR changes the app's UI in any way, please include screenshots or a video showing exactly what changed, so that developers and users can pinpoint it easily. Delete this if it doesn't apply to your PR.-->
+- Before:
+- After:
+
 #### Fixes the following issue(s)
 <!-- Prefix issues with "Fixes" so that GitHub closes them when the PR is merged (note that each "Fixes #" should be in its own item). Also add any other relevant links. -->
 - Fixes #
 
 #### Relies on the following changes
-<!-- Delete this if it doesn't apply to you. -->
+<!-- Delete this if it doesn't apply to your PR. -->
 - 
 
 #### APK testing 
 <!-- Use a new, meaningfully named branch. The name is used as a suffix for the app ID to allow installing and testing multiple versions of NewPipe, e.g. "commentfix", if your PR implements a bugfix for comments. (No names like "patch-0" and "feature-1".)  -->
 <!-- Remove the following line if you directly link the APK created by the CI pipeline. Directly linking is preferred if you need to let users test.-->
-On the website the APK can be found by going to the "Checks" tab below the title and then on "artifacts" on the right.
+The APK can be found by going to the "Checks" tab below the title. On the left pane, click on "CI", scroll down to "artifacts" and click "app" to download the zip file which contains the debug APK of this PR.
 
 #### Due diligence
 - [ ] I read the [contribution guidelines](https://github.com/TeamNewPipe/NewPipe/blob/HEAD/.github/CONTRIBUTING.md).

.github/workflows/ci.yml

@@ -43,32 +43,37 @@ jobs:
         with:
           name: app
           path: app/build/outputs/apk/debug/*.apk
-  test-android:
-    runs-on: macos-latest
-    strategy:
-      matrix:
-        api-level: [21, 29]
-    steps:
-      - uses: actions/checkout@v2
 
-      - name: set up JDK 8
-        uses: actions/setup-java@v2
-        with:
-          java-version: 8
-          distribution: "adopt"
+# Disabled until emulator works again. see https://github.com/TeamNewPipe/NewPipe/pull/6560
+#  test-android:
+     # macos has hardware acceleration. See android-emulator-runner action
+#    runs-on: macos-latest
+#    strategy:
+#      matrix:
+          # api-level 19 is min sdk, but throws errors related to desugaring
+#        api-level: [21, 29]
+#    steps:
+#      - uses: actions/checkout@v2
+#
+#      - name: set up JDK 8
+#        uses: actions/setup-java@v2
+#        with:
+#          java-version: 8
+#          distribution: "adopt"
+#
+#      - name: Cache Gradle dependencies
+#        uses: actions/cache@v2
+#        with:
+#          path: ~/.gradle/caches
+#          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle') }}
+#          restore-keys: ${{ runner.os }}-gradle
+#
+#      - name: Run android tests
+#        uses: reactivecircus/android-emulator-runner@v2
+#        with:
+#          api-level: ${{ matrix.api-level }}
+#          script: ./gradlew connectedCheck
 
-      - name: Cache Gradle dependencies
-        uses: actions/cache@v2
-        with:
-          path: ~/.gradle/caches
-          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle') }}
-          restore-keys: ${{ runner.os }}-gradle
-
-      - name: Run android tests
-        uses: reactivecircus/android-emulator-runner@v2
-        with:
-          api-level: ${{ matrix.api-level }}
-          script: ./gradlew connectedCheck
 #   sonar:
 #     runs-on: ubuntu-latest
 #     steps:

app/build.gradle

@@ -17,8 +17,8 @@ android {
         resValue "string", "app_name", "NewPipe"
         minSdkVersion 19
         targetSdkVersion 29
-        versionCode 971
-        versionName "0.21.5"
+        versionCode 972
+        versionName "0.21.6"
 
         multiDexEnabled true
 
@@ -102,7 +102,7 @@ ext {
     checkstyleVersion = '8.38'
 
     androidxLifecycleVersion = '2.2.0'
-    androidxRoomVersion = '2.3.0-alpha03'
+    androidxRoomVersion = '2.3.0'
 
     icepickVersion = '3.2.0'
     exoPlayerVersion = '2.12.3'
@@ -182,8 +182,11 @@ dependencies {
 
 /** NewPipe libraries **/
     // You can use a local version by uncommenting a few lines in settings.gradle
+    // Or you can use a commit you pushed to GitHub by just replacing TeamNewPipe with your GitHub
+    // name and the commit hash with the commit hash of the (pushed) commit you want to test
+    // This works thanks to JitPack: https://jitpack.io/
     implementation 'com.github.TeamNewPipe:nanojson:1d9e1aea9049fc9f85e68b43ba39fe7be1c1f751'
-    implementation 'com.github.TeamNewPipe:NewPipeExtractor:v0.21.4'
+    implementation 'com.github.TeamNewPipe:NewPipeExtractor:v0.21.6'
 
 /** Checkstyle **/
     checkstyle "com.puppycrawl.tools:checkstyle:${checkstyleVersion}"
@@ -198,6 +201,7 @@ dependencies {
     implementation 'androidx.constraintlayout:constraintlayout:2.0.4'
     implementation 'androidx.core:core-ktx:1.3.2'
     implementation 'androidx.documentfile:documentfile:1.0.1'
+    implementation 'androidx.fragment:fragment-ktx:1.3.4'
     implementation "androidx.lifecycle:lifecycle-livedata:${androidxLifecycleVersion}"
     implementation "androidx.lifecycle:lifecycle-viewmodel:${androidxLifecycleVersion}"
     implementation 'androidx.localbroadcastmanager:localbroadcastmanager:1.0.0'

app/src/main/AndroidManifest.xml

@@ -22,7 +22,6 @@
         android:icon="@mipmap/ic_launcher"
         android:label="@string/app_name"
         android:logo="@mipmap/ic_launcher"
-        android:requestLegacyExternalStorage="true"
         android:theme="@style/OpeningTheme"
         android:resizeableActivity="true"
         tools:ignore="AllowBackup">
@@ -232,18 +231,26 @@
                 <data android:host="invidious.snopyta.org" />
                 <data android:host="yewtu.be" />
                 <data android:host="tube.connect.cafe" />
-                <data android:host="invidious.zapashcanon.fr" />
                 <data android:host="invidious.kavin.rocks" />
-                <data android:host="invidious.tube" />
+                <data android:host="invidious-us.kavin.rocks" />
+                <data android:host="piped.kavin.rocks" />
                 <data android:host="invidious.site" />
-                <data android:host="invidious.xyz" />
                 <data android:host="vid.mint.lgbt" />
                 <data android:host="invidiou.site" />
                 <data android:host="invidious.fdn.fr" />
                 <data android:host="invidious.048596.xyz" />
                 <data android:host="invidious.zee.li" />
                 <data android:host="vid.puffyan.us" />
                 <data android:host="ytprivate.com" />
+                <data android:host="invidious.namazso.eu" />
+                <data android:host="invidious.silkky.cloud" />
+                <data android:host="invidious.exonip.de" />
+                <data android:host="inv.riverside.rocks" />
+                <data android:host="invidious.blamefran.net" />
+                <data android:host="invidious.moomoo.me" />
+                <data android:host="ytb.trom.tf" />
+                <data android:host="yt.cyberhost.uk" />
+                <data android:host="y.com.cm" />
                 <data android:pathPrefix="/" />
             </intent-filter>
 

app/src/main/java/com/google/android/material/appbar/FlingBehavior.java

@@ -63,8 +63,9 @@ public boolean onRequestChildRectangleOnScreen(
         return consumed == dy;
     }
 
-    public boolean onInterceptTouchEvent(final CoordinatorLayout parent, final AppBarLayout child,
-                                         final MotionEvent ev) {
+    public boolean onInterceptTouchEvent(@NonNull final CoordinatorLayout parent,
+                                         @NonNull final AppBarLayout child,
+                                         @NonNull final MotionEvent ev) {
         for (final Integer element : skipInterceptionOfElements) {
             final View view = child.findViewById(element);
             if (view != null) {

app/src/main/java/org/schabi/newpipe/App.java

@@ -27,7 +27,7 @@
 import org.schabi.newpipe.extractor.NewPipe;
 import org.schabi.newpipe.extractor.downloader.Downloader;
 import org.schabi.newpipe.ktx.ExceptionUtils;
-import org.schabi.newpipe.settings.SettingsActivity;
+import org.schabi.newpipe.settings.NewPipeSettings;
 import org.schabi.newpipe.util.Localization;
 import org.schabi.newpipe.util.ServiceHelper;
 import org.schabi.newpipe.util.StateSaver;
@@ -91,7 +91,7 @@ public void onCreate() {
         app = this;
 
         // Initialize settings first because others inits can use its values
-        SettingsActivity.initSettings(this);
+        NewPipeSettings.initSettings(this);
 
         NewPipe.init(getDownloader(),
             Localization.getPreferredLocalization(this),

app/src/main/java/org/schabi/newpipe/CheckForNewAppVersion.java

@@ -129,13 +129,8 @@ private static void compareAppVersionAndShowNotification(@NonNull final Applicat
 
         if (BuildConfig.VERSION_CODE < versionCode) {
             // A pending intent to open the apk location url in the browser.
-            final Intent viewIntent = new Intent(Intent.ACTION_VIEW, Uri.parse(apkLocationUrl));
-
-            final Intent intent = new Intent(Intent.ACTION_CHOOSER);
-            intent.putExtra(Intent.EXTRA_INTENT, viewIntent);
-            intent.putExtra(Intent.EXTRA_TITLE, R.string.open_with);
+            final Intent intent = new Intent(Intent.ACTION_VIEW, Uri.parse(apkLocationUrl));
             intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
-
             final PendingIntent pendingIntent
                     = PendingIntent.getActivity(application, 0, intent, 0);
 

app/src/main/java/org/schabi/newpipe/ExitActivity.java

@@ -6,6 +6,8 @@
 import android.os.Build;
 import android.os.Bundle;
 
+import org.schabi.newpipe.util.NavigationHelper;
+
 /*
  * Copyright (C) Hans-Christoph Steiner 2016 <[email protected]>
  * ExitActivity.java is part of NewPipe.
@@ -48,6 +50,6 @@ protected void onCreate(final Bundle savedInstanceState) {
             finish();
         }
 
-        System.exit(0);
+        NavigationHelper.restartApp(this);
     }
 }

app/src/main/java/org/schabi/newpipe/MainActivity.java

@@ -603,6 +603,7 @@ public void onBackPressed() {
     public void onRequestPermissionsResult(final int requestCode,
                                            @NonNull final String[] permissions,
                                            @NonNull final int[] grantResults) {
+        super.onRequestPermissionsResult(requestCode, permissions, grantResults);
         for (final int i : grantResults) {
             if (i == PackageManager.PERMISSION_DENIED) {
                 return;

app/src/main/java/org/schabi/newpipe/NewPipeDatabase.java

@@ -51,4 +51,15 @@ public static void checkpoint() {
             throw new RuntimeException("Checkpoint was blocked from completing");
         }
     }
+
+    public static void close() {
+        if (databaseInstance != null) {
+            synchronized (NewPipeDatabase.class) {
+                if (databaseInstance != null) {
+                    databaseInstance.close();
+                    databaseInstance = null;
+                }
+            }
+        }
+    }
 }