Introduce AutocompleteProviderDelegate

chrome/browser/autocomplete/base_search_provider.h

 // Copyright 2014 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.
 //
 // This class contains common functionality for search-based autocomplete
 // providers. Search provider and zero suggest provider both use it for common
 // functionality.
 
 #ifndef CHROME_BROWSER_AUTOCOMPLETE_BASE_SEARCH_PROVIDER_H_
 #define CHROME_BROWSER_AUTOCOMPLETE_BASE_SEARCH_PROVIDER_H_
 
 #include <map>
 #include <string>
 #include <utility>
 #include <vector>
 
 #include "base/memory/scoped_vector.h"
 #include "base/strings/string16.h"
 #include "components/metrics/proto/omnibox_event.pb.h"
 #include "components/omnibox/autocomplete_input.h"
 #include "components/omnibox/autocomplete_match.h"
 #include "components/omnibox/autocomplete_provider.h"
 #include "components/omnibox/search_suggestion_parser.h"
 
+class AutocompleteProviderDelegate;
 class GURL;
-class Profile;
 class SearchTermsData;
 class SuggestionDeletionHandler;
 class TemplateURL;
 class TemplateURLService;
 
 namespace base {
 class DictionaryValue;
 class ListValue;
 class Value;
 }
 
 // Base functionality for receiving suggestions from a search engine.
 // This class is abstract and should only be used as a base for other
 // autocomplete providers utilizing its functionality.
 class BaseSearchProvider : public AutocompleteProvider {
  public:
   // ID used in creating URLFetcher for default provider's suggest results.
   static const int kDefaultProviderURLFetcherID;
 
   // ID used in creating URLFetcher for keyword provider's suggest results.
   static const int kKeywordProviderURLFetcherID;
 
   // ID used in creating URLFetcher for deleting suggestion results.
   static const int kDeletionURLFetcherID;
 
   BaseSearchProvider(TemplateURLService* template_url_service,
-                     Profile* profile,
+                     scoped_ptr<AutocompleteProviderDelegate> delegate,
                      AutocompleteProvider::Type type);
 
   // Returns whether |match| is flagged as a query that should be prefetched.
   static bool ShouldPrefetch(const AutocompleteMatch& match);
 
   // Returns a simpler AutocompleteMatch suitable for persistence like in
   // ShortcutsDatabase.  This wrapper function uses a number of default values
   // that may or may not be appropriate for your needs.
   // NOTE: Use with care. Most likely you want the other CreateSearchSuggestion
   // with protected access.
@@ skipping 74 matching lines @@
   // * The user has suggest enabled in their settings and is not in incognito
   //   mode.  (Incognito disables suggest entirely.)
   // * The user's suggest provider is Google.  We might want to allow other
   //   providers to see this data someday, but for now this has only been
   //   implemented for Google.
   static bool ZeroSuggestEnabled(
      const GURL& suggest_url,
      const TemplateURL* template_url,
      metrics::OmniboxEventProto::PageClassification page_classification,
      const SearchTermsData& search_terms_data,
-     Profile* profile);
+     AutocompleteProviderDelegate* delegate);
 
   // Returns whether we can send the URL of the current page in any suggest
   // requests.  Doing this requires that all the following hold:
   // * ZeroSuggestEnabled() is true, so we meet the requirements above.
   // * The current URL is HTTP, or HTTPS with the same domain as the suggest
   //   server.  Non-HTTP[S] URLs (e.g. FTP/file URLs) may contain sensitive
   //   information.  HTTPS URLs may also contain sensitive information, but if
   //   they're on the same domain as the suggest server, then the relevant
   //   entity could have already seen/logged this data.
   // * The user is OK in principle with sending URLs of current pages to their
   //   provider.  Today, there is no explicit setting that controls this, but if
   //   the user has tab sync enabled and tab sync is unencrypted, then they're
   //   already sending this data to Google for sync purposes.  Thus we use this
   //   setting as a proxy for "it's OK to send such data".  In the future,
   //   especially if we want to support suggest providers other than Google, we
   //   may change this to be a standalone setting or part of some explicit
   //   general opt-in.
   static bool CanSendURL(
       const GURL& current_page_url,
       const GURL& suggest_url,
       const TemplateURL* template_url,
       metrics::OmniboxEventProto::PageClassification page_classification,
       const SearchTermsData& search_terms_data,
-      Profile* profile);
+      AutocompleteProviderDelegate* delegate);
 
   // If the |deletion_url| is valid, then set |match.deletable| to true and
   // save the |deletion_url| into the |match|'s additional info under
   // the key |kDeletionUrlKey|.
   void SetDeletionURL(const std::string& deletion_url,
                       AutocompleteMatch* match);
 
   // Creates an AutocompleteMatch from |result| to search for the query in
   // |result|. Adds the created match to |map|; if such a match
   // already exists, whichever one has lower relevance is eliminated.
@@ skipping 31 matching lines @@
 
   // Returns whether the destination URL corresponding to the given |result|
   // should contain command-line-specified query params.
   virtual bool ShouldAppendExtraParams(
       const SearchSuggestionParser::SuggestResult& result) const = 0;
 
   // Records in UMA whether the deletion request resulted in success.
   virtual void RecordDeletionResult(bool success) = 0;
 
   TemplateURLService* template_url_service_;
-  Profile* profile_;
+  scoped_ptr<AutocompleteProviderDelegate> delegate_;
 
   // Whether a field trial, if any, has triggered in the most recent
   // autocomplete query. This field is set to true only if the suggestion
   // provider has completed and the response contained
   // '"google:fieldtrialtriggered":true'.
   bool field_trial_triggered_;
 
   // Same as above except that it is maintained across the current Omnibox
   // session.
   bool field_trial_triggered_in_session_;
@@ skipping 13 matching lines @@
 
   // Each deletion handler in this vector corresponds to an outstanding request
   // that a server delete a personalized suggestion. Making this a ScopedVector
   // causes us to auto-cancel all such requests on shutdown.
   SuggestionDeletionHandlers deletion_handlers_;
 
   DISALLOW_COPY_AND_ASSIGN(BaseSearchProvider);
 };
 
 #endif  // CHROME_BROWSER_AUTOCOMPLETE_BASE_SEARCH_PROVIDER_H_