From c934c25d779b0a69bd8cef2c812b677082fa17ba Mon Sep 17 00:00:00 2001
From: "u7322148@anu.edu.au" <u7322148@anu.edu.au>
Date: Tue, 15 Oct 2024 23:44:55 +1100
Subject: [PATCH] Extended custom URL scheme to include service selection

- Implemented the abilImplemented the ability for third-party apps to initiate a search in NewPipe on a specific service by using the custom URL scheme `newpipe://search?service=SERVICE_NAME&q=YOUR_QUERY`.
- Added intent-filter to RouterActivity to handle the custom URL scheme.
- Enhanced RouterActivity to parse the incoming service parameter, retrieve the corresponding service ID, and start MainActivity with the specified service and search query.
- Added error handling for invalid service names: displays an error message to the user if the service name is invalid.
- Tested the implementation using ADB commands to send an intent with the custom URI.
Fixes: Expose search API with url #3475

Add new tag to customize urls

add logic of handling custom search intents in onCreate method

add comments to helping review

add a new method to get the service by name

improve the RouterActivity to handle the service name

improve the RouterActivity
---
 app/src/main/AndroidManifest.xml              |  8 +++
 .../org/schabi/newpipe/RouterActivity.java    | 50 +++++++++++++++++++
 .../SeekbarPreviewThumbnailHolder.java        | 13 ++++-
 .../schabi/newpipe/util/ServiceHelper.java    | 10 ++++
 4 files changed, 79 insertions(+), 2 deletions(-)

diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml
index d11de9f478d..6692f8537d7 100644
--- a/app/src/main/AndroidManifest.xml
+++ b/app/src/main/AndroidManifest.xml
@@ -406,6 +406,14 @@
                 <data android:sspPattern="bandcamp.com/?show=*" />
             </intent-filter>
 
+            <!-- customized search URL filter -->
+            <intent-filter>
+                <action android:name="android.intent.action.VIEW" />
+                <category android:name="android.intent.category.DEFAULT" />
+                <category android:name="android.intent.category.BROWSABLE" />
+                <data android:scheme="newpipe" android:host="search" />
+            </intent-filter>
+
         </activity>
         <service
             android:name=".RouterActivity$FetcherService"
diff --git a/app/src/main/java/org/schabi/newpipe/RouterActivity.java b/app/src/main/java/org/schabi/newpipe/RouterActivity.java
index 197c965bac5..1849060e522 100644
--- a/app/src/main/java/org/schabi/newpipe/RouterActivity.java
+++ b/app/src/main/java/org/schabi/newpipe/RouterActivity.java
@@ -10,6 +10,7 @@
 import android.content.Intent;
 import android.content.SharedPreferences;
 import android.content.pm.PackageManager;
+import android.net.Uri;
 import android.os.Build;
 import android.os.Bundle;
 import android.text.TextUtils;
@@ -87,6 +88,7 @@
 import org.schabi.newpipe.util.Localization;
 import org.schabi.newpipe.util.NavigationHelper;
 import org.schabi.newpipe.util.PermissionHelper;
+import org.schabi.newpipe.util.ServiceHelper;
 import org.schabi.newpipe.util.ThemeHelper;
 import org.schabi.newpipe.util.external_communication.ShareUtils;
 import org.schabi.newpipe.util.urlfinder.UrlFinder;
