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