Fix a number of problems with the GoogleURLTracker

chrome/browser/google/google_url_tracker.h

 // 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.
 
 #ifndef CHROME_BROWSER_GOOGLE_GOOGLE_URL_TRACKER_H_
 #define CHROME_BROWSER_GOOGLE_GOOGLE_URL_TRACKER_H_
 #pragma once
 
+#include <map>
 #include <string>
 
 #include "base/gtest_prod_util.h"
 #include "base/scoped_ptr.h"
 #include "chrome/browser/tab_contents/infobar_delegate.h"
 #include "chrome/common/net/url_fetcher.h"
 #include "chrome/common/notification_observer.h"
 #include "chrome/common/notification_registrar.h"
 #include "googleurl/src/gurl.h"
 #include "net/base/network_change_notifier.h"
 
+class GoogleURLTrackerInfoBarDelegate;
 class NavigationController;
 class PrefService;
 class TabContents;
 class TemplateURL;
 
 // This object is responsible for checking the Google URL once per network
 // change, and if necessary prompting the user to see if they want to change to
 // using it.  The current and last prompted values are saved to prefs.
 //
 // Most consumers should only call GoogleURL(), which is guaranteed to
@@ skipping 38 matching lines @@
 
   // Notifies the tracker that the user has started a Google search.
   // If prompting is necessary, we then listen for the subsequent
   // NAV_ENTRY_PENDING notification to get the appropriate NavigationController.
   // When the load commits, we'll show the infobar.
   static void GoogleURLSearchCommitted();
 
   static const char kDefaultGoogleHomepage[];
   static const char kSearchDomainCheckURL[];
 
-  // Methods called from InfoBar delegate.
+  // Methods called from GoogleURLTrackerInfoBarDelegate.
   void AcceptGoogleURL(const GURL& google_url);
   void CancelGoogleURL(const GURL& google_url);
-  void InfoBarClosed();
-  void RedoSearch();
+  void InfoBarClosed(GoogleURLTrackerInfoBarDelegate* infobar,
+                     TabContents* tab_contents);
 
  private:
   friend class GoogleURLTrackerTest;
 
-  typedef InfoBarDelegate* (*InfobarCreator)(TabContents*,
-                                             GoogleURLTracker*,
-                                             const GURL&);
+  typedef std::map<TabContents*, GoogleURLTrackerInfoBarDelegate*> Infobars;
+  typedef GoogleURLTrackerInfoBarDelegate* (*InfobarCreator)(
+      TabContents*,
+      const GURL&,
+      GoogleURLTracker*,
+      const GURL&);

[Ilya Sherman, 2010/11/16 00:17:47]

nit: Could you add comments describing the semantics of the two GURLs here?

[Ilya Sherman, 2010/11/16 00:19:57]

By which I mean something very brief, along the lines of

const GURL& /* search_url */

[Peter Kasting, 2010/11/16 00:38:23]

I'll go one better -- I just added the names directly, as apparently the
compiler doesn't mind.

 
   // Registers consumer interest in getting an updated URL from the server.
   // It will be notified as NotificationType::GOOGLE_URL_UPDATED, so the
   // consumer should observe this notification before calling this.
   void SetNeedToFetch();
 
   // Begins the five-second startup sleep period, unless a test has cleared
   // |queue_wakeup_task_|.
   void QueueWakeupTask();
 
@@ skipping 16 matching lines @@
   // NotificationObserver
   virtual void Observe(NotificationType type,
                        const NotificationSource& source,
                        const NotificationDetails& details);
 
   // NetworkChangeNotifier::Observer
   virtual void OnIPAddressChanged();
 
   void SearchCommitted();
   void OnNavigationPending(const NotificationSource& source,
+                           TabContents* tab_contents,
                            const GURL& pending_url);
-  void OnNavigationCommittedOrTabClosed(TabContents* tab_contents,
+  void OnNavigationCommittedOrTabClosed(const NotificationSource& source,
+                                        TabContents* tab_contents,
                                         NotificationType::Type type);
-  void ShowGoogleURLInfoBarIfNecessary(TabContents* tab_contents);
+  void CloseAllInfobars(bool redo_searches);
 
   NotificationRegistrar registrar_;
   InfobarCreator infobar_creator_;
   // TODO(ukai): GoogleURLTracker should track google domain (e.g. google.co.uk)
   // rather than URL (e.g. http://www.google.co.uk/), so that user could
   // configure to use https in search engine templates.
   GURL google_url_;
   GURL fetched_google_url_;
   ScopedRunnableMethodFactory<GoogleURLTracker> runnable_method_factory_;
   scoped_ptr<URLFetcher> fetcher_;
   int fetcher_id_;
   bool queue_wakeup_task_;
   bool in_startup_sleep_;  // True if we're in the five-second "no fetching"
                            // period that begins at browser start.
   bool already_fetched_;   // True if we've already fetched a URL once this run;
                            // we won't fetch again until after a restart.
   bool need_to_fetch_;     // True if a consumer actually wants us to fetch an
                            // updated URL.  If this is never set, we won't
                            // bother to fetch anything.
                            // Consumers should observe
                            // NotificationType::GOOGLE_URL_UPDATED.
   bool request_context_available_;
                            // True when the profile has been loaded and the
                            // default request context created, so we can
                            // actually do the fetch with the right data.
   bool need_to_prompt_;    // True if the last fetched Google URL is not
                            // matched with current user's default Google URL
                            // nor the last prompted Google URL.
-  NavigationController* controller_;
-  InfoBarDelegate* infobar_;
-  GURL search_url_;
+  Infobars infobars_;
 
   DISALLOW_COPY_AND_ASSIGN(GoogleURLTracker);
 };
 
 
 // This infobar delegate is declared here (rather than in the .cc file) so test
 // code can subclass it.
 class GoogleURLTrackerInfoBarDelegate : public ConfirmInfoBarDelegate {
  public:
   GoogleURLTrackerInfoBarDelegate(TabContents* tab_contents,
+                                  const GURL& search_url,
                                   GoogleURLTracker* google_url_tracker,
                                   const GURL& new_google_url);
 
   // ConfirmInfoBarDelegate
   virtual bool Accept();
   virtual bool Cancel();
   virtual void InfoBarClosed();
 
+  // These are virtual so test code can override them in a subclass.
+  virtual void Show();
+  virtual void Close(bool redo_search);
+
  protected:
   virtual ~GoogleURLTrackerInfoBarDelegate();
 
+  TabContents* tab_contents_;
+  const GURL search_url_;
   GoogleURLTracker* google_url_tracker_;
   const GURL new_google_url_;
+  bool showing_;  // True if this delegate has been added to a TabContents.
 
  private:
   // ConfirmInfoBarDelegate
   virtual string16 GetMessageText() const;
   virtual int GetButtons() const;
   virtual string16 GetButtonLabel(InfoBarButton button) const;
 
   DISALLOW_COPY_AND_ASSIGN(GoogleURLTrackerInfoBarDelegate);
 };
 
 #endif  // CHROME_BROWSER_GOOGLE_GOOGLE_URL_TRACKER_H_