/****************************************************************************** * Project: Common Portability Library * Purpose: Function wrapper for libjson-c access. * Author: Dmitry Baryshnikov, dmitry.baryshnikov@nextgis.com * ****************************************************************************** * Copyright (c) 2017-2018 NextGIS, * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER * DEALINGS IN THE SOFTWARE. ****************************************************************************/ #include "cpl_json.h" #include "cpl_error.h" #include "cpl_json_header.h" #include "cpl_vsi.h" #include "cpl_http.h" #include "cpl_multiproc.h" #define TO_JSONOBJ(x) static_cast(x) static const char *JSON_PATH_DELIMITER = "/"; static const char *INVALID_OBJ_KEY = "__INVALID_OBJ_KEY__"; #define JSON_C_VER_014 (14 << 8) // json_object_new_uint64() was added in libjson-c 0.14 #if (!defined(JSON_C_VERSION_NUM)) || (JSON_C_VERSION_NUM < JSON_C_VER_014) static int CPLJSON_json_object_new_uint64_formatter(struct json_object *jso, struct printbuf *pb, int /* level */, int /* flags */) { const char *pszStr = json_object_get_string(jso); return printbuf_memappend(pb, pszStr, static_cast(strlen(pszStr))); } static json_object *CPLJSON_json_object_new_uint64(uint64_t nVal) { json_object *jso = json_object_new_string( CPLSPrintf(CPL_FRMT_GUIB, static_cast(nVal))); json_object_set_serializer(jso, CPLJSON_json_object_new_uint64_formatter, nullptr, nullptr); return jso; } #define json_object_new_uint64 CPLJSON_json_object_new_uint64 #endif //------------------------------------------------------------------------------ // JSONDocument //------------------------------------------------------------------------------ /*! @cond Doxygen_Suppress */ CPLJSONDocument::CPLJSONDocument() : m_poRootJsonObject(nullptr) { } CPLJSONDocument::~CPLJSONDocument() { if (m_poRootJsonObject) json_object_put(TO_JSONOBJ(m_poRootJsonObject)); } CPLJSONDocument::CPLJSONDocument(const CPLJSONDocument &other) : m_poRootJsonObject(json_object_get(TO_JSONOBJ(other.m_poRootJsonObject))) { } CPLJSONDocument &CPLJSONDocument::operator=(const CPLJSONDocument &other) { if (this == &other) return *this; if (m_poRootJsonObject) json_object_put(TO_JSONOBJ(m_poRootJsonObject)); m_poRootJsonObject = json_object_get(TO_JSONOBJ(other.m_poRootJsonObject)); return *this; } CPLJSONDocument::CPLJSONDocument(CPLJSONDocument &&other) : m_poRootJsonObject(other.m_poRootJsonObject) { other.m_poRootJsonObject = nullptr; } CPLJSONDocument &CPLJSONDocument::operator=(CPLJSONDocument &&other) { if (this == &other) return *this; if (m_poRootJsonObject) json_object_put(TO_JSONOBJ(m_poRootJsonObject)); m_poRootJsonObject = other.m_poRootJsonObject; other.m_poRootJsonObject = nullptr; return *this; } /*! @endcond */ /** * Save json document at specified path * @param osPath Path to save json document * @return true on success. If error occurred it can be received using * CPLGetLastErrorMsg method. * * @since GDAL 2.3 */ bool CPLJSONDocument::Save(const std::string &osPath) const { VSILFILE *fp = VSIFOpenL(osPath.c_str(), "wt"); if (nullptr == fp) { CPLError(CE_Failure, CPLE_NoWriteAccess, "Open file %s to write failed", osPath.c_str()); return false; } const char *pabyData = json_object_to_json_string_ext( TO_JSONOBJ(m_poRootJsonObject), JSON_C_TO_STRING_PRETTY); VSIFWriteL(pabyData, 1, strlen(pabyData), fp); VSIFCloseL(fp); return true; } /** * Return the json document as a serialized string. * @return serialized document. * * @since GDAL 2.3 */ std::string CPLJSONDocument::SaveAsString() const { return json_object_to_json_string_ext(TO_JSONOBJ(m_poRootJsonObject), JSON_C_TO_STRING_PRETTY); } /** * Get json document root object * @return CPLJSONObject class instance * * @since GDAL 3.1 */ const CPLJSONObject CPLJSONDocument::GetRoot() const { return const_cast(this)->GetRoot(); } /** * Get json document root object * @return CPLJSONObject class instance * * @since GDAL 2.3 */ CPLJSONObject CPLJSONDocument::GetRoot() { if (nullptr == m_poRootJsonObject) { m_poRootJsonObject = json_object_new_object(); } if (json_object_get_type(TO_JSONOBJ(m_poRootJsonObject)) == json_type_array) { return CPLJSONArray("", m_poRootJsonObject); } else { return CPLJSONObject("", m_poRootJsonObject); } } /** * Set json document root object * @param oRoot CPLJSONObject root object * * @since GDAL 3.4 */ void CPLJSONDocument::SetRoot(const CPLJSONObject &oRoot) { if (m_poRootJsonObject) json_object_put(TO_JSONOBJ(m_poRootJsonObject)); m_poRootJsonObject = json_object_get(TO_JSONOBJ(oRoot.m_poJsonObject)); } /** * Load json document from file by provided path * @param osPath Path to json file. * @return true on success. If error occurred it can be received using * CPLGetLastErrorMsg method. * * @since GDAL 2.3 */ bool CPLJSONDocument::Load(const std::string &osPath) { GByte *pabyOut = nullptr; vsi_l_offset nSize = 0; if (!VSIIngestFile(nullptr, osPath.c_str(), &pabyOut, &nSize, 100 * 1024 * 1024)) // Maximum 100 Mb allowed { CPLError(CE_Failure, CPLE_FileIO, "Load json file %s failed", osPath.c_str()); return false; } bool bResult = LoadMemory(pabyOut, static_cast(nSize)); VSIFree(pabyOut); return bResult; } /** * Load json document from memory buffer. * @param pabyData Buffer.data. * @param nLength Buffer size. * @return true on success. If error occurred it can be received using * CPLGetLastErrorMsg method. * * @since GDAL 2.3 */ bool CPLJSONDocument::LoadMemory(const GByte *pabyData, int nLength) { if (nullptr == pabyData) { return false; } if (m_poRootJsonObject) json_object_put(TO_JSONOBJ(m_poRootJsonObject)); if (nLength == 4 && memcmp(reinterpret_cast(pabyData), "true", nLength) == 0) { m_poRootJsonObject = json_object_new_boolean(true); return true; } if (nLength == 5 && memcmp(reinterpret_cast(pabyData), "false", nLength) == 0) { m_poRootJsonObject = json_object_new_boolean(false); return true; } json_tokener *jstok = json_tokener_new(); m_poRootJsonObject = json_tokener_parse_ex( jstok, reinterpret_cast(pabyData), nLength); bool bParsed = jstok->err == json_tokener_success; if (!bParsed) { CPLError(CE_Failure, CPLE_AppDefined, "JSON parsing error: %s (at offset %d)", json_tokener_error_desc(jstok->err), jstok->char_offset); json_tokener_free(jstok); return false; } json_tokener_free(jstok); return bParsed; } /** * Load json document from memory buffer. * @param osStr String * @return true on success. If error occurred it can be received using * CPLGetLastErrorMsg method. * * @since GDAL 2.3 */ bool CPLJSONDocument::LoadMemory(const std::string &osStr) { if (osStr.empty()) return false; return LoadMemory(reinterpret_cast(osStr.data()), static_cast(osStr.size())); } /** * Load json document from file using small chunks of data. * @param osPath Path to json document file. * @param nChunkSize Chunk size. * @param pfnProgress a function to report progress of the json data loading. * @param pProgressArg application data passed into progress function. * @return true on success. If error occurred it can be received * using CPLGetLastErrorMsg method. * * @since GDAL 2.3 */ bool CPLJSONDocument::LoadChunks(const std::string &osPath, size_t nChunkSize, GDALProgressFunc pfnProgress, void *pProgressArg) { VSIStatBufL sStatBuf; if (VSIStatL(osPath.c_str(), &sStatBuf) != 0) { CPLError(CE_Failure, CPLE_FileIO, "Cannot open %s", osPath.c_str()); return false; } VSILFILE *fp = VSIFOpenL(osPath.c_str(), "rb"); if (fp == nullptr) { CPLError(CE_Failure, CPLE_FileIO, "Cannot open %s", osPath.c_str()); return false; } void *pBuffer = CPLMalloc(nChunkSize); json_tokener *tok = json_tokener_new(); bool bSuccess = true; GUInt32 nFileSize = static_cast(sStatBuf.st_size); double dfTotalRead = 0.0; while (true) { size_t nRead = VSIFReadL(pBuffer, 1, nChunkSize, fp); dfTotalRead += nRead; if (m_poRootJsonObject) json_object_put(TO_JSONOBJ(m_poRootJsonObject)); m_poRootJsonObject = json_tokener_parse_ex( tok, static_cast(pBuffer), static_cast(nRead)); enum json_tokener_error jerr = json_tokener_get_error(tok); if (jerr != json_tokener_continue && jerr != json_tokener_success) { CPLError(CE_Failure, CPLE_AppDefined, "JSON error: %s", json_tokener_error_desc(jerr)); bSuccess = false; break; } if (nRead < nChunkSize) { break; } if (nullptr != pfnProgress) { pfnProgress(dfTotalRead / nFileSize, "Loading ...", pProgressArg); } } json_tokener_free(tok); CPLFree(pBuffer); VSIFCloseL(fp); if (nullptr != pfnProgress) { pfnProgress(1.0, "Loading ...", pProgressArg); } return bSuccess; } /*! @cond Doxygen_Suppress */ #ifdef HAVE_CURL typedef struct { json_object *pObject; json_tokener *pTokener; } JsonContext, *JsonContextL; static size_t CPLJSONWriteFunction(void *pBuffer, size_t nSize, size_t nMemb, void *pUserData) { size_t nLength = nSize * nMemb; JsonContextL ctx = static_cast(pUserData); if (ctx->pObject != nullptr) { CPLError(CE_Failure, CPLE_AppDefined, "A complete JSon object had already been parsed before new " "content is appended to it"); return 0; } ctx->pObject = json_tokener_parse_ex(ctx->pTokener, static_cast(pBuffer), static_cast(nLength)); switch (json_tokener_get_error(ctx->pTokener)) { case json_tokener_continue: case json_tokener_success: return nLength; default: return 0; /* error: interrupt the transfer */ } } #endif // HAVE_CURL /*! @endcond */ /** * Load json document from web. * @param osUrl Url to json document. * @param papszOptions Option list as a NULL-terminated array of strings. May * be NULL. The available keys are same for CPLHTTPFetch method. Additional key * JSON_DEPTH define json parse depth. Default is 10. * @param pfnProgress a function to report progress of the json data loading. * @param pProgressArg application data passed into progress function. * @return true on success. If error occurred it can be received * using CPLGetLastErrorMsg method. * * @since GDAL 2.3 */ #ifdef HAVE_CURL bool CPLJSONDocument::LoadUrl(const std::string &osUrl, const char *const *papszOptions, GDALProgressFunc pfnProgress, void *pProgressArg) #else bool CPLJSONDocument::LoadUrl(const std::string & /*osUrl*/, const char *const * /*papszOptions*/, GDALProgressFunc /*pfnProgress*/, void * /*pProgressArg*/) #endif // HAVE_CURL { #ifdef HAVE_CURL int nDepth = atoi(CSLFetchNameValueDef(papszOptions, "JSON_DEPTH", "32")); // Same as JSON_TOKENER_DEFAULT_DEPTH JsonContext ctx = {nullptr, json_tokener_new_ex(nDepth)}; CPLHTTPFetchWriteFunc pWriteFunc = CPLJSONWriteFunction; CPLHTTPResult *psResult = CPLHTTPFetchEx(osUrl.c_str(), papszOptions, pfnProgress, pProgressArg, pWriteFunc, &ctx); bool bResult = psResult->nStatus == 0 /*CURLE_OK*/ && psResult->pszErrBuf == nullptr; CPLHTTPDestroyResult(psResult); enum json_tokener_error jerr; if ((jerr = json_tokener_get_error(ctx.pTokener)) != json_tokener_success) { CPLError(CE_Failure, CPLE_AppDefined, "JSON error: %s\n", json_tokener_error_desc(jerr)); bResult = false; } else { if (m_poRootJsonObject) json_object_put(TO_JSONOBJ(m_poRootJsonObject)); m_poRootJsonObject = ctx.pObject; } json_tokener_free(ctx.pTokener); return bResult; #else CPLError(CE_Failure, CPLE_NotSupported, "LoadUrl() not supported in a build without Curl"); return false; #endif } //------------------------------------------------------------------------------ // JSONObject //------------------------------------------------------------------------------ /*! @cond Doxygen_Suppress */ CPLJSONObject::CPLJSONObject() : m_poJsonObject(json_object_new_object()) { } CPLJSONObject::CPLJSONObject(std::nullptr_t) : m_poJsonObject(nullptr) { } CPLJSONObject::CPLJSONObject(const std::string &osVal) : m_poJsonObject(json_object_new_string(osVal.c_str())) { } CPLJSONObject::CPLJSONObject(const char *pszValue) : m_poJsonObject(json_object_new_string(pszValue)) { } CPLJSONObject::CPLJSONObject(bool bVal) : m_poJsonObject(json_object_new_boolean(bVal)) { } CPLJSONObject::CPLJSONObject(int nVal) : m_poJsonObject(json_object_new_int(nVal)) { } CPLJSONObject::CPLJSONObject(int64_t nVal) : m_poJsonObject(json_object_new_int64(nVal)) { } CPLJSONObject::CPLJSONObject(uint64_t nVal) : m_poJsonObject(json_object_new_uint64(nVal)) { } CPLJSONObject::CPLJSONObject(double dfVal) : m_poJsonObject(json_object_new_double(dfVal)) { } CPLJSONObject::CPLJSONObject(const std::string &osName, const CPLJSONObject &oParent) : m_poJsonObject(json_object_get(json_object_new_object())), m_osKey(osName) { json_object_object_add(TO_JSONOBJ(oParent.m_poJsonObject), osName.c_str(), TO_JSONOBJ(m_poJsonObject)); } CPLJSONObject::CPLJSONObject(const std::string &osName, JSONObjectH poJsonObject) : m_poJsonObject(json_object_get(TO_JSONOBJ(poJsonObject))), m_osKey(osName) { } CPLJSONObject CPLJSONObject::Clone() const { CPLJSONObject oRet; if (IsValid()) { CPLJSONDocument oTmpDoc; oTmpDoc.SetRoot(*this); std::string osStr = oTmpDoc.SaveAsString(); CPL_IGNORE_RET_VAL(oTmpDoc.LoadMemory(osStr)); oRet = oTmpDoc.GetRoot(); } return oRet; } CPLJSONObject::~CPLJSONObject() { // Should delete m_poJsonObject only if CPLJSONObject has no parent if (m_poJsonObject) { json_object_put(TO_JSONOBJ(m_poJsonObject)); m_poJsonObject = nullptr; } } CPLJSONObject::CPLJSONObject(const CPLJSONObject &other) : m_poJsonObject(json_object_get(TO_JSONOBJ(other.m_poJsonObject))), m_osKey(other.m_osKey) { } CPLJSONObject::CPLJSONObject(CPLJSONObject &&other) : m_poJsonObject(other.m_poJsonObject), m_osKey(std::move(other.m_osKey)) { other.m_poJsonObject = nullptr; } CPLJSONObject &CPLJSONObject::operator=(const CPLJSONObject &other) { if (this == &other) return *this; m_osKey = other.m_osKey; if (m_poJsonObject) json_object_put(TO_JSONOBJ(m_poJsonObject)); m_poJsonObject = json_object_get(TO_JSONOBJ(other.m_poJsonObject)); return *this; } CPLJSONObject &CPLJSONObject::operator=(CPLJSONObject &&other) { if (this == &other) return *this; m_osKey = std::move(other.m_osKey); if (m_poJsonObject) json_object_put(TO_JSONOBJ(m_poJsonObject)); m_poJsonObject = other.m_poJsonObject; other.m_poJsonObject = nullptr; return *this; } /*! @endcond */ /** * Add new key - value pair to json object. * @param osName Key name. * @param osValue String value. * * @since GDAL 2.3 */ void CPLJSONObject::Add(const std::string &osName, const std::string &osValue) { std::string objectName; if (m_osKey == INVALID_OBJ_KEY) m_osKey.clear(); CPLJSONObject object = GetObjectByPath(osName, objectName); if (object.IsValid() && json_object_get_type(TO_JSONOBJ( object.m_poJsonObject)) == json_type_object) { json_object *poVal = json_object_new_string(osValue.c_str()); json_object_object_add(TO_JSONOBJ(object.GetInternalHandle()), objectName.c_str(), poVal); } } /** * Add new key - value pair to json object. * @param osName Key name. * @param pszValue String value. * * @since GDAL 2.3 */ void CPLJSONObject::Add(const std::string &osName, const char *pszValue) { if (nullptr == pszValue) { return; } if (m_osKey == INVALID_OBJ_KEY) m_osKey.clear(); std::string objectName; CPLJSONObject object = GetObjectByPath(osName, objectName); if (object.IsValid() && json_object_get_type(TO_JSONOBJ( object.m_poJsonObject)) == json_type_object) { json_object *poVal = json_object_new_string(pszValue); json_object_object_add(TO_JSONOBJ(object.GetInternalHandle()), objectName.c_str(), poVal); } } // defined in ogr/ogrsf_frmts/geojson/ogrgeojsonwriter.cpp CPL_C_START /* %.XXXg formatting */ json_object CPL_DLL * json_object_new_double_with_significant_figures(double dfVal, int nSignificantFigures); CPL_C_END /** * Add new key - value pair to json object. * @param osName Key name. * @param dfValue Double value. * * @since GDAL 2.3 */ void CPLJSONObject::Add(const std::string &osName, double dfValue) { std::string objectName; if (m_osKey == INVALID_OBJ_KEY) m_osKey.clear(); CPLJSONObject object = GetObjectByPath(osName, objectName); if (object.IsValid() && json_object_get_type(TO_JSONOBJ( object.m_poJsonObject)) == json_type_object) { json_object *poVal = json_object_new_double_with_significant_figures(dfValue, -1); json_object_object_add(TO_JSONOBJ(object.GetInternalHandle()), objectName.c_str(), poVal); } } /** * Add new key - value pair to json object. * @param osName Key name. * @param nValue Integer value. * * @since GDAL 2.3 */ void CPLJSONObject::Add(const std::string &osName, int nValue) { std::string objectName; if (m_osKey == INVALID_OBJ_KEY) m_osKey.clear(); CPLJSONObject object = GetObjectByPath(osName, objectName); if (object.IsValid() && json_object_get_type(TO_JSONOBJ( object.m_poJsonObject)) == json_type_object) { json_object *poVal = json_object_new_int(nValue); json_object_object_add(TO_JSONOBJ(object.GetInternalHandle()), objectName.c_str(), poVal); } } /** * Add new key - value pair to json object. * @param osName Key name. * @param nValue Long value. * * @since GDAL 2.3 */ void CPLJSONObject::Add(const std::string &osName, GInt64 nValue) { std::string objectName; if (m_osKey == INVALID_OBJ_KEY) m_osKey.clear(); CPLJSONObject object = GetObjectByPath(osName, objectName); if (object.IsValid() && json_object_get_type(TO_JSONOBJ( object.m_poJsonObject)) == json_type_object) { json_object *poVal = json_object_new_int64(static_cast(nValue)); json_object_object_add(TO_JSONOBJ(object.GetInternalHandle()), objectName.c_str(), poVal); } } /** * Add new key - value pair to json object. * @param osName Key name. * @param nValue uint64_t value. * * @since GDAL 3.8 */ void CPLJSONObject::Add(const std::string &osName, uint64_t nValue) { std::string objectName; if (m_osKey == INVALID_OBJ_KEY) m_osKey.clear(); CPLJSONObject object = GetObjectByPath(osName, objectName); if (object.IsValid() && json_object_get_type(TO_JSONOBJ( object.m_poJsonObject)) == json_type_object) { json_object *poVal = json_object_new_uint64(nValue); json_object_object_add(TO_JSONOBJ(object.GetInternalHandle()), objectName.c_str(), poVal); } } /** * Add new key - value pair to json object. * @param osName Key name. * @param oValue Array value. * * @since GDAL 2.3 */ void CPLJSONObject::Add(const std::string &osName, const CPLJSONArray &oValue) { std::string objectName; if (m_osKey == INVALID_OBJ_KEY) m_osKey.clear(); CPLJSONObject object = GetObjectByPath(osName, objectName); if (object.IsValid() && json_object_get_type(TO_JSONOBJ( object.m_poJsonObject)) == json_type_object) { json_object_object_add( TO_JSONOBJ(object.GetInternalHandle()), objectName.c_str(), json_object_get(TO_JSONOBJ(oValue.GetInternalHandle()))); } } /** * Add new key - value pair to json object. * @param osName Key name. * @param oValue Json object value. * * @since GDAL 2.3 */ void CPLJSONObject::Add(const std::string &osName, const CPLJSONObject &oValue) { std::string objectName; if (m_osKey == INVALID_OBJ_KEY) m_osKey.clear(); if (osName.empty()) { json_object_object_add( TO_JSONOBJ(GetInternalHandle()), "", json_object_get(TO_JSONOBJ(oValue.GetInternalHandle()))); return; } CPLJSONObject object = GetObjectByPath(osName, objectName); if (object.IsValid() && json_object_get_type(TO_JSONOBJ( object.m_poJsonObject)) == json_type_object) { json_object_object_add( TO_JSONOBJ(object.GetInternalHandle()), objectName.c_str(), json_object_get(TO_JSONOBJ(oValue.GetInternalHandle()))); } } /** * Add new key - value pair to json object. * @param osName Key name (do not split it on '/') * @param oValue Json object value. * * @since GDAL 3.2 */ void CPLJSONObject::AddNoSplitName(const std::string &osName, const CPLJSONObject &oValue) { if (m_osKey == INVALID_OBJ_KEY) m_osKey.clear(); if (IsValid() && json_object_get_type(TO_JSONOBJ(m_poJsonObject)) == json_type_object) { json_object_object_add( TO_JSONOBJ(GetInternalHandle()), osName.c_str(), json_object_get(TO_JSONOBJ(oValue.GetInternalHandle()))); } } /** * Add new key - value pair to json object. * @param osName Key name. * @param bValue Boolean value. * * @since GDAL 2.3 */ void CPLJSONObject::Add(const std::string &osName, bool bValue) { std::string objectName; if (m_osKey == INVALID_OBJ_KEY) m_osKey.clear(); CPLJSONObject object = GetObjectByPath(osName, objectName); if (object.IsValid() && json_object_get_type(TO_JSONOBJ( object.m_poJsonObject)) == json_type_object) { json_object *poVal = json_object_new_boolean(bValue); json_object_object_add(TO_JSONOBJ(object.GetInternalHandle()), objectName.c_str(), poVal); } } /** * Add new key - null pair to json object. * @param osName Key name. * * @since GDAL 2.3 */ void CPLJSONObject::AddNull(const std::string &osName) { std::string objectName; if (m_osKey == INVALID_OBJ_KEY) m_osKey.clear(); CPLJSONObject object = GetObjectByPath(osName, objectName); if (object.IsValid() && json_object_get_type(TO_JSONOBJ( object.m_poJsonObject)) == json_type_object) { json_object_object_add(TO_JSONOBJ(object.GetInternalHandle()), objectName.c_str(), nullptr); } } /** * Change value by key. * @param osName Key name. * @param osValue String value. * * @since GDAL 2.3 */ void CPLJSONObject::Set(const std::string &osName, const std::string &osValue) { Delete(osName); Add(osName, osValue); } /** * Change value by key. * @param osName Key name. * @param pszValue String value. * * @since GDAL 2.3 */ void CPLJSONObject::Set(const std::string &osName, const char *pszValue) { if (nullptr == pszValue) return; Delete(osName); Add(osName, pszValue); } /** * Change value by key. * @param osName Key name. * @param dfValue Double value. * * @since GDAL 2.3 */ void CPLJSONObject::Set(const std::string &osName, double dfValue) { Delete(osName); Add(osName, dfValue); } /** * Change value by key. * @param osName Key name. * @param nValue Integer value. * * @since GDAL 2.3 */ void CPLJSONObject::Set(const std::string &osName, int nValue) { Delete(osName); Add(osName, nValue); } /** * Change value by key. * @param osName Key name. * @param nValue Long value. * * @since GDAL 2.3 */ void CPLJSONObject::Set(const std::string &osName, GInt64 nValue) { Delete(osName); Add(osName, nValue); } /** * Change value by key. * @param osName Key name. * @param nValue uint64_t value. * * @since GDAL 3.8 */ void CPLJSONObject::Set(const std::string &osName, uint64_t nValue) { Delete(osName); Add(osName, nValue); } /** * Change value by key. * @param osName Key name. * @param bValue Boolean value. * * @since GDAL 2.3 */ void CPLJSONObject::Set(const std::string &osName, bool bValue) { Delete(osName); Add(osName, bValue); } /** * Change value by key. * @param osName Key name. * * @since GDAL 2.3 */ void CPLJSONObject::SetNull(const std::string &osName) { Delete(osName); AddNull(osName); } /** * Get value by key. * @param osName Key name. * @return Json array object. * * @since GDAL 2.3 */ CPLJSONArray CPLJSONObject::GetArray(const std::string &osName) const { std::string objectName; CPLJSONObject object = GetObjectByPath(osName, objectName); if (object.IsValid()) { json_object *poVal = nullptr; if (json_object_object_get_ex(TO_JSONOBJ(object.GetInternalHandle()), objectName.c_str(), &poVal)) { if (poVal && json_object_get_type(poVal) == json_type_array) { return CPLJSONArray(objectName, poVal); } } } return CPLJSONArray(INVALID_OBJ_KEY, nullptr); } /** * Get value by key. * @param osName Key name. * @return Json object. * * @since GDAL 2.3 */ CPLJSONObject CPLJSONObject::GetObj(const std::string &osName) const { std::string objectName; CPLJSONObject object = GetObjectByPath(osName, objectName); if (object.IsValid()) { json_object *poVal = nullptr; if (json_object_object_get_ex(TO_JSONOBJ(object.GetInternalHandle()), objectName.c_str(), &poVal)) { return CPLJSONObject(objectName, poVal); } } return CPLJSONObject(INVALID_OBJ_KEY, nullptr); } /** * Get value by key. * @param osName Key name. * @return Json object. * * @since GDAL 2.3 */ CPLJSONObject CPLJSONObject::operator[](const std::string &osName) const { return GetObj(osName); } /** * Delete json object by key. * @param osName Key name. * * @since GDAL 2.3 */ void CPLJSONObject::Delete(const std::string &osName) { std::string objectName; if (m_osKey == INVALID_OBJ_KEY) m_osKey.clear(); CPLJSONObject object = GetObjectByPath(osName, objectName); if (object.IsValid()) { json_object_object_del(TO_JSONOBJ(object.GetInternalHandle()), objectName.c_str()); } } /** * Delete json object by key (without splitting on /) * @param osName Key name. * * @since GDAL 3.4 */ void CPLJSONObject::DeleteNoSplitName(const std::string &osName) { if (m_osKey == INVALID_OBJ_KEY) m_osKey.clear(); if (m_poJsonObject) { json_object_object_del(TO_JSONOBJ(m_poJsonObject), osName.c_str()); } } /** * Get value by key. * @param osName Key name. * @param osDefault Default value. * @return String value. * * @since GDAL 2.3 */ std::string CPLJSONObject::GetString(const std::string &osName, const std::string &osDefault) const { CPLJSONObject object = GetObj(osName); return object.ToString(osDefault); } /** * Get value. * @param osDefault Default value. * @return String value. * * @since GDAL 2.3 */ std::string CPLJSONObject::ToString(const std::string &osDefault) const { if( m_poJsonObject /*&& json_object_get_type( TO_JSONOBJ(m_poJsonObject) ) == json_type_string*/ ) { const char *pszString = json_object_get_string(TO_JSONOBJ(m_poJsonObject)); if (nullptr != pszString) { return pszString; } } return osDefault; } /** * Get value by key. * @param osName Key name. * @param dfDefault Default value. * @return Double value. * * @since GDAL 2.3 */ double CPLJSONObject::GetDouble(const std::string &osName, double dfDefault) const { CPLJSONObject object = GetObj(osName); return object.ToDouble(dfDefault); } /** * Get value * @param dfDefault Default value. * @return Double value. * * @since GDAL 2.3 */ double CPLJSONObject::ToDouble(double dfDefault) const { if( m_poJsonObject /*&& json_object_get_type( TO_JSONOBJ(m_poJsonObject) ) == json_type_double*/ ) return json_object_get_double(TO_JSONOBJ(m_poJsonObject)); return dfDefault; } /** * Get value by key. * @param osName Key name. * @param nDefault Default value. * @return Integer value. * * @since GDAL 2.3 */ int CPLJSONObject::GetInteger(const std::string &osName, int nDefault) const { CPLJSONObject object = GetObj(osName); return object.ToInteger(nDefault); } /** * Get value. * @param nDefault Default value. * @return Integer value. * * @since GDAL 2.3 */ int CPLJSONObject::ToInteger(int nDefault) const { if( m_poJsonObject /*&& json_object_get_type( TO_JSONOBJ(m_poJsonObject) ) == json_type_int*/ ) return json_object_get_int(TO_JSONOBJ(m_poJsonObject)); return nDefault; } /** * Get value by key. * @param osName Key name. * @param nDefault Default value. * @return Long value. * * @since GDAL 2.3 */ GInt64 CPLJSONObject::GetLong(const std::string &osName, GInt64 nDefault) const { CPLJSONObject object = GetObj(osName); return object.ToLong(nDefault); } /** * Get value. * @param nDefault Default value. * @return Long value. * * @since GDAL 2.3 */ GInt64 CPLJSONObject::ToLong(GInt64 nDefault) const { if( m_poJsonObject /*&& json_object_get_type( TO_JSONOBJ(m_poJsonObject) ) == json_type_int*/ ) return static_cast( json_object_get_int64(TO_JSONOBJ(m_poJsonObject))); return nDefault; } /** * Get value by key. * @param osName Key name. * @param bDefault Default value. * @return Boolean value. * * @since GDAL 2.3 */ bool CPLJSONObject::GetBool(const std::string &osName, bool bDefault) const { CPLJSONObject object = GetObj(osName); return object.ToBool(bDefault); } /** * \brief Get json object children. * * This function is useful when keys is not know and need to * iterate over json object items and get keys and values. * * @return Array of CPLJSONObject class instance. * * @since GDAL 2.3 */ std::vector CPLJSONObject::GetChildren() const { std::vector aoChildren; if (nullptr == m_poJsonObject || json_object_get_type(TO_JSONOBJ(m_poJsonObject)) != json_type_object) { return aoChildren; } json_object_iter it; it.key = nullptr; it.val = nullptr; it.entry = nullptr; // cppcheck-suppress cstyleCast json_object_object_foreachC(TO_JSONOBJ(m_poJsonObject), it) { aoChildren.push_back(CPLJSONObject(it.key, it.val)); } return aoChildren; } /** * Get value. * @param bDefault Default value. * @return Boolean value. * * @since GDAL 2.3 */ bool CPLJSONObject::ToBool(bool bDefault) const { if( m_poJsonObject /*&& json_object_get_type( TO_JSONOBJ(m_poJsonObject) ) == json_type_boolean*/ ) return json_object_get_boolean(TO_JSONOBJ(m_poJsonObject)) == 1; return bDefault; } /** * Get value. * @return Array * * @since GDAL 2.3 */ CPLJSONArray CPLJSONObject::ToArray() const { if (m_poJsonObject && json_object_get_type(TO_JSONOBJ(m_poJsonObject)) == json_type_array) return CPLJSONArray("", TO_JSONOBJ(m_poJsonObject)); return CPLJSONArray(INVALID_OBJ_KEY, nullptr); } /** * Stringify object to json format. * @param eFormat Format type, * @return A string in JSON format. * * @since GDAL 2.3 */ std::string CPLJSONObject::Format(PrettyFormat eFormat) const { if (m_poJsonObject) { const char *pszFormatString = nullptr; switch (eFormat) { case PrettyFormat::Spaced: pszFormatString = json_object_to_json_string_ext( TO_JSONOBJ(m_poJsonObject), JSON_C_TO_STRING_SPACED); break; case PrettyFormat::Pretty: pszFormatString = json_object_to_json_string_ext( TO_JSONOBJ(m_poJsonObject), JSON_C_TO_STRING_PRETTY); break; default: pszFormatString = json_object_to_json_string_ext( TO_JSONOBJ(m_poJsonObject), JSON_C_TO_STRING_PLAIN); } if (nullptr != pszFormatString) { return pszFormatString; } } return ""; } /*! @cond Doxygen_Suppress */ CPLJSONObject CPLJSONObject::GetObjectByPath(const std::string &osPath, std::string &osName) const { json_object *poVal = nullptr; // Typically for keys that contain / character if (json_object_object_get_ex(TO_JSONOBJ(GetInternalHandle()), osPath.c_str(), &poVal)) { osName = osPath; return *this; } CPLStringList pathPortions( CSLTokenizeString2(osPath.c_str(), JSON_PATH_DELIMITER, 0)); int portionsCount = pathPortions.size(); if (portionsCount > 100) { CPLError(CE_Failure, CPLE_NotSupported, "Too many components in path"); return CPLJSONObject(INVALID_OBJ_KEY, nullptr); } if (0 == portionsCount) return CPLJSONObject(INVALID_OBJ_KEY, nullptr); CPLJSONObject object = *this; for (int i = 0; i < portionsCount - 1; ++i) { // TODO: check array index in path - i.e. // settings/catalog/root/id:1/name if EQUALN(pathPortions[i+1], "id:", // 3) -> getArray if (json_object_object_get_ex(TO_JSONOBJ(object.GetInternalHandle()), pathPortions[i], &poVal)) { object = CPLJSONObject(pathPortions[i], poVal); } else { if (json_object_get_type(TO_JSONOBJ(object.m_poJsonObject)) != json_type_object) { return CPLJSONObject(INVALID_OBJ_KEY, nullptr); } object = CPLJSONObject(pathPortions[i], object); } } // // Check if such object already exists // if(json_object_object_get_ex(object.m_jsonObject, // pathPortions[portionsCount - 1], &poVal)) // return JSONObject(nullptr); // osName = pathPortions[portionsCount - 1]; return object; } /*! @endcond */ /** * Get json object type. * @return Json object type. * * @since GDAL 2.3 */ CPLJSONObject::Type CPLJSONObject::GetType() const { if (nullptr == m_poJsonObject) { if (m_osKey == INVALID_OBJ_KEY) return CPLJSONObject::Type::Unknown; return CPLJSONObject::Type::Null; } auto jsonObj(TO_JSONOBJ(m_poJsonObject)); switch (json_object_get_type(jsonObj)) { case json_type_boolean: return CPLJSONObject::Type::Boolean; case json_type_double: return CPLJSONObject::Type::Double; case json_type_int: { if (CPL_INT64_FITS_ON_INT32(json_object_get_int64(jsonObj))) return CPLJSONObject::Type::Integer; else return CPLJSONObject::Type::Long; } case json_type_object: return CPLJSONObject::Type::Object; case json_type_array: return CPLJSONObject::Type::Array; case json_type_string: return CPLJSONObject::Type::String; default: break; } return CPLJSONObject::Type::Unknown; } /** * Check if json object valid. * @return true if json object valid. * * @since GDAL 2.3 */ bool CPLJSONObject::IsValid() const { return m_osKey != INVALID_OBJ_KEY; } /** * Decrement reference counter and make pointer NULL. * A json object will become invalid. * * @since GDAL 2.3 */ void CPLJSONObject::Deinit() { if (m_poJsonObject) { json_object_put(TO_JSONOBJ(m_poJsonObject)); m_poJsonObject = nullptr; } m_osKey = INVALID_OBJ_KEY; } //------------------------------------------------------------------------------ // JSONArray //------------------------------------------------------------------------------ /*! @cond Doxygen_Suppress */ CPLJSONArray::CPLJSONArray() { json_object_put(TO_JSONOBJ(m_poJsonObject)); m_poJsonObject = json_object_new_array(); } CPLJSONArray::CPLJSONArray(const std::string &osName) : CPLJSONObject(osName, json_object_new_array()) { json_object_put(TO_JSONOBJ(m_poJsonObject)); } CPLJSONArray::CPLJSONArray(const std::string &osName, JSONObjectH poJsonObject) : CPLJSONObject(osName, poJsonObject) { } CPLJSONArray::CPLJSONArray(const CPLJSONObject &other) : CPLJSONObject(other) { } /*! @endcond */ /** * Get array size. * @return Array size. * * @since GDAL 2.3 */ int CPLJSONArray::Size() const { if (m_poJsonObject) return static_cast( json_object_array_length(TO_JSONOBJ(m_poJsonObject))); return 0; } /** * Add null object to array. * * @since GDAL 3.8 */ void CPLJSONArray::AddNull() { if (m_poJsonObject) json_object_array_add(TO_JSONOBJ(m_poJsonObject), nullptr); } /** * Add json object to array. * @param oValue Json array. * * @since GDAL 2.3 */ void CPLJSONArray::Add(const CPLJSONObject &oValue) { if (m_poJsonObject && oValue.m_poJsonObject) json_object_array_add( TO_JSONOBJ(m_poJsonObject), json_object_get(TO_JSONOBJ(oValue.m_poJsonObject))); } /** * Add value to array * @param osValue Value to add. * * @since GDAL 2.3 */ void CPLJSONArray::Add(const std::string &osValue) { if (m_poJsonObject) json_object_array_add(TO_JSONOBJ(m_poJsonObject), json_object_new_string(osValue.c_str())); } /** * Add value to array * @param pszValue Value to add. * * @since GDAL 2.3 */ void CPLJSONArray::Add(const char *pszValue) { if (nullptr == pszValue) return; if (m_poJsonObject) json_object_array_add(TO_JSONOBJ(m_poJsonObject), json_object_new_string(pszValue)); } /** * Add value to array * @param dfValue Value to add. * * @since GDAL 2.3 */ void CPLJSONArray::Add(double dfValue) { if (m_poJsonObject) json_object_array_add(TO_JSONOBJ(m_poJsonObject), json_object_new_double(dfValue)); } /** * Add value to array * @param nValue Value to add. * * @since GDAL 2.3 */ void CPLJSONArray::Add(int nValue) { if (m_poJsonObject) json_object_array_add(TO_JSONOBJ(m_poJsonObject), json_object_new_int(nValue)); } /** * Add value to array * @param nValue Value to add. * * @since GDAL 2.3 */ void CPLJSONArray::Add(GInt64 nValue) { if (m_poJsonObject) json_object_array_add(TO_JSONOBJ(m_poJsonObject), json_object_new_int64(nValue)); } /** * Add value to array * @param nValue Value to add. * * @since GDAL 3.8 */ void CPLJSONArray::Add(uint64_t nValue) { if (m_poJsonObject) { json_object_array_add(TO_JSONOBJ(m_poJsonObject), json_object_new_uint64(nValue)); } } /** * Add value to array * @param bValue Value to add. * * @since GDAL 2.3 */ void CPLJSONArray::Add(bool bValue) { if (m_poJsonObject) json_object_array_add(TO_JSONOBJ(m_poJsonObject), json_object_new_boolean(bValue)); } /** * Get array item by index. * @param nIndex Item index. * @return Json object. * * @since GDAL 2.3 */ CPLJSONObject CPLJSONArray::operator[](int nIndex) { return CPLJSONObject( CPLSPrintf("id:%d", nIndex), json_object_array_get_idx(TO_JSONOBJ(m_poJsonObject), nIndex)); } /** * Get array const item by index. * @param nIndex Item index. * @return Json object. * * @since GDAL 2.3 */ const CPLJSONObject CPLJSONArray::operator[](int nIndex) const { return CPLJSONObject( CPLSPrintf("id:%d", nIndex), json_object_array_get_idx(TO_JSONOBJ(m_poJsonObject), nIndex)); } /************************************************************************/ /* CPLParseKeyValueJson() */ /************************************************************************/ /** Return a string list of key/value pairs extracted from a JSON doc. We are expecting simple documents with key:value pairs, like the following with no hierarchy or complex structure. \verbatim { "Code" : "Success", "LastUpdated" : "2017-07-03T16:20:17Z", "Type" : "AWS-HMAC", "AccessKeyId" : "bla", "SecretAccessKey" : "bla", "Token" : "bla", "Expiration" : "2017-07-03T22:42:58Z" } \endverbatim @since GDAL 3.7 */ CPLStringList CPLParseKeyValueJson(const char *pszJson) { CPLJSONDocument oDoc; CPLStringList oNameValue; if (pszJson != nullptr && oDoc.LoadMemory(pszJson)) { for (const auto &obj : oDoc.GetRoot().GetChildren()) { const auto eType = obj.GetType(); if (eType == CPLJSONObject::Type::String || eType == CPLJSONObject::Type::Integer || eType == CPLJSONObject::Type::Double) { oNameValue.SetNameValue(obj.GetName().c_str(), obj.ToString().c_str()); } } } return oNameValue; }