Thu Apr 28 2011 17:15:15

Asterisk developer's documentation


app_verbose.c

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- An open source telephony toolkit.
00003  *
00004  * Copyright (c) 2004 - 2005 Tilghman Lesher.  All rights reserved.
00005  *
00006  * Tilghman Lesher <app_verbose_v001@the-tilghman.com>
00007  *
00008  * This code is released by the author with no restrictions on usage.
00009  *
00010  * See http://www.asterisk.org for more information about
00011  * the Asterisk project. Please do not directly contact
00012  * any of the maintainers of this project for assistance;
00013  * the project provides a web site, mailing lists and IRC
00014  * channels for your use.
00015  *
00016  */
00017 
00018 /*! \file
00019  *
00020  * \brief Verbose logging application
00021  *
00022  * \author Tilghman Lesher <app_verbose_v001@the-tilghman.com>
00023  *
00024  * \ingroup applications
00025  */
00026 
00027 #include "asterisk.h"
00028 
00029 ASTERISK_FILE_VERSION(__FILE__, "$Revision: 301176 $")
00030 
00031 #include "asterisk/module.h"
00032 #include "asterisk/app.h"
00033 #include "asterisk/channel.h"
00034 
00035 static char *app_verbose = "Verbose";
00036 static char *app_log = "Log";
00037 
00038 /*** DOCUMENTATION
00039    <application name="Verbose" language="en_US">
00040       <synopsis>
00041          Send arbitrary text to verbose output.
00042       </synopsis>
00043       <syntax>
00044          <parameter name="level">
00045             <para>Must be an integer value.  If not specified, defaults to 0.</para>
00046          </parameter>
00047          <parameter name="message" required="true">
00048             <para>Output text message.</para>
00049          </parameter>
00050       </syntax>
00051       <description>
00052          <para>Sends an arbitrary text message to verbose output.</para>
00053       </description>
00054    </application>
00055    <application name="Log" language="en_US">
00056       <synopsis>
00057          Send arbitrary text to a selected log level.
00058       </synopsis>
00059       <syntax>
00060          <parameter name="level" required="true">
00061             <para>Level must be one of <literal>ERROR</literal>, <literal>WARNING</literal>, <literal>NOTICE</literal>,
00062             <literal>DEBUG</literal>, <literal>VERBOSE</literal> or <literal>DTMF</literal>.</para>   
00063          </parameter>
00064          <parameter name="message" required="true">
00065             <para>Output text message.</para>
00066          </parameter>
00067       </syntax>
00068       <description>
00069          <para>Sends an arbitrary text message to a selected log level.</para>
00070       </description>
00071    </application>
00072  ***/
00073 
00074 
00075 static int verbose_exec(struct ast_channel *chan, void *data)
00076 {
00077    int vsize;
00078    char *parse;
00079    AST_DECLARE_APP_ARGS(args,
00080       AST_APP_ARG(level);
00081       AST_APP_ARG(msg);
00082    );
00083 
00084    if (ast_strlen_zero(data)) {
00085       return 0;
00086    }
00087 
00088    parse = ast_strdupa(data);
00089    AST_STANDARD_APP_ARGS(args, parse);
00090    if (args.argc == 1) {
00091       args.msg = args.level;
00092       args.level = "0";
00093    }
00094 
00095    if (sscanf(args.level, "%30d", &vsize) != 1) {
00096       vsize = 0;
00097       ast_log(LOG_WARNING, "'%s' is not a verboser number\n", args.level);
00098    }
00099    if (option_verbose >= vsize) {
00100       switch (vsize) {
00101       case 0:
00102          ast_verbose("%s\n", args.msg);
00103          break;
00104       case 1:
00105          ast_verbose(VERBOSE_PREFIX_1 "%s\n", args.msg);
00106          break;
00107       case 2:
00108          ast_verbose(VERBOSE_PREFIX_2 "%s\n", args.msg);
00109          break;
00110       case 3:
00111          ast_verbose(VERBOSE_PREFIX_3 "%s\n", args.msg);
00112          break;
00113       default:
00114          ast_verbose(VERBOSE_PREFIX_4 "%s\n", args.msg);
00115       }
00116    }
00117 
00118    return 0;
00119 }
00120 
00121 static int log_exec(struct ast_channel *chan, void *data)
00122 {
00123    char *parse;
00124    int lnum = -1;
00125    char extension[AST_MAX_EXTENSION + 5], context[AST_MAX_EXTENSION + 2];
00126    AST_DECLARE_APP_ARGS(args,
00127       AST_APP_ARG(level);
00128       AST_APP_ARG(msg);
00129    );
00130 
00131    if (ast_strlen_zero(data))
00132       return 0;
00133 
00134    parse = ast_strdupa(data);
00135    AST_STANDARD_APP_ARGS(args, parse);
00136 
00137    if (!strcasecmp(args.level, "ERROR")) {
00138       lnum = __LOG_ERROR;
00139    } else if (!strcasecmp(args.level, "WARNING")) {
00140       lnum = __LOG_WARNING;
00141    } else if (!strcasecmp(args.level, "NOTICE")) {
00142       lnum = __LOG_NOTICE;
00143    } else if (!strcasecmp(args.level, "DEBUG")) {
00144       lnum = __LOG_DEBUG;
00145    } else if (!strcasecmp(args.level, "VERBOSE")) {
00146       lnum = __LOG_VERBOSE;
00147    } else if (!strcasecmp(args.level, "DTMF")) {
00148       lnum = __LOG_DTMF;
00149    } else if (!strcasecmp(args.level, "EVENT")) {
00150       lnum = __LOG_EVENT;
00151    } else {
00152       ast_log(LOG_ERROR, "Unknown log level: '%s'\n", args.level);
00153    }
00154 
00155    if (lnum > -1) {
00156       snprintf(context, sizeof(context), "@ %s", chan->context);
00157       snprintf(extension, sizeof(extension), "Ext. %s", chan->exten);
00158 
00159       ast_log(lnum, extension, chan->priority, context, "%s\n", args.msg);
00160    }
00161 
00162    return 0;
00163 }
00164 
00165 static int unload_module(void)
00166 {
00167    int res;
00168 
00169    res = ast_unregister_application(app_verbose);
00170    res |= ast_unregister_application(app_log);
00171 
00172    return res; 
00173 }
00174 
00175 static int load_module(void)
00176 {
00177    int res;
00178 
00179    res = ast_register_application_xml(app_log, log_exec);
00180    res |= ast_register_application_xml(app_verbose, verbose_exec);
00181 
00182    return res;
00183 }
00184 
00185 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Send verbose output");