git migration: Refactor the ASTERISK_FILE_VERSION macro
[asterisk/asterisk.git] / apps / app_softhangup.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@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 SoftHangup application
22  *
23  * \author Mark Spencer <markster@digium.com>
24  * 
25  * \ingroup applications
26  */
27
28 /*** MODULEINFO
29         <support_level>core</support_level>
30  ***/
31
32 #include "asterisk.h"
33
34 ASTERISK_REGISTER_FILE()
35
36 #include "asterisk/file.h"
37 #include "asterisk/channel.h"
38 #include "asterisk/pbx.h"
39 #include "asterisk/module.h"
40 #include "asterisk/lock.h"
41 #include "asterisk/app.h"
42
43 /*** DOCUMENTATION
44         <application name="SoftHangup" language="en_US">
45                 <synopsis>
46                         Hangs up the requested channel.
47                 </synopsis>
48                 <syntax>
49                         <parameter name="Technology/Resource" required="true" />
50                         <parameter name="options">
51                                 <optionlist>
52                                         <option name="a">
53                                                 <para>Hang up all channels on a specified device instead of a single resource</para>
54                                         </option>
55                                 </optionlist>
56                         </parameter>
57                 </syntax>       
58                 <description>
59                         <para>Hangs up the requested channel.  If there are no channels to 
60                         hangup, the application will report it.</para>
61                 </description>
62         </application>
63
64  ***/
65
66 static char *app = "SoftHangup";
67
68 enum {
69         OPTION_ALL = (1 << 0),
70 };
71
72 AST_APP_OPTIONS(app_opts,{
73         AST_APP_OPTION('a', OPTION_ALL),
74 });
75
76 static int softhangup_exec(struct ast_channel *chan, const char *data)
77 {
78         struct ast_channel *c = NULL;
79         char *cut, *opts[0];
80         char name[AST_CHANNEL_NAME] = "", *parse;
81         struct ast_flags flags = {0};
82         int lenmatch;
83         AST_DECLARE_APP_ARGS(args,
84                 AST_APP_ARG(channel);
85                 AST_APP_ARG(options);
86         );
87         struct ast_channel_iterator *iter;
88         
89         if (ast_strlen_zero(data)) {
90                 ast_log(LOG_WARNING, "SoftHangup requires an argument (Technology/resource)\n");
91                 return 0;
92         }
93
94         parse = ast_strdupa(data);
95         AST_STANDARD_APP_ARGS(args, parse);
96
97         if (args.argc == 2)
98                 ast_app_parse_options(app_opts, &flags, opts, args.options);
99         lenmatch = strlen(args.channel);
100
101         if (!(iter = ast_channel_iterator_by_name_new(args.channel, lenmatch))) {
102                 return -1;
103         }
104
105         while ((c = ast_channel_iterator_next(iter))) {
106                 ast_channel_lock(c);
107                 ast_copy_string(name, ast_channel_name(c), sizeof(name));
108                 if (ast_test_flag(&flags, OPTION_ALL)) {
109                         /* CAPI is set up like CAPI[foo/bar]/clcnt */ 
110                         if (!strcmp(ast_channel_tech(c)->type, "CAPI")) {
111                                 cut = strrchr(name, '/');
112                         /* Basically everything else is Foo/Bar-Z */
113                         } else {
114                                 /* use strrchr() because Foo/Bar-Z could actually be Foo/B-a-r-Z */
115                                 cut = strrchr(name,'-');
116                         }
117                         /* Get rid of what we've cut */
118                         if (cut)
119                                 *cut = 0;
120                 }
121                 if (!strcasecmp(name, args.channel)) {
122                         ast_log(LOG_WARNING, "Soft hanging %s up.\n", ast_channel_name(c));
123                         ast_softhangup(c, AST_SOFTHANGUP_EXPLICIT);
124                         if (!ast_test_flag(&flags, OPTION_ALL)) {
125                                 ast_channel_unlock(c);
126                                 c = ast_channel_unref(c);
127                                 break;
128                         }
129                 }
130                 ast_channel_unlock(c);
131                 c = ast_channel_unref(c);
132         }
133
134         ast_channel_iterator_destroy(iter);
135
136         return 0;
137 }
138
139 static int unload_module(void)
140 {
141         return ast_unregister_application(app);
142 }
143
144 static int load_module(void)
145 {
146         return ast_register_application_xml(app, softhangup_exec);
147 }
148
149 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Hangs up the requested channel");