revert my pass through the tree to remove checks of the result of ast_strdupa
[asterisk/asterisk.git] / apps / app_skel.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) <Year>, <Your Name Here>
5  *
6  * <Your Name Here> <<Your Email Here>>
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 Skeleton application
22  *
23  * \author <Your Name Here> <<Your Email Here>>
24  * 
25  * This is a skeleton for development of an Asterisk application 
26  * \ingroup applications
27  */
28
29 #include <stdio.h>
30 #include <stdlib.h>
31 #include <unistd.h>
32 #include <string.h>
33
34 #include "asterisk.h"
35
36 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
37
38 #include "asterisk/file.h"
39 #include "asterisk/logger.h"
40 #include "asterisk/channel.h"
41 #include "asterisk/pbx.h"
42 #include "asterisk/module.h"
43 #include "asterisk/lock.h"
44 #include "asterisk/app.h"
45
46 static char *tdesc = "Trivial skeleton Application";
47 static char *app = "Skel";
48 static char *synopsis = 
49 "Skeleton application.";
50 static char *descrip = "This application is a template to build other applications from.\n"
51  " It shows you the basic structure to create your own Asterisk applications.\n";
52
53 #define OPTION_A        (1 << 0)        /* Option A */
54 #define OPTION_B        (1 << 1)        /* Option B(n) */
55 #define OPTION_C        (1 << 2)        /* Option C(str) */
56 #define OPTION_NULL     (1 << 3)        /* Dummy Termination */
57
58 AST_DECLARE_OPTIONS(app_opts,{
59         ['a'] = { OPTION_A },
60         ['b'] = { OPTION_B, 1 },
61         ['c'] = { OPTION_C, 2 }
62 });
63
64 STANDARD_LOCAL_USER;
65
66 LOCAL_USER_DECL;
67
68 static int app_exec(struct ast_channel *chan, void *data)
69 {
70         int res = 0;
71         struct ast_flags flags;
72         struct localuser *u;
73         char *options = NULL;
74         char *dummy = NULL;
75         char *args;
76         int argc = 0;
77         char *opts[2];
78         char *argv[2];
79
80         if (ast_strlen_zero(data)) {
81                 ast_log(LOG_WARNING, "%s requires an argument (dummy|[options])\n",app);
82                 return -1;
83         }
84
85         LOCAL_USER_ADD(u);
86
87         /* Do our thing here */
88
89         /* We need to make a copy of the input string if we are going to modify it! */
90         args = ast_strdupa(data);       
91         if (!args) {
92                 ast_log(LOG_ERROR, "Out of memory!\n");
93                 LOCAL_USER_REMOVE(u);
94                 return -1;
95         }
96         
97         if ((argc = ast_app_separate_args(args, '|', argv, sizeof(argv) / sizeof(argv[0])))) {
98                 dummy = argv[0];
99                 options = argv[1];
100                 ast_parseoptions(app_opts, &flags, opts, options);
101         }
102
103         if (!ast_strlen_zero(dummy)) 
104                 ast_log(LOG_NOTICE, "Dummy value is : %s\n", dummy);
105
106         if (ast_test_flag(&flags, OPTION_A))
107                 ast_log(LOG_NOTICE, "Option A is set\n");
108
109         if (ast_test_flag(&flags, OPTION_B))
110                 ast_log(LOG_NOTICE,"Option B is set with : %s\n", opts[0] ? opts[0] : "<unspecified>");
111
112         if (ast_test_flag(&flags, OPTION_C))
113                 ast_log(LOG_NOTICE,"Option C is set with : %s\n", opts[1] ? opts[1] : "<unspecified>");
114
115         LOCAL_USER_REMOVE(u);
116
117         return res;
118 }
119
120 int unload_module(void)
121 {
122         int res;
123
124         res = ast_unregister_application(app);
125
126         STANDARD_HANGUP_LOCALUSERS;
127
128         return res;     
129 }
130
131 int load_module(void)
132 {
133         return ast_register_application(app, app_exec, synopsis, descrip);
134 }
135
136 int reload(void)
137 {
138         /* This function will be called if a 'reload' is requested */
139
140         return 0;
141 }
142
143 char *description(void)
144 {
145         return tdesc;
146 }
147
148 int usecount(void)
149 {
150         int res;
151
152         STANDARD_USECOUNT(res);
153
154         return res;
155 }
156
157 char *key()
158 {
159         return ASTERISK_GPL_KEY;
160 }