[Contextual Search] Trigger the translation one-box.

chrome/android/java/src/org/chromium/chrome/browser/contextualsearch/ContextualSearchManager.java

 // Copyright 2015 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.contextualsearch;
 
 import android.app.Activity;
+import android.content.Context;
 import android.view.View;
 import android.view.ViewGroup;
 import android.view.ViewTreeObserver;
 import android.view.ViewTreeObserver.OnGlobalFocusChangeListener;
 
 import org.chromium.base.ActivityState;
 import org.chromium.base.ApplicationStatus;
 import org.chromium.base.ApplicationStatus.ActivityStateListener;
 import org.chromium.base.SysUtils;
 import org.chromium.base.VisibleForTesting;
@@ skipping 23 matching lines @@
 import org.chromium.chrome.browser.widget.findinpage.FindToolbarManager;
 import org.chromium.chrome.browser.widget.findinpage.FindToolbarObserver;
 import org.chromium.components.navigation_interception.NavigationParams;
 import org.chromium.content.browser.ContentViewCore;
 import org.chromium.content.browser.ContextualSearchClient;
 import org.chromium.content_public.browser.GestureStateListener;
 import org.chromium.content_public.browser.LoadUrlParams;
 import org.chromium.content_public.browser.NavigationEntry;
 import org.chromium.content_public.browser.WebContentsObserver;
 import org.chromium.content_public.common.TopControlsState;
+import org.chromium.ui.UiUtils;
 import org.chromium.ui.base.WindowAndroid;
 
 import java.net.MalformedURLException;
 import java.net.URL;
+import java.util.ArrayList;
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Locale;
+import java.util.Set;
 
 import javax.annotation.Nullable;
 
 
 /**
  * Manager for the Contextual Search feature.
  * This class keeps track of the status of Contextual Search and coordinates the control
  * with the layout.
  */
 public class ContextualSearchManager extends ContextualSearchObservable
@@ skipping 42 matching lines @@
 
     /**
      * This boolean is used for loading content after a long-press when content is not immediately
      * loaded.
      */
     private boolean mShouldLoadDelayedSearch;
 
     private boolean mIsShowingPromo;
     private boolean mDidLogPromoOutcome;
 
+    // Cached target languages for translation;
+    private List<String> mTargetLanguages;
+
     /**
      * Whether contextual search manager is currently promoting a tab. We should be ignoring hide
      * requests when mIsPromotingTab is set to true.
      */
     private boolean mIsPromotingToTab;
 
     private ContextualSearchNetworkCommunicator mNetworkCommunicator;
     private ContextualSearchPanel mSearchPanel;
 
     // TODO(pedrosimonetti): also store selected text, surroundings, url, bounding rect of selected
@@ skipping 156 matching lines @@
 
     /**
      * @return The {@link ContextualSearchPanel}, for testing purposes only.
      */
     @VisibleForTesting
     public ContextualSearchPanel getContextualSearchPanel() {
         return mSearchPanel;
     }
 
     /**
-     * Sets the selection controller for testing purposes.
+     * @return The selection controller, for testing purposes.
      */
     @VisibleForTesting
     ContextualSearchSelectionController getSelectionController() {
         return mSelectionController;
     }
 
