Merged revisions 332177 via svnmerge from
[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         <support_level>core</support_level>
32  ***/
33
34 #include "asterisk.h"
35
36 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
37
38 #include "asterisk/module.h"
39 #include "asterisk/cli.h"
40 #include "asterisk/utils.h"
41 #include "asterisk/manager.h"
42
43 /* The helper function is required by struct manager_custom_hook. See __manager_event for details */
44 static int amihook_helper(int category, const char *event, char *content)
45 {
46         ast_log(LOG_NOTICE, "AMI Event: \nCategory: %d Event: %s\n%s\n", category, event, content);
47         return 0;
48 }
49
50 static struct manager_custom_hook test_hook = {
51         .file = __FILE__,
52         .helper = &amihook_helper,
53 };
54
55 static int hook_send(void) {
56         int res;
57
58         /* Send a test action (core show version) to the AMI */
59         res = ast_hook_send_action(&test_hook, "Action: Command\nCommand: core show version\nActionID: 987654321\n");
60
61         return res;
62 }
63
64 static void register_hook(void) {
65
66         /* Unregister the hook, we don't want a double-registration (Bad Things(tm) happen) */
67         ast_manager_unregister_hook(&test_hook);
68
69         /* Register the hook for AMI events */
70         ast_manager_register_hook(&test_hook);
71
72 }
73
74 static void unregister_hook(void) {
75
76         /* Unregister the hook */
77         ast_manager_unregister_hook(&test_hook);
78
79 }
80
81 static char *handle_cli_amihook_send(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
82 {
83         switch (cmd) {
84         case CLI_INIT:
85                 e->command = "amihook send";
86                 e->usage = ""
87                         "Usage: amihook send"
88                         "";
89                 return NULL;
90         case CLI_GENERATE:
91                 return NULL;
92         case CLI_HANDLER:
93                 hook_send();
94                 return CLI_SUCCESS;
95         }
96
97         return CLI_FAILURE;
98 }
99
100 static char *handle_cli_amihook_register_hook(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
101 {
102         switch (cmd) {
103         case CLI_INIT:
104                 e->command = "amihook register";
105                 e->usage = ""
106                         "Usage: amihook register"
107                         "";
108                 return NULL;
109         case CLI_GENERATE:
110                 return NULL;
111         case CLI_HANDLER:
112                 register_hook();
113                 return CLI_SUCCESS;
114         }
115
116         return CLI_FAILURE;
117 }
118
119 static char *handle_cli_amihook_unregister_hook(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
120 {
121         switch (cmd) {
122         case CLI_INIT:
123                 e->command = "amihook unregister";
124                 e->usage = ""
125                         "Usage: amihook unregister"
126                         "";
127                 return NULL;
128         case CLI_GENERATE:
129                 return NULL;
130         case CLI_HANDLER:
131                 unregister_hook();
132                 return CLI_SUCCESS;
133         }
134
135         return CLI_FAILURE;
136 }
137
138 static struct ast_cli_entry cli_amihook_evt[] = {
139         AST_CLI_DEFINE(handle_cli_amihook_send, "Send an AMI event"),
140         AST_CLI_DEFINE(handle_cli_amihook_register_hook, "Register module for AMI hook"),
141         AST_CLI_DEFINE(handle_cli_amihook_unregister_hook, "Unregister module for AMI hook"),
142 };
143
144 static int unload_module(void)
145 {
146         ast_manager_unregister_hook(&test_hook);
147         return ast_cli_unregister_multiple(cli_amihook_evt, ARRAY_LEN(cli_amihook_evt));
148 }
149
150 static int load_module(void)
151 {
152         int res;
153
154         res = ast_cli_register_multiple(cli_amihook_evt, ARRAY_LEN(cli_amihook_evt));
155
156         return res ? AST_MODULE_LOAD_DECLINE : AST_MODULE_LOAD_SUCCESS;
157 }
158
159 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "AMI Hook Test Module");