path: root/chrome/browser/translate/translate_language_list.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/translate/translate_language_list.h"

#include <set>

#include "base/json/json_reader.h"
#include "base/lazy_instance.h"
#include "base/logging.h"
#include "base/strings/string_util.h"
#include "base/strings/stringprintf.h"
#include "base/values.h"
#include "chrome/browser/browser_process.h"
#include "chrome/browser/translate/translate_event_details.h"
#include "chrome/browser/translate/translate_manager.h"
#include "chrome/browser/translate/translate_url_util.h"
#include "googleurl/src/gurl.h"
#include "net/base/load_flags.h"
#include "net/base/url_util.h"
#include "net/http/http_status_code.h"
#include "net/url_request/url_fetcher.h"
#include "net/url_request/url_request_status.h"

namespace {

// The default list of languages the Google translation server supports.
// We use this list until we receive the list that the server exposes.
// For information, here is the list of languages that Chrome can be run in
// but that the translation server does not support:
// am Amharic
// bn Bengali
// gu Gujarati
// kn Kannada
// ml Malayalam
// mr Marathi
// ta Tamil
// te Telugu
const char* const kDefaultSupportedLanguages[] = {
  "af",     // Afrikaans
  "sq",     // Albanian
  "ar",     // Arabic
  "be",     // Belarusian
  "bg",     // Bulgarian
  "ca",     // Catalan
  "zh-CN",  // Chinese (Simplified)
  "zh-TW",  // Chinese (Traditional)
  "hr",     // Croatian
  "cs",     // Czech
  "da",     // Danish
  "nl",     // Dutch
  "en",     // English
  "eo",     // Esperanto
  "et",     // Estonian
  "tl",     // Filipino
  "fi",     // Finnish
  "fr",     // French
  "gl",     // Galician
  "de",     // German
  "el",     // Greek
  "ht",     // Haitian Creole
  "iw",     // Hebrew
  "hi",     // Hindi
  "hu",     // Hungarian
  "is",     // Icelandic
  "id",     // Indonesian
  "ga",     // Irish
  "it",     // Italian
  "ja",     // Japanese
  "ko",     // Korean
  "lv",     // Latvian
  "lt",     // Lithuanian
  "mk",     // Macedonian
  "ms",     // Malay
  "mt",     // Maltese
  "no",     // Norwegian
  "fa",     // Persian
  "pl",     // Polish
  "pt",     // Portuguese
  "ro",     // Romanian
  "ru",     // Russian
  "sr",     // Serbian
  "sk",     // Slovak
  "sl",     // Slovenian
  "es",     // Spanish
  "sw",     // Swahili
  "sv",     // Swedish
  "th",     // Thai
  "tr",     // Turkish
  "uk",     // Ukrainian
  "vi",     // Vietnamese
  "cy",     // Welsh
  "yi",     // Yiddish
};

// Constant URL string to fetch server supporting language list.
const char kLanguageListFetchURL[] =
    "https://translate.googleapis.com/translate_a/l?client=chrome&cb=sl";

// Used in kTranslateScriptURL to request supporting languages list including
// "alpha languages".
const char kAlphaLanguageQueryName[] = "alpha";
const char kAlphaLanguageQueryValue[] = "1";

// Retry parameter for fetching supporting language list.
const int kMaxRetryLanguageListFetch = 5;

const int kFetcherIdForLanguageList = 1;
const int kFetcherIdForAlphaLanguageList = 2;

// Show a message in chrome:://translate-internals Event Logs.
void NotifyEvent(int line, const std::string& message) {
  TranslateManager* manager = TranslateManager::GetInstance();
  DCHECK(manager);

  TranslateEventDetails details(__FILE__, line, message);
  manager->NotifyTranslateEvent(details);
}

// Parses |language_list| containing the list of languages that the translate
// server can translate to and from, and fills |set| with them.
void SetSupportedLanguages(const std::string& language_list,
                           std::set<std::string>* set) {
  DCHECK(set);
  // The format is:
  // sl({"sl": {"XX": "LanguageName", ...}, "tl": {"XX": "LanguageName", ...}})
  // Where "sl(" is set in kLanguageListCallbackName
  // and "tl" is kTargetLanguagesKey
  if (!StartsWithASCII(language_list,
                       TranslateLanguageList::kLanguageListCallbackName,
                       false) ||
      !EndsWith(language_list, ")", false)) {
    // We don't have a NOTREACHED here since this can happen in ui_tests, even
    // though the the BrowserMain function won't call us with parameters.ui_task
    // is NULL some tests don't set it, so we must bail here.
    return;
  }
  static const size_t kLanguageListCallbackNameLength =
      strlen(TranslateLanguageList::kLanguageListCallbackName);
  std::string languages_json = language_list.substr(
      kLanguageListCallbackNameLength,
      language_list.size() - kLanguageListCallbackNameLength - 1);
  scoped_ptr<Value> json_value(
      base::JSONReader::Read(languages_json, base::JSON_ALLOW_TRAILING_COMMAS));
  if (json_value == NULL || !json_value->IsType(Value::TYPE_DICTIONARY)) {
    NOTREACHED();
    return;
  }
  // The first level dictionary contains two sub-dict, one for source languages
  // and the other for target languages, we want to use the target languages.
  DictionaryValue* language_dict =
      static_cast<DictionaryValue*>(json_value.get());
  DictionaryValue* target_languages = NULL;
  if (!language_dict->GetDictionary(TranslateLanguageList::kTargetLanguagesKey,
                                    &target_languages) ||
      target_languages == NULL) {
    NOTREACHED();
    return;
  }

  // Now we can clear language list.
  set->clear();
  std::string message;
  // ... and replace it with the values we just fetched from the server.
  for (DictionaryValue::Iterator iter(*target_languages);
       !iter.IsAtEnd();
       iter.Advance()) {
    // TODO(toyoshim): Check if UI libraries support adding locale.
    set->insert(iter.key());
    if (message.empty())
      message += iter.key();
    else
      message += ", " + iter.key();
  }
  NotifyEvent(__LINE__, message);
}

// Creates URLFetcher, sets arguments to start, and returns the object.
net::URLFetcher* CreateAndStartFetch(int id,
                                     const GURL& url,
                                     net::URLFetcherDelegate* delegate) {
  DCHECK(delegate);
  std::string message = base::StringPrintf(
      "%s list fetch starts (URL: %s)",
      (id == kFetcherIdForLanguageList) ? "Language" : "Alpha language",
      url.spec().c_str());
  NotifyEvent(__LINE__, message);

  scoped_ptr<net::URLFetcher> fetcher;
  fetcher.reset(net::URLFetcher::Create(id,
                                        url,
                                        net::URLFetcher::GET,
                                        delegate));
  fetcher->SetLoadFlags(net::LOAD_DO_NOT_SEND_COOKIES |
                        net::LOAD_DO_NOT_SAVE_COOKIES);
  fetcher->SetRequestContext(g_browser_process->system_request_context());
  fetcher->SetMaxRetriesOn5xx(kMaxRetryLanguageListFetch);
  fetcher->Start();

  return fetcher.release();
}

}  // namespace

