Store xsrf token received with psuggest results.

chrome/browser/autocomplete/search_provider.h

 // Copyright (c) 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.
 //
 // This file contains the Search autocomplete provider.  This provider is
 // responsible for all autocomplete entries that start with "Search <engine>
 // for ...", including searching for the current input string, search
 // history, and search suggestions.  An instance of it gets created and
 // managed by the autocomplete controller.
 
@@ skipping 40 matching lines @@
 // suggestions.
 class SearchProvider : public AutocompleteProvider,
                        public net::URLFetcherDelegate {
  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;
+
   SearchProvider(AutocompleteProviderListener* listener, Profile* profile);
 
   // Returns an AutocompleteMatch with the given |autocomplete_provider|,
   // |relevance|, and |type|, which represents a search via |template_url| for
   // |query_string|.  If |template_url| is NULL, returns a match with an invalid
   // destination URL.
   //
   // |input_text| is the original user input, which may differ from
   // |query_string|; e.g. the user typed "foo" and got a search suggestion of
   // "food", which we're now marking up.  This is used to highlight portions of
@@ skipping 25 matching lines @@
   // Returns whether the SearchProvider previously flagged |match| as a query
   // that should be prefetched.
   static bool ShouldPrefetch(const AutocompleteMatch& match);
 
   // Extracts the suggest response metadata which SearchProvider previously
   // stored for |match|.
   static std::string GetSuggestMetadata(const AutocompleteMatch& match);
 
   // AutocompleteProvider:
   virtual void AddProviderInfo(ProvidersInfo* provider_info) const OVERRIDE;
+  virtual void DeleteMatch(const AutocompleteMatch& match) OVERRIDE;
   virtual void ResetSession() OVERRIDE;
 
   bool field_trial_triggered_in_session() const {
     return field_trial_triggered_in_session_;
   }
 
   // This URL may be sent with suggest requests; see comments on CanSendURL().
   void set_current_page_url(const GURL& current_page_url) {
     current_page_url_ = current_page_url;
   }
 
  private:
   // TODO(hfung): Remove ZeroSuggestProvider as a friend class after
   // refactoring common code to a new base class.
   friend class SearchProviderTest;
   friend class ZeroSuggestProvider;
   FRIEND_TEST_ALL_PREFIXES(SearchProviderTest, CanSendURL);
   FRIEND_TEST_ALL_PREFIXES(SearchProviderTest, NavigationInline);
   FRIEND_TEST_ALL_PREFIXES(SearchProviderTest, NavigationInlineDomainClassify);
   FRIEND_TEST_ALL_PREFIXES(SearchProviderTest, NavigationInlineSchemeSubstring);
   FRIEND_TEST_ALL_PREFIXES(SearchProviderTest, RemoveStaleResultsTest);
   FRIEND_TEST_ALL_PREFIXES(SearchProviderTest, SuggestRelevanceExperiment);
+  FRIEND_TEST_ALL_PREFIXES(SearchProviderTest,
+                           TestDeleteMatch_HasDeletionUrlSuccess);
+  FRIEND_TEST_ALL_PREFIXES(SearchProviderTest,
+                           TestDeleteMatch_HasDeletionUrlFailure);
   FRIEND_TEST_ALL_PREFIXES(AutocompleteProviderTest, GetDestinationURL);
   FRIEND_TEST_ALL_PREFIXES(InstantExtendedPrefetchTest, ClearPrefetchedResults);
   FRIEND_TEST_ALL_PREFIXES(InstantExtendedPrefetchTest, SetPrefetchQuery);
 
   // Manages the providers (TemplateURLs) used by SearchProvider. Two providers
   // may be used:
   // . The default provider. This corresponds to the user's default search
   //   engine. This is always used, except for the rare case of no default
   //   engine.
   // . The keyword provider. This is used if the user has typed in a keyword.
@@ skipping 88 matching lines @@
     // there.
     bool relevance_from_server_;
   };
 
   class SuggestResult : public Result {
    public:
     SuggestResult(const string16& suggestion,
                   const string16& match_contents,
                   const string16& annotation,
                   const std::string& suggest_query_params,
+                  const std::string& deletion_url,
                   bool from_keyword_provider,
                   int relevance,
                   bool relevance_from_server,
                   bool should_prefetch);
     virtual ~SuggestResult();
 
     const string16& suggestion() const { return suggestion_; }
     const string16& match_contents() const { return match_contents_; }
     const string16& annotation() const { return annotation_; }
     const std::string& suggest_query_params() const {
       return suggest_query_params_;
     }
+    const std::string& deletion_url() const { return deletion_url_; }
     bool should_prefetch() const { return should_prefetch_; }
 
     // Result:
     virtual bool IsInlineable(const string16& input) const OVERRIDE;
     virtual int CalculateRelevance(
         const AutocompleteInput& input,
         bool keyword_provider_requested) const OVERRIDE;
 
    private:
     // The search terms to be used for this suggestion.
     string16 suggestion_;
 
     // The contents to be displayed in the autocomplete match.
     string16 match_contents_;
 
     // Optional annotation for the |match_contents_| for disambiguation.
     // This may be displayed in the autocomplete match contents, but is defined
     // separately to facilitate different formatting.
     string16 annotation_;
 
     // Optional additional parameters to be added to the search URL.
     std::string suggest_query_params_;
 
+    // Optional deletion url provided with psuggest results to delete a

[Peter Kasting, 2013/11/23 00:08:43]

Nit: Don't use "psuggest" in code (not a well-understood phrase).  How about:

Optional deletion URL provided with suggestions.  Fetching this URL should
result in some reasonable deletion behavior on the server, e.g. deleting this
term out of a user's server-side search history.

[Maria, 2013/11/26 02:36:27]

Done.

+    // particular suggestion from personal history.
+    std::string deletion_url_;
+
     // Should this result be prefetched?
     bool should_prefetch_;
   };
 
   class NavigationResult : public Result {
    public:
     // |provider| is necessary to use StringForURLDisplay() in order to
     // compute |formatted_url_|.
     NavigationResult(const AutocompleteProvider& provider,
                      const GURL& url,
@@ skipping 61 matching lines @@
     // suppresses the verbatim result.
     int verbatim_relevance;
 
     // The JSON metadata associated with this server response.
     std::string metadata;
 
    private:
     DISALLOW_COPY_AND_ASSIGN(Results);
   };
 
+  class SuggestionDeletionHandler : public net::URLFetcherDelegate {

[Peter Kasting, 2013/11/23 00:08:43]

Declare this class in the .cc file, since nothing else in this header needs it.

Add a comment above the class describing briefly what it's for and how it's
used.

[Maria, 2013/11/26 02:36:27]

Since I added a ScopedVector<SuggestionDeletionHandler> I need it in the header
class now.

Added a comment.

[Peter Kasting, 2013/11/26 02:46:22]

You can just forward-declare for that, you don't need the whole declaration. 
When you do, don't use a member class anyway; member classes are generally
discouraged and the use of so many here in SearchProvider is probably a bad
thing.

[Maria, 2013/11/27 02:18:06]

Done.

+   public:
+    SuggestionDeletionHandler();
+    virtual void StartRequest(const std::string& deletion_url, Profile* profile,

[Peter Kasting, 2013/11/23 00:08:43]

Nit: One arg per line

Is this an override?  If so, you should say OVERRIDE, and put a "//
net::URLFetcherDelegate:" comment above it. (Put a blank line above said
comment.)

[Maria, 2013/11/26 02:36:27]

Done with args. this is not an override.

[Peter Kasting, 2013/11/26 02:46:22]

Why is it virtual then?

+                              const base::Callback<void(bool)>& callback);
+   private:

[Peter Kasting, 2013/11/23 00:08:43]

Nit: Blank line above this

[Maria, 2013/11/26 02:36:27]

Done.

+    // The class takes care of deleting itself when it's done.

[Peter Kasting, 2013/11/23 00:08:43]

Nit: This kind of comment should either be stated in the above-class class-level
comment or not at all.

[Maria, 2013/11/26 02:36:27]

Done.

+    virtual ~SuggestionDeletionHandler();
+    virtual void OnURLFetchComplete(const net::URLFetcher* source) OVERRIDE;

[Peter Kasting, 2013/11/23 00:08:43]

Nit: Again, put a blank line and a parent-class comment above this as in the
public section.

[Maria, 2013/11/26 02:36:27]

Done.

+    scoped_ptr<net::URLFetcher> deletion_fetcher_;

[Peter Kasting, 2013/11/23 00:08:43]

Nit: Blank line above this

[Maria, 2013/11/26 02:36:27]

Done.

+    base::Callback<void(bool)> callback_;
+
+    DISALLOW_COPY_AND_ASSIGN(SuggestionDeletionHandler);
+  };
+
   virtual ~SearchProvider();
 
   // Removes non-inlineable results until either the top result can inline
   // autocomplete the current input or verbatim outscores the top result.
   static void RemoveStaleResults(const string16& input,
                                  int verbatim_relevance,
                                  SuggestResults* suggest_results,
                                  NavigationResults* navigation_results);
 
   // Calculates the relevance score for the keyword verbatim result (if the
   // input matches one of the profile's keyword).
   static int CalculateRelevanceForKeywordVerbatim(AutocompleteInput::Type type,
                                                   bool prefer_keyword);
 
   // AutocompleteProvider:
   virtual void Start(const AutocompleteInput& input,
                      bool minimal_changes) OVERRIDE;
   virtual void Stop(bool clear_cached_results) OVERRIDE;
 
   // net::URLFetcherDelegate:
   virtual void OnURLFetchComplete(const net::URLFetcher* source) OVERRIDE;
 
