ded039e3fe5254817ca8062665b7c398b1acb3d8
[asterisk/asterisk.git] / apps / app_userevent.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * See http://www.asterisk.org for more information about
7  * the Asterisk project. Please do not directly contact
8  * any of the maintainers of this project for assistance;
9  * the project provides a web site, mailing lists and IRC
10  * channels for your use.
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License Version 2. See the LICENSE file
14  * at the top of the source tree.
15  */
16
17 /*! \file
18  *
19  * \brief UserEvent application -- send manager event
20  * 
21  * \ingroup applications
22  */
23
24 /*** MODULEINFO
25         <support_level>core</support_level>
26  ***/
27
28 #include "asterisk.h"
29
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
31
32 #include "asterisk/pbx.h"
33 #include "asterisk/module.h"
34 #include "asterisk/manager.h"
35 #include "asterisk/app.h"
36 #include "asterisk/json.h"
37 #include "asterisk/stasis_channels.h"
38
39 /*** DOCUMENTATION
40         <application name="UserEvent" language="en_US">
41                 <synopsis>
42                         Send an arbitrary event to the manager interface.
43                 </synopsis>
44                 <syntax>
45                         <parameter name="eventname" required="true" />
46                         <parameter name="body" />
47                 </syntax>
48                 <description>
49                         <para>Sends an arbitrary event to the manager interface, with an optional
50                         <replaceable>body</replaceable> representing additional arguments. The
51                         <replaceable>body</replaceable> may be specified as
52                         a <literal>,</literal> delimited list of headers. Each additional
53                         argument will be placed on a new line in the event. The format of the
54                         event will be:</para>
55                         <para>    Event: UserEvent</para>
56                         <para>    UserEvent: &lt;specified event name&gt;</para>
57                         <para>    [body]</para>
58                         <para>If no <replaceable>body</replaceable> is specified, only Event and UserEvent headers will be present.</para>
59                 </description>
60         </application>
61  ***/
62
63 static char *app = "UserEvent";
64
65 static int userevent_exec(struct ast_channel *chan, const char *data)
66 {
67         char *parse;
68         int x;
69         AST_DECLARE_APP_ARGS(args,
70                 AST_APP_ARG(eventname);
71                 AST_APP_ARG(extra)[100];
72         );
73         RAII_VAR(struct ast_str *, body, ast_str_create(16), ast_free);
74         RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
75         RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
76
77         if (ast_strlen_zero(data)) {
78                 ast_log(LOG_WARNING, "UserEvent requires an argument (eventname,optional event body)\n");
79                 return -1;
80         }
81
82         if (!body) {
83                 ast_log(LOG_WARNING, "Unable to allocate buffer\n");
84                 return -1;
85         }
86
87         parse = ast_strdupa(data);
88
89         AST_STANDARD_APP_ARGS(args, parse);
90
91         for (x = 0; x < args.argc - 1; x++) {
92                 ast_str_append(&body, 0, "%s\r\n", args.extra[x]);
93         }
94
95         blob = ast_json_pack("{s: s, s: s, s: s}",
96                              "eventname", args.eventname,
97                              "body", ast_str_buffer(body));
98         if (!blob) {
99                 ast_log(LOG_WARNING, "Unable to create message buffer\n");
100                 return -1;
101         }
102
103         msg = ast_channel_blob_create(
104                 chan, ast_channel_user_event_type(), blob);
105         if (!msg) {
106                 return -1;
107         }
108
109         stasis_publish(ast_channel_topic(chan), msg);
110
111         return 0;
112 }
113
114 static int unload_module(void)
115 {
116         return ast_unregister_application(app);
117 }
118
119 static int load_module(void)
120 {
121         return ast_register_application_xml(app, userevent_exec);
122 }
123
124 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Custom User Event Application");