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