[Android] Wrap all share parameters into the ShareParams class

chrome/android/java/src/org/chromium/chrome/browser/share/ShareHelper.java

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package org.chromium.chrome.browser.share;
 
 import android.annotation.TargetApi;
 import android.app.Activity;
 import android.app.PendingIntent;
 import android.content.BroadcastReceiver;
@@ skipping 267 matching lines @@
 
     /**
      * Creates and shows a share intent picker dialog or starts a share intent directly with the
      * activity that was most recently used to share based on shareDirectly value.
      *
      * This function will save |screenshot| under {app's root}/files/images/screenshot (or
      * /sdcard/DCIM/browser-images/screenshot if ADK is lower than JB MR2).
      * Cleaning up doesn't happen automatically, and so an app should call clearSharedScreenshots()
      * explicitly when needed.
      *
-     * @param shareDirectly Whether it should share directly with the activity that was most
-     *                      recently used to share.
-     * @param saveLastUsed Whether to save the chosen activity for future direct sharing.
-     * @param activity Activity that is used to access package manager.
-     * @param title Title of the page to be shared.
-     * @param text Text to be shared. If both |text| and |url| are supplied, they are concatenated
-     *             with a space.
-     * @param url URL of the page to be shared.
-     * @param offlineUri URI to the offline MHTML file to be shared.
-     * @param screenshotUri Uri of the screenshot of the page to be shared.
-     * @param callback Optional callback to be called when user makes a choice. Will not be called
-     *                 if receiving a response when the user makes a choice is not supported (on
-     *                 older Android versions).
+     * @param params The container holding the share parameters.
      */
-    public static void share(boolean shareDirectly, boolean saveLastUsed, Activity activity,
-            String title, String text, String url, @Nullable Uri offlineUri, Uri screenshotUri,
-            @Nullable TargetChosenCallback callback) {
-        if (shareDirectly) {
-            shareWithLastUsed(activity, title, text, url, offlineUri, screenshotUri);
+    public static void share(ShareParams params) {
+        if (params.isShareDirectly()) {
+            ComponentName component = getLastShareComponentName();
+            if (component == null) return;
+            makeIntentAndShare(params, component);
         } else if (TargetChosenReceiver.isSupported()) {
-            makeIntentAndShare(saveLastUsed, activity, title, text, url, offlineUri, screenshotUri,
-                    null, callback);
+            makeIntentAndShare(params, null);
         } else {
-            showShareDialog(
-                    saveLastUsed, activity, title, text, url, offlineUri, screenshotUri, callback);
+            showShareDialog(params);
         }
     }
 
     /**
      * Trigger the share action for the given image data.
      * @param activity The activity used to trigger the share action.
      * @param jpegImageData The image data to be shared in jpeg format.
      * @param name When this is not null, it will share the image directly with the
      *             {@link ComponentName}
      */
@@ skipping 110 matching lines @@
                     fileUri = ApiCompatibilityUtils.getUriForImageCaptureFile(savedFile);
                 }
                 callback.onResult(fileUri);
             }
         }.executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR);
     }
 
     /**
      * Creates and shows a share intent picker dialog.
      *
-     * @param saveLastUsed Whether to save the chosen activity for future direct sharing.
-     * @param activity Activity that is used to access package manager.
-     * @param title Title of the page to be shared.
-     * @param text Text to be shared. If both |text| and |url| are supplied, they are concatenated
-     *             with a space.
-     * @param url URL of the page to be shared.
-     * @oaram offlineUri URI of the offline page to be shared.
-     * @param screenshotUri Uri of the screenshot of the page to be shared.
-     * @param callback Optional callback to be called when user makes a choice. Will not be called
-     *                 if receiving a response when the user makes a choice is not supported (on
-     *                 older Android versions).
+     * @param params The container holding the share parameters.
      */