+    /**
+     * @return The current search request, or {@code null} if there is none, for testing.
+     */
+    @VisibleForTesting
+    ContextualSearchRequest getRequest() {
+        return mSearchRequest;
+    }
+
     @VisibleForTesting
     boolean isSearchPanelShowing() {
         return mSearchPanel.isShowing();
     }
 
     /**
      * @return Whether the Search Panel is opened. That is, whether it is EXPANDED or MAXIMIZED.
      */
     public boolean isSearchPanelOpened() {
         PanelState state = mSearchPanel.getPanelState();
@@ skipping 159 matching lines @@
         if (isTap) {
             // If the user action was not a long-press, immediately start loading content.
             mShouldLoadDelayedSearch = false;
         }
 
         if (isTap && mPolicy.shouldPreviousTapResolve(
                 mNetworkCommunicator.getBasePageUrl())) {
             mNetworkCommunicator.startSearchTermResolutionRequest(
                     mSelectionController.getSelectedText());
             didRequestSurroundings = true;
+            // Cache the target languages in case they are needed for translation.
+            if (mPolicy.isTranslationEnabled()) getTargetLanguages();
         } else {
             boolean shouldPrefetch = mPolicy.shouldPrefetchSearchResult(isTap);
             mSearchRequest = new ContextualSearchRequest(mSelectionController.getSelectedText(),
                     null, shouldPrefetch);
+            // TODO(donnd): figure out a way to do translation on long-press selections.
             mDidStartLoadingResolvedSearchRequest = false;
             mSearchPanel.displaySearchTerm(mSelectionController.getSelectedText());
             if (shouldPrefetch) loadSearchUrl();
         }
 
         if (!didRequestSurroundings) {
             // Gather surrounding text for Icing integration, which will make the selection and
             // a shorter version of the surroundings available for Conversational Search.
             // Although the surroundings are extracted, they will not be sent to the server as
             // part of search term resolution, just sent to Icing which keeps them local until
@@ skipping 175 matching lines @@
      *        parameters should be ignored.
      * @param responseCode The HTTP response code.  If the code is not OK, the query
      *        should be ignored.
      * @param searchTerm The term to use in our subsequent search.
      * @param displayText The text to display in our UX.
      * @param alternateTerm The alternate term to display on the results page.
      * @param selectionStartAdjust A positive number of characters that the start of the existing
      *        selection should be expanded by.
      * @param selectionEndAdjust A positive number of characters that the end of the existing
      *        selection should be expanded by.
+     * @param contextLanguage The language of the original search term, or an empty string.
      */
     @CalledByNative
     public void onSearchTermResolutionResponse(boolean isNetworkUnavailable, int responseCode,
             final String searchTerm, final String displayText, final String alternateTerm,
-            boolean doPreventPreload, int selectionStartAdjust, int selectionEndAdjust) {
+            boolean doPreventPreload, int selectionStartAdjust, int selectionEndAdjust,
+            final String contextLanguage) {
         mNetworkCommunicator.handleSearchTermResolutionResponse(isNetworkUnavailable, responseCode,
                 searchTerm, displayText, alternateTerm, doPreventPreload, selectionStartAdjust,
-                selectionEndAdjust);
+                selectionEndAdjust, contextLanguage);
     }
 
     @Override
     public void handleSearchTermResolutionResponse(boolean isNetworkUnavailable, int responseCode,
             String searchTerm, String displayText, String alternateTerm, boolean doPreventPreload,
-            int selectionStartAdjust, int selectionEndAdjust) {
+            int selectionStartAdjust, int selectionEndAdjust, String contextLanguage) {
         if (!mSearchPanel.isShowing()) return;
 
         // Show an appropriate message for what to search for.
         String message;
         boolean doLiteralSearch = false;
         if (isNetworkUnavailable) {
             message = mActivity.getResources().getString(
                     R.string.contextual_search_network_unavailable);
         } else if (!isHttpFailureCode(responseCode)) {
             message = displayText;
@@ skipping 12 matching lines @@
         if (doLiteralSearch) {
             searchTerm = mSelectionController.getSelectedText();
             alternateTerm = null;
             doPreventPreload = true;
         }
         if (!searchTerm.isEmpty()) {
             // TODO(donnd): Instead of preloading, we should prefetch (ie the URL should not
             // appear in the user's history until the user views it).  See crbug.com/406446.
             boolean shouldPreload = !doPreventPreload && mPolicy.shouldPrefetchSearchResult(true);
             mSearchRequest = new ContextualSearchRequest(searchTerm, alternateTerm, shouldPreload);
+            // Trigger translation, if enabled.
+            if (!contextLanguage.isEmpty() && mPolicy.isTranslationEnabled()) {
+                List<String> targetLanguages = getTargetLanguages();
+                if (mPolicy.needsTranslation(contextLanguage, targetLanguages)) {
+                    mSearchRequest.forceTranslation(
+                            contextLanguage, mPolicy.bestTargetLanguage(targetLanguages));
+                }
+            }
             mDidStartLoadingResolvedSearchRequest = false;
             if (mSearchPanel.isContentShowing()) {
                 mSearchRequest.setNormalPriority();
             }
             if (mSearchPanel.isContentShowing() || shouldPreload) {
                 loadSearchUrl();
             }
             mPolicy.logSearchTermResolutionDetails(searchTerm,
                     mNetworkCommunicator.getBasePageUrl());
         }
@@ skipping 28 matching lines @@
      * @return Whether a Tap gesture is currently supported.
      */
     private boolean isTapSupported() {
         // Base page just started navigating away, so taps should be ignored.
         if (mDidBasePageLoadJustStart) return false;
 
         return mPolicy.isTapSupported();
     }
 
     // ============================================================================================
+    // Translation support
+    // ============================================================================================
+
+    /**
+     * Gets the list of target languages for the current user, with the first
+     * item in the list being the user's primary language.
+     * @return The {@link List} of languages the user understands with their primary language first.
+     */
+    private List<String> getTargetLanguages() {
+        // May be cached.
+        if (mTargetLanguages != null) return mTargetLanguages;
+
+        // Using LinkedHashSet keeps the entries both unique and ordered.
+        Set<String> uniqueLanguages = new LinkedHashSet<String>();
+
+        // The primary language always comes first.
+        uniqueLanguages.add(
+                trimLocaleToLanguage(nativeGetTargetLanguage(mNativeContextualSearchManagerPtr)));
+
+        // Next add languages the user knows how to type.
+        Context context = mActivity.getApplicationContext();
+        List<String> locales = context != null
+                ? new ArrayList<String>(UiUtils.getIMELocales(context))
+                : new ArrayList<String>();
+        for (int i = 0; i < locales.size(); i++) {
+            uniqueLanguages.add(trimLocaleToLanguage(locales.get(i)));
+        }
+
+        // Add the accept languages last, since they are a weaker hint than presence of a keyboard.
+        List<String> acceptLanguages = getAcceptLanguages();
+        for (int i = 0; i < acceptLanguages.size(); i++) {
+            uniqueLanguages.add(trimLocaleToLanguage(acceptLanguages.get(i)));
+        }
+        mTargetLanguages = new ArrayList<String>(uniqueLanguages);
+        return mTargetLanguages;
+    }
+
+    /**
+     * Gets the list of accept languages for this user.
+     * @return The {@link List} of languages the user understands or does not want translated.
+     */
+    private List<String> getAcceptLanguages() {
+        String acceptLanguages = nativeGetAcceptLanguages(mNativeContextualSearchManagerPtr);
+        List<String> result = new ArrayList<String>();
+        for (String language : acceptLanguages.split(",")) {
+            result.add(language);
+        }
+        return result;
+    }
+
+    /**
+     * @return The given locale as a language code.
+     */
+    private String trimLocaleToLanguage(String locale) {
+        // TODO(donnd): use getScript or getLanguageTag (both API 21), or some other standard way to
+        // strip the country, instead of hard-coding the two character language code.
+        // TODO(donnd): Shouldn't getLanguage() do this?
+        String trimmedLocale = locale.substring(0, 2);
+        return new Locale(trimmedLocale).getLanguage();
+    }
+
+    // ============================================================================================
     // OverlayContentDelegate
     // ============================================================================================
 
     @Override
     public OverlayContentDelegate getOverlayContentDelegate() {
         return new SearchOverlayContentDelegate();
     }
 
     /**
      * Implementation of OverlayContentDelegate. Made public for testing purposes.
@@ skipping 405 matching lines @@
     // --------------------------------------------------------------------------------------------
 
     private native long nativeInit();
     private native void nativeDestroy(long nativeContextualSearchManager);
     private native void nativeStartSearchTermResolutionRequest(long nativeContextualSearchManager,
             String selection, boolean useResolvedSearchTerm, ContentViewCore baseContentViewCore,
             boolean maySendBasePageUrl);
     private native void nativeGatherSurroundingText(long nativeContextualSearchManager,
             String selection, boolean useResolvedSearchTerm, ContentViewCore baseContentViewCore,
             boolean maySendBasePageUrl);
+    private native String nativeGetTargetLanguage(long nativeContextualSearchManager);
+    private native String nativeGetAcceptLanguages(long nativeContextualSearchManager);
 }