39639bd702b8f7740353c259a97d10f085d8e331
[asterisk/asterisk.git] / cdr / cdr_pgsql.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2003 - 2006
5  *
6  * Matthew D. Hardeman <mhardemn@papersoft.com> 
7  * Adapted from the MySQL CDR logger originally by James Sharp 
8  *
9  * Modified September 2003
10  * Matthew D. Hardeman <mhardemn@papersoft.com>
11  *
12  * See http://www.asterisk.org for more information about
13  * the Asterisk project. Please do not directly contact
14  * any of the maintainers of this project for assistance;
15  * the project provides a web site, mailing lists and IRC
16  * channels for your use.
17  *
18  * This program is free software, distributed under the terms of
19  * the GNU General Public License Version 2. See the LICENSE file
20  * at the top of the source tree.
21  */
22
23 /*! \file
24  *
25  * \brief PostgreSQL CDR logger 
26  * 
27  * \author Matthew D. Hardeman <mhardemn@papersoft.com> 
28  * \extref PostgreSQL http://www.postgresql.org/
29  *
30  * See also
31  * \arg \ref Config_cdr
32  * \arg http://www.postgresql.org/
33  * \ingroup cdr_drivers
34  */
35
36 /*** MODULEINFO
37         <depend>pgsql</depend>
38  ***/
39
40 #include "asterisk.h"
41
42 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
43
44 #include <sys/types.h>
45 #include <stdio.h>
46 #include <string.h>
47 #include <stdlib.h>
48 #include <unistd.h>
49 #include <time.h>
50
51 #include <libpq-fe.h>
52
53 #include "asterisk/config.h"
54 #include "asterisk/options.h"
55 #include "asterisk/channel.h"
56 #include "asterisk/cdr.h"
57 #include "asterisk/module.h"
58 #include "asterisk/logger.h"
59 #include "asterisk.h"
60
61 #define DATE_FORMAT "%Y-%m-%d %T"
62
63 static char *name = "pgsql";
64 static char *config = "cdr_pgsql.conf";
65 static char *pghostname = NULL, *pgdbname = NULL, *pgdbuser = NULL, *pgpassword = NULL, *pgdbport = NULL, *table = NULL;
66 static int connected = 0;
67
68 AST_MUTEX_DEFINE_STATIC(pgsql_lock);
69
70 static PGconn   *conn = NULL;
71 static PGresult *result = NULL;
72
73 static int pgsql_log(struct ast_cdr *cdr)
74 {
75         struct tm tm;
76         char sqlcmd[2048] = "", timestr[128];
77         char *pgerror;
78
79         ast_mutex_lock(&pgsql_lock);
80
81         localtime_r(&cdr->start.tv_sec,&tm);
82         strftime(timestr, sizeof(timestr), DATE_FORMAT, &tm);
83
84         if ((!connected) && pghostname && pgdbuser && pgpassword && pgdbname) {
85                 conn = PQsetdbLogin(pghostname, pgdbport, NULL, NULL, pgdbname, pgdbuser, pgpassword);
86                 if (PQstatus(conn) != CONNECTION_BAD) {
87                         connected = 1;
88                 } else {
89                         pgerror = PQerrorMessage(conn);
90                         ast_log(LOG_ERROR, "cdr_pgsql: Unable to connect to database server %s.  Calls will not be logged!\n", pghostname);
91                         ast_log(LOG_ERROR, "cdr_pgsql: Reason: %s\n", pgerror);
92                 }
93         }
94
95         if (connected) {
96                 char *clid=NULL, *dcontext=NULL, *channel=NULL, *dstchannel=NULL, *lastapp=NULL, *lastdata=NULL;
97                 char *uniqueid=NULL, *userfield=NULL;
98
99                 /* Maximum space needed would be if all characters needed to be escaped, plus a trailing NULL */
100                 if ((clid = alloca(strlen(cdr->clid) * 2 + 1)) != NULL)
101                         PQescapeString(clid, cdr->clid, strlen(cdr->clid));
102                 if ((dcontext = alloca(strlen(cdr->dcontext) * 2 + 1)) != NULL)
103                         PQescapeString(dcontext, cdr->dcontext, strlen(cdr->dcontext));
104                 if ((channel = alloca(strlen(cdr->channel) * 2 + 1)) != NULL)
105                         PQescapeString(channel, cdr->channel, strlen(cdr->channel));
106                 if ((dstchannel = alloca(strlen(cdr->dstchannel) * 2 + 1)) != NULL)
107                         PQescapeString(dstchannel, cdr->dstchannel, strlen(cdr->dstchannel));
108                 if ((lastapp = alloca(strlen(cdr->lastapp) * 2 + 1)) != NULL)
109                         PQescapeString(lastapp, cdr->lastapp, strlen(cdr->lastapp));
110                 if ((lastdata = alloca(strlen(cdr->lastdata) * 2 + 1)) != NULL)
111                         PQescapeString(lastdata, cdr->lastdata, strlen(cdr->lastdata));
112                 if ((uniqueid = alloca(strlen(cdr->uniqueid) * 2 + 1)) != NULL)
113                         PQescapeString(uniqueid, cdr->uniqueid, strlen(cdr->uniqueid));
114                 if ((userfield = alloca(strlen(cdr->userfield) * 2 + 1)) != NULL)
115                         PQescapeString(userfield, cdr->userfield, strlen(cdr->userfield));
116
117                 /* Check for all alloca failures above at once */
118                 if ((!clid) || (!dcontext) || (!channel) || (!dstchannel) || (!lastapp) || (!lastdata) || (!uniqueid) || (!userfield)) {
119                         ast_log(LOG_ERROR, "cdr_pgsql:  Out of memory error (insert fails)\n");
120                         ast_mutex_unlock(&pgsql_lock);
121                         return -1;
122                 }
123
124                 if (option_debug > 1)
125                         ast_log(LOG_DEBUG, "cdr_pgsql: inserting a CDR record.\n");
126
127                 snprintf(sqlcmd,sizeof(sqlcmd),"INSERT INTO %s (calldate,clid,src,dst,dcontext,channel,dstchannel,"
128                                  "lastapp,lastdata,duration,billsec,disposition,amaflags,accountcode,uniqueid,userfield) VALUES"
129                                  " ('%s','%s','%s','%s','%s', '%s','%s','%s','%s',%ld,%ld,'%s',%ld,'%s','%s','%s')",
130                                  table,timestr,clid,cdr->src, cdr->dst, dcontext,channel, dstchannel, lastapp, lastdata,
131                                  cdr->duration,cdr->billsec,ast_cdr_disp2str(cdr->disposition),cdr->amaflags, cdr->accountcode, uniqueid, userfield);
132                 
133                 if (option_debug > 2)
134                         ast_log(LOG_DEBUG, "cdr_pgsql: SQL command executed:  %s\n",sqlcmd);
135                 
136                 /* Test to be sure we're still connected... */
137                 /* If we're connected, and connection is working, good. */
138                 /* Otherwise, attempt reconnect.  If it fails... sorry... */
139                 if (PQstatus(conn) == CONNECTION_OK) {
140                         connected = 1;
141                 } else {
142                         ast_log(LOG_ERROR, "cdr_pgsql: Connection was lost... attempting to reconnect.\n");
143                         PQreset(conn);
144                         if (PQstatus(conn) == CONNECTION_OK) {
145                                 ast_log(LOG_ERROR, "cdr_pgsql: Connection reestablished.\n");
146                                 connected = 1;
147                         } else {
148                                 pgerror = PQerrorMessage(conn);
149                                 ast_log(LOG_ERROR, "cdr_pgsql: Unable to reconnect to database server %s. Calls will not be logged!\n", pghostname);
150                                 ast_log(LOG_ERROR, "cdr_pgsql: Reason: %s\n", pgerror);
151                                 connected = 0;
152                                 ast_mutex_unlock(&pgsql_lock);
153                                 return -1;
154                         }
155                 }
156                 result = PQexec(conn, sqlcmd);
157                 if ( PQresultStatus(result) != PGRES_COMMAND_OK) {
158                         pgerror = PQresultErrorMessage(result);
159                         ast_log(LOG_ERROR,"cdr_pgsql: Failed to insert call detail record into database!\n");
160                         ast_log(LOG_ERROR,"cdr_pgsql: Reason: %s\n", pgerror);
161                         ast_log(LOG_ERROR,"cdr_pgsql: Connection may have been lost... attempting to reconnect.\n");
162                         PQreset(conn);
163                         if (PQstatus(conn) == CONNECTION_OK) {
164                                 ast_log(LOG_ERROR, "cdr_pgsql: Connection reestablished.\n");
165                                 connected = 1;
166                                 result = PQexec(conn, sqlcmd);
167                                 if ( PQresultStatus(result) != PGRES_COMMAND_OK)
168                                 {
169                                         pgerror = PQresultErrorMessage(result);
170                                         ast_log(LOG_ERROR,"cdr_pgsql: HARD ERROR!  Attempted reconnection failed.  DROPPING CALL RECORD!\n");
171                                         ast_log(LOG_ERROR,"cdr_pgsql: Reason: %s\n", pgerror);
172                                 }
173                         }
174                         ast_mutex_unlock(&pgsql_lock);
175                         return -1;
176                 }
177         }
178         ast_mutex_unlock(&pgsql_lock);
179         return 0;
180 }
181
182 static int my_unload_module(void)
183
184         if (conn)
185                 PQfinish(conn);
186         if (pghostname)
187                 ast_free(pghostname);
188         if (pgdbname)
189                 ast_free(pgdbname);
190         if (pgdbuser)
191                 ast_free(pgdbuser);
192         if (pgpassword)
193                 ast_free(pgpassword);
194         if (pgdbport)
195                 ast_free(pgdbport);
196         if (table)
197                 ast_free(table);
198         ast_cdr_unregister(name);
199         return 0;
200 }
201
202 static int process_my_load_module(struct ast_config *cfg)
203 {
204         struct ast_variable *var;
205         char *pgerror;
206         const char *tmp;
207
208         if (!(var = ast_variable_browse(cfg, "global")))
209                 return 0;
210
211         if (!(tmp = ast_variable_retrieve(cfg,"global","hostname"))) {
212                 ast_log(LOG_WARNING,"PostgreSQL server hostname not specified.  Assuming unix socket connection\n");
213                 tmp = "";       /* connect via UNIX-socket by default */
214         }
215         
216         if (!(pghostname = ast_strdup(tmp)))
217                 return -1;
218
219         if (!(tmp = ast_variable_retrieve(cfg, "global", "dbname"))) {
220                 ast_log(LOG_WARNING,"PostgreSQL database not specified.  Assuming asterisk\n");
221                 tmp = "asteriskcdrdb";
222         }
223
224         if (!(pgdbname = ast_strdup(tmp)))
225                 return -1;
226
227         if (!(tmp = ast_variable_retrieve(cfg, "global", "user"))) {
228                 ast_log(LOG_WARNING,"PostgreSQL database user not specified.  Assuming asterisk\n");
229                 tmp = "asterisk";
230         }
231
232         if (!(pgdbuser = ast_strdup(tmp)))
233                 return -1;
234
235         if (!(tmp = ast_variable_retrieve(cfg, "global", "password"))) {
236                 ast_log(LOG_WARNING,"PostgreSQL database password not specified.  Assuming blank\n");
237                 tmp = "";
238         }
239
240         if (!(pgpassword = ast_strdup(tmp)))
241                 return -1;
242
243         if (!(tmp = ast_variable_retrieve(cfg,"global","port"))) {
244                 ast_log(LOG_WARNING,"PostgreSQL database port not specified.  Using default 5432.\n");
245                 tmp = "5432";
246         }
247
248         if (!(pgdbport = ast_strdup(tmp)))
249                 return -1;
250
251         if (!(tmp = ast_variable_retrieve(cfg, "global", "table"))) {
252                 ast_log(LOG_WARNING,"CDR table not specified.  Assuming cdr\n");
253                 tmp = "cdr";
254         }
255
256         if (!(table = ast_strdup(tmp)))
257                 return -1;
258
259         if (option_debug) {
260                 if (ast_strlen_zero(pghostname))
261                         ast_log(LOG_DEBUG, "cdr_pgsql: using default unix socket\n");
262                 else
263                         ast_log(LOG_DEBUG, "cdr_pgsql: got hostname of %s\n", pghostname);
264                 ast_log(LOG_DEBUG, "cdr_pgsql: got port of %s\n", pgdbport);
265                 ast_log(LOG_DEBUG, "cdr_pgsql: got user of %s\n", pgdbuser);
266                 ast_log(LOG_DEBUG, "cdr_pgsql: got dbname of %s\n", pgdbname);
267                 ast_log(LOG_DEBUG, "cdr_pgsql: got password of %s\n", pgpassword);
268                 ast_log(LOG_DEBUG, "cdr_pgsql: got sql table name of %s\n", table);
269         }
270         
271         conn = PQsetdbLogin(pghostname, pgdbport, NULL, NULL, pgdbname, pgdbuser, pgpassword);
272         if (PQstatus(conn) != CONNECTION_BAD) {
273                 if (option_debug)
274                         ast_log(LOG_DEBUG, "Successfully connected to PostgreSQL database.\n");
275                 connected = 1;
276         } else {
277                 pgerror = PQerrorMessage(conn);
278                 ast_log(LOG_ERROR, "cdr_pgsql: Unable to connect to database server %s.  CALLS WILL NOT BE LOGGED!!\n", pghostname);
279                 ast_log(LOG_ERROR, "cdr_pgsql: Reason: %s\n", pgerror);
280                 connected = 0;
281         }
282
283         return ast_cdr_register(name, ast_module_info->description, pgsql_log);
284 }
285
286 static int my_load_module(void)
287 {
288         struct ast_config *cfg;
289         int res;
290
291         if (!(cfg = ast_config_load(config))) {
292                 ast_log(LOG_WARNING, "Unable to load config for PostgreSQL CDR's: %s\n", config);
293                 return AST_MODULE_LOAD_DECLINE;
294         }
295
296         res = process_my_load_module(cfg);
297         ast_config_destroy(cfg);
298
299         return res;
300 }
301
302 static int load_module(void)
303 {
304         return my_load_module();
305 }
306
307 static int unload_module(void)
308 {
309         return my_unload_module();
310 }
311
312 static int reload(void)
313 {
314         my_unload_module();
315         return my_load_module();
316 }
317
318 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "PostgreSQL CDR Backend",
319                 .load = load_module,
320                 .unload = unload_module,
321                 .reload = reload,
322                );