[Contextual Search] Trigger the translation one-box.

chrome/android/java/src/org/chromium/chrome/browser/contextualsearch/ContextualSearchRequest.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.net.Uri;
+import android.text.TextUtils;
 
+import org.chromium.base.VisibleForTesting;
 import org.chromium.chrome.browser.search_engines.TemplateUrlService;
 
 import java.net.MalformedURLException;
 import java.net.URL;
+import java.util.Locale;
 
 import javax.annotation.Nullable;
 
 
 /**
  * Bundles a Search Request URL with a low-priority version of the URL, helps manage the
  * fall-back when the low-priority version fails, and tracks which one is in use.
  */
 class ContextualSearchRequest {
-
-    private final Uri mLowPriorityUri;
-    private final Uri mNormalPriorityUri;
     private final boolean mWasPrefetch;
+    private Uri mLowPriorityUri;
+    private Uri mNormalPriorityUri;
 
     private boolean mIsLowPriority;
     private boolean mHasFailedLowPriorityLoad;
 
+    private static final String GWS_LOW_PRIORITY_SEARCH_PATH = "s";
+    private static final String GWS_SEARCH_NO_SUGGESTIONS_PARAM = "sns";
+    private static final String GWS_SEARCH_NO_SUGGESTIONS_PARAM_VALUE = "1";
+    private static final String GWS_QUERY_PARAM = "q";
     private static final String CTXS_PARAM_PATTERN = "(ctxs=[^&]+)";
     private static final String CTXR_PARAM = "ctxr";
+    @VisibleForTesting static final String TLITE_SOURCE_LANGUAGE_PARAM = "tlitesl";
+    private static final String TLITE_TARGET_LANGUAGE_PARAM = "tlitetl";
+    private static final String TLITE_QUERY_PARAM = "tlitetxt";
 
     /**
      * Creates a search request for the given search term without any alternate term and
      * for normal-priority loading capability only.
      * @param searchTerm The resolved search term.
      */
     ContextualSearchRequest(String searchTerm) {
         this(searchTerm, null, false);
     }
 
     /**
      * Creates a search request for the given search term with the given alternate term and
      * low-priority loading capability.
      * @param searchTerm The resolved search term.
      * @param alternateTerm The alternate search term.
      * @param isLowPriorityEnabled Whether the request can be made at a low priority.
      */
     ContextualSearchRequest(String searchTerm, @Nullable String alternateTerm,
             boolean isLowPriorityEnabled) {
         mWasPrefetch = isLowPriorityEnabled;
         mNormalPriorityUri = getUriTemplate(searchTerm, alternateTerm, false);
         if (isLowPriorityEnabled) {
             // TODO(donnd): Call TemplateURL once we have an API for 3rd-party providers.
             Uri baseLowPriorityUri = getUriTemplate(searchTerm, alternateTerm, true);
-            mLowPriorityUri = baseLowPriorityUri.buildUpon()
-                .path("s")
-                .appendQueryParameter("sns", "1")
-                .build();
+            mLowPriorityUri = makeLowPriorityUri(baseLowPriorityUri);
             mIsLowPriority = true;
         } else {
             mIsLowPriority = false;
             mLowPriorityUri = null;
         }
     }
 
     /**
      * Sets an indicator that the normal-priority URL should be used for this search request.
      */
@@ skipping 63 matching lines @@
         try {
             url = new URL(searchUrl.replaceAll(CTXS_PARAM_PATTERN, CTXR_PARAM));
         } catch (MalformedURLException e) {
             url = null;
         }
 
         return url != null ? url.toString() : null;
     }
 
     /**
+     * Adds translation parameters.
+     * @param sourceLanguage The language of the original search term.
+     * @param targetLanguage The language the that the user prefers.
+     */
+    void forceTranslation(String sourceLanguage, String targetLanguage) {
+        if (mLowPriorityUri != null) {
+            mLowPriorityUri = makeTranslateUri(mLowPriorityUri, sourceLanguage, targetLanguage);
+        }
+        mNormalPriorityUri = makeTranslateUri(mNormalPriorityUri, sourceLanguage, targetLanguage);
+    }
+

