components/translate/core/browser/translate_script.cc

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "components/translate/core/browser/translate_script.h"
   6
   7 #include "base/bind.h"
   8 #include "base/command_line.h"
   9 #include "base/location.h"
  10 #include "base/logging.h"
  11 #include "base/profiler/scoped_tracker.h"
  12 #include "base/single_thread_task_runner.h"
  13 #include "base/strings/string_piece.h"
  14 #include "base/strings/string_util.h"
  15 #include "base/strings/stringprintf.h"
  16 #include "base/thread_task_runner_handle.h"
  17 #include "components/translate/core/browser/translate_url_fetcher.h"
  18 #include "components/translate/core/browser/translate_url_util.h"
  19 #include "components/translate/core/common/translate_switches.h"
  20 #include "components/translate/core/common/translate_util.h"
  21 #include "google_apis/google_api_keys.h"
  22 #include "grit/components_resources.h"
  23 #include "net/base/escape.h"
  24 #include "net/base/url_util.h"
  25 #include "ui/base/resource/resource_bundle.h"
  26
  27 namespace translate {
  28
  29 namespace {
  30
  31 const int kExpirationDelayDays = 1;
  32
  33 }  // namespace
  34
  35 const char TranslateScript::kScriptURL[] =
  36     "https://translate.google.com/translate_a/element.js";
  37 const char TranslateScript::kRequestHeader[] =
  38     "Google-Translate-Element-Mode: library";
  39 const char TranslateScript::kAlwaysUseSslQueryName[] = "aus";
  40 const char TranslateScript::kAlwaysUseSslQueryValue[] = "true";
  41 const char TranslateScript::kCallbackQueryName[] = "cb";
  42 const char TranslateScript::kCallbackQueryValue[] =
  43     "cr.googleTranslate.onTranslateElementLoad";
  44 const char TranslateScript::kCssLoaderCallbackQueryName[] = "clc";
  45 const char TranslateScript::kCssLoaderCallbackQueryValue[] =
  46     "cr.googleTranslate.onLoadCSS";
  47 const char TranslateScript::kJavascriptLoaderCallbackQueryName[] = "jlc";
  48 const char TranslateScript::kJavascriptLoaderCallbackQueryValue[] =
  49     "cr.googleTranslate.onLoadJavascript";
  50
  51 TranslateScript::TranslateScript()
  52     : expiration_delay_(base::TimeDelta::FromDays(kExpirationDelayDays)),
  53       weak_method_factory_(this) {
  54 }
  55
  56 TranslateScript::~TranslateScript() {
  57 }
  58
  59 void TranslateScript::Request(const RequestCallback& callback) {
  60   DCHECK(data_.empty()) << "Do not fetch the script if it is already fetched";
  61   callback_list_.push_back(callback);
  62
  63   if (fetcher_.get() != NULL) {
  64     // If there is already a request in progress, do nothing. |callback| will be
  65     // run on completion.
  66     return;
  67   }
  68
  69   GURL translate_script_url;
  70   // Check if command-line contains an alternative URL for translate service.
  71   const base::CommandLine& command_line =
  72       *base::CommandLine::ForCurrentProcess();
  73   if (command_line.HasSwitch(translate::switches::kTranslateScriptURL)) {
  74     translate_script_url = GURL(command_line.GetSwitchValueASCII(
  75         translate::switches::kTranslateScriptURL));
  76     if (!translate_script_url.is_valid() ||
  77         !translate_script_url.query().empty()) {
  78       LOG(WARNING) << "The following translate URL specified at the "
  79                    << "command-line is invalid: "
  80                    << translate_script_url.spec();
  81       translate_script_url = GURL();
  82     }
  83   }
  84
  85   // Use default URL when command-line argument is not specified, or specified
  86   // URL is invalid.
  87   if (translate_script_url.is_empty())
  88     translate_script_url = GURL(kScriptURL);
  89
  90   translate_script_url = net::AppendQueryParameter(
  91       translate_script_url,
  92       kCallbackQueryName,
  93       kCallbackQueryValue);
  94   translate_script_url = net::AppendQueryParameter(
  95       translate_script_url,
  96       kAlwaysUseSslQueryName,
  97       kAlwaysUseSslQueryValue);
  98 #if !defined(OS_IOS)
  99   // iOS doesn't need to use specific loaders for the isolated world.
 100   translate_script_url = net::AppendQueryParameter(
 101       translate_script_url,
 102       kCssLoaderCallbackQueryName,
 103       kCssLoaderCallbackQueryValue);
 104   translate_script_url = net::AppendQueryParameter(
 105       translate_script_url,
 106       kJavascriptLoaderCallbackQueryName,
 107       kJavascriptLoaderCallbackQueryValue);
 108 #endif  // !defined(OS_IOS)
 109
 110   translate_script_url = AddHostLocaleToUrl(translate_script_url);
 111   translate_script_url = AddApiKeyToUrl(translate_script_url);
 112
 113   fetcher_.reset(new TranslateURLFetcher(kFetcherId));
 114   fetcher_->set_extra_request_header(kRequestHeader);
 115   fetcher_->Request(
 116       translate_script_url,
 117       base::Bind(&TranslateScript::OnScriptFetchComplete,
 118                  base::Unretained(this)));
 119 }
 120
 121
 122 void TranslateScript::OnScriptFetchComplete(
 123     int id, bool success, const std::string& data) {
 124   DCHECK_EQ(kFetcherId, id);
 125
 126   scoped_ptr<const TranslateURLFetcher> delete_ptr(fetcher_.release());
 127
 128   if (success) {
 129     DCHECK(data_.empty());
 130     // Insert variable definitions on API Key and security origin.
 131     data_ = base::StringPrintf("var translateApiKey = '%s';\n",
 132                                google_apis::GetAPIKey().c_str());
 133
 134     GURL security_origin = translate::GetTranslateSecurityOrigin();
 135     base::StringAppendF(
 136         &data_, "var securityOrigin = '%s';", security_origin.spec().c_str());
 137
 138     // Append embedded translate.js and a remote element library.
 139     base::StringPiece str = ResourceBundle::GetSharedInstance().
 140         GetRawDataResource(IDR_TRANSLATE_JS);
 141     str.AppendToString(&data_);
 142     data_ += data;
 143
 144     // We'll expire the cached script after some time, to make sure long
 145     // running browsers still get fixes that might get pushed with newer
 146     // scripts.
 147     base::ThreadTaskRunnerHandle::Get()->PostDelayedTask(
 148         FROM_HERE,
 149         base::Bind(&TranslateScript::Clear, weak_method_factory_.GetWeakPtr()),
 150         expiration_delay_);
 151   }
 152
 153   for (RequestCallbackList::iterator it = callback_list_.begin();
 154        it != callback_list_.end();
 155        ++it) {
 156     it->Run(success, data);
 157   }
 158   callback_list_.clear();
 159 }
 160
 161 }  // namespace translate