update MANY more files with proper copyright/license info (thanks Ian!)
[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> <<You 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 /*
20  *
21  * Skeleton application
22  * 
23  */
24
25 #include <stdlib.h>
26 #include <unistd.h>
27 #include <string.h>
28
29 #include "asterisk.h"
30
31 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
32
33 #include "asterisk/file.h"
34 #include "asterisk/logger.h"
35 #include "asterisk/channel.h"
36 #include "asterisk/pbx.h"
37 #include "asterisk/module.h"
38 #include "asterisk/lock.h"
39 #include "asterisk/app.h"
40
41 static char *tdesc = "Trivial skeleton Application";
42 static char *app = "Skel";
43 static char *synopsis = 
44 "Skeleton application.";
45 static char *descrip = "This application is a template to build other applications from.\n"
46  " It shows you the basic structure to create your own Asterisk applications.\n";
47
48 #define OPTION_A        (1 << 0)        /* Option A */
49 #define OPTION_B        (1 << 1)        /* Option B(n) */
50 #define OPTION_C        (1 << 2)        /* Option C(str) */
51 #define OPTION_NULL     (1 << 3)        /* Dummy Termination */
52
53 AST_DECLARE_OPTIONS(app_opts,{
54         ['a'] = { OPTION_A },
55         ['b'] = { OPTION_B, 1 },
56         ['c'] = { OPTION_C, 2 }
57 });
58
59 STANDARD_LOCAL_USER;
60
61 LOCAL_USER_DECL;
62
63 static int app_exec(struct ast_channel *chan, void *data)
64 {
65         int res = 0;
66         struct ast_flags flags;
67         struct localuser *u;
68         char *options=NULL;
69         char *dummy = NULL;
70         char *args;
71         int argc = 0;
72         char *opts[2];
73         char *argv[2];
74
75         if (!(args = ast_strdupa((char *)data))) {
76                 ast_log(LOG_ERROR, "Out of memory!\n");
77                 return -1;
78         }
79
80         if (!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         if ((argc = ast_separate_app_args(args, '|', argv, sizeof(argv) / sizeof(argv[0])))) {
87                 dummy = argv[0];
88                 options = argv[1];
89                 ast_parseoptions(app_opts, &flags, opts, options);
90         }
91
92         if (dummy && !ast_strlen_zero(dummy)) 
93                 ast_log(LOG_NOTICE, "Dummy value is : %s\n", dummy);
94
95         if (ast_test_flag(&flags, OPTION_A))
96                 ast_log(LOG_NOTICE, "Option A is set\n");
97
98         if (ast_test_flag(&flags, OPTION_B))
99                 ast_log(LOG_NOTICE,"Option B is set with : %s\n", opts[0] ? opts[0] : "<unspecified>");
100
101         if (ast_test_flag(&flags, OPTION_C))
102                 ast_log(LOG_NOTICE,"Option C is set with : %s\n", opts[1] ? opts[1] : "<unspecified>");
103
104         /* Do our thing here */
105         LOCAL_USER_REMOVE(u);
106         return res;
107 }
108
109 int unload_module(void)
110 {
111         STANDARD_HANGUP_LOCALUSERS;
112         return ast_unregister_application(app);
113 }
114
115 int load_module(void)
116 {
117         return ast_register_application(app, app_exec, synopsis, descrip);
118 }
119
120 char *description(void)
121 {
122         return tdesc;
123 }
124
125 int usecount(void)
126 {
127         int res;
128         STANDARD_USECOUNT(res);
129         return res;
130 }
131
132 char *key()
133 {
134         return ASTERISK_GPL_KEY;
135 }