[pedro (no code reviews), 2015/10/23 08:50:36]

There should be a public boolean isTranlationForced() method that tests can use
to assert it is in translation mode. See comment in the
ContextualSearchManagerTest.

[Donn Denman, 2015/10/28 22:17:15]

Done.

+    /**
      * Uses TemplateUrlService to generate the url for the given query
      * {@link String} for {@code query} with the contextual search version param set.
      * @param query The search term to use as the main query in the returned search url.
      * @param alternateTerm The alternate search term to use as an alternate suggestion.
      * @param shouldPrefetch Whether the returned url should include a prefetch parameter.
-     * @return      A {@link String} that contains the url of the default search engine with
-     *              {@code query} and {@code alternateTerm} inserted as parameters and contextual
-     *              search and prefetch parameters conditionally set.
+     * @return A {@link Uri} that contains the url of the default search engine with
+     *         {@code query} and {@code alternateTerm} inserted as parameters and contextual
+     *         search and prefetch parameters conditionally set.
      */
     private Uri getUriTemplate(String query, @Nullable String alternateTerm,
             boolean shouldPrefetch) {
         return Uri.parse(TemplateUrlService.getInstance().getUrlForContextualSearchQuery(
                 query, alternateTerm, shouldPrefetch));
     }
+
+    /**
+     * @return a low-priority {@code Uri} from the given base {@code Uri}.
+     */
+    private Uri makeLowPriorityUri(Uri baseUri) {
+        return baseUri.buildUpon()
+                .path(GWS_LOW_PRIORITY_SEARCH_PATH)
+                .appendQueryParameter(
+                        GWS_SEARCH_NO_SUGGESTIONS_PARAM, GWS_SEARCH_NO_SUGGESTIONS_PARAM_VALUE)
+                .build();
+    }
+
+    /**
+     * Makes the given {@code Uri} into a similar Uri that triggers a Translate one-box.
+     * @param baseUri The base Uri to build off of.
+     * @param sourceLanguage The language of the original search term.
+     * @param targetLanguage The language the that the user prefers.
+     * @return A {@link Uri} that has additional parameters for Translate appropriately set.
+     */
+    private Uri makeTranslateUri(Uri baseUri, String sourceLanguage, String targetLanguage) {
+        // TODO(donnd): update to work for non-English.  See also getTranslateQuery.
+        if (!TextUtils.equals(targetLanguage, Locale.ENGLISH.getLanguage())) return baseUri;
+        Uri resultUri = baseUri;
+        if (!sourceLanguage.isEmpty() || !targetLanguage.isEmpty()) {
+            // We must replace the q= param, and there seems to be no good way other than clearing
+            // all the query params and adding them all back in, changing q=.
+            Uri.Builder builder = baseUri.buildUpon().clearQuery();
+            String query = null;
+            for (String param : baseUri.getQueryParameterNames()) {
+                String value = baseUri.getQueryParameter(param);
+                if (TextUtils.equals(param, GWS_QUERY_PARAM)) {
+                    query = value;
+                    value = getTranslateQuery();
+                }
+                builder.appendQueryParameter(param, value);
+            }
+            if (!sourceLanguage.isEmpty()) {
+                builder.appendQueryParameter(TLITE_SOURCE_LANGUAGE_PARAM, sourceLanguage);
+            }
+            if (!targetLanguage.isEmpty()) {
+                builder.appendQueryParameter(TLITE_TARGET_LANGUAGE_PARAM, targetLanguage);
+            }
+            builder.appendQueryParameter(TLITE_QUERY_PARAM, query);
+            resultUri = builder.build();
+        }
+        return resultUri;
+    }
+
+    /**
+     * TODO(donnd): This translate API is evolving.  Update this code!
+     * TODO(donnd): As of Oct '15 this will only work on production GWS to translate into English.
+     */
+    private String getTranslateQuery() {
+        return "Translate";
+    }
 }