From cb18e83e9f4edd62e5316c19fa5870d46b10ffd4 Mon Sep 17 00:00:00 2001 From: Jennifer Richards Date: Mon, 7 May 2018 14:06:43 -0400 Subject: [PATCH] Move repeated #defines into tr_json_util.h and add documentation --- CMakeLists.txt | 10 ++--- common/tr_config_encoders.c | 20 +--------- common/tr_filter_encoders.c | 19 +-------- common/tr_idp_encoders.c | 18 +-------- common/tr_rp_client_encoders.c | 18 +-------- include/tr_json_util.h | 89 ++++++++++++++++++++++++++++++++++++++++++ trp/trp_peer_encoders.c | 10 +---- trp/trp_route_encoders.c | 16 +------- 8 files changed, 101 insertions(+), 99 deletions(-) create mode 100644 include/tr_json_util.h diff --git a/CMakeLists.txt b/CMakeLists.txt index 1221d67..2aa60bc 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -96,19 +96,19 @@ set(SOURCE_FILES trp/trp_upd.c trp/trpc.c trp/trps.c include/tr_name_internal.h mon/mon_req.c mon/mon_req_encode.c mon/mon_req_decode.c - mon/mon_resp.c mon/mon_common.c mon/mon_resp_encode.c mon/mon_resp_decode.c tr/tr_mon.c mon/mons.c include/tr_socket.h common/tr_gss.c include/tr_gss.h common/tr_config_internal.c mon/mons_handlers.c include/mons_handlers.h tr/tr_tid_mons.c tr/tr_tid_mons.c trp/trp_route.c include/trp_route.h trp/trp_rtable_encoders.c trp/trp_route_encoders.c trp/trp_peer.c include/trp_peer.h trp/trp_peer_encoders.c trp/trp_ptable_encoders.c common/tr_idp_encoders.c common/tr_comm_encoders.c common/tr_rp_client.c include/tr_rp_client.h common/tr_rp_client_encoders.c common/tr_filter_encoders.c common/tr_config_encoders.c common/tr_config_filters.c common/tr_config_realms.c common/tr_config_rp_clients.c common/tr_config_orgs.c common/tr_config_comms.c common/tr_list.c include/tr_list.h include/tr_constraint_internal.h) + mon/mon_resp.c mon/mon_common.c mon/mon_resp_encode.c mon/mon_resp_decode.c tr/tr_mon.c mon/mons.c include/tr_socket.h common/tr_gss.c include/tr_gss.h common/tr_config_internal.c mon/mons_handlers.c include/mons_handlers.h tr/tr_tid_mons.c tr/tr_tid_mons.c trp/trp_route.c include/trp_route.h trp/trp_rtable_encoders.c trp/trp_route_encoders.c trp/trp_peer.c include/trp_peer.h trp/trp_peer_encoders.c trp/trp_ptable_encoders.c common/tr_idp_encoders.c common/tr_comm_encoders.c common/tr_rp_client.c include/tr_rp_client.h common/tr_rp_client_encoders.c common/tr_filter_encoders.c common/tr_config_encoders.c common/tr_config_filters.c common/tr_config_realms.c common/tr_config_rp_clients.c common/tr_config_orgs.c common/tr_config_comms.c common/tr_list.c include/tr_list.h include/tr_constraint_internal.h include/tr_json_util.h) # Does not actually build! add_executable(trust_router ${SOURCE_FILES}) -add_executable(trmon mon/monc.c tr/trmon_main.c common/tr_gss_client.c include/tr_gss_client.h) +add_executable(trmon mon/monc.c tr/trmon_main.c common/tr_gss_client.c include/tr_gss_client.h include/tr_json_util.h) # Test build targets - for debugging -add_executable(test_mon_req_encode mon/mon_common.c mon/mon_req.c mon/tests/test_mon_req_encode.c mon/mon_req_encode.c) +add_executable(test_mon_req_encode mon/mon_common.c mon/mon_req.c mon/tests/test_mon_req_encode.c mon/mon_req_encode.c include/tr_json_util.h) target_link_libraries(test_mon_req_encode jansson talloc glib-2.0) -add_executable(test_mon_req_decode mon/mon_common.c mon/mon_req.c mon/tests/test_mon_req_decode.c mon/mon_req_decode.c) +add_executable(test_mon_req_decode mon/mon_common.c mon/mon_req.c mon/tests/test_mon_req_decode.c mon/mon_req_decode.c include/tr_json_util.h) target_link_libraries(test_mon_req_decode jansson talloc glib-2.0) -add_executable(test_mon_resp_encode mon/mon_common.c mon/mon_req.c mon/mon_resp.c mon/mon_resp_encode.c common/tr_name.c mon/tests/test_mon_resp_encode.c) +add_executable(test_mon_resp_encode mon/mon_common.c mon/mon_req.c mon/mon_resp.c mon/mon_resp_encode.c common/tr_name.c mon/tests/test_mon_resp_encode.c include/tr_json_util.h) target_link_libraries(test_mon_resp_encode jansson talloc glib-2.0) diff --git a/common/tr_config_encoders.c b/common/tr_config_encoders.c index 47331d9..a6307cd 100644 --- a/common/tr_config_encoders.c +++ b/common/tr_config_encoders.c @@ -1,5 +1,5 @@ /* - * Copyright (c) 2012, JANET(UK) + * Copyright (c) 2018, JANET(UK) * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -34,23 +34,7 @@ #include #include - -/* helper for below */ -#define OBJECT_SET_OR_FAIL(jobj, key, val) \ -do { \ - if (val) \ - json_object_set_new((jobj),(key),(val)); \ - else \ - goto cleanup; \ -} while (0) - -#define ARRAY_APPEND_OR_FAIL(jary, val) \ -do { \ - if (val) \ - json_array_append_new((jary),(val)); \ - else \ - goto cleanup; \ -} while (0) +#include static json_t *tr_cfg_file_to_json(TR_CFG_FILE *cfg_file) { diff --git a/common/tr_filter_encoders.c b/common/tr_filter_encoders.c index 932be9e..a69685d 100644 --- a/common/tr_filter_encoders.c +++ b/common/tr_filter_encoders.c @@ -37,24 +37,7 @@ #include #include - -/* helper for below */ -#define OBJECT_SET_OR_FAIL(jobj, key, val) \ -do { \ - if (val) \ - json_object_set_new((jobj),(key),(val)); \ - else \ - goto cleanup; \ -} while (0) - -#define ARRAY_APPEND_OR_FAIL(jary, val) \ -do { \ - if (val) \ - json_array_append_new((jary),(val)); \ - else \ - goto cleanup; \ -} while (0) - +#include typedef json_t *(ITEM_ENCODER_FUNC)(void *); diff --git a/common/tr_idp_encoders.c b/common/tr_idp_encoders.c index 2167ea9..72acd15 100644 --- a/common/tr_idp_encoders.c +++ b/common/tr_idp_encoders.c @@ -40,6 +40,7 @@ #include #include #include +#include static char *tr_aaa_server_to_str(TALLOC_CTX *mem_ctx, TR_AAA_SERVER *aaa) { @@ -121,23 +122,6 @@ char *tr_idp_realm_to_str(TALLOC_CTX *mem_ctx, TR_IDP_REALM *idp) } -/* helper for below */ -#define OBJECT_SET_OR_FAIL(jobj, key, val) \ -do { \ - if (val) \ - json_object_set_new((jobj),(key),(val)); \ - else \ - goto cleanup; \ -} while (0) - -#define ARRAY_APPEND_OR_FAIL(jary, val) \ -do { \ - if (val) \ - json_array_append_new((jary),(val)); \ - else \ - goto cleanup; \ -} while (0) - static json_t *tr_apcs_to_json(TR_APC *apcs) { json_t *jarray = json_array(); diff --git a/common/tr_rp_client_encoders.c b/common/tr_rp_client_encoders.c index 6a7bda9..020962a 100644 --- a/common/tr_rp_client_encoders.c +++ b/common/tr_rp_client_encoders.c @@ -37,23 +37,7 @@ #include #include - -/* helper for below */ -#define OBJECT_SET_OR_FAIL(jobj, key, val) \ -do { \ - if (val) \ - json_object_set_new((jobj),(key),(val)); \ - else \ - goto cleanup; \ -} while (0) - -#define ARRAY_APPEND_OR_FAIL(jary, val) \ -do { \ - if (val) \ - json_array_append_new((jary),(val)); \ - else \ - goto cleanup; \ -} while (0) +#include static json_t *tr_rp_client_to_json(TR_RP_CLIENT *rp_client) { diff --git a/include/tr_json_util.h b/include/tr_json_util.h new file mode 100644 index 0000000..3573a88 --- /dev/null +++ b/include/tr_json_util.h @@ -0,0 +1,89 @@ +/* + * Copyright (c) 2018, JANET(UK) + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * 3. Neither the name of JANET(UK) nor the names of its contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * + */ + +/* Utilities for working with JSON/jansson */ + +#ifndef TRUST_ROUTER_TR_JSON_UTIL_H +#define TRUST_ROUTER_TR_JSON_UTIL_H + +/** + * @def OBJECT_SET_OR_FAIL(job, key, val) + * Add a key/value pair to an object or jump to the cleanup label + * if the value is null. + * + * @param jobj JSON object instance to receive the key/value pair + * @param key key to set + * @param val value to set + */ +#define OBJECT_SET_OR_FAIL(jobj, key, val) \ +do { \ + if (val) \ + json_object_set_new((jobj),(key),(val)); \ + else \ + goto cleanup; \ +} while (0) + +/** + * @def OBJECT_SET_OR_SKIP(job, key, val) + * Add a key/value pair to an object only if it is non-null. + * + * @param jobj JSON object instance to receive the key/value pair + * @param key key to set + * @param val value to set + */ +#define OBJECT_SET_OR_SKIP(jobj, key, val) \ +do { \ + if (val) \ + json_object_set_new((jobj),(key),(val)); \ +} while (0) + + +/** + * @def ARRAY_APPEND_OR_FAIL(job, key, val) + * Append a value to an array or jump to the cleanup label + * if the value is null. + * + * @param jobj JSON array instance to receive the value + * @param val value to set + */ +#define ARRAY_APPEND_OR_FAIL(jary, val) \ +do { \ + if (val) \ + json_array_append_new((jary),(val)); \ + else \ + goto cleanup; \ +} while (0) + + +#endif //TRUST_ROUTER_TR_JSON_UTIL_H diff --git a/trp/trp_peer_encoders.c b/trp/trp_peer_encoders.c index b169e17..a1cc64f 100644 --- a/trp/trp_peer_encoders.c +++ b/trp/trp_peer_encoders.c @@ -38,6 +38,7 @@ #include #include #include +#include char *trp_peer_to_str(TALLOC_CTX *memctx, TRP_PEER *peer, const char *sep) { @@ -76,15 +77,6 @@ static json_t *last_attempt_to_json_string(TRP_PEER *peer) return jstr; } -/* helper for below */ -#define OBJECT_SET_OR_FAIL(jobj, key, val) \ -do { \ - if (val) \ - json_object_set_new((jobj),(key),(val)); \ - else \ - goto cleanup; \ -} while (0) - json_t *trp_peer_to_json(TRP_PEER *peer) { json_t *peer_json = NULL; diff --git a/trp/trp_route_encoders.c b/trp/trp_route_encoders.c index c954a81..7cbb3ac 100644 --- a/trp/trp_route_encoders.c +++ b/trp/trp_route_encoders.c @@ -44,6 +44,7 @@ #include #include #include +#include /* Pretty print a route table entry to a newly allocated string. If sep is NULL, * returns comma+space separated string. */ @@ -103,21 +104,6 @@ static json_t *expiry_to_json_string(TRP_ROUTE *route) return jstr; } -/* helper for below */ -#define OBJECT_SET_OR_FAIL(jobj, key, val) \ -do { \ - if (val) \ - json_object_set_new((jobj),(key),(val)); \ - else \ - goto cleanup; \ -} while (0) - -#define OBJECT_SET_OR_SKIP(jobj, key, val) \ -do { \ - if (val) \ - json_object_set_new((jobj),(key),(val)); \ -} while (0) - json_t *trp_route_to_json(TRP_ROUTE *route) { json_t *route_json = NULL; -- 2.1.4