apps/app_verbose.c

   1 /*
   2  * Asterisk -- An open source telephony toolkit.
   3  *
   4  * Copyright (c) 2004 - 2005 Tilghman Lesher.  All rights reserved.
   5  *
   6  * Tilghman Lesher <app_verbose_v001@the-tilghman.com>
   7  *
   8  * This code is released by the author with no restrictions on usage.
   9  *
  10  * See http://www.asterisk.org for more information about
  11  * the Asterisk project. Please do not directly contact
  12  * any of the maintainers of this project for assistance;
  13  * the project provides a web site, mailing lists and IRC
  14  * channels for your use.
  15  *
  16  */
  17
  18 /*! \file
  19  *
  20  * \brief Verbose logging application
  21  *
  22  * \author Tilghman Lesher <app_verbose_v001@the-tilghman.com>
  23  *
  24  * \ingroup applications
  25  */
  26
  27 /*** MODULEINFO
  28         <support_level>core</support_level>
  29  ***/
  30
  31 #include "asterisk.h"
  32
  33 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
  34
  35 #include "asterisk/module.h"
  36 #include "asterisk/app.h"
  37 #include "asterisk/channel.h"
  38
  39 static char *app_verbose = "Verbose";
  40 static char *app_log = "Log";
  41
  42 /*** DOCUMENTATION
  43         <application name="Verbose" language="en_US">
  44                 <synopsis>
  45                         Send arbitrary text to verbose output.
  46                 </synopsis>
  47                 <syntax>
  48                         <parameter name="level">
  49                                 <para>Must be an integer value.  If not specified, defaults to 0.</para>
  50                         </parameter>
  51                         <parameter name="message" required="true">
  52                                 <para>Output text message.</para>
  53                         </parameter>
  54                 </syntax>
  55                 <description>
  56                         <para>Sends an arbitrary text message to verbose output.</para>
  57                 </description>
  58         </application>
  59         <application name="Log" language="en_US">
  60                 <synopsis>
  61                         Send arbitrary text to a selected log level.
  62                 </synopsis>
  63                 <syntax>
  64                         <parameter name="level" required="true">
  65                                 <para>Level must be one of <literal>ERROR</literal>, <literal>WARNING</literal>, <literal>NOTICE</literal>,
  66                                 <literal>DEBUG</literal>, <literal>VERBOSE</literal> or <literal>DTMF</literal>.</para>
  67                         </parameter>
  68                         <parameter name="message" required="true">
  69                                 <para>Output text message.</para>
  70                         </parameter>
  71                 </syntax>
  72                 <description>
  73                         <para>Sends an arbitrary text message to a selected log level.</para>
  74                 </description>
  75         </application>
  76  ***/
  77
  78
  79 static int verbose_exec(struct ast_channel *chan, const char *data)
  80 {
  81         int vsize;
  82         char *parse;
  83         AST_DECLARE_APP_ARGS(args,
  84                 AST_APP_ARG(level);
  85                 AST_APP_ARG(msg);
  86         );
  87
  88         if (ast_strlen_zero(data)) {
  89                 return 0;
  90         }
  91
  92         parse = ast_strdupa(data);
  93         AST_STANDARD_APP_ARGS(args, parse);
  94         if (args.argc == 1) {
  95                 args.msg = args.level;
  96                 args.level = "0";
  97         }
  98
  99         if (sscanf(args.level, "%30d", &vsize) != 1) {
 100                 vsize = 0;
 101                 ast_log(LOG_WARNING, "'%s' is not a verboser number\n", args.level);
 102         }
 103         if (option_verbose >= vsize) {
 104                 switch (vsize) {
 105                 case 0:
 106                         ast_verb(0, "%s\n", args.msg);
 107                         break;
 108                 case 1:
 109                         ast_verb(1, "%s\n", args.msg);
 110                         break;
 111                 case 2:
 112                         ast_verb(2, "%s\n", args.msg);
 113                         break;
 114                 case 3:
 115                         ast_verb(3, "%s\n", args.msg);
 116                         break;
 117                 default:
 118                         ast_verb(4, "%s\n", args.msg);
 119                 }
 120         }
 121
 122         return 0;
 123 }
 124
 125 static int log_exec(struct ast_channel *chan, const char *data)
 126 {
 127         char *parse;
 128         int lnum = -1;
 129         char extension[AST_MAX_EXTENSION + 5], context[AST_MAX_EXTENSION + 2];
 130         AST_DECLARE_APP_ARGS(args,
 131                 AST_APP_ARG(level);
 132                 AST_APP_ARG(msg);
 133         );
 134
 135         if (ast_strlen_zero(data))
 136                 return 0;
 137
 138         parse = ast_strdupa(data);
 139         AST_STANDARD_APP_ARGS(args, parse);
 140
 141         if (!strcasecmp(args.level, "ERROR")) {
 142                 lnum = __LOG_ERROR;
 143         } else if (!strcasecmp(args.level, "WARNING")) {
 144                 lnum = __LOG_WARNING;
 145         } else if (!strcasecmp(args.level, "NOTICE")) {
 146                 lnum = __LOG_NOTICE;
 147         } else if (!strcasecmp(args.level, "DEBUG")) {
 148                 lnum = __LOG_DEBUG;
 149         } else if (!strcasecmp(args.level, "VERBOSE")) {
 150                 lnum = __LOG_VERBOSE;
 151         } else if (!strcasecmp(args.level, "DTMF")) {
 152                 lnum = __LOG_DTMF;
 153         } else {
 154                 ast_log(LOG_ERROR, "Unknown log level: '%s'\n", args.level);
 155         }
 156
 157         if (lnum > -1) {
 158                 snprintf(context, sizeof(context), "@ %s", ast_channel_context(chan));
 159                 snprintf(extension, sizeof(extension), "Ext. %s", ast_channel_exten(chan));
 160
 161                 ast_log(lnum, extension, ast_channel_priority(chan), context, "%s\n", args.msg);
 162         }
 163
 164         return 0;
 165 }
 166
 167 static int unload_module(void)
 168 {
 169         int res;
 170
 171         res = ast_unregister_application(app_verbose);
 172         res |= ast_unregister_application(app_log);
 173
 174         return res;
 175 }
 176
 177 static int load_module(void)
 178 {
 179         int res;
 180
 181         res = ast_register_application_xml(app_log, log_exec);
 182         res |= ast_register_application_xml(app_verbose, verbose_exec);
 183
 184         return res;
 185 }
 186
 187 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Send verbose output");