// This must be kept in sync with the &cb= value in the kLanguageListFetchURL.
const char TranslateLanguageList::kLanguageListCallbackName[] = "sl(";
const char TranslateLanguageList::kTargetLanguagesKey[] = "tl";

TranslateLanguageList::TranslateLanguageList() {
  // We default to our hard coded list of languages in
  // |kDefaultSupportedLanguages|. This list will be overriden by a server
  // providing supported langauges list.
  for (size_t i = 0; i < arraysize(kDefaultSupportedLanguages); ++i)
    supported_languages_.insert(kDefaultSupportedLanguages[i]);
  UpdateSupportedLanguages();
}

TranslateLanguageList::~TranslateLanguageList() {}

void TranslateLanguageList::OnURLFetchComplete(const net::URLFetcher* source) {
  scoped_ptr<const net::URLFetcher> delete_ptr;

  if (source->GetStatus().status() == net::URLRequestStatus::SUCCESS &&
      source->GetResponseCode() == net::HTTP_OK) {
    std::string data;
    source->GetResponseAsString(&data);
    if (language_list_fetcher_.get() == source) {
      NotifyEvent(__LINE__, "Language list is updated");
      delete_ptr.reset(language_list_fetcher_.release());
      SetSupportedLanguages(data, &supported_languages_);
    } else if (alpha_language_list_fetcher_.get() == source) {
      NotifyEvent(__LINE__, "Alpha language list is updated");
      delete_ptr.reset(alpha_language_list_fetcher_.release());
      SetSupportedLanguages(data, &supported_alpha_languages_);
    } else {
      NOTREACHED();
    }
    UpdateSupportedLanguages();
  } else {
    // TODO(toyoshim): Try again. http://crbug.com/244202 .
    // Also In CrOS, FetchLanguageList is not called at launching Chrome. It
    // will solve this problem that check if FetchLanguageList is already
    // called, and call it if needed in InitSupportedLanguage().
    std::string message = base::StringPrintf(
        "%s list update fails (Status: %d, URL: %s)",
        (language_list_fetcher_.get() == source) ? "Language" :
                                                   "Alpha language",
        source->GetResponseCode(),
        source->GetOriginalURL().spec().c_str());
    NotifyEvent(__LINE__, message);
  }
}

