From 6763d94962b0377be72be2e945d15fbc6ef58c1b Mon Sep 17 00:00:00 2001
From: "Roger A. Light" <roger@atchoo.org>
Date: Thu, 30 Sep 2021 10:56:48 +0100
Subject: [PATCH] Add plugin version helper.

---
 include/mosquitto_plugin.h                      | 17 +++++++++++++++++
 plugins/dynamic-security/plugin.c               | 14 ++------------
 .../add-properties/mosquitto_add_properties.c   | 14 ++------------
 .../examples/auth-by-ip/mosquitto_auth_by_ip.c  | 14 ++------------
 .../mosquitto_client_properties.c               | 14 ++------------
 .../mosquitto_connection_state.c                | 14 ++------------
 .../delayed-auth/mosquitto_delayed_auth.c       | 14 ++------------
 .../force-retain/mosquitto_force_retain.c       | 14 ++------------
 .../mosquitto_message_timestamp.c               | 14 ++------------
 .../mosquitto_payload_modification.c            | 14 ++------------
 .../mosquitto_print_ip_on_publish.c             | 14 ++------------
 .../mosquitto_topic_modification.c              | 14 ++------------
 12 files changed, 39 insertions(+), 132 deletions(-)

diff --git a/include/mosquitto_plugin.h b/include/mosquitto_plugin.h
index d8a6c72c..447f4b89 100644
--- a/include/mosquitto_plugin.h
+++ b/include/mosquitto_plugin.h
@@ -140,9 +140,26 @@ struct mosquitto_acl_msg {
  *
  * If the broker does not support the version that you require, return -1 to
  * indicate failure.
+ *
+ * HELPER: If you only wish to declare support for a single version, you can
+ * use the helper macro:
+ *
+ * MOSQUITTO_PLUGIN_DECLARE_VERSION(5);
  */
 mosq_plugin_EXPORT int mosquitto_plugin_version(int supported_version_count, const int *supported_versions);
 
+#define MOSQUITTO_PLUGIN_DECLARE_VERSION(A) \
+	int mosquitto_plugin_version(int supported_version_count, const int *supported_versions) \
+	{ \
+		int i; \
+		for(i=0; i<supported_version_count; i++){ \
+			if(supported_versions[i] == (A)){ \
+				return (A); \
+			} \
+		} \
+		return -1; \
+	}
+
 /*
  * Function: mosquitto_plugin_init
  *
diff --git a/plugins/dynamic-security/plugin.c b/plugins/dynamic-security/plugin.c
index 664e1941..aa1064a2 100644
--- a/plugins/dynamic-security/plugin.c
+++ b/plugins/dynamic-security/plugin.c
@@ -33,6 +33,8 @@ Contributors:
 
 #include "dynamic_security.h"
 
+MOSQUITTO_PLUGIN_DECLARE_VERSION(5);
+
 static mosquitto_plugin_id_t *plg_id = NULL;
 static char *config_file = NULL;
 struct dynsec__acl_default_access default_access = {false, false, false, false};
@@ -274,18 +276,6 @@ internal_error:
 }
 
 
-int mosquitto_plugin_version(int supported_version_count, const int *supported_versions)
-{
-	int i;
-
-	for(i=0; i<supported_version_count; i++){
-		if(supported_versions[i] == 5){
-			return 5;
-		}
-	}
-	return -1;
-}
-
 static int dynsec__general_config_load(cJSON *tree)
 {
 	cJSON *j_default_access, *jtmp;
diff --git a/plugins/examples/add-properties/mosquitto_add_properties.c b/plugins/examples/add-properties/mosquitto_add_properties.c
index 8747f13f..bfdd072f 100644
--- a/plugins/examples/add-properties/mosquitto_add_properties.c
+++ b/plugins/examples/add-properties/mosquitto_add_properties.c
@@ -46,6 +46,8 @@ Contributors:
 #define PLUGIN_NAME "add-properties"
 #define PLUGIN_VERSION "1.0"
 
+MOSQUITTO_PLUGIN_DECLARE_VERSION(5);
+
 static mosquitto_plugin_id_t *mosq_pid = NULL;
 
 static int callback_message(int event, void *event_data, void *userdata)
@@ -89,18 +91,6 @@ static int callback_message(int event, void *event_data, void *userdata)
 	return MOSQ_ERR_SUCCESS;
 }
 
-int mosquitto_plugin_version(int supported_version_count, const int *supported_versions)
-{
-	int i;
-
-	for(i=0; i<supported_version_count; i++){
-		if(supported_versions[i] == 5){
-			return 5;
-		}
-	}
-	return -1;
-}
-
 int mosquitto_plugin_init(mosquitto_plugin_id_t *identifier, void **user_data, struct mosquitto_opt *opts, int opt_count)
 {
 	UNUSED(user_data);
diff --git a/plugins/examples/auth-by-ip/mosquitto_auth_by_ip.c b/plugins/examples/auth-by-ip/mosquitto_auth_by_ip.c
index 955c88db..06f7901a 100644
--- a/plugins/examples/auth-by-ip/mosquitto_auth_by_ip.c
+++ b/plugins/examples/auth-by-ip/mosquitto_auth_by_ip.c
@@ -45,6 +45,8 @@ Contributors:
 #define PLUGIN_NAME "auth-by-ip"
 #define PLUGIN_VERSION "1.0"
 
+MOSQUITTO_PLUGIN_DECLARE_VERSION(5);
+
 static mosquitto_plugin_id_t *mosq_pid = NULL;
 
 static int basic_auth_callback(int event, void *event_data, void *userdata)
@@ -64,18 +66,6 @@ static int basic_auth_callback(int event, void *event_data, void *userdata)
 	}
 }
 
-int mosquitto_plugin_version(int supported_version_count, const int *supported_versions)
-{
-	int i;
-
-	for(i=0; i<supported_version_count; i++){
-		if(supported_versions[i] == 5){
-			return 5;
-		}
-	}
-	return -1;
-}
-
 int mosquitto_plugin_init(mosquitto_plugin_id_t *identifier, void **user_data, struct mosquitto_opt *opts, int opt_count)
 {
 	UNUSED(user_data);
diff --git a/plugins/examples/client-properties/mosquitto_client_properties.c b/plugins/examples/client-properties/mosquitto_client_properties.c
index b2ccafd9..22d46935 100644
--- a/plugins/examples/client-properties/mosquitto_client_properties.c
+++ b/plugins/examples/client-properties/mosquitto_client_properties.c
@@ -24,6 +24,8 @@
 
 #define UNUSED(A) (void)(A)
 
+MOSQUITTO_PLUGIN_DECLARE_VERSION(5);
+
 static mosquitto_plugin_id_t *mosq_pid = NULL;
 
 static int callback_message(int event, void *event_data, void *userdata)
@@ -41,18 +43,6 @@ static int callback_message(int event, void *event_data, void *userdata)
 	return MOSQ_ERR_SUCCESS;
 }
 
-int mosquitto_plugin_version(int supported_version_count, const int *supported_versions)
-{
-	int i;
-
-	for(i=0; i<supported_version_count; i++){
-		if(supported_versions[i] == 5){
-			return 5;
-		}
-	}
-	return -1;
-}
-
 int mosquitto_plugin_init(mosquitto_plugin_id_t *identifier, void **user_data, struct mosquitto_opt *opts, int opt_count)
 {
 	UNUSED(user_data);
diff --git a/plugins/examples/connection-state/mosquitto_connection_state.c b/plugins/examples/connection-state/mosquitto_connection_state.c
index de8b9ea9..80af0899 100644
--- a/plugins/examples/connection-state/mosquitto_connection_state.c
+++ b/plugins/examples/connection-state/mosquitto_connection_state.c
@@ -45,6 +45,8 @@ Contributors:
 
 #define UNUSED(A) (void)(A)
 
+MOSQUITTO_PLUGIN_DECLARE_VERSION(5);
+
 static mosquitto_plugin_id_t *mosq_pid = NULL;
 
 static int connect_callback(int event, void *event_data, void *userdata)
@@ -97,18 +99,6 @@ static int disconnect_callback(int event, void *event_data, void *userdata)
 }
 
 
-int mosquitto_plugin_version(int supported_version_count, const int *supported_versions)
-{
-	int i;
-
-	for(i=0; i<supported_version_count; i++){
-		if(supported_versions[i] == 5){
-			return 5;
-		}
-	}
-	return -1;
-}
-
 int mosquitto_plugin_init(mosquitto_plugin_id_t *identifier, void **user_data, struct mosquitto_opt *opts, int opt_count)
 {
 	int rc;
diff --git a/plugins/examples/delayed-auth/mosquitto_delayed_auth.c b/plugins/examples/delayed-auth/mosquitto_delayed_auth.c
index 7725e685..6ccf7b4d 100644
--- a/plugins/examples/delayed-auth/mosquitto_delayed_auth.c
+++ b/plugins/examples/delayed-auth/mosquitto_delayed_auth.c
@@ -51,6 +51,8 @@ Contributors:
 #  define UNUSED(A) (void)(A)
 #endif
 
+MOSQUITTO_PLUGIN_DECLARE_VERSION(5);
+
 struct client_list{
 	UT_hash_handle hh;
 	char *id;
@@ -141,18 +143,6 @@ static int tick_callback(int event, void *event_data, void *userdata)
 }
 
 
-int mosquitto_plugin_version(int supported_version_count, const int *supported_versions)
-{
-	int i;
-
-	for(i=0; i<supported_version_count; i++){
-		if(supported_versions[i] == 5){
-			return 5;
-		}
-	}
-	return -1;
-}
-
 int mosquitto_plugin_init(mosquitto_plugin_id_t *identifier, void **user_data, struct mosquitto_opt *opts, int opt_count)
 {
 	int rc;
diff --git a/plugins/examples/force-retain/mosquitto_force_retain.c b/plugins/examples/force-retain/mosquitto_force_retain.c
index 176f1355..1dc2fdee 100644
--- a/plugins/examples/force-retain/mosquitto_force_retain.c
+++ b/plugins/examples/force-retain/mosquitto_force_retain.c
@@ -42,6 +42,8 @@ Contributors:
 
 #define UNUSED(A) (void)(A)
 
+MOSQUITTO_PLUGIN_DECLARE_VERSION(5);
+
 static mosquitto_plugin_id_t *mosq_pid = NULL;
 
 static int callback_message(int event, void *event_data, void *userdata)
@@ -56,18 +58,6 @@ static int callback_message(int event, void *event_data, void *userdata)
 	return MOSQ_ERR_SUCCESS;
 }
 
-int mosquitto_plugin_version(int supported_version_count, const int *supported_versions)
-{
-	int i;
-
-	for(i=0; i<supported_version_count; i++){
-		if(supported_versions[i] == 5){
-			return 5;
-		}
-	}
-	return -1;
-}
-
 int mosquitto_plugin_init(mosquitto_plugin_id_t *identifier, void **user_data, struct mosquitto_opt *opts, int opt_count)
 {
 	UNUSED(user_data);
diff --git a/plugins/examples/message-timestamp/mosquitto_message_timestamp.c b/plugins/examples/message-timestamp/mosquitto_message_timestamp.c
index 2a446267..d9e78cf8 100644
--- a/plugins/examples/message-timestamp/mosquitto_message_timestamp.c
+++ b/plugins/examples/message-timestamp/mosquitto_message_timestamp.c
@@ -41,6 +41,8 @@ Contributors:
 #define PLUGIN_NAME "message-timestamp"
 #define PLUGIN_VERSION "1.0"
 
+MOSQUITTO_PLUGIN_DECLARE_VERSION(5);
+
 static mosquitto_plugin_id_t *mosq_pid = NULL;
 
 static int callback_message(int event, void *event_data, void *userdata)
@@ -60,18 +62,6 @@ static int callback_message(int event, void *event_data, void *userdata)
 	return mosquitto_property_add_string_pair(&ed->properties, MQTT_PROP_USER_PROPERTY, "timestamp", time_buf);
 }
 
-int mosquitto_plugin_version(int supported_version_count, const int *supported_versions)
-{
-	int i;
-
-	for(i=0; i<supported_version_count; i++){
-		if(supported_versions[i] == 5){
-			return 5;
-		}
-	}
-	return -1;
-}
-
 int mosquitto_plugin_init(mosquitto_plugin_id_t *identifier, void **user_data, struct mosquitto_opt *opts, int opt_count)
 {
 	UNUSED(user_data);
diff --git a/plugins/examples/payload-modification/mosquitto_payload_modification.c b/plugins/examples/payload-modification/mosquitto_payload_modification.c
index 9bc37229..16bad2e7 100644
--- a/plugins/examples/payload-modification/mosquitto_payload_modification.c
+++ b/plugins/examples/payload-modification/mosquitto_payload_modification.c
@@ -45,6 +45,8 @@ Contributors:
 
 #define UNUSED(A) (void)(A)
 
+MOSQUITTO_PLUGIN_DECLARE_VERSION(5);
+
 static mosquitto_plugin_id_t *mosq_pid = NULL;
 
 static int callback_message(int event, void *event_data, void *userdata)
@@ -83,18 +85,6 @@ static int callback_message(int event, void *event_data, void *userdata)
 	return MOSQ_ERR_SUCCESS;
 }
 
-int mosquitto_plugin_version(int supported_version_count, const int *supported_versions)
-{
-	int i;
-
-	for(i=0; i<supported_version_count; i++){
-		if(supported_versions[i] == 5){
-			return 5;
-		}
-	}
-	return -1;
-}
-
 int mosquitto_plugin_init(mosquitto_plugin_id_t *identifier, void **user_data, struct mosquitto_opt *opts, int opt_count)
 {
 	UNUSED(user_data);
diff --git a/plugins/examples/print-ip-on-publish/mosquitto_print_ip_on_publish.c b/plugins/examples/print-ip-on-publish/mosquitto_print_ip_on_publish.c
index f62dca35..bb485f4a 100644
--- a/plugins/examples/print-ip-on-publish/mosquitto_print_ip_on_publish.c
+++ b/plugins/examples/print-ip-on-publish/mosquitto_print_ip_on_publish.c
@@ -13,6 +13,8 @@
 #define PLUGIN_NAME "print-ip-on-publish"
 #define PLUGIN_VERSION "1.0"
 
+MOSQUITTO_PLUGIN_DECLARE_VERSION(5);
+
 static mosquitto_plugin_id_t *mosq_pid = NULL;
 
 static char my_topic[] = "troublesome/topic";
@@ -30,18 +32,6 @@ static int message_callback(int event, void *event_data, void *userdata)
 	return MOSQ_ERR_SUCCESS;
 }
 
-int mosquitto_plugin_version(int supported_version_count, const int *supported_versions)
-{
-	int i;
-
-	for(i=0; i<supported_version_count; i++){
-		if(supported_versions[i] == 5){
-			return 5;
-		}
-	}
-	return -1;
-}
-
 int mosquitto_plugin_init(mosquitto_plugin_id_t *identifier, void **user_data, struct mosquitto_opt *opts, int opt_count)
 {
 	UNUSED(user_data);
diff --git a/plugins/examples/topic-modification/mosquitto_topic_modification.c b/plugins/examples/topic-modification/mosquitto_topic_modification.c
index fe5be704..45cd18d6 100644
--- a/plugins/examples/topic-modification/mosquitto_topic_modification.c
+++ b/plugins/examples/topic-modification/mosquitto_topic_modification.c
@@ -45,6 +45,8 @@ Contributors:
 
 #define UNUSED(A) (void)(A)
 
+MOSQUITTO_PLUGIN_DECLARE_VERSION(5);
+
 static mosquitto_plugin_id_t *mosq_pid = NULL;
 
 static int callback_message(int event, void *event_data, void *userdata)
@@ -67,18 +69,6 @@ static int callback_message(int event, void *event_data, void *userdata)
 	return MOSQ_ERR_SUCCESS;
 }
 
-int mosquitto_plugin_version(int supported_version_count, const int *supported_versions)
-{
-	int i;
-
-	for(i=0; i<supported_version_count; i++){
-		if(supported_versions[i] == 5){
-			return 5;
-		}
-	}
-	return -1;
-}
-
 int mosquitto_plugin_init(mosquitto_plugin_id_t *identifier, void **user_data, struct mosquitto_opt *opts, int opt_count)
 {
 	UNUSED(user_data);