dom/storage/SessionStorageCache.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_SessionStorageCache_h
   8 #define mozilla_dom_SessionStorageCache_h
   9
  10 #include "mozilla/UniquePtr.h"
  11 #include "mozilla/dom/LSWriteOptimizerImpl.h"
  12 #include "nsTHashMap.h"
  13
  14 namespace mozilla::dom {
  15
  16 class SSSetItemInfo;
  17 class SSWriteInfo;
  18 class SessionStorageCacheChild;
  19
  20 /**
  21  * Coalescing manipulation queue used by `SessionStorageCache`.  Used by
  22  * `SessionStorageCache` to buffer and coalesce manipulations before they
  23  * are sent to the parent process.
  24  */
  25 class SSWriteOptimizer final : public LSWriteOptimizer<nsAString, nsString> {
  26  public:
  27   void Enumerate(nsTArray<SSWriteInfo>& aWriteInfos);
  28 };
  29
  30 class SessionStorageCache final {
  31  public:
  32   NS_INLINE_DECL_REFCOUNTING(SessionStorageCache)
  33
  34   SessionStorageCache();
  35
  36   int64_t GetOriginQuotaUsage();
  37
  38   uint32_t Length();
  39
  40   void Key(uint32_t aIndex, nsAString& aResult);
  41
  42   void GetItem(const nsAString& aKey, nsAString& aResult);
  43
  44   void GetKeys(nsTArray<nsString>& aKeys);
  45
  46   nsresult SetItem(const nsAString& aKey, const nsAString& aValue,
  47                    nsString& aOldValue, bool aRecordWriteInfo = true);
  48
  49   nsresult RemoveItem(const nsAString& aKey, nsString& aOldValue,
  50                       bool aRecordWriteInfo = true);
  51
  52   void Clear(bool aByUserInteraction = true, bool aRecordWriteInfo = true);
  53
  54   void ResetWriteInfos();
  55
  56   already_AddRefed<SessionStorageCache> Clone() const;
  57
  58   nsTArray<SSSetItemInfo> SerializeData();
  59
  60   nsTArray<SSWriteInfo> SerializeWriteInfos();
  61
  62   void DeserializeData(const nsTArray<SSSetItemInfo>& aData);
  63
  64   void DeserializeWriteInfos(const nsTArray<SSWriteInfo>& aInfos);
  65
  66   void SetActor(SessionStorageCacheChild* aActor);
  67
  68   SessionStorageCacheChild* Actor() const { return mActor; }
  69
  70   void ClearActor();
  71
  72   void SetLoadedOrCloned() { mLoadedOrCloned = true; }
  73
  74   bool WasLoadedOrCloned() const { return mLoadedOrCloned; }
  75
  76  private:
  77   ~SessionStorageCache();
  78
  79   struct DataSet {
  80     DataSet() : mOriginQuotaUsage(0) {}
  81
  82     bool ProcessUsageDelta(int64_t aDelta);
  83
  84     nsTHashMap<nsStringHashKey, nsString> mKeys;
  85
  86     SSWriteOptimizer mWriteOptimizer;
  87
  88     int64_t mOriginQuotaUsage;
  89   };
  90
  91   DataSet mDataSet;
  92
  93   SessionStorageCacheChild* mActor;
  94   bool mLoadedOrCloned;
  95 };
  96
  97 }  // namespace mozilla::dom
  98
  99 #endif  // mozilla_dom_SessionStorageCache_h