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 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "dbus/values_util.h"
#include <memory>
#include <utility>
#include <variant>
#include "base/json/json_writer.h"
#include "base/logging.h"
#include "base/memory/raw_ptr.h"
#include "base/notreached.h"
#include "base/values.h"
#include "dbus/message.h"
namespace dbus {
namespace {
// Returns whether |value| is exactly representable by double or not.
template <typename T>
bool IsExactlyRepresentableByDouble(T value) {
return value == static_cast<T>(static_cast<double>(value));
}
// Pops values from |reader| and appends them to |list_value|.
bool PopListElements(MessageReader* reader, base::Value::List& list_value) {
while (reader->HasMoreData()) {
base::Value element_value = PopDataAsValue(reader);
if (element_value.is_none())
return false;
list_value.Append(std::move(element_value));
}
return true;
}
// Pops dict-entries from |reader| and sets them to |dictionary_value|
bool PopDictionaryEntries(MessageReader* reader,
base::Value::Dict& dictionary_value) {
while (reader->HasMoreData()) {
DCHECK_EQ(Message::DICT_ENTRY, reader->GetDataType());
MessageReader entry_reader(nullptr);
if (!reader->PopDictEntry(&entry_reader))
return false;
// Get key as a string.
std::string key_string;
if (entry_reader.GetDataType() == Message::STRING) {
// If the type of keys is STRING, pop it directly.
if (!entry_reader.PopString(&key_string))
return false;
} else {
// If the type of keys is not STRING, convert it to string.
base::Value key = PopDataAsValue(&entry_reader);
if (key.is_none())
return false;
// Use JSONWriter to convert an arbitrary value to a string.
base::JSONWriter::Write(key, &key_string);
}
// Get the value and set the key-value pair.
base::Value value = PopDataAsValue(&entry_reader);
if (value.is_none())
return false;
dictionary_value.Set(key_string, std::move(value));
}
return true;
}
// Gets the D-Bus type signature for the value.
std::string GetTypeSignature(base::ValueView value) {
struct Visitor {
std::string operator()(std::monostate) {
DLOG(ERROR) << "Unexpected type " << base::Value::Type::NONE;
return std::string();
}
std::string operator()(bool) { return "b"; }
std::string operator()(int) { return "i"; }
std::string operator()(double) { return "d"; }
std::string operator()(std::string_view) { return "s"; }
std::string operator()(const base::Value::BlobStorage&) { return "ay"; }
std::string operator()(const base::Value::Dict&) { return "a{sv}"; }
std::string operator()(const base::Value::List&) { return "av"; }
};
return value.Visit(Visitor());
}
} // namespace
base::Value PopDataAsValue(MessageReader* reader) {
base::Value result;
switch (reader->GetDataType()) {
case Message::INVALID_DATA:
// Do nothing.
break;
case Message::BYTE: {
uint8_t value = 0;
if (reader->PopByte(&value))
result = base::Value(value);
break;
}
case Message::BOOL: {
bool value = false;
if (reader->PopBool(&value))
result = base::Value(value);
break;
}
case Message::INT16: {
int16_t value = 0;
if (reader->PopInt16(&value))
result = base::Value(value);
break;
}
case Message::UINT16: {
uint16_t value = 0;
if (reader->PopUint16(&value))
result = base::Value(value);
break;
}
case Message::INT32: {
int32_t value = 0;
if (reader->PopInt32(&value))
result = base::Value(value);
break;
}
case Message::UINT32: {
uint32_t value = 0;
if (reader->PopUint32(&value)) {
result = base::Value(static_cast<double>(value));
}
break;
}
case Message::INT64: {
int64_t value = 0;
if (reader->PopInt64(&value)) {
DLOG_IF(WARNING, !IsExactlyRepresentableByDouble(value))
<< value << " is not exactly representable by double";
result = base::Value(static_cast<double>(value));
}
break;
}
case Message::UINT64: {
uint64_t value = 0;
if (reader->PopUint64(&value)) {
DLOG_IF(WARNING, !IsExactlyRepresentableByDouble(value))
<< value << " is not exactly representable by double";
result = base::Value(static_cast<double>(value));
}
break;
}
case Message::DOUBLE: {
double value = 0;
if (reader->PopDouble(&value))
result = base::Value(value);
break;
}
case Message::STRING: {
std::string value;
if (reader->PopString(&value))
result = base::Value(value);
break;
}
case Message::OBJECT_PATH: {
ObjectPath value;
if (reader->PopObjectPath(&value))
result = base::Value(value.value());
break;
}
case Message::UNIX_FD: {
// Cannot distinguish a file descriptor from an int
NOTREACHED();
}
case Message::ARRAY: {
MessageReader sub_reader(nullptr);
if (reader->PopArray(&sub_reader)) {
// If the type of the array's element is DICT_ENTRY, create a
// Value with type base::Value::Dict, otherwise create a
// Value with type base::Value::List.
if (sub_reader.GetDataType() == Message::DICT_ENTRY) {
base::Value::Dict dictionary_value;
if (PopDictionaryEntries(&sub_reader, dictionary_value))
result = base::Value(std::move(dictionary_value));
} else {
base::Value::List list_value;
if (PopListElements(&sub_reader, list_value))
result = base::Value(std::move(list_value));
}
}
break;
}
case Message::STRUCT: {
MessageReader sub_reader(nullptr);
if (reader->PopStruct(&sub_reader)) {
base::Value::List list_value;
if (PopListElements(&sub_reader, list_value))
result = base::Value(std::move(list_value));
}
break;
}
case Message::DICT_ENTRY:
// DICT_ENTRY must be popped as an element of an array.
NOTREACHED();
case Message::VARIANT: {
MessageReader sub_reader(nullptr);
if (reader->PopVariant(&sub_reader))
result = PopDataAsValue(&sub_reader);
break;
}
}
return result;
}
void AppendBasicTypeValueData(MessageWriter* writer, base::ValueView value) {
struct Visitor {
raw_ptr<MessageWriter> writer;
void operator()(std::monostate) {
DLOG(ERROR) << "Unexpected type: " << base::Value::Type::NONE;
}
void operator()(bool value) { writer->AppendBool(value); }
void operator()(int value) { writer->AppendInt32(value); }
void operator()(double value) { writer->AppendDouble(value); }
void operator()(std::string_view value) {
writer->AppendString(std::string(value));
}
void operator()(const base::Value::BlobStorage&) {
DLOG(ERROR) << "Unexpected type: " << base::Value::Type::BINARY;
}
void operator()(const base::Value::Dict&) {
DLOG(ERROR) << "Unexpected type: " << base::Value::Type::DICT;
}
void operator()(const base::Value::List&) {
DLOG(ERROR) << "Unexpected type: " << base::Value::Type::LIST;
}
};
value.Visit(Visitor{.writer = writer});
}
void AppendBasicTypeValueDataAsVariant(MessageWriter* writer,
base::ValueView value) {
MessageWriter sub_writer(nullptr);
writer->OpenVariant(GetTypeSignature(value), &sub_writer);
AppendBasicTypeValueData(&sub_writer, value);
writer->CloseContainer(&sub_writer);
}
void AppendValueData(MessageWriter* writer, base::ValueView value) {
struct Visitor {
raw_ptr<MessageWriter> writer;
void operator()(std::monostate) {
DLOG(ERROR) << "Unexpected type: " << base::Value::Type::NONE;
}
void operator()(bool value) {
return AppendBasicTypeValueData(writer, value);
}
void operator()(int value) {
return AppendBasicTypeValueData(writer, value);
}
void operator()(double value) {
return AppendBasicTypeValueData(writer, value);
}
void operator()(std::string_view value) {
return AppendBasicTypeValueData(writer, value);
}
void operator()(const base::Value::BlobStorage& value) {
DLOG(ERROR) << "Unexpected type: " << base::Value::Type::BINARY;
}
void operator()(const base::Value::Dict& value) {
dbus::MessageWriter array_writer(nullptr);
writer->OpenArray("{sv}", &array_writer);
for (auto item : value) {
dbus::MessageWriter dict_entry_writer(nullptr);
array_writer.OpenDictEntry(&dict_entry_writer);
dict_entry_writer.AppendString(item.first);
AppendValueDataAsVariant(&dict_entry_writer, item.second);
array_writer.CloseContainer(&dict_entry_writer);
}
writer->CloseContainer(&array_writer);
}
void operator()(const base::Value::List& value) {
dbus::MessageWriter array_writer(nullptr);
writer->OpenArray("v", &array_writer);
for (const auto& value_in_list : value) {
AppendValueDataAsVariant(&array_writer, value_in_list);
}
writer->CloseContainer(&array_writer);
}
};
value.Visit(Visitor{.writer = writer});
}
void AppendValueDataAsVariant(MessageWriter* writer, base::ValueView value) {
MessageWriter variant_writer(nullptr);
writer->OpenVariant(GetTypeSignature(value), &variant_writer);
AppendValueData(&variant_writer, value);
writer->CloseContainer(&variant_writer);
}
} // namespace dbus
|