AMI hook interface
[asterisk/asterisk.git] / tests / test_amihooks.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2009, Digium, Inc.
5  *
6  * David Brooks <dbrooks@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Test AMI hook
22  *
23  * \author David Brooks <dbrooks@digium.com> based off of code written by Russell Bryant <russell@digium.com>
24  *
25  * This is simply an example or test module illustrating the ability for a custom module
26  * to hook into AMI. Registration for AMI events and sending of AMI actions is shown.
27  */
28
29 /*** MODULEINFO
30         <defaultenabled>no</defaultenabled>
31  ***/
32
33 #include "asterisk.h"
34
35 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
36
37 #include "asterisk/module.h"
38 #include "asterisk/cli.h"
39 #include "asterisk/utils.h"
40 #include "asterisk/manager.h"
41
42 /* The helper function is required by struct manager_custom_hook. See __manager_event for details */
43 static int amihook_helper(int category, const char *event, char *content)
44 {
45         ast_log(LOG_NOTICE, "AMI Event: \nCategory: %d Event: %s\n%s\n", category, event, content);
46         return 0;
47 }
48
49 static struct manager_custom_hook test_hook = {
50         .file = __FILE__,
51         .helper = &amihook_helper,
52 };
53
54 static int test_send(struct ast_cli_args *a) {
55         int res;
56
57         /* Send a test action (core show version) to the AMI */
58         res = ast_hook_send_action(&test_hook, "Action: Command\nCommand: core show version\nActionID: 987654321\n");
59
60         return res;
61 }
62
63 static char *handle_cli_amihook_test_send(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
64 {
65         switch (cmd) {
66         case CLI_INIT:
67                 e->command = "amihook send test";
68                 e->usage = ""
69                         "Usage: amihook send test"
70                         "";
71                 return NULL;
72         case CLI_GENERATE:
73                 return NULL;
74         case CLI_HANDLER:
75                 test_send(a);
76                 return CLI_SUCCESS;
77         }
78
79         return CLI_FAILURE;
80 }
81
82 static struct ast_cli_entry cli_amihook_evt[] = {
83         AST_CLI_DEFINE(handle_cli_amihook_test_send, "Test module for AMI hook"),
84 };
85
86 static int unload_module(void)
87 {
88         ast_manager_unregister_hook(&test_hook);
89         return ast_cli_unregister_multiple(cli_amihook_evt, ARRAY_LEN(cli_amihook_evt));
90 }
91
92 static int load_module(void)
93 {
94         int res;
95
96         /* Register the hook for AMI events */
97         ast_manager_register_hook(&test_hook);
98
99         res = ast_cli_register_multiple(cli_amihook_evt, ARRAY_LEN(cli_amihook_evt));
100
101         return res ? AST_MODULE_LOAD_DECLINE : AST_MODULE_LOAD_SUCCESS;
102 }
103
104 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "AMI Hook Test Module");