src/chrome/browser/search/instant_service.h

   1 // Copyright 2013 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 #ifndef CHROME_BROWSER_SEARCH_INSTANT_SERVICE_H_
   6 #define CHROME_BROWSER_SEARCH_INSTANT_SERVICE_H_
   7
   8 #include <map>
   9 #include <set>
  10 #include <string>
  11 #include <vector>
  12
  13 #include "base/basictypes.h"
  14 #include "base/memory/ref_counted.h"
  15 #include "base/memory/scoped_ptr.h"
  16 #include "base/memory/weak_ptr.h"
  17 #include "base/observer_list.h"
  18 #include "base/prefs/pref_change_registrar.h"
  19 #include "chrome/browser/google/google_url_tracker.h"
  20 #include "chrome/browser/history/history_types.h"
  21 #include "chrome/browser/ui/search/instant_search_prerenderer.h"
  22 #include "chrome/common/instant_types.h"
  23 #include "components/browser_context_keyed_service/browser_context_keyed_service.h"
  24 #include "content/public/browser/notification_observer.h"
  25 #include "content/public/browser/notification_registrar.h"
  26
  27 class GURL;
  28 class InstantIOContext;
  29 class InstantServiceObserver;
  30 class InstantTestBase;
  31 class InstantServiceTest;
  32 class Profile;
  33 class ThemeService;
  34
  35 namespace content {
  36 class RenderProcessHost;
  37 }
  38
  39 namespace net {
  40 class URLRequest;
  41 }
  42
  43 // Tracks render process host IDs that are associated with Instant.
  44 class InstantService : public BrowserContextKeyedService,
  45                        public content::NotificationObserver {
  46  public:
  47   explicit InstantService(Profile* profile);
  48   virtual ~InstantService();
  49
  50   // Add, remove, and query RenderProcessHost IDs that are associated with
  51   // Instant processes.
  52   void AddInstantProcess(int process_id);
  53   bool IsInstantProcess(int process_id) const;
  54
  55   // Adds/Removes InstantService observers.
  56   void AddObserver(InstantServiceObserver* observer);
  57   void RemoveObserver(InstantServiceObserver* observer);
  58
  59 #if defined(UNIT_TEST)
  60   int GetInstantProcessCount() const {
  61     return process_ids_.size();
  62   }
  63 #endif
  64
  65   // Most visited item API.
  66
  67   // Invoked by the InstantController when the Instant page wants to delete a
  68   // Most Visited item.
  69   void DeleteMostVisitedItem(const GURL& url);
  70
  71   // Invoked by the InstantController when the Instant page wants to undo the
  72   // blacklist action.
  73   void UndoMostVisitedDeletion(const GURL& url);
  74
  75   // Invoked by the InstantController when the Instant page wants to undo all
  76   // Most Visited deletions.
  77   void UndoAllMostVisitedDeletions();
  78
  79   // Invoked by the InstantController to update theme information for NTP.
  80   //
  81   // TODO(kmadhusu): Invoking this from InstantController shouldn't be
  82   // necessary. Investigate more and remove this from here.
  83   void UpdateThemeInfo();
  84
  85   // Invoked by the InstantController to update most visited items details for
  86   // NTP.
  87   void UpdateMostVisitedItemsInfo();
  88
  89   // Sends the current set of search URLs to a renderer process.
  90   void SendSearchURLsToRenderer(content::RenderProcessHost* rph);
  91
  92   // Invoked to notify the Instant page that the omnibox start margin has
  93   // changed.
  94   void OnOmniboxStartMarginChanged(int start_margin);
  95
  96   InstantSearchPrerenderer* instant_search_prerenderer() {
  97     return instant_prerenderer_.get();
  98   }
  99
 100   int omnibox_start_margin() const { return omnibox_start_margin_; }
 101
 102  private:
 103   friend class InstantExtendedTest;
 104   friend class InstantServiceTest;
 105   friend class InstantTestBase;
 106   friend class InstantUnitTestBase;
 107
 108   FRIEND_TEST_ALL_PREFIXES(InstantExtendedManualTest,
 109                            MANUAL_SearchesFromFakebox);
 110   FRIEND_TEST_ALL_PREFIXES(InstantExtendedTest, ProcessIsolation);
 111   FRIEND_TEST_ALL_PREFIXES(InstantServiceTest, SendsSearchURLsToRenderer);
 112
 113   // Overridden from BrowserContextKeyedService:
 114   virtual void Shutdown() OVERRIDE;
 115
 116   // Overridden from content::NotificationObserver:
 117   virtual void Observe(int type,
 118                        const content::NotificationSource& source,
 119                        const content::NotificationDetails& details) OVERRIDE;
 120
 121   // Called when a renderer process is terminated.
 122   void OnRendererProcessTerminated(int process_id);
 123
 124   // Called when we get new most visited items from TopSites, registered as an
 125   // async callback. Parses them and sends them to the renderer via
 126   // SendMostVisitedItems.
 127   void OnMostVisitedItemsReceived(const history::MostVisitedURLList& data);
 128
 129   // Notifies the observer about the last known most visited items.
 130   void NotifyAboutMostVisitedItems();
 131
 132   // Theme changed notification handler.
 133   void OnThemeChanged(ThemeService* theme_service);
 134
 135   void OnGoogleURLUpdated(Profile* profile,
 136                           GoogleURLTracker::UpdatedDetails* details);
 137
 138   void OnDefaultSearchProviderChanged(const std::string& pref_name);
 139
 140   void ResetInstantSearchPrerenderer();
 141
 142   Profile* const profile_;
 143
 144   // The process ids associated with Instant processes.
 145   std::set<int> process_ids_;
 146
 147   // InstantMostVisitedItems sent to the Instant Pages.
 148   std::vector<InstantMostVisitedItem> most_visited_items_;
 149
 150   // Theme-related data for NTP overlay to adopt themes.
 151   scoped_ptr<ThemeBackgroundInfo> theme_info_;
 152
 153   // The start-edge margin of the omnibox, used by the Instant page to align
 154   // text or assets properly with the omnibox.
 155   int omnibox_start_margin_;
 156
 157   ObserverList<InstantServiceObserver> observers_;
 158
 159   content::NotificationRegistrar registrar_;
 160
 161   PrefChangeRegistrar profile_pref_registrar_;
 162
 163   scoped_refptr<InstantIOContext> instant_io_context_;
 164
 165   // Set to NULL if the default search provider does not support Instant.
 166   scoped_ptr<InstantSearchPrerenderer> instant_prerenderer_;
 167
 168   // Used for Top Sites async retrieval.
 169   base::WeakPtrFactory<InstantService> weak_ptr_factory_;
 170
 171   DISALLOW_COPY_AND_ASSIGN(InstantService);
 172 };
 173
 174 #endif  // CHROME_BROWSER_SEARCH_INSTANT_SERVICE_H_