Now that the version.h file was getting properly regenerated every time the svn
[asterisk/asterisk.git] / funcs / func_version.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2006, Digium, Inc.
5  *
6  * See http://www.asterisk.org for more information about
7  * the Asterisk project. Please do not directly contact
8  * any of the maintainers of this project for assistance;
9  * the project provides a web site, mailing lists and IRC
10  * channels for your use.
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License Version 2. See the LICENSE file
14  * at the top of the source tree.
15  */
16
17 /*! \file
18  *
19  * \brief Return the current Version strings
20  * 
21  * \author Steve Murphy (murf@digium.com)
22  * \ingroup functions
23  */
24
25 #include "asterisk.h"
26
27 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
28
29 #include "asterisk/module.h"
30 #include "asterisk/channel.h"
31 #include "asterisk/pbx.h"
32 #include "asterisk/utils.h"
33 #include "asterisk/app.h"
34 #include "asterisk/version.h"
35 #include "asterisk/build.h"
36
37 static int acf_version_exec(struct ast_channel *chan, const char *cmd,
38                          char *parse, char *buffer, size_t buflen)
39 {
40         const char *response_char = ast_get_version();
41         AST_DECLARE_APP_ARGS(args,
42                 AST_APP_ARG(info);
43         );
44
45         AST_STANDARD_APP_ARGS(args, parse);
46
47         if (!ast_strlen_zero(args.info) ) {
48                 if (!strcasecmp(args.info,"ASTERISK_VERSION_NUM"))
49                         response_char = ast_get_version_num();
50                 else if (!strcasecmp(args.info,"BUILD_USER"))
51                         response_char = BUILD_USER;
52                 else if (!strcasecmp(args.info,"BUILD_HOSTNAME"))
53                         response_char = BUILD_HOSTNAME;
54                 else if (!strcasecmp(args.info,"BUILD_MACHINE"))
55                         response_char = BUILD_MACHINE;
56                 else if (!strcasecmp(args.info,"BUILD_KERNEL"))
57                         response_char = BUILD_KERNEL;
58                 else if (!strcasecmp(args.info,"BUILD_OS"))
59                         response_char = BUILD_OS;
60                 else if (!strcasecmp(args.info,"BUILD_DATE"))
61                         response_char = BUILD_DATE;
62         }
63
64         ast_debug(1, "VERSION returns %s result, given %s argument\n", response_char, args.info);
65
66         snprintf(buffer, buflen, "%s", response_char);
67
68         return 0;
69 }
70
71 static struct ast_custom_function acf_version = {
72         .name = "VERSION",
73         .synopsis = "Return the Version info for this Asterisk",
74         .syntax = "VERSION([info])",
75         .desc =
76                 "If there are no arguments, return the version of Asterisk in this format: SVN-branch-1.4-r44830M\n"
77                 "If the argument is 'ASTERISK_VERSION_NUM', a string of digits is returned (right now fixed at 999999).\n"
78                 "If the argument is 'BUILD_USER', the string representing the user's name whose account was used to configure Asterisk, is returned.\n"
79                 "If the argument is 'BUILD_HOSTNAME', the string representing the name of the host on which Asterisk was configured, is returned.\n"
80                 "If the argument is 'BUILD_MACHINE', the string representing the type of machine on which Asterisk was configured, is returned.\n"
81                 "If the argument is 'BUILD_OS', the string representing the OS of the machine on which Asterisk was configured, is returned.\n"
82                 "If the argument is 'BUILD_DATE', the string representing the date on which Asterisk was configured, is returned.\n"
83                 "If the argument is 'BUILD_KERNEL', the string representing the kernel version of the machine on which Asterisk was configured, is returned .\n"
84                 "  Example:  Set(junky=${VERSION()}; \n"
85                 "  Sets junky to the string 'SVN-branch-1.6-r74830M', or possibly, 'SVN-trunk-r45126M'.\n",
86         .read = acf_version_exec,
87 };
88
89 static int unload_module(void)
90 {
91         ast_custom_function_unregister(&acf_version);
92
93         return 0;
94 }
95
96 static int load_module(void)
97 {
98         return ast_custom_function_register(&acf_version);
99 }
100
101 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Get Asterisk Version/Build Info");