make app_queue 1.2 jump compliant (issue #5580)
[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
25 #include <stdlib.h>
26 #include <stdio.h>
27 #include <string.h>
28 #include <unistd.h>
29
30 #include "asterisk.h"
31
32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
33
34 #include "asterisk/lock.h"
35 #include "asterisk/file.h"
36 #include "asterisk/logger.h"
37 #include "asterisk/channel.h"
38 #include "asterisk/pbx.h"
39 #include "asterisk/module.h"
40 #include "asterisk/manager.h"
41
42 static char *tdesc = "Custom User Event Application";
43
44 static char *app = "UserEvent";
45
46 static char *synopsis = "Send an arbitrary event to the manager interface";
47
48 static char *descrip = 
49 "  UserEvent(eventname[|body]): Sends an arbitrary event to the\n"
50 "manager interface, with an optional body representing additional\n"
51 "arguments.  The format of the event will be:\n"
52 "    Event: UserEvent<specified event name>\n"
53 "    Channel: <channel name>\n"
54 "    Uniqueid: <call uniqueid>\n"
55 "    [body]\n"
56 "If the body is not specified, only Event, Channel, and Uniqueid fields\n"
57 "will be present.  Returns 0.";
58
59 STANDARD_LOCAL_USER;
60
61 LOCAL_USER_DECL;
62
63 static int userevent_exec(struct ast_channel *chan, void *data)
64 {
65         struct localuser *u;
66         char *info;
67         char eventname[512];
68         char *eventbody;
69
70         if (ast_strlen_zero(data)) {
71                 ast_log(LOG_WARNING, "UserEvent requires an argument (eventname|optional event body)\n");
72                 return -1;
73         }
74
75         LOCAL_USER_ADD(u);
76
77         info = ast_strdupa(data);
78         if (!info) {
79                 ast_log(LOG_ERROR, "Out of memory\n");
80                 LOCAL_USER_REMOVE(u);
81                 return -1;
82         }
83
84         snprintf(eventname, sizeof(eventname), "UserEvent%s", info);
85         eventbody = strchr(eventname, '|');
86         if (eventbody) {
87                 *eventbody = '\0';
88                 eventbody++;
89         }
90         
91         if(eventbody) {
92             ast_log(LOG_DEBUG, "Sending user event: %s, %s\n", eventname, eventbody);
93             manager_event(EVENT_FLAG_USER, eventname, 
94                         "Channel: %s\r\nUniqueid: %s\r\n%s\r\n",
95                         chan->name, chan->uniqueid, eventbody);
96         } else {
97             ast_log(LOG_DEBUG, "Sending user event: %s\n", eventname);
98             manager_event(EVENT_FLAG_USER, eventname, 
99                         "Channel: %s\r\nUniqueid: %s\r\n", chan->name, chan->uniqueid);
100         }
101
102         LOCAL_USER_REMOVE(u);
103         return 0;
104 }
105
106 int unload_module(void)
107 {
108         int res;
109
110         res = ast_unregister_application(app);
111
112         STANDARD_HANGUP_LOCALUSERS;
113
114         return res;     
115 }
116
117 int load_module(void)
118 {
119         return ast_register_application(app, userevent_exec, synopsis, descrip);
120 }
121
122 char *description(void)
123 {
124         return tdesc;
125 }
126
127 int usecount(void)
128 {
129         int res;
130         STANDARD_USECOUNT(res);
131         return res;
132 }
133
134 char *key()
135 {
136         return ASTERISK_GPL_KEY;
137 }