dom/quota/CommonMetadata.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 file,
   5  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef DOM_QUOTA_COMMONMETADATA_H_
   8 #define DOM_QUOTA_COMMONMETADATA_H_
   9
  10 #include <utility>
  11
  12 #include "mozilla/dom/quota/Client.h"
  13 #include "mozilla/dom/quota/Constants.h"
  14 #include "mozilla/dom/quota/PersistenceType.h"
  15 #include "nsString.h"
  16
  17 namespace mozilla::dom::quota {
  18
  19 struct PrincipalMetadata {
  20   nsCString mSuffix;
  21   nsCString mGroup;
  22   nsCString mOrigin;
  23   nsCString mStorageOrigin;
  24   bool mIsPrivate = false;
  25
  26   // These explicit constructors exist to prevent accidental aggregate
  27   // initialization which could for example initialize mSuffix as group and
  28   // mGroup as origin (if only two string arguments are used).
  29   PrincipalMetadata() = default;
  30
  31   PrincipalMetadata(nsCString aSuffix, nsCString aGroup, nsCString aOrigin,
  32                     nsCString aStorageOrigin, bool aIsPrivate)
  33       : mSuffix{std::move(aSuffix)},
  34         mGroup{std::move(aGroup)},
  35         mOrigin{std::move(aOrigin)},
  36         mStorageOrigin{std::move(aStorageOrigin)},
  37         mIsPrivate{aIsPrivate} {
  38     AssertInvariants();
  39   }
  40
  41   void AssertInvariants() const {
  42     MOZ_ASSERT(!StringBeginsWith(mOrigin, kUUIDOriginScheme));
  43     MOZ_ASSERT_IF(!mIsPrivate, mOrigin == mStorageOrigin);
  44     MOZ_ASSERT_IF(mIsPrivate, mOrigin != mStorageOrigin);
  45   }
  46 };
  47
  48 struct OriginMetadata : public PrincipalMetadata {
  49   PersistenceType mPersistenceType;
  50
  51   OriginMetadata() = default;
  52
  53   OriginMetadata(nsCString aSuffix, nsCString aGroup, nsCString aOrigin,
  54                  nsCString aStorageOrigin, bool aIsPrivate,
  55                  PersistenceType aPersistenceType)
  56       : PrincipalMetadata(std::move(aSuffix), std::move(aGroup),
  57                           std::move(aOrigin), std::move(aStorageOrigin),
  58                           aIsPrivate),
  59         mPersistenceType(aPersistenceType) {}
  60
  61   OriginMetadata(PrincipalMetadata aPrincipalMetadata,
  62                  PersistenceType aPersistenceType)
  63       : PrincipalMetadata(std::move(aPrincipalMetadata)),
  64         mPersistenceType(aPersistenceType) {}
  65 };
  66
  67 struct FullOriginMetadata : OriginMetadata {
  68   bool mPersisted;
  69   int64_t mLastAccessTime;
  70
  71   FullOriginMetadata() = default;
  72
  73   FullOriginMetadata(OriginMetadata aOriginMetadata, bool aPersisted,
  74                      int64_t aLastAccessTime)
  75       : OriginMetadata(std::move(aOriginMetadata)),
  76         mPersisted(aPersisted),
  77         mLastAccessTime(aLastAccessTime) {}
  78 };
  79
  80 struct OriginUsageMetadata : FullOriginMetadata {
  81   uint64_t mUsage;
  82
  83   OriginUsageMetadata() = default;
  84
  85   OriginUsageMetadata(FullOriginMetadata aFullOriginMetadata, uint64_t aUsage)
  86       : FullOriginMetadata(std::move(aFullOriginMetadata)), mUsage(aUsage) {}
  87 };
  88
  89 struct ClientMetadata : OriginMetadata {
  90   Client::Type mClientType;
  91
  92   ClientMetadata() = default;
  93
  94   ClientMetadata(OriginMetadata aOriginMetadata, Client::Type aClientType)
  95       : OriginMetadata(std::move(aOriginMetadata)), mClientType(aClientType) {}
  96 };
  97
  98 }  // namespace mozilla::dom::quota
  99
 100 #endif  // DOM_QUOTA_COMMONMETADATA_H_