From: George Joseph <gjoseph@digium.com>
Date: Tue, 13 Jun 2017 16:33:34 +0000 (-0600)
Subject: res_ari:  Add "module loaded" check to ari stubs
X-Git-Tag: 14.6.0-rc1~28^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=dd1fe3436e3ae6caad8835e873f8841839a2ed32;p=thirdparty%2Fasterisk.git

res_ari:  Add "module loaded" check to ari stubs

The recent change to make the use of LOAD_DECLINE more consistent
caused res_ari to unload itself before declining if the ari.conf
file wasn't found.  The ari stubs though still tried to use the
configuration resulting in segfaults.

This patch creates a new CHECK_ARI_MODULE_LOADED macro which tests
to see if res_ari is actually loaded and causes the stubs to also
decline if it isn't.  The macro was then added to the mustache
template's "load_module" function.

ASTERISK-27026 #close
Reported-by: Ronald Raikes

Change-Id: I263d56efa628ee3c411bdcd16d49af6260c6c91d
---

diff --git a/include/asterisk/ari.h b/include/asterisk/ari.h
index 865b4b00cc..f83d5963f3 100644
--- a/include/asterisk/ari.h
+++ b/include/asterisk/ari.h
@@ -268,4 +268,14 @@ void ast_ari_response_created(struct ast_ari_response *response,
  */
 void ast_ari_response_alloc_failed(struct ast_ari_response *response);
 
+/*! \brief Determines whether the res_ari module is loaded */
+#define CHECK_ARI_MODULE_LOADED()				\
+	do {							\
+		if (!ast_module_check("res_ari.so")		\
+			|| !ast_ari_oom_json()) {	\
+			return AST_MODULE_LOAD_DECLINE;		\
+		}						\
+	} while(0)
+
+
 #endif /* _ASTERISK_ARI_H */
diff --git a/res/res_ari_applications.c b/res/res_ari_applications.c
index 478a2581e0..ca4d71e5b3 100644
--- a/res/res_ari_applications.c
+++ b/res/res_ari_applications.c
@@ -502,6 +502,10 @@ static int unload_module(void)
 static int load_module(void)
 {
 	int res = 0;
+
+	CHECK_ARI_MODULE_LOADED();
+
+
 	stasis_app_ref();
 	res |= ast_ari_add_handler(&applications);
 	if (res) {
diff --git a/res/res_ari_asterisk.c b/res/res_ari_asterisk.c
index f81f647b1f..9064e7bec9 100644
--- a/res/res_ari_asterisk.c
+++ b/res/res_ari_asterisk.c
@@ -1223,6 +1223,10 @@ static int unload_module(void)
 static int load_module(void)
 {
 	int res = 0;
+
+	CHECK_ARI_MODULE_LOADED();
+
+
 	stasis_app_ref();
 	res |= ast_ari_add_handler(&asterisk);
 	if (res) {
diff --git a/res/res_ari_bridges.c b/res/res_ari_bridges.c
index 305e70f0d2..2f524fa57a 100644
--- a/res/res_ari_bridges.c
+++ b/res/res_ari_bridges.c
@@ -1549,6 +1549,10 @@ static int unload_module(void)
 static int load_module(void)
 {
 	int res = 0;
+
+	CHECK_ARI_MODULE_LOADED();
+
+
 	stasis_app_ref();
 	res |= ast_ari_add_handler(&bridges);
 	if (res) {
diff --git a/res/res_ari_channels.c b/res/res_ari_channels.c
index 64acfa951b..e03a49423d 100644
--- a/res/res_ari_channels.c
+++ b/res/res_ari_channels.c
@@ -2853,6 +2853,10 @@ static int unload_module(void)
 static int load_module(void)
 {
 	int res = 0;
+
+	CHECK_ARI_MODULE_LOADED();
+
+
 	stasis_app_ref();
 	res |= ast_ari_add_handler(&channels);
 	if (res) {
diff --git a/res/res_ari_device_states.c b/res/res_ari_device_states.c
index 678e40c714..666327ff9c 100644
--- a/res/res_ari_device_states.c
+++ b/res/res_ari_device_states.c
@@ -333,6 +333,10 @@ static int unload_module(void)
 static int load_module(void)
 {
 	int res = 0;
+
+	CHECK_ARI_MODULE_LOADED();
+
+
 	stasis_app_ref();
 	res |= ast_ari_add_handler(&deviceStates);
 	if (res) {
diff --git a/res/res_ari_endpoints.c b/res/res_ari_endpoints.c
index eee1c84b81..34ecfdb0a1 100644
--- a/res/res_ari_endpoints.c
+++ b/res/res_ari_endpoints.c
@@ -457,6 +457,10 @@ static int unload_module(void)
 static int load_module(void)
 {
 	int res = 0;
+
+	CHECK_ARI_MODULE_LOADED();
+
+
 	stasis_app_ref();
 	res |= ast_ari_add_handler(&endpoints);
 	if (res) {
diff --git a/res/res_ari_events.c b/res/res_ari_events.c
index 42862b6dc0..add25867ed 100644
--- a/res/res_ari_events.c
+++ b/res/res_ari_events.c
@@ -432,28 +432,35 @@ static int unload_module(void)
 static int load_module(void)
 {
 	int res = 0;
-	struct ast_websocket_protocol *protocol;
 
-	if (ast_ari_websocket_events_event_websocket_init() == -1) {
-		return AST_MODULE_LOAD_DECLINE;
-	}
+	CHECK_ARI_MODULE_LOADED();
 
-	events.ws_server = ast_websocket_server_create();
-	if (!events.ws_server) {
-		ast_ari_websocket_events_event_websocket_dtor();
-		return AST_MODULE_LOAD_DECLINE;
-	}
+	/* This is scoped to not conflict with CHECK_ARI_MODULE_LOADED */
+	{
+		struct ast_websocket_protocol *protocol;
 
-	protocol = ast_websocket_sub_protocol_alloc("ari");
-	if (!protocol) {
-		ao2_ref(events.ws_server, -1);
-		events.ws_server = NULL;
-		ast_ari_websocket_events_event_websocket_dtor();
-		return AST_MODULE_LOAD_DECLINE;
+		if (ast_ari_websocket_events_event_websocket_init() == -1) {
+			return AST_MODULE_LOAD_DECLINE;
+		}
+
+		events.ws_server = ast_websocket_server_create();
+		if (!events.ws_server) {
+			ast_ari_websocket_events_event_websocket_dtor();
+			return AST_MODULE_LOAD_DECLINE;
+		}
+
+		protocol = ast_websocket_sub_protocol_alloc("ari");
+		if (!protocol) {
+			ao2_ref(events.ws_server, -1);
+			events.ws_server = NULL;
+			ast_ari_websocket_events_event_websocket_dtor();
+			return AST_MODULE_LOAD_DECLINE;
+		}
+		protocol->session_attempted = ast_ari_events_event_websocket_ws_attempted_cb;
+		protocol->session_established = ast_ari_events_event_websocket_ws_established_cb;
+		res |= ast_websocket_server_add_protocol2(events.ws_server, protocol);
 	}
-	protocol->session_attempted = ast_ari_events_event_websocket_ws_attempted_cb;
-	protocol->session_established = ast_ari_events_event_websocket_ws_established_cb;
-	res |= ast_websocket_server_add_protocol2(events.ws_server, protocol);
+
 	stasis_app_ref();
 	res |= ast_ari_add_handler(&events);
 	if (res) {
diff --git a/res/res_ari_mailboxes.c b/res/res_ari_mailboxes.c
index 2f6e752123..a92dccb39f 100644
--- a/res/res_ari_mailboxes.c
+++ b/res/res_ari_mailboxes.c
@@ -339,6 +339,10 @@ static int unload_module(void)
 static int load_module(void)
 {
 	int res = 0;
+
+	CHECK_ARI_MODULE_LOADED();
+
+
 	stasis_app_ref();
 	res |= ast_ari_add_handler(&mailboxes);
 	if (res) {
diff --git a/res/res_ari_playbacks.c b/res/res_ari_playbacks.c
index 2329bb0c21..e65d55cd7a 100644
--- a/res/res_ari_playbacks.c
+++ b/res/res_ari_playbacks.c
@@ -291,6 +291,10 @@ static int unload_module(void)
 static int load_module(void)
 {
 	int res = 0;
+
+	CHECK_ARI_MODULE_LOADED();
+
+
 	stasis_app_ref();
 	res |= ast_ari_add_handler(&playbacks);
 	if (res) {
diff --git a/res/res_ari_recordings.c b/res/res_ari_recordings.c
index 4d8bc6f9bd..230f836bcd 100644
--- a/res/res_ari_recordings.c
+++ b/res/res_ari_recordings.c
@@ -875,6 +875,10 @@ static int unload_module(void)
 static int load_module(void)
 {
 	int res = 0;
+
+	CHECK_ARI_MODULE_LOADED();
+
+
 	stasis_app_ref();
 	res |= ast_ari_add_handler(&recordings);
 	if (res) {
diff --git a/res/res_ari_sounds.c b/res/res_ari_sounds.c
index c4a5837715..97249738e8 100644
--- a/res/res_ari_sounds.c
+++ b/res/res_ari_sounds.c
@@ -221,6 +221,10 @@ static int unload_module(void)
 static int load_module(void)
 {
 	int res = 0;
+
+	CHECK_ARI_MODULE_LOADED();
+
+
 	stasis_app_ref();
 	res |= ast_ari_add_handler(&sounds);
 	if (res) {
diff --git a/rest-api-templates/res_ari_resource.c.mustache b/rest-api-templates/res_ari_resource.c.mustache
index 883f1fdca6..00c0f79b70 100644
--- a/rest-api-templates/res_ari_resource.c.mustache
+++ b/rest-api-templates/res_ari_resource.c.mustache
@@ -275,36 +275,43 @@ static int unload_module(void)
 static int load_module(void)
 {
 	int res = 0;
+
+	CHECK_ARI_MODULE_LOADED();
+
 {{#apis}}
 {{#operations}}
 {{#has_websocket}}
-	struct ast_websocket_protocol *protocol;
+	/* This is scoped to not conflict with CHECK_ARI_MODULE_LOADED */
+	{
+		struct ast_websocket_protocol *protocol;
 
-	if (ast_ari_websocket_{{c_name}}_{{c_nickname}}_init() == -1) {
-		return AST_MODULE_LOAD_DECLINE;
-	}
+		if (ast_ari_websocket_{{c_name}}_{{c_nickname}}_init() == -1) {
+			return AST_MODULE_LOAD_DECLINE;
+		}
 
-	{{full_name}}.ws_server = ast_websocket_server_create();
-	if (!{{full_name}}.ws_server) {
-		ast_ari_websocket_events_event_websocket_dtor();
-		return AST_MODULE_LOAD_DECLINE;
-	}
+		{{full_name}}.ws_server = ast_websocket_server_create();
+		if (!{{full_name}}.ws_server) {
+			ast_ari_websocket_events_event_websocket_dtor();
+			return AST_MODULE_LOAD_DECLINE;
+		}
 
-	protocol = ast_websocket_sub_protocol_alloc("{{websocket_protocol}}");
-	if (!protocol) {
-		ao2_ref({{full_name}}.ws_server, -1);
-		{{full_name}}.ws_server = NULL;
-		ast_ari_websocket_events_event_websocket_dtor();
-		return AST_MODULE_LOAD_DECLINE;
-	}
-	protocol->session_attempted = ast_ari_{{c_name}}_{{c_nickname}}_ws_attempted_cb;
-	protocol->session_established = ast_ari_{{c_name}}_{{c_nickname}}_ws_established_cb;
+		protocol = ast_websocket_sub_protocol_alloc("{{websocket_protocol}}");
+		if (!protocol) {
+			ao2_ref({{full_name}}.ws_server, -1);
+			{{full_name}}.ws_server = NULL;
+			ast_ari_websocket_events_event_websocket_dtor();
+			return AST_MODULE_LOAD_DECLINE;
+		}
+		protocol->session_attempted = ast_ari_{{c_name}}_{{c_nickname}}_ws_attempted_cb;
+		protocol->session_established = ast_ari_{{c_name}}_{{c_nickname}}_ws_established_cb;
 {{/has_websocket}}
 {{#is_websocket}}
-	res |= ast_websocket_server_add_protocol2({{full_name}}.ws_server, protocol);
+		res |= ast_websocket_server_add_protocol2({{full_name}}.ws_server, protocol);
+	}
 {{/is_websocket}}
 {{/operations}}
 {{/apis}}
+
 	stasis_app_ref();
 	res |= ast_ari_add_handler(&{{root_full_name}});
 	if (res) {