Merge local_omnibox_popup into local_ntp. Render the Google logo and fakebox if Google is the sear…

chrome/browser/ui/search/instant_controller.cc

 // Copyright 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 "chrome/browser/ui/search/instant_controller.h"
 
 #include "base/metrics/histogram.h"
 #include "base/string_util.h"
 #include "base/stringprintf.h"
 #include "base/utf_string_conversions.h"
@@ skipping 250 matching lines @@
       UTF16ToUTF8(user_text).c_str(), UTF16ToUTF8(full_text).c_str(),
       static_cast<int>(selection_start), static_cast<int>(selection_end),
       verbatim, user_input_in_progress, omnibox_popup_is_open, escape_pressed,
       is_keyword_search));
 
   // TODO(dhollowa): Complete keyword match UI.  For now just hide suggestions.
   // http://crbug.com/153932.  Note, this early escape is happens prior to the
   // DCHECKs below because |user_text| and |full_text| have different semantics
   // when keyword search is in effect.
   if (is_keyword_search) {
-    if (UseInstantTabToShowSuggestions())
+    if (instant_tab_)
       instant_tab_->Update(string16(), 0, 0, true);
     else
       HideOverlay();
     last_match_was_search_ = false;
     return false;
   }
 
   // Ignore spurious updates when the omnibox is blurred; otherwise click
   // targets on the page may vanish before a click event arrives.
   if (omnibox_focus_state_ == OMNIBOX_FOCUS_NONE)
@@ skipping 32 matching lines @@
   // In non extended mode, Instant is disabled for URLs and keyword mode.
   if (!extended_enabled_ &&
       (!last_match_was_search_ ||
        match.type == AutocompleteMatch::SEARCH_OTHER_ENGINE)) {
     HideOverlay();
     return false;
   }
 
   // If we have an |instant_tab_| use it, else ensure we have an overlay that is
   // current or is using the local overlay.
