Merge "res_pjsip/res_pjsip_callerid: NULL check on caller id name string"
[asterisk/asterisk.git] / res / res_manager_presencestate.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2014, Digium, Inc.
5  *
6  * Mark Michelson <mmichelson@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*** MODULEINFO
20         <support_level>core</support_level>
21  ***/
22
23 /*** DOCUMENTATION
24         <manager name="PresenceStateList" language="en_US">
25                 <synopsis>
26                         List the current known presence states.
27                 </synopsis>
28                 <syntax>
29                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
30                 </syntax>
31                 <description>
32                         <para>This will list out all known presence states in a
33                         sequence of <replaceable>PresenceStateChange</replaceable> events.
34                         When finished, a <replaceable>PresenceStateListComplete</replaceable> event
35                         will be emitted.</para>
36                 </description>
37                 <see-also>
38                         <ref type="manager">PresenceState</ref>
39                         <ref type="managerEvent">PresenceStatus</ref>
40                         <ref type="function">PRESENCE_STATE</ref>
41                 </see-also>
42                 <responses>
43                         <list-elements>
44                                 <xi:include xpointer="xpointer(/docs/managerEvent[@name='PresenceStateChange'])" />
45                         </list-elements>
46                         <managerEvent name="PresenceStateListComplete" language="en_US">
47                                 <managerEventInstance class="EVENT_FLAG_COMMAND">
48                                         <synopsis>
49                                                 Indicates the end of the list the current known extension states.
50                                         </synopsis>
51                                         <syntax>
52                                                 <parameter name="EventList">
53                                                         <para>Conveys the status of the event list.</para>
54                                                 </parameter>
55                                                 <parameter name="ListItems">
56                                                         <para>Conveys the number of statuses reported.</para>
57                                                 </parameter>
58                                         </syntax>
59                                 </managerEventInstance>
60                         </managerEvent>
61                 </responses>
62         </manager>
63  ***/
64
65 #include "asterisk.h"
66 #include "asterisk/module.h"
67 #include "asterisk/manager.h"
68 #include "asterisk/stasis.h"
69 #include "asterisk/presencestate.h"
70
71 static struct stasis_forward *topic_forwarder;
72
73 static int action_presencestatelist(struct mansession *s, const struct message *m)
74 {
75         RAII_VAR(struct ao2_container *, presence_states, NULL, ao2_cleanup);
76         const char *action_id = astman_get_header(m, "ActionID");
77         struct stasis_message *msg;
78         struct ao2_iterator it_states;
79         int count = 0;
80
81         presence_states = stasis_cache_dump(ast_presence_state_cache(),
82                 ast_presence_state_message_type());
83         if (!presence_states) {
84                 astman_send_error(s, m, "Memory Allocation Failure");
85                 return 0;
86         }
87
88         astman_send_listack(s, m, "Presence State Changes will follow", "start");
89
90         it_states = ao2_iterator_init(presence_states, 0);
91         for (; (msg = ao2_iterator_next(&it_states)); ao2_ref(msg, -1)) {
92                 struct ast_manager_event_blob *blob = stasis_message_to_ami(msg);
93
94                 if (!blob) {
95                         continue;
96                 }
97
98                 count++;
99
100                 astman_append(s, "Event: %s\r\n", blob->manager_event);
101                 if (!ast_strlen_zero(action_id)) {
102                         astman_append(s, "ActionID: %s\r\n", action_id);
103                 }
104                 astman_append(s, "%s\r\n", blob->extra_fields);
105                 ao2_ref(blob, -1);
106         }
107         ao2_iterator_destroy(&it_states);
108
109         astman_send_list_complete_start(s, m, "PresenceStateListComplete", count);
110         astman_send_list_complete_end(s);
111
112         return 0;
113 }
114
115 static int unload_module(void)
116 {
117         ast_manager_unregister("PresenceStateList");
118         topic_forwarder = stasis_forward_cancel(topic_forwarder);
119         return 0;
120 }
121
122 static int load_module(void)
123 {
124         struct stasis_topic *manager_topic;
125
126         manager_topic = ast_manager_get_topic();
127         if (!manager_topic) {
128                 return AST_MODULE_LOAD_DECLINE;
129         }
130         topic_forwarder = stasis_forward_all(ast_presence_state_topic_all(), manager_topic);
131         if (!topic_forwarder) {
132                 return AST_MODULE_LOAD_DECLINE;
133         }
134
135         if (ast_manager_register_xml("PresenceStateList", EVENT_FLAG_CALL | EVENT_FLAG_REPORTING,
136                                          action_presencestatelist)) {
137                 topic_forwarder = stasis_forward_cancel(topic_forwarder);
138                 return AST_MODULE_LOAD_DECLINE;
139         }
140
141         return AST_MODULE_LOAD_SUCCESS;
142 }
143
144 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "Manager Presence State Topic Forwarder",
145         .support_level = AST_MODULE_SUPPORT_CORE,
146         .load = load_module,
147         .unload = unload_module,
148         .load_pri = AST_MODPRI_DEVSTATE_CONSUMER,
149 );