/* This file is part of solidity. solidity is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. solidity is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with solidity. If not, see . */ // SPDX-License-Identifier: GPL-3.0 /** @file JSON.cpp * @author Alexander Arlt * @date 2018 */ #include #include #include #include #include #include static_assert( (JSONCPP_VERSION_MAJOR == 1) && (JSONCPP_VERSION_MINOR == 9) && (JSONCPP_VERSION_PATCH == 3), "Unexpected jsoncpp version: " JSONCPP_VERSION_STRING ". Expecting 1.9.3." ); namespace solidity::util { namespace { /// StreamWriterBuilder that can be constructed with specific settings class StreamWriterBuilder: public Json::StreamWriterBuilder { public: explicit StreamWriterBuilder(std::map const& _settings) { for (auto const& iter: _settings) this->settings_[iter.first] = iter.second; } }; /// CharReaderBuilder with strict-mode settings class StrictModeCharReaderBuilder: public Json::CharReaderBuilder { public: StrictModeCharReaderBuilder() { Json::CharReaderBuilder::strictMode(&this->settings_); } }; /// Serialise the JSON object (@a _input) with specific builder (@a _builder) /// \param _input JSON input string /// \param _builder StreamWriterBuilder that is used to create new Json::StreamWriter /// \return serialized json object std::string print(Json::Value const& _input, Json::StreamWriterBuilder const& _builder) { std::stringstream stream; std::unique_ptr writer(_builder.newStreamWriter()); writer->write(_input, &stream); return stream.str(); } /// Parse a JSON string (@a _input) with specified builder (@ _builder) and writes resulting JSON object to (@a _json) /// \param _builder CharReaderBuilder that is used to create new Json::CharReaders /// \param _input JSON input string /// \param _json [out] resulting JSON object /// \param _errs [out] Formatted error messages /// \return \c true if the document was successfully parsed, \c false if an error occurred. bool parse(Json::CharReaderBuilder& _builder, std::string const& _input, Json::Value& _json, std::string* _errs) { std::unique_ptr reader(_builder.newCharReader()); return reader->parse(_input.c_str(), _input.c_str() + _input.length(), &_json, _errs); } /// Takes a JSON value (@ _json) and removes all its members with value 'null' recursively. void removeNullMembersHelper(Json::Value& _json) { if (_json.type() == Json::ValueType::arrayValue) for (auto& child: _json) removeNullMembersHelper(child); else if (_json.type() == Json::ValueType::objectValue) for (auto const& key: _json.getMemberNames()) { Json::Value& value = _json[key]; if (value.isNull()) _json.removeMember(key); else removeNullMembersHelper(value); } } } // end anonymous namespace Json::Value removeNullMembers(Json::Value _json) { removeNullMembersHelper(_json); return _json; } std::string jsonPrettyPrint(Json::Value const& _input) { return jsonPrint(_input, JsonFormat{ JsonFormat::Pretty }); } std::string jsonCompactPrint(Json::Value const& _input) { return jsonPrint(_input, JsonFormat{ JsonFormat::Compact }); } std::string jsonPrint(Json::Value const& _input, JsonFormat const& _format) { std::map settings; if (_format.format == JsonFormat::Pretty) { settings["indentation"] = std::string(_format.indent, ' '); settings["enableYAMLCompatibility"] = true; } else settings["indentation"] = ""; StreamWriterBuilder writerBuilder(settings); std::string result = print(_input, writerBuilder); if (_format.format == JsonFormat::Pretty) boost::replace_all(result, " \n", "\n"); return result; } bool jsonParseStrict(std::string const& _input, Json::Value& _json, std::string* _errs /* = nullptr */) { static StrictModeCharReaderBuilder readerBuilder; return parse(readerBuilder, _input, _json, _errs); } std::optional jsonValueByPath(Json::Value const& _node, std::string_view _jsonPath) { if (!_node.isObject() || _jsonPath.empty()) return {}; std::string memberName = std::string(_jsonPath.substr(0, _jsonPath.find_first_of('.'))); if (!_node.isMember(memberName)) return {}; if (memberName == _jsonPath) return _node[memberName]; return jsonValueByPath(_node[memberName], _jsonPath.substr(memberName.size() + 1)); } } // namespace solidity::util