[Translate] Migrate IPCs to Mojo interfaces.

components/translate/content/renderer/translate_helper.cc

 // Copyright (c) 2012 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 "components/translate/content/renderer/translate_helper.h"
 
 #include "base/bind.h"
 #include "base/compiler_specific.h"
 #include "base/location.h"
 #include "base/logging.h"
 #include "base/metrics/histogram_macros.h"
 #include "base/single_thread_task_runner.h"
 #include "base/strings/string16.h"
 #include "base/strings/string_util.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/threading/thread_task_runner_handle.h"
-#include "components/translate/content/common/translate_messages.h"
 #include "components/translate/core/common/translate_constants.h"
 #include "components/translate/core/common/translate_metrics.h"
 #include "components/translate/core/common/translate_util.h"
 #include "components/translate/core/language_detection/language_detection_util.h"
 #include "content/public/common/content_constants.h"
 #include "content/public/common/url_constants.h"
 #include "content/public/renderer/render_frame.h"
 #include "content/public/renderer/render_thread.h"
-#include "ipc/ipc_platform_file.h"
+#include "services/shell/public/cpp/interface_provider.h"
 #include "third_party/WebKit/public/web/WebDocument.h"
 #include "third_party/WebKit/public/web/WebElement.h"
 #include "third_party/WebKit/public/web/WebLocalFrame.h"
 #include "third_party/WebKit/public/web/WebNode.h"
 #include "third_party/WebKit/public/web/WebScriptSource.h"
 #include "url/gurl.h"
 #include "v8/include/v8.h"
 
 using base::ASCIIToUTF16;
 using blink::WebDocument;
