netwerk/cookie/CookieStorage.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef mozilla_net_CookieStorage_h
   7 #define mozilla_net_CookieStorage_h
   8
   9 #include "CookieKey.h"
  10
  11 #include "nsIObserver.h"
  12 #include "nsTHashtable.h"
  13 #include "nsWeakReference.h"
  14 #include <functional>
  15 #include "CookieCommons.h"
  16
  17 class nsIArray;
  18 class nsICookie;
  19 class nsICookieTransactionCallback;
  20 class nsIPrefBranch;
  21
  22 namespace mozilla {
  23 namespace net {
  24
  25 class Cookie;
  26
  27 // Inherit from CookieKey so this can be stored in nsTHashTable
  28 // TODO: why aren't we using nsClassHashTable<CookieKey, ArrayType>?
  29 class CookieEntry : public CookieKey {
  30  public:
  31   // Hash methods
  32   using ArrayType = nsTArray<RefPtr<Cookie>>;
  33   using IndexType = ArrayType::index_type;
  34
  35   explicit CookieEntry(KeyTypePointer aKey) : CookieKey(aKey) {}
  36
  37   CookieEntry(const CookieEntry& toCopy) {
  38     // if we end up here, things will break. nsTHashtable shouldn't
  39     // allow this, since we set ALLOW_MEMMOVE to true.
  40     MOZ_ASSERT_UNREACHABLE("CookieEntry copy constructor is forbidden!");
  41   }
  42
  43   ~CookieEntry() = default;
  44
  45   inline ArrayType& GetCookies() { return mCookies; }
  46   inline const ArrayType& GetCookies() const { return mCookies; }
  47
  48   size_t SizeOfExcludingThis(MallocSizeOf aMallocSizeOf) const;
  49
  50  private:
  51   ArrayType mCookies;
  52 };
  53
  54 // stores the CookieEntry entryclass and an index into the cookie array within
  55 // that entryclass, for purposes of storing an iteration state that points to a
  56 // certain cookie.
  57 struct CookieListIter {
  58   // default (non-initializing) constructor.
  59   CookieListIter() = default;
  60
  61   // explicit constructor to a given iterator state with entryclass 'aEntry'
  62   // and index 'aIndex'.
  63   explicit CookieListIter(CookieEntry* aEntry, CookieEntry::IndexType aIndex)
  64       : entry(aEntry), index(aIndex) {}
  65
  66   // get the Cookie * the iterator currently points to.
  67   mozilla::net::Cookie* Cookie() const { return entry->GetCookies()[index]; }
  68
  69   CookieEntry* entry;
  70   CookieEntry::IndexType index;
  71 };
  72
  73 class CookieStorage : public nsIObserver, public nsSupportsWeakReference {
  74  public:
  75   NS_DECL_THREADSAFE_ISUPPORTS
  76   NS_DECL_NSIOBSERVER
  77
  78   size_t SizeOfIncludingThis(MallocSizeOf aMallocSizeOf) const;
  79
  80   void GetCookies(nsTArray<RefPtr<nsICookie>>& aCookies) const;
  81
  82   void GetSessionCookies(nsTArray<RefPtr<nsICookie>>& aCookies) const;
  83
  84   bool FindCookie(const nsACString& aBaseDomain,
  85                   const OriginAttributes& aOriginAttributes,
  86                   const nsACString& aHost, const nsACString& aName,
  87                   const nsACString& aPath, CookieListIter& aIter);
  88
  89   uint32_t CountCookiesFromHost(const nsACString& aBaseDomain,
  90                                 uint32_t aPrivateBrowsingId);
  91
  92   void GetAll(nsTArray<RefPtr<nsICookie>>& aResult) const;
  93
  94   const nsTArray<RefPtr<Cookie>>* GetCookiesFromHost(
  95       const nsACString& aBaseDomain, const OriginAttributes& aOriginAttributes);
  96
  97   void GetCookiesWithOriginAttributes(const OriginAttributesPattern& aPattern,
  98                                       const nsACString& aBaseDomain,
  99                                       nsTArray<RefPtr<nsICookie>>& aResult);
 100
 101   void RemoveCookie(const nsACString& aBaseDomain,
 102                     const OriginAttributes& aOriginAttributes,
 103                     const nsACString& aHost, const nsACString& aName,
 104                     const nsACString& aPath);
 105
 106   virtual void RemoveCookiesWithOriginAttributes(
 107       const OriginAttributesPattern& aPattern, const nsACString& aBaseDomain);
 108
 109   virtual void RemoveCookiesFromExactHost(
 110       const nsACString& aHost, const nsACString& aBaseDomain,
 111       const OriginAttributesPattern& aPattern);
 112
 113   void RemoveAll();
 114
 115   void NotifyChanged(nsISupports* aSubject, const char16_t* aData,
 116                      bool aOldCookieIsSession = false);
 117
 118   void AddCookie(nsIConsoleReportCollector* aCRC, const nsACString& aBaseDomain,
 119                  const OriginAttributes& aOriginAttributes, Cookie* aCookie,
 120                  int64_t aCurrentTimeInUsec, nsIURI* aHostURI,
 121                  const nsACString& aCookieHeader, bool aFromHttp);
 122
 123   static void CreateOrUpdatePurgeList(nsCOMPtr<nsIArray>& aPurgedList,
 124                                       nsICookie* aCookie);
 125
 126   virtual void StaleCookies(const nsTArray<Cookie*>& aCookieList,
 127                             int64_t aCurrentTimeInUsec) = 0;
 128
 129   virtual void Close() = 0;
 130
 131   virtual void EnsureInitialized() = 0;
 132
 133   virtual nsresult RunInTransaction(
 134       nsICookieTransactionCallback* aCallback) = 0;
 135
 136  protected:
 137   CookieStorage() = default;
 138   virtual ~CookieStorage() = default;
 139
 140   void Init();
 141
 142   void AddCookieToList(const nsACString& aBaseDomain,
 143                        const OriginAttributes& aOriginAttributes,
 144                        Cookie* aCookie);
 145
 146   virtual void StoreCookie(const nsACString& aBaseDomain,
 147                            const OriginAttributes& aOriginAttributes,
 148                            Cookie* aCookie) = 0;
 149
 150   virtual const char* NotificationTopic() const = 0;
 151
 152   virtual void NotifyChangedInternal(nsISupports* aSubject,
 153                                      const char16_t* aData,
 154                                      bool aOldCookieIsSession) = 0;
 155
 156   virtual void RemoveAllInternal() = 0;
 157
 158   // This method calls RemoveCookieFromDB + RemoveCookieFromListInternal.
 159   void RemoveCookieFromList(const CookieListIter& aIter);
 160
 161   void RemoveCookieFromListInternal(const CookieListIter& aIter);
 162
 163   virtual void RemoveCookieFromDB(const CookieListIter& aIter) = 0;
 164
 165   already_AddRefed<nsIArray> PurgeCookiesWithCallbacks(
 166       int64_t aCurrentTimeInUsec, uint16_t aMaxNumberOfCookies,
 167       int64_t aCookiePurgeAge,
 168       std::function<void(const CookieListIter&)>&& aRemoveCookieCallback,
 169       std::function<void()>&& aFinalizeCallback);
 170
 171   nsTHashtable<CookieEntry> mHostTable;
 172
 173   uint32_t mCookieCount{0};
 174
 175  private:
 176   void PrefChanged(nsIPrefBranch* aPrefBranch);
 177
 178   bool FindSecureCookie(const nsACString& aBaseDomain,
 179                         const OriginAttributes& aOriginAttributes,
 180                         Cookie* aCookie);
 181
 182   static void FindStaleCookies(CookieEntry* aEntry, int64_t aCurrentTime,
 183                                bool aIsSecure,
 184                                nsTArray<CookieListIter>& aOutput,
 185                                uint32_t aLimit);
 186
 187   void UpdateCookieOldestTime(Cookie* aCookie);
 188
 189   void MergeCookieSchemeMap(Cookie* aOldCookie, Cookie* aNewCookie);
 190
 191   static already_AddRefed<nsIArray> CreatePurgeList(nsICookie* aCookie);
 192
 193   virtual already_AddRefed<nsIArray> PurgeCookies(int64_t aCurrentTimeInUsec,
 194                                                   uint16_t aMaxNumberOfCookies,
 195                                                   int64_t aCookiePurgeAge) = 0;
 196
 197   int64_t mCookieOldestTime{INT64_MAX};
 198
 199   uint16_t mMaxNumberOfCookies{kMaxNumberOfCookies};
 200   uint16_t mMaxCookiesPerHost{kMaxCookiesPerHost};
 201   uint16_t mCookieQuotaPerHost{kCookieQuotaPerHost};
 202   int64_t mCookiePurgeAge{kCookiePurgeAge};
 203 };
 204
 205 }  // namespace net
 206 }  // namespace mozilla
 207
 208 #endif  // mozilla_net_CookieStorage_h