-    private static void showShareDialog(final boolean saveLastUsed, final Activity activity,
-            final String title, final String text, final String url, final Uri offlineUri,
-            final Uri screenshotUri, @Nullable final TargetChosenCallback callback) {
-        Intent intent = getShareIntent(activity, title, text, url, null, null);
+    private static void showShareDialog(final ShareParams params) {
+        Activity activity = params.getActivity();
+        final TargetChosenCallback callback = params.getCallback();
+        Intent intent = getShareLinkAppCompatibilityIntent();
         PackageManager manager = activity.getPackageManager();
         List<ResolveInfo> resolveInfoList = manager.queryIntentActivities(intent, 0);
         assert resolveInfoList.size() > 0;
         if (resolveInfoList.size() == 0) return;
         Collections.sort(resolveInfoList, new ResolveInfo.DisplayNameComparator(manager));
 
         final ShareDialogAdapter adapter =
                 new ShareDialogAdapter(activity, manager, resolveInfoList);
         AlertDialog.Builder builder = new AlertDialog.Builder(activity, R.style.AlertDialogTheme);
         builder.setTitle(activity.getString(R.string.share_link_chooser_title));
         builder.setAdapter(adapter, null);
 
         // Need a mutable object to record whether the callback has been fired.
         final boolean[] callbackCalled = new boolean[1];
 
         final AlertDialog dialog = builder.create();
         dialog.show();
         dialog.getListView().setOnItemClickListener(new OnItemClickListener() {
             @Override
             public void onItemClick(AdapterView<?> parent, View view, int position, long id) {
                 ResolveInfo info = adapter.getItem(position);
                 ActivityInfo ai = info.activityInfo;
                 ComponentName component =
                         new ComponentName(ai.applicationInfo.packageName, ai.name);
+
                 if (callback != null && !callbackCalled[0]) {
                     callback.onTargetChosen(component);
                     callbackCalled[0] = true;
                 }
-                if (saveLastUsed) setLastShareComponentName(component);
-                makeIntentAndShare(false, activity, title, text, url, offlineUri, screenshotUri,
-                        component, null);
+                if (params.isSaveLastUsed()) setLastShareComponentName(component);
+                makeIntentAndShare(params, component);
                 dialog.dismiss();
             }
         });
 
         if (callback != null) {
             dialog.setOnDismissListener(new OnDismissListener() {
                 @Override
                 public void onDismiss(DialogInterface dialog) {
                     if (!callbackCalled[0]) {
                         callback.onCancel();
                         callbackCalled[0] = true;
                     }
                 }
             });
         }
 
         if (sFakeIntentReceiverForTesting != null) {
             sFakeIntentReceiverForTesting.onCustomChooserShown(dialog);
         }
     }
 
-    /**
-     * Starts a share intent with the activity that was most recently used to share.
-     * If there is no most recently used activity, it does nothing.
-     * @param activity Activity that is used to start the share intent.
-     * @param title Title of the page to be shared.
-     * @param text Text to be shared. If both |text| and |url| are supplied, they are concatenated
-     *             with a space.
-     * @param url URL of the page to be shared.
-     * @oaram offlineUri URI of the offline page to be shared.
-     * @param screenshotUri Uri of the screenshot of the page to be shared.
-     */
-    private static void shareWithLastUsed(Activity activity, String title, String text, String url,
-            Uri offlineUri, Uri screenshotUri) {
-        ComponentName component = getLastShareComponentName();
-        if (component == null) return;
-        makeIntentAndShare(
-                false, activity, title, text, url, offlineUri, screenshotUri, component, null);
-    }
-
-    private static void shareIntent(boolean saveLastUsed, Activity activity, Intent sharingIntent,
-                                    @Nullable TargetChosenCallback callback) {
-        if (sharingIntent.getComponent() != null) {
+    private static void makeIntentAndShare(ShareParams params, @Nullable ComponentName component) {
+        Intent intent = getShareLinkIntent(params);
+        intent.addFlags(Intent.FLAG_ACTIVITY_FORWARD_RESULT | Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
+        intent.setComponent(component);
+        if (intent.getComponent() != null) {
             // If a component was specified, there should not also be a callback.
-            assert callback == null;
-            fireIntent(activity, sharingIntent);
+            assert params.getCallback() == null;
+            fireIntent(params.getActivity(), intent);
         } else {
             assert TargetChosenReceiver.isSupported();
-            TargetChosenReceiver.sendChooserIntent(saveLastUsed, activity, sharingIntent, callback);
+            TargetChosenReceiver.sendChooserIntent(
+                    params.isSaveLastUsed(), params.getActivity(), intent, params.getCallback());
         }
     }
 
-    private static void makeIntentAndShare(final boolean saveLastUsed, final Activity activity,
-            final String title, final String text, final String url, final Uri offlineUri,
-            final Uri screenshotUri, final ComponentName component,
-            @Nullable final TargetChosenCallback callback) {
-        Intent intent = getDirectShareIntentForComponent(
-                activity, title, text, url, offlineUri, screenshotUri, component);
-        shareIntent(saveLastUsed, activity, intent, callback);
-    }
-
     /**
      * Set the icon and the title for the menu item used for direct share.
      *
      * @param activity Activity that is used to access the package manager.
      * @param item The menu item that is used for direct share
      */
     public static void configureDirectShareMenuItem(Activity activity, MenuItem item) {
-        Intent shareIntent = getShareIntent(activity, "", "", "", null, null);
+        Intent shareIntent = getShareLinkAppCompatibilityIntent();
         Pair<Drawable, CharSequence> directShare = getShareableIconAndName(activity, shareIntent);
         Drawable directShareIcon = directShare.first;
         CharSequence directShareTitle = directShare.second;
 
         item.setIcon(directShareIcon);
         if (directShareTitle != null) {
             item.setTitle(
                     activity.getString(R.string.accessibility_menu_share_via, directShareTitle));
         }
     }
@@ skipping 73 matching lines @@
     @VisibleForTesting
     public static void setLastShareComponentName(ComponentName component) {
         SharedPreferences preferences = ContextUtils.getAppSharedPreferences();
         SharedPreferences.Editor editor = preferences.edit();
         editor.putString(PACKAGE_NAME_KEY, component.getPackageName());
         editor.putString(CLASS_NAME_KEY, component.getClassName());
         editor.apply();
     }
 
     @VisibleForTesting
-    public static Intent getShareIntent(Activity activity, String title, String text, String url,
-            Uri offlineUri, Uri screenshotUri) {
+    public static Intent getShareLinkIntent(ShareParams params) {
+        String url = params.getUrl();
+        String text = params.getText();
         if (!TextUtils.isEmpty(url)) {
             url = DomDistillerUrlUtils.getOriginalUrlFromDistillerUrl(url);
             if (!TextUtils.isEmpty(text)) {
                 // Concatenate text and URL with a space.
                 text = text + " " + url;
             } else {
                 text = url;
             }
         }
 
         Intent intent = new Intent(Intent.ACTION_SEND);
         intent.addFlags(ApiCompatibilityUtils.getActivityNewDocumentFlag());
-        intent.putExtra(Intent.EXTRA_SUBJECT, title);
+        intent.putExtra(Intent.EXTRA_SUBJECT, params.getTitle());
         intent.putExtra(Intent.EXTRA_TEXT, text);
-        intent.putExtra(EXTRA_TASK_ID, activity.getTaskId());
+        intent.putExtra(EXTRA_TASK_ID, params.getActivity().getTaskId());
 
+        Uri screenshotUri = params.getScreenshotUri();
         if (screenshotUri != null) {
             intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
-        }
-        if (screenshotUri != null) {
             // To give read access to an Intent target, we need to put |screenshotUri| in clipData
             // because adding Intent.FLAG_GRANT_READ_URI_PERMISSION doesn't work for
             // EXTRA_SHARE_SCREENSHOT_AS_STREAM.
             intent.setClipData(ClipData.newRawUri("", screenshotUri));
             intent.putExtra(EXTRA_SHARE_SCREENSHOT_AS_STREAM, screenshotUri);
         }
-        if (offlineUri == null) {
+        if (params.getOfflineUri() == null) {
             intent.setType("text/plain");
         } else {
             intent.setType("multipart/related");
-            intent.putExtra(Intent.EXTRA_STREAM, offlineUri);
+            intent.putExtra(Intent.EXTRA_STREAM, params.getOfflineUri());
         }
         return intent;
     }
 
     /**
      * Creates an Intent to share an image.
      * @param imageUri The Uri of the image.
      * @return The Intent used to share the image.
      */
     public static Intent getShareImageIntent(Uri imageUri) {
         Intent intent = new Intent(Intent.ACTION_SEND);
         intent.addFlags(ApiCompatibilityUtils.getActivityNewDocumentFlag());
         intent.setType("image/jpeg");
         intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
         intent.putExtra(Intent.EXTRA_STREAM, imageUri);
         return intent;
     }
 
-    private static Intent getDirectShareIntentForComponent(Activity activity, String title,
-            String text, String url, Uri offlineUri, Uri screenshotUri, ComponentName component) {
-        Intent intent = getShareIntent(activity, title, text, url, offlineUri, screenshotUri);
-        intent.addFlags(Intent.FLAG_ACTIVITY_FORWARD_RESULT
-                | Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
-        intent.setComponent(component);
+    /**
+     * Convenient method to create an Intent to retrieve all the apps support sharing text.

[Yusuf, 2017/06/02 20:07:46]

Convenience

[ltian, 2017/06/02 23:44:39]

Done.

+     */
+    public static Intent getShareLinkAppCompatibilityIntent() {
+        Intent intent = new Intent(Intent.ACTION_SEND);
+        intent.addFlags(ApiCompatibilityUtils.getActivityNewDocumentFlag());
+        intent.putExtra(Intent.EXTRA_SUBJECT, "");
+        intent.putExtra(Intent.EXTRA_TEXT, "");
+        intent.setType("text/plain");
         return intent;
     }
 
     /**
      * Gets the {@link ComponentName} of the app that was used to last share.
      */
     @Nullable
     public static ComponentName getLastShareComponentName() {
         SharedPreferences preferences = ContextUtils.getAppSharedPreferences();
         String packageName = preferences.getString(PACKAGE_NAME_KEY, null);
         String className = preferences.getString(CLASS_NAME_KEY, null);
         if (packageName == null || className == null) return null;
         return new ComponentName(packageName, className);
     }
 }