Pass a RemovalCause to CookieChangedCallback

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 <memory>
@@ skipping 15 matching lines @@
 
 // An interface for storing and retrieving cookies. Implementations are not
 // thread safe, as with most other net classes. All methods must be invoked on
 // the network thread, and all callbacks will be calle there.
 //
 // All async functions may either invoke the callback asynchronously, or they
 // may be invoked immediately (prior to return of the asynchronous function).
 // Destroying the CookieStore will cancel pending async callbacks.
 class NET_EXPORT CookieStore {
  public:
+  // The publicly relevant reasons a cookie might be changed.
+  enum class ChangeCause {
+    // The cookie was inserted.
+    INSERTED,
+    // The cookie was changed directly by a consumer's action.
+    EXPLICIT,
+    // The cookie was deleted, but no more details are known.
+    UNKNOWN_DELETION,
+    // The cookie was automatically removed due to an insert operation that
+    // overwrote it.
+    OVERWRITE,
+    // The cookie was automatically removed as it expired.
+    EXPIRED,
+    // The cookie was automatically evicted during garbage collection.
+    EVICTED,
+    // The cookie was overwritten with an already-expired expiration date.
+    EXPIRED_OVERWRITE
+  };
+
+  static bool ChangeCauseIsDeletion(ChangeCause cause);

[mmenke, 2016/09/27 18:09:21]

Need to document this.

[nharper, 2016/09/27 21:50:53]

Done.

+
   // 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)>
+  typedef base::Callback<void(const CanonicalCookie& cookie, ChangeCause cause)>
       CookieChangedCallback;
-  typedef base::CallbackList<void(const CanonicalCookie& cookie, bool removed)>
+  typedef base::CallbackList<void(const CanonicalCookie& cookie,
+                                  ChangeCause cause)>
       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
@@ skipping 137 matching lines @@
   // cookies and a boolean indicating if the cookies was removed or not.
   //
   // Note that |callback| is called twice when a cookie is updated: once for
   // the removal of the existing cookie and once for the adding the new cookie.
   //
   // Note that this method consumes memory and CPU per (url, name) pair ever
   // registered that are still consumed even after all subscriptions for that
   // (url, name) pair are removed. If this method ever needs to support an
   // unbounded amount of such pairs, this contract needs to change and
   // implementors need to be improved to not behave this way.
+  //
+  // The callback must not synchronously modify another cookie.
   virtual std::unique_ptr<CookieChangedSubscription> AddCallbackForCookie(
       const GURL& url,
       const std::string& name,
       const CookieChangedCallback& callback) = 0;
 
   // Returns true if this cookie store is ephemeral, and false if it is backed
   // by some sort of persistence layer.
   // TODO(nharper): Remove this method once crbug.com/548423 has been closed.
   virtual bool IsEphemeral() = 0;
   void SetChannelIDServiceID(int id);
   int GetChannelIDServiceID();
 
  protected:
   CookieStore();
   int channel_id_service_id_;
 };
 
 }  // namespace net
 
 #endif  // NET_COOKIES_COOKIE_STORE_H_