Doxygen documentation update from oej (issue #5505)
[asterisk/asterisk.git] / apps / app_forkcdr.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Anthony Minessale anthmct@yahoo.com
5  * Development of this app Sponsered/Funded  by TAAN Softworks Corp
6  *
7  * See http://www.asterisk.org for more information about
8  * the Asterisk project. Please do not directly contact
9  * any of the maintainers of this project for assistance;
10  * the project provides a web site, mailing lists and IRC
11  * channels for your use.
12  *
13  * This program is free software, distributed under the terms of
14  * the GNU General Public License Version 2. See the LICENSE file
15  * at the top of the source tree.
16  */
17
18 /*! \file
19  *
20  * \brief Fork CDR application
21  * 
22  */
23
24 #include <stdlib.h>
25 #include <unistd.h>
26 #include <string.h>
27 #include <pthread.h>
28
29 #include "asterisk.h"
30
31 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
32
33 #include "asterisk/file.h"
34 #include "asterisk/logger.h"
35 #include "asterisk/channel.h"
36 #include "asterisk/pbx.h"
37 #include "asterisk/cdr.h"
38 #include "asterisk/module.h"
39
40 static char *tdesc = "Fork The CDR into 2 separate entities.";
41 static char *app = "ForkCDR";
42 static char *synopsis = 
43 "Forks the Call Data Record";
44 static char *descrip = 
45 "  ForkCDR([options]):  Causes the Call Data Record to fork an additional\n"
46         "cdr record starting from the time of the fork call\n"
47 "If the option 'v' is passed all cdr variables will be passed along also.\n"
48 "";
49
50
51 STANDARD_LOCAL_USER;
52
53 LOCAL_USER_DECL;
54
55 static void ast_cdr_fork(struct ast_channel *chan) 
56 {
57         struct ast_cdr *cdr;
58         struct ast_cdr *newcdr;
59         if (!chan || !(cdr = chan->cdr))
60                 return;
61         while (cdr->next)
62                 cdr = cdr->next;
63         if (!(newcdr = ast_cdr_dup(cdr)))
64                 return;
65         ast_cdr_append(cdr, newcdr);
66         ast_cdr_reset(newcdr, AST_CDR_FLAG_KEEP_VARS);
67         if (!ast_test_flag(cdr, AST_CDR_FLAG_KEEP_VARS))
68                 ast_cdr_free_vars(cdr, 0);
69         ast_set_flag(cdr, AST_CDR_FLAG_CHILD | AST_CDR_FLAG_LOCKED);
70 }
71
72 static int forkcdr_exec(struct ast_channel *chan, void *data)
73 {
74         int res=0;
75         struct localuser *u;
76         LOCAL_USER_ADD(u);
77         if (data && !ast_strlen_zero(data))
78                 ast_set2_flag(chan->cdr, strchr((char *)data, 'v'), AST_CDR_FLAG_KEEP_VARS);
79         
80         ast_cdr_fork(chan);
81
82         LOCAL_USER_REMOVE(u);
83         return res;
84 }
85
86 int unload_module(void)
87 {
88         int res;
89
90         res = ast_unregister_application(app);
91
92         STANDARD_HANGUP_LOCALUSERS;
93
94         return res;     
95 }
96
97 int load_module(void)
98 {
99         return ast_register_application(app, forkcdr_exec, synopsis, descrip);
100 }
101
102 char *description(void)
103 {
104         return tdesc;
105 }
106
107 int usecount(void)
108 {
109         int res;
110         STANDARD_USECOUNT(res);
111         return res;
112 }
113
114 char *key()
115 {
116         return ASTERISK_GPL_KEY;
117 }