void TranslateLanguageList::GetSupportedLanguages(
    std::vector<std::string>* languages) {
  DCHECK(languages && languages->empty());
  std::set<std::string>::const_iterator iter = all_supported_languages_.begin();
  for (; iter != all_supported_languages_.end(); ++iter)
    languages->push_back(*iter);
}

std::string TranslateLanguageList::GetLanguageCode(
    const std::string& chrome_locale) {
  // Only remove the country code for country specific languages we don't
  // support specifically yet.
  if (IsSupportedLanguage(chrome_locale))
    return chrome_locale;

  size_t hypen_index = chrome_locale.find('-');
  if (hypen_index == std::string::npos)
    return chrome_locale;
  return chrome_locale.substr(0, hypen_index);
}

bool TranslateLanguageList::IsSupportedLanguage(const std::string& language) {
  return all_supported_languages_.count(language) != 0;
}

bool TranslateLanguageList::IsAlphaLanguage(const std::string& language) {
  // |language| should exist only in the alpha language list.
  return supported_alpha_languages_.count(language) != 0 &&
         supported_languages_.count(language) == 0;
}

void TranslateLanguageList::RequestLanguageList() {
  if (language_list_fetcher_.get() || alpha_language_list_fetcher_.get())
    return;

  // Fetch the stable language list.
  GURL language_list_fetch_url = GURL(kLanguageListFetchURL);
  language_list_fetch_url =
      TranslateURLUtil::AddHostLocaleToUrl(language_list_fetch_url);
  language_list_fetch_url =
      TranslateURLUtil::AddApiKeyToUrl(language_list_fetch_url);

  language_list_fetcher_.reset(
      CreateAndStartFetch(kFetcherIdForLanguageList,
                          language_list_fetch_url,
                          this));

  // Fetch the alpha language list.
  language_list_fetch_url = net::AppendQueryParameter(
      language_list_fetch_url,
      kAlphaLanguageQueryName,
      kAlphaLanguageQueryValue);

  alpha_language_list_fetcher_.reset(
      CreateAndStartFetch(kFetcherIdForAlphaLanguageList,
                          language_list_fetch_url,
                          this));
}

void TranslateLanguageList::UpdateSupportedLanguages() {
  all_supported_languages_.clear();
  std::set<std::string>::const_iterator iter;
  for (iter = supported_languages_.begin();
      iter != supported_languages_.end();
      ++iter)
    all_supported_languages_.insert(*iter);
  for (iter = supported_alpha_languages_.begin();
      iter != supported_alpha_languages_.end();
      ++iter)
    all_supported_languages_.insert(*iter);
}