The UI part of search-by-image search.

chrome/browser/tab_contents/render_view_context_menu.cc

 // 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.
 
 #include "chrome/browser/tab_contents/render_view_context_menu.h"
 
 #include <algorithm>
 #include <set>
 #include <utility>
 
 #include "apps/app_load_service.h"
 #include "base/command_line.h"
 #include "base/logging.h"
 #include "base/metrics/histogram.h"
 #include "base/prefs/pref_member.h"
 #include "base/prefs/pref_service.h"
 #include "base/stl_util.h"
 #include "base/strings/string_util.h"
+#include "base/strings/stringprintf.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/time/time.h"
 #include "chrome/app/chrome_command_ids.h"
 #include "chrome/browser/app_mode/app_mode_utils.h"
 #include "chrome/browser/autocomplete/autocomplete_classifier.h"
 #include "chrome/browser/autocomplete/autocomplete_classifier_factory.h"
 #include "chrome/browser/autocomplete/autocomplete_match.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/chrome_notification_types.h"
 #include "chrome/browser/custom_handlers/protocol_handler_registry_factory.h"
 #include "chrome/browser/devtools/devtools_window.h"
 #include "chrome/browser/download/download_service.h"
 #include "chrome/browser/download/download_service_factory.h"
 #include "chrome/browser/download/download_util.h"
 #include "chrome/browser/extensions/extension_host.h"
 #include "chrome/browser/extensions/extension_service.h"
 #include "chrome/browser/extensions/extension_system.h"
 #include "chrome/browser/google/google_util.h"
 #include "chrome/browser/plugins/chrome_plugin_service_filter.h"
 #include "chrome/browser/prefs/incognito_mode_prefs.h"
 #include "chrome/browser/printing/print_preview_context_menu_observer.h"
 #include "chrome/browser/printing/print_preview_dialog_controller.h"
 #include "chrome/browser/printing/print_view_manager.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/profiles/profile_io_data.h"
 #include "chrome/browser/search/search.h"
+#include "chrome/browser/search_engines/search_terms_data.h"
 #include "chrome/browser/search_engines/template_url.h"
 #include "chrome/browser/search_engines/template_url_service.h"
 #include "chrome/browser/search_engines/template_url_service_factory.h"
 #include "chrome/browser/spellchecker/spellcheck_host_metrics.h"
 #include "chrome/browser/spellchecker/spellcheck_service.h"
 #include "chrome/browser/tab_contents/retargeting_details.h"
 #include "chrome/browser/tab_contents/spellchecker_submenu_observer.h"
 #include "chrome/browser/tab_contents/spelling_menu_observer.h"
 #include "chrome/browser/translate/translate_manager.h"
 #include "chrome/browser/translate/translate_prefs.h"
 #include "chrome/browser/translate/translate_tab_helper.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/browser_commands.h"
 #include "chrome/browser/ui/browser_finder.h"
 #include "chrome/browser/ui/search_engines/search_engine_tab_helper.h"
 #include "chrome/browser/ui/tab_contents/core_tab_helper.h"
 #include "chrome/common/chrome_constants.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/content_restriction.h"
 #include "chrome/common/extensions/extension.h"
 #include "chrome/common/net/url_util.h"
 #include "chrome/common/pref_names.h"
 #include "chrome/common/print_messages.h"
+#include "chrome/common/render_messages.h"
 #include "chrome/common/spellcheck_messages.h"
 #include "chrome/common/url_constants.h"
 #include "content/public/browser/child_process_security_policy.h"
 #include "content/public/browser/download_manager.h"
 #include "content/public/browser/download_save_info.h"
 #include "content/public/browser/download_url_parameters.h"
 #include "content/public/browser/navigation_details.h"
 #include "content/public/browser/navigation_entry.h"
 #include "content/public/browser/notification_service.h"
 #include "content/public/browser/render_process_host.h"
 #include "content/public/browser/render_view_host.h"
 #include "content/public/browser/render_widget_host_view.h"
 #include "content/public/browser/user_metrics.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/common/menu_item.h"
 #include "content/public/common/ssl_status.h"
 #include "content/public/common/url_utils.h"
 #include "extensions/browser/view_type_utils.h"
 #include "grit/generated_resources.h"
 #include "net/base/escape.h"
 #include "third_party/WebKit/public/web/WebContextMenuData.h"
 #include "third_party/WebKit/public/web/WebMediaPlayerAction.h"
 #include "third_party/WebKit/public/web/WebPluginAction.h"
 #include "ui/base/clipboard/clipboard.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/base/text/text_elider.h"
 #include "ui/gfx/favicon_size.h"
