Added help for instances

Author: litetex

app/src/main/java/org/schabi/newpipe/settings/services/instances/AbstractServiceInstanceListFragment.java

@@ -51,10 +51,14 @@ public abstract class AbstractServiceInstanceListFragment<I extends Instance> ex
     protected static final int TYPES_CONTAINER_ANIMATION_DURATION = 500;
 
     @StringRes
-    protected final int title;
+    protected final int titleRes;
 
-    protected final List<? extends InstanceTypeCreator<? extends I>> instanceTypeCreators;
     protected final InstanceManager<I> manager;
+    protected final List<? extends InstanceTypeCreator<? extends I>> instanceTypeCreators;
+
+    @Nullable
+    @StringRes
+    protected final Integer helpTextMsgRes;
 
     protected final List<I> currentInstances = new ArrayList<>();
     protected I selectedInstance;
@@ -66,13 +70,15 @@ public abstract class AbstractServiceInstanceListFragment<I extends Instance> ex
     protected CompositeDisposable disposables = new CompositeDisposable();
 
     protected AbstractServiceInstanceListFragment(
-            @StringRes final int title,
+            @StringRes final int titleRes,
             @NonNull final InstanceManager<I> manager,
-            @NonNull final List<? extends InstanceTypeCreator<? extends I>> instanceTypeCreators
+            @NonNull final List<? extends InstanceTypeCreator<? extends I>> instanceTypeCreators,
+            @Nullable @StringRes final Integer helpTextMsgRes
     ) {
-        this.title = title;
+        this.titleRes = titleRes;
         this.manager = manager;
         this.instanceTypeCreators = instanceTypeCreators;
+        this.helpTextMsgRes = helpTextMsgRes;
     }
 
     @Override
@@ -118,7 +124,7 @@ public void onViewCreated(
     @Override
     public void onResume() {
         super.onResume();
-        ThemeHelper.setTitleToAppCompatActivity(getActivity(), getString(title));
+        ThemeHelper.setTitleToAppCompatActivity(getActivity(), getString(titleRes));
     }
 
     @Override
@@ -145,6 +151,8 @@ public void onCreateOptionsMenu(@NonNull final Menu menu,
                                     @NonNull final MenuInflater inflater) {
         super.onCreateOptionsMenu(menu, inflater);
         inflater.inflate(R.menu.menu_chooser_fragment, menu);
+
+        menu.findItem(R.id.menu_item_instance_help).setVisible(helpTextMsgRes != null);
     }
 
     @Override
@@ -153,6 +161,10 @@ public boolean onOptionsItemSelected(final MenuItem item) {
             restoreDefaults();
             return true;
         }
+        if (item.getItemId() == R.id.menu_item_instance_help) {
+            openHelp();
+            return true;
+        }
 
         return super.onOptionsItemSelected(item);
     }
@@ -191,6 +203,18 @@ protected void restoreDefaults() {
                 .show();
     }
 
+    protected void openHelp() {
+        if (helpTextMsgRes == null) {
+            return;
+        }
+
+        new AlertDialog.Builder(requireContext())
+                .setTitle(R.string.help)
+                .setMessage(helpTextMsgRes)
+                .setPositiveButton(R.string.ok, null)
+                .show();
+    }
+
     protected void onFABCreateButtonClicked() {
         final List<InstanceTypeCreator<? extends I>> availableInstanceTypeCreators =
                 instanceTypeCreators.stream()

app/src/main/java/org/schabi/newpipe/settings/services/instances/peertube/PeertubeInstanceListFragment.java

@@ -15,7 +15,8 @@ public PeertubeInstanceListFragment() {
         super(
                 R.string.peertube_instance_url_title,
                 PeertubeInstanceManager.MANAGER,
-                Collections.singletonList(new PeerTubeInstanceTypeCreator()));
+                Collections.singletonList(new PeerTubeInstanceTypeCreator()),
+                null);
     }
 
     public static class PeerTubeInstanceTypeCreator

app/src/main/java/org/schabi/newpipe/settings/services/instances/youtubelike/YouTubeLikeInstanceListFragment.java

@@ -27,7 +27,8 @@ public YouTubeLikeInstanceListFragment() {
                 YoutubeLikeInstanceManager.MANAGER,
                 Arrays.asList(
                         new YouTubeInstanceTypeCreator(),
-                        new InvidiousInstanceTypeCreator()));
+                        new InvidiousInstanceTypeCreator()),
+                R.string.yt_like_instance_list_help);
     }
 
 

app/src/main/res/menu/menu_chooser_fragment.xml

@@ -5,4 +5,9 @@
         android:title="@string/restore_defaults"
         android:icon="@drawable/ic_settings_backup_restore"
         app:showAsAction="always" />
+    <item
+        android:id="@+id/menu_item_instance_help"
+        android:icon="@drawable/ic_help"
+        android:title="@string/help"
+        app:showAsAction="ifRoom" />
 </menu>

app/src/main/res/values/strings.xml

@@ -131,7 +131,8 @@
     <string name="peertube_instance_url_title">PeerTube instances</string>
     <string name="peertube_instance_url_summary">Select your favorite PeerTube instances</string>
     <string name="yt_like_instance_url_title">YouTube-Like instances</string>
-    <string name="yt_like_instance_url_summary">Manage YouTube-Like instances</string>
+    <string name="yt_like_instance_url_summary">Manage YouTube-Like service instances</string>
+    <string name="yt_like_instance_list_help">This page allows you to manage YouTube-Like service instances.\n\nAn instance provides a alternative way of fetching and delivering content (like a proxy), which can be helpful if the direct extraction fails.\n\nFurthermore it may also provide improved performance, better privacy / tracking protection and additional information.\nHowever keep in mind that an instance might not implement all features and thus limitations may occur.</string>
     <string name="publicly_available_instances_help">A list of publicly available instances can be found at %s</string>
     <string name="add_instance">Add %s instance</string>
     <string name="enter_instance_url">Enter instance URL</string>