+  // Callback for deletion request

[Peter Kasting, 2013/11/23 00:08:43]

Nit: This comment is too vague, and doesn't have trailing punctuation.

[Maria, 2013/11/26 02:36:27]

Done.

+  virtual void OnDeletionComplete(bool success);
+
+  // Removes the deleted match from the list of matches.

[Peter Kasting, 2013/11/23 00:08:43]

Nit: ...from |matches_|.

[Maria, 2013/11/26 02:36:27]

Done.

+  virtual void DeleteMatchFromMatches(const AutocompleteMatch& match);
+
   // Called when timer_ expires.
   void Run();
 
   // Runs the history query, if necessary. The history query is synchronous.
   // This does not update |done_|.
   void DoHistoryQuery(bool minimal_changes);
 
   // Determines whether an asynchronous subcomponent query should run for the
   // current input.  If so, starts it if necessary; otherwise stops it.
   // NOTE: This function does not update |done_|.  Callers must do so.
@@ skipping 126 matching lines @@
                      bool relevance_from_server,
                      bool should_prefetch,
                      const std::string& metadata,
                      AutocompleteMatch::Type type,
                      bool is_keyword,
                      const string16& match_contents,
                      const string16& annotation,
                      const string16& query_string,
                      int accepted_suggestion,
                      const std::string& suggest_query_params,