+#include "ui/gfx/point.h"
+#include "ui/gfx/size.h"
 
 using WebKit::WebContextMenuData;
 using WebKit::WebMediaPlayerAction;
 using WebKit::WebPluginAction;
 using WebKit::WebString;
 using WebKit::WebURL;
 using content::BrowserContext;
 using content::ChildProcessSecurityPolicy;
 using content::DownloadManager;
 using content::DownloadUrlParameters;
 using content::NavigationController;
 using content::NavigationEntry;
 using content::OpenURLParams;
 using content::RenderViewHost;
 using content::SSLStatus;
 using content::UserMetricsAction;
 using content::WebContents;
 using extensions::Extension;
 using extensions::MenuItem;
 using extensions::MenuManager;
 
 namespace {
 
+const int kImageSearchThumbnailMinSize = 300 * 300;
+const int kImageSearchThumbnailMaxWidth = 600;
+const int kImageSearchThumbnailMaxHeight = 600;

[Kibeom Kim (inactive), 2013/07/31 21:25:54]

Actually, Android Chrome need to access these values from the outside. The call
stack of Android popup goes like:

1. content::WebContentsImpl::ShowContextMenu(...)
content/browser/web_contents/web_contents_impl.cc

2. content::WebContentsImpl::ShowContextMenu(...)
content/browser/web_contents/web_contents_view_android.cc

3. content::WebContentsViewAndroid::ShowContextMenu(...)
chrome/browser/ui/android/tab_contents/chrome_web_contents_view_delegate_android.cc

4.TabAndroidImpl::ShowContextMenu(...)
clank/native/framework/chrome/tab_android_impl.cc //private

5. // Android Shows context menu

6. TabAndroidImpl::SearchByImage(...)
clank/native/framework/chrome/tab_android_impl.cc //private

7. call:  web_contents()->GetRenderViewHost()->Send(new
ChromeViewMsg_RequestThumbnailForContextNode(.....))

+
 // Maps UMA enumeration to IDC. IDC could be changed so we can't use
 // just them and |UMA_HISTOGRAM_CUSTOM_ENUMERATION|.
 // Never change mapping or reuse |enum_id|. Always push back new items.
 // Items that is not used any more by |RenderViewContextMenu.ExecuteCommand|
 // could be deleted, but don't change the rest of |kUmaEnumToControlId|.
 const struct UmaEnumCommandIdPair {
   int enum_id;
   int control_id;
 } kUmaEnumToControlId[] = {
   {  0, IDC_CONTENT_CONTEXT_CUSTOM_FIRST },
@@ skipping 46 matching lines @@
   { 47, IDC_CONTENT_CONTEXT_PROTOCOL_HANDLER_SETTINGS },
   { 48, IDC_CONTENT_CONTEXT_ADDSEARCHENGINE },
   { 49, IDC_CONTENT_CONTEXT_SPEECH_INPUT_FILTER_PROFANITIES },
   { 50, IDC_CONTENT_CONTEXT_SPEECH_INPUT_ABOUT },
   { 51, IDC_SPEECH_INPUT_MENU },
   { 52, IDC_CONTENT_CONTEXT_OPENLINKWITH },
   { 53, IDC_CHECK_SPELLING_WHILE_TYPING },
   { 54, IDC_SPELLCHECK_MENU },
   { 55, IDC_CONTENT_CONTEXT_SPELLING_TOGGLE },
   { 56, IDC_SPELLCHECK_LANGUAGES_FIRST },
+  {57, IDC_CONTENT_CONTEXT_SEARCHIMAGENEWTAB },

[Avi (use Gerrit), 2013/07/31 20:11:05]

Match style; space after {

[Johnny(Jianning) Ding, 2013/07/31 21:38:09]

Done.

   // Add new items here and use |enum_id| from the next line.
-  { 57, 0 },  // Must be the last. Increment |enum_id| when new IDC was added.
+  { 58, 0 },  // Must be the last. Increment |enum_id| when new IDC was added.
 };
 
 // Collapses large ranges of ids before looking for UMA enum.
 int CollapleCommandsForUMA(int id) {
   if (id >= IDC_CONTENT_CONTEXT_CUSTOM_FIRST &&
       id <= IDC_CONTENT_CONTEXT_CUSTOM_LAST) {
     return IDC_CONTENT_CONTEXT_CUSTOM_FIRST;
   }
 
   if (id >= IDC_EXTENSIONS_CONTEXT_CUSTOM_FIRST &&
@@ skipping 640 matching lines @@
 void RenderViewContextMenu::AppendImageItems() {
   menu_model_.AddItemWithStringId(IDC_CONTENT_CONTEXT_SAVEIMAGEAS,
                                   IDS_CONTENT_CONTEXT_SAVEIMAGEAS);
   menu_model_.AddItemWithStringId(IDC_CONTENT_CONTEXT_COPYIMAGELOCATION,
                                   IDS_CONTENT_CONTEXT_COPYIMAGELOCATION);
   menu_model_.AddItemWithStringId(IDC_CONTENT_CONTEXT_COPYIMAGE,
                                   IDS_CONTENT_CONTEXT_COPYIMAGE);
   menu_model_.AddItemWithStringId(IDC_CONTENT_CONTEXT_OPENIMAGENEWTAB,
                                   IDS_CONTENT_CONTEXT_OPENIMAGENEWTAB);
   AppendPrintItem();
+  const TemplateURL* const default_provider =
+      TemplateURLServiceFactory::GetForProfile(profile_)->
+      GetDefaultSearchProvider();
+  if (!default_provider)
+    return;
+  SearchTermsData search_terms;
+  if (!default_provider->image_url().empty() &&
+      default_provider->image_url_ref().IsValidUsingTermsData(search_terms)) {
+    std::string search_provider_name =
+        UTF16ToUTF8(default_provider->short_name());
+    std::string menu_item_name =
+        base::StringPrintf("Search Image By %s", search_provider_name.c_str());

[jingbinw, 2013/07/31 20:04:45]

I would suggest to rename this as

"Search %s for this image"

just to keep consistent with the existing 

"Search Google for 'highlighted text'" function in the context menu.

Also, is there any i18n support for translating such messages?

[Avi (use Gerrit), 2013/07/31 20:11:05]

Um...

Every one of our UI strings is localized and translated. How is this different?

[Kibeom Kim (inactive), 2013/07/31 20:20:53]

note: just like IDS_CONTENT_CONTEXT_SEARCHWEBFOR in generated_resources.grd

[Avi (use Gerrit), 2013/07/31 20:35:53]

Yes. Look for examples (in this very file) with l10n_util::GetStringFUTF16,
where that retrieves a localized string and substitutes in a variable.

[Johnny(Jianning) Ding, 2013/07/31 21:26:36]

The hard-code "Search Image By %s" should be replaced by the translated message,
but I am not familiar with this part. Please guide me how to change this part.

[jingbinw, 2013/07/31 23:31:29]

Can you rewording the message to be "Search %s for this image"?

BTW: In terms of translated message, I think what you did is already correct
given Avi's last comment.

On 2013/07/31 21:26:36, Johnny(Jianning) Ding wrote:

[Peter Kasting, 2013/07/31 23:38:22]

No, it's not correct.  You should never see a .cc file with a string in it that
gets displayed to a user.  All strings should be handled by the l10n framework.

Look at line 952 for an example of how to do this correctly.

[Kibeom Kim (inactive), 2013/08/01 00:14:59]

here:
menu_model_.AddItem(
    IDC_CONTENT_CONTEXT_SEARCHIMAGENEWTAB,
    l10n_util::GetStringFUTF16(IDS_CONTENT_CONTEXT_SEARCHWEBFORIMAGE,
                               default_provider->short_name()));

in generated_resources.grd, near the two IDS_CONTENT_CONTEXT_SEARCHWEBFOR s:

<message name="IDS_CONTENT_CONTEXT_SEARCHWEBFORIMAGE" desc="The name of the
Search the Web for the image in the content area context menu">
  &amp;Search image by <ph name="SEARCH_ENGINE">$1<ex>Google</ex></ph>
</message>

and

<message name="IDS_CONTENT_CONTEXT_SEARCHWEBFORIMAGE" desc="The name of the
Search the Web for the image in the content area context menu">
  &amp;Search Image by <ph name="SEARCH_ENGINE">$1<ex>Google</ex></ph>
</message>

+    menu_model_.AddItem(IDC_CONTENT_CONTEXT_SEARCHIMAGENEWTAB,
+                        UTF8ToUTF16(menu_item_name));
+  }
 }
 
 void RenderViewContextMenu::AppendAudioItems() {
   AppendMediaItems();
   menu_model_.AddSeparator(ui::NORMAL_SEPARATOR);
   menu_model_.AddItemWithStringId(IDC_CONTENT_CONTEXT_SAVEAVAS,
                                   IDS_CONTENT_CONTEXT_SAVEAUDIOAS);
   menu_model_.AddItemWithStringId(IDC_CONTENT_CONTEXT_COPYAVLOCATION,
                                   IDS_CONTENT_CONTEXT_COPYAUDIOLOCATION);
   menu_model_.AddItemWithStringId(IDC_CONTENT_CONTEXT_OPENAVNEWTAB,
@@ skipping 390 matching lines @@
       DCHECK(local_state);
       // Test if file-selection dialogs are forbidden by policy.
       if (!local_state->GetBoolean(prefs::kAllowFileSelectionDialogs))
         return false;
 
       return params_.src_url.is_valid() &&
           ProfileIOData::IsHandledProtocol(params_.src_url.scheme());
     }
 
     case IDC_CONTENT_CONTEXT_OPENIMAGENEWTAB:
+    case IDC_CONTENT_CONTEXT_SEARCHIMAGENEWTAB:
       // The images shown in the most visited thumbnails do not currently open
       // in a new tab as they should. Disabling this context menu option for
       // now, as a quick hack, before we resolve this issue (Issue = 2608).
       // TODO(sidchat): Enable this option once this issue is resolved.
       if (params_.src_url.scheme() == chrome::kChromeUIScheme ||
           !params_.src_url.is_valid())
         return false;
       return true;
 
     case IDC_CONTENT_CONTEXT_COPYIMAGE:
@@ skipping 333 matching lines @@
 
     case IDC_CONTENT_CONTEXT_COPYIMAGELOCATION:
     case IDC_CONTENT_CONTEXT_COPYAVLOCATION:
       WriteURLToClipboard(params_.src_url);
       break;
 
     case IDC_CONTENT_CONTEXT_COPYIMAGE:
       CopyImageAt(params_.x, params_.y);
       break;
 
+    case IDC_CONTENT_CONTEXT_SEARCHIMAGENEWTAB:
+      GetImageThumbnailForSearch(params_.x, params_.y);
+      break;
+
     case IDC_CONTENT_CONTEXT_OPENIMAGENEWTAB:
     case IDC_CONTENT_CONTEXT_OPENAVNEWTAB:
       OpenURL(
           params_.src_url,
           params_.frame_url.is_empty() ? params_.page_url : params_.frame_url,
           params_.frame_id,
           NEW_BACKGROUND_TAB, content::PAGE_TRANSITION_LINK);
       break;
 
     case IDC_CONTENT_CONTEXT_PLAYPAUSE: {
@@ skipping 408 matching lines @@
       chrome::NOTIFICATION_RETARGETING,
       content::Source<Profile>(Profile::FromBrowserContext(
           source_web_contents_->GetBrowserContext())),
       content::Details<RetargetingDetails>(&details));
 }
 
 void RenderViewContextMenu::CopyImageAt(int x, int y) {
   source_web_contents_->GetRenderViewHost()->CopyImageAt(x, y);
 }
 
+void RenderViewContextMenu::GetImageThumbnailForSearch(int x, int y) {

[Kibeom Kim (inactive), 2013/07/31 21:49:49]

How x and y are used?

[Johnny(Jianning) Ding, 2013/07/31 21:53:47]

they are gone.

+  source_web_contents_->GetRenderViewHost()->Send(
+       new ChromeViewMsg_RequestThumbnailForContextNode(
+           source_web_contents_->GetRenderViewHost()->GetRoutingID(),
+           kImageSearchThumbnailMinSize,
+           gfx::Size(kImageSearchThumbnailMaxWidth,
+                     kImageSearchThumbnailMaxHeight)));
+}
+
 void RenderViewContextMenu::Inspect(int x, int y) {
   content::RecordAction(UserMetricsAction("DevTools_InspectElement"));
   source_web_contents_->GetRenderViewHostAtPosition(
       x, y, base::Bind(&DevToolsInspectElementAt));
 }
 
 void RenderViewContextMenu::WriteURLToClipboard(const GURL& url) {
   chrome_common_net::WriteURLToClipboard(
       url,
       profile_->GetPrefs()->GetString(prefs::kAcceptLanguages),
       ui::Clipboard::GetForCurrentThread());
 }
 
 void RenderViewContextMenu::MediaPlayerActionAt(
     const gfx::Point& location,
     const WebMediaPlayerAction& action) {
   source_web_contents_->GetRenderViewHost()->
       ExecuteMediaPlayerActionAtLocation(location, action);
 }
 
 void RenderViewContextMenu::PluginActionAt(
     const gfx::Point& location,
     const WebPluginAction& action) {
   source_web_contents_->GetRenderViewHost()->
       ExecutePluginActionAtLocation(location, action);
 }