all: updated FSF address in GPL text
[sip-router] / modules / db_mysql / mysql_mod.c
1 /*
2  * $Id$
3  *
4  * MySQL module interface
5  *
6  * Copyright (C) 2001-2003 FhG Fokus
7  *
8  * This file is part of Kamailio, a free SIP server.
9  *
10  * ser is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version
14  *
15  * For a license to use the Kamailio software under conditions
16  * other than those described here, or to purchase support for this
17  * software, please contact iptel.org by e-mail at the following addresses:
18  *    info@iptel.org
19  *
20  * Kamailio is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23  * GNU General Public License for more details.
24  *
25  * You should have received a copy of the GNU General Public License
26  * along with this program; if not, write to the Free Software
27  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
28  */
29 /*
30  * History:
31  * --------
32  *  2003-03-11  updated to the new module exports interface (andrei)
33  *  2003-03-16  flags export parameter added (janakj)
34  *  2013-04-02  added transaction support (haakon.nessjoen@gmail.com)
35  */
36 /** @addtogroup mysql
37  *  @{
38  */
39  
40 #include "mysql_mod.h"
41 #include "km_db_mysql.h"
42
43 #include "my_uri.h"
44 #include "my_con.h"
45 #include "my_cmd.h"
46 #include "my_fld.h"
47 #include "my_res.h"
48
49 #include "../../sr_module.h"
50 #include "../../lib/srdb2/db.h"
51 #include "../../dprint.h"
52
53 int my_ping_interval = 5 * 60; /* Default is 5 minutes */
54 unsigned int my_connect_to = 2; /* 2 s by default */
55 unsigned int my_send_to = 0; /*  enabled only for mysql >= 5.25  */
56 unsigned int my_recv_to = 0; /* enabled only for mysql >= 5.25 */
57 unsigned int my_retries = 1;    /* Number of retries when command fails */
58
59 unsigned long my_client_ver = 0;
60
61 struct mysql_counters_h mysql_cnts_h;
62 counter_def_t mysql_cnt_defs[] =  {
63         {&mysql_cnts_h.driver_err, "driver_errors", 0, 0, 0,
64                 "incremented each time a Mysql error happened because the server/connection has failed."},
65         {0, 0, 0, 0, 0, 0 }
66 };
67 #define DEFAULT_MY_SEND_TO  2   /* in seconds */
68 #define DEFAULT_MY_RECV_TO  4   /* in seconds */
69
70 static int mysql_mod_init(void);
71
72 MODULE_VERSION
73
74
75 /*
76  * MySQL database module interface
77  */
78 static cmd_export_t cmds[] = {
79         {"db_ctx",    (cmd_function)NULL,         0, 0, 0},
80         {"db_con",    (cmd_function)my_con,       0, 0, 0},
81         {"db_uri",    (cmd_function)my_uri,       0, 0, 0},
82         {"db_cmd",    (cmd_function)my_cmd,       0, 0, 0},
83         {"db_put",    (cmd_function)my_cmd_exec,  0, 0, 0},
84         {"db_del",    (cmd_function)my_cmd_exec,  0, 0, 0},
85         {"db_get",    (cmd_function)my_cmd_exec,  0, 0, 0},
86         {"db_upd",    (cmd_function)my_cmd_exec,  0, 0, 0},
87         {"db_sql",    (cmd_function)my_cmd_exec,  0, 0, 0},
88         {"db_res",    (cmd_function)my_res,       0, 0, 0},
89         {"db_fld",    (cmd_function)my_fld,       0, 0, 0},
90         {"db_first",  (cmd_function)my_cmd_first, 0, 0, 0},
91         {"db_next",   (cmd_function)my_cmd_next,  0, 0, 0},
92         {"db_setopt", (cmd_function)my_setopt,    0, 0, 0},
93         {"db_getopt", (cmd_function)my_getopt,    0, 0, 0},
94         {"db_bind_api",         (cmd_function)db_mysql_bind_api,      0, 0, 0},
95         {0, 0, 0, 0, 0}
96 };
97
98
99 /*
100  * Exported parameters
101  */
102 static param_export_t params[] = {
103         {"ping_interval",   PARAM_INT, &my_ping_interval},
104         {"connect_timeout", PARAM_INT, &my_connect_to},
105         {"send_timeout",    PARAM_INT, &my_send_to},
106         {"receive_timeout", PARAM_INT, &my_recv_to},
107         {"retries",         PARAM_INT, &my_retries},
108
109         {"timeout_interval", INT_PARAM, &db_mysql_timeout_interval},
110         {"auto_reconnect",   INT_PARAM, &db_mysql_auto_reconnect},
111         {"insert_delayed",   INT_PARAM, &db_mysql_insert_all_delayed},
112         {0, 0, 0}
113 };
114
115
116 struct module_exports exports = {
117         "db_mysql",
118         cmds,
119         0,               /* RPC method */
120         params,          /*  module parameters */
121         mysql_mod_init,  /* module initialization function */
122         0,               /* response function*/
123         0,               /* destroy function */
124         0,               /* oncancel function */
125         0                /* per-child init function */
126 };
127
128
129 int mod_register(char *path, int *dlflags, void *p1, void *p2)
130 {
131         if(db_mysql_alloc_buffer()<0)
132                 return -1;
133         return 0;
134 }
135
136 static int mysql_mod_init(void)
137 {
138 #if MYSQL_VERSION_ID >= 40101
139         my_client_ver = mysql_get_client_version();
140         if ((my_client_ver >= 50025) || 
141                 ((my_client_ver >= 40122) && 
142                  (my_client_ver < 50000))) {
143                 if (my_send_to == 0) {
144                         my_send_to= DEFAULT_MY_SEND_TO;
145                 }
146                 if (my_recv_to == 0) {
147                         my_recv_to= DEFAULT_MY_RECV_TO;
148                 }
149         } else if (my_recv_to || my_send_to) {
150                 LOG(L_WARN, "WARNING: mysql send or received timeout set, but "
151                         " not supported by the installed mysql client library"
152                         " (needed at least 4.1.22 or 5.0.25, but installed %ld)\n",
153                         my_client_ver);
154         }
155 #else
156         if (my_recv_to || my_send_to) {
157                 LOG(L_WARN, "WARNING: mysql send or received timeout set, but "
158                         " not supported by the mysql client library used to compile"
159                         " the mysql module (needed at least 4.1.1 but "
160                         " compiled against %ld)\n", MYSQL_VERSION_ID);
161         }
162 #endif
163         if (counter_register_array("mysql", mysql_cnt_defs) < 0)
164                 goto error;
165
166         return kam_mysql_mod_init();
167 error:
168         return -1;
169 }
170
171 /** @} */