modules: several small doxygen bug fixes
[sip-router] / modules / db_mysql / my_con.c
1 /* 
2  * $Id$
3  *
4  * Copyright (C) 2001-2004 iptel.org
5  * Copyright (C) 2006-2007 iptelorg GmbH
6  *
7  * This file is part of ser, a free SIP server.
8  *
9  * ser is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version
13  *
14  * For a license to use the ser software under conditions
15  * other than those described here, or to purchase support for this
16  * software, please contact iptel.org by e-mail at the following addresses:
17  *    info@iptel.org
18  *
19  * ser is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License 
25  * along with this program; if not, write to the Free Software 
26  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
27  */
28
29 #include "my_con.h"
30
31 #include "mysql_mod.h"
32 #include "my_uri.h"
33
34 #include "../../mem/mem.h"
35 #include "../../dprint.h"
36 #include "../../ut.h"
37
38 #include <string.h>
39 #include <time.h>
40
41
42 /*
43  * Close the connection and release memory
44  */
45 static void my_con_free(db_con_t* con, struct my_con* payload)
46 {
47         if (!payload) return;
48         
49         /* Delete the structure only if there are no more references
50          * to it in the connection pool
51          */
52         if (db_pool_remove((db_pool_entry_t*)payload) == 0) return;
53         
54         db_pool_entry_free(&payload->gen);
55         if (payload->con) pkg_free(payload->con);
56         pkg_free(payload);
57 }
58
59
60 int my_con_connect(db_con_t* con)
61 {
62         struct my_con* mcon;
63         struct my_uri* muri;
64         
65         mcon = DB_GET_PAYLOAD(con);
66         muri = DB_GET_PAYLOAD(con->uri);
67         
68         /* Do not reconnect already connected connections */
69         if (mcon->flags & MY_CONNECTED) return 0;
70
71         DBG("mysql: Connecting to %.*s:%.*s\n",
72                 con->uri->scheme.len, ZSW(con->uri->scheme.s),
73                 con->uri->body.len, ZSW(con->uri->body.s));
74
75         if (my_connect_to) {
76                 if (mysql_options(mcon->con, MYSQL_OPT_CONNECT_TIMEOUT, 
77                                                   (char*)&my_connect_to))
78                         WARN("mysql: failed to set MYSQL_OPT_CONNECT_TIMEOUT\n");
79         }
80
81 #if MYSQL_VERSION_ID >= 40101 
82         if ((my_client_ver >= 50025) || 
83                 ((my_client_ver >= 40122) && 
84                  (my_client_ver < 50000))) {
85                 if (my_send_to) {
86                         if (mysql_options(mcon->con, MYSQL_OPT_WRITE_TIMEOUT , 
87                                                           (char*)&my_send_to))
88                                 WARN("mysql: failed to set MYSQL_OPT_WRITE_TIMEOUT\n");
89                 }
90                 if (my_recv_to){
91                         if (mysql_options(mcon->con, MYSQL_OPT_READ_TIMEOUT , 
92                                                           (char*)&my_recv_to))
93                                 WARN("mysql: failed to set MYSQL_OPT_READ_TIMEOUT\n");
94                 }
95         }
96 #endif
97         
98         if (!mysql_real_connect(mcon->con, muri->host, muri->username, 
99                                                         muri->password, muri->database, muri->port, 0, 0)) {
100                 LOG(L_ERR, "mysql: %s\n", mysql_error(mcon->con));
101                 return -1;
102         }
103         
104         DBG("mysql: Connection type is %s\n", mysql_get_host_info(mcon->con));
105         DBG("mysql: Protocol version is %d\n", mysql_get_proto_info(mcon->con));
106         DBG("mysql: Server version is %s\n", mysql_get_server_info(mcon->con));
107
108         mcon->flags |= MY_CONNECTED;
109         return 0;
110 }
111
112
113 void my_con_disconnect(db_con_t* con)
114 {
115         struct my_con* mcon;
116
117         mcon = DB_GET_PAYLOAD(con);
118
119         if ((mcon->flags & MY_CONNECTED) == 0) return;
120
121         DBG("mysql: Disconnecting from %.*s:%.*s\n",
122                 con->uri->scheme.len, ZSW(con->uri->scheme.s),
123                 con->uri->body.len, ZSW(con->uri->body.s));
124
125         mysql_close(mcon->con);
126         mcon->flags &= ~MY_CONNECTED;
127
128         /* Increase the variable that keeps track of number of connection
129          * resets on this connection. The mysql module uses the variable to
130          * determine when a pre-compiled command needs to be uploaded to the
131          * server again. If the number in the my_con structure is larger than
132          * the number kept in my_cmd then it means that we have to upload the
133          * command to the server again because the connection was reset.
134          */
135         mcon->resets++;
136 }
137
138
139 int my_con(db_con_t* con)
140 {
141         struct my_con* ptr;
142         struct my_uri* uri;
143
144         /* First try to lookup the connection in the connection pool and
145          * re-use it if a match is found
146          */
147         ptr = (struct my_con*)db_pool_get(con->uri);
148         if (ptr) {
149                 DBG("mysql: Connection to %.*s:%.*s found in connection pool\n",
150                         con->uri->scheme.len, ZSW(con->uri->scheme.s),
151                         con->uri->body.len, ZSW(con->uri->body.s));
152                 goto found;
153         }
154
155         ptr = (struct my_con*)pkg_malloc(sizeof(struct my_con));
156         if (!ptr) {
157                 LOG(L_ERR, "mysql: No memory left\n");
158                 goto error;
159         }
160         memset(ptr, '\0', sizeof(struct my_con));
161         if (db_pool_entry_init(&ptr->gen, my_con_free, con->uri) < 0) goto error;
162
163         ptr->con = (MYSQL*)pkg_malloc(sizeof(MYSQL));
164         if (!ptr->con) {
165                 LOG(L_ERR, "mysql: No enough memory\n");
166                 goto error;
167         }
168         mysql_init(ptr->con);
169
170         uri = DB_GET_PAYLOAD(con->uri);
171         DBG("mysql: Creating new connection to: %.*s:%.*s\n",
172                 con->uri->scheme.len, ZSW(con->uri->scheme.s),
173                 con->uri->body.len, ZSW(con->uri->body.s));
174
175         /* Put the newly created mysql connection into the pool */
176         db_pool_put((struct db_pool_entry*)ptr);
177         DBG("mysql: Connection stored in connection pool\n");
178
179  found:
180         /* Attach driver payload to the db_con structure and set connect and
181          * disconnect functions
182          */
183         DB_SET_PAYLOAD(con, ptr);
184         con->connect = my_con_connect;
185         con->disconnect = my_con_disconnect;
186         return 0;
187
188  error:
189         if (ptr) {
190                 db_pool_entry_free(&ptr->gen);
191                 if (ptr->con) pkg_free(ptr->con);
192                 pkg_free(ptr);
193         }
194         return 0;
195 }