security_events: Fix error caused by DTD validation error
[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 /*** MODULEINFO
26         <support_level>core</support_level>
27  ***/
28
29 #include "asterisk.h"
30
31 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
32
33 #include "asterisk/module.h"
34 #include "asterisk/channel.h"
35 #include "asterisk/pbx.h"
36 #include "asterisk/utils.h"
37 #include "asterisk/app.h"
38 #include "asterisk/ast_version.h"
39 #include "asterisk/build.h"
40
41 /*** DOCUMENTATION
42         <function name="VERSION" language="en_US">
43                 <synopsis>
44                         Return the Version info for this Asterisk.
45                 </synopsis>
46                 <syntax>
47                         <parameter name="info">
48                                 <para>The possible values are:</para>
49                                 <enumlist>
50                                         <enum name="ASTERISK_VERSION_NUM">
51                                                 <para>A string of digits is returned, e.g. 10602 for 1.6.2 or 100300 for 10.3.0,
52                                                 or 999999 when using an SVN build.</para>
53                                         </enum>
54                                         <enum name="BUILD_USER">
55                                                 <para>The string representing the user's name whose account
56                                                 was used to configure Asterisk, is returned.</para>
57                                         </enum>
58                                         <enum name="BUILD_HOSTNAME">
59                                                 <para>The string representing the name of the host on which Asterisk was configured, is returned.</para>
60                                         </enum>
61                                         <enum name="BUILD_MACHINE">
62                                                 <para>The string representing the type of machine on which Asterisk was configured, is returned.</para>
63                                         </enum>
64                                         <enum name="BUILD_OS">
65                                                 <para>The string representing the OS of the machine on which Asterisk was configured, is returned.</para>
66                                         </enum>
67                                         <enum name="BUILD_DATE">
68                                                 <para>The string representing the date on which Asterisk was configured, is returned.</para>
69                                         </enum>
70                                         <enum name="BUILD_KERNEL">
71                                                 <para>The string representing the kernel version of the machine on which Asterisk
72                                                 was configured, is returned.</para>
73                                         </enum>
74                                 </enumlist>
75                         </parameter>
76                 </syntax>
77                 <description>
78                         <para>If there are no arguments, return the version of Asterisk in this format: SVN-branch-1.4-r44830M</para>
79                         <para>Example:  Set(junky=${VERSION()};</para>
80                         <para>Sets junky to the string <literal>SVN-branch-1.6-r74830M</literal>, or possibly, <literal>SVN-trunk-r45126M</literal>.</para>
81                 </description>
82         </function>
83  ***/
84
85 static int acf_version_exec(struct ast_channel *chan, const char *cmd,
86                          char *parse, char *buffer, size_t buflen)
87 {
88         const char *response_char = ast_get_version();
89         AST_DECLARE_APP_ARGS(args,
90                 AST_APP_ARG(info);
91         );
92
93         AST_STANDARD_APP_ARGS(args, parse);
94
95         if (!ast_strlen_zero(args.info) ) {
96                 if (!strcasecmp(args.info,"ASTERISK_VERSION_NUM"))
97                         response_char = ast_get_version_num();
98                 else if (!strcasecmp(args.info,"BUILD_USER"))
99                         response_char = BUILD_USER;
100                 else if (!strcasecmp(args.info,"BUILD_HOSTNAME"))
101                         response_char = BUILD_HOSTNAME;
102                 else if (!strcasecmp(args.info,"BUILD_MACHINE"))
103                         response_char = BUILD_MACHINE;
104                 else if (!strcasecmp(args.info,"BUILD_KERNEL"))
105                         response_char = BUILD_KERNEL;
106                 else if (!strcasecmp(args.info,"BUILD_OS"))
107                         response_char = BUILD_OS;
108                 else if (!strcasecmp(args.info,"BUILD_DATE"))
109                         response_char = BUILD_DATE;
110         }
111
112         ast_debug(1, "VERSION returns %s result, given %s argument\n", response_char, args.info);
113
114         ast_copy_string(buffer, response_char, buflen);
115
116         return 0;
117 }
118
119 static struct ast_custom_function acf_version = {
120         .name = "VERSION",
121         .read = acf_version_exec,
122 };
123
124 static int unload_module(void)
125 {
126         ast_custom_function_unregister(&acf_version);
127
128         return 0;
129 }
130
131 static int load_module(void)
132 {
133         return ast_custom_function_register(&acf_version);
134 }
135
136 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Get Asterisk Version/Build Info");