@@ skipping 34 matching lines @@
   if (head.isNull() || !head.hasChildNodes())
     return false;
 
   const WebString meta(ASCIIToUTF16("meta"));
   const WebString name(ASCIIToUTF16("name"));
   const WebString google(ASCIIToUTF16("google"));
   const WebString value(ASCIIToUTF16("value"));
   const WebString content(ASCIIToUTF16("content"));
 
   for (WebNode child = head.firstChild(); !child.isNull();
-      child = child.nextSibling()) {
+       child = child.nextSibling()) {
     if (!child.isElementNode())
       continue;
     WebElement element = child.to<WebElement>();
     // Check if a tag is <meta>.
     if (!element.hasHTMLTagName(meta))
       continue;
     // Check if the tag contains name="google".
     WebString attribute = element.getAttribute(name);
     if (attribute.isNull() || attribute != google)
       continue;
@@ skipping 15 matching lines @@
 namespace translate {
 
 ////////////////////////////////////////////////////////////////////////////////
 // TranslateHelper, public:
 //
 TranslateHelper::TranslateHelper(content::RenderFrame* render_frame,
                                  int world_id,
                                  int extension_group,
                                  const std::string& extension_scheme)
     : content::RenderFrameObserver(render_frame),
-      page_seq_no_(0),
-      translation_pending_(false),
       world_id_(world_id),
       extension_group_(extension_group),
       extension_scheme_(extension_scheme),
+      binding_(this),
       weak_method_factory_(this) {}
 
-TranslateHelper::~TranslateHelper() {
-}
+TranslateHelper::~TranslateHelper() {}
 
 void TranslateHelper::PrepareForUrl(const GURL& url) {
-  ++page_seq_no_;
-  Send(new ChromeFrameHostMsg_TranslateAssignedSequenceNumber(routing_id(),
-                                                              page_seq_no_));
+  // Navigated to a new page, close the binding for previous page.
+  binding_.Close();
+  translate_callback_pending_.Reset();
 }
 
 void TranslateHelper::PageCaptured(const base::string16& contents) {
-  PageCapturedImpl(page_seq_no_, contents);
-}
-
-void TranslateHelper::PageCapturedImpl(int page_seq_no,
-                                       const base::string16& contents) {
   // Get the document language as set by WebKit from the http-equiv
   // meta tag for "content-language".  This may or may not also
   // have a value derived from the actual Content-Language HTTP
   // header.  The two actually have different meanings (despite the
   // original intent of http-equiv to be an equivalent) with the former
   // being the language of the document and the latter being the
   // language of the intended audience (a distinction really only
   // relevant for things like langauge textbooks).  This distinction
   // shouldn't affect translation.
   WebLocalFrame* main_frame = render_frame()->GetWebFrame();
-  if (!main_frame || page_seq_no_ != page_seq_no)
+  if (!main_frame)
     return;
 
   WebDocument document = main_frame->document();
   std::string content_language = document.contentLanguage().utf8();
   WebElement html_element = document.documentElement();
   std::string html_lang;
   // |html_element| can be null element, e.g. in
   // BrowserTest.WindowOpenClose.
   if (!html_element.isNull())
     html_lang = html_element.getAttribute("lang").utf8();
@@ skipping 15 matching lines @@
   details.cld_language = cld_language;
   details.is_cld_reliable = is_cld_reliable;
   details.has_notranslate = HasNoTranslateMeta(&document);
   details.html_root_language = html_lang;
   details.adopted_language = language;
 
   // TODO(hajimehoshi): If this affects performance, it should be set only if
   // translate-internals tab exists.
   details.contents = contents;
 
-  Send(new ChromeFrameHostMsg_TranslateLanguageDetermined(
-      routing_id(), details, !details.has_notranslate && !language.empty()));
+  // For the same render frame with the same url, each time when its texts are
+  // captured, it should be treated as a new page to do translation.
+  binding_.Close();
+  GetTranslateDriver()->RegisterPage(
+      binding_.CreateInterfacePtrAndBind(), details,
+      !details.has_notranslate && !language.empty());
 }
 
 void TranslateHelper::CancelPendingTranslation() {
   weak_method_factory_.InvalidateWeakPtrs();
-  translation_pending_ = false;
+  // Make sure to send the cancelled response back.
+  if (translate_callback_pending_) {
+    translate_callback_pending_.Run(true, source_lang_, target_lang_,
+                                    TranslateErrors::NONE);
+    translate_callback_pending_.Reset();
+  }
   source_lang_.clear();
   target_lang_.clear();
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // TranslateHelper, protected:
 //
 bool TranslateHelper::IsTranslateLibAvailable() {
   return ExecuteScriptAndGetBoolResult(
       "typeof cr != 'undefined' && typeof cr.googleTranslate != 'undefined' && "
-      "typeof cr.googleTranslate.translate == 'function'", false);
+      "typeof cr.googleTranslate.translate == 'function'",
+      false);
 }
 
 bool TranslateHelper::IsTranslateLibReady() {
   return ExecuteScriptAndGetBoolResult("cr.googleTranslate.libReady", false);
 }
 
 bool TranslateHelper::HasTranslationFinished() {
   return ExecuteScriptAndGetBoolResult("cr.googleTranslate.finished", true);
 }
 
 bool TranslateHelper::HasTranslationFailed() {
   return ExecuteScriptAndGetBoolResult("cr.googleTranslate.error", true);
 }
 
 bool TranslateHelper::StartTranslation() {
-  std::string script = "cr.googleTranslate.translate('" +
-                       source_lang_ +
-                       "','" +
-                       target_lang_ +
-                       "')";
+  std::string script = "cr.googleTranslate.translate('" + source_lang_ + "','" +

[Tom Sepez, 2016/08/01 17:08:17]

Note: pre-existing.  Although this is invoked in response to a browser message,
and the message flows in a less secure direction, we might want to protect
ourselves if source_lang contains unexpected punctuation, in case souce_lang is
somehow taken by the browser from some user or page input.

I generally get nervous when JS strings are cobbled together without first
filtering the parameter.

Need not address this now.

[leonhsl(Using Gerrit), 2016/08/02 02:52:23]

Understood. I filed an issue crbug.com/633460 to discuss/track this problem.
Thanks.

+                       target_lang_ + "')";
   return ExecuteScriptAndGetBoolResult(script, false);
 }
 
 std::string TranslateHelper::GetOriginalPageLanguage() {
   return ExecuteScriptAndGetStringResult("cr.googleTranslate.sourceLang");
 }
 
 base::TimeDelta TranslateHelper::AdjustDelay(int delayInMs) {
   // Just converts |delayInMs| without any modification in practical cases.
   // Tests will override this function to return modified value.
   return base::TimeDelta::FromMilliseconds(delayInMs);
 }
 
 void TranslateHelper::ExecuteScript(const std::string& script) {
   WebLocalFrame* main_frame = render_frame()->GetWebFrame();
   if (!main_frame)
     return;
 
   WebScriptSource source = WebScriptSource(ASCIIToUTF16(script));
-  main_frame->executeScriptInIsolatedWorld(
-      world_id_, &source, 1, extension_group_);
+  main_frame->executeScriptInIsolatedWorld(world_id_, &source, 1,
+                                           extension_group_);
 }
 
 bool TranslateHelper::ExecuteScriptAndGetBoolResult(const std::string& script,
                                                     bool fallback) {
   WebLocalFrame* main_frame = render_frame()->GetWebFrame();
   if (!main_frame)
     return fallback;
 
   v8::HandleScope handle_scope(v8::Isolate::GetCurrent());
-  WebVector<v8::Local<v8::Value> > results;
+  WebVector<v8::Local<v8::Value>> results;
   WebScriptSource source = WebScriptSource(ASCIIToUTF16(script));
-  main_frame->executeScriptInIsolatedWorld(
-      world_id_, &source, 1, extension_group_, &results);
+  main_frame->executeScriptInIsolatedWorld(world_id_, &source, 1,
+                                           extension_group_, &results);
   if (results.size() != 1 || results[0].IsEmpty() || !results[0]->IsBoolean()) {
     NOTREACHED();
     return fallback;
   }
 
   return results[0]->BooleanValue();
 }
 
 std::string TranslateHelper::ExecuteScriptAndGetStringResult(
     const std::string& script) {
   WebLocalFrame* main_frame = render_frame()->GetWebFrame();
   if (!main_frame)
     return std::string();
 
   v8::HandleScope handle_scope(v8::Isolate::GetCurrent());
-  WebVector<v8::Local<v8::Value> > results;
+  WebVector<v8::Local<v8::Value>> results;
   WebScriptSource source = WebScriptSource(ASCIIToUTF16(script));
-  main_frame->executeScriptInIsolatedWorld(
-      world_id_, &source, 1, extension_group_, &results);
+  main_frame->executeScriptInIsolatedWorld(world_id_, &source, 1,
+                                           extension_group_, &results);
   if (results.size() != 1 || results[0].IsEmpty() || !results[0]->IsString()) {
     NOTREACHED();
     return std::string();
   }
 
   v8::Local<v8::String> v8_str = results[0].As<v8::String>();
   int length = v8_str->Utf8Length() + 1;
   std::unique_ptr<char[]> str(new char[length]);
   v8_str->WriteUtf8(str.get(), length);
   return std::string(str.get());
 }
 
 double TranslateHelper::ExecuteScriptAndGetDoubleResult(
     const std::string& script) {
   WebLocalFrame* main_frame = render_frame()->GetWebFrame();
   if (!main_frame)
     return 0.0;
 
   v8::HandleScope handle_scope(v8::Isolate::GetCurrent());
-  WebVector<v8::Local<v8::Value> > results;
+  WebVector<v8::Local<v8::Value>> results;
   WebScriptSource source = WebScriptSource(ASCIIToUTF16(script));
-  main_frame->executeScriptInIsolatedWorld(
-      world_id_, &source, 1, extension_group_, &results);
+  main_frame->executeScriptInIsolatedWorld(world_id_, &source, 1,
+                                           extension_group_, &results);
   if (results.size() != 1 || results[0].IsEmpty() || !results[0]->IsNumber()) {
     NOTREACHED();
     return 0.0;
   }
 
   return results[0]->NumberValue();
 }
 
-////////////////////////////////////////////////////////////////////////////////
-// TranslateHelper, private:
-//
-bool TranslateHelper::OnMessageReceived(const IPC::Message& message) {
-  bool handled = true;
-  IPC_BEGIN_MESSAGE_MAP(TranslateHelper, message)
-    IPC_MESSAGE_HANDLER(ChromeFrameMsg_TranslatePage, OnTranslatePage)
-    IPC_MESSAGE_HANDLER(ChromeFrameMsg_RevertTranslation, OnRevertTranslation)
-    IPC_MESSAGE_UNHANDLED(handled = false)
-  IPC_END_MESSAGE_MAP()
-  return handled;
-}
-
-void TranslateHelper::OnTranslatePage(int page_seq_no,
-                                      const std::string& translate_script,
-                                      const std::string& source_lang,
-                                      const std::string& target_lang) {
+// mojom::Page implementations.
+void TranslateHelper::Translate(const std::string& translate_script,
+                                const std::string& source_lang,
+                                const std::string& target_lang,
+                                const TranslateCallback& callback) {
   WebLocalFrame* main_frame = render_frame()->GetWebFrame();
-  if (!main_frame || page_seq_no_ != page_seq_no)
+  if (!main_frame) {
+    // Cancelled.
+    callback.Run(true, source_lang, target_lang, TranslateErrors::NONE);
     return;  // We navigated away, nothing to do.
+  }
 
   // A similar translation is already under way, nothing to do.
-  if (translation_pending_ && target_lang_ == target_lang)
+  if (translate_callback_pending_ && target_lang_ == target_lang) {
+    // This request is ignored.
+    callback.Run(true, source_lang, target_lang, TranslateErrors::NONE);
     return;
+  }
 
   // Any pending translation is now irrelevant.
   CancelPendingTranslation();
 
   // Set our states.
-  translation_pending_ = true;
+  translate_callback_pending_ = callback;
 
   // If the source language is undetermined, we'll let the translate element
   // detect it.
   source_lang_ = (source_lang != kUnknownLanguageCode) ? source_lang
                                                        : kAutoDetectionLanguage;
   target_lang_ = target_lang;
 
   ReportUserActionDuration(language_determined_time_, base::TimeTicks::Now());
 
   GURL url(main_frame->document().url());
   ReportPageScheme(url.scheme());
 
   // Set up v8 isolated world with proper content-security-policy and
   // security-origin.
   main_frame->setIsolatedWorldContentSecurityPolicy(
       world_id_, WebString::fromUTF8(kContentSecurityPolicy));
 
   GURL security_origin = GetTranslateSecurityOrigin();
   main_frame->setIsolatedWorldSecurityOrigin(
       world_id_, WebSecurityOrigin::create(security_origin));
 
   if (!IsTranslateLibAvailable()) {
     // Evaluate the script to add the translation related method to the global
     // context of the page.
     ExecuteScript(translate_script);
     DCHECK(IsTranslateLibAvailable());
   }
 
-  TranslatePageImpl(page_seq_no, 0);
+  TranslatePageImpl(0);
 }
 
-void TranslateHelper::OnRevertTranslation(int page_seq_no) {
-  if (page_seq_no_ != page_seq_no)
-    return;  // We navigated away, nothing to do.
-
+void TranslateHelper::RevertTranslation() {
   if (!IsTranslateLibAvailable()) {
     NOTREACHED();
     return;
   }
 
   CancelPendingTranslation();
 
   ExecuteScript("cr.googleTranslate.revert()");
 }
 
-void TranslateHelper::CheckTranslateStatus(int page_seq_no) {
-  // If this is not the same page, the translation has been canceled.
-  if (page_seq_no_ != page_seq_no)
-    return;
-
+////////////////////////////////////////////////////////////////////////////////
+// TranslateHelper, private:
+//
+void TranslateHelper::CheckTranslateStatus() {
   // First check if there was an error.
   if (HasTranslationFailed()) {
     // TODO(toyoshim): Check |errorCode| of translate.js and notify it here.
     NotifyBrowserTranslationFailed(TranslateErrors::TRANSLATION_ERROR);
     return;  // There was an error.
   }
 
   if (HasTranslationFinished()) {
     std::string actual_source_lang;
     // Translation was successfull, if it was auto, retrieve the source
     // language the Translate Element detected.
     if (source_lang_ == kAutoDetectionLanguage) {
       actual_source_lang = GetOriginalPageLanguage();
       if (actual_source_lang.empty()) {
         NotifyBrowserTranslationFailed(TranslateErrors::UNKNOWN_LANGUAGE);
         return;
       } else if (actual_source_lang == target_lang_) {
         NotifyBrowserTranslationFailed(TranslateErrors::IDENTICAL_LANGUAGES);
         return;
       }
     } else {
       actual_source_lang = source_lang_;
     }
 
-    if (!translation_pending_) {
+    if (!translate_callback_pending_) {
       NOTREACHED();
       return;
     }
 
-    translation_pending_ = false;
-
     // Check JavaScript performance counters for UMA reports.
     ReportTimeToTranslate(
         ExecuteScriptAndGetDoubleResult("cr.googleTranslate.translationTime"));
 
     // Notify the browser we are done.
-    render_frame()->Send(new ChromeFrameHostMsg_PageTranslated(
-        render_frame()->GetRoutingID(), actual_source_lang, target_lang_,
-        TranslateErrors::NONE));
+    translate_callback_pending_.Run(false, actual_source_lang, target_lang_,
+                                    TranslateErrors::NONE);
+    translate_callback_pending_.Reset();
     return;
   }
 
   // The translation is still pending, check again later.
   base::ThreadTaskRunnerHandle::Get()->PostDelayedTask(
       FROM_HERE, base::Bind(&TranslateHelper::CheckTranslateStatus,
-                            weak_method_factory_.GetWeakPtr(), page_seq_no),
+                            weak_method_factory_.GetWeakPtr()),
       AdjustDelay(kTranslateStatusCheckDelayMs));
 }
 
-void TranslateHelper::TranslatePageImpl(int page_seq_no, int count) {
+void TranslateHelper::TranslatePageImpl(int count) {
   DCHECK_LT(count, kMaxTranslateInitCheckAttempts);
-  if (page_seq_no_ != page_seq_no)
-    return;
-
   if (!IsTranslateLibReady()) {
     // The library is not ready, try again later, unless we have tried several
     // times unsuccessfully already.
     if (++count >= kMaxTranslateInitCheckAttempts) {
       NotifyBrowserTranslationFailed(TranslateErrors::INITIALIZATION_ERROR);
       return;
     }
     base::ThreadTaskRunnerHandle::Get()->PostDelayedTask(
-        FROM_HERE,
-        base::Bind(&TranslateHelper::TranslatePageImpl,
-                   weak_method_factory_.GetWeakPtr(), page_seq_no, count),
+        FROM_HERE, base::Bind(&TranslateHelper::TranslatePageImpl,
+                              weak_method_factory_.GetWeakPtr(), count),
         AdjustDelay(count * kTranslateInitCheckDelayMs));
     return;
   }
 
   // The library is loaded, and ready for translation now.
   // Check JavaScript performance counters for UMA reports.
   ReportTimeToBeReady(
       ExecuteScriptAndGetDoubleResult("cr.googleTranslate.readyTime"));
   ReportTimeToLoad(
       ExecuteScriptAndGetDoubleResult("cr.googleTranslate.loadTime"));
 
   if (!StartTranslation()) {
     NotifyBrowserTranslationFailed(TranslateErrors::TRANSLATION_ERROR);
     return;
   }
   // Check the status of the translation.
   base::ThreadTaskRunnerHandle::Get()->PostDelayedTask(
       FROM_HERE, base::Bind(&TranslateHelper::CheckTranslateStatus,
-                            weak_method_factory_.GetWeakPtr(), page_seq_no),
+                            weak_method_factory_.GetWeakPtr()),
       AdjustDelay(kTranslateStatusCheckDelayMs));
 }
 
 void TranslateHelper::NotifyBrowserTranslationFailed(
     TranslateErrors::Type error) {
-  translation_pending_ = false;
+  DCHECK(translate_callback_pending_);
   // Notify the browser there was an error.
-  render_frame()->Send(new ChromeFrameHostMsg_PageTranslated(
-      render_frame()->GetRoutingID(), source_lang_, target_lang_, error));
+  translate_callback_pending_.Run(false, source_lang_, target_lang_, error);
+  translate_callback_pending_.Reset();
+}
+
+const mojom::ContentTranslateDriverPtr& TranslateHelper::GetTranslateDriver() {
+  if (!translate_driver_) {
+    render_frame()->GetRemoteInterfaces()->GetInterface(
+        mojo::GetProxy(&translate_driver_));
+  }
+
+  return translate_driver_;
 }
 
 void TranslateHelper::OnDestruct() {
   delete this;
 }
 
 }  // namespace translate