This patch adds the core changes necessary to support AMI event documentation in the source files of Asterisk, and adds documentation to those AMI events defined in the core application modules. Event documentation is built from the source by two new python scripts, located in build_tools: get_documentation.py and post_process_documentation.py. The get_documentation.py script mirrors the actions of the existing AWK get_documentation scripts, except that it will scan the entirety of a source file for Asterisk documentation. Upon encountering it, if the documentation happens to be an AMI event, it will attempt to extract information about the event directly from the manager event macro calls that raise the event. The post_process_documentation.py script combines manager event instances that are the same event but documented in multiple source files. It generates the final core-[lang].xml file. As this process can take longer to complete than a typical 'make all', it is only performed if a new make target, 'full', is chosen. Review: https://reviewboard.asterisk.org/r/1967/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@369346 65c4cc65-6c06-0410-ace0-fbb531ad65f3
125 lines
3.2 KiB
C
125 lines
3.2 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 1999 - 2005, Digium, Inc.
|
|
*
|
|
* See http://www.asterisk.org for more information about
|
|
* the Asterisk project. Please do not directly contact
|
|
* any of the maintainers of this project for assistance;
|
|
* the project provides a web site, mailing lists and IRC
|
|
* channels for your use.
|
|
*
|
|
* This program is free software, distributed under the terms of
|
|
* the GNU General Public License Version 2. See the LICENSE file
|
|
* at the top of the source tree.
|
|
*/
|
|
|
|
/*! \file
|
|
*
|
|
* \brief UserEvent application -- send manager event
|
|
*
|
|
* \ingroup applications
|
|
*/
|
|
|
|
/*** MODULEINFO
|
|
<support_level>core</support_level>
|
|
***/
|
|
|
|
#include "asterisk.h"
|
|
|
|
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
|
|
|
|
#include "asterisk/pbx.h"
|
|
#include "asterisk/module.h"
|
|
#include "asterisk/manager.h"
|
|
#include "asterisk/app.h"
|
|
|
|
/*** DOCUMENTATION
|
|
<application name="UserEvent" language="en_US">
|
|
<synopsis>
|
|
Send an arbitrary event to the manager interface.
|
|
</synopsis>
|
|
<syntax>
|
|
<parameter name="eventname" required="true" />
|
|
<parameter name="body" />
|
|
</syntax>
|
|
<description>
|
|
<para>Sends an arbitrary event to the manager interface, with an optional
|
|
<replaceable>body</replaceable> representing additional arguments. The
|
|
<replaceable>body</replaceable> may be specified as
|
|
a <literal>,</literal> delimited list of headers. Each additional
|
|
argument will be placed on a new line in the event. The format of the
|
|
event will be:</para>
|
|
<para> Event: UserEvent</para>
|
|
<para> UserEvent: <specified event name></para>
|
|
<para> [body]</para>
|
|
<para>If no <replaceable>body</replaceable> is specified, only Event and UserEvent headers will be present.</para>
|
|
</description>
|
|
</application>
|
|
***/
|
|
|
|
static char *app = "UserEvent";
|
|
|
|
static int userevent_exec(struct ast_channel *chan, const char *data)
|
|
{
|
|
char *parse;
|
|
int x;
|
|
AST_DECLARE_APP_ARGS(args,
|
|
AST_APP_ARG(eventname);
|
|
AST_APP_ARG(extra)[100];
|
|
);
|
|
struct ast_str *body = ast_str_create(16);
|
|
|
|
if (ast_strlen_zero(data)) {
|
|
ast_log(LOG_WARNING, "UserEvent requires an argument (eventname,optional event body)\n");
|
|
ast_free(body);
|
|
return -1;
|
|
}
|
|
|
|
if (!body) {
|
|
ast_log(LOG_WARNING, "Unable to allocate buffer\n");
|
|
return -1;
|
|
}
|
|
|
|
parse = ast_strdupa(data);
|
|
|
|
AST_STANDARD_APP_ARGS(args, parse);
|
|
|
|
for (x = 0; x < args.argc - 1; x++) {
|
|
ast_str_append(&body, 0, "%s\r\n", args.extra[x]);
|
|
}
|
|
|
|
/*** DOCUMENTATION
|
|
<managerEventInstance>
|
|
<synopsis>A user defined event raised from the dialplan.</synopsis>
|
|
<parameter name="UserEvent">
|
|
<para>The event name, as specified in the dialplan.</para>
|
|
</parameter>
|
|
<see-also>
|
|
<ref type="application">UserEvent</ref>
|
|
</see-also>
|
|
</managerEventInstance>
|
|
***/
|
|
manager_event(EVENT_FLAG_USER, "UserEvent",
|
|
"UserEvent: %s\r\n"
|
|
"Uniqueid: %s\r\n"
|
|
"%s",
|
|
args.eventname, ast_channel_uniqueid(chan), ast_str_buffer(body));
|
|
|
|
ast_free(body);
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int unload_module(void)
|
|
{
|
|
return ast_unregister_application(app);
|
|
}
|
|
|
|
static int load_module(void)
|
|
{
|
|
return ast_register_application_xml(app, userevent_exec);
|
|
}
|
|
|
|
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Custom User Event Application");
|