+                     const std::string& deletion_url,
                      MatchMap* map);
 
   // Returns an AutocompleteMatch for a navigational suggestion.
   AutocompleteMatch NavigationToMatch(const NavigationResult& navigation);
 
   // Resets the scores of all |keyword_navigation_results_| matches to
   // be below that of the top keyword query match (the verbatim match
   // as expressed by |keyword_verbatim_relevance_| or keyword query
   // suggestions stored in |keyword_suggest_results_|).  If there
   // are no keyword suggestions and keyword verbatim is suppressed,
@@ skipping 44 matching lines @@
   // were server-provided using this key in the |additional_info| field.
   static const char kRelevanceFromServerKey[];
 
   // Indicates whether the server said a match should be prefetched.
   static const char kShouldPrefetchKey[];
 
   // Used to store metadata from the server response, which is needed for
   // prefetching.
   static const char kSuggestMetadataKey[];
 
+  // Used to store a deletion request url for psuggest autocomplete matches.

[Peter Kasting, 2013/11/23 00:08:43]

Nit: Don't use "psuggest"; try "for server-provided suggestions".

[Maria, 2013/11/26 02:36:27]

Done.

+  static const char kDeletionUrlKey[];
+
   // These are the values for the above keys.
   static const char kTrue[];
   static const char kFalse[];
 
   // Maintains the TemplateURLs used.
   Providers providers_;
 
   // The user's input.
   AutocompleteInput input_;
 
@@ skipping 38 matching lines @@
   // If true, search history query suggestions will score low enough that
   // they will not be inlined.
   bool prevent_search_history_inlining_;
 
   GURL current_page_url_;
 
   DISALLOW_COPY_AND_ASSIGN(SearchProvider);
 };
 
 #endif  // CHROME_BROWSER_AUTOCOMPLETE_SEARCH_PROVIDER_H_