Refactor ChromeContextMenuPopulator population

chrome/android/java/src/org/chromium/chrome/browser/contextmenu/ChromeContextMenuPopulator.java

 // Copyright 2013 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.contextmenu;
 
 import android.content.Context;
 import android.net.MailTo;
 import android.support.annotation.IntDef;
 import android.text.TextUtils;
 import android.view.ContextMenu;
 import android.view.MenuInflater;
 import android.view.MenuItem;
 import android.webkit.MimeTypeMap;
 
 import org.chromium.base.metrics.RecordHistogram;
 import org.chromium.chrome.R;
 import org.chromium.chrome.browser.UrlConstants;
 import org.chromium.chrome.browser.firstrun.FirstRunStatus;
 import org.chromium.chrome.browser.preferences.ChromePreferenceManager;
 import org.chromium.chrome.browser.preferences.datareduction.DataReductionProxyUma;
 import org.chromium.chrome.browser.search_engines.TemplateUrlService;
 import org.chromium.chrome.browser.util.UrlUtilities;
 
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.util.Arrays;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.Iterator;
+import java.util.Set;
 
 /**
  * A {@link ContextMenuPopulator} used for showing the default Chrome context menu.
  */
 public class ChromeContextMenuPopulator implements ContextMenuPopulator {
 
     private static final String TAG = "CCMenuPopulator";
 
     /**
      * Defines the context menu modes
      */
     @Retention(RetentionPolicy.SOURCE)
     @IntDef({
         NORMAL_MODE, /* Default mode */
         CUSTOM_TAB_MODE, /* Custom tab mode */
         FULLSCREEN_TAB_MODE /* Full screen mode */
     })
     public @interface ContextMenuMode {}
 
     public static final int NORMAL_MODE = 0;
     public static final int CUSTOM_TAB_MODE = 1;
     public static final int FULLSCREEN_TAB_MODE = 2;
 
     // Items that are included in all context menus.
-    private static final int[] BASE_WHITELIST = {
-            R.id.contextmenu_copy_link_address,
-            R.id.contextmenu_call,
-            R.id.contextmenu_send_message,
-            R.id.contextmenu_add_to_contacts,
-            R.id.contextmenu_copy,
-            R.id.contextmenu_copy_link_text,
-            R.id.contextmenu_load_original_image,
-            R.id.contextmenu_save_link_as,
-            R.id.contextmenu_save_image,
-            R.id.contextmenu_share_image,
-            R.id.contextmenu_save_video,
+    private static final Integer[] BASE_WHITELIST = {

[JJ, 2017/03/01 01:41:04]

cl format would not letup about changing this from a line to shrinking it as
much as possible. I originally ignored it but then realized that the custom Tab
actually does it so I let it through.

+            R.id.contextmenu_copy_link_address, R.id.contextmenu_call,
+            R.id.contextmenu_send_message, R.id.contextmenu_add_to_contacts, R.id.contextmenu_copy,
+            R.id.contextmenu_copy_link_text, R.id.contextmenu_load_original_image,
+            R.id.contextmenu_save_link_as, R.id.contextmenu_save_image,
+            R.id.contextmenu_share_image, R.id.contextmenu_save_video,
     };
 
     // Items that are included for normal Chrome browser mode.
-    private static final int[] NORMAL_MODE_WHITELIST = {
-            R.id.contextmenu_open_in_new_tab,
-            R.id.contextmenu_open_in_other_window,
-            R.id.contextmenu_open_in_incognito_tab,
-            R.id.contextmenu_save_link_as,
-            R.id.contextmenu_open_image_in_new_tab,
-            R.id.contextmenu_search_by_image,
+    private static final Integer[] NORMAL_MODE_WHITELIST = {
+            R.id.contextmenu_open_in_new_tab, R.id.contextmenu_open_in_other_window,
+            R.id.contextmenu_open_in_incognito_tab, R.id.contextmenu_save_link_as,
+            R.id.contextmenu_open_image_in_new_tab, R.id.contextmenu_search_by_image,
     };
 
     // Additional items for custom tabs mode.
-    private static final int[] CUSTOM_TAB_MODE_WHITELIST = {
+    private static final Integer[] CUSTOM_TAB_MODE_WHITELIST = {
             R.id.contextmenu_open_image, R.id.contextmenu_search_by_image,
             R.id.contextmenu_open_in_new_chrome_tab, R.id.contextmenu_open_in_chrome_incognito_tab,
             R.id.contextmenu_open_in_browser_id,
     };
 
     // Additional items for fullscreen tabs mode.
-    private static final int[] FULLSCREEN_TAB_MODE_WHITELIST = {
-            R.id.menu_id_open_in_chrome
-    };
+    private static final Integer[] FULLSCREEN_TAB_MODE_WHITELIST = {R.id.menu_id_open_in_chrome};
 
     private final ContextMenuItemDelegate mDelegate;
     private MenuInflater mMenuInflater;
     private final int mMode;
 
     static class ContextMenuUma {
         // Note: these values must match the ContextMenuOption enum in histograms.xml.
         static final int ACTION_OPEN_IN_NEW_TAB = 0;
         static final int ACTION_OPEN_IN_INCOGNITO_TAB = 1;
         static final int ACTION_COPY_LINK_ADDRESS = 2;
@@ skipping 101 matching lines @@
             setHeaderText(context, menu, params.getTitleText());
         }
 
         if (mMenuInflater == null) mMenuInflater = new MenuInflater(context);
 
         mMenuInflater.inflate(R.menu.chrome_context_menu, menu);
 
         menu.setGroupVisible(R.id.contextmenu_group_anchor, params.isAnchor());
         menu.setGroupVisible(R.id.contextmenu_group_image, params.isImage());
         menu.setGroupVisible(R.id.contextmenu_group_video, params.isVideo());
+        menu.setGroupVisible(R.id.contextmenu_group_message,
+                MailTo.isMailTo(params.getLinkUrl())
+                        || UrlUtilities.isTelScheme(params.getLinkUrl()));
 
+        Set<Integer> supportedOptions = new HashSet<>();
+        Collections.addAll(supportedOptions, BASE_WHITELIST);
+        if (mMode == FULLSCREEN_TAB_MODE) {
+            Collections.addAll(supportedOptions, FULLSCREEN_TAB_MODE_WHITELIST);
+        } else if (mMode == CUSTOM_TAB_MODE) {
+            Collections.addAll(supportedOptions, CUSTOM_TAB_MODE_WHITELIST);
+            if (!ChromePreferenceManager.getInstance().getCachedChromeDefaultBrowser()) {
+                menu.findItem(R.id.contextmenu_open_in_browser_id)
+                        .setTitle(mDelegate.getTitleForOpenTabInExternalApp());
+            }
+        } else {
+            Collections.addAll(supportedOptions, NORMAL_MODE_WHITELIST);
+        }
+
+        trimInvisibleItems(supportedOptions, menu);
+        Set<Integer> disabledOptions = getDisabledOptions(params);
+
+        // Iterate through the entire menu list, if if doesn't exist in the map, don't show it.
+        for (int i = 0; i < menu.size(); i++) {
+            MenuItem item = menu.getItem(i);
+            item.setVisible(supportedOptions.contains(item.getItemId())
+                    && !disabledOptions.contains(item.getItemId()));
+        }
+
+        // Special case for searching by image element.
+        if (supportedOptions.contains(R.id.contextmenu_search_by_image)) {
+            menu.findItem(R.id.contextmenu_search_by_image)
+                    .setTitle(context.getString(R.string.contextmenu_search_web_for_image,
+                            TemplateUrlService.getInstance()
+                                    .getDefaultSearchEngineTemplateUrl()
+                                    .getShortName()));
+        }
+    }
+
+    /**
+     * Removes items from the list of supported items if they are not visible in the context menu.
+     */
+    private void trimInvisibleItems(Set<Integer> supportedItems, ContextMenu menu) {
+        for (Iterator<Integer> itemsIterator = supportedItems.iterator();
+                itemsIterator.hasNext();) {
+            Integer itemId = itemsIterator.next();
+            if (!menu.findItem(itemId).isVisible()) {
+                itemsIterator.remove();
+            }
+        }
+    }
+
+    /**
+     * Given a set of params and context, and a list of all the items. This method never adds items,
+     * only removes or edits them from the
+     * list.
+     * @param params The parameters used to create a list of items that should not be allowed.
+     */
+    private Set<Integer> getDisabledOptions(ContextMenuParams params) {
+        Set<Integer> disabledOptions = new HashSet<>();
         if (params.isAnchor() && !mDelegate.isOpenInOtherWindowSupported()) {
-            menu.findItem(R.id.contextmenu_open_in_other_window).setVisible(false);
+            disabledOptions.add(R.id.contextmenu_open_in_other_window);
         }
 
         if (mDelegate.isIncognito() || !mDelegate.isIncognitoSupported()) {
-            menu.findItem(R.id.contextmenu_open_in_incognito_tab).setVisible(false);
+            disabledOptions.add(R.id.contextmenu_open_in_incognito_tab);
         }
 
         if (params.getLinkText().trim().isEmpty() || params.isImage()) {
-            menu.findItem(R.id.contextmenu_copy_link_text).setVisible(false);
+            disabledOptions.add(R.id.contextmenu_copy_link_text);
         }
 
         if (params.isAnchor() && !UrlUtilities.isAcceptedScheme(params.getLinkUrl())) {
-            menu.findItem(R.id.contextmenu_open_in_other_window).setVisible(false);
-            menu.findItem(R.id.contextmenu_open_in_new_tab).setVisible(false);
-            menu.findItem(R.id.contextmenu_open_in_incognito_tab).setVisible(false);
+            disabledOptions.add(R.id.contextmenu_open_in_other_window);
+            disabledOptions.add(R.id.contextmenu_open_in_new_tab);
+            disabledOptions.add(R.id.contextmenu_open_in_incognito_tab);
         }
 
         if (MailTo.isMailTo(params.getLinkUrl())) {
-            menu.findItem(R.id.contextmenu_copy_link_text).setVisible(false);
-            menu.findItem(R.id.contextmenu_copy_link_address).setVisible(false);
-            menu.setGroupVisible(R.id.contextmenu_group_message, true);
+            disabledOptions.add(R.id.contextmenu_copy_link_text);
+            disabledOptions.add(R.id.contextmenu_copy_link_address);
             if (!mDelegate.supportsSendEmailMessage()) {
-                menu.findItem(R.id.contextmenu_send_message).setVisible(false);
+                disabledOptions.add(R.id.contextmenu_send_message);
             }
             if (TextUtils.isEmpty(MailTo.parse(params.getLinkUrl()).getTo())
                     || !mDelegate.supportsAddToContacts()) {
-                menu.findItem(R.id.contextmenu_add_to_contacts).setVisible(false);
+                disabledOptions.add(R.id.contextmenu_add_to_contacts);
             }
-            menu.findItem(R.id.contextmenu_call).setVisible(false);
+            disabledOptions.add(R.id.contextmenu_call);
         } else if (UrlUtilities.isTelScheme(params.getLinkUrl())) {
-            menu.findItem(R.id.contextmenu_copy_link_text).setVisible(false);
-            menu.findItem(R.id.contextmenu_copy_link_address).setVisible(false);
-            menu.setGroupVisible(R.id.contextmenu_group_message, true);
+            disabledOptions.add(R.id.contextmenu_copy_link_text);
+            disabledOptions.add(R.id.contextmenu_copy_link_address);
             if (!mDelegate.supportsCall()) {
-                menu.findItem(R.id.contextmenu_call).setVisible(false);
+                disabledOptions.add(R.id.contextmenu_call);
             }
             if (!mDelegate.supportsSendTextMessage()) {
-                menu.findItem(R.id.contextmenu_send_message).setVisible(false);
+                disabledOptions.add(R.id.contextmenu_send_message);
             }
             if (!mDelegate.supportsAddToContacts()) {
-                menu.findItem(R.id.contextmenu_add_to_contacts).setVisible(false);
+                disabledOptions.add(R.id.contextmenu_add_to_contacts);
             }
-        } else {
-            menu.setGroupVisible(R.id.contextmenu_group_message, false);
         }
 
-        menu.findItem(R.id.contextmenu_save_link_as).setVisible(
-                UrlUtilities.isDownloadableScheme(params.getLinkUrl()));
+        if (!UrlUtilities.isDownloadableScheme(params.getLinkUrl())) {
+            disabledOptions.add(R.id.contextmenu_save_link_as);
+        }
 
+        boolean isSrcDownloadableScheme = UrlUtilities.isDownloadableScheme(params.getSrcUrl());
         if (params.isVideo()) {
-            menu.findItem(R.id.contextmenu_save_video).setVisible(
-                    params.canSaveMedia() && UrlUtilities.isDownloadableScheme(params.getSrcUrl()));
+            boolean saveableAndDownloadable = params.canSaveMedia() && isSrcDownloadableScheme;
+            if (!saveableAndDownloadable) {
+                disabledOptions.add(R.id.contextmenu_save_video);
+            }
         } else if (params.isImage() && params.imageWasFetchedLoFi()) {
             DataReductionProxyUma.previewsLoFiContextMenuAction(
                     DataReductionProxyUma.ACTION_LOFI_LOAD_IMAGE_CONTEXT_MENU_SHOWN);
             // All image context menu items other than "Load image," "Open original image in
             // new tab," and "Copy image URL" should be disabled on Lo-Fi images.
-            menu.findItem(R.id.contextmenu_save_image).setVisible(false);
-            menu.findItem(R.id.contextmenu_open_image).setVisible(false);
-            menu.findItem(R.id.contextmenu_search_by_image).setVisible(false);
-            menu.findItem(R.id.contextmenu_share_image).setVisible(false);
+            disabledOptions.add(R.id.contextmenu_save_image);
+            disabledOptions.add(R.id.contextmenu_open_image);
+            disabledOptions.add(R.id.contextmenu_search_by_image);
+            disabledOptions.add(R.id.contextmenu_share_image);
         } else if (params.isImage() && !params.imageWasFetchedLoFi()) {
-            menu.findItem(R.id.contextmenu_load_original_image).setVisible(false);
+            disabledOptions.add(R.id.contextmenu_load_original_image);
 
-            menu.findItem(R.id.contextmenu_save_image).setVisible(
-                    UrlUtilities.isDownloadableScheme(params.getSrcUrl()));
+            if (!isSrcDownloadableScheme) {
+                disabledOptions.add(R.id.contextmenu_save_image);
+            }
 
             // Avoid showing open image option for same image which is already opened.
             if (mDelegate.getPageUrl().equals(params.getSrcUrl())) {
-                menu.findItem(R.id.contextmenu_open_image).setVisible(false);
+                disabledOptions.add(R.id.contextmenu_open_image);
             }
             final TemplateUrlService templateUrlServiceInstance = TemplateUrlService.getInstance();
-            final boolean isSearchByImageAvailable =
-                    UrlUtilities.isDownloadableScheme(params.getSrcUrl())
-                            && templateUrlServiceInstance.isLoaded()
-                            && templateUrlServiceInstance.isSearchByImageAvailable()
-                            && templateUrlServiceInstance.getDefaultSearchEngineTemplateUrl()
-                                    != null;
+            final boolean isSearchByImageAvailable = isSrcDownloadableScheme
+                    && templateUrlServiceInstance.isLoaded()
+                    && templateUrlServiceInstance.isSearchByImageAvailable()
+                    && templateUrlServiceInstance.getDefaultSearchEngineTemplateUrl() != null;
 
-            menu.findItem(R.id.contextmenu_search_by_image).setVisible(isSearchByImageAvailable);
-            if (isSearchByImageAvailable) {
-                menu.findItem(R.id.contextmenu_search_by_image).setTitle(
-                        context.getString(R.string.contextmenu_search_web_for_image,
-                                TemplateUrlService.getInstance()
-                                        .getDefaultSearchEngineTemplateUrl().getShortName()));
+            if (!isSearchByImageAvailable) {
+                disabledOptions.add(R.id.contextmenu_search_by_image);
             }
         }
 
         // Hide all items that could spawn additional tabs until FRE has been completed.
         if (!FirstRunStatus.getFirstRunFlowComplete()) {
-            menu.findItem(R.id.contextmenu_open_image_in_new_tab).setVisible(false);
-            menu.findItem(R.id.contextmenu_open_in_other_window).setVisible(false);
-            menu.findItem(R.id.contextmenu_open_in_new_tab).setVisible(false);
-            menu.findItem(R.id.contextmenu_open_in_incognito_tab).setVisible(false);
-            menu.findItem(R.id.contextmenu_search_by_image).setVisible(false);
-            menu.findItem(R.id.menu_id_open_in_chrome).setVisible(false);
+            disabledOptions.add(R.id.contextmenu_open_image_in_new_tab);
+            disabledOptions.add(R.id.contextmenu_open_in_other_window);
+            disabledOptions.add(R.id.contextmenu_open_in_new_tab);
+            disabledOptions.add(R.id.contextmenu_open_in_incognito_tab);
+            disabledOptions.add(R.id.contextmenu_search_by_image);
+            disabledOptions.add(R.id.menu_id_open_in_chrome);
         }
 
-        if (mMode == FULLSCREEN_TAB_MODE) {
-            removeUnsupportedItems(menu, FULLSCREEN_TAB_MODE_WHITELIST);
-        } else if (mMode == CUSTOM_TAB_MODE) {
-            removeUnsupportedItems(menu, CUSTOM_TAB_MODE_WHITELIST);
-            MenuItem defaultOpenMenuItem = menu.findItem(R.id.contextmenu_open_in_browser_id);
+        if (mMode == CUSTOM_TAB_MODE) {
             if (ChromePreferenceManager.getInstance().getCachedChromeDefaultBrowser()) {
-                defaultOpenMenuItem.setVisible(false);
+                disabledOptions.add(R.id.contextmenu_open_in_browser_id);
             } else {
-                menu.findItem(R.id.contextmenu_open_in_new_chrome_tab).setVisible(false);
-                menu.findItem(R.id.contextmenu_open_in_chrome_incognito_tab).setVisible(false);
-                defaultOpenMenuItem.setTitle(mDelegate.getTitleForOpenTabInExternalApp());
+                disabledOptions.add(R.id.contextmenu_open_in_new_chrome_tab);
+                disabledOptions.add(R.id.contextmenu_open_in_chrome_incognito_tab);
             }
-        } else {
-            removeUnsupportedItems(menu, NORMAL_MODE_WHITELIST);
         }
+
+        return disabledOptions;
     }
 
-    private void removeUnsupportedItems(ContextMenu menu, int[] whitelist) {
+    private void removeUnsupportedItems(Set<Integer> itemList, int[] whitelist) {
         Arrays.sort(BASE_WHITELIST);
         Arrays.sort(whitelist);
-        for (int i = 0; i < menu.size(); i++) {
-            MenuItem item = menu.getItem(i);
-            if (Arrays.binarySearch(whitelist, item.getItemId()) < 0
-                    && Arrays.binarySearch(BASE_WHITELIST, item.getItemId()) < 0) {
-                menu.removeItem(item.getItemId());
-                i--;
+        for (Iterator<Integer> idIterator = itemList.iterator(); idIterator.hasNext();) {
+            int itemId = idIterator.next();
+            if (Arrays.binarySearch(whitelist, itemId) < 0
+                    && Arrays.binarySearch(BASE_WHITELIST, itemId) < 0) {
+                idIterator.remove();
             }
         }
     }
 
     @Override
     public boolean onItemSelected(ContextMenuHelper helper, ContextMenuParams params, int itemId) {
         if (itemId == R.id.contextmenu_open_in_other_window) {
             ContextMenuUma.record(params, ContextMenuUma.ACTION_OPEN_IN_OTHER_WINDOW);
             mDelegate.onOpenInOtherWindow(params.getLinkUrl(), params.getReferrer());
         } else if (itemId == R.id.contextmenu_open_in_new_tab) {
@@ skipping 86 matching lines @@
         }
 
         return true;
     }
 
     private void setHeaderText(Context context, ContextMenu menu, String text) {
         ContextMenuTitleView title = new ContextMenuTitleView(context, text);
         menu.setHeaderView(title);
     }
 }