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