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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <algorithm>
#include "third_party/blink/public/common/user_agent/user_agent_metadata.h"
#include "base/containers/contains.h"
#include "base/containers/span.h"
#include "base/pickle.h"
#include "net/http/structured_headers.h"
#include "third_party/blink/public/common/features.h"
namespace blink {
namespace {
constexpr uint32_t kVersion = 3u;
// List of valid form factors.
// See https://wicg.github.io/ua-client-hints/#sec-ch-ua-form-factors
constexpr std::string_view kValidFormFactors[] = {
blink::kDesktopFormFactor, blink::kAutomotiveFormFactor,
blink::kMobileFormFactor, blink::kTabletFormFactor,
blink::kXRFormFactor, blink::kEInkFormFactor,
blink::kWatchFormFactor};
} // namespace
UserAgentBrandVersion::UserAgentBrandVersion(const std::string& ua_brand,
const std::string& ua_version) {
brand = ua_brand;
version = ua_version;
}
const std::string UserAgentMetadata::SerializeBrandVersionList(
const blink::UserAgentBrandList& ua_brand_version_list) {
net::structured_headers::List brand_version_header =
net::structured_headers::List();
for (const UserAgentBrandVersion& brand_version : ua_brand_version_list) {
if (brand_version.version.empty()) {
brand_version_header.push_back(
net::structured_headers::ParameterizedMember(
net::structured_headers::Item(brand_version.brand), {}));
} else {
brand_version_header.push_back(
net::structured_headers::ParameterizedMember(
net::structured_headers::Item(brand_version.brand),
{std::make_pair(
"v", net::structured_headers::Item(brand_version.version))}));
}
}
return net::structured_headers::SerializeList(brand_version_header)
.value_or("");
}
const std::string UserAgentMetadata::SerializeBrandFullVersionList() {
return SerializeBrandVersionList(brand_full_version_list);
}
const std::string UserAgentMetadata::SerializeBrandMajorVersionList() {
return SerializeBrandVersionList(brand_version_list);
}
const std::string UserAgentMetadata::SerializeFormFactors() {
net::structured_headers::List structured;
for (auto& ff : form_factors) {
structured.push_back(net::structured_headers::ParameterizedMember(
net::structured_headers::Item(ff), {}));
}
return SerializeList(structured).value_or("");
}
// static
std::optional<std::string> UserAgentMetadata::Marshal(
const std::optional<UserAgentMetadata>& in) {
if (!in) {
return std::nullopt;
}
base::Pickle out;
out.WriteUInt32(kVersion);
out.WriteUInt32(base::checked_cast<uint32_t>(in->brand_version_list.size()));
for (const auto& brand_version : in->brand_version_list) {
out.WriteString(brand_version.brand);
out.WriteString(brand_version.version);
}
out.WriteUInt32(
base::checked_cast<uint32_t>(in->brand_full_version_list.size()));
for (const auto& brand_version : in->brand_full_version_list) {
out.WriteString(brand_version.brand);
out.WriteString(brand_version.version);
}
out.WriteString(in->full_version);
out.WriteString(in->platform);
out.WriteString(in->platform_version);
out.WriteString(in->architecture);
out.WriteString(in->model);
out.WriteBool(in->mobile);
out.WriteString(in->bitness);
out.WriteBool(in->wow64);
out.WriteUInt32(base::checked_cast<uint32_t>(in->form_factors.size()));
for (const auto& form_factors : in->form_factors) {
out.WriteString(form_factors);
}
return std::string(reinterpret_cast<const char*>(out.data()), out.size());
}
// static
std::optional<UserAgentMetadata> UserAgentMetadata::Demarshal(
const std::optional<std::string>& encoded) {
if (!encoded)
return std::nullopt;
base::Pickle pickle =
base::Pickle::WithUnownedBuffer(base::as_byte_span(encoded.value()));
base::PickleIterator in(pickle);
uint32_t version;
UserAgentMetadata out;
if (!in.ReadUInt32(&version) || version != kVersion)
return std::nullopt;
uint32_t brand_version_size;
if (!in.ReadUInt32(&brand_version_size))
return std::nullopt;
for (uint32_t i = 0; i < brand_version_size; i++) {
UserAgentBrandVersion brand_version;
if (!in.ReadString(&brand_version.brand))
return std::nullopt;
if (!in.ReadString(&brand_version.version))
return std::nullopt;
out.brand_version_list.push_back(std::move(brand_version));
}
uint32_t brand_full_version_size;
if (!in.ReadUInt32(&brand_full_version_size))
return std::nullopt;
for (uint32_t i = 0; i < brand_full_version_size; i++) {
UserAgentBrandVersion brand_version;
if (!in.ReadString(&brand_version.brand))
return std::nullopt;
if (!in.ReadString(&brand_version.version))
return std::nullopt;
out.brand_full_version_list.push_back(std::move(brand_version));
}
if (!in.ReadString(&out.full_version))
return std::nullopt;
if (!in.ReadString(&out.platform))
return std::nullopt;
if (!in.ReadString(&out.platform_version))
return std::nullopt;
if (!in.ReadString(&out.architecture))
return std::nullopt;
if (!in.ReadString(&out.model))
return std::nullopt;
if (!in.ReadBool(&out.mobile))
return std::nullopt;
if (!in.ReadString(&out.bitness))
return std::nullopt;
if (!in.ReadBool(&out.wow64))
return std::nullopt;
uint32_t form_factors_size;
if (!in.ReadUInt32(&form_factors_size)) {
return std::nullopt;
}
std::string form_factors;
form_factors.reserve(form_factors_size);
for (uint32_t i = 0; i < form_factors_size; i++) {
if (!in.ReadString(&form_factors)) {
return std::nullopt;
}
out.form_factors.push_back(std::move(form_factors));
}
return std::make_optional(std::move(out));
}
// static
bool UserAgentMetadata::IsValidFormFactor(std::string_view form_factor) {
return base::Contains(kValidFormFactors, form_factor);
}
bool UserAgentBrandVersion::operator==(const UserAgentBrandVersion& a) const {
return a.brand == brand && a.version == version;
}
bool operator==(const UserAgentMetadata& a, const UserAgentMetadata& b) {
return a.brand_version_list == b.brand_version_list &&
a.brand_full_version_list == b.brand_full_version_list &&
a.full_version == b.full_version && a.platform == b.platform &&
a.platform_version == b.platform_version &&
a.architecture == b.architecture && a.model == b.model &&
a.mobile == b.mobile && a.bitness == b.bitness && a.wow64 == b.wow64 &&
a.form_factors == b.form_factors;
}
// static
UserAgentOverride UserAgentOverride::UserAgentOnly(const std::string& ua) {
UserAgentOverride result;
result.ua_string_override = ua;
// If ua is not empty, it's assumed the system default should be used
if (!ua.empty() &&
base::FeatureList::IsEnabled(features::kUACHOverrideBlank)) {
result.ua_metadata_override = UserAgentMetadata();
}
return result;
}
bool operator==(const UserAgentOverride& a, const UserAgentOverride& b) {
return a.ua_string_override == b.ua_string_override &&
a.ua_metadata_override == b.ua_metadata_override;
}
} // namespace blink
|