-  if (!UseInstantTabToShowSuggestions() &&
-      !(overlay_ && overlay_->IsLocalOverlay()) &&
+  if (!instant_tab_ && !(overlay_ && overlay_->IsLocal()) &&
       !EnsureOverlayIsCurrent(false)) {
     HideOverlay();
     return false;
   }
 
   if (extended_enabled_) {
     if (!omnibox_popup_is_open) {
       if (!user_input_in_progress) {
         // If the user isn't typing and the omnibox popup is closed, it means a
         // regular navigation, tab-switch or the user hitting Escape.
-        if (UseInstantTabToShowSuggestions()) {
+        if (instant_tab_) {
           // The user is on a search results page. It may be showing results for
           // a partial query the user typed before they hit Escape. Send the
           // omnibox text to the page to restore the original results.
           //
           // In a tab switch, |instant_tab_| won't have updated yet, so it may
           // be pointing to the previous tab (which was a search results page).
           // Ensure we don't send the omnibox text to a random webpage (the new
           // tab), by comparing the old and new WebContents.
           if (escape_pressed &&
               instant_tab_->contents() == browser_->GetActiveWebContents()) {
             instant_tab_->Submit(full_text);
           }
         } else if (!full_text.empty()) {
           // If |full_text| is empty, the user is on the NTP. The overlay may
           // be showing custom NTP content; hide only if that's not the case.
           HideOverlay();
         }
       } else if (full_text.empty()) {
         // The user is typing, and backspaced away all omnibox text. Clear
         // |last_omnibox_text_| so that we don't attempt to set suggestions.
         last_omnibox_text_.clear();
         last_user_text_.clear();
         last_suggestion_ = InstantSuggestion();
-        if (UseInstantTabToShowSuggestions()) {
+        if (instant_tab_) {
           // On a search results page, tell it to clear old results.
           instant_tab_->Update(string16(), 0, 0, true);
         } else if (search_mode_.is_origin_ntp()) {
           // On the NTP, tell the overlay to clear old results. Don't hide the
           // overlay so it can show a blank page or logo if it wants.
           overlay_->Update(string16(), 0, 0, true);
         } else {
           HideOverlay();
         }
       } else {
         // The user switched to a tab with partial text already in the omnibox.
         HideOverlay();
 
         // The new tab may or may not be a search results page; we don't know
         // since SearchModeChanged() hasn't been called yet. If it later turns
         // out to be, we should store |full_text| now, so that if the user hits
         // Enter, we'll send the correct query to instant_tab_->Submit(). If the
         // partial text is not a query (|last_match_was_search_| is false), we
         // won't Submit(), so no need to worry about that.
         last_omnibox_text_ = full_text;
         last_user_text_ = user_text;
         last_suggestion_ = InstantSuggestion();
       }
       return false;
     } else if (full_text.empty()) {
       // The user typed a solitary "?". Same as the backspace case above.
       last_omnibox_text_.clear();
       last_user_text_.clear();
       last_suggestion_ = InstantSuggestion();
-      if (UseInstantTabToShowSuggestions())
+      if (instant_tab_)
         instant_tab_->Update(string16(), 0, 0, true);
       else if (search_mode_.is_origin_ntp())
         overlay_->Update(string16(), 0, 0, true);
       else
         HideOverlay();
       return false;
     }
   } else if (!omnibox_popup_is_open || full_text.empty()) {
     // In the non-extended case, hide the overlay as long as the user isn't
     // actively typing a non-empty query.
@@ skipping 34 matching lines @@
   last_verbatim_ = verbatim;
 
   last_transition_type_ = match.transition;
   url_for_history_ = match.destination_url;
 
   // Allow search suggestions. In extended mode, SearchModeChanged() will set
   // this, but it's not called in non-extended mode, so fake it.
   if (!extended_enabled_)
     search_mode_.mode = SearchMode::MODE_SEARCH_SUGGESTIONS;
 
-  if (UseInstantTabToShowSuggestions()) {
+  if (instant_tab_) {
     // If we have an |instant_tab_| but it doesn't support Instant yet, sever
     // the connection to it so we use the overlay instead. This ensures that the
     // user interaction will be responsive and handles cases where
     // |instant_tab_| never responds about whether it supports Instant.
     if (instant_tab_->supports_instant())
       instant_tab_->Update(user_text, selection_start, selection_end, verbatim);
     else
       instant_tab_.reset();
   }
 
-  if (!UseInstantTabToShowSuggestions()) {
+  if (!instant_tab_) {
     if (first_interaction_time_.is_null())
       first_interaction_time_ = base::Time::Now();
     allow_overlay_to_show_search_suggestions_ = true;
 
     // For extended mode, if the loader is not ready at this point, switch over
     // to a backup loader.
     if (extended_enabled_ && !overlay_->supports_instant() &&
-        !overlay_->IsLocalOverlay() && browser_->GetActiveWebContents()) {
-      CreateOverlay(chrome::kChromeSearchLocalOmniboxPopupURL,
+        !overlay_->IsLocal() && browser_->GetActiveWebContents()) {
+      CreateOverlay(chrome::GetLocalInstantURL(browser_->profile()).spec(),
                     browser_->GetActiveWebContents());
     }
 
     overlay_->Update(extended_enabled_ ? user_text : full_text,
                      selection_start, selection_end, verbatim);
   }
 
   content::NotificationService::current()->Notify(
       chrome::NOTIFICATION_INSTANT_CONTROLLER_UPDATED,
       content::Source<InstantController>(this),
       content::NotificationService::NoDetails());
 
   // We don't have new suggestions yet, but we can either reuse the existing
   // suggestion or reset the existing "gray text".
   browser_->SetInstantSuggestion(last_suggestion_);
 
   return true;
 }
 
 scoped_ptr<content::WebContents> InstantController::ReleaseNTPContents() {
   if (!extended_enabled_ || !browser_->profile() ||
       browser_->profile()->IsOffTheRecord())
     return scoped_ptr<content::WebContents>(NULL);
 
   LOG_INSTANT_DEBUG_EVENT(this, "ReleaseNTPContents");
 
   // Switch to the local NTP unless we're already using one.
-  if (!ntp_ || (ShouldSwitchToLocalNTP() && !ntp_->IsLocalNTP()))
+  if (!ntp_ || (ShouldSwitchToLocalNTP() && !ntp_->IsLocal()))

[samarth, 2013/04/17 00:19:34]

There is a bug here.  To reproduce:
0) Enable local-only...
1) Open NTP
2) Switch search provider to Yahoo
3) Open NTP

You'll get the Google local NTP in step 3.  You can fix this by changing the
!ntp->IsLocal() check to ntp_->instant_url() != GetLocalInstantURL().  In other
words, you do want to reload the local NTP if its URL has changed.  (I'd just
move this clause into ShouldSwitchToLocalNTP().  Note also that you will need to
add an instant_url() member to InstantNTP, like the one that exists for
InstantOverlay.)

[jeremycho, 2013/04/17 00:59:23]

Done.  Bug seems fixed.

     ResetNTP(false, true);
 
   scoped_ptr<content::WebContents> ntp_contents = ntp_->ReleaseContents();
 
   // Override the blacklist on an explicit user action.
   ResetNTP(true, false);
   return ntp_contents.Pass();
 }
 
 // TODO(tonyg): This method only fires when the omnibox bounds change. It also
@@ skipping 41 matching lines @@
   // as it stops autocomplete. Ignore these.
   if (omnibox_focus_state_ == OMNIBOX_FOCUS_NONE)
     return;
 
   DVLOG(1) << "AutocompleteResults:";
   std::vector<InstantAutocompleteResult> results;
   for (ACProviders::const_iterator provider = providers.begin();
        provider != providers.end(); ++provider) {
     const bool from_search_provider =
         (*provider)->type() == AutocompleteProvider::TYPE_SEARCH;
-    // Unless we are talking to the local overlay, skip SearchProvider, since
-    // it only echoes suggestions.
-    if (from_search_provider &&
-        (UseInstantTabToShowSuggestions() || !overlay_->IsLocalOverlay()))
+    const bool using_local_page =
+        (instant_tab_ && instant_tab_->IsLocal()) || overlay_->IsLocal();
+    // Unless we are talking to a local page, skip SearchProvider, since it only
+    // echoes suggestions.
+    if (from_search_provider && !using_local_page)
       continue;
     // Only send autocomplete results when all the providers are done. Skip
     // this check for the SearchProvider, since it isn't done until the page
     // calls SetSuggestions (causing SearchProvider::FinalizeInstantQuery() to
     // be called), which makes it a chicken-and-egg thing.
     if (!from_search_provider && !(*provider)->done()) {
       DVLOG(1) << "Waiting for " << (*provider)->GetName();
       return;
     }
     for (ACMatches::const_iterator match = (*provider)->matches().begin();
@@ skipping 11 matching lines @@
                << result.provider << " " << result.destination_url << " '"
                << result.description << "' '" << result.search_query << "' "
                << result.transition;
       results.push_back(result);
     }
   }
   LOG_INSTANT_DEBUG_EVENT(this, base::StringPrintf(
       "HandleAutocompleteResults: total_results=%d",
       static_cast<int>(results.size())));
 
-  if (UseInstantTabToShowSuggestions())
+  if (instant_tab_)
     instant_tab_->SendAutocompleteResults(results);
   else
     overlay_->SendAutocompleteResults(results);
 }
 
 bool InstantController::OnUpOrDownKeyPressed(int count) {
   if (!extended_enabled_)
     return false;
 
   if (!instant_tab_ && !overlay_)
     return false;
 
-  if (UseInstantTabToShowSuggestions())
+  if (instant_tab_)
     instant_tab_->UpOrDownKeyPressed(count);
   else
     overlay_->UpOrDownKeyPressed(count);
 
   return true;
 }
 
 void InstantController::OnCancel(const AutocompleteMatch& match,
                                  const string16& user_text,
                                  const string16& full_text) {
   if (!extended_enabled_)
     return;
 
   if (!instant_tab_ && !overlay_)
     return;
 
   // We manually reset the state here since the JS is not expected to do it.
   // TODO(sreeram): Handle the case where user_text is now a URL
   last_match_was_search_ = AutocompleteMatch::IsSearchType(match.type) &&
                            !full_text.empty();
   last_omnibox_text_ = full_text;
   last_user_text_ = user_text;
   last_suggestion_ = InstantSuggestion();
 
   // Say |full_text| is "amazon.com" and |user_text| is "ama". This means the
   // inline autocompletion is "zon.com"; so the selection should span from
   // user_text.size() to full_text.size(). The selection bounds are inverted
   // because the caret is at the end of |user_text|, not |full_text|.
-  if (UseInstantTabToShowSuggestions()) {
+  if (instant_tab_) {
     instant_tab_->CancelSelection(user_text, full_text.size(), user_text.size(),
                                   last_verbatim_);
   } else {
     overlay_->CancelSelection(user_text, full_text.size(), user_text.size(),
                               last_verbatim_);
   }
 }
 
 void InstantController::OmniboxNavigateToURL() {
   if (!extended_enabled_)
@@ skipping 18 matching lines @@
     return false;
 
   LOG_INSTANT_DEBUG_EVENT(this, base::StringPrintf(
       "CommitIfPossible: type=%d last_omnibox_text_='%s' "
       "last_match_was_search_=%d instant_tab_=%d", type,
       UTF16ToUTF8(last_omnibox_text_).c_str(), last_match_was_search_,
       instant_tab_ != NULL));
 
   // If we are on an already committed search results page, send a submit event
   // to the page, but otherwise, nothing else to do.
-  if (UseInstantTabToShowSuggestions()) {
+  if (instant_tab_) {
     if (type == INSTANT_COMMIT_PRESSED_ENTER &&
+        !instant_tab_->IsLocal() &&
         (last_match_was_search_ ||
          last_suggestion_.behavior == INSTANT_COMPLETE_NEVER)) {
       last_suggestion_.text.clear();
       instant_tab_->Submit(last_omnibox_text_);
       instant_tab_->contents()->GetView()->Focus();
       EnsureSearchTermsAreSet(instant_tab_->contents(), last_omnibox_text_);
       return true;
     }
     return false;
   }
 
   // If the overlay is not showing at all, don't commit it.
   if (!model_.mode().is_search_suggestions())
     return false;
 
   // If the overlay is showing at full height (with results), commit it.
   // If it's showing at parial height, commit if it's navigating.
   if (!IsOverlayingSearchResults() && type != INSTANT_COMMIT_NAVIGATED)
     return false;
 
   // There may re-entrance here, from the call to browser_->CommitInstant below,
   // which can cause a TabDeactivated notification which gets back here.
   // In this case, overlay_->ReleaseContents() was called already.
   if (!GetOverlayContents())
     return false;
 
   // Never commit the local overlay.
-  if (overlay_->IsLocalOverlay())
+  if (overlay_->IsLocal())
     return false;
 
   if (type == INSTANT_COMMIT_FOCUS_LOST) {
     // Extended mode doesn't need or use the Cancel message.
     if (!extended_enabled_)
       overlay_->Cancel(last_omnibox_text_);
   } else if (type != INSTANT_COMMIT_NAVIGATED) {
     overlay_->Submit(last_omnibox_text_);
   }
 
@@ skipping 211 matching lines @@
 #if defined(USE_AURA)
   // On aura the omnibox only receives a focus lost if we initiate the focus
   // change. This does that.
   if (!model_.mode().is_default())
     browser_->InstantOverlayFocused();
 #endif
 }
 
 void InstantController::ReloadOverlayIfStale() {
   // The local overlay is never stale.
-  if (overlay_ && overlay_->IsLocalOverlay())
+  if (overlay_ && overlay_->IsLocal())
     return;
 
   // If the overlay is showing or the omnibox has focus, don't delete the
   // overlay. It will get refreshed the next time the overlay is hidden or the
   // omnibox loses focus.
   if ((!overlay_ || overlay_->is_stale()) &&
       omnibox_focus_state_ == OMNIBOX_FOCUS_NONE &&
       model_.mode().is_default()) {
     overlay_.reset();
     EnsureOverlayIsCurrent(false);
@@ skipping 169 matching lines @@
 }
 
 void InstantController::SetSuggestions(
     const content::WebContents* contents,
     const std::vector<InstantSuggestion>& suggestions) {
   LOG_INSTANT_DEBUG_EVENT(this, "SetSuggestions");
 
   // Ignore if the message is from an unexpected source.
   if (IsContentsFrom(ntp(), contents))
     return;
-  if (UseInstantTabToShowSuggestions() &&
-      !IsContentsFrom(instant_tab(), contents))
+  if (instant_tab_ && !IsContentsFrom(instant_tab(), contents))
     return;
   if (IsContentsFrom(overlay(), contents) &&
       !allow_overlay_to_show_search_suggestions_)
     return;
 
   InstantSuggestion suggestion;
   if (!suggestions.empty())
     suggestion = suggestions[0];
 
   // TODO(samarth): allow InstantTabs to call SetSuggestions() from the NTP once
   // that is better supported.
-  bool can_use_instant_tab = UseInstantTabToShowSuggestions() &&
-      search_mode_.is_search();
+  bool can_use_instant_tab = instant_tab_ && search_mode_.is_search();
   bool can_use_overlay = search_mode_.is_search_suggestions() &&
       !last_omnibox_text_.empty();
   if (!can_use_instant_tab && !can_use_overlay)
     return;
 
   if (suggestion.behavior == INSTANT_COMPLETE_REPLACE) {
     // We don't get an Update() when changing the omnibox due to a REPLACE
     // suggestion (so that we don't inadvertently cause the overlay to change
     // what it's showing, as the user arrows up/down through the page-provided
     // suggestions). So, update these state variables here.
@@ skipping 114 matching lines @@
   else if (!IsViewInContents(GetViewGainingFocus(view_gaining_focus),
                              overlay_->contents()))
     HideOverlay();
 #endif
 }
 
 void InstantController::ResetNTP(bool ignore_blacklist, bool use_local_ntp) {
   std::string instant_url;
   if (use_local_ntp ||
       !GetInstantURL(browser_->profile(), ignore_blacklist, &instant_url))
-    instant_url = chrome::kChromeSearchLocalNtpUrl;
+    instant_url = chrome::GetLocalInstantURL(browser_->profile()).spec();
   ntp_.reset(new InstantNTP(this, instant_url));
   ntp_->InitContents(browser_->profile(), browser_->GetActiveWebContents(),
                      base::Bind(&InstantController::ResetNTP,
                                 base::Unretained(this), false, false));
 }
 
 bool InstantController::EnsureOverlayIsCurrent(bool ignore_blacklist) {
   // If there's no active tab, the browser is closing.
   const content::WebContents* active_tab = browser_->GetActiveWebContents();
   if (!active_tab)
     return false;
 
   Profile* profile = Profile::FromBrowserContext(
       active_tab->GetBrowserContext());
   std::string instant_url;
   if (!GetInstantURL(profile, ignore_blacklist, &instant_url)) {
     // If we are in extended mode, fallback to the local overlay.
     if (extended_enabled_)
-      instant_url = chrome::kChromeSearchLocalOmniboxPopupURL;
+      instant_url = chrome::GetLocalInstantURL(browser_->profile()).spec();
     else
       return false;
   }
 
   if (!overlay_ || overlay_->instant_url() != instant_url)
     CreateOverlay(instant_url, active_tab);
 
   return true;
 }
 
@@ skipping 61 matching lines @@
     // Send a message asking the overlay to clear out old results.
     overlay_->Update(string16(), 0, 0, true);
   }
 
   // Clear the first interaction timestamp for later use.
   first_interaction_time_ = base::Time();
 }
 
 void InstantController::ShowOverlay(int height, InstantSizeUnits units) {
   // If we are on a committed search results page, the |overlay_| is not in use.
-  if (UseInstantTabToShowSuggestions())
+  if (instant_tab_)
     return;
 
   LOG_INSTANT_DEBUG_EVENT(this, base::StringPrintf(
       "Show: height=%d units=%d", height, units));
 
   // Must have updated omnibox after the last HideOverlay() to show suggestions.
   if (!allow_overlay_to_show_search_suggestions_)
     return;
 
   // The page is trying to hide itself. Hide explicitly (i.e., don't use
   // HideOverlay()) so that it can change its mind.
   if (height == 0) {
     model_.SetOverlayState(SearchMode(), 0, INSTANT_SIZE_PERCENT);
     return;
   }
 
   // If the overlay is being shown for the first time since the user started
   // typing, record a histogram value.
   if (!first_interaction_time_.is_null() && model_.mode().is_default()) {
     base::TimeDelta delta = base::Time::Now() - first_interaction_time_;
     UMA_HISTOGRAM_TIMES("Instant.TimeToFirstShow", delta);
   }
 
   // Show at 100% height except in the following cases:
   // - The local overlay (omnibox popup) is being loaded.
   // - Instant is disabled. The page needs to be able to show only a dropdown.
   // - The page is over a website other than search or an NTP, and is not
   //   already showing at 100% height.
-  if (overlay_->IsLocalOverlay() || !instant_enabled_ ||
+  if (overlay_->IsLocal() || !instant_enabled_ ||
       (search_mode_.is_origin_default() && !IsFullHeight(model_)))
     model_.SetOverlayState(search_mode_, height, units);
   else
     model_.SetOverlayState(search_mode_, 100, INSTANT_SIZE_PERCENT);
 
   // If the overlay is being shown at full height and the omnibox is not
   // focused, commit right away.
   if (IsFullHeight(model_) && omnibox_focus_state_ == OMNIBOX_FOCUS_NONE)
     CommitIfPossible(INSTANT_COMMIT_FOCUS_LOST);
 }
@@ skipping 195 matching lines @@
       // suggest 'nstant'. Otherwise, the user text really isn't a prefix, so
       // suggest nothing.
       // TODO(samarth|jered): revisit this logic. http://crbug.com/196572.
       return true;
     }
   }
 
   return false;
 }
 
-bool InstantController::UseInstantTabToShowSuggestions() const {
-  return instant_tab_ && !instant_tab_->IsLocalNTP();
-}
-
 bool InstantController::ShouldSwitchToLocalNTP() const {
   // If there is no Instant URL or the NTP is stale, switch.
   std::string instant_url;
   if (!GetInstantURL(browser_->profile(), false, &instant_url) ||
       !chrome::MatchesOriginAndPath(GURL(ntp_->instant_url()),
                                     GURL(instant_url))) {
     return true;
   }
 
   if (ntp_->supports_instant())
     return false;
 
   // If this is not window startup, switch.
   // TODO(shishir): This is not completely reliable. Find a better way to detect
   // startup time.
   if (browser_->GetActiveWebContents())
     return true;
 
   return chrome::IsAggressiveLocalNTPFallbackEnabled();
 }