Merged revisions 90696 via svnmerge from
[asterisk/asterisk.git] / apps / app_dumpchan.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2004 - 2005, Anthony Minessale II.
5  *
6  * Anthony Minessale <anthmct@yahoo.com>
7  *
8  * A license has been granted to Digium (via disclaimer) for the use of
9  * this code.
10  *
11  * See http://www.asterisk.org for more information about
12  * the Asterisk project. Please do not directly contact
13  * any of the maintainers of this project for assistance;
14  * the project provides a web site, mailing lists and IRC
15  * channels for your use.
16  *
17  * This program is free software, distributed under the terms of
18  * the GNU General Public License Version 2. See the LICENSE file
19  * at the top of the source tree.
20  */
21
22 /*! \file
23  *
24  * \brief Application to dump channel variables
25  *
26  * \author Anthony Minessale <anthmct@yahoo.com>
27  *
28  * \ingroup applications
29  */
30
31 #include "asterisk.h"
32
33 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
34
35 #include "asterisk/pbx.h"
36 #include "asterisk/module.h"
37 #include "asterisk/channel.h"
38
39 static char *app = "DumpChan";
40 static char *synopsis = "Dump Info About The Calling Channel";
41 static char *desc = 
42         "   DumpChan([<min_verbose_level>])\n"
43         "Displays information on channel and listing of all channel\n"
44         "variables. If min_verbose_level is specified, output is only\n"
45         "displayed when the verbose level is currently set to that number\n"
46         "or greater. \n";
47
48
49 static int serialize_showchan(struct ast_channel *c, char *buf, size_t size)
50 {
51         struct timeval now;
52         long elapsed_seconds = 0;
53         int hour = 0, min = 0, sec = 0;
54         char cgrp[BUFSIZ/2];
55         char pgrp[BUFSIZ/2];
56         char formatbuf[BUFSIZ/2];
57         
58         now = ast_tvnow();
59         memset(buf, 0, size);
60         if (!c)
61                 return 0;
62
63         if (c->cdr) {
64                 elapsed_seconds = now.tv_sec - c->cdr->start.tv_sec;
65                 hour = elapsed_seconds / 3600;
66                 min = (elapsed_seconds % 3600) / 60;
67                 sec = elapsed_seconds % 60;
68         }
69
70         snprintf(buf,size, 
71                          "Name=               %s\n"
72                          "Type=               %s\n"
73                          "UniqueID=           %s\n"
74                          "CallerIDNum=        %s\n"
75                          "CallerIDName=       %s\n"
76                          "DNIDDigits=         %s\n"
77                          "RDNIS=              %s\n"
78                          "Language=           %s\n"
79                          "State=              %s (%d)\n"
80                          "Rings=              %d\n"
81                          "NativeFormat=       %s\n"
82                          "WriteFormat=        %s\n"
83                          "ReadFormat=         %s\n"
84                          "RawWriteFormat=     %s\n"
85                          "RawReadFormat=      %s\n"
86                          "1stFileDescriptor=  %d\n"
87                          "Framesin=           %d %s\n"
88                          "Framesout=          %d %s\n"
89                          "TimetoHangup=       %ld\n"
90                          "ElapsedTime=        %dh%dm%ds\n"
91                          "Context=            %s\n"
92                          "Extension=          %s\n"
93                          "Priority=           %d\n"
94                          "CallGroup=          %s\n"
95                          "PickupGroup=        %s\n"
96                          "Application=        %s\n"
97                          "Data=               %s\n"
98                          "Blocking_in=        %s\n",
99                          c->name,
100                          c->tech->type,
101                          c->uniqueid,
102                          S_OR(c->cid.cid_num, "(N/A)"),
103                          S_OR(c->cid.cid_name, "(N/A)"),
104                          S_OR(c->cid.cid_dnid, "(N/A)"),
105                          S_OR(c->cid.cid_rdnis, "(N/A)"),
106                          c->language,
107                          ast_state2str(c->_state),
108                          c->_state,
109                          c->rings,
110                          ast_getformatname_multiple(formatbuf, sizeof(formatbuf), c->nativeformats),
111                          ast_getformatname_multiple(formatbuf, sizeof(formatbuf), c->writeformat),
112                          ast_getformatname_multiple(formatbuf, sizeof(formatbuf), c->readformat),
113                          ast_getformatname_multiple(formatbuf, sizeof(formatbuf), c->rawwriteformat),
114                          ast_getformatname_multiple(formatbuf, sizeof(formatbuf), c->rawreadformat),
115                          c->fds[0], c->fin & ~DEBUGCHAN_FLAG, (c->fin & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "",
116                          c->fout & ~DEBUGCHAN_FLAG, (c->fout & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "", (long)c->whentohangup,
117                          hour,
118                          min,
119                          sec,
120                          c->context,
121                          c->exten,
122                          c->priority,
123                          ast_print_group(cgrp, sizeof(cgrp), c->callgroup),
124                          ast_print_group(pgrp, sizeof(pgrp), c->pickupgroup),
125                          ( c->appl ? c->appl : "(N/A)" ),
126                          ( c-> data ? S_OR(c->data, "(Empty)") : "(None)"),
127                          (ast_test_flag(c, AST_FLAG_BLOCKING) ? c->blockproc : "(Not Blocking)"));
128
129         return 0;
130 }
131
132 static int dumpchan_exec(struct ast_channel *chan, void *data)
133 {
134         struct ast_str *vars = ast_str_alloca(BUFSIZ * 4); /* XXX very large! */
135         char info[1024];
136         int level = 0;
137         static char *line = "================================================================================";
138         
139         if (!ast_strlen_zero(data)) 
140                 level = atoi(data);
141
142         pbx_builtin_serialize_variables(chan, &vars);
143         serialize_showchan(chan, info, sizeof(info));
144         if (option_verbose >= level)
145                 ast_verbose("\nDumping Info For Channel: %s:\n%s\nInfo:\n%s\nVariables:\n%s%s\n", chan->name, line, info, vars->str, line);
146         
147         return 0;
148 }
149
150 static int unload_module(void)
151 {
152         return ast_unregister_application(app);
153 }
154
155 static int load_module(void)
156 {
157         return ast_register_application(app, dumpchan_exec, synopsis, desc);
158 }
159
160 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Dump Info About The Calling Channel");