@@ -127,6 +129,12 @@ public class RouterActivity extends AppCompatActivity {
     private AlertDialog alertDialogChoice = null;
     private FragmentManager.FragmentLifecycleCallbacks dismissListener = null;
 
+    /**
+     * Initializes the activity based on the incoming intent. This activity acts as a router
+     * to direct the user to different parts of the app based on the URL or action specified
+     * in the intent. It handles special URLs like 'newpipe://search?q=query' to trigger
+     * search directly or standard URLs to open specific videos, playlists, or channels.
+     */
     @Override
     protected void onCreate(final Bundle savedInstanceState) {
         ThemeHelper.setDayNightMode(this);
@@ -153,7 +161,49 @@ protected void onCreate(final Bundle savedInstanceState) {
         getWindow().setAttributes(params);
 
         super.onCreate(savedInstanceState);
+
         Bridge.restoreInstanceState(this, savedInstanceState);
+        // Restoring state with Icepick for handling screen rotations more efficiently
+        Icepick.restoreInstanceState(this, savedInstanceState);
+
+        final Intent actionIntent = getIntent();
+        final Uri data = actionIntent.getData();
+        if (data != null) {
+            final String scheme = data.getScheme();
+            final String host = data.getHost();
+            if ("newpipe".equals(scheme) && "search".equals(host)) {
+                final String query = data.getQueryParameter("q");
+                final String serviceName = data.getQueryParameter("service");
+                // Default to use current service
+                int serviceId = ServiceHelper.getSelectedServiceId(this);
+
+                if (serviceName != null) {
+                    // Base on the service name to get correspond Id
+                    try {
+                        serviceId = ServiceHelper.getServiceIdByName(serviceName);
+                    } catch (final IllegalArgumentException e) {
+                        // If service name is invalid, show the Error message
+                        Toast.makeText(this, "Invalid service name", Toast.LENGTH_SHORT).show();
+                        finish();
+                        return;
+                    }
+                }
+
+                if (query != null) {
+                    // Enable the search function
+                    final Intent searchIntent = new Intent(this, MainActivity.class);
+                    searchIntent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
+                            | Intent.FLAG_ACTIVITY_CLEAR_TOP);
+                    searchIntent.putExtra(Constants.KEY_OPEN_SEARCH, true);
+                    searchIntent.putExtra(Constants.KEY_SERVICE_ID, serviceId);
+                    searchIntent.putExtra(Constants.KEY_SEARCH_STRING, query);
+                    startActivity(searchIntent);
+                    currentUrl = null;
+                    finish();
+                    return;
+                }
+            }
+        }
 
         // FragmentManager will take care to recreate (Playlist|Download)Dialog when screen rotates
         // We used to .setOnDismissListener(dialog -> finish()); when creating these DialogFragments
diff --git a/app/src/main/java/org/schabi/newpipe/player/seekbarpreview/SeekbarPreviewThumbnailHolder.java b/app/src/main/java/org/schabi/newpipe/player/seekbarpreview/SeekbarPreviewThumbnailHolder.java
index 09c61b8b35a..c7e4cd78141 100644
--- a/app/src/main/java/org/schabi/newpipe/player/seekbarpreview/SeekbarPreviewThumbnailHolder.java
+++ b/app/src/main/java/org/schabi/newpipe/player/seekbarpreview/SeekbarPreviewThumbnailHolder.java
@@ -132,8 +132,17 @@ private void generateDataFrom(final Frameset frameset, final UUID updateRequestI
 
                 // Get the bounds where the frame is found
                 final int[] bounds = frameset.getFrameBoundsAt(currentPosMs);
-                generatedDataForUrl.put(currentPosMs,
-                                        createBitmapSupplier(srcBitMap, bounds, frameset));
+                generatedDataForUrl.put(currentPosMs, () -> {
+                    // It can happen, that the original bitmap could not be downloaded
+                    // In such a case - we don't want a NullPointer - simply return null
+                    if (srcBitMap == null) {
+                        return null;
+                    }
+
+                    // Cut out the corresponding bitmap form the "srcBitMap"
+                    return Bitmap.createBitmap(srcBitMap, bounds[1], bounds[2],
+                            frameset.getFrameWidth(), frameset.getFrameHeight());
+                });
 
                 currentPosMs += frameset.getDurationPerFrame();
                 pos++;
diff --git a/app/src/main/java/org/schabi/newpipe/util/ServiceHelper.java b/app/src/main/java/org/schabi/newpipe/util/ServiceHelper.java
index c712157b35b..15e4841e78a 100644
--- a/app/src/main/java/org/schabi/newpipe/util/ServiceHelper.java
+++ b/app/src/main/java/org/schabi/newpipe/util/ServiceHelper.java
@@ -121,6 +121,16 @@ public static int getSelectedServiceId(final Context context) {
                 .getServiceId();
     }
 
+    public static int getServiceIdByName(final String serviceName) throws IllegalArgumentException {
+        for (final StreamingService s : NewPipe.getServices()) {
+            if (s.getServiceInfo().getName().equalsIgnoreCase(serviceName)) {
+                return s.getServiceId();
+            }
+        }
+        throw new IllegalArgumentException("Invalid service name");
+    }
+
+
     @Nullable
     public static StreamingService getSelectedService(final Context context) {
         final String serviceName = PreferenceManager.getDefaultSharedPreferences(context)