1*6777b538SAndroid Build Coastguard Worker // Copyright 2012 The Chromium Authors
2*6777b538SAndroid Build Coastguard Worker // Use of this source code is governed by a BSD-style license that can be
3*6777b538SAndroid Build Coastguard Worker // found in the LICENSE file.
4*6777b538SAndroid Build Coastguard Worker
5*6777b538SAndroid Build Coastguard Worker #include "base/json/json_writer.h"
6*6777b538SAndroid Build Coastguard Worker
7*6777b538SAndroid Build Coastguard Worker #include <stdint.h>
8*6777b538SAndroid Build Coastguard Worker
9*6777b538SAndroid Build Coastguard Worker #include <cmath>
10*6777b538SAndroid Build Coastguard Worker #include <limits>
11*6777b538SAndroid Build Coastguard Worker #include <string_view>
12*6777b538SAndroid Build Coastguard Worker
13*6777b538SAndroid Build Coastguard Worker #include "base/json/string_escape.h"
14*6777b538SAndroid Build Coastguard Worker #include "base/logging.h"
15*6777b538SAndroid Build Coastguard Worker #include "base/numerics/safe_conversions.h"
16*6777b538SAndroid Build Coastguard Worker #include "base/strings/string_number_conversions.h"
17*6777b538SAndroid Build Coastguard Worker #include "base/values.h"
18*6777b538SAndroid Build Coastguard Worker #include "build/build_config.h"
19*6777b538SAndroid Build Coastguard Worker
20*6777b538SAndroid Build Coastguard Worker namespace base {
21*6777b538SAndroid Build Coastguard Worker
22*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_WIN)
23*6777b538SAndroid Build Coastguard Worker const char kPrettyPrintLineEnding[] = "\r\n";
24*6777b538SAndroid Build Coastguard Worker #else
25*6777b538SAndroid Build Coastguard Worker const char kPrettyPrintLineEnding[] = "\n";
26*6777b538SAndroid Build Coastguard Worker #endif
27*6777b538SAndroid Build Coastguard Worker
28*6777b538SAndroid Build Coastguard Worker // static
Write(ValueView node,std::string * json,size_t max_depth)29*6777b538SAndroid Build Coastguard Worker bool JSONWriter::Write(ValueView node, std::string* json, size_t max_depth) {
30*6777b538SAndroid Build Coastguard Worker return WriteWithOptions(node, 0, json, max_depth);
31*6777b538SAndroid Build Coastguard Worker }
32*6777b538SAndroid Build Coastguard Worker
33*6777b538SAndroid Build Coastguard Worker // static
WriteWithOptions(ValueView node,int options,std::string * json,size_t max_depth)34*6777b538SAndroid Build Coastguard Worker bool JSONWriter::WriteWithOptions(ValueView node,
35*6777b538SAndroid Build Coastguard Worker int options,
36*6777b538SAndroid Build Coastguard Worker std::string* json,
37*6777b538SAndroid Build Coastguard Worker size_t max_depth) {
38*6777b538SAndroid Build Coastguard Worker json->clear();
39*6777b538SAndroid Build Coastguard Worker // Is there a better way to estimate the size of the output?
40*6777b538SAndroid Build Coastguard Worker if (json->capacity() < 1024) {
41*6777b538SAndroid Build Coastguard Worker json->reserve(1024);
42*6777b538SAndroid Build Coastguard Worker }
43*6777b538SAndroid Build Coastguard Worker
44*6777b538SAndroid Build Coastguard Worker JSONWriter writer(options, json, max_depth);
45*6777b538SAndroid Build Coastguard Worker bool result = node.Visit([&writer](const auto& member) {
46*6777b538SAndroid Build Coastguard Worker return writer.BuildJSONString(member, 0);
47*6777b538SAndroid Build Coastguard Worker });
48*6777b538SAndroid Build Coastguard Worker
49*6777b538SAndroid Build Coastguard Worker if (options & OPTIONS_PRETTY_PRINT) {
50*6777b538SAndroid Build Coastguard Worker json->append(kPrettyPrintLineEnding);
51*6777b538SAndroid Build Coastguard Worker }
52*6777b538SAndroid Build Coastguard Worker
53*6777b538SAndroid Build Coastguard Worker return result;
54*6777b538SAndroid Build Coastguard Worker }
55*6777b538SAndroid Build Coastguard Worker
JSONWriter(int options,std::string * json,size_t max_depth)56*6777b538SAndroid Build Coastguard Worker JSONWriter::JSONWriter(int options, std::string* json, size_t max_depth)
57*6777b538SAndroid Build Coastguard Worker : omit_binary_values_((options & OPTIONS_OMIT_BINARY_VALUES) != 0),
58*6777b538SAndroid Build Coastguard Worker omit_double_type_preservation_(
59*6777b538SAndroid Build Coastguard Worker (options & OPTIONS_OMIT_DOUBLE_TYPE_PRESERVATION) != 0),
60*6777b538SAndroid Build Coastguard Worker pretty_print_((options & OPTIONS_PRETTY_PRINT) != 0),
61*6777b538SAndroid Build Coastguard Worker json_string_(json),
62*6777b538SAndroid Build Coastguard Worker max_depth_(max_depth),
63*6777b538SAndroid Build Coastguard Worker stack_depth_(0) {
64*6777b538SAndroid Build Coastguard Worker DCHECK(json);
65*6777b538SAndroid Build Coastguard Worker CHECK_LE(max_depth, internal::kAbsoluteMaxDepth);
66*6777b538SAndroid Build Coastguard Worker }
67*6777b538SAndroid Build Coastguard Worker
BuildJSONString(absl::monostate node,size_t depth)68*6777b538SAndroid Build Coastguard Worker bool JSONWriter::BuildJSONString(absl::monostate node, size_t depth) {
69*6777b538SAndroid Build Coastguard Worker json_string_->append("null");
70*6777b538SAndroid Build Coastguard Worker return true;
71*6777b538SAndroid Build Coastguard Worker }
72*6777b538SAndroid Build Coastguard Worker
BuildJSONString(bool node,size_t depth)73*6777b538SAndroid Build Coastguard Worker bool JSONWriter::BuildJSONString(bool node, size_t depth) {
74*6777b538SAndroid Build Coastguard Worker json_string_->append(node ? "true" : "false");
75*6777b538SAndroid Build Coastguard Worker return true;
76*6777b538SAndroid Build Coastguard Worker }
77*6777b538SAndroid Build Coastguard Worker
BuildJSONString(int node,size_t depth)78*6777b538SAndroid Build Coastguard Worker bool JSONWriter::BuildJSONString(int node, size_t depth) {
79*6777b538SAndroid Build Coastguard Worker json_string_->append(NumberToString(node));
80*6777b538SAndroid Build Coastguard Worker return true;
81*6777b538SAndroid Build Coastguard Worker }
82*6777b538SAndroid Build Coastguard Worker
BuildJSONString(double node,size_t depth)83*6777b538SAndroid Build Coastguard Worker bool JSONWriter::BuildJSONString(double node, size_t depth) {
84*6777b538SAndroid Build Coastguard Worker if (omit_double_type_preservation_ &&
85*6777b538SAndroid Build Coastguard Worker IsValueInRangeForNumericType<int64_t>(node) && std::floor(node) == node) {
86*6777b538SAndroid Build Coastguard Worker json_string_->append(NumberToString(static_cast<int64_t>(node)));
87*6777b538SAndroid Build Coastguard Worker return true;
88*6777b538SAndroid Build Coastguard Worker }
89*6777b538SAndroid Build Coastguard Worker
90*6777b538SAndroid Build Coastguard Worker std::string real = NumberToString(node);
91*6777b538SAndroid Build Coastguard Worker // Ensure that the number has a .0 if there's no decimal or 'e'. This
92*6777b538SAndroid Build Coastguard Worker // makes sure that when we read the JSON back, it's interpreted as a
93*6777b538SAndroid Build Coastguard Worker // real rather than an int.
94*6777b538SAndroid Build Coastguard Worker if (real.find_first_of(".eE") == std::string::npos) {
95*6777b538SAndroid Build Coastguard Worker real.append(".0");
96*6777b538SAndroid Build Coastguard Worker }
97*6777b538SAndroid Build Coastguard Worker
98*6777b538SAndroid Build Coastguard Worker // The JSON spec requires that non-integer values in the range (-1,1)
99*6777b538SAndroid Build Coastguard Worker // have a zero before the decimal point - ".52" is not valid, "0.52" is.
100*6777b538SAndroid Build Coastguard Worker if (real[0] == '.') {
101*6777b538SAndroid Build Coastguard Worker real.insert(0, 1, '0');
102*6777b538SAndroid Build Coastguard Worker } else if (real.length() > 1 && real[0] == '-' && real[1] == '.') {
103*6777b538SAndroid Build Coastguard Worker // "-.1" bad "-0.1" good
104*6777b538SAndroid Build Coastguard Worker real.insert(1, 1, '0');
105*6777b538SAndroid Build Coastguard Worker }
106*6777b538SAndroid Build Coastguard Worker json_string_->append(real);
107*6777b538SAndroid Build Coastguard Worker return true;
108*6777b538SAndroid Build Coastguard Worker }
109*6777b538SAndroid Build Coastguard Worker
BuildJSONString(std::string_view node,size_t depth)110*6777b538SAndroid Build Coastguard Worker bool JSONWriter::BuildJSONString(std::string_view node, size_t depth) {
111*6777b538SAndroid Build Coastguard Worker EscapeJSONString(node, true, json_string_);
112*6777b538SAndroid Build Coastguard Worker return true;
113*6777b538SAndroid Build Coastguard Worker }
114*6777b538SAndroid Build Coastguard Worker
BuildJSONString(const Value::BlobStorage & node,size_t depth)115*6777b538SAndroid Build Coastguard Worker bool JSONWriter::BuildJSONString(const Value::BlobStorage& node, size_t depth) {
116*6777b538SAndroid Build Coastguard Worker // Successful only if we're allowed to omit it.
117*6777b538SAndroid Build Coastguard Worker DLOG_IF(ERROR, !omit_binary_values_) << "Cannot serialize binary value.";
118*6777b538SAndroid Build Coastguard Worker return omit_binary_values_;
119*6777b538SAndroid Build Coastguard Worker }
120*6777b538SAndroid Build Coastguard Worker
BuildJSONString(const Value::Dict & node,size_t depth)121*6777b538SAndroid Build Coastguard Worker bool JSONWriter::BuildJSONString(const Value::Dict& node, size_t depth) {
122*6777b538SAndroid Build Coastguard Worker internal::StackMarker depth_check(max_depth_, &stack_depth_);
123*6777b538SAndroid Build Coastguard Worker
124*6777b538SAndroid Build Coastguard Worker if (depth_check.IsTooDeep()) {
125*6777b538SAndroid Build Coastguard Worker return false;
126*6777b538SAndroid Build Coastguard Worker }
127*6777b538SAndroid Build Coastguard Worker
128*6777b538SAndroid Build Coastguard Worker json_string_->push_back('{');
129*6777b538SAndroid Build Coastguard Worker if (pretty_print_) {
130*6777b538SAndroid Build Coastguard Worker json_string_->append(kPrettyPrintLineEnding);
131*6777b538SAndroid Build Coastguard Worker }
132*6777b538SAndroid Build Coastguard Worker
133*6777b538SAndroid Build Coastguard Worker bool first_value_has_been_output = false;
134*6777b538SAndroid Build Coastguard Worker bool result = true;
135*6777b538SAndroid Build Coastguard Worker for (const auto [key, value] : node) {
136*6777b538SAndroid Build Coastguard Worker if (omit_binary_values_ && value.type() == Value::Type::BINARY) {
137*6777b538SAndroid Build Coastguard Worker continue;
138*6777b538SAndroid Build Coastguard Worker }
139*6777b538SAndroid Build Coastguard Worker
140*6777b538SAndroid Build Coastguard Worker if (first_value_has_been_output) {
141*6777b538SAndroid Build Coastguard Worker json_string_->push_back(',');
142*6777b538SAndroid Build Coastguard Worker if (pretty_print_) {
143*6777b538SAndroid Build Coastguard Worker json_string_->append(kPrettyPrintLineEnding);
144*6777b538SAndroid Build Coastguard Worker }
145*6777b538SAndroid Build Coastguard Worker }
146*6777b538SAndroid Build Coastguard Worker
147*6777b538SAndroid Build Coastguard Worker if (pretty_print_) {
148*6777b538SAndroid Build Coastguard Worker IndentLine(depth + 1U);
149*6777b538SAndroid Build Coastguard Worker }
150*6777b538SAndroid Build Coastguard Worker
151*6777b538SAndroid Build Coastguard Worker EscapeJSONString(key, true, json_string_);
152*6777b538SAndroid Build Coastguard Worker json_string_->push_back(':');
153*6777b538SAndroid Build Coastguard Worker if (pretty_print_) {
154*6777b538SAndroid Build Coastguard Worker json_string_->push_back(' ');
155*6777b538SAndroid Build Coastguard Worker }
156*6777b538SAndroid Build Coastguard Worker
157*6777b538SAndroid Build Coastguard Worker result &= value.Visit([this, depth = depth + 1](const auto& member) {
158*6777b538SAndroid Build Coastguard Worker return BuildJSONString(member, depth);
159*6777b538SAndroid Build Coastguard Worker });
160*6777b538SAndroid Build Coastguard Worker
161*6777b538SAndroid Build Coastguard Worker first_value_has_been_output = true;
162*6777b538SAndroid Build Coastguard Worker }
163*6777b538SAndroid Build Coastguard Worker
164*6777b538SAndroid Build Coastguard Worker if (pretty_print_) {
165*6777b538SAndroid Build Coastguard Worker if (first_value_has_been_output) {
166*6777b538SAndroid Build Coastguard Worker json_string_->append(kPrettyPrintLineEnding);
167*6777b538SAndroid Build Coastguard Worker }
168*6777b538SAndroid Build Coastguard Worker IndentLine(depth);
169*6777b538SAndroid Build Coastguard Worker }
170*6777b538SAndroid Build Coastguard Worker
171*6777b538SAndroid Build Coastguard Worker json_string_->push_back('}');
172*6777b538SAndroid Build Coastguard Worker return result;
173*6777b538SAndroid Build Coastguard Worker }
174*6777b538SAndroid Build Coastguard Worker
BuildJSONString(const Value::List & node,size_t depth)175*6777b538SAndroid Build Coastguard Worker bool JSONWriter::BuildJSONString(const Value::List& node, size_t depth) {
176*6777b538SAndroid Build Coastguard Worker internal::StackMarker depth_check(max_depth_, &stack_depth_);
177*6777b538SAndroid Build Coastguard Worker
178*6777b538SAndroid Build Coastguard Worker if (depth_check.IsTooDeep()) {
179*6777b538SAndroid Build Coastguard Worker return false;
180*6777b538SAndroid Build Coastguard Worker }
181*6777b538SAndroid Build Coastguard Worker
182*6777b538SAndroid Build Coastguard Worker json_string_->push_back('[');
183*6777b538SAndroid Build Coastguard Worker if (pretty_print_) {
184*6777b538SAndroid Build Coastguard Worker json_string_->push_back(' ');
185*6777b538SAndroid Build Coastguard Worker }
186*6777b538SAndroid Build Coastguard Worker
187*6777b538SAndroid Build Coastguard Worker bool first_value_has_been_output = false;
188*6777b538SAndroid Build Coastguard Worker bool result = true;
189*6777b538SAndroid Build Coastguard Worker for (const auto& value : node) {
190*6777b538SAndroid Build Coastguard Worker if (omit_binary_values_ && value.type() == Value::Type::BINARY) {
191*6777b538SAndroid Build Coastguard Worker continue;
192*6777b538SAndroid Build Coastguard Worker }
193*6777b538SAndroid Build Coastguard Worker
194*6777b538SAndroid Build Coastguard Worker if (first_value_has_been_output) {
195*6777b538SAndroid Build Coastguard Worker json_string_->push_back(',');
196*6777b538SAndroid Build Coastguard Worker if (pretty_print_) {
197*6777b538SAndroid Build Coastguard Worker json_string_->push_back(' ');
198*6777b538SAndroid Build Coastguard Worker }
199*6777b538SAndroid Build Coastguard Worker }
200*6777b538SAndroid Build Coastguard Worker
201*6777b538SAndroid Build Coastguard Worker result &= value.Visit([this, depth](const auto& member) {
202*6777b538SAndroid Build Coastguard Worker return BuildJSONString(member, depth);
203*6777b538SAndroid Build Coastguard Worker });
204*6777b538SAndroid Build Coastguard Worker
205*6777b538SAndroid Build Coastguard Worker first_value_has_been_output = true;
206*6777b538SAndroid Build Coastguard Worker }
207*6777b538SAndroid Build Coastguard Worker
208*6777b538SAndroid Build Coastguard Worker if (pretty_print_) {
209*6777b538SAndroid Build Coastguard Worker json_string_->push_back(' ');
210*6777b538SAndroid Build Coastguard Worker }
211*6777b538SAndroid Build Coastguard Worker json_string_->push_back(']');
212*6777b538SAndroid Build Coastguard Worker return result;
213*6777b538SAndroid Build Coastguard Worker }
214*6777b538SAndroid Build Coastguard Worker
IndentLine(size_t depth)215*6777b538SAndroid Build Coastguard Worker void JSONWriter::IndentLine(size_t depth) {
216*6777b538SAndroid Build Coastguard Worker json_string_->append(depth * 3U, ' ');
217*6777b538SAndroid Build Coastguard Worker }
218*6777b538SAndroid Build Coastguard Worker
WriteJson(ValueView node,size_t max_depth)219*6777b538SAndroid Build Coastguard Worker std::optional<std::string> WriteJson(ValueView node, size_t max_depth) {
220*6777b538SAndroid Build Coastguard Worker std::string result;
221*6777b538SAndroid Build Coastguard Worker if (!JSONWriter::Write(node, &result, max_depth)) {
222*6777b538SAndroid Build Coastguard Worker return std::nullopt;
223*6777b538SAndroid Build Coastguard Worker }
224*6777b538SAndroid Build Coastguard Worker return result;
225*6777b538SAndroid Build Coastguard Worker }
226*6777b538SAndroid Build Coastguard Worker
WriteJsonWithOptions(ValueView node,uint32_t options,size_t max_depth)227*6777b538SAndroid Build Coastguard Worker std::optional<std::string> WriteJsonWithOptions(ValueView node,
228*6777b538SAndroid Build Coastguard Worker uint32_t options,
229*6777b538SAndroid Build Coastguard Worker size_t max_depth) {
230*6777b538SAndroid Build Coastguard Worker std::string result;
231*6777b538SAndroid Build Coastguard Worker if (!JSONWriter::WriteWithOptions(node, static_cast<int>(options), &result,
232*6777b538SAndroid Build Coastguard Worker max_depth)) {
233*6777b538SAndroid Build Coastguard Worker return std::nullopt;
234*6777b538SAndroid Build Coastguard Worker }
235*6777b538SAndroid Build Coastguard Worker return result;
236*6777b538SAndroid Build Coastguard Worker }
237*6777b538SAndroid Build Coastguard Worker
238*6777b538SAndroid Build Coastguard Worker } // namespace base
239