[CookieStore] Upgrading host-based deleting to predicate-based deleting.

net/cookies/cookie_store.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.
 
 // Brought to you by number 42.
 
 #ifndef NET_COOKIES_COOKIE_STORE_H_
 #define NET_COOKIES_COOKIE_STORE_H_
 
 #include <string>
 #include <vector>
 
-#include "base/callback.h"
+#include "base/callback_forward.h"
 #include "base/callback_list.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/time/time.h"
 #include "net/base/net_export.h"
 #include "net/cookies/canonical_cookie.h"
 #include "net/cookies/cookie_options.h"
 
 class GURL;
 
 namespace net {
@@ skipping 12 matching lines @@
   // Callback definitions.
   typedef base::Callback<void(const CookieList& cookies)> GetCookieListCallback;
   typedef base::Callback<void(const std::string& cookie)> GetCookiesCallback;
   typedef base::Callback<void(bool success)> SetCookiesCallback;
   typedef base::Callback<void(int num_deleted)> DeleteCallback;
   typedef base::Callback<void(const CanonicalCookie& cookie, bool removed)>
       CookieChangedCallback;
   typedef base::CallbackList<void(const CanonicalCookie& cookie, bool removed)>
       CookieChangedCallbackList;
   typedef CookieChangedCallbackList::Subscription CookieChangedSubscription;
+  typedef base::Callback<bool(const CanonicalCookie& cookie)> CookiePredicate;
 
   virtual ~CookieStore();
 
   // Returns the cookie line (e.g. "cookie1=value1; cookie2=value2") represented
   // by |cookies|. The string is built in the same order as the given list.
   //
   // TODO(mkwst): We really should standardize on either
   // 'std::vector<CanonicalCookie>' or 'std::vector<CanonicalCookie*>'.
   static std::string BuildCookieLine(
       const std::vector<CanonicalCookie>& cookies);
   static std::string BuildCookieLine(
       const std::vector<CanonicalCookie*>& cookies);
 
+  // This creates a CookiePredicate that matches all host (NOT domain) cookies
+  // that match the host of |url|. This is intended to be used with
+  // DeleteAllCreatedBetweenWithPredicateAsync.
+  static CookiePredicate CreatePredicateForHostCookies(const GURL& url);

[Mike West, 2016/04/01 07:40:52]

This is only used by StoragePartition, right? Did you consider creating the
predicate there, rather than expanding CookieStore? I think I'd prefer to keep
CookieStore a bit leaner if there's not a good reason to put this here.

[dmurph, 2016/04/01 23:16:46]

Done.

+
   // Sets the cookies specified by |cookie_list| returned from |url|
   // with options |options| in effect.  Expects a cookie line, like
   // "a=1; domain=b.com".
   //
   // Fails either if the cookie is invalid or if this is a non-HTTPONLY cookie
   // and it would overwrite an existing HTTPONLY cookie.
   // Returns true if the cookie is successfully set.
   virtual void SetCookieWithOptionsAsync(
       const GURL& url,
       const std::string& cookie_line,
@@ skipping 74 matching lines @@
                                  const base::Closure& callback) = 0;
 
   // Deletes one specific cookie. |cookie| must have been returned by a previous
   // query on this CookieStore. Invokes |callback| with 1 if a cookie was
   // deleted, 0 otherwise.
   virtual void DeleteCanonicalCookieAsync(const CanonicalCookie& cookie,
                                           const DeleteCallback& callback) = 0;
 
   // Deletes all of the cookies that have a creation_date greater than or equal
   // to |delete_begin| and less than |delete_end|
-  // Returns the number of cookies that have been deleted.
+  // Calls |callback| with the number of cookies deleted.
   virtual void DeleteAllCreatedBetweenAsync(const base::Time& delete_begin,
                                             const base::Time& delete_end,
                                             const DeleteCallback& callback) = 0;
 
-  // Deletes all of the cookies that match the host of the given URL
-  // regardless of path and that have a creation_date greater than or
-  // equal to |delete_begin| and less then |delete_end|. This includes
-  // all http_only and secure cookies, but does not include any domain
-  // cookies that may apply to this host.
-  // Returns the number of cookies deleted.
-  virtual void DeleteAllCreatedBetweenForHostAsync(
-      const base::Time delete_begin,
-      const base::Time delete_end,
-      const GURL& url,
+  // Deletes all of the cookies that match the given predicate and that have a
+  // creation_date greater than or equal to |delete_begin| and less then
+  // |delete_end|. This includes all http_only and secure cookies. Make sure you
+  // know what you are doing here so you don't break the web.

[Mike West, 2016/04/01 07:40:52]

This warning isn't very helpful. :) What should developers avoid doing to avoid
breaking the web?

[dmurph, 2016/04/01 23:16:46]

Changed.

+  // Calls |callback| with the number of cookies deleted.
+  virtual void DeleteAllCreatedBetweenWithPredicateAsync(
+      const base::Time& delete_begin,
+      const base::Time& delete_end,
+      const CookiePredicate& predicate,
       const DeleteCallback& callback) = 0;
 
   virtual void DeleteSessionCookiesAsync(const DeleteCallback&) = 0;
 
   // Deletes all cookies in the store.
   void DeleteAllAsync(const DeleteCallback& callback);
 
   // Flush the backing store (if any) to disk and post the given callback when
   // done.
   virtual void FlushStore(const base::Closure& callback) = 0;
@@ skipping 32 matching lines @@
   int GetChannelIDServiceID();
 
  protected:
   CookieStore();
   int channel_id_service_id_;
 };
 
 }  // namespace net
 
 #endif  // NET_COOKIES_COOKIE_STORE_H_