chrome/browser/tab_contents/match_preview.cc

// Copyright (c) 2010 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/match_preview.h"

#include <algorithm>

#include "base/command_line.h"
#include "base/string_number_conversions.h"
#include "base/utf_string_conversions.h"
#include "chrome/browser/autocomplete/autocomplete.h"
#include "chrome/browser/favicon_service.h"
#include "chrome/browser/history/history_marshaling.h"
#include "chrome/browser/profile.h"
#include "chrome/browser/renderer_host/render_view_host.h"
#include "chrome/browser/renderer_host/render_widget_host.h"
#include "chrome/browser/renderer_host/render_widget_host_view.h"
#include "chrome/browser/search_engines/template_url.h"
#include "chrome/browser/search_engines/template_url_model.h"
#include "chrome/browser/tab_contents/match_preview_delegate.h"
#include "chrome/browser/tab_contents/navigation_controller.h"
#include "chrome/browser/tab_contents/navigation_entry.h"
#include "chrome/browser/tab_contents/tab_contents.h"
#include "chrome/browser/tab_contents/tab_contents_delegate.h"
#include "chrome/browser/tab_contents/tab_contents_view.h"
#include "chrome/common/chrome_switches.h"
#include "chrome/common/notification_observer.h"
#include "chrome/common/notification_registrar.h"
#include "chrome/common/notification_service.h"
#include "chrome/common/page_transition_types.h"
#include "chrome/common/render_messages.h"
#include "chrome/common/renderer_preferences.h"
#include "gfx/codec/png_codec.h"
#include "ipc/ipc_message.h"

namespace {

// Script sent as the user is typing and the provider supports instant.
// Params:
// . the text the user typed.
// TODO: add support for the 2nd and 3rd params.
const char kUserInputScript[] =
    "if (window.chrome.userInput) window.chrome.userInput(\"$1\", 0, 0);";

// Script sent when the page is committed and the provider supports instant.
// Params:
// . the text the user typed.
// . boolean indicating if the user pressed enter to accept the text.
const char kUserDoneScript[] =
    "if (window.chrome.userWantsQuery) "
      "window.chrome.userWantsQuery(\"$1\", $2);";

// Script sent when the bounds of the omnibox changes and the provider supports
// instant. The params are the bounds relative to the origin of the preview
// (x, y, width, height).
const char kSetOmniboxBoundsScript[] =
    "if (window.chrome.setOmniboxDimensions) "
    "window.chrome.setOmniboxDimensions($1, $2, $3, $4);";

// Escapes quotes in the |text| so that it be passed to JavaScript as a quoted
// string.
string16 EscapeUserText(const string16& text) {
  string16 escaped_text(text);
  ReplaceSubstringsAfterOffset(&escaped_text, 0L, ASCIIToUTF16("\""),
                               ASCIIToUTF16("\\\""));
  return escaped_text;
}

// Sends the script for when the user commits the preview. |pressed_enter| is
// true if the user pressed enter to commit.
void SendDoneScript(TabContents* tab_contents,
                    const string16& text,
                    bool pressed_enter) {
  std::vector<string16> params;
  params.push_back(EscapeUserText(text));
  params.push_back(pressed_enter ? ASCIIToUTF16("true") :
                   ASCIIToUTF16("false"));
  string16 script = ReplaceStringPlaceholders(ASCIIToUTF16(kUserDoneScript),
                                              params,
                                              NULL);
  tab_contents->render_view_host()->ExecuteJavascriptInWebFrame(
      std::wstring(),
      UTF16ToWide(script));
}

// Sends the user input script to |tab_contents|. |text| is the text the user
// input into the omnibox.
void SendUserInputScript(TabContents* tab_contents, const string16& text) {
  string16 script = ReplaceStringPlaceholders(ASCIIToUTF16(kUserInputScript),
                                              EscapeUserText(text),
                                              NULL);
  tab_contents->render_view_host()->ExecuteJavascriptInWebFrame(
      std::wstring(),
      UTF16ToWide(script));
}

// Sends the script for setting the bounds of the omnibox to |tab_contents|.
void SendOmniboxBoundsScript(TabContents* tab_contents,
                             const gfx::Rect& bounds) {
  std::vector<string16> bounds_vector;
  bounds_vector.push_back(base::IntToString16(bounds.x()));
  bounds_vector.push_back(base::IntToString16(bounds.y()));
  bounds_vector.push_back(base::IntToString16(bounds.width()));
  bounds_vector.push_back(base::IntToString16(bounds.height()));
  string16 script = ReplaceStringPlaceholders(
      ASCIIToUTF16(kSetOmniboxBoundsScript),
      bounds_vector,
      NULL);
  tab_contents->render_view_host()->ExecuteJavascriptInWebFrame(
      std::wstring(),
      UTF16ToWide(script));
}

}  // namespace

// FrameLoadObserver is responsible for waiting for the TabContents to finish
// loading and when done sending the necessary script down to the page.
class MatchPreview::FrameLoadObserver : public NotificationObserver {
 public:
  FrameLoadObserver(MatchPreview* match_preview, const string16& text)
      : match_preview_(match_preview),
        tab_contents_(match_preview->preview_contents()),
        unique_id_(tab_contents_->controller().pending_entry()->unique_id()),
        text_(text),
        pressed_enter_(false) {
    registrar_.Add(this, NotificationType::LOAD_COMPLETED_MAIN_FRAME,
                   Source<TabContents>(tab_contents_));
    registrar_.Add(this, NotificationType::TAB_CONTENTS_DESTROYED,
                   Source<TabContents>(tab_contents_));
  }

  // Sets the text to send to the page.
  void set_text(const string16& text) { text_ = text; }

  // Invoked when the MatchPreview releases ownership of the TabContents and
  // the page hasn't finished loading.
  void DetachFromPreview(bool pressed_enter) {
    match_preview_ = NULL;