From c72f41fdd399c3ebfc44ba55666831ddec1ee25f Mon Sep 17 00:00:00 2001 From: Alexander Couzens Date: Mon, 22 Aug 2022 21:33:16 +0200 Subject: [PATCH 01/12] [dbi]: ogs_mongoc.h: remove include To allow the include to work even when build without mongo installed. No data types require mongoc.h to be in ogs_mongoc.h. --- lib/dbi/ims.c | 2 ++ lib/dbi/ogs-mongoc.h | 2 -- lib/dbi/session.c | 2 ++ lib/dbi/subscription.c | 2 ++ tests/common/context.c | 2 ++ tests/common/context.h | 2 ++ 6 files changed, 10 insertions(+), 2 deletions(-) diff --git a/lib/dbi/ims.c b/lib/dbi/ims.c index bdff0425ce..dfe6afb1d1 100644 --- a/lib/dbi/ims.c +++ b/lib/dbi/ims.c @@ -17,6 +17,8 @@ * along with this program. If not, see . */ +#include + #include "ogs-dbi.h" int ogs_dbi_msisdn_data( diff --git a/lib/dbi/ogs-mongoc.h b/lib/dbi/ogs-mongoc.h index 9e3b4515ba..5caa37985f 100644 --- a/lib/dbi/ogs-mongoc.h +++ b/lib/dbi/ogs-mongoc.h @@ -24,8 +24,6 @@ #ifndef OGS_MONGOC_H #define OGS_MONGOC_H -#include - #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ diff --git a/lib/dbi/session.c b/lib/dbi/session.c index d0edb72182..ff1bbc9bce 100644 --- a/lib/dbi/session.c +++ b/lib/dbi/session.c @@ -17,6 +17,8 @@ * along with this program. If not, see . */ +#include + #include "ogs-dbi.h" int ogs_dbi_session_data(char *supi, ogs_s_nssai_t *s_nssai, char *dnn, diff --git a/lib/dbi/subscription.c b/lib/dbi/subscription.c index dfd86214fa..a541c21448 100644 --- a/lib/dbi/subscription.c +++ b/lib/dbi/subscription.c @@ -17,6 +17,8 @@ * along with this program. If not, see . */ +#include + #include "ogs-dbi.h" int ogs_dbi_auth_info(char *supi, ogs_dbi_auth_info_t *auth_info) diff --git a/tests/common/context.c b/tests/common/context.c index 628d29406b..0c33bae176 100644 --- a/tests/common/context.c +++ b/tests/common/context.c @@ -17,6 +17,8 @@ * along with this program. If not, see . */ +#include + #include "test-config-private.h" #include "test-common.h" diff --git a/tests/common/context.h b/tests/common/context.h index 5481defd15..e62a578412 100644 --- a/tests/common/context.h +++ b/tests/common/context.h @@ -24,6 +24,8 @@ #ifndef TEST_COMMON_CONTEXT_H #define TEST_COMMON_CONTEXT_H +#include + #ifdef __cplusplus extern "C" { #endif From 8b3abcce2d43576487c303c66ae77d9022fda4b8 Mon Sep 17 00:00:00 2001 From: Alexander Couzens Date: Mon, 22 Aug 2022 21:25:29 +0200 Subject: [PATCH 02/12] [dbi]: ogs-dbi.h: add comment to the include of ogs-mongoc.h The only user of ogs-mongoc.h are the tests. Add comment to remove the comment as soon they aren't depend on the ogs-mongoc.h --- lib/dbi/ogs-dbi.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/dbi/ogs-dbi.h b/lib/dbi/ogs-dbi.h index 66e1b6c3c9..67bc0c1e0f 100644 --- a/lib/dbi/ogs-dbi.h +++ b/lib/dbi/ogs-dbi.h @@ -24,7 +24,9 @@ #define OGS_DBI_INSIDE +/* TODO: remove ogs-mongoc.h as soon the test cases don't depend on it */ #include "dbi/ogs-mongoc.h" + #include "dbi/subscription.h" #include "dbi/session.h" #include "dbi/ims.h" From 68efeac90985cddc539fc70e7a20617281f7ccdc Mon Sep 17 00:00:00 2001 From: Alexander Couzens Date: Mon, 22 Aug 2022 20:54:48 +0200 Subject: [PATCH 03/12] [dbi]: move all mongo related files into subdirectory --- lib/dbi/meson.build | 24 +++++++++++++++--------- lib/dbi/{ => mongo}/ims.c | 0 lib/dbi/{ => mongo}/ogs-mongoc.c | 0 lib/dbi/{ => mongo}/ogs-mongoc.h | 0 lib/dbi/{ => mongo}/session.c | 0 lib/dbi/{ => mongo}/subscription.c | 0 lib/dbi/ogs-dbi.h | 2 +- 7 files changed, 16 insertions(+), 10 deletions(-) rename lib/dbi/{ => mongo}/ims.c (100%) rename lib/dbi/{ => mongo}/ogs-mongoc.c (100%) rename lib/dbi/{ => mongo}/ogs-mongoc.h (100%) rename lib/dbi/{ => mongo}/session.c (100%) rename lib/dbi/{ => mongo}/subscription.c (100%) diff --git a/lib/dbi/meson.build b/lib/dbi/meson.build index a48f477856..c0aa380e04 100644 --- a/lib/dbi/meson.build +++ b/lib/dbi/meson.build @@ -15,18 +15,24 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . -libdbi_sources = files(''' - ogs-dbi.h - - ogs-mongoc.h - ogs-mongoc.c - subscription.c - session.c - ims.c +dbi_sources = files(''' + ogs-dbi.h +'''.split()) +libdbi_sources = [dbi_sources] + +mongo_sources = files(''' + mongo/ogs-mongoc.h + mongo/ogs-mongoc.c + mongo/subscription.c + mongo/session.c + mongo/ims.c '''.split()) -libmongoc_dep = dependency('libmongoc-1.0') +libmongoc_dep = dependency('libmongoc-1.0', required: true) +if libmongoc_dep.found() + libdbi_sources += [mongo_sources] +endif libdbi_inc = include_directories('.') diff --git a/lib/dbi/ims.c b/lib/dbi/mongo/ims.c similarity index 100% rename from lib/dbi/ims.c rename to lib/dbi/mongo/ims.c diff --git a/lib/dbi/ogs-mongoc.c b/lib/dbi/mongo/ogs-mongoc.c similarity index 100% rename from lib/dbi/ogs-mongoc.c rename to lib/dbi/mongo/ogs-mongoc.c diff --git a/lib/dbi/ogs-mongoc.h b/lib/dbi/mongo/ogs-mongoc.h similarity index 100% rename from lib/dbi/ogs-mongoc.h rename to lib/dbi/mongo/ogs-mongoc.h diff --git a/lib/dbi/session.c b/lib/dbi/mongo/session.c similarity index 100% rename from lib/dbi/session.c rename to lib/dbi/mongo/session.c diff --git a/lib/dbi/subscription.c b/lib/dbi/mongo/subscription.c similarity index 100% rename from lib/dbi/subscription.c rename to lib/dbi/mongo/subscription.c diff --git a/lib/dbi/ogs-dbi.h b/lib/dbi/ogs-dbi.h index 67bc0c1e0f..4eec01a9de 100644 --- a/lib/dbi/ogs-dbi.h +++ b/lib/dbi/ogs-dbi.h @@ -25,7 +25,7 @@ #define OGS_DBI_INSIDE /* TODO: remove ogs-mongoc.h as soon the test cases don't depend on it */ -#include "dbi/ogs-mongoc.h" +#include "dbi/mongo/ogs-mongoc.h" #include "dbi/subscription.h" #include "dbi/session.h" From 9c66348213c229ca5042ce0110b8b703cef2c614 Mon Sep 17 00:00:00 2001 From: Alexander Couzens Date: Mon, 22 Aug 2022 22:57:08 +0200 Subject: [PATCH 04/12] [dbi]: introduce an abstraction layer to allow multiple database backends The current dbi only supports a single database backend. Add an abstraction layer to allow multiple database backends. Introduce a dbi backend struct containing all database functions. --- lib/dbi/dbi-private.h | 57 ++++++++++++++++ lib/dbi/dbi.c | 119 ++++++++++++++++++++++++++++++++++ lib/dbi/meson.build | 5 ++ lib/dbi/mongo/ims.c | 5 +- lib/dbi/mongo/mongo-private.h | 57 ++++++++++++++++ lib/dbi/mongo/ogs-mongoc.c | 26 +++++++- lib/dbi/mongo/ogs-mongoc.h | 1 + lib/dbi/mongo/session.c | 3 +- lib/dbi/mongo/subscription.c | 11 ++-- 9 files changed, 274 insertions(+), 10 deletions(-) create mode 100644 lib/dbi/dbi-private.h create mode 100644 lib/dbi/dbi.c create mode 100644 lib/dbi/mongo/mongo-private.h diff --git a/lib/dbi/dbi-private.h b/lib/dbi/dbi-private.h new file mode 100644 index 0000000000..ebc71e32f0 --- /dev/null +++ b/lib/dbi/dbi-private.h @@ -0,0 +1,57 @@ +/* + * Copyright (C) 2022 by sysmocom - s.f.m.c. GmbH + * Author: Alexander Couzens + * + * This file is part of Open5GS. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program 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 this program. If not, see . + */ + +#if !defined(OGS_DBI_INSIDE) && !defined(OGS_DBI_COMPILATION) +#error "This header cannot be included directly." +#endif + +#ifndef OGS_DBI_PRIVATE_H +#define OGS_DBI_PRIVATE_H + +#ifdef __cplusplus +extern "C" { +#endif + +struct ogs_dbi_s { + const char *name; + /* session */ + int (*session_data)(char *supi, ogs_s_nssai_t *s_nssai, char *dnn, + ogs_session_data_t *data); + /* ims */ + int (*msisdn_data)(char *imsi_or_msisdn_bcd, ogs_msisdn_data_t *msisdn_data); + int (*ims_data)(char *supi, ogs_ims_data_t *ims_data); + /* subscription */ + int (*auth_info)(char *supi, ogs_dbi_auth_info_t *auth_info); + int (*update_sqn)(char *supi, uint64_t sqn); + int (*increment_sqn)(char *supi); + int (*update_imeisv)(char *supi, char *imeisv); + int (*subscription_data)(char *supi, + ogs_subscription_data_t *subscription_data); +}; +typedef struct ogs_dbi_s ogs_dbi_t; + +int ogs_dbi_deselect_interface(void); +int ogs_dbi_select_interface(const char *dbi_name); + +#ifdef __cplusplus +} +#endif + +#endif /* OGS_DBI_PRIVATE_H */ diff --git a/lib/dbi/dbi.c b/lib/dbi/dbi.c new file mode 100644 index 0000000000..96cd76f1ab --- /dev/null +++ b/lib/dbi/dbi.c @@ -0,0 +1,119 @@ +/* + * Copyright (C) 2022 by sysmocom - s.f.m.c. GmbH + * Author: Alexander Couzens + * + * This file is part of Open5GS. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program 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 this program. If not, see . + */ + +#include "ogs-dbi.h" + +#include "dbi-private.h" +#include "dbi-config-private.h" + +#ifdef WITH_MONGOC +#include "mongo/mongo-private.h" +#endif + +int __ogs_dbi_domain; + +static ogs_dbi_t *dbi_interfaces[] = { +#ifdef WITH_MONGOC + &ogs_dbi_mongo_interface, +#endif + NULL, +}; + +static ogs_dbi_t *dbi_selected; + +int ogs_dbi_deselect_interface() +{ + dbi_selected = NULL; + + return 0; +} + +int ogs_dbi_select_interface(const char *dbi_name) +{ + ogs_dbi_t *dbi; + int i; + ogs_assert(dbi_name); + + for (i = 0; i < OGS_ARRAY_SIZE(dbi_interfaces); i++) { + dbi = dbi_interfaces[i]; + if (!ogs_strcasecmp(dbi->name, dbi_name)) { + dbi_selected = dbi; + return 0; + } + } + + ogs_error("Couldn't find dbi interface %s", dbi_name); + return -1; +} + +/* ims */ +int ogs_dbi_msisdn_data( + char *imsi_or_msisdn_bcd, ogs_msisdn_data_t *msisdn_data) +{ + ogs_assert(dbi_selected); + return dbi_selected->msisdn_data(imsi_or_msisdn_bcd, msisdn_data); +} + +int ogs_dbi_ims_data(char *supi, ogs_ims_data_t *ims_data) +{ + ogs_assert(dbi_selected); + return dbi_selected->ims_data(supi, ims_data); +} + +/* session */ +int ogs_dbi_session_data(char *supi, ogs_s_nssai_t *s_nssai, char *dnn, + ogs_session_data_t *session_data) +{ + ogs_assert(dbi_selected); + return dbi_selected->session_data(supi, s_nssai, dnn, session_data); +} + +/* subscription */ +int ogs_dbi_auth_info(char *supi, ogs_dbi_auth_info_t *auth_info) +{ + ogs_assert(dbi_selected); + return dbi_selected->auth_info(supi, auth_info); +} + +int ogs_dbi_update_sqn(char *supi, uint64_t sqn) +{ + ogs_assert(dbi_selected); + return dbi_selected->update_sqn(supi, sqn); +} + +int ogs_dbi_increment_sqn(char *supi) +{ + ogs_assert(dbi_selected); + return dbi_selected->increment_sqn(supi); +} + +int ogs_dbi_update_imeisv(char *supi, char *imeisv) +{ + ogs_assert(dbi_selected); + return dbi_selected->update_imeisv(supi, imeisv); +} + +int ogs_dbi_subscription_data(char *supi, + ogs_subscription_data_t *subscription_data) +{ + ogs_assert(dbi_selected); + return dbi_selected->subscription_data(supi, subscription_data); +} + diff --git a/lib/dbi/meson.build b/lib/dbi/meson.build index c0aa380e04..d788df798f 100644 --- a/lib/dbi/meson.build +++ b/lib/dbi/meson.build @@ -15,9 +15,11 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . +libdbi_conf = configuration_data() dbi_sources = files(''' ogs-dbi.h + dbi.c '''.split()) libdbi_sources = [dbi_sources] @@ -31,9 +33,12 @@ mongo_sources = files(''' libmongoc_dep = dependency('libmongoc-1.0', required: true) if libmongoc_dep.found() + libdbi_conf.set('WITH_MONGOC', 1) libdbi_sources += [mongo_sources] endif +configure_file(output : 'dbi-config-private.h', configuration : libdbi_conf) + libdbi_inc = include_directories('.') libdbi = library('ogsdbi', diff --git a/lib/dbi/mongo/ims.c b/lib/dbi/mongo/ims.c index dfe6afb1d1..8c9818bbf6 100644 --- a/lib/dbi/mongo/ims.c +++ b/lib/dbi/mongo/ims.c @@ -20,8 +20,9 @@ #include #include "ogs-dbi.h" +#include "mongo-private.h" -int ogs_dbi_msisdn_data( +int ogs_dbi_mongo_msisdn_data( char *imsi_or_msisdn_bcd, ogs_msisdn_data_t *msisdn_data) { int rv = OGS_OK; @@ -119,7 +120,7 @@ int ogs_dbi_msisdn_data( return rv; } -int ogs_dbi_ims_data(char *supi, ogs_ims_data_t *ims_data) +int ogs_dbi_mongo_ims_data(char *supi, ogs_ims_data_t *ims_data) { int rv = OGS_OK; mongoc_cursor_t *cursor = NULL; diff --git a/lib/dbi/mongo/mongo-private.h b/lib/dbi/mongo/mongo-private.h new file mode 100644 index 0000000000..4fb787ef62 --- /dev/null +++ b/lib/dbi/mongo/mongo-private.h @@ -0,0 +1,57 @@ +/* + * Copyright (C) 2022 by sysmocom - s.f.m.c. GmbH + * Author: Alexander Couzens + * + * This file is part of Open5GS. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program 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 this program. If not, see . + */ + +#if !defined(OGS_DBI_INSIDE) && !defined(OGS_DBI_COMPILATION) +#error "This header cannot be included directly." +#endif + +#ifndef OGS_DBI_MONGO_PRIVATE_H +#define OGS_DBI_MONGO_PRIVATE_H + +#ifdef __cplusplus +extern "C" { +#endif + +#include "dbi-private.h" + +extern ogs_dbi_t ogs_dbi_mongo_interface; + +/* ims */ +int ogs_dbi_mongo_msisdn_data( + char *imsi_or_msisdn_bcd, ogs_msisdn_data_t *msisdn_data); +int ogs_dbi_mongo_ims_data(char *supi, ogs_ims_data_t *ims_data); + +/* session */ +int ogs_dbi_mongo_session_data(char *supi, ogs_s_nssai_t *s_nssai, char *dnn, + ogs_session_data_t *session_data); + +/* subscription */ +int ogs_dbi_mongo_auth_info(char *supi, ogs_dbi_auth_info_t *auth_info); +int ogs_dbi_mongo_update_sqn(char *supi, uint64_t sqn); +int ogs_dbi_mongo_update_imeisv(char *supi, char *imeisv); +int ogs_dbi_mongo_increment_sqn(char *supi); +int ogs_dbi_mongo_subscription_data(char *supi, + ogs_subscription_data_t *subscription_data); + +#ifdef __cplusplus +} +#endif + +#endif /* OGS_DBI_MONGO_PRIVATE_H */ diff --git a/lib/dbi/mongo/ogs-mongoc.c b/lib/dbi/mongo/ogs-mongoc.c index 19026aca70..f3b38ae7f9 100644 --- a/lib/dbi/mongo/ogs-mongoc.c +++ b/lib/dbi/mongo/ogs-mongoc.c @@ -20,8 +20,8 @@ #include #include "ogs-dbi.h" - -int __ogs_dbi_domain; +#include "dbi-private.h" +#include "mongo-private.h" static ogs_mongoc_t self; @@ -158,11 +158,32 @@ ogs_mongoc_t *ogs_mongoc(void) return &self; } +ogs_dbi_t ogs_dbi_mongo_interface = { + .name = "mongo", + /* session */ + .session_data = ogs_dbi_mongo_session_data, + /* ims */ + .msisdn_data = ogs_dbi_mongo_msisdn_data, + .ims_data = ogs_dbi_mongo_ims_data, + /* subscription */ + .auth_info = ogs_dbi_mongo_auth_info, + .update_sqn = ogs_dbi_mongo_update_sqn, + .increment_sqn = ogs_dbi_mongo_increment_sqn, + .update_imeisv = ogs_dbi_mongo_update_imeisv, + .subscription_data = ogs_dbi_mongo_subscription_data, +}; + int ogs_dbi_init(const char *db_uri) +{ + return ogs_dbi_mongo_init(db_uri); +} + +int ogs_dbi_mongo_init(const char *db_uri) { int rv; ogs_assert(db_uri); + ogs_dbi_select_interface("mongo"); rv = ogs_mongoc_init(db_uri); if (rv != OGS_OK) return rv; @@ -173,6 +194,7 @@ int ogs_dbi_init(const char *db_uri) ogs_assert(self.collection.subscriber); } + return OGS_OK; } diff --git a/lib/dbi/mongo/ogs-mongoc.h b/lib/dbi/mongo/ogs-mongoc.h index 5caa37985f..a17c8e9f4e 100644 --- a/lib/dbi/mongo/ogs-mongoc.h +++ b/lib/dbi/mongo/ogs-mongoc.h @@ -47,6 +47,7 @@ void ogs_mongoc_final(void); ogs_mongoc_t *ogs_mongoc(void); int ogs_dbi_init(const char *db_uri); +int ogs_dbi_mongo_init(const char *db_uri); void ogs_dbi_final(void); #ifdef __cplusplus diff --git a/lib/dbi/mongo/session.c b/lib/dbi/mongo/session.c index ff1bbc9bce..1b82ce88a6 100644 --- a/lib/dbi/mongo/session.c +++ b/lib/dbi/mongo/session.c @@ -20,8 +20,9 @@ #include #include "ogs-dbi.h" +#include "mongo-private.h" -int ogs_dbi_session_data(char *supi, ogs_s_nssai_t *s_nssai, char *dnn, +int ogs_dbi_mongo_session_data(char *supi, ogs_s_nssai_t *s_nssai, char *dnn, ogs_session_data_t *session_data) { int rv = OGS_OK; diff --git a/lib/dbi/mongo/subscription.c b/lib/dbi/mongo/subscription.c index a541c21448..5a7fe3b1d5 100644 --- a/lib/dbi/mongo/subscription.c +++ b/lib/dbi/mongo/subscription.c @@ -20,8 +20,9 @@ #include #include "ogs-dbi.h" +#include "mongo-private.h" -int ogs_dbi_auth_info(char *supi, ogs_dbi_auth_info_t *auth_info) +int ogs_dbi_mongo_auth_info(char *supi, ogs_dbi_auth_info_t *auth_info) { int rv = OGS_OK; mongoc_cursor_t *cursor = NULL; @@ -111,7 +112,7 @@ int ogs_dbi_auth_info(char *supi, ogs_dbi_auth_info_t *auth_info) return rv; } -int ogs_dbi_update_sqn(char *supi, uint64_t sqn) +int ogs_dbi_mongo_update_sqn(char *supi, uint64_t sqn) { int rv = OGS_OK; bson_t *query = NULL; @@ -150,7 +151,7 @@ int ogs_dbi_update_sqn(char *supi, uint64_t sqn) return rv; } -int ogs_dbi_update_imeisv(char *supi, char *imeisv) +int ogs_dbi_mongo_update_imeisv(char *supi, char *imeisv) { int rv = OGS_OK; bson_t *query = NULL; @@ -191,7 +192,7 @@ int ogs_dbi_update_imeisv(char *supi, char *imeisv) return rv; } -int ogs_dbi_increment_sqn(char *supi) +int ogs_dbi_mongo_increment_sqn(char *supi) { int rv = OGS_OK; bson_t *query = NULL; @@ -245,7 +246,7 @@ int ogs_dbi_increment_sqn(char *supi) return rv; } -int ogs_dbi_subscription_data(char *supi, +int ogs_dbi_mongo_subscription_data(char *supi, ogs_subscription_data_t *subscription_data) { int rv = OGS_OK; From f0c97bff1959b0683675a86ccff5185c17679ed6 Mon Sep 17 00:00:00 2001 From: Alexander Couzens Date: Tue, 23 Aug 2022 17:38:47 +0200 Subject: [PATCH 05/12] [dbi]: mongo: merge all parts from ogs_dbi_final() into ogs_mongoc_final() Nobody is calling ogs_mongoc_final() directly. In preparation of making ogs_dbi_final() more generic --- lib/dbi/mongo/ogs-mongoc.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/dbi/mongo/ogs-mongoc.c b/lib/dbi/mongo/ogs-mongoc.c index f3b38ae7f9..cdb4fae235 100644 --- a/lib/dbi/mongo/ogs-mongoc.c +++ b/lib/dbi/mongo/ogs-mongoc.c @@ -134,6 +134,10 @@ int ogs_mongoc_init(const char *db_uri) void ogs_mongoc_final(void) { + if (self.collection.subscriber) { + mongoc_collection_destroy(self.collection.subscriber); + } + if (self.database) { mongoc_database_destroy(self.database); self.database = NULL; @@ -200,9 +204,5 @@ int ogs_dbi_mongo_init(const char *db_uri) void ogs_dbi_final() { - if (self.collection.subscriber) { - mongoc_collection_destroy(self.collection.subscriber); - } - ogs_mongoc_final(); } From 0e0de176fe882e1b85ed9a0c2e133d344ea475b2 Mon Sep 17 00:00:00 2001 From: Alexander Couzens Date: Tue, 23 Aug 2022 17:39:16 +0200 Subject: [PATCH 06/12] [dbi]: make ogs_dbi_final depend on the selected database driver --- lib/dbi/dbi-private.h | 1 + lib/dbi/dbi.c | 8 ++++++++ lib/dbi/mongo/ogs-mongoc.c | 7 ++----- 3 files changed, 11 insertions(+), 5 deletions(-) diff --git a/lib/dbi/dbi-private.h b/lib/dbi/dbi-private.h index ebc71e32f0..1812cbbe47 100644 --- a/lib/dbi/dbi-private.h +++ b/lib/dbi/dbi-private.h @@ -31,6 +31,7 @@ extern "C" { struct ogs_dbi_s { const char *name; + void (*final)(void); /* session */ int (*session_data)(char *supi, ogs_s_nssai_t *s_nssai, char *dnn, ogs_session_data_t *data); diff --git a/lib/dbi/dbi.c b/lib/dbi/dbi.c index 96cd76f1ab..e26ee72938 100644 --- a/lib/dbi/dbi.c +++ b/lib/dbi/dbi.c @@ -63,6 +63,14 @@ int ogs_dbi_select_interface(const char *dbi_name) return -1; } +void ogs_dbi_final(void) +{ + if (!dbi_selected) + return; + + dbi_selected->final(); +} + /* ims */ int ogs_dbi_msisdn_data( char *imsi_or_msisdn_bcd, ogs_msisdn_data_t *msisdn_data) diff --git a/lib/dbi/mongo/ogs-mongoc.c b/lib/dbi/mongo/ogs-mongoc.c index cdb4fae235..f3c2e17401 100644 --- a/lib/dbi/mongo/ogs-mongoc.c +++ b/lib/dbi/mongo/ogs-mongoc.c @@ -164,6 +164,8 @@ ogs_mongoc_t *ogs_mongoc(void) ogs_dbi_t ogs_dbi_mongo_interface = { .name = "mongo", + /* final */ + .final = ogs_mongoc_final, /* session */ .session_data = ogs_dbi_mongo_session_data, /* ims */ @@ -201,8 +203,3 @@ int ogs_dbi_mongo_init(const char *db_uri) return OGS_OK; } - -void ogs_dbi_final() -{ - ogs_mongoc_final(); -} From c54fb59a87f258358c68c1d8e188b1ddfae50a7d Mon Sep 17 00:00:00 2001 From: Alexander Couzens Date: Mon, 22 Aug 2022 23:59:34 +0200 Subject: [PATCH 07/12] [dbi]: make all db functions optional Allow database driver to only implement parts of the database driver. In preprataion of the json interface which will only implement session_data as might only be used by the PCRF. --- lib/dbi/dbi.c | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/lib/dbi/dbi.c b/lib/dbi/dbi.c index e26ee72938..b828f33256 100644 --- a/lib/dbi/dbi.c +++ b/lib/dbi/dbi.c @@ -76,12 +76,16 @@ int ogs_dbi_msisdn_data( char *imsi_or_msisdn_bcd, ogs_msisdn_data_t *msisdn_data) { ogs_assert(dbi_selected); + if (!dbi_selected->msisdn_data) + return OGS_ERROR; return dbi_selected->msisdn_data(imsi_or_msisdn_bcd, msisdn_data); } int ogs_dbi_ims_data(char *supi, ogs_ims_data_t *ims_data) { ogs_assert(dbi_selected); + if (!dbi_selected->ims_data) + return OGS_ERROR; return dbi_selected->ims_data(supi, ims_data); } @@ -90,6 +94,8 @@ int ogs_dbi_session_data(char *supi, ogs_s_nssai_t *s_nssai, char *dnn, ogs_session_data_t *session_data) { ogs_assert(dbi_selected); + if (!dbi_selected->session_data) + return OGS_ERROR; return dbi_selected->session_data(supi, s_nssai, dnn, session_data); } @@ -97,24 +103,32 @@ int ogs_dbi_session_data(char *supi, ogs_s_nssai_t *s_nssai, char *dnn, int ogs_dbi_auth_info(char *supi, ogs_dbi_auth_info_t *auth_info) { ogs_assert(dbi_selected); + if (!dbi_selected->auth_info) + return OGS_ERROR; return dbi_selected->auth_info(supi, auth_info); } int ogs_dbi_update_sqn(char *supi, uint64_t sqn) { ogs_assert(dbi_selected); + if (!dbi_selected->update_sqn) + return OGS_ERROR; return dbi_selected->update_sqn(supi, sqn); } int ogs_dbi_increment_sqn(char *supi) { ogs_assert(dbi_selected); + if (!dbi_selected->increment_sqn) + return OGS_ERROR; return dbi_selected->increment_sqn(supi); } int ogs_dbi_update_imeisv(char *supi, char *imeisv) { ogs_assert(dbi_selected); + if (!dbi_selected->update_imeisv) + return OGS_ERROR; return dbi_selected->update_imeisv(supi, imeisv); } @@ -122,6 +136,7 @@ int ogs_dbi_subscription_data(char *supi, ogs_subscription_data_t *subscription_data) { ogs_assert(dbi_selected); + if (!dbi_selected->subscription_data) + return OGS_ERROR; return dbi_selected->subscription_data(supi, subscription_data); } - From 0d6ef1e8ace003d103754f41da04c2174fb0a91e Mon Sep 17 00:00:00 2001 From: Alexander Couzens Date: Tue, 23 Aug 2022 00:01:07 +0200 Subject: [PATCH 08/12] [dbi] add database backend json Add json based database backend. TODO: add example json interface --- lib/dbi/dbi.c | 2 + lib/dbi/external/cjson/cJSON.c | 3139 ++++++++++++++++++++++++++++++++ lib/dbi/external/cjson/cJSON.h | 300 +++ lib/dbi/json/json-private.h | 40 + lib/dbi/json/json.c | 418 +++++ lib/dbi/meson.build | 18 +- lib/dbi/ogs-dbi.h | 3 + 7 files changed, 3918 insertions(+), 2 deletions(-) create mode 100644 lib/dbi/external/cjson/cJSON.c create mode 100644 lib/dbi/external/cjson/cJSON.h create mode 100644 lib/dbi/json/json-private.h create mode 100644 lib/dbi/json/json.c diff --git a/lib/dbi/dbi.c b/lib/dbi/dbi.c index b828f33256..2207cd2411 100644 --- a/lib/dbi/dbi.c +++ b/lib/dbi/dbi.c @@ -26,6 +26,7 @@ #ifdef WITH_MONGOC #include "mongo/mongo-private.h" #endif +#include "json/json-private.h" int __ogs_dbi_domain; @@ -33,6 +34,7 @@ static ogs_dbi_t *dbi_interfaces[] = { #ifdef WITH_MONGOC &ogs_dbi_mongo_interface, #endif + &ogs_dbi_json_interface, NULL, }; diff --git a/lib/dbi/external/cjson/cJSON.c b/lib/dbi/external/cjson/cJSON.c new file mode 100644 index 0000000000..ec3a9dc057 --- /dev/null +++ b/lib/dbi/external/cjson/cJSON.c @@ -0,0 +1,3139 @@ +/* + Copyright (c) 2009-2017 Dave Gamble and cJSON contributors + + 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. +*/ + +/* cJSON */ +/* JSON parser in C. */ + +/* disable warnings about old C89 functions in MSVC */ +#if !defined(_CRT_SECURE_NO_DEPRECATE) && defined(_MSC_VER) +#define _CRT_SECURE_NO_DEPRECATE +#endif + +#ifdef __GNUC__ +#pragma GCC visibility push(default) +#endif +#if defined(_MSC_VER) +#pragma warning (push) +/* disable warning about single line comments in system headers */ +#pragma warning (disable : 4001) +#endif + +#include +#include +#include +#include +#include +#include +#include + +#ifdef ENABLE_LOCALES +#include +#endif + +#if defined(_MSC_VER) +#pragma warning (pop) +#endif +#ifdef __GNUC__ +#pragma GCC visibility pop +#endif + +#include "cJSON.h" + +/* define our own boolean type */ +#ifdef true +#undef true +#endif +#define true ((cJSON_bool)1) + +#ifdef false +#undef false +#endif +#define false ((cJSON_bool)0) + +/* define isnan and isinf for ANSI C, if in C99 or above, isnan and isinf has been defined in math.h */ +#ifndef isinf +#define isinf(d) (isnan((d - d)) && !isnan(d)) +#endif +#ifndef isnan +#define isnan(d) (d != d) +#endif + +#ifndef NAN +#ifdef _WIN32 +#define NAN sqrt(-1.0) +#else +#define NAN 0.0/0.0 +#endif +#endif + +typedef struct { + const unsigned char *json; + size_t position; +} error; +static error global_error = { NULL, 0 }; + +CJSON_PUBLIC(const char *) cJSON_GetErrorPtr(void) +{ + return (const char*) (global_error.json + global_error.position); +} + +CJSON_PUBLIC(char *) cJSON_GetStringValue(const cJSON * const item) +{ + if (!cJSON_IsString(item)) + { + return NULL; + } + + return item->valuestring; +} + +CJSON_PUBLIC(double) cJSON_GetNumberValue(const cJSON * const item) +{ + if (!cJSON_IsNumber(item)) + { + return (double) NAN; + } + + return item->valuedouble; +} + +/* This is a safeguard to prevent copy-pasters from using incompatible C and header files */ +#if (CJSON_VERSION_MAJOR != 1) || (CJSON_VERSION_MINOR != 7) || (CJSON_VERSION_PATCH != 15) + #error cJSON.h and cJSON.c have different versions. Make sure that both have the same. +#endif + +CJSON_PUBLIC(const char*) cJSON_Version(void) +{ + static char version[15]; + sprintf(version, "%i.%i.%i", CJSON_VERSION_MAJOR, CJSON_VERSION_MINOR, CJSON_VERSION_PATCH); + + return version; +} + +/* Case insensitive string comparison, doesn't consider two NULL pointers equal though */ +static int case_insensitive_strcmp(const unsigned char *string1, const unsigned char *string2) +{ + if ((string1 == NULL) || (string2 == NULL)) + { + return 1; + } + + if (string1 == string2) + { + return 0; + } + + for(; tolower(*string1) == tolower(*string2); (void)string1++, string2++) + { + if (*string1 == '\0') + { + return 0; + } + } + + return tolower(*string1) - tolower(*string2); +} + +typedef struct internal_hooks +{ + void *(CJSON_CDECL *allocate)(size_t size); + void (CJSON_CDECL *deallocate)(void *pointer); + void *(CJSON_CDECL *reallocate)(void *pointer, size_t size); +} internal_hooks; + +#if defined(_MSC_VER) +/* work around MSVC error C2322: '...' address of dllimport '...' is not static */ +static void * CJSON_CDECL internal_malloc(size_t size) +{ + return malloc(size); +} +static void CJSON_CDECL internal_free(void *pointer) +{ + free(pointer); +} +static void * CJSON_CDECL internal_realloc(void *pointer, size_t size) +{ + return realloc(pointer, size); +} +#else +#if 0 /* modified by acetcom */ +#define internal_malloc malloc +#define internal_free free +#define internal_realloc realloc +#else +#include "ogs-core.h" +static void *internal_malloc(size_t size) +{ + void *ptr = ogs_malloc(size); + ogs_assert(ptr); + return ptr; +} +static void internal_free(void *pointer) +{ + ogs_free(pointer); +} +static void *internal_realloc(void *pointer, size_t size) +{ + void *ptr = ogs_realloc(pointer, size); + ogs_assert(ptr); + return ptr; +} +#endif +#endif + +/* strlen of character literals resolved at compile time */ +#define static_strlen(string_literal) (sizeof(string_literal) - sizeof("")) + +static internal_hooks global_hooks = { internal_malloc, internal_free, internal_realloc }; + +static unsigned char* cJSON_strdup(const unsigned char* string, const internal_hooks * const hooks) +{ + size_t length = 0; + unsigned char *copy = NULL; + + if (string == NULL) + { + return NULL; + } + + length = strlen((const char*)string) + sizeof(""); + copy = (unsigned char*)hooks->allocate(length); + if (copy == NULL) + { + return NULL; + } + memcpy(copy, string, length); + + return copy; +} + +CJSON_PUBLIC(void) cJSON_InitHooks(cJSON_Hooks* hooks) +{ + if (hooks == NULL) + { + /* Reset hooks */ + global_hooks.allocate = malloc; + global_hooks.deallocate = free; + global_hooks.reallocate = realloc; + return; + } + + global_hooks.allocate = malloc; + if (hooks->malloc_fn != NULL) + { + global_hooks.allocate = hooks->malloc_fn; + } + + global_hooks.deallocate = free; + if (hooks->free_fn != NULL) + { + global_hooks.deallocate = hooks->free_fn; + } + + /* use realloc only if both free and malloc are used */ + global_hooks.reallocate = NULL; + if ((global_hooks.allocate == malloc) && (global_hooks.deallocate == free)) + { + global_hooks.reallocate = realloc; + } +} + +/* Internal constructor. */ +static cJSON *cJSON_New_Item(const internal_hooks * const hooks) +{ + cJSON* node = (cJSON*)hooks->allocate(sizeof(cJSON)); + if (node) + { + memset(node, '\0', sizeof(cJSON)); + } + + return node; +} + +/* Delete a cJSON structure. */ +CJSON_PUBLIC(void) cJSON_Delete(cJSON *item) +{ + cJSON *next = NULL; + while (item != NULL) + { + next = item->next; + if (!(item->type & cJSON_IsReference) && (item->child != NULL)) + { + cJSON_Delete(item->child); + } + if (!(item->type & cJSON_IsReference) && (item->valuestring != NULL)) + { + global_hooks.deallocate(item->valuestring); + } + if (!(item->type & cJSON_StringIsConst) && (item->string != NULL)) + { + global_hooks.deallocate(item->string); + } + global_hooks.deallocate(item); + item = next; + } +} + +/* get the decimal point character of the current locale */ +static unsigned char get_decimal_point(void) +{ +#ifdef ENABLE_LOCALES + struct lconv *lconv = localeconv(); + return (unsigned char) lconv->decimal_point[0]; +#else + return '.'; +#endif +} + +typedef struct +{ + const unsigned char *content; + size_t length; + size_t offset; + size_t depth; /* How deeply nested (in arrays/objects) is the input at the current offset. */ + internal_hooks hooks; +} parse_buffer; + +/* check if the given size is left to read in a given parse buffer (starting with 1) */ +#define can_read(buffer, size) ((buffer != NULL) && (((buffer)->offset + size) <= (buffer)->length)) +/* check if the buffer can be accessed at the given index (starting with 0) */ +#define can_access_at_index(buffer, index) ((buffer != NULL) && (((buffer)->offset + index) < (buffer)->length)) +#define cannot_access_at_index(buffer, index) (!can_access_at_index(buffer, index)) +/* get a pointer to the buffer at the position */ +#define buffer_at_offset(buffer) ((buffer)->content + (buffer)->offset) + +/* Parse the input text to generate a number, and populate the result into item. */ +static cJSON_bool parse_number(cJSON * const item, parse_buffer * const input_buffer) +{ + double number = 0; + unsigned char *after_end = NULL; + unsigned char number_c_string[64]; + unsigned char decimal_point = get_decimal_point(); + size_t i = 0; + + if ((input_buffer == NULL) || (input_buffer->content == NULL)) + { + return false; + } + + /* copy the number into a temporary buffer and replace '.' with the decimal point + * of the current locale (for strtod) + * This also takes care of '\0' not necessarily being available for marking the end of the input */ + for (i = 0; (i < (sizeof(number_c_string) - 1)) && can_access_at_index(input_buffer, i); i++) + { + switch (buffer_at_offset(input_buffer)[i]) + { + case '0': + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + case '+': + case '-': + case 'e': + case 'E': + number_c_string[i] = buffer_at_offset(input_buffer)[i]; + break; + + case '.': + number_c_string[i] = decimal_point; + break; + + default: + goto loop_end; + } + } +loop_end: + number_c_string[i] = '\0'; + + number = strtod((const char*)number_c_string, (char**)&after_end); + if (number_c_string == after_end) + { + return false; /* parse_error */ + } + + item->valuedouble = number; + + /* use saturation in case of overflow */ + if (number >= INT_MAX) + { + item->valueint = INT_MAX; + } + else if (number <= (double)INT_MIN) + { + item->valueint = INT_MIN; + } + else + { + item->valueint = (int)number; + } + + item->type = cJSON_Number; + + input_buffer->offset += (size_t)(after_end - number_c_string); + return true; +} + +/* don't ask me, but the original cJSON_SetNumberValue returns an integer or double */ +CJSON_PUBLIC(double) cJSON_SetNumberHelper(cJSON *object, double number) +{ + if (number >= INT_MAX) + { + object->valueint = INT_MAX; + } + else if (number <= (double)INT_MIN) + { + object->valueint = INT_MIN; + } + else + { + object->valueint = (int)number; + } + + return object->valuedouble = number; +} + +CJSON_PUBLIC(char*) cJSON_SetValuestring(cJSON *object, const char *valuestring) +{ + char *copy = NULL; + /* if object's type is not cJSON_String or is cJSON_IsReference, it should not set valuestring */ + if (!(object->type & cJSON_String) || (object->type & cJSON_IsReference)) + { + return NULL; + } + if (strlen(valuestring) <= strlen(object->valuestring)) + { + strcpy(object->valuestring, valuestring); + return object->valuestring; + } + copy = (char*) cJSON_strdup((const unsigned char*)valuestring, &global_hooks); + if (copy == NULL) + { + return NULL; + } + if (object->valuestring != NULL) + { + cJSON_free(object->valuestring); + } + object->valuestring = copy; + + return copy; +} + +typedef struct +{ + unsigned char *buffer; + size_t length; + size_t offset; + size_t depth; /* current nesting depth (for formatted printing) */ + cJSON_bool noalloc; + cJSON_bool format; /* is this print a formatted print */ + internal_hooks hooks; +} printbuffer; + +/* realloc printbuffer if necessary to have at least "needed" bytes more */ +static unsigned char* ensure(printbuffer * const p, size_t needed) +{ + unsigned char *newbuffer = NULL; + size_t newsize = 0; + + if ((p == NULL) || (p->buffer == NULL)) + { + return NULL; + } + + if ((p->length > 0) && (p->offset >= p->length)) + { + /* make sure that offset is valid */ + return NULL; + } + + if (needed > INT_MAX) + { + /* sizes bigger than INT_MAX are currently not supported */ + return NULL; + } + + needed += p->offset + 1; + if (needed <= p->length) + { + return p->buffer + p->offset; + } + + if (p->noalloc) { + return NULL; + } + + /* calculate new buffer size */ + if (needed > (INT_MAX / 2)) + { + /* overflow of int, use INT_MAX if possible */ + if (needed <= INT_MAX) + { + newsize = INT_MAX; + } + else + { + return NULL; + } + } + else + { + newsize = needed * 2; + } + + if (p->hooks.reallocate != NULL) + { + /* reallocate with realloc if available */ + newbuffer = (unsigned char*)p->hooks.reallocate(p->buffer, newsize); + if (newbuffer == NULL) + { + p->hooks.deallocate(p->buffer); + p->length = 0; + p->buffer = NULL; + + return NULL; + } + } + else + { + /* otherwise reallocate manually */ + newbuffer = (unsigned char*)p->hooks.allocate(newsize); + if (!newbuffer) + { + p->hooks.deallocate(p->buffer); + p->length = 0; + p->buffer = NULL; + + return NULL; + } + + memcpy(newbuffer, p->buffer, p->offset + 1); + p->hooks.deallocate(p->buffer); + } + p->length = newsize; + p->buffer = newbuffer; + + return newbuffer + p->offset; +} + +/* calculate the new length of the string in a printbuffer and update the offset */ +static void update_offset(printbuffer * const buffer) +{ + const unsigned char *buffer_pointer = NULL; + if ((buffer == NULL) || (buffer->buffer == NULL)) + { + return; + } + buffer_pointer = buffer->buffer + buffer->offset; + + buffer->offset += strlen((const char*)buffer_pointer); +} + +/* securely comparison of floating-point variables */ +static cJSON_bool compare_double(double a, double b) +{ + double maxVal = fabs(a) > fabs(b) ? fabs(a) : fabs(b); + return (fabs(a - b) <= maxVal * DBL_EPSILON); +} + +/* Render the number nicely from the given item into a string. */ +static cJSON_bool print_number(const cJSON * const item, printbuffer * const output_buffer) +{ + unsigned char *output_pointer = NULL; + double d = item->valuedouble; + int length = 0; + size_t i = 0; + unsigned char number_buffer[26] = {0}; /* temporary buffer to print the number into */ + unsigned char decimal_point = get_decimal_point(); + double test = 0.0; + + if (output_buffer == NULL) + { + return false; + } + + /* This checks for NaN and Infinity */ + if (isnan(d) || isinf(d)) + { + length = sprintf((char*)number_buffer, "null"); + } + else if(d == (double)item->valueint) + { + length = sprintf((char*)number_buffer, "%d", item->valueint); + } + else + { + /* Try 15 decimal places of precision to avoid nonsignificant nonzero digits */ + length = sprintf((char*)number_buffer, "%1.15g", d); + + /* Check whether the original double can be recovered */ + if ((sscanf((char*)number_buffer, "%lg", &test) != 1) || !compare_double((double)test, d)) + { + /* If not, print with 17 decimal places of precision */ + length = sprintf((char*)number_buffer, "%1.17g", d); + } + } + + /* sprintf failed or buffer overrun occurred */ + if ((length < 0) || (length > (int)(sizeof(number_buffer) - 1))) + { + return false; + } + + /* reserve appropriate space in the output */ + output_pointer = ensure(output_buffer, (size_t)length + sizeof("")); + if (output_pointer == NULL) + { + return false; + } + + /* copy the printed number to the output and replace locale + * dependent decimal point with '.' */ + for (i = 0; i < ((size_t)length); i++) + { + if (number_buffer[i] == decimal_point) + { + output_pointer[i] = '.'; + continue; + } + + output_pointer[i] = number_buffer[i]; + } + output_pointer[i] = '\0'; + + output_buffer->offset += (size_t)length; + + return true; +} + +/* parse 4 digit hexadecimal number */ +static unsigned parse_hex4(const unsigned char * const input) +{ + unsigned int h = 0; + size_t i = 0; + + for (i = 0; i < 4; i++) + { + /* parse digit */ + if ((input[i] >= '0') && (input[i] <= '9')) + { + h += (unsigned int) input[i] - '0'; + } + else if ((input[i] >= 'A') && (input[i] <= 'F')) + { + h += (unsigned int) 10 + input[i] - 'A'; + } + else if ((input[i] >= 'a') && (input[i] <= 'f')) + { + h += (unsigned int) 10 + input[i] - 'a'; + } + else /* invalid */ + { + return 0; + } + + if (i < 3) + { + /* shift left to make place for the next nibble */ + h = h << 4; + } + } + + return h; +} + +/* converts a UTF-16 literal to UTF-8 + * A literal can be one or two sequences of the form \uXXXX */ +static unsigned char utf16_literal_to_utf8(const unsigned char * const input_pointer, const unsigned char * const input_end, unsigned char **output_pointer) +{ + long unsigned int codepoint = 0; + unsigned int first_code = 0; + const unsigned char *first_sequence = input_pointer; + unsigned char utf8_length = 0; + unsigned char utf8_position = 0; + unsigned char sequence_length = 0; + unsigned char first_byte_mark = 0; + + if ((input_end - first_sequence) < 6) + { + /* input ends unexpectedly */ + goto fail; + } + + /* get the first utf16 sequence */ + first_code = parse_hex4(first_sequence + 2); + + /* check that the code is valid */ + if (((first_code >= 0xDC00) && (first_code <= 0xDFFF))) + { + goto fail; + } + + /* UTF16 surrogate pair */ + if ((first_code >= 0xD800) && (first_code <= 0xDBFF)) + { + const unsigned char *second_sequence = first_sequence + 6; + unsigned int second_code = 0; + sequence_length = 12; /* \uXXXX\uXXXX */ + + if ((input_end - second_sequence) < 6) + { + /* input ends unexpectedly */ + goto fail; + } + + if ((second_sequence[0] != '\\') || (second_sequence[1] != 'u')) + { + /* missing second half of the surrogate pair */ + goto fail; + } + + /* get the second utf16 sequence */ + second_code = parse_hex4(second_sequence + 2); + /* check that the code is valid */ + if ((second_code < 0xDC00) || (second_code > 0xDFFF)) + { + /* invalid second half of the surrogate pair */ + goto fail; + } + + + /* calculate the unicode codepoint from the surrogate pair */ + codepoint = 0x10000 + (((first_code & 0x3FF) << 10) | (second_code & 0x3FF)); + } + else + { + sequence_length = 6; /* \uXXXX */ + codepoint = first_code; + } + + /* encode as UTF-8 + * takes at maximum 4 bytes to encode: + * 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx */ + if (codepoint < 0x80) + { + /* normal ascii, encoding 0xxxxxxx */ + utf8_length = 1; + } + else if (codepoint < 0x800) + { + /* two bytes, encoding 110xxxxx 10xxxxxx */ + utf8_length = 2; + first_byte_mark = 0xC0; /* 11000000 */ + } + else if (codepoint < 0x10000) + { + /* three bytes, encoding 1110xxxx 10xxxxxx 10xxxxxx */ + utf8_length = 3; + first_byte_mark = 0xE0; /* 11100000 */ + } + else if (codepoint <= 0x10FFFF) + { + /* four bytes, encoding 1110xxxx 10xxxxxx 10xxxxxx 10xxxxxx */ + utf8_length = 4; + first_byte_mark = 0xF0; /* 11110000 */ + } + else + { + /* invalid unicode codepoint */ + goto fail; + } + + /* encode as utf8 */ + for (utf8_position = (unsigned char)(utf8_length - 1); utf8_position > 0; utf8_position--) + { + /* 10xxxxxx */ + (*output_pointer)[utf8_position] = (unsigned char)((codepoint | 0x80) & 0xBF); + codepoint >>= 6; + } + /* encode first byte */ + if (utf8_length > 1) + { + (*output_pointer)[0] = (unsigned char)((codepoint | first_byte_mark) & 0xFF); + } + else + { + (*output_pointer)[0] = (unsigned char)(codepoint & 0x7F); + } + + *output_pointer += utf8_length; + + return sequence_length; + +fail: + return 0; +} + +/* Parse the input text into an unescaped cinput, and populate item. */ +static cJSON_bool parse_string(cJSON * const item, parse_buffer * const input_buffer) +{ + const unsigned char *input_pointer = buffer_at_offset(input_buffer) + 1; + const unsigned char *input_end = buffer_at_offset(input_buffer) + 1; + unsigned char *output_pointer = NULL; + unsigned char *output = NULL; + + /* not a string */ + if (buffer_at_offset(input_buffer)[0] != '\"') + { + goto fail; + } + + { + /* calculate approximate size of the output (overestimate) */ + size_t allocation_length = 0; + size_t skipped_bytes = 0; + while (((size_t)(input_end - input_buffer->content) < input_buffer->length) && (*input_end != '\"')) + { + /* is escape sequence */ + if (input_end[0] == '\\') + { + if ((size_t)(input_end + 1 - input_buffer->content) >= input_buffer->length) + { + /* prevent buffer overflow when last input character is a backslash */ + goto fail; + } + skipped_bytes++; + input_end++; + } + input_end++; + } + if (((size_t)(input_end - input_buffer->content) >= input_buffer->length) || (*input_end != '\"')) + { + goto fail; /* string ended unexpectedly */ + } + + /* This is at most how much we need for the output */ + allocation_length = (size_t) (input_end - buffer_at_offset(input_buffer)) - skipped_bytes; + output = (unsigned char*)input_buffer->hooks.allocate(allocation_length + sizeof("")); + if (output == NULL) + { + goto fail; /* allocation failure */ + } + } + + output_pointer = output; + /* loop through the string literal */ + while (input_pointer < input_end) + { + if (*input_pointer != '\\') + { + *output_pointer++ = *input_pointer++; + } + /* escape sequence */ + else + { + unsigned char sequence_length = 2; + if ((input_end - input_pointer) < 1) + { + goto fail; + } + + switch (input_pointer[1]) + { + case 'b': + *output_pointer++ = '\b'; + break; + case 'f': + *output_pointer++ = '\f'; + break; + case 'n': + *output_pointer++ = '\n'; + break; + case 'r': + *output_pointer++ = '\r'; + break; + case 't': + *output_pointer++ = '\t'; + break; + case '\"': + case '\\': + case '/': + *output_pointer++ = input_pointer[1]; + break; + + /* UTF-16 literal */ + case 'u': + sequence_length = utf16_literal_to_utf8(input_pointer, input_end, &output_pointer); + if (sequence_length == 0) + { + /* failed to convert UTF16-literal to UTF-8 */ + goto fail; + } + break; + + default: + goto fail; + } + input_pointer += sequence_length; + } + } + + /* zero terminate the output */ + *output_pointer = '\0'; + + item->type = cJSON_String; + item->valuestring = (char*)output; + + input_buffer->offset = (size_t) (input_end - input_buffer->content); + input_buffer->offset++; + + return true; + +fail: + if (output != NULL) + { + input_buffer->hooks.deallocate(output); + } + + if (input_pointer != NULL) + { + input_buffer->offset = (size_t)(input_pointer - input_buffer->content); + } + + return false; +} + +/* Render the cstring provided to an escaped version that can be printed. */ +static cJSON_bool print_string_ptr(const unsigned char * const input, printbuffer * const output_buffer) +{ + const unsigned char *input_pointer = NULL; + unsigned char *output = NULL; + unsigned char *output_pointer = NULL; + size_t output_length = 0; + /* numbers of additional characters needed for escaping */ + size_t escape_characters = 0; + + if (output_buffer == NULL) + { + return false; + } + + /* empty string */ + if (input == NULL) + { + output = ensure(output_buffer, sizeof("\"\"")); + if (output == NULL) + { + return false; + } + strcpy((char*)output, "\"\""); + + return true; + } + + /* set "flag" to 1 if something needs to be escaped */ + for (input_pointer = input; *input_pointer; input_pointer++) + { + switch (*input_pointer) + { + case '\"': + case '\\': + case '\b': + case '\f': + case '\n': + case '\r': + case '\t': + /* one character escape sequence */ + escape_characters++; + break; + default: + if (*input_pointer < 32) + { + /* UTF-16 escape sequence uXXXX */ + escape_characters += 5; + } + break; + } + } + output_length = (size_t)(input_pointer - input) + escape_characters; + + output = ensure(output_buffer, output_length + sizeof("\"\"")); + if (output == NULL) + { + return false; + } + + /* no characters have to be escaped */ + if (escape_characters == 0) + { + output[0] = '\"'; + memcpy(output + 1, input, output_length); + output[output_length + 1] = '\"'; + output[output_length + 2] = '\0'; + + return true; + } + + output[0] = '\"'; + output_pointer = output + 1; + /* copy the string */ + for (input_pointer = input; *input_pointer != '\0'; (void)input_pointer++, output_pointer++) + { + if ((*input_pointer > 31) && (*input_pointer != '\"') && (*input_pointer != '\\')) + { + /* normal character, copy */ + *output_pointer = *input_pointer; + } + else + { + /* character needs to be escaped */ + *output_pointer++ = '\\'; + switch (*input_pointer) + { + case '\\': + *output_pointer = '\\'; + break; + case '\"': + *output_pointer = '\"'; + break; + case '\b': + *output_pointer = 'b'; + break; + case '\f': + *output_pointer = 'f'; + break; + case '\n': + *output_pointer = 'n'; + break; + case '\r': + *output_pointer = 'r'; + break; + case '\t': + *output_pointer = 't'; + break; + default: + /* escape and print as unicode codepoint */ + sprintf((char*)output_pointer, "u%04x", *input_pointer); + output_pointer += 4; + break; + } + } + } + output[output_length + 1] = '\"'; + output[output_length + 2] = '\0'; + + return true; +} + +/* Invoke print_string_ptr (which is useful) on an item. */ +static cJSON_bool print_string(const cJSON * const item, printbuffer * const p) +{ + return print_string_ptr((unsigned char*)item->valuestring, p); +} + +/* Predeclare these prototypes. */ +static cJSON_bool parse_value(cJSON * const item, parse_buffer * const input_buffer); +static cJSON_bool print_value(const cJSON * const item, printbuffer * const output_buffer); +static cJSON_bool parse_array(cJSON * const item, parse_buffer * const input_buffer); +static cJSON_bool print_array(const cJSON * const item, printbuffer * const output_buffer); +static cJSON_bool parse_object(cJSON * const item, parse_buffer * const input_buffer); +static cJSON_bool print_object(const cJSON * const item, printbuffer * const output_buffer); + +/* Utility to jump whitespace and cr/lf */ +static parse_buffer *buffer_skip_whitespace(parse_buffer * const buffer) +{ + if ((buffer == NULL) || (buffer->content == NULL)) + { + return NULL; + } + + if (cannot_access_at_index(buffer, 0)) + { + return buffer; + } + + while (can_access_at_index(buffer, 0) && (buffer_at_offset(buffer)[0] <= 32)) + { + buffer->offset++; + } + + if (buffer->offset == buffer->length) + { + buffer->offset--; + } + + return buffer; +} + +/* skip the UTF-8 BOM (byte order mark) if it is at the beginning of a buffer */ +static parse_buffer *skip_utf8_bom(parse_buffer * const buffer) +{ + if ((buffer == NULL) || (buffer->content == NULL) || (buffer->offset != 0)) + { + return NULL; + } + + if (can_access_at_index(buffer, 4) && (strncmp((const char*)buffer_at_offset(buffer), "\xEF\xBB\xBF", 3) == 0)) + { + buffer->offset += 3; + } + + return buffer; +} + +CJSON_PUBLIC(cJSON *) cJSON_ParseWithOpts(const char *value, const char **return_parse_end, cJSON_bool require_null_terminated) +{ + size_t buffer_length; + + if (NULL == value) + { + return NULL; + } + + /* Adding null character size due to require_null_terminated. */ + buffer_length = strlen(value) + sizeof(""); + + return cJSON_ParseWithLengthOpts(value, buffer_length, return_parse_end, require_null_terminated); +} + +/* Parse an object - create a new root, and populate. */ +CJSON_PUBLIC(cJSON *) cJSON_ParseWithLengthOpts(const char *value, size_t buffer_length, const char **return_parse_end, cJSON_bool require_null_terminated) +{ + parse_buffer buffer = { 0, 0, 0, 0, { 0, 0, 0 } }; + cJSON *item = NULL; + + /* reset error position */ + global_error.json = NULL; + global_error.position = 0; + + if (value == NULL || 0 == buffer_length) + { + goto fail; + } + + buffer.content = (const unsigned char*)value; + buffer.length = buffer_length; + buffer.offset = 0; + buffer.hooks = global_hooks; + + item = cJSON_New_Item(&global_hooks); + if (item == NULL) /* memory fail */ + { + goto fail; + } + + if (!parse_value(item, buffer_skip_whitespace(skip_utf8_bom(&buffer)))) + { + /* parse failure. ep is set. */ + goto fail; + } + + /* if we require null-terminated JSON without appended garbage, skip and then check for a null terminator */ + if (require_null_terminated) + { + buffer_skip_whitespace(&buffer); + if ((buffer.offset >= buffer.length) || buffer_at_offset(&buffer)[0] != '\0') + { + goto fail; + } + } + if (return_parse_end) + { + *return_parse_end = (const char*)buffer_at_offset(&buffer); + } + + return item; + +fail: + if (item != NULL) + { + cJSON_Delete(item); + } + + if (value != NULL) + { + error local_error; + local_error.json = (const unsigned char*)value; + local_error.position = 0; + + if (buffer.offset < buffer.length) + { + local_error.position = buffer.offset; + } + else if (buffer.length > 0) + { + local_error.position = buffer.length - 1; + } + + if (return_parse_end != NULL) + { + *return_parse_end = (const char*)local_error.json + local_error.position; + } + + global_error = local_error; + } + + return NULL; +} + +/* Default options for cJSON_Parse */ +CJSON_PUBLIC(cJSON *) cJSON_Parse(const char *value) +{ + return cJSON_ParseWithOpts(value, 0, 0); +} + +CJSON_PUBLIC(cJSON *) cJSON_ParseWithLength(const char *value, size_t buffer_length) +{ + return cJSON_ParseWithLengthOpts(value, buffer_length, 0, 0); +} + +#define cjson_min(a, b) (((a) < (b)) ? (a) : (b)) + +static unsigned char *print(const cJSON * const item, cJSON_bool format, const internal_hooks * const hooks) +{ + static const size_t default_buffer_size = 256; + printbuffer buffer[1]; + unsigned char *printed = NULL; + + memset(buffer, 0, sizeof(buffer)); + + /* create buffer */ + buffer->buffer = (unsigned char*) hooks->allocate(default_buffer_size); + buffer->length = default_buffer_size; + buffer->format = format; + buffer->hooks = *hooks; + if (buffer->buffer == NULL) + { + goto fail; + } + + /* print the value */ + if (!print_value(item, buffer)) + { + goto fail; + } + update_offset(buffer); + + /* check if reallocate is available */ + if (hooks->reallocate != NULL) + { + printed = (unsigned char*) hooks->reallocate(buffer->buffer, buffer->offset + 1); + if (printed == NULL) { + goto fail; + } + buffer->buffer = NULL; + } + else /* otherwise copy the JSON over to a new buffer */ + { + printed = (unsigned char*) hooks->allocate(buffer->offset + 1); + if (printed == NULL) + { + goto fail; + } + memcpy(printed, buffer->buffer, cjson_min(buffer->length, buffer->offset + 1)); + printed[buffer->offset] = '\0'; /* just to be sure */ + + /* free the buffer */ + hooks->deallocate(buffer->buffer); + } + + return printed; + +fail: + if (buffer->buffer != NULL) + { + hooks->deallocate(buffer->buffer); + } + + if (printed != NULL) + { + hooks->deallocate(printed); + } + + return NULL; +} + +/* Render a cJSON item/entity/structure to text. */ +CJSON_PUBLIC(char *) cJSON_Print(const cJSON *item) +{ + return (char*)print(item, true, &global_hooks); +} + +CJSON_PUBLIC(char *) cJSON_PrintUnformatted(const cJSON *item) +{ + return (char*)print(item, false, &global_hooks); +} + +CJSON_PUBLIC(char *) cJSON_PrintBuffered(const cJSON *item, int prebuffer, cJSON_bool fmt) +{ + printbuffer p = { 0, 0, 0, 0, 0, 0, { 0, 0, 0 } }; + + if (prebuffer < 0) + { + return NULL; + } + + p.buffer = (unsigned char*)global_hooks.allocate((size_t)prebuffer); + if (!p.buffer) + { + return NULL; + } + + p.length = (size_t)prebuffer; + p.offset = 0; + p.noalloc = false; + p.format = fmt; + p.hooks = global_hooks; + + if (!print_value(item, &p)) + { + global_hooks.deallocate(p.buffer); + return NULL; + } + + return (char*)p.buffer; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_PrintPreallocated(cJSON *item, char *buffer, const int length, const cJSON_bool format) +{ + printbuffer p = { 0, 0, 0, 0, 0, 0, { 0, 0, 0 } }; + + if ((length < 0) || (buffer == NULL)) + { + return false; + } + + p.buffer = (unsigned char*)buffer; + p.length = (size_t)length; + p.offset = 0; + p.noalloc = true; + p.format = format; + p.hooks = global_hooks; + + return print_value(item, &p); +} + +/* Parser core - when encountering text, process appropriately. */ +static cJSON_bool parse_value(cJSON * const item, parse_buffer * const input_buffer) +{ + if ((input_buffer == NULL) || (input_buffer->content == NULL)) + { + return false; /* no input */ + } + + /* parse the different types of values */ + /* null */ + if (can_read(input_buffer, 4) && (strncmp((const char*)buffer_at_offset(input_buffer), "null", 4) == 0)) + { + item->type = cJSON_NULL; + input_buffer->offset += 4; + return true; + } + /* false */ + if (can_read(input_buffer, 5) && (strncmp((const char*)buffer_at_offset(input_buffer), "false", 5) == 0)) + { + item->type = cJSON_False; + input_buffer->offset += 5; + return true; + } + /* true */ + if (can_read(input_buffer, 4) && (strncmp((const char*)buffer_at_offset(input_buffer), "true", 4) == 0)) + { + item->type = cJSON_True; + item->valueint = 1; + input_buffer->offset += 4; + return true; + } + /* string */ + if (can_access_at_index(input_buffer, 0) && (buffer_at_offset(input_buffer)[0] == '\"')) + { + return parse_string(item, input_buffer); + } + /* number */ + if (can_access_at_index(input_buffer, 0) && ((buffer_at_offset(input_buffer)[0] == '-') || ((buffer_at_offset(input_buffer)[0] >= '0') && (buffer_at_offset(input_buffer)[0] <= '9')))) + { + return parse_number(item, input_buffer); + } + /* array */ + if (can_access_at_index(input_buffer, 0) && (buffer_at_offset(input_buffer)[0] == '[')) + { + return parse_array(item, input_buffer); + } + /* object */ + if (can_access_at_index(input_buffer, 0) && (buffer_at_offset(input_buffer)[0] == '{')) + { + return parse_object(item, input_buffer); + } + + return false; +} + +/* Render a value to text. */ +static cJSON_bool print_value(const cJSON * const item, printbuffer * const output_buffer) +{ + unsigned char *output = NULL; + + if ((item == NULL) || (output_buffer == NULL)) + { + return false; + } + + switch ((item->type) & 0xFF) + { + case cJSON_NULL: + output = ensure(output_buffer, 5); + if (output == NULL) + { + return false; + } + strcpy((char*)output, "null"); + return true; + + case cJSON_False: + output = ensure(output_buffer, 6); + if (output == NULL) + { + return false; + } + strcpy((char*)output, "false"); + return true; + + case cJSON_True: + output = ensure(output_buffer, 5); + if (output == NULL) + { + return false; + } + strcpy((char*)output, "true"); + return true; + + case cJSON_Number: + return print_number(item, output_buffer); + + case cJSON_Raw: + { + size_t raw_length = 0; + if (item->valuestring == NULL) + { + return false; + } + + raw_length = strlen(item->valuestring) + sizeof(""); + output = ensure(output_buffer, raw_length); + if (output == NULL) + { + return false; + } + memcpy(output, item->valuestring, raw_length); + return true; + } + + case cJSON_String: + return print_string(item, output_buffer); + + case cJSON_Array: + return print_array(item, output_buffer); + + case cJSON_Object: + return print_object(item, output_buffer); + + default: + return false; + } +} + +/* Build an array from input text. */ +static cJSON_bool parse_array(cJSON * const item, parse_buffer * const input_buffer) +{ + cJSON *head = NULL; /* head of the linked list */ + cJSON *current_item = NULL; + + if (input_buffer->depth >= CJSON_NESTING_LIMIT) + { + return false; /* to deeply nested */ + } + input_buffer->depth++; + + if (buffer_at_offset(input_buffer)[0] != '[') + { + /* not an array */ + goto fail; + } + + input_buffer->offset++; + buffer_skip_whitespace(input_buffer); + if (can_access_at_index(input_buffer, 0) && (buffer_at_offset(input_buffer)[0] == ']')) + { + /* empty array */ + goto success; + } + + /* check if we skipped to the end of the buffer */ + if (cannot_access_at_index(input_buffer, 0)) + { + input_buffer->offset--; + goto fail; + } + + /* step back to character in front of the first element */ + input_buffer->offset--; + /* loop through the comma separated array elements */ + do + { + /* allocate next item */ + cJSON *new_item = cJSON_New_Item(&(input_buffer->hooks)); + if (new_item == NULL) + { + goto fail; /* allocation failure */ + } + + /* attach next item to list */ + if (head == NULL) + { + /* start the linked list */ + current_item = head = new_item; + } + else + { + /* add to the end and advance */ + current_item->next = new_item; + new_item->prev = current_item; + current_item = new_item; + } + + /* parse next value */ + input_buffer->offset++; + buffer_skip_whitespace(input_buffer); + if (!parse_value(current_item, input_buffer)) + { + goto fail; /* failed to parse value */ + } + buffer_skip_whitespace(input_buffer); + } + while (can_access_at_index(input_buffer, 0) && (buffer_at_offset(input_buffer)[0] == ',')); + + if (cannot_access_at_index(input_buffer, 0) || buffer_at_offset(input_buffer)[0] != ']') + { + goto fail; /* expected end of array */ + } + +success: + input_buffer->depth--; + + if (head != NULL) { + head->prev = current_item; + } + + item->type = cJSON_Array; + item->child = head; + + input_buffer->offset++; + + return true; + +fail: + if (head != NULL) + { + cJSON_Delete(head); + } + + return false; +} + +/* Render an array to text */ +static cJSON_bool print_array(const cJSON * const item, printbuffer * const output_buffer) +{ + unsigned char *output_pointer = NULL; + size_t length = 0; + cJSON *current_element = item->child; + + if (output_buffer == NULL) + { + return false; + } + + /* Compose the output array. */ + /* opening square bracket */ + output_pointer = ensure(output_buffer, 1); + if (output_pointer == NULL) + { + return false; + } + + *output_pointer = '['; + output_buffer->offset++; + output_buffer->depth++; + + while (current_element != NULL) + { + if (!print_value(current_element, output_buffer)) + { + return false; + } + update_offset(output_buffer); + if (current_element->next) + { + length = (size_t) (output_buffer->format ? 2 : 1); + output_pointer = ensure(output_buffer, length + 1); + if (output_pointer == NULL) + { + return false; + } + *output_pointer++ = ','; + if(output_buffer->format) + { + *output_pointer++ = ' '; + } + *output_pointer = '\0'; + output_buffer->offset += length; + } + current_element = current_element->next; + } + + output_pointer = ensure(output_buffer, 2); + if (output_pointer == NULL) + { + return false; + } + *output_pointer++ = ']'; + *output_pointer = '\0'; + output_buffer->depth--; + + return true; +} + +/* Build an object from the text. */ +static cJSON_bool parse_object(cJSON * const item, parse_buffer * const input_buffer) +{ + cJSON *head = NULL; /* linked list head */ + cJSON *current_item = NULL; + + if (input_buffer->depth >= CJSON_NESTING_LIMIT) + { + return false; /* to deeply nested */ + } + input_buffer->depth++; + + if (cannot_access_at_index(input_buffer, 0) || (buffer_at_offset(input_buffer)[0] != '{')) + { + goto fail; /* not an object */ + } + + input_buffer->offset++; + buffer_skip_whitespace(input_buffer); + if (can_access_at_index(input_buffer, 0) && (buffer_at_offset(input_buffer)[0] == '}')) + { + goto success; /* empty object */ + } + + /* check if we skipped to the end of the buffer */ + if (cannot_access_at_index(input_buffer, 0)) + { + input_buffer->offset--; + goto fail; + } + + /* step back to character in front of the first element */ + input_buffer->offset--; + /* loop through the comma separated array elements */ + do + { + /* allocate next item */ + cJSON *new_item = cJSON_New_Item(&(input_buffer->hooks)); + if (new_item == NULL) + { + goto fail; /* allocation failure */ + } + + /* attach next item to list */ + if (head == NULL) + { + /* start the linked list */ + current_item = head = new_item; + } + else + { + /* add to the end and advance */ + current_item->next = new_item; + new_item->prev = current_item; + current_item = new_item; + } + + /* parse the name of the child */ + input_buffer->offset++; + buffer_skip_whitespace(input_buffer); + if (!parse_string(current_item, input_buffer)) + { + goto fail; /* failed to parse name */ + } + buffer_skip_whitespace(input_buffer); + + /* swap valuestring and string, because we parsed the name */ + current_item->string = current_item->valuestring; + current_item->valuestring = NULL; + + if (cannot_access_at_index(input_buffer, 0) || (buffer_at_offset(input_buffer)[0] != ':')) + { + goto fail; /* invalid object */ + } + + /* parse the value */ + input_buffer->offset++; + buffer_skip_whitespace(input_buffer); + if (!parse_value(current_item, input_buffer)) + { + goto fail; /* failed to parse value */ + } + buffer_skip_whitespace(input_buffer); + } + while (can_access_at_index(input_buffer, 0) && (buffer_at_offset(input_buffer)[0] == ',')); + + if (cannot_access_at_index(input_buffer, 0) || (buffer_at_offset(input_buffer)[0] != '}')) + { + goto fail; /* expected end of object */ + } + +success: + input_buffer->depth--; + + if (head != NULL) { + head->prev = current_item; + } + + item->type = cJSON_Object; + item->child = head; + + input_buffer->offset++; + return true; + +fail: + if (head != NULL) + { + cJSON_Delete(head); + } + + return false; +} + +/* Render an object to text. */ +static cJSON_bool print_object(const cJSON * const item, printbuffer * const output_buffer) +{ + unsigned char *output_pointer = NULL; + size_t length = 0; + cJSON *current_item = item->child; + + if (output_buffer == NULL) + { + return false; + } + + /* Compose the output: */ + length = (size_t) (output_buffer->format ? 2 : 1); /* fmt: {\n */ + output_pointer = ensure(output_buffer, length + 1); + if (output_pointer == NULL) + { + return false; + } + + *output_pointer++ = '{'; + output_buffer->depth++; + if (output_buffer->format) + { + *output_pointer++ = '\n'; + } + output_buffer->offset += length; + + while (current_item) + { + if (output_buffer->format) + { + size_t i; + output_pointer = ensure(output_buffer, output_buffer->depth); + if (output_pointer == NULL) + { + return false; + } + for (i = 0; i < output_buffer->depth; i++) + { + *output_pointer++ = '\t'; + } + output_buffer->offset += output_buffer->depth; + } + + /* print key */ + if (!print_string_ptr((unsigned char*)current_item->string, output_buffer)) + { + return false; + } + update_offset(output_buffer); + + length = (size_t) (output_buffer->format ? 2 : 1); + output_pointer = ensure(output_buffer, length); + if (output_pointer == NULL) + { + return false; + } + *output_pointer++ = ':'; + if (output_buffer->format) + { + *output_pointer++ = '\t'; + } + output_buffer->offset += length; + + /* print value */ + if (!print_value(current_item, output_buffer)) + { + return false; + } + update_offset(output_buffer); + + /* print comma if not last */ + length = ((size_t)(output_buffer->format ? 1 : 0) + (size_t)(current_item->next ? 1 : 0)); + output_pointer = ensure(output_buffer, length + 1); + if (output_pointer == NULL) + { + return false; + } + if (current_item->next) + { + *output_pointer++ = ','; + } + + if (output_buffer->format) + { + *output_pointer++ = '\n'; + } + *output_pointer = '\0'; + output_buffer->offset += length; + + current_item = current_item->next; + } + + output_pointer = ensure(output_buffer, output_buffer->format ? (output_buffer->depth + 1) : 2); + if (output_pointer == NULL) + { + return false; + } + if (output_buffer->format) + { + size_t i; + for (i = 0; i < (output_buffer->depth - 1); i++) + { + *output_pointer++ = '\t'; + } + } + *output_pointer++ = '}'; + *output_pointer = '\0'; + output_buffer->depth--; + + return true; +} + +/* Get Array size/item / object item. */ +CJSON_PUBLIC(int) cJSON_GetArraySize(const cJSON *array) +{ + cJSON *child = NULL; + size_t size = 0; + + if (array == NULL) + { + return 0; + } + + child = array->child; + + while(child != NULL) + { + size++; + child = child->next; + } + + /* FIXME: Can overflow here. Cannot be fixed without breaking the API */ + + return (int)size; +} + +static cJSON* get_array_item(const cJSON *array, size_t index) +{ + cJSON *current_child = NULL; + + if (array == NULL) + { + return NULL; + } + + current_child = array->child; + while ((current_child != NULL) && (index > 0)) + { + index--; + current_child = current_child->next; + } + + return current_child; +} + +CJSON_PUBLIC(cJSON *) cJSON_GetArrayItem(const cJSON *array, int index) +{ + if (index < 0) + { + return NULL; + } + + return get_array_item(array, (size_t)index); +} + +static cJSON *get_object_item(const cJSON * const object, const char * const name, const cJSON_bool case_sensitive) +{ + cJSON *current_element = NULL; + + if ((object == NULL) || (name == NULL)) + { + return NULL; + } + + current_element = object->child; + if (case_sensitive) + { + while ((current_element != NULL) && (current_element->string != NULL) && (strcmp(name, current_element->string) != 0)) + { + current_element = current_element->next; + } + } + else + { + while ((current_element != NULL) && (case_insensitive_strcmp((const unsigned char*)name, (const unsigned char*)(current_element->string)) != 0)) + { + current_element = current_element->next; + } + } + + if ((current_element == NULL) || (current_element->string == NULL)) { + return NULL; + } + + return current_element; +} + +CJSON_PUBLIC(cJSON *) cJSON_GetObjectItem(const cJSON * const object, const char * const string) +{ + return get_object_item(object, string, false); +} + +CJSON_PUBLIC(cJSON *) cJSON_GetObjectItemCaseSensitive(const cJSON * const object, const char * const string) +{ + return get_object_item(object, string, true); +} + +CJSON_PUBLIC(cJSON_bool) cJSON_HasObjectItem(const cJSON *object, const char *string) +{ + return cJSON_GetObjectItem(object, string) ? 1 : 0; +} + +/* Utility for array list handling. */ +static void suffix_object(cJSON *prev, cJSON *item) +{ + prev->next = item; + item->prev = prev; +} + +/* Utility for handling references. */ +static cJSON *create_reference(const cJSON *item, const internal_hooks * const hooks) +{ + cJSON *reference = NULL; + if (item == NULL) + { + return NULL; + } + + reference = cJSON_New_Item(hooks); + if (reference == NULL) + { + return NULL; + } + + memcpy(reference, item, sizeof(cJSON)); + reference->string = NULL; + reference->type |= cJSON_IsReference; + reference->next = reference->prev = NULL; + return reference; +} + +static cJSON_bool add_item_to_array(cJSON *array, cJSON *item) +{ + cJSON *child = NULL; + + if ((item == NULL) || (array == NULL) || (array == item)) + { + return false; + } + + child = array->child; + /* + * To find the last item in array quickly, we use prev in array + */ + if (child == NULL) + { + /* list is empty, start new one */ + array->child = item; + item->prev = item; + item->next = NULL; + } + else + { + /* append to the end */ + if (child->prev) + { + suffix_object(child->prev, item); + array->child->prev = item; + } + } + + return true; +} + +/* Add item to array/object. */ +CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToArray(cJSON *array, cJSON *item) +{ + return add_item_to_array(array, item); +} + +#if defined(__clang__) || (defined(__GNUC__) && ((__GNUC__ > 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ > 5)))) + #pragma GCC diagnostic push +#endif +#ifdef __GNUC__ +#pragma GCC diagnostic ignored "-Wcast-qual" +#endif +/* helper function to cast away const */ +static void* cast_away_const(const void* string) +{ + return (void*)string; +} +#if defined(__clang__) || (defined(__GNUC__) && ((__GNUC__ > 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ > 5)))) + #pragma GCC diagnostic pop +#endif + + +static cJSON_bool add_item_to_object(cJSON * const object, const char * const string, cJSON * const item, const internal_hooks * const hooks, const cJSON_bool constant_key) +{ + char *new_key = NULL; + int new_type = cJSON_Invalid; + + if ((object == NULL) || (string == NULL) || (item == NULL) || (object == item)) + { + return false; + } + + if (constant_key) + { + new_key = (char*)cast_away_const(string); + new_type = item->type | cJSON_StringIsConst; + } + else + { + new_key = (char*)cJSON_strdup((const unsigned char*)string, hooks); + if (new_key == NULL) + { + return false; + } + + new_type = item->type & ~cJSON_StringIsConst; + } + + if (!(item->type & cJSON_StringIsConst) && (item->string != NULL)) + { + hooks->deallocate(item->string); + } + + item->string = new_key; + item->type = new_type; + + return add_item_to_array(object, item); +} + +CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToObject(cJSON *object, const char *string, cJSON *item) +{ + return add_item_to_object(object, string, item, &global_hooks, false); +} + +/* Add an item to an object with constant string as key */ +CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToObjectCS(cJSON *object, const char *string, cJSON *item) +{ + return add_item_to_object(object, string, item, &global_hooks, true); +} + +CJSON_PUBLIC(cJSON_bool) cJSON_AddItemReferenceToArray(cJSON *array, cJSON *item) +{ + if (array == NULL) + { + return false; + } + + return add_item_to_array(array, create_reference(item, &global_hooks)); +} + +CJSON_PUBLIC(cJSON_bool) cJSON_AddItemReferenceToObject(cJSON *object, const char *string, cJSON *item) +{ + if ((object == NULL) || (string == NULL)) + { + return false; + } + + return add_item_to_object(object, string, create_reference(item, &global_hooks), &global_hooks, false); +} + +CJSON_PUBLIC(cJSON*) cJSON_AddNullToObject(cJSON * const object, const char * const name) +{ + cJSON *null = cJSON_CreateNull(); + if (add_item_to_object(object, name, null, &global_hooks, false)) + { + return null; + } + + cJSON_Delete(null); + return NULL; +} + +CJSON_PUBLIC(cJSON*) cJSON_AddTrueToObject(cJSON * const object, const char * const name) +{ + cJSON *true_item = cJSON_CreateTrue(); + if (add_item_to_object(object, name, true_item, &global_hooks, false)) + { + return true_item; + } + + cJSON_Delete(true_item); + return NULL; +} + +CJSON_PUBLIC(cJSON*) cJSON_AddFalseToObject(cJSON * const object, const char * const name) +{ + cJSON *false_item = cJSON_CreateFalse(); + if (add_item_to_object(object, name, false_item, &global_hooks, false)) + { + return false_item; + } + + cJSON_Delete(false_item); + return NULL; +} + +CJSON_PUBLIC(cJSON*) cJSON_AddBoolToObject(cJSON * const object, const char * const name, const cJSON_bool boolean) +{ + cJSON *bool_item = cJSON_CreateBool(boolean); + if (add_item_to_object(object, name, bool_item, &global_hooks, false)) + { + return bool_item; + } + + cJSON_Delete(bool_item); + return NULL; +} + +CJSON_PUBLIC(cJSON*) cJSON_AddNumberToObject(cJSON * const object, const char * const name, const double number) +{ + cJSON *number_item = cJSON_CreateNumber(number); + if (add_item_to_object(object, name, number_item, &global_hooks, false)) + { + return number_item; + } + + cJSON_Delete(number_item); + return NULL; +} + +CJSON_PUBLIC(cJSON*) cJSON_AddStringToObject(cJSON * const object, const char * const name, const char * const string) +{ + cJSON *string_item = cJSON_CreateString(string); + if (add_item_to_object(object, name, string_item, &global_hooks, false)) + { + return string_item; + } + + cJSON_Delete(string_item); + return NULL; +} + +CJSON_PUBLIC(cJSON*) cJSON_AddRawToObject(cJSON * const object, const char * const name, const char * const raw) +{ + cJSON *raw_item = cJSON_CreateRaw(raw); + if (add_item_to_object(object, name, raw_item, &global_hooks, false)) + { + return raw_item; + } + + cJSON_Delete(raw_item); + return NULL; +} + +CJSON_PUBLIC(cJSON*) cJSON_AddObjectToObject(cJSON * const object, const char * const name) +{ + cJSON *object_item = cJSON_CreateObject(); + if (add_item_to_object(object, name, object_item, &global_hooks, false)) + { + return object_item; + } + + cJSON_Delete(object_item); + return NULL; +} + +CJSON_PUBLIC(cJSON*) cJSON_AddArrayToObject(cJSON * const object, const char * const name) +{ + cJSON *array = cJSON_CreateArray(); + if (add_item_to_object(object, name, array, &global_hooks, false)) + { + return array; + } + + cJSON_Delete(array); + return NULL; +} + +CJSON_PUBLIC(cJSON *) cJSON_DetachItemViaPointer(cJSON *parent, cJSON * const item) +{ + if ((parent == NULL) || (item == NULL)) + { + return NULL; + } + + if (item != parent->child) + { + /* not the first element */ + item->prev->next = item->next; + } + if (item->next != NULL) + { + /* not the last element */ + item->next->prev = item->prev; + } + + if (item == parent->child) + { + /* first element */ + parent->child = item->next; + } + else if (item->next == NULL) + { + /* last element */ + parent->child->prev = item->prev; + } + + /* make sure the detached item doesn't point anywhere anymore */ + item->prev = NULL; + item->next = NULL; + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromArray(cJSON *array, int which) +{ + if (which < 0) + { + return NULL; + } + + return cJSON_DetachItemViaPointer(array, get_array_item(array, (size_t)which)); +} + +CJSON_PUBLIC(void) cJSON_DeleteItemFromArray(cJSON *array, int which) +{ + cJSON_Delete(cJSON_DetachItemFromArray(array, which)); +} + +CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromObject(cJSON *object, const char *string) +{ + cJSON *to_detach = cJSON_GetObjectItem(object, string); + + return cJSON_DetachItemViaPointer(object, to_detach); +} + +CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromObjectCaseSensitive(cJSON *object, const char *string) +{ + cJSON *to_detach = cJSON_GetObjectItemCaseSensitive(object, string); + + return cJSON_DetachItemViaPointer(object, to_detach); +} + +CJSON_PUBLIC(void) cJSON_DeleteItemFromObject(cJSON *object, const char *string) +{ + cJSON_Delete(cJSON_DetachItemFromObject(object, string)); +} + +CJSON_PUBLIC(void) cJSON_DeleteItemFromObjectCaseSensitive(cJSON *object, const char *string) +{ + cJSON_Delete(cJSON_DetachItemFromObjectCaseSensitive(object, string)); +} + +/* Replace array/object items with new ones. */ +CJSON_PUBLIC(cJSON_bool) cJSON_InsertItemInArray(cJSON *array, int which, cJSON *newitem) +{ + cJSON *after_inserted = NULL; + + if (which < 0) + { + return false; + } + + after_inserted = get_array_item(array, (size_t)which); + if (after_inserted == NULL) + { + return add_item_to_array(array, newitem); + } + + newitem->next = after_inserted; + newitem->prev = after_inserted->prev; + after_inserted->prev = newitem; + if (after_inserted == array->child) + { + array->child = newitem; + } + else + { + newitem->prev->next = newitem; + } + return true; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemViaPointer(cJSON * const parent, cJSON * const item, cJSON * replacement) +{ + if ((parent == NULL) || (replacement == NULL) || (item == NULL)) + { + return false; + } + + if (replacement == item) + { + return true; + } + + replacement->next = item->next; + replacement->prev = item->prev; + + if (replacement->next != NULL) + { + replacement->next->prev = replacement; + } + if (parent->child == item) + { + if (parent->child->prev == parent->child) + { + replacement->prev = replacement; + } + parent->child = replacement; + } + else + { /* + * To find the last item in array quickly, we use prev in array. + * We can't modify the last item's next pointer where this item was the parent's child + */ + if (replacement->prev != NULL) + { + replacement->prev->next = replacement; + } + if (replacement->next == NULL) + { + parent->child->prev = replacement; + } + } + + item->next = NULL; + item->prev = NULL; + cJSON_Delete(item); + + return true; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInArray(cJSON *array, int which, cJSON *newitem) +{ + if (which < 0) + { + return false; + } + + return cJSON_ReplaceItemViaPointer(array, get_array_item(array, (size_t)which), newitem); +} + +static cJSON_bool replace_item_in_object(cJSON *object, const char *string, cJSON *replacement, cJSON_bool case_sensitive) +{ + if ((replacement == NULL) || (string == NULL)) + { + return false; + } + + /* replace the name in the replacement */ + if (!(replacement->type & cJSON_StringIsConst) && (replacement->string != NULL)) + { + cJSON_free(replacement->string); + } + replacement->string = (char*)cJSON_strdup((const unsigned char*)string, &global_hooks); + if (replacement->string == NULL) + { + return false; + } + + replacement->type &= ~cJSON_StringIsConst; + + return cJSON_ReplaceItemViaPointer(object, get_object_item(object, string, case_sensitive), replacement); +} + +CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInObject(cJSON *object, const char *string, cJSON *newitem) +{ + return replace_item_in_object(object, string, newitem, false); +} + +CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInObjectCaseSensitive(cJSON *object, const char *string, cJSON *newitem) +{ + return replace_item_in_object(object, string, newitem, true); +} + +/* Create basic types: */ +CJSON_PUBLIC(cJSON *) cJSON_CreateNull(void) +{ + cJSON *item = cJSON_New_Item(&global_hooks); + if(item) + { + item->type = cJSON_NULL; + } + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateTrue(void) +{ + cJSON *item = cJSON_New_Item(&global_hooks); + if(item) + { + item->type = cJSON_True; + } + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateFalse(void) +{ + cJSON *item = cJSON_New_Item(&global_hooks); + if(item) + { + item->type = cJSON_False; + } + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateBool(cJSON_bool boolean) +{ + cJSON *item = cJSON_New_Item(&global_hooks); + if(item) + { + item->type = boolean ? cJSON_True : cJSON_False; + } + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateNumber(double num) +{ + cJSON *item = cJSON_New_Item(&global_hooks); + if(item) + { + item->type = cJSON_Number; + item->valuedouble = num; + + /* use saturation in case of overflow */ + if (num >= INT_MAX) + { + item->valueint = INT_MAX; + } + else if (num <= (double)INT_MIN) + { + item->valueint = INT_MIN; + } + else + { + item->valueint = (int)num; + } + } + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateString(const char *string) +{ + cJSON *item = cJSON_New_Item(&global_hooks); + if(item) + { + item->type = cJSON_String; + item->valuestring = (char*)cJSON_strdup((const unsigned char*)string, &global_hooks); + if(!item->valuestring) + { + cJSON_Delete(item); + return NULL; + } + } + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateStringReference(const char *string) +{ + cJSON *item = cJSON_New_Item(&global_hooks); + if (item != NULL) + { + item->type = cJSON_String | cJSON_IsReference; + item->valuestring = (char*)cast_away_const(string); + } + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateObjectReference(const cJSON *child) +{ + cJSON *item = cJSON_New_Item(&global_hooks); + if (item != NULL) { + item->type = cJSON_Object | cJSON_IsReference; + item->child = (cJSON*)cast_away_const(child); + } + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateArrayReference(const cJSON *child) { + cJSON *item = cJSON_New_Item(&global_hooks); + if (item != NULL) { + item->type = cJSON_Array | cJSON_IsReference; + item->child = (cJSON*)cast_away_const(child); + } + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateRaw(const char *raw) +{ + cJSON *item = cJSON_New_Item(&global_hooks); + if(item) + { + item->type = cJSON_Raw; + item->valuestring = (char*)cJSON_strdup((const unsigned char*)raw, &global_hooks); + if(!item->valuestring) + { + cJSON_Delete(item); + return NULL; + } + } + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateArray(void) +{ + cJSON *item = cJSON_New_Item(&global_hooks); + if(item) + { + item->type=cJSON_Array; + } + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateObject(void) +{ + cJSON *item = cJSON_New_Item(&global_hooks); + if (item) + { + item->type = cJSON_Object; + } + + return item; +} + +/* Create Arrays: */ +CJSON_PUBLIC(cJSON *) cJSON_CreateIntArray(const int *numbers, int count) +{ + size_t i = 0; + cJSON *n = NULL; + cJSON *p = NULL; + cJSON *a = NULL; + + if ((count < 0) || (numbers == NULL)) + { + return NULL; + } + + a = cJSON_CreateArray(); + + for(i = 0; a && (i < (size_t)count); i++) + { + n = cJSON_CreateNumber(numbers[i]); + if (!n) + { + cJSON_Delete(a); + return NULL; + } + if(!i) + { + a->child = n; + } + else + { + suffix_object(p, n); + } + p = n; + } + + if (a && a->child) { + a->child->prev = n; + } + + return a; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateFloatArray(const float *numbers, int count) +{ + size_t i = 0; + cJSON *n = NULL; + cJSON *p = NULL; + cJSON *a = NULL; + + if ((count < 0) || (numbers == NULL)) + { + return NULL; + } + + a = cJSON_CreateArray(); + + for(i = 0; a && (i < (size_t)count); i++) + { + n = cJSON_CreateNumber((double)numbers[i]); + if(!n) + { + cJSON_Delete(a); + return NULL; + } + if(!i) + { + a->child = n; + } + else + { + suffix_object(p, n); + } + p = n; + } + + if (a && a->child) { + a->child->prev = n; + } + + return a; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateDoubleArray(const double *numbers, int count) +{ + size_t i = 0; + cJSON *n = NULL; + cJSON *p = NULL; + cJSON *a = NULL; + + if ((count < 0) || (numbers == NULL)) + { + return NULL; + } + + a = cJSON_CreateArray(); + + for(i = 0; a && (i < (size_t)count); i++) + { + n = cJSON_CreateNumber(numbers[i]); + if(!n) + { + cJSON_Delete(a); + return NULL; + } + if(!i) + { + a->child = n; + } + else + { + suffix_object(p, n); + } + p = n; + } + + if (a && a->child) { + a->child->prev = n; + } + + return a; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateStringArray(const char *const *strings, int count) +{ + size_t i = 0; + cJSON *n = NULL; + cJSON *p = NULL; + cJSON *a = NULL; + + if ((count < 0) || (strings == NULL)) + { + return NULL; + } + + a = cJSON_CreateArray(); + + for (i = 0; a && (i < (size_t)count); i++) + { + n = cJSON_CreateString(strings[i]); + if(!n) + { + cJSON_Delete(a); + return NULL; + } + if(!i) + { + a->child = n; + } + else + { + suffix_object(p,n); + } + p = n; + } + + if (a && a->child) { + a->child->prev = n; + } + + return a; +} + +/* Duplication */ +CJSON_PUBLIC(cJSON *) cJSON_Duplicate(const cJSON *item, cJSON_bool recurse) +{ + cJSON *newitem = NULL; + cJSON *child = NULL; + cJSON *next = NULL; + cJSON *newchild = NULL; + + /* Bail on bad ptr */ + if (!item) + { + goto fail; + } + /* Create new item */ + newitem = cJSON_New_Item(&global_hooks); + if (!newitem) + { + goto fail; + } + /* Copy over all vars */ + newitem->type = item->type & (~cJSON_IsReference); + newitem->valueint = item->valueint; + newitem->valuedouble = item->valuedouble; + if (item->valuestring) + { + newitem->valuestring = (char*)cJSON_strdup((unsigned char*)item->valuestring, &global_hooks); + if (!newitem->valuestring) + { + goto fail; + } + } + if (item->string) + { + newitem->string = (item->type&cJSON_StringIsConst) ? item->string : (char*)cJSON_strdup((unsigned char*)item->string, &global_hooks); + if (!newitem->string) + { + goto fail; + } + } + /* If non-recursive, then we're done! */ + if (!recurse) + { + return newitem; + } + /* Walk the ->next chain for the child. */ + child = item->child; + while (child != NULL) + { + newchild = cJSON_Duplicate(child, true); /* Duplicate (with recurse) each item in the ->next chain */ + if (!newchild) + { + goto fail; + } + if (next != NULL) + { + /* If newitem->child already set, then crosswire ->prev and ->next and move on */ + next->next = newchild; + newchild->prev = next; + next = newchild; + } + else + { + /* Set newitem->child and move to it */ + newitem->child = newchild; + next = newchild; + } + child = child->next; + } + if (newitem && newitem->child) + { + newitem->child->prev = newchild; + } + + return newitem; + +fail: + if (newitem != NULL) + { + cJSON_Delete(newitem); + } + + return NULL; +} + +static void skip_oneline_comment(char **input) +{ + *input += static_strlen("//"); + + for (; (*input)[0] != '\0'; ++(*input)) + { + if ((*input)[0] == '\n') { + *input += static_strlen("\n"); + return; + } + } +} + +static void skip_multiline_comment(char **input) +{ + *input += static_strlen("/*"); + + for (; (*input)[0] != '\0'; ++(*input)) + { + if (((*input)[0] == '*') && ((*input)[1] == '/')) + { + *input += static_strlen("*/"); + return; + } + } +} + +static void minify_string(char **input, char **output) { + (*output)[0] = (*input)[0]; + *input += static_strlen("\""); + *output += static_strlen("\""); + + + for (; (*input)[0] != '\0'; (void)++(*input), ++(*output)) { + (*output)[0] = (*input)[0]; + + if ((*input)[0] == '\"') { + (*output)[0] = '\"'; + *input += static_strlen("\""); + *output += static_strlen("\""); + return; + } else if (((*input)[0] == '\\') && ((*input)[1] == '\"')) { + (*output)[1] = (*input)[1]; + *input += static_strlen("\""); + *output += static_strlen("\""); + } + } +} + +CJSON_PUBLIC(void) cJSON_Minify(char *json) +{ + char *into = json; + + if (json == NULL) + { + return; + } + + while (json[0] != '\0') + { + switch (json[0]) + { + case ' ': + case '\t': + case '\r': + case '\n': + json++; + break; + + case '/': + if (json[1] == '/') + { + skip_oneline_comment(&json); + } + else if (json[1] == '*') + { + skip_multiline_comment(&json); + } else { + json++; + } + break; + + case '\"': + minify_string(&json, (char**)&into); + break; + + default: + into[0] = json[0]; + json++; + into++; + } + } + + /* and null-terminate. */ + *into = '\0'; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_IsInvalid(const cJSON * const item) +{ + if (item == NULL) + { + return false; + } + + return (item->type & 0xFF) == cJSON_Invalid; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_IsFalse(const cJSON * const item) +{ + if (item == NULL) + { + return false; + } + + return (item->type & 0xFF) == cJSON_False; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_IsTrue(const cJSON * const item) +{ + if (item == NULL) + { + return false; + } + + return (item->type & 0xff) == cJSON_True; +} + + +CJSON_PUBLIC(cJSON_bool) cJSON_IsBool(const cJSON * const item) +{ + if (item == NULL) + { + return false; + } + + return (item->type & (cJSON_True | cJSON_False)) != 0; +} +CJSON_PUBLIC(cJSON_bool) cJSON_IsNull(const cJSON * const item) +{ + if (item == NULL) + { + return false; + } + + return (item->type & 0xFF) == cJSON_NULL; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_IsNumber(const cJSON * const item) +{ + if (item == NULL) + { + return false; + } + + return (item->type & 0xFF) == cJSON_Number; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_IsString(const cJSON * const item) +{ + if (item == NULL) + { + return false; + } + + return (item->type & 0xFF) == cJSON_String; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_IsArray(const cJSON * const item) +{ + if (item == NULL) + { + return false; + } + + return (item->type & 0xFF) == cJSON_Array; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_IsObject(const cJSON * const item) +{ + if (item == NULL) + { + return false; + } + + return (item->type & 0xFF) == cJSON_Object; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_IsRaw(const cJSON * const item) +{ + if (item == NULL) + { + return false; + } + + return (item->type & 0xFF) == cJSON_Raw; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_Compare(const cJSON * const a, const cJSON * const b, const cJSON_bool case_sensitive) +{ + if ((a == NULL) || (b == NULL) || ((a->type & 0xFF) != (b->type & 0xFF))) + { + return false; + } + + /* check if type is valid */ + switch (a->type & 0xFF) + { + case cJSON_False: + case cJSON_True: + case cJSON_NULL: + case cJSON_Number: + case cJSON_String: + case cJSON_Raw: + case cJSON_Array: + case cJSON_Object: + break; + + default: + return false; + } + + /* identical objects are equal */ + if (a == b) + { + return true; + } + + switch (a->type & 0xFF) + { + /* in these cases and equal type is enough */ + case cJSON_False: + case cJSON_True: + case cJSON_NULL: + return true; + + case cJSON_Number: + if (compare_double(a->valuedouble, b->valuedouble)) + { + return true; + } + return false; + + case cJSON_String: + case cJSON_Raw: + if ((a->valuestring == NULL) || (b->valuestring == NULL)) + { + return false; + } + if (strcmp(a->valuestring, b->valuestring) == 0) + { + return true; + } + + return false; + + case cJSON_Array: + { + cJSON *a_element = a->child; + cJSON *b_element = b->child; + + for (; (a_element != NULL) && (b_element != NULL);) + { + if (!cJSON_Compare(a_element, b_element, case_sensitive)) + { + return false; + } + + a_element = a_element->next; + b_element = b_element->next; + } + + /* one of the arrays is longer than the other */ + if (a_element != b_element) { + return false; + } + + return true; + } + + case cJSON_Object: + { + cJSON *a_element = NULL; + cJSON *b_element = NULL; + cJSON_ArrayForEach(a_element, a) + { + /* TODO This has O(n^2) runtime, which is horrible! */ + b_element = get_object_item(b, a_element->string, case_sensitive); + if (b_element == NULL) + { + return false; + } + + if (!cJSON_Compare(a_element, b_element, case_sensitive)) + { + return false; + } + } + + /* doing this twice, once on a and b to prevent true comparison if a subset of b + * TODO: Do this the proper way, this is just a fix for now */ + cJSON_ArrayForEach(b_element, b) + { + a_element = get_object_item(a, b_element->string, case_sensitive); + if (a_element == NULL) + { + return false; + } + + if (!cJSON_Compare(b_element, a_element, case_sensitive)) + { + return false; + } + } + + return true; + } + + default: + return false; + } +} + +CJSON_PUBLIC(void *) cJSON_malloc(size_t size) +{ + return global_hooks.allocate(size); +} + +CJSON_PUBLIC(void) cJSON_free(void *object) +{ + global_hooks.deallocate(object); +} diff --git a/lib/dbi/external/cjson/cJSON.h b/lib/dbi/external/cjson/cJSON.h new file mode 100644 index 0000000000..95a9cf69dd --- /dev/null +++ b/lib/dbi/external/cjson/cJSON.h @@ -0,0 +1,300 @@ +/* + Copyright (c) 2009-2017 Dave Gamble and cJSON contributors + + 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. +*/ + +#ifndef cJSON__h +#define cJSON__h + +#ifdef __cplusplus +extern "C" +{ +#endif + +#if !defined(__WINDOWS__) && (defined(WIN32) || defined(WIN64) || defined(_MSC_VER) || defined(_WIN32)) +#define __WINDOWS__ +#endif + +#ifdef __WINDOWS__ + +/* When compiling for windows, we specify a specific calling convention to avoid issues where we are being called from a project with a different default calling convention. For windows you have 3 define options: + +CJSON_HIDE_SYMBOLS - Define this in the case where you don't want to ever dllexport symbols +CJSON_EXPORT_SYMBOLS - Define this on library build when you want to dllexport symbols (default) +CJSON_IMPORT_SYMBOLS - Define this if you want to dllimport symbol + +For *nix builds that support visibility attribute, you can define similar behavior by + +setting default visibility to hidden by adding +-fvisibility=hidden (for gcc) +or +-xldscope=hidden (for sun cc) +to CFLAGS + +then using the CJSON_API_VISIBILITY flag to "export" the same symbols the way CJSON_EXPORT_SYMBOLS does + +*/ + +#define CJSON_CDECL __cdecl +#define CJSON_STDCALL __stdcall + +/* export symbols by default, this is necessary for copy pasting the C and header file */ +#if !defined(CJSON_HIDE_SYMBOLS) && !defined(CJSON_IMPORT_SYMBOLS) && !defined(CJSON_EXPORT_SYMBOLS) +#define CJSON_EXPORT_SYMBOLS +#endif + +#if defined(CJSON_HIDE_SYMBOLS) +#define CJSON_PUBLIC(type) type CJSON_STDCALL +#elif defined(CJSON_EXPORT_SYMBOLS) +#define CJSON_PUBLIC(type) __declspec(dllexport) type CJSON_STDCALL +#elif defined(CJSON_IMPORT_SYMBOLS) +#define CJSON_PUBLIC(type) __declspec(dllimport) type CJSON_STDCALL +#endif +#else /* !__WINDOWS__ */ +#define CJSON_CDECL +#define CJSON_STDCALL + +#if (defined(__GNUC__) || defined(__SUNPRO_CC) || defined (__SUNPRO_C)) && defined(CJSON_API_VISIBILITY) +#define CJSON_PUBLIC(type) __attribute__((visibility("default"))) type +#else +#define CJSON_PUBLIC(type) type +#endif +#endif + +/* project version */ +#define CJSON_VERSION_MAJOR 1 +#define CJSON_VERSION_MINOR 7 +#define CJSON_VERSION_PATCH 15 + +#include + +/* cJSON Types: */ +#define cJSON_Invalid (0) +#define cJSON_False (1 << 0) +#define cJSON_True (1 << 1) +#define cJSON_NULL (1 << 2) +#define cJSON_Number (1 << 3) +#define cJSON_String (1 << 4) +#define cJSON_Array (1 << 5) +#define cJSON_Object (1 << 6) +#define cJSON_Raw (1 << 7) /* raw json */ + +#define cJSON_IsReference 256 +#define cJSON_StringIsConst 512 + +/* The cJSON structure: */ +typedef struct cJSON +{ + /* next/prev allow you to walk array/object chains. Alternatively, use GetArraySize/GetArrayItem/GetObjectItem */ + struct cJSON *next; + struct cJSON *prev; + /* An array or object item will have a child pointer pointing to a chain of the items in the array/object. */ + struct cJSON *child; + + /* The type of the item, as above. */ + int type; + + /* The item's string, if type==cJSON_String and type == cJSON_Raw */ + char *valuestring; + /* writing to valueint is DEPRECATED, use cJSON_SetNumberValue instead */ + int valueint; + /* The item's number, if type==cJSON_Number */ + double valuedouble; + + /* The item's name string, if this item is the child of, or is in the list of subitems of an object. */ + char *string; +} cJSON; + +typedef struct cJSON_Hooks +{ + /* malloc/free are CDECL on Windows regardless of the default calling convention of the compiler, so ensure the hooks allow passing those functions directly. */ + void *(CJSON_CDECL *malloc_fn)(size_t sz); + void (CJSON_CDECL *free_fn)(void *ptr); +} cJSON_Hooks; + +typedef int cJSON_bool; + +/* Limits how deeply nested arrays/objects can be before cJSON rejects to parse them. + * This is to prevent stack overflows. */ +#ifndef CJSON_NESTING_LIMIT +#define CJSON_NESTING_LIMIT 1000 +#endif + +/* returns the version of cJSON as a string */ +CJSON_PUBLIC(const char*) cJSON_Version(void); + +/* Supply malloc, realloc and free functions to cJSON */ +CJSON_PUBLIC(void) cJSON_InitHooks(cJSON_Hooks* hooks); + +/* Memory Management: the caller is always responsible to free the results from all variants of cJSON_Parse (with cJSON_Delete) and cJSON_Print (with stdlib free, cJSON_Hooks.free_fn, or cJSON_free as appropriate). The exception is cJSON_PrintPreallocated, where the caller has full responsibility of the buffer. */ +/* Supply a block of JSON, and this returns a cJSON object you can interrogate. */ +CJSON_PUBLIC(cJSON *) cJSON_Parse(const char *value); +CJSON_PUBLIC(cJSON *) cJSON_ParseWithLength(const char *value, size_t buffer_length); +/* ParseWithOpts allows you to require (and check) that the JSON is null terminated, and to retrieve the pointer to the final byte parsed. */ +/* If you supply a ptr in return_parse_end and parsing fails, then return_parse_end will contain a pointer to the error so will match cJSON_GetErrorPtr(). */ +CJSON_PUBLIC(cJSON *) cJSON_ParseWithOpts(const char *value, const char **return_parse_end, cJSON_bool require_null_terminated); +CJSON_PUBLIC(cJSON *) cJSON_ParseWithLengthOpts(const char *value, size_t buffer_length, const char **return_parse_end, cJSON_bool require_null_terminated); + +/* Render a cJSON entity to text for transfer/storage. */ +CJSON_PUBLIC(char *) cJSON_Print(const cJSON *item); +/* Render a cJSON entity to text for transfer/storage without any formatting. */ +CJSON_PUBLIC(char *) cJSON_PrintUnformatted(const cJSON *item); +/* Render a cJSON entity to text using a buffered strategy. prebuffer is a guess at the final size. guessing well reduces reallocation. fmt=0 gives unformatted, =1 gives formatted */ +CJSON_PUBLIC(char *) cJSON_PrintBuffered(const cJSON *item, int prebuffer, cJSON_bool fmt); +/* Render a cJSON entity to text using a buffer already allocated in memory with given length. Returns 1 on success and 0 on failure. */ +/* NOTE: cJSON is not always 100% accurate in estimating how much memory it will use, so to be safe allocate 5 bytes more than you actually need */ +CJSON_PUBLIC(cJSON_bool) cJSON_PrintPreallocated(cJSON *item, char *buffer, const int length, const cJSON_bool format); +/* Delete a cJSON entity and all subentities. */ +CJSON_PUBLIC(void) cJSON_Delete(cJSON *item); + +/* Returns the number of items in an array (or object). */ +CJSON_PUBLIC(int) cJSON_GetArraySize(const cJSON *array); +/* Retrieve item number "index" from array "array". Returns NULL if unsuccessful. */ +CJSON_PUBLIC(cJSON *) cJSON_GetArrayItem(const cJSON *array, int index); +/* Get item "string" from object. Case insensitive. */ +CJSON_PUBLIC(cJSON *) cJSON_GetObjectItem(const cJSON * const object, const char * const string); +CJSON_PUBLIC(cJSON *) cJSON_GetObjectItemCaseSensitive(const cJSON * const object, const char * const string); +CJSON_PUBLIC(cJSON_bool) cJSON_HasObjectItem(const cJSON *object, const char *string); +/* For analysing failed parses. This returns a pointer to the parse error. You'll probably need to look a few chars back to make sense of it. Defined when cJSON_Parse() returns 0. 0 when cJSON_Parse() succeeds. */ +CJSON_PUBLIC(const char *) cJSON_GetErrorPtr(void); + +/* Check item type and return its value */ +CJSON_PUBLIC(char *) cJSON_GetStringValue(const cJSON * const item); +CJSON_PUBLIC(double) cJSON_GetNumberValue(const cJSON * const item); + +/* These functions check the type of an item */ +CJSON_PUBLIC(cJSON_bool) cJSON_IsInvalid(const cJSON * const item); +CJSON_PUBLIC(cJSON_bool) cJSON_IsFalse(const cJSON * const item); +CJSON_PUBLIC(cJSON_bool) cJSON_IsTrue(const cJSON * const item); +CJSON_PUBLIC(cJSON_bool) cJSON_IsBool(const cJSON * const item); +CJSON_PUBLIC(cJSON_bool) cJSON_IsNull(const cJSON * const item); +CJSON_PUBLIC(cJSON_bool) cJSON_IsNumber(const cJSON * const item); +CJSON_PUBLIC(cJSON_bool) cJSON_IsString(const cJSON * const item); +CJSON_PUBLIC(cJSON_bool) cJSON_IsArray(const cJSON * const item); +CJSON_PUBLIC(cJSON_bool) cJSON_IsObject(const cJSON * const item); +CJSON_PUBLIC(cJSON_bool) cJSON_IsRaw(const cJSON * const item); + +/* These calls create a cJSON item of the appropriate type. */ +CJSON_PUBLIC(cJSON *) cJSON_CreateNull(void); +CJSON_PUBLIC(cJSON *) cJSON_CreateTrue(void); +CJSON_PUBLIC(cJSON *) cJSON_CreateFalse(void); +CJSON_PUBLIC(cJSON *) cJSON_CreateBool(cJSON_bool boolean); +CJSON_PUBLIC(cJSON *) cJSON_CreateNumber(double num); +CJSON_PUBLIC(cJSON *) cJSON_CreateString(const char *string); +/* raw json */ +CJSON_PUBLIC(cJSON *) cJSON_CreateRaw(const char *raw); +CJSON_PUBLIC(cJSON *) cJSON_CreateArray(void); +CJSON_PUBLIC(cJSON *) cJSON_CreateObject(void); + +/* Create a string where valuestring references a string so + * it will not be freed by cJSON_Delete */ +CJSON_PUBLIC(cJSON *) cJSON_CreateStringReference(const char *string); +/* Create an object/array that only references it's elements so + * they will not be freed by cJSON_Delete */ +CJSON_PUBLIC(cJSON *) cJSON_CreateObjectReference(const cJSON *child); +CJSON_PUBLIC(cJSON *) cJSON_CreateArrayReference(const cJSON *child); + +/* These utilities create an Array of count items. + * The parameter count cannot be greater than the number of elements in the number array, otherwise array access will be out of bounds.*/ +CJSON_PUBLIC(cJSON *) cJSON_CreateIntArray(const int *numbers, int count); +CJSON_PUBLIC(cJSON *) cJSON_CreateFloatArray(const float *numbers, int count); +CJSON_PUBLIC(cJSON *) cJSON_CreateDoubleArray(const double *numbers, int count); +CJSON_PUBLIC(cJSON *) cJSON_CreateStringArray(const char *const *strings, int count); + +/* Append item to the specified array/object. */ +CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToArray(cJSON *array, cJSON *item); +CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToObject(cJSON *object, const char *string, cJSON *item); +/* Use this when string is definitely const (i.e. a literal, or as good as), and will definitely survive the cJSON object. + * WARNING: When this function was used, make sure to always check that (item->type & cJSON_StringIsConst) is zero before + * writing to `item->string` */ +CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToObjectCS(cJSON *object, const char *string, cJSON *item); +/* Append reference to item to the specified array/object. Use this when you want to add an existing cJSON to a new cJSON, but don't want to corrupt your existing cJSON. */ +CJSON_PUBLIC(cJSON_bool) cJSON_AddItemReferenceToArray(cJSON *array, cJSON *item); +CJSON_PUBLIC(cJSON_bool) cJSON_AddItemReferenceToObject(cJSON *object, const char *string, cJSON *item); + +/* Remove/Detach items from Arrays/Objects. */ +CJSON_PUBLIC(cJSON *) cJSON_DetachItemViaPointer(cJSON *parent, cJSON * const item); +CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromArray(cJSON *array, int which); +CJSON_PUBLIC(void) cJSON_DeleteItemFromArray(cJSON *array, int which); +CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromObject(cJSON *object, const char *string); +CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromObjectCaseSensitive(cJSON *object, const char *string); +CJSON_PUBLIC(void) cJSON_DeleteItemFromObject(cJSON *object, const char *string); +CJSON_PUBLIC(void) cJSON_DeleteItemFromObjectCaseSensitive(cJSON *object, const char *string); + +/* Update array items. */ +CJSON_PUBLIC(cJSON_bool) cJSON_InsertItemInArray(cJSON *array, int which, cJSON *newitem); /* Shifts pre-existing items to the right. */ +CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemViaPointer(cJSON * const parent, cJSON * const item, cJSON * replacement); +CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInArray(cJSON *array, int which, cJSON *newitem); +CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInObject(cJSON *object,const char *string,cJSON *newitem); +CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInObjectCaseSensitive(cJSON *object,const char *string,cJSON *newitem); + +/* Duplicate a cJSON item */ +CJSON_PUBLIC(cJSON *) cJSON_Duplicate(const cJSON *item, cJSON_bool recurse); +/* Duplicate will create a new, identical cJSON item to the one you pass, in new memory that will + * need to be released. With recurse!=0, it will duplicate any children connected to the item. + * The item->next and ->prev pointers are always zero on return from Duplicate. */ +/* Recursively compare two cJSON items for equality. If either a or b is NULL or invalid, they will be considered unequal. + * case_sensitive determines if object keys are treated case sensitive (1) or case insensitive (0) */ +CJSON_PUBLIC(cJSON_bool) cJSON_Compare(const cJSON * const a, const cJSON * const b, const cJSON_bool case_sensitive); + +/* Minify a strings, remove blank characters(such as ' ', '\t', '\r', '\n') from strings. + * The input pointer json cannot point to a read-only address area, such as a string constant, + * but should point to a readable and writable address area. */ +CJSON_PUBLIC(void) cJSON_Minify(char *json); + +/* Helper functions for creating and adding items to an object at the same time. + * They return the added item or NULL on failure. */ +CJSON_PUBLIC(cJSON*) cJSON_AddNullToObject(cJSON * const object, const char * const name); +CJSON_PUBLIC(cJSON*) cJSON_AddTrueToObject(cJSON * const object, const char * const name); +CJSON_PUBLIC(cJSON*) cJSON_AddFalseToObject(cJSON * const object, const char * const name); +CJSON_PUBLIC(cJSON*) cJSON_AddBoolToObject(cJSON * const object, const char * const name, const cJSON_bool boolean); +CJSON_PUBLIC(cJSON*) cJSON_AddNumberToObject(cJSON * const object, const char * const name, const double number); +CJSON_PUBLIC(cJSON*) cJSON_AddStringToObject(cJSON * const object, const char * const name, const char * const string); +CJSON_PUBLIC(cJSON*) cJSON_AddRawToObject(cJSON * const object, const char * const name, const char * const raw); +CJSON_PUBLIC(cJSON*) cJSON_AddObjectToObject(cJSON * const object, const char * const name); +CJSON_PUBLIC(cJSON*) cJSON_AddArrayToObject(cJSON * const object, const char * const name); + +/* When assigning an integer value, it needs to be propagated to valuedouble too. */ +#define cJSON_SetIntValue(object, number) ((object) ? (object)->valueint = (object)->valuedouble = (number) : (number)) +/* helper for the cJSON_SetNumberValue macro */ +CJSON_PUBLIC(double) cJSON_SetNumberHelper(cJSON *object, double number); +#define cJSON_SetNumberValue(object, number) ((object != NULL) ? cJSON_SetNumberHelper(object, (double)number) : (number)) +/* Change the valuestring of a cJSON_String object, only takes effect when type of object is cJSON_String */ +CJSON_PUBLIC(char*) cJSON_SetValuestring(cJSON *object, const char *valuestring); + +/* If the object is not a boolean type this does nothing and returns cJSON_Invalid else it returns the new type*/ +#define cJSON_SetBoolValue(object, boolValue) ( \ + (object != NULL && ((object)->type & (cJSON_False|cJSON_True))) ? \ + (object)->type=((object)->type &(~(cJSON_False|cJSON_True)))|((boolValue)?cJSON_True:cJSON_False) : \ + cJSON_Invalid\ +) + +/* Macro for iterating over an array or object */ +#define cJSON_ArrayForEach(element, array) for(element = (array != NULL) ? (array)->child : NULL; element != NULL; element = element->next) + +/* malloc/free objects using the malloc/free functions that have been set with cJSON_InitHooks */ +CJSON_PUBLIC(void *) cJSON_malloc(size_t size); +CJSON_PUBLIC(void) cJSON_free(void *object); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/lib/dbi/json/json-private.h b/lib/dbi/json/json-private.h new file mode 100644 index 0000000000..1afa79c5a9 --- /dev/null +++ b/lib/dbi/json/json-private.h @@ -0,0 +1,40 @@ +/* + * Copyright (C) 2022 by sysmocom - s.f.m.c. GmbH + * Author: Alexander Couzens + * + * This file is part of Open5GS. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program 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 this program. If not, see . + */ + +#if !defined(OGS_DBI_INSIDE) && !defined(OGS_DBI_COMPILATION) +#error "This header cannot be included directly." +#endif + +#ifndef OGS_DBI_JSON_PRIVATE_H +#define OGS_DBI_JSON_PRIVATE_H + +#ifdef __cplusplus +extern "C" { +#endif + +#include "dbi-private.h" + +extern ogs_dbi_t ogs_dbi_json_interface; + +#ifdef __cplusplus +} +#endif + +#endif /* OGS_DBI_JSON_PRIVATE_H */ diff --git a/lib/dbi/json/json.c b/lib/dbi/json/json.c new file mode 100644 index 0000000000..591b70df47 --- /dev/null +++ b/lib/dbi/json/json.c @@ -0,0 +1,418 @@ +/* + * Copyright (C) 2022 by sysmocom - s.f.m.c. GmbH + * Author: Alexander Couzens + * + * This file is part of Open5GS. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program 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 this program. If not, see . + */ + + +#include "ogs-dbi.h" +#include "json-private.h" + +#include + +#define MAX_DB_PROFILES 256 +#define MAX_DB_APNS 10 +typedef struct ogs_json_apn_profile_s { + int32_t id; + ogs_qos_t qos; + bool valid; +} ogs_json_apn_profile_t; + +typedef struct ogs_json_apn_s { + char *apn; + ogs_json_apn_profile_t profiles[MAX_DB_PROFILES]; + ogs_bitrate_t ambr; /* APN-AMBR */ + bool valid; +} ogs_json_apn_t; + +ogs_json_apn_t g_apns[MAX_DB_APNS]; + +static ogs_json_apn_profile_t *ogs_dbi_static_alloc_db_entry(ogs_json_apn_t *db_apn) +{ + int i = 0; + ogs_assert(db_apn); + ogs_json_apn_profile_t *entry; + + for (i = 0; i < MAX_DB_PROFILES; i++) { + entry = &db_apn->profiles[i]; + if (entry->valid) + continue; + + return entry; + } + + return NULL; +} + +static ogs_json_apn_profile_t *ogs_dbi_static_get_apn_profile(ogs_json_apn_t *db_apn, int profile_id) +{ + int i = 0; + ogs_assert(db_apn); + + for (i = 0; i < MAX_DB_PROFILES; i++) { + ogs_json_apn_profile_t *entry = &db_apn->profiles[i]; + if (!entry->valid) + continue; + + if (entry->id != profile_id) + continue; + + return entry; + } + + return NULL; +} + +static ogs_json_apn_t *ogs_dbi_static_get_apn(const char *apn) +{ + int i; + for (i = 0; i < MAX_DB_APNS; i++) { + ogs_json_apn_t *entry = &g_apns[i]; + if (!entry->valid) + continue; + + if (!ogs_strcasecmp(entry->apn, apn)) + return entry; + } + return NULL; +} + + +static ogs_json_apn_t *ogs_dbi_static_alloc_apn(void) +{ + int i = 0; + ogs_json_apn_t *apn; + + for (i = 0; i < MAX_DB_APNS; i++) { + apn = &g_apns[i]; + if (apn->valid) + continue; + + return apn; + } + + return NULL; +} + +static int cjson_get_uint64_t(const cJSON * const top, const char *item_chr, int required, uint64_t min, uint64_t max, uint64_t *value) +{ + uint64_t number; + + ogs_assert(value); + + cJSON *item = cJSON_GetObjectItem(top, item_chr); + if (!item) { + if (!required) + return 0; + + ogs_error("Could not find mandatory field %s\n", item_chr); + return -ENOENT; + } + + if (!cJSON_IsNumber(item)) { + ogs_error("Invalid value for %s. It must be a number!\n", item_chr); + return -EINVAL; + } + + number = cJSON_GetNumberValue(item); + if (!(min <= number && number <= max)) { + ogs_error("Invalid value for %s: %ld. It must be %ld <= x <= %ld\n", item_chr, number, min, max); + return -ERANGE; + } + + *value = number; + + return 0; +} + +static int cjson_get_int(const cJSON * const top, const char *item_chr, int required, int min, int max, int *value) +{ + int number; + + ogs_assert(value); + + cJSON *item = cJSON_GetObjectItem(top, item_chr); + if (!item) { + if (!required) + return 0; + + ogs_error("Could not find mandatory field %s\n", item_chr); + return -ENOENT; + } + + if (!cJSON_IsNumber(item)) { + ogs_error("Invalid value for %s. It must be a number!\n", item_chr); + return -EINVAL; + } + + number = cJSON_GetNumberValue(item); + if (!(min <= number && number <= max)) { + ogs_error("Invalid value for %s: %d. It must be %d <= x <= %d\n", item_chr, number, min, max); + return -ERANGE; + } + + *value = number; + + return 0; +} + +static int get_bandwidth(cJSON *top, const char *mbr, ogs_bitrate_t *bitrate) +{ + int ret; + ogs_assert(mbr); + ogs_assert(top); + ogs_assert(bitrate); + + cJSON *obj = cJSON_GetObjectItem(top, mbr); + if (!obj) + return 0; + + if (!cJSON_IsObject(obj)) { + ogs_error("%s has the wrong type. It is not an object!\n", mbr); + return -EINVAL; + } + + /* TODO: this will break close to 2 gbit */ + ret = cjson_get_uint64_t(obj, "up", 0, 0, UINT64_MAX, &bitrate->uplink); + if (ret) + return ret; + + ret = cjson_get_uint64_t(obj, "down", 0, 0, UINT32_MAX, &bitrate->downlink); + if (ret) + return ret; + + return 0; +} + +int ogs_dbi_json_init(const char *filepath, const char *apn) +{ + int ret = 0; + long filesize = -1; + ssize_t mem_read; + ogs_json_apn_t *db_apn = ogs_dbi_static_get_apn(apn); + FILE *filefp; + char *buf = NULL; + int profile_id; + + ogs_dbi_select_interface("json"); + + if (db_apn) { + return -EALREADY; + } + + filefp = fopen(filepath, "r"); + if (!filefp) { + return -ENOENT; + } + + if (fseek(filefp, 0L, SEEK_END) < 0) { + ret = -ENOENT; + goto fail; + } + + filesize = ftell(filefp); + if (filesize < 0) { + ret = -ENOENT; + goto fail; + } + + buf = ogs_malloc(filesize); + if (!buf) { + ret = -ENOMEM; + goto fail; + } + + if (fseek(filefp, 0L, SEEK_SET) < 0) { + ret = -ENOENT; + goto fail; + } + + mem_read = fread(buf, filesize, 1, filefp); + if (mem_read != 1 && !feof(filefp)) { + ret = -1; + goto fail; + } + + cJSON *profiles = cJSON_ParseWithLength(buf, filesize); + if (!profiles) { + const char *error_ptr = cJSON_GetErrorPtr(); + if (error_ptr != NULL) + { + ogs_error("Error before: %s\n", error_ptr); + } + + ret = -1; + goto fail; + } + + if (!cJSON_IsArray(profiles)) { + ogs_error("Profile root object must be an array"); + ret = -2; + goto fail; + } + + db_apn = ogs_dbi_static_alloc_apn(); + if (!db_apn) { + ogs_error("Too many APNs\n"); + ret = -ENOENT; + goto fail; + } + memset(db_apn, '\0', sizeof(*db_apn)); + db_apn->apn = ogs_strdup(apn); + db_apn->valid = 1; + + cJSON *profile; + cJSON_ArrayForEach(profile, profiles) { + int number; + ogs_json_apn_profile_t *entry; + + ret = cjson_get_int(profile, "id", 1, 0, 65535, &profile_id); + if (ret) + goto fail; + + entry = ogs_dbi_static_get_apn_profile(db_apn, profile_id); + if (entry) { + ogs_error("Doublicated profile with id %d\n", profile_id); + ret = -1; + goto fail; + } + + entry = ogs_dbi_static_alloc_db_entry(db_apn); + if (!entry) { + ogs_error("Tooo many db entries for apn %s\n", apn); + ret = -1; + goto fail; + } + + ogs_info("Loading json profile for apn: \"%s\" / charging id \"%d\"", apn, profile_id); + entry->id = profile_id; + + ret = cjson_get_int(profile, "qci", 1, 0, 16, &number); + if (ret) + goto fail; + + entry->qos.index = number & 0xff; + ret = get_bandwidth(profile, "ambr", &entry->qos.mbr); + if (ret) + goto fail; + + ret = get_bandwidth(profile, "gbr", &entry->qos.gbr); + if (ret) + goto fail; + + /* TODO: check boundary check for fields */ + ret = cjson_get_int(profile, "priority", 1, 0, 15, &number); + if (ret) + goto fail; + entry->qos.arp.priority_level = number & 0xff; + + ret = cjson_get_int(profile, "pre_emption_capability", 1, 0, 1, &number); + if (ret) + goto fail; + if (number) + entry->qos.arp.pre_emption_capability = OGS_5GC_PRE_EMPTION_ENABLED; + else + entry->qos.arp.pre_emption_capability = OGS_5GC_PRE_EMPTION_DISABLED; + + ret = cjson_get_int(profile, "pre_emption_vulnerability", 1, 0, 1, &number); + if (ret) + goto fail; + if (number) + entry->qos.arp.pre_emption_vulnerability = OGS_5GC_PRE_EMPTION_ENABLED; + else + entry->qos.arp.pre_emption_vulnerability = OGS_5GC_PRE_EMPTION_DISABLED; + entry->valid = true; + } + + if (profiles) + cJSON_Delete(profiles); + + if (buf) + ogs_free(buf); + + return 0; + +fail: + if (db_apn->apn) + ogs_free(db_apn->apn); + + if (profiles) + cJSON_Delete(profiles); + + if (buf) + ogs_free(buf); + + fclose(filefp); + return ret; +} + +static int json_session_data(char *supi, ogs_s_nssai_t *s_nssai, char *dnn, ogs_session_data_t *session_data) +{ + ogs_session_t *session = &session_data->session; + ogs_json_apn_profile_t *profile; + ogs_json_apn_t *db_apn = ogs_dbi_static_get_apn(dnn); + + int charging_char = -1; + + if (!db_apn) + db_apn = ogs_dbi_static_get_apn("*"); + + if (!db_apn) { + ogs_error("Couldn't find a profile for dnn (%s)", dnn); + return OGS_ERROR; + } + + profile = ogs_dbi_static_get_apn_profile(db_apn, charging_char); + /* try default profile */ + if (!profile && charging_char != -1) + profile = ogs_dbi_static_get_apn_profile(db_apn, -1); + + if (!profile) { + ogs_error("Couldn't find a profile for dnn (%s) with charging characteristic %d", dnn, charging_char); + return OGS_ERROR; + } + + session->name = ogs_strndup("json_profile", strlen("json_profile")); + /* FIXME: the ambr shouldn't be qos.mbr, instead it should be from apn.ambr, but neither PCRF nor PCEF support it this way */ + session->ambr = profile->qos.mbr; + session->qos = profile->qos; + + return OGS_OK; +} + +static void json_final(void) { + int i; + for (i = 0; i < MAX_DB_APNS; i++) { + ogs_json_apn_t *db_apn = &g_apns[i]; + if (!db_apn->valid) + continue; + db_apn->valid = 0; + + if (db_apn->apn) { + ogs_free(db_apn->apn); + db_apn->apn = NULL; + } + } +} + +ogs_dbi_t ogs_dbi_json_interface = { + .name = "json", + /* session */ + .session_data = json_session_data, + .final = json_final, +}; + diff --git a/lib/dbi/meson.build b/lib/dbi/meson.build index d788df798f..b4e16dd923 100644 --- a/lib/dbi/meson.build +++ b/lib/dbi/meson.build @@ -31,6 +31,13 @@ mongo_sources = files(''' mongo/ims.c '''.split()) +json_sources = files(''' + json/json.c + external/cjson/cJSON.c +'''.split()) +libdbi_sources += [json_sources] +cjson_inc = include_directories('./external/') + libmongoc_dep = dependency('libmongoc-1.0', required: true) if libmongoc_dep.found() libdbi_conf.set('WITH_MONGOC', 1) @@ -41,11 +48,18 @@ configure_file(output : 'dbi-config-private.h', configuration : libdbi_conf) libdbi_inc = include_directories('.') +dbi_cc_flags = ['-DOGS_DBI_COMPILATION'] +if cc.get_id() == 'gcc' or cc.get_id() == 'clang' + dbi_cc_flags += cc.get_supported_arguments([ + '-Wno-float-equal', + ]) +endif + libdbi = library('ogsdbi', sources : libdbi_sources, version : libogslib_version, - c_args : '-DOGS_DBI_COMPILATION', - include_directories : [libdbi_inc, libinc], + c_args : dbi_cc_flags, + include_directories : [libdbi_inc, libinc, cjson_inc], dependencies : [libcrypt_dep, libmongoc_dep], install : true) diff --git a/lib/dbi/ogs-dbi.h b/lib/dbi/ogs-dbi.h index 4eec01a9de..31ec489fb1 100644 --- a/lib/dbi/ogs-dbi.h +++ b/lib/dbi/ogs-dbi.h @@ -39,6 +39,9 @@ extern "C" { extern int __ogs_dbi_domain; +/* can be called multiple times for every apn */ +int ogs_dbi_json_init(const char *filepath, const char *apn); + #undef OGS_LOG_DOMAIN #define OGS_LOG_DOMAIN __ogs_dbi_domain From 9d7737c4b70958e30a6c0ca06c737b920a8ddb91 Mon Sep 17 00:00:00 2001 From: Alexander Couzens Date: Tue, 23 Aug 2022 18:09:36 +0200 Subject: [PATCH 09/12] [dbi] session_data(): add argument charging characteristics Add the charging characteristics to the dbi function to allow the backend to decide the profile based on it. The charging characteristics can be filled by the HSS and will be passed by the PCEF towards the PCRF. This is an API dbi breakage. --- lib/dbi/dbi-private.h | 2 +- lib/dbi/dbi.c | 4 ++-- lib/dbi/json/json.c | 5 ++--- lib/dbi/mongo/mongo-private.h | 2 +- lib/dbi/mongo/session.c | 2 +- lib/dbi/session.h | 4 +++- src/pcf/nbsf-handler.c | 3 ++- src/pcf/npcf-handler.c | 5 +++-- src/pcrf/pcrf-context.c | 2 +- 9 files changed, 16 insertions(+), 13 deletions(-) diff --git a/lib/dbi/dbi-private.h b/lib/dbi/dbi-private.h index 1812cbbe47..e6a5bca53f 100644 --- a/lib/dbi/dbi-private.h +++ b/lib/dbi/dbi-private.h @@ -34,7 +34,7 @@ struct ogs_dbi_s { void (*final)(void); /* session */ int (*session_data)(char *supi, ogs_s_nssai_t *s_nssai, char *dnn, - ogs_session_data_t *data); + int32_t charging_char, ogs_session_data_t *data); /* ims */ int (*msisdn_data)(char *imsi_or_msisdn_bcd, ogs_msisdn_data_t *msisdn_data); int (*ims_data)(char *supi, ogs_ims_data_t *ims_data); diff --git a/lib/dbi/dbi.c b/lib/dbi/dbi.c index 2207cd2411..2b3a4c878e 100644 --- a/lib/dbi/dbi.c +++ b/lib/dbi/dbi.c @@ -93,12 +93,12 @@ int ogs_dbi_ims_data(char *supi, ogs_ims_data_t *ims_data) /* session */ int ogs_dbi_session_data(char *supi, ogs_s_nssai_t *s_nssai, char *dnn, - ogs_session_data_t *session_data) + int32_t charging_char, ogs_session_data_t *session_data) { ogs_assert(dbi_selected); if (!dbi_selected->session_data) return OGS_ERROR; - return dbi_selected->session_data(supi, s_nssai, dnn, session_data); + return dbi_selected->session_data(supi, s_nssai, dnn, charging_char, session_data); } /* subscription */ diff --git a/lib/dbi/json/json.c b/lib/dbi/json/json.c index 591b70df47..697589eef3 100644 --- a/lib/dbi/json/json.c +++ b/lib/dbi/json/json.c @@ -360,14 +360,13 @@ int ogs_dbi_json_init(const char *filepath, const char *apn) return ret; } -static int json_session_data(char *supi, ogs_s_nssai_t *s_nssai, char *dnn, ogs_session_data_t *session_data) +static int json_session_data(char *supi, ogs_s_nssai_t *s_nssai, char *dnn, + int32_t charging_char, ogs_session_data_t *session_data) { ogs_session_t *session = &session_data->session; ogs_json_apn_profile_t *profile; ogs_json_apn_t *db_apn = ogs_dbi_static_get_apn(dnn); - int charging_char = -1; - if (!db_apn) db_apn = ogs_dbi_static_get_apn("*"); diff --git a/lib/dbi/mongo/mongo-private.h b/lib/dbi/mongo/mongo-private.h index 4fb787ef62..f747351dc2 100644 --- a/lib/dbi/mongo/mongo-private.h +++ b/lib/dbi/mongo/mongo-private.h @@ -40,7 +40,7 @@ int ogs_dbi_mongo_ims_data(char *supi, ogs_ims_data_t *ims_data); /* session */ int ogs_dbi_mongo_session_data(char *supi, ogs_s_nssai_t *s_nssai, char *dnn, - ogs_session_data_t *session_data); + int32_t charging_char, ogs_session_data_t *session_data); /* subscription */ int ogs_dbi_mongo_auth_info(char *supi, ogs_dbi_auth_info_t *auth_info); diff --git a/lib/dbi/mongo/session.c b/lib/dbi/mongo/session.c index 1b82ce88a6..dabb5cf310 100644 --- a/lib/dbi/mongo/session.c +++ b/lib/dbi/mongo/session.c @@ -23,7 +23,7 @@ #include "mongo-private.h" int ogs_dbi_mongo_session_data(char *supi, ogs_s_nssai_t *s_nssai, char *dnn, - ogs_session_data_t *session_data) + int32_t charging_char, ogs_session_data_t *session_data) { int rv = OGS_OK; mongoc_cursor_t *cursor = NULL; diff --git a/lib/dbi/session.h b/lib/dbi/session.h index 17e4ddd3e9..2c10c5a34e 100644 --- a/lib/dbi/session.h +++ b/lib/dbi/session.h @@ -28,8 +28,10 @@ extern "C" { #endif +#define OGS_DBI_NO_CHARGING_CHAR -1 + int ogs_dbi_session_data(char *supi, ogs_s_nssai_t *s_nssai, char *dnn, - ogs_session_data_t *session_data); + int32_t charging_char, ogs_session_data_t *session_data); #ifdef __cplusplus } diff --git a/src/pcf/nbsf-handler.c b/src/pcf/nbsf-handler.c index fc48a5e284..ca8e3b834f 100644 --- a/src/pcf/nbsf-handler.c +++ b/src/pcf/nbsf-handler.c @@ -123,7 +123,8 @@ bool pcf_nbsf_management_handle_register( ogs_sbi_header_free(&header); rv = ogs_dbi_session_data( - pcf_ue->supi, &sess->s_nssai, sess->dnn, &session_data); + pcf_ue->supi, &sess->s_nssai, sess->dnn, OGS_DBI_NO_CHARGING_CHAR, + &session_data); if (rv != OGS_OK) { strerror = ogs_msprintf("[%s:%d] Cannot find SUPI in DB", pcf_ue->supi, sess->psi); diff --git a/src/pcf/npcf-handler.c b/src/pcf/npcf-handler.c index d0651f8ded..d6612a2e6a 100644 --- a/src/pcf/npcf-handler.c +++ b/src/pcf/npcf-handler.c @@ -567,7 +567,7 @@ bool pcf_npcf_policyauthorization_handle_create(pcf_sess_t *sess, memset(&session_data, 0, sizeof(ogs_session_data_t)); rv = ogs_dbi_session_data( - pcf_ue->supi, &sess->s_nssai, sess->dnn, &session_data); + pcf_ue->supi, &sess->s_nssai, sess->dnn, OGS_DBI_NO_CHARGING_CHAR, &session_data); if (rv != OGS_OK) { strerror = ogs_msprintf("[%s:%d] Cannot find SUPI in DB", pcf_ue->supi, sess->psi); @@ -980,7 +980,8 @@ bool pcf_npcf_policyauthorization_handle_update( memset(&session_data, 0, sizeof(ogs_session_data_t)); rv = ogs_dbi_session_data( - pcf_ue->supi, &sess->s_nssai, sess->dnn, &session_data); + pcf_ue->supi, &sess->s_nssai, sess->dnn, OGS_DBI_NO_CHARGING_CHAR, + &session_data); if (rv != OGS_OK) { strerror = ogs_msprintf("[%s:%d] Cannot find SUPI in DB", pcf_ue->supi, sess->psi); diff --git a/src/pcrf/pcrf-context.c b/src/pcrf/pcrf-context.c index ca85d71cb6..d3c38c9e74 100644 --- a/src/pcrf/pcrf-context.c +++ b/src/pcrf/pcrf-context.c @@ -281,7 +281,7 @@ int pcrf_db_qos_data( ogs_assert(supi); /* For EPC, we'll use [S_NSSAI = NULL] */ - rv = ogs_dbi_session_data(supi, NULL, apn, session_data); + rv = ogs_dbi_session_data(supi, NULL, apn, OGS_DBI_NO_CHARGING_CHAR, session_data); /* For EPC, we need to inialize Flow-Status in Pcc-Rule */ for (i = 0; i < session_data->num_of_pcc_rule; i++) { From 1a6ceca4b511692027850af355ea042ec3efb7a5 Mon Sep 17 00:00:00 2001 From: Alexander Couzens Date: Tue, 23 Aug 2022 18:15:08 +0200 Subject: [PATCH 10/12] [app/pcrf]: parse json database configuration To make use of the new json database backend, allow the pcrf to parse json backend configuration. --- configs/pcrf-no-mongodb/pcrf-default.json | 17 +++++++ configs/pcrf-no-mongodb/pcrf-internet.json | 32 +++++++++++++ configs/pcrf-no-mongodb/pcrf.yaml.in | 55 ++++++++++++++++++++++ lib/app/ogs-context.c | 19 ++++++++ lib/app/ogs-context.h | 7 +++ src/pcrf/pcrf-init.c | 17 ++++++- 6 files changed, 145 insertions(+), 2 deletions(-) create mode 100644 configs/pcrf-no-mongodb/pcrf-default.json create mode 100644 configs/pcrf-no-mongodb/pcrf-internet.json create mode 100644 configs/pcrf-no-mongodb/pcrf.yaml.in diff --git a/configs/pcrf-no-mongodb/pcrf-default.json b/configs/pcrf-no-mongodb/pcrf-default.json new file mode 100644 index 0000000000..2785ed687c --- /dev/null +++ b/configs/pcrf-no-mongodb/pcrf-default.json @@ -0,0 +1,17 @@ +[ + { + "id": 4660, + "qci": 8, + "priority": 5, + "pre_emption_capability": 0, + "pre_emption_vulnerability": 1, + "ambr": { + "up": 999, + "down": 1000 + }, + "gmbr": { + "up": 500, + "down": 500 + } + } +] diff --git a/configs/pcrf-no-mongodb/pcrf-internet.json b/configs/pcrf-no-mongodb/pcrf-internet.json new file mode 100644 index 0000000000..a1b0a88fe6 --- /dev/null +++ b/configs/pcrf-no-mongodb/pcrf-internet.json @@ -0,0 +1,32 @@ +[ + { + "id": -1, + "qci": 5, + "priority": 5, + "pre_emption_capability": 0, + "pre_emption_vulnerability": 1, + "ambr": { + "up": 1000, + "down": 10000 + }, + "gmbr": { + "up": 500, + "down": 500 + } + }, + { + "id": 4660, + "qci": 5, + "priority": 5, + "pre_emption_capability": 0, + "pre_emption_vulnerability": 1, + "ambr": { + "up": 1000, + "down": 10000 + }, + "gmbr": { + "up": 500, + "down": 500 + } + } +] diff --git a/configs/pcrf-no-mongodb/pcrf.yaml.in b/configs/pcrf-no-mongodb/pcrf.yaml.in new file mode 100644 index 0000000000..d5cf75f756 --- /dev/null +++ b/configs/pcrf-no-mongodb/pcrf.yaml.in @@ -0,0 +1,55 @@ +# db_json +# allow to use json templates for the policy +# a * will be used if the apn isn't defined. it can be omitted. +db_json: + internet: @sysconfdir@/open5gs/pcrf-internet.json + "*": @sysconfdir@/open5gs/pcrf-default.json + +# +# logger: +# +# o Set OGS_LOG_INFO to all domain level +# - If `level` is omitted, the default level is OGS_LOG_INFO) +# - If `domain` is omitted, the all domain level is set from 'level' +# (Nothing is needed) +# +# o Set OGS_LOG_ERROR to all domain level +# - `level` can be set with none, fatal, error, warn, info, debug, trace +# level: error +# +# o Set OGS_LOG_DEBUG to mme/emm domain level +# level: debug +# domain: mme,emm +# +# o Set OGS_LOG_TRACE to all domain level +# level: trace +# domain: core,fd,pcrf,event,mem,sock +logger: + file: @localstatedir@/log/open5gs/pcrf.log + +pcrf: + freeDiameter: @sysconfdir@/freeDiameter/pcrf.conf + +# +# parameter: +# +# o Disable use of IPv4 addresses (only IPv6) +# no_ipv4: true +# +# o Disable use of IPv6 addresses (only IPv4) +# no_ipv6: true +# +# o Prefer IPv4 instead of IPv6 for estabishing new GTP connections. +# prefer_ipv4: true +# +parameter: + +# +# max: +# +# o Maximum Number of UE +# ue: 1024 +# o Maximum Number of Peer(S1AP/NGAP, DIAMETER, GTP, PFCP or SBI) +# peer: 64 +# +max: diff --git a/lib/app/ogs-context.c b/lib/app/ogs-context.c index 08c2024b34..083e59bab6 100644 --- a/lib/app/ogs-context.c +++ b/lib/app/ogs-context.c @@ -252,6 +252,25 @@ int ogs_app_context_parse_config(void) ogs_assert(root_key); if (!strcmp(root_key, "db_uri")) { self.db_uri = ogs_yaml_iter_value(&root_iter); + } else if (!strcmp(root_key, "db_json")) { + ogs_yaml_iter_t dbjson_iter; + ogs_yaml_iter_recurse(&root_iter, &dbjson_iter); + int apns = 0; + while (ogs_yaml_iter_next(&dbjson_iter)) { + const char *apn = ogs_yaml_iter_key(&dbjson_iter); + const char *apn_filepath; + + if (apns >= OGS_APP_DB_JSON_MAX_APNS) { + ogs_error("db_json: too many apns defined!"); + return OGS_ERROR; + } + ogs_assert(apn); + apn_filepath = ogs_yaml_iter_value(&dbjson_iter); + ogs_assert(apn_filepath); + self.db_json[apns].apn = apn; + self.db_json[apns].filepath = apn_filepath; + apns++; + } } else if (!strcmp(root_key, "logger")) { ogs_yaml_iter_t logger_iter; ogs_yaml_iter_recurse(&root_iter, &logger_iter); diff --git a/lib/app/ogs-context.h b/lib/app/ogs-context.h index 2850c88ffa..2e7a1f290b 100644 --- a/lib/app/ogs-context.h +++ b/lib/app/ogs-context.h @@ -28,6 +28,8 @@ extern "C" { #endif +#define OGS_APP_DB_JSON_MAX_APNS 16 + typedef struct ogs_app_context_s { const char *version; @@ -35,6 +37,11 @@ typedef struct ogs_app_context_s { void *document; const char *db_uri; + struct { + const char *apn; + const char *filepath; + } db_json[OGS_APP_DB_JSON_MAX_APNS]; + struct { const char *file; const char *level; diff --git a/src/pcrf/pcrf-init.c b/src/pcrf/pcrf-init.c index 5cd669e7d6..d87f9b232a 100644 --- a/src/pcrf/pcrf-init.c +++ b/src/pcrf/pcrf-init.c @@ -35,8 +35,21 @@ int pcrf_initialize(void) ogs_app()->logger.domain, ogs_app()->logger.level); if (rv != OGS_OK) return rv; - rv = ogs_dbi_init(ogs_app()->db_uri); - if (rv != OGS_OK) return rv; + if (ogs_app()->db_uri) { + rv = ogs_dbi_mongo_init(ogs_app()->db_uri); + if (rv != OGS_OK) return rv; + } else if (ogs_app()->db_json[0].apn) { + int i; + for (i = 0; i < OGS_APP_DB_JSON_MAX_APNS; i++) { + if (ogs_app()->db_json[i].apn && ogs_app()->db_json[i].filepath) { + rv = ogs_dbi_json_init(ogs_app()->db_json[i].filepath, ogs_app()->db_json[i].apn); + if (rv != OGS_OK) return rv; + } + } + } else { + ogs_error("No database selected!"); + return OGS_ERROR; + } rv = pcrf_fd_init(); if (rv != OGS_OK) return OGS_ERROR; From 8960372ed3756e166ac27db4164017153c412bbf Mon Sep 17 00:00:00 2001 From: Alexander Couzens Date: Tue, 23 Aug 2022 18:16:36 +0200 Subject: [PATCH 11/12] [pcrf]: Gx: parse 3GPP Charging Characteristic Also pass the 3GPP-Charging-Characteristics to the dbi session_data call --- src/pcrf/pcrf-context.c | 11 +++++++++-- src/pcrf/pcrf-context.h | 2 +- src/pcrf/pcrf-gx-path.c | 31 +++++++++++++++++++++++++------ 3 files changed, 35 insertions(+), 9 deletions(-) diff --git a/src/pcrf/pcrf-context.c b/src/pcrf/pcrf-context.c index d3c38c9e74..3c0dc8e164 100644 --- a/src/pcrf/pcrf-context.c +++ b/src/pcrf/pcrf-context.c @@ -267,7 +267,7 @@ int pcrf_context_parse_config(void) } int pcrf_db_qos_data( - char *imsi_bcd, char *apn, ogs_session_data_t *session_data) + char *imsi_bcd, char *apn, int32_t charging_char, ogs_session_data_t *session_data) { int rv, i; char *supi = NULL; @@ -281,7 +281,9 @@ int pcrf_db_qos_data( ogs_assert(supi); /* For EPC, we'll use [S_NSSAI = NULL] */ - rv = ogs_dbi_session_data(supi, NULL, apn, OGS_DBI_NO_CHARGING_CHAR, session_data); + rv = ogs_dbi_session_data(supi, NULL, apn, charging_char, session_data); + if (rv) + goto fail; /* For EPC, we need to inialize Flow-Status in Pcc-Rule */ for (i = 0; i < session_data->num_of_pcc_rule; i++) { @@ -292,6 +294,11 @@ int pcrf_db_qos_data( ogs_free(supi); ogs_thread_mutex_unlock(&self.db_lock); + return 0; + +fail: + ogs_thread_mutex_unlock(&self.db_lock); + ogs_free(supi); return rv; } diff --git a/src/pcrf/pcrf-context.h b/src/pcrf/pcrf-context.h index 3ee31c36af..9bde180394 100644 --- a/src/pcrf/pcrf-context.h +++ b/src/pcrf/pcrf-context.h @@ -54,7 +54,7 @@ pcrf_context_t *pcrf_self(void); int pcrf_context_parse_config(void); int pcrf_db_qos_data(char *imsi_bcd, char *apn, - ogs_session_data_t *session_data); + int32_t charging_char, ogs_session_data_t *session_data); void pcrf_sess_set_ipv4(const void *key, uint8_t *sid); void pcrf_sess_set_ipv6(const void *key, uint8_t *sid); diff --git a/src/pcrf/pcrf-gx-path.c b/src/pcrf/pcrf-gx-path.c index 3a288235c6..6d30321e5e 100644 --- a/src/pcrf/pcrf-gx-path.c +++ b/src/pcrf/pcrf-gx-path.c @@ -39,11 +39,13 @@ struct sess_state { char *imsi_bcd; char *apn; -ED3(uint8_t ipv4:1;, +ED4(uint8_t ipv4:1;, uint8_t ipv6:1;, - uint8_t reserved:6;) + uint8_t charging:1;, + uint8_t reserved:5;) uint32_t addr; /* Framed-IPv4-Address */ uint8_t addr6[OGS_IPV6_LEN]; /* Framed-IPv6-Prefix */ + int32_t charging_chr; ogs_list_t rx_list; @@ -352,6 +354,23 @@ static int pcrf_gx_ccr_cb( struct msg **msg, struct avp *avp, sess_data->ipv6 = 1; } + /* Get 3GPP-Charging-Characteristics */ + sess_data->charging_chr = -1; + ret = fd_msg_search_avp(qry, ogs_diam_gx_3gpp_charging_characteristics, &avp); + ogs_assert(ret == 0); + if (avp) { + ret = fd_msg_avp_hdr(avp, &hdr); + ogs_assert(ret == 0); + char charging_bin[OGS_CHRGCHARS_LEN]; + memcpy(charging_bin, + OGS_HEX(hdr->avp_value->os.data, (int)hdr->avp_value->os.len, charging_bin), OGS_CHRGCHARS_LEN); + if (hdr->avp_value->os.len == 1) + sess_data->charging_chr = charging_bin[0]; + else + sess_data->charging_chr = charging_bin[0] << 8 | charging_bin[1]; + sess_data->charging = 1; + } + /* Get IMSI + APN */ ret = fd_msg_search_avp(qry, ogs_diam_subscription_id, &avp); ogs_assert(ret == 0); @@ -416,10 +435,10 @@ static int pcrf_gx_ccr_cb( struct msg **msg, struct avp *avp, /* Retrieve QoS Data from Database */ rv = pcrf_db_qos_data( - sess_data->imsi_bcd, sess_data->apn, &gx_message.session_data); + sess_data->imsi_bcd, sess_data->apn, sess_data->charging_chr, &gx_message.session_data); if (rv != OGS_OK) { - ogs_error("Cannot get data for IMSI(%s)+APN(%s)'", - sess_data->imsi_bcd, sess_data->apn); + ogs_error("Cannot get data for IMSI(%s)+APN(%s)+ChargingChr(%d)'", + sess_data->imsi_bcd, sess_data->apn, sess_data->charging_chr); result_code = OGS_DIAM_UNKNOWN_SESSION_ID; goto out; } @@ -725,7 +744,7 @@ int pcrf_gx_send_rar( /* Retrieve QoS Data from Database */ rv = pcrf_db_qos_data( - sess_data->imsi_bcd, sess_data->apn, &gx_message.session_data); + sess_data->imsi_bcd, sess_data->apn, sess_data->charging_chr, &gx_message.session_data); if (rv != OGS_OK) { ogs_error("Cannot get data for IMSI(%s)+APN(%s)'", sess_data->imsi_bcd, sess_data->apn); From 1151c6ac0fac7fda7da0fe8edf8ea6f718f92278 Mon Sep 17 00:00:00 2001 From: Alexander Couzens Date: Sun, 11 Sep 2022 20:43:57 +0200 Subject: [PATCH 12/12] [dbi]: allow to build without mongodb The tests won't be build as they depend on mongodb. To build without mongodb do meson configure -Dmongodb=false --- lib/dbi/meson.build | 24 ++++++++++++++++------ lib/dbi/mongo/dummy.c | 48 +++++++++++++++++++++++++++++++++++++++++++ meson.build | 3 ++- meson_options.txt | 1 + 4 files changed, 69 insertions(+), 7 deletions(-) create mode 100644 lib/dbi/mongo/dummy.c diff --git a/lib/dbi/meson.build b/lib/dbi/meson.build index b4e16dd923..d41b8d7617 100644 --- a/lib/dbi/meson.build +++ b/lib/dbi/meson.build @@ -16,6 +16,7 @@ # along with this program. If not, see . libdbi_conf = configuration_data() +libdbi_deps = [libcrypt_dep] dbi_sources = files(''' ogs-dbi.h @@ -31,6 +32,11 @@ mongo_sources = files(''' mongo/ims.c '''.split()) +without_mongo_sources = files(''' + mongo/dummy.c + mongo/ogs-mongoc.h +'''.split()) + json_sources = files(''' json/json.c external/cjson/cJSON.c @@ -38,10 +44,16 @@ json_sources = files(''' libdbi_sources += [json_sources] cjson_inc = include_directories('./external/') -libmongoc_dep = dependency('libmongoc-1.0', required: true) -if libmongoc_dep.found() - libdbi_conf.set('WITH_MONGOC', 1) - libdbi_sources += [mongo_sources] +mongodb_optval = get_option('mongodb') +if mongodb_optval + libmongoc_dep = dependency('libmongoc-1.0', required: true) + if libmongoc_dep.found() + libdbi_conf.set('WITH_MONGOC', 1) + libdbi_sources += [mongo_sources] + libdbi_deps += [libmongoc_dep] + endif +else + libdbi_sources += [without_mongo_sources] endif configure_file(output : 'dbi-config-private.h', configuration : libdbi_conf) @@ -60,10 +72,10 @@ libdbi = library('ogsdbi', version : libogslib_version, c_args : dbi_cc_flags, include_directories : [libdbi_inc, libinc, cjson_inc], - dependencies : [libcrypt_dep, libmongoc_dep], + dependencies : libdbi_deps, install : true) libdbi_dep = declare_dependency( link_with : libdbi, include_directories : [libdbi_inc, libinc], - dependencies : [libcrypt_dep, libmongoc_dep]) + dependencies : libdbi_deps) diff --git a/lib/dbi/mongo/dummy.c b/lib/dbi/mongo/dummy.c new file mode 100644 index 0000000000..9190c52b12 --- /dev/null +++ b/lib/dbi/mongo/dummy.c @@ -0,0 +1,48 @@ +/* + * Copyright (C) 2022 by sysmocom - s.f.m.c. GmbH + * Author: Alexander Couzens + * + * This file is part of Open5GS. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program 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 this program. If not, see . + */ + +/* This file will be used when build without mongodb support to support the old api */ +#include "ogs-dbi.h" + +int ogs_dbi_init(const char *db_uri) +{ + return -ENODEV; +} + +int ogs_dbi_mongo_init(const char *db_uri) +{ + return -ENODEV; +} + +int ogs_mongoc_init(const char *db_uri) +{ + return -ENODEV; +} + +void ogs_mongoc_final(void) +{ +} + +ogs_mongoc_t *ogs_mongoc(void) +{ + return NULL; +} + + diff --git a/meson.build b/meson.build index 84670367e3..6552d6dbcb 100644 --- a/meson.build +++ b/meson.build @@ -120,7 +120,8 @@ subdir('lib') subdir('src') subdir('misc') # Don't build the tests unless we can run them (either natively or in an exe wrapper) -build_tests = not meson.is_cross_build() or (meson.is_cross_build() and meson.has_exe_wrapper()) +# tests also depend on mongodb +build_tests = get_option('mongodb') and (not meson.is_cross_build() or (meson.is_cross_build() and meson.has_exe_wrapper())) if build_tests subdir('tests') endif diff --git a/meson_options.txt b/meson_options.txt index 9350a6b8f3..c81c380444 100644 --- a/meson_options.txt +++ b/meson_options.txt @@ -1 +1,2 @@ option('metrics_impl', type : 'combo', choices : ['void', 'prometheus'], value : 'void', description : 'libogsmetrics implementation') +option('mongodb', type : 'boolean', value : 'true', description : 'build with mongodb support')