app_queue: Fix hint updates for included contexts

Previously, if custom hints were used with the hint:
format in app_queue, when device state changes occured,
app_queue would only do a literal string comparison of
the context used for the hint in app_queue and the context
of the hint which just changed state. This caused hints
to not update and become stale if the context associated
with the agent included the context which actually changes
state, essentially completely breaking device state for
any such agents defined in this manner.

This fix adds an additional check to ensure that included
contexts are also compared against the context which changed
state, so that the behavior is correct no matter whether the
context is specified to app_queue directly or indirectly.

ASTERISK-29578 #close

Change-Id: I8caf2f8da8157ef3d9ea71a8568c1eec95592b78

diff --git a/apps/app_queue.c b/apps/app_queue.c
index 4d908a5d58da757a82ac8ba0e1a3a0af58954645..a4f6dcef173275b01c13473440ede043a45700bc 100644 (file)
--- a/apps/app_queue.c
+++ b/apps/app_queue.c
@@ -2633,6 +2633,46 @@ static int extensionstate2devicestate(int state)
        return state;
 }
 
+/*!
+ * \brief Returns if one context includes another context
+ *
+ * \param parent Parent context to search for child
+ * \param child Context to check for inclusion in parent
+ *
+ * This function recrusively checks if the context child is included in the context parent.
+ *
+ * \return 1 if child is included in parent, 0 if not
+ */
+static int context_included(const char *parent, const char *child);
+static int context_included(const char *parent, const char *child)
+{
+       struct ast_context *c = NULL;
+
+       c = ast_context_find(parent);
+       if (!c) {
+               /* well, if parent doesn't exist, how can the child be included in it? */
+               return 0;
+       }
+       if (!strcmp(ast_get_context_name(c), parent)) {
+               /* found the context of the hint app_queue is using. Now, see
+                       if that context includes the one that just changed state */
+               struct ast_include *inc = NULL;
+
+               while ((inc = (struct ast_include*) ast_walk_context_includes(c, inc))) {
+                       const char *includename = ast_get_include_name(inc);
+                       if (!strcasecmp(child, includename)) {
+                               return 1;
+                       }
+                       /* recurse on this context, for nested includes. The
+                               PBX extension parser will prevent infinite recursion. */
+                       if (context_included(includename, child)) {
+                               return 1;
+                       }
+               }
+       }
+       return 0;
+}
+
 static int extension_state_cb(const char *context, const char *exten, struct ast_state_cb_info *info, void *data)
 {
        struct ao2_iterator miter, qiter;
@@ -2653,9 +2693,14 @@ static int extension_state_cb(const char *context, const char *exten, struct ast
                miter = ao2_iterator_init(q->members, 0);
                for (; (m = ao2_iterator_next(&miter)); ao2_ref(m, -1)) {
                        if (!strcmp(m->state_context, context) && !strcmp(m->state_exten, exten)) {
+                               found = 1;
+                       } else if (!strcmp(m->state_exten, exten) && context_included(m->state_context, context)) {
+                               /* context could be included in m->state_context. We need to check. */
+                               found = 1;
+                       }
+                       if (found) {
                                update_status(q, m, device_state);
                                ao2_ref(m, -1);
-                               found = 1;
                                break;
                        }
                }
@@ -2666,7 +2711,7 @@ static int extension_state_cb(const char *context, const char *exten, struct ast
        }
        ao2_iterator_destroy(&qiter);
 
-        if (found) {
+       if (found) {
                ast_debug(1, "Extension '%s@%s' changed to state '%d' (%s)\n", exten, context, device_state, ast_devstate2str(device_state));
        } else {
                ast_debug(3, "Extension '%s@%s' changed to state '%d' (%s) but we don't care because they're not a member of any queue.\n",