1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef DOM_QUOTA_COMMONMETADATA_H_
#define DOM_QUOTA_COMMONMETADATA_H_
#include <utility>
#include "mozilla/dom/quota/Client.h"
#include "mozilla/dom/quota/ClientUsageArray.h"
#include "mozilla/dom/quota/Constants.h"
#include "mozilla/dom/quota/PersistenceType.h"
#include "nsString.h"
namespace mozilla::dom::quota {
struct PrincipalMetadata {
nsCString mSuffix;
nsCString mGroup;
nsCString mOrigin;
nsCString mStorageOrigin;
bool mIsPrivate = false;
// These explicit constructors exist to prevent accidental aggregate
// initialization which could for example initialize mSuffix as group and
// mGroup as origin (if only two string arguments are used).
PrincipalMetadata() = default;
PrincipalMetadata(nsCString aSuffix, nsCString aGroup, nsCString aOrigin,
nsCString aStorageOrigin, bool aIsPrivate)
: mSuffix{std::move(aSuffix)},
mGroup{std::move(aGroup)},
mOrigin{std::move(aOrigin)},
mStorageOrigin{std::move(aStorageOrigin)},
mIsPrivate{aIsPrivate} {
AssertInvariants();
}
void AssertInvariants() const {
MOZ_ASSERT(!StringBeginsWith(mOrigin, kUUIDOriginScheme));
MOZ_ASSERT_IF(!mIsPrivate, mOrigin == mStorageOrigin);
MOZ_ASSERT_IF(mIsPrivate, mOrigin != mStorageOrigin);
}
// Templated to restrict Equals() to exactly PrincipalMetadata. Prevents
// derived types from accidentally inheriting Equals() and comparing only
// base fields without their own fields.
template <typename T, typename = std::enable_if_t<
std::is_same<T, PrincipalMetadata>::value>>
bool Equals(const T& aOther) const {
return mSuffix == aOther.mSuffix && mGroup == aOther.mGroup &&
mOrigin == aOther.mOrigin &&
mStorageOrigin == aOther.mStorageOrigin &&
mIsPrivate == aOther.mIsPrivate;
}
};
struct OriginMetadata : public PrincipalMetadata {
PersistenceType mPersistenceType;
OriginMetadata() = default;
OriginMetadata(nsCString aSuffix, nsCString aGroup, nsCString aOrigin,
nsCString aStorageOrigin, bool aIsPrivate,
PersistenceType aPersistenceType)
: PrincipalMetadata(std::move(aSuffix), std::move(aGroup),
std::move(aOrigin), std::move(aStorageOrigin),
aIsPrivate),
mPersistenceType(aPersistenceType) {}
OriginMetadata(PrincipalMetadata aPrincipalMetadata,
PersistenceType aPersistenceType)
: PrincipalMetadata(std::move(aPrincipalMetadata)),
mPersistenceType(aPersistenceType) {}
// Templated to restrict Equals() to exactly OriginMetadata. Prevents
// derived types from accidentally inheriting Equals() and comparing only
// base fields without their own fields.
template <typename T,
typename = std::enable_if_t<std::is_same<T, OriginMetadata>::value>>
bool Equals(const T& aOther) const {
return static_cast<const PrincipalMetadata&>(*this).Equals(
static_cast<const PrincipalMetadata&>(aOther)) &&
mPersistenceType == aOther.mPersistenceType;
}
// Returns a composite string key in the form "<persistence>*<origin>".
// Useful for flat hash maps keyed by both persistence type and origin,
// as an alternative to using structured keys or nested maps.
// Suitable when tree-based representation is unnecessary.
nsCString GetCompositeKey() const {
nsCString result;
result.AppendInt(mPersistenceType);
result.Append("*");
result.Append(mOrigin);
return result;
}
};
struct OriginStateMetadata {
int64_t mLastAccessTime;
int32_t mLastMaintenanceDate;
bool mAccessed;
bool mPersisted;
OriginStateMetadata() = default;
OriginStateMetadata(int64_t aLastAccessTime, int32_t aLastMaintenanceDate,
bool aAccessed, bool aPersisted)
: mLastAccessTime(aLastAccessTime),
mLastMaintenanceDate(aLastMaintenanceDate),
mAccessed(aAccessed),
mPersisted(aPersisted) {}
// Templated to restrict Equals() to exactly OriginStateMetadata. Prevents
// derived types from accidentally inheriting Equals() and comparing only
// base fields without their own fields.
template <typename T, typename = std::enable_if_t<
std::is_same<T, OriginStateMetadata>::value>>
bool Equals(const T& aOther) const {
return mLastAccessTime == aOther.mLastAccessTime &&
mLastMaintenanceDate == aOther.mLastMaintenanceDate &&
mAccessed == aOther.mAccessed && mPersisted == aOther.mPersisted;
}
};
struct FullOriginMetadata : OriginMetadata, OriginStateMetadata {
ClientUsageArray mClientUsages;
uint64_t mOriginUsage;
uint32_t mQuotaVersion;
FullOriginMetadata() = default;
FullOriginMetadata(OriginMetadata aOriginMetadata,
OriginStateMetadata aOriginStateMetadata,
const ClientUsageArray& aClientUsages, uint64_t aUsage,
uint32_t aQuotaVersion)
: OriginMetadata(std::move(aOriginMetadata)),
OriginStateMetadata(aOriginStateMetadata),
mClientUsages(aClientUsages),
mOriginUsage(aUsage),
mQuotaVersion(aQuotaVersion) {}
// Templated to restrict Equals() to exactly FullOriginMetadata. Prevents
// derived types from accidentally inheriting Equals() and comparing only
// base fields without their own fields.
template <typename T, typename = std::enable_if_t<
std::is_same<T, FullOriginMetadata>::value>>
bool Equals(const T& aOther) const {
return static_cast<const OriginMetadata&>(*this).Equals(
static_cast<const OriginMetadata&>(aOther)) &&
static_cast<const OriginStateMetadata&>(*this).Equals(
static_cast<const OriginStateMetadata&>(aOther)) &&
mClientUsages == aOther.mClientUsages &&
mOriginUsage == aOther.mOriginUsage &&
mQuotaVersion == aOther.mQuotaVersion;
}
// Compares all fields of this FullOriginMetadata instance with another,
// except for the fields inherited from OriginStateMetadata.
template <typename T, typename = std::enable_if_t<
std::is_same<T, FullOriginMetadata>::value>>
bool EqualsIgnoringOriginState(const T& aOther) const {
return static_cast<const OriginMetadata&>(*this).Equals(
static_cast<const OriginMetadata&>(aOther)) &&
mClientUsages == aOther.mClientUsages &&
mOriginUsage == aOther.mOriginUsage &&
mQuotaVersion == aOther.mQuotaVersion;
}
// Convenient method for duplicating a FullOriginMetadata instance. Creates
// a new object by copying both the OriginMetadata and OriginStateMetadata
// parts of this instance.
FullOriginMetadata Clone() const {
return {static_cast<const OriginMetadata&>(*this),
static_cast<const OriginStateMetadata&>(*this), mClientUsages,
mOriginUsage, mQuotaVersion};
}
};
struct OriginUsageMetadata : FullOriginMetadata {
uint64_t mUsage;
OriginUsageMetadata() = default;
OriginUsageMetadata(FullOriginMetadata aFullOriginMetadata, uint64_t aUsage)
: FullOriginMetadata(std::move(aFullOriginMetadata)), mUsage(aUsage) {}
};
struct ClientMetadata : OriginMetadata {
Client::Type mClientType;
ClientMetadata() = default;
ClientMetadata(OriginMetadata aOriginMetadata, Client::Type aClientType)
: OriginMetadata(std::move(aOriginMetadata)), mClientType(aClientType) {}
};
} // namespace mozilla::dom::quota
#endif // DOM_QUOTA_COMMONMETADATA_H_
|
