Fix various spelling and grammatical issues in documentation
[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 #include "asterisk.h"
25
26 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
27
28 #include "asterisk/pbx.h"
29 #include "asterisk/module.h"
30 #include "asterisk/manager.h"
31 #include "asterisk/app.h"
32
33 /*** DOCUMENTATION
34         <application name="UserEvent" language="en_US">
35                 <synopsis>
36                         Send an arbitrary event to the manager interface.
37                 </synopsis>
38                 <syntax>
39                         <parameter name="eventname" required="true" />
40                         <parameter name="body" />
41                 </syntax>
42                 <description>
43                         <para>Sends an arbitrary event to the manager interface, with an optional
44                         <replaceable>body</replaceable> representing additional arguments. The
45                         <replaceable>body</replaceable> may be specified as
46                         a <literal>|</literal> delimited list of headers. Each additional
47                         argument will be placed on a new line in the event. The format of the
48                         event will be:</para>
49                         <para>    Event: UserEvent</para>
50                         <para>    UserEvent: &lt;specified event name&gt;</para>
51                         <para>    [body]</para>
52                         <para>If no <replaceable>body</replaceable> is specified, only Event and UserEvent headers will be present.</para>
53                 </description>
54         </application>
55  ***/
56
57 static char *app = "UserEvent";
58
59 static int userevent_exec(struct ast_channel *chan, void *data)
60 {
61         char *parse, buf[2048] = "";
62         int x, buflen = 0;
63         AST_DECLARE_APP_ARGS(args,
64                 AST_APP_ARG(eventname);
65                 AST_APP_ARG(extra)[100];
66         );
67
68         if (ast_strlen_zero(data)) {
69                 ast_log(LOG_WARNING, "UserEvent requires an argument (eventname,optional event body)\n");
70                 return -1;
71         }
72
73         parse = ast_strdupa(data);
74
75         AST_STANDARD_APP_ARGS(args, parse);
76
77         for (x = 0; x < args.argc - 1; x++) {
78                 ast_copy_string(buf + buflen, args.extra[x], sizeof(buf) - buflen - 2);
79                 buflen += strlen(args.extra[x]);
80                 ast_copy_string(buf + buflen, "\r\n", 3);
81                 buflen += 2;
82         }
83
84         manager_event(EVENT_FLAG_USER, "UserEvent", "UserEvent: %s\r\n%s", args.eventname, buf);
85
86         return 0;
87 }
88
89 static int unload_module(void)
90 {
91         return ast_unregister_application(app);
92 }
93
94 static int load_module(void)
95 {
96         return ast_register_application_xml(app, userevent_exec);
97 }
98
99 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Custom User Event Application");